2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.139 2007-07-04 11:42:14 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>
31 #include <yaz/snprintf.h>
33 static int log_api = 0;
34 static int log_details = 0;
41 static void resultset_destroy(ZOOM_resultset r);
42 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
43 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
44 static char *cql2pqf(ZOOM_connection c, const char *cql);
48 * This wrapper is just for logging failed lookups. It would be nicer
49 * if it could cause failure when a lookup fails, but that's hard.
51 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
52 int oid_class, const char *str) {
53 Odr_oid *res = yaz_string_to_oid_odr(yaz_oid_std(), oid_class, str,
56 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
57 c, (int) oid_class, str);
62 static void initlog(void)
64 static int log_level_initialized = 0;
65 if (!log_level_initialized)
67 log_api = yaz_log_module_level("zoom");
68 log_details = yaz_log_module_level("zoomdetails");
69 log_level_initialized = 1;
73 static ZOOM_Event ZOOM_Event_create(int kind)
75 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
79 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
83 static void ZOOM_Event_destroy(ZOOM_Event event)
88 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
92 c->m_queue_back->prev = event;
93 assert(c->m_queue_front);
97 assert(!c->m_queue_front);
98 c->m_queue_front = event;
100 event->next = c->m_queue_back;
102 c->m_queue_back = event;
105 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
107 ZOOM_Event event = c->m_queue_front;
110 c->last_event = ZOOM_EVENT_NONE;
113 assert(c->m_queue_back);
114 c->m_queue_front = event->prev;
115 if (c->m_queue_front)
117 assert(c->m_queue_back);
118 c->m_queue_front->next = 0;
122 c->last_event = event->kind;
126 static void ZOOM_connection_remove_events(ZOOM_connection c)
129 while ((event = ZOOM_connection_get_event(c)))
130 ZOOM_Event_destroy(event);
133 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
135 ZOOM_Event event = c->m_queue_front;
137 return event ? event->kind : ZOOM_EVENT_NONE;
140 void ZOOM_connection_remove_tasks(ZOOM_connection c);
142 static void set_dset_error(ZOOM_connection c, int error,
144 const char *addinfo, const char *addinfo2)
151 if (!c->diagset || strcmp(dset, c->diagset))
154 c->diagset = xstrdup(dset);
155 /* remove integer part from SRW diagset .. */
156 if ((cp = strrchr(c->diagset, '/')))
159 if (addinfo && addinfo2)
161 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
162 strcpy(c->addinfo, addinfo);
163 strcat(c->addinfo, addinfo2);
166 c->addinfo = xstrdup(addinfo);
167 if (error != ZOOM_ERROR_NONE)
169 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
170 c, c->host_port ? c->host_port : "<>", dset, error,
171 addinfo ? addinfo : "",
172 addinfo2 ? addinfo2 : "");
173 ZOOM_connection_remove_tasks(c);
178 static void set_HTTP_error(ZOOM_connection c, int error,
179 const char *addinfo, const char *addinfo2)
181 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
186 static void set_ZOOM_error(ZOOM_connection c, int error,
189 set_dset_error(c, error, "ZOOM", addinfo, 0);
192 static void clear_error(ZOOM_connection c)
195 * If an error is tied to an operation then it's ok to clear: for
196 * example, a diagnostic returned from a search is cleared by a
197 * subsequent search. However, problems such as Connection Lost
198 * or Init Refused are not cleared, because they are not
199 * recoverable: doing another search doesn't help.
202 ZOOM_connection_remove_events(c);
205 case ZOOM_ERROR_CONNECT:
206 case ZOOM_ERROR_MEMORY:
207 case ZOOM_ERROR_DECODE:
208 case ZOOM_ERROR_CONNECTION_LOST:
209 case ZOOM_ERROR_INIT:
210 case ZOOM_ERROR_INTERNAL:
211 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
214 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
218 void ZOOM_connection_show_task(ZOOM_task task)
222 case ZOOM_TASK_SEARCH:
223 yaz_log(YLOG_LOG, "search p=%p", task);
225 case ZOOM_TASK_RETRIEVE:
226 yaz_log(YLOG_LOG, "retrieve p=%p", task);
228 case ZOOM_TASK_CONNECT:
229 yaz_log(YLOG_LOG, "connect p=%p", task);
232 yaz_log(YLOG_LOG, "scant p=%p", task);
237 void ZOOM_connection_show_tasks(ZOOM_connection c)
240 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
241 for (task = c->tasks; task; task = task->next)
242 ZOOM_connection_show_task(task);
245 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
247 ZOOM_task *taskp = &c->tasks;
249 taskp = &(*taskp)->next;
250 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
251 (*taskp)->running = 0;
252 (*taskp)->which = which;
258 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
260 return c->tasks ? 0 : 1;
263 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
265 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
267 task->next = c->tasks;
276 void ZOOM_connection_remove_task(ZOOM_connection c)
278 ZOOM_task task = c->tasks;
282 c->tasks = task->next;
285 case ZOOM_TASK_SEARCH:
286 resultset_destroy(task->u.search.resultset);
287 xfree(task->u.search.syntax);
288 xfree(task->u.search.elementSetName);
290 case ZOOM_TASK_RETRIEVE:
291 resultset_destroy(task->u.retrieve.resultset);
292 xfree(task->u.retrieve.syntax);
293 xfree(task->u.retrieve.elementSetName);
295 case ZOOM_TASK_CONNECT:
298 ZOOM_scanset_destroy(task->u.scan.scan);
300 case ZOOM_TASK_PACKAGE:
301 ZOOM_package_destroy(task->u.package);
304 resultset_destroy(task->u.sort.resultset);
305 ZOOM_query_destroy(task->u.sort.q);
314 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
315 ZOOM_connection_put_event(c, event);
320 static int ZOOM_connection_exec_task(ZOOM_connection c);
322 void ZOOM_connection_remove_tasks(ZOOM_connection c)
325 ZOOM_connection_remove_task(c);
328 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
330 const char *elementSetName);
332 ZOOM_API(ZOOM_connection)
333 ZOOM_connection_create(ZOOM_options options)
335 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
339 yaz_log(log_api, "%p ZOOM_connection_create", c);
341 c->proto = PROTO_Z3950;
343 ZOOM_connection_set_mask(c, 0);
345 c->state = STATE_IDLE;
348 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
355 c->options = ZOOM_options_create_with_parent(options);
361 c->charset = c->lang = 0;
372 c->maximum_record_size = 0;
373 c->preferred_message_size = 0;
375 c->odr_in = odr_createmem(ODR_DECODE);
376 c->odr_out = odr_createmem(ODR_ENCODE);
379 c->support_named_resultsets = 0;
380 c->last_event = ZOOM_EVENT_NONE;
382 c->m_queue_front = 0;
388 /* set database names. Take local databases (if set); otherwise
389 take databases given in ZURL (if set); otherwise use Default */
390 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
393 char **databaseNames;
394 const char *cp = ZOOM_options_get(options, "databaseName");
396 if ((!cp || !*cp) && con->host_port)
398 if (strncmp(con->host_port, "unix:", 5) == 0)
399 cp = strchr(con->host_port+5, ':');
401 cp = strchr(con->host_port, '/');
407 nmem_strsplit(odr_getmem(odr), "+", cp, &databaseNames, num);
408 return databaseNames;
411 ZOOM_API(ZOOM_connection)
412 ZOOM_connection_new(const char *host, int portnum)
414 ZOOM_connection c = ZOOM_connection_create(0);
416 ZOOM_connection_connect(c, host, portnum);
420 static zoom_sru_mode get_sru_mode_from_string(const char *s)
423 return zoom_sru_soap;
424 if (!yaz_matchstr(s, "soap"))
425 return zoom_sru_soap;
426 else if (!yaz_matchstr(s, "get"))
428 else if (!yaz_matchstr(s, "post"))
429 return zoom_sru_post;
430 return zoom_sru_error;
434 ZOOM_connection_connect(ZOOM_connection c,
435 const char *host, int portnum)
442 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
443 c, host ? host : "null", portnum);
445 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
446 ZOOM_connection_remove_tasks(c);
450 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
454 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
457 val = ZOOM_options_get(c->options, "proxy");
460 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
461 c->proxy = xstrdup(val);
466 val = ZOOM_options_get(c->options, "charset");
469 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
470 c->charset = xstrdup(val);
474 val = ZOOM_options_get(c->options, "lang");
477 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
478 c->lang = xstrdup(val);
489 sprintf(hostn, "%.80s:%d", host, portnum);
490 c->host_port = xstrdup(hostn);
493 c->host_port = xstrdup(host);
498 * If the "<scheme>:" part of the host string is preceded by one
499 * or more comma-separated <name>=<value> pairs, these are taken
500 * to be options to be set on the connection object. Among other
501 * applications, this facility can be used to embed authentication
503 * user=admin,password=secret,tcp:localhost:9999
505 char *remainder = c->host_port;
506 char *pcolon = strchr(remainder, ':');
509 while ((pcomma = strchr(remainder, ',')) != 0 &&
510 (pcolon == 0 || pcomma < pcolon)) {
512 if ((pequals = strchr(remainder, '=')) != 0) {
514 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
515 ZOOM_connection_option_set(c, remainder, pequals+1);
517 remainder = pcomma+1;
520 if (remainder != c->host_port) {
522 c->host_port = xstrdup(remainder);
523 /*printf("# reset hp='%s'\n", remainder);*/
527 val = ZOOM_options_get(c->options, "sru");
528 c->sru_mode = get_sru_mode_from_string(val);
530 ZOOM_options_set(c->options, "host", c->host_port);
532 xfree(c->cookie_out);
534 val = ZOOM_options_get(c->options, "cookie");
537 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
538 c->cookie_out = xstrdup(val);
543 val = ZOOM_options_get(c->options, "clientIP");
546 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
548 c->client_IP = xstrdup(val);
553 val = ZOOM_options_get(c->options, "group");
555 c->group = xstrdup(val);
559 val = ZOOM_options_get(c->options, "user");
561 c->user = xstrdup(val);
565 val = ZOOM_options_get(c->options, "password");
567 val = ZOOM_options_get(c->options, "pass");
570 c->password = xstrdup(val);
572 c->maximum_record_size =
573 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
574 c->preferred_message_size =
575 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
577 c->async = ZOOM_options_get_bool(c->options, "async", 0);
578 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
580 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
584 while (ZOOM_event(1, &c))
590 ZOOM_query_create(void)
592 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
594 yaz_log(log_details, "%p ZOOM_query_create", s);
598 s->odr = odr_createmem(ODR_ENCODE);
605 ZOOM_query_destroy(ZOOM_query s)
611 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
612 if (s->refcount == 0)
620 ZOOM_query_prefix(ZOOM_query s, const char *str)
622 s->query_string = odr_strdup(s->odr, str);
623 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
624 s->z_query->which = Z_Query_type_1;
625 s->z_query->u.type_1 = p_query_rpn(s->odr, str);
626 if (!s->z_query->u.type_1)
628 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
632 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
637 ZOOM_query_cql(ZOOM_query s, const char *str)
641 s->query_string = odr_strdup(s->odr, str);
643 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
644 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
645 ext->indirect_reference = 0;
647 ext->which = Z_External_CQL;
648 ext->u.cql = s->query_string;
650 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
651 s->z_query->which = Z_Query_type_104;
652 s->z_query->u.type_104 = ext;
654 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
660 * Translate the CQL string client-side into RPN which is passed to
661 * the server. This is useful for server's that don't themselves
662 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
663 * only as a place to stash diagnostics if compilation fails; if this
664 * information is not needed, a null pointer may be used.
667 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
671 ZOOM_connection freeme = 0;
673 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
675 conn = freeme = ZOOM_connection_create(0);
677 rpn = cql2pqf(conn, str);
679 ZOOM_connection_destroy(freeme);
683 ret = ZOOM_query_prefix(s, rpn);
689 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
690 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
691 * to the server, as the YAZ GFS doesn't know how to handle this.
694 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
695 int *ccl_error, const char **error_string,
699 struct ccl_rpn_node *rpn;
700 CCL_bibset bibset = ccl_qual_mk();
703 ccl_qual_buf(bibset, config);
705 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
708 *error_string = ccl_err_msg(*ccl_error);
713 WRBUF wr = wrbuf_alloc();
716 ret = ZOOM_query_prefix(s, wrbuf_cstr(wr));
719 ccl_qual_rm(&bibset);
724 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
726 s->sort_spec = yaz_sort_spec(s->odr, criteria);
729 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
733 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
737 static zoom_ret do_write(ZOOM_connection c);
740 ZOOM_connection_destroy(ZOOM_connection c)
745 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
748 for (r = c->resultsets; r; r = r->next)
754 odr_destroy(c->odr_in);
755 odr_destroy(c->odr_out);
756 ZOOM_options_destroy(c->options);
757 ZOOM_connection_remove_tasks(c);
758 ZOOM_connection_remove_events(c);
764 xfree(c->cookie_out);
773 void ZOOM_resultset_addref(ZOOM_resultset r)
778 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
783 ZOOM_resultset ZOOM_resultset_create(void)
786 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
790 yaz_log(log_details, "%p ZOOM_resultset_create", r);
793 r->odr = odr_createmem(ODR_ENCODE);
798 for (i = 0; i<RECORD_HASH_SIZE; i++)
799 r->record_hash[i] = 0;
804 r->databaseNames = 0;
805 r->num_databaseNames = 0;
810 ZOOM_API(ZOOM_resultset)
811 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
814 ZOOM_query s = ZOOM_query_create();
816 ZOOM_query_prefix(s, q);
818 r = ZOOM_connection_search(c, s);
819 ZOOM_query_destroy(s);
823 ZOOM_API(ZOOM_resultset)
824 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
826 ZOOM_resultset r = ZOOM_resultset_create();
830 const char *syntax, *elementSetName;
832 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
833 r->r_sort_spec = q->sort_spec;
836 r->options = ZOOM_options_create_with_parent(c->options);
839 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
841 r->rpn_iconv = yaz_iconv_open(cp, "UTF-8");
845 start = ZOOM_options_get_int(r->options, "start", 0);
846 count = ZOOM_options_get_int(r->options, "count", 0);
848 /* If "presentChunk" is defined use that; otherwise "step" */
849 const char *cp = ZOOM_options_get(r->options, "presentChunk");
850 r->step = ZOOM_options_get_int(r->options,
851 (cp != 0 ? "presentChunk": "step"), 0);
853 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
854 cp = ZOOM_options_get(r->options, "setname");
856 r->setname = xstrdup(cp);
857 cp = ZOOM_options_get(r->options, "schema");
859 r->schema = xstrdup(cp);
861 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
866 r->next = c->resultsets;
871 if (c->host_port && c->proto == PROTO_HTTP)
875 yaz_log(log_details, "ZOOM_connection_search: no comstack");
876 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
880 yaz_log(log_details, "ZOOM_connection_search: reconnect");
885 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
886 task->u.search.resultset = r;
887 task->u.search.start = start;
888 task->u.search.count = count;
890 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
891 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
892 elementSetName = ZOOM_options_get(r->options, "elementSetName");
893 task->u.search.elementSetName = elementSetName
894 ? xstrdup(elementSetName) : 0;
896 ZOOM_resultset_addref(r);
902 while (ZOOM_event(1, &c))
909 ZOOM_resultset_sort(ZOOM_resultset r,
910 const char *sort_type, const char *sort_spec)
912 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
916 ZOOM_resultset_sort1(ZOOM_resultset r,
917 const char *sort_type, const char *sort_spec)
919 ZOOM_connection c = r->connection;
923 newq = ZOOM_query_create();
924 if (ZOOM_query_sortby(newq, sort_spec) < 0)
927 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
928 r, r, sort_type, sort_spec);
932 if (c->host_port && c->proto == PROTO_HTTP)
936 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
937 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
941 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
947 ZOOM_resultset_cache_reset(r);
948 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
949 task->u.sort.resultset = r;
950 task->u.sort.q = newq;
952 ZOOM_resultset_addref(r);
956 while (ZOOM_event(1, &c))
964 ZOOM_resultset_cache_reset(ZOOM_resultset r)
967 for (i = 0; i<RECORD_HASH_SIZE; i++)
969 ZOOM_record_cache rc;
970 for (rc = r->record_hash[i]; rc; rc = rc->next)
972 if (rc->rec.wrbuf_marc)
973 wrbuf_destroy(rc->rec.wrbuf_marc);
974 if (rc->rec.wrbuf_iconv)
975 wrbuf_destroy(rc->rec.wrbuf_iconv);
976 if (rc->rec.wrbuf_opac)
977 wrbuf_destroy(rc->rec.wrbuf_opac);
979 r->record_hash[i] = 0;
984 ZOOM_resultset_destroy(ZOOM_resultset r)
986 resultset_destroy(r);
989 static void resultset_destroy(ZOOM_resultset r)
994 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
996 if (r->refcount == 0)
998 ZOOM_resultset_cache_reset(r);
1002 /* remove ourselves from the resultsets in connection */
1003 ZOOM_resultset *rp = &r->connection->resultsets;
1006 assert(*rp); /* we must be in this list!! */
1008 { /* OK, we're here - take us out of it */
1015 ZOOM_query_destroy(r->query);
1016 ZOOM_options_destroy(r->options);
1018 yaz_iconv_close(r->rpn_iconv);
1019 odr_destroy(r->odr);
1027 ZOOM_resultset_size(ZOOM_resultset r)
1029 yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
1034 static void do_close(ZOOM_connection c)
1039 ZOOM_connection_set_mask(c, 0);
1040 c->state = STATE_IDLE;
1043 static int ZOOM_test_reconnect(ZOOM_connection c)
1047 if (!c->reconnect_ok)
1050 c->reconnect_ok = 0;
1051 c->tasks->running = 0;
1052 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1054 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1055 ZOOM_connection_put_event(c, event);
1060 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1061 int force_sync, int start, int count)
1066 const char *syntax, *elementSetName;
1070 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1071 " count=%d", r, force_sync, start, count);
1076 if (c->host_port && c->proto == PROTO_HTTP)
1080 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1081 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1085 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1087 c->reconnect_ok = 1;
1090 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1091 task->u.retrieve.resultset = r;
1092 task->u.retrieve.start = start;
1093 task->u.retrieve.count = count;
1095 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1096 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1097 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1098 task->u.retrieve.elementSetName = elementSetName
1099 ? xstrdup(elementSetName) : 0;
1101 cp = ZOOM_options_get(r->options, "schema");
1104 if (!r->schema || strcmp(r->schema, cp))
1107 r->schema = xstrdup(cp);
1111 ZOOM_resultset_addref(r);
1113 if (!r->connection->async || force_sync)
1114 while (r->connection && ZOOM_event(1, &r->connection))
1119 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1120 size_t start, size_t count)
1122 int force_present = 0;
1126 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1127 r, r, (long) start, (long) count);
1130 ZOOM_resultset_retrieve(r, force_present, start, count);
1134 for (i = 0; i< count; i++)
1135 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1139 static void get_cert(ZOOM_connection c)
1144 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1146 ZOOM_connection_option_setl(c, "sslPeerCert",
1147 cert_buf, cert_len);
1152 static zoom_ret do_connect(ZOOM_connection c)
1155 const char *effective_host;
1158 effective_host = c->proxy;
1160 effective_host = c->host_port;
1162 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1166 c->cs = cs_create_host(effective_host, 0, &add);
1168 if (c->cs && c->cs->protocol == PROTO_HTTP)
1171 const char *path = 0;
1173 c->proto = PROTO_HTTP;
1174 cs_get_host_args(c->host_port, &path);
1176 c->path = (char*) xmalloc(strlen(path)+2);
1178 strcpy(c->path+1, path);
1180 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1182 return zoom_complete;
1187 int ret = cs_connect(c->cs, add);
1190 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1191 ZOOM_connection_put_event(c, event);
1193 if (c->proto == PROTO_Z3950)
1194 ZOOM_connection_send_init(c);
1197 /* no init request for SRW .. */
1198 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1199 ZOOM_connection_remove_task(c);
1200 ZOOM_connection_set_mask(c, 0);
1201 ZOOM_connection_exec_task(c);
1203 c->state = STATE_ESTABLISHED;
1204 return zoom_pending;
1208 int mask = ZOOM_SELECT_EXCEPT;
1209 if (c->cs->io_pending & CS_WANT_WRITE)
1210 mask += ZOOM_SELECT_WRITE;
1211 if (c->cs->io_pending & CS_WANT_READ)
1212 mask += ZOOM_SELECT_READ;
1213 ZOOM_connection_set_mask(c, mask);
1214 c->state = STATE_CONNECTING;
1215 return zoom_pending;
1218 c->state = STATE_IDLE;
1219 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1220 return zoom_complete;
1223 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1226 for (i = 0; i<200; i++)
1230 Z_OtherInformation **oi;
1235 sprintf(buf, "otherInfo%d", i);
1236 val = ZOOM_options_get(c->options, buf);
1239 cp = strchr(val, ':');
1243 if (len >= sizeof(buf))
1244 len = sizeof(buf)-1;
1245 memcpy(buf, val, len);
1248 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
1253 yaz_oi_APDU(a, &oi);
1254 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
1258 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1263 Z_OtherInformation **oi;
1264 yaz_oi_APDU(a, &oi);
1265 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
1270 Z_OtherInformation **oi;
1271 yaz_oi_APDU(a, &oi);
1272 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
1275 otherInfo_attach(c, a, out);
1276 if (!z_APDU(out, &a, 0, 0))
1278 FILE *outf = fopen("/tmp/apdu.txt", "a");
1281 ODR odr_pr = odr_createmem(ODR_PRINT);
1282 fprintf(outf, "a=%p\n", a);
1283 odr_setprint(odr_pr, outf);
1284 z_APDU(odr_pr, &a, 0, 0);
1285 odr_destroy(odr_pr);
1287 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1288 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1292 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1296 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1300 if (encode_APDU(c, a, c->odr_out))
1301 return zoom_complete;
1302 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1303 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1304 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1305 ZOOM_connection_put_event(c, event);
1306 odr_reset(c->odr_out);
1310 /* returns 1 if PDU was sent OK (still pending )
1311 0 if PDU was not sent OK (nothing to wait for)
1314 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1316 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1317 Z_InitRequest *ireq = apdu->u.initRequest;
1318 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1319 odr_malloc(c->odr_out, sizeof(*auth));
1322 ODR_MASK_SET(ireq->options, Z_Options_search);
1323 ODR_MASK_SET(ireq->options, Z_Options_present);
1324 ODR_MASK_SET(ireq->options, Z_Options_scan);
1325 ODR_MASK_SET(ireq->options, Z_Options_sort);
1326 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1327 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1329 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1330 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1331 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1333 /* Index Data's Z39.50 Implementor Id is 81 */
1334 ireq->implementationId =
1335 odr_prepend(c->odr_out,
1336 ZOOM_options_get(c->options, "implementationId"),
1337 odr_prepend(c->odr_out, "81", ireq->implementationId));
1339 ireq->implementationName =
1340 odr_prepend(c->odr_out,
1341 ZOOM_options_get(c->options, "implementationName"),
1342 odr_prepend(c->odr_out, "ZOOM-C",
1343 ireq->implementationName));
1345 version = odr_strdup(c->odr_out, "$Revision: 1.139 $");
1346 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1347 version[strlen(version)-2] = '\0';
1348 ireq->implementationVersion =
1349 odr_prepend(c->odr_out,
1350 ZOOM_options_get(c->options, "implementationVersion"),
1351 odr_prepend(c->odr_out, &version[11],
1352 ireq->implementationVersion));
1354 *ireq->maximumRecordSize = c->maximum_record_size;
1355 *ireq->preferredMessageSize = c->preferred_message_size;
1357 if (c->group || c->password)
1359 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1362 pass->groupId = odr_strdup(c->odr_out, c->group);
1365 pass->userId = odr_strdup(c->odr_out, c->user);
1368 pass->password = odr_strdup(c->odr_out, c->password);
1369 auth->which = Z_IdAuthentication_idPass;
1370 auth->u.idPass = pass;
1371 ireq->idAuthentication = auth;
1375 auth->which = Z_IdAuthentication_open;
1376 auth->u.open = odr_strdup(c->odr_out, c->user);
1377 ireq->idAuthentication = auth;
1381 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
1382 yaz_oid_userinfo_proxy, 1, c->host_port);
1384 if (c->charset || c->lang)
1386 Z_OtherInformation **oi;
1387 Z_OtherInformationUnit *oi_unit;
1389 yaz_oi_APDU(apdu, &oi);
1391 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1393 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1394 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1395 oi_unit->information.externallyDefinedInfo =
1396 yaz_set_proposal_charneg_list(c->odr_out, " ",
1397 c->charset, c->lang, 1);
1401 return send_APDU(c, apdu);
1405 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1410 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1412 if (c->sru_mode == zoom_sru_get)
1414 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1416 else if (c->sru_mode == zoom_sru_post)
1418 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1420 else if (c->sru_mode == zoom_sru_soap)
1422 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1424 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1425 return zoom_complete;
1426 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1428 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1429 ZOOM_connection_put_event(c, event);
1430 odr_reset(c->odr_out);
1436 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1440 ZOOM_resultset resultset = 0;
1442 const char *option_val = 0;
1444 if (c->error) /* don't continue on error */
1445 return zoom_complete;
1447 switch(c->tasks->which)
1449 case ZOOM_TASK_SEARCH:
1450 resultset = c->tasks->u.search.resultset;
1451 resultset->setname = xstrdup("default");
1452 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1453 start = &c->tasks->u.search.start;
1454 count = &c->tasks->u.search.count;
1456 case ZOOM_TASK_RETRIEVE:
1457 resultset = c->tasks->u.retrieve.resultset;
1459 start = &c->tasks->u.retrieve.start;
1460 count = &c->tasks->u.retrieve.count;
1462 if (*start >= resultset->size)
1463 return zoom_complete;
1464 if (*start + *count > resultset->size)
1465 *count = resultset->size - *start;
1467 for (i = 0; i < *count; i++)
1470 record_cache_lookup(resultset, i + *start,
1471 c->tasks->u.retrieve.syntax,
1472 c->tasks->u.retrieve.elementSetName);
1477 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1478 ZOOM_connection_put_event(c, event);
1485 return zoom_complete;
1488 return zoom_complete;
1490 assert(resultset->query);
1492 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1494 if (resultset->query->z_query->which == Z_Query_type_104
1495 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1497 sr->u.request->query_type = Z_SRW_query_type_cql;
1498 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1500 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1501 resultset->query->z_query->u.type_1)
1503 sr->u.request->query_type = Z_SRW_query_type_pqf;
1504 sr->u.request->query.pqf = resultset->query->query_string;
1508 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1509 return zoom_complete;
1511 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1512 sr->u.request->maximumRecords = odr_intdup(
1513 c->odr_out, resultset->step>0 ? resultset->step : *count);
1514 sr->u.request->recordSchema = resultset->schema;
1516 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1518 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1520 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1522 sr->extra_args = odr_strdup(c->odr_out, option_val);
1523 return send_srw(c, sr);
1526 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1528 return zoom_complete;
1532 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1535 int lslb, ssub, mspn;
1537 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1538 Z_SearchRequest *search_req = apdu->u.searchRequest;
1539 const char *elementSetName;
1540 const char *smallSetElementSetName;
1541 const char *mediumSetElementSetName;
1544 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1546 r = c->tasks->u.search.resultset;
1548 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1551 ZOOM_options_get(r->options, "elementSetName");
1552 smallSetElementSetName =
1553 ZOOM_options_get(r->options, "smallSetElementSetName");
1554 mediumSetElementSetName =
1555 ZOOM_options_get(r->options, "mediumSetElementSetName");
1557 if (!smallSetElementSetName)
1558 smallSetElementSetName = elementSetName;
1560 if (!mediumSetElementSetName)
1561 mediumSetElementSetName = elementSetName;
1566 /* prepare query for the search request */
1567 search_req->query = r->query->z_query;
1568 if (!search_req->query)
1570 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1571 return zoom_complete;
1573 if (r->query->z_query->which == Z_Query_type_1 && r->rpn_iconv)
1575 search_req->query = yaz_copy_Z_Query(r->query->z_query, c->odr_out);
1577 yaz_query_charset_convert_rpnquery(search_req->query->u.type_1,
1578 c->odr_out, r->rpn_iconv);
1580 search_req->databaseNames = r->databaseNames;
1581 search_req->num_databaseNames = r->num_databaseNames;
1583 /* get syntax (no need to provide unless piggyback is in effect) */
1584 syntax = c->tasks->u.search.syntax;
1586 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1587 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1588 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1589 if (lslb != -1 && ssub != -1 && mspn != -1)
1591 /* So're a Z39.50 expert? Let's hope you don't do sort */
1592 *search_req->largeSetLowerBound = lslb;
1593 *search_req->smallSetUpperBound = ssub;
1594 *search_req->mediumSetPresentNumber = mspn;
1596 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1597 && r->piggyback && !r->r_sort_spec && !r->schema)
1599 /* Regular piggyback - do it unless we're going to do sort */
1600 *search_req->largeSetLowerBound = 2000000000;
1601 *search_req->smallSetUpperBound = 1;
1602 *search_req->mediumSetPresentNumber =
1603 r->step>0 ? r->step : c->tasks->u.search.count;
1607 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1608 smallSetElementSetName = 0;
1609 mediumSetElementSetName = 0;
1612 if (smallSetElementSetName && *smallSetElementSetName)
1614 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1615 odr_malloc(c->odr_out, sizeof(*esn));
1617 esn->which = Z_ElementSetNames_generic;
1618 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1619 search_req->smallSetElementSetNames = esn;
1621 if (mediumSetElementSetName && *mediumSetElementSetName)
1623 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1624 odr_malloc(c->odr_out, sizeof(*esn));
1626 esn->which = Z_ElementSetNames_generic;
1627 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1628 search_req->mediumSetElementSetNames = esn;
1631 search_req->preferredRecordSyntax =
1632 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1636 if (c->support_named_resultsets)
1640 /* find the lowest unused ordinal so that we re-use
1641 result sets on the server. */
1642 for (ord = 1; ; ord++)
1645 sprintf(setname, "%d", ord);
1646 for (rp = c->resultsets; rp; rp = rp->next)
1647 if (rp->setname && !strcmp(rp->setname, setname))
1652 r->setname = xstrdup(setname);
1653 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1654 "set %s", c, r->setname);
1658 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1660 r->setname = xstrdup("default");
1662 ZOOM_options_set(r->options, "setname", r->setname);
1664 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1665 return send_APDU(c, apdu);
1668 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1670 char oid_name_buf[OID_STR_MAX];
1671 const char *oid_name;
1674 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
1677 case Z_DefaultDiagFormat_v2Addinfo:
1678 addinfo = r->u.v2Addinfo;
1680 case Z_DefaultDiagFormat_v3Addinfo:
1681 addinfo = r->u.v3Addinfo;
1686 set_dset_error(c, *r->condition, oid_name, addinfo, 0);
1689 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1691 if (p->which != Z_DiagRec_defaultFormat)
1692 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1694 response_default_diag(c, p->u.defaultFormat);
1697 ZOOM_API(ZOOM_record)
1698 ZOOM_record_clone(ZOOM_record srec)
1705 odr_enc = odr_createmem(ODR_ENCODE);
1706 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1708 buf = odr_getbuf(odr_enc, &size, 0);
1710 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1711 nrec->odr = odr_createmem(ODR_DECODE);
1712 nrec->wrbuf_marc = 0;
1713 nrec->wrbuf_iconv = 0;
1714 nrec->wrbuf_opac = 0;
1715 odr_setbuf(nrec->odr, buf, size, 0);
1716 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1718 odr_destroy(odr_enc);
1722 ZOOM_API(ZOOM_record)
1723 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1725 const char *syntax =
1726 ZOOM_options_get(s->options, "preferredRecordSyntax");
1727 const char *elementSetName =
1728 ZOOM_options_get(s->options, "elementSetName");
1730 return record_cache_lookup(s, pos, syntax, elementSetName);
1733 ZOOM_API(ZOOM_record)
1734 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1736 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1741 * MIKE: I think force_sync should always be zero, but I don't
1742 * want to make this change until I get the go-ahead from
1743 * Adam, in case something depends on the old synchronous
1747 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1748 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1749 rec = ZOOM_resultset_record_immediate(r, pos);
1755 ZOOM_record_destroy(ZOOM_record rec)
1759 if (rec->wrbuf_marc)
1760 wrbuf_destroy(rec->wrbuf_marc);
1761 if (rec->wrbuf_iconv)
1762 wrbuf_destroy(rec->wrbuf_iconv);
1763 if (rec->wrbuf_opac)
1764 wrbuf_destroy(rec->wrbuf_opac);
1765 odr_destroy(rec->odr);
1769 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1771 const char *buf, int sz,
1772 const char *record_charset)
1777 yaz_marc_t mt = yaz_marc_create();
1780 strcpy(to, "UTF-8");
1781 if (record_charset && *record_charset)
1783 /* Use "from,to" or just "from" */
1784 const char *cp = strchr(record_charset, ',');
1785 int clen = strlen(record_charset);
1788 strncpy( to, cp+1, sizeof(to)-1);
1789 to[sizeof(to)-1] = '\0';
1790 clen = cp - record_charset;
1792 if (clen > sizeof(from)-1)
1793 clen = sizeof(from)-1;
1796 strncpy(from, record_charset, clen);
1802 cd = yaz_iconv_open(to, from);
1803 yaz_marc_iconv(mt, cd);
1806 yaz_marc_xml(mt, marc_type);
1807 if (!rec->wrbuf_marc)
1808 rec->wrbuf_marc = wrbuf_alloc();
1809 wrbuf_rewind(rec->wrbuf_marc);
1810 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1812 yaz_marc_destroy(mt);
1814 yaz_iconv_close(cd);
1816 *len = wrbuf_len(rec->wrbuf_marc);
1817 return wrbuf_cstr(rec->wrbuf_marc);
1819 yaz_marc_destroy(mt);
1821 yaz_iconv_close(cd);
1825 static const char *record_iconv_return(ZOOM_record rec, int *len,
1826 const char *buf, int sz,
1827 const char *record_charset)
1834 strcpy(to, "UTF-8");
1836 if (record_charset && *record_charset)
1838 /* Use "from,to" or just "from" */
1839 const char *cp = strchr(record_charset, ',');
1840 int clen = strlen(record_charset);
1843 strncpy( to, cp+1, sizeof(to)-1);
1844 to[sizeof(to)-1] = '\0';
1845 clen = cp - record_charset;
1847 if (clen > sizeof(from)-1)
1848 clen = sizeof(from)-1;
1851 strncpy(from, record_charset, clen);
1855 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1857 if (!rec->wrbuf_iconv)
1858 rec->wrbuf_iconv = wrbuf_alloc();
1860 wrbuf_rewind(rec->wrbuf_iconv);
1862 wrbuf_iconv_write(rec->wrbuf_iconv, cd, buf, sz);
1863 wrbuf_iconv_reset(rec->wrbuf_iconv, cd);
1865 buf = wrbuf_cstr(rec->wrbuf_iconv);
1866 sz = wrbuf_len(rec->wrbuf_iconv);
1867 yaz_iconv_close(cd);
1875 ZOOM_record_error(ZOOM_record rec, const char **cp,
1876 const char **addinfo, const char **diagset)
1878 Z_NamePlusRecord *npr;
1883 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1885 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1886 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1887 const char *add = 0;
1889 if (diag_rec->which == Z_DiagRec_defaultFormat)
1891 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1894 error = *ddf->condition;
1897 case Z_DefaultDiagFormat_v2Addinfo:
1898 add = ddf->u.v2Addinfo;
1900 case Z_DefaultDiagFormat_v3Addinfo:
1901 add = ddf->u.v3Addinfo;
1906 yaz_oid_to_string(yaz_oid_std(),
1907 ddf->diagnosticSetId, &oclass);
1915 *addinfo = add ? add : "";
1917 *cp = diagbib1_str(error);
1923 ZOOM_API(const char *)
1924 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1931 Z_NamePlusRecord *npr;
1934 *len = 0; /* default return */
1943 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1945 if (cp[i] == ';' || cp[i] == ' ')
1951 while (type_spec[i] == ';')
1954 while (type_spec[i] == ' ')
1956 if (!strncmp(type_spec+i, "charset=", 8))
1959 i = i + 8; /* skip charset= */
1960 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1962 if (type_spec[i] == ';' || type_spec[i] == ' ')
1968 else if (!strncmp(type_spec+i, "xpath=", 6))
1972 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1976 while (type_spec[i] == ' ')
1979 if (!strcmp(type, "database"))
1982 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1983 return npr->databaseName;
1985 else if (!strcmp(type, "syntax"))
1987 const char *desc = 0;
1988 if (npr->which == Z_NamePlusRecord_databaseRecord)
1990 Z_External *r = (Z_External *) npr->u.databaseRecord;
1991 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
1996 *len = strlen(desc);
1999 if (npr->which != Z_NamePlusRecord_databaseRecord)
2002 /* from now on - we have a database record .. */
2003 if (!strcmp(type, "render"))
2005 Z_External *r = (Z_External *) npr->u.databaseRecord;
2006 const Odr_oid *oid = r->direct_reference;
2008 /* render bibliographic record .. */
2009 if (r->which == Z_External_OPAC)
2011 r = r->u.opac->bibliographicRecord;
2014 oid = r->direct_reference;
2016 if (r->which == Z_External_sutrs)
2017 return record_iconv_return(rec, len,
2018 (char*) r->u.sutrs->buf,
2021 else if (r->which == Z_External_octet)
2023 if (yaz_oid_is_iso2709(oid))
2025 const char *ret_buf = marc_iconv_return(
2026 rec, YAZ_MARC_LINE, len,
2027 (const char *) r->u.octet_aligned->buf,
2028 r->u.octet_aligned->len,
2033 return record_iconv_return(rec, len,
2034 (const char *) r->u.octet_aligned->buf,
2035 r->u.octet_aligned->len,
2038 else if (r->which == Z_External_grs1)
2040 if (!rec->wrbuf_marc)
2041 rec->wrbuf_marc = wrbuf_alloc();
2042 wrbuf_rewind(rec->wrbuf_marc);
2043 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
2044 return record_iconv_return(rec, len,
2045 wrbuf_buf(rec->wrbuf_marc),
2046 wrbuf_len(rec->wrbuf_marc),
2051 else if (!strcmp(type, "xml"))
2053 Z_External *r = (Z_External *) npr->u.databaseRecord;
2054 const Odr_oid *oid = r->direct_reference;
2056 /* render bibliographic record .. */
2057 if (r->which == Z_External_OPAC)
2059 r = r->u.opac->bibliographicRecord;
2062 oid = r->direct_reference;
2065 if (r->which == Z_External_sutrs)
2066 return record_iconv_return(rec, len,
2067 (const char *) r->u.sutrs->buf,
2070 else if (r->which == Z_External_octet)
2072 int marc_decode_type = YAZ_MARC_MARCXML;
2073 if (yaz_oid_is_iso2709(oid))
2075 const char *ret_buf = marc_iconv_return(
2076 rec, marc_decode_type, len,
2077 (const char *) r->u.octet_aligned->buf,
2078 r->u.octet_aligned->len,
2083 return record_iconv_return(rec, len,
2084 (const char *) r->u.octet_aligned->buf,
2085 r->u.octet_aligned->len,
2088 else if (r->which == Z_External_grs1)
2095 else if (!strcmp(type, "raw"))
2097 Z_External *r = (Z_External *) npr->u.databaseRecord;
2099 if (r->which == Z_External_sutrs)
2101 if (len) *len = r->u.sutrs->len;
2102 return (const char *) r->u.sutrs->buf;
2104 else if (r->which == Z_External_octet)
2106 if (len) *len = r->u.octet_aligned->len;
2107 return (const char *) r->u.octet_aligned->buf;
2109 else /* grs-1, explain, OPAC, ... */
2112 return (const char *) npr->u.databaseRecord;
2116 else if (!strcmp (type, "ext"))
2119 return (const char *) npr->u.databaseRecord;
2121 else if (!strcmp (type, "opac"))
2124 Z_External *r = (Z_External *) npr->u.databaseRecord;
2125 if (r->which == Z_External_OPAC)
2127 if (!rec->wrbuf_opac)
2128 rec->wrbuf_opac = wrbuf_alloc();
2129 wrbuf_rewind(rec->wrbuf_opac);
2130 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2131 return record_iconv_return(rec, len,
2132 wrbuf_buf(rec->wrbuf_opac),
2133 wrbuf_len(rec->wrbuf_opac),
2140 static int strcmp_null(const char *v1, const char *v2)
2146 return strcmp(v1, v2);
2149 static size_t record_hash(int pos)
2153 return pos % RECORD_HASH_SIZE;
2156 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2158 const char *syntax, const char *elementSetName)
2160 ZOOM_record_cache rc;
2162 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2163 ZOOM_connection_put_event(r->connection, event);
2165 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2169 if (strcmp_null(r->schema, rc->schema))
2171 if (strcmp_null(elementSetName,rc->elementSetName))
2173 if (strcmp_null(syntax, rc->syntax))
2175 /* not destroying rc->npr (it's handled by nmem )*/
2177 /* keeping wrbuf_marc too */
2181 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2184 rc->rec.wrbuf_marc = 0;
2185 rc->rec.wrbuf_iconv = 0;
2186 rc->rec.wrbuf_opac = 0;
2188 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2190 rc->elementSetName = 0;
2193 rc->syntax = odr_strdup(r->odr, syntax);
2198 rc->schema = odr_strdup(r->odr, r->schema);
2203 rc->next = r->record_hash[record_hash(pos)];
2204 r->record_hash[record_hash(pos)] = rc;
2207 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2209 const char *elementSetName)
2211 ZOOM_record_cache rc;
2213 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2217 if (strcmp_null(r->schema, rc->schema))
2219 if (strcmp_null(elementSetName,rc->elementSetName))
2221 if (strcmp_null(syntax, rc->syntax))
2229 static void handle_records(ZOOM_connection c, Z_Records *sr,
2232 ZOOM_resultset resultset;
2234 const char *syntax = 0, *elementSetName = 0;
2238 switch (c->tasks->which)
2240 case ZOOM_TASK_SEARCH:
2241 resultset = c->tasks->u.search.resultset;
2242 start = &c->tasks->u.search.start;
2243 count = &c->tasks->u.search.count;
2244 syntax = c->tasks->u.search.syntax;
2245 elementSetName = c->tasks->u.search.elementSetName;
2247 case ZOOM_TASK_RETRIEVE:
2248 resultset = c->tasks->u.retrieve.resultset;
2249 start = &c->tasks->u.retrieve.start;
2250 count = &c->tasks->u.retrieve.count;
2251 syntax = c->tasks->u.retrieve.syntax;
2252 elementSetName = c->tasks->u.retrieve.elementSetName;
2257 if (sr && sr->which == Z_Records_NSD)
2258 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2259 else if (sr && sr->which == Z_Records_multipleNSD)
2261 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2262 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2264 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2268 if (*count + *start > resultset->size)
2269 *count = resultset->size - *start;
2272 if (sr && sr->which == Z_Records_DBOSD)
2275 NMEM nmem = odr_extract_mem(c->odr_in);
2276 Z_NamePlusRecordList *p =
2277 sr->u.databaseOrSurDiagnostics;
2278 for (i = 0; i<p->num_records; i++)
2280 record_cache_add(resultset, p->records[i], i + *start,
2281 syntax, elementSetName);
2287 yaz_log(log_details,
2288 "handle_records resultset=%p start=%d count=%d",
2289 resultset, *start, *count);
2291 /* transfer our response to search_nmem .. we need it later */
2292 nmem_transfer(odr_getmem(resultset->odr), nmem);
2294 if (present_phase && p->num_records == 0)
2296 /* present response and we didn't get any records! */
2297 Z_NamePlusRecord *myrec =
2298 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2299 record_cache_add(resultset, myrec, *start,
2300 syntax, elementSetName);
2303 else if (present_phase)
2305 /* present response and we didn't get any records! */
2306 Z_NamePlusRecord *myrec =
2307 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2308 record_cache_add(resultset, myrec, *start, syntax, elementSetName);
2313 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2315 handle_records(c, pr->records, 1);
2318 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2321 switch (term->which)
2323 case Z_Term_general:
2324 ZOOM_options_setl(opt, name,
2325 (const char *)(term->u.general->buf),
2326 term->u.general->len);
2328 case Z_Term_characterString:
2329 ZOOM_options_set(opt, name, term->u.characterString);
2331 case Z_Term_numeric:
2332 ZOOM_options_set_int(opt, name, *term->u.numeric);
2337 static void handle_queryExpression(ZOOM_options opt, const char *name,
2338 Z_QueryExpression *exp)
2344 case Z_QueryExpression_term:
2345 if (exp->u.term && exp->u.term->queryTerm)
2347 sprintf(opt_name, "%s.term", name);
2348 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2351 case Z_QueryExpression_query:
2356 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2357 Z_OtherInformation *o)
2360 for (i = 0; o && i < o->num_elements; i++)
2362 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2364 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2366 if (ext->which == Z_External_searchResult1)
2369 Z_SearchInfoReport *sr = ext->u.searchResult1;
2372 ZOOM_options_set_int(
2373 resultset->options, "searchresult.size", sr->num);
2375 for (j = 0; j < sr->num; j++)
2377 Z_SearchInfoReport_s *ent =
2378 ext->u.searchResult1->elements[j];
2381 sprintf(pref, "searchresult.%d", j);
2383 if (ent->subqueryId)
2386 sprintf(opt_name, "%s.id", pref);
2387 ZOOM_options_set(resultset->options, opt_name,
2390 if (ent->subqueryExpression)
2393 sprintf(opt_name, "%s.subquery", pref);
2394 handle_queryExpression(resultset->options, opt_name,
2395 ent->subqueryExpression);
2397 if (ent->subqueryInterpretation)
2400 sprintf(opt_name, "%s.interpretation", pref);
2401 handle_queryExpression(resultset->options, opt_name,
2402 ent->subqueryInterpretation);
2404 if (ent->subqueryRecommendation)
2407 sprintf(opt_name, "%s.recommendation", pref);
2408 handle_queryExpression(resultset->options, opt_name,
2409 ent->subqueryRecommendation);
2411 if (ent->subqueryCount)
2414 sprintf(opt_name, "%s.count", pref);
2415 ZOOM_options_set_int(resultset->options, opt_name,
2416 *ent->subqueryCount);
2424 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2426 ZOOM_resultset resultset;
2429 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2432 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2433 ZOOM_connection_put_event(c, event);
2435 resultset = c->tasks->u.search.resultset;
2437 if (sr->resultSetStatus)
2439 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2440 *sr->resultSetStatus);
2442 if (sr->presentStatus)
2444 ZOOM_options_set_int(resultset->options, "presentStatus",
2445 *sr->presentStatus);
2447 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2449 resultset->size = *sr->resultCount;
2450 handle_records(c, sr->records, 0);
2453 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2455 if (res->diagnostics && res->num_diagnostics > 0)
2456 response_diag(c, res->diagnostics[0]);
2459 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2461 NMEM nmem = odr_extract_mem(c->odr_in);
2464 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2466 scan = c->tasks->u.scan.scan;
2468 if (res->entries && res->entries->nonsurrogateDiagnostics)
2469 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2470 scan->scan_response = res;
2471 nmem_transfer(odr_getmem(scan->odr), nmem);
2473 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2474 if (res->positionOfTerm)
2475 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2476 if (res->scanStatus)
2477 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2478 if (res->numberOfEntriesReturned)
2479 ZOOM_options_set_int(scan->options, "number",
2480 *res->numberOfEntriesReturned);
2485 static zoom_ret send_sort(ZOOM_connection c,
2486 ZOOM_resultset resultset)
2489 resultset->r_sort_spec = 0;
2490 if (resultset->r_sort_spec)
2492 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2493 Z_SortRequest *req = apdu->u.sortRequest;
2495 req->num_inputResultSetNames = 1;
2496 req->inputResultSetNames = (Z_InternationalString **)
2497 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2498 req->inputResultSetNames[0] =
2499 odr_strdup(c->odr_out, resultset->setname);
2500 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2501 req->sortSequence = resultset->r_sort_spec;
2502 resultset->r_sort_spec = 0;
2503 return send_APDU(c, apdu);
2505 return zoom_complete;
2508 static zoom_ret send_present(ZOOM_connection c)
2511 Z_PresentRequest *req = 0;
2513 const char *syntax = 0;
2514 const char *elementSetName = 0;
2515 ZOOM_resultset resultset;
2520 yaz_log(log_details, "%p send_present no tasks", c);
2521 return zoom_complete;
2524 switch (c->tasks->which)
2526 case ZOOM_TASK_SEARCH:
2527 resultset = c->tasks->u.search.resultset;
2528 start = &c->tasks->u.search.start;
2529 count = &c->tasks->u.search.count;
2530 syntax = c->tasks->u.search.syntax;
2531 elementSetName = c->tasks->u.search.elementSetName;
2533 case ZOOM_TASK_RETRIEVE:
2534 resultset = c->tasks->u.retrieve.resultset;
2535 start = &c->tasks->u.retrieve.start;
2536 count = &c->tasks->u.retrieve.count;
2537 syntax = c->tasks->u.retrieve.syntax;
2538 elementSetName = c->tasks->u.retrieve.elementSetName;
2541 return zoom_complete;
2543 yaz_log(log_details, "%p send_present start=%d count=%d",
2546 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2548 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2551 if (c->error) /* don't continue on error */
2552 return zoom_complete;
2553 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2554 resultset, *start, *count);
2556 for (i = 0; i < *count; i++)
2559 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2564 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2565 ZOOM_connection_put_event(c, event);
2573 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2574 return zoom_complete;
2577 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2578 req = apdu->u.presentRequest;
2581 yaz_log(log_details, "%p send_present skip=%d", c, i);
2583 *req->resultSetStartPoint = *start + 1;
2584 *req->numberOfRecordsRequested = resultset->step>0 ?
2585 resultset->step : *count;
2586 if (*req->numberOfRecordsRequested + *start > resultset->size)
2587 *req->numberOfRecordsRequested = resultset->size - *start;
2588 assert(*req->numberOfRecordsRequested > 0);
2590 if (syntax && *syntax)
2591 req->preferredRecordSyntax =
2592 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2594 if (resultset->schema && *resultset->schema)
2596 Z_RecordComposition *compo = (Z_RecordComposition *)
2597 odr_malloc(c->odr_out, sizeof(*compo));
2599 req->recordComposition = compo;
2600 compo->which = Z_RecordComp_complex;
2601 compo->u.complex = (Z_CompSpec *)
2602 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2603 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2604 odr_malloc(c->odr_out, sizeof(bool_t));
2605 *compo->u.complex->selectAlternativeSyntax = 0;
2607 compo->u.complex->generic = (Z_Specification *)
2608 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2610 compo->u.complex->generic->which = Z_Schema_oid;
2611 compo->u.complex->generic->schema.oid = (Odr_oid *)
2612 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2614 if (!compo->u.complex->generic->schema.oid)
2616 /* OID wasn't a schema! Try record syntax instead. */
2618 compo->u.complex->generic->schema.oid = (Odr_oid *)
2619 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2621 if (elementSetName && *elementSetName)
2623 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2624 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2625 compo->u.complex->generic->elementSpec->which =
2626 Z_ElementSpec_elementSetName;
2627 compo->u.complex->generic->elementSpec->u.elementSetName =
2628 odr_strdup(c->odr_out, elementSetName);
2631 compo->u.complex->generic->elementSpec = 0;
2632 compo->u.complex->num_dbSpecific = 0;
2633 compo->u.complex->dbSpecific = 0;
2634 compo->u.complex->num_recordSyntax = 0;
2635 compo->u.complex->recordSyntax = 0;
2637 else if (elementSetName && *elementSetName)
2639 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2640 odr_malloc(c->odr_out, sizeof(*esn));
2641 Z_RecordComposition *compo = (Z_RecordComposition *)
2642 odr_malloc(c->odr_out, sizeof(*compo));
2644 esn->which = Z_ElementSetNames_generic;
2645 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2646 compo->which = Z_RecordComp_simple;
2647 compo->u.simple = esn;
2648 req->recordComposition = compo;
2650 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2651 return send_APDU(c, apdu);
2654 ZOOM_API(ZOOM_scanset)
2655 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2658 ZOOM_query q = ZOOM_query_create();
2660 ZOOM_query_prefix(q, start);
2662 s = ZOOM_connection_scan1(c, q);
2663 ZOOM_query_destroy(q);
2668 ZOOM_API(ZOOM_scanset)
2669 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2673 ZOOM_scanset scan = 0;
2676 * We need to check the query-type, so we can recognise CQL and
2677 * CCL and compile them into a form that we can use here. The
2678 * ZOOM_query structure has no explicit `type' member, but
2679 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2680 * functions shows how the structure is set up in each case.
2684 else if (q->z_query->which == Z_Query_type_1)
2686 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2687 c, q, q->query_string);
2688 start = q->query_string;
2690 else if (q->z_query->which == Z_Query_type_104)
2692 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2693 c, q, q->query_string);
2694 start = freeme = cql2pqf(c, q->query_string);
2700 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2701 c, q, q->query_string);
2705 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2706 scan->connection = c;
2707 scan->odr = odr_createmem(ODR_DECODE);
2708 scan->options = ZOOM_options_create_with_parent(c->options);
2710 scan->scan_response = 0;
2711 scan->termListAndStartPoint =
2712 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2716 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
2719 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
2722 yaz_query_charset_convert_apt(scan->termListAndStartPoint,
2729 scan->databaseNames = set_DatabaseNames(c, c->options,
2730 &scan->num_databaseNames,
2732 if (scan->termListAndStartPoint != 0)
2734 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2735 task->u.scan.scan = scan;
2740 while (ZOOM_event(1, &c))
2748 ZOOM_scanset_destroy(ZOOM_scanset scan)
2753 if (scan->refcount == 0)
2755 odr_destroy(scan->odr);
2757 ZOOM_options_destroy(scan->options);
2762 static zoom_ret send_package(ZOOM_connection c)
2766 yaz_log(log_details, "%p send_package", c);
2768 return zoom_complete;
2769 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2771 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2772 ZOOM_connection_put_event(c, event);
2774 c->buf_out = c->tasks->u.package->buf_out;
2775 c->len_out = c->tasks->u.package->len_out;
2780 static zoom_ret send_scan(ZOOM_connection c)
2783 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2784 Z_ScanRequest *req = apdu->u.scanRequest;
2786 yaz_log(log_details, "%p send_scan", c);
2788 return zoom_complete;
2789 assert (c->tasks->which == ZOOM_TASK_SCAN);
2790 scan = c->tasks->u.scan.scan;
2792 req->termListAndStartPoint = scan->termListAndStartPoint;
2793 req->attributeSet = scan->attributeSet;
2795 *req->numberOfTermsRequested =
2796 ZOOM_options_get_int(scan->options, "number", 10);
2798 req->preferredPositionInResponse =
2799 odr_intdup(c->odr_out,
2800 ZOOM_options_get_int(scan->options, "position", 1));
2803 odr_intdup(c->odr_out,
2804 ZOOM_options_get_int(scan->options, "stepSize", 0));
2806 req->databaseNames = scan->databaseNames;
2807 req->num_databaseNames = scan->num_databaseNames;
2809 return send_APDU(c, apdu);
2813 ZOOM_scanset_size(ZOOM_scanset scan)
2815 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2817 return scan->scan_response->entries->num_entries;
2820 ZOOM_API(const char *)
2821 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2824 const char *term = 0;
2825 size_t noent = ZOOM_scanset_size(scan);
2826 Z_ScanResponse *res = scan->scan_response;
2832 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2834 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2836 if (t->term->which == Z_Term_general)
2838 term = (const char *) t->term->u.general->buf;
2839 *len = t->term->u.general->len;
2841 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2846 ZOOM_API(const char *)
2847 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2850 const char *term = 0;
2851 size_t noent = ZOOM_scanset_size(scan);
2852 Z_ScanResponse *res = scan->scan_response;
2858 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2860 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2864 term = t->displayTerm;
2865 *len = strlen(term);
2867 else if (t->term->which == Z_Term_general)
2869 term = (const char *) t->term->u.general->buf;
2870 *len = t->term->u.general->len;
2872 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2877 ZOOM_API(const char *)
2878 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2880 return ZOOM_options_get(scan->options, key);
2884 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2887 ZOOM_options_set(scan->options, key, val);
2890 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
2893 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2894 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2896 str = ZOOM_options_get(p->options, "package-name");
2898 req->packageName = odr_strdup(p->odr_out, str);
2900 str = ZOOM_options_get(p->options, "user-id");
2902 req->userId = odr_strdup(p->odr_out, str);
2904 req->packageType = odr_oiddup(p->odr_out, oid);
2906 str = ZOOM_options_get(p->options, "function");
2909 if (!strcmp (str, "create"))
2910 *req->function = Z_ExtendedServicesRequest_create;
2911 if (!strcmp (str, "delete"))
2912 *req->function = Z_ExtendedServicesRequest_delete;
2913 if (!strcmp (str, "modify"))
2914 *req->function = Z_ExtendedServicesRequest_modify;
2917 str = ZOOM_options_get(p->options, "waitAction");
2920 if (!strcmp (str, "wait"))
2921 *req->waitAction = Z_ExtendedServicesRequest_wait;
2922 if (!strcmp (str, "waitIfPossible"))
2923 *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
2924 if (!strcmp (str, "dontWait"))
2925 *req->waitAction = Z_ExtendedServicesRequest_dontWait;
2926 if (!strcmp (str, "dontReturnPackage"))
2927 *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
2932 static const char *ill_array_lookup(void *clientData, const char *idx)
2934 ZOOM_package p = (ZOOM_package) clientData;
2935 return ZOOM_options_get(p->options, idx+4);
2938 static Z_External *encode_ill_request(ZOOM_package p)
2940 ODR out = p->odr_out;
2943 struct ill_get_ctl ctl;
2945 ctl.odr = p->odr_out;
2947 ctl.f = ill_array_lookup;
2949 req = ill_get_ILLRequest(&ctl, "ill", 0);
2951 if (!ill_Request(out, &req, 0, 0))
2953 int ill_request_size;
2954 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2955 if (ill_request_buf)
2956 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2961 int illRequest_size = 0;
2962 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2964 r = (Z_External *) odr_malloc(out, sizeof(*r));
2965 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
2966 r->indirect_reference = 0;
2968 r->which = Z_External_single;
2970 r->u.single_ASN1_type =
2971 odr_create_Odr_oct(out,
2972 (unsigned char *)illRequest_buf,
2978 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2980 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2983 req->which = Z_IOItemOrder_esRequest;
2984 req->u.esRequest = (Z_IORequest *)
2985 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2987 /* to keep part ... */
2988 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2989 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2990 req->u.esRequest->toKeep->supplDescription = 0;
2991 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2992 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2994 str = ZOOM_options_get(p->options, "contact-name");
2995 req->u.esRequest->toKeep->contact->name = str ?
2996 odr_strdup(p->odr_out, str) : 0;
2998 str = ZOOM_options_get(p->options, "contact-phone");
2999 req->u.esRequest->toKeep->contact->phone = str ?
3000 odr_strdup(p->odr_out, str) : 0;
3002 str = ZOOM_options_get(p->options, "contact-email");
3003 req->u.esRequest->toKeep->contact->email = str ?
3004 odr_strdup(p->odr_out, str) : 0;
3006 req->u.esRequest->toKeep->addlBilling = 0;
3008 /* not to keep part ... */
3009 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
3010 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3012 str = ZOOM_options_get(p->options, "itemorder-setname");
3017 req->u.esRequest->notToKeep->resultSetItem = 0;
3020 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3021 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3023 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3024 odr_strdup(p->odr_out, str);
3025 req->u.esRequest->notToKeep->resultSetItem->item =
3026 (int *) odr_malloc(p->odr_out, sizeof(int));
3028 str = ZOOM_options_get(p->options, "itemorder-item");
3029 *req->u.esRequest->notToKeep->resultSetItem->item =
3030 (str ? atoi(str) : 1);
3033 str = ZOOM_options_get(p->options, "doc");
3036 req->u.esRequest->notToKeep->itemRequest =
3037 z_ext_record_xml(p->odr_out, str, strlen(str));
3040 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3045 Z_APDU *create_admin_package(ZOOM_package p, int type,
3046 Z_ESAdminOriginPartToKeep **toKeepP,
3047 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3049 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3052 Z_ESAdminOriginPartToKeep *toKeep;
3053 Z_ESAdminOriginPartNotToKeep *notToKeep;
3054 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3055 const char *first_db = "Default";
3057 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3062 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3064 r->indirect_reference = 0;
3065 r->which = Z_External_ESAdmin;
3067 r->u.adminService = (Z_Admin *)
3068 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3069 r->u.adminService->which = Z_Admin_esRequest;
3070 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3071 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3073 toKeep = r->u.adminService->u.esRequest->toKeep =
3074 (Z_ESAdminOriginPartToKeep *)
3075 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3076 toKeep->which = type;
3077 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3078 toKeep->u.create = odr_nullval();
3079 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3081 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3082 (Z_ESAdminOriginPartNotToKeep *)
3083 odr_malloc(p->odr_out,
3084 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3085 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3086 notToKeep->u.recordsWillFollow = odr_nullval();
3090 *notToKeepP = notToKeep;
3095 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3097 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3098 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3099 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3100 const char *doc = ZOOM_options_get(p->options, "doc");
3105 req->taskSpecificParameters = ext;
3106 ext->direct_reference = req->packageType;
3107 ext->descriptor = 0;
3108 ext->indirect_reference = 0;
3110 ext->which = Z_External_octet;
3111 ext->u.single_ASN1_type =
3112 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
3117 static Z_APDU *create_update_package(ZOOM_package p)
3120 const char *first_db = "Default";
3122 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3123 const char *action = ZOOM_options_get(p->options, "action");
3124 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
3125 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3126 const char *record_buf = ZOOM_options_get(p->options, "record");
3127 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3128 const char *version = ZOOM_options_get(p->options, "updateVersion");
3130 const char *correlationInfo_note =
3131 ZOOM_options_get(p->options, "correlationInfo.note");
3132 const char *correlationInfo_id =
3133 ZOOM_options_get(p->options, "correlationInfo.id");
3135 Odr_oid *syntax_oid = 0;
3136 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
3144 record_buf = "void";
3145 syntax_str = "SUTRS";
3150 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3151 CLASS_RECSYN, syntax_str,
3163 package_oid = yaz_oid_extserv_database_update_first_version;
3164 /* old update does not support specialUpdate */
3166 action = "recordInsert";
3170 action = "specialUpdate";
3171 package_oid = yaz_oid_extserv_database_update_second_version;
3175 action = "specialUpdate";
3176 package_oid = yaz_oid_extserv_database_update;
3182 if (!strcmp(action, "recordInsert"))
3183 action_no = Z_IUOriginPartToKeep_recordInsert;
3184 else if (!strcmp(action, "recordReplace"))
3185 action_no = Z_IUOriginPartToKeep_recordReplace;
3186 else if (!strcmp(action, "recordDelete"))
3187 action_no = Z_IUOriginPartToKeep_recordDelete;
3188 else if (!strcmp(action, "elementUpdate"))
3189 action_no = Z_IUOriginPartToKeep_elementUpdate;
3190 else if (!strcmp(action, "specialUpdate"))
3191 action_no = Z_IUOriginPartToKeep_specialUpdate;
3195 apdu = create_es_package(p, package_oid);
3198 Z_IUOriginPartToKeep *toKeep;
3199 Z_IUSuppliedRecords *notToKeep;
3200 Z_External *r = (Z_External *)
3201 odr_malloc(p->odr_out, sizeof(*r));
3202 const char *elementSetName =
3203 ZOOM_options_get(p->options, "elementSetName");
3205 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3207 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
3209 r->which = Z_External_update;
3210 r->indirect_reference = 0;
3211 r->u.update = (Z_IUUpdate *)
3212 odr_malloc(p->odr_out, sizeof(*r->u.update));
3214 r->u.update->which = Z_IUUpdate_esRequest;
3215 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3216 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3217 toKeep = r->u.update->u.esRequest->toKeep =
3218 (Z_IUOriginPartToKeep *)
3219 odr_malloc(p->odr_out, sizeof(*toKeep));
3221 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3224 toKeep->elementSetName = 0;
3226 toKeep->elementSetName = odr_strdup(p->odr_out, elementSetName);
3228 toKeep->actionQualifier = 0;
3229 toKeep->action = odr_intdup(p->odr_out, action_no);
3231 notToKeep = r->u.update->u.esRequest->notToKeep =
3232 (Z_IUSuppliedRecords *)
3233 odr_malloc(p->odr_out, sizeof(*notToKeep));
3235 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3236 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3237 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3238 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3239 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3242 notToKeep->elements[0]->u.opaque =
3243 odr_create_Odr_oct(p->odr_out,
3244 (const unsigned char *) recordIdOpaque,
3245 strlen(recordIdOpaque));
3247 else if (recordIdNumber)
3249 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3251 notToKeep->elements[0]->u.number =
3252 odr_intdup(p->odr_out, atoi(recordIdNumber));
3255 notToKeep->elements[0]->u.opaque = 0;
3256 notToKeep->elements[0]->supplementalId = 0;
3257 if (correlationInfo_note || correlationInfo_id)
3259 Z_IUCorrelationInfo *ci;
3260 ci = notToKeep->elements[0]->correlationInfo =
3261 odr_malloc(p->odr_out, sizeof(*ci));
3262 ci->note = correlationInfo_note ?
3263 odr_strdup(p->odr_out, correlationInfo_note) : 0;
3264 ci->id = correlationInfo_id ?
3265 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3268 notToKeep->elements[0]->correlationInfo = 0;
3269 notToKeep->elements[0]->record =
3270 z_ext_record_oid(p->odr_out, syntax_oid,
3271 record_buf, strlen(record_buf));
3275 ODR print = odr_createmem(ODR_PRINT);
3277 z_APDU(print, &apdu, 0, 0);
3284 ZOOM_package_send(ZOOM_package p, const char *type)
3291 odr_reset(p->odr_out);
3294 if (!strcmp(type, "itemorder"))
3296 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3299 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3301 r->direct_reference =
3302 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3304 r->which = Z_External_itemOrder;
3305 r->indirect_reference = 0;
3306 r->u.itemOrder = encode_item_order(p);
3308 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3311 else if (!strcmp(type, "create")) /* create database */
3313 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3316 else if (!strcmp(type, "drop")) /* drop database */
3318 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3321 else if (!strcmp(type, "commit")) /* commit changes */
3323 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3326 else if (!strcmp(type, "update")) /* update record(s) */
3328 apdu = create_update_package(p);
3330 else if (!strcmp(type, "xmlupdate"))
3332 apdu = create_xmlupdate_package(p);
3336 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3340 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3341 task->u.package = p;
3342 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3343 p->buf_out = (char *) xmalloc(p->len_out);
3344 memcpy(p->buf_out, buf, p->len_out);
3349 while (ZOOM_event(1, &c))
3356 ZOOM_API(ZOOM_package)
3357 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3359 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3362 p->odr_out = odr_createmem(ODR_ENCODE);
3363 p->options = ZOOM_options_create_with_parent2(options, c->options);
3371 ZOOM_package_destroy(ZOOM_package p)
3376 if (p->refcount == 0)
3378 odr_destroy(p->odr_out);
3381 ZOOM_options_destroy(p->options);
3386 ZOOM_API(const char *)
3387 ZOOM_package_option_get(ZOOM_package p, const char *key)
3389 return ZOOM_options_get(p->options, key);
3394 ZOOM_package_option_set(ZOOM_package p, const char *key,
3397 ZOOM_options_set(p->options, key, val);
3400 static int ZOOM_connection_exec_task(ZOOM_connection c)
3402 ZOOM_task task = c->tasks;
3403 zoom_ret ret = zoom_complete;
3407 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3408 c, task->which, task->running);
3409 if (c->error != ZOOM_ERROR_NONE)
3411 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3412 "removing tasks because of error = %d", c, c->error);
3413 ZOOM_connection_remove_tasks(c);
3418 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3419 "task already running", c);
3423 ret = zoom_complete;
3424 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3426 switch (task->which)
3428 case ZOOM_TASK_SEARCH:
3429 if (c->proto == PROTO_HTTP)
3430 ret = ZOOM_connection_srw_send_search(c);
3432 ret = ZOOM_connection_send_search(c);
3434 case ZOOM_TASK_RETRIEVE:
3435 if (c->proto == PROTO_HTTP)
3436 ret = ZOOM_connection_srw_send_search(c);
3438 ret = send_present(c);
3440 case ZOOM_TASK_CONNECT:
3441 ret = do_connect(c);
3443 case ZOOM_TASK_SCAN:
3446 case ZOOM_TASK_PACKAGE:
3447 ret = send_package(c);
3449 case ZOOM_TASK_SORT:
3450 c->tasks->u.sort.resultset->r_sort_spec =
3451 c->tasks->u.sort.q->sort_spec;
3452 ret = send_sort(c, c->tasks->u.sort.resultset);
3458 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3459 "remove tasks because no connection exist", c);
3460 ZOOM_connection_remove_tasks(c);
3462 if (ret == zoom_complete)
3464 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3465 "task removed (complete)", c);
3466 ZOOM_connection_remove_task(c);
3469 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3474 static zoom_ret send_sort_present(ZOOM_connection c)
3476 zoom_ret r = zoom_complete;
3478 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3479 r = send_sort(c, c->tasks->u.search.resultset);
3480 if (r == zoom_complete)
3481 r = send_present(c);
3485 static int es_response(ZOOM_connection c,
3486 Z_ExtendedServicesResponse *res)
3488 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3490 if (res->diagnostics && res->num_diagnostics > 0)
3491 response_diag(c, res->diagnostics[0]);
3492 if (res->taskPackage &&
3493 res->taskPackage->which == Z_External_extendedService)
3495 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3496 Odr_oct *id = taskPackage->targetReference;
3499 ZOOM_options_setl(c->tasks->u.package->options,
3500 "targetReference", (char*) id->buf, id->len);
3502 if (res->taskPackage &&
3503 res->taskPackage->which == Z_External_octet)
3505 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3506 ZOOM_options_setl(c->tasks->u.package->options,
3507 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3512 static void interpret_init_diag(ZOOM_connection c,
3513 Z_DiagnosticFormat *diag)
3517 Z_DiagnosticFormat_s *ds = diag->elements[0];
3518 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3519 response_default_diag(c, ds->u.defaultDiagRec);
3524 static void interpret_otherinformation_field(ZOOM_connection c,
3525 Z_OtherInformation *ui)
3528 for (i = 0; i < ui->num_elements; i++)
3530 Z_OtherInformationUnit *unit = ui->list[i];
3531 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3532 unit->information.externallyDefinedInfo &&
3533 unit->information.externallyDefinedInfo->which ==
3536 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3542 static void set_init_option(const char *name, void *clientData) {
3543 ZOOM_connection c = (ZOOM_connection) clientData;
3546 sprintf(buf, "init_opt_%.70s", name);
3547 ZOOM_connection_option_set(c, buf, "1");
3551 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3553 Z_InitResponse *initrs;
3555 ZOOM_connection_set_mask(c, 0);
3556 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3559 case Z_APDU_initResponse:
3560 yaz_log(log_api, "%p recv_apdu: Received Init response", c);
3561 initrs = apdu->u.initResponse;
3562 ZOOM_connection_option_set(c, "serverImplementationId",
3563 initrs->implementationId ?
3564 initrs->implementationId : "");
3565 ZOOM_connection_option_set(c, "serverImplementationName",
3566 initrs->implementationName ?
3567 initrs->implementationName : "");
3568 ZOOM_connection_option_set(c, "serverImplementationVersion",
3569 initrs->implementationVersion ?
3570 initrs->implementationVersion : "");
3571 /* Set the three old options too, for old applications */
3572 ZOOM_connection_option_set(c, "targetImplementationId",
3573 initrs->implementationId ?
3574 initrs->implementationId : "");
3575 ZOOM_connection_option_set(c, "targetImplementationName",
3576 initrs->implementationName ?
3577 initrs->implementationName : "");
3578 ZOOM_connection_option_set(c, "targetImplementationVersion",
3579 initrs->implementationVersion ?
3580 initrs->implementationVersion : "");
3582 /* Make initrs->options available as ZOOM-level options */
3583 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3585 if (!*initrs->result)
3587 Z_External *uif = initrs->userInformationField;
3589 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3591 if (uif && uif->which == Z_External_userInfo1)
3592 interpret_otherinformation_field(c, uif->u.userInfo1);
3597 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
3598 yaz_oid_userinfo_cookie, 1, 0);
3599 xfree(c->cookie_in);
3602 c->cookie_in = xstrdup(cookie);
3603 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3604 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3605 c->support_named_resultsets = 1;
3608 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3609 ZOOM_connection_remove_task(c);
3611 ZOOM_connection_exec_task(c);
3613 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3615 NMEM tmpmem = nmem_create();
3616 Z_CharSetandLanguageNegotiation *p =
3617 yaz_get_charneg_record(initrs->otherInfo);
3621 char *charset = NULL, *lang = NULL;
3624 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3625 yaz_log(log_details, "%p recv_apdu target accepted: "
3626 "charset %s, language %s, select %d",
3628 charset ? charset : "none", lang ? lang : "none", sel);
3630 ZOOM_connection_option_set(c, "negotiation-charset",
3633 ZOOM_connection_option_set(c, "negotiation-lang",
3636 ZOOM_connection_option_set(
3637 c, "negotiation-charset-in-effect-for-records",
3638 (sel != 0) ? "1" : "0");
3639 nmem_destroy(tmpmem);
3643 case Z_APDU_searchResponse:
3644 yaz_log(log_api, "%p recv_apdu Search response", c);
3645 handle_search_response(c, apdu->u.searchResponse);
3646 if (send_sort_present(c) == zoom_complete)
3647 ZOOM_connection_remove_task(c);
3649 case Z_APDU_presentResponse:
3650 yaz_log(log_api, "%p recv_apdu Present response", c);
3651 handle_present_response(c, apdu->u.presentResponse);
3652 if (send_present(c) == zoom_complete)
3653 ZOOM_connection_remove_task(c);
3655 case Z_APDU_sortResponse:
3656 yaz_log(log_api, "%p recv_apdu Sort response", c);
3657 sort_response(c, apdu->u.sortResponse);
3658 if (send_present(c) == zoom_complete)
3659 ZOOM_connection_remove_task(c);
3661 case Z_APDU_scanResponse:
3662 yaz_log(log_api, "%p recv_apdu Scan response", c);
3663 scan_response(c, apdu->u.scanResponse);
3664 ZOOM_connection_remove_task(c);
3666 case Z_APDU_extendedServicesResponse:
3667 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3668 es_response(c, apdu->u.extendedServicesResponse);
3669 ZOOM_connection_remove_task(c);
3672 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3673 if (!ZOOM_test_reconnect(c))
3675 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3680 yaz_log(log_api, "%p Received unknown PDU", c);
3681 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3687 static void handle_srw_response(ZOOM_connection c,
3688 Z_SRW_searchRetrieveResponse *res)
3690 ZOOM_resultset resultset = 0;
3695 const char *syntax, *elementSetName;
3700 switch(c->tasks->which)
3702 case ZOOM_TASK_SEARCH:
3703 resultset = c->tasks->u.search.resultset;
3704 start = &c->tasks->u.search.start;
3705 syntax = c->tasks->u.search.syntax;
3706 elementSetName = c->tasks->u.search.elementSetName;
3708 case ZOOM_TASK_RETRIEVE:
3709 resultset = c->tasks->u.retrieve.resultset;
3710 start = &c->tasks->u.retrieve.start;
3711 syntax = c->tasks->u.retrieve.syntax;
3712 elementSetName = c->tasks->u.retrieve.elementSetName;
3717 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3718 ZOOM_connection_put_event(c, event);
3720 resultset->size = 0;
3722 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3724 if (res->numberOfRecords)
3725 resultset->size = *res->numberOfRecords;
3727 for (i = 0; i<res->num_records; i++)
3731 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3732 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3734 if (res->records[i].recordPosition &&
3735 *res->records[i].recordPosition > 0)
3736 pos = *res->records[i].recordPosition - 1;
3740 npr->databaseName = 0;
3741 npr->which = Z_NamePlusRecord_databaseRecord;
3742 npr->u.databaseRecord = (Z_External *)
3743 odr_malloc(c->odr_in, sizeof(Z_External));
3744 npr->u.databaseRecord->descriptor = 0;
3745 npr->u.databaseRecord->direct_reference =
3746 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
3747 npr->u.databaseRecord->which = Z_External_octet;
3749 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3750 odr_malloc(c->odr_in, sizeof(Odr_oct));
3751 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3752 res->records[i].recordData_buf;
3753 npr->u.databaseRecord->u.octet_aligned->len =
3754 npr->u.databaseRecord->u.octet_aligned->size =
3755 res->records[i].recordData_len;
3756 record_cache_add(resultset, npr, pos, syntax, elementSetName);
3758 if (res->num_diagnostics > 0)
3760 const char *uri = res->diagnostics[0].uri;
3765 if ((cp = strrchr(uri, '/')))
3767 set_dset_error(c, code, uri,
3768 res->diagnostics[0].details, 0);
3771 nmem = odr_extract_mem(c->odr_in);
3772 nmem_transfer(odr_getmem(resultset->odr), nmem);
3778 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3781 const char *addinfo = 0;
3782 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3784 ZOOM_connection_set_mask(c, 0);
3785 yaz_log(log_details, "%p handle_http", c);
3787 if (!yaz_srw_check_content_type(hres))
3788 addinfo = "content-type";
3791 Z_SOAP *soap_package = 0;
3793 Z_SOAP_Handler soap_handlers[2] = {
3794 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
3797 ret = z_soap_codec(o, &soap_package,
3798 &hres->content_buf, &hres->content_len,
3800 if (!ret && soap_package->which == Z_SOAP_generic &&
3801 soap_package->u.generic->no == 0)
3803 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3804 if (sr->which == Z_SRW_searchRetrieve_response)
3805 handle_srw_response(c, sr->u.response);
3809 else if (!ret && (soap_package->which == Z_SOAP_fault
3810 || soap_package->which == Z_SOAP_error))
3812 set_HTTP_error(c, hres->code,
3813 soap_package->u.fault->fault_code,
3814 soap_package->u.fault->fault_string);
3821 if (hres->code != 200)
3822 set_HTTP_error(c, hres->code, 0, 0);
3824 set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
3827 ZOOM_connection_remove_task(c);
3828 if (!strcmp(hres->version, "1.0"))
3830 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3831 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3836 /* HTTP 1.1: only if no close we stay alive .. */
3837 if (connection_head && !strcmp(connection_head, "close"))
3843 static int do_read(ZOOM_connection c)
3848 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3849 ZOOM_connection_put_event(c, event);
3851 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3852 more = cs_more(c->cs);
3853 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3858 if (!ZOOM_test_reconnect(c))
3860 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3869 odr_reset(c->odr_in);
3870 odr_setbuf(c->odr_in, c->buf_in, r, 0);
3871 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3872 ZOOM_connection_put_event(c, event);
3874 if (!z_GDU(c->odr_in, &gdu, 0, 0))
3877 int err = odr_geterrorx(c->odr_in, &x);
3879 const char *element = odr_getelement(c->odr_in);
3880 yaz_snprintf(msg, sizeof(msg),
3881 "ODR code %d:%d element=%s offset=%d",
3882 err, x, element ? element : "<unknown>",
3883 odr_offset(c->odr_in));
3884 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3887 FILE *ber_file = yaz_log_file();
3889 odr_dumpBER(ber_file, c->buf_in, r);
3893 else if (gdu->which == Z_GDU_Z3950)
3894 recv_apdu(c, gdu->u.z3950);
3895 else if (gdu->which == Z_GDU_HTTP_Response)
3898 handle_http(c, gdu->u.HTTP_Response);
3900 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3904 c->reconnect_ok = 0;
3909 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3914 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3915 ZOOM_connection_put_event(c, event);
3917 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3918 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3920 yaz_log(log_details, "%p do_write_ex write failed", c);
3921 if (ZOOM_test_reconnect(c))
3923 return zoom_pending;
3925 if (c->state == STATE_CONNECTING)
3926 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3928 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3930 return zoom_complete;
3934 int mask = ZOOM_SELECT_EXCEPT;
3935 if (c->cs->io_pending & CS_WANT_WRITE)
3936 mask += ZOOM_SELECT_WRITE;
3937 if (c->cs->io_pending & CS_WANT_READ)
3938 mask += ZOOM_SELECT_READ;
3939 ZOOM_connection_set_mask(c, mask);
3940 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3945 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
3946 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3949 return zoom_pending;
3952 static zoom_ret do_write(ZOOM_connection c)
3954 return do_write_ex(c, c->buf_out, c->len_out);
3958 ZOOM_API(const char *)
3959 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3961 return ZOOM_options_get(c->options, key);
3964 ZOOM_API(const char *)
3965 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3967 return ZOOM_options_getl(c->options, key, lenp);
3971 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3974 ZOOM_options_set(c->options, key, val);
3978 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3979 const char *val, int len)
3981 ZOOM_options_setl(c->options, key, val, len);
3984 ZOOM_API(const char *)
3985 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3987 return ZOOM_options_get(r->options, key);
3991 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3994 ZOOM_options_set(r->options, key, val);
3999 ZOOM_connection_errcode(ZOOM_connection c)
4001 return ZOOM_connection_error(c, 0, 0);
4004 ZOOM_API(const char *)
4005 ZOOM_connection_errmsg(ZOOM_connection c)
4008 ZOOM_connection_error(c, &msg, 0);
4012 ZOOM_API(const char *)
4013 ZOOM_connection_addinfo(ZOOM_connection c)
4015 const char *addinfo;
4016 ZOOM_connection_error(c, 0, &addinfo);
4020 ZOOM_API(const char *)
4021 ZOOM_connection_diagset(ZOOM_connection c)
4023 const char *diagset;
4024 ZOOM_connection_error_x(c, 0, 0, &diagset);
4028 ZOOM_API(const char *)
4029 ZOOM_diag_str(int error)
4033 case ZOOM_ERROR_NONE:
4035 case ZOOM_ERROR_CONNECT:
4036 return "Connect failed";
4037 case ZOOM_ERROR_MEMORY:
4038 return "Out of memory";
4039 case ZOOM_ERROR_ENCODE:
4040 return "Encoding failed";
4041 case ZOOM_ERROR_DECODE:
4042 return "Decoding failed";
4043 case ZOOM_ERROR_CONNECTION_LOST:
4044 return "Connection lost";
4045 case ZOOM_ERROR_INIT:
4046 return "Init rejected";
4047 case ZOOM_ERROR_INTERNAL:
4048 return "Internal failure";
4049 case ZOOM_ERROR_TIMEOUT:
4051 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4052 return "Unsupported protocol";
4053 case ZOOM_ERROR_UNSUPPORTED_QUERY:
4054 return "Unsupported query type";
4055 case ZOOM_ERROR_INVALID_QUERY:
4056 return "Invalid query";
4057 case ZOOM_ERROR_CQL_PARSE:
4058 return "CQL parsing error";
4059 case ZOOM_ERROR_CQL_TRANSFORM:
4060 return "CQL transformation error";
4061 case ZOOM_ERROR_CCL_CONFIG:
4062 return "CCL configuration error";
4063 case ZOOM_ERROR_CCL_PARSE:
4064 return "CCL parsing error";
4066 return diagbib1_str(error);
4071 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4072 const char **addinfo, const char **diagset)
4074 int error = c->error;
4077 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4078 *cp = ZOOM_diag_str(error);
4079 else if (!strcmp(c->diagset, "HTTP"))
4080 *cp = z_HTTP_errmsg(c->error);
4081 else if (!strcmp(c->diagset, "Bib-1"))
4082 *cp = ZOOM_diag_str(error);
4083 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4084 *cp = yaz_diag_srw_str(c->error);
4086 *cp = "Unknown error and diagnostic set";
4089 *addinfo = c->addinfo ? c->addinfo : "";
4091 *diagset = c->diagset ? c->diagset : "";
4096 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4097 const char **addinfo)
4099 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4102 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4104 ZOOM_Event event = 0;
4105 int r = cs_look(c->cs);
4106 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4111 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4112 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4114 ZOOM_connection_put_event(c, event);
4116 else if (r == CS_CONNECT)
4118 int ret = ret = cs_rcvconnect(c->cs);
4119 yaz_log(log_details, "%p ZOOM_connection_do_io "
4120 "cs_rcvconnect returned %d", c, ret);
4123 int mask = ZOOM_SELECT_EXCEPT;
4124 if (c->cs->io_pending & CS_WANT_WRITE)
4125 mask += ZOOM_SELECT_WRITE;
4126 if (c->cs->io_pending & CS_WANT_READ)
4127 mask += ZOOM_SELECT_READ;
4128 ZOOM_connection_set_mask(c, mask);
4129 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
4130 ZOOM_connection_put_event(c, event);
4134 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4135 ZOOM_connection_put_event(c, event);
4137 if (c->proto == PROTO_Z3950)
4138 ZOOM_connection_send_init(c);
4141 /* no init request for SRW .. */
4142 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4143 ZOOM_connection_remove_task(c);
4144 ZOOM_connection_set_mask(c, 0);
4145 ZOOM_connection_exec_task(c);
4147 c->state = STATE_ESTABLISHED;
4151 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4157 if (mask & ZOOM_SELECT_EXCEPT)
4159 if (!ZOOM_test_reconnect(c))
4161 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4166 if (mask & ZOOM_SELECT_READ)
4168 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4174 ZOOM_connection_last_event(ZOOM_connection cs)
4177 return ZOOM_EVENT_NONE;
4178 return cs->last_event;
4182 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4184 WRBUF wrbuf = (WRBUF) client_data;
4185 wrbuf_puts(wrbuf, buf);
4189 * Returns an xmalloc()d string containing RPN that corresponds to the
4190 * CQL passed in. On error, sets the Connection object's error state
4191 * and returns a null pointer.
4192 * ### We could cache CQL parser and/or transformer in Connection.
4194 static char *cql2pqf(ZOOM_connection c, const char *cql)
4198 const char *cqlfile;
4199 cql_transform_t trans;
4202 parser = cql_parser_create();
4203 if ((error = cql_parser_string(parser, cql)) != 0) {
4204 cql_parser_destroy(parser);
4205 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4209 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4212 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4214 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4217 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4218 cqlfile, strerror(errno));
4219 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4223 WRBUF wrbuf_result = wrbuf_alloc();
4224 error = cql_transform(trans, cql_parser_result(parser),
4225 cql2pqf_wrbuf_puts, wrbuf_result);
4228 const char *addinfo;
4229 error = cql_transform_error(trans, &addinfo);
4230 sprintf(buf, "%.200s (addinfo=%.200s)",
4231 cql_strerror(error), addinfo);
4232 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4236 result = xstrdup(wrbuf_cstr(wrbuf_result));
4238 cql_transform_close(trans);
4239 wrbuf_destroy(wrbuf_result);
4241 cql_parser_destroy(parser);
4245 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4249 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4250 /* timeout and this connection was waiting */
4251 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4253 ZOOM_connection_put_event(c, event);
4259 ZOOM_connection_process(ZOOM_connection c)
4265 event = ZOOM_connection_get_event(c);
4268 ZOOM_Event_destroy(event);
4271 ZOOM_connection_exec_task(c);
4272 event = ZOOM_connection_get_event(c);
4275 ZOOM_Event_destroy(event);
4282 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4286 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4288 for (i = 0; i<no; i++)
4290 ZOOM_connection c = cs[i];
4292 if (c && ZOOM_connection_process(c))
4298 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4300 if (c->mask && mask)
4301 ZOOM_connection_do_io(c, mask);
4305 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4308 return cs_fileno(c->cs);
4312 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4320 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4327 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4329 return ZOOM_options_get_int(c->options, "timeout", 30);
4335 * indent-tabs-mode: nil
4337 * vim: shiftwidth=4 tabstop=8 expandtab