2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.111 2007-02-07 17:52:44 mike 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 zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
39 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
40 static char *cql2pqf(ZOOM_connection c, const char *cql);
44 * This wrapper is just for logging failed lookups. It would be nicer
45 * if it could cause failure when a lookup fails, but that's hard.
47 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
48 int oid_class, const char *str) {
49 Odr_oid *res = yaz_str_to_z3950oid(c->odr_out, oid_class, str);
51 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
52 c, (int) oid_class, str);
57 static void initlog(void)
59 static int log_level_initialized = 0;
60 if (!log_level_initialized)
62 log_api = yaz_log_module_level("zoom");
63 log_details = yaz_log_module_level("zoomdetails");
64 log_level_initialized = 1;
68 static ZOOM_Event ZOOM_Event_create(int kind)
70 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
74 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
78 static void ZOOM_Event_destroy(ZOOM_Event event)
83 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
87 c->m_queue_back->prev = event;
88 assert(c->m_queue_front);
92 assert(!c->m_queue_front);
93 c->m_queue_front = event;
95 event->next = c->m_queue_back;
97 c->m_queue_back = event;
100 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
102 ZOOM_Event event = c->m_queue_front;
105 c->last_event = ZOOM_EVENT_NONE;
108 assert(c->m_queue_back);
109 c->m_queue_front = event->prev;
110 if (c->m_queue_front)
112 assert(c->m_queue_back);
113 c->m_queue_front->next = 0;
117 c->last_event = event->kind;
121 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
123 ZOOM_Event event = c->m_queue_front;
125 return event ? event->kind : ZOOM_EVENT_NONE;
128 static void set_dset_error(ZOOM_connection c, int error,
130 const char *addinfo, const char *addinfo2)
137 if (!c->diagset || strcmp(dset, c->diagset))
140 c->diagset = xstrdup(dset);
141 /* remove integer part from SRW diagset .. */
142 if ((cp = strrchr(c->diagset, '/')))
145 if (addinfo && addinfo2)
147 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
148 strcpy(c->addinfo, addinfo);
149 strcat(c->addinfo, addinfo2);
152 c->addinfo = xstrdup(addinfo);
154 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
155 c, c->host_port ? c->host_port : "<>", dset, error,
156 addinfo ? addinfo : "",
157 addinfo2 ? addinfo2 : "");
161 static void set_HTTP_error(ZOOM_connection c, int error,
162 const char *addinfo, const char *addinfo2)
164 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
168 static void set_ZOOM_error(ZOOM_connection c, int error,
171 set_dset_error(c, error, "ZOOM", addinfo, 0);
174 static void clear_error(ZOOM_connection c)
177 * If an error is tied to an operation then it's ok to clear: for
178 * example, a diagnostic returned from a search is cleared by a
179 * subsequent search. However, problems such as Connection Lost
180 * or Init Refused are not cleared, because they are not
181 * recoverable: doing another search doesn't help.
185 case ZOOM_ERROR_CONNECT:
186 case ZOOM_ERROR_MEMORY:
187 case ZOOM_ERROR_DECODE:
188 case ZOOM_ERROR_CONNECTION_LOST:
189 case ZOOM_ERROR_INIT:
190 case ZOOM_ERROR_INTERNAL:
191 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
194 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
198 void ZOOM_connection_show_task(ZOOM_task task)
202 case ZOOM_TASK_SEARCH:
203 yaz_log(YLOG_LOG, "search p=%p", task);
205 case ZOOM_TASK_RETRIEVE:
206 yaz_log(YLOG_LOG, "retrieve p=%p", task);
208 case ZOOM_TASK_CONNECT:
209 yaz_log(YLOG_LOG, "connect p=%p", task);
212 yaz_log(YLOG_LOG, "scant p=%p", task);
217 void ZOOM_connection_show_tasks(ZOOM_connection c)
220 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
221 for (task = c->tasks; task; task = task->next)
222 ZOOM_connection_show_task(task);
225 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
227 ZOOM_task *taskp = &c->tasks;
229 taskp = &(*taskp)->next;
230 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
231 (*taskp)->running = 0;
232 (*taskp)->which = which;
238 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
240 return c->tasks ? 0 : 1;
243 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
245 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
247 task->next = c->tasks;
256 void ZOOM_connection_remove_task(ZOOM_connection c)
258 ZOOM_task task = c->tasks;
262 c->tasks = task->next;
265 case ZOOM_TASK_SEARCH:
266 ZOOM_resultset_destroy(task->u.search.resultset);
267 xfree(task->u.search.syntax);
268 xfree(task->u.search.elementSetName);
270 case ZOOM_TASK_RETRIEVE:
271 ZOOM_resultset_destroy(task->u.retrieve.resultset);
272 xfree(task->u.retrieve.syntax);
273 xfree(task->u.retrieve.elementSetName);
275 case ZOOM_TASK_CONNECT:
278 ZOOM_scanset_destroy(task->u.scan.scan);
280 case ZOOM_TASK_PACKAGE:
281 ZOOM_package_destroy(task->u.package);
284 ZOOM_resultset_destroy(task->u.sort.resultset);
285 ZOOM_query_destroy(task->u.sort.q);
294 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
295 ZOOM_connection_put_event(c, event);
300 static int ZOOM_connection_exec_task(ZOOM_connection c);
302 void ZOOM_connection_remove_tasks(ZOOM_connection c)
305 ZOOM_connection_remove_task(c);
308 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
310 const char *elementSetName);
312 ZOOM_API(ZOOM_connection)
313 ZOOM_connection_create(ZOOM_options options)
315 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
319 yaz_log(log_api, "%p ZOOM_connection_create", c);
321 c->proto = PROTO_Z3950;
323 ZOOM_connection_set_mask(c, 0);
325 c->state = STATE_IDLE;
328 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
335 c->options = ZOOM_options_create_with_parent(options);
341 c->charset = c->lang = 0;
348 c->odr_in = odr_createmem(ODR_DECODE);
349 c->odr_out = odr_createmem(ODR_ENCODE);
352 c->support_named_resultsets = 0;
353 c->last_event = ZOOM_EVENT_NONE;
355 c->m_queue_front = 0;
361 /* set database names. Take local databases (if set); otherwise
362 take databases given in ZURL (if set); otherwise use Default */
363 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
366 char **databaseNames;
367 const char *cp = ZOOM_options_get(options, "databaseName");
369 if ((!cp || !*cp) && con->host_port)
371 if (strncmp(con->host_port, "unix:", 5) == 0)
372 cp = strchr(con->host_port+5, ':');
374 cp = strchr(con->host_port, '/');
380 nmem_strsplit(odr->mem, "+", cp, &databaseNames, num);
381 return databaseNames;
384 ZOOM_API(ZOOM_connection)
385 ZOOM_connection_new(const char *host, int portnum)
387 ZOOM_connection c = ZOOM_connection_create(0);
389 ZOOM_connection_connect(c, host, portnum);
393 static zoom_sru_mode get_sru_mode_from_string(const char *s)
396 return zoom_sru_soap;
397 if (!yaz_matchstr(s, "soap"))
398 return zoom_sru_soap;
399 else if (!yaz_matchstr(s, "get"))
401 else if (!yaz_matchstr(s, "post"))
402 return zoom_sru_post;
403 return zoom_sru_error;
407 ZOOM_connection_connect(ZOOM_connection c,
408 const char *host, int portnum)
415 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
418 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
419 ZOOM_connection_remove_tasks(c);
423 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
427 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
429 val = ZOOM_options_get(c->options, "proxy");
432 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
433 c->proxy = xstrdup(val);
439 val = ZOOM_options_get(c->options, "charset");
442 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
443 c->charset = xstrdup(val);
449 val = ZOOM_options_get(c->options, "lang");
452 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
453 c->lang = xstrdup(val);
462 sprintf(hostn, "%.80s:%d", host, portnum);
463 c->host_port = xstrdup(hostn);
466 c->host_port = xstrdup(host);
470 * If the "<scheme>:" part of the host string is preceded by one
471 * or more comma-separated <name>=<value> pairs, these are taken
472 * to be options to be set on the connection object. Among other
473 * applications, this facility can be used to embed authentication
475 * user=admin,password=secret,tcp:localhost:9999
477 char *remainder = c->host_port;
478 char *pcolon = strchr(remainder, ':');
481 while ((pcomma = strchr(remainder, ',')) != 0 &&
482 (pcolon == 0 || pcomma < pcolon)) {
484 if ((pequals = strchr(remainder, '=')) != 0) {
486 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
487 ZOOM_connection_option_set(c, remainder, pequals+1);
489 remainder = pcomma+1;
492 if (remainder != c->host_port) {
494 c->host_port = xstrdup(remainder);
495 /*printf("# reset hp='%s'\n", remainder);*/
499 val = ZOOM_options_get(c->options, "sru");
500 c->sru_mode = get_sru_mode_from_string(val);
502 ZOOM_options_set(c->options, "host", c->host_port);
504 val = ZOOM_options_get(c->options, "cookie");
507 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
508 c->cookie_out = xstrdup(val);
511 val = ZOOM_options_get(c->options, "clientIP");
514 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
516 c->client_IP = xstrdup(val);
519 c->async = ZOOM_options_get_bool(c->options, "async", 0);
520 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
522 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
526 while (ZOOM_event(1, &c))
532 ZOOM_query_create(void)
534 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
536 yaz_log(log_details, "%p ZOOM_query_create", s);
540 s->odr = odr_createmem(ODR_ENCODE);
547 ZOOM_query_destroy(ZOOM_query s)
553 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
554 if (s->refcount == 0)
562 ZOOM_query_prefix(ZOOM_query s, const char *str)
564 s->query_string = odr_strdup(s->odr, str);
565 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
566 s->z_query->which = Z_Query_type_1;
567 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
568 if (!s->z_query->u.type_1)
570 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
574 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
579 ZOOM_query_cql(ZOOM_query s, const char *str)
583 s->query_string = odr_strdup(s->odr, str);
585 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
586 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
587 ext->indirect_reference = 0;
589 ext->which = Z_External_CQL;
590 ext->u.cql = s->query_string;
592 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
593 s->z_query->which = Z_Query_type_104;
594 s->z_query->u.type_104 = ext;
596 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
602 * Translate the CQL string client-side into RPN which is passed to
603 * the server. This is useful for server's that don't themselves
604 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
605 * only as a place to stash diagnostics if compilation fails; if this
606 * information is not needed, a null pointer may be used.
609 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
613 ZOOM_connection freeme = 0;
615 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
617 conn = freeme = ZOOM_connection_create(0);
619 rpn = cql2pqf(conn, str);
621 ZOOM_connection_destroy(freeme);
625 ret = ZOOM_query_prefix(s, rpn);
631 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
632 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
633 * to the server, as the YAZ GFS doesn't know how to handle this.
636 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
637 int *ccl_error, const char **error_string,
641 struct ccl_rpn_node *rpn;
642 CCL_bibset bibset = ccl_qual_mk();
645 ccl_qual_buf(bibset, config);
647 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
650 *error_string = ccl_err_msg(*ccl_error);
655 WRBUF wr = wrbuf_alloc();
658 ret = ZOOM_query_prefix(s, wrbuf_buf(wr));
661 ccl_qual_rm(&bibset);
666 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
668 s->sort_spec = yaz_sort_spec(s->odr, criteria);
671 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
675 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
679 static zoom_ret do_write(ZOOM_connection c);
682 ZOOM_connection_destroy(ZOOM_connection c)
687 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
690 for (r = c->resultsets; r; r = r->next)
696 odr_destroy(c->odr_in);
697 odr_destroy(c->odr_out);
698 ZOOM_options_destroy(c->options);
699 ZOOM_connection_remove_tasks(c);
705 xfree(c->cookie_out);
711 void ZOOM_resultset_addref(ZOOM_resultset r)
716 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
721 ZOOM_resultset ZOOM_resultset_create(void)
724 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
728 yaz_log(log_details, "%p ZOOM_resultset_create", r);
731 r->odr = odr_createmem(ODR_ENCODE);
736 for (i = 0; i<RECORD_HASH_SIZE; i++)
737 r->record_hash[i] = 0;
742 r->databaseNames = 0;
743 r->num_databaseNames = 0;
747 ZOOM_API(ZOOM_resultset)
748 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
751 ZOOM_query s = ZOOM_query_create();
753 ZOOM_query_prefix(s, q);
755 r = ZOOM_connection_search(c, s);
756 ZOOM_query_destroy(s);
760 ZOOM_API(ZOOM_resultset)
761 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
763 ZOOM_resultset r = ZOOM_resultset_create();
767 const char *syntax, *elementSetName;
769 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
770 r->r_sort_spec = q->sort_spec;
773 r->options = ZOOM_options_create_with_parent(c->options);
775 start = ZOOM_options_get_int(r->options, "start", 0);
776 count = ZOOM_options_get_int(r->options, "count", 0);
778 /* If "presentChunk" is defined use that; otherwise "step" */
779 const char *cp = ZOOM_options_get(r->options, "presentChunk");
780 r->step = ZOOM_options_get_int(r->options,
781 (cp != 0 ? "presentChunk": "step"), 0);
783 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
784 cp = ZOOM_options_get(r->options, "setname");
786 r->setname = xstrdup(cp);
787 cp = ZOOM_options_get(r->options, "schema");
789 r->schema = xstrdup(cp);
791 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
796 r->next = c->resultsets;
799 if (c->host_port && c->proto == PROTO_HTTP)
803 yaz_log(log_details, "ZOOM_connection_search: no comstack");
804 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
808 yaz_log(log_details, "ZOOM_connection_search: reconnect");
813 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
814 task->u.search.resultset = r;
815 task->u.search.start = start;
816 task->u.search.count = count;
818 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
819 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
820 elementSetName = ZOOM_options_get(r->options, "elementSetName");
821 task->u.search.elementSetName = elementSetName
822 ? xstrdup(elementSetName) : 0;
824 ZOOM_resultset_addref(r);
830 while (ZOOM_event(1, &c))
837 * This is the old result-set sorting API, which is maintained only
838 * for the sake of binary compatibility. There is no reason ever to
839 * use this rather than ZOOM_resultset_sort1().
842 ZOOM_resultset_sort(ZOOM_resultset r,
843 const char *sort_type, const char *sort_spec)
845 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
849 ZOOM_resultset_sort1(ZOOM_resultset r,
850 const char *sort_type, const char *sort_spec)
852 ZOOM_connection c = r->connection;
856 newq = ZOOM_query_create();
857 if (ZOOM_query_sortby(newq, sort_spec) < 0)
860 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
861 r, r, sort_type, sort_spec);
865 if (c->host_port && c->proto == PROTO_HTTP)
869 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
870 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
874 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
880 ZOOM_resultset_cache_reset(r);
881 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
882 task->u.sort.resultset = r;
883 task->u.sort.q = newq;
885 ZOOM_resultset_addref(r);
889 while (ZOOM_event(1, &c))
897 ZOOM_resultset_cache_reset(ZOOM_resultset r)
900 for (i = 0; i<RECORD_HASH_SIZE; i++)
902 ZOOM_record_cache rc;
903 for (rc = r->record_hash[i]; rc; rc = rc->next)
905 if (rc->rec.wrbuf_marc)
906 wrbuf_free(rc->rec.wrbuf_marc, 1);
907 if (rc->rec.wrbuf_iconv)
908 wrbuf_free(rc->rec.wrbuf_iconv, 1);
909 if (rc->rec.wrbuf_opac)
910 wrbuf_free(rc->rec.wrbuf_opac, 1);
912 r->record_hash[i] = 0;
917 ZOOM_resultset_destroy(ZOOM_resultset r)
922 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
924 if (r->refcount == 0)
926 ZOOM_resultset_cache_reset(r);
930 /* remove ourselves from the resultsets in connection */
931 ZOOM_resultset *rp = &r->connection->resultsets;
934 assert(*rp); /* we must be in this list!! */
936 { /* OK, we're here - take us out of it */
943 ZOOM_query_destroy(r->query);
944 ZOOM_options_destroy(r->options);
953 ZOOM_resultset_size(ZOOM_resultset r)
955 yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
960 static void do_close(ZOOM_connection c)
965 ZOOM_connection_set_mask(c, 0);
966 c->state = STATE_IDLE;
969 static int ZOOM_test_reconnect(ZOOM_connection c)
971 if (!c->reconnect_ok)
975 c->tasks->running = 0;
976 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
980 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
981 int force_sync, int start, int count)
986 const char *syntax, *elementSetName;
990 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
991 " count=%d", r, force_sync, start, count);
996 if (c->host_port && c->proto == PROTO_HTTP)
1000 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1001 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1005 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1007 c->reconnect_ok = 1;
1010 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1011 task->u.retrieve.resultset = r;
1012 task->u.retrieve.start = start;
1013 task->u.retrieve.count = count;
1015 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1016 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1017 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1018 task->u.retrieve.elementSetName = elementSetName
1019 ? xstrdup(elementSetName) : 0;
1021 cp = ZOOM_options_get(r->options, "schema");
1024 if (!r->schema || strcmp(r->schema, cp))
1027 r->schema = xstrdup(cp);
1031 ZOOM_resultset_addref(r);
1033 if (!r->connection->async || force_sync)
1034 while (r->connection && ZOOM_event(1, &r->connection))
1039 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1040 size_t start, size_t count)
1042 int force_present = 0;
1046 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1047 r, r, (long) start, (long) count);
1050 ZOOM_resultset_retrieve(r, force_present, start, count);
1054 for (i = 0; i< count; i++)
1055 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1059 static void get_cert(ZOOM_connection c)
1064 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1066 ZOOM_connection_option_setl(c, "sslPeerCert",
1067 cert_buf, cert_len);
1072 static zoom_ret do_connect(ZOOM_connection c)
1075 const char *effective_host;
1078 effective_host = c->proxy;
1080 effective_host = c->host_port;
1082 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1086 c->cs = cs_create_host(effective_host, 0, &add);
1088 if (c->cs && c->cs->protocol == PROTO_HTTP)
1091 const char *path = 0;
1093 c->proto = PROTO_HTTP;
1094 cs_get_host_args(c->host_port, &path);
1096 c->path = (char*) xmalloc(strlen(path)+2);
1098 strcpy(c->path+1, path);
1100 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1102 return zoom_complete;
1107 int ret = cs_connect(c->cs, add);
1110 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1111 ZOOM_connection_put_event(c, event);
1113 if (c->proto == PROTO_Z3950)
1114 ZOOM_connection_send_init(c);
1117 /* no init request for SRW .. */
1118 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1119 ZOOM_connection_remove_task(c);
1120 ZOOM_connection_set_mask(c, 0);
1121 ZOOM_connection_exec_task(c);
1123 c->state = STATE_ESTABLISHED;
1124 return zoom_pending;
1128 int mask = ZOOM_SELECT_EXCEPT;
1129 if (c->cs->io_pending & CS_WANT_WRITE)
1130 mask += ZOOM_SELECT_WRITE;
1131 if (c->cs->io_pending & CS_WANT_READ)
1132 mask += ZOOM_SELECT_READ;
1133 ZOOM_connection_set_mask(c, mask);
1134 c->state = STATE_CONNECTING;
1135 return zoom_pending;
1138 c->state = STATE_IDLE;
1139 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1140 return zoom_complete;
1143 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1146 for (i = 0; i<200; i++)
1149 Z_OtherInformation **oi;
1155 sprintf(buf, "otherInfo%d", i);
1156 val = ZOOM_options_get(c->options, buf);
1159 cp = strchr(val, ':');
1163 if (len >= sizeof(buf))
1164 len = sizeof(buf)-1;
1165 memcpy(buf, val, len);
1167 oidval = oid_getvalbyname(buf);
1168 if (oidval == VAL_NONE)
1171 yaz_oi_APDU(a, &oi);
1172 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1176 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1181 Z_OtherInformation **oi;
1182 yaz_oi_APDU(a, &oi);
1183 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1187 Z_OtherInformation **oi;
1188 yaz_oi_APDU(a, &oi);
1189 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1191 otherInfo_attach(c, a, out);
1192 if (!z_APDU(out, &a, 0, 0))
1194 FILE *outf = fopen("/tmp/apdu.txt", "a");
1197 ODR odr_pr = odr_createmem(ODR_PRINT);
1198 fprintf(outf, "a=%p\n", a);
1199 odr_setprint(odr_pr, outf);
1200 z_APDU(odr_pr, &a, 0, 0);
1201 odr_destroy(odr_pr);
1203 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1204 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1208 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1212 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1216 if (encode_APDU(c, a, c->odr_out))
1217 return zoom_complete;
1218 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1219 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1220 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1221 ZOOM_connection_put_event(c, event);
1222 odr_reset(c->odr_out);
1226 /* returns 1 if PDU was sent OK (still pending )
1227 0 if PDU was not sent OK (nothing to wait for)
1230 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1232 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1233 Z_InitRequest *ireq = apdu->u.initRequest;
1234 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1235 odr_malloc(c->odr_out, sizeof(*auth));
1236 const char *auth_groupId = ZOOM_options_get(c->options, "group");
1237 const char *auth_userId = ZOOM_options_get(c->options, "user");
1238 const char *auth_password = ZOOM_options_get(c->options, "password");
1241 /* support the pass for backwards compatibility */
1243 auth_password = ZOOM_options_get(c->options, "pass");
1245 ODR_MASK_SET(ireq->options, Z_Options_search);
1246 ODR_MASK_SET(ireq->options, Z_Options_present);
1247 ODR_MASK_SET(ireq->options, Z_Options_scan);
1248 ODR_MASK_SET(ireq->options, Z_Options_sort);
1249 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1250 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1252 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1253 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1254 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1256 /* Index Data's Z39.50 Implementor Id is 81 */
1257 ireq->implementationId =
1258 odr_prepend(c->odr_out,
1259 ZOOM_options_get(c->options, "implementationId"),
1260 odr_prepend(c->odr_out, "81", ireq->implementationId));
1262 ireq->implementationName =
1263 odr_prepend(c->odr_out,
1264 ZOOM_options_get(c->options, "implementationName"),
1265 odr_prepend(c->odr_out, "ZOOM-C",
1266 ireq->implementationName));
1268 version = odr_strdup(c->odr_out, "$Revision: 1.111 $");
1269 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1270 version[strlen(version)-2] = '\0';
1271 ireq->implementationVersion =
1272 odr_prepend(c->odr_out,
1273 ZOOM_options_get(c->options, "implementationVersion"),
1274 odr_prepend(c->odr_out, &version[11],
1275 ireq->implementationVersion));
1277 *ireq->maximumRecordSize =
1278 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
1279 *ireq->preferredMessageSize =
1280 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
1282 if (auth_groupId || auth_password)
1284 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1287 if (auth_groupId && *auth_groupId)
1289 pass->groupId = (char *)
1290 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1291 strcpy(pass->groupId, auth_groupId);
1295 if (auth_userId && *auth_userId)
1297 pass->userId = (char *)
1298 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1299 strcpy(pass->userId, auth_userId);
1303 if (auth_password && *auth_password)
1305 pass->password = (char *)
1306 odr_malloc(c->odr_out, strlen(auth_password)+1);
1307 strcpy(pass->password, auth_password);
1312 auth->which = Z_IdAuthentication_idPass;
1313 auth->u.idPass = pass;
1314 ireq->idAuthentication = auth;
1317 else if (auth_userId)
1319 auth->which = Z_IdAuthentication_open;
1320 auth->u.open = (char *)
1321 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1322 strcpy(auth->u.open, auth_userId);
1323 ireq->idAuthentication = auth;
1326 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1327 VAL_PROXY, 1, c->host_port);
1328 if (c->charset || c->lang)
1330 Z_OtherInformation **oi;
1331 Z_OtherInformationUnit *oi_unit;
1333 yaz_oi_APDU(apdu, &oi);
1335 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1337 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1338 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1339 oi_unit->information.externallyDefinedInfo =
1340 yaz_set_proposal_charneg_list(c->odr_out, " ",
1341 c->charset, c->lang, 1);
1345 return send_APDU(c, apdu);
1349 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1354 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1356 if (c->sru_mode == zoom_sru_get)
1358 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1360 else if (c->sru_mode == zoom_sru_post)
1362 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1364 else if (c->sru_mode == zoom_sru_soap)
1366 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1368 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1369 return zoom_complete;
1370 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1372 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1373 ZOOM_connection_put_event(c, event);
1374 odr_reset(c->odr_out);
1380 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1384 ZOOM_resultset resultset = 0;
1386 const char *option_val = 0;
1388 if (c->error) /* don't continue on error */
1389 return zoom_complete;
1391 switch(c->tasks->which)
1393 case ZOOM_TASK_SEARCH:
1394 resultset = c->tasks->u.search.resultset;
1395 resultset->setname = xstrdup("default");
1396 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1397 start = &c->tasks->u.search.start;
1398 count = &c->tasks->u.search.count;
1400 case ZOOM_TASK_RETRIEVE:
1401 resultset = c->tasks->u.retrieve.resultset;
1403 start = &c->tasks->u.retrieve.start;
1404 count = &c->tasks->u.retrieve.count;
1406 if (*start >= resultset->size)
1407 return zoom_complete;
1408 if (*start + *count > resultset->size)
1409 *count = resultset->size - *start;
1411 for (i = 0; i < *count; i++)
1414 record_cache_lookup(resultset, i + *start,
1415 c->tasks->u.retrieve.syntax,
1416 c->tasks->u.retrieve.elementSetName);
1421 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1422 ZOOM_connection_put_event(c, event);
1429 return zoom_complete;
1432 return zoom_complete;
1434 assert(resultset->query);
1436 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1438 if (resultset->query->z_query->which == Z_Query_type_104
1439 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1441 sr->u.request->query_type = Z_SRW_query_type_cql;
1442 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1444 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1445 resultset->query->z_query->u.type_1)
1447 sr->u.request->query_type = Z_SRW_query_type_pqf;
1448 sr->u.request->query.pqf = resultset->query->query_string;
1452 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1453 return zoom_complete;
1455 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1456 sr->u.request->maximumRecords = odr_intdup(
1457 c->odr_out, resultset->step>0 ? resultset->step : *count);
1458 sr->u.request->recordSchema = resultset->schema;
1460 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1462 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1464 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1466 sr->extra_args = odr_strdup(c->odr_out, option_val);
1467 return send_srw(c, sr);
1470 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1472 return zoom_complete;
1476 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1479 int lslb, ssub, mspn;
1481 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1482 Z_SearchRequest *search_req = apdu->u.searchRequest;
1483 const char *elementSetName;
1484 const char *smallSetElementSetName;
1485 const char *mediumSetElementSetName;
1488 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1490 r = c->tasks->u.search.resultset;
1492 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1495 ZOOM_options_get(r->options, "elementSetName");
1496 smallSetElementSetName =
1497 ZOOM_options_get(r->options, "smallSetElementSetName");
1498 mediumSetElementSetName =
1499 ZOOM_options_get(r->options, "mediumSetElementSetName");
1501 if (!smallSetElementSetName)
1502 smallSetElementSetName = elementSetName;
1504 if (!mediumSetElementSetName)
1505 mediumSetElementSetName = elementSetName;
1510 /* prepare query for the search request */
1511 search_req->query = r->query->z_query;
1512 if (!search_req->query)
1514 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1515 return zoom_complete;
1518 search_req->databaseNames = r->databaseNames;
1519 search_req->num_databaseNames = r->num_databaseNames;
1521 /* get syntax (no need to provide unless piggyback is in effect) */
1522 syntax = c->tasks->u.search.syntax;
1524 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1525 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1526 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1527 if (lslb != -1 && ssub != -1 && mspn != -1)
1529 /* So're a Z39.50 expert? Let's hope you don't do sort */
1530 *search_req->largeSetLowerBound = lslb;
1531 *search_req->smallSetUpperBound = ssub;
1532 *search_req->mediumSetPresentNumber = mspn;
1534 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1535 && r->piggyback && !r->r_sort_spec && !r->schema)
1537 /* Regular piggyback - do it unless we're going to do sort */
1538 *search_req->largeSetLowerBound = 2000000000;
1539 *search_req->smallSetUpperBound = 1;
1540 *search_req->mediumSetPresentNumber =
1541 r->step>0 ? r->step : c->tasks->u.search.count;
1545 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1546 smallSetElementSetName = 0;
1547 mediumSetElementSetName = 0;
1550 if (smallSetElementSetName && *smallSetElementSetName)
1552 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1553 odr_malloc(c->odr_out, sizeof(*esn));
1555 esn->which = Z_ElementSetNames_generic;
1556 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1557 search_req->smallSetElementSetNames = esn;
1559 if (mediumSetElementSetName && *mediumSetElementSetName)
1561 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1562 odr_malloc(c->odr_out, sizeof(*esn));
1564 esn->which = Z_ElementSetNames_generic;
1565 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1566 search_req->mediumSetElementSetNames = esn;
1569 search_req->preferredRecordSyntax =
1570 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1574 if (c->support_named_resultsets)
1578 /* find the lowest unused ordinal so that we re-use
1579 result sets on the server. */
1580 for (ord = 1; ; ord++)
1583 sprintf(setname, "%d", ord);
1584 for (rp = c->resultsets; rp; rp = rp->next)
1585 if (rp->setname && !strcmp(rp->setname, setname))
1590 r->setname = xstrdup(setname);
1591 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1592 "set %s", c, r->setname);
1596 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1598 r->setname = xstrdup("default");
1600 ZOOM_options_set(r->options, "setname", r->setname);
1602 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1603 return send_APDU(c, apdu);
1606 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1613 case Z_DefaultDiagFormat_v2Addinfo:
1614 addinfo = r->u.v2Addinfo;
1616 case Z_DefaultDiagFormat_v3Addinfo:
1617 addinfo = r->u.v3Addinfo;
1622 set_dset_error(c, *r->condition,
1623 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1627 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1629 if (p->which != Z_DiagRec_defaultFormat)
1630 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1632 response_default_diag(c, p->u.defaultFormat);
1635 ZOOM_API(ZOOM_record)
1636 ZOOM_record_clone(ZOOM_record srec)
1643 odr_enc = odr_createmem(ODR_ENCODE);
1644 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1646 buf = odr_getbuf(odr_enc, &size, 0);
1648 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1649 nrec->odr = odr_createmem(ODR_DECODE);
1650 nrec->wrbuf_marc = 0;
1651 nrec->wrbuf_iconv = 0;
1652 nrec->wrbuf_opac = 0;
1653 odr_setbuf(nrec->odr, buf, size, 0);
1654 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1656 odr_destroy(odr_enc);
1660 ZOOM_API(ZOOM_record)
1661 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1663 const char *syntax =
1664 ZOOM_options_get(s->options, "preferredRecordSyntax");
1665 const char *elementSetName =
1666 ZOOM_options_get(s->options, "elementSetName");
1668 return record_cache_lookup(s, pos, syntax, elementSetName);
1671 ZOOM_API(ZOOM_record)
1672 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1674 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1679 * MIKE: I think force_sync should always be zero, but I don't
1680 * want to make this change until I get the go-ahead from
1681 * Adam, in case something depends on the old synchronous
1685 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1686 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1687 rec = ZOOM_resultset_record_immediate(r, pos);
1693 ZOOM_record_destroy(ZOOM_record rec)
1697 if (rec->wrbuf_marc)
1698 wrbuf_free(rec->wrbuf_marc, 1);
1699 if (rec->wrbuf_iconv)
1700 wrbuf_free(rec->wrbuf_iconv, 1);
1701 if (rec->wrbuf_opac)
1702 wrbuf_free(rec->wrbuf_opac, 1);
1703 odr_destroy(rec->odr);
1707 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1709 const char *buf, int sz,
1710 const char *record_charset)
1715 yaz_marc_t mt = yaz_marc_create();
1718 strcpy(to, "UTF-8");
1719 if (record_charset && *record_charset)
1721 /* Use "from,to" or just "from" */
1722 const char *cp = strchr(record_charset, ',');
1723 int clen = strlen(record_charset);
1726 strncpy( to, cp+1, sizeof(to)-1);
1727 to[sizeof(to)-1] = '\0';
1728 clen = cp - record_charset;
1730 if (clen > sizeof(from)-1)
1731 clen = sizeof(from)-1;
1734 strncpy(from, record_charset, clen);
1740 cd = yaz_iconv_open(to, from);
1741 yaz_marc_iconv(mt, cd);
1744 yaz_marc_xml(mt, marc_type);
1745 if (!rec->wrbuf_marc)
1746 rec->wrbuf_marc = wrbuf_alloc();
1747 wrbuf_rewind(rec->wrbuf_marc);
1748 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1750 yaz_marc_destroy(mt);
1752 yaz_iconv_close(cd);
1754 *len = wrbuf_len(rec->wrbuf_marc);
1755 return wrbuf_buf(rec->wrbuf_marc);
1757 yaz_marc_destroy(mt);
1759 yaz_iconv_close(cd);
1763 static const char *record_iconv_return(ZOOM_record rec, int *len,
1764 const char *buf, int sz,
1765 const char *record_charset)
1772 strcpy(to, "UTF-8");
1773 if (record_charset && *record_charset)
1775 /* Use "from,to" or just "from" */
1776 const char *cp = strchr(record_charset, ',');
1777 int clen = strlen(record_charset);
1780 strncpy( to, cp+1, sizeof(to)-1);
1781 to[sizeof(to)-1] = '\0';
1782 clen = cp - record_charset;
1784 if (clen > sizeof(from)-1)
1785 clen = sizeof(from)-1;
1788 strncpy(from, record_charset, clen);
1792 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1795 size_t inbytesleft = sz;
1796 const char *inp = buf;
1798 if (!rec->wrbuf_iconv)
1799 rec->wrbuf_iconv = wrbuf_alloc();
1801 wrbuf_rewind(rec->wrbuf_iconv);
1805 size_t outbytesleft = sizeof(outbuf);
1806 char *outp = outbuf;
1807 size_t r = yaz_iconv(cd, (char**) &inp,
1809 &outp, &outbytesleft);
1810 if (r == (size_t) (-1))
1812 int e = yaz_iconv_error(cd);
1813 if (e != YAZ_ICONV_E2BIG)
1816 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1818 wrbuf_puts(rec->wrbuf_iconv, "");
1819 buf = wrbuf_buf(rec->wrbuf_iconv);
1820 sz = wrbuf_len(rec->wrbuf_iconv);
1821 yaz_iconv_close(cd);
1829 ZOOM_record_error(ZOOM_record rec, const char **cp,
1830 const char **addinfo, const char **diagset)
1832 Z_NamePlusRecord *npr;
1837 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1839 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1840 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1841 const char *add = 0;
1843 if (diag_rec->which == Z_DiagRec_defaultFormat)
1845 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1848 error = *ddf->condition;
1851 case Z_DefaultDiagFormat_v2Addinfo:
1852 add = ddf->u.v2Addinfo;
1854 case Z_DefaultDiagFormat_v3Addinfo:
1855 add = ddf->u.v3Addinfo;
1859 *diagset = yaz_z3950oid_to_str(ddf->diagnosticSetId, &oclass);
1867 *addinfo = add ? add : "";
1869 *cp = diagbib1_str(error);
1875 ZOOM_API(const char *)
1876 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1883 Z_NamePlusRecord *npr;
1886 *len = 0; /* default return */
1895 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1897 if (cp[i] == ';' || cp[i] == ' ')
1903 while (type_spec[i] == ';')
1906 while (type_spec[i] == ' ')
1908 if (!strncmp(type_spec+i, "charset=", 8))
1911 i = i + 8; /* skip charset= */
1912 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1914 if (type_spec[i] == ';' || type_spec[i] == ' ')
1920 else if (!strncmp(type_spec+i, "xpath=", 6))
1924 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1928 while (type_spec[i] == ' ')
1931 if (!strcmp(type, "database"))
1934 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1935 return npr->databaseName;
1937 else if (!strcmp(type, "syntax"))
1939 const char *desc = 0;
1940 if (npr->which == Z_NamePlusRecord_databaseRecord)
1942 Z_External *r = (Z_External *) npr->u.databaseRecord;
1943 oident *ent = oid_getentbyoid(r->direct_reference);
1950 *len = strlen(desc);
1953 if (npr->which != Z_NamePlusRecord_databaseRecord)
1956 /* from now on - we have a database record .. */
1957 if (!strcmp(type, "render"))
1959 Z_External *r = (Z_External *) npr->u.databaseRecord;
1960 oident *ent = oid_getentbyoid(r->direct_reference);
1962 /* render bibliographic record .. */
1963 if (r->which == Z_External_OPAC)
1965 r = r->u.opac->bibliographicRecord;
1968 ent = oid_getentbyoid(r->direct_reference);
1970 if (r->which == Z_External_sutrs)
1971 return record_iconv_return(rec, len,
1972 (char*) r->u.sutrs->buf,
1975 else if (r->which == Z_External_octet)
1977 const char *ret_buf;
1985 case VAL_APPLICATION_XML:
1988 ret_buf = marc_iconv_return(
1989 rec, YAZ_MARC_LINE, len,
1990 (const char *) r->u.octet_aligned->buf,
1991 r->u.octet_aligned->len,
1996 return record_iconv_return(rec, len,
1997 (const char *) r->u.octet_aligned->buf,
1998 r->u.octet_aligned->len,
2001 else if (r->which == Z_External_grs1)
2003 if (!rec->wrbuf_marc)
2004 rec->wrbuf_marc = wrbuf_alloc();
2005 wrbuf_rewind(rec->wrbuf_marc);
2006 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
2007 return record_iconv_return(rec, len,
2008 wrbuf_buf(rec->wrbuf_marc),
2009 wrbuf_len(rec->wrbuf_marc),
2014 else if (!strcmp(type, "xml"))
2016 Z_External *r = (Z_External *) npr->u.databaseRecord;
2017 oident *ent = oid_getentbyoid(r->direct_reference);
2019 /* render bibliographic record .. */
2020 if (r->which == Z_External_OPAC)
2022 r = r->u.opac->bibliographicRecord;
2025 ent = oid_getentbyoid(r->direct_reference);
2028 if (r->which == Z_External_sutrs)
2029 return record_iconv_return(rec, len,
2030 (const char *) r->u.sutrs->buf,
2033 else if (r->which == Z_External_octet)
2035 const char *ret_buf;
2036 int marc_decode_type = YAZ_MARC_MARCXML;
2045 case VAL_APPLICATION_XML:
2048 ret_buf = marc_iconv_return(
2049 rec, marc_decode_type, len,
2050 (const char *) r->u.octet_aligned->buf,
2051 r->u.octet_aligned->len,
2056 return record_iconv_return(rec, len,
2057 (const char *) r->u.octet_aligned->buf,
2058 r->u.octet_aligned->len,
2061 else if (r->which == Z_External_grs1)
2068 else if (!strcmp(type, "raw"))
2070 Z_External *r = (Z_External *) npr->u.databaseRecord;
2072 if (r->which == Z_External_sutrs)
2074 if (len) *len = r->u.sutrs->len;
2075 return (const char *) r->u.sutrs->buf;
2077 else if (r->which == Z_External_octet)
2079 if (len) *len = r->u.octet_aligned->len;
2080 return (const char *) r->u.octet_aligned->buf;
2082 else /* grs-1, explain, OPAC, ... */
2085 return (const char *) npr->u.databaseRecord;
2089 else if (!strcmp (type, "ext"))
2092 return (const char *) npr->u.databaseRecord;
2094 else if (!strcmp (type, "opac"))
2097 Z_External *r = (Z_External *) npr->u.databaseRecord;
2098 if (r->which == Z_External_OPAC)
2100 if (!rec->wrbuf_opac)
2101 rec->wrbuf_opac = wrbuf_alloc();
2102 wrbuf_rewind(rec->wrbuf_opac);
2103 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2104 return record_iconv_return(rec, len,
2105 wrbuf_buf(rec->wrbuf_opac),
2106 wrbuf_len(rec->wrbuf_opac),
2113 static int strcmp_null(const char *v1, const char *v2)
2119 return strcmp(v1, v2);
2122 static size_t record_hash(int pos)
2126 return pos % RECORD_HASH_SIZE;
2129 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2131 const char *syntax, const char *elementSetName)
2133 ZOOM_record_cache rc;
2135 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2136 ZOOM_connection_put_event(r->connection, event);
2138 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2142 if (strcmp_null(r->schema, rc->schema))
2144 if (strcmp_null(elementSetName,rc->elementSetName))
2146 if (strcmp_null(syntax, rc->syntax))
2148 /* not destroying rc->npr (it's handled by nmem )*/
2150 /* keeping wrbuf_marc too */
2154 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2157 rc->rec.wrbuf_marc = 0;
2158 rc->rec.wrbuf_iconv = 0;
2159 rc->rec.wrbuf_opac = 0;
2161 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2163 rc->elementSetName = 0;
2166 rc->syntax = odr_strdup(r->odr, syntax);
2171 rc->schema = odr_strdup(r->odr, r->schema);
2176 rc->next = r->record_hash[record_hash(pos)];
2177 r->record_hash[record_hash(pos)] = rc;
2180 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2182 const char *elementSetName)
2184 ZOOM_record_cache rc;
2186 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2190 if (strcmp_null(r->schema, rc->schema))
2192 if (strcmp_null(elementSetName,rc->elementSetName))
2194 if (strcmp_null(syntax, rc->syntax))
2202 static void handle_records(ZOOM_connection c, Z_Records *sr,
2205 ZOOM_resultset resultset;
2207 const char *syntax = 0, *elementSetName = 0;
2211 switch (c->tasks->which)
2213 case ZOOM_TASK_SEARCH:
2214 resultset = c->tasks->u.search.resultset;
2215 start = &c->tasks->u.search.start;
2216 count = &c->tasks->u.search.count;
2217 syntax = c->tasks->u.search.syntax;
2218 elementSetName = c->tasks->u.search.elementSetName;
2220 case ZOOM_TASK_RETRIEVE:
2221 resultset = c->tasks->u.retrieve.resultset;
2222 start = &c->tasks->u.retrieve.start;
2223 count = &c->tasks->u.retrieve.count;
2224 syntax = c->tasks->u.retrieve.syntax;
2225 elementSetName = c->tasks->u.retrieve.elementSetName;
2230 if (sr && sr->which == Z_Records_NSD)
2231 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2232 else if (sr && sr->which == Z_Records_multipleNSD)
2234 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2235 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2237 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2241 if (*count + *start > resultset->size)
2242 *count = resultset->size - *start;
2245 if (sr && sr->which == Z_Records_DBOSD)
2248 NMEM nmem = odr_extract_mem(c->odr_in);
2249 Z_NamePlusRecordList *p =
2250 sr->u.databaseOrSurDiagnostics;
2251 for (i = 0; i<p->num_records; i++)
2253 record_cache_add(resultset, p->records[i], i + *start,
2254 syntax, elementSetName);
2260 yaz_log(log_details,
2261 "handle_records resultset=%p start=%d count=%d",
2262 resultset, *start, *count);
2264 /* transfer our response to search_nmem .. we need it later */
2265 nmem_transfer(resultset->odr->mem, nmem);
2267 if (present_phase && p->num_records == 0)
2269 /* present response and we didn't get any records! */
2270 Z_NamePlusRecord *myrec =
2271 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2272 record_cache_add(resultset, myrec, *start,
2273 syntax, elementSetName);
2276 else if (present_phase)
2278 /* present response and we didn't get any records! */
2279 Z_NamePlusRecord *myrec =
2280 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2281 record_cache_add(resultset, myrec, *start, syntax, elementSetName);
2286 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2288 handle_records(c, pr->records, 1);
2291 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2294 switch (term->which)
2296 case Z_Term_general:
2297 ZOOM_options_setl(opt, name,
2298 (const char *)(term->u.general->buf),
2299 term->u.general->len);
2301 case Z_Term_characterString:
2302 ZOOM_options_set(opt, name, term->u.characterString);
2304 case Z_Term_numeric:
2305 ZOOM_options_set_int(opt, name, *term->u.numeric);
2310 static void handle_queryExpression(ZOOM_options opt, const char *name,
2311 Z_QueryExpression *exp)
2317 case Z_QueryExpression_term:
2318 if (exp->u.term && exp->u.term->queryTerm)
2320 sprintf(opt_name, "%s.term", name);
2321 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2324 case Z_QueryExpression_query:
2329 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2330 Z_OtherInformation *o)
2333 for (i = 0; o && i < o->num_elements; i++)
2335 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2337 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2339 if (ext->which == Z_External_searchResult1)
2342 Z_SearchInfoReport *sr = ext->u.searchResult1;
2345 ZOOM_options_set_int(
2346 resultset->options, "searchresult.size", sr->num);
2348 for (j = 0; j < sr->num; j++)
2350 Z_SearchInfoReport_s *ent =
2351 ext->u.searchResult1->elements[j];
2354 sprintf(pref, "searchresult.%d", j);
2356 if (ent->subqueryId)
2359 sprintf(opt_name, "%s.id", pref);
2360 ZOOM_options_set(resultset->options, opt_name,
2363 if (ent->subqueryExpression)
2366 sprintf(opt_name, "%s.subquery", pref);
2367 handle_queryExpression(resultset->options, opt_name,
2368 ent->subqueryExpression);
2370 if (ent->subqueryInterpretation)
2373 sprintf(opt_name, "%s.interpretation", pref);
2374 handle_queryExpression(resultset->options, opt_name,
2375 ent->subqueryInterpretation);
2377 if (ent->subqueryRecommendation)
2380 sprintf(opt_name, "%s.recommendation", pref);
2381 handle_queryExpression(resultset->options, opt_name,
2382 ent->subqueryRecommendation);
2384 if (ent->subqueryCount)
2387 sprintf(opt_name, "%s.count", pref);
2388 ZOOM_options_set_int(resultset->options, opt_name,
2389 *ent->subqueryCount);
2397 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2399 ZOOM_resultset resultset;
2402 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2405 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2406 ZOOM_connection_put_event(c, event);
2408 resultset = c->tasks->u.search.resultset;
2410 if (sr->resultSetStatus)
2412 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2413 *sr->resultSetStatus);
2415 if (sr->presentStatus)
2417 ZOOM_options_set_int(resultset->options, "presentStatus",
2418 *sr->presentStatus);
2420 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2422 resultset->size = *sr->resultCount;
2423 handle_records(c, sr->records, 0);
2426 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2428 if (res->diagnostics && res->num_diagnostics > 0)
2429 response_diag(c, res->diagnostics[0]);
2432 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2434 NMEM nmem = odr_extract_mem(c->odr_in);
2437 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2439 scan = c->tasks->u.scan.scan;
2441 if (res->entries && res->entries->nonsurrogateDiagnostics)
2442 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2443 scan->scan_response = res;
2444 nmem_transfer(scan->odr->mem, nmem);
2446 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2447 if (res->positionOfTerm)
2448 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2449 if (res->scanStatus)
2450 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2451 if (res->numberOfEntriesReturned)
2452 ZOOM_options_set_int(scan->options, "number",
2453 *res->numberOfEntriesReturned);
2458 static zoom_ret send_sort(ZOOM_connection c,
2459 ZOOM_resultset resultset)
2462 resultset->r_sort_spec = 0;
2463 if (resultset->r_sort_spec)
2465 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2466 Z_SortRequest *req = apdu->u.sortRequest;
2468 req->num_inputResultSetNames = 1;
2469 req->inputResultSetNames = (Z_InternationalString **)
2470 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2471 req->inputResultSetNames[0] =
2472 odr_strdup(c->odr_out, resultset->setname);
2473 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2474 req->sortSequence = resultset->r_sort_spec;
2475 resultset->r_sort_spec = 0;
2476 return send_APDU(c, apdu);
2478 return zoom_complete;
2481 static zoom_ret send_present(ZOOM_connection c)
2484 Z_PresentRequest *req = 0;
2486 const char *syntax = 0;
2487 const char *elementSetName = 0;
2488 ZOOM_resultset resultset;
2493 yaz_log(log_details, "%p send_present no tasks", c);
2494 return zoom_complete;
2497 switch (c->tasks->which)
2499 case ZOOM_TASK_SEARCH:
2500 resultset = c->tasks->u.search.resultset;
2501 start = &c->tasks->u.search.start;
2502 count = &c->tasks->u.search.count;
2503 syntax = c->tasks->u.search.syntax;
2504 elementSetName = c->tasks->u.search.elementSetName;
2506 case ZOOM_TASK_RETRIEVE:
2507 resultset = c->tasks->u.retrieve.resultset;
2508 start = &c->tasks->u.retrieve.start;
2509 count = &c->tasks->u.retrieve.count;
2510 syntax = c->tasks->u.retrieve.syntax;
2511 elementSetName = c->tasks->u.retrieve.elementSetName;
2514 return zoom_complete;
2516 yaz_log(log_details, "%p send_present start=%d count=%d",
2519 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2521 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2524 if (c->error) /* don't continue on error */
2525 return zoom_complete;
2526 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2527 resultset, *start, *count);
2529 for (i = 0; i < *count; i++)
2532 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2537 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2538 ZOOM_connection_put_event(c, event);
2546 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2547 return zoom_complete;
2550 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2551 req = apdu->u.presentRequest;
2554 yaz_log(log_details, "%p send_present skip=%d", c, i);
2556 *req->resultSetStartPoint = *start + 1;
2557 *req->numberOfRecordsRequested = resultset->step>0 ?
2558 resultset->step : *count;
2559 if (*req->numberOfRecordsRequested + *start > resultset->size)
2560 *req->numberOfRecordsRequested = resultset->size - *start;
2561 assert(*req->numberOfRecordsRequested > 0);
2563 if (syntax && *syntax)
2564 req->preferredRecordSyntax =
2565 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2567 if (resultset->schema && *resultset->schema)
2569 Z_RecordComposition *compo = (Z_RecordComposition *)
2570 odr_malloc(c->odr_out, sizeof(*compo));
2572 req->recordComposition = compo;
2573 compo->which = Z_RecordComp_complex;
2574 compo->u.complex = (Z_CompSpec *)
2575 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2576 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2577 odr_malloc(c->odr_out, sizeof(bool_t));
2578 *compo->u.complex->selectAlternativeSyntax = 0;
2580 compo->u.complex->generic = (Z_Specification *)
2581 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2583 compo->u.complex->generic->which = Z_Schema_oid;
2584 compo->u.complex->generic->schema.oid = (Odr_oid *)
2585 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2587 if (!compo->u.complex->generic->schema.oid)
2589 /* OID wasn't a schema! Try record syntax instead. */
2591 compo->u.complex->generic->schema.oid = (Odr_oid *)
2592 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2594 if (elementSetName && *elementSetName)
2596 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2597 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2598 compo->u.complex->generic->elementSpec->which =
2599 Z_ElementSpec_elementSetName;
2600 compo->u.complex->generic->elementSpec->u.elementSetName =
2601 odr_strdup(c->odr_out, elementSetName);
2604 compo->u.complex->generic->elementSpec = 0;
2605 compo->u.complex->num_dbSpecific = 0;
2606 compo->u.complex->dbSpecific = 0;
2607 compo->u.complex->num_recordSyntax = 0;
2608 compo->u.complex->recordSyntax = 0;
2610 else if (elementSetName && *elementSetName)
2612 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2613 odr_malloc(c->odr_out, sizeof(*esn));
2614 Z_RecordComposition *compo = (Z_RecordComposition *)
2615 odr_malloc(c->odr_out, sizeof(*compo));
2617 esn->which = Z_ElementSetNames_generic;
2618 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2619 compo->which = Z_RecordComp_simple;
2620 compo->u.simple = esn;
2621 req->recordComposition = compo;
2623 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2624 return send_APDU(c, apdu);
2627 ZOOM_API(ZOOM_scanset)
2628 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2631 ZOOM_query q = ZOOM_query_create();
2633 ZOOM_query_prefix(q, start);
2635 s = ZOOM_connection_scan1(c, q);
2636 ZOOM_query_destroy(q);
2641 ZOOM_API(ZOOM_scanset)
2642 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2646 ZOOM_scanset scan = 0;
2649 * We need to check the query-type, so we can recognise CQL and
2650 * CCL and compile them into a form that we can use here. The
2651 * ZOOM_query structure has no explicit `type' member, but
2652 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2653 * functions shows how the structure is set up in each case.
2657 else if (q->z_query->which == Z_Query_type_1)
2659 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2660 c, q, q->query_string);
2661 start = q->query_string;
2663 else if (q->z_query->which == Z_Query_type_104)
2665 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2666 c, q, q->query_string);
2667 start = freeme = cql2pqf(c, q->query_string);
2673 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2674 c, q, q->query_string);
2678 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2679 scan->connection = c;
2680 scan->odr = odr_createmem(ODR_DECODE);
2681 scan->options = ZOOM_options_create_with_parent(c->options);
2683 scan->scan_response = 0;
2684 scan->termListAndStartPoint =
2685 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2688 scan->databaseNames = set_DatabaseNames(c, c->options,
2689 &scan->num_databaseNames,
2691 if (scan->termListAndStartPoint != 0)
2693 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2694 task->u.scan.scan = scan;
2699 while (ZOOM_event(1, &c))
2707 ZOOM_scanset_destroy(ZOOM_scanset scan)
2712 if (scan->refcount == 0)
2714 odr_destroy(scan->odr);
2716 ZOOM_options_destroy(scan->options);
2721 static zoom_ret send_package(ZOOM_connection c)
2725 yaz_log(log_details, "%p send_package", c);
2727 return zoom_complete;
2728 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2730 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2731 ZOOM_connection_put_event(c, event);
2733 c->buf_out = c->tasks->u.package->buf_out;
2734 c->len_out = c->tasks->u.package->len_out;
2739 static zoom_ret send_scan(ZOOM_connection c)
2742 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2743 Z_ScanRequest *req = apdu->u.scanRequest;
2745 yaz_log(log_details, "%p send_scan", c);
2747 return zoom_complete;
2748 assert (c->tasks->which == ZOOM_TASK_SCAN);
2749 scan = c->tasks->u.scan.scan;
2751 req->termListAndStartPoint = scan->termListAndStartPoint;
2752 req->attributeSet = scan->attributeSet;
2754 *req->numberOfTermsRequested =
2755 ZOOM_options_get_int(scan->options, "number", 10);
2757 req->preferredPositionInResponse =
2758 odr_intdup(c->odr_out,
2759 ZOOM_options_get_int(scan->options, "position", 1));
2762 odr_intdup(c->odr_out,
2763 ZOOM_options_get_int(scan->options, "stepSize", 0));
2765 req->databaseNames = scan->databaseNames;
2766 req->num_databaseNames = scan->num_databaseNames;
2768 return send_APDU(c, apdu);
2772 ZOOM_scanset_size(ZOOM_scanset scan)
2774 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2776 return scan->scan_response->entries->num_entries;
2779 ZOOM_API(const char *)
2780 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2783 const char *term = 0;
2784 size_t noent = ZOOM_scanset_size(scan);
2785 Z_ScanResponse *res = scan->scan_response;
2791 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2793 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2795 if (t->term->which == Z_Term_general)
2797 term = (const char *) t->term->u.general->buf;
2798 *len = t->term->u.general->len;
2800 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2805 ZOOM_API(const char *)
2806 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2809 const char *term = 0;
2810 size_t noent = ZOOM_scanset_size(scan);
2811 Z_ScanResponse *res = scan->scan_response;
2817 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2819 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2823 term = t->displayTerm;
2824 *len = strlen(term);
2826 else if (t->term->which == Z_Term_general)
2828 term = (const char *) t->term->u.general->buf;
2829 *len = t->term->u.general->len;
2831 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2836 ZOOM_API(const char *)
2837 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2839 return ZOOM_options_get(scan->options, key);
2843 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2846 ZOOM_options_set(scan->options, key, val);
2849 static Z_APDU *create_es_package(ZOOM_package p, int type)
2852 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2853 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2855 *req->function = Z_ExtendedServicesRequest_create;
2857 str = ZOOM_options_get(p->options, "package-name");
2859 req->packageName = nmem_strdup(p->odr_out->mem, str);
2861 str = ZOOM_options_get(p->options, "user-id");
2863 req->userId = nmem_strdup(p->odr_out->mem, str);
2865 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2868 str = ZOOM_options_get(p->options, "function");
2871 if (!strcmp (str, "create"))
2873 if (!strcmp (str, "delete"))
2875 if (!strcmp (str, "modify"))
2881 static const char *ill_array_lookup(void *clientData, const char *idx)
2883 ZOOM_package p = (ZOOM_package) clientData;
2884 return ZOOM_options_get(p->options, idx+4);
2887 static Z_External *encode_ill_request(ZOOM_package p)
2889 ODR out = p->odr_out;
2892 struct ill_get_ctl ctl;
2894 ctl.odr = p->odr_out;
2896 ctl.f = ill_array_lookup;
2898 req = ill_get_ILLRequest(&ctl, "ill", 0);
2900 if (!ill_Request(out, &req, 0, 0))
2902 int ill_request_size;
2903 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2904 if (ill_request_buf)
2905 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2911 int illRequest_size = 0;
2912 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2914 oid.proto = PROTO_GENERAL;
2915 oid.oclass = CLASS_GENERAL;
2916 oid.value = VAL_ISO_ILL_1;
2918 r = (Z_External *) odr_malloc(out, sizeof(*r));
2919 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2920 r->indirect_reference = 0;
2922 r->which = Z_External_single;
2924 r->u.single_ASN1_type =
2925 odr_create_Odr_oct(out,
2926 (unsigned char *)illRequest_buf,
2932 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2934 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2937 req->which = Z_IOItemOrder_esRequest;
2938 req->u.esRequest = (Z_IORequest *)
2939 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2941 /* to keep part ... */
2942 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2943 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2944 req->u.esRequest->toKeep->supplDescription = 0;
2945 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2946 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2948 str = ZOOM_options_get(p->options, "contact-name");
2949 req->u.esRequest->toKeep->contact->name = str ?
2950 nmem_strdup(p->odr_out->mem, str) : 0;
2952 str = ZOOM_options_get(p->options, "contact-phone");
2953 req->u.esRequest->toKeep->contact->phone = str ?
2954 nmem_strdup(p->odr_out->mem, str) : 0;
2956 str = ZOOM_options_get(p->options, "contact-email");
2957 req->u.esRequest->toKeep->contact->email = str ?
2958 nmem_strdup(p->odr_out->mem, str) : 0;
2960 req->u.esRequest->toKeep->addlBilling = 0;
2962 /* not to keep part ... */
2963 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2964 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2966 str = ZOOM_options_get(p->options, "itemorder-setname");
2971 req->u.esRequest->notToKeep->resultSetItem = 0;
2974 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2975 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2977 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2978 nmem_strdup(p->odr_out->mem, str);
2979 req->u.esRequest->notToKeep->resultSetItem->item =
2980 (int *) odr_malloc(p->odr_out, sizeof(int));
2982 str = ZOOM_options_get(p->options, "itemorder-item");
2983 *req->u.esRequest->notToKeep->resultSetItem->item =
2984 (str ? atoi(str) : 1);
2987 str = ZOOM_options_get(p->options, "doc");
2989 req->u.esRequest->notToKeep->itemRequest =
2990 z_ext_record(p->odr_out, VAL_TEXT_XML, str, strlen(str));
2992 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2997 Z_APDU *create_admin_package(ZOOM_package p, int type,
2998 Z_ESAdminOriginPartToKeep **toKeepP,
2999 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3001 Z_APDU *apdu = create_es_package(p, VAL_ADMINSERVICE);
3004 Z_ESAdminOriginPartToKeep *toKeep;
3005 Z_ESAdminOriginPartNotToKeep *notToKeep;
3006 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3007 const char *first_db = "Default";
3009 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3014 r->direct_reference =
3015 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3018 r->indirect_reference = 0;
3019 r->which = Z_External_ESAdmin;
3021 r->u.adminService = (Z_Admin *)
3022 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3023 r->u.adminService->which = Z_Admin_esRequest;
3024 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3025 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3027 toKeep = r->u.adminService->u.esRequest->toKeep =
3028 (Z_ESAdminOriginPartToKeep *)
3029 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3030 toKeep->which = type;
3031 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3032 toKeep->u.create = odr_nullval();
3033 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3035 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3036 (Z_ESAdminOriginPartNotToKeep *)
3037 odr_malloc(p->odr_out,
3038 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3039 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3040 notToKeep->u.recordsWillFollow = odr_nullval();
3044 *notToKeepP = notToKeep;
3049 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3051 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
3052 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3053 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3054 const char *doc = ZOOM_options_get(p->options, "doc");
3059 req->taskSpecificParameters = ext;
3060 ext->direct_reference = req->packageType;
3061 ext->descriptor = 0;
3062 ext->indirect_reference = 0;
3064 ext->which = Z_External_octet;
3065 ext->u.single_ASN1_type =
3066 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
3071 static Z_APDU *create_update_package(ZOOM_package p)
3074 const char *first_db = "Default";
3076 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3077 const char *action = ZOOM_options_get(p->options, "action");
3078 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
3079 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3080 const char *record_buf = ZOOM_options_get(p->options, "record");
3081 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3082 int syntax_oid = VAL_NONE;
3086 syntax_oid = oid_getvalbyname(syntax_str);
3089 record_buf = "void";
3090 syntax_oid = VAL_SUTRS;
3092 if (syntax_oid == VAL_NONE)
3093 syntax_oid = VAL_TEXT_XML;
3099 action = "specialUpdate";
3101 if (!strcmp(action, "recordInsert"))
3102 action_no = Z_IUOriginPartToKeep_recordInsert;
3103 else if (!strcmp(action, "recordReplace"))
3104 action_no = Z_IUOriginPartToKeep_recordReplace;
3105 else if (!strcmp(action, "recordDelete"))
3106 action_no = Z_IUOriginPartToKeep_recordDelete;
3107 else if (!strcmp(action, "elementUpdate"))
3108 action_no = Z_IUOriginPartToKeep_elementUpdate;
3109 else if (!strcmp(action, "specialUpdate"))
3110 action_no = Z_IUOriginPartToKeep_specialUpdate;
3114 apdu = create_es_package(p, VAL_DBUPDATE);
3117 Z_IUOriginPartToKeep *toKeep;
3118 Z_IUSuppliedRecords *notToKeep;
3119 Z_External *r = (Z_External *)
3120 odr_malloc(p->odr_out, sizeof(*r));
3122 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3124 r->direct_reference =
3125 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3128 r->which = Z_External_update;
3129 r->indirect_reference = 0;
3130 r->u.update = (Z_IUUpdate *)
3131 odr_malloc(p->odr_out, sizeof(*r->u.update));
3133 r->u.update->which = Z_IUUpdate_esRequest;
3134 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3135 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3136 toKeep = r->u.update->u.esRequest->toKeep =
3137 (Z_IUOriginPartToKeep *)
3138 odr_malloc(p->odr_out, sizeof(*toKeep));
3140 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3142 toKeep->elementSetName = 0;
3143 toKeep->actionQualifier = 0;
3144 toKeep->action = odr_intdup(p->odr_out, action_no);
3146 notToKeep = r->u.update->u.esRequest->notToKeep =
3147 (Z_IUSuppliedRecords *)
3148 odr_malloc(p->odr_out, sizeof(*notToKeep));
3150 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3151 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3152 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3153 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3154 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3157 notToKeep->elements[0]->u.opaque =
3158 odr_create_Odr_oct(p->odr_out,
3159 (const unsigned char *) recordIdOpaque,
3160 strlen(recordIdOpaque));
3162 else if (recordIdNumber)
3164 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3166 notToKeep->elements[0]->u.number =
3167 odr_intdup(p->odr_out, atoi(recordIdNumber));
3170 notToKeep->elements[0]->u.opaque = 0;
3171 notToKeep->elements[0]->supplementalId = 0;
3172 notToKeep->elements[0]->correlationInfo = 0;
3173 notToKeep->elements[0]->record =
3174 z_ext_record(p->odr_out, syntax_oid,
3175 record_buf, strlen(record_buf));
3179 ODR print = odr_createmem(ODR_PRINT);
3181 z_APDU(print, &apdu, 0, 0);
3188 ZOOM_package_send(ZOOM_package p, const char *type)
3195 odr_reset(p->odr_out);
3198 if (!strcmp(type, "itemorder"))
3200 apdu = create_es_package(p, VAL_ITEMORDER);
3203 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3205 r->direct_reference =
3206 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3209 r->which = Z_External_itemOrder;
3210 r->indirect_reference = 0;
3211 r->u.itemOrder = encode_item_order(p);
3213 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3216 else if (!strcmp(type, "create")) /* create database */
3218 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3221 else if (!strcmp(type, "drop")) /* drop database */
3223 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3226 else if (!strcmp(type, "commit")) /* commit changes */
3228 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3231 else if (!strcmp(type, "update")) /* update record(s) */
3233 apdu = create_update_package(p);
3235 else if (!strcmp(type, "xmlupdate"))
3237 apdu = create_xmlupdate_package(p);
3241 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3245 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3246 task->u.package = p;
3247 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3248 p->buf_out = (char *) xmalloc(p->len_out);
3249 memcpy(p->buf_out, buf, p->len_out);
3254 while (ZOOM_event(1, &c))
3261 ZOOM_API(ZOOM_package)
3262 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3264 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3267 p->odr_out = odr_createmem(ODR_ENCODE);
3268 p->options = ZOOM_options_create_with_parent2(options, c->options);
3276 ZOOM_package_destroy(ZOOM_package p)
3281 if (p->refcount == 0)
3283 odr_destroy(p->odr_out);
3286 ZOOM_options_destroy(p->options);
3291 ZOOM_API(const char *)
3292 ZOOM_package_option_get(ZOOM_package p, const char *key)
3294 return ZOOM_options_get(p->options, key);
3299 ZOOM_package_option_set(ZOOM_package p, const char *key,
3302 ZOOM_options_set(p->options, key, val);
3305 static int ZOOM_connection_exec_task(ZOOM_connection c)
3307 ZOOM_task task = c->tasks;
3308 zoom_ret ret = zoom_complete;
3312 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3313 c, task->which, task->running);
3314 if (c->error != ZOOM_ERROR_NONE)
3316 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3317 "removing tasks because of error = %d", c, c->error);
3318 ZOOM_connection_remove_tasks(c);
3323 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3324 "task already running", c);
3328 ret = zoom_complete;
3329 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3331 switch (task->which)
3333 case ZOOM_TASK_SEARCH:
3334 if (c->proto == PROTO_HTTP)
3335 ret = ZOOM_connection_srw_send_search(c);
3337 ret = ZOOM_connection_send_search(c);
3339 case ZOOM_TASK_RETRIEVE:
3340 if (c->proto == PROTO_HTTP)
3341 ret = ZOOM_connection_srw_send_search(c);
3343 ret = send_present(c);
3345 case ZOOM_TASK_CONNECT:
3346 ret = do_connect(c);
3348 case ZOOM_TASK_SCAN:
3351 case ZOOM_TASK_PACKAGE:
3352 ret = send_package(c);
3354 case ZOOM_TASK_SORT:
3355 c->tasks->u.sort.resultset->r_sort_spec =
3356 c->tasks->u.sort.q->sort_spec;
3357 ret = send_sort(c, c->tasks->u.sort.resultset);
3363 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3364 "remove tasks because no connection exist", c);
3365 ZOOM_connection_remove_tasks(c);
3367 if (ret == zoom_complete)
3369 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3370 "task removed (complete)", c);
3371 ZOOM_connection_remove_task(c);
3374 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3379 static zoom_ret send_sort_present(ZOOM_connection c)
3381 zoom_ret r = zoom_complete;
3383 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3384 r = send_sort(c, c->tasks->u.search.resultset);
3385 if (r == zoom_complete)
3386 r = send_present(c);
3390 static int es_response(ZOOM_connection c,
3391 Z_ExtendedServicesResponse *res)
3393 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3395 if (res->diagnostics && res->num_diagnostics > 0)
3396 response_diag(c, res->diagnostics[0]);
3397 if (res->taskPackage &&
3398 res->taskPackage->which == Z_External_extendedService)
3400 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3401 Odr_oct *id = taskPackage->targetReference;
3404 ZOOM_options_setl(c->tasks->u.package->options,
3405 "targetReference", (char*) id->buf, id->len);
3407 if (res->taskPackage &&
3408 res->taskPackage->which == Z_External_octet)
3410 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3411 ZOOM_options_setl(c->tasks->u.package->options,
3412 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3417 static void interpret_init_diag(ZOOM_connection c,
3418 Z_DiagnosticFormat *diag)
3422 Z_DiagnosticFormat_s *ds = diag->elements[0];
3423 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3424 response_default_diag(c, ds->u.defaultDiagRec);
3429 static void interpret_otherinformation_field(ZOOM_connection c,
3430 Z_OtherInformation *ui)
3433 for (i = 0; i < ui->num_elements; i++)
3435 Z_OtherInformationUnit *unit = ui->list[i];
3436 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3437 unit->information.externallyDefinedInfo &&
3438 unit->information.externallyDefinedInfo->which ==
3441 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3447 static void set_init_option(const char *name, void *clientData) {
3448 ZOOM_connection c = clientData;
3451 sprintf(buf, "init_opt_%.70s", name);
3452 ZOOM_connection_option_set(c, buf, "1");
3456 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3458 Z_InitResponse *initrs;
3460 ZOOM_connection_set_mask(c, 0);
3461 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3464 case Z_APDU_initResponse:
3465 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3466 initrs = apdu->u.initResponse;
3467 ZOOM_connection_option_set(c, "serverImplementationId",
3468 initrs->implementationId ?
3469 initrs->implementationId : "");
3470 ZOOM_connection_option_set(c, "serverImplementationName",
3471 initrs->implementationName ?
3472 initrs->implementationName : "");
3473 ZOOM_connection_option_set(c, "serverImplementationVersion",
3474 initrs->implementationVersion ?
3475 initrs->implementationVersion : "");
3476 /* Set the three old options too, for old applications */
3477 ZOOM_connection_option_set(c, "targetImplementationId",
3478 initrs->implementationId ?
3479 initrs->implementationId : "");
3480 ZOOM_connection_option_set(c, "targetImplementationName",
3481 initrs->implementationName ?
3482 initrs->implementationName : "");
3483 ZOOM_connection_option_set(c, "targetImplementationVersion",
3484 initrs->implementationVersion ?
3485 initrs->implementationVersion : "");
3487 /* Make initrs->options available as ZOOM-level options */
3488 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3490 if (!*initrs->result)
3492 Z_External *uif = initrs->userInformationField;
3494 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3496 if (uif && uif->which == Z_External_userInfo1)
3497 interpret_otherinformation_field(c, uif->u.userInfo1);
3502 yaz_oi_get_string_oidval(&apdu->u.initResponse->otherInfo,
3504 xfree(c->cookie_in);
3507 c->cookie_in = xstrdup(cookie);
3508 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3509 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3510 c->support_named_resultsets = 1;
3513 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3514 ZOOM_connection_remove_task(c);
3516 ZOOM_connection_exec_task(c);
3518 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3520 NMEM tmpmem = nmem_create();
3521 Z_CharSetandLanguageNegotiation *p =
3522 yaz_get_charneg_record(initrs->otherInfo);
3526 char *charset = NULL, *lang = NULL;
3529 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3530 yaz_log(log_details, "%p recv_apdu target accepted: "
3531 "charset %s, language %s, select %d",
3533 charset ? charset : "none", lang ? lang : "none", sel);
3535 ZOOM_connection_option_set(c, "negotiation-charset",
3538 ZOOM_connection_option_set(c, "negotiation-lang",
3541 ZOOM_connection_option_set(
3542 c, "negotiation-charset-in-effect-for-records",
3543 (sel != 0) ? "1" : "0");
3544 nmem_destroy(tmpmem);
3548 case Z_APDU_searchResponse:
3549 yaz_log(log_api, "%p recv_apdu Search response", c);
3550 handle_search_response(c, apdu->u.searchResponse);
3551 if (send_sort_present(c) == zoom_complete)
3552 ZOOM_connection_remove_task(c);
3554 case Z_APDU_presentResponse:
3555 yaz_log(log_api, "%p recv_apdu Present response", c);
3556 handle_present_response(c, apdu->u.presentResponse);
3557 if (send_present(c) == zoom_complete)
3558 ZOOM_connection_remove_task(c);
3560 case Z_APDU_sortResponse:
3561 yaz_log(log_api, "%p recv_apdu Sort response", c);
3562 sort_response(c, apdu->u.sortResponse);
3563 if (send_present(c) == zoom_complete)
3564 ZOOM_connection_remove_task(c);
3566 case Z_APDU_scanResponse:
3567 yaz_log(log_api, "%p recv_apdu Scan response", c);
3568 scan_response(c, apdu->u.scanResponse);
3569 ZOOM_connection_remove_task(c);
3571 case Z_APDU_extendedServicesResponse:
3572 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3573 es_response(c, apdu->u.extendedServicesResponse);
3574 ZOOM_connection_remove_task(c);
3577 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3578 if (!ZOOM_test_reconnect(c))
3580 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3585 yaz_log(log_api, "%p Received unknown PDU", c);
3586 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3592 static void handle_srw_response(ZOOM_connection c,
3593 Z_SRW_searchRetrieveResponse *res)
3595 ZOOM_resultset resultset = 0;
3600 const char *syntax, *elementSetName;
3605 switch(c->tasks->which)
3607 case ZOOM_TASK_SEARCH:
3608 resultset = c->tasks->u.search.resultset;
3609 start = &c->tasks->u.search.start;
3610 syntax = c->tasks->u.search.syntax;
3611 elementSetName = c->tasks->u.search.elementSetName;
3613 case ZOOM_TASK_RETRIEVE:
3614 resultset = c->tasks->u.retrieve.resultset;
3615 start = &c->tasks->u.retrieve.start;
3616 syntax = c->tasks->u.retrieve.syntax;
3617 elementSetName = c->tasks->u.retrieve.elementSetName;
3622 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3623 ZOOM_connection_put_event(c, event);
3625 resultset->size = 0;
3627 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3629 if (res->numberOfRecords)
3630 resultset->size = *res->numberOfRecords;
3632 for (i = 0; i<res->num_records; i++)
3636 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3637 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3639 if (res->records[i].recordPosition &&
3640 *res->records[i].recordPosition > 0)
3641 pos = *res->records[i].recordPosition - 1;
3645 npr->databaseName = 0;
3646 npr->which = Z_NamePlusRecord_databaseRecord;
3647 npr->u.databaseRecord = (Z_External *)
3648 odr_malloc(c->odr_in, sizeof(Z_External));
3649 npr->u.databaseRecord->descriptor = 0;
3650 npr->u.databaseRecord->direct_reference =
3651 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3652 npr->u.databaseRecord->which = Z_External_octet;
3654 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3655 odr_malloc(c->odr_in, sizeof(Odr_oct));
3656 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3657 res->records[i].recordData_buf;
3658 npr->u.databaseRecord->u.octet_aligned->len =
3659 npr->u.databaseRecord->u.octet_aligned->size =
3660 res->records[i].recordData_len;
3661 record_cache_add(resultset, npr, pos, syntax, elementSetName);
3663 if (res->num_diagnostics > 0)
3665 const char *uri = res->diagnostics[0].uri;
3670 if ((cp = strrchr(uri, '/')))
3672 set_dset_error(c, code, uri,
3673 res->diagnostics[0].details, 0);
3676 nmem = odr_extract_mem(c->odr_in);
3677 nmem_transfer(resultset->odr->mem, nmem);
3683 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3686 const char *content_type = z_HTTP_header_lookup(hres->headers,
3688 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3690 ZOOM_connection_set_mask(c, 0);
3691 yaz_log(log_details, "%p handle_http", c);
3693 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3695 Z_SOAP *soap_package = 0;
3697 Z_SOAP_Handler soap_handlers[2] = {
3698 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
3701 ret = z_soap_codec(o, &soap_package,
3702 &hres->content_buf, &hres->content_len,
3704 if (!ret && soap_package->which == Z_SOAP_generic &&
3705 soap_package->u.generic->no == 0)
3707 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3708 if (sr->which == Z_SRW_searchRetrieve_response)
3709 handle_srw_response(c, sr->u.response);
3713 else if (!ret && (soap_package->which == Z_SOAP_fault
3714 || soap_package->which == Z_SOAP_error))
3716 set_HTTP_error(c, hres->code,
3717 soap_package->u.fault->fault_code,
3718 soap_package->u.fault->fault_string);
3725 if (hres->code != 200)
3726 set_HTTP_error(c, hres->code, 0, 0);
3728 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3731 ZOOM_connection_remove_task(c);
3732 if (!strcmp(hres->version, "1.0"))
3734 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3735 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3740 /* HTTP 1.1: only if no close we stay alive .. */
3741 if (connection_head && !strcmp(connection_head, "close"))
3747 static int do_read(ZOOM_connection c)
3752 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3753 ZOOM_connection_put_event(c, event);
3755 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3756 more = cs_more(c->cs);
3757 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3762 if (ZOOM_test_reconnect(c))
3764 yaz_log(log_details, "%p do_read reconnect read", c);
3768 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3777 odr_reset(c->odr_in);
3778 odr_setbuf(c->odr_in, c->buf_in, r, 0);
3779 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3780 ZOOM_connection_put_event(c, event);
3782 if (!z_GDU(c->odr_in, &gdu, 0, 0))
3785 int err = odr_geterrorx(c->odr_in, &x);
3787 const char *element = odr_getelement(c->odr_in);
3788 sprintf(msg, "ODR code %d:%d element=%-20s",
3789 err, x, element ? element : "<unknown>");
3790 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3793 else if (gdu->which == Z_GDU_Z3950)
3794 recv_apdu(c, gdu->u.z3950);
3795 else if (gdu->which == Z_GDU_HTTP_Response)
3798 handle_http(c, gdu->u.HTTP_Response);
3800 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3804 c->reconnect_ok = 0;
3809 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3814 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3815 ZOOM_connection_put_event(c, event);
3817 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3818 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3820 yaz_log(log_details, "%p do_write_ex write failed", c);
3821 if (ZOOM_test_reconnect(c))
3823 return zoom_pending;
3825 if (c->state == STATE_CONNECTING)
3826 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3828 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3830 return zoom_complete;
3834 int mask = ZOOM_SELECT_EXCEPT;
3835 if (c->cs->io_pending & CS_WANT_WRITE)
3836 mask += ZOOM_SELECT_WRITE;
3837 if (c->cs->io_pending & CS_WANT_READ)
3838 mask += ZOOM_SELECT_READ;
3839 ZOOM_connection_set_mask(c, mask);
3840 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3845 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
3846 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3849 return zoom_pending;
3852 static zoom_ret do_write(ZOOM_connection c)
3854 return do_write_ex(c, c->buf_out, c->len_out);
3858 ZOOM_API(const char *)
3859 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3861 return ZOOM_options_get(c->options, key);
3864 ZOOM_API(const char *)
3865 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3867 return ZOOM_options_getl(c->options, key, lenp);
3871 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3874 ZOOM_options_set(c->options, key, val);
3878 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3879 const char *val, int len)
3881 ZOOM_options_setl(c->options, key, val, len);
3884 ZOOM_API(const char *)
3885 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3887 return ZOOM_options_get(r->options, key);
3891 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3894 ZOOM_options_set(r->options, key, val);
3899 ZOOM_connection_errcode(ZOOM_connection c)
3901 return ZOOM_connection_error(c, 0, 0);
3904 ZOOM_API(const char *)
3905 ZOOM_connection_errmsg(ZOOM_connection c)
3908 ZOOM_connection_error(c, &msg, 0);
3912 ZOOM_API(const char *)
3913 ZOOM_connection_addinfo(ZOOM_connection c)
3915 const char *addinfo;
3916 ZOOM_connection_error(c, 0, &addinfo);
3920 ZOOM_API(const char *)
3921 ZOOM_connection_diagset(ZOOM_connection c)
3923 const char *diagset;
3924 ZOOM_connection_error_x(c, 0, 0, &diagset);
3928 ZOOM_API(const char *)
3929 ZOOM_diag_str(int error)
3933 case ZOOM_ERROR_NONE:
3935 case ZOOM_ERROR_CONNECT:
3936 return "Connect failed";
3937 case ZOOM_ERROR_MEMORY:
3938 return "Out of memory";
3939 case ZOOM_ERROR_ENCODE:
3940 return "Encoding failed";
3941 case ZOOM_ERROR_DECODE:
3942 return "Decoding failed";
3943 case ZOOM_ERROR_CONNECTION_LOST:
3944 return "Connection lost";
3945 case ZOOM_ERROR_INIT:
3946 return "Init rejected";
3947 case ZOOM_ERROR_INTERNAL:
3948 return "Internal failure";
3949 case ZOOM_ERROR_TIMEOUT:
3951 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3952 return "Unsupported protocol";
3953 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3954 return "Unsupported query type";
3955 case ZOOM_ERROR_INVALID_QUERY:
3956 return "Invalid query";
3957 case ZOOM_ERROR_CQL_PARSE:
3958 return "CQL parsing error";
3959 case ZOOM_ERROR_CQL_TRANSFORM:
3960 return "CQL transformation error";
3961 case ZOOM_ERROR_CCL_CONFIG:
3962 return "CCL configuration error";
3963 case ZOOM_ERROR_CCL_PARSE:
3964 return "CCL parsing error";
3966 return diagbib1_str(error);
3971 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
3972 const char **addinfo, const char **diagset)
3974 int error = c->error;
3977 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3978 *cp = ZOOM_diag_str(error);
3979 else if (!strcmp(c->diagset, "HTTP"))
3980 *cp = z_HTTP_errmsg(c->error);
3981 else if (!strcmp(c->diagset, "Bib-1"))
3982 *cp = ZOOM_diag_str(error);
3983 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3984 *cp = yaz_diag_srw_str(c->error);
3986 *cp = "Unknown error and diagnostic set";
3989 *addinfo = c->addinfo ? c->addinfo : "";
3991 *diagset = c->diagset ? c->diagset : "";
3996 ZOOM_connection_error(ZOOM_connection c, const char **cp,
3997 const char **addinfo)
3999 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4002 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4004 ZOOM_Event event = 0;
4005 int r = cs_look(c->cs);
4006 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4011 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4012 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4014 ZOOM_connection_put_event(c, event);
4016 else if (r == CS_CONNECT)
4018 int ret = ret = cs_rcvconnect(c->cs);
4019 yaz_log(log_details, "%p ZOOM_connection_do_io "
4020 "cs_rcvconnect returned %d", c, ret);
4023 int mask = ZOOM_SELECT_EXCEPT;
4024 if (c->cs->io_pending & CS_WANT_WRITE)
4025 mask += ZOOM_SELECT_WRITE;
4026 if (c->cs->io_pending & CS_WANT_READ)
4027 mask += ZOOM_SELECT_READ;
4028 ZOOM_connection_set_mask(c, mask);
4032 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4033 ZOOM_connection_put_event(c, event);
4035 if (c->proto == PROTO_Z3950)
4036 ZOOM_connection_send_init(c);
4039 /* no init request for SRW .. */
4040 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4041 ZOOM_connection_remove_task(c);
4042 ZOOM_connection_set_mask(c, 0);
4043 ZOOM_connection_exec_task(c);
4045 c->state = STATE_ESTABLISHED;
4049 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4055 if (mask & ZOOM_SELECT_EXCEPT)
4057 if (ZOOM_test_reconnect(c))
4059 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4060 ZOOM_connection_put_event(c, event);
4064 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4069 if (mask & ZOOM_SELECT_READ)
4071 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4077 ZOOM_connection_last_event(ZOOM_connection cs)
4080 return ZOOM_EVENT_NONE;
4081 return cs->last_event;
4086 * Returns an xmalloc()d string containing RPN that corresponds to the
4087 * CQL passed in. On error, sets the Connection object's error state
4088 * and returns a null pointer.
4089 * ### We could cache CQL parser and/or transformer in Connection.
4091 static char *cql2pqf(ZOOM_connection c, const char *cql)
4095 struct cql_node *node;
4096 const char *cqlfile;
4097 static cql_transform_t trans;
4100 parser = cql_parser_create();
4101 if ((error = cql_parser_string(parser, cql)) != 0) {
4102 cql_parser_destroy(parser);
4103 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4107 node = cql_parser_result(parser);
4108 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4110 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4112 cql_parser_destroy(parser);
4113 cql_node_destroy(node);
4114 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4118 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4120 cql_parser_destroy(parser);
4121 cql_node_destroy(node);
4122 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4123 cqlfile, strerror(errno));
4124 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4128 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4129 cql_parser_destroy(parser);
4130 cql_node_destroy(node);
4133 const char *addinfo;
4134 error = cql_transform_error(trans, &addinfo);
4135 cql_transform_close(trans);
4136 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4137 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4141 cql_transform_close(trans);
4142 return xstrdup(pqfbuf);
4145 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4149 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4150 /* timeout and this connection was waiting */
4151 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4153 ZOOM_connection_put_event(c, event);
4159 ZOOM_connection_process(ZOOM_connection c)
4165 event = ZOOM_connection_get_event(c);
4168 ZOOM_Event_destroy(event);
4171 ZOOM_connection_exec_task(c);
4172 event = ZOOM_connection_get_event(c);
4175 ZOOM_Event_destroy(event);
4182 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4186 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4188 for (i = 0; i<no; i++)
4190 ZOOM_connection c = cs[i];
4192 if (c && ZOOM_connection_process(c))
4198 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4200 if (c->mask && mask)
4201 ZOOM_connection_do_io(c, mask);
4205 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4208 return cs_fileno(c->cs);
4212 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4220 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4227 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4229 return ZOOM_options_get_int(c->options, "timeout", 30);
4235 * indent-tabs-mode: nil
4237 * vim: shiftwidth=4 tabstop=8 expandtab