2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.146 2007-09-08 06:17:45 adam Exp $
9 * \brief Implements ZOOM C interface.
17 #include <yaz/yaz-util.h>
18 #include <yaz/xmalloc.h>
19 #include <yaz/otherinfo.h>
21 #include <yaz/pquery.h>
22 #include <yaz/marcdisp.h>
23 #include <yaz/diagbib1.h>
24 #include <yaz/charneg.h>
29 #include <yaz/query-charset.h>
30 #include <yaz/copy_types.h>
31 #include <yaz/snprintf.h>
33 static int log_api = 0;
34 static int log_details = 0;
41 static void resultset_destroy(ZOOM_resultset r);
42 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
43 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
44 static char *cql2pqf(ZOOM_connection c, const char *cql);
48 * This wrapper is just for logging failed lookups. It would be nicer
49 * if it could cause failure when a lookup fails, but that's hard.
51 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
52 int oid_class, const char *str) {
53 Odr_oid *res = yaz_string_to_oid_odr(yaz_oid_std(), oid_class, str,
56 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
57 c, (int) oid_class, str);
62 static void initlog(void)
64 static int log_level_initialized = 0;
65 if (!log_level_initialized)
67 log_api = yaz_log_module_level("zoom");
68 log_details = yaz_log_module_level("zoomdetails");
69 log_level_initialized = 1;
73 static ZOOM_Event ZOOM_Event_create(int kind)
75 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
79 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
83 static void ZOOM_Event_destroy(ZOOM_Event event)
88 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
92 c->m_queue_back->prev = event;
93 assert(c->m_queue_front);
97 assert(!c->m_queue_front);
98 c->m_queue_front = event;
100 event->next = c->m_queue_back;
102 c->m_queue_back = event;
105 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
107 ZOOM_Event event = c->m_queue_front;
110 c->last_event = ZOOM_EVENT_NONE;
113 assert(c->m_queue_back);
114 c->m_queue_front = event->prev;
115 if (c->m_queue_front)
117 assert(c->m_queue_back);
118 c->m_queue_front->next = 0;
122 c->last_event = event->kind;
126 static void ZOOM_connection_remove_events(ZOOM_connection c)
129 while ((event = ZOOM_connection_get_event(c)))
130 ZOOM_Event_destroy(event);
133 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
135 ZOOM_Event event = c->m_queue_front;
137 return event ? event->kind : ZOOM_EVENT_NONE;
140 void ZOOM_connection_remove_tasks(ZOOM_connection c);
142 static void set_dset_error(ZOOM_connection c, int error,
144 const char *addinfo, const char *addinfo2)
151 if (!c->diagset || strcmp(dset, c->diagset))
154 c->diagset = xstrdup(dset);
155 /* remove integer part from SRW diagset .. */
156 if ((cp = strrchr(c->diagset, '/')))
159 if (addinfo && addinfo2)
161 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
162 strcpy(c->addinfo, addinfo);
163 strcat(c->addinfo, addinfo2);
166 c->addinfo = xstrdup(addinfo);
167 if (error != ZOOM_ERROR_NONE)
169 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
170 c, c->host_port ? c->host_port : "<>", dset, error,
171 addinfo ? addinfo : "",
172 addinfo2 ? addinfo2 : "");
173 ZOOM_connection_remove_tasks(c);
178 static void set_HTTP_error(ZOOM_connection c, int error,
179 const char *addinfo, const char *addinfo2)
181 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
184 static void set_SRU_error(ZOOM_connection c, Z_SRW_diagnostic *d)
186 const char *uri = d->uri;
191 if ((cp = strrchr(uri, '/')))
193 set_dset_error(c, code, uri, d->details, 0);
200 static void set_ZOOM_error(ZOOM_connection c, int error,
203 set_dset_error(c, error, "ZOOM", addinfo, 0);
206 static void clear_error(ZOOM_connection c)
209 * If an error is tied to an operation then it's ok to clear: for
210 * example, a diagnostic returned from a search is cleared by a
211 * subsequent search. However, problems such as Connection Lost
212 * or Init Refused are not cleared, because they are not
213 * recoverable: doing another search doesn't help.
216 ZOOM_connection_remove_events(c);
219 case ZOOM_ERROR_CONNECT:
220 case ZOOM_ERROR_MEMORY:
221 case ZOOM_ERROR_DECODE:
222 case ZOOM_ERROR_CONNECTION_LOST:
223 case ZOOM_ERROR_INIT:
224 case ZOOM_ERROR_INTERNAL:
225 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
228 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
232 void ZOOM_connection_show_task(ZOOM_task task)
236 case ZOOM_TASK_SEARCH:
237 yaz_log(YLOG_LOG, "search p=%p", task);
239 case ZOOM_TASK_RETRIEVE:
240 yaz_log(YLOG_LOG, "retrieve p=%p", task);
242 case ZOOM_TASK_CONNECT:
243 yaz_log(YLOG_LOG, "connect p=%p", task);
246 yaz_log(YLOG_LOG, "scant p=%p", task);
251 void ZOOM_connection_show_tasks(ZOOM_connection c)
254 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
255 for (task = c->tasks; task; task = task->next)
256 ZOOM_connection_show_task(task);
259 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
261 ZOOM_task *taskp = &c->tasks;
263 taskp = &(*taskp)->next;
264 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
265 (*taskp)->running = 0;
266 (*taskp)->which = which;
272 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
274 return c->tasks ? 0 : 1;
277 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
279 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
281 task->next = c->tasks;
290 void ZOOM_connection_remove_task(ZOOM_connection c)
292 ZOOM_task task = c->tasks;
296 c->tasks = task->next;
299 case ZOOM_TASK_SEARCH:
300 resultset_destroy(task->u.search.resultset);
301 xfree(task->u.search.syntax);
302 xfree(task->u.search.elementSetName);
304 case ZOOM_TASK_RETRIEVE:
305 resultset_destroy(task->u.retrieve.resultset);
306 xfree(task->u.retrieve.syntax);
307 xfree(task->u.retrieve.elementSetName);
309 case ZOOM_TASK_CONNECT:
312 ZOOM_scanset_destroy(task->u.scan.scan);
314 case ZOOM_TASK_PACKAGE:
315 ZOOM_package_destroy(task->u.package);
318 resultset_destroy(task->u.sort.resultset);
319 ZOOM_query_destroy(task->u.sort.q);
328 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
329 ZOOM_connection_put_event(c, event);
334 static int ZOOM_connection_exec_task(ZOOM_connection c);
336 void ZOOM_connection_remove_tasks(ZOOM_connection c)
339 ZOOM_connection_remove_task(c);
342 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
344 const char *elementSetName);
346 ZOOM_API(ZOOM_connection)
347 ZOOM_connection_create(ZOOM_options options)
349 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
353 yaz_log(log_api, "%p ZOOM_connection_create", c);
355 c->proto = PROTO_Z3950;
357 ZOOM_connection_set_mask(c, 0);
359 c->state = STATE_IDLE;
362 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
369 c->options = ZOOM_options_create_with_parent(options);
375 c->charset = c->lang = 0;
386 c->maximum_record_size = 0;
387 c->preferred_message_size = 0;
389 c->odr_in = odr_createmem(ODR_DECODE);
390 c->odr_out = odr_createmem(ODR_ENCODE);
393 c->support_named_resultsets = 0;
394 c->last_event = ZOOM_EVENT_NONE;
396 c->m_queue_front = 0;
399 c->sru_version = xstrdup("1.1");
404 /* set database names. Take local databases (if set); otherwise
405 take databases given in ZURL (if set); otherwise use Default */
406 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
409 char **databaseNames;
410 const char *cp = ZOOM_options_get(options, "databaseName");
412 if ((!cp || !*cp) && con->host_port)
414 if (strncmp(con->host_port, "unix:", 5) == 0)
415 cp = strchr(con->host_port+5, ':');
417 cp = strchr(con->host_port, '/');
423 nmem_strsplit(odr_getmem(odr), "+", cp, &databaseNames, num);
424 return databaseNames;
427 ZOOM_API(ZOOM_connection)
428 ZOOM_connection_new(const char *host, int portnum)
430 ZOOM_connection c = ZOOM_connection_create(0);
432 ZOOM_connection_connect(c, host, portnum);
436 static zoom_sru_mode get_sru_mode_from_string(const char *s)
439 return zoom_sru_soap;
440 if (!yaz_matchstr(s, "soap"))
441 return zoom_sru_soap;
442 else if (!yaz_matchstr(s, "get"))
444 else if (!yaz_matchstr(s, "post"))
445 return zoom_sru_post;
446 return zoom_sru_error;
450 ZOOM_connection_connect(ZOOM_connection c,
451 const char *host, int portnum)
458 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
459 c, host ? host : "null", portnum);
461 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
462 ZOOM_connection_remove_tasks(c);
466 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
470 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
473 val = ZOOM_options_get(c->options, "proxy");
476 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
477 c->proxy = xstrdup(val);
482 val = ZOOM_options_get(c->options, "charset");
485 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
486 c->charset = xstrdup(val);
490 val = ZOOM_options_get(c->options, "lang");
493 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
494 c->lang = xstrdup(val);
505 sprintf(hostn, "%.80s:%d", host, portnum);
506 c->host_port = xstrdup(hostn);
509 c->host_port = xstrdup(host);
514 * If the "<scheme>:" part of the host string is preceded by one
515 * or more comma-separated <name>=<value> pairs, these are taken
516 * to be options to be set on the connection object. Among other
517 * applications, this facility can be used to embed authentication
519 * user=admin,password=secret,tcp:localhost:9999
521 char *remainder = c->host_port;
522 char *pcolon = strchr(remainder, ':');
525 while ((pcomma = strchr(remainder, ',')) != 0 &&
526 (pcolon == 0 || pcomma < pcolon)) {
528 if ((pequals = strchr(remainder, '=')) != 0) {
530 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
531 ZOOM_connection_option_set(c, remainder, pequals+1);
533 remainder = pcomma+1;
536 if (remainder != c->host_port) {
538 c->host_port = xstrdup(remainder);
539 /*printf("# reset hp='%s'\n", remainder);*/
543 val = ZOOM_options_get(c->options, "sru");
544 c->sru_mode = get_sru_mode_from_string(val);
546 xfree(c->sru_version);
547 val = ZOOM_options_get(c->options, "sru_version");
548 c->sru_version = xstrdup(val ? val : "1.1");
550 ZOOM_options_set(c->options, "host", c->host_port);
552 xfree(c->cookie_out);
554 val = ZOOM_options_get(c->options, "cookie");
557 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
558 c->cookie_out = xstrdup(val);
563 val = ZOOM_options_get(c->options, "clientIP");
566 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
568 c->client_IP = xstrdup(val);
573 val = ZOOM_options_get(c->options, "group");
575 c->group = xstrdup(val);
579 val = ZOOM_options_get(c->options, "user");
581 c->user = xstrdup(val);
585 val = ZOOM_options_get(c->options, "password");
587 val = ZOOM_options_get(c->options, "pass");
590 c->password = xstrdup(val);
592 c->maximum_record_size =
593 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
594 c->preferred_message_size =
595 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
597 c->async = ZOOM_options_get_bool(c->options, "async", 0);
598 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
600 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
604 while (ZOOM_event(1, &c))
610 ZOOM_query_create(void)
612 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
614 yaz_log(log_details, "%p ZOOM_query_create", s);
618 s->odr = odr_createmem(ODR_ENCODE);
625 ZOOM_query_destroy(ZOOM_query s)
631 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
632 if (s->refcount == 0)
640 ZOOM_query_prefix(ZOOM_query s, const char *str)
642 s->query_string = odr_strdup(s->odr, str);
643 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
644 s->z_query->which = Z_Query_type_1;
645 s->z_query->u.type_1 = p_query_rpn(s->odr, str);
646 if (!s->z_query->u.type_1)
648 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
652 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
657 ZOOM_query_cql(ZOOM_query s, const char *str)
661 s->query_string = odr_strdup(s->odr, str);
663 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
664 ext->direct_reference = odr_oiddup(s->odr, yaz_oid_userinfo_cql);
665 ext->indirect_reference = 0;
667 ext->which = Z_External_CQL;
668 ext->u.cql = s->query_string;
670 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
671 s->z_query->which = Z_Query_type_104;
672 s->z_query->u.type_104 = ext;
674 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
680 * Translate the CQL string client-side into RPN which is passed to
681 * the server. This is useful for server's that don't themselves
682 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
683 * only as a place to stash diagnostics if compilation fails; if this
684 * information is not needed, a null pointer may be used.
687 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
691 ZOOM_connection freeme = 0;
693 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
695 conn = freeme = ZOOM_connection_create(0);
697 rpn = cql2pqf(conn, str);
699 ZOOM_connection_destroy(freeme);
703 ret = ZOOM_query_prefix(s, rpn);
709 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
710 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
711 * to the server, as the YAZ GFS doesn't know how to handle this.
714 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
715 int *ccl_error, const char **error_string,
719 struct ccl_rpn_node *rpn;
720 CCL_bibset bibset = ccl_qual_mk();
723 ccl_qual_buf(bibset, config);
725 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
728 *error_string = ccl_err_msg(*ccl_error);
733 WRBUF wr = wrbuf_alloc();
736 ret = ZOOM_query_prefix(s, wrbuf_cstr(wr));
739 ccl_qual_rm(&bibset);
744 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
746 s->sort_spec = yaz_sort_spec(s->odr, criteria);
749 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
753 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
757 static zoom_ret do_write(ZOOM_connection c);
760 ZOOM_connection_destroy(ZOOM_connection c)
765 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
768 for (r = c->resultsets; r; r = r->next)
774 odr_destroy(c->odr_in);
775 odr_destroy(c->odr_out);
776 ZOOM_options_destroy(c->options);
777 ZOOM_connection_remove_tasks(c);
778 ZOOM_connection_remove_events(c);
784 xfree(c->cookie_out);
790 xfree(c->sru_version);
794 void ZOOM_resultset_addref(ZOOM_resultset r)
799 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
804 ZOOM_resultset ZOOM_resultset_create(void)
807 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
811 yaz_log(log_details, "%p ZOOM_resultset_create", r);
814 r->odr = odr_createmem(ODR_ENCODE);
819 for (i = 0; i<RECORD_HASH_SIZE; i++)
820 r->record_hash[i] = 0;
825 r->databaseNames = 0;
826 r->num_databaseNames = 0;
830 ZOOM_API(ZOOM_resultset)
831 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
834 ZOOM_query s = ZOOM_query_create();
836 ZOOM_query_prefix(s, q);
838 r = ZOOM_connection_search(c, s);
839 ZOOM_query_destroy(s);
843 ZOOM_API(ZOOM_resultset)
844 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
846 ZOOM_resultset r = ZOOM_resultset_create();
850 const char *syntax, *elementSetName;
852 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
853 r->r_sort_spec = q->sort_spec;
856 r->options = ZOOM_options_create_with_parent(c->options);
858 start = ZOOM_options_get_int(r->options, "start", 0);
859 count = ZOOM_options_get_int(r->options, "count", 0);
861 /* If "presentChunk" is defined use that; otherwise "step" */
862 const char *cp = ZOOM_options_get(r->options, "presentChunk");
863 r->step = ZOOM_options_get_int(r->options,
864 (cp != 0 ? "presentChunk": "step"), 0);
866 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
867 cp = ZOOM_options_get(r->options, "setname");
869 r->setname = xstrdup(cp);
870 cp = ZOOM_options_get(r->options, "schema");
872 r->schema = xstrdup(cp);
874 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
879 r->next = c->resultsets;
884 if (c->host_port && c->proto == PROTO_HTTP)
888 yaz_log(log_details, "ZOOM_connection_search: no comstack");
889 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
893 yaz_log(log_details, "ZOOM_connection_search: reconnect");
898 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
899 task->u.search.resultset = r;
900 task->u.search.start = start;
901 task->u.search.count = count;
903 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
904 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
905 elementSetName = ZOOM_options_get(r->options, "elementSetName");
906 task->u.search.elementSetName = elementSetName
907 ? xstrdup(elementSetName) : 0;
909 ZOOM_resultset_addref(r);
915 while (ZOOM_event(1, &c))
922 ZOOM_resultset_sort(ZOOM_resultset r,
923 const char *sort_type, const char *sort_spec)
925 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
929 ZOOM_resultset_sort1(ZOOM_resultset r,
930 const char *sort_type, const char *sort_spec)
932 ZOOM_connection c = r->connection;
936 newq = ZOOM_query_create();
937 if (ZOOM_query_sortby(newq, sort_spec) < 0)
940 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
941 r, r, sort_type, sort_spec);
945 if (c->host_port && c->proto == PROTO_HTTP)
949 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
950 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
954 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
960 ZOOM_resultset_cache_reset(r);
961 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
962 task->u.sort.resultset = r;
963 task->u.sort.q = newq;
965 ZOOM_resultset_addref(r);
969 while (ZOOM_event(1, &c))
977 ZOOM_resultset_cache_reset(ZOOM_resultset r)
980 for (i = 0; i<RECORD_HASH_SIZE; i++)
982 ZOOM_record_cache rc;
983 for (rc = r->record_hash[i]; rc; rc = rc->next)
985 if (rc->rec.wrbuf_marc)
986 wrbuf_destroy(rc->rec.wrbuf_marc);
987 if (rc->rec.wrbuf_iconv)
988 wrbuf_destroy(rc->rec.wrbuf_iconv);
989 if (rc->rec.wrbuf_opac)
990 wrbuf_destroy(rc->rec.wrbuf_opac);
992 r->record_hash[i] = 0;
997 ZOOM_resultset_destroy(ZOOM_resultset r)
999 resultset_destroy(r);
1002 static void resultset_destroy(ZOOM_resultset r)
1007 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
1009 if (r->refcount == 0)
1011 ZOOM_resultset_cache_reset(r);
1015 /* remove ourselves from the resultsets in connection */
1016 ZOOM_resultset *rp = &r->connection->resultsets;
1019 assert(*rp); /* we must be in this list!! */
1021 { /* OK, we're here - take us out of it */
1028 ZOOM_query_destroy(r->query);
1029 ZOOM_options_destroy(r->options);
1030 odr_destroy(r->odr);
1038 ZOOM_resultset_size(ZOOM_resultset r)
1040 yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
1045 static void do_close(ZOOM_connection c)
1050 ZOOM_connection_set_mask(c, 0);
1051 c->state = STATE_IDLE;
1054 static int ZOOM_test_reconnect(ZOOM_connection c)
1058 if (!c->reconnect_ok)
1061 c->reconnect_ok = 0;
1062 c->tasks->running = 0;
1063 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1065 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1066 ZOOM_connection_put_event(c, event);
1071 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1072 int force_sync, int start, int count)
1077 const char *syntax, *elementSetName;
1081 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1082 " count=%d", r, force_sync, start, count);
1087 if (c->host_port && c->proto == PROTO_HTTP)
1091 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1092 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1096 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1098 c->reconnect_ok = 1;
1101 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1102 task->u.retrieve.resultset = r;
1103 task->u.retrieve.start = start;
1104 task->u.retrieve.count = count;
1106 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1107 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1108 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1109 task->u.retrieve.elementSetName = elementSetName
1110 ? xstrdup(elementSetName) : 0;
1112 cp = ZOOM_options_get(r->options, "schema");
1115 if (!r->schema || strcmp(r->schema, cp))
1118 r->schema = xstrdup(cp);
1122 ZOOM_resultset_addref(r);
1124 if (!r->connection->async || force_sync)
1125 while (r->connection && ZOOM_event(1, &r->connection))
1130 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1131 size_t start, size_t count)
1133 int force_present = 0;
1137 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1138 r, r, (long) start, (long) count);
1141 ZOOM_resultset_retrieve(r, force_present, start, count);
1145 for (i = 0; i< count; i++)
1146 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1150 static void get_cert(ZOOM_connection c)
1155 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1157 ZOOM_connection_option_setl(c, "sslPeerCert",
1158 cert_buf, cert_len);
1163 static zoom_ret do_connect(ZOOM_connection c)
1166 const char *effective_host;
1169 effective_host = c->proxy;
1171 effective_host = c->host_port;
1173 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1177 c->cs = cs_create_host(effective_host, 0, &add);
1179 if (c->cs && c->cs->protocol == PROTO_HTTP)
1182 const char *path = 0;
1184 c->proto = PROTO_HTTP;
1185 cs_get_host_args(c->host_port, &path);
1187 c->path = (char*) xmalloc(strlen(path)+2);
1189 strcpy(c->path+1, path);
1191 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1193 return zoom_complete;
1198 int ret = cs_connect(c->cs, add);
1201 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1202 ZOOM_connection_put_event(c, event);
1204 if (c->proto == PROTO_Z3950)
1205 ZOOM_connection_send_init(c);
1208 /* no init request for SRW .. */
1209 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1210 ZOOM_connection_remove_task(c);
1211 ZOOM_connection_set_mask(c, 0);
1212 ZOOM_connection_exec_task(c);
1214 c->state = STATE_ESTABLISHED;
1215 return zoom_pending;
1219 int mask = ZOOM_SELECT_EXCEPT;
1220 if (c->cs->io_pending & CS_WANT_WRITE)
1221 mask += ZOOM_SELECT_WRITE;
1222 if (c->cs->io_pending & CS_WANT_READ)
1223 mask += ZOOM_SELECT_READ;
1224 ZOOM_connection_set_mask(c, mask);
1225 c->state = STATE_CONNECTING;
1226 return zoom_pending;
1229 c->state = STATE_IDLE;
1230 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1231 return zoom_complete;
1234 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1237 for (i = 0; i<200; i++)
1241 Z_OtherInformation **oi;
1246 sprintf(buf, "otherInfo%d", i);
1247 val = ZOOM_options_get(c->options, buf);
1250 cp = strchr(val, ':');
1254 if (len >= sizeof(buf))
1255 len = sizeof(buf)-1;
1256 memcpy(buf, val, len);
1259 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
1264 yaz_oi_APDU(a, &oi);
1265 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
1269 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1274 Z_OtherInformation **oi;
1275 yaz_oi_APDU(a, &oi);
1276 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
1281 Z_OtherInformation **oi;
1282 yaz_oi_APDU(a, &oi);
1283 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
1286 otherInfo_attach(c, a, out);
1287 if (!z_APDU(out, &a, 0, 0))
1289 FILE *outf = fopen("/tmp/apdu.txt", "a");
1292 ODR odr_pr = odr_createmem(ODR_PRINT);
1293 fprintf(outf, "a=%p\n", a);
1294 odr_setprint(odr_pr, outf);
1295 z_APDU(odr_pr, &a, 0, 0);
1296 odr_destroy(odr_pr);
1298 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1299 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1303 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1307 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1311 if (encode_APDU(c, a, c->odr_out))
1312 return zoom_complete;
1313 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1314 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1315 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1316 ZOOM_connection_put_event(c, event);
1317 odr_reset(c->odr_out);
1321 /* returns 1 if PDU was sent OK (still pending )
1322 0 if PDU was not sent OK (nothing to wait for)
1325 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1327 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1328 Z_InitRequest *ireq = apdu->u.initRequest;
1329 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1330 odr_malloc(c->odr_out, sizeof(*auth));
1333 ODR_MASK_SET(ireq->options, Z_Options_search);
1334 ODR_MASK_SET(ireq->options, Z_Options_present);
1335 ODR_MASK_SET(ireq->options, Z_Options_scan);
1336 ODR_MASK_SET(ireq->options, Z_Options_sort);
1337 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1338 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1340 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1341 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1342 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1344 /* Index Data's Z39.50 Implementor Id is 81 */
1345 ireq->implementationId =
1346 odr_prepend(c->odr_out,
1347 ZOOM_options_get(c->options, "implementationId"),
1348 odr_prepend(c->odr_out, "81", ireq->implementationId));
1350 ireq->implementationName =
1351 odr_prepend(c->odr_out,
1352 ZOOM_options_get(c->options, "implementationName"),
1353 odr_prepend(c->odr_out, "ZOOM-C",
1354 ireq->implementationName));
1356 version = odr_strdup(c->odr_out, "$Revision: 1.146 $");
1357 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1358 version[strlen(version)-2] = '\0';
1359 ireq->implementationVersion =
1360 odr_prepend(c->odr_out,
1361 ZOOM_options_get(c->options, "implementationVersion"),
1362 odr_prepend(c->odr_out, &version[11],
1363 ireq->implementationVersion));
1365 *ireq->maximumRecordSize = c->maximum_record_size;
1366 *ireq->preferredMessageSize = c->preferred_message_size;
1368 if (c->group || c->password)
1370 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1373 pass->groupId = odr_strdup(c->odr_out, c->group);
1376 pass->userId = odr_strdup(c->odr_out, c->user);
1379 pass->password = odr_strdup(c->odr_out, c->password);
1380 auth->which = Z_IdAuthentication_idPass;
1381 auth->u.idPass = pass;
1382 ireq->idAuthentication = auth;
1386 auth->which = Z_IdAuthentication_open;
1387 auth->u.open = odr_strdup(c->odr_out, c->user);
1388 ireq->idAuthentication = auth;
1392 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
1393 yaz_oid_userinfo_proxy, 1, c->host_port);
1395 if (c->charset || c->lang)
1397 Z_OtherInformation **oi;
1398 Z_OtherInformationUnit *oi_unit;
1400 yaz_oi_APDU(apdu, &oi);
1402 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1404 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1405 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1406 oi_unit->information.externallyDefinedInfo =
1407 yaz_set_proposal_charneg_list(c->odr_out, " ",
1408 c->charset, c->lang, 1);
1412 return send_APDU(c, apdu);
1416 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1421 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1423 if (c->sru_mode == zoom_sru_get)
1425 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1427 else if (c->sru_mode == zoom_sru_post)
1429 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1431 else if (c->sru_mode == zoom_sru_soap)
1433 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1435 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1436 return zoom_complete;
1437 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1439 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1440 ZOOM_connection_put_event(c, event);
1441 odr_reset(c->odr_out);
1447 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type) {
1448 Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
1449 sr->username = c->user;
1450 sr->password = c->password;
1456 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1460 ZOOM_resultset resultset = 0;
1462 const char *option_val = 0;
1464 if (c->error) /* don't continue on error */
1465 return zoom_complete;
1467 switch(c->tasks->which)
1469 case ZOOM_TASK_SEARCH:
1470 resultset = c->tasks->u.search.resultset;
1471 resultset->setname = xstrdup("default");
1472 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1473 start = &c->tasks->u.search.start;
1474 count = &c->tasks->u.search.count;
1476 case ZOOM_TASK_RETRIEVE:
1477 resultset = c->tasks->u.retrieve.resultset;
1479 start = &c->tasks->u.retrieve.start;
1480 count = &c->tasks->u.retrieve.count;
1482 if (*start >= resultset->size)
1483 return zoom_complete;
1484 if (*start + *count > resultset->size)
1485 *count = resultset->size - *start;
1487 for (i = 0; i < *count; i++)
1490 record_cache_lookup(resultset, i + *start,
1491 c->tasks->u.retrieve.syntax,
1492 c->tasks->u.retrieve.elementSetName);
1497 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1498 ZOOM_connection_put_event(c, event);
1505 return zoom_complete;
1508 return zoom_complete;
1510 assert(resultset->query);
1512 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
1513 if (resultset->query->z_query->which == Z_Query_type_104
1514 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1516 sr->u.request->query_type = Z_SRW_query_type_cql;
1517 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1519 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1520 resultset->query->z_query->u.type_1)
1522 sr->u.request->query_type = Z_SRW_query_type_pqf;
1523 sr->u.request->query.pqf = resultset->query->query_string;
1527 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1528 return zoom_complete;
1530 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1531 sr->u.request->maximumRecords = odr_intdup(
1532 c->odr_out, resultset->step>0 ? resultset->step : *count);
1533 sr->u.request->recordSchema = resultset->schema;
1535 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1537 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1539 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1541 sr->extra_args = odr_strdup(c->odr_out, option_val);
1542 return send_srw(c, sr);
1545 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1547 return zoom_complete;
1551 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1554 int lslb, ssub, mspn;
1556 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1557 Z_SearchRequest *search_req = apdu->u.searchRequest;
1558 const char *elementSetName;
1559 const char *smallSetElementSetName;
1560 const char *mediumSetElementSetName;
1563 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1565 r = c->tasks->u.search.resultset;
1567 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1570 ZOOM_options_get(r->options, "elementSetName");
1571 smallSetElementSetName =
1572 ZOOM_options_get(r->options, "smallSetElementSetName");
1573 mediumSetElementSetName =
1574 ZOOM_options_get(r->options, "mediumSetElementSetName");
1576 if (!smallSetElementSetName)
1577 smallSetElementSetName = elementSetName;
1579 if (!mediumSetElementSetName)
1580 mediumSetElementSetName = elementSetName;
1585 /* prepare query for the search request */
1586 search_req->query = r->query->z_query;
1587 if (!search_req->query)
1589 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1590 return zoom_complete;
1592 if (r->query->z_query->which == Z_Query_type_1 ||
1593 r->query->z_query->which == Z_Query_type_101)
1595 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
1598 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
1601 search_req->query = yaz_copy_Z_Query(search_req->query,
1604 yaz_query_charset_convert_rpnquery(search_req->query->u.type_1,
1606 yaz_iconv_close(cd);
1610 search_req->databaseNames = r->databaseNames;
1611 search_req->num_databaseNames = r->num_databaseNames;
1613 /* get syntax (no need to provide unless piggyback is in effect) */
1614 syntax = c->tasks->u.search.syntax;
1616 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1617 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1618 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1619 if (lslb != -1 && ssub != -1 && mspn != -1)
1621 /* So're a Z39.50 expert? Let's hope you don't do sort */
1622 *search_req->largeSetLowerBound = lslb;
1623 *search_req->smallSetUpperBound = ssub;
1624 *search_req->mediumSetPresentNumber = mspn;
1626 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1627 && r->piggyback && !r->r_sort_spec && !r->schema)
1629 /* Regular piggyback - do it unless we're going to do sort */
1630 *search_req->largeSetLowerBound = 2000000000;
1631 *search_req->smallSetUpperBound = 1;
1632 *search_req->mediumSetPresentNumber =
1633 r->step>0 ? r->step : c->tasks->u.search.count;
1637 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1638 smallSetElementSetName = 0;
1639 mediumSetElementSetName = 0;
1642 if (smallSetElementSetName && *smallSetElementSetName)
1644 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1645 odr_malloc(c->odr_out, sizeof(*esn));
1647 esn->which = Z_ElementSetNames_generic;
1648 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1649 search_req->smallSetElementSetNames = esn;
1651 if (mediumSetElementSetName && *mediumSetElementSetName)
1653 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1654 odr_malloc(c->odr_out, sizeof(*esn));
1656 esn->which = Z_ElementSetNames_generic;
1657 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1658 search_req->mediumSetElementSetNames = esn;
1661 search_req->preferredRecordSyntax =
1662 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1666 if (c->support_named_resultsets)
1670 /* find the lowest unused ordinal so that we re-use
1671 result sets on the server. */
1672 for (ord = 1; ; ord++)
1675 sprintf(setname, "%d", ord);
1676 for (rp = c->resultsets; rp; rp = rp->next)
1677 if (rp->setname && !strcmp(rp->setname, setname))
1682 r->setname = xstrdup(setname);
1683 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1684 "set %s", c, r->setname);
1688 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1690 r->setname = xstrdup("default");
1692 ZOOM_options_set(r->options, "setname", r->setname);
1694 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1695 return send_APDU(c, apdu);
1698 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1700 char oid_name_buf[OID_STR_MAX];
1701 const char *oid_name;
1704 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
1707 case Z_DefaultDiagFormat_v2Addinfo:
1708 addinfo = r->u.v2Addinfo;
1710 case Z_DefaultDiagFormat_v3Addinfo:
1711 addinfo = r->u.v3Addinfo;
1716 set_dset_error(c, *r->condition, oid_name, addinfo, 0);
1719 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1721 if (p->which != Z_DiagRec_defaultFormat)
1722 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1724 response_default_diag(c, p->u.defaultFormat);
1727 ZOOM_API(ZOOM_record)
1728 ZOOM_record_clone(ZOOM_record srec)
1735 odr_enc = odr_createmem(ODR_ENCODE);
1736 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1738 buf = odr_getbuf(odr_enc, &size, 0);
1740 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1741 nrec->odr = odr_createmem(ODR_DECODE);
1742 nrec->wrbuf_marc = 0;
1743 nrec->wrbuf_iconv = 0;
1744 nrec->wrbuf_opac = 0;
1745 odr_setbuf(nrec->odr, buf, size, 0);
1746 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1748 odr_destroy(odr_enc);
1752 ZOOM_API(ZOOM_record)
1753 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1755 const char *syntax =
1756 ZOOM_options_get(s->options, "preferredRecordSyntax");
1757 const char *elementSetName =
1758 ZOOM_options_get(s->options, "elementSetName");
1760 return record_cache_lookup(s, pos, syntax, elementSetName);
1763 ZOOM_API(ZOOM_record)
1764 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1766 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1771 * MIKE: I think force_sync should always be zero, but I don't
1772 * want to make this change until I get the go-ahead from
1773 * Adam, in case something depends on the old synchronous
1777 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1778 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1779 rec = ZOOM_resultset_record_immediate(r, pos);
1785 ZOOM_record_destroy(ZOOM_record rec)
1789 if (rec->wrbuf_marc)
1790 wrbuf_destroy(rec->wrbuf_marc);
1791 if (rec->wrbuf_iconv)
1792 wrbuf_destroy(rec->wrbuf_iconv);
1793 if (rec->wrbuf_opac)
1794 wrbuf_destroy(rec->wrbuf_opac);
1795 odr_destroy(rec->odr);
1799 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1801 const char *buf, int sz,
1802 const char *record_charset)
1807 yaz_marc_t mt = yaz_marc_create();
1810 strcpy(to, "UTF-8");
1811 if (record_charset && *record_charset)
1813 /* Use "from,to" or just "from" */
1814 const char *cp = strchr(record_charset, ',');
1815 int clen = strlen(record_charset);
1818 strncpy( to, cp+1, sizeof(to)-1);
1819 to[sizeof(to)-1] = '\0';
1820 clen = cp - record_charset;
1822 if (clen > sizeof(from)-1)
1823 clen = sizeof(from)-1;
1826 strncpy(from, record_charset, clen);
1832 cd = yaz_iconv_open(to, from);
1833 yaz_marc_iconv(mt, cd);
1836 yaz_marc_xml(mt, marc_type);
1837 if (!rec->wrbuf_marc)
1838 rec->wrbuf_marc = wrbuf_alloc();
1839 wrbuf_rewind(rec->wrbuf_marc);
1840 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1842 yaz_marc_destroy(mt);
1844 yaz_iconv_close(cd);
1846 *len = wrbuf_len(rec->wrbuf_marc);
1847 return wrbuf_cstr(rec->wrbuf_marc);
1849 yaz_marc_destroy(mt);
1851 yaz_iconv_close(cd);
1855 static const char *record_iconv_return(ZOOM_record rec, int *len,
1856 const char *buf, int sz,
1857 const char *record_charset)
1864 strcpy(to, "UTF-8");
1866 if (record_charset && *record_charset)
1868 /* Use "from,to" or just "from" */
1869 const char *cp = strchr(record_charset, ',');
1870 int clen = strlen(record_charset);
1873 strncpy( to, cp+1, sizeof(to)-1);
1874 to[sizeof(to)-1] = '\0';
1875 clen = cp - record_charset;
1877 if (clen > sizeof(from)-1)
1878 clen = sizeof(from)-1;
1881 strncpy(from, record_charset, clen);
1885 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1887 if (!rec->wrbuf_iconv)
1888 rec->wrbuf_iconv = wrbuf_alloc();
1890 wrbuf_rewind(rec->wrbuf_iconv);
1892 wrbuf_iconv_write(rec->wrbuf_iconv, cd, buf, sz);
1893 wrbuf_iconv_reset(rec->wrbuf_iconv, cd);
1895 buf = wrbuf_cstr(rec->wrbuf_iconv);
1896 sz = wrbuf_len(rec->wrbuf_iconv);
1897 yaz_iconv_close(cd);
1905 ZOOM_record_error(ZOOM_record rec, const char **cp,
1906 const char **addinfo, const char **diagset)
1908 Z_NamePlusRecord *npr;
1913 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1915 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1916 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1917 const char *add = 0;
1919 if (diag_rec->which == Z_DiagRec_defaultFormat)
1921 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1924 error = *ddf->condition;
1927 case Z_DefaultDiagFormat_v2Addinfo:
1928 add = ddf->u.v2Addinfo;
1930 case Z_DefaultDiagFormat_v3Addinfo:
1931 add = ddf->u.v3Addinfo;
1936 yaz_oid_to_string(yaz_oid_std(),
1937 ddf->diagnosticSetId, &oclass);
1945 *addinfo = add ? add : "";
1947 *cp = diagbib1_str(error);
1953 ZOOM_API(const char *)
1954 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1961 Z_NamePlusRecord *npr;
1964 *len = 0; /* default return */
1973 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1975 if (cp[i] == ';' || cp[i] == ' ')
1981 while (type_spec[i] == ';')
1984 while (type_spec[i] == ' ')
1986 if (!strncmp(type_spec+i, "charset=", 8))
1989 i = i + 8; /* skip charset= */
1990 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1992 if (type_spec[i] == ';' || type_spec[i] == ' ')
1998 else if (!strncmp(type_spec+i, "xpath=", 6))
2002 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
2006 while (type_spec[i] == ' ')
2009 if (!strcmp(type, "database"))
2012 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
2013 return npr->databaseName;
2015 else if (!strcmp(type, "schema"))
2018 *len = rec->schema ? strlen(rec->schema) : 0;
2021 else if (!strcmp(type, "syntax"))
2023 const char *desc = 0;
2024 if (npr->which == Z_NamePlusRecord_databaseRecord)
2026 Z_External *r = (Z_External *) npr->u.databaseRecord;
2027 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
2032 *len = strlen(desc);
2035 if (npr->which != Z_NamePlusRecord_databaseRecord)
2038 /* from now on - we have a database record .. */
2039 if (!strcmp(type, "render"))
2041 Z_External *r = (Z_External *) npr->u.databaseRecord;
2042 const Odr_oid *oid = r->direct_reference;
2044 /* render bibliographic record .. */
2045 if (r->which == Z_External_OPAC)
2047 r = r->u.opac->bibliographicRecord;
2050 oid = r->direct_reference;
2052 if (r->which == Z_External_sutrs)
2053 return record_iconv_return(rec, len,
2054 (char*) r->u.sutrs->buf,
2057 else if (r->which == Z_External_octet)
2059 if (yaz_oid_is_iso2709(oid))
2061 const char *ret_buf = marc_iconv_return(
2062 rec, YAZ_MARC_LINE, len,
2063 (const char *) r->u.octet_aligned->buf,
2064 r->u.octet_aligned->len,
2069 return record_iconv_return(rec, len,
2070 (const char *) r->u.octet_aligned->buf,
2071 r->u.octet_aligned->len,
2074 else if (r->which == Z_External_grs1)
2076 if (!rec->wrbuf_marc)
2077 rec->wrbuf_marc = wrbuf_alloc();
2078 wrbuf_rewind(rec->wrbuf_marc);
2079 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
2080 return record_iconv_return(rec, len,
2081 wrbuf_buf(rec->wrbuf_marc),
2082 wrbuf_len(rec->wrbuf_marc),
2087 else if (!strcmp(type, "xml"))
2089 Z_External *r = (Z_External *) npr->u.databaseRecord;
2090 const Odr_oid *oid = r->direct_reference;
2092 /* render bibliographic record .. */
2093 if (r->which == Z_External_OPAC)
2095 r = r->u.opac->bibliographicRecord;
2098 oid = r->direct_reference;
2101 if (r->which == Z_External_sutrs)
2102 return record_iconv_return(rec, len,
2103 (const char *) r->u.sutrs->buf,
2106 else if (r->which == Z_External_octet)
2108 int marc_decode_type = YAZ_MARC_MARCXML;
2109 if (yaz_oid_is_iso2709(oid))
2111 const char *ret_buf = marc_iconv_return(
2112 rec, marc_decode_type, len,
2113 (const char *) r->u.octet_aligned->buf,
2114 r->u.octet_aligned->len,
2119 return record_iconv_return(rec, len,
2120 (const char *) r->u.octet_aligned->buf,
2121 r->u.octet_aligned->len,
2124 else if (r->which == Z_External_grs1)
2131 else if (!strcmp(type, "raw"))
2133 Z_External *r = (Z_External *) npr->u.databaseRecord;
2135 if (r->which == Z_External_sutrs)
2137 if (len) *len = r->u.sutrs->len;
2138 return (const char *) r->u.sutrs->buf;
2140 else if (r->which == Z_External_octet)
2142 if (len) *len = r->u.octet_aligned->len;
2143 return (const char *) r->u.octet_aligned->buf;
2145 else /* grs-1, explain, OPAC, ... */
2148 return (const char *) npr->u.databaseRecord;
2152 else if (!strcmp (type, "ext"))
2155 return (const char *) npr->u.databaseRecord;
2157 else if (!strcmp (type, "opac"))
2160 Z_External *r = (Z_External *) npr->u.databaseRecord;
2161 if (r->which == Z_External_OPAC)
2163 if (!rec->wrbuf_opac)
2164 rec->wrbuf_opac = wrbuf_alloc();
2165 wrbuf_rewind(rec->wrbuf_opac);
2166 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2167 return record_iconv_return(rec, len,
2168 wrbuf_buf(rec->wrbuf_opac),
2169 wrbuf_len(rec->wrbuf_opac),
2176 static int strcmp_null(const char *v1, const char *v2)
2182 return strcmp(v1, v2);
2185 static size_t record_hash(int pos)
2189 return pos % RECORD_HASH_SIZE;
2192 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2194 const char *syntax, const char *elementSetName,
2197 ZOOM_record_cache rc;
2199 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2200 ZOOM_connection_put_event(r->connection, event);
2202 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2206 if (strcmp_null(r->schema, rc->schema))
2208 if (strcmp_null(elementSetName,rc->elementSetName))
2210 if (strcmp_null(syntax, rc->syntax))
2212 /* not destroying rc->npr (it's handled by nmem )*/
2214 /* keeping wrbuf_marc too */
2218 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2220 rc->rec.schema = schema ? odr_strdup(r->odr, schema) : 0;
2222 rc->rec.wrbuf_marc = 0;
2223 rc->rec.wrbuf_iconv = 0;
2224 rc->rec.wrbuf_opac = 0;
2226 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2228 rc->elementSetName = 0;
2231 rc->syntax = odr_strdup(r->odr, syntax);
2236 rc->schema = odr_strdup(r->odr, r->schema);
2241 rc->next = r->record_hash[record_hash(pos)];
2242 r->record_hash[record_hash(pos)] = rc;
2245 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2247 const char *elementSetName)
2249 ZOOM_record_cache rc;
2251 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2255 if (strcmp_null(r->schema, rc->schema))
2257 if (strcmp_null(elementSetName,rc->elementSetName))
2259 if (strcmp_null(syntax, rc->syntax))
2267 static void handle_records(ZOOM_connection c, Z_Records *sr,
2270 ZOOM_resultset resultset;
2272 const char *syntax = 0, *elementSetName = 0;
2276 switch (c->tasks->which)
2278 case ZOOM_TASK_SEARCH:
2279 resultset = c->tasks->u.search.resultset;
2280 start = &c->tasks->u.search.start;
2281 count = &c->tasks->u.search.count;
2282 syntax = c->tasks->u.search.syntax;
2283 elementSetName = c->tasks->u.search.elementSetName;
2285 case ZOOM_TASK_RETRIEVE:
2286 resultset = c->tasks->u.retrieve.resultset;
2287 start = &c->tasks->u.retrieve.start;
2288 count = &c->tasks->u.retrieve.count;
2289 syntax = c->tasks->u.retrieve.syntax;
2290 elementSetName = c->tasks->u.retrieve.elementSetName;
2295 if (sr && sr->which == Z_Records_NSD)
2296 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2297 else if (sr && sr->which == Z_Records_multipleNSD)
2299 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2300 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2302 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2306 if (*count + *start > resultset->size)
2307 *count = resultset->size - *start;
2310 if (sr && sr->which == Z_Records_DBOSD)
2313 NMEM nmem = odr_extract_mem(c->odr_in);
2314 Z_NamePlusRecordList *p =
2315 sr->u.databaseOrSurDiagnostics;
2316 for (i = 0; i<p->num_records; i++)
2318 record_cache_add(resultset, p->records[i], i + *start,
2319 syntax, elementSetName,
2326 yaz_log(log_details,
2327 "handle_records resultset=%p start=%d count=%d",
2328 resultset, *start, *count);
2330 /* transfer our response to search_nmem .. we need it later */
2331 nmem_transfer(odr_getmem(resultset->odr), nmem);
2333 if (present_phase && p->num_records == 0)
2335 /* present response and we didn't get any records! */
2336 Z_NamePlusRecord *myrec =
2337 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2338 record_cache_add(resultset, myrec, *start,
2339 syntax, elementSetName, 0);
2342 else if (present_phase)
2344 /* present response and we didn't get any records! */
2345 Z_NamePlusRecord *myrec =
2346 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2347 record_cache_add(resultset, myrec, *start, syntax, elementSetName,
2353 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2355 handle_records(c, pr->records, 1);
2358 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2361 switch (term->which)
2363 case Z_Term_general:
2364 ZOOM_options_setl(opt, name,
2365 (const char *)(term->u.general->buf),
2366 term->u.general->len);
2368 case Z_Term_characterString:
2369 ZOOM_options_set(opt, name, term->u.characterString);
2371 case Z_Term_numeric:
2372 ZOOM_options_set_int(opt, name, *term->u.numeric);
2377 static void handle_queryExpression(ZOOM_options opt, const char *name,
2378 Z_QueryExpression *exp)
2384 case Z_QueryExpression_term:
2385 if (exp->u.term && exp->u.term->queryTerm)
2387 sprintf(opt_name, "%s.term", name);
2388 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2391 case Z_QueryExpression_query:
2396 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2397 Z_OtherInformation *o)
2400 for (i = 0; o && i < o->num_elements; i++)
2402 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2404 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2406 if (ext->which == Z_External_searchResult1)
2409 Z_SearchInfoReport *sr = ext->u.searchResult1;
2412 ZOOM_options_set_int(
2413 resultset->options, "searchresult.size", sr->num);
2415 for (j = 0; j < sr->num; j++)
2417 Z_SearchInfoReport_s *ent =
2418 ext->u.searchResult1->elements[j];
2421 sprintf(pref, "searchresult.%d", j);
2423 if (ent->subqueryId)
2426 sprintf(opt_name, "%s.id", pref);
2427 ZOOM_options_set(resultset->options, opt_name,
2430 if (ent->subqueryExpression)
2433 sprintf(opt_name, "%s.subquery", pref);
2434 handle_queryExpression(resultset->options, opt_name,
2435 ent->subqueryExpression);
2437 if (ent->subqueryInterpretation)
2440 sprintf(opt_name, "%s.interpretation", pref);
2441 handle_queryExpression(resultset->options, opt_name,
2442 ent->subqueryInterpretation);
2444 if (ent->subqueryRecommendation)
2447 sprintf(opt_name, "%s.recommendation", pref);
2448 handle_queryExpression(resultset->options, opt_name,
2449 ent->subqueryRecommendation);
2451 if (ent->subqueryCount)
2454 sprintf(opt_name, "%s.count", pref);
2455 ZOOM_options_set_int(resultset->options, opt_name,
2456 *ent->subqueryCount);
2464 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2466 ZOOM_resultset resultset;
2469 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2472 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2473 ZOOM_connection_put_event(c, event);
2475 resultset = c->tasks->u.search.resultset;
2477 if (sr->resultSetStatus)
2479 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2480 *sr->resultSetStatus);
2482 if (sr->presentStatus)
2484 ZOOM_options_set_int(resultset->options, "presentStatus",
2485 *sr->presentStatus);
2487 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2489 resultset->size = *sr->resultCount;
2490 handle_records(c, sr->records, 0);
2493 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2495 if (res->diagnostics && res->num_diagnostics > 0)
2496 response_diag(c, res->diagnostics[0]);
2499 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2501 NMEM nmem = odr_extract_mem(c->odr_in);
2504 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2506 scan = c->tasks->u.scan.scan;
2508 if (res->entries && res->entries->nonsurrogateDiagnostics)
2509 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2510 scan->scan_response = res;
2511 scan->srw_scan_response = 0;
2512 nmem_transfer(odr_getmem(scan->odr), nmem);
2514 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2515 if (res->positionOfTerm)
2516 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2517 if (res->scanStatus)
2518 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2519 if (res->numberOfEntriesReturned)
2520 ZOOM_options_set_int(scan->options, "number",
2521 *res->numberOfEntriesReturned);
2526 static zoom_ret send_sort(ZOOM_connection c,
2527 ZOOM_resultset resultset)
2530 resultset->r_sort_spec = 0;
2531 if (resultset->r_sort_spec)
2533 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2534 Z_SortRequest *req = apdu->u.sortRequest;
2536 req->num_inputResultSetNames = 1;
2537 req->inputResultSetNames = (Z_InternationalString **)
2538 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2539 req->inputResultSetNames[0] =
2540 odr_strdup(c->odr_out, resultset->setname);
2541 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2542 req->sortSequence = resultset->r_sort_spec;
2543 resultset->r_sort_spec = 0;
2544 return send_APDU(c, apdu);
2546 return zoom_complete;
2549 static zoom_ret send_present(ZOOM_connection c)
2552 Z_PresentRequest *req = 0;
2554 const char *syntax = 0;
2555 const char *elementSetName = 0;
2556 ZOOM_resultset resultset;
2561 yaz_log(log_details, "%p send_present no tasks", c);
2562 return zoom_complete;
2565 switch (c->tasks->which)
2567 case ZOOM_TASK_SEARCH:
2568 resultset = c->tasks->u.search.resultset;
2569 start = &c->tasks->u.search.start;
2570 count = &c->tasks->u.search.count;
2571 syntax = c->tasks->u.search.syntax;
2572 elementSetName = c->tasks->u.search.elementSetName;
2574 case ZOOM_TASK_RETRIEVE:
2575 resultset = c->tasks->u.retrieve.resultset;
2576 start = &c->tasks->u.retrieve.start;
2577 count = &c->tasks->u.retrieve.count;
2578 syntax = c->tasks->u.retrieve.syntax;
2579 elementSetName = c->tasks->u.retrieve.elementSetName;
2582 return zoom_complete;
2584 yaz_log(log_details, "%p send_present start=%d count=%d",
2587 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2589 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2592 if (c->error) /* don't continue on error */
2593 return zoom_complete;
2594 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2595 resultset, *start, *count);
2597 for (i = 0; i < *count; i++)
2600 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2605 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2606 ZOOM_connection_put_event(c, event);
2614 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2615 return zoom_complete;
2618 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2619 req = apdu->u.presentRequest;
2622 yaz_log(log_details, "%p send_present skip=%d", c, i);
2624 *req->resultSetStartPoint = *start + 1;
2625 *req->numberOfRecordsRequested = resultset->step>0 ?
2626 resultset->step : *count;
2627 if (*req->numberOfRecordsRequested + *start > resultset->size)
2628 *req->numberOfRecordsRequested = resultset->size - *start;
2629 assert(*req->numberOfRecordsRequested > 0);
2631 if (syntax && *syntax)
2632 req->preferredRecordSyntax =
2633 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2635 if (resultset->schema && *resultset->schema)
2637 Z_RecordComposition *compo = (Z_RecordComposition *)
2638 odr_malloc(c->odr_out, sizeof(*compo));
2640 req->recordComposition = compo;
2641 compo->which = Z_RecordComp_complex;
2642 compo->u.complex = (Z_CompSpec *)
2643 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2644 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2645 odr_malloc(c->odr_out, sizeof(bool_t));
2646 *compo->u.complex->selectAlternativeSyntax = 0;
2648 compo->u.complex->generic = (Z_Specification *)
2649 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2651 compo->u.complex->generic->which = Z_Schema_oid;
2652 compo->u.complex->generic->schema.oid = (Odr_oid *)
2653 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2655 if (!compo->u.complex->generic->schema.oid)
2657 /* OID wasn't a schema! Try record syntax instead. */
2659 compo->u.complex->generic->schema.oid = (Odr_oid *)
2660 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2662 if (elementSetName && *elementSetName)
2664 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2665 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2666 compo->u.complex->generic->elementSpec->which =
2667 Z_ElementSpec_elementSetName;
2668 compo->u.complex->generic->elementSpec->u.elementSetName =
2669 odr_strdup(c->odr_out, elementSetName);
2672 compo->u.complex->generic->elementSpec = 0;
2673 compo->u.complex->num_dbSpecific = 0;
2674 compo->u.complex->dbSpecific = 0;
2675 compo->u.complex->num_recordSyntax = 0;
2676 compo->u.complex->recordSyntax = 0;
2678 else if (elementSetName && *elementSetName)
2680 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2681 odr_malloc(c->odr_out, sizeof(*esn));
2682 Z_RecordComposition *compo = (Z_RecordComposition *)
2683 odr_malloc(c->odr_out, sizeof(*compo));
2685 esn->which = Z_ElementSetNames_generic;
2686 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2687 compo->which = Z_RecordComp_simple;
2688 compo->u.simple = esn;
2689 req->recordComposition = compo;
2691 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2692 return send_APDU(c, apdu);
2695 ZOOM_API(ZOOM_scanset)
2696 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2699 ZOOM_query q = ZOOM_query_create();
2701 ZOOM_query_prefix(q, start);
2703 s = ZOOM_connection_scan1(c, q);
2704 ZOOM_query_destroy(q);
2709 ZOOM_API(ZOOM_scanset)
2710 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2712 ZOOM_scanset scan = 0;
2716 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2717 scan->connection = c;
2718 scan->odr = odr_createmem(ODR_DECODE);
2719 scan->options = ZOOM_options_create_with_parent(c->options);
2721 scan->scan_response = 0;
2722 scan->srw_scan_response = 0;
2726 scan->databaseNames = set_DatabaseNames(c, c->options,
2727 &scan->num_databaseNames,
2732 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2733 task->u.scan.scan = scan;
2738 while (ZOOM_event(1, &c))
2746 ZOOM_scanset_destroy(ZOOM_scanset scan)
2751 if (scan->refcount == 0)
2753 ZOOM_query_destroy(scan->query);
2755 odr_destroy(scan->odr);
2757 ZOOM_options_destroy(scan->options);
2762 static zoom_ret send_package(ZOOM_connection c)
2766 yaz_log(log_details, "%p send_package", c);
2768 return zoom_complete;
2769 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2771 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2772 ZOOM_connection_put_event(c, event);
2774 c->buf_out = c->tasks->u.package->buf_out;
2775 c->len_out = c->tasks->u.package->len_out;
2780 static zoom_ret ZOOM_connection_send_scan(ZOOM_connection c)
2783 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2784 Z_ScanRequest *req = apdu->u.scanRequest;
2786 yaz_log(log_details, "%p send_scan", c);
2788 return zoom_complete;
2789 assert (c->tasks->which == ZOOM_TASK_SCAN);
2790 scan = c->tasks->u.scan.scan;
2792 /* Z39.50 scan can only carry RPN */
2793 if (scan->query->z_query->which == Z_Query_type_1 ||
2794 scan->query->z_query->which == Z_Query_type_101)
2796 Z_RPNQuery *rpn = scan->query->z_query->u.type_1;
2797 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
2800 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
2803 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
2805 yaz_query_charset_convert_rpnquery(
2806 rpn, c->odr_out, cd);
2807 yaz_iconv_close(cd);
2810 req->attributeSet = rpn->attributeSetId;
2811 if (!req->attributeSet)
2812 req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
2813 if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
2814 rpn->RPNStructure->u.simple->which == Z_Operand_APT)
2816 req->termListAndStartPoint =
2817 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
2821 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
2822 return zoom_complete;
2827 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2828 return zoom_complete;
2831 *req->numberOfTermsRequested =
2832 ZOOM_options_get_int(scan->options, "number", 10);
2834 req->preferredPositionInResponse =
2835 odr_intdup(c->odr_out,
2836 ZOOM_options_get_int(scan->options, "position", 1));
2839 odr_intdup(c->odr_out,
2840 ZOOM_options_get_int(scan->options, "stepSize", 0));
2842 req->databaseNames = scan->databaseNames;
2843 req->num_databaseNames = scan->num_databaseNames;
2845 return send_APDU(c, apdu);
2849 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2853 const char *option_val = 0;
2856 return zoom_complete;
2857 assert (c->tasks->which == ZOOM_TASK_SCAN);
2858 scan = c->tasks->u.scan.scan;
2860 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
2862 /* SRU scan can only carry CQL and PQF */
2863 if (scan->query->z_query->which == Z_Query_type_104)
2865 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
2866 sr->u.scan_request->scanClause.cql = scan->query->query_string;
2868 else if (scan->query->z_query->which == Z_Query_type_1
2869 || scan->query->z_query->which == Z_Query_type_101)
2871 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
2872 sr->u.scan_request->scanClause.pqf = scan->query->query_string;
2876 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2877 return zoom_complete;
2880 sr->u.scan_request->maximumTerms = odr_intdup(
2881 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
2883 sr->u.scan_request->responsePosition = odr_intdup(
2884 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
2886 option_val = ZOOM_options_get(scan->options, "extraArgs");
2888 sr->extra_args = odr_strdup(c->odr_out, option_val);
2889 return send_srw(c, sr);
2892 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2894 return zoom_complete;
2900 ZOOM_scanset_size(ZOOM_scanset scan)
2905 if (scan->scan_response && scan->scan_response->entries)
2906 return scan->scan_response->entries->num_entries;
2907 else if (scan->srw_scan_response)
2908 return scan->srw_scan_response->num_terms;
2912 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
2914 const char **value_term, size_t *value_len,
2915 const char **disp_term, size_t *disp_len)
2917 size_t noent = ZOOM_scanset_size(scan);
2926 if (pos >= noent || pos < 0)
2928 if (scan->scan_response)
2930 Z_ScanResponse *res = scan->scan_response;
2931 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2933 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2935 *value_term = (const char *) t->term->u.general->buf;
2936 *value_len = t->term->u.general->len;
2939 *disp_term = t->displayTerm;
2940 *disp_len = strlen(*disp_term);
2942 else if (t->term->which == Z_Term_general)
2944 *disp_term = (const char *) t->term->u.general->buf;
2945 *disp_len = t->term->u.general->len;
2947 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2950 if (scan->srw_scan_response)
2952 Z_SRW_scanResponse *res = scan->srw_scan_response;
2953 Z_SRW_scanTerm *t = res->terms + pos;
2956 *value_term = t->value;
2957 *value_len = strlen(*value_term);
2960 *disp_term = t->displayTerm;
2962 *disp_term = t->value;
2963 *disp_len = strlen(*disp_term);
2964 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
2969 ZOOM_API(const char *)
2970 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2973 const char *value_term = 0;
2974 size_t value_len = 0;
2975 const char *disp_term = 0;
2976 size_t disp_len = 0;
2978 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
2979 &disp_term, &disp_len);
2985 ZOOM_API(const char *)
2986 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2989 const char *value_term = 0;
2990 size_t value_len = 0;
2991 const char *disp_term = 0;
2992 size_t disp_len = 0;
2994 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
2995 &disp_term, &disp_len);
3001 ZOOM_API(const char *)
3002 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
3004 return ZOOM_options_get(scan->options, key);
3008 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
3011 ZOOM_options_set(scan->options, key, val);
3014 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
3017 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
3018 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3020 str = ZOOM_options_get(p->options, "package-name");
3022 req->packageName = odr_strdup(p->odr_out, str);
3024 str = ZOOM_options_get(p->options, "user-id");
3026 req->userId = odr_strdup(p->odr_out, str);
3028 req->packageType = odr_oiddup(p->odr_out, oid);
3030 str = ZOOM_options_get(p->options, "function");
3033 if (!strcmp (str, "create"))
3034 *req->function = Z_ExtendedServicesRequest_create;
3035 if (!strcmp (str, "delete"))
3036 *req->function = Z_ExtendedServicesRequest_delete;
3037 if (!strcmp (str, "modify"))
3038 *req->function = Z_ExtendedServicesRequest_modify;
3041 str = ZOOM_options_get(p->options, "waitAction");
3044 if (!strcmp (str, "wait"))
3045 *req->waitAction = Z_ExtendedServicesRequest_wait;
3046 if (!strcmp (str, "waitIfPossible"))
3047 *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
3048 if (!strcmp (str, "dontWait"))
3049 *req->waitAction = Z_ExtendedServicesRequest_dontWait;
3050 if (!strcmp (str, "dontReturnPackage"))
3051 *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
3056 static const char *ill_array_lookup(void *clientData, const char *idx)
3058 ZOOM_package p = (ZOOM_package) clientData;
3059 return ZOOM_options_get(p->options, idx+4);
3062 static Z_External *encode_ill_request(ZOOM_package p)
3064 ODR out = p->odr_out;
3067 struct ill_get_ctl ctl;
3069 ctl.odr = p->odr_out;
3071 ctl.f = ill_array_lookup;
3073 req = ill_get_ILLRequest(&ctl, "ill", 0);
3075 if (!ill_Request(out, &req, 0, 0))
3077 int ill_request_size;
3078 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
3079 if (ill_request_buf)
3080 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
3085 int illRequest_size = 0;
3086 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
3088 r = (Z_External *) odr_malloc(out, sizeof(*r));
3089 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
3090 r->indirect_reference = 0;
3092 r->which = Z_External_single;
3094 r->u.single_ASN1_type =
3095 odr_create_Odr_oct(out,
3096 (unsigned char *)illRequest_buf,
3102 static Z_ItemOrder *encode_item_order(ZOOM_package p)
3104 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
3107 req->which = Z_IOItemOrder_esRequest;
3108 req->u.esRequest = (Z_IORequest *)
3109 odr_malloc(p->odr_out,sizeof(Z_IORequest));
3111 /* to keep part ... */
3112 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
3113 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
3114 req->u.esRequest->toKeep->supplDescription = 0;
3115 req->u.esRequest->toKeep->contact = (Z_IOContact *)
3116 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
3118 str = ZOOM_options_get(p->options, "contact-name");
3119 req->u.esRequest->toKeep->contact->name = str ?
3120 odr_strdup(p->odr_out, str) : 0;
3122 str = ZOOM_options_get(p->options, "contact-phone");
3123 req->u.esRequest->toKeep->contact->phone = str ?
3124 odr_strdup(p->odr_out, str) : 0;
3126 str = ZOOM_options_get(p->options, "contact-email");
3127 req->u.esRequest->toKeep->contact->email = str ?
3128 odr_strdup(p->odr_out, str) : 0;
3130 req->u.esRequest->toKeep->addlBilling = 0;
3132 /* not to keep part ... */
3133 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
3134 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3136 str = ZOOM_options_get(p->options, "itemorder-setname");
3141 req->u.esRequest->notToKeep->resultSetItem = 0;
3144 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3145 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3147 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3148 odr_strdup(p->odr_out, str);
3149 req->u.esRequest->notToKeep->resultSetItem->item =
3150 (int *) odr_malloc(p->odr_out, sizeof(int));
3152 str = ZOOM_options_get(p->options, "itemorder-item");
3153 *req->u.esRequest->notToKeep->resultSetItem->item =
3154 (str ? atoi(str) : 1);
3157 str = ZOOM_options_get(p->options, "doc");
3160 req->u.esRequest->notToKeep->itemRequest =
3161 z_ext_record_xml(p->odr_out, str, strlen(str));
3164 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3169 Z_APDU *create_admin_package(ZOOM_package p, int type,
3170 Z_ESAdminOriginPartToKeep **toKeepP,
3171 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3173 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3176 Z_ESAdminOriginPartToKeep *toKeep;
3177 Z_ESAdminOriginPartNotToKeep *notToKeep;
3178 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3179 const char *first_db = "Default";
3181 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3186 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3188 r->indirect_reference = 0;
3189 r->which = Z_External_ESAdmin;
3191 r->u.adminService = (Z_Admin *)
3192 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3193 r->u.adminService->which = Z_Admin_esRequest;
3194 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3195 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3197 toKeep = r->u.adminService->u.esRequest->toKeep =
3198 (Z_ESAdminOriginPartToKeep *)
3199 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3200 toKeep->which = type;
3201 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3202 toKeep->u.create = odr_nullval();
3203 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3205 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3206 (Z_ESAdminOriginPartNotToKeep *)
3207 odr_malloc(p->odr_out,
3208 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3209 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3210 notToKeep->u.recordsWillFollow = odr_nullval();
3214 *notToKeepP = notToKeep;
3219 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3221 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3222 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3223 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3224 const char *doc = ZOOM_options_get(p->options, "doc");
3229 req->taskSpecificParameters = ext;
3230 ext->direct_reference = req->packageType;
3231 ext->descriptor = 0;
3232 ext->indirect_reference = 0;
3234 ext->which = Z_External_octet;
3235 ext->u.single_ASN1_type =
3236 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
3241 static Z_APDU *create_update_package(ZOOM_package p)
3244 const char *first_db = "Default";
3246 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3247 const char *action = ZOOM_options_get(p->options, "action");
3248 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
3249 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3250 const char *record_buf = ZOOM_options_get(p->options, "record");
3251 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3252 const char *version = ZOOM_options_get(p->options, "updateVersion");
3254 const char *correlationInfo_note =
3255 ZOOM_options_get(p->options, "correlationInfo.note");
3256 const char *correlationInfo_id =
3257 ZOOM_options_get(p->options, "correlationInfo.id");
3259 Odr_oid *syntax_oid = 0;
3260 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
3268 record_buf = "void";
3269 syntax_str = "SUTRS";
3274 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3275 CLASS_RECSYN, syntax_str,
3287 package_oid = yaz_oid_extserv_database_update_first_version;
3288 /* old update does not support specialUpdate */
3290 action = "recordInsert";
3294 action = "specialUpdate";
3295 package_oid = yaz_oid_extserv_database_update_second_version;
3299 action = "specialUpdate";
3300 package_oid = yaz_oid_extserv_database_update;
3306 if (!strcmp(action, "recordInsert"))
3307 action_no = Z_IUOriginPartToKeep_recordInsert;
3308 else if (!strcmp(action, "recordReplace"))
3309 action_no = Z_IUOriginPartToKeep_recordReplace;
3310 else if (!strcmp(action, "recordDelete"))
3311 action_no = Z_IUOriginPartToKeep_recordDelete;
3312 else if (!strcmp(action, "elementUpdate"))
3313 action_no = Z_IUOriginPartToKeep_elementUpdate;
3314 else if (!strcmp(action, "specialUpdate"))
3315 action_no = Z_IUOriginPartToKeep_specialUpdate;
3319 apdu = create_es_package(p, package_oid);
3322 Z_IUOriginPartToKeep *toKeep;
3323 Z_IUSuppliedRecords *notToKeep;
3324 Z_External *r = (Z_External *)
3325 odr_malloc(p->odr_out, sizeof(*r));
3326 const char *elementSetName =
3327 ZOOM_options_get(p->options, "elementSetName");
3329 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3331 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
3333 r->which = Z_External_update;
3334 r->indirect_reference = 0;
3335 r->u.update = (Z_IUUpdate *)
3336 odr_malloc(p->odr_out, sizeof(*r->u.update));
3338 r->u.update->which = Z_IUUpdate_esRequest;
3339 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3340 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3341 toKeep = r->u.update->u.esRequest->toKeep =
3342 (Z_IUOriginPartToKeep *)
3343 odr_malloc(p->odr_out, sizeof(*toKeep));
3345 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3348 toKeep->elementSetName = 0;
3350 toKeep->elementSetName = odr_strdup(p->odr_out, elementSetName);
3352 toKeep->actionQualifier = 0;
3353 toKeep->action = odr_intdup(p->odr_out, action_no);
3355 notToKeep = r->u.update->u.esRequest->notToKeep =
3356 (Z_IUSuppliedRecords *)
3357 odr_malloc(p->odr_out, sizeof(*notToKeep));
3359 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3360 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3361 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3362 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3363 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3366 notToKeep->elements[0]->u.opaque =
3367 odr_create_Odr_oct(p->odr_out,
3368 (const unsigned char *) recordIdOpaque,
3369 strlen(recordIdOpaque));
3371 else if (recordIdNumber)
3373 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3375 notToKeep->elements[0]->u.number =
3376 odr_intdup(p->odr_out, atoi(recordIdNumber));
3379 notToKeep->elements[0]->u.opaque = 0;
3380 notToKeep->elements[0]->supplementalId = 0;
3381 if (correlationInfo_note || correlationInfo_id)
3383 Z_IUCorrelationInfo *ci;
3384 ci = notToKeep->elements[0]->correlationInfo =
3385 odr_malloc(p->odr_out, sizeof(*ci));
3386 ci->note = correlationInfo_note ?
3387 odr_strdup(p->odr_out, correlationInfo_note) : 0;
3388 ci->id = correlationInfo_id ?
3389 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3392 notToKeep->elements[0]->correlationInfo = 0;
3393 notToKeep->elements[0]->record =
3394 z_ext_record_oid(p->odr_out, syntax_oid,
3395 record_buf, strlen(record_buf));
3399 ODR print = odr_createmem(ODR_PRINT);
3401 z_APDU(print, &apdu, 0, 0);
3408 ZOOM_package_send(ZOOM_package p, const char *type)
3415 odr_reset(p->odr_out);
3418 if (!strcmp(type, "itemorder"))
3420 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3423 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3425 r->direct_reference =
3426 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3428 r->which = Z_External_itemOrder;
3429 r->indirect_reference = 0;
3430 r->u.itemOrder = encode_item_order(p);
3432 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3435 else if (!strcmp(type, "create")) /* create database */
3437 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3440 else if (!strcmp(type, "drop")) /* drop database */
3442 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3445 else if (!strcmp(type, "commit")) /* commit changes */
3447 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3450 else if (!strcmp(type, "update")) /* update record(s) */
3452 apdu = create_update_package(p);
3454 else if (!strcmp(type, "xmlupdate"))
3456 apdu = create_xmlupdate_package(p);
3460 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3464 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3465 task->u.package = p;
3466 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3467 p->buf_out = (char *) xmalloc(p->len_out);
3468 memcpy(p->buf_out, buf, p->len_out);
3473 while (ZOOM_event(1, &c))
3480 ZOOM_API(ZOOM_package)
3481 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3483 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3486 p->odr_out = odr_createmem(ODR_ENCODE);
3487 p->options = ZOOM_options_create_with_parent2(options, c->options);
3495 ZOOM_package_destroy(ZOOM_package p)
3500 if (p->refcount == 0)
3502 odr_destroy(p->odr_out);
3505 ZOOM_options_destroy(p->options);
3510 ZOOM_API(const char *)
3511 ZOOM_package_option_get(ZOOM_package p, const char *key)
3513 return ZOOM_options_get(p->options, key);
3518 ZOOM_package_option_set(ZOOM_package p, const char *key,
3521 ZOOM_options_set(p->options, key, val);
3524 static int ZOOM_connection_exec_task(ZOOM_connection c)
3526 ZOOM_task task = c->tasks;
3527 zoom_ret ret = zoom_complete;
3531 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3532 c, task->which, task->running);
3533 if (c->error != ZOOM_ERROR_NONE)
3535 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3536 "removing tasks because of error = %d", c, c->error);
3537 ZOOM_connection_remove_tasks(c);
3542 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3543 "task already running", c);
3547 ret = zoom_complete;
3548 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3550 switch (task->which)
3552 case ZOOM_TASK_SEARCH:
3553 if (c->proto == PROTO_HTTP)
3554 ret = ZOOM_connection_srw_send_search(c);
3556 ret = ZOOM_connection_send_search(c);
3558 case ZOOM_TASK_RETRIEVE:
3559 if (c->proto == PROTO_HTTP)
3560 ret = ZOOM_connection_srw_send_search(c);
3562 ret = send_present(c);
3564 case ZOOM_TASK_CONNECT:
3565 ret = do_connect(c);
3567 case ZOOM_TASK_SCAN:
3568 if (c->proto == PROTO_HTTP)
3569 ret = ZOOM_connection_srw_send_scan(c);
3571 ret = ZOOM_connection_send_scan(c);
3573 case ZOOM_TASK_PACKAGE:
3574 ret = send_package(c);
3576 case ZOOM_TASK_SORT:
3577 c->tasks->u.sort.resultset->r_sort_spec =
3578 c->tasks->u.sort.q->sort_spec;
3579 ret = send_sort(c, c->tasks->u.sort.resultset);
3585 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3586 "remove tasks because no connection exist", c);
3587 ZOOM_connection_remove_tasks(c);
3589 if (ret == zoom_complete)
3591 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3592 "task removed (complete)", c);
3593 ZOOM_connection_remove_task(c);
3596 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3601 static zoom_ret send_sort_present(ZOOM_connection c)
3603 zoom_ret r = zoom_complete;
3605 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3606 r = send_sort(c, c->tasks->u.search.resultset);
3607 if (r == zoom_complete)
3608 r = send_present(c);
3612 static int es_response(ZOOM_connection c,
3613 Z_ExtendedServicesResponse *res)
3615 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3617 if (res->diagnostics && res->num_diagnostics > 0)
3618 response_diag(c, res->diagnostics[0]);
3619 if (res->taskPackage &&
3620 res->taskPackage->which == Z_External_extendedService)
3622 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3623 Odr_oct *id = taskPackage->targetReference;
3626 ZOOM_options_setl(c->tasks->u.package->options,
3627 "targetReference", (char*) id->buf, id->len);
3629 if (res->taskPackage &&
3630 res->taskPackage->which == Z_External_octet)
3632 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3633 ZOOM_options_setl(c->tasks->u.package->options,
3634 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3639 static void interpret_init_diag(ZOOM_connection c,
3640 Z_DiagnosticFormat *diag)
3644 Z_DiagnosticFormat_s *ds = diag->elements[0];
3645 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3646 response_default_diag(c, ds->u.defaultDiagRec);
3651 static void interpret_otherinformation_field(ZOOM_connection c,
3652 Z_OtherInformation *ui)
3655 for (i = 0; i < ui->num_elements; i++)
3657 Z_OtherInformationUnit *unit = ui->list[i];
3658 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3659 unit->information.externallyDefinedInfo &&
3660 unit->information.externallyDefinedInfo->which ==
3663 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3669 static void set_init_option(const char *name, void *clientData) {
3670 ZOOM_connection c = (ZOOM_connection) clientData;
3673 sprintf(buf, "init_opt_%.70s", name);
3674 ZOOM_connection_option_set(c, buf, "1");
3678 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3680 Z_InitResponse *initrs;
3682 ZOOM_connection_set_mask(c, 0);
3683 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3686 case Z_APDU_initResponse:
3687 yaz_log(log_api, "%p recv_apdu: Received Init response", c);
3688 initrs = apdu->u.initResponse;
3689 ZOOM_connection_option_set(c, "serverImplementationId",
3690 initrs->implementationId ?
3691 initrs->implementationId : "");
3692 ZOOM_connection_option_set(c, "serverImplementationName",
3693 initrs->implementationName ?
3694 initrs->implementationName : "");
3695 ZOOM_connection_option_set(c, "serverImplementationVersion",
3696 initrs->implementationVersion ?
3697 initrs->implementationVersion : "");
3698 /* Set the three old options too, for old applications */
3699 ZOOM_connection_option_set(c, "targetImplementationId",
3700 initrs->implementationId ?
3701 initrs->implementationId : "");
3702 ZOOM_connection_option_set(c, "targetImplementationName",
3703 initrs->implementationName ?
3704 initrs->implementationName : "");
3705 ZOOM_connection_option_set(c, "targetImplementationVersion",
3706 initrs->implementationVersion ?
3707 initrs->implementationVersion : "");
3709 /* Make initrs->options available as ZOOM-level options */
3710 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3712 if (!*initrs->result)
3714 Z_External *uif = initrs->userInformationField;
3716 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3718 if (uif && uif->which == Z_External_userInfo1)
3719 interpret_otherinformation_field(c, uif->u.userInfo1);
3724 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
3725 yaz_oid_userinfo_cookie, 1, 0);
3726 xfree(c->cookie_in);
3729 c->cookie_in = xstrdup(cookie);
3730 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3731 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3732 c->support_named_resultsets = 1;
3735 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3736 ZOOM_connection_remove_task(c);
3738 ZOOM_connection_exec_task(c);
3740 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3742 NMEM tmpmem = nmem_create();
3743 Z_CharSetandLanguageNegotiation *p =
3744 yaz_get_charneg_record(initrs->otherInfo);
3748 char *charset = NULL, *lang = NULL;
3751 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3752 yaz_log(log_details, "%p recv_apdu target accepted: "
3753 "charset %s, language %s, select %d",
3755 charset ? charset : "none", lang ? lang : "none", sel);
3757 ZOOM_connection_option_set(c, "negotiation-charset",
3760 ZOOM_connection_option_set(c, "negotiation-lang",
3763 ZOOM_connection_option_set(
3764 c, "negotiation-charset-in-effect-for-records",
3765 (sel != 0) ? "1" : "0");
3766 nmem_destroy(tmpmem);
3770 case Z_APDU_searchResponse:
3771 yaz_log(log_api, "%p recv_apdu Search response", c);
3772 handle_search_response(c, apdu->u.searchResponse);
3773 if (send_sort_present(c) == zoom_complete)
3774 ZOOM_connection_remove_task(c);
3776 case Z_APDU_presentResponse:
3777 yaz_log(log_api, "%p recv_apdu Present response", c);
3778 handle_present_response(c, apdu->u.presentResponse);
3779 if (send_present(c) == zoom_complete)
3780 ZOOM_connection_remove_task(c);
3782 case Z_APDU_sortResponse:
3783 yaz_log(log_api, "%p recv_apdu Sort response", c);
3784 sort_response(c, apdu->u.sortResponse);
3785 if (send_present(c) == zoom_complete)
3786 ZOOM_connection_remove_task(c);
3788 case Z_APDU_scanResponse:
3789 yaz_log(log_api, "%p recv_apdu Scan response", c);
3790 scan_response(c, apdu->u.scanResponse);
3791 ZOOM_connection_remove_task(c);
3793 case Z_APDU_extendedServicesResponse:
3794 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3795 es_response(c, apdu->u.extendedServicesResponse);
3796 ZOOM_connection_remove_task(c);
3799 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3800 if (!ZOOM_test_reconnect(c))
3802 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3807 yaz_log(log_api, "%p Received unknown PDU", c);
3808 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3814 static void handle_srw_response(ZOOM_connection c,
3815 Z_SRW_searchRetrieveResponse *res)
3817 ZOOM_resultset resultset = 0;
3822 const char *syntax, *elementSetName;
3827 switch(c->tasks->which)
3829 case ZOOM_TASK_SEARCH:
3830 resultset = c->tasks->u.search.resultset;
3831 start = &c->tasks->u.search.start;
3832 syntax = c->tasks->u.search.syntax;
3833 elementSetName = c->tasks->u.search.elementSetName;
3835 case ZOOM_TASK_RETRIEVE:
3836 resultset = c->tasks->u.retrieve.resultset;
3837 start = &c->tasks->u.retrieve.start;
3838 syntax = c->tasks->u.retrieve.syntax;
3839 elementSetName = c->tasks->u.retrieve.elementSetName;
3844 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3845 ZOOM_connection_put_event(c, event);
3847 resultset->size = 0;
3849 if (res->resultSetId)
3850 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
3852 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3854 if (res->numberOfRecords)
3855 resultset->size = *res->numberOfRecords;
3857 for (i = 0; i<res->num_records; i++)
3861 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3862 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3864 if (res->records[i].recordPosition &&
3865 *res->records[i].recordPosition > 0)
3866 pos = *res->records[i].recordPosition - 1;
3870 npr->databaseName = 0;
3871 npr->which = Z_NamePlusRecord_databaseRecord;
3872 npr->u.databaseRecord = (Z_External *)
3873 odr_malloc(c->odr_in, sizeof(Z_External));
3874 npr->u.databaseRecord->descriptor = 0;
3875 npr->u.databaseRecord->direct_reference =
3876 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
3877 npr->u.databaseRecord->which = Z_External_octet;
3879 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3880 odr_malloc(c->odr_in, sizeof(Odr_oct));
3881 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3882 res->records[i].recordData_buf;
3883 npr->u.databaseRecord->u.octet_aligned->len =
3884 npr->u.databaseRecord->u.octet_aligned->size =
3885 res->records[i].recordData_len;
3886 record_cache_add(resultset, npr, pos, syntax, elementSetName,
3887 res->records[i].recordSchema);
3889 if (res->num_diagnostics > 0)
3890 set_SRU_error(c, &res->diagnostics[0]);
3891 nmem = odr_extract_mem(c->odr_in);
3892 nmem_transfer(odr_getmem(resultset->odr), nmem);
3898 static void handle_srw_scan_response(ZOOM_connection c,
3899 Z_SRW_scanResponse *res)
3901 NMEM nmem = odr_extract_mem(c->odr_in);
3904 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
3906 scan = c->tasks->u.scan.scan;
3908 if (res->num_diagnostics > 0)
3909 set_SRU_error(c, &res->diagnostics[0]);
3911 scan->scan_response = 0;
3912 scan->srw_scan_response = res;
3913 nmem_transfer(odr_getmem(scan->odr), nmem);
3915 ZOOM_options_set_int(scan->options, "number", res->num_terms);
3921 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3924 const char *addinfo = 0;
3925 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3927 ZOOM_connection_set_mask(c, 0);
3928 yaz_log(log_details, "%p handle_http", c);
3930 if (!yaz_srw_check_content_type(hres))
3931 addinfo = "content-type";
3934 Z_SOAP *soap_package = 0;
3936 Z_SOAP_Handler soap_handlers[2] = {
3937 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
3940 ret = z_soap_codec(o, &soap_package,
3941 &hres->content_buf, &hres->content_len,
3943 if (!ret && soap_package->which == Z_SOAP_generic &&
3944 soap_package->u.generic->no == 0)
3946 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3948 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
3949 if (sr->which == Z_SRW_searchRetrieve_response)
3950 handle_srw_response(c, sr->u.response);
3951 else if (sr->which == Z_SRW_scan_response)
3952 handle_srw_scan_response(c, sr->u.scan_response);
3956 else if (!ret && (soap_package->which == Z_SOAP_fault
3957 || soap_package->which == Z_SOAP_error))
3959 set_HTTP_error(c, hres->code,
3960 soap_package->u.fault->fault_code,
3961 soap_package->u.fault->fault_string);
3968 if (hres->code != 200)
3969 set_HTTP_error(c, hres->code, 0, 0);
3971 set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
3974 ZOOM_connection_remove_task(c);
3975 if (!strcmp(hres->version, "1.0"))
3977 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3978 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3983 /* HTTP 1.1: only if no close we stay alive .. */
3984 if (connection_head && !strcmp(connection_head, "close"))
3990 static int do_read(ZOOM_connection c)
3995 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3996 ZOOM_connection_put_event(c, event);
3998 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3999 more = cs_more(c->cs);
4000 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
4005 if (!ZOOM_test_reconnect(c))
4007 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4016 odr_reset(c->odr_in);
4017 odr_setbuf(c->odr_in, c->buf_in, r, 0);
4018 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
4019 ZOOM_connection_put_event(c, event);
4021 if (!z_GDU(c->odr_in, &gdu, 0, 0))
4024 int err = odr_geterrorx(c->odr_in, &x);
4026 const char *element = odr_getelement(c->odr_in);
4027 yaz_snprintf(msg, sizeof(msg),
4028 "ODR code %d:%d element=%s offset=%d",
4029 err, x, element ? element : "<unknown>",
4030 odr_offset(c->odr_in));
4031 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
4034 FILE *ber_file = yaz_log_file();
4036 odr_dumpBER(ber_file, c->buf_in, r);
4040 else if (gdu->which == Z_GDU_Z3950)
4041 recv_apdu(c, gdu->u.z3950);
4042 else if (gdu->which == Z_GDU_HTTP_Response)
4045 handle_http(c, gdu->u.HTTP_Response);
4047 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4051 c->reconnect_ok = 0;
4056 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
4061 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
4062 ZOOM_connection_put_event(c, event);
4064 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
4065 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
4067 yaz_log(log_details, "%p do_write_ex write failed", c);
4068 if (ZOOM_test_reconnect(c))
4070 return zoom_pending;
4072 if (c->state == STATE_CONNECTING)
4073 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4075 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4077 return zoom_complete;
4081 int mask = ZOOM_SELECT_EXCEPT;
4082 if (c->cs->io_pending & CS_WANT_WRITE)
4083 mask += ZOOM_SELECT_WRITE;
4084 if (c->cs->io_pending & CS_WANT_READ)
4085 mask += ZOOM_SELECT_READ;
4086 ZOOM_connection_set_mask(c, mask);
4087 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
4092 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
4093 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
4096 return zoom_pending;
4099 static zoom_ret do_write(ZOOM_connection c)
4101 return do_write_ex(c, c->buf_out, c->len_out);
4105 ZOOM_API(const char *)
4106 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
4108 return ZOOM_options_get(c->options, key);
4111 ZOOM_API(const char *)
4112 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
4114 return ZOOM_options_getl(c->options, key, lenp);
4118 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
4121 ZOOM_options_set(c->options, key, val);
4125 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
4126 const char *val, int len)
4128 ZOOM_options_setl(c->options, key, val, len);
4131 ZOOM_API(const char *)
4132 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
4134 return ZOOM_options_get(r->options, key);
4138 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
4141 ZOOM_options_set(r->options, key, val);
4146 ZOOM_connection_errcode(ZOOM_connection c)
4148 return ZOOM_connection_error(c, 0, 0);
4151 ZOOM_API(const char *)
4152 ZOOM_connection_errmsg(ZOOM_connection c)
4155 ZOOM_connection_error(c, &msg, 0);
4159 ZOOM_API(const char *)
4160 ZOOM_connection_addinfo(ZOOM_connection c)
4162 const char *addinfo;
4163 ZOOM_connection_error(c, 0, &addinfo);
4167 ZOOM_API(const char *)
4168 ZOOM_connection_diagset(ZOOM_connection c)
4170 const char *diagset;
4171 ZOOM_connection_error_x(c, 0, 0, &diagset);
4175 ZOOM_API(const char *)
4176 ZOOM_diag_str(int error)
4180 case ZOOM_ERROR_NONE:
4182 case ZOOM_ERROR_CONNECT:
4183 return "Connect failed";
4184 case ZOOM_ERROR_MEMORY:
4185 return "Out of memory";
4186 case ZOOM_ERROR_ENCODE:
4187 return "Encoding failed";
4188 case ZOOM_ERROR_DECODE:
4189 return "Decoding failed";
4190 case ZOOM_ERROR_CONNECTION_LOST:
4191 return "Connection lost";
4192 case ZOOM_ERROR_INIT:
4193 return "Init rejected";
4194 case ZOOM_ERROR_INTERNAL:
4195 return "Internal failure";
4196 case ZOOM_ERROR_TIMEOUT:
4198 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4199 return "Unsupported protocol";
4200 case ZOOM_ERROR_UNSUPPORTED_QUERY:
4201 return "Unsupported query type";
4202 case ZOOM_ERROR_INVALID_QUERY:
4203 return "Invalid query";
4204 case ZOOM_ERROR_CQL_PARSE:
4205 return "CQL parsing error";
4206 case ZOOM_ERROR_CQL_TRANSFORM:
4207 return "CQL transformation error";
4208 case ZOOM_ERROR_CCL_CONFIG:
4209 return "CCL configuration error";
4210 case ZOOM_ERROR_CCL_PARSE:
4211 return "CCL parsing error";
4213 return diagbib1_str(error);
4218 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4219 const char **addinfo, const char **diagset)
4221 int error = c->error;
4224 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4225 *cp = ZOOM_diag_str(error);
4226 else if (!strcmp(c->diagset, "HTTP"))
4227 *cp = z_HTTP_errmsg(c->error);
4228 else if (!strcmp(c->diagset, "Bib-1"))
4229 *cp = ZOOM_diag_str(error);
4230 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4231 *cp = yaz_diag_srw_str(c->error);
4233 *cp = "Unknown error and diagnostic set";
4236 *addinfo = c->addinfo ? c->addinfo : "";
4238 *diagset = c->diagset ? c->diagset : "";
4243 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4244 const char **addinfo)
4246 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4249 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4251 ZOOM_Event event = 0;
4252 int r = cs_look(c->cs);
4253 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4258 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4259 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4261 ZOOM_connection_put_event(c, event);
4263 else if (r == CS_CONNECT)
4265 int ret = ret = cs_rcvconnect(c->cs);
4266 yaz_log(log_details, "%p ZOOM_connection_do_io "
4267 "cs_rcvconnect returned %d", c, ret);
4270 int mask = ZOOM_SELECT_EXCEPT;
4271 if (c->cs->io_pending & CS_WANT_WRITE)
4272 mask += ZOOM_SELECT_WRITE;
4273 if (c->cs->io_pending & CS_WANT_READ)
4274 mask += ZOOM_SELECT_READ;
4275 ZOOM_connection_set_mask(c, mask);
4276 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
4277 ZOOM_connection_put_event(c, event);
4281 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4282 ZOOM_connection_put_event(c, event);
4284 if (c->proto == PROTO_Z3950)
4285 ZOOM_connection_send_init(c);
4288 /* no init request for SRW .. */
4289 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4290 ZOOM_connection_remove_task(c);
4291 ZOOM_connection_set_mask(c, 0);
4292 ZOOM_connection_exec_task(c);
4294 c->state = STATE_ESTABLISHED;
4298 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4304 if (mask & ZOOM_SELECT_EXCEPT)
4306 if (!ZOOM_test_reconnect(c))
4308 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4313 if (mask & ZOOM_SELECT_READ)
4315 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4321 ZOOM_connection_last_event(ZOOM_connection cs)
4324 return ZOOM_EVENT_NONE;
4325 return cs->last_event;
4329 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4331 WRBUF wrbuf = (WRBUF) client_data;
4332 wrbuf_puts(wrbuf, buf);
4336 * Returns an xmalloc()d string containing RPN that corresponds to the
4337 * CQL passed in. On error, sets the Connection object's error state
4338 * and returns a null pointer.
4339 * ### We could cache CQL parser and/or transformer in Connection.
4341 static char *cql2pqf(ZOOM_connection c, const char *cql)
4345 const char *cqlfile;
4346 cql_transform_t trans;
4349 parser = cql_parser_create();
4350 if ((error = cql_parser_string(parser, cql)) != 0) {
4351 cql_parser_destroy(parser);
4352 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4356 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4359 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4361 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4364 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4365 cqlfile, strerror(errno));
4366 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4370 WRBUF wrbuf_result = wrbuf_alloc();
4371 error = cql_transform(trans, cql_parser_result(parser),
4372 cql2pqf_wrbuf_puts, wrbuf_result);
4375 const char *addinfo;
4376 error = cql_transform_error(trans, &addinfo);
4377 sprintf(buf, "%.200s (addinfo=%.200s)",
4378 cql_strerror(error), addinfo);
4379 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4383 result = xstrdup(wrbuf_cstr(wrbuf_result));
4385 cql_transform_close(trans);
4386 wrbuf_destroy(wrbuf_result);
4388 cql_parser_destroy(parser);
4392 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4396 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4397 /* timeout and this connection was waiting */
4398 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4400 ZOOM_connection_put_event(c, event);
4406 ZOOM_connection_process(ZOOM_connection c)
4412 event = ZOOM_connection_get_event(c);
4415 ZOOM_Event_destroy(event);
4418 ZOOM_connection_exec_task(c);
4419 event = ZOOM_connection_get_event(c);
4422 ZOOM_Event_destroy(event);
4429 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4433 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4435 for (i = 0; i<no; i++)
4437 ZOOM_connection c = cs[i];
4439 if (c && ZOOM_connection_process(c))
4445 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4447 if (c->mask && mask)
4448 ZOOM_connection_do_io(c, mask);
4452 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4455 return cs_fileno(c->cs);
4459 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4467 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4474 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4476 return ZOOM_options_get_int(c->options, "timeout", 30);
4482 * indent-tabs-mode: nil
4484 * vim: shiftwidth=4 tabstop=8 expandtab