2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.116 2007-03-12 08:27:44 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 void resultset_destroy(ZOOM_resultset r);
41 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
42 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
43 static char *cql2pqf(ZOOM_connection c, const char *cql);
47 * This wrapper is just for logging failed lookups. It would be nicer
48 * if it could cause failure when a lookup fails, but that's hard.
50 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
51 int oid_class, const char *str) {
52 Odr_oid *res = yaz_str_to_z3950oid(c->odr_out, oid_class, str);
54 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
55 c, (int) oid_class, str);
60 static void initlog(void)
62 static int log_level_initialized = 0;
63 if (!log_level_initialized)
65 log_api = yaz_log_module_level("zoom");
66 log_details = yaz_log_module_level("zoomdetails");
67 log_level_initialized = 1;
71 static ZOOM_Event ZOOM_Event_create(int kind)
73 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
77 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
81 static void ZOOM_Event_destroy(ZOOM_Event event)
86 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
90 c->m_queue_back->prev = event;
91 assert(c->m_queue_front);
95 assert(!c->m_queue_front);
96 c->m_queue_front = event;
98 event->next = c->m_queue_back;
100 c->m_queue_back = event;
103 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
105 ZOOM_Event event = c->m_queue_front;
108 c->last_event = ZOOM_EVENT_NONE;
111 assert(c->m_queue_back);
112 c->m_queue_front = event->prev;
113 if (c->m_queue_front)
115 assert(c->m_queue_back);
116 c->m_queue_front->next = 0;
120 c->last_event = event->kind;
124 static void ZOOM_connection_remove_events(ZOOM_connection c)
127 while ((event = ZOOM_connection_get_event(c)))
128 ZOOM_Event_destroy(event);
131 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
133 ZOOM_Event event = c->m_queue_front;
135 return event ? event->kind : ZOOM_EVENT_NONE;
138 void ZOOM_connection_remove_tasks(ZOOM_connection c);
140 static void set_dset_error(ZOOM_connection c, int error,
142 const char *addinfo, const char *addinfo2)
149 if (!c->diagset || strcmp(dset, c->diagset))
152 c->diagset = xstrdup(dset);
153 /* remove integer part from SRW diagset .. */
154 if ((cp = strrchr(c->diagset, '/')))
157 if (addinfo && addinfo2)
159 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
160 strcpy(c->addinfo, addinfo);
161 strcat(c->addinfo, addinfo2);
164 c->addinfo = xstrdup(addinfo);
165 if (error != ZOOM_ERROR_NONE)
167 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
168 c, c->host_port ? c->host_port : "<>", dset, error,
169 addinfo ? addinfo : "",
170 addinfo2 ? addinfo2 : "");
172 ZOOM_connection_remove_tasks(c);
178 static void set_HTTP_error(ZOOM_connection c, int error,
179 const char *addinfo, const char *addinfo2)
181 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
186 static void set_ZOOM_error(ZOOM_connection c, int error,
189 set_dset_error(c, error, "ZOOM", addinfo, 0);
192 static void clear_error(ZOOM_connection c)
195 * If an error is tied to an operation then it's ok to clear: for
196 * example, a diagnostic returned from a search is cleared by a
197 * subsequent search. However, problems such as Connection Lost
198 * or Init Refused are not cleared, because they are not
199 * recoverable: doing another search doesn't help.
202 ZOOM_connection_remove_events(c);
205 case ZOOM_ERROR_CONNECT:
206 case ZOOM_ERROR_MEMORY:
207 case ZOOM_ERROR_DECODE:
208 case ZOOM_ERROR_CONNECTION_LOST:
209 case ZOOM_ERROR_INIT:
210 case ZOOM_ERROR_INTERNAL:
211 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
214 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
218 void ZOOM_connection_show_task(ZOOM_task task)
222 case ZOOM_TASK_SEARCH:
223 yaz_log(YLOG_LOG, "search p=%p", task);
225 case ZOOM_TASK_RETRIEVE:
226 yaz_log(YLOG_LOG, "retrieve p=%p", task);
228 case ZOOM_TASK_CONNECT:
229 yaz_log(YLOG_LOG, "connect p=%p", task);
232 yaz_log(YLOG_LOG, "scant p=%p", task);
237 void ZOOM_connection_show_tasks(ZOOM_connection c)
240 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
241 for (task = c->tasks; task; task = task->next)
242 ZOOM_connection_show_task(task);
245 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
247 ZOOM_task *taskp = &c->tasks;
249 taskp = &(*taskp)->next;
250 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
251 (*taskp)->running = 0;
252 (*taskp)->which = which;
258 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
260 return c->tasks ? 0 : 1;
263 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
265 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
267 task->next = c->tasks;
276 void ZOOM_connection_remove_task(ZOOM_connection c)
278 ZOOM_task task = c->tasks;
282 c->tasks = task->next;
285 case ZOOM_TASK_SEARCH:
286 resultset_destroy(task->u.search.resultset);
287 xfree(task->u.search.syntax);
288 xfree(task->u.search.elementSetName);
290 case ZOOM_TASK_RETRIEVE:
291 resultset_destroy(task->u.retrieve.resultset);
292 xfree(task->u.retrieve.syntax);
293 xfree(task->u.retrieve.elementSetName);
295 case ZOOM_TASK_CONNECT:
298 ZOOM_scanset_destroy(task->u.scan.scan);
300 case ZOOM_TASK_PACKAGE:
301 ZOOM_package_destroy(task->u.package);
304 resultset_destroy(task->u.sort.resultset);
305 ZOOM_query_destroy(task->u.sort.q);
314 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
315 ZOOM_connection_put_event(c, event);
320 static int ZOOM_connection_exec_task(ZOOM_connection c);
322 void ZOOM_connection_remove_tasks(ZOOM_connection c)
325 ZOOM_connection_remove_task(c);
328 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
330 const char *elementSetName);
332 ZOOM_API(ZOOM_connection)
333 ZOOM_connection_create(ZOOM_options options)
335 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
339 yaz_log(log_api, "%p ZOOM_connection_create", c);
341 c->proto = PROTO_Z3950;
343 ZOOM_connection_set_mask(c, 0);
345 c->state = STATE_IDLE;
348 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
355 c->options = ZOOM_options_create_with_parent(options);
361 c->charset = c->lang = 0;
368 c->odr_in = odr_createmem(ODR_DECODE);
369 c->odr_out = odr_createmem(ODR_ENCODE);
372 c->support_named_resultsets = 0;
373 c->last_event = ZOOM_EVENT_NONE;
375 c->m_queue_front = 0;
381 /* set database names. Take local databases (if set); otherwise
382 take databases given in ZURL (if set); otherwise use Default */
383 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
386 char **databaseNames;
387 const char *cp = ZOOM_options_get(options, "databaseName");
389 if ((!cp || !*cp) && con->host_port)
391 if (strncmp(con->host_port, "unix:", 5) == 0)
392 cp = strchr(con->host_port+5, ':');
394 cp = strchr(con->host_port, '/');
400 nmem_strsplit(odr->mem, "+", cp, &databaseNames, num);
401 return databaseNames;
404 ZOOM_API(ZOOM_connection)
405 ZOOM_connection_new(const char *host, int portnum)
407 ZOOM_connection c = ZOOM_connection_create(0);
409 ZOOM_connection_connect(c, host, portnum);
413 static zoom_sru_mode get_sru_mode_from_string(const char *s)
416 return zoom_sru_soap;
417 if (!yaz_matchstr(s, "soap"))
418 return zoom_sru_soap;
419 else if (!yaz_matchstr(s, "get"))
421 else if (!yaz_matchstr(s, "post"))
422 return zoom_sru_post;
423 return zoom_sru_error;
427 ZOOM_connection_connect(ZOOM_connection c,
428 const char *host, int portnum)
435 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
436 c, host ? host : "null", portnum);
438 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
439 ZOOM_connection_remove_tasks(c);
443 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
447 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
449 val = ZOOM_options_get(c->options, "proxy");
452 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
453 c->proxy = xstrdup(val);
459 val = ZOOM_options_get(c->options, "charset");
462 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
463 c->charset = xstrdup(val);
469 val = ZOOM_options_get(c->options, "lang");
472 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
473 c->lang = xstrdup(val);
484 sprintf(hostn, "%.80s:%d", host, portnum);
485 c->host_port = xstrdup(hostn);
488 c->host_port = xstrdup(host);
493 * If the "<scheme>:" part of the host string is preceded by one
494 * or more comma-separated <name>=<value> pairs, these are taken
495 * to be options to be set on the connection object. Among other
496 * applications, this facility can be used to embed authentication
498 * user=admin,password=secret,tcp:localhost:9999
500 char *remainder = c->host_port;
501 char *pcolon = strchr(remainder, ':');
504 while ((pcomma = strchr(remainder, ',')) != 0 &&
505 (pcolon == 0 || pcomma < pcolon)) {
507 if ((pequals = strchr(remainder, '=')) != 0) {
509 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
510 ZOOM_connection_option_set(c, remainder, pequals+1);
512 remainder = pcomma+1;
515 if (remainder != c->host_port) {
517 c->host_port = xstrdup(remainder);
518 /*printf("# reset hp='%s'\n", remainder);*/
522 val = ZOOM_options_get(c->options, "sru");
523 c->sru_mode = get_sru_mode_from_string(val);
525 ZOOM_options_set(c->options, "host", c->host_port);
527 val = ZOOM_options_get(c->options, "cookie");
530 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
531 c->cookie_out = xstrdup(val);
534 val = ZOOM_options_get(c->options, "clientIP");
537 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
539 c->client_IP = xstrdup(val);
542 c->async = ZOOM_options_get_bool(c->options, "async", 0);
543 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
545 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
549 while (ZOOM_event(1, &c))
555 ZOOM_query_create(void)
557 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
559 yaz_log(log_details, "%p ZOOM_query_create", s);
563 s->odr = odr_createmem(ODR_ENCODE);
570 ZOOM_query_destroy(ZOOM_query s)
576 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
577 if (s->refcount == 0)
585 ZOOM_query_prefix(ZOOM_query s, const char *str)
587 s->query_string = odr_strdup(s->odr, str);
588 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
589 s->z_query->which = Z_Query_type_1;
590 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
591 if (!s->z_query->u.type_1)
593 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
597 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
602 ZOOM_query_cql(ZOOM_query s, const char *str)
606 s->query_string = odr_strdup(s->odr, str);
608 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
609 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
610 ext->indirect_reference = 0;
612 ext->which = Z_External_CQL;
613 ext->u.cql = s->query_string;
615 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
616 s->z_query->which = Z_Query_type_104;
617 s->z_query->u.type_104 = ext;
619 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
625 * Translate the CQL string client-side into RPN which is passed to
626 * the server. This is useful for server's that don't themselves
627 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
628 * only as a place to stash diagnostics if compilation fails; if this
629 * information is not needed, a null pointer may be used.
632 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
636 ZOOM_connection freeme = 0;
638 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
640 conn = freeme = ZOOM_connection_create(0);
642 rpn = cql2pqf(conn, str);
644 ZOOM_connection_destroy(freeme);
648 ret = ZOOM_query_prefix(s, rpn);
654 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
655 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
656 * to the server, as the YAZ GFS doesn't know how to handle this.
659 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
660 int *ccl_error, const char **error_string,
664 struct ccl_rpn_node *rpn;
665 CCL_bibset bibset = ccl_qual_mk();
668 ccl_qual_buf(bibset, config);
670 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
673 *error_string = ccl_err_msg(*ccl_error);
678 WRBUF wr = wrbuf_alloc();
681 ret = ZOOM_query_prefix(s, wrbuf_buf(wr));
684 ccl_qual_rm(&bibset);
689 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
691 s->sort_spec = yaz_sort_spec(s->odr, criteria);
694 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
698 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
702 static zoom_ret do_write(ZOOM_connection c);
705 ZOOM_connection_destroy(ZOOM_connection c)
710 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
713 for (r = c->resultsets; r; r = r->next)
719 odr_destroy(c->odr_in);
720 odr_destroy(c->odr_out);
721 ZOOM_options_destroy(c->options);
722 ZOOM_connection_remove_tasks(c);
723 ZOOM_connection_remove_events(c);
729 xfree(c->cookie_out);
735 void ZOOM_resultset_addref(ZOOM_resultset r)
740 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
745 ZOOM_resultset ZOOM_resultset_create(void)
748 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
752 yaz_log(log_details, "%p ZOOM_resultset_create", r);
755 r->odr = odr_createmem(ODR_ENCODE);
760 for (i = 0; i<RECORD_HASH_SIZE; i++)
761 r->record_hash[i] = 0;
766 r->databaseNames = 0;
767 r->num_databaseNames = 0;
771 ZOOM_API(ZOOM_resultset)
772 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
775 ZOOM_query s = ZOOM_query_create();
777 ZOOM_query_prefix(s, q);
779 r = ZOOM_connection_search(c, s);
780 ZOOM_query_destroy(s);
784 ZOOM_API(ZOOM_resultset)
785 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
787 ZOOM_resultset r = ZOOM_resultset_create();
791 const char *syntax, *elementSetName;
793 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
794 r->r_sort_spec = q->sort_spec;
797 r->options = ZOOM_options_create_with_parent(c->options);
799 start = ZOOM_options_get_int(r->options, "start", 0);
800 count = ZOOM_options_get_int(r->options, "count", 0);
802 /* If "presentChunk" is defined use that; otherwise "step" */
803 const char *cp = ZOOM_options_get(r->options, "presentChunk");
804 r->step = ZOOM_options_get_int(r->options,
805 (cp != 0 ? "presentChunk": "step"), 0);
807 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
808 cp = ZOOM_options_get(r->options, "setname");
810 r->setname = xstrdup(cp);
811 cp = ZOOM_options_get(r->options, "schema");
813 r->schema = xstrdup(cp);
815 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
820 r->next = c->resultsets;
823 if (c->host_port && c->proto == PROTO_HTTP)
827 yaz_log(log_details, "ZOOM_connection_search: no comstack");
828 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
832 yaz_log(log_details, "ZOOM_connection_search: reconnect");
837 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
838 task->u.search.resultset = r;
839 task->u.search.start = start;
840 task->u.search.count = count;
842 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
843 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
844 elementSetName = ZOOM_options_get(r->options, "elementSetName");
845 task->u.search.elementSetName = elementSetName
846 ? xstrdup(elementSetName) : 0;
848 ZOOM_resultset_addref(r);
854 while (ZOOM_event(1, &c))
861 * This is the old result-set sorting API, which is maintained only
862 * for the sake of binary compatibility. There is no reason ever to
863 * use this rather than ZOOM_resultset_sort1().
866 ZOOM_resultset_sort(ZOOM_resultset r,
867 const char *sort_type, const char *sort_spec)
869 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
873 ZOOM_resultset_sort1(ZOOM_resultset r,
874 const char *sort_type, const char *sort_spec)
876 ZOOM_connection c = r->connection;
880 newq = ZOOM_query_create();
881 if (ZOOM_query_sortby(newq, sort_spec) < 0)
884 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
885 r, r, sort_type, sort_spec);
889 if (c->host_port && c->proto == PROTO_HTTP)
893 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
894 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
898 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
904 ZOOM_resultset_cache_reset(r);
905 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
906 task->u.sort.resultset = r;
907 task->u.sort.q = newq;
909 ZOOM_resultset_addref(r);
913 while (ZOOM_event(1, &c))
921 ZOOM_resultset_cache_reset(ZOOM_resultset r)
924 for (i = 0; i<RECORD_HASH_SIZE; i++)
926 ZOOM_record_cache rc;
927 for (rc = r->record_hash[i]; rc; rc = rc->next)
929 if (rc->rec.wrbuf_marc)
930 wrbuf_free(rc->rec.wrbuf_marc, 1);
931 if (rc->rec.wrbuf_iconv)
932 wrbuf_free(rc->rec.wrbuf_iconv, 1);
933 if (rc->rec.wrbuf_opac)
934 wrbuf_free(rc->rec.wrbuf_opac, 1);
936 r->record_hash[i] = 0;
941 ZOOM_resultset_destroy(ZOOM_resultset r)
943 resultset_destroy(r);
946 static void resultset_destroy(ZOOM_resultset r)
951 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
953 if (r->refcount == 0)
955 ZOOM_resultset_cache_reset(r);
959 /* remove ourselves from the resultsets in connection */
960 ZOOM_resultset *rp = &r->connection->resultsets;
963 assert(*rp); /* we must be in this list!! */
965 { /* OK, we're here - take us out of it */
972 ZOOM_query_destroy(r->query);
973 ZOOM_options_destroy(r->options);
982 ZOOM_resultset_size(ZOOM_resultset r)
984 yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
989 static void do_close(ZOOM_connection c)
994 ZOOM_connection_set_mask(c, 0);
995 c->state = STATE_IDLE;
998 static int ZOOM_test_reconnect(ZOOM_connection c)
1002 if (!c->reconnect_ok)
1005 c->reconnect_ok = 0;
1006 c->tasks->running = 0;
1007 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1009 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1010 ZOOM_connection_put_event(c, event);
1015 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1016 int force_sync, int start, int count)
1021 const char *syntax, *elementSetName;
1025 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1026 " count=%d", r, force_sync, start, count);
1031 if (c->host_port && c->proto == PROTO_HTTP)
1035 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1036 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1040 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1042 c->reconnect_ok = 1;
1045 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1046 task->u.retrieve.resultset = r;
1047 task->u.retrieve.start = start;
1048 task->u.retrieve.count = count;
1050 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1051 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1052 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1053 task->u.retrieve.elementSetName = elementSetName
1054 ? xstrdup(elementSetName) : 0;
1056 cp = ZOOM_options_get(r->options, "schema");
1059 if (!r->schema || strcmp(r->schema, cp))
1062 r->schema = xstrdup(cp);
1066 ZOOM_resultset_addref(r);
1068 if (!r->connection->async || force_sync)
1069 while (r->connection && ZOOM_event(1, &r->connection))
1074 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1075 size_t start, size_t count)
1077 int force_present = 0;
1081 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1082 r, r, (long) start, (long) count);
1085 ZOOM_resultset_retrieve(r, force_present, start, count);
1089 for (i = 0; i< count; i++)
1090 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1094 static void get_cert(ZOOM_connection c)
1099 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1101 ZOOM_connection_option_setl(c, "sslPeerCert",
1102 cert_buf, cert_len);
1107 static zoom_ret do_connect(ZOOM_connection c)
1110 const char *effective_host;
1113 effective_host = c->proxy;
1115 effective_host = c->host_port;
1117 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1121 c->cs = cs_create_host(effective_host, 0, &add);
1123 if (c->cs && c->cs->protocol == PROTO_HTTP)
1126 const char *path = 0;
1128 c->proto = PROTO_HTTP;
1129 cs_get_host_args(c->host_port, &path);
1131 c->path = (char*) xmalloc(strlen(path)+2);
1133 strcpy(c->path+1, path);
1135 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1137 return zoom_complete;
1142 int ret = cs_connect(c->cs, add);
1145 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1146 ZOOM_connection_put_event(c, event);
1148 if (c->proto == PROTO_Z3950)
1149 ZOOM_connection_send_init(c);
1152 /* no init request for SRW .. */
1153 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1154 ZOOM_connection_remove_task(c);
1155 ZOOM_connection_set_mask(c, 0);
1156 ZOOM_connection_exec_task(c);
1158 c->state = STATE_ESTABLISHED;
1159 return zoom_pending;
1163 int mask = ZOOM_SELECT_EXCEPT;
1164 if (c->cs->io_pending & CS_WANT_WRITE)
1165 mask += ZOOM_SELECT_WRITE;
1166 if (c->cs->io_pending & CS_WANT_READ)
1167 mask += ZOOM_SELECT_READ;
1168 ZOOM_connection_set_mask(c, mask);
1169 c->state = STATE_CONNECTING;
1170 return zoom_pending;
1173 c->state = STATE_IDLE;
1174 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1175 return zoom_complete;
1178 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1181 for (i = 0; i<200; i++)
1184 Z_OtherInformation **oi;
1190 sprintf(buf, "otherInfo%d", i);
1191 val = ZOOM_options_get(c->options, buf);
1194 cp = strchr(val, ':');
1198 if (len >= sizeof(buf))
1199 len = sizeof(buf)-1;
1200 memcpy(buf, val, len);
1202 oidval = oid_getvalbyname(buf);
1203 if (oidval == VAL_NONE)
1206 yaz_oi_APDU(a, &oi);
1207 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1211 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1216 Z_OtherInformation **oi;
1217 yaz_oi_APDU(a, &oi);
1218 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1222 Z_OtherInformation **oi;
1223 yaz_oi_APDU(a, &oi);
1224 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1226 otherInfo_attach(c, a, out);
1227 if (!z_APDU(out, &a, 0, 0))
1229 FILE *outf = fopen("/tmp/apdu.txt", "a");
1232 ODR odr_pr = odr_createmem(ODR_PRINT);
1233 fprintf(outf, "a=%p\n", a);
1234 odr_setprint(odr_pr, outf);
1235 z_APDU(odr_pr, &a, 0, 0);
1236 odr_destroy(odr_pr);
1238 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1239 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1243 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1247 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1251 if (encode_APDU(c, a, c->odr_out))
1252 return zoom_complete;
1253 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1254 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1255 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1256 ZOOM_connection_put_event(c, event);
1257 odr_reset(c->odr_out);
1261 /* returns 1 if PDU was sent OK (still pending )
1262 0 if PDU was not sent OK (nothing to wait for)
1265 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1267 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1268 Z_InitRequest *ireq = apdu->u.initRequest;
1269 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1270 odr_malloc(c->odr_out, sizeof(*auth));
1271 const char *auth_groupId = ZOOM_options_get(c->options, "group");
1272 const char *auth_userId = ZOOM_options_get(c->options, "user");
1273 const char *auth_password = ZOOM_options_get(c->options, "password");
1276 /* support the pass for backwards compatibility */
1278 auth_password = ZOOM_options_get(c->options, "pass");
1280 ODR_MASK_SET(ireq->options, Z_Options_search);
1281 ODR_MASK_SET(ireq->options, Z_Options_present);
1282 ODR_MASK_SET(ireq->options, Z_Options_scan);
1283 ODR_MASK_SET(ireq->options, Z_Options_sort);
1284 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1285 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1287 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1288 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1289 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1291 /* Index Data's Z39.50 Implementor Id is 81 */
1292 ireq->implementationId =
1293 odr_prepend(c->odr_out,
1294 ZOOM_options_get(c->options, "implementationId"),
1295 odr_prepend(c->odr_out, "81", ireq->implementationId));
1297 ireq->implementationName =
1298 odr_prepend(c->odr_out,
1299 ZOOM_options_get(c->options, "implementationName"),
1300 odr_prepend(c->odr_out, "ZOOM-C",
1301 ireq->implementationName));
1303 version = odr_strdup(c->odr_out, "$Revision: 1.116 $");
1304 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1305 version[strlen(version)-2] = '\0';
1306 ireq->implementationVersion =
1307 odr_prepend(c->odr_out,
1308 ZOOM_options_get(c->options, "implementationVersion"),
1309 odr_prepend(c->odr_out, &version[11],
1310 ireq->implementationVersion));
1312 *ireq->maximumRecordSize =
1313 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
1314 *ireq->preferredMessageSize =
1315 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
1317 if (auth_groupId || auth_password)
1319 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1322 if (auth_groupId && *auth_groupId)
1324 pass->groupId = (char *)
1325 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1326 strcpy(pass->groupId, auth_groupId);
1330 if (auth_userId && *auth_userId)
1332 pass->userId = (char *)
1333 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1334 strcpy(pass->userId, auth_userId);
1338 if (auth_password && *auth_password)
1340 pass->password = (char *)
1341 odr_malloc(c->odr_out, strlen(auth_password)+1);
1342 strcpy(pass->password, auth_password);
1347 auth->which = Z_IdAuthentication_idPass;
1348 auth->u.idPass = pass;
1349 ireq->idAuthentication = auth;
1352 else if (auth_userId)
1354 auth->which = Z_IdAuthentication_open;
1355 auth->u.open = (char *)
1356 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1357 strcpy(auth->u.open, auth_userId);
1358 ireq->idAuthentication = auth;
1361 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1362 VAL_PROXY, 1, c->host_port);
1363 if (c->charset || c->lang)
1365 Z_OtherInformation **oi;
1366 Z_OtherInformationUnit *oi_unit;
1368 yaz_oi_APDU(apdu, &oi);
1370 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1372 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1373 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1374 oi_unit->information.externallyDefinedInfo =
1375 yaz_set_proposal_charneg_list(c->odr_out, " ",
1376 c->charset, c->lang, 1);
1380 return send_APDU(c, apdu);
1384 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1389 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1391 if (c->sru_mode == zoom_sru_get)
1393 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1395 else if (c->sru_mode == zoom_sru_post)
1397 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1399 else if (c->sru_mode == zoom_sru_soap)
1401 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1403 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1404 return zoom_complete;
1405 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1407 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1408 ZOOM_connection_put_event(c, event);
1409 odr_reset(c->odr_out);
1415 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1419 ZOOM_resultset resultset = 0;
1421 const char *option_val = 0;
1423 if (c->error) /* don't continue on error */
1424 return zoom_complete;
1426 switch(c->tasks->which)
1428 case ZOOM_TASK_SEARCH:
1429 resultset = c->tasks->u.search.resultset;
1430 resultset->setname = xstrdup("default");
1431 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1432 start = &c->tasks->u.search.start;
1433 count = &c->tasks->u.search.count;
1435 case ZOOM_TASK_RETRIEVE:
1436 resultset = c->tasks->u.retrieve.resultset;
1438 start = &c->tasks->u.retrieve.start;
1439 count = &c->tasks->u.retrieve.count;
1441 if (*start >= resultset->size)
1442 return zoom_complete;
1443 if (*start + *count > resultset->size)
1444 *count = resultset->size - *start;
1446 for (i = 0; i < *count; i++)
1449 record_cache_lookup(resultset, i + *start,
1450 c->tasks->u.retrieve.syntax,
1451 c->tasks->u.retrieve.elementSetName);
1456 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1457 ZOOM_connection_put_event(c, event);
1464 return zoom_complete;
1467 return zoom_complete;
1469 assert(resultset->query);
1471 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1473 if (resultset->query->z_query->which == Z_Query_type_104
1474 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1476 sr->u.request->query_type = Z_SRW_query_type_cql;
1477 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1479 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1480 resultset->query->z_query->u.type_1)
1482 sr->u.request->query_type = Z_SRW_query_type_pqf;
1483 sr->u.request->query.pqf = resultset->query->query_string;
1487 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1488 return zoom_complete;
1490 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1491 sr->u.request->maximumRecords = odr_intdup(
1492 c->odr_out, resultset->step>0 ? resultset->step : *count);
1493 sr->u.request->recordSchema = resultset->schema;
1495 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1497 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1499 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1501 sr->extra_args = odr_strdup(c->odr_out, option_val);
1502 return send_srw(c, sr);
1505 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1507 return zoom_complete;
1511 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1514 int lslb, ssub, mspn;
1516 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1517 Z_SearchRequest *search_req = apdu->u.searchRequest;
1518 const char *elementSetName;
1519 const char *smallSetElementSetName;
1520 const char *mediumSetElementSetName;
1523 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1525 r = c->tasks->u.search.resultset;
1527 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1530 ZOOM_options_get(r->options, "elementSetName");
1531 smallSetElementSetName =
1532 ZOOM_options_get(r->options, "smallSetElementSetName");
1533 mediumSetElementSetName =
1534 ZOOM_options_get(r->options, "mediumSetElementSetName");
1536 if (!smallSetElementSetName)
1537 smallSetElementSetName = elementSetName;
1539 if (!mediumSetElementSetName)
1540 mediumSetElementSetName = elementSetName;
1545 /* prepare query for the search request */
1546 search_req->query = r->query->z_query;
1547 if (!search_req->query)
1549 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1550 return zoom_complete;
1553 search_req->databaseNames = r->databaseNames;
1554 search_req->num_databaseNames = r->num_databaseNames;
1556 /* get syntax (no need to provide unless piggyback is in effect) */
1557 syntax = c->tasks->u.search.syntax;
1559 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1560 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1561 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1562 if (lslb != -1 && ssub != -1 && mspn != -1)
1564 /* So're a Z39.50 expert? Let's hope you don't do sort */
1565 *search_req->largeSetLowerBound = lslb;
1566 *search_req->smallSetUpperBound = ssub;
1567 *search_req->mediumSetPresentNumber = mspn;
1569 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1570 && r->piggyback && !r->r_sort_spec && !r->schema)
1572 /* Regular piggyback - do it unless we're going to do sort */
1573 *search_req->largeSetLowerBound = 2000000000;
1574 *search_req->smallSetUpperBound = 1;
1575 *search_req->mediumSetPresentNumber =
1576 r->step>0 ? r->step : c->tasks->u.search.count;
1580 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1581 smallSetElementSetName = 0;
1582 mediumSetElementSetName = 0;
1585 if (smallSetElementSetName && *smallSetElementSetName)
1587 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1588 odr_malloc(c->odr_out, sizeof(*esn));
1590 esn->which = Z_ElementSetNames_generic;
1591 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1592 search_req->smallSetElementSetNames = esn;
1594 if (mediumSetElementSetName && *mediumSetElementSetName)
1596 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1597 odr_malloc(c->odr_out, sizeof(*esn));
1599 esn->which = Z_ElementSetNames_generic;
1600 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1601 search_req->mediumSetElementSetNames = esn;
1604 search_req->preferredRecordSyntax =
1605 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1609 if (c->support_named_resultsets)
1613 /* find the lowest unused ordinal so that we re-use
1614 result sets on the server. */
1615 for (ord = 1; ; ord++)
1618 sprintf(setname, "%d", ord);
1619 for (rp = c->resultsets; rp; rp = rp->next)
1620 if (rp->setname && !strcmp(rp->setname, setname))
1625 r->setname = xstrdup(setname);
1626 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1627 "set %s", c, r->setname);
1631 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1633 r->setname = xstrdup("default");
1635 ZOOM_options_set(r->options, "setname", r->setname);
1637 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1638 return send_APDU(c, apdu);
1641 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1648 case Z_DefaultDiagFormat_v2Addinfo:
1649 addinfo = r->u.v2Addinfo;
1651 case Z_DefaultDiagFormat_v3Addinfo:
1652 addinfo = r->u.v3Addinfo;
1657 set_dset_error(c, *r->condition,
1658 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1662 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1664 if (p->which != Z_DiagRec_defaultFormat)
1665 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1667 response_default_diag(c, p->u.defaultFormat);
1670 ZOOM_API(ZOOM_record)
1671 ZOOM_record_clone(ZOOM_record srec)
1678 odr_enc = odr_createmem(ODR_ENCODE);
1679 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1681 buf = odr_getbuf(odr_enc, &size, 0);
1683 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1684 nrec->odr = odr_createmem(ODR_DECODE);
1685 nrec->wrbuf_marc = 0;
1686 nrec->wrbuf_iconv = 0;
1687 nrec->wrbuf_opac = 0;
1688 odr_setbuf(nrec->odr, buf, size, 0);
1689 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1691 odr_destroy(odr_enc);
1695 ZOOM_API(ZOOM_record)
1696 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1698 const char *syntax =
1699 ZOOM_options_get(s->options, "preferredRecordSyntax");
1700 const char *elementSetName =
1701 ZOOM_options_get(s->options, "elementSetName");
1703 return record_cache_lookup(s, pos, syntax, elementSetName);
1706 ZOOM_API(ZOOM_record)
1707 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1709 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1714 * MIKE: I think force_sync should always be zero, but I don't
1715 * want to make this change until I get the go-ahead from
1716 * Adam, in case something depends on the old synchronous
1720 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1721 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1722 rec = ZOOM_resultset_record_immediate(r, pos);
1728 ZOOM_record_destroy(ZOOM_record rec)
1732 if (rec->wrbuf_marc)
1733 wrbuf_free(rec->wrbuf_marc, 1);
1734 if (rec->wrbuf_iconv)
1735 wrbuf_free(rec->wrbuf_iconv, 1);
1736 if (rec->wrbuf_opac)
1737 wrbuf_free(rec->wrbuf_opac, 1);
1738 odr_destroy(rec->odr);
1742 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1744 const char *buf, int sz,
1745 const char *record_charset)
1750 yaz_marc_t mt = yaz_marc_create();
1753 strcpy(to, "UTF-8");
1754 if (record_charset && *record_charset)
1756 /* Use "from,to" or just "from" */
1757 const char *cp = strchr(record_charset, ',');
1758 int clen = strlen(record_charset);
1761 strncpy( to, cp+1, sizeof(to)-1);
1762 to[sizeof(to)-1] = '\0';
1763 clen = cp - record_charset;
1765 if (clen > sizeof(from)-1)
1766 clen = sizeof(from)-1;
1769 strncpy(from, record_charset, clen);
1775 cd = yaz_iconv_open(to, from);
1776 yaz_marc_iconv(mt, cd);
1779 yaz_marc_xml(mt, marc_type);
1780 if (!rec->wrbuf_marc)
1781 rec->wrbuf_marc = wrbuf_alloc();
1782 wrbuf_rewind(rec->wrbuf_marc);
1783 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1785 yaz_marc_destroy(mt);
1787 yaz_iconv_close(cd);
1789 *len = wrbuf_len(rec->wrbuf_marc);
1790 return wrbuf_buf(rec->wrbuf_marc);
1792 yaz_marc_destroy(mt);
1794 yaz_iconv_close(cd);
1798 static const char *record_iconv_return(ZOOM_record rec, int *len,
1799 const char *buf, int sz,
1800 const char *record_charset)
1807 strcpy(to, "UTF-8");
1808 if (record_charset && *record_charset)
1810 /* Use "from,to" or just "from" */
1811 const char *cp = strchr(record_charset, ',');
1812 int clen = strlen(record_charset);
1815 strncpy( to, cp+1, sizeof(to)-1);
1816 to[sizeof(to)-1] = '\0';
1817 clen = cp - record_charset;
1819 if (clen > sizeof(from)-1)
1820 clen = sizeof(from)-1;
1823 strncpy(from, record_charset, clen);
1827 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1830 size_t inbytesleft = sz;
1831 const char *inp = buf;
1833 if (!rec->wrbuf_iconv)
1834 rec->wrbuf_iconv = wrbuf_alloc();
1836 wrbuf_rewind(rec->wrbuf_iconv);
1840 size_t outbytesleft = sizeof(outbuf);
1841 char *outp = outbuf;
1842 size_t r = yaz_iconv(cd, (char**) &inp,
1844 &outp, &outbytesleft);
1845 if (r == (size_t) (-1))
1847 int e = yaz_iconv_error(cd);
1848 if (e != YAZ_ICONV_E2BIG)
1851 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1853 wrbuf_puts(rec->wrbuf_iconv, "");
1854 buf = wrbuf_buf(rec->wrbuf_iconv);
1855 sz = wrbuf_len(rec->wrbuf_iconv);
1856 yaz_iconv_close(cd);
1864 ZOOM_record_error(ZOOM_record rec, const char **cp,
1865 const char **addinfo, const char **diagset)
1867 Z_NamePlusRecord *npr;
1872 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1874 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1875 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1876 const char *add = 0;
1878 if (diag_rec->which == Z_DiagRec_defaultFormat)
1880 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1883 error = *ddf->condition;
1886 case Z_DefaultDiagFormat_v2Addinfo:
1887 add = ddf->u.v2Addinfo;
1889 case Z_DefaultDiagFormat_v3Addinfo:
1890 add = ddf->u.v3Addinfo;
1894 *diagset = yaz_z3950oid_to_str(ddf->diagnosticSetId, &oclass);
1902 *addinfo = add ? add : "";
1904 *cp = diagbib1_str(error);
1910 ZOOM_API(const char *)
1911 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1918 Z_NamePlusRecord *npr;
1921 *len = 0; /* default return */
1930 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1932 if (cp[i] == ';' || cp[i] == ' ')
1938 while (type_spec[i] == ';')
1941 while (type_spec[i] == ' ')
1943 if (!strncmp(type_spec+i, "charset=", 8))
1946 i = i + 8; /* skip charset= */
1947 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1949 if (type_spec[i] == ';' || type_spec[i] == ' ')
1955 else if (!strncmp(type_spec+i, "xpath=", 6))
1959 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1963 while (type_spec[i] == ' ')
1966 if (!strcmp(type, "database"))
1969 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1970 return npr->databaseName;
1972 else if (!strcmp(type, "syntax"))
1974 const char *desc = 0;
1975 if (npr->which == Z_NamePlusRecord_databaseRecord)
1977 Z_External *r = (Z_External *) npr->u.databaseRecord;
1978 oident *ent = oid_getentbyoid(r->direct_reference);
1985 *len = strlen(desc);
1988 if (npr->which != Z_NamePlusRecord_databaseRecord)
1991 /* from now on - we have a database record .. */
1992 if (!strcmp(type, "render"))
1994 Z_External *r = (Z_External *) npr->u.databaseRecord;
1995 oident *ent = oid_getentbyoid(r->direct_reference);
1997 /* render bibliographic record .. */
1998 if (r->which == Z_External_OPAC)
2000 r = r->u.opac->bibliographicRecord;
2003 ent = oid_getentbyoid(r->direct_reference);
2005 if (r->which == Z_External_sutrs)
2006 return record_iconv_return(rec, len,
2007 (char*) r->u.sutrs->buf,
2010 else if (r->which == Z_External_octet)
2012 const char *ret_buf;
2020 case VAL_APPLICATION_XML:
2023 ret_buf = marc_iconv_return(
2024 rec, YAZ_MARC_LINE, len,
2025 (const char *) r->u.octet_aligned->buf,
2026 r->u.octet_aligned->len,
2031 return record_iconv_return(rec, len,
2032 (const char *) r->u.octet_aligned->buf,
2033 r->u.octet_aligned->len,
2036 else if (r->which == Z_External_grs1)
2038 if (!rec->wrbuf_marc)
2039 rec->wrbuf_marc = wrbuf_alloc();
2040 wrbuf_rewind(rec->wrbuf_marc);
2041 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
2042 return record_iconv_return(rec, len,
2043 wrbuf_buf(rec->wrbuf_marc),
2044 wrbuf_len(rec->wrbuf_marc),
2049 else if (!strcmp(type, "xml"))
2051 Z_External *r = (Z_External *) npr->u.databaseRecord;
2052 oident *ent = oid_getentbyoid(r->direct_reference);
2054 /* render bibliographic record .. */
2055 if (r->which == Z_External_OPAC)
2057 r = r->u.opac->bibliographicRecord;
2060 ent = oid_getentbyoid(r->direct_reference);
2063 if (r->which == Z_External_sutrs)
2064 return record_iconv_return(rec, len,
2065 (const char *) r->u.sutrs->buf,
2068 else if (r->which == Z_External_octet)
2070 const char *ret_buf;
2071 int marc_decode_type = YAZ_MARC_MARCXML;
2080 case VAL_APPLICATION_XML:
2083 ret_buf = marc_iconv_return(
2084 rec, marc_decode_type, len,
2085 (const char *) r->u.octet_aligned->buf,
2086 r->u.octet_aligned->len,
2091 return record_iconv_return(rec, len,
2092 (const char *) r->u.octet_aligned->buf,
2093 r->u.octet_aligned->len,
2096 else if (r->which == Z_External_grs1)
2103 else if (!strcmp(type, "raw"))
2105 Z_External *r = (Z_External *) npr->u.databaseRecord;
2107 if (r->which == Z_External_sutrs)
2109 if (len) *len = r->u.sutrs->len;
2110 return (const char *) r->u.sutrs->buf;
2112 else if (r->which == Z_External_octet)
2114 if (len) *len = r->u.octet_aligned->len;
2115 return (const char *) r->u.octet_aligned->buf;
2117 else /* grs-1, explain, OPAC, ... */
2120 return (const char *) npr->u.databaseRecord;
2124 else if (!strcmp (type, "ext"))
2127 return (const char *) npr->u.databaseRecord;
2129 else if (!strcmp (type, "opac"))
2132 Z_External *r = (Z_External *) npr->u.databaseRecord;
2133 if (r->which == Z_External_OPAC)
2135 if (!rec->wrbuf_opac)
2136 rec->wrbuf_opac = wrbuf_alloc();
2137 wrbuf_rewind(rec->wrbuf_opac);
2138 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2139 return record_iconv_return(rec, len,
2140 wrbuf_buf(rec->wrbuf_opac),
2141 wrbuf_len(rec->wrbuf_opac),
2148 static int strcmp_null(const char *v1, const char *v2)
2154 return strcmp(v1, v2);
2157 static size_t record_hash(int pos)
2161 return pos % RECORD_HASH_SIZE;
2164 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2166 const char *syntax, const char *elementSetName)
2168 ZOOM_record_cache rc;
2170 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2171 ZOOM_connection_put_event(r->connection, event);
2173 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2177 if (strcmp_null(r->schema, rc->schema))
2179 if (strcmp_null(elementSetName,rc->elementSetName))
2181 if (strcmp_null(syntax, rc->syntax))
2183 /* not destroying rc->npr (it's handled by nmem )*/
2185 /* keeping wrbuf_marc too */
2189 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2192 rc->rec.wrbuf_marc = 0;
2193 rc->rec.wrbuf_iconv = 0;
2194 rc->rec.wrbuf_opac = 0;
2196 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2198 rc->elementSetName = 0;
2201 rc->syntax = odr_strdup(r->odr, syntax);
2206 rc->schema = odr_strdup(r->odr, r->schema);
2211 rc->next = r->record_hash[record_hash(pos)];
2212 r->record_hash[record_hash(pos)] = rc;
2215 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2217 const char *elementSetName)
2219 ZOOM_record_cache rc;
2221 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2225 if (strcmp_null(r->schema, rc->schema))
2227 if (strcmp_null(elementSetName,rc->elementSetName))
2229 if (strcmp_null(syntax, rc->syntax))
2237 static void handle_records(ZOOM_connection c, Z_Records *sr,
2240 ZOOM_resultset resultset;
2242 const char *syntax = 0, *elementSetName = 0;
2246 switch (c->tasks->which)
2248 case ZOOM_TASK_SEARCH:
2249 resultset = c->tasks->u.search.resultset;
2250 start = &c->tasks->u.search.start;
2251 count = &c->tasks->u.search.count;
2252 syntax = c->tasks->u.search.syntax;
2253 elementSetName = c->tasks->u.search.elementSetName;
2255 case ZOOM_TASK_RETRIEVE:
2256 resultset = c->tasks->u.retrieve.resultset;
2257 start = &c->tasks->u.retrieve.start;
2258 count = &c->tasks->u.retrieve.count;
2259 syntax = c->tasks->u.retrieve.syntax;
2260 elementSetName = c->tasks->u.retrieve.elementSetName;
2265 if (sr && sr->which == Z_Records_NSD)
2266 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2267 else if (sr && sr->which == Z_Records_multipleNSD)
2269 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2270 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2272 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2276 if (*count + *start > resultset->size)
2277 *count = resultset->size - *start;
2280 if (sr && sr->which == Z_Records_DBOSD)
2283 NMEM nmem = odr_extract_mem(c->odr_in);
2284 Z_NamePlusRecordList *p =
2285 sr->u.databaseOrSurDiagnostics;
2286 for (i = 0; i<p->num_records; i++)
2288 record_cache_add(resultset, p->records[i], i + *start,
2289 syntax, elementSetName);
2295 yaz_log(log_details,
2296 "handle_records resultset=%p start=%d count=%d",
2297 resultset, *start, *count);
2299 /* transfer our response to search_nmem .. we need it later */
2300 nmem_transfer(resultset->odr->mem, nmem);
2302 if (present_phase && p->num_records == 0)
2304 /* present response and we didn't get any records! */
2305 Z_NamePlusRecord *myrec =
2306 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2307 record_cache_add(resultset, myrec, *start,
2308 syntax, elementSetName);
2311 else if (present_phase)
2313 /* present response and we didn't get any records! */
2314 Z_NamePlusRecord *myrec =
2315 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2316 record_cache_add(resultset, myrec, *start, syntax, elementSetName);
2321 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2323 handle_records(c, pr->records, 1);
2326 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2329 switch (term->which)
2331 case Z_Term_general:
2332 ZOOM_options_setl(opt, name,
2333 (const char *)(term->u.general->buf),
2334 term->u.general->len);
2336 case Z_Term_characterString:
2337 ZOOM_options_set(opt, name, term->u.characterString);
2339 case Z_Term_numeric:
2340 ZOOM_options_set_int(opt, name, *term->u.numeric);
2345 static void handle_queryExpression(ZOOM_options opt, const char *name,
2346 Z_QueryExpression *exp)
2352 case Z_QueryExpression_term:
2353 if (exp->u.term && exp->u.term->queryTerm)
2355 sprintf(opt_name, "%s.term", name);
2356 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2359 case Z_QueryExpression_query:
2364 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2365 Z_OtherInformation *o)
2368 for (i = 0; o && i < o->num_elements; i++)
2370 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2372 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2374 if (ext->which == Z_External_searchResult1)
2377 Z_SearchInfoReport *sr = ext->u.searchResult1;
2380 ZOOM_options_set_int(
2381 resultset->options, "searchresult.size", sr->num);
2383 for (j = 0; j < sr->num; j++)
2385 Z_SearchInfoReport_s *ent =
2386 ext->u.searchResult1->elements[j];
2389 sprintf(pref, "searchresult.%d", j);
2391 if (ent->subqueryId)
2394 sprintf(opt_name, "%s.id", pref);
2395 ZOOM_options_set(resultset->options, opt_name,
2398 if (ent->subqueryExpression)
2401 sprintf(opt_name, "%s.subquery", pref);
2402 handle_queryExpression(resultset->options, opt_name,
2403 ent->subqueryExpression);
2405 if (ent->subqueryInterpretation)
2408 sprintf(opt_name, "%s.interpretation", pref);
2409 handle_queryExpression(resultset->options, opt_name,
2410 ent->subqueryInterpretation);
2412 if (ent->subqueryRecommendation)
2415 sprintf(opt_name, "%s.recommendation", pref);
2416 handle_queryExpression(resultset->options, opt_name,
2417 ent->subqueryRecommendation);
2419 if (ent->subqueryCount)
2422 sprintf(opt_name, "%s.count", pref);
2423 ZOOM_options_set_int(resultset->options, opt_name,
2424 *ent->subqueryCount);
2432 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2434 ZOOM_resultset resultset;
2437 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2440 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2441 ZOOM_connection_put_event(c, event);
2443 resultset = c->tasks->u.search.resultset;
2445 if (sr->resultSetStatus)
2447 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2448 *sr->resultSetStatus);
2450 if (sr->presentStatus)
2452 ZOOM_options_set_int(resultset->options, "presentStatus",
2453 *sr->presentStatus);
2455 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2457 resultset->size = *sr->resultCount;
2458 handle_records(c, sr->records, 0);
2461 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2463 if (res->diagnostics && res->num_diagnostics > 0)
2464 response_diag(c, res->diagnostics[0]);
2467 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2469 NMEM nmem = odr_extract_mem(c->odr_in);
2472 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2474 scan = c->tasks->u.scan.scan;
2476 if (res->entries && res->entries->nonsurrogateDiagnostics)
2477 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2478 scan->scan_response = res;
2479 nmem_transfer(scan->odr->mem, nmem);
2481 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2482 if (res->positionOfTerm)
2483 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2484 if (res->scanStatus)
2485 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2486 if (res->numberOfEntriesReturned)
2487 ZOOM_options_set_int(scan->options, "number",
2488 *res->numberOfEntriesReturned);
2493 static zoom_ret send_sort(ZOOM_connection c,
2494 ZOOM_resultset resultset)
2497 resultset->r_sort_spec = 0;
2498 if (resultset->r_sort_spec)
2500 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2501 Z_SortRequest *req = apdu->u.sortRequest;
2503 req->num_inputResultSetNames = 1;
2504 req->inputResultSetNames = (Z_InternationalString **)
2505 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2506 req->inputResultSetNames[0] =
2507 odr_strdup(c->odr_out, resultset->setname);
2508 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2509 req->sortSequence = resultset->r_sort_spec;
2510 resultset->r_sort_spec = 0;
2511 return send_APDU(c, apdu);
2513 return zoom_complete;
2516 static zoom_ret send_present(ZOOM_connection c)
2519 Z_PresentRequest *req = 0;
2521 const char *syntax = 0;
2522 const char *elementSetName = 0;
2523 ZOOM_resultset resultset;
2528 yaz_log(log_details, "%p send_present no tasks", c);
2529 return zoom_complete;
2532 switch (c->tasks->which)
2534 case ZOOM_TASK_SEARCH:
2535 resultset = c->tasks->u.search.resultset;
2536 start = &c->tasks->u.search.start;
2537 count = &c->tasks->u.search.count;
2538 syntax = c->tasks->u.search.syntax;
2539 elementSetName = c->tasks->u.search.elementSetName;
2541 case ZOOM_TASK_RETRIEVE:
2542 resultset = c->tasks->u.retrieve.resultset;
2543 start = &c->tasks->u.retrieve.start;
2544 count = &c->tasks->u.retrieve.count;
2545 syntax = c->tasks->u.retrieve.syntax;
2546 elementSetName = c->tasks->u.retrieve.elementSetName;
2549 return zoom_complete;
2551 yaz_log(log_details, "%p send_present start=%d count=%d",
2554 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2556 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2559 if (c->error) /* don't continue on error */
2560 return zoom_complete;
2561 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2562 resultset, *start, *count);
2564 for (i = 0; i < *count; i++)
2567 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2572 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2573 ZOOM_connection_put_event(c, event);
2581 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2582 return zoom_complete;
2585 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2586 req = apdu->u.presentRequest;
2589 yaz_log(log_details, "%p send_present skip=%d", c, i);
2591 *req->resultSetStartPoint = *start + 1;
2592 *req->numberOfRecordsRequested = resultset->step>0 ?
2593 resultset->step : *count;
2594 if (*req->numberOfRecordsRequested + *start > resultset->size)
2595 *req->numberOfRecordsRequested = resultset->size - *start;
2596 assert(*req->numberOfRecordsRequested > 0);
2598 if (syntax && *syntax)
2599 req->preferredRecordSyntax =
2600 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2602 if (resultset->schema && *resultset->schema)
2604 Z_RecordComposition *compo = (Z_RecordComposition *)
2605 odr_malloc(c->odr_out, sizeof(*compo));
2607 req->recordComposition = compo;
2608 compo->which = Z_RecordComp_complex;
2609 compo->u.complex = (Z_CompSpec *)
2610 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2611 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2612 odr_malloc(c->odr_out, sizeof(bool_t));
2613 *compo->u.complex->selectAlternativeSyntax = 0;
2615 compo->u.complex->generic = (Z_Specification *)
2616 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2618 compo->u.complex->generic->which = Z_Schema_oid;
2619 compo->u.complex->generic->schema.oid = (Odr_oid *)
2620 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2622 if (!compo->u.complex->generic->schema.oid)
2624 /* OID wasn't a schema! Try record syntax instead. */
2626 compo->u.complex->generic->schema.oid = (Odr_oid *)
2627 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2629 if (elementSetName && *elementSetName)
2631 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2632 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2633 compo->u.complex->generic->elementSpec->which =
2634 Z_ElementSpec_elementSetName;
2635 compo->u.complex->generic->elementSpec->u.elementSetName =
2636 odr_strdup(c->odr_out, elementSetName);
2639 compo->u.complex->generic->elementSpec = 0;
2640 compo->u.complex->num_dbSpecific = 0;
2641 compo->u.complex->dbSpecific = 0;
2642 compo->u.complex->num_recordSyntax = 0;
2643 compo->u.complex->recordSyntax = 0;
2645 else if (elementSetName && *elementSetName)
2647 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2648 odr_malloc(c->odr_out, sizeof(*esn));
2649 Z_RecordComposition *compo = (Z_RecordComposition *)
2650 odr_malloc(c->odr_out, sizeof(*compo));
2652 esn->which = Z_ElementSetNames_generic;
2653 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2654 compo->which = Z_RecordComp_simple;
2655 compo->u.simple = esn;
2656 req->recordComposition = compo;
2658 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2659 return send_APDU(c, apdu);
2662 ZOOM_API(ZOOM_scanset)
2663 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2666 ZOOM_query q = ZOOM_query_create();
2668 ZOOM_query_prefix(q, start);
2670 s = ZOOM_connection_scan1(c, q);
2671 ZOOM_query_destroy(q);
2676 ZOOM_API(ZOOM_scanset)
2677 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2681 ZOOM_scanset scan = 0;
2684 * We need to check the query-type, so we can recognise CQL and
2685 * CCL and compile them into a form that we can use here. The
2686 * ZOOM_query structure has no explicit `type' member, but
2687 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2688 * functions shows how the structure is set up in each case.
2692 else if (q->z_query->which == Z_Query_type_1)
2694 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2695 c, q, q->query_string);
2696 start = q->query_string;
2698 else if (q->z_query->which == Z_Query_type_104)
2700 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2701 c, q, q->query_string);
2702 start = freeme = cql2pqf(c, q->query_string);
2708 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2709 c, q, q->query_string);
2713 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2714 scan->connection = c;
2715 scan->odr = odr_createmem(ODR_DECODE);
2716 scan->options = ZOOM_options_create_with_parent(c->options);
2718 scan->scan_response = 0;
2719 scan->termListAndStartPoint =
2720 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2723 scan->databaseNames = set_DatabaseNames(c, c->options,
2724 &scan->num_databaseNames,
2726 if (scan->termListAndStartPoint != 0)
2728 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2729 task->u.scan.scan = scan;
2734 while (ZOOM_event(1, &c))
2742 ZOOM_scanset_destroy(ZOOM_scanset scan)
2747 if (scan->refcount == 0)
2749 odr_destroy(scan->odr);
2751 ZOOM_options_destroy(scan->options);
2756 static zoom_ret send_package(ZOOM_connection c)
2760 yaz_log(log_details, "%p send_package", c);
2762 return zoom_complete;
2763 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2765 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2766 ZOOM_connection_put_event(c, event);
2768 c->buf_out = c->tasks->u.package->buf_out;
2769 c->len_out = c->tasks->u.package->len_out;
2774 static zoom_ret send_scan(ZOOM_connection c)
2777 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2778 Z_ScanRequest *req = apdu->u.scanRequest;
2780 yaz_log(log_details, "%p send_scan", c);
2782 return zoom_complete;
2783 assert (c->tasks->which == ZOOM_TASK_SCAN);
2784 scan = c->tasks->u.scan.scan;
2786 req->termListAndStartPoint = scan->termListAndStartPoint;
2787 req->attributeSet = scan->attributeSet;
2789 *req->numberOfTermsRequested =
2790 ZOOM_options_get_int(scan->options, "number", 10);
2792 req->preferredPositionInResponse =
2793 odr_intdup(c->odr_out,
2794 ZOOM_options_get_int(scan->options, "position", 1));
2797 odr_intdup(c->odr_out,
2798 ZOOM_options_get_int(scan->options, "stepSize", 0));
2800 req->databaseNames = scan->databaseNames;
2801 req->num_databaseNames = scan->num_databaseNames;
2803 return send_APDU(c, apdu);
2807 ZOOM_scanset_size(ZOOM_scanset scan)
2809 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2811 return scan->scan_response->entries->num_entries;
2814 ZOOM_API(const char *)
2815 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2818 const char *term = 0;
2819 size_t noent = ZOOM_scanset_size(scan);
2820 Z_ScanResponse *res = scan->scan_response;
2826 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2828 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2830 if (t->term->which == Z_Term_general)
2832 term = (const char *) t->term->u.general->buf;
2833 *len = t->term->u.general->len;
2835 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2840 ZOOM_API(const char *)
2841 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2844 const char *term = 0;
2845 size_t noent = ZOOM_scanset_size(scan);
2846 Z_ScanResponse *res = scan->scan_response;
2852 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2854 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2858 term = t->displayTerm;
2859 *len = strlen(term);
2861 else if (t->term->which == Z_Term_general)
2863 term = (const char *) t->term->u.general->buf;
2864 *len = t->term->u.general->len;
2866 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2871 ZOOM_API(const char *)
2872 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2874 return ZOOM_options_get(scan->options, key);
2878 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2881 ZOOM_options_set(scan->options, key, val);
2884 static Z_APDU *create_es_package(ZOOM_package p, int type)
2887 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2888 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2890 *req->function = Z_ExtendedServicesRequest_create;
2892 str = ZOOM_options_get(p->options, "package-name");
2894 req->packageName = nmem_strdup(p->odr_out->mem, str);
2896 str = ZOOM_options_get(p->options, "user-id");
2898 req->userId = nmem_strdup(p->odr_out->mem, str);
2900 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2903 str = ZOOM_options_get(p->options, "function");
2906 if (!strcmp (str, "create"))
2908 if (!strcmp (str, "delete"))
2910 if (!strcmp (str, "modify"))
2916 static const char *ill_array_lookup(void *clientData, const char *idx)
2918 ZOOM_package p = (ZOOM_package) clientData;
2919 return ZOOM_options_get(p->options, idx+4);
2922 static Z_External *encode_ill_request(ZOOM_package p)
2924 ODR out = p->odr_out;
2927 struct ill_get_ctl ctl;
2929 ctl.odr = p->odr_out;
2931 ctl.f = ill_array_lookup;
2933 req = ill_get_ILLRequest(&ctl, "ill", 0);
2935 if (!ill_Request(out, &req, 0, 0))
2937 int ill_request_size;
2938 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2939 if (ill_request_buf)
2940 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2946 int illRequest_size = 0;
2947 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2949 oid.proto = PROTO_GENERAL;
2950 oid.oclass = CLASS_GENERAL;
2951 oid.value = VAL_ISO_ILL_1;
2953 r = (Z_External *) odr_malloc(out, sizeof(*r));
2954 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2955 r->indirect_reference = 0;
2957 r->which = Z_External_single;
2959 r->u.single_ASN1_type =
2960 odr_create_Odr_oct(out,
2961 (unsigned char *)illRequest_buf,
2967 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2969 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2972 req->which = Z_IOItemOrder_esRequest;
2973 req->u.esRequest = (Z_IORequest *)
2974 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2976 /* to keep part ... */
2977 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2978 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2979 req->u.esRequest->toKeep->supplDescription = 0;
2980 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2981 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2983 str = ZOOM_options_get(p->options, "contact-name");
2984 req->u.esRequest->toKeep->contact->name = str ?
2985 nmem_strdup(p->odr_out->mem, str) : 0;
2987 str = ZOOM_options_get(p->options, "contact-phone");
2988 req->u.esRequest->toKeep->contact->phone = str ?
2989 nmem_strdup(p->odr_out->mem, str) : 0;
2991 str = ZOOM_options_get(p->options, "contact-email");
2992 req->u.esRequest->toKeep->contact->email = str ?
2993 nmem_strdup(p->odr_out->mem, str) : 0;
2995 req->u.esRequest->toKeep->addlBilling = 0;
2997 /* not to keep part ... */
2998 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2999 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3001 str = ZOOM_options_get(p->options, "itemorder-setname");
3006 req->u.esRequest->notToKeep->resultSetItem = 0;
3009 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3010 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3012 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3013 nmem_strdup(p->odr_out->mem, str);
3014 req->u.esRequest->notToKeep->resultSetItem->item =
3015 (int *) odr_malloc(p->odr_out, sizeof(int));
3017 str = ZOOM_options_get(p->options, "itemorder-item");
3018 *req->u.esRequest->notToKeep->resultSetItem->item =
3019 (str ? atoi(str) : 1);
3022 str = ZOOM_options_get(p->options, "doc");
3024 req->u.esRequest->notToKeep->itemRequest =
3025 z_ext_record(p->odr_out, VAL_TEXT_XML, str, strlen(str));
3027 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3032 Z_APDU *create_admin_package(ZOOM_package p, int type,
3033 Z_ESAdminOriginPartToKeep **toKeepP,
3034 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3036 Z_APDU *apdu = create_es_package(p, VAL_ADMINSERVICE);
3039 Z_ESAdminOriginPartToKeep *toKeep;
3040 Z_ESAdminOriginPartNotToKeep *notToKeep;
3041 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3042 const char *first_db = "Default";
3044 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3049 r->direct_reference =
3050 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3053 r->indirect_reference = 0;
3054 r->which = Z_External_ESAdmin;
3056 r->u.adminService = (Z_Admin *)
3057 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3058 r->u.adminService->which = Z_Admin_esRequest;
3059 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3060 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3062 toKeep = r->u.adminService->u.esRequest->toKeep =
3063 (Z_ESAdminOriginPartToKeep *)
3064 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3065 toKeep->which = type;
3066 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3067 toKeep->u.create = odr_nullval();
3068 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3070 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3071 (Z_ESAdminOriginPartNotToKeep *)
3072 odr_malloc(p->odr_out,
3073 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3074 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3075 notToKeep->u.recordsWillFollow = odr_nullval();
3079 *notToKeepP = notToKeep;
3084 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3086 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
3087 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3088 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3089 const char *doc = ZOOM_options_get(p->options, "doc");
3094 req->taskSpecificParameters = ext;
3095 ext->direct_reference = req->packageType;
3096 ext->descriptor = 0;
3097 ext->indirect_reference = 0;
3099 ext->which = Z_External_octet;
3100 ext->u.single_ASN1_type =
3101 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
3106 static Z_APDU *create_update_package(ZOOM_package p)
3109 const char *first_db = "Default";
3111 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3112 const char *action = ZOOM_options_get(p->options, "action");
3113 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
3114 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3115 const char *record_buf = ZOOM_options_get(p->options, "record");
3116 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3117 int syntax_oid = VAL_NONE;
3121 syntax_oid = oid_getvalbyname(syntax_str);
3124 record_buf = "void";
3125 syntax_oid = VAL_SUTRS;
3127 if (syntax_oid == VAL_NONE)
3128 syntax_oid = VAL_TEXT_XML;
3134 action = "specialUpdate";
3136 if (!strcmp(action, "recordInsert"))
3137 action_no = Z_IUOriginPartToKeep_recordInsert;
3138 else if (!strcmp(action, "recordReplace"))
3139 action_no = Z_IUOriginPartToKeep_recordReplace;
3140 else if (!strcmp(action, "recordDelete"))
3141 action_no = Z_IUOriginPartToKeep_recordDelete;
3142 else if (!strcmp(action, "elementUpdate"))
3143 action_no = Z_IUOriginPartToKeep_elementUpdate;
3144 else if (!strcmp(action, "specialUpdate"))
3145 action_no = Z_IUOriginPartToKeep_specialUpdate;
3149 apdu = create_es_package(p, VAL_DBUPDATE);
3152 Z_IUOriginPartToKeep *toKeep;
3153 Z_IUSuppliedRecords *notToKeep;
3154 Z_External *r = (Z_External *)
3155 odr_malloc(p->odr_out, sizeof(*r));
3157 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3159 r->direct_reference =
3160 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3163 r->which = Z_External_update;
3164 r->indirect_reference = 0;
3165 r->u.update = (Z_IUUpdate *)
3166 odr_malloc(p->odr_out, sizeof(*r->u.update));
3168 r->u.update->which = Z_IUUpdate_esRequest;
3169 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3170 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3171 toKeep = r->u.update->u.esRequest->toKeep =
3172 (Z_IUOriginPartToKeep *)
3173 odr_malloc(p->odr_out, sizeof(*toKeep));
3175 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3177 toKeep->elementSetName = 0;
3178 toKeep->actionQualifier = 0;
3179 toKeep->action = odr_intdup(p->odr_out, action_no);
3181 notToKeep = r->u.update->u.esRequest->notToKeep =
3182 (Z_IUSuppliedRecords *)
3183 odr_malloc(p->odr_out, sizeof(*notToKeep));
3185 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3186 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3187 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3188 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3189 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3192 notToKeep->elements[0]->u.opaque =
3193 odr_create_Odr_oct(p->odr_out,
3194 (const unsigned char *) recordIdOpaque,
3195 strlen(recordIdOpaque));
3197 else if (recordIdNumber)
3199 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3201 notToKeep->elements[0]->u.number =
3202 odr_intdup(p->odr_out, atoi(recordIdNumber));
3205 notToKeep->elements[0]->u.opaque = 0;
3206 notToKeep->elements[0]->supplementalId = 0;
3207 notToKeep->elements[0]->correlationInfo = 0;
3208 notToKeep->elements[0]->record =
3209 z_ext_record(p->odr_out, syntax_oid,
3210 record_buf, strlen(record_buf));
3214 ODR print = odr_createmem(ODR_PRINT);
3216 z_APDU(print, &apdu, 0, 0);
3223 ZOOM_package_send(ZOOM_package p, const char *type)
3230 odr_reset(p->odr_out);
3233 if (!strcmp(type, "itemorder"))
3235 apdu = create_es_package(p, VAL_ITEMORDER);
3238 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3240 r->direct_reference =
3241 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3244 r->which = Z_External_itemOrder;
3245 r->indirect_reference = 0;
3246 r->u.itemOrder = encode_item_order(p);
3248 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3251 else if (!strcmp(type, "create")) /* create database */
3253 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3256 else if (!strcmp(type, "drop")) /* drop database */
3258 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3261 else if (!strcmp(type, "commit")) /* commit changes */
3263 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3266 else if (!strcmp(type, "update")) /* update record(s) */
3268 apdu = create_update_package(p);
3270 else if (!strcmp(type, "xmlupdate"))
3272 apdu = create_xmlupdate_package(p);
3276 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3280 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3281 task->u.package = p;
3282 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3283 p->buf_out = (char *) xmalloc(p->len_out);
3284 memcpy(p->buf_out, buf, p->len_out);
3289 while (ZOOM_event(1, &c))
3296 ZOOM_API(ZOOM_package)
3297 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3299 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3302 p->odr_out = odr_createmem(ODR_ENCODE);
3303 p->options = ZOOM_options_create_with_parent2(options, c->options);
3311 ZOOM_package_destroy(ZOOM_package p)
3316 if (p->refcount == 0)
3318 odr_destroy(p->odr_out);
3321 ZOOM_options_destroy(p->options);
3326 ZOOM_API(const char *)
3327 ZOOM_package_option_get(ZOOM_package p, const char *key)
3329 return ZOOM_options_get(p->options, key);
3334 ZOOM_package_option_set(ZOOM_package p, const char *key,
3337 ZOOM_options_set(p->options, key, val);
3340 static int ZOOM_connection_exec_task(ZOOM_connection c)
3342 ZOOM_task task = c->tasks;
3343 zoom_ret ret = zoom_complete;
3347 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3348 c, task->which, task->running);
3349 if (c->error != ZOOM_ERROR_NONE)
3351 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3352 "removing tasks because of error = %d", c, c->error);
3353 ZOOM_connection_remove_tasks(c);
3358 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3359 "task already running", c);
3363 ret = zoom_complete;
3364 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3366 switch (task->which)
3368 case ZOOM_TASK_SEARCH:
3369 if (c->proto == PROTO_HTTP)
3370 ret = ZOOM_connection_srw_send_search(c);
3372 ret = ZOOM_connection_send_search(c);
3374 case ZOOM_TASK_RETRIEVE:
3375 if (c->proto == PROTO_HTTP)
3376 ret = ZOOM_connection_srw_send_search(c);
3378 ret = send_present(c);
3380 case ZOOM_TASK_CONNECT:
3381 ret = do_connect(c);
3383 case ZOOM_TASK_SCAN:
3386 case ZOOM_TASK_PACKAGE:
3387 ret = send_package(c);
3389 case ZOOM_TASK_SORT:
3390 c->tasks->u.sort.resultset->r_sort_spec =
3391 c->tasks->u.sort.q->sort_spec;
3392 ret = send_sort(c, c->tasks->u.sort.resultset);
3398 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3399 "remove tasks because no connection exist", c);
3400 ZOOM_connection_remove_tasks(c);
3402 if (ret == zoom_complete)
3404 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3405 "task removed (complete)", c);
3406 ZOOM_connection_remove_task(c);
3409 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3414 static zoom_ret send_sort_present(ZOOM_connection c)
3416 zoom_ret r = zoom_complete;
3418 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3419 r = send_sort(c, c->tasks->u.search.resultset);
3420 if (r == zoom_complete)
3421 r = send_present(c);
3425 static int es_response(ZOOM_connection c,
3426 Z_ExtendedServicesResponse *res)
3428 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3430 if (res->diagnostics && res->num_diagnostics > 0)
3431 response_diag(c, res->diagnostics[0]);
3432 if (res->taskPackage &&
3433 res->taskPackage->which == Z_External_extendedService)
3435 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3436 Odr_oct *id = taskPackage->targetReference;
3439 ZOOM_options_setl(c->tasks->u.package->options,
3440 "targetReference", (char*) id->buf, id->len);
3442 if (res->taskPackage &&
3443 res->taskPackage->which == Z_External_octet)
3445 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3446 ZOOM_options_setl(c->tasks->u.package->options,
3447 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3452 static void interpret_init_diag(ZOOM_connection c,
3453 Z_DiagnosticFormat *diag)
3457 Z_DiagnosticFormat_s *ds = diag->elements[0];
3458 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3459 response_default_diag(c, ds->u.defaultDiagRec);
3464 static void interpret_otherinformation_field(ZOOM_connection c,
3465 Z_OtherInformation *ui)
3468 for (i = 0; i < ui->num_elements; i++)
3470 Z_OtherInformationUnit *unit = ui->list[i];
3471 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3472 unit->information.externallyDefinedInfo &&
3473 unit->information.externallyDefinedInfo->which ==
3476 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3482 static void set_init_option(const char *name, void *clientData) {
3483 ZOOM_connection c = clientData;
3486 sprintf(buf, "init_opt_%.70s", name);
3487 ZOOM_connection_option_set(c, buf, "1");
3491 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3493 Z_InitResponse *initrs;
3495 ZOOM_connection_set_mask(c, 0);
3496 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3499 case Z_APDU_initResponse:
3500 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3501 initrs = apdu->u.initResponse;
3502 ZOOM_connection_option_set(c, "serverImplementationId",
3503 initrs->implementationId ?
3504 initrs->implementationId : "");
3505 ZOOM_connection_option_set(c, "serverImplementationName",
3506 initrs->implementationName ?
3507 initrs->implementationName : "");
3508 ZOOM_connection_option_set(c, "serverImplementationVersion",
3509 initrs->implementationVersion ?
3510 initrs->implementationVersion : "");
3511 /* Set the three old options too, for old applications */
3512 ZOOM_connection_option_set(c, "targetImplementationId",
3513 initrs->implementationId ?
3514 initrs->implementationId : "");
3515 ZOOM_connection_option_set(c, "targetImplementationName",
3516 initrs->implementationName ?
3517 initrs->implementationName : "");
3518 ZOOM_connection_option_set(c, "targetImplementationVersion",
3519 initrs->implementationVersion ?
3520 initrs->implementationVersion : "");
3522 /* Make initrs->options available as ZOOM-level options */
3523 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3525 if (!*initrs->result)
3527 Z_External *uif = initrs->userInformationField;
3529 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3531 if (uif && uif->which == Z_External_userInfo1)
3532 interpret_otherinformation_field(c, uif->u.userInfo1);
3537 yaz_oi_get_string_oidval(&apdu->u.initResponse->otherInfo,
3539 xfree(c->cookie_in);
3542 c->cookie_in = xstrdup(cookie);
3543 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3544 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3545 c->support_named_resultsets = 1;
3548 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3549 ZOOM_connection_remove_task(c);
3551 ZOOM_connection_exec_task(c);
3553 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3555 NMEM tmpmem = nmem_create();
3556 Z_CharSetandLanguageNegotiation *p =
3557 yaz_get_charneg_record(initrs->otherInfo);
3561 char *charset = NULL, *lang = NULL;
3564 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3565 yaz_log(log_details, "%p recv_apdu target accepted: "
3566 "charset %s, language %s, select %d",
3568 charset ? charset : "none", lang ? lang : "none", sel);
3570 ZOOM_connection_option_set(c, "negotiation-charset",
3573 ZOOM_connection_option_set(c, "negotiation-lang",
3576 ZOOM_connection_option_set(
3577 c, "negotiation-charset-in-effect-for-records",
3578 (sel != 0) ? "1" : "0");
3579 nmem_destroy(tmpmem);
3583 case Z_APDU_searchResponse:
3584 yaz_log(log_api, "%p recv_apdu Search response", c);
3585 handle_search_response(c, apdu->u.searchResponse);
3586 if (send_sort_present(c) == zoom_complete)
3587 ZOOM_connection_remove_task(c);
3589 case Z_APDU_presentResponse:
3590 yaz_log(log_api, "%p recv_apdu Present response", c);
3591 handle_present_response(c, apdu->u.presentResponse);
3592 if (send_present(c) == zoom_complete)
3593 ZOOM_connection_remove_task(c);
3595 case Z_APDU_sortResponse:
3596 yaz_log(log_api, "%p recv_apdu Sort response", c);
3597 sort_response(c, apdu->u.sortResponse);
3598 if (send_present(c) == zoom_complete)
3599 ZOOM_connection_remove_task(c);
3601 case Z_APDU_scanResponse:
3602 yaz_log(log_api, "%p recv_apdu Scan response", c);
3603 scan_response(c, apdu->u.scanResponse);
3604 ZOOM_connection_remove_task(c);
3606 case Z_APDU_extendedServicesResponse:
3607 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3608 es_response(c, apdu->u.extendedServicesResponse);
3609 ZOOM_connection_remove_task(c);
3612 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3613 if (!ZOOM_test_reconnect(c))
3615 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3620 yaz_log(log_api, "%p Received unknown PDU", c);
3621 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3627 static void handle_srw_response(ZOOM_connection c,
3628 Z_SRW_searchRetrieveResponse *res)
3630 ZOOM_resultset resultset = 0;
3635 const char *syntax, *elementSetName;
3640 switch(c->tasks->which)
3642 case ZOOM_TASK_SEARCH:
3643 resultset = c->tasks->u.search.resultset;
3644 start = &c->tasks->u.search.start;
3645 syntax = c->tasks->u.search.syntax;
3646 elementSetName = c->tasks->u.search.elementSetName;
3648 case ZOOM_TASK_RETRIEVE:
3649 resultset = c->tasks->u.retrieve.resultset;
3650 start = &c->tasks->u.retrieve.start;
3651 syntax = c->tasks->u.retrieve.syntax;
3652 elementSetName = c->tasks->u.retrieve.elementSetName;
3657 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3658 ZOOM_connection_put_event(c, event);
3660 resultset->size = 0;
3662 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3664 if (res->numberOfRecords)
3665 resultset->size = *res->numberOfRecords;
3667 for (i = 0; i<res->num_records; i++)
3671 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3672 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3674 if (res->records[i].recordPosition &&
3675 *res->records[i].recordPosition > 0)
3676 pos = *res->records[i].recordPosition - 1;
3680 npr->databaseName = 0;
3681 npr->which = Z_NamePlusRecord_databaseRecord;
3682 npr->u.databaseRecord = (Z_External *)
3683 odr_malloc(c->odr_in, sizeof(Z_External));
3684 npr->u.databaseRecord->descriptor = 0;
3685 npr->u.databaseRecord->direct_reference =
3686 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3687 npr->u.databaseRecord->which = Z_External_octet;
3689 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3690 odr_malloc(c->odr_in, sizeof(Odr_oct));
3691 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3692 res->records[i].recordData_buf;
3693 npr->u.databaseRecord->u.octet_aligned->len =
3694 npr->u.databaseRecord->u.octet_aligned->size =
3695 res->records[i].recordData_len;
3696 record_cache_add(resultset, npr, pos, syntax, elementSetName);
3698 if (res->num_diagnostics > 0)
3700 const char *uri = res->diagnostics[0].uri;
3705 if ((cp = strrchr(uri, '/')))
3707 set_dset_error(c, code, uri,
3708 res->diagnostics[0].details, 0);
3711 nmem = odr_extract_mem(c->odr_in);
3712 nmem_transfer(resultset->odr->mem, nmem);
3718 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3721 const char *content_type = z_HTTP_header_lookup(hres->headers,
3723 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3725 ZOOM_connection_set_mask(c, 0);
3726 yaz_log(log_details, "%p handle_http", c);
3728 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3730 Z_SOAP *soap_package = 0;
3732 Z_SOAP_Handler soap_handlers[2] = {
3733 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
3736 ret = z_soap_codec(o, &soap_package,
3737 &hres->content_buf, &hres->content_len,
3739 if (!ret && soap_package->which == Z_SOAP_generic &&
3740 soap_package->u.generic->no == 0)
3742 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3743 if (sr->which == Z_SRW_searchRetrieve_response)
3744 handle_srw_response(c, sr->u.response);
3748 else if (!ret && (soap_package->which == Z_SOAP_fault
3749 || soap_package->which == Z_SOAP_error))
3751 set_HTTP_error(c, hres->code,
3752 soap_package->u.fault->fault_code,
3753 soap_package->u.fault->fault_string);
3760 if (hres->code != 200)
3761 set_HTTP_error(c, hres->code, 0, 0);
3763 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3766 ZOOM_connection_remove_task(c);
3767 if (!strcmp(hres->version, "1.0"))
3769 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3770 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3775 /* HTTP 1.1: only if no close we stay alive .. */
3776 if (connection_head && !strcmp(connection_head, "close"))
3782 static int do_read(ZOOM_connection c)
3787 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3788 ZOOM_connection_put_event(c, event);
3790 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3791 more = cs_more(c->cs);
3792 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3797 if (!ZOOM_test_reconnect(c))
3799 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3808 odr_reset(c->odr_in);
3809 odr_setbuf(c->odr_in, c->buf_in, r, 0);
3810 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3811 ZOOM_connection_put_event(c, event);
3813 if (!z_GDU(c->odr_in, &gdu, 0, 0))
3816 int err = odr_geterrorx(c->odr_in, &x);
3818 const char *element = odr_getelement(c->odr_in);
3819 sprintf(msg, "ODR code %d:%d element=%-20s",
3820 err, x, element ? element : "<unknown>");
3821 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3824 else if (gdu->which == Z_GDU_Z3950)
3825 recv_apdu(c, gdu->u.z3950);
3826 else if (gdu->which == Z_GDU_HTTP_Response)
3829 handle_http(c, gdu->u.HTTP_Response);
3831 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3835 c->reconnect_ok = 0;
3840 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3845 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3846 ZOOM_connection_put_event(c, event);
3848 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3849 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3851 yaz_log(log_details, "%p do_write_ex write failed", c);
3852 if (ZOOM_test_reconnect(c))
3854 return zoom_pending;
3856 if (c->state == STATE_CONNECTING)
3857 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3859 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3861 return zoom_complete;
3865 int mask = ZOOM_SELECT_EXCEPT;
3866 if (c->cs->io_pending & CS_WANT_WRITE)
3867 mask += ZOOM_SELECT_WRITE;
3868 if (c->cs->io_pending & CS_WANT_READ)
3869 mask += ZOOM_SELECT_READ;
3870 ZOOM_connection_set_mask(c, mask);
3871 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3876 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
3877 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3880 return zoom_pending;
3883 static zoom_ret do_write(ZOOM_connection c)
3885 return do_write_ex(c, c->buf_out, c->len_out);
3889 ZOOM_API(const char *)
3890 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3892 return ZOOM_options_get(c->options, key);
3895 ZOOM_API(const char *)
3896 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3898 return ZOOM_options_getl(c->options, key, lenp);
3902 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3905 ZOOM_options_set(c->options, key, val);
3909 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3910 const char *val, int len)
3912 ZOOM_options_setl(c->options, key, val, len);
3915 ZOOM_API(const char *)
3916 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3918 return ZOOM_options_get(r->options, key);
3922 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3925 ZOOM_options_set(r->options, key, val);
3930 ZOOM_connection_errcode(ZOOM_connection c)
3932 return ZOOM_connection_error(c, 0, 0);
3935 ZOOM_API(const char *)
3936 ZOOM_connection_errmsg(ZOOM_connection c)
3939 ZOOM_connection_error(c, &msg, 0);
3943 ZOOM_API(const char *)
3944 ZOOM_connection_addinfo(ZOOM_connection c)
3946 const char *addinfo;
3947 ZOOM_connection_error(c, 0, &addinfo);
3951 ZOOM_API(const char *)
3952 ZOOM_connection_diagset(ZOOM_connection c)
3954 const char *diagset;
3955 ZOOM_connection_error_x(c, 0, 0, &diagset);
3959 ZOOM_API(const char *)
3960 ZOOM_diag_str(int error)
3964 case ZOOM_ERROR_NONE:
3966 case ZOOM_ERROR_CONNECT:
3967 return "Connect failed";
3968 case ZOOM_ERROR_MEMORY:
3969 return "Out of memory";
3970 case ZOOM_ERROR_ENCODE:
3971 return "Encoding failed";
3972 case ZOOM_ERROR_DECODE:
3973 return "Decoding failed";
3974 case ZOOM_ERROR_CONNECTION_LOST:
3975 return "Connection lost";
3976 case ZOOM_ERROR_INIT:
3977 return "Init rejected";
3978 case ZOOM_ERROR_INTERNAL:
3979 return "Internal failure";
3980 case ZOOM_ERROR_TIMEOUT:
3982 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3983 return "Unsupported protocol";
3984 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3985 return "Unsupported query type";
3986 case ZOOM_ERROR_INVALID_QUERY:
3987 return "Invalid query";
3988 case ZOOM_ERROR_CQL_PARSE:
3989 return "CQL parsing error";
3990 case ZOOM_ERROR_CQL_TRANSFORM:
3991 return "CQL transformation error";
3992 case ZOOM_ERROR_CCL_CONFIG:
3993 return "CCL configuration error";
3994 case ZOOM_ERROR_CCL_PARSE:
3995 return "CCL parsing error";
3997 return diagbib1_str(error);
4002 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4003 const char **addinfo, const char **diagset)
4005 int error = c->error;
4008 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4009 *cp = ZOOM_diag_str(error);
4010 else if (!strcmp(c->diagset, "HTTP"))
4011 *cp = z_HTTP_errmsg(c->error);
4012 else if (!strcmp(c->diagset, "Bib-1"))
4013 *cp = ZOOM_diag_str(error);
4014 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4015 *cp = yaz_diag_srw_str(c->error);
4017 *cp = "Unknown error and diagnostic set";
4020 *addinfo = c->addinfo ? c->addinfo : "";
4022 *diagset = c->diagset ? c->diagset : "";
4027 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4028 const char **addinfo)
4030 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4033 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4035 ZOOM_Event event = 0;
4036 int r = cs_look(c->cs);
4037 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4042 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4043 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4045 ZOOM_connection_put_event(c, event);
4047 else if (r == CS_CONNECT)
4049 int ret = ret = cs_rcvconnect(c->cs);
4050 yaz_log(log_details, "%p ZOOM_connection_do_io "
4051 "cs_rcvconnect returned %d", c, ret);
4054 int mask = ZOOM_SELECT_EXCEPT;
4055 if (c->cs->io_pending & CS_WANT_WRITE)
4056 mask += ZOOM_SELECT_WRITE;
4057 if (c->cs->io_pending & CS_WANT_READ)
4058 mask += ZOOM_SELECT_READ;
4059 ZOOM_connection_set_mask(c, mask);
4063 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4064 ZOOM_connection_put_event(c, event);
4066 if (c->proto == PROTO_Z3950)
4067 ZOOM_connection_send_init(c);
4070 /* no init request for SRW .. */
4071 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4072 ZOOM_connection_remove_task(c);
4073 ZOOM_connection_set_mask(c, 0);
4074 ZOOM_connection_exec_task(c);
4076 c->state = STATE_ESTABLISHED;
4080 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4086 if (mask & ZOOM_SELECT_EXCEPT)
4088 if (!ZOOM_test_reconnect(c))
4090 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4095 if (mask & ZOOM_SELECT_READ)
4097 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4103 ZOOM_connection_last_event(ZOOM_connection cs)
4106 return ZOOM_EVENT_NONE;
4107 return cs->last_event;
4112 * Returns an xmalloc()d string containing RPN that corresponds to the
4113 * CQL passed in. On error, sets the Connection object's error state
4114 * and returns a null pointer.
4115 * ### We could cache CQL parser and/or transformer in Connection.
4117 static char *cql2pqf(ZOOM_connection c, const char *cql)
4121 struct cql_node *node;
4122 const char *cqlfile;
4123 static cql_transform_t trans;
4126 parser = cql_parser_create();
4127 if ((error = cql_parser_string(parser, cql)) != 0) {
4128 cql_parser_destroy(parser);
4129 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4133 node = cql_parser_result(parser);
4134 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4136 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4138 cql_parser_destroy(parser);
4139 cql_node_destroy(node);
4140 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4144 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4146 cql_parser_destroy(parser);
4147 cql_node_destroy(node);
4148 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4149 cqlfile, strerror(errno));
4150 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4154 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4155 cql_parser_destroy(parser);
4156 cql_node_destroy(node);
4159 const char *addinfo;
4160 error = cql_transform_error(trans, &addinfo);
4161 cql_transform_close(trans);
4162 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4163 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4167 cql_transform_close(trans);
4168 return xstrdup(pqfbuf);
4171 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4175 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4176 /* timeout and this connection was waiting */
4177 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4179 ZOOM_connection_put_event(c, event);
4185 ZOOM_connection_process(ZOOM_connection c)
4191 event = ZOOM_connection_get_event(c);
4194 ZOOM_Event_destroy(event);
4197 ZOOM_connection_exec_task(c);
4198 event = ZOOM_connection_get_event(c);
4201 ZOOM_Event_destroy(event);
4208 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4212 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4214 for (i = 0; i<no; i++)
4216 ZOOM_connection c = cs[i];
4218 if (c && ZOOM_connection_process(c))
4224 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4226 if (c->mask && mask)
4227 ZOOM_connection_do_io(c, mask);
4231 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4234 return cs_fileno(c->cs);
4238 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4246 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4253 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4255 return ZOOM_options_get_int(c->options, "timeout", 30);
4261 * indent-tabs-mode: nil
4263 * vim: shiftwidth=4 tabstop=8 expandtab