1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2010 Index Data
3 * See the file LICENSE for details.
7 * \brief Implements ZOOM C interface.
15 #include <yaz/yaz-util.h>
16 #include <yaz/xmalloc.h>
17 #include <yaz/otherinfo.h>
19 #include <yaz/pquery.h>
20 #include <yaz/marcdisp.h>
21 #include <yaz/diagbib1.h>
22 #include <yaz/charneg.h>
27 #include <yaz/query-charset.h>
28 #include <yaz/copy_types.h>
29 #include <yaz/snprintf.h>
31 static int log_api = 0;
32 static int log_details = 0;
39 static void resultset_destroy(ZOOM_resultset r);
40 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
41 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
42 static char *cql2pqf(ZOOM_connection c, const char *cql);
44 ZOOM_API(const char *) ZOOM_get_event_str(int event)
46 static const char *ar[] = {
63 * This wrapper is just for logging failed lookups. It would be nicer
64 * if it could cause failure when a lookup fails, but that's hard.
66 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
67 oid_class oid_class, const char *str) {
68 Odr_oid *res = yaz_string_to_oid_odr(yaz_oid_std(), oid_class, str,
71 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
72 c, (int) oid_class, str);
77 static void initlog(void)
79 static int log_level_initialized = 0;
80 if (!log_level_initialized)
82 log_api = yaz_log_module_level("zoom");
83 log_details = yaz_log_module_level("zoomdetails");
84 log_level_initialized = 1;
88 static ZOOM_Event ZOOM_Event_create(int kind)
90 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
94 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
98 static void ZOOM_Event_destroy(ZOOM_Event event)
103 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
107 c->m_queue_back->prev = event;
108 assert(c->m_queue_front);
112 assert(!c->m_queue_front);
113 c->m_queue_front = event;
115 event->next = c->m_queue_back;
117 c->m_queue_back = event;
120 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
122 ZOOM_Event event = c->m_queue_front;
125 c->last_event = ZOOM_EVENT_NONE;
128 assert(c->m_queue_back);
129 c->m_queue_front = event->prev;
130 if (c->m_queue_front)
132 assert(c->m_queue_back);
133 c->m_queue_front->next = 0;
137 c->last_event = event->kind;
141 static void ZOOM_connection_remove_events(ZOOM_connection c)
144 while ((event = ZOOM_connection_get_event(c)))
145 ZOOM_Event_destroy(event);
148 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
150 ZOOM_Event event = c->m_queue_front;
152 return event ? event->kind : ZOOM_EVENT_NONE;
155 void ZOOM_connection_remove_tasks(ZOOM_connection c);
157 static void set_dset_error(ZOOM_connection c, int error,
159 const char *addinfo, const char *addinfo2)
166 if (!c->diagset || strcmp(dset, c->diagset))
169 c->diagset = xstrdup(dset);
170 /* remove integer part from SRW diagset .. */
171 if ((cp = strrchr(c->diagset, '/')))
174 if (addinfo && addinfo2)
176 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
177 strcpy(c->addinfo, addinfo);
178 strcat(c->addinfo, addinfo2);
181 c->addinfo = xstrdup(addinfo);
182 if (error != ZOOM_ERROR_NONE)
184 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
185 c, c->host_port ? c->host_port : "<>", dset, error,
186 addinfo ? addinfo : "",
187 addinfo2 ? addinfo2 : "");
188 ZOOM_connection_remove_tasks(c);
192 static int uri_to_code(const char *uri)
196 if ((cp = strrchr(uri, '/')))
202 static void set_HTTP_error(ZOOM_connection c, int error,
203 const char *addinfo, const char *addinfo2)
205 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
208 static void set_SRU_error(ZOOM_connection c, Z_SRW_diagnostic *d)
210 const char *uri = d->uri;
212 set_dset_error(c, uri_to_code(uri), uri, d->details, 0);
218 static void set_ZOOM_error(ZOOM_connection c, int error,
221 set_dset_error(c, error, "ZOOM", addinfo, 0);
224 static void clear_error(ZOOM_connection c)
227 * If an error is tied to an operation then it's ok to clear: for
228 * example, a diagnostic returned from a search is cleared by a
229 * subsequent search. However, problems such as Connection Lost
230 * or Init Refused are not cleared, because they are not
231 * recoverable: doing another search doesn't help.
234 ZOOM_connection_remove_events(c);
237 case ZOOM_ERROR_CONNECT:
238 case ZOOM_ERROR_MEMORY:
239 case ZOOM_ERROR_DECODE:
240 case ZOOM_ERROR_CONNECTION_LOST:
241 case ZOOM_ERROR_INIT:
242 case ZOOM_ERROR_INTERNAL:
243 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
246 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
250 void ZOOM_connection_show_task(ZOOM_task task)
254 case ZOOM_TASK_SEARCH:
255 yaz_log(YLOG_LOG, "search p=%p", task);
257 case ZOOM_TASK_RETRIEVE:
258 yaz_log(YLOG_LOG, "retrieve p=%p", task);
260 case ZOOM_TASK_CONNECT:
261 yaz_log(YLOG_LOG, "connect p=%p", task);
264 yaz_log(YLOG_LOG, "scan p=%p", task);
269 void ZOOM_connection_show_tasks(ZOOM_connection c)
272 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
273 for (task = c->tasks; task; task = task->next)
274 ZOOM_connection_show_task(task);
277 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
279 ZOOM_task *taskp = &c->tasks;
281 taskp = &(*taskp)->next;
282 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
283 (*taskp)->running = 0;
284 (*taskp)->which = which;
290 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
292 return c->tasks ? 0 : 1;
295 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
297 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
299 task->next = c->tasks;
308 void ZOOM_connection_remove_task(ZOOM_connection c)
310 ZOOM_task task = c->tasks;
314 c->tasks = task->next;
317 case ZOOM_TASK_SEARCH:
318 resultset_destroy(task->u.search.resultset);
319 xfree(task->u.search.syntax);
320 xfree(task->u.search.elementSetName);
322 case ZOOM_TASK_RETRIEVE:
323 resultset_destroy(task->u.retrieve.resultset);
324 xfree(task->u.retrieve.syntax);
325 xfree(task->u.retrieve.elementSetName);
327 case ZOOM_TASK_CONNECT:
330 ZOOM_scanset_destroy(task->u.scan.scan);
332 case ZOOM_TASK_PACKAGE:
333 ZOOM_package_destroy(task->u.package);
336 resultset_destroy(task->u.sort.resultset);
337 ZOOM_query_destroy(task->u.sort.q);
346 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
347 ZOOM_connection_put_event(c, event);
352 void ZOOM_connection_remove_tasks(ZOOM_connection c)
355 ZOOM_connection_remove_task(c);
358 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
360 const char *elementSetName);
362 ZOOM_API(ZOOM_connection)
363 ZOOM_connection_create(ZOOM_options options)
365 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
369 yaz_log(log_api, "%p ZOOM_connection_create", c);
371 c->proto = PROTO_Z3950;
373 ZOOM_connection_set_mask(c, 0);
375 c->state = STATE_IDLE;
378 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
385 c->options = ZOOM_options_create_with_parent(options);
391 c->charset = c->lang = 0;
402 c->maximum_record_size = 0;
403 c->preferred_message_size = 0;
405 c->odr_in = odr_createmem(ODR_DECODE);
406 c->odr_out = odr_createmem(ODR_ENCODE);
410 c->support_named_resultsets = 0;
411 c->last_event = ZOOM_EVENT_NONE;
413 c->m_queue_front = 0;
421 /* set database names. Take local databases (if set); otherwise
422 take databases given in ZURL (if set); otherwise use Default */
423 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
426 char **databaseNames;
427 const char *cp = ZOOM_options_get(options, "databaseName");
429 if ((!cp || !*cp) && con->host_port)
431 if (strncmp(con->host_port, "unix:", 5) == 0)
432 cp = strchr(con->host_port+5, ':');
434 cp = strchr(con->host_port, '/');
440 nmem_strsplit(odr_getmem(odr), "+", cp, &databaseNames, num);
441 return databaseNames;
444 ZOOM_API(ZOOM_connection)
445 ZOOM_connection_new(const char *host, int portnum)
447 ZOOM_connection c = ZOOM_connection_create(0);
449 ZOOM_connection_connect(c, host, portnum);
453 static zoom_sru_mode get_sru_mode_from_string(const char *s)
456 return zoom_sru_soap;
457 if (!yaz_matchstr(s, "soap"))
458 return zoom_sru_soap;
459 else if (!yaz_matchstr(s, "get"))
461 else if (!yaz_matchstr(s, "post"))
462 return zoom_sru_post;
463 return zoom_sru_error;
467 ZOOM_connection_connect(ZOOM_connection c,
468 const char *host, int portnum)
475 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
476 c, host ? host : "null", portnum);
478 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
479 ZOOM_connection_remove_tasks(c);
483 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
484 odr_destroy(c->odr_print);
486 if (ZOOM_options_get_bool(c->options, "apdulog", 0))
488 c->odr_print = odr_createmem(ODR_PRINT);
489 odr_setprint(c->odr_print, yaz_log_file());
496 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
500 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
503 val = ZOOM_options_get(c->options, "proxy");
506 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
507 c->proxy = xstrdup(val);
512 val = ZOOM_options_get(c->options, "charset");
515 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
516 c->charset = xstrdup(val);
520 val = ZOOM_options_get(c->options, "lang");
523 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
524 c->lang = xstrdup(val);
535 sprintf(hostn, "%.80s:%d", host, portnum);
536 c->host_port = xstrdup(hostn);
539 c->host_port = xstrdup(host);
544 * If the "<scheme>:" part of the host string is preceded by one
545 * or more comma-separated <name>=<value> pairs, these are taken
546 * to be options to be set on the connection object. Among other
547 * applications, this facility can be used to embed authentication
549 * user=admin,password=secret,tcp:localhost:9999
551 char *remainder = c->host_port;
552 char *pcolon = strchr(remainder, ':');
555 while ((pcomma = strchr(remainder, ',')) != 0 &&
556 (pcolon == 0 || pcomma < pcolon)) {
558 if ((pequals = strchr(remainder, '=')) != 0) {
560 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
561 ZOOM_connection_option_set(c, remainder, pequals+1);
563 remainder = pcomma+1;
566 if (remainder != c->host_port) {
568 c->host_port = xstrdup(remainder);
569 /*printf("# reset hp='%s'\n", remainder);*/
573 val = ZOOM_options_get(c->options, "sru");
574 c->sru_mode = get_sru_mode_from_string(val);
576 xfree(c->sru_version);
577 val = ZOOM_options_get(c->options, "sru_version");
578 c->sru_version = xstrdup(val ? val : "1.2");
580 ZOOM_options_set(c->options, "host", c->host_port);
582 xfree(c->cookie_out);
584 val = ZOOM_options_get(c->options, "cookie");
587 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
588 c->cookie_out = xstrdup(val);
593 val = ZOOM_options_get(c->options, "clientIP");
596 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
598 c->client_IP = xstrdup(val);
603 val = ZOOM_options_get(c->options, "group");
605 c->group = xstrdup(val);
609 val = ZOOM_options_get(c->options, "user");
611 c->user = xstrdup(val);
615 val = ZOOM_options_get(c->options, "password");
617 val = ZOOM_options_get(c->options, "pass");
620 c->password = xstrdup(val);
622 c->maximum_record_size =
623 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
624 c->preferred_message_size =
625 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
627 c->async = ZOOM_options_get_bool(c->options, "async", 0);
628 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
630 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
634 while (ZOOM_event(1, &c))
640 ZOOM_query_create(void)
642 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
644 yaz_log(log_details, "%p ZOOM_query_create", s);
648 s->odr = odr_createmem(ODR_ENCODE);
655 ZOOM_query_destroy(ZOOM_query s)
661 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
662 if (s->refcount == 0)
670 ZOOM_query_prefix(ZOOM_query s, const char *str)
672 s->query_string = odr_strdup(s->odr, str);
673 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
674 s->z_query->which = Z_Query_type_1;
675 s->z_query->u.type_1 = p_query_rpn(s->odr, str);
676 if (!s->z_query->u.type_1)
678 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
682 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
687 ZOOM_query_cql(ZOOM_query s, const char *str)
691 s->query_string = odr_strdup(s->odr, str);
693 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
694 ext->direct_reference = odr_oiddup(s->odr, yaz_oid_userinfo_cql);
695 ext->indirect_reference = 0;
697 ext->which = Z_External_CQL;
698 ext->u.cql = s->query_string;
700 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
701 s->z_query->which = Z_Query_type_104;
702 s->z_query->u.type_104 = ext;
704 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
710 * Translate the CQL string client-side into RPN which is passed to
711 * the server. This is useful for server's that don't themselves
712 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
713 * only as a place to stash diagnostics if compilation fails; if this
714 * information is not needed, a null pointer may be used.
717 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
721 ZOOM_connection freeme = 0;
723 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
725 conn = freeme = ZOOM_connection_create(0);
727 rpn = cql2pqf(conn, str);
729 ZOOM_connection_destroy(freeme);
733 ret = ZOOM_query_prefix(s, rpn);
739 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
740 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
741 * to the server, as the YAZ GFS doesn't know how to handle this.
744 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
745 int *ccl_error, const char **error_string,
749 struct ccl_rpn_node *rpn;
750 CCL_bibset bibset = ccl_qual_mk();
753 ccl_qual_buf(bibset, config);
755 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
758 *error_string = ccl_err_msg(*ccl_error);
763 WRBUF wr = wrbuf_alloc();
766 ret = ZOOM_query_prefix(s, wrbuf_cstr(wr));
769 ccl_qual_rm(&bibset);
774 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
776 s->sort_spec = yaz_sort_spec(s->odr, criteria);
779 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
783 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
787 static zoom_ret do_write(ZOOM_connection c);
790 ZOOM_connection_destroy(ZOOM_connection c)
795 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
798 for (r = c->resultsets; r; r = r->next)
804 odr_destroy(c->odr_in);
805 odr_destroy(c->odr_out);
808 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
809 odr_destroy(c->odr_print);
811 ZOOM_options_destroy(c->options);
812 ZOOM_connection_remove_tasks(c);
813 ZOOM_connection_remove_events(c);
819 xfree(c->cookie_out);
825 xfree(c->sru_version);
829 void ZOOM_resultset_addref(ZOOM_resultset r)
834 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
839 ZOOM_resultset ZOOM_resultset_create(void)
842 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
846 yaz_log(log_details, "%p ZOOM_resultset_create", r);
849 r->odr = odr_createmem(ODR_ENCODE);
854 for (i = 0; i<RECORD_HASH_SIZE; i++)
855 r->record_hash[i] = 0;
860 r->databaseNames = 0;
861 r->num_databaseNames = 0;
865 ZOOM_API(ZOOM_resultset)
866 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
869 ZOOM_query s = ZOOM_query_create();
871 ZOOM_query_prefix(s, q);
873 r = ZOOM_connection_search(c, s);
874 ZOOM_query_destroy(s);
878 ZOOM_API(ZOOM_resultset)
879 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
881 ZOOM_resultset r = ZOOM_resultset_create();
885 const char *syntax, *elementSetName;
887 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
888 r->r_sort_spec = q->sort_spec;
891 r->options = ZOOM_options_create_with_parent(c->options);
893 start = ZOOM_options_get_int(r->options, "start", 0);
894 count = ZOOM_options_get_int(r->options, "count", 0);
896 /* If "presentChunk" is defined use that; otherwise "step" */
897 const char *cp = ZOOM_options_get(r->options, "presentChunk");
898 r->step = ZOOM_options_get_int(r->options,
899 (cp != 0 ? "presentChunk": "step"), 0);
901 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
902 cp = ZOOM_options_get(r->options, "setname");
904 r->setname = xstrdup(cp);
905 cp = ZOOM_options_get(r->options, "schema");
907 r->schema = xstrdup(cp);
909 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
914 r->next = c->resultsets;
919 if (c->host_port && c->proto == PROTO_HTTP)
923 yaz_log(log_details, "ZOOM_connection_search: no comstack");
924 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
928 yaz_log(log_details, "ZOOM_connection_search: reconnect");
933 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
934 task->u.search.resultset = r;
935 task->u.search.start = start;
936 task->u.search.count = count;
937 task->u.search.recv_search_fired = 0;
939 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
940 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
941 elementSetName = ZOOM_options_get(r->options, "elementSetName");
942 task->u.search.elementSetName = elementSetName
943 ? xstrdup(elementSetName) : 0;
945 ZOOM_resultset_addref(r);
951 while (ZOOM_event(1, &c))
958 ZOOM_resultset_sort(ZOOM_resultset r,
959 const char *sort_type, const char *sort_spec)
961 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
965 ZOOM_resultset_sort1(ZOOM_resultset r,
966 const char *sort_type, const char *sort_spec)
968 ZOOM_connection c = r->connection;
972 newq = ZOOM_query_create();
973 if (ZOOM_query_sortby(newq, sort_spec) < 0)
976 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
977 r, r, sort_type, sort_spec);
981 if (c->host_port && c->proto == PROTO_HTTP)
985 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
986 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
990 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
996 ZOOM_resultset_cache_reset(r);
997 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
998 task->u.sort.resultset = r;
999 task->u.sort.q = newq;
1001 ZOOM_resultset_addref(r);
1005 while (ZOOM_event(1, &c))
1012 static void ZOOM_record_release(ZOOM_record rec)
1017 wrbuf_destroy(rec->wrbuf);
1020 xmlFree(rec->xml_mem);
1023 odr_destroy(rec->odr);
1027 ZOOM_resultset_cache_reset(ZOOM_resultset r)
1030 for (i = 0; i<RECORD_HASH_SIZE; i++)
1032 ZOOM_record_cache rc;
1033 for (rc = r->record_hash[i]; rc; rc = rc->next)
1035 ZOOM_record_release(&rc->rec);
1037 r->record_hash[i] = 0;
1042 ZOOM_resultset_destroy(ZOOM_resultset r)
1044 resultset_destroy(r);
1047 static void resultset_destroy(ZOOM_resultset r)
1052 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
1054 if (r->refcount == 0)
1056 ZOOM_resultset_cache_reset(r);
1060 /* remove ourselves from the resultsets in connection */
1061 ZOOM_resultset *rp = &r->connection->resultsets;
1064 assert(*rp); /* we must be in this list!! */
1066 { /* OK, we're here - take us out of it */
1073 ZOOM_query_destroy(r->query);
1074 ZOOM_options_destroy(r->options);
1075 odr_destroy(r->odr);
1083 ZOOM_resultset_size(ZOOM_resultset r)
1085 yaz_log(log_details, "ZOOM_resultset_size r=%p count=" ODR_INT_PRINTF,
1090 static void do_close(ZOOM_connection c)
1095 ZOOM_connection_set_mask(c, 0);
1096 c->state = STATE_IDLE;
1099 static int ZOOM_test_reconnect(ZOOM_connection c)
1103 if (!c->reconnect_ok)
1106 c->reconnect_ok = 0;
1107 c->tasks->running = 0;
1108 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1110 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1111 ZOOM_connection_put_event(c, event);
1116 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1117 int force_sync, int start, int count)
1122 const char *syntax, *elementSetName;
1126 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1127 " count=%d", r, force_sync, start, count);
1132 if (c->host_port && c->proto == PROTO_HTTP)
1136 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1137 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1141 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1143 c->reconnect_ok = 1;
1146 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1147 task->u.retrieve.resultset = r;
1148 task->u.retrieve.start = start;
1149 task->u.retrieve.count = count;
1151 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1152 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1153 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1154 task->u.retrieve.elementSetName = elementSetName
1155 ? xstrdup(elementSetName) : 0;
1157 cp = ZOOM_options_get(r->options, "schema");
1160 if (!r->schema || strcmp(r->schema, cp))
1163 r->schema = xstrdup(cp);
1167 ZOOM_resultset_addref(r);
1169 if (!r->connection->async || force_sync)
1170 while (r->connection && ZOOM_event(1, &r->connection))
1175 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1176 size_t start, size_t count)
1178 int force_present = 0;
1182 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1183 r, r, (long) start, (long) count);
1186 ZOOM_resultset_retrieve(r, force_present, start, count);
1190 for (i = 0; i< count; i++)
1191 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1195 static void get_cert(ZOOM_connection c)
1200 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1202 ZOOM_connection_option_setl(c, "sslPeerCert",
1203 cert_buf, cert_len);
1208 static zoom_ret do_connect(ZOOM_connection c)
1211 const char *effective_host;
1214 effective_host = c->proxy;
1216 effective_host = c->host_port;
1218 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1222 c->cs = cs_create_host(effective_host, 0, &add);
1224 if (c->cs && c->cs->protocol == PROTO_HTTP)
1229 c->proto = PROTO_HTTP;
1230 cs_get_host_args(c->host_port, &db);
1233 c->path = xmalloc(strlen(db) * 3 + 2);
1234 yaz_encode_sru_dbpath_buf(c->path, db);
1236 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1238 return zoom_complete;
1243 int ret = cs_connect(c->cs, add);
1246 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1247 ZOOM_connection_put_event(c, event);
1249 if (c->proto == PROTO_Z3950)
1250 ZOOM_connection_send_init(c);
1253 /* no init request for SRW .. */
1254 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1255 ZOOM_connection_remove_task(c);
1256 ZOOM_connection_set_mask(c, 0);
1257 ZOOM_connection_exec_task(c);
1259 c->state = STATE_ESTABLISHED;
1260 return zoom_pending;
1264 int mask = ZOOM_SELECT_EXCEPT;
1265 if (c->cs->io_pending & CS_WANT_WRITE)
1266 mask += ZOOM_SELECT_WRITE;
1267 if (c->cs->io_pending & CS_WANT_READ)
1268 mask += ZOOM_SELECT_READ;
1269 ZOOM_connection_set_mask(c, mask);
1270 c->state = STATE_CONNECTING;
1271 return zoom_pending;
1274 c->state = STATE_IDLE;
1275 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1276 return zoom_complete;
1279 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1282 for (i = 0; i<200; i++)
1286 Z_OtherInformation **oi;
1291 sprintf(buf, "otherInfo%d", i);
1292 val = ZOOM_options_get(c->options, buf);
1295 cp = strchr(val, ':');
1299 if (len >= sizeof(buf))
1300 len = sizeof(buf)-1;
1301 memcpy(buf, val, len);
1304 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
1309 yaz_oi_APDU(a, &oi);
1310 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
1314 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1319 Z_OtherInformation **oi;
1320 yaz_oi_APDU(a, &oi);
1321 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
1326 Z_OtherInformation **oi;
1327 yaz_oi_APDU(a, &oi);
1328 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
1331 otherInfo_attach(c, a, out);
1332 if (!z_APDU(out, &a, 0, 0))
1334 FILE *outf = fopen("/tmp/apdu.txt", "a");
1337 ODR odr_pr = odr_createmem(ODR_PRINT);
1338 fprintf(outf, "a=%p\n", a);
1339 odr_setprint(odr_pr, outf);
1340 z_APDU(odr_pr, &a, 0, 0);
1341 odr_destroy(odr_pr);
1343 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1344 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1349 z_APDU(c->odr_print, &a, 0, 0);
1350 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1354 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1358 if (encode_APDU(c, a, c->odr_out))
1359 return zoom_complete;
1360 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1361 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1362 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1363 ZOOM_connection_put_event(c, event);
1364 odr_reset(c->odr_out);
1368 /* returns 1 if PDU was sent OK (still pending )
1369 0 if PDU was not sent OK (nothing to wait for)
1372 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1374 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1375 Z_InitRequest *ireq = apdu->u.initRequest;
1376 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1377 odr_malloc(c->odr_out, sizeof(*auth));
1379 ODR_MASK_SET(ireq->options, Z_Options_search);
1380 ODR_MASK_SET(ireq->options, Z_Options_present);
1381 ODR_MASK_SET(ireq->options, Z_Options_scan);
1382 ODR_MASK_SET(ireq->options, Z_Options_sort);
1383 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1384 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1386 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1387 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1388 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1390 ireq->implementationId =
1391 odr_prepend(c->odr_out,
1392 ZOOM_options_get(c->options, "implementationId"),
1393 ireq->implementationId);
1395 ireq->implementationName =
1396 odr_prepend(c->odr_out,
1397 ZOOM_options_get(c->options, "implementationName"),
1398 odr_prepend(c->odr_out, "ZOOM-C",
1399 ireq->implementationName));
1401 ireq->implementationVersion =
1402 odr_prepend(c->odr_out,
1403 ZOOM_options_get(c->options, "implementationVersion"),
1404 ireq->implementationVersion);
1406 *ireq->maximumRecordSize = c->maximum_record_size;
1407 *ireq->preferredMessageSize = c->preferred_message_size;
1409 if (c->group || c->password)
1411 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1412 pass->groupId = odr_strdup_null(c->odr_out, c->group);
1413 pass->userId = odr_strdup_null(c->odr_out, c->user);
1414 pass->password = odr_strdup_null(c->odr_out, c->password);
1415 auth->which = Z_IdAuthentication_idPass;
1416 auth->u.idPass = pass;
1417 ireq->idAuthentication = auth;
1421 auth->which = Z_IdAuthentication_open;
1422 auth->u.open = odr_strdup(c->odr_out, c->user);
1423 ireq->idAuthentication = auth;
1427 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
1428 yaz_oid_userinfo_proxy, 1, c->host_port);
1430 if (c->charset || c->lang)
1432 Z_OtherInformation **oi;
1433 Z_OtherInformationUnit *oi_unit;
1435 yaz_oi_APDU(apdu, &oi);
1437 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1439 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1440 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1441 oi_unit->information.externallyDefinedInfo =
1442 yaz_set_proposal_charneg_list(c->odr_out, " ",
1443 c->charset, c->lang, 1);
1447 return send_APDU(c, apdu);
1451 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1455 const char *database = ZOOM_options_get(c->options, "databaseName");
1456 char *fdatabase = 0;
1459 fdatabase = yaz_encode_sru_dbpath_odr(c->odr_out, database);
1460 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port,
1461 fdatabase ? fdatabase : c->path);
1463 if (c->sru_mode == zoom_sru_get)
1465 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1467 else if (c->sru_mode == zoom_sru_post)
1469 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1471 else if (c->sru_mode == zoom_sru_soap)
1473 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1475 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1476 return zoom_complete;
1478 z_GDU(c->odr_print, &gdu, 0, 0);
1479 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1481 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1482 ZOOM_connection_put_event(c, event);
1483 odr_reset(c->odr_out);
1489 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type)
1491 Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
1492 sr->username = c->user;
1493 sr->password = c->password;
1499 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1503 ZOOM_resultset resultset = 0;
1505 const char *option_val = 0;
1507 if (c->error) /* don't continue on error */
1508 return zoom_complete;
1510 switch(c->tasks->which)
1512 case ZOOM_TASK_SEARCH:
1513 resultset = c->tasks->u.search.resultset;
1514 if (!resultset->setname)
1515 resultset->setname = xstrdup("default");
1516 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1517 start = &c->tasks->u.search.start;
1518 count = &c->tasks->u.search.count;
1520 case ZOOM_TASK_RETRIEVE:
1521 resultset = c->tasks->u.retrieve.resultset;
1523 start = &c->tasks->u.retrieve.start;
1524 count = &c->tasks->u.retrieve.count;
1526 if (*start >= resultset->size)
1527 return zoom_complete;
1528 if (*start + *count > resultset->size)
1529 *count = resultset->size - *start;
1531 for (i = 0; i < *count; i++)
1534 record_cache_lookup(resultset, i + *start,
1535 c->tasks->u.retrieve.syntax,
1536 c->tasks->u.retrieve.elementSetName);
1541 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1542 ZOOM_connection_put_event(c, event);
1549 return zoom_complete;
1552 return zoom_complete;
1554 assert(resultset->query);
1556 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
1557 if (resultset->query->z_query->which == Z_Query_type_104
1558 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1560 sr->u.request->query_type = Z_SRW_query_type_cql;
1561 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1563 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1564 resultset->query->z_query->u.type_1)
1566 sr->u.request->query_type = Z_SRW_query_type_pqf;
1567 sr->u.request->query.pqf = resultset->query->query_string;
1571 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1572 return zoom_complete;
1574 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1575 sr->u.request->maximumRecords = odr_intdup(
1576 c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
1577 resultset->step : *count);
1578 sr->u.request->recordSchema = resultset->schema;
1580 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1582 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1584 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1585 yaz_encode_sru_extra(sr, c->odr_out, option_val);
1586 return send_srw(c, sr);
1589 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1591 return zoom_complete;
1595 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1598 int lslb, ssub, mspn;
1600 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1601 Z_SearchRequest *search_req = apdu->u.searchRequest;
1602 const char *elementSetName;
1603 const char *smallSetElementSetName;
1604 const char *mediumSetElementSetName;
1607 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1609 r = c->tasks->u.search.resultset;
1611 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1614 ZOOM_options_get(r->options, "elementSetName");
1615 smallSetElementSetName =
1616 ZOOM_options_get(r->options, "smallSetElementSetName");
1617 mediumSetElementSetName =
1618 ZOOM_options_get(r->options, "mediumSetElementSetName");
1620 if (!smallSetElementSetName)
1621 smallSetElementSetName = elementSetName;
1623 if (!mediumSetElementSetName)
1624 mediumSetElementSetName = elementSetName;
1629 /* prepare query for the search request */
1630 search_req->query = r->query->z_query;
1631 if (!search_req->query)
1633 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1634 return zoom_complete;
1636 if (r->query->z_query->which == Z_Query_type_1 ||
1637 r->query->z_query->which == Z_Query_type_101)
1639 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
1642 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
1646 search_req->query = yaz_copy_Z_Query(search_req->query,
1649 r = yaz_query_charset_convert_rpnquery_check(
1650 search_req->query->u.type_1,
1652 yaz_iconv_close(cd);
1654 { /* query could not be char converted */
1655 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1656 return zoom_complete;
1661 search_req->databaseNames = r->databaseNames;
1662 search_req->num_databaseNames = r->num_databaseNames;
1664 /* get syntax (no need to provide unless piggyback is in effect) */
1665 syntax = c->tasks->u.search.syntax;
1667 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1668 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1669 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1670 if (lslb != -1 && ssub != -1 && mspn != -1)
1672 /* So're a Z39.50 expert? Let's hope you don't do sort */
1673 *search_req->largeSetLowerBound = lslb;
1674 *search_req->smallSetUpperBound = ssub;
1675 *search_req->mediumSetPresentNumber = mspn;
1677 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1678 && r->piggyback && !r->r_sort_spec && !r->schema)
1680 /* Regular piggyback - do it unless we're going to do sort */
1681 *search_req->largeSetLowerBound = 2000000000;
1682 *search_req->smallSetUpperBound = 1;
1683 *search_req->mediumSetPresentNumber =
1684 r->step>0 ? r->step : c->tasks->u.search.count;
1688 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1689 smallSetElementSetName = 0;
1690 mediumSetElementSetName = 0;
1693 if (smallSetElementSetName && *smallSetElementSetName)
1695 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1696 odr_malloc(c->odr_out, sizeof(*esn));
1698 esn->which = Z_ElementSetNames_generic;
1699 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1700 search_req->smallSetElementSetNames = esn;
1702 if (mediumSetElementSetName && *mediumSetElementSetName)
1704 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1705 odr_malloc(c->odr_out, sizeof(*esn));
1707 esn->which = Z_ElementSetNames_generic;
1708 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1709 search_req->mediumSetElementSetNames = esn;
1712 search_req->preferredRecordSyntax =
1713 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1717 if (c->support_named_resultsets)
1721 /* find the lowest unused ordinal so that we re-use
1722 result sets on the server. */
1723 for (ord = 1; ; ord++)
1726 sprintf(setname, "%d", ord);
1727 for (rp = c->resultsets; rp; rp = rp->next)
1728 if (rp->setname && !strcmp(rp->setname, setname))
1733 r->setname = xstrdup(setname);
1734 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1735 "set %s", c, r->setname);
1739 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1741 r->setname = xstrdup("default");
1743 ZOOM_options_set(r->options, "setname", r->setname);
1745 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1746 return send_APDU(c, apdu);
1749 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1751 char oid_name_buf[OID_STR_MAX];
1752 const char *oid_name;
1755 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
1758 case Z_DefaultDiagFormat_v2Addinfo:
1759 addinfo = r->u.v2Addinfo;
1761 case Z_DefaultDiagFormat_v3Addinfo:
1762 addinfo = r->u.v3Addinfo;
1767 set_dset_error(c, *r->condition, oid_name, addinfo, 0);
1770 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1772 if (p->which != Z_DiagRec_defaultFormat)
1773 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1775 response_default_diag(c, p->u.defaultFormat);
1778 ZOOM_API(ZOOM_record)
1779 ZOOM_record_clone(ZOOM_record srec)
1786 odr_enc = odr_createmem(ODR_ENCODE);
1787 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1789 buf = odr_getbuf(odr_enc, &size, 0);
1791 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1792 nrec->odr = odr_createmem(ODR_DECODE);
1798 odr_setbuf(nrec->odr, buf, size, 0);
1799 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1801 nrec->schema = odr_strdup_null(nrec->odr, srec->schema);
1802 nrec->diag_uri = odr_strdup_null(nrec->odr, srec->diag_uri);
1803 nrec->diag_message = odr_strdup_null(nrec->odr, srec->diag_message);
1804 nrec->diag_details = odr_strdup_null(nrec->odr, srec->diag_details);
1805 nrec->diag_set = odr_strdup_null(nrec->odr, srec->diag_set);
1806 odr_destroy(odr_enc);
1810 ZOOM_API(ZOOM_record)
1811 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1813 const char *syntax =
1814 ZOOM_options_get(s->options, "preferredRecordSyntax");
1815 const char *elementSetName =
1816 ZOOM_options_get(s->options, "elementSetName");
1818 return record_cache_lookup(s, pos, syntax, elementSetName);
1821 ZOOM_API(ZOOM_record)
1822 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1824 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1829 * MIKE: I think force_sync should always be zero, but I don't
1830 * want to make this change until I get the go-ahead from
1831 * Adam, in case something depends on the old synchronous
1835 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1836 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1837 rec = ZOOM_resultset_record_immediate(r, pos);
1843 ZOOM_record_destroy(ZOOM_record rec)
1845 ZOOM_record_release(rec);
1850 static yaz_iconv_t iconv_create_charset(const char *record_charset)
1857 strcpy(to, "UTF-8");
1858 if (record_charset && *record_charset)
1860 /* Use "from,to" or just "from" */
1861 const char *cp = strchr(record_charset, ',');
1862 size_t clen = strlen(record_charset);
1865 strncpy( to, cp+1, sizeof(to)-1);
1866 to[sizeof(to)-1] = '\0';
1867 clen = cp - record_charset;
1869 if (clen > sizeof(from)-1)
1870 clen = sizeof(from)-1;
1873 strncpy(from, record_charset, clen);
1877 cd = yaz_iconv_open(to, from);
1881 static const char *return_marc_record(ZOOM_record rec, int marc_type,
1883 const char *buf, int sz,
1884 const char *record_charset)
1886 yaz_iconv_t cd = iconv_create_charset(record_charset);
1887 yaz_marc_t mt = yaz_marc_create();
1888 const char *ret_string = 0;
1891 yaz_marc_iconv(mt, cd);
1892 yaz_marc_xml(mt, marc_type);
1894 rec->wrbuf = wrbuf_alloc();
1895 wrbuf_rewind(rec->wrbuf);
1896 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf) > 0)
1899 *len = wrbuf_len(rec->wrbuf);
1900 ret_string = wrbuf_cstr(rec->wrbuf);
1902 yaz_marc_destroy(mt);
1904 yaz_iconv_close(cd);
1908 static const char *return_opac_record(ZOOM_record rec, int marc_type,
1910 Z_OPACRecord *opac_rec,
1911 const char *record_charset)
1913 yaz_iconv_t cd = iconv_create_charset(record_charset);
1914 yaz_marc_t mt = yaz_marc_create();
1917 yaz_marc_iconv(mt, cd);
1918 yaz_marc_xml(mt, marc_type);
1921 rec->wrbuf = wrbuf_alloc();
1922 wrbuf_rewind(rec->wrbuf);
1924 yaz_opac_decode_wrbuf(mt, opac_rec, rec->wrbuf);
1925 yaz_marc_destroy(mt);
1928 yaz_iconv_close(cd);
1930 *len = wrbuf_len(rec->wrbuf);
1931 return wrbuf_cstr(rec->wrbuf);
1934 static const char *return_string_record(ZOOM_record rec, int *len,
1935 const char *buf, int sz,
1936 const char *record_charset)
1938 yaz_iconv_t cd = iconv_create_charset(record_charset);
1943 rec->wrbuf = wrbuf_alloc();
1945 wrbuf_rewind(rec->wrbuf);
1947 wrbuf_iconv_write(rec->wrbuf, cd, buf, sz);
1948 wrbuf_iconv_reset(rec->wrbuf, cd);
1950 buf = wrbuf_cstr(rec->wrbuf);
1951 sz = wrbuf_len(rec->wrbuf);
1952 yaz_iconv_close(cd);
1959 static const char *return_record(ZOOM_record rec, int *len,
1960 Z_NamePlusRecord *npr,
1961 int marctype, const char *charset)
1963 Z_External *r = (Z_External *) npr->u.databaseRecord;
1964 const Odr_oid *oid = r->direct_reference;
1966 /* render bibliographic record .. */
1967 if (r->which == Z_External_OPAC)
1969 return return_opac_record(rec, marctype, len,
1970 r->u.opac, charset);
1972 if (r->which == Z_External_sutrs)
1973 return return_string_record(rec, len,
1974 (char*) r->u.sutrs->buf,
1977 else if (r->which == Z_External_octet)
1979 if (yaz_oid_is_iso2709(oid))
1981 const char *ret_buf = return_marc_record(
1983 (const char *) r->u.octet_aligned->buf,
1984 r->u.octet_aligned->len,
1988 /* bad ISO2709. Return fail unless raw (ISO2709) is wanted */
1989 if (marctype != YAZ_MARC_ISO2709)
1992 return return_string_record(rec, len,
1993 (const char *) r->u.octet_aligned->buf,
1994 r->u.octet_aligned->len,
1997 else if (r->which == Z_External_grs1)
2000 rec->wrbuf = wrbuf_alloc();
2001 wrbuf_rewind(rec->wrbuf);
2002 yaz_display_grs1(rec->wrbuf, r->u.grs1, 0);
2003 return return_string_record(rec, len,
2004 wrbuf_buf(rec->wrbuf),
2005 wrbuf_len(rec->wrbuf),
2013 ZOOM_record_error(ZOOM_record rec, const char **cp,
2014 const char **addinfo, const char **diagset)
2016 Z_NamePlusRecord *npr;
2025 *cp = rec->diag_message;
2027 *addinfo = rec->diag_details;
2029 *diagset = rec->diag_set;
2030 return uri_to_code(rec->diag_uri);
2032 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
2034 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
2035 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
2036 const char *add = 0;
2038 if (diag_rec->which == Z_DiagRec_defaultFormat)
2040 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
2043 error = *ddf->condition;
2046 case Z_DefaultDiagFormat_v2Addinfo:
2047 add = ddf->u.v2Addinfo;
2049 case Z_DefaultDiagFormat_v3Addinfo:
2050 add = ddf->u.v3Addinfo;
2055 yaz_oid_to_string(yaz_oid_std(),
2056 ddf->diagnosticSetId, &oclass);
2064 *addinfo = add ? add : "";
2066 *cp = diagbib1_str(error);
2072 static const char *get_record_format(ZOOM_record rec, int *len,
2073 Z_NamePlusRecord *npr,
2074 int marctype, const char *charset,
2077 const char *res = return_record(rec, len, npr, marctype, charset);
2079 if (*format == '1' && len)
2081 /* try to XML format res */
2083 xmlKeepBlanksDefault(0); /* get get xmlDocFormatMemory to work! */
2084 doc = xmlParseMemory(res, *len);
2088 xmlFree(rec->xml_mem);
2089 xmlDocDumpFormatMemory(doc, &rec->xml_mem, &rec->xml_size, 1);
2091 res = (char *) rec->xml_mem;
2092 *len = rec->xml_size;
2100 ZOOM_API(const char *)
2101 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
2108 Z_NamePlusRecord *npr;
2111 *len = 0; /* default return */
2120 for (i = 0; cp[i] && cp[i] != ';' && cp[i] != ' ' && i < sizeof(type)-1;
2128 while (cp[i] == ' ')
2133 while (cp[i] == ' ')
2135 if (!strncmp(cp + i, "charset=", 8))
2138 i = i + 8; /* skip charset= */
2139 for (j = 0; cp[i] && cp[i] != ';' && cp[i] != ' '; i++)
2141 if (j < sizeof(charset)-1)
2142 charset[j++] = cp[i];
2146 else if (!strncmp(cp + i, "format=", 7))
2150 for (j = 0; cp[i] && cp[i] != ';' && cp[i] != ' '; i++)
2152 if (j < sizeof(format)-1)
2153 format[j++] = cp[i];
2158 if (!strcmp(type, "database"))
2161 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
2162 return npr->databaseName;
2164 else if (!strcmp(type, "schema"))
2167 *len = rec->schema ? strlen(rec->schema) : 0;
2170 else if (!strcmp(type, "syntax"))
2172 const char *desc = 0;
2173 if (npr->which == Z_NamePlusRecord_databaseRecord)
2175 Z_External *r = (Z_External *) npr->u.databaseRecord;
2176 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
2181 *len = strlen(desc);
2184 if (npr->which != Z_NamePlusRecord_databaseRecord)
2187 /* from now on - we have a database record .. */
2188 if (!strcmp(type, "render"))
2190 return get_record_format(rec, len, npr, YAZ_MARC_LINE, charset, format);
2192 else if (!strcmp(type, "xml"))
2194 return get_record_format(rec, len, npr, YAZ_MARC_MARCXML, charset,
2197 else if (!strcmp(type, "txml"))
2199 return get_record_format(rec, len, npr, YAZ_MARC_TURBOMARC, charset,
2202 else if (!strcmp(type, "raw"))
2204 return get_record_format(rec, len, npr, YAZ_MARC_ISO2709, charset,
2207 else if (!strcmp(type, "ext"))
2210 return (const char *) npr->u.databaseRecord;
2212 else if (!strcmp(type, "opac"))
2214 if (npr->u.databaseRecord->which == Z_External_OPAC)
2215 return get_record_format(rec, len, npr, YAZ_MARC_MARCXML, charset,
2221 static int strcmp_null(const char *v1, const char *v2)
2227 return strcmp(v1, v2);
2230 static size_t record_hash(int pos)
2234 return pos % RECORD_HASH_SIZE;
2237 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2239 const char *syntax, const char *elementSetName,
2241 Z_SRW_diagnostic *diag)
2243 ZOOM_record_cache rc = 0;
2245 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2246 ZOOM_connection_put_event(r->connection, event);
2248 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2251 && strcmp_null(r->schema, rc->schema) == 0
2252 && strcmp_null(elementSetName,rc->elementSetName) == 0
2253 && strcmp_null(syntax, rc->syntax) == 0)
2258 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2262 rc->rec.xml_mem = 0;
2264 rc->elementSetName = odr_strdup_null(r->odr, elementSetName);
2266 rc->syntax = odr_strdup_null(r->odr, syntax);
2268 rc->schema = odr_strdup_null(r->odr, r->schema);
2271 rc->next = r->record_hash[record_hash(pos)];
2272 r->record_hash[record_hash(pos)] = rc;
2275 rc->rec.schema = odr_strdup_null(r->odr, schema);
2276 rc->rec.diag_set = 0;
2277 rc->rec.diag_uri = 0;
2278 rc->rec.diag_message = 0;
2279 rc->rec.diag_details = 0;
2285 rc->rec.diag_set = odr_strdup(r->odr, diag->uri);
2286 if ((cp = strrchr(rc->rec.diag_set, '/')))
2288 rc->rec.diag_uri = odr_strdup(r->odr, diag->uri);
2290 rc->rec.diag_message = odr_strdup_null(r->odr, diag->message);
2291 rc->rec.diag_details = odr_strdup_null(r->odr, diag->details);
2295 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2297 const char *elementSetName)
2299 ZOOM_record_cache rc;
2301 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2305 if (strcmp_null(r->schema, rc->schema))
2307 if (strcmp_null(elementSetName,rc->elementSetName))
2309 if (strcmp_null(syntax, rc->syntax))
2317 static void handle_records(ZOOM_connection c, Z_Records *sr,
2320 ZOOM_resultset resultset;
2322 const char *syntax = 0, *elementSetName = 0;
2326 switch (c->tasks->which)
2328 case ZOOM_TASK_SEARCH:
2329 resultset = c->tasks->u.search.resultset;
2330 start = &c->tasks->u.search.start;
2331 count = &c->tasks->u.search.count;
2332 syntax = c->tasks->u.search.syntax;
2333 elementSetName = c->tasks->u.search.elementSetName;
2335 case ZOOM_TASK_RETRIEVE:
2336 resultset = c->tasks->u.retrieve.resultset;
2337 start = &c->tasks->u.retrieve.start;
2338 count = &c->tasks->u.retrieve.count;
2339 syntax = c->tasks->u.retrieve.syntax;
2340 elementSetName = c->tasks->u.retrieve.elementSetName;
2345 if (sr && sr->which == Z_Records_NSD)
2346 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2347 else if (sr && sr->which == Z_Records_multipleNSD)
2349 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2350 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2352 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2356 if (*count + *start > resultset->size)
2357 *count = resultset->size - *start;
2360 if (sr && sr->which == Z_Records_DBOSD)
2363 NMEM nmem = odr_extract_mem(c->odr_in);
2364 Z_NamePlusRecordList *p =
2365 sr->u.databaseOrSurDiagnostics;
2366 for (i = 0; i<p->num_records; i++)
2368 record_cache_add(resultset, p->records[i], i + *start,
2369 syntax, elementSetName,
2376 yaz_log(log_details,
2377 "handle_records resultset=%p start=%d count=%d",
2378 resultset, *start, *count);
2380 /* transfer our response to search_nmem .. we need it later */
2381 nmem_transfer(odr_getmem(resultset->odr), nmem);
2383 if (present_phase && p->num_records == 0)
2385 /* present response and we didn't get any records! */
2386 Z_NamePlusRecord *myrec =
2387 zget_surrogateDiagRec(
2389 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
2390 "ZOOM C generated. Present phase and no records");
2391 record_cache_add(resultset, myrec, *start,
2392 syntax, elementSetName, 0, 0);
2395 else if (present_phase)
2397 /* present response and we didn't get any records! */
2398 Z_NamePlusRecord *myrec =
2399 zget_surrogateDiagRec(
2401 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
2402 "ZOOM C generated: Present response and no records");
2403 record_cache_add(resultset, myrec, *start, syntax, elementSetName,
2409 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2411 handle_records(c, pr->records, 1);
2414 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2417 switch (term->which)
2419 case Z_Term_general:
2420 ZOOM_options_setl(opt, name,
2421 (const char *)(term->u.general->buf),
2422 term->u.general->len);
2424 case Z_Term_characterString:
2425 ZOOM_options_set(opt, name, term->u.characterString);
2427 case Z_Term_numeric:
2428 ZOOM_options_set_int(opt, name, *term->u.numeric);
2433 static void handle_queryExpression(ZOOM_options opt, const char *name,
2434 Z_QueryExpression *exp)
2440 case Z_QueryExpression_term:
2441 if (exp->u.term && exp->u.term->queryTerm)
2443 sprintf(opt_name, "%s.term", name);
2444 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2447 case Z_QueryExpression_query:
2452 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2453 Z_OtherInformation *o)
2456 for (i = 0; o && i < o->num_elements; i++)
2458 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2460 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2462 if (ext->which == Z_External_searchResult1)
2465 Z_SearchInfoReport *sr = ext->u.searchResult1;
2468 ZOOM_options_set_int(
2469 resultset->options, "searchresult.size", sr->num);
2471 for (j = 0; j < sr->num; j++)
2473 Z_SearchInfoReport_s *ent =
2474 ext->u.searchResult1->elements[j];
2477 sprintf(pref, "searchresult.%d", j);
2479 if (ent->subqueryId)
2482 sprintf(opt_name, "%s.id", pref);
2483 ZOOM_options_set(resultset->options, opt_name,
2486 if (ent->subqueryExpression)
2489 sprintf(opt_name, "%s.subquery", pref);
2490 handle_queryExpression(resultset->options, opt_name,
2491 ent->subqueryExpression);
2493 if (ent->subqueryInterpretation)
2496 sprintf(opt_name, "%s.interpretation", pref);
2497 handle_queryExpression(resultset->options, opt_name,
2498 ent->subqueryInterpretation);
2500 if (ent->subqueryRecommendation)
2503 sprintf(opt_name, "%s.recommendation", pref);
2504 handle_queryExpression(resultset->options, opt_name,
2505 ent->subqueryRecommendation);
2507 if (ent->subqueryCount)
2510 sprintf(opt_name, "%s.count", pref);
2511 ZOOM_options_set_int(resultset->options, opt_name,
2512 *ent->subqueryCount);
2520 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2522 ZOOM_resultset resultset;
2525 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2528 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2529 ZOOM_connection_put_event(c, event);
2531 resultset = c->tasks->u.search.resultset;
2533 if (sr->resultSetStatus)
2535 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2536 *sr->resultSetStatus);
2538 if (sr->presentStatus)
2540 ZOOM_options_set_int(resultset->options, "presentStatus",
2541 *sr->presentStatus);
2543 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2545 resultset->size = *sr->resultCount;
2546 handle_records(c, sr->records, 0);
2549 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2551 if (res->diagnostics && res->num_diagnostics > 0)
2552 response_diag(c, res->diagnostics[0]);
2555 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2557 NMEM nmem = odr_extract_mem(c->odr_in);
2560 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2562 scan = c->tasks->u.scan.scan;
2564 if (res->entries && res->entries->nonsurrogateDiagnostics)
2565 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2566 scan->scan_response = res;
2567 scan->srw_scan_response = 0;
2568 nmem_transfer(odr_getmem(scan->odr), nmem);
2570 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2571 if (res->positionOfTerm)
2572 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2573 if (res->scanStatus)
2574 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2575 if (res->numberOfEntriesReturned)
2576 ZOOM_options_set_int(scan->options, "number",
2577 *res->numberOfEntriesReturned);
2582 static zoom_ret send_sort(ZOOM_connection c,
2583 ZOOM_resultset resultset)
2586 resultset->r_sort_spec = 0;
2587 if (resultset->r_sort_spec)
2589 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2590 Z_SortRequest *req = apdu->u.sortRequest;
2592 req->num_inputResultSetNames = 1;
2593 req->inputResultSetNames = (Z_InternationalString **)
2594 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2595 req->inputResultSetNames[0] =
2596 odr_strdup(c->odr_out, resultset->setname);
2597 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2598 req->sortSequence = resultset->r_sort_spec;
2599 resultset->r_sort_spec = 0;
2600 return send_APDU(c, apdu);
2602 return zoom_complete;
2605 static zoom_ret send_present(ZOOM_connection c)
2608 Z_PresentRequest *req = 0;
2610 const char *syntax = 0;
2611 const char *elementSetName = 0;
2612 ZOOM_resultset resultset;
2617 yaz_log(log_details, "%p send_present no tasks", c);
2618 return zoom_complete;
2621 switch (c->tasks->which)
2623 case ZOOM_TASK_SEARCH:
2624 resultset = c->tasks->u.search.resultset;
2625 start = &c->tasks->u.search.start;
2626 count = &c->tasks->u.search.count;
2627 syntax = c->tasks->u.search.syntax;
2628 elementSetName = c->tasks->u.search.elementSetName;
2630 case ZOOM_TASK_RETRIEVE:
2631 resultset = c->tasks->u.retrieve.resultset;
2632 start = &c->tasks->u.retrieve.start;
2633 count = &c->tasks->u.retrieve.count;
2634 syntax = c->tasks->u.retrieve.syntax;
2635 elementSetName = c->tasks->u.retrieve.elementSetName;
2638 return zoom_complete;
2640 yaz_log(log_details, "%p send_present start=%d count=%d",
2643 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2645 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2648 if (c->error) /* don't continue on error */
2649 return zoom_complete;
2650 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2651 resultset, *start, *count);
2653 for (i = 0; i < *count; i++)
2656 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2661 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2662 ZOOM_connection_put_event(c, event);
2670 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2671 return zoom_complete;
2674 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2675 req = apdu->u.presentRequest;
2678 yaz_log(log_details, "%p send_present skip=%d", c, i);
2680 *req->resultSetStartPoint = *start + 1;
2682 if (resultset->step > 0 && resultset->step < *count)
2683 *req->numberOfRecordsRequested = resultset->step;
2685 *req->numberOfRecordsRequested = *count;
2687 if (*req->numberOfRecordsRequested + *start > resultset->size)
2688 *req->numberOfRecordsRequested = resultset->size - *start;
2689 assert(*req->numberOfRecordsRequested > 0);
2691 if (syntax && *syntax)
2692 req->preferredRecordSyntax =
2693 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2695 if (resultset->schema && *resultset->schema)
2697 Z_RecordComposition *compo = (Z_RecordComposition *)
2698 odr_malloc(c->odr_out, sizeof(*compo));
2700 req->recordComposition = compo;
2701 compo->which = Z_RecordComp_complex;
2702 compo->u.complex = (Z_CompSpec *)
2703 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2704 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2705 odr_malloc(c->odr_out, sizeof(bool_t));
2706 *compo->u.complex->selectAlternativeSyntax = 0;
2708 compo->u.complex->generic = (Z_Specification *)
2709 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2711 compo->u.complex->generic->which = Z_Schema_oid;
2712 compo->u.complex->generic->schema.oid = (Odr_oid *)
2713 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2715 if (!compo->u.complex->generic->schema.oid)
2717 /* OID wasn't a schema! Try record syntax instead. */
2719 compo->u.complex->generic->schema.oid = (Odr_oid *)
2720 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2722 if (elementSetName && *elementSetName)
2724 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2725 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2726 compo->u.complex->generic->elementSpec->which =
2727 Z_ElementSpec_elementSetName;
2728 compo->u.complex->generic->elementSpec->u.elementSetName =
2729 odr_strdup(c->odr_out, elementSetName);
2732 compo->u.complex->generic->elementSpec = 0;
2733 compo->u.complex->num_dbSpecific = 0;
2734 compo->u.complex->dbSpecific = 0;
2735 compo->u.complex->num_recordSyntax = 0;
2736 compo->u.complex->recordSyntax = 0;
2738 else if (elementSetName && *elementSetName)
2740 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2741 odr_malloc(c->odr_out, sizeof(*esn));
2742 Z_RecordComposition *compo = (Z_RecordComposition *)
2743 odr_malloc(c->odr_out, sizeof(*compo));
2745 esn->which = Z_ElementSetNames_generic;
2746 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2747 compo->which = Z_RecordComp_simple;
2748 compo->u.simple = esn;
2749 req->recordComposition = compo;
2751 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2752 return send_APDU(c, apdu);
2755 ZOOM_API(ZOOM_scanset)
2756 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2759 ZOOM_query q = ZOOM_query_create();
2761 ZOOM_query_prefix(q, start);
2763 s = ZOOM_connection_scan1(c, q);
2764 ZOOM_query_destroy(q);
2769 ZOOM_API(ZOOM_scanset)
2770 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2772 ZOOM_scanset scan = 0;
2776 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2777 scan->connection = c;
2778 scan->odr = odr_createmem(ODR_DECODE);
2779 scan->options = ZOOM_options_create_with_parent(c->options);
2781 scan->scan_response = 0;
2782 scan->srw_scan_response = 0;
2786 scan->databaseNames = set_DatabaseNames(c, c->options,
2787 &scan->num_databaseNames,
2792 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2793 task->u.scan.scan = scan;
2798 while (ZOOM_event(1, &c))
2806 ZOOM_scanset_destroy(ZOOM_scanset scan)
2811 if (scan->refcount == 0)
2813 ZOOM_query_destroy(scan->query);
2815 odr_destroy(scan->odr);
2817 ZOOM_options_destroy(scan->options);
2822 static zoom_ret send_package(ZOOM_connection c)
2826 yaz_log(log_details, "%p send_package", c);
2828 return zoom_complete;
2829 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2831 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2832 ZOOM_connection_put_event(c, event);
2834 c->buf_out = c->tasks->u.package->buf_out;
2835 c->len_out = c->tasks->u.package->len_out;
2840 static zoom_ret ZOOM_connection_send_scan(ZOOM_connection c)
2843 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2844 Z_ScanRequest *req = apdu->u.scanRequest;
2846 yaz_log(log_details, "%p send_scan", c);
2848 return zoom_complete;
2849 assert (c->tasks->which == ZOOM_TASK_SCAN);
2850 scan = c->tasks->u.scan.scan;
2852 /* Z39.50 scan can only carry RPN */
2853 if (scan->query->z_query->which == Z_Query_type_1 ||
2854 scan->query->z_query->which == Z_Query_type_101)
2856 Z_RPNQuery *rpn = scan->query->z_query->u.type_1;
2857 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
2860 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
2863 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
2865 yaz_query_charset_convert_rpnquery(
2866 rpn, c->odr_out, cd);
2867 yaz_iconv_close(cd);
2870 req->attributeSet = rpn->attributeSetId;
2871 if (!req->attributeSet)
2872 req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
2873 if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
2874 rpn->RPNStructure->u.simple->which == Z_Operand_APT)
2876 req->termListAndStartPoint =
2877 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
2881 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
2882 return zoom_complete;
2887 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2888 return zoom_complete;
2891 *req->numberOfTermsRequested =
2892 ZOOM_options_get_int(scan->options, "number", 10);
2894 req->preferredPositionInResponse =
2895 odr_intdup(c->odr_out,
2896 ZOOM_options_get_int(scan->options, "position", 1));
2899 odr_intdup(c->odr_out,
2900 ZOOM_options_get_int(scan->options, "stepSize", 0));
2902 req->databaseNames = scan->databaseNames;
2903 req->num_databaseNames = scan->num_databaseNames;
2905 return send_APDU(c, apdu);
2909 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2913 const char *option_val = 0;
2916 return zoom_complete;
2917 assert (c->tasks->which == ZOOM_TASK_SCAN);
2918 scan = c->tasks->u.scan.scan;
2920 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
2922 /* SRU scan can only carry CQL and PQF */
2923 if (scan->query->z_query->which == Z_Query_type_104)
2925 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
2926 sr->u.scan_request->scanClause.cql = scan->query->query_string;
2928 else if (scan->query->z_query->which == Z_Query_type_1
2929 || scan->query->z_query->which == Z_Query_type_101)
2931 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
2932 sr->u.scan_request->scanClause.pqf = scan->query->query_string;
2936 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2937 return zoom_complete;
2940 sr->u.scan_request->maximumTerms = odr_intdup(
2941 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
2943 sr->u.scan_request->responsePosition = odr_intdup(
2944 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
2946 option_val = ZOOM_options_get(scan->options, "extraArgs");
2947 yaz_encode_sru_extra(sr, c->odr_out, option_val);
2948 return send_srw(c, sr);
2951 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2953 return zoom_complete;
2959 ZOOM_scanset_size(ZOOM_scanset scan)
2964 if (scan->scan_response && scan->scan_response->entries)
2965 return scan->scan_response->entries->num_entries;
2966 else if (scan->srw_scan_response)
2967 return scan->srw_scan_response->num_terms;
2971 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
2973 const char **value_term, size_t *value_len,
2974 const char **disp_term, size_t *disp_len)
2976 size_t noent = ZOOM_scanset_size(scan);
2987 if (scan->scan_response)
2989 Z_ScanResponse *res = scan->scan_response;
2990 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2992 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2994 *value_term = (const char *) t->term->u.general->buf;
2995 *value_len = t->term->u.general->len;
2998 *disp_term = t->displayTerm;
2999 *disp_len = strlen(*disp_term);
3001 else if (t->term->which == Z_Term_general)
3003 *disp_term = (const char *) t->term->u.general->buf;
3004 *disp_len = t->term->u.general->len;
3006 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
3009 if (scan->srw_scan_response)
3011 Z_SRW_scanResponse *res = scan->srw_scan_response;
3012 Z_SRW_scanTerm *t = res->terms + pos;
3015 *value_term = t->value;
3016 *value_len = strlen(*value_term);
3019 *disp_term = t->displayTerm;
3021 *disp_term = t->value;
3022 *disp_len = strlen(*disp_term);
3023 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
3028 ZOOM_API(const char *)
3029 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
3030 size_t *occ, size_t *len)
3032 const char *value_term = 0;
3033 size_t value_len = 0;
3034 const char *disp_term = 0;
3035 size_t disp_len = 0;
3037 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3038 &disp_term, &disp_len);
3044 ZOOM_API(const char *)
3045 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
3046 size_t *occ, size_t *len)
3048 const char *value_term = 0;
3049 size_t value_len = 0;
3050 const char *disp_term = 0;
3051 size_t disp_len = 0;
3053 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3054 &disp_term, &disp_len);
3060 ZOOM_API(const char *)
3061 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
3063 return ZOOM_options_get(scan->options, key);
3067 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
3070 ZOOM_options_set(scan->options, key, val);
3073 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
3076 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
3077 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3079 str = ZOOM_options_get(p->options, "package-name");
3081 req->packageName = odr_strdup(p->odr_out, str);
3083 str = ZOOM_options_get(p->options, "user-id");
3085 req->userId = odr_strdup_null(p->odr_out, str);
3087 req->packageType = odr_oiddup(p->odr_out, oid);
3089 str = ZOOM_options_get(p->options, "function");
3092 if (!strcmp (str, "create"))
3093 *req->function = Z_ExtendedServicesRequest_create;
3094 if (!strcmp (str, "delete"))
3095 *req->function = Z_ExtendedServicesRequest_delete;
3096 if (!strcmp (str, "modify"))
3097 *req->function = Z_ExtendedServicesRequest_modify;
3100 str = ZOOM_options_get(p->options, "waitAction");
3103 if (!strcmp (str, "wait"))
3104 *req->waitAction = Z_ExtendedServicesRequest_wait;
3105 if (!strcmp (str, "waitIfPossible"))
3106 *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
3107 if (!strcmp (str, "dontWait"))
3108 *req->waitAction = Z_ExtendedServicesRequest_dontWait;
3109 if (!strcmp (str, "dontReturnPackage"))
3110 *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
3115 static const char *ill_array_lookup(void *clientData, const char *idx)
3117 ZOOM_package p = (ZOOM_package) clientData;
3118 return ZOOM_options_get(p->options, idx+4);
3121 static Z_External *encode_ill_request(ZOOM_package p)
3123 ODR out = p->odr_out;
3126 struct ill_get_ctl ctl;
3128 ctl.odr = p->odr_out;
3130 ctl.f = ill_array_lookup;
3132 req = ill_get_ILLRequest(&ctl, "ill", 0);
3134 if (!ill_Request(out, &req, 0, 0))
3136 int ill_request_size;
3137 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
3138 if (ill_request_buf)
3139 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
3144 int illRequest_size = 0;
3145 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
3147 r = (Z_External *) odr_malloc(out, sizeof(*r));
3148 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
3149 r->indirect_reference = 0;
3151 r->which = Z_External_single;
3153 r->u.single_ASN1_type =
3154 odr_create_Odr_oct(out,
3155 (unsigned char *)illRequest_buf,
3161 static Z_ItemOrder *encode_item_order(ZOOM_package p)
3163 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
3167 req->which = Z_IOItemOrder_esRequest;
3168 req->u.esRequest = (Z_IORequest *)
3169 odr_malloc(p->odr_out,sizeof(Z_IORequest));
3171 /* to keep part ... */
3172 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
3173 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
3174 req->u.esRequest->toKeep->supplDescription = 0;
3175 req->u.esRequest->toKeep->contact = (Z_IOContact *)
3176 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
3178 str = ZOOM_options_get(p->options, "contact-name");
3179 req->u.esRequest->toKeep->contact->name =
3180 odr_strdup_null(p->odr_out, str);
3182 str = ZOOM_options_get(p->options, "contact-phone");
3183 req->u.esRequest->toKeep->contact->phone =
3184 odr_strdup_null(p->odr_out, str);
3186 str = ZOOM_options_get(p->options, "contact-email");
3187 req->u.esRequest->toKeep->contact->email =
3188 odr_strdup_null(p->odr_out, str);
3190 req->u.esRequest->toKeep->addlBilling = 0;
3192 /* not to keep part ... */
3193 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
3194 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3196 str = ZOOM_options_get(p->options, "itemorder-setname");
3201 req->u.esRequest->notToKeep->resultSetItem = 0;
3204 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3205 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3207 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3208 odr_strdup(p->odr_out, str);
3209 req->u.esRequest->notToKeep->resultSetItem->item =
3210 odr_intdup(p->odr_out, 0);
3212 str = ZOOM_options_get(p->options, "itemorder-item");
3213 *req->u.esRequest->notToKeep->resultSetItem->item =
3214 (str ? atoi(str) : 1);
3217 str = ZOOM_options_getl(p->options, "doc", &len);
3220 req->u.esRequest->notToKeep->itemRequest =
3221 z_ext_record_xml(p->odr_out, str, len);
3224 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3229 Z_APDU *create_admin_package(ZOOM_package p, int type,
3230 Z_ESAdminOriginPartToKeep **toKeepP,
3231 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3233 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3236 Z_ESAdminOriginPartToKeep *toKeep;
3237 Z_ESAdminOriginPartNotToKeep *notToKeep;
3238 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3239 const char *first_db = "Default";
3241 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3246 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3248 r->indirect_reference = 0;
3249 r->which = Z_External_ESAdmin;
3251 r->u.adminService = (Z_Admin *)
3252 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3253 r->u.adminService->which = Z_Admin_esRequest;
3254 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3255 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3257 toKeep = r->u.adminService->u.esRequest->toKeep =
3258 (Z_ESAdminOriginPartToKeep *)
3259 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3260 toKeep->which = type;
3261 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3262 toKeep->u.create = odr_nullval();
3263 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3265 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3266 (Z_ESAdminOriginPartNotToKeep *)
3267 odr_malloc(p->odr_out,
3268 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3269 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3270 notToKeep->u.recordsWillFollow = odr_nullval();
3274 *notToKeepP = notToKeep;
3279 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3281 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3282 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3283 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3285 const char *doc = ZOOM_options_getl(p->options, "doc", &len);
3293 req->taskSpecificParameters = ext;
3294 ext->direct_reference = req->packageType;
3295 ext->descriptor = 0;
3296 ext->indirect_reference = 0;
3298 ext->which = Z_External_octet;
3299 ext->u.single_ASN1_type =
3300 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc, len);
3304 static Z_APDU *create_update_package(ZOOM_package p)
3307 const char *first_db = "Default";
3309 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3310 const char *action = ZOOM_options_get(p->options, "action");
3311 int recordIdOpaque_len;
3312 const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
3313 &recordIdOpaque_len);
3314 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3316 const char *record_buf = ZOOM_options_getl(p->options, "record",
3318 int recordOpaque_len;
3319 const char *recordOpaque_buf = ZOOM_options_getl(p->options, "recordOpaque",
3321 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3322 const char *version = ZOOM_options_get(p->options, "updateVersion");
3324 const char *correlationInfo_note =
3325 ZOOM_options_get(p->options, "correlationInfo.note");
3326 const char *correlationInfo_id =
3327 ZOOM_options_get(p->options, "correlationInfo.id");
3329 Odr_oid *syntax_oid = 0;
3330 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
3336 if (!record_buf && !recordOpaque_buf)
3338 record_buf = "void";
3340 syntax_str = "SUTRS";
3345 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3346 CLASS_RECSYN, syntax_str,
3358 package_oid = yaz_oid_extserv_database_update_first_version;
3359 /* old update does not support specialUpdate */
3361 action = "recordInsert";
3365 action = "specialUpdate";
3366 package_oid = yaz_oid_extserv_database_update_second_version;
3370 action = "specialUpdate";
3371 package_oid = yaz_oid_extserv_database_update;
3377 if (!strcmp(action, "recordInsert"))
3378 action_no = Z_IUOriginPartToKeep_recordInsert;
3379 else if (!strcmp(action, "recordReplace"))
3380 action_no = Z_IUOriginPartToKeep_recordReplace;
3381 else if (!strcmp(action, "recordDelete"))
3382 action_no = Z_IUOriginPartToKeep_recordDelete;
3383 else if (!strcmp(action, "elementUpdate"))
3384 action_no = Z_IUOriginPartToKeep_elementUpdate;
3385 else if (!strcmp(action, "specialUpdate"))
3386 action_no = Z_IUOriginPartToKeep_specialUpdate;
3390 apdu = create_es_package(p, package_oid);
3393 Z_IUOriginPartToKeep *toKeep;
3394 Z_IUSuppliedRecords *notToKeep;
3395 Z_External *r = (Z_External *)
3396 odr_malloc(p->odr_out, sizeof(*r));
3397 const char *elementSetName =
3398 ZOOM_options_get(p->options, "elementSetName");
3400 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3402 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
3404 r->which = Z_External_update;
3405 r->indirect_reference = 0;
3406 r->u.update = (Z_IUUpdate *)
3407 odr_malloc(p->odr_out, sizeof(*r->u.update));
3409 r->u.update->which = Z_IUUpdate_esRequest;
3410 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3411 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3412 toKeep = r->u.update->u.esRequest->toKeep =
3413 (Z_IUOriginPartToKeep *)
3414 odr_malloc(p->odr_out, sizeof(*toKeep));
3416 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3419 toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
3421 toKeep->actionQualifier = 0;
3422 toKeep->action = odr_intdup(p->odr_out, action_no);
3424 notToKeep = r->u.update->u.esRequest->notToKeep =
3425 (Z_IUSuppliedRecords *)
3426 odr_malloc(p->odr_out, sizeof(*notToKeep));
3428 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3429 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3430 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3431 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3432 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3435 notToKeep->elements[0]->u.opaque =
3436 odr_create_Odr_oct(p->odr_out,
3437 (const unsigned char *) recordIdOpaque,
3438 recordIdOpaque_len);
3440 else if (recordIdNumber)
3442 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3444 notToKeep->elements[0]->u.number =
3445 odr_intdup(p->odr_out, atoi(recordIdNumber));
3448 notToKeep->elements[0]->u.opaque = 0;
3449 notToKeep->elements[0]->supplementalId = 0;
3450 if (correlationInfo_note || correlationInfo_id)
3452 Z_IUCorrelationInfo *ci;
3453 ci = notToKeep->elements[0]->correlationInfo =
3454 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
3455 ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
3456 ci->id = correlationInfo_id ?
3457 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3460 notToKeep->elements[0]->correlationInfo = 0;
3461 if (recordOpaque_buf)
3463 notToKeep->elements[0]->record =
3464 z_ext_record_oid_any(p->odr_out, syntax_oid,
3465 recordOpaque_buf, recordOpaque_len);
3469 notToKeep->elements[0]->record =
3470 z_ext_record_oid(p->odr_out, syntax_oid,
3471 record_buf, record_len);
3476 ODR print = odr_createmem(ODR_PRINT);
3478 z_APDU(print, &apdu, 0, 0);
3485 ZOOM_package_send(ZOOM_package p, const char *type)
3492 odr_reset(p->odr_out);
3495 if (!strcmp(type, "itemorder"))
3497 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3500 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3502 r->direct_reference =
3503 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3505 r->which = Z_External_itemOrder;
3506 r->indirect_reference = 0;
3507 r->u.itemOrder = encode_item_order(p);
3509 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3512 else if (!strcmp(type, "create")) /* create database */
3514 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3517 else if (!strcmp(type, "drop")) /* drop database */
3519 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3522 else if (!strcmp(type, "commit")) /* commit changes */
3524 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3527 else if (!strcmp(type, "update")) /* update record(s) */
3529 apdu = create_update_package(p);
3531 else if (!strcmp(type, "xmlupdate"))
3533 apdu = create_xmlupdate_package(p);
3537 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3541 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3542 task->u.package = p;
3543 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3544 p->buf_out = (char *) xmalloc(p->len_out);
3545 memcpy(p->buf_out, buf, p->len_out);
3550 while (ZOOM_event(1, &c))
3557 ZOOM_API(ZOOM_package)
3558 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3560 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3563 p->odr_out = odr_createmem(ODR_ENCODE);
3564 p->options = ZOOM_options_create_with_parent2(options, c->options);
3572 ZOOM_package_destroy(ZOOM_package p)
3577 if (p->refcount == 0)
3579 odr_destroy(p->odr_out);
3582 ZOOM_options_destroy(p->options);
3587 ZOOM_API(const char *)
3588 ZOOM_package_option_get(ZOOM_package p, const char *key)
3590 return ZOOM_options_get(p->options, key);
3593 ZOOM_API(const char *)
3594 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
3596 return ZOOM_options_getl(p->options, key, lenp);
3600 ZOOM_package_option_set(ZOOM_package p, const char *key,
3603 ZOOM_options_set(p->options, key, val);
3607 ZOOM_package_option_setl(ZOOM_package p, const char *key,
3608 const char *val, int len)
3610 ZOOM_options_setl(p->options, key, val, len);
3614 ZOOM_connection_exec_task(ZOOM_connection c)
3616 ZOOM_task task = c->tasks;
3617 zoom_ret ret = zoom_complete;
3621 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3622 c, task->which, task->running);
3623 if (c->error != ZOOM_ERROR_NONE)
3625 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3626 "removing tasks because of error = %d", c, c->error);
3627 ZOOM_connection_remove_tasks(c);
3632 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3633 "task already running", c);
3637 ret = zoom_complete;
3638 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3640 switch (task->which)
3642 case ZOOM_TASK_SEARCH:
3643 if (c->proto == PROTO_HTTP)
3644 ret = ZOOM_connection_srw_send_search(c);
3646 ret = ZOOM_connection_send_search(c);
3648 case ZOOM_TASK_RETRIEVE:
3649 if (c->proto == PROTO_HTTP)
3650 ret = ZOOM_connection_srw_send_search(c);
3652 ret = send_present(c);
3654 case ZOOM_TASK_CONNECT:
3655 ret = do_connect(c);
3657 case ZOOM_TASK_SCAN:
3658 if (c->proto == PROTO_HTTP)
3659 ret = ZOOM_connection_srw_send_scan(c);
3661 ret = ZOOM_connection_send_scan(c);
3663 case ZOOM_TASK_PACKAGE:
3664 ret = send_package(c);
3666 case ZOOM_TASK_SORT:
3667 c->tasks->u.sort.resultset->r_sort_spec =
3668 c->tasks->u.sort.q->sort_spec;
3669 ret = send_sort(c, c->tasks->u.sort.resultset);
3675 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3676 "remove tasks because no connection exist", c);
3677 ZOOM_connection_remove_tasks(c);
3679 if (ret == zoom_complete)
3681 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3682 "task removed (complete)", c);
3683 ZOOM_connection_remove_task(c);
3686 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3691 static zoom_ret send_sort_present(ZOOM_connection c)
3693 zoom_ret r = zoom_complete;
3695 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3696 r = send_sort(c, c->tasks->u.search.resultset);
3697 if (r == zoom_complete)
3698 r = send_present(c);
3702 static int es_response_taskpackage_update(ZOOM_connection c,
3703 Z_IUUpdateTaskPackage *utp)
3705 if (utp && utp->targetPart)
3707 Z_IUTargetPart *targetPart = utp->targetPart;
3708 switch ( *targetPart->updateStatus ) {
3709 case Z_IUTargetPart_success:
3710 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
3712 case Z_IUTargetPart_partial:
3713 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
3715 case Z_IUTargetPart_failure:
3716 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
3717 if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
3718 response_diag(c, targetPart->globalDiagnostics[0]);
3721 // NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED.
3726 static int es_response_taskpackage(ZOOM_connection c,
3727 Z_TaskPackage *taskPackage)
3730 Odr_oct *id = taskPackage->targetReference;
3732 ZOOM_options_setl(c->tasks->u.package->options,
3733 "targetReference", (char*) id->buf, id->len);
3736 switch ( *taskPackage->taskStatus ) {
3737 case Z_TaskPackage_pending:
3738 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
3740 case Z_TaskPackage_active:
3741 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
3743 case Z_TaskPackage_complete:
3744 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
3746 case Z_TaskPackage_aborted:
3747 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
3748 if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
3749 response_diag(c, taskPackage->packageDiagnostics[0]);
3753 // taskSpecificParameters
3754 // NOTE: Only Update implemented, no others.
3755 if ( taskPackage->taskSpecificParameters->which == Z_External_update ) {
3756 Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
3757 es_response_taskpackage_update(c, utp);
3763 static int es_response(ZOOM_connection c,
3764 Z_ExtendedServicesResponse *res)
3766 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3768 switch (*res->operationStatus) {
3769 case Z_ExtendedServicesResponse_done:
3770 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
3772 case Z_ExtendedServicesResponse_accepted:
3773 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
3775 case Z_ExtendedServicesResponse_failure:
3776 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
3777 if (res->diagnostics && res->num_diagnostics > 0)
3778 response_diag(c, res->diagnostics[0]);
3781 if (res->taskPackage &&
3782 res->taskPackage->which == Z_External_extendedService)
3784 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3785 es_response_taskpackage(c, taskPackage);
3787 if (res->taskPackage &&
3788 res->taskPackage->which == Z_External_octet)
3790 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3791 ZOOM_options_setl(c->tasks->u.package->options,
3792 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3797 static void interpret_init_diag(ZOOM_connection c,
3798 Z_DiagnosticFormat *diag)
3802 Z_DiagnosticFormat_s *ds = diag->elements[0];
3803 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3804 response_default_diag(c, ds->u.defaultDiagRec);
3809 static void interpret_otherinformation_field(ZOOM_connection c,
3810 Z_OtherInformation *ui)
3813 for (i = 0; i < ui->num_elements; i++)
3815 Z_OtherInformationUnit *unit = ui->list[i];
3816 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3817 unit->information.externallyDefinedInfo &&
3818 unit->information.externallyDefinedInfo->which ==
3821 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3827 static void set_init_option(const char *name, void *clientData) {
3828 ZOOM_connection c = (ZOOM_connection) clientData;
3831 sprintf(buf, "init_opt_%.70s", name);
3832 ZOOM_connection_option_set(c, buf, "1");
3836 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3838 Z_InitResponse *initrs;
3840 ZOOM_connection_set_mask(c, 0);
3841 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3844 case Z_APDU_initResponse:
3845 yaz_log(log_api, "%p recv_apdu: Received Init response", c);
3846 initrs = apdu->u.initResponse;
3847 ZOOM_connection_option_set(c, "serverImplementationId",
3848 initrs->implementationId ?
3849 initrs->implementationId : "");
3850 ZOOM_connection_option_set(c, "serverImplementationName",
3851 initrs->implementationName ?
3852 initrs->implementationName : "");
3853 ZOOM_connection_option_set(c, "serverImplementationVersion",
3854 initrs->implementationVersion ?
3855 initrs->implementationVersion : "");
3856 /* Set the three old options too, for old applications */
3857 ZOOM_connection_option_set(c, "targetImplementationId",
3858 initrs->implementationId ?
3859 initrs->implementationId : "");
3860 ZOOM_connection_option_set(c, "targetImplementationName",
3861 initrs->implementationName ?
3862 initrs->implementationName : "");
3863 ZOOM_connection_option_set(c, "targetImplementationVersion",
3864 initrs->implementationVersion ?
3865 initrs->implementationVersion : "");
3867 /* Make initrs->options available as ZOOM-level options */
3868 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3870 if (!*initrs->result)
3872 Z_External *uif = initrs->userInformationField;
3874 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3876 if (uif && uif->which == Z_External_userInfo1)
3877 interpret_otherinformation_field(c, uif->u.userInfo1);
3882 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
3883 yaz_oid_userinfo_cookie, 1, 0);
3884 xfree(c->cookie_in);
3887 c->cookie_in = xstrdup(cookie);
3888 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3889 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3890 c->support_named_resultsets = 1;
3893 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3894 ZOOM_connection_remove_task(c);
3896 ZOOM_connection_exec_task(c);
3898 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3900 NMEM tmpmem = nmem_create();
3901 Z_CharSetandLanguageNegotiation *p =
3902 yaz_get_charneg_record(initrs->otherInfo);
3906 char *charset = NULL, *lang = NULL;
3909 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3910 yaz_log(log_details, "%p recv_apdu target accepted: "
3911 "charset %s, language %s, select %d",
3913 charset ? charset : "none", lang ? lang : "none", sel);
3915 ZOOM_connection_option_set(c, "negotiation-charset",
3918 ZOOM_connection_option_set(c, "negotiation-lang",
3921 ZOOM_connection_option_set(
3922 c, "negotiation-charset-in-effect-for-records",
3923 (sel != 0) ? "1" : "0");
3924 nmem_destroy(tmpmem);
3928 case Z_APDU_searchResponse:
3929 yaz_log(log_api, "%p recv_apdu Search response", c);
3930 handle_search_response(c, apdu->u.searchResponse);
3931 if (send_sort_present(c) == zoom_complete)
3932 ZOOM_connection_remove_task(c);
3934 case Z_APDU_presentResponse:
3935 yaz_log(log_api, "%p recv_apdu Present response", c);
3936 handle_present_response(c, apdu->u.presentResponse);
3937 if (send_present(c) == zoom_complete)
3938 ZOOM_connection_remove_task(c);
3940 case Z_APDU_sortResponse:
3941 yaz_log(log_api, "%p recv_apdu Sort response", c);
3942 sort_response(c, apdu->u.sortResponse);
3943 if (send_present(c) == zoom_complete)
3944 ZOOM_connection_remove_task(c);
3946 case Z_APDU_scanResponse:
3947 yaz_log(log_api, "%p recv_apdu Scan response", c);
3948 scan_response(c, apdu->u.scanResponse);
3949 ZOOM_connection_remove_task(c);
3951 case Z_APDU_extendedServicesResponse:
3952 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3953 es_response(c, apdu->u.extendedServicesResponse);
3954 ZOOM_connection_remove_task(c);
3957 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3958 if (!ZOOM_test_reconnect(c))
3960 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3965 yaz_log(log_api, "%p Received unknown PDU", c);
3966 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3972 static zoom_ret handle_srw_response(ZOOM_connection c,
3973 Z_SRW_searchRetrieveResponse *res)
3975 ZOOM_resultset resultset = 0;
3980 const char *syntax, *elementSetName;
3983 return zoom_complete;
3985 switch(c->tasks->which)
3987 case ZOOM_TASK_SEARCH:
3988 resultset = c->tasks->u.search.resultset;
3989 start = &c->tasks->u.search.start;
3990 count = &c->tasks->u.search.count;
3991 syntax = c->tasks->u.search.syntax;
3992 elementSetName = c->tasks->u.search.elementSetName;
3994 if (!c->tasks->u.search.recv_search_fired)
3996 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3997 ZOOM_connection_put_event(c, event);
3998 c->tasks->u.search.recv_search_fired = 1;
4001 case ZOOM_TASK_RETRIEVE:
4002 resultset = c->tasks->u.retrieve.resultset;
4003 start = &c->tasks->u.retrieve.start;
4004 count = &c->tasks->u.retrieve.count;
4005 syntax = c->tasks->u.retrieve.syntax;
4006 elementSetName = c->tasks->u.retrieve.elementSetName;
4009 return zoom_complete;
4012 resultset->size = 0;
4014 if (res->resultSetId)
4015 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
4017 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
4019 if (res->num_diagnostics > 0)
4021 set_SRU_error(c, &res->diagnostics[0]);
4025 if (res->numberOfRecords)
4026 resultset->size = *res->numberOfRecords;
4027 for (i = 0; i<res->num_records; i++)
4030 Z_SRW_record *sru_rec;
4031 Z_SRW_diagnostic *diag = 0;
4034 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
4035 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
4037 if (res->records[i].recordPosition &&
4038 *res->records[i].recordPosition > 0)
4039 pos = *res->records[i].recordPosition - 1;
4043 sru_rec = &res->records[i];
4045 npr->databaseName = 0;
4046 npr->which = Z_NamePlusRecord_databaseRecord;
4047 npr->u.databaseRecord = (Z_External *)
4048 odr_malloc(c->odr_in, sizeof(Z_External));
4049 npr->u.databaseRecord->descriptor = 0;
4050 npr->u.databaseRecord->direct_reference =
4051 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
4052 npr->u.databaseRecord->which = Z_External_octet;
4054 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
4055 odr_malloc(c->odr_in, sizeof(Odr_oct));
4056 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
4057 sru_rec->recordData_buf;
4058 npr->u.databaseRecord->u.octet_aligned->len =
4059 npr->u.databaseRecord->u.octet_aligned->size =
4060 sru_rec->recordData_len;
4062 if (sru_rec->recordSchema
4063 && !strcmp(sru_rec->recordSchema,
4064 "info:srw/schema/1/diagnostics-v1.1"))
4066 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
4067 sru_rec->recordData_len,
4071 record_cache_add(resultset, npr, pos, syntax, elementSetName,
4072 sru_rec->recordSchema, diag);
4076 if (*count + *start > resultset->size)
4077 *count = resultset->size - *start;
4081 nmem = odr_extract_mem(c->odr_in);
4082 nmem_transfer(odr_getmem(resultset->odr), nmem);
4086 return ZOOM_connection_srw_send_search(c);
4088 return zoom_complete;
4093 static void handle_srw_scan_response(ZOOM_connection c,
4094 Z_SRW_scanResponse *res)
4096 NMEM nmem = odr_extract_mem(c->odr_in);
4099 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
4101 scan = c->tasks->u.scan.scan;
4103 if (res->num_diagnostics > 0)
4104 set_SRU_error(c, &res->diagnostics[0]);
4106 scan->scan_response = 0;
4107 scan->srw_scan_response = res;
4108 nmem_transfer(odr_getmem(scan->odr), nmem);
4110 ZOOM_options_set_int(scan->options, "number", res->num_terms);
4116 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
4118 zoom_ret cret = zoom_complete;
4120 const char *addinfo = 0;
4121 const char *connection_head = z_HTTP_header_lookup(hres->headers,
4123 ZOOM_connection_set_mask(c, 0);
4124 yaz_log(log_details, "%p handle_http", c);
4126 if (!yaz_srw_check_content_type(hres))
4127 addinfo = "content-type";
4130 Z_SOAP *soap_package = 0;
4132 Z_SOAP_Handler soap_handlers[2] = {
4133 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
4136 ret = z_soap_codec(o, &soap_package,
4137 &hres->content_buf, &hres->content_len,
4139 if (!ret && soap_package->which == Z_SOAP_generic &&
4140 soap_package->u.generic->no == 0)
4142 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
4144 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
4145 ZOOM_options_setl(c->options, "sru_extra_response_data",
4146 sr->extraResponseData_buf, sr->extraResponseData_len);
4147 if (sr->which == Z_SRW_searchRetrieve_response)
4148 cret = handle_srw_response(c, sr->u.response);
4149 else if (sr->which == Z_SRW_scan_response)
4150 handle_srw_scan_response(c, sr->u.scan_response);
4154 else if (!ret && (soap_package->which == Z_SOAP_fault
4155 || soap_package->which == Z_SOAP_error))
4157 set_HTTP_error(c, hres->code,
4158 soap_package->u.fault->fault_code,
4159 soap_package->u.fault->fault_string);
4166 if (hres->code != 200)
4167 set_HTTP_error(c, hres->code, 0, 0);
4169 set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
4172 if (cret == zoom_complete)
4173 ZOOM_connection_remove_task(c);
4174 if (!strcmp(hres->version, "1.0"))
4176 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
4177 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
4182 /* HTTP 1.1: only if no close we stay alive .. */
4183 if (connection_head && !strcmp(connection_head, "close"))
4189 static int do_read(ZOOM_connection c)
4194 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
4195 ZOOM_connection_put_event(c, event);
4197 r = cs_get(c->cs, &c->buf_in, &c->len_in);
4198 more = cs_more(c->cs);
4199 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
4204 if (!ZOOM_test_reconnect(c))
4206 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4215 odr_reset(c->odr_in);
4216 odr_setbuf(c->odr_in, c->buf_in, r, 0);
4217 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
4218 ZOOM_connection_put_event(c, event);
4220 if (!z_GDU(c->odr_in, &gdu, 0, 0))
4223 int err = odr_geterrorx(c->odr_in, &x);
4225 const char *element = odr_getelement(c->odr_in);
4226 yaz_snprintf(msg, sizeof(msg),
4227 "ODR code %d:%d element=%s offset=%d",
4228 err, x, element ? element : "<unknown>",
4229 odr_offset(c->odr_in));
4230 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
4233 FILE *ber_file = yaz_log_file();
4235 odr_dumpBER(ber_file, c->buf_in, r);
4242 z_GDU(c->odr_print, &gdu, 0, 0);
4243 if (gdu->which == Z_GDU_Z3950)
4244 recv_apdu(c, gdu->u.z3950);
4245 else if (gdu->which == Z_GDU_HTTP_Response)
4248 handle_http(c, gdu->u.HTTP_Response);
4250 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4255 c->reconnect_ok = 0;
4260 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
4265 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
4266 ZOOM_connection_put_event(c, event);
4268 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
4269 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
4271 yaz_log(log_details, "%p do_write_ex write failed", c);
4272 if (ZOOM_test_reconnect(c))
4274 return zoom_pending;
4276 if (c->state == STATE_CONNECTING)
4277 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4279 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4281 return zoom_complete;
4285 int mask = ZOOM_SELECT_EXCEPT;
4286 if (c->cs->io_pending & CS_WANT_WRITE)
4287 mask += ZOOM_SELECT_WRITE;
4288 if (c->cs->io_pending & CS_WANT_READ)
4289 mask += ZOOM_SELECT_READ;
4290 ZOOM_connection_set_mask(c, mask);
4291 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
4296 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
4297 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
4300 return zoom_pending;
4303 static zoom_ret do_write(ZOOM_connection c)
4305 return do_write_ex(c, c->buf_out, c->len_out);
4309 ZOOM_API(const char *)
4310 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
4312 return ZOOM_options_get(c->options, key);
4315 ZOOM_API(const char *)
4316 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
4318 return ZOOM_options_getl(c->options, key, lenp);
4322 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
4325 ZOOM_options_set(c->options, key, val);
4329 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
4330 const char *val, int len)
4332 ZOOM_options_setl(c->options, key, val, len);
4335 ZOOM_API(const char *)
4336 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
4338 return ZOOM_options_get(r->options, key);
4342 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
4345 ZOOM_options_set(r->options, key, val);
4350 ZOOM_connection_errcode(ZOOM_connection c)
4352 return ZOOM_connection_error(c, 0, 0);
4355 ZOOM_API(const char *)
4356 ZOOM_connection_errmsg(ZOOM_connection c)
4359 ZOOM_connection_error(c, &msg, 0);
4363 ZOOM_API(const char *)
4364 ZOOM_connection_addinfo(ZOOM_connection c)
4366 const char *addinfo;
4367 ZOOM_connection_error(c, 0, &addinfo);
4371 ZOOM_API(const char *)
4372 ZOOM_connection_diagset(ZOOM_connection c)
4374 const char *diagset;
4375 ZOOM_connection_error_x(c, 0, 0, &diagset);
4379 ZOOM_API(const char *)
4380 ZOOM_diag_str(int error)
4384 case ZOOM_ERROR_NONE:
4386 case ZOOM_ERROR_CONNECT:
4387 return "Connect failed";
4388 case ZOOM_ERROR_MEMORY:
4389 return "Out of memory";
4390 case ZOOM_ERROR_ENCODE:
4391 return "Encoding failed";
4392 case ZOOM_ERROR_DECODE:
4393 return "Decoding failed";
4394 case ZOOM_ERROR_CONNECTION_LOST:
4395 return "Connection lost";
4396 case ZOOM_ERROR_INIT:
4397 return "Init rejected";
4398 case ZOOM_ERROR_INTERNAL:
4399 return "Internal failure";
4400 case ZOOM_ERROR_TIMEOUT:
4402 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4403 return "Unsupported protocol";
4404 case ZOOM_ERROR_UNSUPPORTED_QUERY:
4405 return "Unsupported query type";
4406 case ZOOM_ERROR_INVALID_QUERY:
4407 return "Invalid query";
4408 case ZOOM_ERROR_CQL_PARSE:
4409 return "CQL parsing error";
4410 case ZOOM_ERROR_CQL_TRANSFORM:
4411 return "CQL transformation error";
4412 case ZOOM_ERROR_CCL_CONFIG:
4413 return "CCL configuration error";
4414 case ZOOM_ERROR_CCL_PARSE:
4415 return "CCL parsing error";
4417 return diagbib1_str(error);
4422 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4423 const char **addinfo, const char **diagset)
4425 int error = c->error;
4428 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4429 *cp = ZOOM_diag_str(error);
4430 else if (!strcmp(c->diagset, "HTTP"))
4431 *cp = z_HTTP_errmsg(c->error);
4432 else if (!strcmp(c->diagset, "Bib-1"))
4433 *cp = ZOOM_diag_str(error);
4434 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4435 *cp = yaz_diag_srw_str(c->error);
4437 *cp = "Unknown error and diagnostic set";
4440 *addinfo = c->addinfo ? c->addinfo : "";
4442 *diagset = c->diagset ? c->diagset : "";
4447 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4448 const char **addinfo)
4450 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4453 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4455 ZOOM_Event event = 0;
4456 int r = cs_look(c->cs);
4457 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4462 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4463 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4465 ZOOM_connection_put_event(c, event);
4467 else if (r == CS_CONNECT)
4469 int ret = ret = cs_rcvconnect(c->cs);
4470 yaz_log(log_details, "%p ZOOM_connection_do_io "
4471 "cs_rcvconnect returned %d", c, ret);
4474 int mask = ZOOM_SELECT_EXCEPT;
4475 if (c->cs->io_pending & CS_WANT_WRITE)
4476 mask += ZOOM_SELECT_WRITE;
4477 if (c->cs->io_pending & CS_WANT_READ)
4478 mask += ZOOM_SELECT_READ;
4479 ZOOM_connection_set_mask(c, mask);
4480 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
4481 ZOOM_connection_put_event(c, event);
4485 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4486 ZOOM_connection_put_event(c, event);
4488 if (c->proto == PROTO_Z3950)
4489 ZOOM_connection_send_init(c);
4492 /* no init request for SRW .. */
4493 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4494 ZOOM_connection_remove_task(c);
4495 ZOOM_connection_set_mask(c, 0);
4496 ZOOM_connection_exec_task(c);
4498 c->state = STATE_ESTABLISHED;
4502 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4508 if (mask & ZOOM_SELECT_EXCEPT)
4510 if (!ZOOM_test_reconnect(c))
4512 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4517 if (mask & ZOOM_SELECT_READ)
4519 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4525 ZOOM_connection_last_event(ZOOM_connection cs)
4528 return ZOOM_EVENT_NONE;
4529 return cs->last_event;
4533 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4535 WRBUF wrbuf = (WRBUF) client_data;
4536 wrbuf_puts(wrbuf, buf);
4540 * Returns an xmalloc()d string containing RPN that corresponds to the
4541 * CQL passed in. On error, sets the Connection object's error state
4542 * and returns a null pointer.
4543 * ### We could cache CQL parser and/or transformer in Connection.
4545 static char *cql2pqf(ZOOM_connection c, const char *cql)
4549 const char *cqlfile;
4550 cql_transform_t trans;
4553 parser = cql_parser_create();
4554 if ((error = cql_parser_string(parser, cql)) != 0) {
4555 cql_parser_destroy(parser);
4556 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4560 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4563 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4565 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4568 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4569 cqlfile, strerror(errno));
4570 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4574 WRBUF wrbuf_result = wrbuf_alloc();
4575 error = cql_transform(trans, cql_parser_result(parser),
4576 cql2pqf_wrbuf_puts, wrbuf_result);
4579 const char *addinfo;
4580 error = cql_transform_error(trans, &addinfo);
4581 sprintf(buf, "%.200s (addinfo=%.200s)",
4582 cql_strerror(error), addinfo);
4583 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4587 result = xstrdup(wrbuf_cstr(wrbuf_result));
4589 cql_transform_close(trans);
4590 wrbuf_destroy(wrbuf_result);
4592 cql_parser_destroy(parser);
4596 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4600 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4601 /* timeout and this connection was waiting */
4602 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4604 ZOOM_connection_put_event(c, event);
4610 ZOOM_connection_process(ZOOM_connection c)
4616 event = ZOOM_connection_get_event(c);
4619 ZOOM_Event_destroy(event);
4622 ZOOM_connection_exec_task(c);
4623 event = ZOOM_connection_get_event(c);
4626 ZOOM_Event_destroy(event);
4633 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4637 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4639 for (i = 0; i<no; i++)
4641 ZOOM_connection c = cs[i];
4643 if (c && ZOOM_connection_process(c))
4649 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4651 if (c->mask && mask)
4652 ZOOM_connection_do_io(c, mask);
4656 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4659 return cs_fileno(c->cs);
4663 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4671 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4678 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4680 return ZOOM_options_get_int(c->options, "timeout", 30);
4683 ZOOM_API(void) ZOOM_connection_close(ZOOM_connection c)
4691 * c-file-style: "Stroustrup"
4692 * indent-tabs-mode: nil
4694 * vim: shiftwidth=4 tabstop=8 expandtab