2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.113 2007-02-21 09:19:26 adam Exp $
9 * \brief Implements ZOOM C interface.
17 #include <yaz/yaz-util.h>
18 #include <yaz/xmalloc.h>
19 #include <yaz/otherinfo.h>
21 #include <yaz/pquery.h>
22 #include <yaz/marcdisp.h>
23 #include <yaz/diagbib1.h>
24 #include <yaz/charneg.h>
32 static int log_api = 0;
33 static int log_details = 0;
40 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
41 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
42 static char *cql2pqf(ZOOM_connection c, const char *cql);
46 * This wrapper is just for logging failed lookups. It would be nicer
47 * if it could cause failure when a lookup fails, but that's hard.
49 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
50 int oid_class, const char *str) {
51 Odr_oid *res = yaz_str_to_z3950oid(c->odr_out, oid_class, str);
53 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
54 c, (int) oid_class, str);
59 static void initlog(void)
61 static int log_level_initialized = 0;
62 if (!log_level_initialized)
64 log_api = yaz_log_module_level("zoom");
65 log_details = yaz_log_module_level("zoomdetails");
66 log_level_initialized = 1;
70 static ZOOM_Event ZOOM_Event_create(int kind)
72 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
76 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
80 static void ZOOM_Event_destroy(ZOOM_Event event)
85 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
89 c->m_queue_back->prev = event;
90 assert(c->m_queue_front);
94 assert(!c->m_queue_front);
95 c->m_queue_front = event;
97 event->next = c->m_queue_back;
99 c->m_queue_back = event;
102 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
104 ZOOM_Event event = c->m_queue_front;
107 c->last_event = ZOOM_EVENT_NONE;
110 assert(c->m_queue_back);
111 c->m_queue_front = event->prev;
112 if (c->m_queue_front)
114 assert(c->m_queue_back);
115 c->m_queue_front->next = 0;
119 c->last_event = event->kind;
123 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
125 ZOOM_Event event = c->m_queue_front;
127 return event ? event->kind : ZOOM_EVENT_NONE;
130 void ZOOM_connection_remove_tasks(ZOOM_connection c);
132 static void set_dset_error(ZOOM_connection c, int error,
134 const char *addinfo, const char *addinfo2)
141 if (!c->diagset || strcmp(dset, c->diagset))
144 c->diagset = xstrdup(dset);
145 /* remove integer part from SRW diagset .. */
146 if ((cp = strrchr(c->diagset, '/')))
149 if (addinfo && addinfo2)
151 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
152 strcpy(c->addinfo, addinfo);
153 strcat(c->addinfo, addinfo2);
156 c->addinfo = xstrdup(addinfo);
157 if (error != ZOOM_ERROR_NONE)
159 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
160 c, c->host_port ? c->host_port : "<>", dset, error,
161 addinfo ? addinfo : "",
162 addinfo2 ? addinfo2 : "");
164 ZOOM_connection_remove_tasks(c);
170 static void set_HTTP_error(ZOOM_connection c, int error,
171 const char *addinfo, const char *addinfo2)
173 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
178 static void set_ZOOM_error(ZOOM_connection c, int error,
181 set_dset_error(c, error, "ZOOM", addinfo, 0);
184 static void clear_error(ZOOM_connection c)
187 * If an error is tied to an operation then it's ok to clear: for
188 * example, a diagnostic returned from a search is cleared by a
189 * subsequent search. However, problems such as Connection Lost
190 * or Init Refused are not cleared, because they are not
191 * recoverable: doing another search doesn't help.
195 case ZOOM_ERROR_CONNECT:
196 case ZOOM_ERROR_MEMORY:
197 case ZOOM_ERROR_DECODE:
198 case ZOOM_ERROR_CONNECTION_LOST:
199 case ZOOM_ERROR_INIT:
200 case ZOOM_ERROR_INTERNAL:
201 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
204 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
208 void ZOOM_connection_show_task(ZOOM_task task)
212 case ZOOM_TASK_SEARCH:
213 yaz_log(YLOG_LOG, "search p=%p", task);
215 case ZOOM_TASK_RETRIEVE:
216 yaz_log(YLOG_LOG, "retrieve p=%p", task);
218 case ZOOM_TASK_CONNECT:
219 yaz_log(YLOG_LOG, "connect p=%p", task);
222 yaz_log(YLOG_LOG, "scant p=%p", task);
227 void ZOOM_connection_show_tasks(ZOOM_connection c)
230 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
231 for (task = c->tasks; task; task = task->next)
232 ZOOM_connection_show_task(task);
235 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
237 ZOOM_task *taskp = &c->tasks;
239 taskp = &(*taskp)->next;
240 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
241 (*taskp)->running = 0;
242 (*taskp)->which = which;
248 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
250 return c->tasks ? 0 : 1;
253 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
255 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
257 task->next = c->tasks;
266 void ZOOM_connection_remove_task(ZOOM_connection c)
268 ZOOM_task task = c->tasks;
272 c->tasks = task->next;
275 case ZOOM_TASK_SEARCH:
276 ZOOM_resultset_destroy(task->u.search.resultset);
277 xfree(task->u.search.syntax);
278 xfree(task->u.search.elementSetName);
280 case ZOOM_TASK_RETRIEVE:
281 ZOOM_resultset_destroy(task->u.retrieve.resultset);
282 xfree(task->u.retrieve.syntax);
283 xfree(task->u.retrieve.elementSetName);
285 case ZOOM_TASK_CONNECT:
288 ZOOM_scanset_destroy(task->u.scan.scan);
290 case ZOOM_TASK_PACKAGE:
291 ZOOM_package_destroy(task->u.package);
294 ZOOM_resultset_destroy(task->u.sort.resultset);
295 ZOOM_query_destroy(task->u.sort.q);
304 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
305 ZOOM_connection_put_event(c, event);
310 static int ZOOM_connection_exec_task(ZOOM_connection c);
312 void ZOOM_connection_remove_tasks(ZOOM_connection c)
315 ZOOM_connection_remove_task(c);
318 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
320 const char *elementSetName);
322 ZOOM_API(ZOOM_connection)
323 ZOOM_connection_create(ZOOM_options options)
325 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
329 yaz_log(log_api, "%p ZOOM_connection_create", c);
331 c->proto = PROTO_Z3950;
333 ZOOM_connection_set_mask(c, 0);
335 c->state = STATE_IDLE;
338 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
345 c->options = ZOOM_options_create_with_parent(options);
351 c->charset = c->lang = 0;
358 c->odr_in = odr_createmem(ODR_DECODE);
359 c->odr_out = odr_createmem(ODR_ENCODE);
362 c->support_named_resultsets = 0;
363 c->last_event = ZOOM_EVENT_NONE;
365 c->m_queue_front = 0;
371 /* set database names. Take local databases (if set); otherwise
372 take databases given in ZURL (if set); otherwise use Default */
373 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
376 char **databaseNames;
377 const char *cp = ZOOM_options_get(options, "databaseName");
379 if ((!cp || !*cp) && con->host_port)
381 if (strncmp(con->host_port, "unix:", 5) == 0)
382 cp = strchr(con->host_port+5, ':');
384 cp = strchr(con->host_port, '/');
390 nmem_strsplit(odr->mem, "+", cp, &databaseNames, num);
391 return databaseNames;
394 ZOOM_API(ZOOM_connection)
395 ZOOM_connection_new(const char *host, int portnum)
397 ZOOM_connection c = ZOOM_connection_create(0);
399 ZOOM_connection_connect(c, host, portnum);
403 static zoom_sru_mode get_sru_mode_from_string(const char *s)
406 return zoom_sru_soap;
407 if (!yaz_matchstr(s, "soap"))
408 return zoom_sru_soap;
409 else if (!yaz_matchstr(s, "get"))
411 else if (!yaz_matchstr(s, "post"))
412 return zoom_sru_post;
413 return zoom_sru_error;
417 ZOOM_connection_connect(ZOOM_connection c,
418 const char *host, int portnum)
425 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
428 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
429 ZOOM_connection_remove_tasks(c);
433 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
437 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
439 val = ZOOM_options_get(c->options, "proxy");
442 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
443 c->proxy = xstrdup(val);
449 val = ZOOM_options_get(c->options, "charset");
452 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
453 c->charset = xstrdup(val);
459 val = ZOOM_options_get(c->options, "lang");
462 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
463 c->lang = xstrdup(val);
472 sprintf(hostn, "%.80s:%d", host, portnum);
473 c->host_port = xstrdup(hostn);
476 c->host_port = xstrdup(host);
480 * If the "<scheme>:" part of the host string is preceded by one
481 * or more comma-separated <name>=<value> pairs, these are taken
482 * to be options to be set on the connection object. Among other
483 * applications, this facility can be used to embed authentication
485 * user=admin,password=secret,tcp:localhost:9999
487 char *remainder = c->host_port;
488 char *pcolon = strchr(remainder, ':');
491 while ((pcomma = strchr(remainder, ',')) != 0 &&
492 (pcolon == 0 || pcomma < pcolon)) {
494 if ((pequals = strchr(remainder, '=')) != 0) {
496 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
497 ZOOM_connection_option_set(c, remainder, pequals+1);
499 remainder = pcomma+1;
502 if (remainder != c->host_port) {
504 c->host_port = xstrdup(remainder);
505 /*printf("# reset hp='%s'\n", remainder);*/
509 val = ZOOM_options_get(c->options, "sru");
510 c->sru_mode = get_sru_mode_from_string(val);
512 ZOOM_options_set(c->options, "host", c->host_port);
514 val = ZOOM_options_get(c->options, "cookie");
517 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
518 c->cookie_out = xstrdup(val);
521 val = ZOOM_options_get(c->options, "clientIP");
524 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
526 c->client_IP = xstrdup(val);
529 c->async = ZOOM_options_get_bool(c->options, "async", 0);
530 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
532 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
536 while (ZOOM_event(1, &c))
542 ZOOM_query_create(void)
544 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
546 yaz_log(log_details, "%p ZOOM_query_create", s);
550 s->odr = odr_createmem(ODR_ENCODE);
557 ZOOM_query_destroy(ZOOM_query s)
563 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
564 if (s->refcount == 0)
572 ZOOM_query_prefix(ZOOM_query s, const char *str)
574 s->query_string = odr_strdup(s->odr, str);
575 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
576 s->z_query->which = Z_Query_type_1;
577 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
578 if (!s->z_query->u.type_1)
580 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
584 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
589 ZOOM_query_cql(ZOOM_query s, const char *str)
593 s->query_string = odr_strdup(s->odr, str);
595 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
596 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
597 ext->indirect_reference = 0;
599 ext->which = Z_External_CQL;
600 ext->u.cql = s->query_string;
602 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
603 s->z_query->which = Z_Query_type_104;
604 s->z_query->u.type_104 = ext;
606 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
612 * Translate the CQL string client-side into RPN which is passed to
613 * the server. This is useful for server's that don't themselves
614 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
615 * only as a place to stash diagnostics if compilation fails; if this
616 * information is not needed, a null pointer may be used.
619 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
623 ZOOM_connection freeme = 0;
625 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
627 conn = freeme = ZOOM_connection_create(0);
629 rpn = cql2pqf(conn, str);
631 ZOOM_connection_destroy(freeme);
635 ret = ZOOM_query_prefix(s, rpn);
641 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
642 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
643 * to the server, as the YAZ GFS doesn't know how to handle this.
646 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
647 int *ccl_error, const char **error_string,
651 struct ccl_rpn_node *rpn;
652 CCL_bibset bibset = ccl_qual_mk();
655 ccl_qual_buf(bibset, config);
657 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
660 *error_string = ccl_err_msg(*ccl_error);
665 WRBUF wr = wrbuf_alloc();
668 ret = ZOOM_query_prefix(s, wrbuf_buf(wr));
671 ccl_qual_rm(&bibset);
676 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
678 s->sort_spec = yaz_sort_spec(s->odr, criteria);
681 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
685 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
689 static zoom_ret do_write(ZOOM_connection c);
692 ZOOM_connection_destroy(ZOOM_connection c)
697 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
700 for (r = c->resultsets; r; r = r->next)
706 odr_destroy(c->odr_in);
707 odr_destroy(c->odr_out);
708 ZOOM_options_destroy(c->options);
709 ZOOM_connection_remove_tasks(c);
715 xfree(c->cookie_out);
721 void ZOOM_resultset_addref(ZOOM_resultset r)
726 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
731 ZOOM_resultset ZOOM_resultset_create(void)
734 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
738 yaz_log(log_details, "%p ZOOM_resultset_create", r);
741 r->odr = odr_createmem(ODR_ENCODE);
746 for (i = 0; i<RECORD_HASH_SIZE; i++)
747 r->record_hash[i] = 0;
752 r->databaseNames = 0;
753 r->num_databaseNames = 0;
757 ZOOM_API(ZOOM_resultset)
758 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
761 ZOOM_query s = ZOOM_query_create();
763 ZOOM_query_prefix(s, q);
765 r = ZOOM_connection_search(c, s);
766 ZOOM_query_destroy(s);
770 ZOOM_API(ZOOM_resultset)
771 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
773 ZOOM_resultset r = ZOOM_resultset_create();
777 const char *syntax, *elementSetName;
779 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
780 r->r_sort_spec = q->sort_spec;
783 r->options = ZOOM_options_create_with_parent(c->options);
785 start = ZOOM_options_get_int(r->options, "start", 0);
786 count = ZOOM_options_get_int(r->options, "count", 0);
788 /* If "presentChunk" is defined use that; otherwise "step" */
789 const char *cp = ZOOM_options_get(r->options, "presentChunk");
790 r->step = ZOOM_options_get_int(r->options,
791 (cp != 0 ? "presentChunk": "step"), 0);
793 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
794 cp = ZOOM_options_get(r->options, "setname");
796 r->setname = xstrdup(cp);
797 cp = ZOOM_options_get(r->options, "schema");
799 r->schema = xstrdup(cp);
801 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
806 r->next = c->resultsets;
809 if (c->host_port && c->proto == PROTO_HTTP)
813 yaz_log(log_details, "ZOOM_connection_search: no comstack");
814 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
818 yaz_log(log_details, "ZOOM_connection_search: reconnect");
823 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
824 task->u.search.resultset = r;
825 task->u.search.start = start;
826 task->u.search.count = count;
828 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
829 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
830 elementSetName = ZOOM_options_get(r->options, "elementSetName");
831 task->u.search.elementSetName = elementSetName
832 ? xstrdup(elementSetName) : 0;
834 ZOOM_resultset_addref(r);
840 while (ZOOM_event(1, &c))
847 * This is the old result-set sorting API, which is maintained only
848 * for the sake of binary compatibility. There is no reason ever to
849 * use this rather than ZOOM_resultset_sort1().
852 ZOOM_resultset_sort(ZOOM_resultset r,
853 const char *sort_type, const char *sort_spec)
855 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
859 ZOOM_resultset_sort1(ZOOM_resultset r,
860 const char *sort_type, const char *sort_spec)
862 ZOOM_connection c = r->connection;
866 newq = ZOOM_query_create();
867 if (ZOOM_query_sortby(newq, sort_spec) < 0)
870 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
871 r, r, sort_type, sort_spec);
875 if (c->host_port && c->proto == PROTO_HTTP)
879 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
880 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
884 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
890 ZOOM_resultset_cache_reset(r);
891 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
892 task->u.sort.resultset = r;
893 task->u.sort.q = newq;
895 ZOOM_resultset_addref(r);
899 while (ZOOM_event(1, &c))
907 ZOOM_resultset_cache_reset(ZOOM_resultset r)
910 for (i = 0; i<RECORD_HASH_SIZE; i++)
912 ZOOM_record_cache rc;
913 for (rc = r->record_hash[i]; rc; rc = rc->next)
915 if (rc->rec.wrbuf_marc)
916 wrbuf_free(rc->rec.wrbuf_marc, 1);
917 if (rc->rec.wrbuf_iconv)
918 wrbuf_free(rc->rec.wrbuf_iconv, 1);
919 if (rc->rec.wrbuf_opac)
920 wrbuf_free(rc->rec.wrbuf_opac, 1);
922 r->record_hash[i] = 0;
927 ZOOM_resultset_destroy(ZOOM_resultset r)
932 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
934 if (r->refcount == 0)
936 ZOOM_resultset_cache_reset(r);
940 /* remove ourselves from the resultsets in connection */
941 ZOOM_resultset *rp = &r->connection->resultsets;
944 assert(*rp); /* we must be in this list!! */
946 { /* OK, we're here - take us out of it */
953 ZOOM_query_destroy(r->query);
954 ZOOM_options_destroy(r->options);
963 ZOOM_resultset_size(ZOOM_resultset r)
965 yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
970 static void do_close(ZOOM_connection c)
975 ZOOM_connection_set_mask(c, 0);
976 c->state = STATE_IDLE;
979 static int ZOOM_test_reconnect(ZOOM_connection c)
981 if (!c->reconnect_ok)
985 c->tasks->running = 0;
986 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
990 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
991 int force_sync, int start, int count)
996 const char *syntax, *elementSetName;
1000 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1001 " count=%d", r, force_sync, start, count);
1006 if (c->host_port && c->proto == PROTO_HTTP)
1010 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1011 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1015 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1017 c->reconnect_ok = 1;
1020 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1021 task->u.retrieve.resultset = r;
1022 task->u.retrieve.start = start;
1023 task->u.retrieve.count = count;
1025 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1026 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1027 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1028 task->u.retrieve.elementSetName = elementSetName
1029 ? xstrdup(elementSetName) : 0;
1031 cp = ZOOM_options_get(r->options, "schema");
1034 if (!r->schema || strcmp(r->schema, cp))
1037 r->schema = xstrdup(cp);
1041 ZOOM_resultset_addref(r);
1043 if (!r->connection->async || force_sync)
1044 while (r->connection && ZOOM_event(1, &r->connection))
1049 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1050 size_t start, size_t count)
1052 int force_present = 0;
1056 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1057 r, r, (long) start, (long) count);
1060 ZOOM_resultset_retrieve(r, force_present, start, count);
1064 for (i = 0; i< count; i++)
1065 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1069 static void get_cert(ZOOM_connection c)
1074 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1076 ZOOM_connection_option_setl(c, "sslPeerCert",
1077 cert_buf, cert_len);
1082 static zoom_ret do_connect(ZOOM_connection c)
1085 const char *effective_host;
1088 effective_host = c->proxy;
1090 effective_host = c->host_port;
1092 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1096 c->cs = cs_create_host(effective_host, 0, &add);
1098 if (c->cs && c->cs->protocol == PROTO_HTTP)
1101 const char *path = 0;
1103 c->proto = PROTO_HTTP;
1104 cs_get_host_args(c->host_port, &path);
1106 c->path = (char*) xmalloc(strlen(path)+2);
1108 strcpy(c->path+1, path);
1110 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1112 return zoom_complete;
1117 int ret = cs_connect(c->cs, add);
1120 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1121 ZOOM_connection_put_event(c, event);
1123 if (c->proto == PROTO_Z3950)
1124 ZOOM_connection_send_init(c);
1127 /* no init request for SRW .. */
1128 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1129 ZOOM_connection_remove_task(c);
1130 ZOOM_connection_set_mask(c, 0);
1131 ZOOM_connection_exec_task(c);
1133 c->state = STATE_ESTABLISHED;
1134 return zoom_pending;
1138 int mask = ZOOM_SELECT_EXCEPT;
1139 if (c->cs->io_pending & CS_WANT_WRITE)
1140 mask += ZOOM_SELECT_WRITE;
1141 if (c->cs->io_pending & CS_WANT_READ)
1142 mask += ZOOM_SELECT_READ;
1143 ZOOM_connection_set_mask(c, mask);
1144 c->state = STATE_CONNECTING;
1145 return zoom_pending;
1148 c->state = STATE_IDLE;
1149 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1150 return zoom_complete;
1153 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1156 for (i = 0; i<200; i++)
1159 Z_OtherInformation **oi;
1165 sprintf(buf, "otherInfo%d", i);
1166 val = ZOOM_options_get(c->options, buf);
1169 cp = strchr(val, ':');
1173 if (len >= sizeof(buf))
1174 len = sizeof(buf)-1;
1175 memcpy(buf, val, len);
1177 oidval = oid_getvalbyname(buf);
1178 if (oidval == VAL_NONE)
1181 yaz_oi_APDU(a, &oi);
1182 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1186 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1191 Z_OtherInformation **oi;
1192 yaz_oi_APDU(a, &oi);
1193 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1197 Z_OtherInformation **oi;
1198 yaz_oi_APDU(a, &oi);
1199 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1201 otherInfo_attach(c, a, out);
1202 if (!z_APDU(out, &a, 0, 0))
1204 FILE *outf = fopen("/tmp/apdu.txt", "a");
1207 ODR odr_pr = odr_createmem(ODR_PRINT);
1208 fprintf(outf, "a=%p\n", a);
1209 odr_setprint(odr_pr, outf);
1210 z_APDU(odr_pr, &a, 0, 0);
1211 odr_destroy(odr_pr);
1213 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1214 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1218 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1222 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1226 if (encode_APDU(c, a, c->odr_out))
1227 return zoom_complete;
1228 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1229 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1230 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1231 ZOOM_connection_put_event(c, event);
1232 odr_reset(c->odr_out);
1236 /* returns 1 if PDU was sent OK (still pending )
1237 0 if PDU was not sent OK (nothing to wait for)
1240 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1242 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1243 Z_InitRequest *ireq = apdu->u.initRequest;
1244 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1245 odr_malloc(c->odr_out, sizeof(*auth));
1246 const char *auth_groupId = ZOOM_options_get(c->options, "group");
1247 const char *auth_userId = ZOOM_options_get(c->options, "user");
1248 const char *auth_password = ZOOM_options_get(c->options, "password");
1251 /* support the pass for backwards compatibility */
1253 auth_password = ZOOM_options_get(c->options, "pass");
1255 ODR_MASK_SET(ireq->options, Z_Options_search);
1256 ODR_MASK_SET(ireq->options, Z_Options_present);
1257 ODR_MASK_SET(ireq->options, Z_Options_scan);
1258 ODR_MASK_SET(ireq->options, Z_Options_sort);
1259 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1260 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1262 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1263 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1264 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1266 /* Index Data's Z39.50 Implementor Id is 81 */
1267 ireq->implementationId =
1268 odr_prepend(c->odr_out,
1269 ZOOM_options_get(c->options, "implementationId"),
1270 odr_prepend(c->odr_out, "81", ireq->implementationId));
1272 ireq->implementationName =
1273 odr_prepend(c->odr_out,
1274 ZOOM_options_get(c->options, "implementationName"),
1275 odr_prepend(c->odr_out, "ZOOM-C",
1276 ireq->implementationName));
1278 version = odr_strdup(c->odr_out, "$Revision: 1.113 $");
1279 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1280 version[strlen(version)-2] = '\0';
1281 ireq->implementationVersion =
1282 odr_prepend(c->odr_out,
1283 ZOOM_options_get(c->options, "implementationVersion"),
1284 odr_prepend(c->odr_out, &version[11],
1285 ireq->implementationVersion));
1287 *ireq->maximumRecordSize =
1288 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
1289 *ireq->preferredMessageSize =
1290 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
1292 if (auth_groupId || auth_password)
1294 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1297 if (auth_groupId && *auth_groupId)
1299 pass->groupId = (char *)
1300 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1301 strcpy(pass->groupId, auth_groupId);
1305 if (auth_userId && *auth_userId)
1307 pass->userId = (char *)
1308 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1309 strcpy(pass->userId, auth_userId);
1313 if (auth_password && *auth_password)
1315 pass->password = (char *)
1316 odr_malloc(c->odr_out, strlen(auth_password)+1);
1317 strcpy(pass->password, auth_password);
1322 auth->which = Z_IdAuthentication_idPass;
1323 auth->u.idPass = pass;
1324 ireq->idAuthentication = auth;
1327 else if (auth_userId)
1329 auth->which = Z_IdAuthentication_open;
1330 auth->u.open = (char *)
1331 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1332 strcpy(auth->u.open, auth_userId);
1333 ireq->idAuthentication = auth;
1336 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1337 VAL_PROXY, 1, c->host_port);
1338 if (c->charset || c->lang)
1340 Z_OtherInformation **oi;
1341 Z_OtherInformationUnit *oi_unit;
1343 yaz_oi_APDU(apdu, &oi);
1345 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1347 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1348 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1349 oi_unit->information.externallyDefinedInfo =
1350 yaz_set_proposal_charneg_list(c->odr_out, " ",
1351 c->charset, c->lang, 1);
1355 return send_APDU(c, apdu);
1359 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1364 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1366 if (c->sru_mode == zoom_sru_get)
1368 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1370 else if (c->sru_mode == zoom_sru_post)
1372 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1374 else if (c->sru_mode == zoom_sru_soap)
1376 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1378 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1379 return zoom_complete;
1380 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1382 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1383 ZOOM_connection_put_event(c, event);
1384 odr_reset(c->odr_out);
1390 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1394 ZOOM_resultset resultset = 0;
1396 const char *option_val = 0;
1398 if (c->error) /* don't continue on error */
1399 return zoom_complete;
1401 switch(c->tasks->which)
1403 case ZOOM_TASK_SEARCH:
1404 resultset = c->tasks->u.search.resultset;
1405 resultset->setname = xstrdup("default");
1406 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1407 start = &c->tasks->u.search.start;
1408 count = &c->tasks->u.search.count;
1410 case ZOOM_TASK_RETRIEVE:
1411 resultset = c->tasks->u.retrieve.resultset;
1413 start = &c->tasks->u.retrieve.start;
1414 count = &c->tasks->u.retrieve.count;
1416 if (*start >= resultset->size)
1417 return zoom_complete;
1418 if (*start + *count > resultset->size)
1419 *count = resultset->size - *start;
1421 for (i = 0; i < *count; i++)
1424 record_cache_lookup(resultset, i + *start,
1425 c->tasks->u.retrieve.syntax,
1426 c->tasks->u.retrieve.elementSetName);
1431 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1432 ZOOM_connection_put_event(c, event);
1439 return zoom_complete;
1442 return zoom_complete;
1444 assert(resultset->query);
1446 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1448 if (resultset->query->z_query->which == Z_Query_type_104
1449 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1451 sr->u.request->query_type = Z_SRW_query_type_cql;
1452 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1454 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1455 resultset->query->z_query->u.type_1)
1457 sr->u.request->query_type = Z_SRW_query_type_pqf;
1458 sr->u.request->query.pqf = resultset->query->query_string;
1462 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1463 return zoom_complete;
1465 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1466 sr->u.request->maximumRecords = odr_intdup(
1467 c->odr_out, resultset->step>0 ? resultset->step : *count);
1468 sr->u.request->recordSchema = resultset->schema;
1470 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1472 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1474 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1476 sr->extra_args = odr_strdup(c->odr_out, option_val);
1477 return send_srw(c, sr);
1480 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1482 return zoom_complete;
1486 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1489 int lslb, ssub, mspn;
1491 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1492 Z_SearchRequest *search_req = apdu->u.searchRequest;
1493 const char *elementSetName;
1494 const char *smallSetElementSetName;
1495 const char *mediumSetElementSetName;
1498 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1500 r = c->tasks->u.search.resultset;
1502 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1505 ZOOM_options_get(r->options, "elementSetName");
1506 smallSetElementSetName =
1507 ZOOM_options_get(r->options, "smallSetElementSetName");
1508 mediumSetElementSetName =
1509 ZOOM_options_get(r->options, "mediumSetElementSetName");
1511 if (!smallSetElementSetName)
1512 smallSetElementSetName = elementSetName;
1514 if (!mediumSetElementSetName)
1515 mediumSetElementSetName = elementSetName;
1520 /* prepare query for the search request */
1521 search_req->query = r->query->z_query;
1522 if (!search_req->query)
1524 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1525 return zoom_complete;
1528 search_req->databaseNames = r->databaseNames;
1529 search_req->num_databaseNames = r->num_databaseNames;
1531 /* get syntax (no need to provide unless piggyback is in effect) */
1532 syntax = c->tasks->u.search.syntax;
1534 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1535 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1536 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1537 if (lslb != -1 && ssub != -1 && mspn != -1)
1539 /* So're a Z39.50 expert? Let's hope you don't do sort */
1540 *search_req->largeSetLowerBound = lslb;
1541 *search_req->smallSetUpperBound = ssub;
1542 *search_req->mediumSetPresentNumber = mspn;
1544 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1545 && r->piggyback && !r->r_sort_spec && !r->schema)
1547 /* Regular piggyback - do it unless we're going to do sort */
1548 *search_req->largeSetLowerBound = 2000000000;
1549 *search_req->smallSetUpperBound = 1;
1550 *search_req->mediumSetPresentNumber =
1551 r->step>0 ? r->step : c->tasks->u.search.count;
1555 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1556 smallSetElementSetName = 0;
1557 mediumSetElementSetName = 0;
1560 if (smallSetElementSetName && *smallSetElementSetName)
1562 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1563 odr_malloc(c->odr_out, sizeof(*esn));
1565 esn->which = Z_ElementSetNames_generic;
1566 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1567 search_req->smallSetElementSetNames = esn;
1569 if (mediumSetElementSetName && *mediumSetElementSetName)
1571 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1572 odr_malloc(c->odr_out, sizeof(*esn));
1574 esn->which = Z_ElementSetNames_generic;
1575 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1576 search_req->mediumSetElementSetNames = esn;
1579 search_req->preferredRecordSyntax =
1580 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1584 if (c->support_named_resultsets)
1588 /* find the lowest unused ordinal so that we re-use
1589 result sets on the server. */
1590 for (ord = 1; ; ord++)
1593 sprintf(setname, "%d", ord);
1594 for (rp = c->resultsets; rp; rp = rp->next)
1595 if (rp->setname && !strcmp(rp->setname, setname))
1600 r->setname = xstrdup(setname);
1601 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1602 "set %s", c, r->setname);
1606 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1608 r->setname = xstrdup("default");
1610 ZOOM_options_set(r->options, "setname", r->setname);
1612 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1613 return send_APDU(c, apdu);
1616 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1623 case Z_DefaultDiagFormat_v2Addinfo:
1624 addinfo = r->u.v2Addinfo;
1626 case Z_DefaultDiagFormat_v3Addinfo:
1627 addinfo = r->u.v3Addinfo;
1632 set_dset_error(c, *r->condition,
1633 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1637 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1639 if (p->which != Z_DiagRec_defaultFormat)
1640 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1642 response_default_diag(c, p->u.defaultFormat);
1645 ZOOM_API(ZOOM_record)
1646 ZOOM_record_clone(ZOOM_record srec)
1653 odr_enc = odr_createmem(ODR_ENCODE);
1654 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1656 buf = odr_getbuf(odr_enc, &size, 0);
1658 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1659 nrec->odr = odr_createmem(ODR_DECODE);
1660 nrec->wrbuf_marc = 0;
1661 nrec->wrbuf_iconv = 0;
1662 nrec->wrbuf_opac = 0;
1663 odr_setbuf(nrec->odr, buf, size, 0);
1664 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1666 odr_destroy(odr_enc);
1670 ZOOM_API(ZOOM_record)
1671 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1673 const char *syntax =
1674 ZOOM_options_get(s->options, "preferredRecordSyntax");
1675 const char *elementSetName =
1676 ZOOM_options_get(s->options, "elementSetName");
1678 return record_cache_lookup(s, pos, syntax, elementSetName);
1681 ZOOM_API(ZOOM_record)
1682 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1684 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1689 * MIKE: I think force_sync should always be zero, but I don't
1690 * want to make this change until I get the go-ahead from
1691 * Adam, in case something depends on the old synchronous
1695 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1696 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1697 rec = ZOOM_resultset_record_immediate(r, pos);
1703 ZOOM_record_destroy(ZOOM_record rec)
1707 if (rec->wrbuf_marc)
1708 wrbuf_free(rec->wrbuf_marc, 1);
1709 if (rec->wrbuf_iconv)
1710 wrbuf_free(rec->wrbuf_iconv, 1);
1711 if (rec->wrbuf_opac)
1712 wrbuf_free(rec->wrbuf_opac, 1);
1713 odr_destroy(rec->odr);
1717 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1719 const char *buf, int sz,
1720 const char *record_charset)
1725 yaz_marc_t mt = yaz_marc_create();
1728 strcpy(to, "UTF-8");
1729 if (record_charset && *record_charset)
1731 /* Use "from,to" or just "from" */
1732 const char *cp = strchr(record_charset, ',');
1733 int clen = strlen(record_charset);
1736 strncpy( to, cp+1, sizeof(to)-1);
1737 to[sizeof(to)-1] = '\0';
1738 clen = cp - record_charset;
1740 if (clen > sizeof(from)-1)
1741 clen = sizeof(from)-1;
1744 strncpy(from, record_charset, clen);
1750 cd = yaz_iconv_open(to, from);
1751 yaz_marc_iconv(mt, cd);
1754 yaz_marc_xml(mt, marc_type);
1755 if (!rec->wrbuf_marc)
1756 rec->wrbuf_marc = wrbuf_alloc();
1757 wrbuf_rewind(rec->wrbuf_marc);
1758 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1760 yaz_marc_destroy(mt);
1762 yaz_iconv_close(cd);
1764 *len = wrbuf_len(rec->wrbuf_marc);
1765 return wrbuf_buf(rec->wrbuf_marc);
1767 yaz_marc_destroy(mt);
1769 yaz_iconv_close(cd);
1773 static const char *record_iconv_return(ZOOM_record rec, int *len,
1774 const char *buf, int sz,
1775 const char *record_charset)
1782 strcpy(to, "UTF-8");
1783 if (record_charset && *record_charset)
1785 /* Use "from,to" or just "from" */
1786 const char *cp = strchr(record_charset, ',');
1787 int clen = strlen(record_charset);
1790 strncpy( to, cp+1, sizeof(to)-1);
1791 to[sizeof(to)-1] = '\0';
1792 clen = cp - record_charset;
1794 if (clen > sizeof(from)-1)
1795 clen = sizeof(from)-1;
1798 strncpy(from, record_charset, clen);
1802 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1805 size_t inbytesleft = sz;
1806 const char *inp = buf;
1808 if (!rec->wrbuf_iconv)
1809 rec->wrbuf_iconv = wrbuf_alloc();
1811 wrbuf_rewind(rec->wrbuf_iconv);
1815 size_t outbytesleft = sizeof(outbuf);
1816 char *outp = outbuf;
1817 size_t r = yaz_iconv(cd, (char**) &inp,
1819 &outp, &outbytesleft);
1820 if (r == (size_t) (-1))
1822 int e = yaz_iconv_error(cd);
1823 if (e != YAZ_ICONV_E2BIG)
1826 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1828 wrbuf_puts(rec->wrbuf_iconv, "");
1829 buf = wrbuf_buf(rec->wrbuf_iconv);
1830 sz = wrbuf_len(rec->wrbuf_iconv);
1831 yaz_iconv_close(cd);
1839 ZOOM_record_error(ZOOM_record rec, const char **cp,
1840 const char **addinfo, const char **diagset)
1842 Z_NamePlusRecord *npr;
1847 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1849 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1850 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1851 const char *add = 0;
1853 if (diag_rec->which == Z_DiagRec_defaultFormat)
1855 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1858 error = *ddf->condition;
1861 case Z_DefaultDiagFormat_v2Addinfo:
1862 add = ddf->u.v2Addinfo;
1864 case Z_DefaultDiagFormat_v3Addinfo:
1865 add = ddf->u.v3Addinfo;
1869 *diagset = yaz_z3950oid_to_str(ddf->diagnosticSetId, &oclass);
1877 *addinfo = add ? add : "";
1879 *cp = diagbib1_str(error);
1885 ZOOM_API(const char *)
1886 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1893 Z_NamePlusRecord *npr;
1896 *len = 0; /* default return */
1905 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1907 if (cp[i] == ';' || cp[i] == ' ')
1913 while (type_spec[i] == ';')
1916 while (type_spec[i] == ' ')
1918 if (!strncmp(type_spec+i, "charset=", 8))
1921 i = i + 8; /* skip charset= */
1922 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1924 if (type_spec[i] == ';' || type_spec[i] == ' ')
1930 else if (!strncmp(type_spec+i, "xpath=", 6))
1934 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1938 while (type_spec[i] == ' ')
1941 if (!strcmp(type, "database"))
1944 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1945 return npr->databaseName;
1947 else if (!strcmp(type, "syntax"))
1949 const char *desc = 0;
1950 if (npr->which == Z_NamePlusRecord_databaseRecord)
1952 Z_External *r = (Z_External *) npr->u.databaseRecord;
1953 oident *ent = oid_getentbyoid(r->direct_reference);
1960 *len = strlen(desc);
1963 if (npr->which != Z_NamePlusRecord_databaseRecord)
1966 /* from now on - we have a database record .. */
1967 if (!strcmp(type, "render"))
1969 Z_External *r = (Z_External *) npr->u.databaseRecord;
1970 oident *ent = oid_getentbyoid(r->direct_reference);
1972 /* render bibliographic record .. */
1973 if (r->which == Z_External_OPAC)
1975 r = r->u.opac->bibliographicRecord;
1978 ent = oid_getentbyoid(r->direct_reference);
1980 if (r->which == Z_External_sutrs)
1981 return record_iconv_return(rec, len,
1982 (char*) r->u.sutrs->buf,
1985 else if (r->which == Z_External_octet)
1987 const char *ret_buf;
1995 case VAL_APPLICATION_XML:
1998 ret_buf = marc_iconv_return(
1999 rec, YAZ_MARC_LINE, len,
2000 (const char *) r->u.octet_aligned->buf,
2001 r->u.octet_aligned->len,
2006 return record_iconv_return(rec, len,
2007 (const char *) r->u.octet_aligned->buf,
2008 r->u.octet_aligned->len,
2011 else if (r->which == Z_External_grs1)
2013 if (!rec->wrbuf_marc)
2014 rec->wrbuf_marc = wrbuf_alloc();
2015 wrbuf_rewind(rec->wrbuf_marc);
2016 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
2017 return record_iconv_return(rec, len,
2018 wrbuf_buf(rec->wrbuf_marc),
2019 wrbuf_len(rec->wrbuf_marc),
2024 else if (!strcmp(type, "xml"))
2026 Z_External *r = (Z_External *) npr->u.databaseRecord;
2027 oident *ent = oid_getentbyoid(r->direct_reference);
2029 /* render bibliographic record .. */
2030 if (r->which == Z_External_OPAC)
2032 r = r->u.opac->bibliographicRecord;
2035 ent = oid_getentbyoid(r->direct_reference);
2038 if (r->which == Z_External_sutrs)
2039 return record_iconv_return(rec, len,
2040 (const char *) r->u.sutrs->buf,
2043 else if (r->which == Z_External_octet)
2045 const char *ret_buf;
2046 int marc_decode_type = YAZ_MARC_MARCXML;
2055 case VAL_APPLICATION_XML:
2058 ret_buf = marc_iconv_return(
2059 rec, marc_decode_type, len,
2060 (const char *) r->u.octet_aligned->buf,
2061 r->u.octet_aligned->len,
2066 return record_iconv_return(rec, len,
2067 (const char *) r->u.octet_aligned->buf,
2068 r->u.octet_aligned->len,
2071 else if (r->which == Z_External_grs1)
2078 else if (!strcmp(type, "raw"))
2080 Z_External *r = (Z_External *) npr->u.databaseRecord;
2082 if (r->which == Z_External_sutrs)
2084 if (len) *len = r->u.sutrs->len;
2085 return (const char *) r->u.sutrs->buf;
2087 else if (r->which == Z_External_octet)
2089 if (len) *len = r->u.octet_aligned->len;
2090 return (const char *) r->u.octet_aligned->buf;
2092 else /* grs-1, explain, OPAC, ... */
2095 return (const char *) npr->u.databaseRecord;
2099 else if (!strcmp (type, "ext"))
2102 return (const char *) npr->u.databaseRecord;
2104 else if (!strcmp (type, "opac"))
2107 Z_External *r = (Z_External *) npr->u.databaseRecord;
2108 if (r->which == Z_External_OPAC)
2110 if (!rec->wrbuf_opac)
2111 rec->wrbuf_opac = wrbuf_alloc();
2112 wrbuf_rewind(rec->wrbuf_opac);
2113 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2114 return record_iconv_return(rec, len,
2115 wrbuf_buf(rec->wrbuf_opac),
2116 wrbuf_len(rec->wrbuf_opac),
2123 static int strcmp_null(const char *v1, const char *v2)
2129 return strcmp(v1, v2);
2132 static size_t record_hash(int pos)
2136 return pos % RECORD_HASH_SIZE;
2139 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2141 const char *syntax, const char *elementSetName)
2143 ZOOM_record_cache rc;
2145 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2146 ZOOM_connection_put_event(r->connection, event);
2148 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2152 if (strcmp_null(r->schema, rc->schema))
2154 if (strcmp_null(elementSetName,rc->elementSetName))
2156 if (strcmp_null(syntax, rc->syntax))
2158 /* not destroying rc->npr (it's handled by nmem )*/
2160 /* keeping wrbuf_marc too */
2164 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2167 rc->rec.wrbuf_marc = 0;
2168 rc->rec.wrbuf_iconv = 0;
2169 rc->rec.wrbuf_opac = 0;
2171 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2173 rc->elementSetName = 0;
2176 rc->syntax = odr_strdup(r->odr, syntax);
2181 rc->schema = odr_strdup(r->odr, r->schema);
2186 rc->next = r->record_hash[record_hash(pos)];
2187 r->record_hash[record_hash(pos)] = rc;
2190 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2192 const char *elementSetName)
2194 ZOOM_record_cache rc;
2196 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2200 if (strcmp_null(r->schema, rc->schema))
2202 if (strcmp_null(elementSetName,rc->elementSetName))
2204 if (strcmp_null(syntax, rc->syntax))
2212 static void handle_records(ZOOM_connection c, Z_Records *sr,
2215 ZOOM_resultset resultset;
2217 const char *syntax = 0, *elementSetName = 0;
2221 switch (c->tasks->which)
2223 case ZOOM_TASK_SEARCH:
2224 resultset = c->tasks->u.search.resultset;
2225 start = &c->tasks->u.search.start;
2226 count = &c->tasks->u.search.count;
2227 syntax = c->tasks->u.search.syntax;
2228 elementSetName = c->tasks->u.search.elementSetName;
2230 case ZOOM_TASK_RETRIEVE:
2231 resultset = c->tasks->u.retrieve.resultset;
2232 start = &c->tasks->u.retrieve.start;
2233 count = &c->tasks->u.retrieve.count;
2234 syntax = c->tasks->u.retrieve.syntax;
2235 elementSetName = c->tasks->u.retrieve.elementSetName;
2240 if (sr && sr->which == Z_Records_NSD)
2241 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2242 else if (sr && sr->which == Z_Records_multipleNSD)
2244 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2245 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2247 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2251 if (*count + *start > resultset->size)
2252 *count = resultset->size - *start;
2255 if (sr && sr->which == Z_Records_DBOSD)
2258 NMEM nmem = odr_extract_mem(c->odr_in);
2259 Z_NamePlusRecordList *p =
2260 sr->u.databaseOrSurDiagnostics;
2261 for (i = 0; i<p->num_records; i++)
2263 record_cache_add(resultset, p->records[i], i + *start,
2264 syntax, elementSetName);
2270 yaz_log(log_details,
2271 "handle_records resultset=%p start=%d count=%d",
2272 resultset, *start, *count);
2274 /* transfer our response to search_nmem .. we need it later */
2275 nmem_transfer(resultset->odr->mem, nmem);
2277 if (present_phase && p->num_records == 0)
2279 /* present response and we didn't get any records! */
2280 Z_NamePlusRecord *myrec =
2281 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2282 record_cache_add(resultset, myrec, *start,
2283 syntax, elementSetName);
2286 else if (present_phase)
2288 /* present response and we didn't get any records! */
2289 Z_NamePlusRecord *myrec =
2290 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2291 record_cache_add(resultset, myrec, *start, syntax, elementSetName);
2296 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2298 handle_records(c, pr->records, 1);
2301 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2304 switch (term->which)
2306 case Z_Term_general:
2307 ZOOM_options_setl(opt, name,
2308 (const char *)(term->u.general->buf),
2309 term->u.general->len);
2311 case Z_Term_characterString:
2312 ZOOM_options_set(opt, name, term->u.characterString);
2314 case Z_Term_numeric:
2315 ZOOM_options_set_int(opt, name, *term->u.numeric);
2320 static void handle_queryExpression(ZOOM_options opt, const char *name,
2321 Z_QueryExpression *exp)
2327 case Z_QueryExpression_term:
2328 if (exp->u.term && exp->u.term->queryTerm)
2330 sprintf(opt_name, "%s.term", name);
2331 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2334 case Z_QueryExpression_query:
2339 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2340 Z_OtherInformation *o)
2343 for (i = 0; o && i < o->num_elements; i++)
2345 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2347 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2349 if (ext->which == Z_External_searchResult1)
2352 Z_SearchInfoReport *sr = ext->u.searchResult1;
2355 ZOOM_options_set_int(
2356 resultset->options, "searchresult.size", sr->num);
2358 for (j = 0; j < sr->num; j++)
2360 Z_SearchInfoReport_s *ent =
2361 ext->u.searchResult1->elements[j];
2364 sprintf(pref, "searchresult.%d", j);
2366 if (ent->subqueryId)
2369 sprintf(opt_name, "%s.id", pref);
2370 ZOOM_options_set(resultset->options, opt_name,
2373 if (ent->subqueryExpression)
2376 sprintf(opt_name, "%s.subquery", pref);
2377 handle_queryExpression(resultset->options, opt_name,
2378 ent->subqueryExpression);
2380 if (ent->subqueryInterpretation)
2383 sprintf(opt_name, "%s.interpretation", pref);
2384 handle_queryExpression(resultset->options, opt_name,
2385 ent->subqueryInterpretation);
2387 if (ent->subqueryRecommendation)
2390 sprintf(opt_name, "%s.recommendation", pref);
2391 handle_queryExpression(resultset->options, opt_name,
2392 ent->subqueryRecommendation);
2394 if (ent->subqueryCount)
2397 sprintf(opt_name, "%s.count", pref);
2398 ZOOM_options_set_int(resultset->options, opt_name,
2399 *ent->subqueryCount);
2407 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2409 ZOOM_resultset resultset;
2412 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2415 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2416 ZOOM_connection_put_event(c, event);
2418 resultset = c->tasks->u.search.resultset;
2420 if (sr->resultSetStatus)
2422 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2423 *sr->resultSetStatus);
2425 if (sr->presentStatus)
2427 ZOOM_options_set_int(resultset->options, "presentStatus",
2428 *sr->presentStatus);
2430 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2432 resultset->size = *sr->resultCount;
2433 handle_records(c, sr->records, 0);
2436 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2438 if (res->diagnostics && res->num_diagnostics > 0)
2439 response_diag(c, res->diagnostics[0]);
2442 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2444 NMEM nmem = odr_extract_mem(c->odr_in);
2447 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2449 scan = c->tasks->u.scan.scan;
2451 if (res->entries && res->entries->nonsurrogateDiagnostics)
2452 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2453 scan->scan_response = res;
2454 nmem_transfer(scan->odr->mem, nmem);
2456 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2457 if (res->positionOfTerm)
2458 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2459 if (res->scanStatus)
2460 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2461 if (res->numberOfEntriesReturned)
2462 ZOOM_options_set_int(scan->options, "number",
2463 *res->numberOfEntriesReturned);
2468 static zoom_ret send_sort(ZOOM_connection c,
2469 ZOOM_resultset resultset)
2472 resultset->r_sort_spec = 0;
2473 if (resultset->r_sort_spec)
2475 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2476 Z_SortRequest *req = apdu->u.sortRequest;
2478 req->num_inputResultSetNames = 1;
2479 req->inputResultSetNames = (Z_InternationalString **)
2480 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2481 req->inputResultSetNames[0] =
2482 odr_strdup(c->odr_out, resultset->setname);
2483 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2484 req->sortSequence = resultset->r_sort_spec;
2485 resultset->r_sort_spec = 0;
2486 return send_APDU(c, apdu);
2488 return zoom_complete;
2491 static zoom_ret send_present(ZOOM_connection c)
2494 Z_PresentRequest *req = 0;
2496 const char *syntax = 0;
2497 const char *elementSetName = 0;
2498 ZOOM_resultset resultset;
2503 yaz_log(log_details, "%p send_present no tasks", c);
2504 return zoom_complete;
2507 switch (c->tasks->which)
2509 case ZOOM_TASK_SEARCH:
2510 resultset = c->tasks->u.search.resultset;
2511 start = &c->tasks->u.search.start;
2512 count = &c->tasks->u.search.count;
2513 syntax = c->tasks->u.search.syntax;
2514 elementSetName = c->tasks->u.search.elementSetName;
2516 case ZOOM_TASK_RETRIEVE:
2517 resultset = c->tasks->u.retrieve.resultset;
2518 start = &c->tasks->u.retrieve.start;
2519 count = &c->tasks->u.retrieve.count;
2520 syntax = c->tasks->u.retrieve.syntax;
2521 elementSetName = c->tasks->u.retrieve.elementSetName;
2524 return zoom_complete;
2526 yaz_log(log_details, "%p send_present start=%d count=%d",
2529 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2531 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2534 if (c->error) /* don't continue on error */
2535 return zoom_complete;
2536 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2537 resultset, *start, *count);
2539 for (i = 0; i < *count; i++)
2542 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2547 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2548 ZOOM_connection_put_event(c, event);
2556 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2557 return zoom_complete;
2560 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2561 req = apdu->u.presentRequest;
2564 yaz_log(log_details, "%p send_present skip=%d", c, i);
2566 *req->resultSetStartPoint = *start + 1;
2567 *req->numberOfRecordsRequested = resultset->step>0 ?
2568 resultset->step : *count;
2569 if (*req->numberOfRecordsRequested + *start > resultset->size)
2570 *req->numberOfRecordsRequested = resultset->size - *start;
2571 assert(*req->numberOfRecordsRequested > 0);
2573 if (syntax && *syntax)
2574 req->preferredRecordSyntax =
2575 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2577 if (resultset->schema && *resultset->schema)
2579 Z_RecordComposition *compo = (Z_RecordComposition *)
2580 odr_malloc(c->odr_out, sizeof(*compo));
2582 req->recordComposition = compo;
2583 compo->which = Z_RecordComp_complex;
2584 compo->u.complex = (Z_CompSpec *)
2585 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2586 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2587 odr_malloc(c->odr_out, sizeof(bool_t));
2588 *compo->u.complex->selectAlternativeSyntax = 0;
2590 compo->u.complex->generic = (Z_Specification *)
2591 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2593 compo->u.complex->generic->which = Z_Schema_oid;
2594 compo->u.complex->generic->schema.oid = (Odr_oid *)
2595 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2597 if (!compo->u.complex->generic->schema.oid)
2599 /* OID wasn't a schema! Try record syntax instead. */
2601 compo->u.complex->generic->schema.oid = (Odr_oid *)
2602 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2604 if (elementSetName && *elementSetName)
2606 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2607 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2608 compo->u.complex->generic->elementSpec->which =
2609 Z_ElementSpec_elementSetName;
2610 compo->u.complex->generic->elementSpec->u.elementSetName =
2611 odr_strdup(c->odr_out, elementSetName);
2614 compo->u.complex->generic->elementSpec = 0;
2615 compo->u.complex->num_dbSpecific = 0;
2616 compo->u.complex->dbSpecific = 0;
2617 compo->u.complex->num_recordSyntax = 0;
2618 compo->u.complex->recordSyntax = 0;
2620 else if (elementSetName && *elementSetName)
2622 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2623 odr_malloc(c->odr_out, sizeof(*esn));
2624 Z_RecordComposition *compo = (Z_RecordComposition *)
2625 odr_malloc(c->odr_out, sizeof(*compo));
2627 esn->which = Z_ElementSetNames_generic;
2628 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2629 compo->which = Z_RecordComp_simple;
2630 compo->u.simple = esn;
2631 req->recordComposition = compo;
2633 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2634 return send_APDU(c, apdu);
2637 ZOOM_API(ZOOM_scanset)
2638 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2641 ZOOM_query q = ZOOM_query_create();
2643 ZOOM_query_prefix(q, start);
2645 s = ZOOM_connection_scan1(c, q);
2646 ZOOM_query_destroy(q);
2651 ZOOM_API(ZOOM_scanset)
2652 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2656 ZOOM_scanset scan = 0;
2659 * We need to check the query-type, so we can recognise CQL and
2660 * CCL and compile them into a form that we can use here. The
2661 * ZOOM_query structure has no explicit `type' member, but
2662 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2663 * functions shows how the structure is set up in each case.
2667 else if (q->z_query->which == Z_Query_type_1)
2669 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2670 c, q, q->query_string);
2671 start = q->query_string;
2673 else if (q->z_query->which == Z_Query_type_104)
2675 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2676 c, q, q->query_string);
2677 start = freeme = cql2pqf(c, q->query_string);
2683 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2684 c, q, q->query_string);
2688 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2689 scan->connection = c;
2690 scan->odr = odr_createmem(ODR_DECODE);
2691 scan->options = ZOOM_options_create_with_parent(c->options);
2693 scan->scan_response = 0;
2694 scan->termListAndStartPoint =
2695 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2698 scan->databaseNames = set_DatabaseNames(c, c->options,
2699 &scan->num_databaseNames,
2701 if (scan->termListAndStartPoint != 0)
2703 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2704 task->u.scan.scan = scan;
2709 while (ZOOM_event(1, &c))
2717 ZOOM_scanset_destroy(ZOOM_scanset scan)
2722 if (scan->refcount == 0)
2724 odr_destroy(scan->odr);
2726 ZOOM_options_destroy(scan->options);
2731 static zoom_ret send_package(ZOOM_connection c)
2735 yaz_log(log_details, "%p send_package", c);
2737 return zoom_complete;
2738 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2740 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2741 ZOOM_connection_put_event(c, event);
2743 c->buf_out = c->tasks->u.package->buf_out;
2744 c->len_out = c->tasks->u.package->len_out;
2749 static zoom_ret send_scan(ZOOM_connection c)
2752 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2753 Z_ScanRequest *req = apdu->u.scanRequest;
2755 yaz_log(log_details, "%p send_scan", c);
2757 return zoom_complete;
2758 assert (c->tasks->which == ZOOM_TASK_SCAN);
2759 scan = c->tasks->u.scan.scan;
2761 req->termListAndStartPoint = scan->termListAndStartPoint;
2762 req->attributeSet = scan->attributeSet;
2764 *req->numberOfTermsRequested =
2765 ZOOM_options_get_int(scan->options, "number", 10);
2767 req->preferredPositionInResponse =
2768 odr_intdup(c->odr_out,
2769 ZOOM_options_get_int(scan->options, "position", 1));
2772 odr_intdup(c->odr_out,
2773 ZOOM_options_get_int(scan->options, "stepSize", 0));
2775 req->databaseNames = scan->databaseNames;
2776 req->num_databaseNames = scan->num_databaseNames;
2778 return send_APDU(c, apdu);
2782 ZOOM_scanset_size(ZOOM_scanset scan)
2784 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2786 return scan->scan_response->entries->num_entries;
2789 ZOOM_API(const char *)
2790 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2793 const char *term = 0;
2794 size_t noent = ZOOM_scanset_size(scan);
2795 Z_ScanResponse *res = scan->scan_response;
2801 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2803 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2805 if (t->term->which == Z_Term_general)
2807 term = (const char *) t->term->u.general->buf;
2808 *len = t->term->u.general->len;
2810 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2815 ZOOM_API(const char *)
2816 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2819 const char *term = 0;
2820 size_t noent = ZOOM_scanset_size(scan);
2821 Z_ScanResponse *res = scan->scan_response;
2827 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2829 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2833 term = t->displayTerm;
2834 *len = strlen(term);
2836 else if (t->term->which == Z_Term_general)
2838 term = (const char *) t->term->u.general->buf;
2839 *len = t->term->u.general->len;
2841 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2846 ZOOM_API(const char *)
2847 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2849 return ZOOM_options_get(scan->options, key);
2853 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2856 ZOOM_options_set(scan->options, key, val);
2859 static Z_APDU *create_es_package(ZOOM_package p, int type)
2862 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2863 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2865 *req->function = Z_ExtendedServicesRequest_create;
2867 str = ZOOM_options_get(p->options, "package-name");
2869 req->packageName = nmem_strdup(p->odr_out->mem, str);
2871 str = ZOOM_options_get(p->options, "user-id");
2873 req->userId = nmem_strdup(p->odr_out->mem, str);
2875 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2878 str = ZOOM_options_get(p->options, "function");
2881 if (!strcmp (str, "create"))
2883 if (!strcmp (str, "delete"))
2885 if (!strcmp (str, "modify"))
2891 static const char *ill_array_lookup(void *clientData, const char *idx)
2893 ZOOM_package p = (ZOOM_package) clientData;
2894 return ZOOM_options_get(p->options, idx+4);
2897 static Z_External *encode_ill_request(ZOOM_package p)
2899 ODR out = p->odr_out;
2902 struct ill_get_ctl ctl;
2904 ctl.odr = p->odr_out;
2906 ctl.f = ill_array_lookup;
2908 req = ill_get_ILLRequest(&ctl, "ill", 0);
2910 if (!ill_Request(out, &req, 0, 0))
2912 int ill_request_size;
2913 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2914 if (ill_request_buf)
2915 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2921 int illRequest_size = 0;
2922 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2924 oid.proto = PROTO_GENERAL;
2925 oid.oclass = CLASS_GENERAL;
2926 oid.value = VAL_ISO_ILL_1;
2928 r = (Z_External *) odr_malloc(out, sizeof(*r));
2929 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2930 r->indirect_reference = 0;
2932 r->which = Z_External_single;
2934 r->u.single_ASN1_type =
2935 odr_create_Odr_oct(out,
2936 (unsigned char *)illRequest_buf,
2942 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2944 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2947 req->which = Z_IOItemOrder_esRequest;
2948 req->u.esRequest = (Z_IORequest *)
2949 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2951 /* to keep part ... */
2952 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2953 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2954 req->u.esRequest->toKeep->supplDescription = 0;
2955 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2956 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2958 str = ZOOM_options_get(p->options, "contact-name");
2959 req->u.esRequest->toKeep->contact->name = str ?
2960 nmem_strdup(p->odr_out->mem, str) : 0;
2962 str = ZOOM_options_get(p->options, "contact-phone");
2963 req->u.esRequest->toKeep->contact->phone = str ?
2964 nmem_strdup(p->odr_out->mem, str) : 0;
2966 str = ZOOM_options_get(p->options, "contact-email");
2967 req->u.esRequest->toKeep->contact->email = str ?
2968 nmem_strdup(p->odr_out->mem, str) : 0;
2970 req->u.esRequest->toKeep->addlBilling = 0;
2972 /* not to keep part ... */
2973 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2974 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2976 str = ZOOM_options_get(p->options, "itemorder-setname");
2981 req->u.esRequest->notToKeep->resultSetItem = 0;
2984 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2985 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2987 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2988 nmem_strdup(p->odr_out->mem, str);
2989 req->u.esRequest->notToKeep->resultSetItem->item =
2990 (int *) odr_malloc(p->odr_out, sizeof(int));
2992 str = ZOOM_options_get(p->options, "itemorder-item");
2993 *req->u.esRequest->notToKeep->resultSetItem->item =
2994 (str ? atoi(str) : 1);
2997 str = ZOOM_options_get(p->options, "doc");
2999 req->u.esRequest->notToKeep->itemRequest =
3000 z_ext_record(p->odr_out, VAL_TEXT_XML, str, strlen(str));
3002 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3007 Z_APDU *create_admin_package(ZOOM_package p, int type,
3008 Z_ESAdminOriginPartToKeep **toKeepP,
3009 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3011 Z_APDU *apdu = create_es_package(p, VAL_ADMINSERVICE);
3014 Z_ESAdminOriginPartToKeep *toKeep;
3015 Z_ESAdminOriginPartNotToKeep *notToKeep;
3016 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3017 const char *first_db = "Default";
3019 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3024 r->direct_reference =
3025 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3028 r->indirect_reference = 0;
3029 r->which = Z_External_ESAdmin;
3031 r->u.adminService = (Z_Admin *)
3032 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3033 r->u.adminService->which = Z_Admin_esRequest;
3034 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3035 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3037 toKeep = r->u.adminService->u.esRequest->toKeep =
3038 (Z_ESAdminOriginPartToKeep *)
3039 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3040 toKeep->which = type;
3041 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3042 toKeep->u.create = odr_nullval();
3043 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3045 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3046 (Z_ESAdminOriginPartNotToKeep *)
3047 odr_malloc(p->odr_out,
3048 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3049 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3050 notToKeep->u.recordsWillFollow = odr_nullval();
3054 *notToKeepP = notToKeep;
3059 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3061 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
3062 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3063 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3064 const char *doc = ZOOM_options_get(p->options, "doc");
3069 req->taskSpecificParameters = ext;
3070 ext->direct_reference = req->packageType;
3071 ext->descriptor = 0;
3072 ext->indirect_reference = 0;
3074 ext->which = Z_External_octet;
3075 ext->u.single_ASN1_type =
3076 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
3081 static Z_APDU *create_update_package(ZOOM_package p)
3084 const char *first_db = "Default";
3086 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3087 const char *action = ZOOM_options_get(p->options, "action");
3088 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
3089 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3090 const char *record_buf = ZOOM_options_get(p->options, "record");
3091 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3092 int syntax_oid = VAL_NONE;
3096 syntax_oid = oid_getvalbyname(syntax_str);
3099 record_buf = "void";
3100 syntax_oid = VAL_SUTRS;
3102 if (syntax_oid == VAL_NONE)
3103 syntax_oid = VAL_TEXT_XML;
3109 action = "specialUpdate";
3111 if (!strcmp(action, "recordInsert"))
3112 action_no = Z_IUOriginPartToKeep_recordInsert;
3113 else if (!strcmp(action, "recordReplace"))
3114 action_no = Z_IUOriginPartToKeep_recordReplace;
3115 else if (!strcmp(action, "recordDelete"))
3116 action_no = Z_IUOriginPartToKeep_recordDelete;
3117 else if (!strcmp(action, "elementUpdate"))
3118 action_no = Z_IUOriginPartToKeep_elementUpdate;
3119 else if (!strcmp(action, "specialUpdate"))
3120 action_no = Z_IUOriginPartToKeep_specialUpdate;
3124 apdu = create_es_package(p, VAL_DBUPDATE);
3127 Z_IUOriginPartToKeep *toKeep;
3128 Z_IUSuppliedRecords *notToKeep;
3129 Z_External *r = (Z_External *)
3130 odr_malloc(p->odr_out, sizeof(*r));
3132 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3134 r->direct_reference =
3135 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3138 r->which = Z_External_update;
3139 r->indirect_reference = 0;
3140 r->u.update = (Z_IUUpdate *)
3141 odr_malloc(p->odr_out, sizeof(*r->u.update));
3143 r->u.update->which = Z_IUUpdate_esRequest;
3144 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3145 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3146 toKeep = r->u.update->u.esRequest->toKeep =
3147 (Z_IUOriginPartToKeep *)
3148 odr_malloc(p->odr_out, sizeof(*toKeep));
3150 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3152 toKeep->elementSetName = 0;
3153 toKeep->actionQualifier = 0;
3154 toKeep->action = odr_intdup(p->odr_out, action_no);
3156 notToKeep = r->u.update->u.esRequest->notToKeep =
3157 (Z_IUSuppliedRecords *)
3158 odr_malloc(p->odr_out, sizeof(*notToKeep));
3160 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3161 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3162 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3163 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3164 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3167 notToKeep->elements[0]->u.opaque =
3168 odr_create_Odr_oct(p->odr_out,
3169 (const unsigned char *) recordIdOpaque,
3170 strlen(recordIdOpaque));
3172 else if (recordIdNumber)
3174 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3176 notToKeep->elements[0]->u.number =
3177 odr_intdup(p->odr_out, atoi(recordIdNumber));
3180 notToKeep->elements[0]->u.opaque = 0;
3181 notToKeep->elements[0]->supplementalId = 0;
3182 notToKeep->elements[0]->correlationInfo = 0;
3183 notToKeep->elements[0]->record =
3184 z_ext_record(p->odr_out, syntax_oid,
3185 record_buf, strlen(record_buf));
3189 ODR print = odr_createmem(ODR_PRINT);
3191 z_APDU(print, &apdu, 0, 0);
3198 ZOOM_package_send(ZOOM_package p, const char *type)
3205 odr_reset(p->odr_out);
3208 if (!strcmp(type, "itemorder"))
3210 apdu = create_es_package(p, VAL_ITEMORDER);
3213 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3215 r->direct_reference =
3216 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3219 r->which = Z_External_itemOrder;
3220 r->indirect_reference = 0;
3221 r->u.itemOrder = encode_item_order(p);
3223 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3226 else if (!strcmp(type, "create")) /* create database */
3228 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3231 else if (!strcmp(type, "drop")) /* drop database */
3233 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3236 else if (!strcmp(type, "commit")) /* commit changes */
3238 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3241 else if (!strcmp(type, "update")) /* update record(s) */
3243 apdu = create_update_package(p);
3245 else if (!strcmp(type, "xmlupdate"))
3247 apdu = create_xmlupdate_package(p);
3251 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3255 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3256 task->u.package = p;
3257 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3258 p->buf_out = (char *) xmalloc(p->len_out);
3259 memcpy(p->buf_out, buf, p->len_out);
3264 while (ZOOM_event(1, &c))
3271 ZOOM_API(ZOOM_package)
3272 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3274 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3277 p->odr_out = odr_createmem(ODR_ENCODE);
3278 p->options = ZOOM_options_create_with_parent2(options, c->options);
3286 ZOOM_package_destroy(ZOOM_package p)
3291 if (p->refcount == 0)
3293 odr_destroy(p->odr_out);
3296 ZOOM_options_destroy(p->options);
3301 ZOOM_API(const char *)
3302 ZOOM_package_option_get(ZOOM_package p, const char *key)
3304 return ZOOM_options_get(p->options, key);
3309 ZOOM_package_option_set(ZOOM_package p, const char *key,
3312 ZOOM_options_set(p->options, key, val);
3315 static int ZOOM_connection_exec_task(ZOOM_connection c)
3317 ZOOM_task task = c->tasks;
3318 zoom_ret ret = zoom_complete;
3322 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3323 c, task->which, task->running);
3324 if (c->error != ZOOM_ERROR_NONE)
3326 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3327 "removing tasks because of error = %d", c, c->error);
3328 ZOOM_connection_remove_tasks(c);
3333 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3334 "task already running", c);
3338 ret = zoom_complete;
3339 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3341 switch (task->which)
3343 case ZOOM_TASK_SEARCH:
3344 if (c->proto == PROTO_HTTP)
3345 ret = ZOOM_connection_srw_send_search(c);
3347 ret = ZOOM_connection_send_search(c);
3349 case ZOOM_TASK_RETRIEVE:
3350 if (c->proto == PROTO_HTTP)
3351 ret = ZOOM_connection_srw_send_search(c);
3353 ret = send_present(c);
3355 case ZOOM_TASK_CONNECT:
3356 ret = do_connect(c);
3358 case ZOOM_TASK_SCAN:
3361 case ZOOM_TASK_PACKAGE:
3362 ret = send_package(c);
3364 case ZOOM_TASK_SORT:
3365 c->tasks->u.sort.resultset->r_sort_spec =
3366 c->tasks->u.sort.q->sort_spec;
3367 ret = send_sort(c, c->tasks->u.sort.resultset);
3373 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3374 "remove tasks because no connection exist", c);
3375 ZOOM_connection_remove_tasks(c);
3377 if (ret == zoom_complete)
3379 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3380 "task removed (complete)", c);
3381 ZOOM_connection_remove_task(c);
3384 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3389 static zoom_ret send_sort_present(ZOOM_connection c)
3391 zoom_ret r = zoom_complete;
3393 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3394 r = send_sort(c, c->tasks->u.search.resultset);
3395 if (r == zoom_complete)
3396 r = send_present(c);
3400 static int es_response(ZOOM_connection c,
3401 Z_ExtendedServicesResponse *res)
3403 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3405 if (res->diagnostics && res->num_diagnostics > 0)
3406 response_diag(c, res->diagnostics[0]);
3407 if (res->taskPackage &&
3408 res->taskPackage->which == Z_External_extendedService)
3410 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3411 Odr_oct *id = taskPackage->targetReference;
3414 ZOOM_options_setl(c->tasks->u.package->options,
3415 "targetReference", (char*) id->buf, id->len);
3417 if (res->taskPackage &&
3418 res->taskPackage->which == Z_External_octet)
3420 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3421 ZOOM_options_setl(c->tasks->u.package->options,
3422 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3427 static void interpret_init_diag(ZOOM_connection c,
3428 Z_DiagnosticFormat *diag)
3432 Z_DiagnosticFormat_s *ds = diag->elements[0];
3433 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3434 response_default_diag(c, ds->u.defaultDiagRec);
3439 static void interpret_otherinformation_field(ZOOM_connection c,
3440 Z_OtherInformation *ui)
3443 for (i = 0; i < ui->num_elements; i++)
3445 Z_OtherInformationUnit *unit = ui->list[i];
3446 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3447 unit->information.externallyDefinedInfo &&
3448 unit->information.externallyDefinedInfo->which ==
3451 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3457 static void set_init_option(const char *name, void *clientData) {
3458 ZOOM_connection c = clientData;
3461 sprintf(buf, "init_opt_%.70s", name);
3462 ZOOM_connection_option_set(c, buf, "1");
3466 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3468 Z_InitResponse *initrs;
3470 ZOOM_connection_set_mask(c, 0);
3471 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3474 case Z_APDU_initResponse:
3475 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3476 initrs = apdu->u.initResponse;
3477 ZOOM_connection_option_set(c, "serverImplementationId",
3478 initrs->implementationId ?
3479 initrs->implementationId : "");
3480 ZOOM_connection_option_set(c, "serverImplementationName",
3481 initrs->implementationName ?
3482 initrs->implementationName : "");
3483 ZOOM_connection_option_set(c, "serverImplementationVersion",
3484 initrs->implementationVersion ?
3485 initrs->implementationVersion : "");
3486 /* Set the three old options too, for old applications */
3487 ZOOM_connection_option_set(c, "targetImplementationId",
3488 initrs->implementationId ?
3489 initrs->implementationId : "");
3490 ZOOM_connection_option_set(c, "targetImplementationName",
3491 initrs->implementationName ?
3492 initrs->implementationName : "");
3493 ZOOM_connection_option_set(c, "targetImplementationVersion",
3494 initrs->implementationVersion ?
3495 initrs->implementationVersion : "");
3497 /* Make initrs->options available as ZOOM-level options */
3498 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3500 if (!*initrs->result)
3502 Z_External *uif = initrs->userInformationField;
3504 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3506 if (uif && uif->which == Z_External_userInfo1)
3507 interpret_otherinformation_field(c, uif->u.userInfo1);
3512 yaz_oi_get_string_oidval(&apdu->u.initResponse->otherInfo,
3514 xfree(c->cookie_in);
3517 c->cookie_in = xstrdup(cookie);
3518 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3519 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3520 c->support_named_resultsets = 1;
3523 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3524 ZOOM_connection_remove_task(c);
3526 ZOOM_connection_exec_task(c);
3528 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3530 NMEM tmpmem = nmem_create();
3531 Z_CharSetandLanguageNegotiation *p =
3532 yaz_get_charneg_record(initrs->otherInfo);
3536 char *charset = NULL, *lang = NULL;
3539 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3540 yaz_log(log_details, "%p recv_apdu target accepted: "
3541 "charset %s, language %s, select %d",
3543 charset ? charset : "none", lang ? lang : "none", sel);
3545 ZOOM_connection_option_set(c, "negotiation-charset",
3548 ZOOM_connection_option_set(c, "negotiation-lang",
3551 ZOOM_connection_option_set(
3552 c, "negotiation-charset-in-effect-for-records",
3553 (sel != 0) ? "1" : "0");
3554 nmem_destroy(tmpmem);
3558 case Z_APDU_searchResponse:
3559 yaz_log(log_api, "%p recv_apdu Search response", c);
3560 handle_search_response(c, apdu->u.searchResponse);
3561 if (send_sort_present(c) == zoom_complete)
3562 ZOOM_connection_remove_task(c);
3564 case Z_APDU_presentResponse:
3565 yaz_log(log_api, "%p recv_apdu Present response", c);
3566 handle_present_response(c, apdu->u.presentResponse);
3567 if (send_present(c) == zoom_complete)
3568 ZOOM_connection_remove_task(c);
3570 case Z_APDU_sortResponse:
3571 yaz_log(log_api, "%p recv_apdu Sort response", c);
3572 sort_response(c, apdu->u.sortResponse);
3573 if (send_present(c) == zoom_complete)
3574 ZOOM_connection_remove_task(c);
3576 case Z_APDU_scanResponse:
3577 yaz_log(log_api, "%p recv_apdu Scan response", c);
3578 scan_response(c, apdu->u.scanResponse);
3579 ZOOM_connection_remove_task(c);
3581 case Z_APDU_extendedServicesResponse:
3582 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3583 es_response(c, apdu->u.extendedServicesResponse);
3584 ZOOM_connection_remove_task(c);
3587 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3588 if (!ZOOM_test_reconnect(c))
3590 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3595 yaz_log(log_api, "%p Received unknown PDU", c);
3596 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3602 static void handle_srw_response(ZOOM_connection c,
3603 Z_SRW_searchRetrieveResponse *res)
3605 ZOOM_resultset resultset = 0;
3610 const char *syntax, *elementSetName;
3615 switch(c->tasks->which)
3617 case ZOOM_TASK_SEARCH:
3618 resultset = c->tasks->u.search.resultset;
3619 start = &c->tasks->u.search.start;
3620 syntax = c->tasks->u.search.syntax;
3621 elementSetName = c->tasks->u.search.elementSetName;
3623 case ZOOM_TASK_RETRIEVE:
3624 resultset = c->tasks->u.retrieve.resultset;
3625 start = &c->tasks->u.retrieve.start;
3626 syntax = c->tasks->u.retrieve.syntax;
3627 elementSetName = c->tasks->u.retrieve.elementSetName;
3632 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3633 ZOOM_connection_put_event(c, event);
3635 resultset->size = 0;
3637 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3639 if (res->numberOfRecords)
3640 resultset->size = *res->numberOfRecords;
3642 for (i = 0; i<res->num_records; i++)
3646 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3647 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3649 if (res->records[i].recordPosition &&
3650 *res->records[i].recordPosition > 0)
3651 pos = *res->records[i].recordPosition - 1;
3655 npr->databaseName = 0;
3656 npr->which = Z_NamePlusRecord_databaseRecord;
3657 npr->u.databaseRecord = (Z_External *)
3658 odr_malloc(c->odr_in, sizeof(Z_External));
3659 npr->u.databaseRecord->descriptor = 0;
3660 npr->u.databaseRecord->direct_reference =
3661 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3662 npr->u.databaseRecord->which = Z_External_octet;
3664 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3665 odr_malloc(c->odr_in, sizeof(Odr_oct));
3666 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3667 res->records[i].recordData_buf;
3668 npr->u.databaseRecord->u.octet_aligned->len =
3669 npr->u.databaseRecord->u.octet_aligned->size =
3670 res->records[i].recordData_len;
3671 record_cache_add(resultset, npr, pos, syntax, elementSetName);
3673 if (res->num_diagnostics > 0)
3675 const char *uri = res->diagnostics[0].uri;
3680 if ((cp = strrchr(uri, '/')))
3682 set_dset_error(c, code, uri,
3683 res->diagnostics[0].details, 0);
3686 nmem = odr_extract_mem(c->odr_in);
3687 nmem_transfer(resultset->odr->mem, nmem);
3693 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3696 const char *content_type = z_HTTP_header_lookup(hres->headers,
3698 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3700 ZOOM_connection_set_mask(c, 0);
3701 yaz_log(log_details, "%p handle_http", c);
3703 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3705 Z_SOAP *soap_package = 0;
3707 Z_SOAP_Handler soap_handlers[2] = {
3708 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
3711 ret = z_soap_codec(o, &soap_package,
3712 &hres->content_buf, &hres->content_len,
3714 if (!ret && soap_package->which == Z_SOAP_generic &&
3715 soap_package->u.generic->no == 0)
3717 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3718 if (sr->which == Z_SRW_searchRetrieve_response)
3719 handle_srw_response(c, sr->u.response);
3723 else if (!ret && (soap_package->which == Z_SOAP_fault
3724 || soap_package->which == Z_SOAP_error))
3726 set_HTTP_error(c, hres->code,
3727 soap_package->u.fault->fault_code,
3728 soap_package->u.fault->fault_string);
3735 if (hres->code != 200)
3736 set_HTTP_error(c, hres->code, 0, 0);
3738 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3741 ZOOM_connection_remove_task(c);
3742 if (!strcmp(hres->version, "1.0"))
3744 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3745 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3750 /* HTTP 1.1: only if no close we stay alive .. */
3751 if (connection_head && !strcmp(connection_head, "close"))
3757 static int do_read(ZOOM_connection c)
3762 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3763 ZOOM_connection_put_event(c, event);
3765 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3766 more = cs_more(c->cs);
3767 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3772 if (ZOOM_test_reconnect(c))
3774 yaz_log(log_details, "%p do_read reconnect read", c);
3778 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3787 odr_reset(c->odr_in);
3788 odr_setbuf(c->odr_in, c->buf_in, r, 0);
3789 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3790 ZOOM_connection_put_event(c, event);
3792 if (!z_GDU(c->odr_in, &gdu, 0, 0))
3795 int err = odr_geterrorx(c->odr_in, &x);
3797 const char *element = odr_getelement(c->odr_in);
3798 sprintf(msg, "ODR code %d:%d element=%-20s",
3799 err, x, element ? element : "<unknown>");
3800 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3803 else if (gdu->which == Z_GDU_Z3950)
3804 recv_apdu(c, gdu->u.z3950);
3805 else if (gdu->which == Z_GDU_HTTP_Response)
3808 handle_http(c, gdu->u.HTTP_Response);
3810 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3814 c->reconnect_ok = 0;
3819 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3824 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3825 ZOOM_connection_put_event(c, event);
3827 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3828 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3830 yaz_log(log_details, "%p do_write_ex write failed", c);
3831 if (ZOOM_test_reconnect(c))
3833 return zoom_pending;
3835 if (c->state == STATE_CONNECTING)
3836 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3838 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3840 return zoom_complete;
3844 int mask = ZOOM_SELECT_EXCEPT;
3845 if (c->cs->io_pending & CS_WANT_WRITE)
3846 mask += ZOOM_SELECT_WRITE;
3847 if (c->cs->io_pending & CS_WANT_READ)
3848 mask += ZOOM_SELECT_READ;
3849 ZOOM_connection_set_mask(c, mask);
3850 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3855 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
3856 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3859 return zoom_pending;
3862 static zoom_ret do_write(ZOOM_connection c)
3864 return do_write_ex(c, c->buf_out, c->len_out);
3868 ZOOM_API(const char *)
3869 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3871 return ZOOM_options_get(c->options, key);
3874 ZOOM_API(const char *)
3875 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3877 return ZOOM_options_getl(c->options, key, lenp);
3881 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3884 ZOOM_options_set(c->options, key, val);
3888 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3889 const char *val, int len)
3891 ZOOM_options_setl(c->options, key, val, len);
3894 ZOOM_API(const char *)
3895 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3897 return ZOOM_options_get(r->options, key);
3901 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3904 ZOOM_options_set(r->options, key, val);
3909 ZOOM_connection_errcode(ZOOM_connection c)
3911 return ZOOM_connection_error(c, 0, 0);
3914 ZOOM_API(const char *)
3915 ZOOM_connection_errmsg(ZOOM_connection c)
3918 ZOOM_connection_error(c, &msg, 0);
3922 ZOOM_API(const char *)
3923 ZOOM_connection_addinfo(ZOOM_connection c)
3925 const char *addinfo;
3926 ZOOM_connection_error(c, 0, &addinfo);
3930 ZOOM_API(const char *)
3931 ZOOM_connection_diagset(ZOOM_connection c)
3933 const char *diagset;
3934 ZOOM_connection_error_x(c, 0, 0, &diagset);
3938 ZOOM_API(const char *)
3939 ZOOM_diag_str(int error)
3943 case ZOOM_ERROR_NONE:
3945 case ZOOM_ERROR_CONNECT:
3946 return "Connect failed";
3947 case ZOOM_ERROR_MEMORY:
3948 return "Out of memory";
3949 case ZOOM_ERROR_ENCODE:
3950 return "Encoding failed";
3951 case ZOOM_ERROR_DECODE:
3952 return "Decoding failed";
3953 case ZOOM_ERROR_CONNECTION_LOST:
3954 return "Connection lost";
3955 case ZOOM_ERROR_INIT:
3956 return "Init rejected";
3957 case ZOOM_ERROR_INTERNAL:
3958 return "Internal failure";
3959 case ZOOM_ERROR_TIMEOUT:
3961 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3962 return "Unsupported protocol";
3963 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3964 return "Unsupported query type";
3965 case ZOOM_ERROR_INVALID_QUERY:
3966 return "Invalid query";
3967 case ZOOM_ERROR_CQL_PARSE:
3968 return "CQL parsing error";
3969 case ZOOM_ERROR_CQL_TRANSFORM:
3970 return "CQL transformation error";
3971 case ZOOM_ERROR_CCL_CONFIG:
3972 return "CCL configuration error";
3973 case ZOOM_ERROR_CCL_PARSE:
3974 return "CCL parsing error";
3976 return diagbib1_str(error);
3981 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
3982 const char **addinfo, const char **diagset)
3984 int error = c->error;
3987 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3988 *cp = ZOOM_diag_str(error);
3989 else if (!strcmp(c->diagset, "HTTP"))
3990 *cp = z_HTTP_errmsg(c->error);
3991 else if (!strcmp(c->diagset, "Bib-1"))
3992 *cp = ZOOM_diag_str(error);
3993 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3994 *cp = yaz_diag_srw_str(c->error);
3996 *cp = "Unknown error and diagnostic set";
3999 *addinfo = c->addinfo ? c->addinfo : "";
4001 *diagset = c->diagset ? c->diagset : "";
4006 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4007 const char **addinfo)
4009 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4012 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4014 ZOOM_Event event = 0;
4015 int r = cs_look(c->cs);
4016 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4021 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4022 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4024 ZOOM_connection_put_event(c, event);
4026 else if (r == CS_CONNECT)
4028 int ret = ret = cs_rcvconnect(c->cs);
4029 yaz_log(log_details, "%p ZOOM_connection_do_io "
4030 "cs_rcvconnect returned %d", c, ret);
4033 int mask = ZOOM_SELECT_EXCEPT;
4034 if (c->cs->io_pending & CS_WANT_WRITE)
4035 mask += ZOOM_SELECT_WRITE;
4036 if (c->cs->io_pending & CS_WANT_READ)
4037 mask += ZOOM_SELECT_READ;
4038 ZOOM_connection_set_mask(c, mask);
4042 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4043 ZOOM_connection_put_event(c, event);
4045 if (c->proto == PROTO_Z3950)
4046 ZOOM_connection_send_init(c);
4049 /* no init request for SRW .. */
4050 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4051 ZOOM_connection_remove_task(c);
4052 ZOOM_connection_set_mask(c, 0);
4053 ZOOM_connection_exec_task(c);
4055 c->state = STATE_ESTABLISHED;
4059 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4065 if (mask & ZOOM_SELECT_EXCEPT)
4067 if (ZOOM_test_reconnect(c))
4069 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4070 ZOOM_connection_put_event(c, event);
4074 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4079 if (mask & ZOOM_SELECT_READ)
4081 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4087 ZOOM_connection_last_event(ZOOM_connection cs)
4090 return ZOOM_EVENT_NONE;
4091 return cs->last_event;
4096 * Returns an xmalloc()d string containing RPN that corresponds to the
4097 * CQL passed in. On error, sets the Connection object's error state
4098 * and returns a null pointer.
4099 * ### We could cache CQL parser and/or transformer in Connection.
4101 static char *cql2pqf(ZOOM_connection c, const char *cql)
4105 struct cql_node *node;
4106 const char *cqlfile;
4107 static cql_transform_t trans;
4110 parser = cql_parser_create();
4111 if ((error = cql_parser_string(parser, cql)) != 0) {
4112 cql_parser_destroy(parser);
4113 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4117 node = cql_parser_result(parser);
4118 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4120 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4122 cql_parser_destroy(parser);
4123 cql_node_destroy(node);
4124 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4128 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4130 cql_parser_destroy(parser);
4131 cql_node_destroy(node);
4132 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4133 cqlfile, strerror(errno));
4134 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4138 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4139 cql_parser_destroy(parser);
4140 cql_node_destroy(node);
4143 const char *addinfo;
4144 error = cql_transform_error(trans, &addinfo);
4145 cql_transform_close(trans);
4146 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4147 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4151 cql_transform_close(trans);
4152 return xstrdup(pqfbuf);
4155 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4159 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4160 /* timeout and this connection was waiting */
4161 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4163 ZOOM_connection_put_event(c, event);
4169 ZOOM_connection_process(ZOOM_connection c)
4175 event = ZOOM_connection_get_event(c);
4178 ZOOM_Event_destroy(event);
4181 ZOOM_connection_exec_task(c);
4182 event = ZOOM_connection_get_event(c);
4185 ZOOM_Event_destroy(event);
4192 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4196 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4198 for (i = 0; i<no; i++)
4200 ZOOM_connection c = cs[i];
4202 if (c && ZOOM_connection_process(c))
4208 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4210 if (c->mask && mask)
4211 ZOOM_connection_do_io(c, mask);
4215 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4218 return cs_fileno(c->cs);
4222 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4230 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4237 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4239 return ZOOM_options_get_int(c->options, "timeout", 30);
4245 * indent-tabs-mode: nil
4247 * vim: shiftwidth=4 tabstop=8 expandtab