2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.124 2007-04-13 09:55:41 adam Exp $
9 * \brief Implements ZOOM C interface.
17 #include <yaz/yaz-util.h>
18 #include <yaz/xmalloc.h>
19 #include <yaz/otherinfo.h>
21 #include <yaz/pquery.h>
22 #include <yaz/marcdisp.h>
23 #include <yaz/diagbib1.h>
24 #include <yaz/charneg.h>
30 static int log_api = 0;
31 static int log_details = 0;
38 static void resultset_destroy(ZOOM_resultset r);
39 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
40 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
41 static char *cql2pqf(ZOOM_connection c, const char *cql);
45 * This wrapper is just for logging failed lookups. It would be nicer
46 * if it could cause failure when a lookup fails, but that's hard.
48 static int *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
49 int oid_class, const char *str) {
50 int *res = yaz_string_to_oid_odr(yaz_oid_std(), oid_class, str,
53 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
54 c, (int) oid_class, str);
59 static void initlog(void)
61 static int log_level_initialized = 0;
62 if (!log_level_initialized)
64 log_api = yaz_log_module_level("zoom");
65 log_details = yaz_log_module_level("zoomdetails");
66 log_level_initialized = 1;
70 static ZOOM_Event ZOOM_Event_create(int kind)
72 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
76 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
80 static void ZOOM_Event_destroy(ZOOM_Event event)
85 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
89 c->m_queue_back->prev = event;
90 assert(c->m_queue_front);
94 assert(!c->m_queue_front);
95 c->m_queue_front = event;
97 event->next = c->m_queue_back;
99 c->m_queue_back = event;
102 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
104 ZOOM_Event event = c->m_queue_front;
107 c->last_event = ZOOM_EVENT_NONE;
110 assert(c->m_queue_back);
111 c->m_queue_front = event->prev;
112 if (c->m_queue_front)
114 assert(c->m_queue_back);
115 c->m_queue_front->next = 0;
119 c->last_event = event->kind;
123 static void ZOOM_connection_remove_events(ZOOM_connection c)
126 while ((event = ZOOM_connection_get_event(c)))
127 ZOOM_Event_destroy(event);
130 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
132 ZOOM_Event event = c->m_queue_front;
134 return event ? event->kind : ZOOM_EVENT_NONE;
137 void ZOOM_connection_remove_tasks(ZOOM_connection c);
139 static void set_dset_error(ZOOM_connection c, int error,
141 const char *addinfo, const char *addinfo2)
148 if (!c->diagset || strcmp(dset, c->diagset))
151 c->diagset = xstrdup(dset);
152 /* remove integer part from SRW diagset .. */
153 if ((cp = strrchr(c->diagset, '/')))
156 if (addinfo && addinfo2)
158 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
159 strcpy(c->addinfo, addinfo);
160 strcat(c->addinfo, addinfo2);
163 c->addinfo = xstrdup(addinfo);
164 if (error != ZOOM_ERROR_NONE)
166 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
167 c, c->host_port ? c->host_port : "<>", dset, error,
168 addinfo ? addinfo : "",
169 addinfo2 ? addinfo2 : "");
170 ZOOM_connection_remove_tasks(c);
175 static void set_HTTP_error(ZOOM_connection c, int error,
176 const char *addinfo, const char *addinfo2)
178 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
183 static void set_ZOOM_error(ZOOM_connection c, int error,
186 set_dset_error(c, error, "ZOOM", addinfo, 0);
189 static void clear_error(ZOOM_connection c)
192 * If an error is tied to an operation then it's ok to clear: for
193 * example, a diagnostic returned from a search is cleared by a
194 * subsequent search. However, problems such as Connection Lost
195 * or Init Refused are not cleared, because they are not
196 * recoverable: doing another search doesn't help.
199 ZOOM_connection_remove_events(c);
202 case ZOOM_ERROR_CONNECT:
203 case ZOOM_ERROR_MEMORY:
204 case ZOOM_ERROR_DECODE:
205 case ZOOM_ERROR_CONNECTION_LOST:
206 case ZOOM_ERROR_INIT:
207 case ZOOM_ERROR_INTERNAL:
208 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
211 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
215 void ZOOM_connection_show_task(ZOOM_task task)
219 case ZOOM_TASK_SEARCH:
220 yaz_log(YLOG_LOG, "search p=%p", task);
222 case ZOOM_TASK_RETRIEVE:
223 yaz_log(YLOG_LOG, "retrieve p=%p", task);
225 case ZOOM_TASK_CONNECT:
226 yaz_log(YLOG_LOG, "connect p=%p", task);
229 yaz_log(YLOG_LOG, "scant p=%p", task);
234 void ZOOM_connection_show_tasks(ZOOM_connection c)
237 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
238 for (task = c->tasks; task; task = task->next)
239 ZOOM_connection_show_task(task);
242 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
244 ZOOM_task *taskp = &c->tasks;
246 taskp = &(*taskp)->next;
247 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
248 (*taskp)->running = 0;
249 (*taskp)->which = which;
255 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
257 return c->tasks ? 0 : 1;
260 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
262 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
264 task->next = c->tasks;
273 void ZOOM_connection_remove_task(ZOOM_connection c)
275 ZOOM_task task = c->tasks;
279 c->tasks = task->next;
282 case ZOOM_TASK_SEARCH:
283 resultset_destroy(task->u.search.resultset);
284 xfree(task->u.search.syntax);
285 xfree(task->u.search.elementSetName);
287 case ZOOM_TASK_RETRIEVE:
288 resultset_destroy(task->u.retrieve.resultset);
289 xfree(task->u.retrieve.syntax);
290 xfree(task->u.retrieve.elementSetName);
292 case ZOOM_TASK_CONNECT:
295 ZOOM_scanset_destroy(task->u.scan.scan);
297 case ZOOM_TASK_PACKAGE:
298 ZOOM_package_destroy(task->u.package);
301 resultset_destroy(task->u.sort.resultset);
302 ZOOM_query_destroy(task->u.sort.q);
311 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
312 ZOOM_connection_put_event(c, event);
317 static int ZOOM_connection_exec_task(ZOOM_connection c);
319 void ZOOM_connection_remove_tasks(ZOOM_connection c)
322 ZOOM_connection_remove_task(c);
325 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
327 const char *elementSetName);
329 ZOOM_API(ZOOM_connection)
330 ZOOM_connection_create(ZOOM_options options)
332 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
336 yaz_log(log_api, "%p ZOOM_connection_create", c);
338 c->proto = PROTO_Z3950;
340 ZOOM_connection_set_mask(c, 0);
342 c->state = STATE_IDLE;
345 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
352 c->options = ZOOM_options_create_with_parent(options);
358 c->charset = c->lang = 0;
365 c->odr_in = odr_createmem(ODR_DECODE);
366 c->odr_out = odr_createmem(ODR_ENCODE);
369 c->support_named_resultsets = 0;
370 c->last_event = ZOOM_EVENT_NONE;
372 c->m_queue_front = 0;
378 /* set database names. Take local databases (if set); otherwise
379 take databases given in ZURL (if set); otherwise use Default */
380 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
383 char **databaseNames;
384 const char *cp = ZOOM_options_get(options, "databaseName");
386 if ((!cp || !*cp) && con->host_port)
388 if (strncmp(con->host_port, "unix:", 5) == 0)
389 cp = strchr(con->host_port+5, ':');
391 cp = strchr(con->host_port, '/');
397 nmem_strsplit(odr_getmem(odr), "+", cp, &databaseNames, num);
398 return databaseNames;
401 ZOOM_API(ZOOM_connection)
402 ZOOM_connection_new(const char *host, int portnum)
404 ZOOM_connection c = ZOOM_connection_create(0);
406 ZOOM_connection_connect(c, host, portnum);
410 static zoom_sru_mode get_sru_mode_from_string(const char *s)
413 return zoom_sru_soap;
414 if (!yaz_matchstr(s, "soap"))
415 return zoom_sru_soap;
416 else if (!yaz_matchstr(s, "get"))
418 else if (!yaz_matchstr(s, "post"))
419 return zoom_sru_post;
420 return zoom_sru_error;
424 ZOOM_connection_connect(ZOOM_connection c,
425 const char *host, int portnum)
432 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
433 c, host ? host : "null", portnum);
435 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
436 ZOOM_connection_remove_tasks(c);
440 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
444 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
446 val = ZOOM_options_get(c->options, "proxy");
449 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
450 c->proxy = xstrdup(val);
456 val = ZOOM_options_get(c->options, "charset");
459 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
460 c->charset = xstrdup(val);
466 val = ZOOM_options_get(c->options, "lang");
469 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
470 c->lang = xstrdup(val);
481 sprintf(hostn, "%.80s:%d", host, portnum);
482 c->host_port = xstrdup(hostn);
485 c->host_port = xstrdup(host);
490 * If the "<scheme>:" part of the host string is preceded by one
491 * or more comma-separated <name>=<value> pairs, these are taken
492 * to be options to be set on the connection object. Among other
493 * applications, this facility can be used to embed authentication
495 * user=admin,password=secret,tcp:localhost:9999
497 char *remainder = c->host_port;
498 char *pcolon = strchr(remainder, ':');
501 while ((pcomma = strchr(remainder, ',')) != 0 &&
502 (pcolon == 0 || pcomma < pcolon)) {
504 if ((pequals = strchr(remainder, '=')) != 0) {
506 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
507 ZOOM_connection_option_set(c, remainder, pequals+1);
509 remainder = pcomma+1;
512 if (remainder != c->host_port) {
514 c->host_port = xstrdup(remainder);
515 /*printf("# reset hp='%s'\n", remainder);*/
519 val = ZOOM_options_get(c->options, "sru");
520 c->sru_mode = get_sru_mode_from_string(val);
522 ZOOM_options_set(c->options, "host", c->host_port);
524 val = ZOOM_options_get(c->options, "cookie");
527 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
528 c->cookie_out = xstrdup(val);
531 val = ZOOM_options_get(c->options, "clientIP");
534 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
536 c->client_IP = xstrdup(val);
539 c->async = ZOOM_options_get_bool(c->options, "async", 0);
540 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
542 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
546 while (ZOOM_event(1, &c))
552 ZOOM_query_create(void)
554 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
556 yaz_log(log_details, "%p ZOOM_query_create", s);
560 s->odr = odr_createmem(ODR_ENCODE);
567 ZOOM_query_destroy(ZOOM_query s)
573 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
574 if (s->refcount == 0)
582 ZOOM_query_prefix(ZOOM_query s, const char *str)
584 s->query_string = odr_strdup(s->odr, str);
585 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
586 s->z_query->which = Z_Query_type_1;
587 s->z_query->u.type_1 = p_query_rpn(s->odr, str);
588 if (!s->z_query->u.type_1)
590 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
594 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
599 ZOOM_query_cql(ZOOM_query s, const char *str)
603 s->query_string = odr_strdup(s->odr, str);
605 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
606 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
607 ext->indirect_reference = 0;
609 ext->which = Z_External_CQL;
610 ext->u.cql = s->query_string;
612 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
613 s->z_query->which = Z_Query_type_104;
614 s->z_query->u.type_104 = ext;
616 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
622 * Translate the CQL string client-side into RPN which is passed to
623 * the server. This is useful for server's that don't themselves
624 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
625 * only as a place to stash diagnostics if compilation fails; if this
626 * information is not needed, a null pointer may be used.
629 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
633 ZOOM_connection freeme = 0;
635 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
637 conn = freeme = ZOOM_connection_create(0);
639 rpn = cql2pqf(conn, str);
641 ZOOM_connection_destroy(freeme);
645 ret = ZOOM_query_prefix(s, rpn);
651 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
652 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
653 * to the server, as the YAZ GFS doesn't know how to handle this.
656 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
657 int *ccl_error, const char **error_string,
661 struct ccl_rpn_node *rpn;
662 CCL_bibset bibset = ccl_qual_mk();
665 ccl_qual_buf(bibset, config);
667 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
670 *error_string = ccl_err_msg(*ccl_error);
675 WRBUF wr = wrbuf_alloc();
678 ret = ZOOM_query_prefix(s, wrbuf_cstr(wr));
681 ccl_qual_rm(&bibset);
686 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
688 s->sort_spec = yaz_sort_spec(s->odr, criteria);
691 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
695 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
699 static zoom_ret do_write(ZOOM_connection c);
702 ZOOM_connection_destroy(ZOOM_connection c)
707 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
710 for (r = c->resultsets; r; r = r->next)
716 odr_destroy(c->odr_in);
717 odr_destroy(c->odr_out);
718 ZOOM_options_destroy(c->options);
719 ZOOM_connection_remove_tasks(c);
720 ZOOM_connection_remove_events(c);
726 xfree(c->cookie_out);
732 void ZOOM_resultset_addref(ZOOM_resultset r)
737 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
742 ZOOM_resultset ZOOM_resultset_create(void)
745 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
749 yaz_log(log_details, "%p ZOOM_resultset_create", r);
752 r->odr = odr_createmem(ODR_ENCODE);
757 for (i = 0; i<RECORD_HASH_SIZE; i++)
758 r->record_hash[i] = 0;
763 r->databaseNames = 0;
764 r->num_databaseNames = 0;
768 ZOOM_API(ZOOM_resultset)
769 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
772 ZOOM_query s = ZOOM_query_create();
774 ZOOM_query_prefix(s, q);
776 r = ZOOM_connection_search(c, s);
777 ZOOM_query_destroy(s);
781 ZOOM_API(ZOOM_resultset)
782 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
784 ZOOM_resultset r = ZOOM_resultset_create();
788 const char *syntax, *elementSetName;
790 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
791 r->r_sort_spec = q->sort_spec;
794 r->options = ZOOM_options_create_with_parent(c->options);
796 start = ZOOM_options_get_int(r->options, "start", 0);
797 count = ZOOM_options_get_int(r->options, "count", 0);
799 /* If "presentChunk" is defined use that; otherwise "step" */
800 const char *cp = ZOOM_options_get(r->options, "presentChunk");
801 r->step = ZOOM_options_get_int(r->options,
802 (cp != 0 ? "presentChunk": "step"), 0);
804 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
805 cp = ZOOM_options_get(r->options, "setname");
807 r->setname = xstrdup(cp);
808 cp = ZOOM_options_get(r->options, "schema");
810 r->schema = xstrdup(cp);
812 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
817 r->next = c->resultsets;
820 if (c->host_port && c->proto == PROTO_HTTP)
824 yaz_log(log_details, "ZOOM_connection_search: no comstack");
825 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
829 yaz_log(log_details, "ZOOM_connection_search: reconnect");
834 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
835 task->u.search.resultset = r;
836 task->u.search.start = start;
837 task->u.search.count = count;
839 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
840 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
841 elementSetName = ZOOM_options_get(r->options, "elementSetName");
842 task->u.search.elementSetName = elementSetName
843 ? xstrdup(elementSetName) : 0;
845 ZOOM_resultset_addref(r);
851 while (ZOOM_event(1, &c))
858 ZOOM_resultset_sort(ZOOM_resultset r,
859 const char *sort_type, const char *sort_spec)
861 (void) ZOOM_resultset_sort(r, sort_type, sort_spec);
865 ZOOM_resultset_sort1(ZOOM_resultset r,
866 const char *sort_type, const char *sort_spec)
868 ZOOM_connection c = r->connection;
872 newq = ZOOM_query_create();
873 if (ZOOM_query_sortby(newq, sort_spec) < 0)
876 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
877 r, r, sort_type, sort_spec);
881 if (c->host_port && c->proto == PROTO_HTTP)
885 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
886 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
890 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
896 ZOOM_resultset_cache_reset(r);
897 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
898 task->u.sort.resultset = r;
899 task->u.sort.q = newq;
901 ZOOM_resultset_addref(r);
905 while (ZOOM_event(1, &c))
913 ZOOM_resultset_cache_reset(ZOOM_resultset r)
916 for (i = 0; i<RECORD_HASH_SIZE; i++)
918 ZOOM_record_cache rc;
919 for (rc = r->record_hash[i]; rc; rc = rc->next)
921 if (rc->rec.wrbuf_marc)
922 wrbuf_destroy(rc->rec.wrbuf_marc);
923 if (rc->rec.wrbuf_iconv)
924 wrbuf_destroy(rc->rec.wrbuf_iconv);
925 if (rc->rec.wrbuf_opac)
926 wrbuf_destroy(rc->rec.wrbuf_opac);
928 r->record_hash[i] = 0;
933 ZOOM_resultset_destroy(ZOOM_resultset r)
935 resultset_destroy(r);
938 static void resultset_destroy(ZOOM_resultset r)
943 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
945 if (r->refcount == 0)
947 ZOOM_resultset_cache_reset(r);
951 /* remove ourselves from the resultsets in connection */
952 ZOOM_resultset *rp = &r->connection->resultsets;
955 assert(*rp); /* we must be in this list!! */
957 { /* OK, we're here - take us out of it */
964 ZOOM_query_destroy(r->query);
965 ZOOM_options_destroy(r->options);
974 ZOOM_resultset_size(ZOOM_resultset r)
976 yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
981 static void do_close(ZOOM_connection c)
986 ZOOM_connection_set_mask(c, 0);
987 c->state = STATE_IDLE;
990 static int ZOOM_test_reconnect(ZOOM_connection c)
994 if (!c->reconnect_ok)
998 c->tasks->running = 0;
999 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1001 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1002 ZOOM_connection_put_event(c, event);
1007 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1008 int force_sync, int start, int count)
1013 const char *syntax, *elementSetName;
1017 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1018 " count=%d", r, force_sync, start, count);
1023 if (c->host_port && c->proto == PROTO_HTTP)
1027 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1028 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1032 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1034 c->reconnect_ok = 1;
1037 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1038 task->u.retrieve.resultset = r;
1039 task->u.retrieve.start = start;
1040 task->u.retrieve.count = count;
1042 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1043 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1044 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1045 task->u.retrieve.elementSetName = elementSetName
1046 ? xstrdup(elementSetName) : 0;
1048 cp = ZOOM_options_get(r->options, "schema");
1051 if (!r->schema || strcmp(r->schema, cp))
1054 r->schema = xstrdup(cp);
1058 ZOOM_resultset_addref(r);
1060 if (!r->connection->async || force_sync)
1061 while (r->connection && ZOOM_event(1, &r->connection))
1066 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1067 size_t start, size_t count)
1069 int force_present = 0;
1073 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1074 r, r, (long) start, (long) count);
1077 ZOOM_resultset_retrieve(r, force_present, start, count);
1081 for (i = 0; i< count; i++)
1082 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1086 static void get_cert(ZOOM_connection c)
1091 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1093 ZOOM_connection_option_setl(c, "sslPeerCert",
1094 cert_buf, cert_len);
1099 static zoom_ret do_connect(ZOOM_connection c)
1102 const char *effective_host;
1105 effective_host = c->proxy;
1107 effective_host = c->host_port;
1109 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1113 c->cs = cs_create_host(effective_host, 0, &add);
1115 if (c->cs && c->cs->protocol == PROTO_HTTP)
1118 const char *path = 0;
1120 c->proto = PROTO_HTTP;
1121 cs_get_host_args(c->host_port, &path);
1123 c->path = (char*) xmalloc(strlen(path)+2);
1125 strcpy(c->path+1, path);
1127 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1129 return zoom_complete;
1134 int ret = cs_connect(c->cs, add);
1137 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1138 ZOOM_connection_put_event(c, event);
1140 if (c->proto == PROTO_Z3950)
1141 ZOOM_connection_send_init(c);
1144 /* no init request for SRW .. */
1145 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1146 ZOOM_connection_remove_task(c);
1147 ZOOM_connection_set_mask(c, 0);
1148 ZOOM_connection_exec_task(c);
1150 c->state = STATE_ESTABLISHED;
1151 return zoom_pending;
1155 int mask = ZOOM_SELECT_EXCEPT;
1156 if (c->cs->io_pending & CS_WANT_WRITE)
1157 mask += ZOOM_SELECT_WRITE;
1158 if (c->cs->io_pending & CS_WANT_READ)
1159 mask += ZOOM_SELECT_READ;
1160 ZOOM_connection_set_mask(c, mask);
1161 c->state = STATE_CONNECTING;
1162 return zoom_pending;
1165 c->state = STATE_IDLE;
1166 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1167 return zoom_complete;
1170 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1173 for (i = 0; i<200; i++)
1177 Z_OtherInformation **oi;
1182 sprintf(buf, "otherInfo%d", i);
1183 val = ZOOM_options_get(c->options, buf);
1186 cp = strchr(val, ':');
1190 if (len >= sizeof(buf))
1191 len = sizeof(buf)-1;
1192 memcpy(buf, val, len);
1195 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
1200 yaz_oi_APDU(a, &oi);
1201 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
1205 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1210 const int *oid = yaz_string_to_oid(
1211 yaz_oid_std(), CLASS_USERINFO, OID_STR_COOKIE);
1212 Z_OtherInformation **oi;
1213 yaz_oi_APDU(a, &oi);
1214 yaz_oi_set_string_oid(oi, out, oid, 1, c->cookie_out);
1218 const int *oid = yaz_string_to_oid(
1219 yaz_oid_std(), CLASS_USERINFO, OID_STR_CLIENT_IP);
1220 Z_OtherInformation **oi;
1221 yaz_oi_APDU(a, &oi);
1222 yaz_oi_set_string_oid(oi, out, oid, 1, c->client_IP);
1224 otherInfo_attach(c, a, out);
1225 if (!z_APDU(out, &a, 0, 0))
1227 FILE *outf = fopen("/tmp/apdu.txt", "a");
1230 ODR odr_pr = odr_createmem(ODR_PRINT);
1231 fprintf(outf, "a=%p\n", a);
1232 odr_setprint(odr_pr, outf);
1233 z_APDU(odr_pr, &a, 0, 0);
1234 odr_destroy(odr_pr);
1236 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1237 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1241 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1245 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1249 if (encode_APDU(c, a, c->odr_out))
1250 return zoom_complete;
1251 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1252 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1253 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1254 ZOOM_connection_put_event(c, event);
1255 odr_reset(c->odr_out);
1259 /* returns 1 if PDU was sent OK (still pending )
1260 0 if PDU was not sent OK (nothing to wait for)
1263 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1265 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1266 Z_InitRequest *ireq = apdu->u.initRequest;
1267 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1268 odr_malloc(c->odr_out, sizeof(*auth));
1269 const char *auth_groupId = ZOOM_options_get(c->options, "group");
1270 const char *auth_userId = ZOOM_options_get(c->options, "user");
1271 const char *auth_password = ZOOM_options_get(c->options, "password");
1274 /* support the pass for backwards compatibility */
1276 auth_password = ZOOM_options_get(c->options, "pass");
1278 ODR_MASK_SET(ireq->options, Z_Options_search);
1279 ODR_MASK_SET(ireq->options, Z_Options_present);
1280 ODR_MASK_SET(ireq->options, Z_Options_scan);
1281 ODR_MASK_SET(ireq->options, Z_Options_sort);
1282 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1283 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1285 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1286 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1287 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1289 /* Index Data's Z39.50 Implementor Id is 81 */
1290 ireq->implementationId =
1291 odr_prepend(c->odr_out,
1292 ZOOM_options_get(c->options, "implementationId"),
1293 odr_prepend(c->odr_out, "81", ireq->implementationId));
1295 ireq->implementationName =
1296 odr_prepend(c->odr_out,
1297 ZOOM_options_get(c->options, "implementationName"),
1298 odr_prepend(c->odr_out, "ZOOM-C",
1299 ireq->implementationName));
1301 version = odr_strdup(c->odr_out, "$Revision: 1.124 $");
1302 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1303 version[strlen(version)-2] = '\0';
1304 ireq->implementationVersion =
1305 odr_prepend(c->odr_out,
1306 ZOOM_options_get(c->options, "implementationVersion"),
1307 odr_prepend(c->odr_out, &version[11],
1308 ireq->implementationVersion));
1310 *ireq->maximumRecordSize =
1311 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
1312 *ireq->preferredMessageSize =
1313 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
1315 if (auth_groupId || auth_password)
1317 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1320 if (auth_groupId && *auth_groupId)
1322 pass->groupId = (char *)
1323 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1324 strcpy(pass->groupId, auth_groupId);
1328 if (auth_userId && *auth_userId)
1330 pass->userId = (char *)
1331 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1332 strcpy(pass->userId, auth_userId);
1336 if (auth_password && *auth_password)
1338 pass->password = (char *)
1339 odr_malloc(c->odr_out, strlen(auth_password)+1);
1340 strcpy(pass->password, auth_password);
1345 auth->which = Z_IdAuthentication_idPass;
1346 auth->u.idPass = pass;
1347 ireq->idAuthentication = auth;
1350 else if (auth_userId)
1352 auth->which = Z_IdAuthentication_open;
1353 auth->u.open = (char *)
1354 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1355 strcpy(auth->u.open, auth_userId);
1356 ireq->idAuthentication = auth;
1360 const int *oid = yaz_string_to_oid(
1361 yaz_oid_std(), CLASS_USERINFO, OID_STR_CLIENT_IP);
1362 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
1363 oid, 1, c->host_port);
1365 if (c->charset || c->lang)
1367 Z_OtherInformation **oi;
1368 Z_OtherInformationUnit *oi_unit;
1370 yaz_oi_APDU(apdu, &oi);
1372 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1374 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1375 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1376 oi_unit->information.externallyDefinedInfo =
1377 yaz_set_proposal_charneg_list(c->odr_out, " ",
1378 c->charset, c->lang, 1);
1382 return send_APDU(c, apdu);
1386 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1391 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1393 if (c->sru_mode == zoom_sru_get)
1395 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1397 else if (c->sru_mode == zoom_sru_post)
1399 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1401 else if (c->sru_mode == zoom_sru_soap)
1403 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1405 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1406 return zoom_complete;
1407 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1409 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1410 ZOOM_connection_put_event(c, event);
1411 odr_reset(c->odr_out);
1417 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1421 ZOOM_resultset resultset = 0;
1423 const char *option_val = 0;
1425 if (c->error) /* don't continue on error */
1426 return zoom_complete;
1428 switch(c->tasks->which)
1430 case ZOOM_TASK_SEARCH:
1431 resultset = c->tasks->u.search.resultset;
1432 resultset->setname = xstrdup("default");
1433 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1434 start = &c->tasks->u.search.start;
1435 count = &c->tasks->u.search.count;
1437 case ZOOM_TASK_RETRIEVE:
1438 resultset = c->tasks->u.retrieve.resultset;
1440 start = &c->tasks->u.retrieve.start;
1441 count = &c->tasks->u.retrieve.count;
1443 if (*start >= resultset->size)
1444 return zoom_complete;
1445 if (*start + *count > resultset->size)
1446 *count = resultset->size - *start;
1448 for (i = 0; i < *count; i++)
1451 record_cache_lookup(resultset, i + *start,
1452 c->tasks->u.retrieve.syntax,
1453 c->tasks->u.retrieve.elementSetName);
1458 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1459 ZOOM_connection_put_event(c, event);
1466 return zoom_complete;
1469 return zoom_complete;
1471 assert(resultset->query);
1473 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1475 if (resultset->query->z_query->which == Z_Query_type_104
1476 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1478 sr->u.request->query_type = Z_SRW_query_type_cql;
1479 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1481 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1482 resultset->query->z_query->u.type_1)
1484 sr->u.request->query_type = Z_SRW_query_type_pqf;
1485 sr->u.request->query.pqf = resultset->query->query_string;
1489 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1490 return zoom_complete;
1492 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1493 sr->u.request->maximumRecords = odr_intdup(
1494 c->odr_out, resultset->step>0 ? resultset->step : *count);
1495 sr->u.request->recordSchema = resultset->schema;
1497 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1499 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1501 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1503 sr->extra_args = odr_strdup(c->odr_out, option_val);
1504 return send_srw(c, sr);
1507 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1509 return zoom_complete;
1513 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1516 int lslb, ssub, mspn;
1518 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1519 Z_SearchRequest *search_req = apdu->u.searchRequest;
1520 const char *elementSetName;
1521 const char *smallSetElementSetName;
1522 const char *mediumSetElementSetName;
1525 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1527 r = c->tasks->u.search.resultset;
1529 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1532 ZOOM_options_get(r->options, "elementSetName");
1533 smallSetElementSetName =
1534 ZOOM_options_get(r->options, "smallSetElementSetName");
1535 mediumSetElementSetName =
1536 ZOOM_options_get(r->options, "mediumSetElementSetName");
1538 if (!smallSetElementSetName)
1539 smallSetElementSetName = elementSetName;
1541 if (!mediumSetElementSetName)
1542 mediumSetElementSetName = elementSetName;
1547 /* prepare query for the search request */
1548 search_req->query = r->query->z_query;
1549 if (!search_req->query)
1551 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1552 return zoom_complete;
1555 search_req->databaseNames = r->databaseNames;
1556 search_req->num_databaseNames = r->num_databaseNames;
1558 /* get syntax (no need to provide unless piggyback is in effect) */
1559 syntax = c->tasks->u.search.syntax;
1561 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1562 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1563 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1564 if (lslb != -1 && ssub != -1 && mspn != -1)
1566 /* So're a Z39.50 expert? Let's hope you don't do sort */
1567 *search_req->largeSetLowerBound = lslb;
1568 *search_req->smallSetUpperBound = ssub;
1569 *search_req->mediumSetPresentNumber = mspn;
1571 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1572 && r->piggyback && !r->r_sort_spec && !r->schema)
1574 /* Regular piggyback - do it unless we're going to do sort */
1575 *search_req->largeSetLowerBound = 2000000000;
1576 *search_req->smallSetUpperBound = 1;
1577 *search_req->mediumSetPresentNumber =
1578 r->step>0 ? r->step : c->tasks->u.search.count;
1582 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1583 smallSetElementSetName = 0;
1584 mediumSetElementSetName = 0;
1587 if (smallSetElementSetName && *smallSetElementSetName)
1589 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1590 odr_malloc(c->odr_out, sizeof(*esn));
1592 esn->which = Z_ElementSetNames_generic;
1593 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1594 search_req->smallSetElementSetNames = esn;
1596 if (mediumSetElementSetName && *mediumSetElementSetName)
1598 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1599 odr_malloc(c->odr_out, sizeof(*esn));
1601 esn->which = Z_ElementSetNames_generic;
1602 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1603 search_req->mediumSetElementSetNames = esn;
1606 search_req->preferredRecordSyntax =
1607 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1611 if (c->support_named_resultsets)
1615 /* find the lowest unused ordinal so that we re-use
1616 result sets on the server. */
1617 for (ord = 1; ; ord++)
1620 sprintf(setname, "%d", ord);
1621 for (rp = c->resultsets; rp; rp = rp->next)
1622 if (rp->setname && !strcmp(rp->setname, setname))
1627 r->setname = xstrdup(setname);
1628 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1629 "set %s", c, r->setname);
1633 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1635 r->setname = xstrdup("default");
1637 ZOOM_options_set(r->options, "setname", r->setname);
1639 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1640 return send_APDU(c, apdu);
1643 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1650 case Z_DefaultDiagFormat_v2Addinfo:
1651 addinfo = r->u.v2Addinfo;
1653 case Z_DefaultDiagFormat_v3Addinfo:
1654 addinfo = r->u.v3Addinfo;
1659 set_dset_error(c, *r->condition,
1660 yaz_oid_to_string(yaz_oid_std(),
1661 r->diagnosticSetId, &oclass),
1665 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1667 if (p->which != Z_DiagRec_defaultFormat)
1668 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1670 response_default_diag(c, p->u.defaultFormat);
1673 ZOOM_API(ZOOM_record)
1674 ZOOM_record_clone(ZOOM_record srec)
1681 odr_enc = odr_createmem(ODR_ENCODE);
1682 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1684 buf = odr_getbuf(odr_enc, &size, 0);
1686 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1687 nrec->odr = odr_createmem(ODR_DECODE);
1688 nrec->wrbuf_marc = 0;
1689 nrec->wrbuf_iconv = 0;
1690 nrec->wrbuf_opac = 0;
1691 odr_setbuf(nrec->odr, buf, size, 0);
1692 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1694 odr_destroy(odr_enc);
1698 ZOOM_API(ZOOM_record)
1699 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1701 const char *syntax =
1702 ZOOM_options_get(s->options, "preferredRecordSyntax");
1703 const char *elementSetName =
1704 ZOOM_options_get(s->options, "elementSetName");
1706 return record_cache_lookup(s, pos, syntax, elementSetName);
1709 ZOOM_API(ZOOM_record)
1710 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1712 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1717 * MIKE: I think force_sync should always be zero, but I don't
1718 * want to make this change until I get the go-ahead from
1719 * Adam, in case something depends on the old synchronous
1723 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1724 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1725 rec = ZOOM_resultset_record_immediate(r, pos);
1731 ZOOM_record_destroy(ZOOM_record rec)
1735 if (rec->wrbuf_marc)
1736 wrbuf_destroy(rec->wrbuf_marc);
1737 if (rec->wrbuf_iconv)
1738 wrbuf_destroy(rec->wrbuf_iconv);
1739 if (rec->wrbuf_opac)
1740 wrbuf_destroy(rec->wrbuf_opac);
1741 odr_destroy(rec->odr);
1745 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1747 const char *buf, int sz,
1748 const char *record_charset)
1753 yaz_marc_t mt = yaz_marc_create();
1756 strcpy(to, "UTF-8");
1757 if (record_charset && *record_charset)
1759 /* Use "from,to" or just "from" */
1760 const char *cp = strchr(record_charset, ',');
1761 int clen = strlen(record_charset);
1764 strncpy( to, cp+1, sizeof(to)-1);
1765 to[sizeof(to)-1] = '\0';
1766 clen = cp - record_charset;
1768 if (clen > sizeof(from)-1)
1769 clen = sizeof(from)-1;
1772 strncpy(from, record_charset, clen);
1778 cd = yaz_iconv_open(to, from);
1779 yaz_marc_iconv(mt, cd);
1782 yaz_marc_xml(mt, marc_type);
1783 if (!rec->wrbuf_marc)
1784 rec->wrbuf_marc = wrbuf_alloc();
1785 wrbuf_rewind(rec->wrbuf_marc);
1786 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1788 yaz_marc_destroy(mt);
1790 yaz_iconv_close(cd);
1792 *len = wrbuf_len(rec->wrbuf_marc);
1793 return wrbuf_cstr(rec->wrbuf_marc);
1795 yaz_marc_destroy(mt);
1797 yaz_iconv_close(cd);
1801 static const char *record_iconv_return(ZOOM_record rec, int *len,
1802 const char *buf, int sz,
1803 const char *record_charset)
1810 strcpy(to, "UTF-8");
1812 if (record_charset && *record_charset)
1814 /* Use "from,to" or just "from" */
1815 const char *cp = strchr(record_charset, ',');
1816 int clen = strlen(record_charset);
1819 strncpy( to, cp+1, sizeof(to)-1);
1820 to[sizeof(to)-1] = '\0';
1821 clen = cp - record_charset;
1823 if (clen > sizeof(from)-1)
1824 clen = sizeof(from)-1;
1827 strncpy(from, record_charset, clen);
1831 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1833 if (!rec->wrbuf_iconv)
1834 rec->wrbuf_iconv = wrbuf_alloc();
1836 wrbuf_rewind(rec->wrbuf_iconv);
1838 wrbuf_iconv_write(rec->wrbuf_iconv, cd, buf, sz);
1839 wrbuf_iconv_reset(rec->wrbuf_iconv, cd);
1841 buf = wrbuf_cstr(rec->wrbuf_iconv);
1842 sz = wrbuf_len(rec->wrbuf_iconv);
1843 yaz_iconv_close(cd);
1851 ZOOM_record_error(ZOOM_record rec, const char **cp,
1852 const char **addinfo, const char **diagset)
1854 Z_NamePlusRecord *npr;
1859 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1861 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1862 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1863 const char *add = 0;
1865 if (diag_rec->which == Z_DiagRec_defaultFormat)
1867 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1870 error = *ddf->condition;
1873 case Z_DefaultDiagFormat_v2Addinfo:
1874 add = ddf->u.v2Addinfo;
1876 case Z_DefaultDiagFormat_v3Addinfo:
1877 add = ddf->u.v3Addinfo;
1882 yaz_oid_to_string(yaz_oid_std(),
1883 ddf->diagnosticSetId, &oclass);
1891 *addinfo = add ? add : "";
1893 *cp = diagbib1_str(error);
1899 ZOOM_API(const char *)
1900 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1907 Z_NamePlusRecord *npr;
1910 *len = 0; /* default return */
1919 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1921 if (cp[i] == ';' || cp[i] == ' ')
1927 while (type_spec[i] == ';')
1930 while (type_spec[i] == ' ')
1932 if (!strncmp(type_spec+i, "charset=", 8))
1935 i = i + 8; /* skip charset= */
1936 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1938 if (type_spec[i] == ';' || type_spec[i] == ' ')
1944 else if (!strncmp(type_spec+i, "xpath=", 6))
1948 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1952 while (type_spec[i] == ' ')
1955 if (!strcmp(type, "database"))
1958 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1959 return npr->databaseName;
1961 else if (!strcmp(type, "syntax"))
1963 const char *desc = 0;
1964 if (npr->which == Z_NamePlusRecord_databaseRecord)
1966 Z_External *r = (Z_External *) npr->u.databaseRecord;
1967 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
1972 *len = strlen(desc);
1975 if (npr->which != Z_NamePlusRecord_databaseRecord)
1978 /* from now on - we have a database record .. */
1979 if (!strcmp(type, "render"))
1981 Z_External *r = (Z_External *) npr->u.databaseRecord;
1982 const int *oid = r->direct_reference;
1984 /* render bibliographic record .. */
1985 if (r->which == Z_External_OPAC)
1987 r = r->u.opac->bibliographicRecord;
1990 oid = r->direct_reference;
1992 if (r->which == Z_External_sutrs)
1993 return record_iconv_return(rec, len,
1994 (char*) r->u.sutrs->buf,
1997 else if (r->which == Z_External_octet)
1999 if (yaz_oid_is_iso2709(oid))
2001 const char *ret_buf = marc_iconv_return(
2002 rec, YAZ_MARC_LINE, len,
2003 (const char *) r->u.octet_aligned->buf,
2004 r->u.octet_aligned->len,
2009 return record_iconv_return(rec, len,
2010 (const char *) r->u.octet_aligned->buf,
2011 r->u.octet_aligned->len,
2014 else if (r->which == Z_External_grs1)
2016 if (!rec->wrbuf_marc)
2017 rec->wrbuf_marc = wrbuf_alloc();
2018 wrbuf_rewind(rec->wrbuf_marc);
2019 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
2020 return record_iconv_return(rec, len,
2021 wrbuf_buf(rec->wrbuf_marc),
2022 wrbuf_len(rec->wrbuf_marc),
2027 else if (!strcmp(type, "xml"))
2029 Z_External *r = (Z_External *) npr->u.databaseRecord;
2030 const int *oid = r->direct_reference;
2032 /* render bibliographic record .. */
2033 if (r->which == Z_External_OPAC)
2035 r = r->u.opac->bibliographicRecord;
2038 oid = r->direct_reference;
2041 if (r->which == Z_External_sutrs)
2042 return record_iconv_return(rec, len,
2043 (const char *) r->u.sutrs->buf,
2046 else if (r->which == Z_External_octet)
2048 int marc_decode_type = YAZ_MARC_MARCXML;
2049 if (yaz_oid_is_iso2709(oid))
2051 const char *ret_buf = marc_iconv_return(
2052 rec, marc_decode_type, len,
2053 (const char *) r->u.octet_aligned->buf,
2054 r->u.octet_aligned->len,
2059 return record_iconv_return(rec, len,
2060 (const char *) r->u.octet_aligned->buf,
2061 r->u.octet_aligned->len,
2064 else if (r->which == Z_External_grs1)
2071 else if (!strcmp(type, "raw"))
2073 Z_External *r = (Z_External *) npr->u.databaseRecord;
2075 if (r->which == Z_External_sutrs)
2077 if (len) *len = r->u.sutrs->len;
2078 return (const char *) r->u.sutrs->buf;
2080 else if (r->which == Z_External_octet)
2082 if (len) *len = r->u.octet_aligned->len;
2083 return (const char *) r->u.octet_aligned->buf;
2085 else /* grs-1, explain, OPAC, ... */
2088 return (const char *) npr->u.databaseRecord;
2092 else if (!strcmp (type, "ext"))
2095 return (const char *) npr->u.databaseRecord;
2097 else if (!strcmp (type, "opac"))
2100 Z_External *r = (Z_External *) npr->u.databaseRecord;
2101 if (r->which == Z_External_OPAC)
2103 if (!rec->wrbuf_opac)
2104 rec->wrbuf_opac = wrbuf_alloc();
2105 wrbuf_rewind(rec->wrbuf_opac);
2106 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2107 return record_iconv_return(rec, len,
2108 wrbuf_buf(rec->wrbuf_opac),
2109 wrbuf_len(rec->wrbuf_opac),
2116 static int strcmp_null(const char *v1, const char *v2)
2122 return strcmp(v1, v2);
2125 static size_t record_hash(int pos)
2129 return pos % RECORD_HASH_SIZE;
2132 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2134 const char *syntax, const char *elementSetName)
2136 ZOOM_record_cache rc;
2138 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2139 ZOOM_connection_put_event(r->connection, event);
2141 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2145 if (strcmp_null(r->schema, rc->schema))
2147 if (strcmp_null(elementSetName,rc->elementSetName))
2149 if (strcmp_null(syntax, rc->syntax))
2151 /* not destroying rc->npr (it's handled by nmem )*/
2153 /* keeping wrbuf_marc too */
2157 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2160 rc->rec.wrbuf_marc = 0;
2161 rc->rec.wrbuf_iconv = 0;
2162 rc->rec.wrbuf_opac = 0;
2164 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2166 rc->elementSetName = 0;
2169 rc->syntax = odr_strdup(r->odr, syntax);
2174 rc->schema = odr_strdup(r->odr, r->schema);
2179 rc->next = r->record_hash[record_hash(pos)];
2180 r->record_hash[record_hash(pos)] = rc;
2183 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2185 const char *elementSetName)
2187 ZOOM_record_cache rc;
2189 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2193 if (strcmp_null(r->schema, rc->schema))
2195 if (strcmp_null(elementSetName,rc->elementSetName))
2197 if (strcmp_null(syntax, rc->syntax))
2205 static void handle_records(ZOOM_connection c, Z_Records *sr,
2208 ZOOM_resultset resultset;
2210 const char *syntax = 0, *elementSetName = 0;
2214 switch (c->tasks->which)
2216 case ZOOM_TASK_SEARCH:
2217 resultset = c->tasks->u.search.resultset;
2218 start = &c->tasks->u.search.start;
2219 count = &c->tasks->u.search.count;
2220 syntax = c->tasks->u.search.syntax;
2221 elementSetName = c->tasks->u.search.elementSetName;
2223 case ZOOM_TASK_RETRIEVE:
2224 resultset = c->tasks->u.retrieve.resultset;
2225 start = &c->tasks->u.retrieve.start;
2226 count = &c->tasks->u.retrieve.count;
2227 syntax = c->tasks->u.retrieve.syntax;
2228 elementSetName = c->tasks->u.retrieve.elementSetName;
2233 if (sr && sr->which == Z_Records_NSD)
2234 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2235 else if (sr && sr->which == Z_Records_multipleNSD)
2237 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2238 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2240 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2244 if (*count + *start > resultset->size)
2245 *count = resultset->size - *start;
2248 if (sr && sr->which == Z_Records_DBOSD)
2251 NMEM nmem = odr_extract_mem(c->odr_in);
2252 Z_NamePlusRecordList *p =
2253 sr->u.databaseOrSurDiagnostics;
2254 for (i = 0; i<p->num_records; i++)
2256 record_cache_add(resultset, p->records[i], i + *start,
2257 syntax, elementSetName);
2263 yaz_log(log_details,
2264 "handle_records resultset=%p start=%d count=%d",
2265 resultset, *start, *count);
2267 /* transfer our response to search_nmem .. we need it later */
2268 nmem_transfer(odr_getmem(resultset->odr), nmem);
2270 if (present_phase && p->num_records == 0)
2272 /* present response and we didn't get any records! */
2273 Z_NamePlusRecord *myrec =
2274 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2275 record_cache_add(resultset, myrec, *start,
2276 syntax, elementSetName);
2279 else if (present_phase)
2281 /* present response and we didn't get any records! */
2282 Z_NamePlusRecord *myrec =
2283 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2284 record_cache_add(resultset, myrec, *start, syntax, elementSetName);
2289 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2291 handle_records(c, pr->records, 1);
2294 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2297 switch (term->which)
2299 case Z_Term_general:
2300 ZOOM_options_setl(opt, name,
2301 (const char *)(term->u.general->buf),
2302 term->u.general->len);
2304 case Z_Term_characterString:
2305 ZOOM_options_set(opt, name, term->u.characterString);
2307 case Z_Term_numeric:
2308 ZOOM_options_set_int(opt, name, *term->u.numeric);
2313 static void handle_queryExpression(ZOOM_options opt, const char *name,
2314 Z_QueryExpression *exp)
2320 case Z_QueryExpression_term:
2321 if (exp->u.term && exp->u.term->queryTerm)
2323 sprintf(opt_name, "%s.term", name);
2324 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2327 case Z_QueryExpression_query:
2332 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2333 Z_OtherInformation *o)
2336 for (i = 0; o && i < o->num_elements; i++)
2338 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2340 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2342 if (ext->which == Z_External_searchResult1)
2345 Z_SearchInfoReport *sr = ext->u.searchResult1;
2348 ZOOM_options_set_int(
2349 resultset->options, "searchresult.size", sr->num);
2351 for (j = 0; j < sr->num; j++)
2353 Z_SearchInfoReport_s *ent =
2354 ext->u.searchResult1->elements[j];
2357 sprintf(pref, "searchresult.%d", j);
2359 if (ent->subqueryId)
2362 sprintf(opt_name, "%s.id", pref);
2363 ZOOM_options_set(resultset->options, opt_name,
2366 if (ent->subqueryExpression)
2369 sprintf(opt_name, "%s.subquery", pref);
2370 handle_queryExpression(resultset->options, opt_name,
2371 ent->subqueryExpression);
2373 if (ent->subqueryInterpretation)
2376 sprintf(opt_name, "%s.interpretation", pref);
2377 handle_queryExpression(resultset->options, opt_name,
2378 ent->subqueryInterpretation);
2380 if (ent->subqueryRecommendation)
2383 sprintf(opt_name, "%s.recommendation", pref);
2384 handle_queryExpression(resultset->options, opt_name,
2385 ent->subqueryRecommendation);
2387 if (ent->subqueryCount)
2390 sprintf(opt_name, "%s.count", pref);
2391 ZOOM_options_set_int(resultset->options, opt_name,
2392 *ent->subqueryCount);
2400 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2402 ZOOM_resultset resultset;
2405 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2408 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2409 ZOOM_connection_put_event(c, event);
2411 resultset = c->tasks->u.search.resultset;
2413 if (sr->resultSetStatus)
2415 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2416 *sr->resultSetStatus);
2418 if (sr->presentStatus)
2420 ZOOM_options_set_int(resultset->options, "presentStatus",
2421 *sr->presentStatus);
2423 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2425 resultset->size = *sr->resultCount;
2426 handle_records(c, sr->records, 0);
2429 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2431 if (res->diagnostics && res->num_diagnostics > 0)
2432 response_diag(c, res->diagnostics[0]);
2435 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2437 NMEM nmem = odr_extract_mem(c->odr_in);
2440 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2442 scan = c->tasks->u.scan.scan;
2444 if (res->entries && res->entries->nonsurrogateDiagnostics)
2445 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2446 scan->scan_response = res;
2447 nmem_transfer(odr_getmem(scan->odr), nmem);
2449 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2450 if (res->positionOfTerm)
2451 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2452 if (res->scanStatus)
2453 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2454 if (res->numberOfEntriesReturned)
2455 ZOOM_options_set_int(scan->options, "number",
2456 *res->numberOfEntriesReturned);
2461 static zoom_ret send_sort(ZOOM_connection c,
2462 ZOOM_resultset resultset)
2465 resultset->r_sort_spec = 0;
2466 if (resultset->r_sort_spec)
2468 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2469 Z_SortRequest *req = apdu->u.sortRequest;
2471 req->num_inputResultSetNames = 1;
2472 req->inputResultSetNames = (Z_InternationalString **)
2473 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2474 req->inputResultSetNames[0] =
2475 odr_strdup(c->odr_out, resultset->setname);
2476 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2477 req->sortSequence = resultset->r_sort_spec;
2478 resultset->r_sort_spec = 0;
2479 return send_APDU(c, apdu);
2481 return zoom_complete;
2484 static zoom_ret send_present(ZOOM_connection c)
2487 Z_PresentRequest *req = 0;
2489 const char *syntax = 0;
2490 const char *elementSetName = 0;
2491 ZOOM_resultset resultset;
2496 yaz_log(log_details, "%p send_present no tasks", c);
2497 return zoom_complete;
2500 switch (c->tasks->which)
2502 case ZOOM_TASK_SEARCH:
2503 resultset = c->tasks->u.search.resultset;
2504 start = &c->tasks->u.search.start;
2505 count = &c->tasks->u.search.count;
2506 syntax = c->tasks->u.search.syntax;
2507 elementSetName = c->tasks->u.search.elementSetName;
2509 case ZOOM_TASK_RETRIEVE:
2510 resultset = c->tasks->u.retrieve.resultset;
2511 start = &c->tasks->u.retrieve.start;
2512 count = &c->tasks->u.retrieve.count;
2513 syntax = c->tasks->u.retrieve.syntax;
2514 elementSetName = c->tasks->u.retrieve.elementSetName;
2517 return zoom_complete;
2519 yaz_log(log_details, "%p send_present start=%d count=%d",
2522 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2524 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2527 if (c->error) /* don't continue on error */
2528 return zoom_complete;
2529 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2530 resultset, *start, *count);
2532 for (i = 0; i < *count; i++)
2535 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2540 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2541 ZOOM_connection_put_event(c, event);
2549 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2550 return zoom_complete;
2553 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2554 req = apdu->u.presentRequest;
2557 yaz_log(log_details, "%p send_present skip=%d", c, i);
2559 *req->resultSetStartPoint = *start + 1;
2560 *req->numberOfRecordsRequested = resultset->step>0 ?
2561 resultset->step : *count;
2562 if (*req->numberOfRecordsRequested + *start > resultset->size)
2563 *req->numberOfRecordsRequested = resultset->size - *start;
2564 assert(*req->numberOfRecordsRequested > 0);
2566 if (syntax && *syntax)
2567 req->preferredRecordSyntax =
2568 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2570 if (resultset->schema && *resultset->schema)
2572 Z_RecordComposition *compo = (Z_RecordComposition *)
2573 odr_malloc(c->odr_out, sizeof(*compo));
2575 req->recordComposition = compo;
2576 compo->which = Z_RecordComp_complex;
2577 compo->u.complex = (Z_CompSpec *)
2578 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2579 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2580 odr_malloc(c->odr_out, sizeof(bool_t));
2581 *compo->u.complex->selectAlternativeSyntax = 0;
2583 compo->u.complex->generic = (Z_Specification *)
2584 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2586 compo->u.complex->generic->which = Z_Schema_oid;
2587 compo->u.complex->generic->schema.oid = (Odr_oid *)
2588 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2590 if (!compo->u.complex->generic->schema.oid)
2592 /* OID wasn't a schema! Try record syntax instead. */
2594 compo->u.complex->generic->schema.oid = (Odr_oid *)
2595 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2597 if (elementSetName && *elementSetName)
2599 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2600 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2601 compo->u.complex->generic->elementSpec->which =
2602 Z_ElementSpec_elementSetName;
2603 compo->u.complex->generic->elementSpec->u.elementSetName =
2604 odr_strdup(c->odr_out, elementSetName);
2607 compo->u.complex->generic->elementSpec = 0;
2608 compo->u.complex->num_dbSpecific = 0;
2609 compo->u.complex->dbSpecific = 0;
2610 compo->u.complex->num_recordSyntax = 0;
2611 compo->u.complex->recordSyntax = 0;
2613 else if (elementSetName && *elementSetName)
2615 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2616 odr_malloc(c->odr_out, sizeof(*esn));
2617 Z_RecordComposition *compo = (Z_RecordComposition *)
2618 odr_malloc(c->odr_out, sizeof(*compo));
2620 esn->which = Z_ElementSetNames_generic;
2621 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2622 compo->which = Z_RecordComp_simple;
2623 compo->u.simple = esn;
2624 req->recordComposition = compo;
2626 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2627 return send_APDU(c, apdu);
2630 ZOOM_API(ZOOM_scanset)
2631 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2634 ZOOM_query q = ZOOM_query_create();
2636 ZOOM_query_prefix(q, start);
2638 s = ZOOM_connection_scan1(c, q);
2639 ZOOM_query_destroy(q);
2644 ZOOM_API(ZOOM_scanset)
2645 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2649 ZOOM_scanset scan = 0;
2652 * We need to check the query-type, so we can recognise CQL and
2653 * CCL and compile them into a form that we can use here. The
2654 * ZOOM_query structure has no explicit `type' member, but
2655 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2656 * functions shows how the structure is set up in each case.
2660 else if (q->z_query->which == Z_Query_type_1)
2662 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2663 c, q, q->query_string);
2664 start = q->query_string;
2666 else if (q->z_query->which == Z_Query_type_104)
2668 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2669 c, q, q->query_string);
2670 start = freeme = cql2pqf(c, q->query_string);
2676 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2677 c, q, q->query_string);
2681 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2682 scan->connection = c;
2683 scan->odr = odr_createmem(ODR_DECODE);
2684 scan->options = ZOOM_options_create_with_parent(c->options);
2686 scan->scan_response = 0;
2687 scan->termListAndStartPoint =
2688 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2691 scan->databaseNames = set_DatabaseNames(c, c->options,
2692 &scan->num_databaseNames,
2694 if (scan->termListAndStartPoint != 0)
2696 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2697 task->u.scan.scan = scan;
2702 while (ZOOM_event(1, &c))
2710 ZOOM_scanset_destroy(ZOOM_scanset scan)
2715 if (scan->refcount == 0)
2717 odr_destroy(scan->odr);
2719 ZOOM_options_destroy(scan->options);
2724 static zoom_ret send_package(ZOOM_connection c)
2728 yaz_log(log_details, "%p send_package", c);
2730 return zoom_complete;
2731 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2733 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2734 ZOOM_connection_put_event(c, event);
2736 c->buf_out = c->tasks->u.package->buf_out;
2737 c->len_out = c->tasks->u.package->len_out;
2742 static zoom_ret send_scan(ZOOM_connection c)
2745 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2746 Z_ScanRequest *req = apdu->u.scanRequest;
2748 yaz_log(log_details, "%p send_scan", c);
2750 return zoom_complete;
2751 assert (c->tasks->which == ZOOM_TASK_SCAN);
2752 scan = c->tasks->u.scan.scan;
2754 req->termListAndStartPoint = scan->termListAndStartPoint;
2755 req->attributeSet = scan->attributeSet;
2757 *req->numberOfTermsRequested =
2758 ZOOM_options_get_int(scan->options, "number", 10);
2760 req->preferredPositionInResponse =
2761 odr_intdup(c->odr_out,
2762 ZOOM_options_get_int(scan->options, "position", 1));
2765 odr_intdup(c->odr_out,
2766 ZOOM_options_get_int(scan->options, "stepSize", 0));
2768 req->databaseNames = scan->databaseNames;
2769 req->num_databaseNames = scan->num_databaseNames;
2771 return send_APDU(c, apdu);
2775 ZOOM_scanset_size(ZOOM_scanset scan)
2777 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2779 return scan->scan_response->entries->num_entries;
2782 ZOOM_API(const char *)
2783 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2786 const char *term = 0;
2787 size_t noent = ZOOM_scanset_size(scan);
2788 Z_ScanResponse *res = scan->scan_response;
2794 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2796 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2798 if (t->term->which == Z_Term_general)
2800 term = (const char *) t->term->u.general->buf;
2801 *len = t->term->u.general->len;
2803 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2808 ZOOM_API(const char *)
2809 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2812 const char *term = 0;
2813 size_t noent = ZOOM_scanset_size(scan);
2814 Z_ScanResponse *res = scan->scan_response;
2820 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2822 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2826 term = t->displayTerm;
2827 *len = strlen(term);
2829 else if (t->term->which == Z_Term_general)
2831 term = (const char *) t->term->u.general->buf;
2832 *len = t->term->u.general->len;
2834 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2839 ZOOM_API(const char *)
2840 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2842 return ZOOM_options_get(scan->options, key);
2846 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2849 ZOOM_options_set(scan->options, key, val);
2852 static Z_APDU *create_es_package(ZOOM_package p, const char *type)
2855 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2856 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2858 *req->function = Z_ExtendedServicesRequest_create;
2860 str = ZOOM_options_get(p->options, "package-name");
2862 req->packageName = odr_strdup(p->odr_out, str);
2864 str = ZOOM_options_get(p->options, "user-id");
2866 req->userId = odr_strdup(p->odr_out, str);
2868 req->packageType = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_EXTSERV,
2871 str = ZOOM_options_get(p->options, "function");
2874 if (!strcmp (str, "create"))
2876 if (!strcmp (str, "delete"))
2878 if (!strcmp (str, "modify"))
2884 static const char *ill_array_lookup(void *clientData, const char *idx)
2886 ZOOM_package p = (ZOOM_package) clientData;
2887 return ZOOM_options_get(p->options, idx+4);
2890 static Z_External *encode_ill_request(ZOOM_package p)
2892 ODR out = p->odr_out;
2895 struct ill_get_ctl ctl;
2897 ctl.odr = p->odr_out;
2899 ctl.f = ill_array_lookup;
2901 req = ill_get_ILLRequest(&ctl, "ill", 0);
2903 if (!ill_Request(out, &req, 0, 0))
2905 int ill_request_size;
2906 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2907 if (ill_request_buf)
2908 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2913 int illRequest_size = 0;
2914 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2916 r = (Z_External *) odr_malloc(out, sizeof(*r));
2917 r->direct_reference = yaz_string_to_oid_odr(yaz_oid_std(),
2921 r->indirect_reference = 0;
2923 r->which = Z_External_single;
2925 r->u.single_ASN1_type =
2926 odr_create_Odr_oct(out,
2927 (unsigned char *)illRequest_buf,
2933 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2935 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2938 req->which = Z_IOItemOrder_esRequest;
2939 req->u.esRequest = (Z_IORequest *)
2940 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2942 /* to keep part ... */
2943 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2944 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2945 req->u.esRequest->toKeep->supplDescription = 0;
2946 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2947 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2949 str = ZOOM_options_get(p->options, "contact-name");
2950 req->u.esRequest->toKeep->contact->name = str ?
2951 odr_strdup(p->odr_out, str) : 0;
2953 str = ZOOM_options_get(p->options, "contact-phone");
2954 req->u.esRequest->toKeep->contact->phone = str ?
2955 odr_strdup(p->odr_out, str) : 0;
2957 str = ZOOM_options_get(p->options, "contact-email");
2958 req->u.esRequest->toKeep->contact->email = str ?
2959 odr_strdup(p->odr_out, str) : 0;
2961 req->u.esRequest->toKeep->addlBilling = 0;
2963 /* not to keep part ... */
2964 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2965 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2967 str = ZOOM_options_get(p->options, "itemorder-setname");
2972 req->u.esRequest->notToKeep->resultSetItem = 0;
2975 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2976 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2978 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2979 odr_strdup(p->odr_out, str);
2980 req->u.esRequest->notToKeep->resultSetItem->item =
2981 (int *) odr_malloc(p->odr_out, sizeof(int));
2983 str = ZOOM_options_get(p->options, "itemorder-item");
2984 *req->u.esRequest->notToKeep->resultSetItem->item =
2985 (str ? atoi(str) : 1);
2988 str = ZOOM_options_get(p->options, "doc");
2991 req->u.esRequest->notToKeep->itemRequest =
2992 z_ext_record_xml(p->odr_out, str, strlen(str));
2995 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3000 Z_APDU *create_admin_package(ZOOM_package p, int type,
3001 Z_ESAdminOriginPartToKeep **toKeepP,
3002 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3004 Z_APDU *apdu = create_es_package(p, OID_STR_ADMIN);
3007 Z_ESAdminOriginPartToKeep *toKeep;
3008 Z_ESAdminOriginPartNotToKeep *notToKeep;
3009 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3010 const char *first_db = "Default";
3012 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3017 r->direct_reference =
3018 yaz_string_to_oid_odr(yaz_oid_std(),
3019 CLASS_EXTSERV, OID_STR_ADMIN, p->odr_out);
3021 r->indirect_reference = 0;
3022 r->which = Z_External_ESAdmin;
3024 r->u.adminService = (Z_Admin *)
3025 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3026 r->u.adminService->which = Z_Admin_esRequest;
3027 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3028 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3030 toKeep = r->u.adminService->u.esRequest->toKeep =
3031 (Z_ESAdminOriginPartToKeep *)
3032 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3033 toKeep->which = type;
3034 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3035 toKeep->u.create = odr_nullval();
3036 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3038 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3039 (Z_ESAdminOriginPartNotToKeep *)
3040 odr_malloc(p->odr_out,
3041 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3042 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3043 notToKeep->u.recordsWillFollow = odr_nullval();
3047 *notToKeepP = notToKeep;
3052 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3054 Z_APDU *apdu = create_es_package(p, OID_STR_XMLES);
3055 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3056 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3057 const char *doc = ZOOM_options_get(p->options, "doc");
3062 req->taskSpecificParameters = ext;
3063 ext->direct_reference = req->packageType;
3064 ext->descriptor = 0;
3065 ext->indirect_reference = 0;
3067 ext->which = Z_External_octet;
3068 ext->u.single_ASN1_type =
3069 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
3074 static Z_APDU *create_update_package(ZOOM_package p)
3077 const char *first_db = "Default";
3079 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3080 const char *action = ZOOM_options_get(p->options, "action");
3081 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
3082 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3083 const char *record_buf = ZOOM_options_get(p->options, "record");
3084 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3086 int *syntax_oid = 0;
3092 record_buf = "void";
3093 syntax_str = "SUTRS";
3098 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3099 CLASS_RECSYN, syntax_str,
3109 action = "specialUpdate";
3111 if (!strcmp(action, "recordInsert"))
3112 action_no = Z_IUOriginPartToKeep_recordInsert;
3113 else if (!strcmp(action, "recordReplace"))
3114 action_no = Z_IUOriginPartToKeep_recordReplace;
3115 else if (!strcmp(action, "recordDelete"))
3116 action_no = Z_IUOriginPartToKeep_recordDelete;
3117 else if (!strcmp(action, "elementUpdate"))
3118 action_no = Z_IUOriginPartToKeep_elementUpdate;
3119 else if (!strcmp(action, "specialUpdate"))
3120 action_no = Z_IUOriginPartToKeep_specialUpdate;
3124 apdu = create_es_package(p, OID_STR_EXT_UPDATE);
3127 Z_IUOriginPartToKeep *toKeep;
3128 Z_IUSuppliedRecords *notToKeep;
3129 Z_External *r = (Z_External *)
3130 odr_malloc(p->odr_out, sizeof(*r));
3132 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3135 r->direct_reference =
3136 yaz_string_to_oid_odr(yaz_oid_std(), CLASS_EXTSERV,
3137 OID_STR_EXT_UPDATE, p->odr_out);
3139 r->which = Z_External_update;
3140 r->indirect_reference = 0;
3141 r->u.update = (Z_IUUpdate *)
3142 odr_malloc(p->odr_out, sizeof(*r->u.update));
3144 r->u.update->which = Z_IUUpdate_esRequest;
3145 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3146 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3147 toKeep = r->u.update->u.esRequest->toKeep =
3148 (Z_IUOriginPartToKeep *)
3149 odr_malloc(p->odr_out, sizeof(*toKeep));
3151 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3153 toKeep->elementSetName = 0;
3154 toKeep->actionQualifier = 0;
3155 toKeep->action = odr_intdup(p->odr_out, action_no);
3157 notToKeep = r->u.update->u.esRequest->notToKeep =
3158 (Z_IUSuppliedRecords *)
3159 odr_malloc(p->odr_out, sizeof(*notToKeep));
3161 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3162 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3163 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3164 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3165 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3168 notToKeep->elements[0]->u.opaque =
3169 odr_create_Odr_oct(p->odr_out,
3170 (const unsigned char *) recordIdOpaque,
3171 strlen(recordIdOpaque));
3173 else if (recordIdNumber)
3175 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3177 notToKeep->elements[0]->u.number =
3178 odr_intdup(p->odr_out, atoi(recordIdNumber));
3181 notToKeep->elements[0]->u.opaque = 0;
3182 notToKeep->elements[0]->supplementalId = 0;
3183 notToKeep->elements[0]->correlationInfo = 0;
3184 notToKeep->elements[0]->record =
3185 z_ext_record_oid(p->odr_out, syntax_oid,
3186 record_buf, strlen(record_buf));
3190 ODR print = odr_createmem(ODR_PRINT);
3192 z_APDU(print, &apdu, 0, 0);
3199 ZOOM_package_send(ZOOM_package p, const char *type)
3206 odr_reset(p->odr_out);
3209 if (!strcmp(type, "itemorder"))
3211 apdu = create_es_package(p, OID_STR_ITEMORDER);
3214 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3216 r->direct_reference =
3217 yaz_string_to_oid_odr(yaz_oid_std(), CLASS_EXTSERV,
3218 OID_STR_ITEMORDER, p->odr_out);
3220 r->which = Z_External_itemOrder;
3221 r->indirect_reference = 0;
3222 r->u.itemOrder = encode_item_order(p);
3224 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3227 else if (!strcmp(type, "create")) /* create database */
3229 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3232 else if (!strcmp(type, "drop")) /* drop database */
3234 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3237 else if (!strcmp(type, "commit")) /* commit changes */
3239 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3242 else if (!strcmp(type, "update")) /* update record(s) */
3244 apdu = create_update_package(p);
3246 else if (!strcmp(type, "xmlupdate"))
3248 apdu = create_xmlupdate_package(p);
3252 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3256 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3257 task->u.package = p;
3258 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3259 p->buf_out = (char *) xmalloc(p->len_out);
3260 memcpy(p->buf_out, buf, p->len_out);
3265 while (ZOOM_event(1, &c))
3272 ZOOM_API(ZOOM_package)
3273 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3275 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3278 p->odr_out = odr_createmem(ODR_ENCODE);
3279 p->options = ZOOM_options_create_with_parent2(options, c->options);
3287 ZOOM_package_destroy(ZOOM_package p)
3292 if (p->refcount == 0)
3294 odr_destroy(p->odr_out);
3297 ZOOM_options_destroy(p->options);
3302 ZOOM_API(const char *)
3303 ZOOM_package_option_get(ZOOM_package p, const char *key)
3305 return ZOOM_options_get(p->options, key);
3310 ZOOM_package_option_set(ZOOM_package p, const char *key,
3313 ZOOM_options_set(p->options, key, val);
3316 static int ZOOM_connection_exec_task(ZOOM_connection c)
3318 ZOOM_task task = c->tasks;
3319 zoom_ret ret = zoom_complete;
3323 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3324 c, task->which, task->running);
3325 if (c->error != ZOOM_ERROR_NONE)
3327 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3328 "removing tasks because of error = %d", c, c->error);
3329 ZOOM_connection_remove_tasks(c);
3334 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3335 "task already running", c);
3339 ret = zoom_complete;
3340 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3342 switch (task->which)
3344 case ZOOM_TASK_SEARCH:
3345 if (c->proto == PROTO_HTTP)
3346 ret = ZOOM_connection_srw_send_search(c);
3348 ret = ZOOM_connection_send_search(c);
3350 case ZOOM_TASK_RETRIEVE:
3351 if (c->proto == PROTO_HTTP)
3352 ret = ZOOM_connection_srw_send_search(c);
3354 ret = send_present(c);
3356 case ZOOM_TASK_CONNECT:
3357 ret = do_connect(c);
3359 case ZOOM_TASK_SCAN:
3362 case ZOOM_TASK_PACKAGE:
3363 ret = send_package(c);
3365 case ZOOM_TASK_SORT:
3366 c->tasks->u.sort.resultset->r_sort_spec =
3367 c->tasks->u.sort.q->sort_spec;
3368 ret = send_sort(c, c->tasks->u.sort.resultset);
3374 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3375 "remove tasks because no connection exist", c);
3376 ZOOM_connection_remove_tasks(c);
3378 if (ret == zoom_complete)
3380 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3381 "task removed (complete)", c);
3382 ZOOM_connection_remove_task(c);
3385 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3390 static zoom_ret send_sort_present(ZOOM_connection c)
3392 zoom_ret r = zoom_complete;
3394 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3395 r = send_sort(c, c->tasks->u.search.resultset);
3396 if (r == zoom_complete)
3397 r = send_present(c);
3401 static int es_response(ZOOM_connection c,
3402 Z_ExtendedServicesResponse *res)
3404 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3406 if (res->diagnostics && res->num_diagnostics > 0)
3407 response_diag(c, res->diagnostics[0]);
3408 if (res->taskPackage &&
3409 res->taskPackage->which == Z_External_extendedService)
3411 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3412 Odr_oct *id = taskPackage->targetReference;
3415 ZOOM_options_setl(c->tasks->u.package->options,
3416 "targetReference", (char*) id->buf, id->len);
3418 if (res->taskPackage &&
3419 res->taskPackage->which == Z_External_octet)
3421 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3422 ZOOM_options_setl(c->tasks->u.package->options,
3423 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3428 static void interpret_init_diag(ZOOM_connection c,
3429 Z_DiagnosticFormat *diag)
3433 Z_DiagnosticFormat_s *ds = diag->elements[0];
3434 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3435 response_default_diag(c, ds->u.defaultDiagRec);
3440 static void interpret_otherinformation_field(ZOOM_connection c,
3441 Z_OtherInformation *ui)
3444 for (i = 0; i < ui->num_elements; i++)
3446 Z_OtherInformationUnit *unit = ui->list[i];
3447 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3448 unit->information.externallyDefinedInfo &&
3449 unit->information.externallyDefinedInfo->which ==
3452 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3458 static void set_init_option(const char *name, void *clientData) {
3459 ZOOM_connection c = clientData;
3462 sprintf(buf, "init_opt_%.70s", name);
3463 ZOOM_connection_option_set(c, buf, "1");
3467 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3469 Z_InitResponse *initrs;
3471 ZOOM_connection_set_mask(c, 0);
3472 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3475 case Z_APDU_initResponse:
3476 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3477 initrs = apdu->u.initResponse;
3478 ZOOM_connection_option_set(c, "serverImplementationId",
3479 initrs->implementationId ?
3480 initrs->implementationId : "");
3481 ZOOM_connection_option_set(c, "serverImplementationName",
3482 initrs->implementationName ?
3483 initrs->implementationName : "");
3484 ZOOM_connection_option_set(c, "serverImplementationVersion",
3485 initrs->implementationVersion ?
3486 initrs->implementationVersion : "");
3487 /* Set the three old options too, for old applications */
3488 ZOOM_connection_option_set(c, "targetImplementationId",
3489 initrs->implementationId ?
3490 initrs->implementationId : "");
3491 ZOOM_connection_option_set(c, "targetImplementationName",
3492 initrs->implementationName ?
3493 initrs->implementationName : "");
3494 ZOOM_connection_option_set(c, "targetImplementationVersion",
3495 initrs->implementationVersion ?
3496 initrs->implementationVersion : "");
3498 /* Make initrs->options available as ZOOM-level options */
3499 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3501 if (!*initrs->result)
3503 Z_External *uif = initrs->userInformationField;
3505 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3507 if (uif && uif->which == Z_External_userInfo1)
3508 interpret_otherinformation_field(c, uif->u.userInfo1);
3512 const int *oid = yaz_string_to_oid(yaz_oid_std(),
3516 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
3518 xfree(c->cookie_in);
3521 c->cookie_in = xstrdup(cookie);
3522 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3523 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3524 c->support_named_resultsets = 1;
3527 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3528 ZOOM_connection_remove_task(c);
3530 ZOOM_connection_exec_task(c);
3532 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3534 NMEM tmpmem = nmem_create();
3535 Z_CharSetandLanguageNegotiation *p =
3536 yaz_get_charneg_record(initrs->otherInfo);
3540 char *charset = NULL, *lang = NULL;
3543 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3544 yaz_log(log_details, "%p recv_apdu target accepted: "
3545 "charset %s, language %s, select %d",
3547 charset ? charset : "none", lang ? lang : "none", sel);
3549 ZOOM_connection_option_set(c, "negotiation-charset",
3552 ZOOM_connection_option_set(c, "negotiation-lang",
3555 ZOOM_connection_option_set(
3556 c, "negotiation-charset-in-effect-for-records",
3557 (sel != 0) ? "1" : "0");
3558 nmem_destroy(tmpmem);
3562 case Z_APDU_searchResponse:
3563 yaz_log(log_api, "%p recv_apdu Search response", c);
3564 handle_search_response(c, apdu->u.searchResponse);
3565 if (send_sort_present(c) == zoom_complete)
3566 ZOOM_connection_remove_task(c);
3568 case Z_APDU_presentResponse:
3569 yaz_log(log_api, "%p recv_apdu Present response", c);
3570 handle_present_response(c, apdu->u.presentResponse);
3571 if (send_present(c) == zoom_complete)
3572 ZOOM_connection_remove_task(c);
3574 case Z_APDU_sortResponse:
3575 yaz_log(log_api, "%p recv_apdu Sort response", c);
3576 sort_response(c, apdu->u.sortResponse);
3577 if (send_present(c) == zoom_complete)
3578 ZOOM_connection_remove_task(c);
3580 case Z_APDU_scanResponse:
3581 yaz_log(log_api, "%p recv_apdu Scan response", c);
3582 scan_response(c, apdu->u.scanResponse);
3583 ZOOM_connection_remove_task(c);
3585 case Z_APDU_extendedServicesResponse:
3586 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3587 es_response(c, apdu->u.extendedServicesResponse);
3588 ZOOM_connection_remove_task(c);
3591 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3592 if (!ZOOM_test_reconnect(c))
3594 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3599 yaz_log(log_api, "%p Received unknown PDU", c);
3600 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3606 static void handle_srw_response(ZOOM_connection c,
3607 Z_SRW_searchRetrieveResponse *res)
3609 ZOOM_resultset resultset = 0;
3614 const char *syntax, *elementSetName;
3619 switch(c->tasks->which)
3621 case ZOOM_TASK_SEARCH:
3622 resultset = c->tasks->u.search.resultset;
3623 start = &c->tasks->u.search.start;
3624 syntax = c->tasks->u.search.syntax;
3625 elementSetName = c->tasks->u.search.elementSetName;
3627 case ZOOM_TASK_RETRIEVE:
3628 resultset = c->tasks->u.retrieve.resultset;
3629 start = &c->tasks->u.retrieve.start;
3630 syntax = c->tasks->u.retrieve.syntax;
3631 elementSetName = c->tasks->u.retrieve.elementSetName;
3636 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3637 ZOOM_connection_put_event(c, event);
3639 resultset->size = 0;
3641 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3643 if (res->numberOfRecords)
3644 resultset->size = *res->numberOfRecords;
3646 for (i = 0; i<res->num_records; i++)
3650 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3651 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3653 if (res->records[i].recordPosition &&
3654 *res->records[i].recordPosition > 0)
3655 pos = *res->records[i].recordPosition - 1;
3659 npr->databaseName = 0;
3660 npr->which = Z_NamePlusRecord_databaseRecord;
3661 npr->u.databaseRecord = (Z_External *)
3662 odr_malloc(c->odr_in, sizeof(Z_External));
3663 npr->u.databaseRecord->descriptor = 0;
3664 npr->u.databaseRecord->direct_reference =
3665 yaz_string_to_oid_odr(yaz_oid_std(), CLASS_RECSYN, OID_STR_XML,
3667 npr->u.databaseRecord->which = Z_External_octet;
3669 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3670 odr_malloc(c->odr_in, sizeof(Odr_oct));
3671 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3672 res->records[i].recordData_buf;
3673 npr->u.databaseRecord->u.octet_aligned->len =
3674 npr->u.databaseRecord->u.octet_aligned->size =
3675 res->records[i].recordData_len;
3676 record_cache_add(resultset, npr, pos, syntax, elementSetName);
3678 if (res->num_diagnostics > 0)
3680 const char *uri = res->diagnostics[0].uri;
3685 if ((cp = strrchr(uri, '/')))
3687 set_dset_error(c, code, uri,
3688 res->diagnostics[0].details, 0);
3691 nmem = odr_extract_mem(c->odr_in);
3692 nmem_transfer(odr_getmem(resultset->odr), nmem);
3698 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3701 const char *content_type = z_HTTP_header_lookup(hres->headers,
3703 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3705 ZOOM_connection_set_mask(c, 0);
3706 yaz_log(log_details, "%p handle_http", c);
3708 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3710 Z_SOAP *soap_package = 0;
3712 Z_SOAP_Handler soap_handlers[2] = {
3713 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
3716 ret = z_soap_codec(o, &soap_package,
3717 &hres->content_buf, &hres->content_len,
3719 if (!ret && soap_package->which == Z_SOAP_generic &&
3720 soap_package->u.generic->no == 0)
3722 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3723 if (sr->which == Z_SRW_searchRetrieve_response)
3724 handle_srw_response(c, sr->u.response);
3728 else if (!ret && (soap_package->which == Z_SOAP_fault
3729 || soap_package->which == Z_SOAP_error))
3731 set_HTTP_error(c, hres->code,
3732 soap_package->u.fault->fault_code,
3733 soap_package->u.fault->fault_string);
3740 if (hres->code != 200)
3741 set_HTTP_error(c, hres->code, 0, 0);
3743 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3746 ZOOM_connection_remove_task(c);
3747 if (!strcmp(hres->version, "1.0"))
3749 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3750 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3755 /* HTTP 1.1: only if no close we stay alive .. */
3756 if (connection_head && !strcmp(connection_head, "close"))
3762 static int do_read(ZOOM_connection c)
3767 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3768 ZOOM_connection_put_event(c, event);
3770 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3771 more = cs_more(c->cs);
3772 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3777 if (!ZOOM_test_reconnect(c))
3779 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3788 odr_reset(c->odr_in);
3789 odr_setbuf(c->odr_in, c->buf_in, r, 0);
3790 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3791 ZOOM_connection_put_event(c, event);
3793 if (!z_GDU(c->odr_in, &gdu, 0, 0))
3796 int err = odr_geterrorx(c->odr_in, &x);
3798 const char *element = odr_getelement(c->odr_in);
3799 sprintf(msg, "ODR code %d:%d element=%-20s",
3800 err, x, element ? element : "<unknown>");
3801 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3804 else if (gdu->which == Z_GDU_Z3950)
3805 recv_apdu(c, gdu->u.z3950);
3806 else if (gdu->which == Z_GDU_HTTP_Response)
3809 handle_http(c, gdu->u.HTTP_Response);
3811 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3815 c->reconnect_ok = 0;
3820 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3825 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3826 ZOOM_connection_put_event(c, event);
3828 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3829 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3831 yaz_log(log_details, "%p do_write_ex write failed", c);
3832 if (ZOOM_test_reconnect(c))
3834 return zoom_pending;
3836 if (c->state == STATE_CONNECTING)
3837 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3839 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3841 return zoom_complete;
3845 int mask = ZOOM_SELECT_EXCEPT;
3846 if (c->cs->io_pending & CS_WANT_WRITE)
3847 mask += ZOOM_SELECT_WRITE;
3848 if (c->cs->io_pending & CS_WANT_READ)
3849 mask += ZOOM_SELECT_READ;
3850 ZOOM_connection_set_mask(c, mask);
3851 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3856 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
3857 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3860 return zoom_pending;
3863 static zoom_ret do_write(ZOOM_connection c)
3865 return do_write_ex(c, c->buf_out, c->len_out);
3869 ZOOM_API(const char *)
3870 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3872 return ZOOM_options_get(c->options, key);
3875 ZOOM_API(const char *)
3876 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3878 return ZOOM_options_getl(c->options, key, lenp);
3882 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3885 ZOOM_options_set(c->options, key, val);
3889 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3890 const char *val, int len)
3892 ZOOM_options_setl(c->options, key, val, len);
3895 ZOOM_API(const char *)
3896 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3898 return ZOOM_options_get(r->options, key);
3902 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3905 ZOOM_options_set(r->options, key, val);
3910 ZOOM_connection_errcode(ZOOM_connection c)
3912 return ZOOM_connection_error(c, 0, 0);
3915 ZOOM_API(const char *)
3916 ZOOM_connection_errmsg(ZOOM_connection c)
3919 ZOOM_connection_error(c, &msg, 0);
3923 ZOOM_API(const char *)
3924 ZOOM_connection_addinfo(ZOOM_connection c)
3926 const char *addinfo;
3927 ZOOM_connection_error(c, 0, &addinfo);
3931 ZOOM_API(const char *)
3932 ZOOM_connection_diagset(ZOOM_connection c)
3934 const char *diagset;
3935 ZOOM_connection_error_x(c, 0, 0, &diagset);
3939 ZOOM_API(const char *)
3940 ZOOM_diag_str(int error)
3944 case ZOOM_ERROR_NONE:
3946 case ZOOM_ERROR_CONNECT:
3947 return "Connect failed";
3948 case ZOOM_ERROR_MEMORY:
3949 return "Out of memory";
3950 case ZOOM_ERROR_ENCODE:
3951 return "Encoding failed";
3952 case ZOOM_ERROR_DECODE:
3953 return "Decoding failed";
3954 case ZOOM_ERROR_CONNECTION_LOST:
3955 return "Connection lost";
3956 case ZOOM_ERROR_INIT:
3957 return "Init rejected";
3958 case ZOOM_ERROR_INTERNAL:
3959 return "Internal failure";
3960 case ZOOM_ERROR_TIMEOUT:
3962 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3963 return "Unsupported protocol";
3964 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3965 return "Unsupported query type";
3966 case ZOOM_ERROR_INVALID_QUERY:
3967 return "Invalid query";
3968 case ZOOM_ERROR_CQL_PARSE:
3969 return "CQL parsing error";
3970 case ZOOM_ERROR_CQL_TRANSFORM:
3971 return "CQL transformation error";
3972 case ZOOM_ERROR_CCL_CONFIG:
3973 return "CCL configuration error";
3974 case ZOOM_ERROR_CCL_PARSE:
3975 return "CCL parsing error";
3977 return diagbib1_str(error);
3982 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
3983 const char **addinfo, const char **diagset)
3985 int error = c->error;
3988 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3989 *cp = ZOOM_diag_str(error);
3990 else if (!strcmp(c->diagset, "HTTP"))
3991 *cp = z_HTTP_errmsg(c->error);
3992 else if (!strcmp(c->diagset, "Bib-1"))
3993 *cp = ZOOM_diag_str(error);
3994 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3995 *cp = yaz_diag_srw_str(c->error);
3997 *cp = "Unknown error and diagnostic set";
4000 *addinfo = c->addinfo ? c->addinfo : "";
4002 *diagset = c->diagset ? c->diagset : "";
4007 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4008 const char **addinfo)
4010 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4013 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4015 ZOOM_Event event = 0;
4016 int r = cs_look(c->cs);
4017 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4022 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4023 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4025 ZOOM_connection_put_event(c, event);
4027 else if (r == CS_CONNECT)
4029 int ret = ret = cs_rcvconnect(c->cs);
4030 yaz_log(log_details, "%p ZOOM_connection_do_io "
4031 "cs_rcvconnect returned %d", c, ret);
4034 int mask = ZOOM_SELECT_EXCEPT;
4035 if (c->cs->io_pending & CS_WANT_WRITE)
4036 mask += ZOOM_SELECT_WRITE;
4037 if (c->cs->io_pending & CS_WANT_READ)
4038 mask += ZOOM_SELECT_READ;
4039 ZOOM_connection_set_mask(c, mask);
4043 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4044 ZOOM_connection_put_event(c, event);
4046 if (c->proto == PROTO_Z3950)
4047 ZOOM_connection_send_init(c);
4050 /* no init request for SRW .. */
4051 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4052 ZOOM_connection_remove_task(c);
4053 ZOOM_connection_set_mask(c, 0);
4054 ZOOM_connection_exec_task(c);
4056 c->state = STATE_ESTABLISHED;
4060 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4066 if (mask & ZOOM_SELECT_EXCEPT)
4068 if (!ZOOM_test_reconnect(c))
4070 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4075 if (mask & ZOOM_SELECT_READ)
4077 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4083 ZOOM_connection_last_event(ZOOM_connection cs)
4086 return ZOOM_EVENT_NONE;
4087 return cs->last_event;
4091 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4093 WRBUF wrbuf = client_data;
4094 wrbuf_puts(wrbuf, buf);
4098 * Returns an xmalloc()d string containing RPN that corresponds to the
4099 * CQL passed in. On error, sets the Connection object's error state
4100 * and returns a null pointer.
4101 * ### We could cache CQL parser and/or transformer in Connection.
4103 static char *cql2pqf(ZOOM_connection c, const char *cql)
4107 const char *cqlfile;
4108 cql_transform_t trans;
4111 parser = cql_parser_create();
4112 if ((error = cql_parser_string(parser, cql)) != 0) {
4113 cql_parser_destroy(parser);
4114 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4118 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4121 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4123 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4126 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4127 cqlfile, strerror(errno));
4128 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4132 WRBUF wrbuf_result = wrbuf_alloc();
4133 error = cql_transform(trans, cql_parser_result(parser),
4134 cql2pqf_wrbuf_puts, wrbuf_result);
4137 const char *addinfo;
4138 error = cql_transform_error(trans, &addinfo);
4139 sprintf(buf, "%.200s (addinfo=%.200s)",
4140 cql_strerror(error), addinfo);
4141 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4145 result = xstrdup(wrbuf_cstr(wrbuf_result));
4147 cql_transform_close(trans);
4148 wrbuf_destroy(wrbuf_result);
4150 cql_parser_destroy(parser);
4154 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4158 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4159 /* timeout and this connection was waiting */
4160 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4162 ZOOM_connection_put_event(c, event);
4168 ZOOM_connection_process(ZOOM_connection c)
4174 event = ZOOM_connection_get_event(c);
4177 ZOOM_Event_destroy(event);
4180 ZOOM_connection_exec_task(c);
4181 event = ZOOM_connection_get_event(c);
4184 ZOOM_Event_destroy(event);
4191 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4195 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4197 for (i = 0; i<no; i++)
4199 ZOOM_connection c = cs[i];
4201 if (c && ZOOM_connection_process(c))
4207 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4209 if (c->mask && mask)
4210 ZOOM_connection_do_io(c, mask);
4214 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4217 return cs_fileno(c->cs);
4221 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4229 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4236 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4238 return ZOOM_options_get_int(c->options, "timeout", 30);
4244 * indent-tabs-mode: nil
4246 * vim: shiftwidth=4 tabstop=8 expandtab