2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.127 2007-04-30 08:29:07 adam Exp $
9 * \brief Implements ZOOM C interface.
17 #include <yaz/yaz-util.h>
18 #include <yaz/xmalloc.h>
19 #include <yaz/otherinfo.h>
21 #include <yaz/pquery.h>
22 #include <yaz/marcdisp.h>
23 #include <yaz/diagbib1.h>
24 #include <yaz/charneg.h>
29 #include <yaz/query-charset.h>
30 #include <yaz/copy_types.h>
32 static int log_api = 0;
33 static int log_details = 0;
40 static void resultset_destroy(ZOOM_resultset r);
41 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
42 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
43 static char *cql2pqf(ZOOM_connection c, const char *cql);
47 * This wrapper is just for logging failed lookups. It would be nicer
48 * if it could cause failure when a lookup fails, but that's hard.
50 static int *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
51 int oid_class, const char *str) {
52 int *res = yaz_string_to_oid_odr(yaz_oid_std(), oid_class, str,
55 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
56 c, (int) oid_class, str);
61 static void initlog(void)
63 static int log_level_initialized = 0;
64 if (!log_level_initialized)
66 log_api = yaz_log_module_level("zoom");
67 log_details = yaz_log_module_level("zoomdetails");
68 log_level_initialized = 1;
72 static ZOOM_Event ZOOM_Event_create(int kind)
74 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
78 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
82 static void ZOOM_Event_destroy(ZOOM_Event event)
87 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
91 c->m_queue_back->prev = event;
92 assert(c->m_queue_front);
96 assert(!c->m_queue_front);
97 c->m_queue_front = event;
99 event->next = c->m_queue_back;
101 c->m_queue_back = event;
104 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
106 ZOOM_Event event = c->m_queue_front;
109 c->last_event = ZOOM_EVENT_NONE;
112 assert(c->m_queue_back);
113 c->m_queue_front = event->prev;
114 if (c->m_queue_front)
116 assert(c->m_queue_back);
117 c->m_queue_front->next = 0;
121 c->last_event = event->kind;
125 static void ZOOM_connection_remove_events(ZOOM_connection c)
128 while ((event = ZOOM_connection_get_event(c)))
129 ZOOM_Event_destroy(event);
132 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
134 ZOOM_Event event = c->m_queue_front;
136 return event ? event->kind : ZOOM_EVENT_NONE;
139 void ZOOM_connection_remove_tasks(ZOOM_connection c);
141 static void set_dset_error(ZOOM_connection c, int error,
143 const char *addinfo, const char *addinfo2)
150 if (!c->diagset || strcmp(dset, c->diagset))
153 c->diagset = xstrdup(dset);
154 /* remove integer part from SRW diagset .. */
155 if ((cp = strrchr(c->diagset, '/')))
158 if (addinfo && addinfo2)
160 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
161 strcpy(c->addinfo, addinfo);
162 strcat(c->addinfo, addinfo2);
165 c->addinfo = xstrdup(addinfo);
166 if (error != ZOOM_ERROR_NONE)
168 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
169 c, c->host_port ? c->host_port : "<>", dset, error,
170 addinfo ? addinfo : "",
171 addinfo2 ? addinfo2 : "");
172 ZOOM_connection_remove_tasks(c);
177 static void set_HTTP_error(ZOOM_connection c, int error,
178 const char *addinfo, const char *addinfo2)
180 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
185 static void set_ZOOM_error(ZOOM_connection c, int error,
188 set_dset_error(c, error, "ZOOM", addinfo, 0);
191 static void clear_error(ZOOM_connection c)
194 * If an error is tied to an operation then it's ok to clear: for
195 * example, a diagnostic returned from a search is cleared by a
196 * subsequent search. However, problems such as Connection Lost
197 * or Init Refused are not cleared, because they are not
198 * recoverable: doing another search doesn't help.
201 ZOOM_connection_remove_events(c);
204 case ZOOM_ERROR_CONNECT:
205 case ZOOM_ERROR_MEMORY:
206 case ZOOM_ERROR_DECODE:
207 case ZOOM_ERROR_CONNECTION_LOST:
208 case ZOOM_ERROR_INIT:
209 case ZOOM_ERROR_INTERNAL:
210 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
213 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
217 void ZOOM_connection_show_task(ZOOM_task task)
221 case ZOOM_TASK_SEARCH:
222 yaz_log(YLOG_LOG, "search p=%p", task);
224 case ZOOM_TASK_RETRIEVE:
225 yaz_log(YLOG_LOG, "retrieve p=%p", task);
227 case ZOOM_TASK_CONNECT:
228 yaz_log(YLOG_LOG, "connect p=%p", task);
231 yaz_log(YLOG_LOG, "scant p=%p", task);
236 void ZOOM_connection_show_tasks(ZOOM_connection c)
239 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
240 for (task = c->tasks; task; task = task->next)
241 ZOOM_connection_show_task(task);
244 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
246 ZOOM_task *taskp = &c->tasks;
248 taskp = &(*taskp)->next;
249 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
250 (*taskp)->running = 0;
251 (*taskp)->which = which;
257 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
259 return c->tasks ? 0 : 1;
262 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
264 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
266 task->next = c->tasks;
275 void ZOOM_connection_remove_task(ZOOM_connection c)
277 ZOOM_task task = c->tasks;
281 c->tasks = task->next;
284 case ZOOM_TASK_SEARCH:
285 resultset_destroy(task->u.search.resultset);
286 xfree(task->u.search.syntax);
287 xfree(task->u.search.elementSetName);
289 case ZOOM_TASK_RETRIEVE:
290 resultset_destroy(task->u.retrieve.resultset);
291 xfree(task->u.retrieve.syntax);
292 xfree(task->u.retrieve.elementSetName);
294 case ZOOM_TASK_CONNECT:
297 ZOOM_scanset_destroy(task->u.scan.scan);
299 case ZOOM_TASK_PACKAGE:
300 ZOOM_package_destroy(task->u.package);
303 resultset_destroy(task->u.sort.resultset);
304 ZOOM_query_destroy(task->u.sort.q);
313 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
314 ZOOM_connection_put_event(c, event);
319 static int ZOOM_connection_exec_task(ZOOM_connection c);
321 void ZOOM_connection_remove_tasks(ZOOM_connection c)
324 ZOOM_connection_remove_task(c);
327 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
329 const char *elementSetName);
331 ZOOM_API(ZOOM_connection)
332 ZOOM_connection_create(ZOOM_options options)
334 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
338 yaz_log(log_api, "%p ZOOM_connection_create", c);
340 c->proto = PROTO_Z3950;
342 ZOOM_connection_set_mask(c, 0);
344 c->state = STATE_IDLE;
347 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
354 c->options = ZOOM_options_create_with_parent(options);
360 c->charset = c->lang = 0;
367 c->odr_in = odr_createmem(ODR_DECODE);
368 c->odr_out = odr_createmem(ODR_ENCODE);
371 c->support_named_resultsets = 0;
372 c->last_event = ZOOM_EVENT_NONE;
374 c->m_queue_front = 0;
380 /* set database names. Take local databases (if set); otherwise
381 take databases given in ZURL (if set); otherwise use Default */
382 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
385 char **databaseNames;
386 const char *cp = ZOOM_options_get(options, "databaseName");
388 if ((!cp || !*cp) && con->host_port)
390 if (strncmp(con->host_port, "unix:", 5) == 0)
391 cp = strchr(con->host_port+5, ':');
393 cp = strchr(con->host_port, '/');
399 nmem_strsplit(odr_getmem(odr), "+", cp, &databaseNames, num);
400 return databaseNames;
403 ZOOM_API(ZOOM_connection)
404 ZOOM_connection_new(const char *host, int portnum)
406 ZOOM_connection c = ZOOM_connection_create(0);
408 ZOOM_connection_connect(c, host, portnum);
412 static zoom_sru_mode get_sru_mode_from_string(const char *s)
415 return zoom_sru_soap;
416 if (!yaz_matchstr(s, "soap"))
417 return zoom_sru_soap;
418 else if (!yaz_matchstr(s, "get"))
420 else if (!yaz_matchstr(s, "post"))
421 return zoom_sru_post;
422 return zoom_sru_error;
426 ZOOM_connection_connect(ZOOM_connection c,
427 const char *host, int portnum)
434 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
435 c, host ? host : "null", portnum);
437 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
438 ZOOM_connection_remove_tasks(c);
442 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
446 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
448 val = ZOOM_options_get(c->options, "proxy");
451 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
452 c->proxy = xstrdup(val);
458 val = ZOOM_options_get(c->options, "charset");
461 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
462 c->charset = xstrdup(val);
468 val = ZOOM_options_get(c->options, "lang");
471 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
472 c->lang = xstrdup(val);
483 sprintf(hostn, "%.80s:%d", host, portnum);
484 c->host_port = xstrdup(hostn);
487 c->host_port = xstrdup(host);
492 * If the "<scheme>:" part of the host string is preceded by one
493 * or more comma-separated <name>=<value> pairs, these are taken
494 * to be options to be set on the connection object. Among other
495 * applications, this facility can be used to embed authentication
497 * user=admin,password=secret,tcp:localhost:9999
499 char *remainder = c->host_port;
500 char *pcolon = strchr(remainder, ':');
503 while ((pcomma = strchr(remainder, ',')) != 0 &&
504 (pcolon == 0 || pcomma < pcolon)) {
506 if ((pequals = strchr(remainder, '=')) != 0) {
508 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
509 ZOOM_connection_option_set(c, remainder, pequals+1);
511 remainder = pcomma+1;
514 if (remainder != c->host_port) {
516 c->host_port = xstrdup(remainder);
517 /*printf("# reset hp='%s'\n", remainder);*/
521 val = ZOOM_options_get(c->options, "sru");
522 c->sru_mode = get_sru_mode_from_string(val);
524 ZOOM_options_set(c->options, "host", c->host_port);
526 val = ZOOM_options_get(c->options, "cookie");
529 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
530 c->cookie_out = xstrdup(val);
533 val = ZOOM_options_get(c->options, "clientIP");
536 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
538 c->client_IP = xstrdup(val);
541 c->async = ZOOM_options_get_bool(c->options, "async", 0);
542 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
544 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
548 while (ZOOM_event(1, &c))
554 ZOOM_query_create(void)
556 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
558 yaz_log(log_details, "%p ZOOM_query_create", s);
562 s->odr = odr_createmem(ODR_ENCODE);
569 ZOOM_query_destroy(ZOOM_query s)
575 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
576 if (s->refcount == 0)
584 ZOOM_query_prefix(ZOOM_query s, const char *str)
586 s->query_string = odr_strdup(s->odr, str);
587 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
588 s->z_query->which = Z_Query_type_1;
589 s->z_query->u.type_1 = p_query_rpn(s->odr, str);
590 if (!s->z_query->u.type_1)
592 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
596 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
601 ZOOM_query_cql(ZOOM_query s, const char *str)
605 s->query_string = odr_strdup(s->odr, str);
607 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
608 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
609 ext->indirect_reference = 0;
611 ext->which = Z_External_CQL;
612 ext->u.cql = s->query_string;
614 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
615 s->z_query->which = Z_Query_type_104;
616 s->z_query->u.type_104 = ext;
618 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
624 * Translate the CQL string client-side into RPN which is passed to
625 * the server. This is useful for server's that don't themselves
626 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
627 * only as a place to stash diagnostics if compilation fails; if this
628 * information is not needed, a null pointer may be used.
631 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
635 ZOOM_connection freeme = 0;
637 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
639 conn = freeme = ZOOM_connection_create(0);
641 rpn = cql2pqf(conn, str);
643 ZOOM_connection_destroy(freeme);
647 ret = ZOOM_query_prefix(s, rpn);
653 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
654 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
655 * to the server, as the YAZ GFS doesn't know how to handle this.
658 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
659 int *ccl_error, const char **error_string,
663 struct ccl_rpn_node *rpn;
664 CCL_bibset bibset = ccl_qual_mk();
667 ccl_qual_buf(bibset, config);
669 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
672 *error_string = ccl_err_msg(*ccl_error);
677 WRBUF wr = wrbuf_alloc();
680 ret = ZOOM_query_prefix(s, wrbuf_cstr(wr));
683 ccl_qual_rm(&bibset);
688 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
690 s->sort_spec = yaz_sort_spec(s->odr, criteria);
693 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
697 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
701 static zoom_ret do_write(ZOOM_connection c);
704 ZOOM_connection_destroy(ZOOM_connection c)
709 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
712 for (r = c->resultsets; r; r = r->next)
718 odr_destroy(c->odr_in);
719 odr_destroy(c->odr_out);
720 ZOOM_options_destroy(c->options);
721 ZOOM_connection_remove_tasks(c);
722 ZOOM_connection_remove_events(c);
728 xfree(c->cookie_out);
734 void ZOOM_resultset_addref(ZOOM_resultset r)
739 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
744 ZOOM_resultset ZOOM_resultset_create(void)
747 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
751 yaz_log(log_details, "%p ZOOM_resultset_create", r);
754 r->odr = odr_createmem(ODR_ENCODE);
759 for (i = 0; i<RECORD_HASH_SIZE; i++)
760 r->record_hash[i] = 0;
765 r->databaseNames = 0;
766 r->num_databaseNames = 0;
771 ZOOM_API(ZOOM_resultset)
772 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
775 ZOOM_query s = ZOOM_query_create();
777 ZOOM_query_prefix(s, q);
779 r = ZOOM_connection_search(c, s);
780 ZOOM_query_destroy(s);
784 ZOOM_API(ZOOM_resultset)
785 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
787 ZOOM_resultset r = ZOOM_resultset_create();
791 const char *syntax, *elementSetName;
793 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
794 r->r_sort_spec = q->sort_spec;
797 r->options = ZOOM_options_create_with_parent(c->options);
800 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
802 r->rpn_iconv = yaz_iconv_open(cp, "UTF-8");
806 start = ZOOM_options_get_int(r->options, "start", 0);
807 count = ZOOM_options_get_int(r->options, "count", 0);
809 /* If "presentChunk" is defined use that; otherwise "step" */
810 const char *cp = ZOOM_options_get(r->options, "presentChunk");
811 r->step = ZOOM_options_get_int(r->options,
812 (cp != 0 ? "presentChunk": "step"), 0);
814 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
815 cp = ZOOM_options_get(r->options, "setname");
817 r->setname = xstrdup(cp);
818 cp = ZOOM_options_get(r->options, "schema");
820 r->schema = xstrdup(cp);
822 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
827 r->next = c->resultsets;
832 if (c->host_port && c->proto == PROTO_HTTP)
836 yaz_log(log_details, "ZOOM_connection_search: no comstack");
837 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
841 yaz_log(log_details, "ZOOM_connection_search: reconnect");
846 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
847 task->u.search.resultset = r;
848 task->u.search.start = start;
849 task->u.search.count = count;
851 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
852 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
853 elementSetName = ZOOM_options_get(r->options, "elementSetName");
854 task->u.search.elementSetName = elementSetName
855 ? xstrdup(elementSetName) : 0;
857 ZOOM_resultset_addref(r);
863 while (ZOOM_event(1, &c))
870 ZOOM_resultset_sort(ZOOM_resultset r,
871 const char *sort_type, const char *sort_spec)
873 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
877 ZOOM_resultset_sort1(ZOOM_resultset r,
878 const char *sort_type, const char *sort_spec)
880 ZOOM_connection c = r->connection;
884 newq = ZOOM_query_create();
885 if (ZOOM_query_sortby(newq, sort_spec) < 0)
888 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
889 r, r, sort_type, sort_spec);
893 if (c->host_port && c->proto == PROTO_HTTP)
897 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
898 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
902 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
908 ZOOM_resultset_cache_reset(r);
909 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
910 task->u.sort.resultset = r;
911 task->u.sort.q = newq;
913 ZOOM_resultset_addref(r);
917 while (ZOOM_event(1, &c))
925 ZOOM_resultset_cache_reset(ZOOM_resultset r)
928 for (i = 0; i<RECORD_HASH_SIZE; i++)
930 ZOOM_record_cache rc;
931 for (rc = r->record_hash[i]; rc; rc = rc->next)
933 if (rc->rec.wrbuf_marc)
934 wrbuf_destroy(rc->rec.wrbuf_marc);
935 if (rc->rec.wrbuf_iconv)
936 wrbuf_destroy(rc->rec.wrbuf_iconv);
937 if (rc->rec.wrbuf_opac)
938 wrbuf_destroy(rc->rec.wrbuf_opac);
940 r->record_hash[i] = 0;
945 ZOOM_resultset_destroy(ZOOM_resultset r)
947 resultset_destroy(r);
950 static void resultset_destroy(ZOOM_resultset r)
955 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
957 if (r->refcount == 0)
959 ZOOM_resultset_cache_reset(r);
963 /* remove ourselves from the resultsets in connection */
964 ZOOM_resultset *rp = &r->connection->resultsets;
967 assert(*rp); /* we must be in this list!! */
969 { /* OK, we're here - take us out of it */
976 ZOOM_query_destroy(r->query);
977 ZOOM_options_destroy(r->options);
979 yaz_iconv_close(r->rpn_iconv);
988 ZOOM_resultset_size(ZOOM_resultset r)
990 yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
995 static void do_close(ZOOM_connection c)
1000 ZOOM_connection_set_mask(c, 0);
1001 c->state = STATE_IDLE;
1004 static int ZOOM_test_reconnect(ZOOM_connection c)
1008 if (!c->reconnect_ok)
1011 c->reconnect_ok = 0;
1012 c->tasks->running = 0;
1013 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1015 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1016 ZOOM_connection_put_event(c, event);
1021 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1022 int force_sync, int start, int count)
1027 const char *syntax, *elementSetName;
1031 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1032 " count=%d", r, force_sync, start, count);
1037 if (c->host_port && c->proto == PROTO_HTTP)
1041 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1042 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1046 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1048 c->reconnect_ok = 1;
1051 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1052 task->u.retrieve.resultset = r;
1053 task->u.retrieve.start = start;
1054 task->u.retrieve.count = count;
1056 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1057 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1058 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1059 task->u.retrieve.elementSetName = elementSetName
1060 ? xstrdup(elementSetName) : 0;
1062 cp = ZOOM_options_get(r->options, "schema");
1065 if (!r->schema || strcmp(r->schema, cp))
1068 r->schema = xstrdup(cp);
1072 ZOOM_resultset_addref(r);
1074 if (!r->connection->async || force_sync)
1075 while (r->connection && ZOOM_event(1, &r->connection))
1080 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1081 size_t start, size_t count)
1083 int force_present = 0;
1087 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1088 r, r, (long) start, (long) count);
1091 ZOOM_resultset_retrieve(r, force_present, start, count);
1095 for (i = 0; i< count; i++)
1096 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1100 static void get_cert(ZOOM_connection c)
1105 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1107 ZOOM_connection_option_setl(c, "sslPeerCert",
1108 cert_buf, cert_len);
1113 static zoom_ret do_connect(ZOOM_connection c)
1116 const char *effective_host;
1119 effective_host = c->proxy;
1121 effective_host = c->host_port;
1123 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1127 c->cs = cs_create_host(effective_host, 0, &add);
1129 if (c->cs && c->cs->protocol == PROTO_HTTP)
1132 const char *path = 0;
1134 c->proto = PROTO_HTTP;
1135 cs_get_host_args(c->host_port, &path);
1137 c->path = (char*) xmalloc(strlen(path)+2);
1139 strcpy(c->path+1, path);
1141 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1143 return zoom_complete;
1148 int ret = cs_connect(c->cs, add);
1151 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1152 ZOOM_connection_put_event(c, event);
1154 if (c->proto == PROTO_Z3950)
1155 ZOOM_connection_send_init(c);
1158 /* no init request for SRW .. */
1159 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1160 ZOOM_connection_remove_task(c);
1161 ZOOM_connection_set_mask(c, 0);
1162 ZOOM_connection_exec_task(c);
1164 c->state = STATE_ESTABLISHED;
1165 return zoom_pending;
1169 int mask = ZOOM_SELECT_EXCEPT;
1170 if (c->cs->io_pending & CS_WANT_WRITE)
1171 mask += ZOOM_SELECT_WRITE;
1172 if (c->cs->io_pending & CS_WANT_READ)
1173 mask += ZOOM_SELECT_READ;
1174 ZOOM_connection_set_mask(c, mask);
1175 c->state = STATE_CONNECTING;
1176 return zoom_pending;
1179 c->state = STATE_IDLE;
1180 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1181 return zoom_complete;
1184 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1187 for (i = 0; i<200; i++)
1191 Z_OtherInformation **oi;
1196 sprintf(buf, "otherInfo%d", i);
1197 val = ZOOM_options_get(c->options, buf);
1200 cp = strchr(val, ':');
1204 if (len >= sizeof(buf))
1205 len = sizeof(buf)-1;
1206 memcpy(buf, val, len);
1209 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
1214 yaz_oi_APDU(a, &oi);
1215 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
1219 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1224 Z_OtherInformation **oi;
1225 yaz_oi_APDU(a, &oi);
1226 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
1231 Z_OtherInformation **oi;
1232 yaz_oi_APDU(a, &oi);
1233 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
1236 otherInfo_attach(c, a, out);
1237 if (!z_APDU(out, &a, 0, 0))
1239 FILE *outf = fopen("/tmp/apdu.txt", "a");
1242 ODR odr_pr = odr_createmem(ODR_PRINT);
1243 fprintf(outf, "a=%p\n", a);
1244 odr_setprint(odr_pr, outf);
1245 z_APDU(odr_pr, &a, 0, 0);
1246 odr_destroy(odr_pr);
1248 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1249 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1253 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1257 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1261 if (encode_APDU(c, a, c->odr_out))
1262 return zoom_complete;
1263 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1264 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1265 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1266 ZOOM_connection_put_event(c, event);
1267 odr_reset(c->odr_out);
1271 /* returns 1 if PDU was sent OK (still pending )
1272 0 if PDU was not sent OK (nothing to wait for)
1275 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1277 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1278 Z_InitRequest *ireq = apdu->u.initRequest;
1279 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1280 odr_malloc(c->odr_out, sizeof(*auth));
1281 const char *auth_groupId = ZOOM_options_get(c->options, "group");
1282 const char *auth_userId = ZOOM_options_get(c->options, "user");
1283 const char *auth_password = ZOOM_options_get(c->options, "password");
1286 /* support the pass for backwards compatibility */
1288 auth_password = ZOOM_options_get(c->options, "pass");
1290 ODR_MASK_SET(ireq->options, Z_Options_search);
1291 ODR_MASK_SET(ireq->options, Z_Options_present);
1292 ODR_MASK_SET(ireq->options, Z_Options_scan);
1293 ODR_MASK_SET(ireq->options, Z_Options_sort);
1294 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1295 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1297 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1298 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1299 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1301 /* Index Data's Z39.50 Implementor Id is 81 */
1302 ireq->implementationId =
1303 odr_prepend(c->odr_out,
1304 ZOOM_options_get(c->options, "implementationId"),
1305 odr_prepend(c->odr_out, "81", ireq->implementationId));
1307 ireq->implementationName =
1308 odr_prepend(c->odr_out,
1309 ZOOM_options_get(c->options, "implementationName"),
1310 odr_prepend(c->odr_out, "ZOOM-C",
1311 ireq->implementationName));
1313 version = odr_strdup(c->odr_out, "$Revision: 1.127 $");
1314 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1315 version[strlen(version)-2] = '\0';
1316 ireq->implementationVersion =
1317 odr_prepend(c->odr_out,
1318 ZOOM_options_get(c->options, "implementationVersion"),
1319 odr_prepend(c->odr_out, &version[11],
1320 ireq->implementationVersion));
1322 *ireq->maximumRecordSize =
1323 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
1324 *ireq->preferredMessageSize =
1325 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
1327 if (auth_groupId || auth_password)
1329 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1332 if (auth_groupId && *auth_groupId)
1334 pass->groupId = (char *)
1335 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1336 strcpy(pass->groupId, auth_groupId);
1340 if (auth_userId && *auth_userId)
1342 pass->userId = (char *)
1343 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1344 strcpy(pass->userId, auth_userId);
1348 if (auth_password && *auth_password)
1350 pass->password = (char *)
1351 odr_malloc(c->odr_out, strlen(auth_password)+1);
1352 strcpy(pass->password, auth_password);
1357 auth->which = Z_IdAuthentication_idPass;
1358 auth->u.idPass = pass;
1359 ireq->idAuthentication = auth;
1362 else if (auth_userId)
1364 auth->which = Z_IdAuthentication_open;
1365 auth->u.open = (char *)
1366 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1367 strcpy(auth->u.open, auth_userId);
1368 ireq->idAuthentication = auth;
1372 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
1373 yaz_oid_userinfo_proxy, 1, c->host_port);
1375 if (c->charset || c->lang)
1377 Z_OtherInformation **oi;
1378 Z_OtherInformationUnit *oi_unit;
1380 yaz_oi_APDU(apdu, &oi);
1382 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1384 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1385 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1386 oi_unit->information.externallyDefinedInfo =
1387 yaz_set_proposal_charneg_list(c->odr_out, " ",
1388 c->charset, c->lang, 1);
1392 return send_APDU(c, apdu);
1396 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1401 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1403 if (c->sru_mode == zoom_sru_get)
1405 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1407 else if (c->sru_mode == zoom_sru_post)
1409 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1411 else if (c->sru_mode == zoom_sru_soap)
1413 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1415 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1416 return zoom_complete;
1417 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1419 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1420 ZOOM_connection_put_event(c, event);
1421 odr_reset(c->odr_out);
1427 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1431 ZOOM_resultset resultset = 0;
1433 const char *option_val = 0;
1435 if (c->error) /* don't continue on error */
1436 return zoom_complete;
1438 switch(c->tasks->which)
1440 case ZOOM_TASK_SEARCH:
1441 resultset = c->tasks->u.search.resultset;
1442 resultset->setname = xstrdup("default");
1443 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1444 start = &c->tasks->u.search.start;
1445 count = &c->tasks->u.search.count;
1447 case ZOOM_TASK_RETRIEVE:
1448 resultset = c->tasks->u.retrieve.resultset;
1450 start = &c->tasks->u.retrieve.start;
1451 count = &c->tasks->u.retrieve.count;
1453 if (*start >= resultset->size)
1454 return zoom_complete;
1455 if (*start + *count > resultset->size)
1456 *count = resultset->size - *start;
1458 for (i = 0; i < *count; i++)
1461 record_cache_lookup(resultset, i + *start,
1462 c->tasks->u.retrieve.syntax,
1463 c->tasks->u.retrieve.elementSetName);
1468 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1469 ZOOM_connection_put_event(c, event);
1476 return zoom_complete;
1479 return zoom_complete;
1481 assert(resultset->query);
1483 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1485 if (resultset->query->z_query->which == Z_Query_type_104
1486 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1488 sr->u.request->query_type = Z_SRW_query_type_cql;
1489 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1491 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1492 resultset->query->z_query->u.type_1)
1494 sr->u.request->query_type = Z_SRW_query_type_pqf;
1495 sr->u.request->query.pqf = resultset->query->query_string;
1499 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1500 return zoom_complete;
1502 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1503 sr->u.request->maximumRecords = odr_intdup(
1504 c->odr_out, resultset->step>0 ? resultset->step : *count);
1505 sr->u.request->recordSchema = resultset->schema;
1507 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1509 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1511 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1513 sr->extra_args = odr_strdup(c->odr_out, option_val);
1514 return send_srw(c, sr);
1517 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1519 return zoom_complete;
1523 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1526 int lslb, ssub, mspn;
1528 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1529 Z_SearchRequest *search_req = apdu->u.searchRequest;
1530 const char *elementSetName;
1531 const char *smallSetElementSetName;
1532 const char *mediumSetElementSetName;
1535 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1537 r = c->tasks->u.search.resultset;
1539 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1542 ZOOM_options_get(r->options, "elementSetName");
1543 smallSetElementSetName =
1544 ZOOM_options_get(r->options, "smallSetElementSetName");
1545 mediumSetElementSetName =
1546 ZOOM_options_get(r->options, "mediumSetElementSetName");
1548 if (!smallSetElementSetName)
1549 smallSetElementSetName = elementSetName;
1551 if (!mediumSetElementSetName)
1552 mediumSetElementSetName = elementSetName;
1557 /* prepare query for the search request */
1558 search_req->query = r->query->z_query;
1559 if (!search_req->query)
1561 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1562 return zoom_complete;
1564 if (r->query->z_query->which == Z_Query_type_1 && r->rpn_iconv)
1566 search_req->query = yaz_copy_Z_Query(r->query->z_query, c->odr_out);
1568 yaz_query_charset_convert_rpnquery(search_req->query->u.type_1,
1569 c->odr_out, r->rpn_iconv);
1571 search_req->databaseNames = r->databaseNames;
1572 search_req->num_databaseNames = r->num_databaseNames;
1574 /* get syntax (no need to provide unless piggyback is in effect) */
1575 syntax = c->tasks->u.search.syntax;
1577 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1578 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1579 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1580 if (lslb != -1 && ssub != -1 && mspn != -1)
1582 /* So're a Z39.50 expert? Let's hope you don't do sort */
1583 *search_req->largeSetLowerBound = lslb;
1584 *search_req->smallSetUpperBound = ssub;
1585 *search_req->mediumSetPresentNumber = mspn;
1587 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1588 && r->piggyback && !r->r_sort_spec && !r->schema)
1590 /* Regular piggyback - do it unless we're going to do sort */
1591 *search_req->largeSetLowerBound = 2000000000;
1592 *search_req->smallSetUpperBound = 1;
1593 *search_req->mediumSetPresentNumber =
1594 r->step>0 ? r->step : c->tasks->u.search.count;
1598 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1599 smallSetElementSetName = 0;
1600 mediumSetElementSetName = 0;
1603 if (smallSetElementSetName && *smallSetElementSetName)
1605 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1606 odr_malloc(c->odr_out, sizeof(*esn));
1608 esn->which = Z_ElementSetNames_generic;
1609 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1610 search_req->smallSetElementSetNames = esn;
1612 if (mediumSetElementSetName && *mediumSetElementSetName)
1614 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1615 odr_malloc(c->odr_out, sizeof(*esn));
1617 esn->which = Z_ElementSetNames_generic;
1618 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1619 search_req->mediumSetElementSetNames = esn;
1622 search_req->preferredRecordSyntax =
1623 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1627 if (c->support_named_resultsets)
1631 /* find the lowest unused ordinal so that we re-use
1632 result sets on the server. */
1633 for (ord = 1; ; ord++)
1636 sprintf(setname, "%d", ord);
1637 for (rp = c->resultsets; rp; rp = rp->next)
1638 if (rp->setname && !strcmp(rp->setname, setname))
1643 r->setname = xstrdup(setname);
1644 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1645 "set %s", c, r->setname);
1649 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1651 r->setname = xstrdup("default");
1653 ZOOM_options_set(r->options, "setname", r->setname);
1655 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1656 return send_APDU(c, apdu);
1659 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1666 case Z_DefaultDiagFormat_v2Addinfo:
1667 addinfo = r->u.v2Addinfo;
1669 case Z_DefaultDiagFormat_v3Addinfo:
1670 addinfo = r->u.v3Addinfo;
1675 set_dset_error(c, *r->condition,
1676 yaz_oid_to_string(yaz_oid_std(),
1677 r->diagnosticSetId, &oclass),
1681 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1683 if (p->which != Z_DiagRec_defaultFormat)
1684 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1686 response_default_diag(c, p->u.defaultFormat);
1689 ZOOM_API(ZOOM_record)
1690 ZOOM_record_clone(ZOOM_record srec)
1697 odr_enc = odr_createmem(ODR_ENCODE);
1698 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1700 buf = odr_getbuf(odr_enc, &size, 0);
1702 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1703 nrec->odr = odr_createmem(ODR_DECODE);
1704 nrec->wrbuf_marc = 0;
1705 nrec->wrbuf_iconv = 0;
1706 nrec->wrbuf_opac = 0;
1707 odr_setbuf(nrec->odr, buf, size, 0);
1708 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1710 odr_destroy(odr_enc);
1714 ZOOM_API(ZOOM_record)
1715 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1717 const char *syntax =
1718 ZOOM_options_get(s->options, "preferredRecordSyntax");
1719 const char *elementSetName =
1720 ZOOM_options_get(s->options, "elementSetName");
1722 return record_cache_lookup(s, pos, syntax, elementSetName);
1725 ZOOM_API(ZOOM_record)
1726 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1728 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1733 * MIKE: I think force_sync should always be zero, but I don't
1734 * want to make this change until I get the go-ahead from
1735 * Adam, in case something depends on the old synchronous
1739 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1740 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1741 rec = ZOOM_resultset_record_immediate(r, pos);
1747 ZOOM_record_destroy(ZOOM_record rec)
1751 if (rec->wrbuf_marc)
1752 wrbuf_destroy(rec->wrbuf_marc);
1753 if (rec->wrbuf_iconv)
1754 wrbuf_destroy(rec->wrbuf_iconv);
1755 if (rec->wrbuf_opac)
1756 wrbuf_destroy(rec->wrbuf_opac);
1757 odr_destroy(rec->odr);
1761 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1763 const char *buf, int sz,
1764 const char *record_charset)
1769 yaz_marc_t mt = yaz_marc_create();
1772 strcpy(to, "UTF-8");
1773 if (record_charset && *record_charset)
1775 /* Use "from,to" or just "from" */
1776 const char *cp = strchr(record_charset, ',');
1777 int clen = strlen(record_charset);
1780 strncpy( to, cp+1, sizeof(to)-1);
1781 to[sizeof(to)-1] = '\0';
1782 clen = cp - record_charset;
1784 if (clen > sizeof(from)-1)
1785 clen = sizeof(from)-1;
1788 strncpy(from, record_charset, clen);
1794 cd = yaz_iconv_open(to, from);
1795 yaz_marc_iconv(mt, cd);
1798 yaz_marc_xml(mt, marc_type);
1799 if (!rec->wrbuf_marc)
1800 rec->wrbuf_marc = wrbuf_alloc();
1801 wrbuf_rewind(rec->wrbuf_marc);
1802 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1804 yaz_marc_destroy(mt);
1806 yaz_iconv_close(cd);
1808 *len = wrbuf_len(rec->wrbuf_marc);
1809 return wrbuf_cstr(rec->wrbuf_marc);
1811 yaz_marc_destroy(mt);
1813 yaz_iconv_close(cd);
1817 static const char *record_iconv_return(ZOOM_record rec, int *len,
1818 const char *buf, int sz,
1819 const char *record_charset)
1826 strcpy(to, "UTF-8");
1828 if (record_charset && *record_charset)
1830 /* Use "from,to" or just "from" */
1831 const char *cp = strchr(record_charset, ',');
1832 int clen = strlen(record_charset);
1835 strncpy( to, cp+1, sizeof(to)-1);
1836 to[sizeof(to)-1] = '\0';
1837 clen = cp - record_charset;
1839 if (clen > sizeof(from)-1)
1840 clen = sizeof(from)-1;
1843 strncpy(from, record_charset, clen);
1847 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1849 if (!rec->wrbuf_iconv)
1850 rec->wrbuf_iconv = wrbuf_alloc();
1852 wrbuf_rewind(rec->wrbuf_iconv);
1854 wrbuf_iconv_write(rec->wrbuf_iconv, cd, buf, sz);
1855 wrbuf_iconv_reset(rec->wrbuf_iconv, cd);
1857 buf = wrbuf_cstr(rec->wrbuf_iconv);
1858 sz = wrbuf_len(rec->wrbuf_iconv);
1859 yaz_iconv_close(cd);
1867 ZOOM_record_error(ZOOM_record rec, const char **cp,
1868 const char **addinfo, const char **diagset)
1870 Z_NamePlusRecord *npr;
1875 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1877 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1878 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1879 const char *add = 0;
1881 if (diag_rec->which == Z_DiagRec_defaultFormat)
1883 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1886 error = *ddf->condition;
1889 case Z_DefaultDiagFormat_v2Addinfo:
1890 add = ddf->u.v2Addinfo;
1892 case Z_DefaultDiagFormat_v3Addinfo:
1893 add = ddf->u.v3Addinfo;
1898 yaz_oid_to_string(yaz_oid_std(),
1899 ddf->diagnosticSetId, &oclass);
1907 *addinfo = add ? add : "";
1909 *cp = diagbib1_str(error);
1915 ZOOM_API(const char *)
1916 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1923 Z_NamePlusRecord *npr;
1926 *len = 0; /* default return */
1935 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1937 if (cp[i] == ';' || cp[i] == ' ')
1943 while (type_spec[i] == ';')
1946 while (type_spec[i] == ' ')
1948 if (!strncmp(type_spec+i, "charset=", 8))
1951 i = i + 8; /* skip charset= */
1952 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1954 if (type_spec[i] == ';' || type_spec[i] == ' ')
1960 else if (!strncmp(type_spec+i, "xpath=", 6))
1964 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1968 while (type_spec[i] == ' ')
1971 if (!strcmp(type, "database"))
1974 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1975 return npr->databaseName;
1977 else if (!strcmp(type, "syntax"))
1979 const char *desc = 0;
1980 if (npr->which == Z_NamePlusRecord_databaseRecord)
1982 Z_External *r = (Z_External *) npr->u.databaseRecord;
1983 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
1988 *len = strlen(desc);
1991 if (npr->which != Z_NamePlusRecord_databaseRecord)
1994 /* from now on - we have a database record .. */
1995 if (!strcmp(type, "render"))
1997 Z_External *r = (Z_External *) npr->u.databaseRecord;
1998 const int *oid = r->direct_reference;
2000 /* render bibliographic record .. */
2001 if (r->which == Z_External_OPAC)
2003 r = r->u.opac->bibliographicRecord;
2006 oid = r->direct_reference;
2008 if (r->which == Z_External_sutrs)
2009 return record_iconv_return(rec, len,
2010 (char*) r->u.sutrs->buf,
2013 else if (r->which == Z_External_octet)
2015 if (yaz_oid_is_iso2709(oid))
2017 const char *ret_buf = marc_iconv_return(
2018 rec, YAZ_MARC_LINE, len,
2019 (const char *) r->u.octet_aligned->buf,
2020 r->u.octet_aligned->len,
2025 return record_iconv_return(rec, len,
2026 (const char *) r->u.octet_aligned->buf,
2027 r->u.octet_aligned->len,
2030 else if (r->which == Z_External_grs1)
2032 if (!rec->wrbuf_marc)
2033 rec->wrbuf_marc = wrbuf_alloc();
2034 wrbuf_rewind(rec->wrbuf_marc);
2035 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
2036 return record_iconv_return(rec, len,
2037 wrbuf_buf(rec->wrbuf_marc),
2038 wrbuf_len(rec->wrbuf_marc),
2043 else if (!strcmp(type, "xml"))
2045 Z_External *r = (Z_External *) npr->u.databaseRecord;
2046 const int *oid = r->direct_reference;
2048 /* render bibliographic record .. */
2049 if (r->which == Z_External_OPAC)
2051 r = r->u.opac->bibliographicRecord;
2054 oid = r->direct_reference;
2057 if (r->which == Z_External_sutrs)
2058 return record_iconv_return(rec, len,
2059 (const char *) r->u.sutrs->buf,
2062 else if (r->which == Z_External_octet)
2064 int marc_decode_type = YAZ_MARC_MARCXML;
2065 if (yaz_oid_is_iso2709(oid))
2067 const char *ret_buf = marc_iconv_return(
2068 rec, marc_decode_type, len,
2069 (const char *) r->u.octet_aligned->buf,
2070 r->u.octet_aligned->len,
2075 return record_iconv_return(rec, len,
2076 (const char *) r->u.octet_aligned->buf,
2077 r->u.octet_aligned->len,
2080 else if (r->which == Z_External_grs1)
2087 else if (!strcmp(type, "raw"))
2089 Z_External *r = (Z_External *) npr->u.databaseRecord;
2091 if (r->which == Z_External_sutrs)
2093 if (len) *len = r->u.sutrs->len;
2094 return (const char *) r->u.sutrs->buf;
2096 else if (r->which == Z_External_octet)
2098 if (len) *len = r->u.octet_aligned->len;
2099 return (const char *) r->u.octet_aligned->buf;
2101 else /* grs-1, explain, OPAC, ... */
2104 return (const char *) npr->u.databaseRecord;
2108 else if (!strcmp (type, "ext"))
2111 return (const char *) npr->u.databaseRecord;
2113 else if (!strcmp (type, "opac"))
2116 Z_External *r = (Z_External *) npr->u.databaseRecord;
2117 if (r->which == Z_External_OPAC)
2119 if (!rec->wrbuf_opac)
2120 rec->wrbuf_opac = wrbuf_alloc();
2121 wrbuf_rewind(rec->wrbuf_opac);
2122 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2123 return record_iconv_return(rec, len,
2124 wrbuf_buf(rec->wrbuf_opac),
2125 wrbuf_len(rec->wrbuf_opac),
2132 static int strcmp_null(const char *v1, const char *v2)
2138 return strcmp(v1, v2);
2141 static size_t record_hash(int pos)
2145 return pos % RECORD_HASH_SIZE;
2148 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2150 const char *syntax, const char *elementSetName)
2152 ZOOM_record_cache rc;
2154 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2155 ZOOM_connection_put_event(r->connection, event);
2157 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2161 if (strcmp_null(r->schema, rc->schema))
2163 if (strcmp_null(elementSetName,rc->elementSetName))
2165 if (strcmp_null(syntax, rc->syntax))
2167 /* not destroying rc->npr (it's handled by nmem )*/
2169 /* keeping wrbuf_marc too */
2173 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2176 rc->rec.wrbuf_marc = 0;
2177 rc->rec.wrbuf_iconv = 0;
2178 rc->rec.wrbuf_opac = 0;
2180 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2182 rc->elementSetName = 0;
2185 rc->syntax = odr_strdup(r->odr, syntax);
2190 rc->schema = odr_strdup(r->odr, r->schema);
2195 rc->next = r->record_hash[record_hash(pos)];
2196 r->record_hash[record_hash(pos)] = rc;
2199 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2201 const char *elementSetName)
2203 ZOOM_record_cache rc;
2205 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2209 if (strcmp_null(r->schema, rc->schema))
2211 if (strcmp_null(elementSetName,rc->elementSetName))
2213 if (strcmp_null(syntax, rc->syntax))
2221 static void handle_records(ZOOM_connection c, Z_Records *sr,
2224 ZOOM_resultset resultset;
2226 const char *syntax = 0, *elementSetName = 0;
2230 switch (c->tasks->which)
2232 case ZOOM_TASK_SEARCH:
2233 resultset = c->tasks->u.search.resultset;
2234 start = &c->tasks->u.search.start;
2235 count = &c->tasks->u.search.count;
2236 syntax = c->tasks->u.search.syntax;
2237 elementSetName = c->tasks->u.search.elementSetName;
2239 case ZOOM_TASK_RETRIEVE:
2240 resultset = c->tasks->u.retrieve.resultset;
2241 start = &c->tasks->u.retrieve.start;
2242 count = &c->tasks->u.retrieve.count;
2243 syntax = c->tasks->u.retrieve.syntax;
2244 elementSetName = c->tasks->u.retrieve.elementSetName;
2249 if (sr && sr->which == Z_Records_NSD)
2250 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2251 else if (sr && sr->which == Z_Records_multipleNSD)
2253 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2254 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2256 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2260 if (*count + *start > resultset->size)
2261 *count = resultset->size - *start;
2264 if (sr && sr->which == Z_Records_DBOSD)
2267 NMEM nmem = odr_extract_mem(c->odr_in);
2268 Z_NamePlusRecordList *p =
2269 sr->u.databaseOrSurDiagnostics;
2270 for (i = 0; i<p->num_records; i++)
2272 record_cache_add(resultset, p->records[i], i + *start,
2273 syntax, elementSetName);
2279 yaz_log(log_details,
2280 "handle_records resultset=%p start=%d count=%d",
2281 resultset, *start, *count);
2283 /* transfer our response to search_nmem .. we need it later */
2284 nmem_transfer(odr_getmem(resultset->odr), nmem);
2286 if (present_phase && p->num_records == 0)
2288 /* present response and we didn't get any records! */
2289 Z_NamePlusRecord *myrec =
2290 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2291 record_cache_add(resultset, myrec, *start,
2292 syntax, elementSetName);
2295 else if (present_phase)
2297 /* present response and we didn't get any records! */
2298 Z_NamePlusRecord *myrec =
2299 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2300 record_cache_add(resultset, myrec, *start, syntax, elementSetName);
2305 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2307 handle_records(c, pr->records, 1);
2310 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2313 switch (term->which)
2315 case Z_Term_general:
2316 ZOOM_options_setl(opt, name,
2317 (const char *)(term->u.general->buf),
2318 term->u.general->len);
2320 case Z_Term_characterString:
2321 ZOOM_options_set(opt, name, term->u.characterString);
2323 case Z_Term_numeric:
2324 ZOOM_options_set_int(opt, name, *term->u.numeric);
2329 static void handle_queryExpression(ZOOM_options opt, const char *name,
2330 Z_QueryExpression *exp)
2336 case Z_QueryExpression_term:
2337 if (exp->u.term && exp->u.term->queryTerm)
2339 sprintf(opt_name, "%s.term", name);
2340 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2343 case Z_QueryExpression_query:
2348 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2349 Z_OtherInformation *o)
2352 for (i = 0; o && i < o->num_elements; i++)
2354 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2356 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2358 if (ext->which == Z_External_searchResult1)
2361 Z_SearchInfoReport *sr = ext->u.searchResult1;
2364 ZOOM_options_set_int(
2365 resultset->options, "searchresult.size", sr->num);
2367 for (j = 0; j < sr->num; j++)
2369 Z_SearchInfoReport_s *ent =
2370 ext->u.searchResult1->elements[j];
2373 sprintf(pref, "searchresult.%d", j);
2375 if (ent->subqueryId)
2378 sprintf(opt_name, "%s.id", pref);
2379 ZOOM_options_set(resultset->options, opt_name,
2382 if (ent->subqueryExpression)
2385 sprintf(opt_name, "%s.subquery", pref);
2386 handle_queryExpression(resultset->options, opt_name,
2387 ent->subqueryExpression);
2389 if (ent->subqueryInterpretation)
2392 sprintf(opt_name, "%s.interpretation", pref);
2393 handle_queryExpression(resultset->options, opt_name,
2394 ent->subqueryInterpretation);
2396 if (ent->subqueryRecommendation)
2399 sprintf(opt_name, "%s.recommendation", pref);
2400 handle_queryExpression(resultset->options, opt_name,
2401 ent->subqueryRecommendation);
2403 if (ent->subqueryCount)
2406 sprintf(opt_name, "%s.count", pref);
2407 ZOOM_options_set_int(resultset->options, opt_name,
2408 *ent->subqueryCount);
2416 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2418 ZOOM_resultset resultset;
2421 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2424 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2425 ZOOM_connection_put_event(c, event);
2427 resultset = c->tasks->u.search.resultset;
2429 if (sr->resultSetStatus)
2431 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2432 *sr->resultSetStatus);
2434 if (sr->presentStatus)
2436 ZOOM_options_set_int(resultset->options, "presentStatus",
2437 *sr->presentStatus);
2439 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2441 resultset->size = *sr->resultCount;
2442 handle_records(c, sr->records, 0);
2445 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2447 if (res->diagnostics && res->num_diagnostics > 0)
2448 response_diag(c, res->diagnostics[0]);
2451 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2453 NMEM nmem = odr_extract_mem(c->odr_in);
2456 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2458 scan = c->tasks->u.scan.scan;
2460 if (res->entries && res->entries->nonsurrogateDiagnostics)
2461 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2462 scan->scan_response = res;
2463 nmem_transfer(odr_getmem(scan->odr), nmem);
2465 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2466 if (res->positionOfTerm)
2467 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2468 if (res->scanStatus)
2469 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2470 if (res->numberOfEntriesReturned)
2471 ZOOM_options_set_int(scan->options, "number",
2472 *res->numberOfEntriesReturned);
2477 static zoom_ret send_sort(ZOOM_connection c,
2478 ZOOM_resultset resultset)
2481 resultset->r_sort_spec = 0;
2482 if (resultset->r_sort_spec)
2484 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2485 Z_SortRequest *req = apdu->u.sortRequest;
2487 req->num_inputResultSetNames = 1;
2488 req->inputResultSetNames = (Z_InternationalString **)
2489 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2490 req->inputResultSetNames[0] =
2491 odr_strdup(c->odr_out, resultset->setname);
2492 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2493 req->sortSequence = resultset->r_sort_spec;
2494 resultset->r_sort_spec = 0;
2495 return send_APDU(c, apdu);
2497 return zoom_complete;
2500 static zoom_ret send_present(ZOOM_connection c)
2503 Z_PresentRequest *req = 0;
2505 const char *syntax = 0;
2506 const char *elementSetName = 0;
2507 ZOOM_resultset resultset;
2512 yaz_log(log_details, "%p send_present no tasks", c);
2513 return zoom_complete;
2516 switch (c->tasks->which)
2518 case ZOOM_TASK_SEARCH:
2519 resultset = c->tasks->u.search.resultset;
2520 start = &c->tasks->u.search.start;
2521 count = &c->tasks->u.search.count;
2522 syntax = c->tasks->u.search.syntax;
2523 elementSetName = c->tasks->u.search.elementSetName;
2525 case ZOOM_TASK_RETRIEVE:
2526 resultset = c->tasks->u.retrieve.resultset;
2527 start = &c->tasks->u.retrieve.start;
2528 count = &c->tasks->u.retrieve.count;
2529 syntax = c->tasks->u.retrieve.syntax;
2530 elementSetName = c->tasks->u.retrieve.elementSetName;
2533 return zoom_complete;
2535 yaz_log(log_details, "%p send_present start=%d count=%d",
2538 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2540 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2543 if (c->error) /* don't continue on error */
2544 return zoom_complete;
2545 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2546 resultset, *start, *count);
2548 for (i = 0; i < *count; i++)
2551 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2556 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2557 ZOOM_connection_put_event(c, event);
2565 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2566 return zoom_complete;
2569 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2570 req = apdu->u.presentRequest;
2573 yaz_log(log_details, "%p send_present skip=%d", c, i);
2575 *req->resultSetStartPoint = *start + 1;
2576 *req->numberOfRecordsRequested = resultset->step>0 ?
2577 resultset->step : *count;
2578 if (*req->numberOfRecordsRequested + *start > resultset->size)
2579 *req->numberOfRecordsRequested = resultset->size - *start;
2580 assert(*req->numberOfRecordsRequested > 0);
2582 if (syntax && *syntax)
2583 req->preferredRecordSyntax =
2584 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2586 if (resultset->schema && *resultset->schema)
2588 Z_RecordComposition *compo = (Z_RecordComposition *)
2589 odr_malloc(c->odr_out, sizeof(*compo));
2591 req->recordComposition = compo;
2592 compo->which = Z_RecordComp_complex;
2593 compo->u.complex = (Z_CompSpec *)
2594 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2595 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2596 odr_malloc(c->odr_out, sizeof(bool_t));
2597 *compo->u.complex->selectAlternativeSyntax = 0;
2599 compo->u.complex->generic = (Z_Specification *)
2600 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2602 compo->u.complex->generic->which = Z_Schema_oid;
2603 compo->u.complex->generic->schema.oid = (Odr_oid *)
2604 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2606 if (!compo->u.complex->generic->schema.oid)
2608 /* OID wasn't a schema! Try record syntax instead. */
2610 compo->u.complex->generic->schema.oid = (Odr_oid *)
2611 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2613 if (elementSetName && *elementSetName)
2615 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2616 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2617 compo->u.complex->generic->elementSpec->which =
2618 Z_ElementSpec_elementSetName;
2619 compo->u.complex->generic->elementSpec->u.elementSetName =
2620 odr_strdup(c->odr_out, elementSetName);
2623 compo->u.complex->generic->elementSpec = 0;
2624 compo->u.complex->num_dbSpecific = 0;
2625 compo->u.complex->dbSpecific = 0;
2626 compo->u.complex->num_recordSyntax = 0;
2627 compo->u.complex->recordSyntax = 0;
2629 else if (elementSetName && *elementSetName)
2631 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2632 odr_malloc(c->odr_out, sizeof(*esn));
2633 Z_RecordComposition *compo = (Z_RecordComposition *)
2634 odr_malloc(c->odr_out, sizeof(*compo));
2636 esn->which = Z_ElementSetNames_generic;
2637 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2638 compo->which = Z_RecordComp_simple;
2639 compo->u.simple = esn;
2640 req->recordComposition = compo;
2642 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2643 return send_APDU(c, apdu);
2646 ZOOM_API(ZOOM_scanset)
2647 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2650 ZOOM_query q = ZOOM_query_create();
2652 ZOOM_query_prefix(q, start);
2654 s = ZOOM_connection_scan1(c, q);
2655 ZOOM_query_destroy(q);
2660 ZOOM_API(ZOOM_scanset)
2661 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2665 ZOOM_scanset scan = 0;
2668 * We need to check the query-type, so we can recognise CQL and
2669 * CCL and compile them into a form that we can use here. The
2670 * ZOOM_query structure has no explicit `type' member, but
2671 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2672 * functions shows how the structure is set up in each case.
2676 else if (q->z_query->which == Z_Query_type_1)
2678 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2679 c, q, q->query_string);
2680 start = q->query_string;
2682 else if (q->z_query->which == Z_Query_type_104)
2684 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2685 c, q, q->query_string);
2686 start = freeme = cql2pqf(c, q->query_string);
2692 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2693 c, q, q->query_string);
2697 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2698 scan->connection = c;
2699 scan->odr = odr_createmem(ODR_DECODE);
2700 scan->options = ZOOM_options_create_with_parent(c->options);
2702 scan->scan_response = 0;
2703 scan->termListAndStartPoint =
2704 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2708 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
2711 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
2714 yaz_query_charset_convert_apt(scan->termListAndStartPoint,
2721 scan->databaseNames = set_DatabaseNames(c, c->options,
2722 &scan->num_databaseNames,
2724 if (scan->termListAndStartPoint != 0)
2726 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2727 task->u.scan.scan = scan;
2732 while (ZOOM_event(1, &c))
2740 ZOOM_scanset_destroy(ZOOM_scanset scan)
2745 if (scan->refcount == 0)
2747 odr_destroy(scan->odr);
2749 ZOOM_options_destroy(scan->options);
2754 static zoom_ret send_package(ZOOM_connection c)
2758 yaz_log(log_details, "%p send_package", c);
2760 return zoom_complete;
2761 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2763 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2764 ZOOM_connection_put_event(c, event);
2766 c->buf_out = c->tasks->u.package->buf_out;
2767 c->len_out = c->tasks->u.package->len_out;
2772 static zoom_ret send_scan(ZOOM_connection c)
2775 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2776 Z_ScanRequest *req = apdu->u.scanRequest;
2778 yaz_log(log_details, "%p send_scan", c);
2780 return zoom_complete;
2781 assert (c->tasks->which == ZOOM_TASK_SCAN);
2782 scan = c->tasks->u.scan.scan;
2784 req->termListAndStartPoint = scan->termListAndStartPoint;
2785 req->attributeSet = scan->attributeSet;
2787 *req->numberOfTermsRequested =
2788 ZOOM_options_get_int(scan->options, "number", 10);
2790 req->preferredPositionInResponse =
2791 odr_intdup(c->odr_out,
2792 ZOOM_options_get_int(scan->options, "position", 1));
2795 odr_intdup(c->odr_out,
2796 ZOOM_options_get_int(scan->options, "stepSize", 0));
2798 req->databaseNames = scan->databaseNames;
2799 req->num_databaseNames = scan->num_databaseNames;
2801 return send_APDU(c, apdu);
2805 ZOOM_scanset_size(ZOOM_scanset scan)
2807 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2809 return scan->scan_response->entries->num_entries;
2812 ZOOM_API(const char *)
2813 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2816 const char *term = 0;
2817 size_t noent = ZOOM_scanset_size(scan);
2818 Z_ScanResponse *res = scan->scan_response;
2824 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2826 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2828 if (t->term->which == Z_Term_general)
2830 term = (const char *) t->term->u.general->buf;
2831 *len = t->term->u.general->len;
2833 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2838 ZOOM_API(const char *)
2839 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2842 const char *term = 0;
2843 size_t noent = ZOOM_scanset_size(scan);
2844 Z_ScanResponse *res = scan->scan_response;
2850 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2852 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2856 term = t->displayTerm;
2857 *len = strlen(term);
2859 else if (t->term->which == Z_Term_general)
2861 term = (const char *) t->term->u.general->buf;
2862 *len = t->term->u.general->len;
2864 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2869 ZOOM_API(const char *)
2870 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2872 return ZOOM_options_get(scan->options, key);
2876 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2879 ZOOM_options_set(scan->options, key, val);
2882 static Z_APDU *create_es_package(ZOOM_package p, const int *oid)
2885 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2886 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2888 *req->function = Z_ExtendedServicesRequest_create;
2890 str = ZOOM_options_get(p->options, "package-name");
2892 req->packageName = odr_strdup(p->odr_out, str);
2894 str = ZOOM_options_get(p->options, "user-id");
2896 req->userId = odr_strdup(p->odr_out, str);
2898 req->packageType = odr_oiddup(p->odr_out, oid);
2900 str = ZOOM_options_get(p->options, "function");
2903 if (!strcmp (str, "create"))
2905 if (!strcmp (str, "delete"))
2907 if (!strcmp (str, "modify"))
2913 static const char *ill_array_lookup(void *clientData, const char *idx)
2915 ZOOM_package p = (ZOOM_package) clientData;
2916 return ZOOM_options_get(p->options, idx+4);
2919 static Z_External *encode_ill_request(ZOOM_package p)
2921 ODR out = p->odr_out;
2924 struct ill_get_ctl ctl;
2926 ctl.odr = p->odr_out;
2928 ctl.f = ill_array_lookup;
2930 req = ill_get_ILLRequest(&ctl, "ill", 0);
2932 if (!ill_Request(out, &req, 0, 0))
2934 int ill_request_size;
2935 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2936 if (ill_request_buf)
2937 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2942 int illRequest_size = 0;
2943 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2945 r = (Z_External *) odr_malloc(out, sizeof(*r));
2946 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
2947 r->indirect_reference = 0;
2949 r->which = Z_External_single;
2951 r->u.single_ASN1_type =
2952 odr_create_Odr_oct(out,
2953 (unsigned char *)illRequest_buf,
2959 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2961 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2964 req->which = Z_IOItemOrder_esRequest;
2965 req->u.esRequest = (Z_IORequest *)
2966 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2968 /* to keep part ... */
2969 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2970 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2971 req->u.esRequest->toKeep->supplDescription = 0;
2972 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2973 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2975 str = ZOOM_options_get(p->options, "contact-name");
2976 req->u.esRequest->toKeep->contact->name = str ?
2977 odr_strdup(p->odr_out, str) : 0;
2979 str = ZOOM_options_get(p->options, "contact-phone");
2980 req->u.esRequest->toKeep->contact->phone = str ?
2981 odr_strdup(p->odr_out, str) : 0;
2983 str = ZOOM_options_get(p->options, "contact-email");
2984 req->u.esRequest->toKeep->contact->email = str ?
2985 odr_strdup(p->odr_out, str) : 0;
2987 req->u.esRequest->toKeep->addlBilling = 0;
2989 /* not to keep part ... */
2990 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2991 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2993 str = ZOOM_options_get(p->options, "itemorder-setname");
2998 req->u.esRequest->notToKeep->resultSetItem = 0;
3001 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3002 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3004 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3005 odr_strdup(p->odr_out, str);
3006 req->u.esRequest->notToKeep->resultSetItem->item =
3007 (int *) odr_malloc(p->odr_out, sizeof(int));
3009 str = ZOOM_options_get(p->options, "itemorder-item");
3010 *req->u.esRequest->notToKeep->resultSetItem->item =
3011 (str ? atoi(str) : 1);
3014 str = ZOOM_options_get(p->options, "doc");
3017 req->u.esRequest->notToKeep->itemRequest =
3018 z_ext_record_xml(p->odr_out, str, strlen(str));
3021 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3026 Z_APDU *create_admin_package(ZOOM_package p, int type,
3027 Z_ESAdminOriginPartToKeep **toKeepP,
3028 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3030 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3033 Z_ESAdminOriginPartToKeep *toKeep;
3034 Z_ESAdminOriginPartNotToKeep *notToKeep;
3035 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3036 const char *first_db = "Default";
3038 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3043 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3045 r->indirect_reference = 0;
3046 r->which = Z_External_ESAdmin;
3048 r->u.adminService = (Z_Admin *)
3049 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3050 r->u.adminService->which = Z_Admin_esRequest;
3051 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3052 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3054 toKeep = r->u.adminService->u.esRequest->toKeep =
3055 (Z_ESAdminOriginPartToKeep *)
3056 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3057 toKeep->which = type;
3058 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3059 toKeep->u.create = odr_nullval();
3060 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3062 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3063 (Z_ESAdminOriginPartNotToKeep *)
3064 odr_malloc(p->odr_out,
3065 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3066 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3067 notToKeep->u.recordsWillFollow = odr_nullval();
3071 *notToKeepP = notToKeep;
3076 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3078 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3079 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3080 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3081 const char *doc = ZOOM_options_get(p->options, "doc");
3086 req->taskSpecificParameters = ext;
3087 ext->direct_reference = req->packageType;
3088 ext->descriptor = 0;
3089 ext->indirect_reference = 0;
3091 ext->which = Z_External_octet;
3092 ext->u.single_ASN1_type =
3093 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
3098 static Z_APDU *create_update_package(ZOOM_package p)
3101 const char *first_db = "Default";
3103 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3104 const char *action = ZOOM_options_get(p->options, "action");
3105 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
3106 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3107 const char *record_buf = ZOOM_options_get(p->options, "record");
3108 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3110 int *syntax_oid = 0;
3116 record_buf = "void";
3117 syntax_str = "SUTRS";
3122 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3123 CLASS_RECSYN, syntax_str,
3133 action = "specialUpdate";
3135 if (!strcmp(action, "recordInsert"))
3136 action_no = Z_IUOriginPartToKeep_recordInsert;
3137 else if (!strcmp(action, "recordReplace"))
3138 action_no = Z_IUOriginPartToKeep_recordReplace;
3139 else if (!strcmp(action, "recordDelete"))
3140 action_no = Z_IUOriginPartToKeep_recordDelete;
3141 else if (!strcmp(action, "elementUpdate"))
3142 action_no = Z_IUOriginPartToKeep_elementUpdate;
3143 else if (!strcmp(action, "specialUpdate"))
3144 action_no = Z_IUOriginPartToKeep_specialUpdate;
3148 apdu = create_es_package(p, yaz_oid_extserv_database_update);
3151 Z_IUOriginPartToKeep *toKeep;
3152 Z_IUSuppliedRecords *notToKeep;
3153 Z_External *r = (Z_External *)
3154 odr_malloc(p->odr_out, sizeof(*r));
3156 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3159 r->direct_reference = odr_oiddup(p->odr_out,
3160 yaz_oid_extserv_database_update);
3162 r->which = Z_External_update;
3163 r->indirect_reference = 0;
3164 r->u.update = (Z_IUUpdate *)
3165 odr_malloc(p->odr_out, sizeof(*r->u.update));
3167 r->u.update->which = Z_IUUpdate_esRequest;
3168 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3169 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3170 toKeep = r->u.update->u.esRequest->toKeep =
3171 (Z_IUOriginPartToKeep *)
3172 odr_malloc(p->odr_out, sizeof(*toKeep));
3174 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3176 toKeep->elementSetName = 0;
3177 toKeep->actionQualifier = 0;
3178 toKeep->action = odr_intdup(p->odr_out, action_no);
3180 notToKeep = r->u.update->u.esRequest->notToKeep =
3181 (Z_IUSuppliedRecords *)
3182 odr_malloc(p->odr_out, sizeof(*notToKeep));
3184 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3185 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3186 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3187 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3188 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3191 notToKeep->elements[0]->u.opaque =
3192 odr_create_Odr_oct(p->odr_out,
3193 (const unsigned char *) recordIdOpaque,
3194 strlen(recordIdOpaque));
3196 else if (recordIdNumber)
3198 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3200 notToKeep->elements[0]->u.number =
3201 odr_intdup(p->odr_out, atoi(recordIdNumber));
3204 notToKeep->elements[0]->u.opaque = 0;
3205 notToKeep->elements[0]->supplementalId = 0;
3206 notToKeep->elements[0]->correlationInfo = 0;
3207 notToKeep->elements[0]->record =
3208 z_ext_record_oid(p->odr_out, syntax_oid,
3209 record_buf, strlen(record_buf));
3213 ODR print = odr_createmem(ODR_PRINT);
3215 z_APDU(print, &apdu, 0, 0);
3222 ZOOM_package_send(ZOOM_package p, const char *type)
3229 odr_reset(p->odr_out);
3232 if (!strcmp(type, "itemorder"))
3234 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3237 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3239 r->direct_reference =
3240 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3242 r->which = Z_External_itemOrder;
3243 r->indirect_reference = 0;
3244 r->u.itemOrder = encode_item_order(p);
3246 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3249 else if (!strcmp(type, "create")) /* create database */
3251 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3254 else if (!strcmp(type, "drop")) /* drop database */
3256 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3259 else if (!strcmp(type, "commit")) /* commit changes */
3261 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3264 else if (!strcmp(type, "update")) /* update record(s) */
3266 apdu = create_update_package(p);
3268 else if (!strcmp(type, "xmlupdate"))
3270 apdu = create_xmlupdate_package(p);
3274 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3278 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3279 task->u.package = p;
3280 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3281 p->buf_out = (char *) xmalloc(p->len_out);
3282 memcpy(p->buf_out, buf, p->len_out);
3287 while (ZOOM_event(1, &c))
3294 ZOOM_API(ZOOM_package)
3295 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3297 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3300 p->odr_out = odr_createmem(ODR_ENCODE);
3301 p->options = ZOOM_options_create_with_parent2(options, c->options);
3309 ZOOM_package_destroy(ZOOM_package p)
3314 if (p->refcount == 0)
3316 odr_destroy(p->odr_out);
3319 ZOOM_options_destroy(p->options);
3324 ZOOM_API(const char *)
3325 ZOOM_package_option_get(ZOOM_package p, const char *key)
3327 return ZOOM_options_get(p->options, key);
3332 ZOOM_package_option_set(ZOOM_package p, const char *key,
3335 ZOOM_options_set(p->options, key, val);
3338 static int ZOOM_connection_exec_task(ZOOM_connection c)
3340 ZOOM_task task = c->tasks;
3341 zoom_ret ret = zoom_complete;
3345 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3346 c, task->which, task->running);
3347 if (c->error != ZOOM_ERROR_NONE)
3349 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3350 "removing tasks because of error = %d", c, c->error);
3351 ZOOM_connection_remove_tasks(c);
3356 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3357 "task already running", c);
3361 ret = zoom_complete;
3362 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3364 switch (task->which)
3366 case ZOOM_TASK_SEARCH:
3367 if (c->proto == PROTO_HTTP)
3368 ret = ZOOM_connection_srw_send_search(c);
3370 ret = ZOOM_connection_send_search(c);
3372 case ZOOM_TASK_RETRIEVE:
3373 if (c->proto == PROTO_HTTP)
3374 ret = ZOOM_connection_srw_send_search(c);
3376 ret = send_present(c);
3378 case ZOOM_TASK_CONNECT:
3379 ret = do_connect(c);
3381 case ZOOM_TASK_SCAN:
3384 case ZOOM_TASK_PACKAGE:
3385 ret = send_package(c);
3387 case ZOOM_TASK_SORT:
3388 c->tasks->u.sort.resultset->r_sort_spec =
3389 c->tasks->u.sort.q->sort_spec;
3390 ret = send_sort(c, c->tasks->u.sort.resultset);
3396 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3397 "remove tasks because no connection exist", c);
3398 ZOOM_connection_remove_tasks(c);
3400 if (ret == zoom_complete)
3402 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3403 "task removed (complete)", c);
3404 ZOOM_connection_remove_task(c);
3407 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3412 static zoom_ret send_sort_present(ZOOM_connection c)
3414 zoom_ret r = zoom_complete;
3416 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3417 r = send_sort(c, c->tasks->u.search.resultset);
3418 if (r == zoom_complete)
3419 r = send_present(c);
3423 static int es_response(ZOOM_connection c,
3424 Z_ExtendedServicesResponse *res)
3426 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3428 if (res->diagnostics && res->num_diagnostics > 0)
3429 response_diag(c, res->diagnostics[0]);
3430 if (res->taskPackage &&
3431 res->taskPackage->which == Z_External_extendedService)
3433 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3434 Odr_oct *id = taskPackage->targetReference;
3437 ZOOM_options_setl(c->tasks->u.package->options,
3438 "targetReference", (char*) id->buf, id->len);
3440 if (res->taskPackage &&
3441 res->taskPackage->which == Z_External_octet)
3443 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3444 ZOOM_options_setl(c->tasks->u.package->options,
3445 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3450 static void interpret_init_diag(ZOOM_connection c,
3451 Z_DiagnosticFormat *diag)
3455 Z_DiagnosticFormat_s *ds = diag->elements[0];
3456 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3457 response_default_diag(c, ds->u.defaultDiagRec);
3462 static void interpret_otherinformation_field(ZOOM_connection c,
3463 Z_OtherInformation *ui)
3466 for (i = 0; i < ui->num_elements; i++)
3468 Z_OtherInformationUnit *unit = ui->list[i];
3469 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3470 unit->information.externallyDefinedInfo &&
3471 unit->information.externallyDefinedInfo->which ==
3474 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3480 static void set_init_option(const char *name, void *clientData) {
3481 ZOOM_connection c = clientData;
3484 sprintf(buf, "init_opt_%.70s", name);
3485 ZOOM_connection_option_set(c, buf, "1");
3489 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3491 Z_InitResponse *initrs;
3493 ZOOM_connection_set_mask(c, 0);
3494 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3497 case Z_APDU_initResponse:
3498 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3499 initrs = apdu->u.initResponse;
3500 ZOOM_connection_option_set(c, "serverImplementationId",
3501 initrs->implementationId ?
3502 initrs->implementationId : "");
3503 ZOOM_connection_option_set(c, "serverImplementationName",
3504 initrs->implementationName ?
3505 initrs->implementationName : "");
3506 ZOOM_connection_option_set(c, "serverImplementationVersion",
3507 initrs->implementationVersion ?
3508 initrs->implementationVersion : "");
3509 /* Set the three old options too, for old applications */
3510 ZOOM_connection_option_set(c, "targetImplementationId",
3511 initrs->implementationId ?
3512 initrs->implementationId : "");
3513 ZOOM_connection_option_set(c, "targetImplementationName",
3514 initrs->implementationName ?
3515 initrs->implementationName : "");
3516 ZOOM_connection_option_set(c, "targetImplementationVersion",
3517 initrs->implementationVersion ?
3518 initrs->implementationVersion : "");
3520 /* Make initrs->options available as ZOOM-level options */
3521 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3523 if (!*initrs->result)
3525 Z_External *uif = initrs->userInformationField;
3527 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3529 if (uif && uif->which == Z_External_userInfo1)
3530 interpret_otherinformation_field(c, uif->u.userInfo1);
3535 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
3536 yaz_oid_userinfo_cookie, 1, 0);
3537 xfree(c->cookie_in);
3540 c->cookie_in = xstrdup(cookie);
3541 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3542 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3543 c->support_named_resultsets = 1;
3546 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3547 ZOOM_connection_remove_task(c);
3549 ZOOM_connection_exec_task(c);
3551 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3553 NMEM tmpmem = nmem_create();
3554 Z_CharSetandLanguageNegotiation *p =
3555 yaz_get_charneg_record(initrs->otherInfo);
3559 char *charset = NULL, *lang = NULL;
3562 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3563 yaz_log(log_details, "%p recv_apdu target accepted: "
3564 "charset %s, language %s, select %d",
3566 charset ? charset : "none", lang ? lang : "none", sel);
3568 ZOOM_connection_option_set(c, "negotiation-charset",
3571 ZOOM_connection_option_set(c, "negotiation-lang",
3574 ZOOM_connection_option_set(
3575 c, "negotiation-charset-in-effect-for-records",
3576 (sel != 0) ? "1" : "0");
3577 nmem_destroy(tmpmem);
3581 case Z_APDU_searchResponse:
3582 yaz_log(log_api, "%p recv_apdu Search response", c);
3583 handle_search_response(c, apdu->u.searchResponse);
3584 if (send_sort_present(c) == zoom_complete)
3585 ZOOM_connection_remove_task(c);
3587 case Z_APDU_presentResponse:
3588 yaz_log(log_api, "%p recv_apdu Present response", c);
3589 handle_present_response(c, apdu->u.presentResponse);
3590 if (send_present(c) == zoom_complete)
3591 ZOOM_connection_remove_task(c);
3593 case Z_APDU_sortResponse:
3594 yaz_log(log_api, "%p recv_apdu Sort response", c);
3595 sort_response(c, apdu->u.sortResponse);
3596 if (send_present(c) == zoom_complete)
3597 ZOOM_connection_remove_task(c);
3599 case Z_APDU_scanResponse:
3600 yaz_log(log_api, "%p recv_apdu Scan response", c);
3601 scan_response(c, apdu->u.scanResponse);
3602 ZOOM_connection_remove_task(c);
3604 case Z_APDU_extendedServicesResponse:
3605 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3606 es_response(c, apdu->u.extendedServicesResponse);
3607 ZOOM_connection_remove_task(c);
3610 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3611 if (!ZOOM_test_reconnect(c))
3613 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3618 yaz_log(log_api, "%p Received unknown PDU", c);
3619 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3625 static void handle_srw_response(ZOOM_connection c,
3626 Z_SRW_searchRetrieveResponse *res)
3628 ZOOM_resultset resultset = 0;
3633 const char *syntax, *elementSetName;
3638 switch(c->tasks->which)
3640 case ZOOM_TASK_SEARCH:
3641 resultset = c->tasks->u.search.resultset;
3642 start = &c->tasks->u.search.start;
3643 syntax = c->tasks->u.search.syntax;
3644 elementSetName = c->tasks->u.search.elementSetName;
3646 case ZOOM_TASK_RETRIEVE:
3647 resultset = c->tasks->u.retrieve.resultset;
3648 start = &c->tasks->u.retrieve.start;
3649 syntax = c->tasks->u.retrieve.syntax;
3650 elementSetName = c->tasks->u.retrieve.elementSetName;
3655 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3656 ZOOM_connection_put_event(c, event);
3658 resultset->size = 0;
3660 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3662 if (res->numberOfRecords)
3663 resultset->size = *res->numberOfRecords;
3665 for (i = 0; i<res->num_records; i++)
3669 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3670 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3672 if (res->records[i].recordPosition &&
3673 *res->records[i].recordPosition > 0)
3674 pos = *res->records[i].recordPosition - 1;
3678 npr->databaseName = 0;
3679 npr->which = Z_NamePlusRecord_databaseRecord;
3680 npr->u.databaseRecord = (Z_External *)
3681 odr_malloc(c->odr_in, sizeof(Z_External));
3682 npr->u.databaseRecord->descriptor = 0;
3683 npr->u.databaseRecord->direct_reference =
3684 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
3685 npr->u.databaseRecord->which = Z_External_octet;
3687 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3688 odr_malloc(c->odr_in, sizeof(Odr_oct));
3689 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3690 res->records[i].recordData_buf;
3691 npr->u.databaseRecord->u.octet_aligned->len =
3692 npr->u.databaseRecord->u.octet_aligned->size =
3693 res->records[i].recordData_len;
3694 record_cache_add(resultset, npr, pos, syntax, elementSetName);
3696 if (res->num_diagnostics > 0)
3698 const char *uri = res->diagnostics[0].uri;
3703 if ((cp = strrchr(uri, '/')))
3705 set_dset_error(c, code, uri,
3706 res->diagnostics[0].details, 0);
3709 nmem = odr_extract_mem(c->odr_in);
3710 nmem_transfer(odr_getmem(resultset->odr), nmem);
3716 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3719 const char *content_type = z_HTTP_header_lookup(hres->headers,
3721 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3723 ZOOM_connection_set_mask(c, 0);
3724 yaz_log(log_details, "%p handle_http", c);
3726 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3728 Z_SOAP *soap_package = 0;
3730 Z_SOAP_Handler soap_handlers[2] = {
3731 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
3734 ret = z_soap_codec(o, &soap_package,
3735 &hres->content_buf, &hres->content_len,
3737 if (!ret && soap_package->which == Z_SOAP_generic &&
3738 soap_package->u.generic->no == 0)
3740 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3741 if (sr->which == Z_SRW_searchRetrieve_response)
3742 handle_srw_response(c, sr->u.response);
3746 else if (!ret && (soap_package->which == Z_SOAP_fault
3747 || soap_package->which == Z_SOAP_error))
3749 set_HTTP_error(c, hres->code,
3750 soap_package->u.fault->fault_code,
3751 soap_package->u.fault->fault_string);
3758 if (hres->code != 200)
3759 set_HTTP_error(c, hres->code, 0, 0);
3761 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3764 ZOOM_connection_remove_task(c);
3765 if (!strcmp(hres->version, "1.0"))
3767 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3768 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3773 /* HTTP 1.1: only if no close we stay alive .. */
3774 if (connection_head && !strcmp(connection_head, "close"))
3780 static int do_read(ZOOM_connection c)
3785 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3786 ZOOM_connection_put_event(c, event);
3788 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3789 more = cs_more(c->cs);
3790 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3795 if (!ZOOM_test_reconnect(c))
3797 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3806 odr_reset(c->odr_in);
3807 odr_setbuf(c->odr_in, c->buf_in, r, 0);
3808 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3809 ZOOM_connection_put_event(c, event);
3811 if (!z_GDU(c->odr_in, &gdu, 0, 0))
3814 int err = odr_geterrorx(c->odr_in, &x);
3816 const char *element = odr_getelement(c->odr_in);
3817 sprintf(msg, "ODR code %d:%d element=%-20s",
3818 err, x, element ? element : "<unknown>");
3819 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3822 else if (gdu->which == Z_GDU_Z3950)
3823 recv_apdu(c, gdu->u.z3950);
3824 else if (gdu->which == Z_GDU_HTTP_Response)
3827 handle_http(c, gdu->u.HTTP_Response);
3829 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3833 c->reconnect_ok = 0;
3838 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3843 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3844 ZOOM_connection_put_event(c, event);
3846 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3847 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3849 yaz_log(log_details, "%p do_write_ex write failed", c);
3850 if (ZOOM_test_reconnect(c))
3852 return zoom_pending;
3854 if (c->state == STATE_CONNECTING)
3855 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3857 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3859 return zoom_complete;
3863 int mask = ZOOM_SELECT_EXCEPT;
3864 if (c->cs->io_pending & CS_WANT_WRITE)
3865 mask += ZOOM_SELECT_WRITE;
3866 if (c->cs->io_pending & CS_WANT_READ)
3867 mask += ZOOM_SELECT_READ;
3868 ZOOM_connection_set_mask(c, mask);
3869 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3874 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
3875 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3878 return zoom_pending;
3881 static zoom_ret do_write(ZOOM_connection c)
3883 return do_write_ex(c, c->buf_out, c->len_out);
3887 ZOOM_API(const char *)
3888 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3890 return ZOOM_options_get(c->options, key);
3893 ZOOM_API(const char *)
3894 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3896 return ZOOM_options_getl(c->options, key, lenp);
3900 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3903 ZOOM_options_set(c->options, key, val);
3907 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3908 const char *val, int len)
3910 ZOOM_options_setl(c->options, key, val, len);
3913 ZOOM_API(const char *)
3914 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3916 return ZOOM_options_get(r->options, key);
3920 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3923 ZOOM_options_set(r->options, key, val);
3928 ZOOM_connection_errcode(ZOOM_connection c)
3930 return ZOOM_connection_error(c, 0, 0);
3933 ZOOM_API(const char *)
3934 ZOOM_connection_errmsg(ZOOM_connection c)
3937 ZOOM_connection_error(c, &msg, 0);
3941 ZOOM_API(const char *)
3942 ZOOM_connection_addinfo(ZOOM_connection c)
3944 const char *addinfo;
3945 ZOOM_connection_error(c, 0, &addinfo);
3949 ZOOM_API(const char *)
3950 ZOOM_connection_diagset(ZOOM_connection c)
3952 const char *diagset;
3953 ZOOM_connection_error_x(c, 0, 0, &diagset);
3957 ZOOM_API(const char *)
3958 ZOOM_diag_str(int error)
3962 case ZOOM_ERROR_NONE:
3964 case ZOOM_ERROR_CONNECT:
3965 return "Connect failed";
3966 case ZOOM_ERROR_MEMORY:
3967 return "Out of memory";
3968 case ZOOM_ERROR_ENCODE:
3969 return "Encoding failed";
3970 case ZOOM_ERROR_DECODE:
3971 return "Decoding failed";
3972 case ZOOM_ERROR_CONNECTION_LOST:
3973 return "Connection lost";
3974 case ZOOM_ERROR_INIT:
3975 return "Init rejected";
3976 case ZOOM_ERROR_INTERNAL:
3977 return "Internal failure";
3978 case ZOOM_ERROR_TIMEOUT:
3980 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3981 return "Unsupported protocol";
3982 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3983 return "Unsupported query type";
3984 case ZOOM_ERROR_INVALID_QUERY:
3985 return "Invalid query";
3986 case ZOOM_ERROR_CQL_PARSE:
3987 return "CQL parsing error";
3988 case ZOOM_ERROR_CQL_TRANSFORM:
3989 return "CQL transformation error";
3990 case ZOOM_ERROR_CCL_CONFIG:
3991 return "CCL configuration error";
3992 case ZOOM_ERROR_CCL_PARSE:
3993 return "CCL parsing error";
3995 return diagbib1_str(error);
4000 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4001 const char **addinfo, const char **diagset)
4003 int error = c->error;
4006 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4007 *cp = ZOOM_diag_str(error);
4008 else if (!strcmp(c->diagset, "HTTP"))
4009 *cp = z_HTTP_errmsg(c->error);
4010 else if (!strcmp(c->diagset, "Bib-1"))
4011 *cp = ZOOM_diag_str(error);
4012 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4013 *cp = yaz_diag_srw_str(c->error);
4015 *cp = "Unknown error and diagnostic set";
4018 *addinfo = c->addinfo ? c->addinfo : "";
4020 *diagset = c->diagset ? c->diagset : "";
4025 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4026 const char **addinfo)
4028 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4031 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4033 ZOOM_Event event = 0;
4034 int r = cs_look(c->cs);
4035 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4040 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4041 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4043 ZOOM_connection_put_event(c, event);
4045 else if (r == CS_CONNECT)
4047 int ret = ret = cs_rcvconnect(c->cs);
4048 yaz_log(log_details, "%p ZOOM_connection_do_io "
4049 "cs_rcvconnect returned %d", c, ret);
4052 int mask = ZOOM_SELECT_EXCEPT;
4053 if (c->cs->io_pending & CS_WANT_WRITE)
4054 mask += ZOOM_SELECT_WRITE;
4055 if (c->cs->io_pending & CS_WANT_READ)
4056 mask += ZOOM_SELECT_READ;
4057 ZOOM_connection_set_mask(c, mask);
4061 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4062 ZOOM_connection_put_event(c, event);
4064 if (c->proto == PROTO_Z3950)
4065 ZOOM_connection_send_init(c);
4068 /* no init request for SRW .. */
4069 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4070 ZOOM_connection_remove_task(c);
4071 ZOOM_connection_set_mask(c, 0);
4072 ZOOM_connection_exec_task(c);
4074 c->state = STATE_ESTABLISHED;
4078 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4084 if (mask & ZOOM_SELECT_EXCEPT)
4086 if (!ZOOM_test_reconnect(c))
4088 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4093 if (mask & ZOOM_SELECT_READ)
4095 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4101 ZOOM_connection_last_event(ZOOM_connection cs)
4104 return ZOOM_EVENT_NONE;
4105 return cs->last_event;
4109 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4111 WRBUF wrbuf = client_data;
4112 wrbuf_puts(wrbuf, buf);
4116 * Returns an xmalloc()d string containing RPN that corresponds to the
4117 * CQL passed in. On error, sets the Connection object's error state
4118 * and returns a null pointer.
4119 * ### We could cache CQL parser and/or transformer in Connection.
4121 static char *cql2pqf(ZOOM_connection c, const char *cql)
4125 const char *cqlfile;
4126 cql_transform_t trans;
4129 parser = cql_parser_create();
4130 if ((error = cql_parser_string(parser, cql)) != 0) {
4131 cql_parser_destroy(parser);
4132 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4136 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4139 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4141 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4144 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4145 cqlfile, strerror(errno));
4146 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4150 WRBUF wrbuf_result = wrbuf_alloc();
4151 error = cql_transform(trans, cql_parser_result(parser),
4152 cql2pqf_wrbuf_puts, wrbuf_result);
4155 const char *addinfo;
4156 error = cql_transform_error(trans, &addinfo);
4157 sprintf(buf, "%.200s (addinfo=%.200s)",
4158 cql_strerror(error), addinfo);
4159 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4163 result = xstrdup(wrbuf_cstr(wrbuf_result));
4165 cql_transform_close(trans);
4166 wrbuf_destroy(wrbuf_result);
4168 cql_parser_destroy(parser);
4172 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4176 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4177 /* timeout and this connection was waiting */
4178 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4180 ZOOM_connection_put_event(c, event);
4186 ZOOM_connection_process(ZOOM_connection c)
4192 event = ZOOM_connection_get_event(c);
4195 ZOOM_Event_destroy(event);
4198 ZOOM_connection_exec_task(c);
4199 event = ZOOM_connection_get_event(c);
4202 ZOOM_Event_destroy(event);
4209 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4213 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4215 for (i = 0; i<no; i++)
4217 ZOOM_connection c = cs[i];
4219 if (c && ZOOM_connection_process(c))
4225 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4227 if (c->mask && mask)
4228 ZOOM_connection_do_io(c, mask);
4232 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4235 return cs_fileno(c->cs);
4239 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4247 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4254 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4256 return ZOOM_options_get_int(c->options, "timeout", 30);
4262 * indent-tabs-mode: nil
4264 * vim: shiftwidth=4 tabstop=8 expandtab