2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.133 2007-06-04 09:18:09 adam Exp $
9 * \brief Implements ZOOM C interface.
17 #include <yaz/yaz-util.h>
18 #include <yaz/xmalloc.h>
19 #include <yaz/otherinfo.h>
21 #include <yaz/pquery.h>
22 #include <yaz/marcdisp.h>
23 #include <yaz/diagbib1.h>
24 #include <yaz/charneg.h>
29 #include <yaz/query-charset.h>
30 #include <yaz/copy_types.h>
32 static int log_api = 0;
33 static int log_details = 0;
40 static void resultset_destroy(ZOOM_resultset r);
41 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
42 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
43 static char *cql2pqf(ZOOM_connection c, const char *cql);
47 * This wrapper is just for logging failed lookups. It would be nicer
48 * if it could cause failure when a lookup fails, but that's hard.
50 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
51 int oid_class, const char *str) {
52 Odr_oid *res = yaz_string_to_oid_odr(yaz_oid_std(), oid_class, str,
55 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
56 c, (int) oid_class, str);
61 static void initlog(void)
63 static int log_level_initialized = 0;
64 if (!log_level_initialized)
66 log_api = yaz_log_module_level("zoom");
67 log_details = yaz_log_module_level("zoomdetails");
68 log_level_initialized = 1;
72 static ZOOM_Event ZOOM_Event_create(int kind)
74 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
78 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
82 static void ZOOM_Event_destroy(ZOOM_Event event)
87 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
91 c->m_queue_back->prev = event;
92 assert(c->m_queue_front);
96 assert(!c->m_queue_front);
97 c->m_queue_front = event;
99 event->next = c->m_queue_back;
101 c->m_queue_back = event;
104 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
106 ZOOM_Event event = c->m_queue_front;
109 c->last_event = ZOOM_EVENT_NONE;
112 assert(c->m_queue_back);
113 c->m_queue_front = event->prev;
114 if (c->m_queue_front)
116 assert(c->m_queue_back);
117 c->m_queue_front->next = 0;
121 c->last_event = event->kind;
125 static void ZOOM_connection_remove_events(ZOOM_connection c)
128 while ((event = ZOOM_connection_get_event(c)))
129 ZOOM_Event_destroy(event);
132 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
134 ZOOM_Event event = c->m_queue_front;
136 return event ? event->kind : ZOOM_EVENT_NONE;
139 void ZOOM_connection_remove_tasks(ZOOM_connection c);
141 static void set_dset_error(ZOOM_connection c, int error,
143 const char *addinfo, const char *addinfo2)
150 if (!c->diagset || strcmp(dset, c->diagset))
153 c->diagset = xstrdup(dset);
154 /* remove integer part from SRW diagset .. */
155 if ((cp = strrchr(c->diagset, '/')))
158 if (addinfo && addinfo2)
160 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
161 strcpy(c->addinfo, addinfo);
162 strcat(c->addinfo, addinfo2);
165 c->addinfo = xstrdup(addinfo);
166 if (error != ZOOM_ERROR_NONE)
168 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
169 c, c->host_port ? c->host_port : "<>", dset, error,
170 addinfo ? addinfo : "",
171 addinfo2 ? addinfo2 : "");
172 ZOOM_connection_remove_tasks(c);
177 static void set_HTTP_error(ZOOM_connection c, int error,
178 const char *addinfo, const char *addinfo2)
180 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
185 static void set_ZOOM_error(ZOOM_connection c, int error,
188 set_dset_error(c, error, "ZOOM", addinfo, 0);
191 static void clear_error(ZOOM_connection c)
194 * If an error is tied to an operation then it's ok to clear: for
195 * example, a diagnostic returned from a search is cleared by a
196 * subsequent search. However, problems such as Connection Lost
197 * or Init Refused are not cleared, because they are not
198 * recoverable: doing another search doesn't help.
201 ZOOM_connection_remove_events(c);
204 case ZOOM_ERROR_CONNECT:
205 case ZOOM_ERROR_MEMORY:
206 case ZOOM_ERROR_DECODE:
207 case ZOOM_ERROR_CONNECTION_LOST:
208 case ZOOM_ERROR_INIT:
209 case ZOOM_ERROR_INTERNAL:
210 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
213 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
217 void ZOOM_connection_show_task(ZOOM_task task)
221 case ZOOM_TASK_SEARCH:
222 yaz_log(YLOG_LOG, "search p=%p", task);
224 case ZOOM_TASK_RETRIEVE:
225 yaz_log(YLOG_LOG, "retrieve p=%p", task);
227 case ZOOM_TASK_CONNECT:
228 yaz_log(YLOG_LOG, "connect p=%p", task);
231 yaz_log(YLOG_LOG, "scant p=%p", task);
236 void ZOOM_connection_show_tasks(ZOOM_connection c)
239 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
240 for (task = c->tasks; task; task = task->next)
241 ZOOM_connection_show_task(task);
244 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
246 ZOOM_task *taskp = &c->tasks;
248 taskp = &(*taskp)->next;
249 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
250 (*taskp)->running = 0;
251 (*taskp)->which = which;
257 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
259 return c->tasks ? 0 : 1;
262 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
264 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
266 task->next = c->tasks;
275 void ZOOM_connection_remove_task(ZOOM_connection c)
277 ZOOM_task task = c->tasks;
281 c->tasks = task->next;
284 case ZOOM_TASK_SEARCH:
285 resultset_destroy(task->u.search.resultset);
286 xfree(task->u.search.syntax);
287 xfree(task->u.search.elementSetName);
289 case ZOOM_TASK_RETRIEVE:
290 resultset_destroy(task->u.retrieve.resultset);
291 xfree(task->u.retrieve.syntax);
292 xfree(task->u.retrieve.elementSetName);
294 case ZOOM_TASK_CONNECT:
297 ZOOM_scanset_destroy(task->u.scan.scan);
299 case ZOOM_TASK_PACKAGE:
300 ZOOM_package_destroy(task->u.package);
303 resultset_destroy(task->u.sort.resultset);
304 ZOOM_query_destroy(task->u.sort.q);
313 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
314 ZOOM_connection_put_event(c, event);
319 static int ZOOM_connection_exec_task(ZOOM_connection c);
321 void ZOOM_connection_remove_tasks(ZOOM_connection c)
324 ZOOM_connection_remove_task(c);
327 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
329 const char *elementSetName);
331 ZOOM_API(ZOOM_connection)
332 ZOOM_connection_create(ZOOM_options options)
334 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
338 yaz_log(log_api, "%p ZOOM_connection_create", c);
340 c->proto = PROTO_Z3950;
342 ZOOM_connection_set_mask(c, 0);
344 c->state = STATE_IDLE;
347 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
354 c->options = ZOOM_options_create_with_parent(options);
360 c->charset = c->lang = 0;
371 c->maximum_record_size = 0;
372 c->preferred_message_size = 0;
374 c->odr_in = odr_createmem(ODR_DECODE);
375 c->odr_out = odr_createmem(ODR_ENCODE);
378 c->support_named_resultsets = 0;
379 c->last_event = ZOOM_EVENT_NONE;
381 c->m_queue_front = 0;
387 /* set database names. Take local databases (if set); otherwise
388 take databases given in ZURL (if set); otherwise use Default */
389 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
392 char **databaseNames;
393 const char *cp = ZOOM_options_get(options, "databaseName");
395 if ((!cp || !*cp) && con->host_port)
397 if (strncmp(con->host_port, "unix:", 5) == 0)
398 cp = strchr(con->host_port+5, ':');
400 cp = strchr(con->host_port, '/');
406 nmem_strsplit(odr_getmem(odr), "+", cp, &databaseNames, num);
407 return databaseNames;
410 ZOOM_API(ZOOM_connection)
411 ZOOM_connection_new(const char *host, int portnum)
413 ZOOM_connection c = ZOOM_connection_create(0);
415 ZOOM_connection_connect(c, host, portnum);
419 static zoom_sru_mode get_sru_mode_from_string(const char *s)
422 return zoom_sru_soap;
423 if (!yaz_matchstr(s, "soap"))
424 return zoom_sru_soap;
425 else if (!yaz_matchstr(s, "get"))
427 else if (!yaz_matchstr(s, "post"))
428 return zoom_sru_post;
429 return zoom_sru_error;
433 ZOOM_connection_connect(ZOOM_connection c,
434 const char *host, int portnum)
441 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
442 c, host ? host : "null", portnum);
444 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
445 ZOOM_connection_remove_tasks(c);
449 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
453 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
456 val = ZOOM_options_get(c->options, "proxy");
459 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
460 c->proxy = xstrdup(val);
465 val = ZOOM_options_get(c->options, "charset");
468 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
469 c->charset = xstrdup(val);
473 val = ZOOM_options_get(c->options, "lang");
476 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
477 c->lang = xstrdup(val);
488 sprintf(hostn, "%.80s:%d", host, portnum);
489 c->host_port = xstrdup(hostn);
492 c->host_port = xstrdup(host);
497 * If the "<scheme>:" part of the host string is preceded by one
498 * or more comma-separated <name>=<value> pairs, these are taken
499 * to be options to be set on the connection object. Among other
500 * applications, this facility can be used to embed authentication
502 * user=admin,password=secret,tcp:localhost:9999
504 char *remainder = c->host_port;
505 char *pcolon = strchr(remainder, ':');
508 while ((pcomma = strchr(remainder, ',')) != 0 &&
509 (pcolon == 0 || pcomma < pcolon)) {
511 if ((pequals = strchr(remainder, '=')) != 0) {
513 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
514 ZOOM_connection_option_set(c, remainder, pequals+1);
516 remainder = pcomma+1;
519 if (remainder != c->host_port) {
521 c->host_port = xstrdup(remainder);
522 /*printf("# reset hp='%s'\n", remainder);*/
526 val = ZOOM_options_get(c->options, "sru");
527 c->sru_mode = get_sru_mode_from_string(val);
529 ZOOM_options_set(c->options, "host", c->host_port);
531 xfree(c->cookie_out);
533 val = ZOOM_options_get(c->options, "cookie");
536 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
537 c->cookie_out = xstrdup(val);
542 val = ZOOM_options_get(c->options, "clientIP");
545 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
547 c->client_IP = xstrdup(val);
552 val = ZOOM_options_get(c->options, "group");
554 c->group = xstrdup(val);
558 val = ZOOM_options_get(c->options, "user");
560 c->user = xstrdup(val);
564 val = ZOOM_options_get(c->options, "password");
566 val = ZOOM_options_get(c->options, "pass");
569 c->password = xstrdup(val);
571 c->maximum_record_size =
572 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
573 c->preferred_message_size =
574 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
576 c->async = ZOOM_options_get_bool(c->options, "async", 0);
577 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
579 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
583 while (ZOOM_event(1, &c))
589 ZOOM_query_create(void)
591 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
593 yaz_log(log_details, "%p ZOOM_query_create", s);
597 s->odr = odr_createmem(ODR_ENCODE);
604 ZOOM_query_destroy(ZOOM_query s)
610 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
611 if (s->refcount == 0)
619 ZOOM_query_prefix(ZOOM_query s, const char *str)
621 s->query_string = odr_strdup(s->odr, str);
622 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
623 s->z_query->which = Z_Query_type_1;
624 s->z_query->u.type_1 = p_query_rpn(s->odr, str);
625 if (!s->z_query->u.type_1)
627 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
631 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
636 ZOOM_query_cql(ZOOM_query s, const char *str)
640 s->query_string = odr_strdup(s->odr, str);
642 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
643 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
644 ext->indirect_reference = 0;
646 ext->which = Z_External_CQL;
647 ext->u.cql = s->query_string;
649 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
650 s->z_query->which = Z_Query_type_104;
651 s->z_query->u.type_104 = ext;
653 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
659 * Translate the CQL string client-side into RPN which is passed to
660 * the server. This is useful for server's that don't themselves
661 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
662 * only as a place to stash diagnostics if compilation fails; if this
663 * information is not needed, a null pointer may be used.
666 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
670 ZOOM_connection freeme = 0;
672 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
674 conn = freeme = ZOOM_connection_create(0);
676 rpn = cql2pqf(conn, str);
678 ZOOM_connection_destroy(freeme);
682 ret = ZOOM_query_prefix(s, rpn);
688 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
689 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
690 * to the server, as the YAZ GFS doesn't know how to handle this.
693 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
694 int *ccl_error, const char **error_string,
698 struct ccl_rpn_node *rpn;
699 CCL_bibset bibset = ccl_qual_mk();
702 ccl_qual_buf(bibset, config);
704 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
707 *error_string = ccl_err_msg(*ccl_error);
712 WRBUF wr = wrbuf_alloc();
715 ret = ZOOM_query_prefix(s, wrbuf_cstr(wr));
718 ccl_qual_rm(&bibset);
723 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
725 s->sort_spec = yaz_sort_spec(s->odr, criteria);
728 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
732 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
736 static zoom_ret do_write(ZOOM_connection c);
739 ZOOM_connection_destroy(ZOOM_connection c)
744 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
747 for (r = c->resultsets; r; r = r->next)
753 odr_destroy(c->odr_in);
754 odr_destroy(c->odr_out);
755 ZOOM_options_destroy(c->options);
756 ZOOM_connection_remove_tasks(c);
757 ZOOM_connection_remove_events(c);
763 xfree(c->cookie_out);
772 void ZOOM_resultset_addref(ZOOM_resultset r)
777 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
782 ZOOM_resultset ZOOM_resultset_create(void)
785 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
789 yaz_log(log_details, "%p ZOOM_resultset_create", r);
792 r->odr = odr_createmem(ODR_ENCODE);
797 for (i = 0; i<RECORD_HASH_SIZE; i++)
798 r->record_hash[i] = 0;
803 r->databaseNames = 0;
804 r->num_databaseNames = 0;
809 ZOOM_API(ZOOM_resultset)
810 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
813 ZOOM_query s = ZOOM_query_create();
815 ZOOM_query_prefix(s, q);
817 r = ZOOM_connection_search(c, s);
818 ZOOM_query_destroy(s);
822 ZOOM_API(ZOOM_resultset)
823 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
825 ZOOM_resultset r = ZOOM_resultset_create();
829 const char *syntax, *elementSetName;
831 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
832 r->r_sort_spec = q->sort_spec;
835 r->options = ZOOM_options_create_with_parent(c->options);
838 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
840 r->rpn_iconv = yaz_iconv_open(cp, "UTF-8");
844 start = ZOOM_options_get_int(r->options, "start", 0);
845 count = ZOOM_options_get_int(r->options, "count", 0);
847 /* If "presentChunk" is defined use that; otherwise "step" */
848 const char *cp = ZOOM_options_get(r->options, "presentChunk");
849 r->step = ZOOM_options_get_int(r->options,
850 (cp != 0 ? "presentChunk": "step"), 0);
852 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
853 cp = ZOOM_options_get(r->options, "setname");
855 r->setname = xstrdup(cp);
856 cp = ZOOM_options_get(r->options, "schema");
858 r->schema = xstrdup(cp);
860 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
865 r->next = c->resultsets;
870 if (c->host_port && c->proto == PROTO_HTTP)
874 yaz_log(log_details, "ZOOM_connection_search: no comstack");
875 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
879 yaz_log(log_details, "ZOOM_connection_search: reconnect");
884 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
885 task->u.search.resultset = r;
886 task->u.search.start = start;
887 task->u.search.count = count;
889 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
890 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
891 elementSetName = ZOOM_options_get(r->options, "elementSetName");
892 task->u.search.elementSetName = elementSetName
893 ? xstrdup(elementSetName) : 0;
895 ZOOM_resultset_addref(r);
901 while (ZOOM_event(1, &c))
908 ZOOM_resultset_sort(ZOOM_resultset r,
909 const char *sort_type, const char *sort_spec)
911 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
915 ZOOM_resultset_sort1(ZOOM_resultset r,
916 const char *sort_type, const char *sort_spec)
918 ZOOM_connection c = r->connection;
922 newq = ZOOM_query_create();
923 if (ZOOM_query_sortby(newq, sort_spec) < 0)
926 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
927 r, r, sort_type, sort_spec);
931 if (c->host_port && c->proto == PROTO_HTTP)
935 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
936 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
940 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
946 ZOOM_resultset_cache_reset(r);
947 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
948 task->u.sort.resultset = r;
949 task->u.sort.q = newq;
951 ZOOM_resultset_addref(r);
955 while (ZOOM_event(1, &c))
963 ZOOM_resultset_cache_reset(ZOOM_resultset r)
966 for (i = 0; i<RECORD_HASH_SIZE; i++)
968 ZOOM_record_cache rc;
969 for (rc = r->record_hash[i]; rc; rc = rc->next)
971 if (rc->rec.wrbuf_marc)
972 wrbuf_destroy(rc->rec.wrbuf_marc);
973 if (rc->rec.wrbuf_iconv)
974 wrbuf_destroy(rc->rec.wrbuf_iconv);
975 if (rc->rec.wrbuf_opac)
976 wrbuf_destroy(rc->rec.wrbuf_opac);
978 r->record_hash[i] = 0;
983 ZOOM_resultset_destroy(ZOOM_resultset r)
985 resultset_destroy(r);
988 static void resultset_destroy(ZOOM_resultset r)
993 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
995 if (r->refcount == 0)
997 ZOOM_resultset_cache_reset(r);
1001 /* remove ourselves from the resultsets in connection */
1002 ZOOM_resultset *rp = &r->connection->resultsets;
1005 assert(*rp); /* we must be in this list!! */
1007 { /* OK, we're here - take us out of it */
1014 ZOOM_query_destroy(r->query);
1015 ZOOM_options_destroy(r->options);
1017 yaz_iconv_close(r->rpn_iconv);
1018 odr_destroy(r->odr);
1026 ZOOM_resultset_size(ZOOM_resultset r)
1028 yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
1033 static void do_close(ZOOM_connection c)
1038 ZOOM_connection_set_mask(c, 0);
1039 c->state = STATE_IDLE;
1042 static int ZOOM_test_reconnect(ZOOM_connection c)
1046 if (!c->reconnect_ok)
1049 c->reconnect_ok = 0;
1050 c->tasks->running = 0;
1051 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1053 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1054 ZOOM_connection_put_event(c, event);
1059 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1060 int force_sync, int start, int count)
1065 const char *syntax, *elementSetName;
1069 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1070 " count=%d", r, force_sync, start, count);
1075 if (c->host_port && c->proto == PROTO_HTTP)
1079 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1080 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1084 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1086 c->reconnect_ok = 1;
1089 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1090 task->u.retrieve.resultset = r;
1091 task->u.retrieve.start = start;
1092 task->u.retrieve.count = count;
1094 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1095 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1096 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1097 task->u.retrieve.elementSetName = elementSetName
1098 ? xstrdup(elementSetName) : 0;
1100 cp = ZOOM_options_get(r->options, "schema");
1103 if (!r->schema || strcmp(r->schema, cp))
1106 r->schema = xstrdup(cp);
1110 ZOOM_resultset_addref(r);
1112 if (!r->connection->async || force_sync)
1113 while (r->connection && ZOOM_event(1, &r->connection))
1118 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1119 size_t start, size_t count)
1121 int force_present = 0;
1125 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1126 r, r, (long) start, (long) count);
1129 ZOOM_resultset_retrieve(r, force_present, start, count);
1133 for (i = 0; i< count; i++)
1134 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1138 static void get_cert(ZOOM_connection c)
1143 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1145 ZOOM_connection_option_setl(c, "sslPeerCert",
1146 cert_buf, cert_len);
1151 static zoom_ret do_connect(ZOOM_connection c)
1154 const char *effective_host;
1157 effective_host = c->proxy;
1159 effective_host = c->host_port;
1161 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1165 c->cs = cs_create_host(effective_host, 0, &add);
1167 if (c->cs && c->cs->protocol == PROTO_HTTP)
1170 const char *path = 0;
1172 c->proto = PROTO_HTTP;
1173 cs_get_host_args(c->host_port, &path);
1175 c->path = (char*) xmalloc(strlen(path)+2);
1177 strcpy(c->path+1, path);
1179 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1181 return zoom_complete;
1186 int ret = cs_connect(c->cs, add);
1189 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1190 ZOOM_connection_put_event(c, event);
1192 if (c->proto == PROTO_Z3950)
1193 ZOOM_connection_send_init(c);
1196 /* no init request for SRW .. */
1197 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1198 ZOOM_connection_remove_task(c);
1199 ZOOM_connection_set_mask(c, 0);
1200 ZOOM_connection_exec_task(c);
1202 c->state = STATE_ESTABLISHED;
1203 return zoom_pending;
1207 int mask = ZOOM_SELECT_EXCEPT;
1208 if (c->cs->io_pending & CS_WANT_WRITE)
1209 mask += ZOOM_SELECT_WRITE;
1210 if (c->cs->io_pending & CS_WANT_READ)
1211 mask += ZOOM_SELECT_READ;
1212 ZOOM_connection_set_mask(c, mask);
1213 c->state = STATE_CONNECTING;
1214 return zoom_pending;
1217 c->state = STATE_IDLE;
1218 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1219 return zoom_complete;
1222 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1225 for (i = 0; i<200; i++)
1229 Z_OtherInformation **oi;
1234 sprintf(buf, "otherInfo%d", i);
1235 val = ZOOM_options_get(c->options, buf);
1238 cp = strchr(val, ':');
1242 if (len >= sizeof(buf))
1243 len = sizeof(buf)-1;
1244 memcpy(buf, val, len);
1247 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
1252 yaz_oi_APDU(a, &oi);
1253 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
1257 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1262 Z_OtherInformation **oi;
1263 yaz_oi_APDU(a, &oi);
1264 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
1269 Z_OtherInformation **oi;
1270 yaz_oi_APDU(a, &oi);
1271 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
1274 otherInfo_attach(c, a, out);
1275 if (!z_APDU(out, &a, 0, 0))
1277 FILE *outf = fopen("/tmp/apdu.txt", "a");
1280 ODR odr_pr = odr_createmem(ODR_PRINT);
1281 fprintf(outf, "a=%p\n", a);
1282 odr_setprint(odr_pr, outf);
1283 z_APDU(odr_pr, &a, 0, 0);
1284 odr_destroy(odr_pr);
1286 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1287 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1291 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1295 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1299 if (encode_APDU(c, a, c->odr_out))
1300 return zoom_complete;
1301 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1302 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1303 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1304 ZOOM_connection_put_event(c, event);
1305 odr_reset(c->odr_out);
1309 /* returns 1 if PDU was sent OK (still pending )
1310 0 if PDU was not sent OK (nothing to wait for)
1313 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1315 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1316 Z_InitRequest *ireq = apdu->u.initRequest;
1317 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1318 odr_malloc(c->odr_out, sizeof(*auth));
1321 ODR_MASK_SET(ireq->options, Z_Options_search);
1322 ODR_MASK_SET(ireq->options, Z_Options_present);
1323 ODR_MASK_SET(ireq->options, Z_Options_scan);
1324 ODR_MASK_SET(ireq->options, Z_Options_sort);
1325 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1326 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1328 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1329 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1330 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1332 /* Index Data's Z39.50 Implementor Id is 81 */
1333 ireq->implementationId =
1334 odr_prepend(c->odr_out,
1335 ZOOM_options_get(c->options, "implementationId"),
1336 odr_prepend(c->odr_out, "81", ireq->implementationId));
1338 ireq->implementationName =
1339 odr_prepend(c->odr_out,
1340 ZOOM_options_get(c->options, "implementationName"),
1341 odr_prepend(c->odr_out, "ZOOM-C",
1342 ireq->implementationName));
1344 version = odr_strdup(c->odr_out, "$Revision: 1.133 $");
1345 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1346 version[strlen(version)-2] = '\0';
1347 ireq->implementationVersion =
1348 odr_prepend(c->odr_out,
1349 ZOOM_options_get(c->options, "implementationVersion"),
1350 odr_prepend(c->odr_out, &version[11],
1351 ireq->implementationVersion));
1353 *ireq->maximumRecordSize = c->maximum_record_size;
1354 *ireq->preferredMessageSize = c->preferred_message_size;
1356 if (c->group || c->password)
1358 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1361 pass->groupId = odr_strdup(c->odr_out, c->group);
1364 pass->userId = odr_strdup(c->odr_out, c->user);
1367 pass->password = odr_strdup(c->odr_out, c->password);
1368 auth->which = Z_IdAuthentication_idPass;
1369 auth->u.idPass = pass;
1370 ireq->idAuthentication = auth;
1374 auth->which = Z_IdAuthentication_open;
1375 auth->u.open = odr_strdup(c->odr_out, c->user);
1376 ireq->idAuthentication = auth;
1380 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
1381 yaz_oid_userinfo_proxy, 1, c->host_port);
1383 if (c->charset || c->lang)
1385 Z_OtherInformation **oi;
1386 Z_OtherInformationUnit *oi_unit;
1388 yaz_oi_APDU(apdu, &oi);
1390 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1392 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1393 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1394 oi_unit->information.externallyDefinedInfo =
1395 yaz_set_proposal_charneg_list(c->odr_out, " ",
1396 c->charset, c->lang, 1);
1400 return send_APDU(c, apdu);
1404 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1409 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1411 if (c->sru_mode == zoom_sru_get)
1413 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1415 else if (c->sru_mode == zoom_sru_post)
1417 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1419 else if (c->sru_mode == zoom_sru_soap)
1421 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1423 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1424 return zoom_complete;
1425 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1427 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1428 ZOOM_connection_put_event(c, event);
1429 odr_reset(c->odr_out);
1435 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1439 ZOOM_resultset resultset = 0;
1441 const char *option_val = 0;
1443 if (c->error) /* don't continue on error */
1444 return zoom_complete;
1446 switch(c->tasks->which)
1448 case ZOOM_TASK_SEARCH:
1449 resultset = c->tasks->u.search.resultset;
1450 resultset->setname = xstrdup("default");
1451 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1452 start = &c->tasks->u.search.start;
1453 count = &c->tasks->u.search.count;
1455 case ZOOM_TASK_RETRIEVE:
1456 resultset = c->tasks->u.retrieve.resultset;
1458 start = &c->tasks->u.retrieve.start;
1459 count = &c->tasks->u.retrieve.count;
1461 if (*start >= resultset->size)
1462 return zoom_complete;
1463 if (*start + *count > resultset->size)
1464 *count = resultset->size - *start;
1466 for (i = 0; i < *count; i++)
1469 record_cache_lookup(resultset, i + *start,
1470 c->tasks->u.retrieve.syntax,
1471 c->tasks->u.retrieve.elementSetName);
1476 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1477 ZOOM_connection_put_event(c, event);
1484 return zoom_complete;
1487 return zoom_complete;
1489 assert(resultset->query);
1491 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1493 if (resultset->query->z_query->which == Z_Query_type_104
1494 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1496 sr->u.request->query_type = Z_SRW_query_type_cql;
1497 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1499 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1500 resultset->query->z_query->u.type_1)
1502 sr->u.request->query_type = Z_SRW_query_type_pqf;
1503 sr->u.request->query.pqf = resultset->query->query_string;
1507 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1508 return zoom_complete;
1510 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1511 sr->u.request->maximumRecords = odr_intdup(
1512 c->odr_out, resultset->step>0 ? resultset->step : *count);
1513 sr->u.request->recordSchema = resultset->schema;
1515 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1517 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1519 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1521 sr->extra_args = odr_strdup(c->odr_out, option_val);
1522 return send_srw(c, sr);
1525 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1527 return zoom_complete;
1531 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1534 int lslb, ssub, mspn;
1536 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1537 Z_SearchRequest *search_req = apdu->u.searchRequest;
1538 const char *elementSetName;
1539 const char *smallSetElementSetName;
1540 const char *mediumSetElementSetName;
1543 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1545 r = c->tasks->u.search.resultset;
1547 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1550 ZOOM_options_get(r->options, "elementSetName");
1551 smallSetElementSetName =
1552 ZOOM_options_get(r->options, "smallSetElementSetName");
1553 mediumSetElementSetName =
1554 ZOOM_options_get(r->options, "mediumSetElementSetName");
1556 if (!smallSetElementSetName)
1557 smallSetElementSetName = elementSetName;
1559 if (!mediumSetElementSetName)
1560 mediumSetElementSetName = elementSetName;
1565 /* prepare query for the search request */
1566 search_req->query = r->query->z_query;
1567 if (!search_req->query)
1569 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1570 return zoom_complete;
1572 if (r->query->z_query->which == Z_Query_type_1 && r->rpn_iconv)
1574 search_req->query = yaz_copy_Z_Query(r->query->z_query, c->odr_out);
1576 yaz_query_charset_convert_rpnquery(search_req->query->u.type_1,
1577 c->odr_out, r->rpn_iconv);
1579 search_req->databaseNames = r->databaseNames;
1580 search_req->num_databaseNames = r->num_databaseNames;
1582 /* get syntax (no need to provide unless piggyback is in effect) */
1583 syntax = c->tasks->u.search.syntax;
1585 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1586 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1587 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1588 if (lslb != -1 && ssub != -1 && mspn != -1)
1590 /* So're a Z39.50 expert? Let's hope you don't do sort */
1591 *search_req->largeSetLowerBound = lslb;
1592 *search_req->smallSetUpperBound = ssub;
1593 *search_req->mediumSetPresentNumber = mspn;
1595 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1596 && r->piggyback && !r->r_sort_spec && !r->schema)
1598 /* Regular piggyback - do it unless we're going to do sort */
1599 *search_req->largeSetLowerBound = 2000000000;
1600 *search_req->smallSetUpperBound = 1;
1601 *search_req->mediumSetPresentNumber =
1602 r->step>0 ? r->step : c->tasks->u.search.count;
1606 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1607 smallSetElementSetName = 0;
1608 mediumSetElementSetName = 0;
1611 if (smallSetElementSetName && *smallSetElementSetName)
1613 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1614 odr_malloc(c->odr_out, sizeof(*esn));
1616 esn->which = Z_ElementSetNames_generic;
1617 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1618 search_req->smallSetElementSetNames = esn;
1620 if (mediumSetElementSetName && *mediumSetElementSetName)
1622 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1623 odr_malloc(c->odr_out, sizeof(*esn));
1625 esn->which = Z_ElementSetNames_generic;
1626 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1627 search_req->mediumSetElementSetNames = esn;
1630 search_req->preferredRecordSyntax =
1631 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1635 if (c->support_named_resultsets)
1639 /* find the lowest unused ordinal so that we re-use
1640 result sets on the server. */
1641 for (ord = 1; ; ord++)
1644 sprintf(setname, "%d", ord);
1645 for (rp = c->resultsets; rp; rp = rp->next)
1646 if (rp->setname && !strcmp(rp->setname, setname))
1651 r->setname = xstrdup(setname);
1652 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1653 "set %s", c, r->setname);
1657 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1659 r->setname = xstrdup("default");
1661 ZOOM_options_set(r->options, "setname", r->setname);
1663 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1664 return send_APDU(c, apdu);
1667 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1669 char oid_name_buf[OID_STR_MAX];
1670 const char *oid_name;
1673 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
1676 case Z_DefaultDiagFormat_v2Addinfo:
1677 addinfo = r->u.v2Addinfo;
1679 case Z_DefaultDiagFormat_v3Addinfo:
1680 addinfo = r->u.v3Addinfo;
1685 set_dset_error(c, *r->condition, oid_name, addinfo, 0);
1688 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1690 if (p->which != Z_DiagRec_defaultFormat)
1691 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1693 response_default_diag(c, p->u.defaultFormat);
1696 ZOOM_API(ZOOM_record)
1697 ZOOM_record_clone(ZOOM_record srec)
1704 odr_enc = odr_createmem(ODR_ENCODE);
1705 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1707 buf = odr_getbuf(odr_enc, &size, 0);
1709 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1710 nrec->odr = odr_createmem(ODR_DECODE);
1711 nrec->wrbuf_marc = 0;
1712 nrec->wrbuf_iconv = 0;
1713 nrec->wrbuf_opac = 0;
1714 odr_setbuf(nrec->odr, buf, size, 0);
1715 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1717 odr_destroy(odr_enc);
1721 ZOOM_API(ZOOM_record)
1722 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1724 const char *syntax =
1725 ZOOM_options_get(s->options, "preferredRecordSyntax");
1726 const char *elementSetName =
1727 ZOOM_options_get(s->options, "elementSetName");
1729 return record_cache_lookup(s, pos, syntax, elementSetName);
1732 ZOOM_API(ZOOM_record)
1733 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1735 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1740 * MIKE: I think force_sync should always be zero, but I don't
1741 * want to make this change until I get the go-ahead from
1742 * Adam, in case something depends on the old synchronous
1746 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1747 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1748 rec = ZOOM_resultset_record_immediate(r, pos);
1754 ZOOM_record_destroy(ZOOM_record rec)
1758 if (rec->wrbuf_marc)
1759 wrbuf_destroy(rec->wrbuf_marc);
1760 if (rec->wrbuf_iconv)
1761 wrbuf_destroy(rec->wrbuf_iconv);
1762 if (rec->wrbuf_opac)
1763 wrbuf_destroy(rec->wrbuf_opac);
1764 odr_destroy(rec->odr);
1768 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1770 const char *buf, int sz,
1771 const char *record_charset)
1776 yaz_marc_t mt = yaz_marc_create();
1779 strcpy(to, "UTF-8");
1780 if (record_charset && *record_charset)
1782 /* Use "from,to" or just "from" */
1783 const char *cp = strchr(record_charset, ',');
1784 int clen = strlen(record_charset);
1787 strncpy( to, cp+1, sizeof(to)-1);
1788 to[sizeof(to)-1] = '\0';
1789 clen = cp - record_charset;
1791 if (clen > sizeof(from)-1)
1792 clen = sizeof(from)-1;
1795 strncpy(from, record_charset, clen);
1801 cd = yaz_iconv_open(to, from);
1802 yaz_marc_iconv(mt, cd);
1805 yaz_marc_xml(mt, marc_type);
1806 if (!rec->wrbuf_marc)
1807 rec->wrbuf_marc = wrbuf_alloc();
1808 wrbuf_rewind(rec->wrbuf_marc);
1809 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1811 yaz_marc_destroy(mt);
1813 yaz_iconv_close(cd);
1815 *len = wrbuf_len(rec->wrbuf_marc);
1816 return wrbuf_cstr(rec->wrbuf_marc);
1818 yaz_marc_destroy(mt);
1820 yaz_iconv_close(cd);
1824 static const char *record_iconv_return(ZOOM_record rec, int *len,
1825 const char *buf, int sz,
1826 const char *record_charset)
1833 strcpy(to, "UTF-8");
1835 if (record_charset && *record_charset)
1837 /* Use "from,to" or just "from" */
1838 const char *cp = strchr(record_charset, ',');
1839 int clen = strlen(record_charset);
1842 strncpy( to, cp+1, sizeof(to)-1);
1843 to[sizeof(to)-1] = '\0';
1844 clen = cp - record_charset;
1846 if (clen > sizeof(from)-1)
1847 clen = sizeof(from)-1;
1850 strncpy(from, record_charset, clen);
1854 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1856 if (!rec->wrbuf_iconv)
1857 rec->wrbuf_iconv = wrbuf_alloc();
1859 wrbuf_rewind(rec->wrbuf_iconv);
1861 wrbuf_iconv_write(rec->wrbuf_iconv, cd, buf, sz);
1862 wrbuf_iconv_reset(rec->wrbuf_iconv, cd);
1864 buf = wrbuf_cstr(rec->wrbuf_iconv);
1865 sz = wrbuf_len(rec->wrbuf_iconv);
1866 yaz_iconv_close(cd);
1874 ZOOM_record_error(ZOOM_record rec, const char **cp,
1875 const char **addinfo, const char **diagset)
1877 Z_NamePlusRecord *npr;
1882 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1884 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1885 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1886 const char *add = 0;
1888 if (diag_rec->which == Z_DiagRec_defaultFormat)
1890 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1893 error = *ddf->condition;
1896 case Z_DefaultDiagFormat_v2Addinfo:
1897 add = ddf->u.v2Addinfo;
1899 case Z_DefaultDiagFormat_v3Addinfo:
1900 add = ddf->u.v3Addinfo;
1905 yaz_oid_to_string(yaz_oid_std(),
1906 ddf->diagnosticSetId, &oclass);
1914 *addinfo = add ? add : "";
1916 *cp = diagbib1_str(error);
1922 ZOOM_API(const char *)
1923 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1930 Z_NamePlusRecord *npr;
1933 *len = 0; /* default return */
1942 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1944 if (cp[i] == ';' || cp[i] == ' ')
1950 while (type_spec[i] == ';')
1953 while (type_spec[i] == ' ')
1955 if (!strncmp(type_spec+i, "charset=", 8))
1958 i = i + 8; /* skip charset= */
1959 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1961 if (type_spec[i] == ';' || type_spec[i] == ' ')
1967 else if (!strncmp(type_spec+i, "xpath=", 6))
1971 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1975 while (type_spec[i] == ' ')
1978 if (!strcmp(type, "database"))
1981 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1982 return npr->databaseName;
1984 else if (!strcmp(type, "syntax"))
1986 const char *desc = 0;
1987 if (npr->which == Z_NamePlusRecord_databaseRecord)
1989 Z_External *r = (Z_External *) npr->u.databaseRecord;
1990 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
1995 *len = strlen(desc);
1998 if (npr->which != Z_NamePlusRecord_databaseRecord)
2001 /* from now on - we have a database record .. */
2002 if (!strcmp(type, "render"))
2004 Z_External *r = (Z_External *) npr->u.databaseRecord;
2005 const Odr_oid *oid = r->direct_reference;
2007 /* render bibliographic record .. */
2008 if (r->which == Z_External_OPAC)
2010 r = r->u.opac->bibliographicRecord;
2013 oid = r->direct_reference;
2015 if (r->which == Z_External_sutrs)
2016 return record_iconv_return(rec, len,
2017 (char*) r->u.sutrs->buf,
2020 else if (r->which == Z_External_octet)
2022 if (yaz_oid_is_iso2709(oid))
2024 const char *ret_buf = marc_iconv_return(
2025 rec, YAZ_MARC_LINE, len,
2026 (const char *) r->u.octet_aligned->buf,
2027 r->u.octet_aligned->len,
2032 return record_iconv_return(rec, len,
2033 (const char *) r->u.octet_aligned->buf,
2034 r->u.octet_aligned->len,
2037 else if (r->which == Z_External_grs1)
2039 if (!rec->wrbuf_marc)
2040 rec->wrbuf_marc = wrbuf_alloc();
2041 wrbuf_rewind(rec->wrbuf_marc);
2042 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
2043 return record_iconv_return(rec, len,
2044 wrbuf_buf(rec->wrbuf_marc),
2045 wrbuf_len(rec->wrbuf_marc),
2050 else if (!strcmp(type, "xml"))
2052 Z_External *r = (Z_External *) npr->u.databaseRecord;
2053 const Odr_oid *oid = r->direct_reference;
2055 /* render bibliographic record .. */
2056 if (r->which == Z_External_OPAC)
2058 r = r->u.opac->bibliographicRecord;
2061 oid = r->direct_reference;
2064 if (r->which == Z_External_sutrs)
2065 return record_iconv_return(rec, len,
2066 (const char *) r->u.sutrs->buf,
2069 else if (r->which == Z_External_octet)
2071 int marc_decode_type = YAZ_MARC_MARCXML;
2072 if (yaz_oid_is_iso2709(oid))
2074 const char *ret_buf = marc_iconv_return(
2075 rec, marc_decode_type, len,
2076 (const char *) r->u.octet_aligned->buf,
2077 r->u.octet_aligned->len,
2082 return record_iconv_return(rec, len,
2083 (const char *) r->u.octet_aligned->buf,
2084 r->u.octet_aligned->len,
2087 else if (r->which == Z_External_grs1)
2094 else if (!strcmp(type, "raw"))
2096 Z_External *r = (Z_External *) npr->u.databaseRecord;
2098 if (r->which == Z_External_sutrs)
2100 if (len) *len = r->u.sutrs->len;
2101 return (const char *) r->u.sutrs->buf;
2103 else if (r->which == Z_External_octet)
2105 if (len) *len = r->u.octet_aligned->len;
2106 return (const char *) r->u.octet_aligned->buf;
2108 else /* grs-1, explain, OPAC, ... */
2111 return (const char *) npr->u.databaseRecord;
2115 else if (!strcmp (type, "ext"))
2118 return (const char *) npr->u.databaseRecord;
2120 else if (!strcmp (type, "opac"))
2123 Z_External *r = (Z_External *) npr->u.databaseRecord;
2124 if (r->which == Z_External_OPAC)
2126 if (!rec->wrbuf_opac)
2127 rec->wrbuf_opac = wrbuf_alloc();
2128 wrbuf_rewind(rec->wrbuf_opac);
2129 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2130 return record_iconv_return(rec, len,
2131 wrbuf_buf(rec->wrbuf_opac),
2132 wrbuf_len(rec->wrbuf_opac),
2139 static int strcmp_null(const char *v1, const char *v2)
2145 return strcmp(v1, v2);
2148 static size_t record_hash(int pos)
2152 return pos % RECORD_HASH_SIZE;
2155 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2157 const char *syntax, const char *elementSetName)
2159 ZOOM_record_cache rc;
2161 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2162 ZOOM_connection_put_event(r->connection, event);
2164 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2168 if (strcmp_null(r->schema, rc->schema))
2170 if (strcmp_null(elementSetName,rc->elementSetName))
2172 if (strcmp_null(syntax, rc->syntax))
2174 /* not destroying rc->npr (it's handled by nmem )*/
2176 /* keeping wrbuf_marc too */
2180 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2183 rc->rec.wrbuf_marc = 0;
2184 rc->rec.wrbuf_iconv = 0;
2185 rc->rec.wrbuf_opac = 0;
2187 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2189 rc->elementSetName = 0;
2192 rc->syntax = odr_strdup(r->odr, syntax);
2197 rc->schema = odr_strdup(r->odr, r->schema);
2202 rc->next = r->record_hash[record_hash(pos)];
2203 r->record_hash[record_hash(pos)] = rc;
2206 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2208 const char *elementSetName)
2210 ZOOM_record_cache rc;
2212 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2216 if (strcmp_null(r->schema, rc->schema))
2218 if (strcmp_null(elementSetName,rc->elementSetName))
2220 if (strcmp_null(syntax, rc->syntax))
2228 static void handle_records(ZOOM_connection c, Z_Records *sr,
2231 ZOOM_resultset resultset;
2233 const char *syntax = 0, *elementSetName = 0;
2237 switch (c->tasks->which)
2239 case ZOOM_TASK_SEARCH:
2240 resultset = c->tasks->u.search.resultset;
2241 start = &c->tasks->u.search.start;
2242 count = &c->tasks->u.search.count;
2243 syntax = c->tasks->u.search.syntax;
2244 elementSetName = c->tasks->u.search.elementSetName;
2246 case ZOOM_TASK_RETRIEVE:
2247 resultset = c->tasks->u.retrieve.resultset;
2248 start = &c->tasks->u.retrieve.start;
2249 count = &c->tasks->u.retrieve.count;
2250 syntax = c->tasks->u.retrieve.syntax;
2251 elementSetName = c->tasks->u.retrieve.elementSetName;
2256 if (sr && sr->which == Z_Records_NSD)
2257 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2258 else if (sr && sr->which == Z_Records_multipleNSD)
2260 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2261 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2263 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2267 if (*count + *start > resultset->size)
2268 *count = resultset->size - *start;
2271 if (sr && sr->which == Z_Records_DBOSD)
2274 NMEM nmem = odr_extract_mem(c->odr_in);
2275 Z_NamePlusRecordList *p =
2276 sr->u.databaseOrSurDiagnostics;
2277 for (i = 0; i<p->num_records; i++)
2279 record_cache_add(resultset, p->records[i], i + *start,
2280 syntax, elementSetName);
2286 yaz_log(log_details,
2287 "handle_records resultset=%p start=%d count=%d",
2288 resultset, *start, *count);
2290 /* transfer our response to search_nmem .. we need it later */
2291 nmem_transfer(odr_getmem(resultset->odr), nmem);
2293 if (present_phase && p->num_records == 0)
2295 /* present response and we didn't get any records! */
2296 Z_NamePlusRecord *myrec =
2297 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2298 record_cache_add(resultset, myrec, *start,
2299 syntax, elementSetName);
2302 else if (present_phase)
2304 /* present response and we didn't get any records! */
2305 Z_NamePlusRecord *myrec =
2306 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2307 record_cache_add(resultset, myrec, *start, syntax, elementSetName);
2312 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2314 handle_records(c, pr->records, 1);
2317 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2320 switch (term->which)
2322 case Z_Term_general:
2323 ZOOM_options_setl(opt, name,
2324 (const char *)(term->u.general->buf),
2325 term->u.general->len);
2327 case Z_Term_characterString:
2328 ZOOM_options_set(opt, name, term->u.characterString);
2330 case Z_Term_numeric:
2331 ZOOM_options_set_int(opt, name, *term->u.numeric);
2336 static void handle_queryExpression(ZOOM_options opt, const char *name,
2337 Z_QueryExpression *exp)
2343 case Z_QueryExpression_term:
2344 if (exp->u.term && exp->u.term->queryTerm)
2346 sprintf(opt_name, "%s.term", name);
2347 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2350 case Z_QueryExpression_query:
2355 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2356 Z_OtherInformation *o)
2359 for (i = 0; o && i < o->num_elements; i++)
2361 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2363 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2365 if (ext->which == Z_External_searchResult1)
2368 Z_SearchInfoReport *sr = ext->u.searchResult1;
2371 ZOOM_options_set_int(
2372 resultset->options, "searchresult.size", sr->num);
2374 for (j = 0; j < sr->num; j++)
2376 Z_SearchInfoReport_s *ent =
2377 ext->u.searchResult1->elements[j];
2380 sprintf(pref, "searchresult.%d", j);
2382 if (ent->subqueryId)
2385 sprintf(opt_name, "%s.id", pref);
2386 ZOOM_options_set(resultset->options, opt_name,
2389 if (ent->subqueryExpression)
2392 sprintf(opt_name, "%s.subquery", pref);
2393 handle_queryExpression(resultset->options, opt_name,
2394 ent->subqueryExpression);
2396 if (ent->subqueryInterpretation)
2399 sprintf(opt_name, "%s.interpretation", pref);
2400 handle_queryExpression(resultset->options, opt_name,
2401 ent->subqueryInterpretation);
2403 if (ent->subqueryRecommendation)
2406 sprintf(opt_name, "%s.recommendation", pref);
2407 handle_queryExpression(resultset->options, opt_name,
2408 ent->subqueryRecommendation);
2410 if (ent->subqueryCount)
2413 sprintf(opt_name, "%s.count", pref);
2414 ZOOM_options_set_int(resultset->options, opt_name,
2415 *ent->subqueryCount);
2423 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2425 ZOOM_resultset resultset;
2428 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2431 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2432 ZOOM_connection_put_event(c, event);
2434 resultset = c->tasks->u.search.resultset;
2436 if (sr->resultSetStatus)
2438 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2439 *sr->resultSetStatus);
2441 if (sr->presentStatus)
2443 ZOOM_options_set_int(resultset->options, "presentStatus",
2444 *sr->presentStatus);
2446 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2448 resultset->size = *sr->resultCount;
2449 handle_records(c, sr->records, 0);
2452 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2454 if (res->diagnostics && res->num_diagnostics > 0)
2455 response_diag(c, res->diagnostics[0]);
2458 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2460 NMEM nmem = odr_extract_mem(c->odr_in);
2463 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2465 scan = c->tasks->u.scan.scan;
2467 if (res->entries && res->entries->nonsurrogateDiagnostics)
2468 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2469 scan->scan_response = res;
2470 nmem_transfer(odr_getmem(scan->odr), nmem);
2472 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2473 if (res->positionOfTerm)
2474 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2475 if (res->scanStatus)
2476 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2477 if (res->numberOfEntriesReturned)
2478 ZOOM_options_set_int(scan->options, "number",
2479 *res->numberOfEntriesReturned);
2484 static zoom_ret send_sort(ZOOM_connection c,
2485 ZOOM_resultset resultset)
2488 resultset->r_sort_spec = 0;
2489 if (resultset->r_sort_spec)
2491 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2492 Z_SortRequest *req = apdu->u.sortRequest;
2494 req->num_inputResultSetNames = 1;
2495 req->inputResultSetNames = (Z_InternationalString **)
2496 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2497 req->inputResultSetNames[0] =
2498 odr_strdup(c->odr_out, resultset->setname);
2499 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2500 req->sortSequence = resultset->r_sort_spec;
2501 resultset->r_sort_spec = 0;
2502 return send_APDU(c, apdu);
2504 return zoom_complete;
2507 static zoom_ret send_present(ZOOM_connection c)
2510 Z_PresentRequest *req = 0;
2512 const char *syntax = 0;
2513 const char *elementSetName = 0;
2514 ZOOM_resultset resultset;
2519 yaz_log(log_details, "%p send_present no tasks", c);
2520 return zoom_complete;
2523 switch (c->tasks->which)
2525 case ZOOM_TASK_SEARCH:
2526 resultset = c->tasks->u.search.resultset;
2527 start = &c->tasks->u.search.start;
2528 count = &c->tasks->u.search.count;
2529 syntax = c->tasks->u.search.syntax;
2530 elementSetName = c->tasks->u.search.elementSetName;
2532 case ZOOM_TASK_RETRIEVE:
2533 resultset = c->tasks->u.retrieve.resultset;
2534 start = &c->tasks->u.retrieve.start;
2535 count = &c->tasks->u.retrieve.count;
2536 syntax = c->tasks->u.retrieve.syntax;
2537 elementSetName = c->tasks->u.retrieve.elementSetName;
2540 return zoom_complete;
2542 yaz_log(log_details, "%p send_present start=%d count=%d",
2545 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2547 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2550 if (c->error) /* don't continue on error */
2551 return zoom_complete;
2552 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2553 resultset, *start, *count);
2555 for (i = 0; i < *count; i++)
2558 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2563 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2564 ZOOM_connection_put_event(c, event);
2572 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2573 return zoom_complete;
2576 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2577 req = apdu->u.presentRequest;
2580 yaz_log(log_details, "%p send_present skip=%d", c, i);
2582 *req->resultSetStartPoint = *start + 1;
2583 *req->numberOfRecordsRequested = resultset->step>0 ?
2584 resultset->step : *count;
2585 if (*req->numberOfRecordsRequested + *start > resultset->size)
2586 *req->numberOfRecordsRequested = resultset->size - *start;
2587 assert(*req->numberOfRecordsRequested > 0);
2589 if (syntax && *syntax)
2590 req->preferredRecordSyntax =
2591 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2593 if (resultset->schema && *resultset->schema)
2595 Z_RecordComposition *compo = (Z_RecordComposition *)
2596 odr_malloc(c->odr_out, sizeof(*compo));
2598 req->recordComposition = compo;
2599 compo->which = Z_RecordComp_complex;
2600 compo->u.complex = (Z_CompSpec *)
2601 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2602 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2603 odr_malloc(c->odr_out, sizeof(bool_t));
2604 *compo->u.complex->selectAlternativeSyntax = 0;
2606 compo->u.complex->generic = (Z_Specification *)
2607 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2609 compo->u.complex->generic->which = Z_Schema_oid;
2610 compo->u.complex->generic->schema.oid = (Odr_oid *)
2611 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2613 if (!compo->u.complex->generic->schema.oid)
2615 /* OID wasn't a schema! Try record syntax instead. */
2617 compo->u.complex->generic->schema.oid = (Odr_oid *)
2618 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2620 if (elementSetName && *elementSetName)
2622 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2623 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2624 compo->u.complex->generic->elementSpec->which =
2625 Z_ElementSpec_elementSetName;
2626 compo->u.complex->generic->elementSpec->u.elementSetName =
2627 odr_strdup(c->odr_out, elementSetName);
2630 compo->u.complex->generic->elementSpec = 0;
2631 compo->u.complex->num_dbSpecific = 0;
2632 compo->u.complex->dbSpecific = 0;
2633 compo->u.complex->num_recordSyntax = 0;
2634 compo->u.complex->recordSyntax = 0;
2636 else if (elementSetName && *elementSetName)
2638 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2639 odr_malloc(c->odr_out, sizeof(*esn));
2640 Z_RecordComposition *compo = (Z_RecordComposition *)
2641 odr_malloc(c->odr_out, sizeof(*compo));
2643 esn->which = Z_ElementSetNames_generic;
2644 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2645 compo->which = Z_RecordComp_simple;
2646 compo->u.simple = esn;
2647 req->recordComposition = compo;
2649 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2650 return send_APDU(c, apdu);
2653 ZOOM_API(ZOOM_scanset)
2654 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2657 ZOOM_query q = ZOOM_query_create();
2659 ZOOM_query_prefix(q, start);
2661 s = ZOOM_connection_scan1(c, q);
2662 ZOOM_query_destroy(q);
2667 ZOOM_API(ZOOM_scanset)
2668 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2672 ZOOM_scanset scan = 0;
2675 * We need to check the query-type, so we can recognise CQL and
2676 * CCL and compile them into a form that we can use here. The
2677 * ZOOM_query structure has no explicit `type' member, but
2678 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2679 * functions shows how the structure is set up in each case.
2683 else if (q->z_query->which == Z_Query_type_1)
2685 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2686 c, q, q->query_string);
2687 start = q->query_string;
2689 else if (q->z_query->which == Z_Query_type_104)
2691 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2692 c, q, q->query_string);
2693 start = freeme = cql2pqf(c, q->query_string);
2699 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2700 c, q, q->query_string);
2704 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2705 scan->connection = c;
2706 scan->odr = odr_createmem(ODR_DECODE);
2707 scan->options = ZOOM_options_create_with_parent(c->options);
2709 scan->scan_response = 0;
2710 scan->termListAndStartPoint =
2711 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2715 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
2718 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
2721 yaz_query_charset_convert_apt(scan->termListAndStartPoint,
2728 scan->databaseNames = set_DatabaseNames(c, c->options,
2729 &scan->num_databaseNames,
2731 if (scan->termListAndStartPoint != 0)
2733 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2734 task->u.scan.scan = scan;
2739 while (ZOOM_event(1, &c))
2747 ZOOM_scanset_destroy(ZOOM_scanset scan)
2752 if (scan->refcount == 0)
2754 odr_destroy(scan->odr);
2756 ZOOM_options_destroy(scan->options);
2761 static zoom_ret send_package(ZOOM_connection c)
2765 yaz_log(log_details, "%p send_package", c);
2767 return zoom_complete;
2768 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2770 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2771 ZOOM_connection_put_event(c, event);
2773 c->buf_out = c->tasks->u.package->buf_out;
2774 c->len_out = c->tasks->u.package->len_out;
2779 static zoom_ret send_scan(ZOOM_connection c)
2782 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2783 Z_ScanRequest *req = apdu->u.scanRequest;
2785 yaz_log(log_details, "%p send_scan", c);
2787 return zoom_complete;
2788 assert (c->tasks->which == ZOOM_TASK_SCAN);
2789 scan = c->tasks->u.scan.scan;
2791 req->termListAndStartPoint = scan->termListAndStartPoint;
2792 req->attributeSet = scan->attributeSet;
2794 *req->numberOfTermsRequested =
2795 ZOOM_options_get_int(scan->options, "number", 10);
2797 req->preferredPositionInResponse =
2798 odr_intdup(c->odr_out,
2799 ZOOM_options_get_int(scan->options, "position", 1));
2802 odr_intdup(c->odr_out,
2803 ZOOM_options_get_int(scan->options, "stepSize", 0));
2805 req->databaseNames = scan->databaseNames;
2806 req->num_databaseNames = scan->num_databaseNames;
2808 return send_APDU(c, apdu);
2812 ZOOM_scanset_size(ZOOM_scanset scan)
2814 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2816 return scan->scan_response->entries->num_entries;
2819 ZOOM_API(const char *)
2820 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2823 const char *term = 0;
2824 size_t noent = ZOOM_scanset_size(scan);
2825 Z_ScanResponse *res = scan->scan_response;
2831 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2833 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2835 if (t->term->which == Z_Term_general)
2837 term = (const char *) t->term->u.general->buf;
2838 *len = t->term->u.general->len;
2840 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2845 ZOOM_API(const char *)
2846 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2849 const char *term = 0;
2850 size_t noent = ZOOM_scanset_size(scan);
2851 Z_ScanResponse *res = scan->scan_response;
2857 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2859 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2863 term = t->displayTerm;
2864 *len = strlen(term);
2866 else if (t->term->which == Z_Term_general)
2868 term = (const char *) t->term->u.general->buf;
2869 *len = t->term->u.general->len;
2871 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2876 ZOOM_API(const char *)
2877 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2879 return ZOOM_options_get(scan->options, key);
2883 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2886 ZOOM_options_set(scan->options, key, val);
2889 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
2892 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2893 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2895 *req->function = Z_ExtendedServicesRequest_create;
2897 str = ZOOM_options_get(p->options, "package-name");
2899 req->packageName = odr_strdup(p->odr_out, str);
2901 str = ZOOM_options_get(p->options, "user-id");
2903 req->userId = odr_strdup(p->odr_out, str);
2905 req->packageType = odr_oiddup(p->odr_out, oid);
2907 str = ZOOM_options_get(p->options, "function");
2910 if (!strcmp (str, "create"))
2912 if (!strcmp (str, "delete"))
2914 if (!strcmp (str, "modify"))
2920 static const char *ill_array_lookup(void *clientData, const char *idx)
2922 ZOOM_package p = (ZOOM_package) clientData;
2923 return ZOOM_options_get(p->options, idx+4);
2926 static Z_External *encode_ill_request(ZOOM_package p)
2928 ODR out = p->odr_out;
2931 struct ill_get_ctl ctl;
2933 ctl.odr = p->odr_out;
2935 ctl.f = ill_array_lookup;
2937 req = ill_get_ILLRequest(&ctl, "ill", 0);
2939 if (!ill_Request(out, &req, 0, 0))
2941 int ill_request_size;
2942 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2943 if (ill_request_buf)
2944 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2949 int illRequest_size = 0;
2950 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2952 r = (Z_External *) odr_malloc(out, sizeof(*r));
2953 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
2954 r->indirect_reference = 0;
2956 r->which = Z_External_single;
2958 r->u.single_ASN1_type =
2959 odr_create_Odr_oct(out,
2960 (unsigned char *)illRequest_buf,
2966 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2968 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2971 req->which = Z_IOItemOrder_esRequest;
2972 req->u.esRequest = (Z_IORequest *)
2973 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2975 /* to keep part ... */
2976 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2977 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2978 req->u.esRequest->toKeep->supplDescription = 0;
2979 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2980 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2982 str = ZOOM_options_get(p->options, "contact-name");
2983 req->u.esRequest->toKeep->contact->name = str ?
2984 odr_strdup(p->odr_out, str) : 0;
2986 str = ZOOM_options_get(p->options, "contact-phone");
2987 req->u.esRequest->toKeep->contact->phone = str ?
2988 odr_strdup(p->odr_out, str) : 0;
2990 str = ZOOM_options_get(p->options, "contact-email");
2991 req->u.esRequest->toKeep->contact->email = str ?
2992 odr_strdup(p->odr_out, str) : 0;
2994 req->u.esRequest->toKeep->addlBilling = 0;
2996 /* not to keep part ... */
2997 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2998 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3000 str = ZOOM_options_get(p->options, "itemorder-setname");
3005 req->u.esRequest->notToKeep->resultSetItem = 0;
3008 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3009 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3011 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3012 odr_strdup(p->odr_out, str);
3013 req->u.esRequest->notToKeep->resultSetItem->item =
3014 (int *) odr_malloc(p->odr_out, sizeof(int));
3016 str = ZOOM_options_get(p->options, "itemorder-item");
3017 *req->u.esRequest->notToKeep->resultSetItem->item =
3018 (str ? atoi(str) : 1);
3021 str = ZOOM_options_get(p->options, "doc");
3024 req->u.esRequest->notToKeep->itemRequest =
3025 z_ext_record_xml(p->odr_out, str, strlen(str));
3028 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3033 Z_APDU *create_admin_package(ZOOM_package p, int type,
3034 Z_ESAdminOriginPartToKeep **toKeepP,
3035 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3037 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3040 Z_ESAdminOriginPartToKeep *toKeep;
3041 Z_ESAdminOriginPartNotToKeep *notToKeep;
3042 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3043 const char *first_db = "Default";
3045 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3050 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3052 r->indirect_reference = 0;
3053 r->which = Z_External_ESAdmin;
3055 r->u.adminService = (Z_Admin *)
3056 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3057 r->u.adminService->which = Z_Admin_esRequest;
3058 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3059 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3061 toKeep = r->u.adminService->u.esRequest->toKeep =
3062 (Z_ESAdminOriginPartToKeep *)
3063 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3064 toKeep->which = type;
3065 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3066 toKeep->u.create = odr_nullval();
3067 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3069 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3070 (Z_ESAdminOriginPartNotToKeep *)
3071 odr_malloc(p->odr_out,
3072 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3073 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3074 notToKeep->u.recordsWillFollow = odr_nullval();
3078 *notToKeepP = notToKeep;
3083 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3085 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3086 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3087 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3088 const char *doc = ZOOM_options_get(p->options, "doc");
3093 req->taskSpecificParameters = ext;
3094 ext->direct_reference = req->packageType;
3095 ext->descriptor = 0;
3096 ext->indirect_reference = 0;
3098 ext->which = Z_External_octet;
3099 ext->u.single_ASN1_type =
3100 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
3105 static Z_APDU *create_update_package(ZOOM_package p)
3108 const char *first_db = "Default";
3110 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3111 const char *action = ZOOM_options_get(p->options, "action");
3112 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
3113 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3114 const char *record_buf = ZOOM_options_get(p->options, "record");
3115 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3117 const char *correlationInfo_note =
3118 ZOOM_options_get(p->options, "correlationInfo.note");
3119 const char *correlationInfo_id =
3120 ZOOM_options_get(p->options, "correlationInfo.id");
3122 Odr_oid *syntax_oid = 0;
3128 record_buf = "void";
3129 syntax_str = "SUTRS";
3134 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3135 CLASS_RECSYN, syntax_str,
3145 action = "specialUpdate";
3147 if (!strcmp(action, "recordInsert"))
3148 action_no = Z_IUOriginPartToKeep_recordInsert;
3149 else if (!strcmp(action, "recordReplace"))
3150 action_no = Z_IUOriginPartToKeep_recordReplace;
3151 else if (!strcmp(action, "recordDelete"))
3152 action_no = Z_IUOriginPartToKeep_recordDelete;
3153 else if (!strcmp(action, "elementUpdate"))
3154 action_no = Z_IUOriginPartToKeep_elementUpdate;
3155 else if (!strcmp(action, "specialUpdate"))
3156 action_no = Z_IUOriginPartToKeep_specialUpdate;
3160 apdu = create_es_package(p, yaz_oid_extserv_database_update);
3163 Z_IUOriginPartToKeep *toKeep;
3164 Z_IUSuppliedRecords *notToKeep;
3165 Z_External *r = (Z_External *)
3166 odr_malloc(p->odr_out, sizeof(*r));
3168 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3171 r->direct_reference = odr_oiddup(p->odr_out,
3172 yaz_oid_extserv_database_update);
3174 r->which = Z_External_update;
3175 r->indirect_reference = 0;
3176 r->u.update = (Z_IUUpdate *)
3177 odr_malloc(p->odr_out, sizeof(*r->u.update));
3179 r->u.update->which = Z_IUUpdate_esRequest;
3180 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3181 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3182 toKeep = r->u.update->u.esRequest->toKeep =
3183 (Z_IUOriginPartToKeep *)
3184 odr_malloc(p->odr_out, sizeof(*toKeep));
3186 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3188 toKeep->elementSetName = 0;
3189 toKeep->actionQualifier = 0;
3190 toKeep->action = odr_intdup(p->odr_out, action_no);
3192 notToKeep = r->u.update->u.esRequest->notToKeep =
3193 (Z_IUSuppliedRecords *)
3194 odr_malloc(p->odr_out, sizeof(*notToKeep));
3196 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3197 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3198 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3199 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3200 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3203 notToKeep->elements[0]->u.opaque =
3204 odr_create_Odr_oct(p->odr_out,
3205 (const unsigned char *) recordIdOpaque,
3206 strlen(recordIdOpaque));
3208 else if (recordIdNumber)
3210 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3212 notToKeep->elements[0]->u.number =
3213 odr_intdup(p->odr_out, atoi(recordIdNumber));
3216 notToKeep->elements[0]->u.opaque = 0;
3217 notToKeep->elements[0]->supplementalId = 0;
3218 if (correlationInfo_note || correlationInfo_id)
3220 Z_IUCorrelationInfo *ci;
3221 ci = notToKeep->elements[0]->correlationInfo =
3222 odr_malloc(p->odr_out, sizeof(*ci));
3223 ci->note = correlationInfo_note ?
3224 odr_strdup(p->odr_out, correlationInfo_note) : 0;
3225 ci->id = correlationInfo_id ?
3226 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3229 notToKeep->elements[0]->correlationInfo = 0;
3230 notToKeep->elements[0]->record =
3231 z_ext_record_oid(p->odr_out, syntax_oid,
3232 record_buf, strlen(record_buf));
3236 ODR print = odr_createmem(ODR_PRINT);
3238 z_APDU(print, &apdu, 0, 0);
3245 ZOOM_package_send(ZOOM_package p, const char *type)
3252 odr_reset(p->odr_out);
3255 if (!strcmp(type, "itemorder"))
3257 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3260 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3262 r->direct_reference =
3263 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3265 r->which = Z_External_itemOrder;
3266 r->indirect_reference = 0;
3267 r->u.itemOrder = encode_item_order(p);
3269 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3272 else if (!strcmp(type, "create")) /* create database */
3274 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3277 else if (!strcmp(type, "drop")) /* drop database */
3279 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3282 else if (!strcmp(type, "commit")) /* commit changes */
3284 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3287 else if (!strcmp(type, "update")) /* update record(s) */
3289 apdu = create_update_package(p);
3291 else if (!strcmp(type, "xmlupdate"))
3293 apdu = create_xmlupdate_package(p);
3297 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3301 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3302 task->u.package = p;
3303 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3304 p->buf_out = (char *) xmalloc(p->len_out);
3305 memcpy(p->buf_out, buf, p->len_out);
3310 while (ZOOM_event(1, &c))
3317 ZOOM_API(ZOOM_package)
3318 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3320 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3323 p->odr_out = odr_createmem(ODR_ENCODE);
3324 p->options = ZOOM_options_create_with_parent2(options, c->options);
3332 ZOOM_package_destroy(ZOOM_package p)
3337 if (p->refcount == 0)
3339 odr_destroy(p->odr_out);
3342 ZOOM_options_destroy(p->options);
3347 ZOOM_API(const char *)
3348 ZOOM_package_option_get(ZOOM_package p, const char *key)
3350 return ZOOM_options_get(p->options, key);
3355 ZOOM_package_option_set(ZOOM_package p, const char *key,
3358 ZOOM_options_set(p->options, key, val);
3361 static int ZOOM_connection_exec_task(ZOOM_connection c)
3363 ZOOM_task task = c->tasks;
3364 zoom_ret ret = zoom_complete;
3368 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3369 c, task->which, task->running);
3370 if (c->error != ZOOM_ERROR_NONE)
3372 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3373 "removing tasks because of error = %d", c, c->error);
3374 ZOOM_connection_remove_tasks(c);
3379 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3380 "task already running", c);
3384 ret = zoom_complete;
3385 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3387 switch (task->which)
3389 case ZOOM_TASK_SEARCH:
3390 if (c->proto == PROTO_HTTP)
3391 ret = ZOOM_connection_srw_send_search(c);
3393 ret = ZOOM_connection_send_search(c);
3395 case ZOOM_TASK_RETRIEVE:
3396 if (c->proto == PROTO_HTTP)
3397 ret = ZOOM_connection_srw_send_search(c);
3399 ret = send_present(c);
3401 case ZOOM_TASK_CONNECT:
3402 ret = do_connect(c);
3404 case ZOOM_TASK_SCAN:
3407 case ZOOM_TASK_PACKAGE:
3408 ret = send_package(c);
3410 case ZOOM_TASK_SORT:
3411 c->tasks->u.sort.resultset->r_sort_spec =
3412 c->tasks->u.sort.q->sort_spec;
3413 ret = send_sort(c, c->tasks->u.sort.resultset);
3419 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3420 "remove tasks because no connection exist", c);
3421 ZOOM_connection_remove_tasks(c);
3423 if (ret == zoom_complete)
3425 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3426 "task removed (complete)", c);
3427 ZOOM_connection_remove_task(c);
3430 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3435 static zoom_ret send_sort_present(ZOOM_connection c)
3437 zoom_ret r = zoom_complete;
3439 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3440 r = send_sort(c, c->tasks->u.search.resultset);
3441 if (r == zoom_complete)
3442 r = send_present(c);
3446 static int es_response(ZOOM_connection c,
3447 Z_ExtendedServicesResponse *res)
3449 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3451 if (res->diagnostics && res->num_diagnostics > 0)
3452 response_diag(c, res->diagnostics[0]);
3453 if (res->taskPackage &&
3454 res->taskPackage->which == Z_External_extendedService)
3456 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3457 Odr_oct *id = taskPackage->targetReference;
3460 ZOOM_options_setl(c->tasks->u.package->options,
3461 "targetReference", (char*) id->buf, id->len);
3463 if (res->taskPackage &&
3464 res->taskPackage->which == Z_External_octet)
3466 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3467 ZOOM_options_setl(c->tasks->u.package->options,
3468 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3473 static void interpret_init_diag(ZOOM_connection c,
3474 Z_DiagnosticFormat *diag)
3478 Z_DiagnosticFormat_s *ds = diag->elements[0];
3479 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3480 response_default_diag(c, ds->u.defaultDiagRec);
3485 static void interpret_otherinformation_field(ZOOM_connection c,
3486 Z_OtherInformation *ui)
3489 for (i = 0; i < ui->num_elements; i++)
3491 Z_OtherInformationUnit *unit = ui->list[i];
3492 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3493 unit->information.externallyDefinedInfo &&
3494 unit->information.externallyDefinedInfo->which ==
3497 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3503 static void set_init_option(const char *name, void *clientData) {
3504 ZOOM_connection c = (ZOOM_connection) clientData;
3507 sprintf(buf, "init_opt_%.70s", name);
3508 ZOOM_connection_option_set(c, buf, "1");
3512 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3514 Z_InitResponse *initrs;
3516 ZOOM_connection_set_mask(c, 0);
3517 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3520 case Z_APDU_initResponse:
3521 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3522 initrs = apdu->u.initResponse;
3523 ZOOM_connection_option_set(c, "serverImplementationId",
3524 initrs->implementationId ?
3525 initrs->implementationId : "");
3526 ZOOM_connection_option_set(c, "serverImplementationName",
3527 initrs->implementationName ?
3528 initrs->implementationName : "");
3529 ZOOM_connection_option_set(c, "serverImplementationVersion",
3530 initrs->implementationVersion ?
3531 initrs->implementationVersion : "");
3532 /* Set the three old options too, for old applications */
3533 ZOOM_connection_option_set(c, "targetImplementationId",
3534 initrs->implementationId ?
3535 initrs->implementationId : "");
3536 ZOOM_connection_option_set(c, "targetImplementationName",
3537 initrs->implementationName ?
3538 initrs->implementationName : "");
3539 ZOOM_connection_option_set(c, "targetImplementationVersion",
3540 initrs->implementationVersion ?
3541 initrs->implementationVersion : "");
3543 /* Make initrs->options available as ZOOM-level options */
3544 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3546 if (!*initrs->result)
3548 Z_External *uif = initrs->userInformationField;
3550 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3552 if (uif && uif->which == Z_External_userInfo1)
3553 interpret_otherinformation_field(c, uif->u.userInfo1);
3558 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
3559 yaz_oid_userinfo_cookie, 1, 0);
3560 xfree(c->cookie_in);
3563 c->cookie_in = xstrdup(cookie);
3564 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3565 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3566 c->support_named_resultsets = 1;
3569 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3570 ZOOM_connection_remove_task(c);
3572 ZOOM_connection_exec_task(c);
3574 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3576 NMEM tmpmem = nmem_create();
3577 Z_CharSetandLanguageNegotiation *p =
3578 yaz_get_charneg_record(initrs->otherInfo);
3582 char *charset = NULL, *lang = NULL;
3585 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3586 yaz_log(log_details, "%p recv_apdu target accepted: "
3587 "charset %s, language %s, select %d",
3589 charset ? charset : "none", lang ? lang : "none", sel);
3591 ZOOM_connection_option_set(c, "negotiation-charset",
3594 ZOOM_connection_option_set(c, "negotiation-lang",
3597 ZOOM_connection_option_set(
3598 c, "negotiation-charset-in-effect-for-records",
3599 (sel != 0) ? "1" : "0");
3600 nmem_destroy(tmpmem);
3604 case Z_APDU_searchResponse:
3605 yaz_log(log_api, "%p recv_apdu Search response", c);
3606 handle_search_response(c, apdu->u.searchResponse);
3607 if (send_sort_present(c) == zoom_complete)
3608 ZOOM_connection_remove_task(c);
3610 case Z_APDU_presentResponse:
3611 yaz_log(log_api, "%p recv_apdu Present response", c);
3612 handle_present_response(c, apdu->u.presentResponse);
3613 if (send_present(c) == zoom_complete)
3614 ZOOM_connection_remove_task(c);
3616 case Z_APDU_sortResponse:
3617 yaz_log(log_api, "%p recv_apdu Sort response", c);
3618 sort_response(c, apdu->u.sortResponse);
3619 if (send_present(c) == zoom_complete)
3620 ZOOM_connection_remove_task(c);
3622 case Z_APDU_scanResponse:
3623 yaz_log(log_api, "%p recv_apdu Scan response", c);
3624 scan_response(c, apdu->u.scanResponse);
3625 ZOOM_connection_remove_task(c);
3627 case Z_APDU_extendedServicesResponse:
3628 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3629 es_response(c, apdu->u.extendedServicesResponse);
3630 ZOOM_connection_remove_task(c);
3633 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3634 if (!ZOOM_test_reconnect(c))
3636 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3641 yaz_log(log_api, "%p Received unknown PDU", c);
3642 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3648 static void handle_srw_response(ZOOM_connection c,
3649 Z_SRW_searchRetrieveResponse *res)
3651 ZOOM_resultset resultset = 0;
3656 const char *syntax, *elementSetName;
3661 switch(c->tasks->which)
3663 case ZOOM_TASK_SEARCH:
3664 resultset = c->tasks->u.search.resultset;
3665 start = &c->tasks->u.search.start;
3666 syntax = c->tasks->u.search.syntax;
3667 elementSetName = c->tasks->u.search.elementSetName;
3669 case ZOOM_TASK_RETRIEVE:
3670 resultset = c->tasks->u.retrieve.resultset;
3671 start = &c->tasks->u.retrieve.start;
3672 syntax = c->tasks->u.retrieve.syntax;
3673 elementSetName = c->tasks->u.retrieve.elementSetName;
3678 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3679 ZOOM_connection_put_event(c, event);
3681 resultset->size = 0;
3683 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3685 if (res->numberOfRecords)
3686 resultset->size = *res->numberOfRecords;
3688 for (i = 0; i<res->num_records; i++)
3692 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3693 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3695 if (res->records[i].recordPosition &&
3696 *res->records[i].recordPosition > 0)
3697 pos = *res->records[i].recordPosition - 1;
3701 npr->databaseName = 0;
3702 npr->which = Z_NamePlusRecord_databaseRecord;
3703 npr->u.databaseRecord = (Z_External *)
3704 odr_malloc(c->odr_in, sizeof(Z_External));
3705 npr->u.databaseRecord->descriptor = 0;
3706 npr->u.databaseRecord->direct_reference =
3707 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
3708 npr->u.databaseRecord->which = Z_External_octet;
3710 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3711 odr_malloc(c->odr_in, sizeof(Odr_oct));
3712 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3713 res->records[i].recordData_buf;
3714 npr->u.databaseRecord->u.octet_aligned->len =
3715 npr->u.databaseRecord->u.octet_aligned->size =
3716 res->records[i].recordData_len;
3717 record_cache_add(resultset, npr, pos, syntax, elementSetName);
3719 if (res->num_diagnostics > 0)
3721 const char *uri = res->diagnostics[0].uri;
3726 if ((cp = strrchr(uri, '/')))
3728 set_dset_error(c, code, uri,
3729 res->diagnostics[0].details, 0);
3732 nmem = odr_extract_mem(c->odr_in);
3733 nmem_transfer(odr_getmem(resultset->odr), nmem);
3739 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3742 const char *addinfo = 0;
3743 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3745 ZOOM_connection_set_mask(c, 0);
3746 yaz_log(log_details, "%p handle_http", c);
3748 if (!yaz_srw_check_content_type(hres))
3749 addinfo = "content-type";
3752 Z_SOAP *soap_package = 0;
3754 Z_SOAP_Handler soap_handlers[2] = {
3755 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
3758 ret = z_soap_codec(o, &soap_package,
3759 &hres->content_buf, &hres->content_len,
3761 if (!ret && soap_package->which == Z_SOAP_generic &&
3762 soap_package->u.generic->no == 0)
3764 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3765 if (sr->which == Z_SRW_searchRetrieve_response)
3766 handle_srw_response(c, sr->u.response);
3770 else if (!ret && (soap_package->which == Z_SOAP_fault
3771 || soap_package->which == Z_SOAP_error))
3773 set_HTTP_error(c, hres->code,
3774 soap_package->u.fault->fault_code,
3775 soap_package->u.fault->fault_string);
3782 if (hres->code != 200)
3783 set_HTTP_error(c, hres->code, 0, 0);
3785 set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
3788 ZOOM_connection_remove_task(c);
3789 if (!strcmp(hres->version, "1.0"))
3791 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3792 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3797 /* HTTP 1.1: only if no close we stay alive .. */
3798 if (connection_head && !strcmp(connection_head, "close"))
3804 static int do_read(ZOOM_connection c)
3809 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3810 ZOOM_connection_put_event(c, event);
3812 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3813 more = cs_more(c->cs);
3814 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3819 if (!ZOOM_test_reconnect(c))
3821 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3830 odr_reset(c->odr_in);
3831 odr_setbuf(c->odr_in, c->buf_in, r, 0);
3832 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3833 ZOOM_connection_put_event(c, event);
3835 if (!z_GDU(c->odr_in, &gdu, 0, 0))
3838 int err = odr_geterrorx(c->odr_in, &x);
3840 const char *element = odr_getelement(c->odr_in);
3841 sprintf(msg, "ODR code %d:%d element=%-20s",
3842 err, x, element ? element : "<unknown>");
3843 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3846 else if (gdu->which == Z_GDU_Z3950)
3847 recv_apdu(c, gdu->u.z3950);
3848 else if (gdu->which == Z_GDU_HTTP_Response)
3851 handle_http(c, gdu->u.HTTP_Response);
3853 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3857 c->reconnect_ok = 0;
3862 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3867 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3868 ZOOM_connection_put_event(c, event);
3870 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3871 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3873 yaz_log(log_details, "%p do_write_ex write failed", c);
3874 if (ZOOM_test_reconnect(c))
3876 return zoom_pending;
3878 if (c->state == STATE_CONNECTING)
3879 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3881 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3883 return zoom_complete;
3887 int mask = ZOOM_SELECT_EXCEPT;
3888 if (c->cs->io_pending & CS_WANT_WRITE)
3889 mask += ZOOM_SELECT_WRITE;
3890 if (c->cs->io_pending & CS_WANT_READ)
3891 mask += ZOOM_SELECT_READ;
3892 ZOOM_connection_set_mask(c, mask);
3893 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3898 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
3899 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3902 return zoom_pending;
3905 static zoom_ret do_write(ZOOM_connection c)
3907 return do_write_ex(c, c->buf_out, c->len_out);
3911 ZOOM_API(const char *)
3912 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3914 return ZOOM_options_get(c->options, key);
3917 ZOOM_API(const char *)
3918 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3920 return ZOOM_options_getl(c->options, key, lenp);
3924 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3927 ZOOM_options_set(c->options, key, val);
3931 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3932 const char *val, int len)
3934 ZOOM_options_setl(c->options, key, val, len);
3937 ZOOM_API(const char *)
3938 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3940 return ZOOM_options_get(r->options, key);
3944 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3947 ZOOM_options_set(r->options, key, val);
3952 ZOOM_connection_errcode(ZOOM_connection c)
3954 return ZOOM_connection_error(c, 0, 0);
3957 ZOOM_API(const char *)
3958 ZOOM_connection_errmsg(ZOOM_connection c)
3961 ZOOM_connection_error(c, &msg, 0);
3965 ZOOM_API(const char *)
3966 ZOOM_connection_addinfo(ZOOM_connection c)
3968 const char *addinfo;
3969 ZOOM_connection_error(c, 0, &addinfo);
3973 ZOOM_API(const char *)
3974 ZOOM_connection_diagset(ZOOM_connection c)
3976 const char *diagset;
3977 ZOOM_connection_error_x(c, 0, 0, &diagset);
3981 ZOOM_API(const char *)
3982 ZOOM_diag_str(int error)
3986 case ZOOM_ERROR_NONE:
3988 case ZOOM_ERROR_CONNECT:
3989 return "Connect failed";
3990 case ZOOM_ERROR_MEMORY:
3991 return "Out of memory";
3992 case ZOOM_ERROR_ENCODE:
3993 return "Encoding failed";
3994 case ZOOM_ERROR_DECODE:
3995 return "Decoding failed";
3996 case ZOOM_ERROR_CONNECTION_LOST:
3997 return "Connection lost";
3998 case ZOOM_ERROR_INIT:
3999 return "Init rejected";
4000 case ZOOM_ERROR_INTERNAL:
4001 return "Internal failure";
4002 case ZOOM_ERROR_TIMEOUT:
4004 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4005 return "Unsupported protocol";
4006 case ZOOM_ERROR_UNSUPPORTED_QUERY:
4007 return "Unsupported query type";
4008 case ZOOM_ERROR_INVALID_QUERY:
4009 return "Invalid query";
4010 case ZOOM_ERROR_CQL_PARSE:
4011 return "CQL parsing error";
4012 case ZOOM_ERROR_CQL_TRANSFORM:
4013 return "CQL transformation error";
4014 case ZOOM_ERROR_CCL_CONFIG:
4015 return "CCL configuration error";
4016 case ZOOM_ERROR_CCL_PARSE:
4017 return "CCL parsing error";
4019 return diagbib1_str(error);
4024 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4025 const char **addinfo, const char **diagset)
4027 int error = c->error;
4030 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4031 *cp = ZOOM_diag_str(error);
4032 else if (!strcmp(c->diagset, "HTTP"))
4033 *cp = z_HTTP_errmsg(c->error);
4034 else if (!strcmp(c->diagset, "Bib-1"))
4035 *cp = ZOOM_diag_str(error);
4036 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4037 *cp = yaz_diag_srw_str(c->error);
4039 *cp = "Unknown error and diagnostic set";
4042 *addinfo = c->addinfo ? c->addinfo : "";
4044 *diagset = c->diagset ? c->diagset : "";
4049 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4050 const char **addinfo)
4052 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4055 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4057 ZOOM_Event event = 0;
4058 int r = cs_look(c->cs);
4059 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4064 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4065 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4067 ZOOM_connection_put_event(c, event);
4069 else if (r == CS_CONNECT)
4071 int ret = ret = cs_rcvconnect(c->cs);
4072 yaz_log(log_details, "%p ZOOM_connection_do_io "
4073 "cs_rcvconnect returned %d", c, ret);
4076 int mask = ZOOM_SELECT_EXCEPT;
4077 if (c->cs->io_pending & CS_WANT_WRITE)
4078 mask += ZOOM_SELECT_WRITE;
4079 if (c->cs->io_pending & CS_WANT_READ)
4080 mask += ZOOM_SELECT_READ;
4081 ZOOM_connection_set_mask(c, mask);
4085 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4086 ZOOM_connection_put_event(c, event);
4088 if (c->proto == PROTO_Z3950)
4089 ZOOM_connection_send_init(c);
4092 /* no init request for SRW .. */
4093 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4094 ZOOM_connection_remove_task(c);
4095 ZOOM_connection_set_mask(c, 0);
4096 ZOOM_connection_exec_task(c);
4098 c->state = STATE_ESTABLISHED;
4102 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4108 if (mask & ZOOM_SELECT_EXCEPT)
4110 if (!ZOOM_test_reconnect(c))
4112 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4117 if (mask & ZOOM_SELECT_READ)
4119 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4125 ZOOM_connection_last_event(ZOOM_connection cs)
4128 return ZOOM_EVENT_NONE;
4129 return cs->last_event;
4133 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4135 WRBUF wrbuf = (WRBUF) client_data;
4136 wrbuf_puts(wrbuf, buf);
4140 * Returns an xmalloc()d string containing RPN that corresponds to the
4141 * CQL passed in. On error, sets the Connection object's error state
4142 * and returns a null pointer.
4143 * ### We could cache CQL parser and/or transformer in Connection.
4145 static char *cql2pqf(ZOOM_connection c, const char *cql)
4149 const char *cqlfile;
4150 cql_transform_t trans;
4153 parser = cql_parser_create();
4154 if ((error = cql_parser_string(parser, cql)) != 0) {
4155 cql_parser_destroy(parser);
4156 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4160 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4163 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4165 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4168 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4169 cqlfile, strerror(errno));
4170 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4174 WRBUF wrbuf_result = wrbuf_alloc();
4175 error = cql_transform(trans, cql_parser_result(parser),
4176 cql2pqf_wrbuf_puts, wrbuf_result);
4179 const char *addinfo;
4180 error = cql_transform_error(trans, &addinfo);
4181 sprintf(buf, "%.200s (addinfo=%.200s)",
4182 cql_strerror(error), addinfo);
4183 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4187 result = xstrdup(wrbuf_cstr(wrbuf_result));
4189 cql_transform_close(trans);
4190 wrbuf_destroy(wrbuf_result);
4192 cql_parser_destroy(parser);
4196 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4200 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4201 /* timeout and this connection was waiting */
4202 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4204 ZOOM_connection_put_event(c, event);
4210 ZOOM_connection_process(ZOOM_connection c)
4216 event = ZOOM_connection_get_event(c);
4219 ZOOM_Event_destroy(event);
4222 ZOOM_connection_exec_task(c);
4223 event = ZOOM_connection_get_event(c);
4226 ZOOM_Event_destroy(event);
4233 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4237 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4239 for (i = 0; i<no; i++)
4241 ZOOM_connection c = cs[i];
4243 if (c && ZOOM_connection_process(c))
4249 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4251 if (c->mask && mask)
4252 ZOOM_connection_do_io(c, mask);
4256 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4259 return cs_fileno(c->cs);
4263 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4271 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4278 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4280 return ZOOM_options_get_int(c->options, "timeout", 30);
4286 * indent-tabs-mode: nil
4288 * vim: shiftwidth=4 tabstop=8 expandtab