2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.118 2007-03-19 20:58:34 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>
30 static int log_api = 0;
31 static int log_details = 0;
38 static void resultset_destroy(ZOOM_resultset r);
39 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
40 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
41 static char *cql2pqf(ZOOM_connection c, const char *cql);
45 * This wrapper is just for logging failed lookups. It would be nicer
46 * if it could cause failure when a lookup fails, but that's hard.
48 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
49 int oid_class, const char *str) {
50 Odr_oid *res = yaz_str_to_z3950oid(c->odr_out, oid_class, str);
52 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
53 c, (int) oid_class, str);
58 static void initlog(void)
60 static int log_level_initialized = 0;
61 if (!log_level_initialized)
63 log_api = yaz_log_module_level("zoom");
64 log_details = yaz_log_module_level("zoomdetails");
65 log_level_initialized = 1;
69 static ZOOM_Event ZOOM_Event_create(int kind)
71 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
75 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
79 static void ZOOM_Event_destroy(ZOOM_Event event)
84 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
88 c->m_queue_back->prev = event;
89 assert(c->m_queue_front);
93 assert(!c->m_queue_front);
94 c->m_queue_front = event;
96 event->next = c->m_queue_back;
98 c->m_queue_back = event;
101 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
103 ZOOM_Event event = c->m_queue_front;
106 c->last_event = ZOOM_EVENT_NONE;
109 assert(c->m_queue_back);
110 c->m_queue_front = event->prev;
111 if (c->m_queue_front)
113 assert(c->m_queue_back);
114 c->m_queue_front->next = 0;
118 c->last_event = event->kind;
122 static void ZOOM_connection_remove_events(ZOOM_connection c)
125 while ((event = ZOOM_connection_get_event(c)))
126 ZOOM_Event_destroy(event);
129 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
131 ZOOM_Event event = c->m_queue_front;
133 return event ? event->kind : ZOOM_EVENT_NONE;
136 void ZOOM_connection_remove_tasks(ZOOM_connection c);
138 static void set_dset_error(ZOOM_connection c, int error,
140 const char *addinfo, const char *addinfo2)
147 if (!c->diagset || strcmp(dset, c->diagset))
150 c->diagset = xstrdup(dset);
151 /* remove integer part from SRW diagset .. */
152 if ((cp = strrchr(c->diagset, '/')))
155 if (addinfo && addinfo2)
157 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
158 strcpy(c->addinfo, addinfo);
159 strcat(c->addinfo, addinfo2);
162 c->addinfo = xstrdup(addinfo);
163 if (error != ZOOM_ERROR_NONE)
165 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
166 c, c->host_port ? c->host_port : "<>", dset, error,
167 addinfo ? addinfo : "",
168 addinfo2 ? addinfo2 : "");
169 ZOOM_connection_remove_tasks(c);
174 static void set_HTTP_error(ZOOM_connection c, int error,
175 const char *addinfo, const char *addinfo2)
177 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
182 static void set_ZOOM_error(ZOOM_connection c, int error,
185 set_dset_error(c, error, "ZOOM", addinfo, 0);
188 static void clear_error(ZOOM_connection c)
191 * If an error is tied to an operation then it's ok to clear: for
192 * example, a diagnostic returned from a search is cleared by a
193 * subsequent search. However, problems such as Connection Lost
194 * or Init Refused are not cleared, because they are not
195 * recoverable: doing another search doesn't help.
198 ZOOM_connection_remove_events(c);
201 case ZOOM_ERROR_CONNECT:
202 case ZOOM_ERROR_MEMORY:
203 case ZOOM_ERROR_DECODE:
204 case ZOOM_ERROR_CONNECTION_LOST:
205 case ZOOM_ERROR_INIT:
206 case ZOOM_ERROR_INTERNAL:
207 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
210 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
214 void ZOOM_connection_show_task(ZOOM_task task)
218 case ZOOM_TASK_SEARCH:
219 yaz_log(YLOG_LOG, "search p=%p", task);
221 case ZOOM_TASK_RETRIEVE:
222 yaz_log(YLOG_LOG, "retrieve p=%p", task);
224 case ZOOM_TASK_CONNECT:
225 yaz_log(YLOG_LOG, "connect p=%p", task);
228 yaz_log(YLOG_LOG, "scant p=%p", task);
233 void ZOOM_connection_show_tasks(ZOOM_connection c)
236 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
237 for (task = c->tasks; task; task = task->next)
238 ZOOM_connection_show_task(task);
241 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
243 ZOOM_task *taskp = &c->tasks;
245 taskp = &(*taskp)->next;
246 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
247 (*taskp)->running = 0;
248 (*taskp)->which = which;
254 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
256 return c->tasks ? 0 : 1;
259 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
261 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
263 task->next = c->tasks;
272 void ZOOM_connection_remove_task(ZOOM_connection c)
274 ZOOM_task task = c->tasks;
278 c->tasks = task->next;
281 case ZOOM_TASK_SEARCH:
282 resultset_destroy(task->u.search.resultset);
283 xfree(task->u.search.syntax);
284 xfree(task->u.search.elementSetName);
286 case ZOOM_TASK_RETRIEVE:
287 resultset_destroy(task->u.retrieve.resultset);
288 xfree(task->u.retrieve.syntax);
289 xfree(task->u.retrieve.elementSetName);
291 case ZOOM_TASK_CONNECT:
294 ZOOM_scanset_destroy(task->u.scan.scan);
296 case ZOOM_TASK_PACKAGE:
297 ZOOM_package_destroy(task->u.package);
300 resultset_destroy(task->u.sort.resultset);
301 ZOOM_query_destroy(task->u.sort.q);
310 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
311 ZOOM_connection_put_event(c, event);
316 static int ZOOM_connection_exec_task(ZOOM_connection c);
318 void ZOOM_connection_remove_tasks(ZOOM_connection c)
321 ZOOM_connection_remove_task(c);
324 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
326 const char *elementSetName);
328 ZOOM_API(ZOOM_connection)
329 ZOOM_connection_create(ZOOM_options options)
331 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
335 yaz_log(log_api, "%p ZOOM_connection_create", c);
337 c->proto = PROTO_Z3950;
339 ZOOM_connection_set_mask(c, 0);
341 c->state = STATE_IDLE;
344 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
351 c->options = ZOOM_options_create_with_parent(options);
357 c->charset = c->lang = 0;
364 c->odr_in = odr_createmem(ODR_DECODE);
365 c->odr_out = odr_createmem(ODR_ENCODE);
368 c->support_named_resultsets = 0;
369 c->last_event = ZOOM_EVENT_NONE;
371 c->m_queue_front = 0;
377 /* set database names. Take local databases (if set); otherwise
378 take databases given in ZURL (if set); otherwise use Default */
379 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
382 char **databaseNames;
383 const char *cp = ZOOM_options_get(options, "databaseName");
385 if ((!cp || !*cp) && con->host_port)
387 if (strncmp(con->host_port, "unix:", 5) == 0)
388 cp = strchr(con->host_port+5, ':');
390 cp = strchr(con->host_port, '/');
396 nmem_strsplit(odr->mem, "+", cp, &databaseNames, num);
397 return databaseNames;
400 ZOOM_API(ZOOM_connection)
401 ZOOM_connection_new(const char *host, int portnum)
403 ZOOM_connection c = ZOOM_connection_create(0);
405 ZOOM_connection_connect(c, host, portnum);
409 static zoom_sru_mode get_sru_mode_from_string(const char *s)
412 return zoom_sru_soap;
413 if (!yaz_matchstr(s, "soap"))
414 return zoom_sru_soap;
415 else if (!yaz_matchstr(s, "get"))
417 else if (!yaz_matchstr(s, "post"))
418 return zoom_sru_post;
419 return zoom_sru_error;
423 ZOOM_connection_connect(ZOOM_connection c,
424 const char *host, int portnum)
431 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
432 c, host ? host : "null", portnum);
434 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
435 ZOOM_connection_remove_tasks(c);
439 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
443 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
445 val = ZOOM_options_get(c->options, "proxy");
448 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
449 c->proxy = xstrdup(val);
455 val = ZOOM_options_get(c->options, "charset");
458 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
459 c->charset = xstrdup(val);
465 val = ZOOM_options_get(c->options, "lang");
468 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
469 c->lang = xstrdup(val);
480 sprintf(hostn, "%.80s:%d", host, portnum);
481 c->host_port = xstrdup(hostn);
484 c->host_port = xstrdup(host);
489 * If the "<scheme>:" part of the host string is preceded by one
490 * or more comma-separated <name>=<value> pairs, these are taken
491 * to be options to be set on the connection object. Among other
492 * applications, this facility can be used to embed authentication
494 * user=admin,password=secret,tcp:localhost:9999
496 char *remainder = c->host_port;
497 char *pcolon = strchr(remainder, ':');
500 while ((pcomma = strchr(remainder, ',')) != 0 &&
501 (pcolon == 0 || pcomma < pcolon)) {
503 if ((pequals = strchr(remainder, '=')) != 0) {
505 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
506 ZOOM_connection_option_set(c, remainder, pequals+1);
508 remainder = pcomma+1;
511 if (remainder != c->host_port) {
513 c->host_port = xstrdup(remainder);
514 /*printf("# reset hp='%s'\n", remainder);*/
518 val = ZOOM_options_get(c->options, "sru");
519 c->sru_mode = get_sru_mode_from_string(val);
521 ZOOM_options_set(c->options, "host", c->host_port);
523 val = ZOOM_options_get(c->options, "cookie");
526 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
527 c->cookie_out = xstrdup(val);
530 val = ZOOM_options_get(c->options, "clientIP");
533 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
535 c->client_IP = xstrdup(val);
538 c->async = ZOOM_options_get_bool(c->options, "async", 0);
539 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
541 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
545 while (ZOOM_event(1, &c))
551 ZOOM_query_create(void)
553 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
555 yaz_log(log_details, "%p ZOOM_query_create", s);
559 s->odr = odr_createmem(ODR_ENCODE);
566 ZOOM_query_destroy(ZOOM_query s)
572 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
573 if (s->refcount == 0)
581 ZOOM_query_prefix(ZOOM_query s, const char *str)
583 s->query_string = odr_strdup(s->odr, str);
584 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
585 s->z_query->which = Z_Query_type_1;
586 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
587 if (!s->z_query->u.type_1)
589 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
593 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
598 ZOOM_query_cql(ZOOM_query s, const char *str)
602 s->query_string = odr_strdup(s->odr, str);
604 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
605 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
606 ext->indirect_reference = 0;
608 ext->which = Z_External_CQL;
609 ext->u.cql = s->query_string;
611 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
612 s->z_query->which = Z_Query_type_104;
613 s->z_query->u.type_104 = ext;
615 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
621 * Translate the CQL string client-side into RPN which is passed to
622 * the server. This is useful for server's that don't themselves
623 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
624 * only as a place to stash diagnostics if compilation fails; if this
625 * information is not needed, a null pointer may be used.
628 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
632 ZOOM_connection freeme = 0;
634 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
636 conn = freeme = ZOOM_connection_create(0);
638 rpn = cql2pqf(conn, str);
640 ZOOM_connection_destroy(freeme);
644 ret = ZOOM_query_prefix(s, rpn);
650 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
651 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
652 * to the server, as the YAZ GFS doesn't know how to handle this.
655 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
656 int *ccl_error, const char **error_string,
660 struct ccl_rpn_node *rpn;
661 CCL_bibset bibset = ccl_qual_mk();
664 ccl_qual_buf(bibset, config);
666 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
669 *error_string = ccl_err_msg(*ccl_error);
674 WRBUF wr = wrbuf_alloc();
677 ret = ZOOM_query_prefix(s, wrbuf_cstr(wr));
680 ccl_qual_rm(&bibset);
685 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
687 s->sort_spec = yaz_sort_spec(s->odr, criteria);
690 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
694 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
698 static zoom_ret do_write(ZOOM_connection c);
701 ZOOM_connection_destroy(ZOOM_connection c)
706 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
709 for (r = c->resultsets; r; r = r->next)
715 odr_destroy(c->odr_in);
716 odr_destroy(c->odr_out);
717 ZOOM_options_destroy(c->options);
718 ZOOM_connection_remove_tasks(c);
719 ZOOM_connection_remove_events(c);
725 xfree(c->cookie_out);
731 void ZOOM_resultset_addref(ZOOM_resultset r)
736 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
741 ZOOM_resultset ZOOM_resultset_create(void)
744 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
748 yaz_log(log_details, "%p ZOOM_resultset_create", r);
751 r->odr = odr_createmem(ODR_ENCODE);
756 for (i = 0; i<RECORD_HASH_SIZE; i++)
757 r->record_hash[i] = 0;
762 r->databaseNames = 0;
763 r->num_databaseNames = 0;
767 ZOOM_API(ZOOM_resultset)
768 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
771 ZOOM_query s = ZOOM_query_create();
773 ZOOM_query_prefix(s, q);
775 r = ZOOM_connection_search(c, s);
776 ZOOM_query_destroy(s);
780 ZOOM_API(ZOOM_resultset)
781 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
783 ZOOM_resultset r = ZOOM_resultset_create();
787 const char *syntax, *elementSetName;
789 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
790 r->r_sort_spec = q->sort_spec;
793 r->options = ZOOM_options_create_with_parent(c->options);
795 start = ZOOM_options_get_int(r->options, "start", 0);
796 count = ZOOM_options_get_int(r->options, "count", 0);
798 /* If "presentChunk" is defined use that; otherwise "step" */
799 const char *cp = ZOOM_options_get(r->options, "presentChunk");
800 r->step = ZOOM_options_get_int(r->options,
801 (cp != 0 ? "presentChunk": "step"), 0);
803 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
804 cp = ZOOM_options_get(r->options, "setname");
806 r->setname = xstrdup(cp);
807 cp = ZOOM_options_get(r->options, "schema");
809 r->schema = xstrdup(cp);
811 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
816 r->next = c->resultsets;
819 if (c->host_port && c->proto == PROTO_HTTP)
823 yaz_log(log_details, "ZOOM_connection_search: no comstack");
824 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
828 yaz_log(log_details, "ZOOM_connection_search: reconnect");
833 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
834 task->u.search.resultset = r;
835 task->u.search.start = start;
836 task->u.search.count = count;
838 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
839 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
840 elementSetName = ZOOM_options_get(r->options, "elementSetName");
841 task->u.search.elementSetName = elementSetName
842 ? xstrdup(elementSetName) : 0;
844 ZOOM_resultset_addref(r);
850 while (ZOOM_event(1, &c))
857 ZOOM_resultset_sort(ZOOM_resultset r,
858 const char *sort_type, const char *sort_spec)
860 ZOOM_connection c = r->connection;
864 newq = ZOOM_query_create();
865 if (ZOOM_query_sortby(newq, sort_spec) < 0)
868 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
869 r, r, sort_type, sort_spec);
873 if (c->host_port && c->proto == PROTO_HTTP)
877 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
878 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
882 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
888 ZOOM_resultset_cache_reset(r);
889 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
890 task->u.sort.resultset = r;
891 task->u.sort.q = newq;
893 ZOOM_resultset_addref(r);
897 while (ZOOM_event(1, &c))
905 ZOOM_resultset_cache_reset(ZOOM_resultset r)
908 for (i = 0; i<RECORD_HASH_SIZE; i++)
910 ZOOM_record_cache rc;
911 for (rc = r->record_hash[i]; rc; rc = rc->next)
913 if (rc->rec.wrbuf_marc)
914 wrbuf_destroy(rc->rec.wrbuf_marc);
915 if (rc->rec.wrbuf_iconv)
916 wrbuf_destroy(rc->rec.wrbuf_iconv);
917 if (rc->rec.wrbuf_opac)
918 wrbuf_destroy(rc->rec.wrbuf_opac);
920 r->record_hash[i] = 0;
925 ZOOM_resultset_destroy(ZOOM_resultset r)
927 resultset_destroy(r);
930 static void resultset_destroy(ZOOM_resultset r)
935 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
937 if (r->refcount == 0)
939 ZOOM_resultset_cache_reset(r);
943 /* remove ourselves from the resultsets in connection */
944 ZOOM_resultset *rp = &r->connection->resultsets;
947 assert(*rp); /* we must be in this list!! */
949 { /* OK, we're here - take us out of it */
956 ZOOM_query_destroy(r->query);
957 ZOOM_options_destroy(r->options);
966 ZOOM_resultset_size(ZOOM_resultset r)
968 yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
973 static void do_close(ZOOM_connection c)
978 ZOOM_connection_set_mask(c, 0);
979 c->state = STATE_IDLE;
982 static int ZOOM_test_reconnect(ZOOM_connection c)
986 if (!c->reconnect_ok)
990 c->tasks->running = 0;
991 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
993 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
994 ZOOM_connection_put_event(c, event);
999 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1000 int force_sync, int start, int count)
1005 const char *syntax, *elementSetName;
1009 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1010 " count=%d", r, force_sync, start, count);
1015 if (c->host_port && c->proto == PROTO_HTTP)
1019 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1020 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1024 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1026 c->reconnect_ok = 1;
1029 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1030 task->u.retrieve.resultset = r;
1031 task->u.retrieve.start = start;
1032 task->u.retrieve.count = count;
1034 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1035 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1036 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1037 task->u.retrieve.elementSetName = elementSetName
1038 ? xstrdup(elementSetName) : 0;
1040 cp = ZOOM_options_get(r->options, "schema");
1043 if (!r->schema || strcmp(r->schema, cp))
1046 r->schema = xstrdup(cp);
1050 ZOOM_resultset_addref(r);
1052 if (!r->connection->async || force_sync)
1053 while (r->connection && ZOOM_event(1, &r->connection))
1058 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1059 size_t start, size_t count)
1061 int force_present = 0;
1065 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1066 r, r, (long) start, (long) count);
1069 ZOOM_resultset_retrieve(r, force_present, start, count);
1073 for (i = 0; i< count; i++)
1074 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1078 static void get_cert(ZOOM_connection c)
1083 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1085 ZOOM_connection_option_setl(c, "sslPeerCert",
1086 cert_buf, cert_len);
1091 static zoom_ret do_connect(ZOOM_connection c)
1094 const char *effective_host;
1097 effective_host = c->proxy;
1099 effective_host = c->host_port;
1101 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1105 c->cs = cs_create_host(effective_host, 0, &add);
1107 if (c->cs && c->cs->protocol == PROTO_HTTP)
1110 const char *path = 0;
1112 c->proto = PROTO_HTTP;
1113 cs_get_host_args(c->host_port, &path);
1115 c->path = (char*) xmalloc(strlen(path)+2);
1117 strcpy(c->path+1, path);
1119 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1121 return zoom_complete;
1126 int ret = cs_connect(c->cs, add);
1129 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1130 ZOOM_connection_put_event(c, event);
1132 if (c->proto == PROTO_Z3950)
1133 ZOOM_connection_send_init(c);
1136 /* no init request for SRW .. */
1137 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1138 ZOOM_connection_remove_task(c);
1139 ZOOM_connection_set_mask(c, 0);
1140 ZOOM_connection_exec_task(c);
1142 c->state = STATE_ESTABLISHED;
1143 return zoom_pending;
1147 int mask = ZOOM_SELECT_EXCEPT;
1148 if (c->cs->io_pending & CS_WANT_WRITE)
1149 mask += ZOOM_SELECT_WRITE;
1150 if (c->cs->io_pending & CS_WANT_READ)
1151 mask += ZOOM_SELECT_READ;
1152 ZOOM_connection_set_mask(c, mask);
1153 c->state = STATE_CONNECTING;
1154 return zoom_pending;
1157 c->state = STATE_IDLE;
1158 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1159 return zoom_complete;
1162 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1165 for (i = 0; i<200; i++)
1168 Z_OtherInformation **oi;
1174 sprintf(buf, "otherInfo%d", i);
1175 val = ZOOM_options_get(c->options, buf);
1178 cp = strchr(val, ':');
1182 if (len >= sizeof(buf))
1183 len = sizeof(buf)-1;
1184 memcpy(buf, val, len);
1186 oidval = oid_getvalbyname(buf);
1187 if (oidval == VAL_NONE)
1190 yaz_oi_APDU(a, &oi);
1191 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1195 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1200 Z_OtherInformation **oi;
1201 yaz_oi_APDU(a, &oi);
1202 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1206 Z_OtherInformation **oi;
1207 yaz_oi_APDU(a, &oi);
1208 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1210 otherInfo_attach(c, a, out);
1211 if (!z_APDU(out, &a, 0, 0))
1213 FILE *outf = fopen("/tmp/apdu.txt", "a");
1216 ODR odr_pr = odr_createmem(ODR_PRINT);
1217 fprintf(outf, "a=%p\n", a);
1218 odr_setprint(odr_pr, outf);
1219 z_APDU(odr_pr, &a, 0, 0);
1220 odr_destroy(odr_pr);
1222 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1223 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1227 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1231 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1235 if (encode_APDU(c, a, c->odr_out))
1236 return zoom_complete;
1237 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1238 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1239 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1240 ZOOM_connection_put_event(c, event);
1241 odr_reset(c->odr_out);
1245 /* returns 1 if PDU was sent OK (still pending )
1246 0 if PDU was not sent OK (nothing to wait for)
1249 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1251 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1252 Z_InitRequest *ireq = apdu->u.initRequest;
1253 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1254 odr_malloc(c->odr_out, sizeof(*auth));
1255 const char *auth_groupId = ZOOM_options_get(c->options, "group");
1256 const char *auth_userId = ZOOM_options_get(c->options, "user");
1257 const char *auth_password = ZOOM_options_get(c->options, "password");
1260 /* support the pass for backwards compatibility */
1262 auth_password = ZOOM_options_get(c->options, "pass");
1264 ODR_MASK_SET(ireq->options, Z_Options_search);
1265 ODR_MASK_SET(ireq->options, Z_Options_present);
1266 ODR_MASK_SET(ireq->options, Z_Options_scan);
1267 ODR_MASK_SET(ireq->options, Z_Options_sort);
1268 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1269 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1271 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1272 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1273 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1275 /* Index Data's Z39.50 Implementor Id is 81 */
1276 ireq->implementationId =
1277 odr_prepend(c->odr_out,
1278 ZOOM_options_get(c->options, "implementationId"),
1279 odr_prepend(c->odr_out, "81", ireq->implementationId));
1281 ireq->implementationName =
1282 odr_prepend(c->odr_out,
1283 ZOOM_options_get(c->options, "implementationName"),
1284 odr_prepend(c->odr_out, "ZOOM-C",
1285 ireq->implementationName));
1287 version = odr_strdup(c->odr_out, "$Revision: 1.118 $");
1288 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1289 version[strlen(version)-2] = '\0';
1290 ireq->implementationVersion =
1291 odr_prepend(c->odr_out,
1292 ZOOM_options_get(c->options, "implementationVersion"),
1293 odr_prepend(c->odr_out, &version[11],
1294 ireq->implementationVersion));
1296 *ireq->maximumRecordSize =
1297 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
1298 *ireq->preferredMessageSize =
1299 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
1301 if (auth_groupId || auth_password)
1303 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1306 if (auth_groupId && *auth_groupId)
1308 pass->groupId = (char *)
1309 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1310 strcpy(pass->groupId, auth_groupId);
1314 if (auth_userId && *auth_userId)
1316 pass->userId = (char *)
1317 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1318 strcpy(pass->userId, auth_userId);
1322 if (auth_password && *auth_password)
1324 pass->password = (char *)
1325 odr_malloc(c->odr_out, strlen(auth_password)+1);
1326 strcpy(pass->password, auth_password);
1331 auth->which = Z_IdAuthentication_idPass;
1332 auth->u.idPass = pass;
1333 ireq->idAuthentication = auth;
1336 else if (auth_userId)
1338 auth->which = Z_IdAuthentication_open;
1339 auth->u.open = (char *)
1340 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1341 strcpy(auth->u.open, auth_userId);
1342 ireq->idAuthentication = auth;
1345 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1346 VAL_PROXY, 1, c->host_port);
1347 if (c->charset || c->lang)
1349 Z_OtherInformation **oi;
1350 Z_OtherInformationUnit *oi_unit;
1352 yaz_oi_APDU(apdu, &oi);
1354 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1356 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1357 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1358 oi_unit->information.externallyDefinedInfo =
1359 yaz_set_proposal_charneg_list(c->odr_out, " ",
1360 c->charset, c->lang, 1);
1364 return send_APDU(c, apdu);
1368 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1373 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1375 if (c->sru_mode == zoom_sru_get)
1377 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1379 else if (c->sru_mode == zoom_sru_post)
1381 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1383 else if (c->sru_mode == zoom_sru_soap)
1385 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1387 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1388 return zoom_complete;
1389 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1391 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1392 ZOOM_connection_put_event(c, event);
1393 odr_reset(c->odr_out);
1399 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1403 ZOOM_resultset resultset = 0;
1405 const char *option_val = 0;
1407 if (c->error) /* don't continue on error */
1408 return zoom_complete;
1410 switch(c->tasks->which)
1412 case ZOOM_TASK_SEARCH:
1413 resultset = c->tasks->u.search.resultset;
1414 resultset->setname = xstrdup("default");
1415 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1416 start = &c->tasks->u.search.start;
1417 count = &c->tasks->u.search.count;
1419 case ZOOM_TASK_RETRIEVE:
1420 resultset = c->tasks->u.retrieve.resultset;
1422 start = &c->tasks->u.retrieve.start;
1423 count = &c->tasks->u.retrieve.count;
1425 if (*start >= resultset->size)
1426 return zoom_complete;
1427 if (*start + *count > resultset->size)
1428 *count = resultset->size - *start;
1430 for (i = 0; i < *count; i++)
1433 record_cache_lookup(resultset, i + *start,
1434 c->tasks->u.retrieve.syntax,
1435 c->tasks->u.retrieve.elementSetName);
1440 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1441 ZOOM_connection_put_event(c, event);
1448 return zoom_complete;
1451 return zoom_complete;
1453 assert(resultset->query);
1455 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1457 if (resultset->query->z_query->which == Z_Query_type_104
1458 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1460 sr->u.request->query_type = Z_SRW_query_type_cql;
1461 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1463 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1464 resultset->query->z_query->u.type_1)
1466 sr->u.request->query_type = Z_SRW_query_type_pqf;
1467 sr->u.request->query.pqf = resultset->query->query_string;
1471 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1472 return zoom_complete;
1474 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1475 sr->u.request->maximumRecords = odr_intdup(
1476 c->odr_out, resultset->step>0 ? resultset->step : *count);
1477 sr->u.request->recordSchema = resultset->schema;
1479 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1481 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1483 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1485 sr->extra_args = odr_strdup(c->odr_out, option_val);
1486 return send_srw(c, sr);
1489 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1491 return zoom_complete;
1495 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1498 int lslb, ssub, mspn;
1500 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1501 Z_SearchRequest *search_req = apdu->u.searchRequest;
1502 const char *elementSetName;
1503 const char *smallSetElementSetName;
1504 const char *mediumSetElementSetName;
1507 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1509 r = c->tasks->u.search.resultset;
1511 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1514 ZOOM_options_get(r->options, "elementSetName");
1515 smallSetElementSetName =
1516 ZOOM_options_get(r->options, "smallSetElementSetName");
1517 mediumSetElementSetName =
1518 ZOOM_options_get(r->options, "mediumSetElementSetName");
1520 if (!smallSetElementSetName)
1521 smallSetElementSetName = elementSetName;
1523 if (!mediumSetElementSetName)
1524 mediumSetElementSetName = elementSetName;
1529 /* prepare query for the search request */
1530 search_req->query = r->query->z_query;
1531 if (!search_req->query)
1533 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1534 return zoom_complete;
1537 search_req->databaseNames = r->databaseNames;
1538 search_req->num_databaseNames = r->num_databaseNames;
1540 /* get syntax (no need to provide unless piggyback is in effect) */
1541 syntax = c->tasks->u.search.syntax;
1543 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1544 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1545 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1546 if (lslb != -1 && ssub != -1 && mspn != -1)
1548 /* So're a Z39.50 expert? Let's hope you don't do sort */
1549 *search_req->largeSetLowerBound = lslb;
1550 *search_req->smallSetUpperBound = ssub;
1551 *search_req->mediumSetPresentNumber = mspn;
1553 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1554 && r->piggyback && !r->r_sort_spec && !r->schema)
1556 /* Regular piggyback - do it unless we're going to do sort */
1557 *search_req->largeSetLowerBound = 2000000000;
1558 *search_req->smallSetUpperBound = 1;
1559 *search_req->mediumSetPresentNumber =
1560 r->step>0 ? r->step : c->tasks->u.search.count;
1564 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1565 smallSetElementSetName = 0;
1566 mediumSetElementSetName = 0;
1569 if (smallSetElementSetName && *smallSetElementSetName)
1571 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1572 odr_malloc(c->odr_out, sizeof(*esn));
1574 esn->which = Z_ElementSetNames_generic;
1575 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1576 search_req->smallSetElementSetNames = esn;
1578 if (mediumSetElementSetName && *mediumSetElementSetName)
1580 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1581 odr_malloc(c->odr_out, sizeof(*esn));
1583 esn->which = Z_ElementSetNames_generic;
1584 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1585 search_req->mediumSetElementSetNames = esn;
1588 search_req->preferredRecordSyntax =
1589 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1593 if (c->support_named_resultsets)
1597 /* find the lowest unused ordinal so that we re-use
1598 result sets on the server. */
1599 for (ord = 1; ; ord++)
1602 sprintf(setname, "%d", ord);
1603 for (rp = c->resultsets; rp; rp = rp->next)
1604 if (rp->setname && !strcmp(rp->setname, setname))
1609 r->setname = xstrdup(setname);
1610 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1611 "set %s", c, r->setname);
1615 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1617 r->setname = xstrdup("default");
1619 ZOOM_options_set(r->options, "setname", r->setname);
1621 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1622 return send_APDU(c, apdu);
1625 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1632 case Z_DefaultDiagFormat_v2Addinfo:
1633 addinfo = r->u.v2Addinfo;
1635 case Z_DefaultDiagFormat_v3Addinfo:
1636 addinfo = r->u.v3Addinfo;
1641 set_dset_error(c, *r->condition,
1642 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1646 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1648 if (p->which != Z_DiagRec_defaultFormat)
1649 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1651 response_default_diag(c, p->u.defaultFormat);
1654 ZOOM_API(ZOOM_record)
1655 ZOOM_record_clone(ZOOM_record srec)
1662 odr_enc = odr_createmem(ODR_ENCODE);
1663 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1665 buf = odr_getbuf(odr_enc, &size, 0);
1667 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1668 nrec->odr = odr_createmem(ODR_DECODE);
1669 nrec->wrbuf_marc = 0;
1670 nrec->wrbuf_iconv = 0;
1671 nrec->wrbuf_opac = 0;
1672 odr_setbuf(nrec->odr, buf, size, 0);
1673 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1675 odr_destroy(odr_enc);
1679 ZOOM_API(ZOOM_record)
1680 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1682 const char *syntax =
1683 ZOOM_options_get(s->options, "preferredRecordSyntax");
1684 const char *elementSetName =
1685 ZOOM_options_get(s->options, "elementSetName");
1687 return record_cache_lookup(s, pos, syntax, elementSetName);
1690 ZOOM_API(ZOOM_record)
1691 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1693 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1698 * MIKE: I think force_sync should always be zero, but I don't
1699 * want to make this change until I get the go-ahead from
1700 * Adam, in case something depends on the old synchronous
1704 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1705 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1706 rec = ZOOM_resultset_record_immediate(r, pos);
1712 ZOOM_record_destroy(ZOOM_record rec)
1716 if (rec->wrbuf_marc)
1717 wrbuf_destroy(rec->wrbuf_marc);
1718 if (rec->wrbuf_iconv)
1719 wrbuf_destroy(rec->wrbuf_iconv);
1720 if (rec->wrbuf_opac)
1721 wrbuf_destroy(rec->wrbuf_opac);
1722 odr_destroy(rec->odr);
1726 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1728 const char *buf, int sz,
1729 const char *record_charset)
1734 yaz_marc_t mt = yaz_marc_create();
1737 strcpy(to, "UTF-8");
1738 if (record_charset && *record_charset)
1740 /* Use "from,to" or just "from" */
1741 const char *cp = strchr(record_charset, ',');
1742 int clen = strlen(record_charset);
1745 strncpy( to, cp+1, sizeof(to)-1);
1746 to[sizeof(to)-1] = '\0';
1747 clen = cp - record_charset;
1749 if (clen > sizeof(from)-1)
1750 clen = sizeof(from)-1;
1753 strncpy(from, record_charset, clen);
1759 cd = yaz_iconv_open(to, from);
1760 yaz_marc_iconv(mt, cd);
1763 yaz_marc_xml(mt, marc_type);
1764 if (!rec->wrbuf_marc)
1765 rec->wrbuf_marc = wrbuf_alloc();
1766 wrbuf_rewind(rec->wrbuf_marc);
1767 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1769 yaz_marc_destroy(mt);
1771 yaz_iconv_close(cd);
1773 *len = wrbuf_len(rec->wrbuf_marc);
1774 return wrbuf_cstr(rec->wrbuf_marc);
1776 yaz_marc_destroy(mt);
1778 yaz_iconv_close(cd);
1782 static const char *record_iconv_return(ZOOM_record rec, int *len,
1783 const char *buf, int sz,
1784 const char *record_charset)
1791 strcpy(to, "UTF-8");
1792 if (record_charset && *record_charset)
1794 /* Use "from,to" or just "from" */
1795 const char *cp = strchr(record_charset, ',');
1796 int clen = strlen(record_charset);
1799 strncpy( to, cp+1, sizeof(to)-1);
1800 to[sizeof(to)-1] = '\0';
1801 clen = cp - record_charset;
1803 if (clen > sizeof(from)-1)
1804 clen = sizeof(from)-1;
1807 strncpy(from, record_charset, clen);
1811 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1814 size_t inbytesleft = sz;
1815 const char *inp = buf;
1817 if (!rec->wrbuf_iconv)
1818 rec->wrbuf_iconv = wrbuf_alloc();
1820 wrbuf_rewind(rec->wrbuf_iconv);
1824 size_t outbytesleft = sizeof(outbuf);
1825 char *outp = outbuf;
1826 size_t r = yaz_iconv(cd, (char**) &inp,
1828 &outp, &outbytesleft);
1829 if (r == (size_t) (-1))
1831 int e = yaz_iconv_error(cd);
1832 if (e != YAZ_ICONV_E2BIG)
1835 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1837 buf = wrbuf_cstr(rec->wrbuf_iconv);
1838 sz = wrbuf_len(rec->wrbuf_iconv);
1839 yaz_iconv_close(cd);
1847 ZOOM_record_error(ZOOM_record rec, const char **cp,
1848 const char **addinfo, const char **diagset)
1850 Z_NamePlusRecord *npr;
1855 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1857 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1858 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1859 const char *add = 0;
1861 if (diag_rec->which == Z_DiagRec_defaultFormat)
1863 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1866 error = *ddf->condition;
1869 case Z_DefaultDiagFormat_v2Addinfo:
1870 add = ddf->u.v2Addinfo;
1872 case Z_DefaultDiagFormat_v3Addinfo:
1873 add = ddf->u.v3Addinfo;
1877 *diagset = yaz_z3950oid_to_str(ddf->diagnosticSetId, &oclass);
1885 *addinfo = add ? add : "";
1887 *cp = diagbib1_str(error);
1893 ZOOM_API(const char *)
1894 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1901 Z_NamePlusRecord *npr;
1904 *len = 0; /* default return */
1913 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1915 if (cp[i] == ';' || cp[i] == ' ')
1921 while (type_spec[i] == ';')
1924 while (type_spec[i] == ' ')
1926 if (!strncmp(type_spec+i, "charset=", 8))
1929 i = i + 8; /* skip charset= */
1930 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1932 if (type_spec[i] == ';' || type_spec[i] == ' ')
1938 else if (!strncmp(type_spec+i, "xpath=", 6))
1942 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1946 while (type_spec[i] == ' ')
1949 if (!strcmp(type, "database"))
1952 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1953 return npr->databaseName;
1955 else if (!strcmp(type, "syntax"))
1957 const char *desc = 0;
1958 if (npr->which == Z_NamePlusRecord_databaseRecord)
1960 Z_External *r = (Z_External *) npr->u.databaseRecord;
1961 oident *ent = oid_getentbyoid(r->direct_reference);
1968 *len = strlen(desc);
1971 if (npr->which != Z_NamePlusRecord_databaseRecord)
1974 /* from now on - we have a database record .. */
1975 if (!strcmp(type, "render"))
1977 Z_External *r = (Z_External *) npr->u.databaseRecord;
1978 oident *ent = oid_getentbyoid(r->direct_reference);
1980 /* render bibliographic record .. */
1981 if (r->which == Z_External_OPAC)
1983 r = r->u.opac->bibliographicRecord;
1986 ent = oid_getentbyoid(r->direct_reference);
1988 if (r->which == Z_External_sutrs)
1989 return record_iconv_return(rec, len,
1990 (char*) r->u.sutrs->buf,
1993 else if (r->which == Z_External_octet)
1995 const char *ret_buf;
2003 case VAL_APPLICATION_XML:
2006 ret_buf = marc_iconv_return(
2007 rec, YAZ_MARC_LINE, len,
2008 (const char *) r->u.octet_aligned->buf,
2009 r->u.octet_aligned->len,
2014 return record_iconv_return(rec, len,
2015 (const char *) r->u.octet_aligned->buf,
2016 r->u.octet_aligned->len,
2019 else if (r->which == Z_External_grs1)
2021 if (!rec->wrbuf_marc)
2022 rec->wrbuf_marc = wrbuf_alloc();
2023 wrbuf_rewind(rec->wrbuf_marc);
2024 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
2025 return record_iconv_return(rec, len,
2026 wrbuf_buf(rec->wrbuf_marc),
2027 wrbuf_len(rec->wrbuf_marc),
2032 else if (!strcmp(type, "xml"))
2034 Z_External *r = (Z_External *) npr->u.databaseRecord;
2035 oident *ent = oid_getentbyoid(r->direct_reference);
2037 /* render bibliographic record .. */
2038 if (r->which == Z_External_OPAC)
2040 r = r->u.opac->bibliographicRecord;
2043 ent = oid_getentbyoid(r->direct_reference);
2046 if (r->which == Z_External_sutrs)
2047 return record_iconv_return(rec, len,
2048 (const char *) r->u.sutrs->buf,
2051 else if (r->which == Z_External_octet)
2053 const char *ret_buf;
2054 int marc_decode_type = YAZ_MARC_MARCXML;
2063 case VAL_APPLICATION_XML:
2066 ret_buf = marc_iconv_return(
2067 rec, marc_decode_type, len,
2068 (const char *) r->u.octet_aligned->buf,
2069 r->u.octet_aligned->len,
2074 return record_iconv_return(rec, len,
2075 (const char *) r->u.octet_aligned->buf,
2076 r->u.octet_aligned->len,
2079 else if (r->which == Z_External_grs1)
2086 else if (!strcmp(type, "raw"))
2088 Z_External *r = (Z_External *) npr->u.databaseRecord;
2090 if (r->which == Z_External_sutrs)
2092 if (len) *len = r->u.sutrs->len;
2093 return (const char *) r->u.sutrs->buf;
2095 else if (r->which == Z_External_octet)
2097 if (len) *len = r->u.octet_aligned->len;
2098 return (const char *) r->u.octet_aligned->buf;
2100 else /* grs-1, explain, OPAC, ... */
2103 return (const char *) npr->u.databaseRecord;
2107 else if (!strcmp (type, "ext"))
2110 return (const char *) npr->u.databaseRecord;
2112 else if (!strcmp (type, "opac"))
2115 Z_External *r = (Z_External *) npr->u.databaseRecord;
2116 if (r->which == Z_External_OPAC)
2118 if (!rec->wrbuf_opac)
2119 rec->wrbuf_opac = wrbuf_alloc();
2120 wrbuf_rewind(rec->wrbuf_opac);
2121 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2122 return record_iconv_return(rec, len,
2123 wrbuf_buf(rec->wrbuf_opac),
2124 wrbuf_len(rec->wrbuf_opac),
2131 static int strcmp_null(const char *v1, const char *v2)
2137 return strcmp(v1, v2);
2140 static size_t record_hash(int pos)
2144 return pos % RECORD_HASH_SIZE;
2147 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2149 const char *syntax, const char *elementSetName)
2151 ZOOM_record_cache rc;
2153 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2154 ZOOM_connection_put_event(r->connection, event);
2156 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2160 if (strcmp_null(r->schema, rc->schema))
2162 if (strcmp_null(elementSetName,rc->elementSetName))
2164 if (strcmp_null(syntax, rc->syntax))
2166 /* not destroying rc->npr (it's handled by nmem )*/
2168 /* keeping wrbuf_marc too */
2172 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2175 rc->rec.wrbuf_marc = 0;
2176 rc->rec.wrbuf_iconv = 0;
2177 rc->rec.wrbuf_opac = 0;
2179 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2181 rc->elementSetName = 0;
2184 rc->syntax = odr_strdup(r->odr, syntax);
2189 rc->schema = odr_strdup(r->odr, r->schema);
2194 rc->next = r->record_hash[record_hash(pos)];
2195 r->record_hash[record_hash(pos)] = rc;
2198 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2200 const char *elementSetName)
2202 ZOOM_record_cache rc;
2204 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2208 if (strcmp_null(r->schema, rc->schema))
2210 if (strcmp_null(elementSetName,rc->elementSetName))
2212 if (strcmp_null(syntax, rc->syntax))
2220 static void handle_records(ZOOM_connection c, Z_Records *sr,
2223 ZOOM_resultset resultset;
2225 const char *syntax = 0, *elementSetName = 0;
2229 switch (c->tasks->which)
2231 case ZOOM_TASK_SEARCH:
2232 resultset = c->tasks->u.search.resultset;
2233 start = &c->tasks->u.search.start;
2234 count = &c->tasks->u.search.count;
2235 syntax = c->tasks->u.search.syntax;
2236 elementSetName = c->tasks->u.search.elementSetName;
2238 case ZOOM_TASK_RETRIEVE:
2239 resultset = c->tasks->u.retrieve.resultset;
2240 start = &c->tasks->u.retrieve.start;
2241 count = &c->tasks->u.retrieve.count;
2242 syntax = c->tasks->u.retrieve.syntax;
2243 elementSetName = c->tasks->u.retrieve.elementSetName;
2248 if (sr && sr->which == Z_Records_NSD)
2249 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2250 else if (sr && sr->which == Z_Records_multipleNSD)
2252 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2253 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2255 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2259 if (*count + *start > resultset->size)
2260 *count = resultset->size - *start;
2263 if (sr && sr->which == Z_Records_DBOSD)
2266 NMEM nmem = odr_extract_mem(c->odr_in);
2267 Z_NamePlusRecordList *p =
2268 sr->u.databaseOrSurDiagnostics;
2269 for (i = 0; i<p->num_records; i++)
2271 record_cache_add(resultset, p->records[i], i + *start,
2272 syntax, elementSetName);
2278 yaz_log(log_details,
2279 "handle_records resultset=%p start=%d count=%d",
2280 resultset, *start, *count);
2282 /* transfer our response to search_nmem .. we need it later */
2283 nmem_transfer(resultset->odr->mem, nmem);
2285 if (present_phase && p->num_records == 0)
2287 /* present response and we didn't get any records! */
2288 Z_NamePlusRecord *myrec =
2289 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2290 record_cache_add(resultset, myrec, *start,
2291 syntax, elementSetName);
2294 else if (present_phase)
2296 /* present response and we didn't get any records! */
2297 Z_NamePlusRecord *myrec =
2298 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2299 record_cache_add(resultset, myrec, *start, syntax, elementSetName);
2304 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2306 handle_records(c, pr->records, 1);
2309 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2312 switch (term->which)
2314 case Z_Term_general:
2315 ZOOM_options_setl(opt, name,
2316 (const char *)(term->u.general->buf),
2317 term->u.general->len);
2319 case Z_Term_characterString:
2320 ZOOM_options_set(opt, name, term->u.characterString);
2322 case Z_Term_numeric:
2323 ZOOM_options_set_int(opt, name, *term->u.numeric);
2328 static void handle_queryExpression(ZOOM_options opt, const char *name,
2329 Z_QueryExpression *exp)
2335 case Z_QueryExpression_term:
2336 if (exp->u.term && exp->u.term->queryTerm)
2338 sprintf(opt_name, "%s.term", name);
2339 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2342 case Z_QueryExpression_query:
2347 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2348 Z_OtherInformation *o)
2351 for (i = 0; o && i < o->num_elements; i++)
2353 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2355 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2357 if (ext->which == Z_External_searchResult1)
2360 Z_SearchInfoReport *sr = ext->u.searchResult1;
2363 ZOOM_options_set_int(
2364 resultset->options, "searchresult.size", sr->num);
2366 for (j = 0; j < sr->num; j++)
2368 Z_SearchInfoReport_s *ent =
2369 ext->u.searchResult1->elements[j];
2372 sprintf(pref, "searchresult.%d", j);
2374 if (ent->subqueryId)
2377 sprintf(opt_name, "%s.id", pref);
2378 ZOOM_options_set(resultset->options, opt_name,
2381 if (ent->subqueryExpression)
2384 sprintf(opt_name, "%s.subquery", pref);
2385 handle_queryExpression(resultset->options, opt_name,
2386 ent->subqueryExpression);
2388 if (ent->subqueryInterpretation)
2391 sprintf(opt_name, "%s.interpretation", pref);
2392 handle_queryExpression(resultset->options, opt_name,
2393 ent->subqueryInterpretation);
2395 if (ent->subqueryRecommendation)
2398 sprintf(opt_name, "%s.recommendation", pref);
2399 handle_queryExpression(resultset->options, opt_name,
2400 ent->subqueryRecommendation);
2402 if (ent->subqueryCount)
2405 sprintf(opt_name, "%s.count", pref);
2406 ZOOM_options_set_int(resultset->options, opt_name,
2407 *ent->subqueryCount);
2415 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2417 ZOOM_resultset resultset;
2420 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2423 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2424 ZOOM_connection_put_event(c, event);
2426 resultset = c->tasks->u.search.resultset;
2428 if (sr->resultSetStatus)
2430 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2431 *sr->resultSetStatus);
2433 if (sr->presentStatus)
2435 ZOOM_options_set_int(resultset->options, "presentStatus",
2436 *sr->presentStatus);
2438 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2440 resultset->size = *sr->resultCount;
2441 handle_records(c, sr->records, 0);
2444 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2446 if (res->diagnostics && res->num_diagnostics > 0)
2447 response_diag(c, res->diagnostics[0]);
2450 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2452 NMEM nmem = odr_extract_mem(c->odr_in);
2455 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2457 scan = c->tasks->u.scan.scan;
2459 if (res->entries && res->entries->nonsurrogateDiagnostics)
2460 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2461 scan->scan_response = res;
2462 nmem_transfer(scan->odr->mem, nmem);
2464 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2465 if (res->positionOfTerm)
2466 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2467 if (res->scanStatus)
2468 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2469 if (res->numberOfEntriesReturned)
2470 ZOOM_options_set_int(scan->options, "number",
2471 *res->numberOfEntriesReturned);
2476 static zoom_ret send_sort(ZOOM_connection c,
2477 ZOOM_resultset resultset)
2480 resultset->r_sort_spec = 0;
2481 if (resultset->r_sort_spec)
2483 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2484 Z_SortRequest *req = apdu->u.sortRequest;
2486 req->num_inputResultSetNames = 1;
2487 req->inputResultSetNames = (Z_InternationalString **)
2488 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2489 req->inputResultSetNames[0] =
2490 odr_strdup(c->odr_out, resultset->setname);
2491 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2492 req->sortSequence = resultset->r_sort_spec;
2493 resultset->r_sort_spec = 0;
2494 return send_APDU(c, apdu);
2496 return zoom_complete;
2499 static zoom_ret send_present(ZOOM_connection c)
2502 Z_PresentRequest *req = 0;
2504 const char *syntax = 0;
2505 const char *elementSetName = 0;
2506 ZOOM_resultset resultset;
2511 yaz_log(log_details, "%p send_present no tasks", c);
2512 return zoom_complete;
2515 switch (c->tasks->which)
2517 case ZOOM_TASK_SEARCH:
2518 resultset = c->tasks->u.search.resultset;
2519 start = &c->tasks->u.search.start;
2520 count = &c->tasks->u.search.count;
2521 syntax = c->tasks->u.search.syntax;
2522 elementSetName = c->tasks->u.search.elementSetName;
2524 case ZOOM_TASK_RETRIEVE:
2525 resultset = c->tasks->u.retrieve.resultset;
2526 start = &c->tasks->u.retrieve.start;
2527 count = &c->tasks->u.retrieve.count;
2528 syntax = c->tasks->u.retrieve.syntax;
2529 elementSetName = c->tasks->u.retrieve.elementSetName;
2532 return zoom_complete;
2534 yaz_log(log_details, "%p send_present start=%d count=%d",
2537 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2539 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2542 if (c->error) /* don't continue on error */
2543 return zoom_complete;
2544 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2545 resultset, *start, *count);
2547 for (i = 0; i < *count; i++)
2550 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2555 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2556 ZOOM_connection_put_event(c, event);
2564 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2565 return zoom_complete;
2568 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2569 req = apdu->u.presentRequest;
2572 yaz_log(log_details, "%p send_present skip=%d", c, i);
2574 *req->resultSetStartPoint = *start + 1;
2575 *req->numberOfRecordsRequested = resultset->step>0 ?
2576 resultset->step : *count;
2577 if (*req->numberOfRecordsRequested + *start > resultset->size)
2578 *req->numberOfRecordsRequested = resultset->size - *start;
2579 assert(*req->numberOfRecordsRequested > 0);
2581 if (syntax && *syntax)
2582 req->preferredRecordSyntax =
2583 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2585 if (resultset->schema && *resultset->schema)
2587 Z_RecordComposition *compo = (Z_RecordComposition *)
2588 odr_malloc(c->odr_out, sizeof(*compo));
2590 req->recordComposition = compo;
2591 compo->which = Z_RecordComp_complex;
2592 compo->u.complex = (Z_CompSpec *)
2593 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2594 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2595 odr_malloc(c->odr_out, sizeof(bool_t));
2596 *compo->u.complex->selectAlternativeSyntax = 0;
2598 compo->u.complex->generic = (Z_Specification *)
2599 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2601 compo->u.complex->generic->which = Z_Schema_oid;
2602 compo->u.complex->generic->schema.oid = (Odr_oid *)
2603 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2605 if (!compo->u.complex->generic->schema.oid)
2607 /* OID wasn't a schema! Try record syntax instead. */
2609 compo->u.complex->generic->schema.oid = (Odr_oid *)
2610 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2612 if (elementSetName && *elementSetName)
2614 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2615 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2616 compo->u.complex->generic->elementSpec->which =
2617 Z_ElementSpec_elementSetName;
2618 compo->u.complex->generic->elementSpec->u.elementSetName =
2619 odr_strdup(c->odr_out, elementSetName);
2622 compo->u.complex->generic->elementSpec = 0;
2623 compo->u.complex->num_dbSpecific = 0;
2624 compo->u.complex->dbSpecific = 0;
2625 compo->u.complex->num_recordSyntax = 0;
2626 compo->u.complex->recordSyntax = 0;
2628 else if (elementSetName && *elementSetName)
2630 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2631 odr_malloc(c->odr_out, sizeof(*esn));
2632 Z_RecordComposition *compo = (Z_RecordComposition *)
2633 odr_malloc(c->odr_out, sizeof(*compo));
2635 esn->which = Z_ElementSetNames_generic;
2636 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2637 compo->which = Z_RecordComp_simple;
2638 compo->u.simple = esn;
2639 req->recordComposition = compo;
2641 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2642 return send_APDU(c, apdu);
2645 ZOOM_API(ZOOM_scanset)
2646 ZOOM_connection_scan_pqf(ZOOM_connection c, const char *start)
2649 ZOOM_query q = ZOOM_query_create();
2651 ZOOM_query_prefix(q, start);
2653 s = ZOOM_connection_scan(c, q);
2654 ZOOM_query_destroy(q);
2659 ZOOM_API(ZOOM_scanset)
2660 ZOOM_connection_scan(ZOOM_connection c, ZOOM_query q)
2664 ZOOM_scanset scan = 0;
2667 * We need to check the query-type, so we can recognise CQL and
2668 * CCL and compile them into a form that we can use here. The
2669 * ZOOM_query structure has no explicit `type' member, but
2670 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2671 * functions shows how the structure is set up in each case.
2675 else if (q->z_query->which == Z_Query_type_1)
2677 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2678 c, q, q->query_string);
2679 start = q->query_string;
2681 else if (q->z_query->which == Z_Query_type_104)
2683 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2684 c, q, q->query_string);
2685 start = freeme = cql2pqf(c, q->query_string);
2691 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2692 c, q, q->query_string);
2696 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2697 scan->connection = c;
2698 scan->odr = odr_createmem(ODR_DECODE);
2699 scan->options = ZOOM_options_create_with_parent(c->options);
2701 scan->scan_response = 0;
2702 scan->termListAndStartPoint =
2703 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2706 scan->databaseNames = set_DatabaseNames(c, c->options,
2707 &scan->num_databaseNames,
2709 if (scan->termListAndStartPoint != 0)
2711 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2712 task->u.scan.scan = scan;
2717 while (ZOOM_event(1, &c))
2725 ZOOM_scanset_destroy(ZOOM_scanset scan)
2730 if (scan->refcount == 0)
2732 odr_destroy(scan->odr);
2734 ZOOM_options_destroy(scan->options);
2739 static zoom_ret send_package(ZOOM_connection c)
2743 yaz_log(log_details, "%p send_package", c);
2745 return zoom_complete;
2746 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2748 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2749 ZOOM_connection_put_event(c, event);
2751 c->buf_out = c->tasks->u.package->buf_out;
2752 c->len_out = c->tasks->u.package->len_out;
2757 static zoom_ret send_scan(ZOOM_connection c)
2760 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2761 Z_ScanRequest *req = apdu->u.scanRequest;
2763 yaz_log(log_details, "%p send_scan", c);
2765 return zoom_complete;
2766 assert (c->tasks->which == ZOOM_TASK_SCAN);
2767 scan = c->tasks->u.scan.scan;
2769 req->termListAndStartPoint = scan->termListAndStartPoint;
2770 req->attributeSet = scan->attributeSet;
2772 *req->numberOfTermsRequested =
2773 ZOOM_options_get_int(scan->options, "number", 10);
2775 req->preferredPositionInResponse =
2776 odr_intdup(c->odr_out,
2777 ZOOM_options_get_int(scan->options, "position", 1));
2780 odr_intdup(c->odr_out,
2781 ZOOM_options_get_int(scan->options, "stepSize", 0));
2783 req->databaseNames = scan->databaseNames;
2784 req->num_databaseNames = scan->num_databaseNames;
2786 return send_APDU(c, apdu);
2790 ZOOM_scanset_size(ZOOM_scanset scan)
2792 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2794 return scan->scan_response->entries->num_entries;
2797 ZOOM_API(const char *)
2798 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2801 const char *term = 0;
2802 size_t noent = ZOOM_scanset_size(scan);
2803 Z_ScanResponse *res = scan->scan_response;
2809 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2811 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2813 if (t->term->which == Z_Term_general)
2815 term = (const char *) t->term->u.general->buf;
2816 *len = t->term->u.general->len;
2818 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2823 ZOOM_API(const char *)
2824 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2827 const char *term = 0;
2828 size_t noent = ZOOM_scanset_size(scan);
2829 Z_ScanResponse *res = scan->scan_response;
2835 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2837 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2841 term = t->displayTerm;
2842 *len = strlen(term);
2844 else if (t->term->which == Z_Term_general)
2846 term = (const char *) t->term->u.general->buf;
2847 *len = t->term->u.general->len;
2849 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2854 ZOOM_API(const char *)
2855 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2857 return ZOOM_options_get(scan->options, key);
2861 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2864 ZOOM_options_set(scan->options, key, val);
2868 static Z_APDU *create_es_package(ZOOM_package p, int type)
2871 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2872 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2874 *req->function = Z_ExtendedServicesRequest_create;
2876 str = ZOOM_options_get(p->options, "package-name");
2878 req->packageName = nmem_strdup(p->odr_out->mem, str);
2880 str = ZOOM_options_get(p->options, "user-id");
2882 req->userId = nmem_strdup(p->odr_out->mem, str);
2884 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2887 str = ZOOM_options_get(p->options, "function");
2890 if (!strcmp (str, "create"))
2892 if (!strcmp (str, "delete"))
2894 if (!strcmp (str, "modify"))
2900 static const char *ill_array_lookup(void *clientData, const char *idx)
2902 ZOOM_package p = (ZOOM_package) clientData;
2903 return ZOOM_options_get(p->options, idx+4);
2906 static Z_External *encode_ill_request(ZOOM_package p)
2908 ODR out = p->odr_out;
2911 struct ill_get_ctl ctl;
2913 ctl.odr = p->odr_out;
2915 ctl.f = ill_array_lookup;
2917 req = ill_get_ILLRequest(&ctl, "ill", 0);
2919 if (!ill_Request(out, &req, 0, 0))
2921 int ill_request_size;
2922 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2923 if (ill_request_buf)
2924 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2930 int illRequest_size = 0;
2931 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2933 oid.proto = PROTO_GENERAL;
2934 oid.oclass = CLASS_GENERAL;
2935 oid.value = VAL_ISO_ILL_1;
2937 r = (Z_External *) odr_malloc(out, sizeof(*r));
2938 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2939 r->indirect_reference = 0;
2941 r->which = Z_External_single;
2943 r->u.single_ASN1_type =
2944 odr_create_Odr_oct(out,
2945 (unsigned char *)illRequest_buf,
2951 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2953 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2956 req->which = Z_IOItemOrder_esRequest;
2957 req->u.esRequest = (Z_IORequest *)
2958 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2960 /* to keep part ... */
2961 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2962 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2963 req->u.esRequest->toKeep->supplDescription = 0;
2964 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2965 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2967 str = ZOOM_options_get(p->options, "contact-name");
2968 req->u.esRequest->toKeep->contact->name = str ?
2969 nmem_strdup(p->odr_out->mem, str) : 0;
2971 str = ZOOM_options_get(p->options, "contact-phone");
2972 req->u.esRequest->toKeep->contact->phone = str ?
2973 nmem_strdup(p->odr_out->mem, str) : 0;
2975 str = ZOOM_options_get(p->options, "contact-email");
2976 req->u.esRequest->toKeep->contact->email = str ?
2977 nmem_strdup(p->odr_out->mem, str) : 0;
2979 req->u.esRequest->toKeep->addlBilling = 0;
2981 /* not to keep part ... */
2982 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2983 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2985 str = ZOOM_options_get(p->options, "itemorder-setname");
2990 req->u.esRequest->notToKeep->resultSetItem = 0;
2993 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2994 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2996 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2997 nmem_strdup(p->odr_out->mem, str);
2998 req->u.esRequest->notToKeep->resultSetItem->item =
2999 (int *) odr_malloc(p->odr_out, sizeof(int));
3001 str = ZOOM_options_get(p->options, "itemorder-item");
3002 *req->u.esRequest->notToKeep->resultSetItem->item =
3003 (str ? atoi(str) : 1);
3006 str = ZOOM_options_get(p->options, "doc");
3008 req->u.esRequest->notToKeep->itemRequest =
3009 z_ext_record(p->odr_out, VAL_TEXT_XML, str, strlen(str));
3011 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3016 Z_APDU *create_admin_package(ZOOM_package p, int type,
3017 Z_ESAdminOriginPartToKeep **toKeepP,
3018 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3020 Z_APDU *apdu = create_es_package(p, VAL_ADMINSERVICE);
3023 Z_ESAdminOriginPartToKeep *toKeep;
3024 Z_ESAdminOriginPartNotToKeep *notToKeep;
3025 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3026 const char *first_db = "Default";
3028 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3033 r->direct_reference =
3034 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3037 r->indirect_reference = 0;
3038 r->which = Z_External_ESAdmin;
3040 r->u.adminService = (Z_Admin *)
3041 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3042 r->u.adminService->which = Z_Admin_esRequest;
3043 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3044 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3046 toKeep = r->u.adminService->u.esRequest->toKeep =
3047 (Z_ESAdminOriginPartToKeep *)
3048 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3049 toKeep->which = type;
3050 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3051 toKeep->u.create = odr_nullval();
3052 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3054 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3055 (Z_ESAdminOriginPartNotToKeep *)
3056 odr_malloc(p->odr_out,
3057 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3058 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3059 notToKeep->u.recordsWillFollow = odr_nullval();
3063 *notToKeepP = notToKeep;
3068 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3070 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
3071 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3072 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3073 const char *doc = ZOOM_options_get(p->options, "doc");
3078 req->taskSpecificParameters = ext;
3079 ext->direct_reference = req->packageType;
3080 ext->descriptor = 0;
3081 ext->indirect_reference = 0;
3083 ext->which = Z_External_octet;
3084 ext->u.single_ASN1_type =
3085 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
3090 static Z_APDU *create_update_package(ZOOM_package p)
3093 const char *first_db = "Default";
3095 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3096 const char *action = ZOOM_options_get(p->options, "action");
3097 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
3098 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3099 const char *record_buf = ZOOM_options_get(p->options, "record");
3100 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3101 int syntax_oid = VAL_NONE;
3105 syntax_oid = oid_getvalbyname(syntax_str);
3108 record_buf = "void";
3109 syntax_oid = VAL_SUTRS;
3111 if (syntax_oid == VAL_NONE)
3112 syntax_oid = VAL_TEXT_XML;
3118 action = "specialUpdate";
3120 if (!strcmp(action, "recordInsert"))
3121 action_no = Z_IUOriginPartToKeep_recordInsert;
3122 else if (!strcmp(action, "recordReplace"))
3123 action_no = Z_IUOriginPartToKeep_recordReplace;
3124 else if (!strcmp(action, "recordDelete"))
3125 action_no = Z_IUOriginPartToKeep_recordDelete;
3126 else if (!strcmp(action, "elementUpdate"))
3127 action_no = Z_IUOriginPartToKeep_elementUpdate;
3128 else if (!strcmp(action, "specialUpdate"))
3129 action_no = Z_IUOriginPartToKeep_specialUpdate;
3133 apdu = create_es_package(p, VAL_DBUPDATE);
3136 Z_IUOriginPartToKeep *toKeep;
3137 Z_IUSuppliedRecords *notToKeep;
3138 Z_External *r = (Z_External *)
3139 odr_malloc(p->odr_out, sizeof(*r));
3141 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3143 r->direct_reference =
3144 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3147 r->which = Z_External_update;
3148 r->indirect_reference = 0;
3149 r->u.update = (Z_IUUpdate *)
3150 odr_malloc(p->odr_out, sizeof(*r->u.update));
3152 r->u.update->which = Z_IUUpdate_esRequest;
3153 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3154 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3155 toKeep = r->u.update->u.esRequest->toKeep =
3156 (Z_IUOriginPartToKeep *)
3157 odr_malloc(p->odr_out, sizeof(*toKeep));
3159 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3161 toKeep->elementSetName = 0;
3162 toKeep->actionQualifier = 0;
3163 toKeep->action = odr_intdup(p->odr_out, action_no);
3165 notToKeep = r->u.update->u.esRequest->notToKeep =
3166 (Z_IUSuppliedRecords *)
3167 odr_malloc(p->odr_out, sizeof(*notToKeep));
3169 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3170 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3171 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3172 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3173 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3176 notToKeep->elements[0]->u.opaque =
3177 odr_create_Odr_oct(p->odr_out,
3178 (const unsigned char *) recordIdOpaque,
3179 strlen(recordIdOpaque));
3181 else if (recordIdNumber)
3183 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3185 notToKeep->elements[0]->u.number =
3186 odr_intdup(p->odr_out, atoi(recordIdNumber));
3189 notToKeep->elements[0]->u.opaque = 0;
3190 notToKeep->elements[0]->supplementalId = 0;
3191 notToKeep->elements[0]->correlationInfo = 0;
3192 notToKeep->elements[0]->record =
3193 z_ext_record(p->odr_out, syntax_oid,
3194 record_buf, strlen(record_buf));
3198 ODR print = odr_createmem(ODR_PRINT);
3200 z_APDU(print, &apdu, 0, 0);
3207 ZOOM_package_send(ZOOM_package p, const char *type)
3214 odr_reset(p->odr_out);
3217 if (!strcmp(type, "itemorder"))
3219 apdu = create_es_package(p, VAL_ITEMORDER);
3222 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3224 r->direct_reference =
3225 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3228 r->which = Z_External_itemOrder;
3229 r->indirect_reference = 0;
3230 r->u.itemOrder = encode_item_order(p);
3232 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3235 else if (!strcmp(type, "create")) /* create database */
3237 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3240 else if (!strcmp(type, "drop")) /* drop database */
3242 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3245 else if (!strcmp(type, "commit")) /* commit changes */
3247 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3250 else if (!strcmp(type, "update")) /* update record(s) */
3252 apdu = create_update_package(p);
3254 else if (!strcmp(type, "xmlupdate"))
3256 apdu = create_xmlupdate_package(p);
3260 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3264 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3265 task->u.package = p;
3266 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3267 p->buf_out = (char *) xmalloc(p->len_out);
3268 memcpy(p->buf_out, buf, p->len_out);
3273 while (ZOOM_event(1, &c))
3280 ZOOM_API(ZOOM_package)
3281 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3283 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3286 p->odr_out = odr_createmem(ODR_ENCODE);
3287 p->options = ZOOM_options_create_with_parent2(options, c->options);
3295 ZOOM_package_destroy(ZOOM_package p)
3300 if (p->refcount == 0)
3302 odr_destroy(p->odr_out);
3305 ZOOM_options_destroy(p->options);
3310 ZOOM_API(const char *)
3311 ZOOM_package_option_get(ZOOM_package p, const char *key)
3313 return ZOOM_options_get(p->options, key);
3318 ZOOM_package_option_set(ZOOM_package p, const char *key,
3321 ZOOM_options_set(p->options, key, val);
3325 static int ZOOM_connection_exec_task(ZOOM_connection c)
3327 ZOOM_task task = c->tasks;
3328 zoom_ret ret = zoom_complete;
3332 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3333 c, task->which, task->running);
3334 if (c->error != ZOOM_ERROR_NONE)
3336 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3337 "removing tasks because of error = %d", c, c->error);
3338 ZOOM_connection_remove_tasks(c);
3343 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3344 "task already running", c);
3348 ret = zoom_complete;
3349 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3351 switch (task->which)
3353 case ZOOM_TASK_SEARCH:
3354 if (c->proto == PROTO_HTTP)
3355 ret = ZOOM_connection_srw_send_search(c);
3357 ret = ZOOM_connection_send_search(c);
3359 case ZOOM_TASK_RETRIEVE:
3360 if (c->proto == PROTO_HTTP)
3361 ret = ZOOM_connection_srw_send_search(c);
3363 ret = send_present(c);
3365 case ZOOM_TASK_CONNECT:
3366 ret = do_connect(c);
3368 case ZOOM_TASK_SCAN:
3371 case ZOOM_TASK_PACKAGE:
3372 ret = send_package(c);
3374 case ZOOM_TASK_SORT:
3375 c->tasks->u.sort.resultset->r_sort_spec =
3376 c->tasks->u.sort.q->sort_spec;
3377 ret = send_sort(c, c->tasks->u.sort.resultset);
3383 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3384 "remove tasks because no connection exist", c);
3385 ZOOM_connection_remove_tasks(c);
3387 if (ret == zoom_complete)
3389 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3390 "task removed (complete)", c);
3391 ZOOM_connection_remove_task(c);
3394 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3399 static zoom_ret send_sort_present(ZOOM_connection c)
3401 zoom_ret r = zoom_complete;
3403 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3404 r = send_sort(c, c->tasks->u.search.resultset);
3405 if (r == zoom_complete)
3406 r = send_present(c);
3410 static int es_response(ZOOM_connection c,
3411 Z_ExtendedServicesResponse *res)
3413 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3415 if (res->diagnostics && res->num_diagnostics > 0)
3416 response_diag(c, res->diagnostics[0]);
3417 if (res->taskPackage &&
3418 res->taskPackage->which == Z_External_extendedService)
3420 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3421 Odr_oct *id = taskPackage->targetReference;
3424 ZOOM_options_setl(c->tasks->u.package->options,
3425 "targetReference", (char*) id->buf, id->len);
3427 if (res->taskPackage &&
3428 res->taskPackage->which == Z_External_octet)
3430 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3431 ZOOM_options_setl(c->tasks->u.package->options,
3432 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3437 static void interpret_init_diag(ZOOM_connection c,
3438 Z_DiagnosticFormat *diag)
3442 Z_DiagnosticFormat_s *ds = diag->elements[0];
3443 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3444 response_default_diag(c, ds->u.defaultDiagRec);
3449 static void interpret_otherinformation_field(ZOOM_connection c,
3450 Z_OtherInformation *ui)
3453 for (i = 0; i < ui->num_elements; i++)
3455 Z_OtherInformationUnit *unit = ui->list[i];
3456 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3457 unit->information.externallyDefinedInfo &&
3458 unit->information.externallyDefinedInfo->which ==
3461 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3467 static void set_init_option(const char *name, void *clientData) {
3468 ZOOM_connection c = clientData;
3471 sprintf(buf, "init_opt_%.70s", name);
3472 ZOOM_connection_option_set(c, buf, "1");
3476 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3478 Z_InitResponse *initrs;
3480 ZOOM_connection_set_mask(c, 0);
3481 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3484 case Z_APDU_initResponse:
3485 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3486 initrs = apdu->u.initResponse;
3487 ZOOM_connection_option_set(c, "serverImplementationId",
3488 initrs->implementationId ?
3489 initrs->implementationId : "");
3490 ZOOM_connection_option_set(c, "serverImplementationName",
3491 initrs->implementationName ?
3492 initrs->implementationName : "");
3493 ZOOM_connection_option_set(c, "serverImplementationVersion",
3494 initrs->implementationVersion ?
3495 initrs->implementationVersion : "");
3496 /* Set the three old options too, for old applications */
3497 ZOOM_connection_option_set(c, "targetImplementationId",
3498 initrs->implementationId ?
3499 initrs->implementationId : "");
3500 ZOOM_connection_option_set(c, "targetImplementationName",
3501 initrs->implementationName ?
3502 initrs->implementationName : "");
3503 ZOOM_connection_option_set(c, "targetImplementationVersion",
3504 initrs->implementationVersion ?
3505 initrs->implementationVersion : "");
3507 /* Make initrs->options available as ZOOM-level options */
3508 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3510 if (!*initrs->result)
3512 Z_External *uif = initrs->userInformationField;
3514 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3516 if (uif && uif->which == Z_External_userInfo1)
3517 interpret_otherinformation_field(c, uif->u.userInfo1);
3522 yaz_oi_get_string_oidval(&apdu->u.initResponse->otherInfo,
3524 xfree(c->cookie_in);
3527 c->cookie_in = xstrdup(cookie);
3528 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3529 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3530 c->support_named_resultsets = 1;
3533 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3534 ZOOM_connection_remove_task(c);
3536 ZOOM_connection_exec_task(c);
3538 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3540 NMEM tmpmem = nmem_create();
3541 Z_CharSetandLanguageNegotiation *p =
3542 yaz_get_charneg_record(initrs->otherInfo);
3546 char *charset = NULL, *lang = NULL;
3549 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3550 yaz_log(log_details, "%p recv_apdu target accepted: "
3551 "charset %s, language %s, select %d",
3553 charset ? charset : "none", lang ? lang : "none", sel);
3555 ZOOM_connection_option_set(c, "negotiation-charset",
3558 ZOOM_connection_option_set(c, "negotiation-lang",
3561 ZOOM_connection_option_set(
3562 c, "negotiation-charset-in-effect-for-records",
3563 (sel != 0) ? "1" : "0");
3564 nmem_destroy(tmpmem);
3568 case Z_APDU_searchResponse:
3569 yaz_log(log_api, "%p recv_apdu Search response", c);
3570 handle_search_response(c, apdu->u.searchResponse);
3571 if (send_sort_present(c) == zoom_complete)
3572 ZOOM_connection_remove_task(c);
3574 case Z_APDU_presentResponse:
3575 yaz_log(log_api, "%p recv_apdu Present response", c);
3576 handle_present_response(c, apdu->u.presentResponse);
3577 if (send_present(c) == zoom_complete)
3578 ZOOM_connection_remove_task(c);
3580 case Z_APDU_sortResponse:
3581 yaz_log(log_api, "%p recv_apdu Sort response", c);
3582 sort_response(c, apdu->u.sortResponse);
3583 if (send_present(c) == zoom_complete)
3584 ZOOM_connection_remove_task(c);
3586 case Z_APDU_scanResponse:
3587 yaz_log(log_api, "%p recv_apdu Scan response", c);
3588 scan_response(c, apdu->u.scanResponse);
3589 ZOOM_connection_remove_task(c);
3591 case Z_APDU_extendedServicesResponse:
3592 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3593 es_response(c, apdu->u.extendedServicesResponse);
3594 ZOOM_connection_remove_task(c);
3597 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3598 if (!ZOOM_test_reconnect(c))
3600 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3605 yaz_log(log_api, "%p Received unknown PDU", c);
3606 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3612 static void handle_srw_response(ZOOM_connection c,
3613 Z_SRW_searchRetrieveResponse *res)
3615 ZOOM_resultset resultset = 0;
3620 const char *syntax, *elementSetName;
3625 switch(c->tasks->which)
3627 case ZOOM_TASK_SEARCH:
3628 resultset = c->tasks->u.search.resultset;
3629 start = &c->tasks->u.search.start;
3630 syntax = c->tasks->u.search.syntax;
3631 elementSetName = c->tasks->u.search.elementSetName;
3633 case ZOOM_TASK_RETRIEVE:
3634 resultset = c->tasks->u.retrieve.resultset;
3635 start = &c->tasks->u.retrieve.start;
3636 syntax = c->tasks->u.retrieve.syntax;
3637 elementSetName = c->tasks->u.retrieve.elementSetName;
3642 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3643 ZOOM_connection_put_event(c, event);
3645 resultset->size = 0;
3647 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3649 if (res->numberOfRecords)
3650 resultset->size = *res->numberOfRecords;
3652 for (i = 0; i<res->num_records; i++)
3656 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3657 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3659 if (res->records[i].recordPosition &&
3660 *res->records[i].recordPosition > 0)
3661 pos = *res->records[i].recordPosition - 1;
3665 npr->databaseName = 0;
3666 npr->which = Z_NamePlusRecord_databaseRecord;
3667 npr->u.databaseRecord = (Z_External *)
3668 odr_malloc(c->odr_in, sizeof(Z_External));
3669 npr->u.databaseRecord->descriptor = 0;
3670 npr->u.databaseRecord->direct_reference =
3671 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3672 npr->u.databaseRecord->which = Z_External_octet;
3674 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3675 odr_malloc(c->odr_in, sizeof(Odr_oct));
3676 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3677 res->records[i].recordData_buf;
3678 npr->u.databaseRecord->u.octet_aligned->len =
3679 npr->u.databaseRecord->u.octet_aligned->size =
3680 res->records[i].recordData_len;
3681 record_cache_add(resultset, npr, pos, syntax, elementSetName);
3683 if (res->num_diagnostics > 0)
3685 const char *uri = res->diagnostics[0].uri;
3690 if ((cp = strrchr(uri, '/')))
3692 set_dset_error(c, code, uri,
3693 res->diagnostics[0].details, 0);
3696 nmem = odr_extract_mem(c->odr_in);
3697 nmem_transfer(resultset->odr->mem, nmem);
3703 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3706 const char *content_type = z_HTTP_header_lookup(hres->headers,
3708 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3710 ZOOM_connection_set_mask(c, 0);
3711 yaz_log(log_details, "%p handle_http", c);
3713 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3715 Z_SOAP *soap_package = 0;
3717 Z_SOAP_Handler soap_handlers[2] = {
3718 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
3721 ret = z_soap_codec(o, &soap_package,
3722 &hres->content_buf, &hres->content_len,
3724 if (!ret && soap_package->which == Z_SOAP_generic &&
3725 soap_package->u.generic->no == 0)
3727 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3728 if (sr->which == Z_SRW_searchRetrieve_response)
3729 handle_srw_response(c, sr->u.response);
3733 else if (!ret && (soap_package->which == Z_SOAP_fault
3734 || soap_package->which == Z_SOAP_error))
3736 set_HTTP_error(c, hres->code,
3737 soap_package->u.fault->fault_code,
3738 soap_package->u.fault->fault_string);
3745 if (hres->code != 200)
3746 set_HTTP_error(c, hres->code, 0, 0);
3748 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3751 ZOOM_connection_remove_task(c);
3752 if (!strcmp(hres->version, "1.0"))
3754 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3755 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3760 /* HTTP 1.1: only if no close we stay alive .. */
3761 if (connection_head && !strcmp(connection_head, "close"))
3767 static int do_read(ZOOM_connection c)
3772 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3773 ZOOM_connection_put_event(c, event);
3775 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3776 more = cs_more(c->cs);
3777 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3782 if (!ZOOM_test_reconnect(c))
3784 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3793 odr_reset(c->odr_in);
3794 odr_setbuf(c->odr_in, c->buf_in, r, 0);
3795 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3796 ZOOM_connection_put_event(c, event);
3798 if (!z_GDU(c->odr_in, &gdu, 0, 0))
3801 int err = odr_geterrorx(c->odr_in, &x);
3803 const char *element = odr_getelement(c->odr_in);
3804 sprintf(msg, "ODR code %d:%d element=%-20s",
3805 err, x, element ? element : "<unknown>");
3806 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3809 else if (gdu->which == Z_GDU_Z3950)
3810 recv_apdu(c, gdu->u.z3950);
3811 else if (gdu->which == Z_GDU_HTTP_Response)
3814 handle_http(c, gdu->u.HTTP_Response);
3816 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3820 c->reconnect_ok = 0;
3825 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3830 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3831 ZOOM_connection_put_event(c, event);
3833 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3834 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3836 yaz_log(log_details, "%p do_write_ex write failed", c);
3837 if (ZOOM_test_reconnect(c))
3839 return zoom_pending;
3841 if (c->state == STATE_CONNECTING)
3842 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3844 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3846 return zoom_complete;
3850 int mask = ZOOM_SELECT_EXCEPT;
3851 if (c->cs->io_pending & CS_WANT_WRITE)
3852 mask += ZOOM_SELECT_WRITE;
3853 if (c->cs->io_pending & CS_WANT_READ)
3854 mask += ZOOM_SELECT_READ;
3855 ZOOM_connection_set_mask(c, mask);
3856 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3861 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
3862 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3865 return zoom_pending;
3868 static zoom_ret do_write(ZOOM_connection c)
3870 return do_write_ex(c, c->buf_out, c->len_out);
3874 ZOOM_API(const char *)
3875 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3877 return ZOOM_options_get(c->options, key);
3880 ZOOM_API(const char *)
3881 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3883 return ZOOM_options_getl(c->options, key, lenp);
3887 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3890 ZOOM_options_set(c->options, key, val);
3895 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3896 const char *val, int len)
3898 ZOOM_options_setl(c->options, key, val, len);
3902 ZOOM_API(const char *)
3903 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3905 return ZOOM_options_get(r->options, key);
3909 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3912 ZOOM_options_set(r->options, key, val);
3918 ZOOM_connection_errcode(ZOOM_connection c)
3920 return ZOOM_connection_error(c, 0, 0);
3923 ZOOM_API(const char *)
3924 ZOOM_connection_errmsg(ZOOM_connection c)
3927 ZOOM_connection_error(c, &msg, 0);
3931 ZOOM_API(const char *)
3932 ZOOM_connection_addinfo(ZOOM_connection c)
3934 const char *addinfo;
3935 ZOOM_connection_error(c, 0, &addinfo);
3939 ZOOM_API(const char *)
3940 ZOOM_connection_diagset(ZOOM_connection c)
3942 const char *diagset;
3943 ZOOM_connection_error_x(c, 0, 0, &diagset);
3947 ZOOM_API(const char *)
3948 ZOOM_diag_str(int error)
3952 case ZOOM_ERROR_NONE:
3954 case ZOOM_ERROR_CONNECT:
3955 return "Connect failed";
3956 case ZOOM_ERROR_MEMORY:
3957 return "Out of memory";
3958 case ZOOM_ERROR_ENCODE:
3959 return "Encoding failed";
3960 case ZOOM_ERROR_DECODE:
3961 return "Decoding failed";
3962 case ZOOM_ERROR_CONNECTION_LOST:
3963 return "Connection lost";
3964 case ZOOM_ERROR_INIT:
3965 return "Init rejected";
3966 case ZOOM_ERROR_INTERNAL:
3967 return "Internal failure";
3968 case ZOOM_ERROR_TIMEOUT:
3970 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3971 return "Unsupported protocol";
3972 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3973 return "Unsupported query type";
3974 case ZOOM_ERROR_INVALID_QUERY:
3975 return "Invalid query";
3976 case ZOOM_ERROR_CQL_PARSE:
3977 return "CQL parsing error";
3978 case ZOOM_ERROR_CQL_TRANSFORM:
3979 return "CQL transformation error";
3980 case ZOOM_ERROR_CCL_CONFIG:
3981 return "CCL configuration error";
3982 case ZOOM_ERROR_CCL_PARSE:
3983 return "CCL parsing error";
3985 return diagbib1_str(error);
3990 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
3991 const char **addinfo, const char **diagset)
3993 int error = c->error;
3996 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3997 *cp = ZOOM_diag_str(error);
3998 else if (!strcmp(c->diagset, "HTTP"))
3999 *cp = z_HTTP_errmsg(c->error);
4000 else if (!strcmp(c->diagset, "Bib-1"))
4001 *cp = ZOOM_diag_str(error);
4002 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4003 *cp = yaz_diag_srw_str(c->error);
4005 *cp = "Unknown error and diagnostic set";
4008 *addinfo = c->addinfo ? c->addinfo : "";
4010 *diagset = c->diagset ? c->diagset : "";
4015 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4016 const char **addinfo)
4018 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4021 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4023 ZOOM_Event event = 0;
4024 int r = cs_look(c->cs);
4025 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4030 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4031 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4033 ZOOM_connection_put_event(c, event);
4035 else if (r == CS_CONNECT)
4037 int ret = ret = cs_rcvconnect(c->cs);
4038 yaz_log(log_details, "%p ZOOM_connection_do_io "
4039 "cs_rcvconnect returned %d", c, ret);
4042 int mask = ZOOM_SELECT_EXCEPT;
4043 if (c->cs->io_pending & CS_WANT_WRITE)
4044 mask += ZOOM_SELECT_WRITE;
4045 if (c->cs->io_pending & CS_WANT_READ)
4046 mask += ZOOM_SELECT_READ;
4047 ZOOM_connection_set_mask(c, mask);
4051 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4052 ZOOM_connection_put_event(c, event);
4054 if (c->proto == PROTO_Z3950)
4055 ZOOM_connection_send_init(c);
4058 /* no init request for SRW .. */
4059 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4060 ZOOM_connection_remove_task(c);
4061 ZOOM_connection_set_mask(c, 0);
4062 ZOOM_connection_exec_task(c);
4064 c->state = STATE_ESTABLISHED;
4068 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4074 if (mask & ZOOM_SELECT_EXCEPT)
4076 if (!ZOOM_test_reconnect(c))
4078 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4083 if (mask & ZOOM_SELECT_READ)
4085 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4091 ZOOM_connection_last_event(ZOOM_connection cs)
4094 return ZOOM_EVENT_NONE;
4095 return cs->last_event;
4100 * Returns an xmalloc()d string containing RPN that corresponds to the
4101 * CQL passed in. On error, sets the Connection object's error state
4102 * and returns a null pointer.
4103 * ### We could cache CQL parser and/or transformer in Connection.
4105 static char *cql2pqf(ZOOM_connection c, const char *cql)
4109 struct cql_node *node;
4110 const char *cqlfile;
4111 static cql_transform_t trans;
4114 parser = cql_parser_create();
4115 if ((error = cql_parser_string(parser, cql)) != 0) {
4116 cql_parser_destroy(parser);
4117 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4121 node = cql_parser_result(parser);
4122 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4124 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4126 cql_parser_destroy(parser);
4127 cql_node_destroy(node);
4128 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4132 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4134 cql_parser_destroy(parser);
4135 cql_node_destroy(node);
4136 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4137 cqlfile, strerror(errno));
4138 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4142 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4143 cql_parser_destroy(parser);
4144 cql_node_destroy(node);
4147 const char *addinfo;
4148 error = cql_transform_error(trans, &addinfo);
4149 cql_transform_close(trans);
4150 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4151 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4155 cql_transform_close(trans);
4156 return xstrdup(pqfbuf);
4159 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4163 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4164 /* timeout and this connection was waiting */
4165 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4167 ZOOM_connection_put_event(c, event);
4173 ZOOM_connection_process(ZOOM_connection c)
4179 event = ZOOM_connection_get_event(c);
4182 ZOOM_Event_destroy(event);
4185 ZOOM_connection_exec_task(c);
4186 event = ZOOM_connection_get_event(c);
4189 ZOOM_Event_destroy(event);
4196 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4200 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4202 for (i = 0; i<no; i++)
4204 ZOOM_connection c = cs[i];
4206 if (c && ZOOM_connection_process(c))
4212 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4214 if (c->mask && mask)
4215 ZOOM_connection_do_io(c, mask);
4219 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4222 return cs_fileno(c->cs);
4226 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4234 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4241 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4243 return ZOOM_options_get_int(c->options, "timeout", 30);
4249 * indent-tabs-mode: nil
4251 * vim: shiftwidth=4 tabstop=8 expandtab