2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.105 2007-01-09 13:56:48 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 zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
39 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
40 static char *cql2pqf(ZOOM_connection c, const char *cql);
42 static void initlog(void)
44 static int log_level_initialized = 0;
45 if (!log_level_initialized)
47 log_api = yaz_log_module_level("zoom");
48 log_details = yaz_log_module_level("zoomdetails");
49 log_level_initialized = 1;
53 static ZOOM_Event ZOOM_Event_create(int kind)
55 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
59 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
63 static void ZOOM_Event_destroy(ZOOM_Event event)
68 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
72 c->m_queue_back->prev = event;
73 assert(c->m_queue_front);
77 assert(!c->m_queue_front);
78 c->m_queue_front = event;
80 event->next = c->m_queue_back;
82 c->m_queue_back = event;
85 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
87 ZOOM_Event event = c->m_queue_front;
90 c->last_event = ZOOM_EVENT_NONE;
93 assert(c->m_queue_back);
94 c->m_queue_front = event->prev;
97 assert(c->m_queue_back);
98 c->m_queue_front->next = 0;
102 c->last_event = event->kind;
107 static void set_dset_error(ZOOM_connection c, int error,
109 const char *addinfo, const char *addinfo2)
116 if (!c->diagset || strcmp(dset, c->diagset))
119 c->diagset = xstrdup(dset);
120 /* remove integer part from SRW diagset .. */
121 if ((cp = strrchr(c->diagset, '/')))
124 if (addinfo && addinfo2)
126 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
127 strcpy(c->addinfo, addinfo);
128 strcat(c->addinfo, addinfo2);
131 c->addinfo = xstrdup(addinfo);
133 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
134 c, c->host_port ? c->host_port : "<>", dset, error,
135 addinfo ? addinfo : "",
136 addinfo2 ? addinfo2 : "");
140 static void set_HTTP_error(ZOOM_connection c, int error,
141 const char *addinfo, const char *addinfo2)
143 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
147 static void set_ZOOM_error(ZOOM_connection c, int error,
150 set_dset_error(c, error, "ZOOM", addinfo, 0);
153 static void clear_error(ZOOM_connection c)
156 * If an error is tied to an operation then it's ok to clear: for
157 * example, a diagnostic returned from a search is cleared by a
158 * subsequent search. However, problems such as Connection Lost
159 * or Init Refused are not cleared, because they are not
160 * recoverable: doing another search doesn't help.
164 case ZOOM_ERROR_CONNECT:
165 case ZOOM_ERROR_MEMORY:
166 case ZOOM_ERROR_DECODE:
167 case ZOOM_ERROR_CONNECTION_LOST:
168 case ZOOM_ERROR_INIT:
169 case ZOOM_ERROR_INTERNAL:
170 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
173 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
177 void ZOOM_connection_show_task(ZOOM_task task)
181 case ZOOM_TASK_SEARCH:
182 yaz_log(YLOG_LOG, "search p=%p", task);
184 case ZOOM_TASK_RETRIEVE:
185 yaz_log(YLOG_LOG, "retrieve p=%p", task);
187 case ZOOM_TASK_CONNECT:
188 yaz_log(YLOG_LOG, "connect p=%p", task);
191 yaz_log(YLOG_LOG, "scant p=%p", task);
196 void ZOOM_connection_show_tasks(ZOOM_connection c)
199 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
200 for (task = c->tasks; task; task = task->next)
201 ZOOM_connection_show_task(task);
204 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
206 ZOOM_task *taskp = &c->tasks;
208 taskp = &(*taskp)->next;
209 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
210 (*taskp)->running = 0;
211 (*taskp)->which = which;
217 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
219 return c->tasks ? 0 : 1;
222 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
224 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
226 task->next = c->tasks;
235 void ZOOM_connection_remove_task(ZOOM_connection c)
237 ZOOM_task task = c->tasks;
241 c->tasks = task->next;
244 case ZOOM_TASK_SEARCH:
245 ZOOM_resultset_destroy(task->u.search.resultset);
246 xfree(task->u.search.syntax);
247 xfree(task->u.search.elementSetName);
249 case ZOOM_TASK_RETRIEVE:
250 ZOOM_resultset_destroy(task->u.retrieve.resultset);
251 xfree(task->u.retrieve.syntax);
252 xfree(task->u.retrieve.elementSetName);
254 case ZOOM_TASK_CONNECT:
257 ZOOM_scanset_destroy(task->u.scan.scan);
259 case ZOOM_TASK_PACKAGE:
260 ZOOM_package_destroy(task->u.package);
263 ZOOM_resultset_destroy(task->u.sort.resultset);
264 ZOOM_query_destroy(task->u.sort.q);
273 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
274 ZOOM_connection_put_event(c, event);
279 static int ZOOM_connection_exec_task(ZOOM_connection c);
281 void ZOOM_connection_remove_tasks(ZOOM_connection c)
284 ZOOM_connection_remove_task(c);
287 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
289 const char *elementSetName);
291 ZOOM_API(ZOOM_connection)
292 ZOOM_connection_create(ZOOM_options options)
294 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
298 yaz_log(log_api, "%p ZOOM_connection_create", c);
300 c->proto = PROTO_Z3950;
302 ZOOM_connection_set_mask(c, 0);
304 c->state = STATE_IDLE;
307 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
314 c->options = ZOOM_options_create_with_parent(options);
320 c->charset = c->lang = 0;
327 c->odr_in = odr_createmem(ODR_DECODE);
328 c->odr_out = odr_createmem(ODR_ENCODE);
331 c->support_named_resultsets = 0;
332 c->last_event = ZOOM_EVENT_NONE;
334 c->m_queue_front = 0;
340 /* set database names. Take local databases (if set); otherwise
341 take databases given in ZURL (if set); otherwise use Default */
342 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
345 char **databaseNames;
346 const char *cp = ZOOM_options_get(options, "databaseName");
348 if ((!cp || !*cp) && con->host_port)
350 if (strncmp(con->host_port, "unix:", 5) == 0)
351 cp = strchr(con->host_port+5, ':');
353 cp = strchr(con->host_port, '/');
359 nmem_strsplit(odr->mem, "+", cp, &databaseNames, num);
360 return databaseNames;
363 ZOOM_API(ZOOM_connection)
364 ZOOM_connection_new(const char *host, int portnum)
366 ZOOM_connection c = ZOOM_connection_create(0);
368 ZOOM_connection_connect(c, host, portnum);
372 static zoom_sru_mode get_sru_mode_from_string(const char *s)
375 return zoom_sru_soap;
376 if (!yaz_matchstr(s, "soap"))
377 return zoom_sru_soap;
378 else if (!yaz_matchstr(s, "get"))
380 else if (!yaz_matchstr(s, "post"))
381 return zoom_sru_post;
382 return zoom_sru_error;
386 ZOOM_connection_connect(ZOOM_connection c,
387 const char *host, int portnum)
394 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
397 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
398 ZOOM_connection_remove_tasks(c);
402 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
406 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
408 val = ZOOM_options_get(c->options, "proxy");
411 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
412 c->proxy = xstrdup(val);
418 val = ZOOM_options_get(c->options, "charset");
421 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
422 c->charset = xstrdup(val);
428 val = ZOOM_options_get(c->options, "lang");
431 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
432 c->lang = xstrdup(val);
441 sprintf(hostn, "%.80s:%d", host, portnum);
442 c->host_port = xstrdup(hostn);
445 c->host_port = xstrdup(host);
449 * If the "<scheme>:" part of the host string is preceded by one
450 * or more comma-separated <name>=<value> pairs, these are taken
451 * to be options to be set on the connection object. Among other
452 * applications, this facility can be used to embed authentication
454 * user=admin,password=secret,tcp:localhost:9999
456 char *remainder = c->host_port;
457 char *pcolon = strchr(remainder, ':');
460 while ((pcomma = strchr(remainder, ',')) != 0 &&
461 (pcolon == 0 || pcomma < pcolon)) {
463 if ((pequals = strchr(remainder, '=')) != 0) {
465 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
466 ZOOM_connection_option_set(c, remainder, pequals+1);
468 remainder = pcomma+1;
471 if (remainder != c->host_port) {
473 c->host_port = xstrdup(remainder);
474 /*printf("# reset hp='%s'\n", remainder);*/
478 val = ZOOM_options_get(c->options, "sru");
479 c->sru_mode = get_sru_mode_from_string(val);
481 ZOOM_options_set(c->options, "host", c->host_port);
483 val = ZOOM_options_get(c->options, "cookie");
486 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
487 c->cookie_out = xstrdup(val);
490 val = ZOOM_options_get(c->options, "clientIP");
493 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
495 c->client_IP = xstrdup(val);
498 c->async = ZOOM_options_get_bool(c->options, "async", 0);
499 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
501 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
505 while (ZOOM_event(1, &c))
511 ZOOM_query_create(void)
513 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
515 yaz_log(log_details, "%p ZOOM_query_create", s);
519 s->odr = odr_createmem(ODR_ENCODE);
526 ZOOM_query_destroy(ZOOM_query s)
532 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
533 if (s->refcount == 0)
541 ZOOM_query_prefix(ZOOM_query s, const char *str)
543 s->query_string = odr_strdup(s->odr, str);
544 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
545 s->z_query->which = Z_Query_type_1;
546 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
547 if (!s->z_query->u.type_1)
549 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
553 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
558 ZOOM_query_cql(ZOOM_query s, const char *str)
562 s->query_string = odr_strdup(s->odr, str);
564 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
565 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
566 ext->indirect_reference = 0;
568 ext->which = Z_External_CQL;
569 ext->u.cql = s->query_string;
571 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
572 s->z_query->which = Z_Query_type_104;
573 s->z_query->u.type_104 = ext;
575 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
581 * Translate the CQL string client-side into RPN which is passed to
582 * the server. This is useful for server's that don't themselves
583 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
584 * only as a place to stash diagnostics if compilation fails; if this
585 * information is not needed, a null pointer may be used.
588 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
592 ZOOM_connection freeme = 0;
594 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
596 conn = freeme = ZOOM_connection_create(0);
598 rpn = cql2pqf(conn, str);
600 ZOOM_connection_destroy(freeme);
604 ret = ZOOM_query_prefix(s, rpn);
610 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
611 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
612 * to the server, as the YAZ GFS doesn't know how to handle this.
615 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
616 int *ccl_error, const char **error_string,
620 struct ccl_rpn_node *rpn;
621 CCL_bibset bibset = ccl_qual_mk();
624 ccl_qual_buf(bibset, config);
626 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
629 *error_string = ccl_err_msg(*ccl_error);
634 WRBUF wr = wrbuf_alloc();
637 ret = ZOOM_query_prefix(s, wrbuf_buf(wr));
640 ccl_qual_rm(&bibset);
645 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
647 s->sort_spec = yaz_sort_spec(s->odr, criteria);
650 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
654 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
658 static zoom_ret do_write(ZOOM_connection c);
661 ZOOM_connection_destroy(ZOOM_connection c)
666 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
669 for (r = c->resultsets; r; r = r->next)
675 odr_destroy(c->odr_in);
676 odr_destroy(c->odr_out);
677 ZOOM_options_destroy(c->options);
678 ZOOM_connection_remove_tasks(c);
684 xfree(c->cookie_out);
690 void ZOOM_resultset_addref(ZOOM_resultset r)
695 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
700 ZOOM_resultset ZOOM_resultset_create(void)
703 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
707 yaz_log(log_details, "%p ZOOM_resultset_create", r);
710 r->odr = odr_createmem(ODR_ENCODE);
715 for (i = 0; i<RECORD_HASH_SIZE; i++)
716 r->record_hash[i] = 0;
721 r->databaseNames = 0;
722 r->num_databaseNames = 0;
726 ZOOM_API(ZOOM_resultset)
727 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
730 ZOOM_query s = ZOOM_query_create();
732 ZOOM_query_prefix(s, q);
734 r = ZOOM_connection_search(c, s);
735 ZOOM_query_destroy(s);
739 ZOOM_API(ZOOM_resultset)
740 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
742 ZOOM_resultset r = ZOOM_resultset_create();
746 const char *syntax, *elementSetName;
748 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
749 r->r_sort_spec = q->sort_spec;
752 r->options = ZOOM_options_create_with_parent(c->options);
754 start = ZOOM_options_get_int(r->options, "start", 0);
755 count = ZOOM_options_get_int(r->options, "count", 0);
757 /* If "presentChunk" is defined use that; otherwise "step" */
758 const char *cp = ZOOM_options_get(r->options, "presentChunk");
759 r->step = ZOOM_options_get_int(r->options,
760 (cp != 0 ? "presentChunk": "step"), 0);
762 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
763 cp = ZOOM_options_get(r->options, "setname");
765 r->setname = xstrdup(cp);
766 cp = ZOOM_options_get(r->options, "schema");
768 r->schema = xstrdup(cp);
770 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
775 r->next = c->resultsets;
778 if (c->host_port && c->proto == PROTO_HTTP)
782 yaz_log(log_details, "ZOOM_connection_search: no comstack");
783 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
787 yaz_log(log_details, "ZOOM_connection_search: reconnect");
792 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
793 task->u.search.resultset = r;
794 task->u.search.start = start;
795 task->u.search.count = count;
797 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
798 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
799 elementSetName = ZOOM_options_get(r->options, "elementSetName");
800 task->u.search.elementSetName = elementSetName
801 ? xstrdup(elementSetName) : 0;
803 ZOOM_resultset_addref(r);
809 while (ZOOM_event(1, &c))
816 * This is the old result-set sorting API, which is maintained only
817 * for the sake of binary compatibility. There is no reason ever to
818 * use this rather than ZOOM_resultset_sort1().
821 ZOOM_resultset_sort(ZOOM_resultset r,
822 const char *sort_type, const char *sort_spec)
824 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
828 ZOOM_resultset_sort1(ZOOM_resultset r,
829 const char *sort_type, const char *sort_spec)
831 ZOOM_connection c = r->connection;
835 newq = ZOOM_query_create();
836 if (ZOOM_query_sortby(newq, sort_spec) < 0)
839 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
840 r, r, sort_type, sort_spec);
844 if (c->host_port && c->proto == PROTO_HTTP)
848 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
849 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
853 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
859 ZOOM_resultset_cache_reset(r);
860 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
861 task->u.sort.resultset = r;
862 task->u.sort.q = newq;
864 ZOOM_resultset_addref(r);
868 while (ZOOM_event(1, &c))
876 ZOOM_resultset_cache_reset(ZOOM_resultset r)
879 for (i = 0; i<RECORD_HASH_SIZE; i++)
881 ZOOM_record_cache rc;
882 for (rc = r->record_hash[i]; rc; rc = rc->next)
884 if (rc->rec.wrbuf_marc)
885 wrbuf_free(rc->rec.wrbuf_marc, 1);
886 if (rc->rec.wrbuf_iconv)
887 wrbuf_free(rc->rec.wrbuf_iconv, 1);
888 if (rc->rec.wrbuf_opac)
889 wrbuf_free(rc->rec.wrbuf_opac, 1);
891 r->record_hash[i] = 0;
896 ZOOM_resultset_destroy(ZOOM_resultset r)
901 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
903 if (r->refcount == 0)
905 ZOOM_resultset_cache_reset(r);
909 /* remove ourselves from the resultsets in connection */
910 ZOOM_resultset *rp = &r->connection->resultsets;
913 assert(*rp); /* we must be in this list!! */
915 { /* OK, we're here - take us out of it */
922 ZOOM_query_destroy(r->query);
923 ZOOM_options_destroy(r->options);
932 ZOOM_resultset_size(ZOOM_resultset r)
934 yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
939 static void do_close(ZOOM_connection c)
944 ZOOM_connection_set_mask(c, 0);
945 c->state = STATE_IDLE;
948 static int ZOOM_test_reconnect(ZOOM_connection c)
950 if (!c->reconnect_ok)
954 c->tasks->running = 0;
955 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
959 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
960 int force_sync, int start, int count)
965 const char *syntax, *elementSetName;
969 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
970 " count=%d", r, force_sync, start, count);
975 if (c->host_port && c->proto == PROTO_HTTP)
979 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
980 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
984 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
989 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
990 task->u.retrieve.resultset = r;
991 task->u.retrieve.start = start;
992 task->u.retrieve.count = count;
994 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
995 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
996 elementSetName = ZOOM_options_get(r->options, "elementSetName");
997 task->u.retrieve.elementSetName = elementSetName
998 ? xstrdup(elementSetName) : 0;
1000 cp = ZOOM_options_get(r->options, "schema");
1003 if (!r->schema || strcmp(r->schema, cp))
1006 r->schema = xstrdup(cp);
1010 ZOOM_resultset_addref(r);
1012 if (!r->connection->async || force_sync)
1013 while (r->connection && ZOOM_event(1, &r->connection))
1018 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1019 size_t start, size_t count)
1021 int force_present = 0;
1025 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1026 r, r, (long) start, (long) count);
1029 ZOOM_resultset_retrieve(r, force_present, start, count);
1033 for (i = 0; i< count; i++)
1034 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1038 static void get_cert(ZOOM_connection c)
1043 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1045 ZOOM_connection_option_setl(c, "sslPeerCert",
1046 cert_buf, cert_len);
1051 static zoom_ret do_connect(ZOOM_connection c)
1054 const char *effective_host;
1057 effective_host = c->proxy;
1059 effective_host = c->host_port;
1061 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1065 c->cs = cs_create_host(effective_host, 0, &add);
1067 if (c->cs && c->cs->protocol == PROTO_HTTP)
1070 const char *path = 0;
1072 c->proto = PROTO_HTTP;
1073 cs_get_host_args(c->host_port, &path);
1075 c->path = (char*) xmalloc(strlen(path)+2);
1077 strcpy(c->path+1, path);
1079 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1081 return zoom_complete;
1086 int ret = cs_connect(c->cs, add);
1089 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1090 ZOOM_connection_put_event(c, event);
1092 if (c->proto == PROTO_Z3950)
1093 ZOOM_connection_send_init(c);
1096 /* no init request for SRW .. */
1097 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1098 ZOOM_connection_remove_task(c);
1099 ZOOM_connection_set_mask(c, 0);
1100 ZOOM_connection_exec_task(c);
1102 c->state = STATE_ESTABLISHED;
1103 return zoom_pending;
1107 int mask = ZOOM_SELECT_EXCEPT;
1108 if (c->cs->io_pending & CS_WANT_WRITE)
1109 mask += ZOOM_SELECT_WRITE;
1110 if (c->cs->io_pending & CS_WANT_READ)
1111 mask += ZOOM_SELECT_READ;
1112 ZOOM_connection_set_mask(c, mask);
1113 c->state = STATE_CONNECTING;
1114 return zoom_pending;
1117 c->state = STATE_IDLE;
1118 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1119 return zoom_complete;
1122 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1125 for (i = 0; i<200; i++)
1128 Z_OtherInformation **oi;
1134 sprintf(buf, "otherInfo%d", i);
1135 val = ZOOM_options_get(c->options, buf);
1138 cp = strchr(val, ':');
1142 if (len >= sizeof(buf))
1143 len = sizeof(buf)-1;
1144 memcpy(buf, val, len);
1146 oidval = oid_getvalbyname(buf);
1147 if (oidval == VAL_NONE)
1150 yaz_oi_APDU(a, &oi);
1151 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1155 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1160 Z_OtherInformation **oi;
1161 yaz_oi_APDU(a, &oi);
1162 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1166 Z_OtherInformation **oi;
1167 yaz_oi_APDU(a, &oi);
1168 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1170 otherInfo_attach(c, a, out);
1171 if (!z_APDU(out, &a, 0, 0))
1173 FILE *outf = fopen("/tmp/apdu.txt", "a");
1176 ODR odr_pr = odr_createmem(ODR_PRINT);
1177 fprintf(outf, "a=%p\n", a);
1178 odr_setprint(odr_pr, outf);
1179 z_APDU(odr_pr, &a, 0, 0);
1180 odr_destroy(odr_pr);
1182 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1183 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1187 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1191 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1195 if (encode_APDU(c, a, c->odr_out))
1196 return zoom_complete;
1197 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1198 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1199 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1200 ZOOM_connection_put_event(c, event);
1201 odr_reset(c->odr_out);
1205 /* returns 1 if PDU was sent OK (still pending )
1206 0 if PDU was not sent OK (nothing to wait for)
1209 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1211 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1212 Z_InitRequest *ireq = apdu->u.initRequest;
1213 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1214 odr_malloc(c->odr_out, sizeof(*auth));
1215 const char *auth_groupId = ZOOM_options_get(c->options, "group");
1216 const char *auth_userId = ZOOM_options_get(c->options, "user");
1217 const char *auth_password = ZOOM_options_get(c->options, "password");
1220 /* support the pass for backwards compatibility */
1222 auth_password = ZOOM_options_get(c->options, "pass");
1224 ODR_MASK_SET(ireq->options, Z_Options_search);
1225 ODR_MASK_SET(ireq->options, Z_Options_present);
1226 ODR_MASK_SET(ireq->options, Z_Options_scan);
1227 ODR_MASK_SET(ireq->options, Z_Options_sort);
1228 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1229 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1231 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1232 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1233 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1235 /* Index Data's Z39.50 Implementor Id is 81 */
1236 ireq->implementationId =
1237 odr_prepend(c->odr_out,
1238 ZOOM_options_get(c->options, "implementationId"),
1239 odr_prepend(c->odr_out, "81", ireq->implementationId));
1241 ireq->implementationName =
1242 odr_prepend(c->odr_out,
1243 ZOOM_options_get(c->options, "implementationName"),
1244 odr_prepend(c->odr_out, "ZOOM-C",
1245 ireq->implementationName));
1247 version = odr_strdup(c->odr_out, "$Revision: 1.105 $");
1248 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1249 version[strlen(version)-2] = '\0';
1250 ireq->implementationVersion =
1251 odr_prepend(c->odr_out,
1252 ZOOM_options_get(c->options, "implementationVersion"),
1253 odr_prepend(c->odr_out, &version[11],
1254 ireq->implementationVersion));
1256 *ireq->maximumRecordSize =
1257 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
1258 *ireq->preferredMessageSize =
1259 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
1261 if (auth_groupId || auth_password)
1263 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1266 if (auth_groupId && *auth_groupId)
1268 pass->groupId = (char *)
1269 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1270 strcpy(pass->groupId, auth_groupId);
1274 if (auth_userId && *auth_userId)
1276 pass->userId = (char *)
1277 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1278 strcpy(pass->userId, auth_userId);
1282 if (auth_password && *auth_password)
1284 pass->password = (char *)
1285 odr_malloc(c->odr_out, strlen(auth_password)+1);
1286 strcpy(pass->password, auth_password);
1291 auth->which = Z_IdAuthentication_idPass;
1292 auth->u.idPass = pass;
1293 ireq->idAuthentication = auth;
1296 else if (auth_userId)
1298 auth->which = Z_IdAuthentication_open;
1299 auth->u.open = (char *)
1300 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1301 strcpy(auth->u.open, auth_userId);
1302 ireq->idAuthentication = auth;
1305 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1306 VAL_PROXY, 1, c->host_port);
1307 if (c->charset || c->lang)
1309 Z_OtherInformation **oi;
1310 Z_OtherInformationUnit *oi_unit;
1312 yaz_oi_APDU(apdu, &oi);
1314 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1316 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1317 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1318 oi_unit->information.externallyDefinedInfo =
1319 yaz_set_proposal_charneg_list(c->odr_out, " ",
1320 c->charset, c->lang, 1);
1324 return send_APDU(c, apdu);
1328 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1333 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1335 if (c->sru_mode == zoom_sru_get)
1337 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1339 else if (c->sru_mode == zoom_sru_post)
1341 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1343 else if (c->sru_mode == zoom_sru_soap)
1345 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1347 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1348 return zoom_complete;
1349 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1351 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1352 ZOOM_connection_put_event(c, event);
1353 odr_reset(c->odr_out);
1359 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1363 ZOOM_resultset resultset = 0;
1365 const char *option_val = 0;
1367 if (c->error) /* don't continue on error */
1368 return zoom_complete;
1370 switch(c->tasks->which)
1372 case ZOOM_TASK_SEARCH:
1373 resultset = c->tasks->u.search.resultset;
1374 resultset->setname = xstrdup("default");
1375 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1376 start = &c->tasks->u.search.start;
1377 count = &c->tasks->u.search.count;
1379 case ZOOM_TASK_RETRIEVE:
1380 resultset = c->tasks->u.retrieve.resultset;
1382 start = &c->tasks->u.retrieve.start;
1383 count = &c->tasks->u.retrieve.count;
1385 if (*start >= resultset->size)
1386 return zoom_complete;
1387 if (*start + *count > resultset->size)
1388 *count = resultset->size - *start;
1390 for (i = 0; i < *count; i++)
1393 record_cache_lookup(resultset, i + *start,
1394 c->tasks->u.retrieve.syntax,
1395 c->tasks->u.retrieve.elementSetName);
1400 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1401 ZOOM_connection_put_event(c, event);
1408 return zoom_complete;
1411 return zoom_complete;
1413 assert(resultset->query);
1415 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1417 if (resultset->query->z_query->which == Z_Query_type_104
1418 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1420 sr->u.request->query_type = Z_SRW_query_type_cql;
1421 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1423 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1424 resultset->query->z_query->u.type_1)
1426 sr->u.request->query_type = Z_SRW_query_type_pqf;
1427 sr->u.request->query.pqf = resultset->query->query_string;
1431 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1432 return zoom_complete;
1434 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1435 sr->u.request->maximumRecords = odr_intdup(
1436 c->odr_out, resultset->step>0 ? resultset->step : *count);
1437 sr->u.request->recordSchema = resultset->schema;
1439 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1441 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1443 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1445 sr->extra_args = odr_strdup(c->odr_out, option_val);
1446 return send_srw(c, sr);
1449 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1451 return zoom_complete;
1455 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1458 int lslb, ssub, mspn;
1460 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1461 Z_SearchRequest *search_req = apdu->u.searchRequest;
1462 const char *elementSetName;
1463 const char *smallSetElementSetName;
1464 const char *mediumSetElementSetName;
1467 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1469 r = c->tasks->u.search.resultset;
1471 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1474 ZOOM_options_get(r->options, "elementSetName");
1475 smallSetElementSetName =
1476 ZOOM_options_get(r->options, "smallSetElementSetName");
1477 mediumSetElementSetName =
1478 ZOOM_options_get(r->options, "mediumSetElementSetName");
1480 if (!smallSetElementSetName)
1481 smallSetElementSetName = elementSetName;
1483 if (!mediumSetElementSetName)
1484 mediumSetElementSetName = elementSetName;
1489 /* prepare query for the search request */
1490 search_req->query = r->query->z_query;
1491 if (!search_req->query)
1493 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1494 return zoom_complete;
1497 search_req->databaseNames = r->databaseNames;
1498 search_req->num_databaseNames = r->num_databaseNames;
1500 /* get syntax (no need to provide unless piggyback is in effect) */
1501 syntax = c->tasks->u.search.syntax;
1503 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1504 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1505 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1506 if (lslb != -1 && ssub != -1 && mspn != -1)
1508 /* So're a Z39.50 expert? Let's hope you don't do sort */
1509 *search_req->largeSetLowerBound = lslb;
1510 *search_req->smallSetUpperBound = ssub;
1511 *search_req->mediumSetPresentNumber = mspn;
1513 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1514 && r->piggyback && !r->r_sort_spec && !r->schema)
1516 /* Regular piggyback - do it unless we're going to do sort */
1517 *search_req->largeSetLowerBound = 2000000000;
1518 *search_req->smallSetUpperBound = 1;
1519 *search_req->mediumSetPresentNumber =
1520 r->step>0 ? r->step : c->tasks->u.search.count;
1524 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1525 smallSetElementSetName = 0;
1526 mediumSetElementSetName = 0;
1529 if (smallSetElementSetName && *smallSetElementSetName)
1531 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1532 odr_malloc(c->odr_out, sizeof(*esn));
1534 esn->which = Z_ElementSetNames_generic;
1535 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1536 search_req->smallSetElementSetNames = esn;
1538 if (mediumSetElementSetName && *mediumSetElementSetName)
1540 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1541 odr_malloc(c->odr_out, sizeof(*esn));
1543 esn->which = Z_ElementSetNames_generic;
1544 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1545 search_req->mediumSetElementSetNames = esn;
1548 search_req->preferredRecordSyntax =
1549 yaz_str_to_z3950oid(c->odr_out, CLASS_RECSYN, syntax);
1553 if (c->support_named_resultsets)
1557 /* find the lowest unused ordinal so that we re-use
1558 result sets on the server. */
1559 for (ord = 1; ; ord++)
1562 sprintf(setname, "%d", ord);
1563 for (rp = c->resultsets; rp; rp = rp->next)
1564 if (rp->setname && !strcmp(rp->setname, setname))
1569 r->setname = xstrdup(setname);
1570 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1571 "set %s", c, r->setname);
1575 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1577 r->setname = xstrdup("default");
1579 ZOOM_options_set(r->options, "setname", r->setname);
1581 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1582 return send_APDU(c, apdu);
1585 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1592 case Z_DefaultDiagFormat_v2Addinfo:
1593 addinfo = r->u.v2Addinfo;
1595 case Z_DefaultDiagFormat_v3Addinfo:
1596 addinfo = r->u.v3Addinfo;
1601 set_dset_error(c, *r->condition,
1602 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1606 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1608 if (p->which != Z_DiagRec_defaultFormat)
1609 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1611 response_default_diag(c, p->u.defaultFormat);
1614 ZOOM_API(ZOOM_record)
1615 ZOOM_record_clone(ZOOM_record srec)
1622 odr_enc = odr_createmem(ODR_ENCODE);
1623 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1625 buf = odr_getbuf(odr_enc, &size, 0);
1627 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1628 nrec->odr = odr_createmem(ODR_DECODE);
1629 nrec->wrbuf_marc = 0;
1630 nrec->wrbuf_iconv = 0;
1631 nrec->wrbuf_opac = 0;
1632 odr_setbuf(nrec->odr, buf, size, 0);
1633 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1635 odr_destroy(odr_enc);
1639 ZOOM_API(ZOOM_record)
1640 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1642 const char *syntax =
1643 ZOOM_options_get(s->options, "preferredRecordSyntax");
1644 const char *elementSetName =
1645 ZOOM_options_get(s->options, "elementSetName");
1647 return record_cache_lookup(s, pos, syntax, elementSetName);
1650 ZOOM_API(ZOOM_record)
1651 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1653 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1658 * MIKE: I think force_sync should always be zero, but I don't
1659 * want to make this change until I get the go-ahead from
1660 * Adam, in case something depends on the old synchronous
1664 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1665 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1666 rec = ZOOM_resultset_record_immediate(r, pos);
1672 ZOOM_record_destroy(ZOOM_record rec)
1676 if (rec->wrbuf_marc)
1677 wrbuf_free(rec->wrbuf_marc, 1);
1678 if (rec->wrbuf_iconv)
1679 wrbuf_free(rec->wrbuf_iconv, 1);
1680 if (rec->wrbuf_opac)
1681 wrbuf_free(rec->wrbuf_opac, 1);
1682 odr_destroy(rec->odr);
1686 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1688 const char *buf, int sz,
1689 const char *record_charset)
1694 yaz_marc_t mt = yaz_marc_create();
1697 strcpy(to, "UTF-8");
1698 if (record_charset && *record_charset)
1700 /* Use "from,to" or just "from" */
1701 const char *cp = strchr(record_charset, ',');
1702 int clen = strlen(record_charset);
1705 strncpy( to, cp+1, sizeof(to)-1);
1706 to[sizeof(to)-1] = '\0';
1707 clen = cp - record_charset;
1709 if (clen > sizeof(from)-1)
1710 clen = sizeof(from)-1;
1713 strncpy(from, record_charset, clen);
1719 cd = yaz_iconv_open(to, from);
1720 yaz_marc_iconv(mt, cd);
1723 yaz_marc_xml(mt, marc_type);
1724 if (!rec->wrbuf_marc)
1725 rec->wrbuf_marc = wrbuf_alloc();
1726 wrbuf_rewind(rec->wrbuf_marc);
1727 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1729 yaz_marc_destroy(mt);
1731 yaz_iconv_close(cd);
1733 *len = wrbuf_len(rec->wrbuf_marc);
1734 return wrbuf_buf(rec->wrbuf_marc);
1736 yaz_marc_destroy(mt);
1738 yaz_iconv_close(cd);
1742 static const char *record_iconv_return(ZOOM_record rec, int *len,
1743 const char *buf, int sz,
1744 const char *record_charset)
1751 strcpy(to, "UTF-8");
1752 if (record_charset && *record_charset)
1754 /* Use "from,to" or just "from" */
1755 const char *cp = strchr(record_charset, ',');
1756 int clen = strlen(record_charset);
1759 strncpy( to, cp+1, sizeof(to)-1);
1760 to[sizeof(to)-1] = '\0';
1761 clen = cp - record_charset;
1763 if (clen > sizeof(from)-1)
1764 clen = sizeof(from)-1;
1767 strncpy(from, record_charset, clen);
1771 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1774 size_t inbytesleft = sz;
1775 const char *inp = buf;
1777 if (!rec->wrbuf_iconv)
1778 rec->wrbuf_iconv = wrbuf_alloc();
1780 wrbuf_rewind(rec->wrbuf_iconv);
1784 size_t outbytesleft = sizeof(outbuf);
1785 char *outp = outbuf;
1786 size_t r = yaz_iconv(cd, (char**) &inp,
1788 &outp, &outbytesleft);
1789 if (r == (size_t) (-1))
1791 int e = yaz_iconv_error(cd);
1792 if (e != YAZ_ICONV_E2BIG)
1795 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1797 wrbuf_puts(rec->wrbuf_iconv, "");
1798 buf = wrbuf_buf(rec->wrbuf_iconv);
1799 sz = wrbuf_len(rec->wrbuf_iconv);
1800 yaz_iconv_close(cd);
1808 ZOOM_record_error(ZOOM_record rec, const char **cp,
1809 const char **addinfo, const char **diagset)
1811 Z_NamePlusRecord *npr;
1816 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1818 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1819 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1820 const char *add = 0;
1822 if (diag_rec->which == Z_DiagRec_defaultFormat)
1824 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1827 error = *ddf->condition;
1830 case Z_DefaultDiagFormat_v2Addinfo:
1831 add = ddf->u.v2Addinfo;
1833 case Z_DefaultDiagFormat_v3Addinfo:
1834 add = ddf->u.v3Addinfo;
1838 *diagset = yaz_z3950oid_to_str(ddf->diagnosticSetId, &oclass);
1846 *addinfo = add ? add : "";
1848 *cp = diagbib1_str(error);
1854 ZOOM_API(const char *)
1855 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1862 Z_NamePlusRecord *npr;
1865 *len = 0; /* default return */
1874 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1876 if (cp[i] == ';' || cp[i] == ' ')
1882 while (type_spec[i] == ';')
1885 while (type_spec[i] == ' ')
1887 if (!strncmp(type_spec+i, "charset=", 8))
1890 i = i + 8; /* skip charset= */
1891 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1893 if (type_spec[i] == ';' || type_spec[i] == ' ')
1899 else if (!strncmp(type_spec+i, "xpath=", 6))
1903 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1907 while (type_spec[i] == ' ')
1910 if (!strcmp(type, "database"))
1913 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1914 return npr->databaseName;
1916 else if (!strcmp(type, "syntax"))
1918 const char *desc = 0;
1919 if (npr->which == Z_NamePlusRecord_databaseRecord)
1921 Z_External *r = (Z_External *) npr->u.databaseRecord;
1922 oident *ent = oid_getentbyoid(r->direct_reference);
1929 *len = strlen(desc);
1932 if (npr->which != Z_NamePlusRecord_databaseRecord)
1935 /* from now on - we have a database record .. */
1936 if (!strcmp(type, "render"))
1938 Z_External *r = (Z_External *) npr->u.databaseRecord;
1939 oident *ent = oid_getentbyoid(r->direct_reference);
1941 /* render bibliographic record .. */
1942 if (r->which == Z_External_OPAC)
1944 r = r->u.opac->bibliographicRecord;
1947 ent = oid_getentbyoid(r->direct_reference);
1949 if (r->which == Z_External_sutrs)
1950 return record_iconv_return(rec, len,
1951 (char*) r->u.sutrs->buf,
1954 else if (r->which == Z_External_octet)
1956 const char *ret_buf;
1964 case VAL_APPLICATION_XML:
1967 ret_buf = marc_iconv_return(
1968 rec, YAZ_MARC_LINE, len,
1969 (const char *) r->u.octet_aligned->buf,
1970 r->u.octet_aligned->len,
1975 return record_iconv_return(rec, len,
1976 (const char *) r->u.octet_aligned->buf,
1977 r->u.octet_aligned->len,
1980 else if (r->which == Z_External_grs1)
1982 if (!rec->wrbuf_marc)
1983 rec->wrbuf_marc = wrbuf_alloc();
1984 wrbuf_rewind(rec->wrbuf_marc);
1985 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1986 return record_iconv_return(rec, len,
1987 wrbuf_buf(rec->wrbuf_marc),
1988 wrbuf_len(rec->wrbuf_marc),
1993 else if (!strcmp(type, "xml"))
1995 Z_External *r = (Z_External *) npr->u.databaseRecord;
1996 oident *ent = oid_getentbyoid(r->direct_reference);
1998 /* render bibliographic record .. */
1999 if (r->which == Z_External_OPAC)
2001 r = r->u.opac->bibliographicRecord;
2004 ent = oid_getentbyoid(r->direct_reference);
2007 if (r->which == Z_External_sutrs)
2008 return record_iconv_return(rec, len,
2009 (const char *) r->u.sutrs->buf,
2012 else if (r->which == Z_External_octet)
2014 const char *ret_buf;
2015 int marc_decode_type = YAZ_MARC_MARCXML;
2024 case VAL_APPLICATION_XML:
2027 ret_buf = marc_iconv_return(
2028 rec, marc_decode_type, len,
2029 (const char *) r->u.octet_aligned->buf,
2030 r->u.octet_aligned->len,
2035 return record_iconv_return(rec, len,
2036 (const char *) r->u.octet_aligned->buf,
2037 r->u.octet_aligned->len,
2040 else if (r->which == Z_External_grs1)
2047 else if (!strcmp(type, "raw"))
2049 Z_External *r = (Z_External *) npr->u.databaseRecord;
2051 if (r->which == Z_External_sutrs)
2053 if (len) *len = r->u.sutrs->len;
2054 return (const char *) r->u.sutrs->buf;
2056 else if (r->which == Z_External_octet)
2058 if (len) *len = r->u.octet_aligned->len;
2059 return (const char *) r->u.octet_aligned->buf;
2061 else /* grs-1, explain, OPAC, ... */
2064 return (const char *) npr->u.databaseRecord;
2068 else if (!strcmp (type, "ext"))
2071 return (const char *) npr->u.databaseRecord;
2073 else if (!strcmp (type, "opac"))
2076 Z_External *r = (Z_External *) npr->u.databaseRecord;
2077 if (r->which == Z_External_OPAC)
2079 if (!rec->wrbuf_opac)
2080 rec->wrbuf_opac = wrbuf_alloc();
2081 wrbuf_rewind(rec->wrbuf_opac);
2082 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2083 return record_iconv_return(rec, len,
2084 wrbuf_buf(rec->wrbuf_opac),
2085 wrbuf_len(rec->wrbuf_opac),
2092 static int strcmp_null(const char *v1, const char *v2)
2098 return strcmp(v1, v2);
2101 static size_t record_hash(int pos)
2105 return pos % RECORD_HASH_SIZE;
2108 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2110 const char *syntax, const char *elementSetName)
2112 ZOOM_record_cache rc;
2114 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2115 ZOOM_connection_put_event(r->connection, event);
2117 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2121 if (strcmp_null(r->schema, rc->schema))
2123 if (strcmp_null(elementSetName,rc->elementSetName))
2125 if (strcmp_null(syntax, rc->syntax))
2127 /* not destroying rc->npr (it's handled by nmem )*/
2129 /* keeping wrbuf_marc too */
2133 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2136 rc->rec.wrbuf_marc = 0;
2137 rc->rec.wrbuf_iconv = 0;
2138 rc->rec.wrbuf_opac = 0;
2140 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2142 rc->elementSetName = 0;
2145 rc->syntax = odr_strdup(r->odr, syntax);
2150 rc->schema = odr_strdup(r->odr, r->schema);
2155 rc->next = r->record_hash[record_hash(pos)];
2156 r->record_hash[record_hash(pos)] = rc;
2159 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2161 const char *elementSetName)
2163 ZOOM_record_cache rc;
2165 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2169 if (strcmp_null(r->schema, rc->schema))
2171 if (strcmp_null(elementSetName,rc->elementSetName))
2173 if (strcmp_null(syntax, rc->syntax))
2181 static void handle_records(ZOOM_connection c, Z_Records *sr,
2184 ZOOM_resultset resultset;
2186 const char *syntax = 0, *elementSetName = 0;
2190 switch (c->tasks->which)
2192 case ZOOM_TASK_SEARCH:
2193 resultset = c->tasks->u.search.resultset;
2194 start = &c->tasks->u.search.start;
2195 count = &c->tasks->u.search.count;
2196 syntax = c->tasks->u.search.syntax;
2197 elementSetName = c->tasks->u.search.elementSetName;
2199 case ZOOM_TASK_RETRIEVE:
2200 resultset = c->tasks->u.retrieve.resultset;
2201 start = &c->tasks->u.retrieve.start;
2202 count = &c->tasks->u.retrieve.count;
2203 syntax = c->tasks->u.retrieve.syntax;
2204 elementSetName = c->tasks->u.retrieve.elementSetName;
2209 if (sr && sr->which == Z_Records_NSD)
2210 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2211 else if (sr && sr->which == Z_Records_multipleNSD)
2213 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2214 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2216 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2220 if (*count + *start > resultset->size)
2221 *count = resultset->size - *start;
2224 if (sr && sr->which == Z_Records_DBOSD)
2227 NMEM nmem = odr_extract_mem(c->odr_in);
2228 Z_NamePlusRecordList *p =
2229 sr->u.databaseOrSurDiagnostics;
2230 for (i = 0; i<p->num_records; i++)
2232 record_cache_add(resultset, p->records[i], i + *start,
2233 syntax, elementSetName);
2239 yaz_log(log_details,
2240 "handle_records resultset=%p start=%d count=%d",
2241 resultset, *start, *count);
2243 /* transfer our response to search_nmem .. we need it later */
2244 nmem_transfer(resultset->odr->mem, nmem);
2246 if (present_phase && p->num_records == 0)
2248 /* present response and we didn't get any records! */
2249 Z_NamePlusRecord *myrec =
2250 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2251 record_cache_add(resultset, myrec, *start,
2252 syntax, elementSetName);
2255 else if (present_phase)
2257 /* present response and we didn't get any records! */
2258 Z_NamePlusRecord *myrec =
2259 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2260 record_cache_add(resultset, myrec, *start, syntax, elementSetName);
2265 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2267 handle_records(c, pr->records, 1);
2270 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2273 switch (term->which)
2275 case Z_Term_general:
2276 ZOOM_options_setl(opt, name,
2277 (const char *)(term->u.general->buf),
2278 term->u.general->len);
2280 case Z_Term_characterString:
2281 ZOOM_options_set(opt, name, term->u.characterString);
2283 case Z_Term_numeric:
2284 ZOOM_options_set_int(opt, name, *term->u.numeric);
2289 static void handle_queryExpression(ZOOM_options opt, const char *name,
2290 Z_QueryExpression *exp)
2296 case Z_QueryExpression_term:
2297 if (exp->u.term && exp->u.term->queryTerm)
2299 sprintf(opt_name, "%s.term", name);
2300 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2303 case Z_QueryExpression_query:
2308 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2309 Z_OtherInformation *o)
2312 for (i = 0; o && i < o->num_elements; i++)
2314 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2316 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2318 if (ext->which == Z_External_searchResult1)
2321 Z_SearchInfoReport *sr = ext->u.searchResult1;
2324 ZOOM_options_set_int(
2325 resultset->options, "searchresult.size", sr->num);
2327 for (j = 0; j < sr->num; j++)
2329 Z_SearchInfoReport_s *ent =
2330 ext->u.searchResult1->elements[j];
2333 sprintf(pref, "searchresult.%d", j);
2335 if (ent->subqueryId)
2338 sprintf(opt_name, "%s.id", pref);
2339 ZOOM_options_set(resultset->options, opt_name,
2342 if (ent->subqueryExpression)
2345 sprintf(opt_name, "%s.subquery", pref);
2346 handle_queryExpression(resultset->options, opt_name,
2347 ent->subqueryExpression);
2349 if (ent->subqueryInterpretation)
2352 sprintf(opt_name, "%s.interpretation", pref);
2353 handle_queryExpression(resultset->options, opt_name,
2354 ent->subqueryInterpretation);
2356 if (ent->subqueryRecommendation)
2359 sprintf(opt_name, "%s.recommendation", pref);
2360 handle_queryExpression(resultset->options, opt_name,
2361 ent->subqueryRecommendation);
2363 if (ent->subqueryCount)
2366 sprintf(opt_name, "%s.count", pref);
2367 ZOOM_options_set_int(resultset->options, opt_name,
2368 *ent->subqueryCount);
2376 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2378 ZOOM_resultset resultset;
2381 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2384 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2385 ZOOM_connection_put_event(c, event);
2387 resultset = c->tasks->u.search.resultset;
2389 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2391 resultset->size = *sr->resultCount;
2392 handle_records(c, sr->records, 0);
2395 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2397 if (res->diagnostics && res->num_diagnostics > 0)
2398 response_diag(c, res->diagnostics[0]);
2401 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2403 NMEM nmem = odr_extract_mem(c->odr_in);
2406 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2408 scan = c->tasks->u.scan.scan;
2410 if (res->entries && res->entries->nonsurrogateDiagnostics)
2411 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2412 scan->scan_response = res;
2413 nmem_transfer(scan->odr->mem, nmem);
2415 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2416 if (res->positionOfTerm)
2417 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2418 if (res->scanStatus)
2419 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2420 if (res->numberOfEntriesReturned)
2421 ZOOM_options_set_int(scan->options, "number",
2422 *res->numberOfEntriesReturned);
2427 static zoom_ret send_sort(ZOOM_connection c,
2428 ZOOM_resultset resultset)
2431 resultset->r_sort_spec = 0;
2432 if (resultset->r_sort_spec)
2434 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2435 Z_SortRequest *req = apdu->u.sortRequest;
2437 req->num_inputResultSetNames = 1;
2438 req->inputResultSetNames = (Z_InternationalString **)
2439 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2440 req->inputResultSetNames[0] =
2441 odr_strdup(c->odr_out, resultset->setname);
2442 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2443 req->sortSequence = resultset->r_sort_spec;
2444 resultset->r_sort_spec = 0;
2445 return send_APDU(c, apdu);
2447 return zoom_complete;
2450 static zoom_ret send_present(ZOOM_connection c)
2453 Z_PresentRequest *req = 0;
2455 const char *syntax = 0;
2456 const char *elementSetName = 0;
2457 ZOOM_resultset resultset;
2462 yaz_log(log_details, "%p send_present no tasks", c);
2463 return zoom_complete;
2466 switch (c->tasks->which)
2468 case ZOOM_TASK_SEARCH:
2469 resultset = c->tasks->u.search.resultset;
2470 start = &c->tasks->u.search.start;
2471 count = &c->tasks->u.search.count;
2472 syntax = c->tasks->u.search.syntax;
2473 elementSetName = c->tasks->u.search.elementSetName;
2475 case ZOOM_TASK_RETRIEVE:
2476 resultset = c->tasks->u.retrieve.resultset;
2477 start = &c->tasks->u.retrieve.start;
2478 count = &c->tasks->u.retrieve.count;
2479 syntax = c->tasks->u.retrieve.syntax;
2480 elementSetName = c->tasks->u.retrieve.elementSetName;
2483 return zoom_complete;
2485 yaz_log(log_details, "%p send_present start=%d count=%d",
2488 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2490 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2493 if (c->error) /* don't continue on error */
2494 return zoom_complete;
2495 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2496 resultset, *start, *count);
2498 for (i = 0; i < *count; i++)
2501 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2506 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2507 ZOOM_connection_put_event(c, event);
2515 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2516 return zoom_complete;
2519 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2520 req = apdu->u.presentRequest;
2523 yaz_log(log_details, "%p send_present skip=%d", c, i);
2525 *req->resultSetStartPoint = *start + 1;
2526 *req->numberOfRecordsRequested = resultset->step>0 ?
2527 resultset->step : *count;
2528 if (*req->numberOfRecordsRequested + *start > resultset->size)
2529 *req->numberOfRecordsRequested = resultset->size - *start;
2530 assert(*req->numberOfRecordsRequested > 0);
2532 if (syntax && *syntax)
2533 req->preferredRecordSyntax =
2534 yaz_str_to_z3950oid(c->odr_out, CLASS_RECSYN, syntax);
2536 if (resultset->schema && *resultset->schema)
2538 Z_RecordComposition *compo = (Z_RecordComposition *)
2539 odr_malloc(c->odr_out, sizeof(*compo));
2541 req->recordComposition = compo;
2542 compo->which = Z_RecordComp_complex;
2543 compo->u.complex = (Z_CompSpec *)
2544 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2545 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2546 odr_malloc(c->odr_out, sizeof(bool_t));
2547 *compo->u.complex->selectAlternativeSyntax = 0;
2549 compo->u.complex->generic = (Z_Specification *)
2550 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2552 compo->u.complex->generic->which = Z_Schema_oid;
2553 compo->u.complex->generic->schema.oid = (Odr_oid *)
2554 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2556 if (!compo->u.complex->generic->schema.oid)
2558 /* OID wasn't a schema! Try record syntax instead. */
2560 compo->u.complex->generic->schema.oid = (Odr_oid *)
2561 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2563 if (elementSetName && *elementSetName)
2565 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2566 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2567 compo->u.complex->generic->elementSpec->which =
2568 Z_ElementSpec_elementSetName;
2569 compo->u.complex->generic->elementSpec->u.elementSetName =
2570 odr_strdup(c->odr_out, elementSetName);
2573 compo->u.complex->generic->elementSpec = 0;
2574 compo->u.complex->num_dbSpecific = 0;
2575 compo->u.complex->dbSpecific = 0;
2576 compo->u.complex->num_recordSyntax = 0;
2577 compo->u.complex->recordSyntax = 0;
2579 else if (elementSetName && *elementSetName)
2581 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2582 odr_malloc(c->odr_out, sizeof(*esn));
2583 Z_RecordComposition *compo = (Z_RecordComposition *)
2584 odr_malloc(c->odr_out, sizeof(*compo));
2586 esn->which = Z_ElementSetNames_generic;
2587 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2588 compo->which = Z_RecordComp_simple;
2589 compo->u.simple = esn;
2590 req->recordComposition = compo;
2592 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2593 return send_APDU(c, apdu);
2596 ZOOM_API(ZOOM_scanset)
2597 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2600 ZOOM_query q = ZOOM_query_create();
2602 ZOOM_query_prefix(q, start);
2604 s = ZOOM_connection_scan1(c, q);
2605 ZOOM_query_destroy(q);
2610 ZOOM_API(ZOOM_scanset)
2611 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2615 ZOOM_scanset scan = 0;
2618 * We need to check the query-type, so we can recognise CQL and
2619 * CCL and compile them into a form that we can use here. The
2620 * ZOOM_query structure has no explicit `type' member, but
2621 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2622 * functions shows how the structure is set up in each case.
2626 else if (q->z_query->which == Z_Query_type_1)
2628 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2629 c, q, q->query_string);
2630 start = q->query_string;
2632 else if (q->z_query->which == Z_Query_type_104)
2634 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2635 c, q, q->query_string);
2636 start = freeme = cql2pqf(c, q->query_string);
2642 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2643 c, q, q->query_string);
2647 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2648 scan->connection = c;
2649 scan->odr = odr_createmem(ODR_DECODE);
2650 scan->options = ZOOM_options_create_with_parent(c->options);
2652 scan->scan_response = 0;
2653 scan->termListAndStartPoint =
2654 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2657 scan->databaseNames = set_DatabaseNames(c, c->options,
2658 &scan->num_databaseNames,
2660 if (scan->termListAndStartPoint != 0)
2662 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2663 task->u.scan.scan = scan;
2668 while (ZOOM_event(1, &c))
2676 ZOOM_scanset_destroy(ZOOM_scanset scan)
2681 if (scan->refcount == 0)
2683 odr_destroy(scan->odr);
2685 ZOOM_options_destroy(scan->options);
2690 static zoom_ret send_package(ZOOM_connection c)
2694 yaz_log(log_details, "%p send_package", c);
2696 return zoom_complete;
2697 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2699 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2700 ZOOM_connection_put_event(c, event);
2702 c->buf_out = c->tasks->u.package->buf_out;
2703 c->len_out = c->tasks->u.package->len_out;
2708 static zoom_ret send_scan(ZOOM_connection c)
2711 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2712 Z_ScanRequest *req = apdu->u.scanRequest;
2714 yaz_log(log_details, "%p send_scan", c);
2716 return zoom_complete;
2717 assert (c->tasks->which == ZOOM_TASK_SCAN);
2718 scan = c->tasks->u.scan.scan;
2720 req->termListAndStartPoint = scan->termListAndStartPoint;
2721 req->attributeSet = scan->attributeSet;
2723 *req->numberOfTermsRequested =
2724 ZOOM_options_get_int(scan->options, "number", 10);
2726 req->preferredPositionInResponse =
2727 odr_intdup(c->odr_out,
2728 ZOOM_options_get_int(scan->options, "position", 1));
2731 odr_intdup(c->odr_out,
2732 ZOOM_options_get_int(scan->options, "stepSize", 0));
2734 req->databaseNames = scan->databaseNames;
2735 req->num_databaseNames = scan->num_databaseNames;
2737 return send_APDU(c, apdu);
2741 ZOOM_scanset_size(ZOOM_scanset scan)
2743 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2745 return scan->scan_response->entries->num_entries;
2748 ZOOM_API(const char *)
2749 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2752 const char *term = 0;
2753 size_t noent = ZOOM_scanset_size(scan);
2754 Z_ScanResponse *res = scan->scan_response;
2760 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2762 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2764 if (t->term->which == Z_Term_general)
2766 term = (const char *) t->term->u.general->buf;
2767 *len = t->term->u.general->len;
2769 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2774 ZOOM_API(const char *)
2775 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2778 const char *term = 0;
2779 size_t noent = ZOOM_scanset_size(scan);
2780 Z_ScanResponse *res = scan->scan_response;
2786 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2788 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2792 term = t->displayTerm;
2793 *len = strlen(term);
2795 else if (t->term->which == Z_Term_general)
2797 term = (const char *) t->term->u.general->buf;
2798 *len = t->term->u.general->len;
2800 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2805 ZOOM_API(const char *)
2806 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2808 return ZOOM_options_get(scan->options, key);
2812 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2815 ZOOM_options_set(scan->options, key, val);
2818 static Z_APDU *create_es_package(ZOOM_package p, int type)
2821 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2822 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2824 *req->function = Z_ExtendedServicesRequest_create;
2826 str = ZOOM_options_get(p->options, "package-name");
2828 req->packageName = nmem_strdup(p->odr_out->mem, str);
2830 str = ZOOM_options_get(p->options, "user-id");
2832 req->userId = nmem_strdup(p->odr_out->mem, str);
2834 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2837 str = ZOOM_options_get(p->options, "function");
2840 if (!strcmp (str, "create"))
2842 if (!strcmp (str, "delete"))
2844 if (!strcmp (str, "modify"))
2850 static const char *ill_array_lookup(void *clientData, const char *idx)
2852 ZOOM_package p = (ZOOM_package) clientData;
2853 return ZOOM_options_get(p->options, idx+4);
2856 static Z_External *encode_ill_request(ZOOM_package p)
2858 ODR out = p->odr_out;
2861 struct ill_get_ctl ctl;
2863 ctl.odr = p->odr_out;
2865 ctl.f = ill_array_lookup;
2867 req = ill_get_ILLRequest(&ctl, "ill", 0);
2869 if (!ill_Request(out, &req, 0, 0))
2871 int ill_request_size;
2872 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2873 if (ill_request_buf)
2874 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2880 int illRequest_size = 0;
2881 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2883 oid.proto = PROTO_GENERAL;
2884 oid.oclass = CLASS_GENERAL;
2885 oid.value = VAL_ISO_ILL_1;
2887 r = (Z_External *) odr_malloc(out, sizeof(*r));
2888 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2889 r->indirect_reference = 0;
2891 r->which = Z_External_single;
2893 r->u.single_ASN1_type =
2894 odr_create_Odr_oct(out,
2895 (unsigned char *)illRequest_buf,
2901 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2903 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2906 req->which = Z_IOItemOrder_esRequest;
2907 req->u.esRequest = (Z_IORequest *)
2908 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2910 /* to keep part ... */
2911 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2912 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2913 req->u.esRequest->toKeep->supplDescription = 0;
2914 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2915 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2917 str = ZOOM_options_get(p->options, "contact-name");
2918 req->u.esRequest->toKeep->contact->name = str ?
2919 nmem_strdup(p->odr_out->mem, str) : 0;
2921 str = ZOOM_options_get(p->options, "contact-phone");
2922 req->u.esRequest->toKeep->contact->phone = str ?
2923 nmem_strdup(p->odr_out->mem, str) : 0;
2925 str = ZOOM_options_get(p->options, "contact-email");
2926 req->u.esRequest->toKeep->contact->email = str ?
2927 nmem_strdup(p->odr_out->mem, str) : 0;
2929 req->u.esRequest->toKeep->addlBilling = 0;
2931 /* not to keep part ... */
2932 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2933 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2935 str = ZOOM_options_get(p->options, "itemorder-setname");
2940 req->u.esRequest->notToKeep->resultSetItem = 0;
2943 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2944 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2946 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2947 nmem_strdup(p->odr_out->mem, str);
2948 req->u.esRequest->notToKeep->resultSetItem->item =
2949 (int *) odr_malloc(p->odr_out, sizeof(int));
2951 str = ZOOM_options_get(p->options, "itemorder-item");
2952 *req->u.esRequest->notToKeep->resultSetItem->item =
2953 (str ? atoi(str) : 1);
2955 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2960 Z_APDU *create_admin_package(ZOOM_package p, int type,
2961 Z_ESAdminOriginPartToKeep **toKeepP,
2962 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2964 Z_APDU *apdu = create_es_package(p, VAL_ADMINSERVICE);
2967 Z_ESAdminOriginPartToKeep *toKeep;
2968 Z_ESAdminOriginPartNotToKeep *notToKeep;
2969 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
2970 const char *first_db = "Default";
2972 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
2977 r->direct_reference =
2978 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2981 r->indirect_reference = 0;
2982 r->which = Z_External_ESAdmin;
2984 r->u.adminService = (Z_Admin *)
2985 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2986 r->u.adminService->which = Z_Admin_esRequest;
2987 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2988 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2990 toKeep = r->u.adminService->u.esRequest->toKeep =
2991 (Z_ESAdminOriginPartToKeep *)
2992 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2993 toKeep->which = type;
2994 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2995 toKeep->u.create = odr_nullval();
2996 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2998 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2999 (Z_ESAdminOriginPartNotToKeep *)
3000 odr_malloc(p->odr_out,
3001 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3002 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3003 notToKeep->u.recordsWillFollow = odr_nullval();
3007 *notToKeepP = notToKeep;
3012 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3014 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
3015 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3016 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3017 const char *doc = ZOOM_options_get(p->options, "doc");
3022 req->taskSpecificParameters = ext;
3023 ext->direct_reference = req->packageType;
3024 ext->descriptor = 0;
3025 ext->indirect_reference = 0;
3027 ext->which = Z_External_octet;
3028 ext->u.single_ASN1_type =
3029 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
3034 static Z_APDU *create_update_package(ZOOM_package p)
3037 const char *first_db = "Default";
3039 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3040 const char *action = ZOOM_options_get(p->options, "action");
3041 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
3042 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3043 const char *record_buf = ZOOM_options_get(p->options, "record");
3044 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3045 int syntax_oid = VAL_NONE;
3049 syntax_oid = oid_getvalbyname(syntax_str);
3052 record_buf = "void";
3053 syntax_oid = VAL_SUTRS;
3055 if (syntax_oid == VAL_NONE)
3056 syntax_oid = VAL_TEXT_XML;
3062 action = "specialUpdate";
3064 if (!strcmp(action, "recordInsert"))
3065 action_no = Z_IUOriginPartToKeep_recordInsert;
3066 else if (!strcmp(action, "recordReplace"))
3067 action_no = Z_IUOriginPartToKeep_recordReplace;
3068 else if (!strcmp(action, "recordDelete"))
3069 action_no = Z_IUOriginPartToKeep_recordDelete;
3070 else if (!strcmp(action, "elementUpdate"))
3071 action_no = Z_IUOriginPartToKeep_elementUpdate;
3072 else if (!strcmp(action, "specialUpdate"))
3073 action_no = Z_IUOriginPartToKeep_specialUpdate;
3077 apdu = create_es_package(p, VAL_DBUPDATE);
3080 Z_IUOriginPartToKeep *toKeep;
3081 Z_IUSuppliedRecords *notToKeep;
3082 Z_External *r = (Z_External *)
3083 odr_malloc(p->odr_out, sizeof(*r));
3085 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3087 r->direct_reference =
3088 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3091 r->which = Z_External_update;
3092 r->indirect_reference = 0;
3093 r->u.update = (Z_IUUpdate *)
3094 odr_malloc(p->odr_out, sizeof(*r->u.update));
3096 r->u.update->which = Z_IUUpdate_esRequest;
3097 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3098 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3099 toKeep = r->u.update->u.esRequest->toKeep =
3100 (Z_IUOriginPartToKeep *)
3101 odr_malloc(p->odr_out, sizeof(*toKeep));
3103 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3105 toKeep->elementSetName = 0;
3106 toKeep->actionQualifier = 0;
3107 toKeep->action = odr_intdup(p->odr_out, action_no);
3109 notToKeep = r->u.update->u.esRequest->notToKeep =
3110 (Z_IUSuppliedRecords *)
3111 odr_malloc(p->odr_out, sizeof(*notToKeep));
3113 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3114 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3115 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3116 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3117 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3120 notToKeep->elements[0]->u.opaque =
3121 odr_create_Odr_oct(p->odr_out,
3122 (const unsigned char *) recordIdOpaque,
3123 strlen(recordIdOpaque));
3125 else if (recordIdNumber)
3127 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3129 notToKeep->elements[0]->u.number =
3130 odr_intdup(p->odr_out, atoi(recordIdNumber));
3133 notToKeep->elements[0]->u.opaque = 0;
3134 notToKeep->elements[0]->supplementalId = 0;
3135 notToKeep->elements[0]->correlationInfo = 0;
3136 notToKeep->elements[0]->record =
3137 z_ext_record(p->odr_out, syntax_oid,
3138 record_buf, strlen(record_buf));
3142 ODR print = odr_createmem(ODR_PRINT);
3144 z_APDU(print, &apdu, 0, 0);
3151 ZOOM_package_send(ZOOM_package p, const char *type)
3158 odr_reset(p->odr_out);
3161 if (!strcmp(type, "itemorder"))
3163 apdu = create_es_package(p, VAL_ITEMORDER);
3166 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3168 r->direct_reference =
3169 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3172 r->which = Z_External_itemOrder;
3173 r->indirect_reference = 0;
3174 r->u.itemOrder = encode_item_order(p);
3176 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3179 else if (!strcmp(type, "create")) /* create database */
3181 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3184 else if (!strcmp(type, "drop")) /* drop database */
3186 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3189 else if (!strcmp(type, "commit")) /* commit changes */
3191 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3194 else if (!strcmp(type, "update")) /* update record(s) */
3196 apdu = create_update_package(p);
3198 else if (!strcmp(type, "xmlupdate"))
3200 apdu = create_xmlupdate_package(p);
3204 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3208 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3209 task->u.package = p;
3210 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3211 p->buf_out = (char *) xmalloc(p->len_out);
3212 memcpy(p->buf_out, buf, p->len_out);
3217 while (ZOOM_event(1, &c))
3224 ZOOM_API(ZOOM_package)
3225 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3227 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3230 p->odr_out = odr_createmem(ODR_ENCODE);
3231 p->options = ZOOM_options_create_with_parent2(options, c->options);
3239 ZOOM_package_destroy(ZOOM_package p)
3244 if (p->refcount == 0)
3246 odr_destroy(p->odr_out);
3249 ZOOM_options_destroy(p->options);
3254 ZOOM_API(const char *)
3255 ZOOM_package_option_get(ZOOM_package p, const char *key)
3257 return ZOOM_options_get(p->options, key);
3262 ZOOM_package_option_set(ZOOM_package p, const char *key,
3265 ZOOM_options_set(p->options, key, val);
3268 static int ZOOM_connection_exec_task(ZOOM_connection c)
3270 ZOOM_task task = c->tasks;
3271 zoom_ret ret = zoom_complete;
3275 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3276 c, task->which, task->running);
3277 if (c->error != ZOOM_ERROR_NONE)
3279 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3280 "removing tasks because of error = %d", c, c->error);
3281 ZOOM_connection_remove_tasks(c);
3286 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3287 "task already running", c);
3291 ret = zoom_complete;
3292 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3294 switch (task->which)
3296 case ZOOM_TASK_SEARCH:
3297 if (c->proto == PROTO_HTTP)
3298 ret = ZOOM_connection_srw_send_search(c);
3300 ret = ZOOM_connection_send_search(c);
3302 case ZOOM_TASK_RETRIEVE:
3303 if (c->proto == PROTO_HTTP)
3304 ret = ZOOM_connection_srw_send_search(c);
3306 ret = send_present(c);
3308 case ZOOM_TASK_CONNECT:
3309 ret = do_connect(c);
3311 case ZOOM_TASK_SCAN:
3314 case ZOOM_TASK_PACKAGE:
3315 ret = send_package(c);
3317 case ZOOM_TASK_SORT:
3318 c->tasks->u.sort.resultset->r_sort_spec =
3319 c->tasks->u.sort.q->sort_spec;
3320 ret = send_sort(c, c->tasks->u.sort.resultset);
3326 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3327 "remove tasks because no connection exist", c);
3328 ZOOM_connection_remove_tasks(c);
3330 if (ret == zoom_complete)
3332 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3333 "task removed (complete)", c);
3334 ZOOM_connection_remove_task(c);
3337 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3342 static zoom_ret send_sort_present(ZOOM_connection c)
3344 zoom_ret r = zoom_complete;
3346 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3347 r = send_sort(c, c->tasks->u.search.resultset);
3348 if (r == zoom_complete)
3349 r = send_present(c);
3353 static int es_response(ZOOM_connection c,
3354 Z_ExtendedServicesResponse *res)
3356 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3358 if (res->diagnostics && res->num_diagnostics > 0)
3359 response_diag(c, res->diagnostics[0]);
3360 if (res->taskPackage &&
3361 res->taskPackage->which == Z_External_extendedService)
3363 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3364 Odr_oct *id = taskPackage->targetReference;
3367 ZOOM_options_setl(c->tasks->u.package->options,
3368 "targetReference", (char*) id->buf, id->len);
3370 if (res->taskPackage &&
3371 res->taskPackage->which == Z_External_octet)
3373 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3374 ZOOM_options_setl(c->tasks->u.package->options,
3375 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3380 static void interpret_init_diag(ZOOM_connection c,
3381 Z_DiagnosticFormat *diag)
3385 Z_DiagnosticFormat_s *ds = diag->elements[0];
3386 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3387 response_default_diag(c, ds->u.defaultDiagRec);
3392 static void interpret_otherinformation_field(ZOOM_connection c,
3393 Z_OtherInformation *ui)
3396 for (i = 0; i < ui->num_elements; i++)
3398 Z_OtherInformationUnit *unit = ui->list[i];
3399 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3400 unit->information.externallyDefinedInfo &&
3401 unit->information.externallyDefinedInfo->which ==
3404 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3410 static void set_init_option(const char *name, void *clientData) {
3411 ZOOM_connection c = clientData;
3414 sprintf(buf, "init_opt_%.70s", name);
3415 ZOOM_connection_option_set(c, buf, "1");
3419 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3421 Z_InitResponse *initrs;
3423 ZOOM_connection_set_mask(c, 0);
3424 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3427 case Z_APDU_initResponse:
3428 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3429 initrs = apdu->u.initResponse;
3430 ZOOM_connection_option_set(c, "serverImplementationId",
3431 initrs->implementationId ?
3432 initrs->implementationId : "");
3433 ZOOM_connection_option_set(c, "serverImplementationName",
3434 initrs->implementationName ?
3435 initrs->implementationName : "");
3436 ZOOM_connection_option_set(c, "serverImplementationVersion",
3437 initrs->implementationVersion ?
3438 initrs->implementationVersion : "");
3439 /* Set the three old options too, for old applications */
3440 ZOOM_connection_option_set(c, "targetImplementationId",
3441 initrs->implementationId ?
3442 initrs->implementationId : "");
3443 ZOOM_connection_option_set(c, "targetImplementationName",
3444 initrs->implementationName ?
3445 initrs->implementationName : "");
3446 ZOOM_connection_option_set(c, "targetImplementationVersion",
3447 initrs->implementationVersion ?
3448 initrs->implementationVersion : "");
3450 /* Make initrs->options available as ZOOM-level options */
3451 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3453 if (!*initrs->result)
3455 Z_External *uif = initrs->userInformationField;
3457 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3459 if (uif && uif->which == Z_External_userInfo1)
3460 interpret_otherinformation_field(c, uif->u.userInfo1);
3465 yaz_oi_get_string_oidval(&apdu->u.initResponse->otherInfo,
3467 xfree(c->cookie_in);
3470 c->cookie_in = xstrdup(cookie);
3471 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3472 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3473 c->support_named_resultsets = 1;
3476 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3477 ZOOM_connection_remove_task(c);
3479 ZOOM_connection_exec_task(c);
3481 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3483 NMEM tmpmem = nmem_create();
3484 Z_CharSetandLanguageNegotiation *p =
3485 yaz_get_charneg_record(initrs->otherInfo);
3489 char *charset = NULL, *lang = NULL;
3492 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3493 yaz_log(log_details, "%p recv_apdu target accepted: "
3494 "charset %s, language %s, select %d",
3496 charset ? charset : "none", lang ? lang : "none", sel);
3498 ZOOM_connection_option_set(c, "negotiation-charset",
3501 ZOOM_connection_option_set(c, "negotiation-lang",
3504 ZOOM_connection_option_set(
3505 c, "negotiation-charset-in-effect-for-records",
3506 (sel != 0) ? "1" : "0");
3507 nmem_destroy(tmpmem);
3511 case Z_APDU_searchResponse:
3512 yaz_log(log_api, "%p recv_apdu Search response", c);
3513 handle_search_response(c, apdu->u.searchResponse);
3514 if (send_sort_present(c) == zoom_complete)
3515 ZOOM_connection_remove_task(c);
3517 case Z_APDU_presentResponse:
3518 yaz_log(log_api, "%p recv_apdu Present response", c);
3519 handle_present_response(c, apdu->u.presentResponse);
3520 if (send_present(c) == zoom_complete)
3521 ZOOM_connection_remove_task(c);
3523 case Z_APDU_sortResponse:
3524 yaz_log(log_api, "%p recv_apdu Sort response", c);
3525 sort_response(c, apdu->u.sortResponse);
3526 if (send_present(c) == zoom_complete)
3527 ZOOM_connection_remove_task(c);
3529 case Z_APDU_scanResponse:
3530 yaz_log(log_api, "%p recv_apdu Scan response", c);
3531 scan_response(c, apdu->u.scanResponse);
3532 ZOOM_connection_remove_task(c);
3534 case Z_APDU_extendedServicesResponse:
3535 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3536 es_response(c, apdu->u.extendedServicesResponse);
3537 ZOOM_connection_remove_task(c);
3540 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3541 if (!ZOOM_test_reconnect(c))
3543 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3548 yaz_log(log_api, "%p Received unknown PDU", c);
3549 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3555 static void handle_srw_response(ZOOM_connection c,
3556 Z_SRW_searchRetrieveResponse *res)
3558 ZOOM_resultset resultset = 0;
3563 const char *syntax, *elementSetName;
3568 switch(c->tasks->which)
3570 case ZOOM_TASK_SEARCH:
3571 resultset = c->tasks->u.search.resultset;
3572 start = &c->tasks->u.search.start;
3573 syntax = c->tasks->u.search.syntax;
3574 elementSetName = c->tasks->u.search.elementSetName;
3576 case ZOOM_TASK_RETRIEVE:
3577 resultset = c->tasks->u.retrieve.resultset;
3578 start = &c->tasks->u.retrieve.start;
3579 syntax = c->tasks->u.retrieve.syntax;
3580 elementSetName = c->tasks->u.retrieve.elementSetName;
3585 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3586 ZOOM_connection_put_event(c, event);
3588 resultset->size = 0;
3590 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3592 if (res->numberOfRecords)
3593 resultset->size = *res->numberOfRecords;
3595 for (i = 0; i<res->num_records; i++)
3599 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3600 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3602 if (res->records[i].recordPosition &&
3603 *res->records[i].recordPosition > 0)
3604 pos = *res->records[i].recordPosition - 1;
3608 npr->databaseName = 0;
3609 npr->which = Z_NamePlusRecord_databaseRecord;
3610 npr->u.databaseRecord = (Z_External *)
3611 odr_malloc(c->odr_in, sizeof(Z_External));
3612 npr->u.databaseRecord->descriptor = 0;
3613 npr->u.databaseRecord->direct_reference =
3614 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3615 npr->u.databaseRecord->which = Z_External_octet;
3617 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3618 odr_malloc(c->odr_in, sizeof(Odr_oct));
3619 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3620 res->records[i].recordData_buf;
3621 npr->u.databaseRecord->u.octet_aligned->len =
3622 npr->u.databaseRecord->u.octet_aligned->size =
3623 res->records[i].recordData_len;
3624 record_cache_add(resultset, npr, pos, syntax, elementSetName);
3626 if (res->num_diagnostics > 0)
3628 const char *uri = res->diagnostics[0].uri;
3633 if ((cp = strrchr(uri, '/')))
3635 set_dset_error(c, code, uri,
3636 res->diagnostics[0].details, 0);
3639 nmem = odr_extract_mem(c->odr_in);
3640 nmem_transfer(resultset->odr->mem, nmem);
3646 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3649 const char *content_type = z_HTTP_header_lookup(hres->headers,
3651 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3653 ZOOM_connection_set_mask(c, 0);
3654 yaz_log(log_details, "%p handle_http", c);
3656 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3658 Z_SOAP *soap_package = 0;
3660 Z_SOAP_Handler soap_handlers[2] = {
3661 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
3664 ret = z_soap_codec(o, &soap_package,
3665 &hres->content_buf, &hres->content_len,
3667 if (!ret && soap_package->which == Z_SOAP_generic &&
3668 soap_package->u.generic->no == 0)
3670 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3671 if (sr->which == Z_SRW_searchRetrieve_response)
3672 handle_srw_response(c, sr->u.response);
3676 else if (!ret && (soap_package->which == Z_SOAP_fault
3677 || soap_package->which == Z_SOAP_error))
3679 set_HTTP_error(c, hres->code,
3680 soap_package->u.fault->fault_code,
3681 soap_package->u.fault->fault_string);
3688 if (hres->code != 200)
3689 set_HTTP_error(c, hres->code, 0, 0);
3691 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3694 ZOOM_connection_remove_task(c);
3695 if (!strcmp(hres->version, "1.0"))
3697 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3698 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3703 /* HTTP 1.1: only if no close we stay alive .. */
3704 if (connection_head && !strcmp(connection_head, "close"))
3710 static int do_read(ZOOM_connection c)
3715 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3716 ZOOM_connection_put_event(c, event);
3718 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3719 more = cs_more(c->cs);
3720 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3725 if (ZOOM_test_reconnect(c))
3727 yaz_log(log_details, "%p do_read reconnect read", c);
3731 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3740 odr_reset(c->odr_in);
3741 odr_setbuf(c->odr_in, c->buf_in, r, 0);
3742 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3743 ZOOM_connection_put_event(c, event);
3745 if (!z_GDU(c->odr_in, &gdu, 0, 0))
3748 int err = odr_geterrorx(c->odr_in, &x);
3750 const char *element = odr_getelement(c->odr_in);
3751 sprintf(msg, "ODR code %d:%d element=%-20s",
3752 err, x, element ? element : "<unknown>");
3753 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3756 else if (gdu->which == Z_GDU_Z3950)
3757 recv_apdu(c, gdu->u.z3950);
3758 else if (gdu->which == Z_GDU_HTTP_Response)
3761 handle_http(c, gdu->u.HTTP_Response);
3763 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3767 c->reconnect_ok = 0;
3772 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3777 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3778 ZOOM_connection_put_event(c, event);
3780 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3781 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3783 yaz_log(log_details, "%p do_write_ex write failed", c);
3784 if (ZOOM_test_reconnect(c))
3786 return zoom_pending;
3788 if (c->state == STATE_CONNECTING)
3789 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3791 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3793 return zoom_complete;
3797 int mask = ZOOM_SELECT_EXCEPT;
3798 if (c->cs->io_pending & CS_WANT_WRITE)
3799 mask += ZOOM_SELECT_WRITE;
3800 if (c->cs->io_pending & CS_WANT_READ)
3801 mask += ZOOM_SELECT_READ;
3802 ZOOM_connection_set_mask(c, mask);
3803 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3808 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
3809 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3812 return zoom_pending;
3815 static zoom_ret do_write(ZOOM_connection c)
3817 return do_write_ex(c, c->buf_out, c->len_out);
3821 ZOOM_API(const char *)
3822 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3824 return ZOOM_options_get(c->options, key);
3827 ZOOM_API(const char *)
3828 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3830 return ZOOM_options_getl(c->options, key, lenp);
3834 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3837 ZOOM_options_set(c->options, key, val);
3841 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3842 const char *val, int len)
3844 ZOOM_options_setl(c->options, key, val, len);
3847 ZOOM_API(const char *)
3848 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3850 return ZOOM_options_get(r->options, key);
3854 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3857 ZOOM_options_set(r->options, key, val);
3862 ZOOM_connection_errcode(ZOOM_connection c)
3864 return ZOOM_connection_error(c, 0, 0);
3867 ZOOM_API(const char *)
3868 ZOOM_connection_errmsg(ZOOM_connection c)
3871 ZOOM_connection_error(c, &msg, 0);
3875 ZOOM_API(const char *)
3876 ZOOM_connection_addinfo(ZOOM_connection c)
3878 const char *addinfo;
3879 ZOOM_connection_error(c, 0, &addinfo);
3883 ZOOM_API(const char *)
3884 ZOOM_connection_diagset(ZOOM_connection c)
3886 const char *diagset;
3887 ZOOM_connection_error_x(c, 0, 0, &diagset);
3891 ZOOM_API(const char *)
3892 ZOOM_diag_str(int error)
3896 case ZOOM_ERROR_NONE:
3898 case ZOOM_ERROR_CONNECT:
3899 return "Connect failed";
3900 case ZOOM_ERROR_MEMORY:
3901 return "Out of memory";
3902 case ZOOM_ERROR_ENCODE:
3903 return "Encoding failed";
3904 case ZOOM_ERROR_DECODE:
3905 return "Decoding failed";
3906 case ZOOM_ERROR_CONNECTION_LOST:
3907 return "Connection lost";
3908 case ZOOM_ERROR_INIT:
3909 return "Init rejected";
3910 case ZOOM_ERROR_INTERNAL:
3911 return "Internal failure";
3912 case ZOOM_ERROR_TIMEOUT:
3914 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3915 return "Unsupported protocol";
3916 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3917 return "Unsupported query type";
3918 case ZOOM_ERROR_INVALID_QUERY:
3919 return "Invalid query";
3920 case ZOOM_ERROR_CQL_PARSE:
3921 return "CQL parsing error";
3922 case ZOOM_ERROR_CQL_TRANSFORM:
3923 return "CQL transformation error";
3924 case ZOOM_ERROR_CCL_CONFIG:
3925 return "CCL configuration error";
3926 case ZOOM_ERROR_CCL_PARSE:
3927 return "CCL parsing error";
3929 return diagbib1_str(error);
3934 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
3935 const char **addinfo, const char **diagset)
3937 int error = c->error;
3940 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3941 *cp = ZOOM_diag_str(error);
3942 else if (!strcmp(c->diagset, "HTTP"))
3943 *cp = z_HTTP_errmsg(c->error);
3944 else if (!strcmp(c->diagset, "Bib-1"))
3945 *cp = ZOOM_diag_str(error);
3946 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3947 *cp = yaz_diag_srw_str(c->error);
3949 *cp = "Unknown error and diagnostic set";
3952 *addinfo = c->addinfo ? c->addinfo : "";
3954 *diagset = c->diagset ? c->diagset : "";
3959 ZOOM_connection_error(ZOOM_connection c, const char **cp,
3960 const char **addinfo)
3962 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3965 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
3967 ZOOM_Event event = 0;
3968 int r = cs_look(c->cs);
3969 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
3974 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
3975 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3977 ZOOM_connection_put_event(c, event);
3979 else if (r == CS_CONNECT)
3981 int ret = ret = cs_rcvconnect(c->cs);
3982 yaz_log(log_details, "%p ZOOM_connection_do_io "
3983 "cs_rcvconnect returned %d", c, ret);
3986 int mask = ZOOM_SELECT_EXCEPT;
3987 if (c->cs->io_pending & CS_WANT_WRITE)
3988 mask += ZOOM_SELECT_WRITE;
3989 if (c->cs->io_pending & CS_WANT_READ)
3990 mask += ZOOM_SELECT_READ;
3991 ZOOM_connection_set_mask(c, mask);
3995 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
3996 ZOOM_connection_put_event(c, event);
3998 if (c->proto == PROTO_Z3950)
3999 ZOOM_connection_send_init(c);
4002 /* no init request for SRW .. */
4003 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4004 ZOOM_connection_remove_task(c);
4005 ZOOM_connection_set_mask(c, 0);
4006 ZOOM_connection_exec_task(c);
4008 c->state = STATE_ESTABLISHED;
4012 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4018 if (mask & ZOOM_SELECT_EXCEPT)
4020 if (ZOOM_test_reconnect(c))
4022 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4023 ZOOM_connection_put_event(c, event);
4027 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4032 if (mask & ZOOM_SELECT_READ)
4034 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4040 ZOOM_connection_last_event(ZOOM_connection cs)
4043 return ZOOM_EVENT_NONE;
4044 return cs->last_event;
4049 * Returns an xmalloc()d string containing RPN that corresponds to the
4050 * CQL passed in. On error, sets the Connection object's error state
4051 * and returns a null pointer.
4052 * ### We could cache CQL parser and/or transformer in Connection.
4054 static char *cql2pqf(ZOOM_connection c, const char *cql)
4058 struct cql_node *node;
4059 const char *cqlfile;
4060 static cql_transform_t trans;
4063 parser = cql_parser_create();
4064 if ((error = cql_parser_string(parser, cql)) != 0) {
4065 cql_parser_destroy(parser);
4066 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4070 node = cql_parser_result(parser);
4071 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4073 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4075 cql_parser_destroy(parser);
4076 cql_node_destroy(node);
4077 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4081 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4083 cql_parser_destroy(parser);
4084 cql_node_destroy(node);
4085 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4086 cqlfile, strerror(errno));
4087 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4091 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4092 cql_parser_destroy(parser);
4093 cql_node_destroy(node);
4096 const char *addinfo;
4097 error = cql_transform_error(trans, &addinfo);
4098 cql_transform_close(trans);
4099 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4100 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4104 cql_transform_close(trans);
4105 return xstrdup(pqfbuf);
4108 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4112 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4113 /* timeout and this connection was waiting */
4114 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4116 ZOOM_connection_put_event(c, event);
4122 ZOOM_process_event(int no, ZOOM_connection *cs)
4126 yaz_log(log_details, "ZOOM_event_poll(no=%d,cs=%p)", no, cs);
4128 for (i = 0; i<no; i++)
4130 ZOOM_connection c = cs[i];
4135 ZOOM_connection_show_tasks(c);
4138 if (c && (event = ZOOM_connection_get_event(c)))
4140 ZOOM_Event_destroy(event);
4144 for (i = 0; i<no; i++)
4146 ZOOM_connection c = cs[i];
4150 ZOOM_connection_exec_task(c);
4151 if ((event = ZOOM_connection_get_event(c)))
4153 ZOOM_Event_destroy(event);
4161 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4163 if (c->mask && mask)
4164 ZOOM_connection_do_io(c, mask);
4168 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4171 return cs_fileno(c->cs);
4175 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4183 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4190 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4192 return ZOOM_options_get_int(c->options, "timeout", 30);
4198 * indent-tabs-mode: nil
4200 * vim: shiftwidth=4 tabstop=8 expandtab