2 * Copyright (C) 1995-2006, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.87 2006-08-25 14:57:04 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>
31 #include <sys/types.h>
40 #include <sys/select.h>
46 static int log_api = 0;
47 static int log_details = 0;
54 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
55 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
56 static char *cql2pqf(ZOOM_connection c, const char *cql);
60 static int log_level_initialized = 0;
61 if (!log_level_initialized)
63 log_api = yaz_log_module_level("zoom");
64 log_details = yaz_log_module_level("zoomdetails");
65 log_level_initialized = 1;
69 static ZOOM_Event ZOOM_Event_create(int kind)
71 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
75 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
79 static void ZOOM_Event_destroy(ZOOM_Event event)
84 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
88 c->m_queue_back->prev = event;
89 assert(c->m_queue_front);
93 assert(!c->m_queue_front);
94 c->m_queue_front = event;
96 event->next = c->m_queue_back;
98 c->m_queue_back = event;
101 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
103 ZOOM_Event event = c->m_queue_front;
106 c->last_event = ZOOM_EVENT_NONE;
109 assert(c->m_queue_back);
110 c->m_queue_front = event->prev;
111 if (c->m_queue_front)
113 assert(c->m_queue_back);
114 c->m_queue_front->next = 0;
118 c->last_event = event->kind;
123 static void set_dset_error(ZOOM_connection c, int error,
125 const char *addinfo, const char *addinfo2)
132 if (!c->diagset || strcmp(dset, c->diagset))
135 c->diagset = xstrdup(dset);
136 /* remove integer part from SRW diagset .. */
137 if ((cp = strrchr(c->diagset, '/')))
140 if (addinfo && addinfo2)
142 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
143 strcpy(c->addinfo, addinfo);
144 strcat(c->addinfo, addinfo2);
147 c->addinfo = xstrdup(addinfo);
149 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
150 c, c->host_port ? c->host_port : "<>", dset, error,
151 addinfo ? addinfo : "",
152 addinfo2 ? addinfo2 : "");
156 static void set_HTTP_error(ZOOM_connection c, int error,
157 const char *addinfo, const char *addinfo2)
159 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
163 static void set_ZOOM_error(ZOOM_connection c, int error,
166 set_dset_error(c, error, "ZOOM", addinfo, 0);
169 static void clear_error(ZOOM_connection c)
172 * If an error is tied to an operation then it's ok to clear: for
173 * example, a diagnostic returned from a search is cleared by a
174 * subsequent search. However, problems such as Connection Lost
175 * or Init Refused are not cleared, because they are not
176 * recoverable: doing another search doesn't help.
180 case ZOOM_ERROR_CONNECT:
181 case ZOOM_ERROR_MEMORY:
182 case ZOOM_ERROR_DECODE:
183 case ZOOM_ERROR_CONNECTION_LOST:
184 case ZOOM_ERROR_INIT:
185 case ZOOM_ERROR_INTERNAL:
186 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
189 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
193 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
195 ZOOM_task *taskp = &c->tasks;
197 taskp = &(*taskp)->next;
198 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
199 (*taskp)->running = 0;
200 (*taskp)->which = which;
206 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
208 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
210 task->next = c->tasks;
219 void ZOOM_connection_remove_task(ZOOM_connection c)
221 ZOOM_task task = c->tasks;
225 c->tasks = task->next;
228 case ZOOM_TASK_SEARCH:
229 ZOOM_resultset_destroy(task->u.search.resultset);
231 case ZOOM_TASK_RETRIEVE:
232 ZOOM_resultset_destroy(task->u.retrieve.resultset);
234 case ZOOM_TASK_CONNECT:
237 ZOOM_scanset_destroy(task->u.scan.scan);
239 case ZOOM_TASK_PACKAGE:
240 ZOOM_package_destroy(task->u.package);
243 ZOOM_resultset_destroy(task->u.sort.resultset);
244 ZOOM_query_destroy(task->u.sort.q);
253 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
254 ZOOM_connection_put_event(c, event);
259 static int ZOOM_connection_exec_task(ZOOM_connection c);
261 void ZOOM_connection_remove_tasks(ZOOM_connection c)
264 ZOOM_connection_remove_task(c);
267 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos);
269 ZOOM_API(ZOOM_connection)
270 ZOOM_connection_create(ZOOM_options options)
272 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
276 yaz_log(log_api, "%p ZOOM_connection_create", c);
278 c->proto = PROTO_Z3950;
282 c->state = STATE_IDLE;
285 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
292 c->options = ZOOM_options_create_with_parent(options);
298 c->charset = c->lang = 0;
305 c->odr_in = odr_createmem(ODR_DECODE);
306 c->odr_out = odr_createmem(ODR_ENCODE);
309 c->support_named_resultsets = 0;
310 c->last_event = ZOOM_EVENT_NONE;
312 c->m_queue_front = 0;
317 /* set database names. Take local databases (if set); otherwise
318 take databases given in ZURL (if set); otherwise use Default */
319 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
322 char **databaseNames;
323 const char *cp = ZOOM_options_get(options, "databaseName");
325 if ((!cp || !*cp) && con->host_port)
327 if (strncmp(con->host_port, "unix:", 5) == 0)
328 cp = strchr(con->host_port+5, ':');
330 cp = strchr(con->host_port, '/');
336 nmem_strsplit(con->odr_out->mem, "+", cp, &databaseNames, num);
337 return databaseNames;
340 ZOOM_API(ZOOM_connection)
341 ZOOM_connection_new(const char *host, int portnum)
343 ZOOM_connection c = ZOOM_connection_create(0);
345 ZOOM_connection_connect(c, host, portnum);
349 static zoom_sru_mode get_sru_mode_from_string(const char *s)
352 return zoom_sru_soap;
353 if (!yaz_matchstr(s, "soap"))
354 return zoom_sru_soap;
355 else if (!yaz_matchstr(s, "get"))
357 else if (!yaz_matchstr(s, "post"))
358 return zoom_sru_post;
359 return zoom_sru_error;
363 ZOOM_connection_connect(ZOOM_connection c,
364 const char *host, int portnum)
371 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
374 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
375 ZOOM_connection_remove_tasks(c);
379 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
383 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
385 val = ZOOM_options_get(c->options, "proxy");
388 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
389 c->proxy = xstrdup(val);
395 val = ZOOM_options_get(c->options, "charset");
398 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
399 c->charset = xstrdup(val);
405 val = ZOOM_options_get(c->options, "lang");
408 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
409 c->lang = xstrdup(val);
414 val = ZOOM_options_get(c->options, "sru");
415 c->sru_mode = get_sru_mode_from_string(val);
421 sprintf(hostn, "%.80s:%d", host, portnum);
422 c->host_port = xstrdup(hostn);
425 c->host_port = xstrdup(host);
429 * If the "<scheme>:" part of the host string is preceded by one
430 * or more comma-separated <name>=<value> pairs, these are taken
431 * to be options to be set on the connection object. Among other
432 * applications, this facility can be used to embed authentication
434 * user=admin,password=secret,tcp:localhost:9999
436 char *remainder = c->host_port;
437 char *pcolon = strchr(remainder, ':');
440 while ((pcomma = strchr(remainder, ',')) != 0 &&
441 (pcolon == 0 || pcomma < pcolon)) {
443 if ((pequals = strchr(remainder, '=')) != 0) {
445 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
446 ZOOM_connection_option_set(c, remainder, pequals+1);
448 remainder = pcomma+1;
451 if (remainder != c->host_port) {
453 c->host_port = xstrdup(remainder);
454 /*printf("# reset hp='%s'\n", remainder);*/
458 ZOOM_options_set(c->options, "host", c->host_port);
460 val = ZOOM_options_get(c->options, "cookie");
463 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
464 c->cookie_out = xstrdup(val);
467 val = ZOOM_options_get(c->options, "clientIP");
470 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
472 c->client_IP = xstrdup(val);
475 c->async = ZOOM_options_get_bool(c->options, "async", 0);
476 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
478 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
482 while (ZOOM_event(1, &c))
488 ZOOM_query_create(void)
490 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
492 yaz_log(log_details, "%p ZOOM_query_create", s);
496 s->odr = odr_createmem(ODR_ENCODE);
503 ZOOM_query_destroy(ZOOM_query s)
509 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
510 if (s->refcount == 0)
518 ZOOM_query_prefix(ZOOM_query s, const char *str)
520 s->query_string = odr_strdup(s->odr, str);
521 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
522 s->z_query->which = Z_Query_type_1;
523 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
524 if (!s->z_query->u.type_1)
526 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
530 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
535 ZOOM_query_cql(ZOOM_query s, const char *str)
539 s->query_string = odr_strdup(s->odr, str);
541 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
542 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
543 ext->indirect_reference = 0;
545 ext->which = Z_External_CQL;
546 ext->u.cql = s->query_string;
548 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
549 s->z_query->which = Z_Query_type_104;
550 s->z_query->u.type_104 = ext;
552 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
558 * Translate the CQL string client-side into RPN which is passed to
559 * the server. This is useful for server's that don't themselves
560 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
561 * only as a place to stash diagnostics if compilation fails; if this
562 * information is not needed, a null pointer may be used.
565 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
569 ZOOM_connection freeme = 0;
571 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
573 conn = freeme = ZOOM_connection_create(0);
575 rpn = cql2pqf(conn, str);
577 ZOOM_connection_destroy(freeme);
581 ret = ZOOM_query_prefix(s, rpn);
587 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
588 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
589 * to the server, as the YAZ GFS doesn't know how to handle this.
592 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
593 int *ccl_error, const char **error_string,
597 struct ccl_rpn_node *rpn;
598 CCL_bibset bibset = ccl_qual_mk();
601 ccl_qual_buf(bibset, config);
603 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
606 *error_string = ccl_err_msg(*ccl_error);
611 WRBUF wr = wrbuf_alloc();
614 ret = ZOOM_query_prefix(s, wrbuf_buf(wr));
617 ccl_qual_rm(&bibset);
622 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
624 s->sort_spec = yaz_sort_spec(s->odr, criteria);
627 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
631 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
635 static zoom_ret do_write(ZOOM_connection c);
638 ZOOM_connection_destroy(ZOOM_connection c)
643 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
646 for (r = c->resultsets; r; r = r->next)
652 odr_destroy(c->odr_in);
653 odr_destroy(c->odr_out);
654 ZOOM_options_destroy(c->options);
655 ZOOM_connection_remove_tasks(c);
661 xfree(c->cookie_out);
667 void ZOOM_resultset_addref(ZOOM_resultset r)
672 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
677 ZOOM_resultset ZOOM_resultset_create()
680 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
684 yaz_log(log_details, "%p ZOOM_resultset_create", r);
687 r->odr = odr_createmem(ODR_ENCODE);
692 for (i = 0; i<RECORD_HASH_SIZE; i++)
693 r->record_hash[i] = 0;
701 ZOOM_API(ZOOM_resultset)
702 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
705 ZOOM_query s = ZOOM_query_create();
707 ZOOM_query_prefix(s, q);
709 r = ZOOM_connection_search(c, s);
710 ZOOM_query_destroy(s);
714 ZOOM_API(ZOOM_resultset)
715 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
717 ZOOM_resultset r = ZOOM_resultset_create();
722 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
723 r->r_sort_spec = q->sort_spec;
726 r->options = ZOOM_options_create_with_parent(c->options);
728 start = ZOOM_options_get_int(r->options, "start", 0);
729 count = ZOOM_options_get_int(r->options, "count", 0);
731 /* If "presentChunk" is defined use that; otherwise "step" */
732 const char *cp = ZOOM_options_get(r->options, "presentChunk");
733 r->step = ZOOM_options_get_int(r->options,
734 (cp != 0 ? "presentChunk": "step"), 0);
736 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
737 cp = ZOOM_options_get(r->options, "setname");
739 r->setname = xstrdup(cp);
740 cp = ZOOM_options_get(r->options, "schema");
742 r->schema = xstrdup(cp);
746 r->next = c->resultsets;
749 if (c->host_port && c->proto == PROTO_HTTP)
753 yaz_log(log_details, "ZOOM_connection_search: no comstack");
754 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
758 yaz_log(log_details, "ZOOM_connection_search: reconnect");
763 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
764 task->u.search.resultset = r;
765 task->u.search.start = start;
766 task->u.search.count = count;
767 ZOOM_resultset_addref(r);
773 while (ZOOM_event(1, &c))
780 * This is the old result-set sorting API, which is maintained only
781 * for the sake of binary compatibility. There is no reason ever to
782 * use this rather than ZOOM_resultset_sort1().
785 ZOOM_resultset_sort(ZOOM_resultset r,
786 const char *sort_type, const char *sort_spec)
788 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
792 ZOOM_resultset_sort1(ZOOM_resultset r,
793 const char *sort_type, const char *sort_spec)
795 ZOOM_connection c = r->connection;
799 newq = ZOOM_query_create();
800 if (ZOOM_query_sortby(newq, sort_spec) < 0)
803 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
804 r, r, sort_type, sort_spec);
808 if (c->host_port && c->proto == PROTO_HTTP)
812 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
813 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
817 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
823 ZOOM_resultset_cache_reset(r);
824 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
825 task->u.sort.resultset = r;
826 task->u.sort.q = newq;
828 ZOOM_resultset_addref(r);
832 while (ZOOM_event(1, &c))
840 ZOOM_resultset_cache_reset(ZOOM_resultset r)
843 for (i = 0; i<RECORD_HASH_SIZE; i++)
845 ZOOM_record_cache rc;
846 for (rc = r->record_hash[i]; rc; rc = rc->next)
848 if (rc->rec.wrbuf_marc)
849 wrbuf_free(rc->rec.wrbuf_marc, 1);
850 if (rc->rec.wrbuf_iconv)
851 wrbuf_free(rc->rec.wrbuf_iconv, 1);
852 if (rc->rec.wrbuf_opac)
853 wrbuf_free(rc->rec.wrbuf_opac, 1);
855 r->record_hash[i] = 0;
860 ZOOM_resultset_destroy(ZOOM_resultset r)
865 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
867 if (r->refcount == 0)
869 ZOOM_resultset_cache_reset(r);
873 /* remove ourselves from the resultsets in connection */
874 ZOOM_resultset *rp = &r->connection->resultsets;
877 assert(*rp); /* we must be in this list!! */
879 { /* OK, we're here - take us out of it */
886 ZOOM_query_destroy(r->query);
887 ZOOM_options_destroy(r->options);
896 ZOOM_resultset_size(ZOOM_resultset r)
901 static void do_close(ZOOM_connection c)
907 c->state = STATE_IDLE;
910 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
911 int force_sync, int start, int count)
919 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
920 " count=%d", r, force_sync, start, count);
925 if (c->host_port && c->proto == PROTO_HTTP)
929 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
930 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
934 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
939 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
940 task->u.retrieve.resultset = r;
941 task->u.retrieve.start = start;
942 task->u.retrieve.count = count;
944 cp = ZOOM_options_get(r->options, "schema");
947 if (!r->schema || strcmp(r->schema, cp))
950 r->schema = xstrdup(cp);
954 ZOOM_resultset_addref(r);
956 if (!r->connection->async || force_sync)
957 while (r->connection && ZOOM_event(1, &r->connection))
962 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
963 size_t start, size_t count)
965 int force_present = 0;
969 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
970 r, r, (long) start, (long) count);
973 ZOOM_resultset_retrieve(r, force_present, start, count);
977 for (i = 0; i< count; i++)
978 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
982 static void get_cert(ZOOM_connection c)
987 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
989 ZOOM_connection_option_setl(c, "sslPeerCert",
995 static zoom_ret do_connect(ZOOM_connection c)
998 const char *effective_host;
1001 effective_host = c->proxy;
1003 effective_host = c->host_port;
1005 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1009 c->cs = cs_create_host(effective_host, 0, &add);
1011 if (c->cs && c->cs->protocol == PROTO_HTTP)
1014 const char *path = 0;
1016 c->proto = PROTO_HTTP;
1017 cs_get_host_args(c->host_port, &path);
1019 c->path = (char*) xmalloc(strlen(path)+2);
1021 strcpy(c->path+1, path);
1023 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1025 return zoom_complete;
1030 int ret = cs_connect(c->cs, add);
1033 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1034 ZOOM_connection_put_event(c, event);
1036 if (c->proto == PROTO_Z3950)
1037 ZOOM_connection_send_init(c);
1040 /* no init request for SRW .. */
1041 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1042 ZOOM_connection_remove_task(c);
1044 ZOOM_connection_exec_task(c);
1046 c->state = STATE_ESTABLISHED;
1047 return zoom_pending;
1051 c->state = STATE_CONNECTING;
1052 c->mask = ZOOM_SELECT_EXCEPT;
1053 if (c->cs->io_pending & CS_WANT_WRITE)
1054 c->mask += ZOOM_SELECT_WRITE;
1055 if (c->cs->io_pending & CS_WANT_READ)
1056 c->mask += ZOOM_SELECT_READ;
1057 return zoom_pending;
1060 c->state = STATE_IDLE;
1061 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1062 return zoom_complete;
1065 int z3950_connection_socket(ZOOM_connection c)
1068 return cs_fileno(c->cs);
1072 int z3950_connection_mask(ZOOM_connection c)
1079 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1082 for (i = 0; i<200; i++)
1085 Z_OtherInformation **oi;
1091 sprintf(buf, "otherInfo%d", i);
1092 val = ZOOM_options_get(c->options, buf);
1095 cp = strchr(val, ':');
1099 if (len >= sizeof(buf))
1100 len = sizeof(buf)-1;
1101 memcpy(buf, val, len);
1103 oidval = oid_getvalbyname(buf);
1104 if (oidval == VAL_NONE)
1107 yaz_oi_APDU(a, &oi);
1108 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1112 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1117 Z_OtherInformation **oi;
1118 yaz_oi_APDU(a, &oi);
1119 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1123 Z_OtherInformation **oi;
1124 yaz_oi_APDU(a, &oi);
1125 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1127 otherInfo_attach(c, a, out);
1128 if (!z_APDU(out, &a, 0, 0))
1130 FILE *outf = fopen("/tmp/apdu.txt", "a");
1133 ODR odr_pr = odr_createmem(ODR_PRINT);
1134 fprintf(outf, "a=%p\n", a);
1135 odr_setprint(odr_pr, outf);
1136 z_APDU(odr_pr, &a, 0, 0);
1137 odr_destroy(odr_pr);
1139 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1140 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1144 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1148 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1152 if (encode_APDU(c, a, c->odr_out))
1153 return zoom_complete;
1154 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1155 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1156 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1157 ZOOM_connection_put_event(c, event);
1158 odr_reset(c->odr_out);
1162 /* returns 1 if PDU was sent OK (still pending )
1163 0 if PDU was not sent OK (nothing to wait for)
1166 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1168 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1169 Z_InitRequest *ireq = apdu->u.initRequest;
1170 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1171 odr_malloc(c->odr_out, sizeof(*auth));
1172 const char *auth_groupId = ZOOM_options_get(c->options, "group");
1173 const char *auth_userId = ZOOM_options_get(c->options, "user");
1174 const char *auth_password = ZOOM_options_get(c->options, "password");
1177 /* support the pass for backwards compatibility */
1179 auth_password = ZOOM_options_get(c->options, "pass");
1181 ODR_MASK_SET(ireq->options, Z_Options_search);
1182 ODR_MASK_SET(ireq->options, Z_Options_present);
1183 ODR_MASK_SET(ireq->options, Z_Options_scan);
1184 ODR_MASK_SET(ireq->options, Z_Options_sort);
1185 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1186 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1188 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1189 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1190 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1192 /* Index Data's Z39.50 Implementor Id is 81 */
1193 ireq->implementationId =
1194 odr_prepend(c->odr_out,
1195 ZOOM_options_get(c->options, "implementationId"),
1196 odr_prepend(c->odr_out, "81", ireq->implementationId));
1198 ireq->implementationName =
1199 odr_prepend(c->odr_out,
1200 ZOOM_options_get(c->options, "implementationName"),
1201 odr_prepend(c->odr_out, "ZOOM-C",
1202 ireq->implementationName));
1204 version = odr_strdup(c->odr_out, "$Revision: 1.87 $");
1205 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1206 version[strlen(version)-2] = '\0';
1207 ireq->implementationVersion =
1208 odr_prepend(c->odr_out,
1209 ZOOM_options_get(c->options, "implementationVersion"),
1210 odr_prepend(c->odr_out, &version[11],
1211 ireq->implementationVersion));
1213 *ireq->maximumRecordSize =
1214 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
1215 *ireq->preferredMessageSize =
1216 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
1218 if (auth_groupId || auth_password)
1220 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1223 if (auth_groupId && *auth_groupId)
1225 pass->groupId = (char *)
1226 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1227 strcpy(pass->groupId, auth_groupId);
1231 if (auth_userId && *auth_userId)
1233 pass->userId = (char *)
1234 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1235 strcpy(pass->userId, auth_userId);
1239 if (auth_password && *auth_password)
1241 pass->password = (char *)
1242 odr_malloc(c->odr_out, strlen(auth_password)+1);
1243 strcpy(pass->password, auth_password);
1248 auth->which = Z_IdAuthentication_idPass;
1249 auth->u.idPass = pass;
1250 ireq->idAuthentication = auth;
1253 else if (auth_userId)
1255 auth->which = Z_IdAuthentication_open;
1256 auth->u.open = (char *)
1257 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1258 strcpy(auth->u.open, auth_userId);
1259 ireq->idAuthentication = auth;
1262 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1263 VAL_PROXY, 1, c->host_port);
1264 if (c->charset || c->lang)
1266 Z_OtherInformation **oi;
1267 Z_OtherInformationUnit *oi_unit;
1269 yaz_oi_APDU(apdu, &oi);
1271 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1273 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1274 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1275 oi_unit->information.externallyDefinedInfo =
1276 yaz_set_proposal_charneg_list(c->odr_out, " ",
1277 c->charset, c->lang, 1);
1281 return send_APDU(c, apdu);
1285 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1290 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1292 if (c->sru_mode == zoom_sru_get)
1294 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1296 else if (c->sru_mode == zoom_sru_post)
1298 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1300 else if (c->sru_mode == zoom_sru_soap)
1302 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1304 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1305 return zoom_complete;
1306 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1308 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1309 ZOOM_connection_put_event(c, event);
1310 odr_reset(c->odr_out);
1316 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1320 ZOOM_resultset resultset = 0;
1322 const char *option_val = 0;
1324 if (c->error) /* don't continue on error */
1325 return zoom_complete;
1327 if (c->tasks->which == ZOOM_TASK_SEARCH)
1329 resultset = c->tasks->u.search.resultset;
1330 resultset->setname = xstrdup("default");
1331 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1332 start = &c->tasks->u.search.start;
1333 count = &c->tasks->u.search.count;
1335 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
1337 resultset = c->tasks->u.retrieve.resultset;
1339 start = &c->tasks->u.retrieve.start;
1340 count = &c->tasks->u.retrieve.count;
1342 if (*start >= resultset->size)
1343 return zoom_complete;
1344 if (*start + *count > resultset->size)
1345 *count = resultset->size - *start;
1347 for (i = 0; i < *count; i++)
1350 record_cache_lookup(resultset, i + *start);
1355 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1356 ZOOM_connection_put_event(c, event);
1363 return zoom_complete;
1365 assert(resultset->query);
1367 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1369 if (resultset->query->z_query->which == Z_Query_type_104
1370 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1372 sr->u.request->query_type = Z_SRW_query_type_cql;
1373 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1375 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1376 resultset->query->z_query->u.type_1)
1378 sr->u.request->query_type = Z_SRW_query_type_pqf;
1379 sr->u.request->query.pqf = resultset->query->query_string;
1383 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1384 return zoom_complete;
1386 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1387 sr->u.request->maximumRecords = odr_intdup(
1388 c->odr_out, resultset->step>0 ? resultset->step : *count);
1389 sr->u.request->recordSchema = resultset->schema;
1391 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1393 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1395 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1397 sr->extra_args = odr_strdup(c->odr_out, option_val);
1398 return send_srw(c, sr);
1401 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1403 return zoom_complete;
1407 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1410 int lslb, ssub, mspn;
1412 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1413 Z_SearchRequest *search_req = apdu->u.searchRequest;
1414 const char *elementSetName;
1415 const char *smallSetElementSetName;
1416 const char *mediumSetElementSetName;
1419 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1421 r = c->tasks->u.search.resultset;
1423 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1426 ZOOM_options_get(r->options, "elementSetName");
1427 smallSetElementSetName =
1428 ZOOM_options_get(r->options, "smallSetElementSetName");
1429 mediumSetElementSetName =
1430 ZOOM_options_get(r->options, "mediumSetElementSetName");
1432 if (!smallSetElementSetName)
1433 smallSetElementSetName = elementSetName;
1435 if (!mediumSetElementSetName)
1436 mediumSetElementSetName = elementSetName;
1441 /* prepare query for the search request */
1442 search_req->query = r->query->z_query;
1443 if (!search_req->query)
1445 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1446 return zoom_complete;
1449 search_req->databaseNames =
1450 set_DatabaseNames(c, r->options, &search_req->num_databaseNames);
1452 /* get syntax (no need to provide unless piggyback is in effect) */
1453 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1455 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1456 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1457 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1458 if (lslb != -1 && ssub != -1 && mspn != -1)
1460 /* So're a Z39.50 expert? Let's hope you don't do sort */
1461 *search_req->largeSetLowerBound = lslb;
1462 *search_req->smallSetUpperBound = ssub;
1463 *search_req->mediumSetPresentNumber = mspn;
1465 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1466 && r->piggyback && !r->r_sort_spec && !r->schema)
1468 /* Regular piggyback - do it unless we're going to do sort */
1469 *search_req->largeSetLowerBound = 2000000000;
1470 *search_req->smallSetUpperBound = 1;
1471 *search_req->mediumSetPresentNumber =
1472 r->step>0 ? r->step : c->tasks->u.search.count;
1476 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1477 smallSetElementSetName = 0;
1478 mediumSetElementSetName = 0;
1481 if (smallSetElementSetName && *smallSetElementSetName)
1483 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1484 odr_malloc(c->odr_out, sizeof(*esn));
1486 esn->which = Z_ElementSetNames_generic;
1487 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1488 search_req->smallSetElementSetNames = esn;
1490 if (mediumSetElementSetName && *mediumSetElementSetName)
1492 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1493 odr_malloc(c->odr_out, sizeof(*esn));
1495 esn->which = Z_ElementSetNames_generic;
1496 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1497 search_req->mediumSetElementSetNames = esn;
1500 search_req->preferredRecordSyntax =
1501 yaz_str_to_z3950oid(c->odr_out, CLASS_RECSYN, syntax);
1505 if (c->support_named_resultsets)
1509 /* find the lowest unused ordinal so that we re-use
1510 result sets on the server. */
1511 for (ord = 1; ; ord++)
1514 sprintf(setname, "%d", ord);
1515 for (rp = c->resultsets; rp; rp = rp->next)
1516 if (rp->setname && !strcmp(rp->setname, setname))
1521 r->setname = xstrdup(setname);
1522 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1523 "set %s", c, r->setname);
1527 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1529 r->setname = xstrdup("default");
1531 ZOOM_options_set(r->options, "setname", r->setname);
1533 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1534 return send_APDU(c, apdu);
1537 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1544 case Z_DefaultDiagFormat_v2Addinfo:
1545 addinfo = r->u.v2Addinfo;
1547 case Z_DefaultDiagFormat_v3Addinfo:
1548 addinfo = r->u.v3Addinfo;
1553 set_dset_error(c, *r->condition,
1554 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1558 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1560 if (p->which != Z_DiagRec_defaultFormat)
1561 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1563 response_default_diag(c, p->u.defaultFormat);
1566 ZOOM_API(ZOOM_record)
1567 ZOOM_record_clone(ZOOM_record srec)
1574 odr_enc = odr_createmem(ODR_ENCODE);
1575 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1577 buf = odr_getbuf(odr_enc, &size, 0);
1579 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1580 nrec->odr = odr_createmem(ODR_DECODE);
1581 nrec->wrbuf_marc = 0;
1582 nrec->wrbuf_iconv = 0;
1583 nrec->wrbuf_opac = 0;
1584 odr_setbuf(nrec->odr, buf, size, 0);
1585 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1587 odr_destroy(odr_enc);
1591 ZOOM_API(ZOOM_record)
1592 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1594 return record_cache_lookup(s, pos);
1597 ZOOM_API(ZOOM_record)
1598 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1600 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1605 * MIKE: I think force_sync should always be zero, but I don't
1606 * want to make this change until I get the go-ahead from
1607 * Adam, in case something depends on the old synchronous
1611 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1612 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1613 rec = ZOOM_resultset_record_immediate(r, pos);
1619 ZOOM_record_destroy(ZOOM_record rec)
1623 if (rec->wrbuf_marc)
1624 wrbuf_free(rec->wrbuf_marc, 1);
1625 if (rec->wrbuf_iconv)
1626 wrbuf_free(rec->wrbuf_iconv, 1);
1627 if (rec->wrbuf_opac)
1628 wrbuf_free(rec->wrbuf_opac, 1);
1629 odr_destroy(rec->odr);
1633 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1635 const char *buf, int sz,
1636 const char *record_charset)
1641 yaz_marc_t mt = yaz_marc_create();
1644 strcpy(to, "UTF-8");
1645 if (record_charset && *record_charset)
1647 /* Use "from,to" or just "from" */
1648 const char *cp = strchr(record_charset, ',');
1649 int clen = strlen(record_charset);
1652 strncpy( to, cp+1, sizeof(to)-1);
1653 to[sizeof(to)-1] = '\0';
1654 clen = cp - record_charset;
1656 if (clen > sizeof(from)-1)
1657 clen = sizeof(from)-1;
1660 strncpy(from, record_charset, clen);
1666 cd = yaz_iconv_open(to, from);
1667 yaz_marc_iconv(mt, cd);
1670 yaz_marc_xml(mt, marc_type);
1671 if (!rec->wrbuf_marc)
1672 rec->wrbuf_marc = wrbuf_alloc();
1673 wrbuf_rewind(rec->wrbuf_marc);
1674 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1676 yaz_marc_destroy(mt);
1678 yaz_iconv_close(cd);
1680 *len = wrbuf_len(rec->wrbuf_marc);
1681 return wrbuf_buf(rec->wrbuf_marc);
1683 yaz_marc_destroy(mt);
1685 yaz_iconv_close(cd);
1689 static const char *record_iconv_return(ZOOM_record rec, int *len,
1690 const char *buf, int sz,
1691 const char *record_charset)
1698 strcpy(to, "UTF-8");
1699 if (record_charset && *record_charset)
1701 /* Use "from,to" or just "from" */
1702 const char *cp = strchr(record_charset, ',');
1703 int clen = strlen(record_charset);
1706 strncpy( to, cp+1, sizeof(to)-1);
1707 to[sizeof(to)-1] = '\0';
1708 clen = cp - record_charset;
1710 if (clen > sizeof(from)-1)
1711 clen = sizeof(from)-1;
1714 strncpy(from, record_charset, clen);
1718 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1721 size_t inbytesleft = sz;
1722 const char *inp = buf;
1724 if (!rec->wrbuf_iconv)
1725 rec->wrbuf_iconv = wrbuf_alloc();
1727 wrbuf_rewind(rec->wrbuf_iconv);
1731 size_t outbytesleft = sizeof(outbuf);
1732 char *outp = outbuf;
1733 size_t r = yaz_iconv(cd, (char**) &inp,
1735 &outp, &outbytesleft);
1736 if (r == (size_t) (-1))
1738 int e = yaz_iconv_error(cd);
1739 if (e != YAZ_ICONV_E2BIG)
1742 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1744 wrbuf_puts(rec->wrbuf_iconv, "");
1745 buf = wrbuf_buf(rec->wrbuf_iconv);
1746 sz = wrbuf_len(rec->wrbuf_iconv);
1747 yaz_iconv_close(cd);
1754 ZOOM_API(const char *)
1755 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1762 Z_NamePlusRecord *npr;
1765 *len = 0; /* default return */
1774 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1776 if (cp[i] == ';' || cp[i] == ' ')
1782 while (type_spec[i] == ';')
1785 while (type_spec[i] == ' ')
1787 if (!strncmp(type_spec+i, "charset=", 8))
1790 i = i + 8; /* skip charset= */
1791 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1793 if (type_spec[i] == ';' || type_spec[i] == ' ')
1799 else if (!strncmp(type_spec+i, "xpath=", 6))
1803 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1807 while (type_spec[i] == ' ')
1810 if (!strcmp(type, "database"))
1813 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1814 return npr->databaseName;
1816 else if (!strcmp(type, "syntax"))
1818 const char *desc = 0;
1819 if (npr->which == Z_NamePlusRecord_databaseRecord)
1821 Z_External *r = (Z_External *) npr->u.databaseRecord;
1822 oident *ent = oid_getentbyoid(r->direct_reference);
1829 *len = strlen(desc);
1832 if (npr->which != Z_NamePlusRecord_databaseRecord)
1835 /* from now on - we have a database record .. */
1836 if (!strcmp(type, "render"))
1838 Z_External *r = (Z_External *) npr->u.databaseRecord;
1839 oident *ent = oid_getentbyoid(r->direct_reference);
1841 /* render bibliographic record .. */
1842 if (r->which == Z_External_OPAC)
1844 r = r->u.opac->bibliographicRecord;
1847 ent = oid_getentbyoid(r->direct_reference);
1849 if (r->which == Z_External_sutrs)
1850 return record_iconv_return(rec, len,
1851 (char*) r->u.sutrs->buf,
1854 else if (r->which == Z_External_octet)
1856 const char *ret_buf;
1864 case VAL_APPLICATION_XML:
1867 ret_buf = marc_iconv_return(
1868 rec, YAZ_MARC_LINE, len,
1869 (const char *) r->u.octet_aligned->buf,
1870 r->u.octet_aligned->len,
1875 return record_iconv_return(rec, len,
1876 (const char *) r->u.octet_aligned->buf,
1877 r->u.octet_aligned->len,
1880 else if (r->which == Z_External_grs1)
1882 if (!rec->wrbuf_marc)
1883 rec->wrbuf_marc = wrbuf_alloc();
1884 wrbuf_rewind(rec->wrbuf_marc);
1885 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1886 return record_iconv_return(rec, len,
1887 wrbuf_buf(rec->wrbuf_marc),
1888 wrbuf_len(rec->wrbuf_marc),
1893 else if (!strcmp(type, "xml"))
1895 Z_External *r = (Z_External *) npr->u.databaseRecord;
1896 oident *ent = oid_getentbyoid(r->direct_reference);
1898 /* render bibliographic record .. */
1899 if (r->which == Z_External_OPAC)
1901 r = r->u.opac->bibliographicRecord;
1904 ent = oid_getentbyoid(r->direct_reference);
1907 if (r->which == Z_External_sutrs)
1908 return record_iconv_return(rec, len,
1909 (const char *) r->u.sutrs->buf,
1912 else if (r->which == Z_External_octet)
1914 const char *ret_buf;
1915 int marc_decode_type = YAZ_MARC_MARCXML;
1924 case VAL_APPLICATION_XML:
1927 ret_buf = marc_iconv_return(
1928 rec, marc_decode_type, len,
1929 (const char *) r->u.octet_aligned->buf,
1930 r->u.octet_aligned->len,
1935 return record_iconv_return(rec, len,
1936 (const char *) r->u.octet_aligned->buf,
1937 r->u.octet_aligned->len,
1940 else if (r->which == Z_External_grs1)
1947 else if (!strcmp(type, "raw"))
1949 Z_External *r = (Z_External *) npr->u.databaseRecord;
1951 if (r->which == Z_External_sutrs)
1953 if (len) *len = r->u.sutrs->len;
1954 return (const char *) r->u.sutrs->buf;
1956 else if (r->which == Z_External_octet)
1958 if (len) *len = r->u.octet_aligned->len;
1959 return (const char *) r->u.octet_aligned->buf;
1961 else /* grs-1, explain, OPAC, ... */
1964 return (const char *) npr->u.databaseRecord;
1968 else if (!strcmp (type, "ext"))
1971 return (const char *) npr->u.databaseRecord;
1973 else if (!strcmp (type, "opac"))
1976 Z_External *r = (Z_External *) npr->u.databaseRecord;
1977 if (r->which == Z_External_OPAC)
1979 if (!rec->wrbuf_opac)
1980 rec->wrbuf_opac = wrbuf_alloc();
1981 wrbuf_rewind(rec->wrbuf_opac);
1982 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
1983 return record_iconv_return(rec, len,
1984 wrbuf_buf(rec->wrbuf_opac),
1985 wrbuf_len(rec->wrbuf_opac),
1992 static int strcmp_null(const char *v1, const char *v2)
1998 return strcmp(v1, v2);
2001 static size_t record_hash(int pos)
2005 return pos % RECORD_HASH_SIZE;
2008 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2011 ZOOM_record_cache rc;
2012 const char *elementSetName =
2013 ZOOM_resultset_option_get(r, "elementSetName");
2014 const char *syntax =
2015 ZOOM_resultset_option_get(r, "preferredRecordSyntax");
2017 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2018 ZOOM_connection_put_event(r->connection, event);
2020 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2024 if (strcmp_null(r->schema, rc->schema))
2026 if (strcmp_null(elementSetName,rc->elementSetName))
2028 if (strcmp_null(syntax, rc->syntax))
2030 /* not destroying rc->npr (it's handled by nmem )*/
2032 /* keeping wrbuf_marc too */
2036 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2039 rc->rec.wrbuf_marc = 0;
2040 rc->rec.wrbuf_iconv = 0;
2041 rc->rec.wrbuf_opac = 0;
2043 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2045 rc->elementSetName = 0;
2048 rc->syntax = odr_strdup(r->odr, syntax);
2053 rc->schema = odr_strdup(r->odr, r->schema);
2058 rc->next = r->record_hash[record_hash(pos)];
2059 r->record_hash[record_hash(pos)] = rc;
2062 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos)
2064 ZOOM_record_cache rc;
2065 const char *elementSetName =
2066 ZOOM_resultset_option_get(r, "elementSetName");
2067 const char *syntax =
2068 ZOOM_resultset_option_get(r, "preferredRecordSyntax");
2070 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2074 if (strcmp_null(r->schema, rc->schema))
2076 if (strcmp_null(elementSetName,rc->elementSetName))
2078 if (strcmp_null(syntax, rc->syntax))
2086 static void handle_records(ZOOM_connection c, Z_Records *sr,
2089 ZOOM_resultset resultset;
2094 switch (c->tasks->which)
2096 case ZOOM_TASK_SEARCH:
2097 resultset = c->tasks->u.search.resultset;
2098 start = &c->tasks->u.search.start;
2099 count = &c->tasks->u.search.count;
2101 case ZOOM_TASK_RETRIEVE:
2102 resultset = c->tasks->u.retrieve.resultset;
2103 start = &c->tasks->u.retrieve.start;
2104 count = &c->tasks->u.retrieve.count;
2109 if (sr && sr->which == Z_Records_NSD)
2110 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2111 else if (sr && sr->which == Z_Records_multipleNSD)
2113 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2114 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2116 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2120 if (*count + *start > resultset->size)
2121 *count = resultset->size - *start;
2124 if (sr && sr->which == Z_Records_DBOSD)
2127 NMEM nmem = odr_extract_mem(c->odr_in);
2128 Z_NamePlusRecordList *p =
2129 sr->u.databaseOrSurDiagnostics;
2130 for (i = 0; i<p->num_records; i++)
2132 record_cache_add(resultset, p->records[i], i + *start);
2136 yaz_log(log_details,
2137 "handle_records resultset=%p start=%d count=%d",
2138 resultset, *start, *count);
2140 /* transfer our response to search_nmem .. we need it later */
2141 nmem_transfer(resultset->odr->mem, nmem);
2143 if (present_phase && p->num_records == 0)
2145 /* present response and we didn't get any records! */
2146 Z_NamePlusRecord *myrec =
2147 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2148 record_cache_add(resultset, myrec, *start);
2151 else if (present_phase)
2153 /* present response and we didn't get any records! */
2154 Z_NamePlusRecord *myrec =
2155 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2156 record_cache_add(resultset, myrec, *start);
2161 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2163 handle_records(c, pr->records, 1);
2166 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2169 switch (term->which)
2171 case Z_Term_general:
2172 ZOOM_options_setl(opt, name,
2173 (const char *)(term->u.general->buf),
2174 term->u.general->len);
2176 case Z_Term_characterString:
2177 ZOOM_options_set(opt, name, term->u.characterString);
2179 case Z_Term_numeric:
2180 ZOOM_options_set_int(opt, name, *term->u.numeric);
2185 static void handle_queryExpression(ZOOM_options opt, const char *name,
2186 Z_QueryExpression *exp)
2192 case Z_QueryExpression_term:
2193 if (exp->u.term && exp->u.term->queryTerm)
2195 sprintf(opt_name, "%s.term", name);
2196 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2199 case Z_QueryExpression_query:
2204 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2205 Z_OtherInformation *o)
2208 for (i = 0; o && i < o->num_elements; i++)
2210 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2212 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2214 if (ext->which == Z_External_searchResult1)
2217 Z_SearchInfoReport *sr = ext->u.searchResult1;
2220 ZOOM_options_set_int(
2221 resultset->options, "searchresult.size", sr->num);
2223 for (j = 0; j < sr->num; j++)
2225 Z_SearchInfoReport_s *ent =
2226 ext->u.searchResult1->elements[j];
2229 sprintf(pref, "searchresult.%d", j);
2231 if (ent->subqueryId)
2234 sprintf(opt_name, "%s.id", pref);
2235 ZOOM_options_set(resultset->options, opt_name,
2238 if (ent->subqueryExpression)
2241 sprintf(opt_name, "%s.subquery", pref);
2242 handle_queryExpression(resultset->options, opt_name,
2243 ent->subqueryExpression);
2245 if (ent->subqueryInterpretation)
2248 sprintf(opt_name, "%s.interpretation", pref);
2249 handle_queryExpression(resultset->options, opt_name,
2250 ent->subqueryInterpretation);
2252 if (ent->subqueryRecommendation)
2255 sprintf(opt_name, "%s.recommendation", pref);
2256 handle_queryExpression(resultset->options, opt_name,
2257 ent->subqueryRecommendation);
2259 if (ent->subqueryCount)
2262 sprintf(opt_name, "%s.count", pref);
2263 ZOOM_options_set_int(resultset->options, opt_name,
2264 *ent->subqueryCount);
2272 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2274 ZOOM_resultset resultset;
2277 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2280 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2281 ZOOM_connection_put_event(c, event);
2283 resultset = c->tasks->u.search.resultset;
2285 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2287 resultset->size = *sr->resultCount;
2288 handle_records(c, sr->records, 0);
2291 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2293 if (res->diagnostics && res->num_diagnostics > 0)
2294 response_diag(c, res->diagnostics[0]);
2297 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2299 NMEM nmem = odr_extract_mem(c->odr_in);
2302 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2304 scan = c->tasks->u.scan.scan;
2306 if (res->entries && res->entries->nonsurrogateDiagnostics)
2307 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2308 scan->scan_response = res;
2309 nmem_transfer(scan->odr->mem, nmem);
2311 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2312 if (res->positionOfTerm)
2313 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2314 if (res->scanStatus)
2315 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2316 if (res->numberOfEntriesReturned)
2317 ZOOM_options_set_int(scan->options, "number",
2318 *res->numberOfEntriesReturned);
2323 static zoom_ret send_sort(ZOOM_connection c,
2324 ZOOM_resultset resultset)
2327 resultset->r_sort_spec = 0;
2328 if (resultset->r_sort_spec)
2330 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2331 Z_SortRequest *req = apdu->u.sortRequest;
2333 req->num_inputResultSetNames = 1;
2334 req->inputResultSetNames = (Z_InternationalString **)
2335 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2336 req->inputResultSetNames[0] =
2337 odr_strdup(c->odr_out, resultset->setname);
2338 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2339 req->sortSequence = resultset->r_sort_spec;
2340 resultset->r_sort_spec = 0;
2341 return send_APDU(c, apdu);
2343 return zoom_complete;
2346 static zoom_ret send_present(ZOOM_connection c)
2349 Z_PresentRequest *req = 0;
2351 const char *syntax = 0;
2352 const char *elementSetName = 0;
2353 ZOOM_resultset resultset;
2358 yaz_log(log_details, "%p send_present no tasks", c);
2359 return zoom_complete;
2362 switch (c->tasks->which)
2364 case ZOOM_TASK_SEARCH:
2365 resultset = c->tasks->u.search.resultset;
2366 start = &c->tasks->u.search.start;
2367 count = &c->tasks->u.search.count;
2369 case ZOOM_TASK_RETRIEVE:
2370 resultset = c->tasks->u.retrieve.resultset;
2371 start = &c->tasks->u.retrieve.start;
2372 count = &c->tasks->u.retrieve.count;
2374 if (*start >= resultset->size)
2376 yaz_log(log_details, "%p send_present start=%d >= size=%d",
2377 c, *start, resultset->size);
2378 return zoom_complete;
2380 if (*start + *count > resultset->size)
2381 *count = resultset->size - *start;
2384 return zoom_complete;
2386 yaz_log(log_details, "%p send_present start=%d count=%d",
2389 syntax = ZOOM_resultset_option_get(resultset, "preferredRecordSyntax");
2390 elementSetName = ZOOM_resultset_option_get(resultset, "elementSetName");
2392 if (c->error) /* don't continue on error */
2393 return zoom_complete;
2395 return zoom_complete;
2396 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2397 resultset, *start, *count);
2399 for (i = 0; i < *count; i++)
2402 record_cache_lookup(resultset, i + *start);
2407 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2408 ZOOM_connection_put_event(c, event);
2416 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2417 return zoom_complete;
2420 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2421 req = apdu->u.presentRequest;
2424 yaz_log(log_details, "%p send_present skip=%d", c, i);
2426 *req->resultSetStartPoint = *start + 1;
2427 *req->numberOfRecordsRequested = resultset->step>0 ?
2428 resultset->step : *count;
2429 if (*req->numberOfRecordsRequested + *start > resultset->size)
2430 *req->numberOfRecordsRequested = resultset->size - *start;
2431 assert(*req->numberOfRecordsRequested > 0);
2433 if (syntax && *syntax)
2434 req->preferredRecordSyntax =
2435 yaz_str_to_z3950oid(c->odr_out, CLASS_RECSYN, syntax);
2437 if (resultset->schema && *resultset->schema)
2439 Z_RecordComposition *compo = (Z_RecordComposition *)
2440 odr_malloc(c->odr_out, sizeof(*compo));
2442 req->recordComposition = compo;
2443 compo->which = Z_RecordComp_complex;
2444 compo->u.complex = (Z_CompSpec *)
2445 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2446 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2447 odr_malloc(c->odr_out, sizeof(bool_t));
2448 *compo->u.complex->selectAlternativeSyntax = 0;
2450 compo->u.complex->generic = (Z_Specification *)
2451 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2453 compo->u.complex->generic->which = Z_Schema_oid;
2454 compo->u.complex->generic->schema.oid = (Odr_oid *)
2455 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2457 if (!compo->u.complex->generic->schema.oid)
2459 /* OID wasn't a schema! Try record syntax instead. */
2461 compo->u.complex->generic->schema.oid = (Odr_oid *)
2462 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2464 if (elementSetName && *elementSetName)
2466 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2467 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2468 compo->u.complex->generic->elementSpec->which =
2469 Z_ElementSpec_elementSetName;
2470 compo->u.complex->generic->elementSpec->u.elementSetName =
2471 odr_strdup(c->odr_out, elementSetName);
2474 compo->u.complex->generic->elementSpec = 0;
2475 compo->u.complex->num_dbSpecific = 0;
2476 compo->u.complex->dbSpecific = 0;
2477 compo->u.complex->num_recordSyntax = 0;
2478 compo->u.complex->recordSyntax = 0;
2480 else if (elementSetName && *elementSetName)
2482 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2483 odr_malloc(c->odr_out, sizeof(*esn));
2484 Z_RecordComposition *compo = (Z_RecordComposition *)
2485 odr_malloc(c->odr_out, sizeof(*compo));
2487 esn->which = Z_ElementSetNames_generic;
2488 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2489 compo->which = Z_RecordComp_simple;
2490 compo->u.simple = esn;
2491 req->recordComposition = compo;
2493 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2494 return send_APDU(c, apdu);
2497 ZOOM_API(ZOOM_scanset)
2498 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2501 ZOOM_query q = ZOOM_query_create();
2503 ZOOM_query_prefix(q, start);
2505 s = ZOOM_connection_scan1(c, q);
2506 ZOOM_query_destroy(q);
2511 ZOOM_API(ZOOM_scanset)
2512 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2516 ZOOM_scanset scan = 0;
2519 * We need to check the query-type, so we can recognise CQL and
2520 * CCL and compile them into a form that we can use here. The
2521 * ZOOM_query structure has no explicit `type' member, but
2522 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2523 * functions shows how the structure is set up in each case.
2527 else if (q->z_query->which == Z_Query_type_1)
2529 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2530 c, q, q->query_string);
2531 start = q->query_string;
2533 else if (q->z_query->which == Z_Query_type_104)
2535 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2536 c, q, q->query_string);
2537 start = freeme = cql2pqf(c, q->query_string);
2543 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2544 c, q, q->query_string);
2548 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2549 scan->connection = c;
2550 scan->odr = odr_createmem(ODR_DECODE);
2551 scan->options = ZOOM_options_create_with_parent(c->options);
2553 scan->scan_response = 0;
2554 scan->termListAndStartPoint =
2555 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2557 if (scan->termListAndStartPoint != 0)
2559 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2560 task->u.scan.scan = scan;
2565 while (ZOOM_event(1, &c))
2573 ZOOM_scanset_destroy(ZOOM_scanset scan)
2578 if (scan->refcount == 0)
2580 odr_destroy(scan->odr);
2582 ZOOM_options_destroy(scan->options);
2587 static zoom_ret send_package(ZOOM_connection c)
2591 yaz_log(log_details, "%p send_package", c);
2593 return zoom_complete;
2594 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2596 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2597 ZOOM_connection_put_event(c, event);
2599 c->buf_out = c->tasks->u.package->buf_out;
2600 c->len_out = c->tasks->u.package->len_out;
2605 static zoom_ret send_scan(ZOOM_connection c)
2608 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2609 Z_ScanRequest *req = apdu->u.scanRequest;
2611 yaz_log(log_details, "%p send_scan", c);
2613 return zoom_complete;
2614 assert (c->tasks->which == ZOOM_TASK_SCAN);
2615 scan = c->tasks->u.scan.scan;
2617 req->termListAndStartPoint = scan->termListAndStartPoint;
2618 req->attributeSet = scan->attributeSet;
2620 *req->numberOfTermsRequested =
2621 ZOOM_options_get_int(scan->options, "number", 10);
2623 req->preferredPositionInResponse =
2624 odr_intdup(c->odr_out,
2625 ZOOM_options_get_int(scan->options, "position", 1));
2628 odr_intdup(c->odr_out,
2629 ZOOM_options_get_int(scan->options, "stepSize", 0));
2631 req->databaseNames = set_DatabaseNames(c, scan->options,
2632 &req->num_databaseNames);
2634 return send_APDU(c, apdu);
2638 ZOOM_scanset_size(ZOOM_scanset scan)
2640 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2642 return scan->scan_response->entries->num_entries;
2645 ZOOM_API(const char *)
2646 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2649 const char *term = 0;
2650 size_t noent = ZOOM_scanset_size(scan);
2651 Z_ScanResponse *res = scan->scan_response;
2657 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2659 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2661 if (t->term->which == Z_Term_general)
2663 term = (const char *) t->term->u.general->buf;
2664 *len = t->term->u.general->len;
2666 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2671 ZOOM_API(const char *)
2672 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2675 const char *term = 0;
2676 size_t noent = ZOOM_scanset_size(scan);
2677 Z_ScanResponse *res = scan->scan_response;
2683 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2685 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2689 term = t->displayTerm;
2690 *len = strlen(term);
2692 else if (t->term->which == Z_Term_general)
2694 term = (const char *) t->term->u.general->buf;
2695 *len = t->term->u.general->len;
2697 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2702 ZOOM_API(const char *)
2703 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2705 return ZOOM_options_get(scan->options, key);
2709 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2712 ZOOM_options_set(scan->options, key, val);
2715 static Z_APDU *create_es_package(ZOOM_package p, int type)
2718 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2719 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2721 *req->function = Z_ExtendedServicesRequest_create;
2723 str = ZOOM_options_get(p->options, "package-name");
2725 req->packageName = nmem_strdup(p->odr_out->mem, str);
2727 str = ZOOM_options_get(p->options, "user-id");
2729 req->userId = nmem_strdup(p->odr_out->mem, str);
2731 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2734 str = ZOOM_options_get(p->options, "function");
2737 if (!strcmp (str, "create"))
2739 if (!strcmp (str, "delete"))
2741 if (!strcmp (str, "modify"))
2747 static const char *ill_array_lookup(void *clientData, const char *idx)
2749 ZOOM_package p = (ZOOM_package) clientData;
2750 return ZOOM_options_get(p->options, idx+4);
2753 static Z_External *encode_ill_request(ZOOM_package p)
2755 ODR out = p->odr_out;
2758 struct ill_get_ctl ctl;
2760 ctl.odr = p->odr_out;
2762 ctl.f = ill_array_lookup;
2764 req = ill_get_ILLRequest(&ctl, "ill", 0);
2766 if (!ill_Request(out, &req, 0, 0))
2768 int ill_request_size;
2769 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2770 if (ill_request_buf)
2771 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2777 int illRequest_size = 0;
2778 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2780 oid.proto = PROTO_GENERAL;
2781 oid.oclass = CLASS_GENERAL;
2782 oid.value = VAL_ISO_ILL_1;
2784 r = (Z_External *) odr_malloc(out, sizeof(*r));
2785 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2786 r->indirect_reference = 0;
2788 r->which = Z_External_single;
2790 r->u.single_ASN1_type =
2791 odr_create_Odr_oct(out,
2792 (unsigned char *)illRequest_buf,
2798 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2800 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2803 req->which = Z_IOItemOrder_esRequest;
2804 req->u.esRequest = (Z_IORequest *)
2805 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2807 /* to keep part ... */
2808 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2809 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2810 req->u.esRequest->toKeep->supplDescription = 0;
2811 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2812 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2814 str = ZOOM_options_get(p->options, "contact-name");
2815 req->u.esRequest->toKeep->contact->name = str ?
2816 nmem_strdup(p->odr_out->mem, str) : 0;
2818 str = ZOOM_options_get(p->options, "contact-phone");
2819 req->u.esRequest->toKeep->contact->phone = str ?
2820 nmem_strdup(p->odr_out->mem, str) : 0;
2822 str = ZOOM_options_get(p->options, "contact-email");
2823 req->u.esRequest->toKeep->contact->email = str ?
2824 nmem_strdup(p->odr_out->mem, str) : 0;
2826 req->u.esRequest->toKeep->addlBilling = 0;
2828 /* not to keep part ... */
2829 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2830 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2832 str = ZOOM_options_get(p->options, "itemorder-setname");
2837 req->u.esRequest->notToKeep->resultSetItem = 0;
2840 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2841 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2843 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2844 nmem_strdup(p->odr_out->mem, str);
2845 req->u.esRequest->notToKeep->resultSetItem->item =
2846 (int *) odr_malloc(p->odr_out, sizeof(int));
2848 str = ZOOM_options_get(p->options, "itemorder-item");
2849 *req->u.esRequest->notToKeep->resultSetItem->item =
2850 (str ? atoi(str) : 1);
2852 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2857 Z_APDU *create_admin_package(ZOOM_package p, int type,
2858 Z_ESAdminOriginPartToKeep **toKeepP,
2859 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2861 Z_APDU *apdu = create_es_package(p, VAL_ADMINSERVICE);
2864 Z_ESAdminOriginPartToKeep *toKeep;
2865 Z_ESAdminOriginPartNotToKeep *notToKeep;
2866 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
2867 const char *first_db = "Default";
2869 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2873 r->direct_reference =
2874 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2877 r->indirect_reference = 0;
2878 r->which = Z_External_ESAdmin;
2880 r->u.adminService = (Z_Admin *)
2881 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2882 r->u.adminService->which = Z_Admin_esRequest;
2883 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2884 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2886 toKeep = r->u.adminService->u.esRequest->toKeep =
2887 (Z_ESAdminOriginPartToKeep *)
2888 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2889 toKeep->which = type;
2890 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2891 toKeep->u.create = odr_nullval();
2892 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2894 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2895 (Z_ESAdminOriginPartNotToKeep *)
2896 odr_malloc(p->odr_out,
2897 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2898 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
2899 notToKeep->u.recordsWillFollow = odr_nullval();
2903 *notToKeepP = notToKeep;
2908 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
2910 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
2911 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2912 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
2913 const char *doc = ZOOM_options_get(p->options, "doc");
2918 req->taskSpecificParameters = ext;
2919 ext->direct_reference = req->packageType;
2920 ext->descriptor = 0;
2921 ext->indirect_reference = 0;
2923 ext->which = Z_External_octet;
2924 ext->u.single_ASN1_type =
2925 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
2930 static Z_APDU *create_update_package(ZOOM_package p)
2933 const char *first_db = "Default";
2935 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2936 const char *action = ZOOM_options_get(p->options, "action");
2937 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
2938 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
2939 const char *record_buf = ZOOM_options_get(p->options, "record");
2940 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
2941 int syntax_oid = VAL_NONE;
2945 syntax_oid = oid_getvalbyname(syntax_str);
2948 record_buf = "void";
2949 syntax_oid = VAL_SUTRS;
2951 if (syntax_oid == VAL_NONE)
2952 syntax_oid = VAL_TEXT_XML;
2958 action = "specialUpdate";
2960 if (!strcmp(action, "recordInsert"))
2961 action_no = Z_IUOriginPartToKeep_recordInsert;
2962 else if (!strcmp(action, "recordReplace"))
2963 action_no = Z_IUOriginPartToKeep_recordReplace;
2964 else if (!strcmp(action, "recordDelete"))
2965 action_no = Z_IUOriginPartToKeep_recordDelete;
2966 else if (!strcmp(action, "elementUpdate"))
2967 action_no = Z_IUOriginPartToKeep_elementUpdate;
2968 else if (!strcmp(action, "specialUpdate"))
2969 action_no = Z_IUOriginPartToKeep_specialUpdate;
2973 apdu = create_es_package(p, VAL_DBUPDATE);
2976 Z_IUOriginPartToKeep *toKeep;
2977 Z_IUSuppliedRecords *notToKeep;
2978 Z_External *r = (Z_External *)
2979 odr_malloc(p->odr_out, sizeof(*r));
2981 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2983 r->direct_reference =
2984 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2987 r->which = Z_External_update;
2988 r->indirect_reference = 0;
2989 r->u.update = (Z_IUUpdate *)
2990 odr_malloc(p->odr_out, sizeof(*r->u.update));
2992 r->u.update->which = Z_IUUpdate_esRequest;
2993 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
2994 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
2995 toKeep = r->u.update->u.esRequest->toKeep =
2996 (Z_IUOriginPartToKeep *)
2997 odr_malloc(p->odr_out, sizeof(*toKeep));
2999 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3001 toKeep->elementSetName = 0;
3002 toKeep->actionQualifier = 0;
3003 toKeep->action = odr_intdup(p->odr_out, action_no);
3005 notToKeep = r->u.update->u.esRequest->notToKeep =
3006 (Z_IUSuppliedRecords *)
3007 odr_malloc(p->odr_out, sizeof(*notToKeep));
3009 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3010 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3011 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3012 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3013 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3016 notToKeep->elements[0]->u.opaque =
3017 odr_create_Odr_oct(p->odr_out,
3018 (const unsigned char *) recordIdOpaque,
3019 strlen(recordIdOpaque));
3021 else if (recordIdNumber)
3023 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3025 notToKeep->elements[0]->u.number =
3026 odr_intdup(p->odr_out, atoi(recordIdNumber));
3029 notToKeep->elements[0]->u.opaque = 0;
3030 notToKeep->elements[0]->supplementalId = 0;
3031 notToKeep->elements[0]->correlationInfo = 0;
3032 notToKeep->elements[0]->record =
3033 z_ext_record(p->odr_out, syntax_oid,
3034 record_buf, strlen(record_buf));
3038 ODR print = odr_createmem(ODR_PRINT);
3040 z_APDU(print, &apdu, 0, 0);
3047 ZOOM_package_send(ZOOM_package p, const char *type)
3054 odr_reset(p->odr_out);
3057 if (!strcmp(type, "itemorder"))
3059 apdu = create_es_package(p, VAL_ITEMORDER);
3062 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3064 r->direct_reference =
3065 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3068 r->which = Z_External_itemOrder;
3069 r->indirect_reference = 0;
3070 r->u.itemOrder = encode_item_order(p);
3072 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3075 else if (!strcmp(type, "create")) /* create database */
3077 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3080 else if (!strcmp(type, "drop")) /* drop database */
3082 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3085 else if (!strcmp(type, "commit")) /* commit changes */
3087 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3090 else if (!strcmp(type, "update")) /* update record(s) */
3092 apdu = create_update_package(p);
3094 else if (!strcmp(type, "xmlupdate"))
3096 apdu = create_xmlupdate_package(p);
3100 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3104 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3105 task->u.package = p;
3106 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3107 p->buf_out = (char *) xmalloc(p->len_out);
3108 memcpy(p->buf_out, buf, p->len_out);
3113 while (ZOOM_event(1, &c))
3120 ZOOM_API(ZOOM_package)
3121 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3123 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3126 p->odr_out = odr_createmem(ODR_ENCODE);
3127 p->options = ZOOM_options_create_with_parent2(options, c->options);
3135 ZOOM_package_destroy(ZOOM_package p)
3140 if (p->refcount == 0)
3142 odr_destroy(p->odr_out);
3145 ZOOM_options_destroy(p->options);
3150 ZOOM_API(const char *)
3151 ZOOM_package_option_get(ZOOM_package p, const char *key)
3153 return ZOOM_options_get(p->options, key);
3158 ZOOM_package_option_set(ZOOM_package p, const char *key,
3161 ZOOM_options_set(p->options, key, val);
3164 static int ZOOM_connection_exec_task(ZOOM_connection c)
3166 ZOOM_task task = c->tasks;
3167 zoom_ret ret = zoom_complete;
3171 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3172 c, task->which, task->running);
3173 if (c->error != ZOOM_ERROR_NONE)
3175 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3176 "removing tasks because of error = %d", c, c->error);
3177 ZOOM_connection_remove_tasks(c);
3182 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3183 "task already running", c);
3187 ret = zoom_complete;
3188 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3190 switch (task->which)
3192 case ZOOM_TASK_SEARCH:
3193 if (c->proto == PROTO_HTTP)
3194 ret = ZOOM_connection_srw_send_search(c);
3196 ret = ZOOM_connection_send_search(c);
3198 case ZOOM_TASK_RETRIEVE:
3199 if (c->proto == PROTO_HTTP)
3200 ret = ZOOM_connection_srw_send_search(c);
3202 ret = send_present(c);
3204 case ZOOM_TASK_CONNECT:
3205 ret = do_connect(c);
3207 case ZOOM_TASK_SCAN:
3210 case ZOOM_TASK_PACKAGE:
3211 ret = send_package(c);
3213 case ZOOM_TASK_SORT:
3214 c->tasks->u.sort.resultset->r_sort_spec =
3215 c->tasks->u.sort.q->sort_spec;
3216 ret = send_sort(c, c->tasks->u.sort.resultset);
3222 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3223 "remove tasks because no connection exist", c);
3224 ZOOM_connection_remove_tasks(c);
3226 if (ret == zoom_complete)
3228 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3229 "task removed (complete)", c);
3230 ZOOM_connection_remove_task(c);
3233 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3238 static zoom_ret send_sort_present(ZOOM_connection c)
3240 zoom_ret r = zoom_complete;
3242 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3243 r = send_sort(c, c->tasks->u.search.resultset);
3244 if (r == zoom_complete)
3245 r = send_present(c);
3249 static int es_response(ZOOM_connection c,
3250 Z_ExtendedServicesResponse *res)
3252 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3254 if (res->diagnostics && res->num_diagnostics > 0)
3255 response_diag(c, res->diagnostics[0]);
3256 if (res->taskPackage &&
3257 res->taskPackage->which == Z_External_extendedService)
3259 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3260 Odr_oct *id = taskPackage->targetReference;
3263 ZOOM_options_setl(c->tasks->u.package->options,
3264 "targetReference", (char*) id->buf, id->len);
3266 if (res->taskPackage &&
3267 res->taskPackage->which == Z_External_octet)
3269 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3270 ZOOM_options_setl(c->tasks->u.package->options,
3271 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3276 static void interpret_init_diag(ZOOM_connection c,
3277 Z_DiagnosticFormat *diag)
3281 Z_DiagnosticFormat_s *ds = diag->elements[0];
3282 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3283 response_default_diag(c, ds->u.defaultDiagRec);
3288 static void interpret_otherinformation_field(ZOOM_connection c,
3289 Z_OtherInformation *ui)
3292 for (i = 0; i < ui->num_elements; i++)
3294 Z_OtherInformationUnit *unit = ui->list[i];
3295 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3296 unit->information.externallyDefinedInfo &&
3297 unit->information.externallyDefinedInfo->which ==
3300 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3305 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3307 Z_InitResponse *initrs;
3310 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3313 case Z_APDU_initResponse:
3314 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3315 initrs = apdu->u.initResponse;
3316 ZOOM_connection_option_set(c, "serverImplementationId",
3317 initrs->implementationId ?
3318 initrs->implementationId : "");
3319 ZOOM_connection_option_set(c, "serverImplementationName",
3320 initrs->implementationName ?
3321 initrs->implementationName : "");
3322 ZOOM_connection_option_set(c, "serverImplementationVersion",
3323 initrs->implementationVersion ?
3324 initrs->implementationVersion : "");
3325 /* Set the three old options too, for old applications */
3326 ZOOM_connection_option_set(c, "targetImplementationId",
3327 initrs->implementationId ?
3328 initrs->implementationId : "");
3329 ZOOM_connection_option_set(c, "targetImplementationName",
3330 initrs->implementationName ?
3331 initrs->implementationName : "");
3332 ZOOM_connection_option_set(c, "targetImplementationVersion",
3333 initrs->implementationVersion ?
3334 initrs->implementationVersion : "");
3335 if (!*initrs->result)
3337 Z_External *uif = initrs->userInformationField;
3339 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3341 if (uif && uif->which == Z_External_userInfo1)
3342 interpret_otherinformation_field(c, uif->u.userInfo1);
3347 yaz_oi_get_string_oidval(&apdu->u.initResponse->otherInfo,
3349 xfree(c->cookie_in);
3352 c->cookie_in = xstrdup(cookie);
3353 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3354 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3355 c->support_named_resultsets = 1;
3358 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3359 ZOOM_connection_remove_task(c);
3361 ZOOM_connection_exec_task(c);
3363 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3365 NMEM tmpmem = nmem_create();
3366 Z_CharSetandLanguageNegotiation *p =
3367 yaz_get_charneg_record(initrs->otherInfo);
3371 char *charset = NULL, *lang = NULL;
3374 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3375 yaz_log(log_details, "%p recv_apdu target accepted: "
3376 "charset %s, language %s, select %d",
3378 charset ? charset : "none", lang ? lang : "none", sel);
3380 ZOOM_connection_option_set(c, "negotiation-charset",
3383 ZOOM_connection_option_set(c, "negotiation-lang",
3386 ZOOM_connection_option_set(
3387 c, "negotiation-charset-in-effect-for-records",
3388 (sel != 0) ? "1" : "0");
3389 nmem_destroy(tmpmem);
3393 case Z_APDU_searchResponse:
3394 yaz_log(log_api, "%p recv_apdu Search response", c);
3395 handle_search_response(c, apdu->u.searchResponse);
3396 if (send_sort_present(c) == zoom_complete)
3397 ZOOM_connection_remove_task(c);
3399 case Z_APDU_presentResponse:
3400 yaz_log(log_api, "%p recv_apdu Present response", c);
3401 handle_present_response(c, apdu->u.presentResponse);
3402 if (send_present(c) == zoom_complete)
3403 ZOOM_connection_remove_task(c);
3405 case Z_APDU_sortResponse:
3406 yaz_log(log_api, "%p recv_apdu Sort response", c);
3407 sort_response(c, apdu->u.sortResponse);
3408 if (send_present(c) == zoom_complete)
3409 ZOOM_connection_remove_task(c);
3411 case Z_APDU_scanResponse:
3412 yaz_log(log_api, "%p recv_apdu Scan response", c);
3413 scan_response(c, apdu->u.scanResponse);
3414 ZOOM_connection_remove_task(c);
3416 case Z_APDU_extendedServicesResponse:
3417 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3418 es_response(c, apdu->u.extendedServicesResponse);
3419 ZOOM_connection_remove_task(c);
3422 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3423 if (c->reconnect_ok)
3426 c->reconnect_ok = 0;
3427 c->tasks->running = 0;
3428 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
3432 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3437 yaz_log(log_api, "%p Received unknown PDU", c);
3438 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3444 static void handle_srw_response(ZOOM_connection c,
3445 Z_SRW_searchRetrieveResponse *res)
3447 ZOOM_resultset resultset = 0;
3456 if (c->tasks->which == ZOOM_TASK_SEARCH)
3458 resultset = c->tasks->u.search.resultset;
3459 start = &c->tasks->u.search.start;
3461 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
3463 resultset = c->tasks->u.retrieve.resultset;
3464 start = &c->tasks->u.retrieve.start;
3469 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3470 ZOOM_connection_put_event(c, event);
3472 resultset->size = 0;
3474 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3476 if (res->numberOfRecords)
3477 resultset->size = *res->numberOfRecords;
3479 for (i = 0; i<res->num_records; i++)
3483 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3484 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3486 if (res->records[i].recordPosition &&
3487 *res->records[i].recordPosition > 0)
3488 pos = *res->records[i].recordPosition - 1;
3492 npr->databaseName = 0;
3493 npr->which = Z_NamePlusRecord_databaseRecord;
3494 npr->u.databaseRecord = (Z_External *)
3495 odr_malloc(c->odr_in, sizeof(Z_External));
3496 npr->u.databaseRecord->descriptor = 0;
3497 npr->u.databaseRecord->direct_reference =
3498 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3499 npr->u.databaseRecord->which = Z_External_octet;
3501 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3502 odr_malloc(c->odr_in, sizeof(Odr_oct));
3503 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3504 res->records[i].recordData_buf;
3505 npr->u.databaseRecord->u.octet_aligned->len =
3506 npr->u.databaseRecord->u.octet_aligned->size =
3507 res->records[i].recordData_len;
3508 record_cache_add(resultset, npr, pos);
3510 if (res->num_diagnostics > 0)
3512 const char *uri = res->diagnostics[0].uri;
3517 if ((cp = strrchr(uri, '/')))
3519 set_dset_error(c, code, uri,
3520 res->diagnostics[0].details, 0);
3523 nmem = odr_extract_mem(c->odr_in);
3524 nmem_transfer(resultset->odr->mem, nmem);
3530 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3533 const char *content_type = z_HTTP_header_lookup(hres->headers,
3535 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3538 yaz_log(log_details, "%p handle_http", c);
3540 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3542 Z_SOAP *soap_package = 0;
3544 Z_SOAP_Handler soap_handlers[2] = {
3545 {"http://www.loc.gov/zing/srw/", 0,
3546 (Z_SOAP_fun) yaz_srw_codec},
3549 ret = z_soap_codec(o, &soap_package,
3550 &hres->content_buf, &hres->content_len,
3552 if (!ret && soap_package->which == Z_SOAP_generic &&
3553 soap_package->u.generic->no == 0)
3555 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3556 if (sr->which == Z_SRW_searchRetrieve_response)
3557 handle_srw_response(c, sr->u.response);
3561 else if (!ret && (soap_package->which == Z_SOAP_fault
3562 || soap_package->which == Z_SOAP_error))
3564 set_HTTP_error(c, hres->code,
3565 soap_package->u.fault->fault_code,
3566 soap_package->u.fault->fault_string);
3573 if (hres->code != 200)
3574 set_HTTP_error(c, hres->code, 0, 0);
3576 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3579 ZOOM_connection_remove_task(c);
3580 if (!strcmp(hres->version, "1.0"))
3582 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3583 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3588 /* HTTP 1.1: only if no close we stay alive .. */
3589 if (connection_head && !strcmp(connection_head, "close"))
3595 static int do_read(ZOOM_connection c)
3600 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3601 ZOOM_connection_put_event(c, event);
3603 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3604 more = cs_more(c->cs);
3605 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3610 if (c->reconnect_ok)
3612 yaz_log(log_details, "%p do_read reconnect read", c);
3614 c->reconnect_ok = 0;
3615 c->tasks->running = 0;
3616 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
3620 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3629 odr_reset(c->odr_in);
3630 odr_setbuf(c->odr_in, c->buf_in, r, 0);
3631 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3632 ZOOM_connection_put_event(c, event);
3634 if (!z_GDU(c->odr_in, &gdu, 0, 0))
3637 int err = odr_geterrorx(c->odr_in, &x);
3639 const char *element = odr_getelement(c->odr_in);
3640 sprintf(msg, "ODR code %d:%d element=%-20s",
3641 err, x, element ? element : "<unknown>");
3642 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3645 else if (gdu->which == Z_GDU_Z3950)
3646 recv_apdu(c, gdu->u.z3950);
3647 else if (gdu->which == Z_GDU_HTTP_Response)
3650 handle_http(c, gdu->u.HTTP_Response);
3652 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3656 c->reconnect_ok = 0;
3661 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3666 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3667 ZOOM_connection_put_event(c, event);
3669 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3670 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3672 yaz_log(log_details, "%p do_write_ex write failed", c);
3673 if (c->reconnect_ok)
3676 c->reconnect_ok = 0;
3677 c->tasks->running = 0;
3678 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
3679 return zoom_pending;
3681 if (c->state == STATE_CONNECTING)
3682 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3684 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3686 return zoom_complete;
3690 c->mask = ZOOM_SELECT_EXCEPT;
3691 if (c->cs->io_pending & CS_WANT_WRITE)
3692 c->mask += ZOOM_SELECT_WRITE;
3693 if (c->cs->io_pending & CS_WANT_READ)
3694 c->mask += ZOOM_SELECT_READ;
3695 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3700 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3701 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3704 return zoom_pending;
3707 static zoom_ret do_write(ZOOM_connection c)
3709 return do_write_ex(c, c->buf_out, c->len_out);
3713 ZOOM_API(const char *)
3714 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3716 return ZOOM_options_get(c->options, key);
3719 ZOOM_API(const char *)
3720 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3722 return ZOOM_options_getl(c->options, key, lenp);
3726 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3729 ZOOM_options_set(c->options, key, val);
3733 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3734 const char *val, int len)
3736 ZOOM_options_setl(c->options, key, val, len);
3739 ZOOM_API(const char *)
3740 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3742 return ZOOM_options_get(r->options, key);
3746 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3749 ZOOM_options_set(r->options, key, val);
3754 ZOOM_connection_errcode(ZOOM_connection c)
3756 return ZOOM_connection_error(c, 0, 0);
3759 ZOOM_API(const char *)
3760 ZOOM_connection_errmsg(ZOOM_connection c)
3763 ZOOM_connection_error(c, &msg, 0);
3767 ZOOM_API(const char *)
3768 ZOOM_connection_addinfo(ZOOM_connection c)
3770 const char *addinfo;
3771 ZOOM_connection_error(c, 0, &addinfo);
3775 ZOOM_API(const char *)
3776 ZOOM_connection_diagset(ZOOM_connection c)
3778 const char *diagset;
3779 ZOOM_connection_error_x(c, 0, 0, &diagset);
3783 ZOOM_API(const char *)
3784 ZOOM_diag_str(int error)
3788 case ZOOM_ERROR_NONE:
3790 case ZOOM_ERROR_CONNECT:
3791 return "Connect failed";
3792 case ZOOM_ERROR_MEMORY:
3793 return "Out of memory";
3794 case ZOOM_ERROR_ENCODE:
3795 return "Encoding failed";
3796 case ZOOM_ERROR_DECODE:
3797 return "Decoding failed";
3798 case ZOOM_ERROR_CONNECTION_LOST:
3799 return "Connection lost";
3800 case ZOOM_ERROR_INIT:
3801 return "Init rejected";
3802 case ZOOM_ERROR_INTERNAL:
3803 return "Internal failure";
3804 case ZOOM_ERROR_TIMEOUT:
3806 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3807 return "Unsupported protocol";
3808 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3809 return "Unsupported query type";
3810 case ZOOM_ERROR_INVALID_QUERY:
3811 return "Invalid query";
3812 case ZOOM_ERROR_CQL_PARSE:
3813 return "CQL parsing error";
3814 case ZOOM_ERROR_CQL_TRANSFORM:
3815 return "CQL transformation error";
3816 case ZOOM_ERROR_CCL_CONFIG:
3817 return "CCL configuration error";
3818 case ZOOM_ERROR_CCL_PARSE:
3819 return "CCL parsing error";
3821 return diagbib1_str(error);
3826 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
3827 const char **addinfo, const char **diagset)
3829 int error = c->error;
3832 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3833 *cp = ZOOM_diag_str(error);
3834 else if (!strcmp(c->diagset, "HTTP"))
3835 *cp = z_HTTP_errmsg(c->error);
3836 else if (!strcmp(c->diagset, "Bib-1"))
3837 *cp = ZOOM_diag_str(error);
3838 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3839 *cp = yaz_diag_srw_str(c->error);
3841 *cp = "Unknown error and diagnostic set";
3844 *addinfo = c->addinfo ? c->addinfo : "";
3846 *diagset = c->diagset ? c->diagset : "";
3851 ZOOM_connection_error(ZOOM_connection c, const char **cp,
3852 const char **addinfo)
3854 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3857 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
3859 ZOOM_Event event = 0;
3860 int r = cs_look(c->cs);
3861 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
3864 if (mask & ZOOM_SELECT_EXCEPT)
3866 if (r == CS_CONNECT)
3867 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3869 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3875 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
3876 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3878 ZOOM_connection_put_event(c, event);
3880 else if (r == CS_CONNECT)
3882 int ret = ret = cs_rcvconnect(c->cs);
3883 yaz_log(log_details, "%p ZOOM_connection_do_io "
3884 "cs_rcvconnect returned %d", c, ret);
3887 c->mask = ZOOM_SELECT_EXCEPT;
3888 if (c->cs->io_pending & CS_WANT_WRITE)
3889 c->mask += ZOOM_SELECT_WRITE;
3890 if (c->cs->io_pending & CS_WANT_READ)
3891 c->mask += ZOOM_SELECT_READ;
3895 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
3896 ZOOM_connection_put_event(c, event);
3898 if (c->proto == PROTO_Z3950)
3899 ZOOM_connection_send_init(c);
3902 /* no init request for SRW .. */
3903 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3904 ZOOM_connection_remove_task(c);
3906 ZOOM_connection_exec_task(c);
3908 c->state = STATE_ESTABLISHED;
3912 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3918 if (mask & ZOOM_SELECT_READ)
3920 if (c->cs && (mask & ZOOM_SELECT_WRITE))
3926 ZOOM_connection_last_event(ZOOM_connection cs)
3929 return ZOOM_EVENT_NONE;
3930 return cs->last_event;
3934 ZOOM_event(int no, ZOOM_connection *cs)
3936 int timeout = 30; /* default timeout in seconds */
3937 int timeout_set = 0; /* whether it was overriden at all */
3939 struct pollfd pollfds[1024];
3940 ZOOM_connection poll_cs[1024];
3943 fd_set input, output, except;
3948 yaz_log(log_details, "ZOOM_event(no=%d,cs=%p)", no, cs);
3949 for (i = 0; i<no; i++)
3951 ZOOM_connection c = cs[i];
3953 if (c && (event = ZOOM_connection_get_event(c)))
3955 ZOOM_Event_destroy(event);
3959 for (i = 0; i<no; i++)
3961 ZOOM_connection c = cs[i];
3965 ZOOM_connection_exec_task(c);
3966 if ((event = ZOOM_connection_get_event(c)))
3968 ZOOM_Event_destroy(event);
3981 for (i = 0; i<no; i++)
3983 ZOOM_connection c = cs[i];
3989 fd = z3950_connection_socket(c);
3990 mask = z3950_connection_mask(c);
3997 /* -1 is used for indefinite timeout (no timeout), so -2 here. */
3998 this_timeout = ZOOM_options_get_int(c->options, "timeout", -2);
3999 if (this_timeout != -2)
4001 /* ensure the minimum timeout is used */
4003 timeout = this_timeout;
4004 else if (this_timeout != -1 && this_timeout < timeout)
4005 timeout = this_timeout;
4011 short poll_events = 0;
4013 if (mask & ZOOM_SELECT_READ)
4014 poll_events += POLLIN;
4015 if (mask & ZOOM_SELECT_WRITE)
4016 poll_events += POLLOUT;
4017 if (mask & ZOOM_SELECT_EXCEPT)
4018 poll_events += POLLERR;
4019 pollfds[nfds].fd = fd;
4020 pollfds[nfds].events = poll_events;
4021 pollfds[nfds].revents = 0;
4026 if (mask & ZOOM_SELECT_READ)
4031 if (mask & ZOOM_SELECT_WRITE)
4033 FD_SET(fd, &output);
4036 if (mask & ZOOM_SELECT_EXCEPT)
4038 FD_SET(fd, &except);
4047 r = poll(pollfds, nfds, (timeout == -1 ? -1 : timeout * 1000));
4048 for (i = 0; i<nfds; i++)
4050 ZOOM_connection c = poll_cs[i];
4054 if (pollfds[i].revents & POLLIN)
4055 mask += ZOOM_SELECT_READ;
4056 if (pollfds[i].revents & POLLOUT)
4057 mask += ZOOM_SELECT_WRITE;
4058 if (pollfds[i].revents & POLLERR)
4059 mask += ZOOM_SELECT_EXCEPT;
4061 ZOOM_connection_do_io(c, mask);
4063 else if (r == 0 && c->mask)
4065 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4066 /* timeout and this connection was waiting */
4067 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4069 ZOOM_connection_put_event(c, event);
4073 tv.tv_sec = timeout;
4075 r = select(max_fd+1, &input, &output, &except, (timeout == -1 ? 0 : &tv));
4076 for (i = 0; i<no; i++)
4078 ZOOM_connection c = cs[i];
4083 fd = z3950_connection_socket(c);
4087 /* no timeout and real socket */
4088 if (FD_ISSET(fd, &input))
4089 mask += ZOOM_SELECT_READ;
4090 if (FD_ISSET(fd, &output))
4091 mask += ZOOM_SELECT_WRITE;
4092 if (FD_ISSET(fd, &except))
4093 mask += ZOOM_SELECT_EXCEPT;
4095 ZOOM_connection_do_io(c, mask);
4097 if (r == 0 && c->mask)
4099 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4100 /* timeout and this connection was waiting */
4101 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4103 ZOOM_connection_put_event(c, event);
4107 for (i = 0; i<no; i++)
4109 ZOOM_connection c = cs[i];
4111 if (c && (event = ZOOM_connection_get_event(c)))
4113 ZOOM_Event_destroy(event);
4122 * Returns an xmalloc()d string containing RPN that corresponds to the
4123 * CQL passed in. On error, sets the Connection object's error state
4124 * and returns a null pointer.
4125 * ### We could cache CQL parser and/or transformer in Connection.
4127 static char *cql2pqf(ZOOM_connection c, const char *cql)
4131 struct cql_node *node;
4132 const char *cqlfile;
4133 static cql_transform_t trans;
4136 parser = cql_parser_create();
4137 if ((error = cql_parser_string(parser, cql)) != 0) {
4138 cql_parser_destroy(parser);
4139 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4143 node = cql_parser_result(parser);
4144 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4146 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4148 cql_parser_destroy(parser);
4149 cql_node_destroy(node);
4150 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4154 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4156 cql_parser_destroy(parser);
4157 cql_node_destroy(node);
4158 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4159 cqlfile, strerror(errno));
4160 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4164 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4165 cql_parser_destroy(parser);
4166 cql_node_destroy(node);
4169 const char *addinfo;
4170 error = cql_transform_error(trans, &addinfo);
4171 cql_transform_close(trans);
4172 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4173 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4177 cql_transform_close(trans);
4178 return xstrdup(pqfbuf);
4184 * indent-tabs-mode: nil
4186 * vim: shiftwidth=4 tabstop=8 expandtab