2 * Copyright (C) 1995-2006, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.82 2006-08-08 20:58:52 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",
376 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
380 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
382 val = ZOOM_options_get(c->options, "proxy");
385 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
386 c->proxy = xstrdup(val);
392 val = ZOOM_options_get(c->options, "charset");
395 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
396 c->charset = xstrdup(val);
402 val = ZOOM_options_get(c->options, "lang");
405 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
406 c->lang = xstrdup(val);
411 val = ZOOM_options_get(c->options, "sru");
412 c->sru_mode = get_sru_mode_from_string(val);
418 sprintf(hostn, "%.80s:%d", host, portnum);
419 c->host_port = xstrdup(hostn);
422 c->host_port = xstrdup(host);
426 * If the "<scheme>:" part of the host string is preceded by one
427 * or more comma-separated <name>=<value> pairs, these are taken
428 * to be options to be set on the connection object. Among other
429 * applications, this facility can be used to embed authentication
431 * user=admin,password=secret,tcp:localhost:9999
433 char *remainder = c->host_port;
434 char *pcolon = strchr(remainder, ':');
437 while ((pcomma = strchr(remainder, ',')) != 0 &&
438 (pcolon == 0 || pcomma < pcolon)) {
440 if ((pequals = strchr(remainder, '=')) != 0) {
442 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
443 ZOOM_connection_option_set(c, remainder, pequals+1);
445 remainder = pcomma+1;
448 if (remainder != c->host_port) {
450 c->host_port = xstrdup(remainder);
451 /*printf("# reset hp='%s'\n", remainder);*/
455 ZOOM_options_set(c->options, "host", c->host_port);
457 val = ZOOM_options_get(c->options, "cookie");
460 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
461 c->cookie_out = xstrdup(val);
464 val = ZOOM_options_get(c->options, "clientIP");
467 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
469 c->client_IP = xstrdup(val);
472 c->async = ZOOM_options_get_bool(c->options, "async", 0);
473 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
475 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
477 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
481 while (ZOOM_event(1, &c))
487 ZOOM_query_create(void)
489 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
491 yaz_log(log_details, "%p ZOOM_query_create", s);
495 s->odr = odr_createmem(ODR_ENCODE);
502 ZOOM_query_destroy(ZOOM_query s)
508 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
509 if (s->refcount == 0)
517 ZOOM_query_prefix(ZOOM_query s, const char *str)
519 s->query_string = odr_strdup(s->odr, str);
520 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
521 s->z_query->which = Z_Query_type_1;
522 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
523 if (!s->z_query->u.type_1)
525 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
529 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
534 ZOOM_query_cql(ZOOM_query s, const char *str)
538 s->query_string = odr_strdup(s->odr, str);
540 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
541 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
542 ext->indirect_reference = 0;
544 ext->which = Z_External_CQL;
545 ext->u.cql = s->query_string;
547 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
548 s->z_query->which = Z_Query_type_104;
549 s->z_query->u.type_104 = ext;
551 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
557 * Translate the CQL string client-side into RPN which is passed to
558 * the server. This is useful for server's that don't themselves
559 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
560 * only as a place to stash diagnostics if compilation fails; if this
561 * information is not needed, a null pointer may be used.
564 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
568 ZOOM_connection freeme = 0;
570 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
572 conn = freeme = ZOOM_connection_create(0);
574 rpn = cql2pqf(conn, str);
576 ZOOM_connection_destroy(freeme);
580 ret = ZOOM_query_prefix(s, rpn);
586 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
587 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
588 * to the server, as the YAZ GFS doesn't know how to handle this.
591 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
592 int *ccl_error, const char **error_string,
596 struct ccl_rpn_node *rpn;
597 CCL_bibset bibset = ccl_qual_mk();
600 ccl_qual_buf(bibset, config);
602 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
605 *error_string = ccl_err_msg(*ccl_error);
610 WRBUF wr = wrbuf_alloc();
613 ret = ZOOM_query_prefix(s, wrbuf_buf(wr));
616 ccl_qual_rm(&bibset);
621 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
623 s->sort_spec = yaz_sort_spec(s->odr, criteria);
626 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
630 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
634 static zoom_ret do_write(ZOOM_connection c);
637 ZOOM_connection_destroy(ZOOM_connection c)
642 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
645 for (r = c->resultsets; r; r = r->next)
651 odr_destroy(c->odr_in);
652 odr_destroy(c->odr_out);
653 ZOOM_options_destroy(c->options);
654 ZOOM_connection_remove_tasks(c);
660 xfree(c->cookie_out);
666 void ZOOM_resultset_addref(ZOOM_resultset r)
671 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
676 ZOOM_resultset ZOOM_resultset_create()
679 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
683 yaz_log(log_details, "%p ZOOM_resultset_create", r);
686 r->odr = odr_createmem(ODR_ENCODE);
691 for (i = 0; i<RECORD_HASH_SIZE; i++)
692 r->record_hash[i] = 0;
700 ZOOM_API(ZOOM_resultset)
701 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
704 ZOOM_query s = ZOOM_query_create();
706 ZOOM_query_prefix(s, q);
708 r = ZOOM_connection_search(c, s);
709 ZOOM_query_destroy(s);
713 ZOOM_API(ZOOM_resultset)
714 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
716 ZOOM_resultset r = ZOOM_resultset_create();
721 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
722 r->r_sort_spec = q->sort_spec;
725 r->options = ZOOM_options_create_with_parent(c->options);
727 start = ZOOM_options_get_int(r->options, "start", 0);
728 count = ZOOM_options_get_int(r->options, "count", 0);
730 /* If "presentChunk" is defined use that; otherwise "step" */
731 const char *cp = ZOOM_options_get(r->options, "presentChunk");
732 r->step = ZOOM_options_get_int(r->options,
733 (cp != 0 ? "presentChunk": "step"), 0);
735 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
736 cp = ZOOM_options_get(r->options, "setname");
738 r->setname = xstrdup(cp);
739 cp = ZOOM_options_get(r->options, "schema");
741 r->schema = xstrdup(cp);
745 r->next = c->resultsets;
748 if (c->host_port && c->proto == PROTO_HTTP)
752 yaz_log(log_details, "ZOOM_connection_search: no comstack");
753 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
757 yaz_log(log_details, "ZOOM_connection_search: reconnect");
762 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
763 task->u.search.resultset = r;
764 task->u.search.start = start;
765 task->u.search.count = count;
766 ZOOM_resultset_addref(r);
772 while (ZOOM_event(1, &c))
779 * This is the old result-set sorting API, which is maintained only
780 * for the sake of binary compatibility. There is no reason ever to
781 * use this rather than ZOOM_resultset_sort1().
784 ZOOM_resultset_sort(ZOOM_resultset r,
785 const char *sort_type, const char *sort_spec)
787 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
791 ZOOM_resultset_sort1(ZOOM_resultset r,
792 const char *sort_type, const char *sort_spec)
794 ZOOM_connection c = r->connection;
798 newq = ZOOM_query_create();
799 if (ZOOM_query_sortby(newq, sort_spec) < 0)
802 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
803 r, r, sort_type, sort_spec);
807 if (c->host_port && c->proto == PROTO_HTTP)
811 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
812 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
816 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
822 ZOOM_resultset_cache_reset(r);
823 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
824 task->u.sort.resultset = r;
825 task->u.sort.q = newq;
827 ZOOM_resultset_addref(r);
831 while (ZOOM_event(1, &c))
839 ZOOM_resultset_cache_reset(ZOOM_resultset r)
842 for (i = 0; i<RECORD_HASH_SIZE; i++)
844 ZOOM_record_cache rc;
845 for (rc = r->record_hash[i]; rc; rc = rc->next)
847 if (rc->rec.wrbuf_marc)
848 wrbuf_free(rc->rec.wrbuf_marc, 1);
849 if (rc->rec.wrbuf_iconv)
850 wrbuf_free(rc->rec.wrbuf_iconv, 1);
851 if (rc->rec.wrbuf_opac)
852 wrbuf_free(rc->rec.wrbuf_opac, 1);
854 r->record_hash[i] = 0;
859 ZOOM_resultset_destroy(ZOOM_resultset r)
864 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
866 if (r->refcount == 0)
868 ZOOM_resultset_cache_reset(r);
872 /* remove ourselves from the resultsets in connection */
873 ZOOM_resultset *rp = &r->connection->resultsets;
876 assert(*rp); /* we must be in this list!! */
878 { /* OK, we're here - take us out of it */
885 ZOOM_query_destroy(r->query);
886 ZOOM_options_destroy(r->options);
895 ZOOM_resultset_size(ZOOM_resultset r)
900 static void do_close(ZOOM_connection c)
906 c->state = STATE_IDLE;
909 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
910 int force_sync, int start, int count)
918 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
919 " count=%d", r, force_sync, start, count);
924 if (c->host_port && c->proto == PROTO_HTTP)
928 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
929 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
933 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
938 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
939 task->u.retrieve.resultset = r;
940 task->u.retrieve.start = start;
941 task->u.retrieve.count = count;
943 cp = ZOOM_options_get(r->options, "schema");
946 if (!r->schema || strcmp(r->schema, cp))
949 r->schema = xstrdup(cp);
953 ZOOM_resultset_addref(r);
955 if (!r->connection->async || force_sync)
956 while (r->connection && ZOOM_event(1, &r->connection))
961 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
962 size_t start, size_t count)
964 int force_present = 0;
968 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
969 r, r, (long) start, (long) count);
972 ZOOM_resultset_retrieve(r, force_present, start, count);
976 for (i = 0; i< count; i++)
977 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
981 static void get_cert(ZOOM_connection c)
986 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
988 ZOOM_connection_option_setl(c, "sslPeerCert",
994 static zoom_ret do_connect(ZOOM_connection c)
997 const char *effective_host;
1000 effective_host = c->proxy;
1002 effective_host = c->host_port;
1004 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1008 c->cs = cs_create_host(effective_host, 0, &add);
1010 if (c->cs && c->cs->protocol == PROTO_HTTP)
1013 const char *path = 0;
1015 c->proto = PROTO_HTTP;
1016 cs_get_host_args(c->host_port, &path);
1018 c->path = (char*) xmalloc(strlen(path)+2);
1020 strcpy(c->path+1, path);
1022 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1024 return zoom_complete;
1029 int ret = cs_connect(c->cs, add);
1032 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1033 ZOOM_connection_put_event(c, event);
1035 if (c->proto == PROTO_Z3950)
1036 ZOOM_connection_send_init(c);
1039 /* no init request for SRW .. */
1040 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1041 ZOOM_connection_remove_task(c);
1043 ZOOM_connection_exec_task(c);
1045 c->state = STATE_ESTABLISHED;
1046 return zoom_pending;
1050 c->state = STATE_CONNECTING;
1051 c->mask = ZOOM_SELECT_EXCEPT;
1052 if (c->cs->io_pending & CS_WANT_WRITE)
1053 c->mask += ZOOM_SELECT_WRITE;
1054 if (c->cs->io_pending & CS_WANT_READ)
1055 c->mask += ZOOM_SELECT_READ;
1056 return zoom_pending;
1059 c->state = STATE_IDLE;
1060 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1061 return zoom_complete;
1064 int z3950_connection_socket(ZOOM_connection c)
1067 return cs_fileno(c->cs);
1071 int z3950_connection_mask(ZOOM_connection c)
1078 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1081 for (i = 0; i<200; i++)
1084 Z_OtherInformation **oi;
1090 sprintf(buf, "otherInfo%d", i);
1091 val = ZOOM_options_get(c->options, buf);
1094 cp = strchr(val, ':');
1098 if (len >= sizeof(buf))
1099 len = sizeof(buf)-1;
1100 memcpy(buf, val, len);
1102 oidval = oid_getvalbyname(buf);
1103 if (oidval == VAL_NONE)
1106 yaz_oi_APDU(a, &oi);
1107 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1111 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1116 Z_OtherInformation **oi;
1117 yaz_oi_APDU(a, &oi);
1118 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1122 Z_OtherInformation **oi;
1123 yaz_oi_APDU(a, &oi);
1124 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1126 otherInfo_attach(c, a, out);
1127 if (!z_APDU(out, &a, 0, 0))
1129 FILE *outf = fopen("/tmp/apdu.txt", "a");
1132 ODR odr_pr = odr_createmem(ODR_PRINT);
1133 fprintf(outf, "a=%p\n", a);
1134 odr_setprint(odr_pr, outf);
1135 z_APDU(odr_pr, &a, 0, 0);
1136 odr_destroy(odr_pr);
1138 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1139 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1143 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1147 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1151 if (encode_APDU(c, a, c->odr_out))
1152 return zoom_complete;
1153 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1154 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1155 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1156 ZOOM_connection_put_event(c, event);
1157 odr_reset(c->odr_out);
1161 /* returns 1 if PDU was sent OK (still pending )
1162 0 if PDU was not sent OK (nothing to wait for)
1165 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1167 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1168 Z_InitRequest *ireq = apdu->u.initRequest;
1169 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1170 odr_malloc(c->odr_out, sizeof(*auth));
1171 const char *auth_groupId = ZOOM_options_get(c->options, "group");
1172 const char *auth_userId = ZOOM_options_get(c->options, "user");
1173 const char *auth_password = ZOOM_options_get(c->options, "password");
1176 /* support the pass for backwards compatibility */
1178 auth_password = ZOOM_options_get(c->options, "pass");
1180 ODR_MASK_SET(ireq->options, Z_Options_search);
1181 ODR_MASK_SET(ireq->options, Z_Options_present);
1182 ODR_MASK_SET(ireq->options, Z_Options_scan);
1183 ODR_MASK_SET(ireq->options, Z_Options_sort);
1184 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1185 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1187 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1188 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1189 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1191 /* Index Data's Z39.50 Implementor Id is 81 */
1192 ireq->implementationId = odr_prepend(c->odr_out,
1193 ZOOM_options_get(c->options, "implementationId"),
1194 odr_prepend(c->odr_out, "81", ireq->implementationId));
1196 ireq->implementationName = odr_prepend(c->odr_out,
1197 ZOOM_options_get(c->options, "implementationName"),
1198 odr_prepend(c->odr_out, "ZOOM-C", ireq->implementationName));
1200 version = odr_strdup(c->odr_out, "$Revision: 1.82 $");
1201 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1202 version[strlen(version)-2] = '\0';
1203 ireq->implementationVersion = odr_prepend(c->odr_out,
1204 ZOOM_options_get(c->options, "implementationVersion"),
1205 odr_prepend(c->odr_out, &version[11], ireq->implementationVersion));
1207 *ireq->maximumRecordSize =
1208 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
1209 *ireq->preferredMessageSize =
1210 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
1212 if (auth_groupId || auth_password)
1214 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1217 if (auth_groupId && *auth_groupId)
1219 pass->groupId = (char *)
1220 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1221 strcpy(pass->groupId, auth_groupId);
1225 if (auth_userId && *auth_userId)
1227 pass->userId = (char *)
1228 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1229 strcpy(pass->userId, auth_userId);
1233 if (auth_password && *auth_password)
1235 pass->password = (char *)
1236 odr_malloc(c->odr_out, strlen(auth_password)+1);
1237 strcpy(pass->password, auth_password);
1242 auth->which = Z_IdAuthentication_idPass;
1243 auth->u.idPass = pass;
1244 ireq->idAuthentication = auth;
1247 else if (auth_userId)
1249 auth->which = Z_IdAuthentication_open;
1250 auth->u.open = (char *)
1251 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1252 strcpy(auth->u.open, auth_userId);
1253 ireq->idAuthentication = auth;
1256 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1257 VAL_PROXY, 1, c->host_port);
1258 if (c->charset || c->lang)
1260 Z_OtherInformation **oi;
1261 Z_OtherInformationUnit *oi_unit;
1263 yaz_oi_APDU(apdu, &oi);
1265 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1267 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1268 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1269 oi_unit->information.externallyDefinedInfo =
1270 yaz_set_proposal_charneg_list(c->odr_out, " ",
1271 c->charset, c->lang, 1);
1275 return send_APDU(c, apdu);
1279 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1284 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1286 if (c->sru_mode == zoom_sru_get)
1288 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1290 else if (c->sru_mode == zoom_sru_post)
1292 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1294 else if (c->sru_mode == zoom_sru_soap)
1296 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1298 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1299 return zoom_complete;
1300 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1302 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1303 ZOOM_connection_put_event(c, event);
1304 odr_reset(c->odr_out);
1310 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1314 ZOOM_resultset resultset = 0;
1316 const char *recordPacking = 0;
1318 if (c->error) /* don't continue on error */
1319 return zoom_complete;
1321 if (c->tasks->which == ZOOM_TASK_SEARCH)
1323 resultset = c->tasks->u.search.resultset;
1324 resultset->setname = xstrdup("default");
1325 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1326 start = &c->tasks->u.search.start;
1327 count = &c->tasks->u.search.count;
1329 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
1331 resultset = c->tasks->u.retrieve.resultset;
1333 start = &c->tasks->u.retrieve.start;
1334 count = &c->tasks->u.retrieve.count;
1336 if (*start >= resultset->size)
1337 return zoom_complete;
1338 if (*start + *count > resultset->size)
1339 *count = resultset->size - *start;
1341 for (i = 0; i < *count; i++)
1344 record_cache_lookup(resultset, i + *start);
1349 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1350 ZOOM_connection_put_event(c, event);
1357 return zoom_complete;
1359 assert(resultset->query);
1361 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1363 if (resultset->query->z_query->which == Z_Query_type_104
1364 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1366 sr->u.request->query_type = Z_SRW_query_type_cql;
1367 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1369 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1370 resultset->query->z_query->u.type_1)
1372 sr->u.request->query_type = Z_SRW_query_type_pqf;
1373 sr->u.request->query.pqf = resultset->query->query_string;
1377 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1378 return zoom_complete;
1380 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1381 sr->u.request->maximumRecords = odr_intdup(
1382 c->odr_out, resultset->step>0 ? resultset->step : *count);
1383 sr->u.request->recordSchema = resultset->schema;
1385 recordPacking = ZOOM_resultset_option_get(resultset, "recordPacking");
1388 sr->u.request->recordPacking = odr_strdup(c->odr_out, recordPacking);
1390 return send_srw(c, sr);
1393 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1395 return zoom_complete;
1399 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1402 int lslb, ssub, mspn;
1404 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1405 Z_SearchRequest *search_req = apdu->u.searchRequest;
1406 const char *elementSetName;
1407 const char *smallSetElementSetName;
1408 const char *mediumSetElementSetName;
1411 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1413 r = c->tasks->u.search.resultset;
1415 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1418 ZOOM_options_get(r->options, "elementSetName");
1419 smallSetElementSetName =
1420 ZOOM_options_get(r->options, "smallSetElementSetName");
1421 mediumSetElementSetName =
1422 ZOOM_options_get(r->options, "mediumSetElementSetName");
1424 if (!smallSetElementSetName)
1425 smallSetElementSetName = elementSetName;
1427 if (!mediumSetElementSetName)
1428 mediumSetElementSetName = elementSetName;
1433 /* prepare query for the search request */
1434 search_req->query = r->query->z_query;
1435 if (!search_req->query)
1437 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1438 return zoom_complete;
1441 search_req->databaseNames =
1442 set_DatabaseNames(c, r->options, &search_req->num_databaseNames);
1444 /* get syntax (no need to provide unless piggyback is in effect) */
1445 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1447 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1448 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1449 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1450 if (lslb != -1 && ssub != -1 && mspn != -1)
1452 /* So're a Z39.50 expert? Let's hope you don't do sort */
1453 *search_req->largeSetLowerBound = lslb;
1454 *search_req->smallSetUpperBound = ssub;
1455 *search_req->mediumSetPresentNumber = mspn;
1457 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1458 && r->piggyback && !r->r_sort_spec && !r->schema)
1460 /* Regular piggyback - do it unless we're going to do sort */
1461 *search_req->largeSetLowerBound = 2000000000;
1462 *search_req->smallSetUpperBound = 1;
1463 *search_req->mediumSetPresentNumber =
1464 r->step>0 ? r->step : c->tasks->u.search.count;
1468 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1469 smallSetElementSetName = 0;
1470 mediumSetElementSetName = 0;
1473 if (smallSetElementSetName && *smallSetElementSetName)
1475 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1476 odr_malloc(c->odr_out, sizeof(*esn));
1478 esn->which = Z_ElementSetNames_generic;
1479 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1480 search_req->smallSetElementSetNames = esn;
1482 if (mediumSetElementSetName && *mediumSetElementSetName)
1484 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1485 odr_malloc(c->odr_out, sizeof(*esn));
1487 esn->which = Z_ElementSetNames_generic;
1488 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1489 search_req->mediumSetElementSetNames = esn;
1492 search_req->preferredRecordSyntax =
1493 yaz_str_to_z3950oid(c->odr_out, CLASS_RECSYN, syntax);
1497 if (c->support_named_resultsets)
1501 /* find the lowest unused ordinal so that we re-use
1502 result sets on the server. */
1503 for (ord = 1; ; ord++)
1506 sprintf(setname, "%d", ord);
1507 for (rp = c->resultsets; rp; rp = rp->next)
1508 if (rp->setname && !strcmp(rp->setname, setname))
1513 r->setname = xstrdup(setname);
1514 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1515 "set %s", c, r->setname);
1519 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1521 r->setname = xstrdup("default");
1523 ZOOM_options_set(r->options, "setname", r->setname);
1525 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1526 return send_APDU(c, apdu);
1529 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1536 case Z_DefaultDiagFormat_v2Addinfo:
1537 addinfo = r->u.v2Addinfo;
1539 case Z_DefaultDiagFormat_v3Addinfo:
1540 addinfo = r->u.v3Addinfo;
1545 set_dset_error(c, *r->condition,
1546 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1550 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1552 if (p->which != Z_DiagRec_defaultFormat)
1553 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1555 response_default_diag(c, p->u.defaultFormat);
1558 ZOOM_API(ZOOM_record)
1559 ZOOM_record_clone(ZOOM_record srec)
1566 odr_enc = odr_createmem(ODR_ENCODE);
1567 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1569 buf = odr_getbuf(odr_enc, &size, 0);
1571 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1572 nrec->odr = odr_createmem(ODR_DECODE);
1573 nrec->wrbuf_marc = 0;
1574 nrec->wrbuf_iconv = 0;
1575 nrec->wrbuf_opac = 0;
1576 odr_setbuf(nrec->odr, buf, size, 0);
1577 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1579 odr_destroy(odr_enc);
1583 ZOOM_API(ZOOM_record)
1584 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1586 return record_cache_lookup(s, pos);
1589 ZOOM_API(ZOOM_record)
1590 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1592 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1597 * MIKE: I think force_sync should always be zero, but I don't
1598 * want to make this change until I get the go-ahead from
1599 * Adam, in case something depends on the old synchronous
1603 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1604 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1605 rec = ZOOM_resultset_record_immediate(r, pos);
1611 ZOOM_record_destroy(ZOOM_record rec)
1615 if (rec->wrbuf_marc)
1616 wrbuf_free(rec->wrbuf_marc, 1);
1617 if (rec->wrbuf_iconv)
1618 wrbuf_free(rec->wrbuf_iconv, 1);
1619 if (rec->wrbuf_opac)
1620 wrbuf_free(rec->wrbuf_opac, 1);
1621 odr_destroy(rec->odr);
1625 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1627 const char *buf, int sz,
1628 const char *record_charset)
1633 yaz_marc_t mt = yaz_marc_create();
1636 strcpy(to, "UTF-8");
1637 if (record_charset && *record_charset)
1639 /* Use "from,to" or just "from" */
1640 const char *cp = strchr(record_charset, ',');
1641 int clen = strlen(record_charset);
1644 strncpy( to, cp+1, sizeof(to)-1);
1645 to[sizeof(to)-1] = '\0';
1646 clen = cp - record_charset;
1648 if (clen > sizeof(from)-1)
1649 clen = sizeof(from)-1;
1652 strncpy(from, record_charset, clen);
1658 cd = yaz_iconv_open(to, from);
1659 yaz_marc_iconv(mt, cd);
1662 yaz_marc_xml(mt, marc_type);
1663 if (!rec->wrbuf_marc)
1664 rec->wrbuf_marc = wrbuf_alloc();
1665 wrbuf_rewind(rec->wrbuf_marc);
1666 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1668 yaz_marc_destroy(mt);
1670 yaz_iconv_close(cd);
1672 *len = wrbuf_len(rec->wrbuf_marc);
1673 return wrbuf_buf(rec->wrbuf_marc);
1675 yaz_marc_destroy(mt);
1677 yaz_iconv_close(cd);
1681 static const char *record_iconv_return(ZOOM_record rec, int *len,
1682 const char *buf, int sz,
1683 const char *record_charset)
1690 strcpy(to, "UTF-8");
1691 if (record_charset && *record_charset)
1693 /* Use "from,to" or just "from" */
1694 const char *cp = strchr(record_charset, ',');
1695 int clen = strlen(record_charset);
1698 strncpy( to, cp+1, sizeof(to)-1);
1699 to[sizeof(to)-1] = '\0';
1700 clen = cp - record_charset;
1702 if (clen > sizeof(from)-1)
1703 clen = sizeof(from)-1;
1706 strncpy(from, record_charset, clen);
1710 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1713 size_t inbytesleft = sz;
1714 const char *inp = buf;
1716 if (!rec->wrbuf_iconv)
1717 rec->wrbuf_iconv = wrbuf_alloc();
1719 wrbuf_rewind(rec->wrbuf_iconv);
1723 size_t outbytesleft = sizeof(outbuf);
1724 char *outp = outbuf;
1725 size_t r = yaz_iconv(cd, (char**) &inp,
1727 &outp, &outbytesleft);
1728 if (r == (size_t) (-1))
1730 int e = yaz_iconv_error(cd);
1731 if (e != YAZ_ICONV_E2BIG)
1734 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1736 wrbuf_puts(rec->wrbuf_iconv, "");
1737 buf = wrbuf_buf(rec->wrbuf_iconv);
1738 sz = wrbuf_len(rec->wrbuf_iconv);
1739 yaz_iconv_close(cd);
1746 ZOOM_API(const char *)
1747 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1754 Z_NamePlusRecord *npr;
1757 *len = 0; /* default return */
1766 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1768 if (cp[i] == ';' || cp[i] == ' ')
1774 while (type_spec[i] == ';')
1777 while (type_spec[i] == ' ')
1779 if (!strncmp(type_spec+i, "charset=", 8))
1782 i = i + 8; /* skip charset= */
1783 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1785 if (type_spec[i] == ';' || type_spec[i] == ' ')
1791 else if (!strncmp(type_spec+i, "xpath=", 6))
1795 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1799 while (type_spec[i] == ' ')
1802 if (!strcmp(type, "database"))
1805 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1806 return npr->databaseName;
1808 else if (!strcmp(type, "syntax"))
1810 const char *desc = 0;
1811 if (npr->which == Z_NamePlusRecord_databaseRecord)
1813 Z_External *r = (Z_External *) npr->u.databaseRecord;
1814 oident *ent = oid_getentbyoid(r->direct_reference);
1821 *len = strlen(desc);
1824 if (npr->which != Z_NamePlusRecord_databaseRecord)
1827 /* from now on - we have a database record .. */
1828 if (!strcmp(type, "render"))
1830 Z_External *r = (Z_External *) npr->u.databaseRecord;
1831 oident *ent = oid_getentbyoid(r->direct_reference);
1833 /* render bibliographic record .. */
1834 if (r->which == Z_External_OPAC)
1836 r = r->u.opac->bibliographicRecord;
1839 ent = oid_getentbyoid(r->direct_reference);
1841 if (r->which == Z_External_sutrs)
1842 return record_iconv_return(rec, len,
1843 (char*) r->u.sutrs->buf,
1846 else if (r->which == Z_External_octet)
1848 const char *ret_buf;
1856 case VAL_APPLICATION_XML:
1859 ret_buf = marc_iconv_return(
1860 rec, YAZ_MARC_LINE, len,
1861 (const char *) r->u.octet_aligned->buf,
1862 r->u.octet_aligned->len,
1867 return record_iconv_return(rec, len,
1868 (const char *) r->u.octet_aligned->buf,
1869 r->u.octet_aligned->len,
1872 else if (r->which == Z_External_grs1)
1874 if (!rec->wrbuf_marc)
1875 rec->wrbuf_marc = wrbuf_alloc();
1876 wrbuf_rewind(rec->wrbuf_marc);
1877 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1878 return record_iconv_return(rec, len,
1879 wrbuf_buf(rec->wrbuf_marc),
1880 wrbuf_len(rec->wrbuf_marc),
1885 else if (!strcmp(type, "xml"))
1887 Z_External *r = (Z_External *) npr->u.databaseRecord;
1888 oident *ent = oid_getentbyoid(r->direct_reference);
1890 /* render bibliographic record .. */
1891 if (r->which == Z_External_OPAC)
1893 r = r->u.opac->bibliographicRecord;
1896 ent = oid_getentbyoid(r->direct_reference);
1899 if (r->which == Z_External_sutrs)
1900 return record_iconv_return(rec, len,
1901 (const char *) r->u.sutrs->buf,
1904 else if (r->which == Z_External_octet)
1906 const char *ret_buf;
1907 int marc_decode_type = YAZ_MARC_MARCXML;
1916 case VAL_APPLICATION_XML:
1919 ret_buf = marc_iconv_return(
1920 rec, marc_decode_type, len,
1921 (const char *) r->u.octet_aligned->buf,
1922 r->u.octet_aligned->len,
1927 return record_iconv_return(rec, len,
1928 (const char *) r->u.octet_aligned->buf,
1929 r->u.octet_aligned->len,
1932 else if (r->which == Z_External_grs1)
1939 else if (!strcmp(type, "raw"))
1941 Z_External *r = (Z_External *) npr->u.databaseRecord;
1943 if (r->which == Z_External_sutrs)
1945 if (len) *len = r->u.sutrs->len;
1946 return (const char *) r->u.sutrs->buf;
1948 else if (r->which == Z_External_octet)
1950 if (len) *len = r->u.octet_aligned->len;
1951 return (const char *) r->u.octet_aligned->buf;
1953 else /* grs-1, explain, OPAC, ... */
1956 return (const char *) npr->u.databaseRecord;
1960 else if (!strcmp (type, "ext"))
1963 return (const char *) npr->u.databaseRecord;
1965 else if (!strcmp (type, "opac"))
1968 Z_External *r = (Z_External *) npr->u.databaseRecord;
1969 if (r->which == Z_External_OPAC)
1971 if (!rec->wrbuf_opac)
1972 rec->wrbuf_opac = wrbuf_alloc();
1973 wrbuf_rewind(rec->wrbuf_opac);
1974 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
1975 return record_iconv_return(rec, len,
1976 wrbuf_buf(rec->wrbuf_opac),
1977 wrbuf_len(rec->wrbuf_opac),
1984 static int strcmp_null(const char *v1, const char *v2)
1990 return strcmp(v1, v2);
1993 static size_t record_hash(int pos)
1997 return pos % RECORD_HASH_SIZE;
2000 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2003 ZOOM_record_cache rc;
2004 const char *elementSetName =
2005 ZOOM_resultset_option_get(r, "elementSetName");
2006 const char *syntax =
2007 ZOOM_resultset_option_get(r, "preferredRecordSyntax");
2009 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2010 ZOOM_connection_put_event(r->connection, event);
2012 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2016 if (strcmp_null(r->schema, rc->schema))
2018 if (strcmp_null(elementSetName,rc->elementSetName))
2020 if (strcmp_null(syntax, rc->syntax))
2022 /* not destroying rc->npr (it's handled by nmem )*/
2024 /* keeping wrbuf_marc too */
2028 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2031 rc->rec.wrbuf_marc = 0;
2032 rc->rec.wrbuf_iconv = 0;
2033 rc->rec.wrbuf_opac = 0;
2035 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2037 rc->elementSetName = 0;
2040 rc->syntax = odr_strdup(r->odr, syntax);
2045 rc->schema = odr_strdup(r->odr, r->schema);
2050 rc->next = r->record_hash[record_hash(pos)];
2051 r->record_hash[record_hash(pos)] = rc;
2054 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos)
2056 ZOOM_record_cache rc;
2057 const char *elementSetName =
2058 ZOOM_resultset_option_get(r, "elementSetName");
2059 const char *syntax =
2060 ZOOM_resultset_option_get(r, "preferredRecordSyntax");
2062 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2066 if (strcmp_null(r->schema, rc->schema))
2068 if (strcmp_null(elementSetName,rc->elementSetName))
2070 if (strcmp_null(syntax, rc->syntax))
2078 static void handle_records(ZOOM_connection c, Z_Records *sr,
2081 ZOOM_resultset resultset;
2086 switch (c->tasks->which)
2088 case ZOOM_TASK_SEARCH:
2089 resultset = c->tasks->u.search.resultset;
2090 start = &c->tasks->u.search.start;
2091 count = &c->tasks->u.search.count;
2093 case ZOOM_TASK_RETRIEVE:
2094 resultset = c->tasks->u.retrieve.resultset;
2095 start = &c->tasks->u.retrieve.start;
2096 count = &c->tasks->u.retrieve.count;
2101 if (sr && sr->which == Z_Records_NSD)
2102 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2103 else if (sr && sr->which == Z_Records_multipleNSD)
2105 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2106 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2108 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2112 if (*count + *start > resultset->size)
2113 *count = resultset->size - *start;
2116 if (sr && sr->which == Z_Records_DBOSD)
2119 NMEM nmem = odr_extract_mem(c->odr_in);
2120 Z_NamePlusRecordList *p =
2121 sr->u.databaseOrSurDiagnostics;
2122 for (i = 0; i<p->num_records; i++)
2124 record_cache_add(resultset, p->records[i], i + *start);
2128 yaz_log(log_details,
2129 "handle_records resultset=%p start=%d count=%d",
2130 resultset, *start, *count);
2132 /* transfer our response to search_nmem .. we need it later */
2133 nmem_transfer(resultset->odr->mem, nmem);
2135 if (present_phase && p->num_records == 0)
2137 /* present response and we didn't get any records! */
2138 Z_NamePlusRecord *myrec =
2139 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2140 record_cache_add(resultset, myrec, *start);
2143 else if (present_phase)
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);
2153 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2155 handle_records(c, pr->records, 1);
2158 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2161 switch (term->which)
2163 case Z_Term_general:
2164 ZOOM_options_setl(opt, name,
2165 (const char *)(term->u.general->buf),
2166 term->u.general->len);
2168 case Z_Term_characterString:
2169 ZOOM_options_set(opt, name, term->u.characterString);
2171 case Z_Term_numeric:
2172 ZOOM_options_set_int(opt, name, *term->u.numeric);
2177 static void handle_queryExpression(ZOOM_options opt, const char *name,
2178 Z_QueryExpression *exp)
2184 case Z_QueryExpression_term:
2185 if (exp->u.term && exp->u.term->queryTerm)
2187 sprintf(opt_name, "%s.term", name);
2188 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2191 case Z_QueryExpression_query:
2196 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2197 Z_OtherInformation *o)
2200 for (i = 0; o && i < o->num_elements; i++)
2202 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2204 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2206 if (ext->which == Z_External_searchResult1)
2209 Z_SearchInfoReport *sr = ext->u.searchResult1;
2212 ZOOM_options_set_int(
2213 resultset->options, "searchresult.size", sr->num);
2215 for (j = 0; j < sr->num; j++)
2217 Z_SearchInfoReport_s *ent =
2218 ext->u.searchResult1->elements[j];
2221 sprintf(pref, "searchresult.%d", j);
2223 if (ent->subqueryId)
2226 sprintf(opt_name, "%s.id", pref);
2227 ZOOM_options_set(resultset->options, opt_name,
2230 if (ent->subqueryExpression)
2233 sprintf(opt_name, "%s.subquery", pref);
2234 handle_queryExpression(resultset->options, opt_name,
2235 ent->subqueryExpression);
2237 if (ent->subqueryInterpretation)
2240 sprintf(opt_name, "%s.interpretation", pref);
2241 handle_queryExpression(resultset->options, opt_name,
2242 ent->subqueryInterpretation);
2244 if (ent->subqueryRecommendation)
2247 sprintf(opt_name, "%s.recommendation", pref);
2248 handle_queryExpression(resultset->options, opt_name,
2249 ent->subqueryRecommendation);
2251 if (ent->subqueryCount)
2254 sprintf(opt_name, "%s.count", pref);
2255 ZOOM_options_set_int(resultset->options, opt_name,
2256 *ent->subqueryCount);
2264 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2266 ZOOM_resultset resultset;
2269 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2272 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2273 ZOOM_connection_put_event(c, event);
2275 resultset = c->tasks->u.search.resultset;
2277 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2279 resultset->size = *sr->resultCount;
2280 handle_records(c, sr->records, 0);
2283 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2285 if (res->diagnostics && res->num_diagnostics > 0)
2286 response_diag(c, res->diagnostics[0]);
2289 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2291 NMEM nmem = odr_extract_mem(c->odr_in);
2294 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2296 scan = c->tasks->u.scan.scan;
2298 if (res->entries && res->entries->nonsurrogateDiagnostics)
2299 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2300 scan->scan_response = res;
2301 nmem_transfer(scan->odr->mem, nmem);
2303 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2304 if (res->positionOfTerm)
2305 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2306 if (res->scanStatus)
2307 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2308 if (res->numberOfEntriesReturned)
2309 ZOOM_options_set_int(scan->options, "number",
2310 *res->numberOfEntriesReturned);
2315 static zoom_ret send_sort(ZOOM_connection c,
2316 ZOOM_resultset resultset)
2319 resultset->r_sort_spec = 0;
2320 if (resultset->r_sort_spec)
2322 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2323 Z_SortRequest *req = apdu->u.sortRequest;
2325 req->num_inputResultSetNames = 1;
2326 req->inputResultSetNames = (Z_InternationalString **)
2327 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2328 req->inputResultSetNames[0] =
2329 odr_strdup(c->odr_out, resultset->setname);
2330 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2331 req->sortSequence = resultset->r_sort_spec;
2332 resultset->r_sort_spec = 0;
2333 return send_APDU(c, apdu);
2335 return zoom_complete;
2338 static zoom_ret send_present(ZOOM_connection c)
2341 Z_PresentRequest *req = 0;
2343 const char *syntax = 0;
2344 const char *elementSetName = 0;
2345 ZOOM_resultset resultset;
2350 yaz_log(log_details, "%p send_present no tasks", c);
2351 return zoom_complete;
2354 switch (c->tasks->which)
2356 case ZOOM_TASK_SEARCH:
2357 resultset = c->tasks->u.search.resultset;
2358 start = &c->tasks->u.search.start;
2359 count = &c->tasks->u.search.count;
2361 case ZOOM_TASK_RETRIEVE:
2362 resultset = c->tasks->u.retrieve.resultset;
2363 start = &c->tasks->u.retrieve.start;
2364 count = &c->tasks->u.retrieve.count;
2366 if (*start >= resultset->size)
2368 yaz_log(log_details, "%p send_present start=%d >= size=%d",
2369 c, *start, resultset->size);
2370 return zoom_complete;
2372 if (*start + *count > resultset->size)
2373 *count = resultset->size - *start;
2376 return zoom_complete;
2378 yaz_log(log_details, "%p send_present start=%d count=%d",
2381 syntax = ZOOM_resultset_option_get(resultset, "preferredRecordSyntax");
2382 elementSetName = ZOOM_resultset_option_get(resultset, "elementSetName");
2384 if (c->error) /* don't continue on error */
2385 return zoom_complete;
2387 return zoom_complete;
2388 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2389 resultset, *start, *count);
2391 for (i = 0; i < *count; i++)
2394 record_cache_lookup(resultset, i + *start);
2399 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2400 ZOOM_connection_put_event(c, event);
2408 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2409 return zoom_complete;
2412 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2413 req = apdu->u.presentRequest;
2416 yaz_log(log_details, "%p send_present skip=%d", c, i);
2418 *req->resultSetStartPoint = *start + 1;
2419 *req->numberOfRecordsRequested = resultset->step>0 ?
2420 resultset->step : *count;
2421 if (*req->numberOfRecordsRequested + *start > resultset->size)
2422 *req->numberOfRecordsRequested = resultset->size - *start;
2423 assert(*req->numberOfRecordsRequested > 0);
2425 if (syntax && *syntax)
2426 req->preferredRecordSyntax =
2427 yaz_str_to_z3950oid(c->odr_out, CLASS_RECSYN, syntax);
2429 if (resultset->schema && *resultset->schema)
2431 Z_RecordComposition *compo = (Z_RecordComposition *)
2432 odr_malloc(c->odr_out, sizeof(*compo));
2434 req->recordComposition = compo;
2435 compo->which = Z_RecordComp_complex;
2436 compo->u.complex = (Z_CompSpec *)
2437 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2438 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2439 odr_malloc(c->odr_out, sizeof(bool_t));
2440 *compo->u.complex->selectAlternativeSyntax = 0;
2442 compo->u.complex->generic = (Z_Specification *)
2443 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2445 compo->u.complex->generic->which = Z_Schema_oid;
2446 compo->u.complex->generic->schema.oid = (Odr_oid *)
2447 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2449 if (!compo->u.complex->generic->schema.oid)
2451 /* OID wasn't a schema! Try record syntax instead. */
2453 compo->u.complex->generic->schema.oid = (Odr_oid *)
2454 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2456 if (elementSetName && *elementSetName)
2458 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2459 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2460 compo->u.complex->generic->elementSpec->which =
2461 Z_ElementSpec_elementSetName;
2462 compo->u.complex->generic->elementSpec->u.elementSetName =
2463 odr_strdup(c->odr_out, elementSetName);
2466 compo->u.complex->generic->elementSpec = 0;
2467 compo->u.complex->num_dbSpecific = 0;
2468 compo->u.complex->dbSpecific = 0;
2469 compo->u.complex->num_recordSyntax = 0;
2470 compo->u.complex->recordSyntax = 0;
2472 else if (elementSetName && *elementSetName)
2474 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2475 odr_malloc(c->odr_out, sizeof(*esn));
2476 Z_RecordComposition *compo = (Z_RecordComposition *)
2477 odr_malloc(c->odr_out, sizeof(*compo));
2479 esn->which = Z_ElementSetNames_generic;
2480 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2481 compo->which = Z_RecordComp_simple;
2482 compo->u.simple = esn;
2483 req->recordComposition = compo;
2485 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2486 return send_APDU(c, apdu);
2489 ZOOM_API(ZOOM_scanset)
2490 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2493 ZOOM_query q = ZOOM_query_create();
2495 ZOOM_query_prefix(q, start);
2497 s = ZOOM_connection_scan1(c, q);
2498 ZOOM_query_destroy(q);
2503 ZOOM_API(ZOOM_scanset)
2504 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2506 ZOOM_scanset scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2510 scan->connection = c;
2511 scan->odr = odr_createmem(ODR_DECODE);
2512 scan->options = ZOOM_options_create_with_parent(c->options);
2514 scan->scan_response = 0;
2517 * We need to check the query-type, so we can recognise CQL and
2518 * CCL and compile them into a form that we can use here. The
2519 * ZOOM_query structure has no explicit `type' member, but
2520 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2521 * functions shows how the structure is set up in each case.
2523 if (q->z_query->which == Z_Query_type_1) {
2524 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2525 c, q, q->query_string);
2526 start = q->query_string;
2527 } else if (q->z_query->which == Z_Query_type_104) {
2528 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2529 c, q, q->query_string);
2530 start = freeme = cql2pqf(c, q->query_string);
2534 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2535 c, q, q->query_string);
2539 scan->termListAndStartPoint =
2540 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2542 if (scan->termListAndStartPoint != 0)
2544 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2545 task->u.scan.scan = scan;
2550 while (ZOOM_event(1, &c))
2558 ZOOM_scanset_destroy(ZOOM_scanset scan)
2563 if (scan->refcount == 0)
2565 odr_destroy(scan->odr);
2567 ZOOM_options_destroy(scan->options);
2572 static zoom_ret send_package(ZOOM_connection c)
2576 yaz_log(log_details, "%p send_package", c);
2578 return zoom_complete;
2579 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2581 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2582 ZOOM_connection_put_event(c, event);
2584 c->buf_out = c->tasks->u.package->buf_out;
2585 c->len_out = c->tasks->u.package->len_out;
2590 static zoom_ret send_scan(ZOOM_connection c)
2593 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2594 Z_ScanRequest *req = apdu->u.scanRequest;
2596 yaz_log(log_details, "%p send_scan", c);
2598 return zoom_complete;
2599 assert (c->tasks->which == ZOOM_TASK_SCAN);
2600 scan = c->tasks->u.scan.scan;
2602 req->termListAndStartPoint = scan->termListAndStartPoint;
2603 req->attributeSet = scan->attributeSet;
2605 *req->numberOfTermsRequested =
2606 ZOOM_options_get_int(scan->options, "number", 10);
2608 req->preferredPositionInResponse =
2609 odr_intdup(c->odr_out,
2610 ZOOM_options_get_int(scan->options, "position", 1));
2613 odr_intdup(c->odr_out,
2614 ZOOM_options_get_int(scan->options, "stepSize", 0));
2616 req->databaseNames = set_DatabaseNames(c, scan->options,
2617 &req->num_databaseNames);
2619 return send_APDU(c, apdu);
2623 ZOOM_scanset_size(ZOOM_scanset scan)
2625 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2627 return scan->scan_response->entries->num_entries;
2630 ZOOM_API(const char *)
2631 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2634 const char *term = 0;
2635 size_t noent = ZOOM_scanset_size(scan);
2636 Z_ScanResponse *res = scan->scan_response;
2642 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2644 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2646 if (t->term->which == Z_Term_general)
2648 term = (const char *) t->term->u.general->buf;
2649 *len = t->term->u.general->len;
2651 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2656 ZOOM_API(const char *)
2657 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2660 const char *term = 0;
2661 size_t noent = ZOOM_scanset_size(scan);
2662 Z_ScanResponse *res = scan->scan_response;
2668 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2670 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2674 term = t->displayTerm;
2675 *len = strlen(term);
2677 else if (t->term->which == Z_Term_general)
2679 term = (const char *) t->term->u.general->buf;
2680 *len = t->term->u.general->len;
2682 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2687 ZOOM_API(const char *)
2688 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2690 return ZOOM_options_get(scan->options, key);
2694 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2697 ZOOM_options_set(scan->options, key, val);
2700 static Z_APDU *create_es_package(ZOOM_package p, int type)
2703 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2704 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2706 *req->function = Z_ExtendedServicesRequest_create;
2708 str = ZOOM_options_get(p->options, "package-name");
2710 req->packageName = nmem_strdup(p->odr_out->mem, str);
2712 str = ZOOM_options_get(p->options, "user-id");
2714 req->userId = nmem_strdup(p->odr_out->mem, str);
2716 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2719 str = ZOOM_options_get(p->options, "function");
2722 if (!strcmp (str, "create"))
2724 if (!strcmp (str, "delete"))
2726 if (!strcmp (str, "modify"))
2732 static const char *ill_array_lookup(void *clientData, const char *idx)
2734 ZOOM_package p = (ZOOM_package) clientData;
2735 return ZOOM_options_get(p->options, idx+4);
2738 static Z_External *encode_ill_request(ZOOM_package p)
2740 ODR out = p->odr_out;
2743 struct ill_get_ctl ctl;
2745 ctl.odr = p->odr_out;
2747 ctl.f = ill_array_lookup;
2749 req = ill_get_ILLRequest(&ctl, "ill", 0);
2751 if (!ill_Request(out, &req, 0, 0))
2753 int ill_request_size;
2754 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2755 if (ill_request_buf)
2756 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2762 int illRequest_size = 0;
2763 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2765 oid.proto = PROTO_GENERAL;
2766 oid.oclass = CLASS_GENERAL;
2767 oid.value = VAL_ISO_ILL_1;
2769 r = (Z_External *) odr_malloc(out, sizeof(*r));
2770 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2771 r->indirect_reference = 0;
2773 r->which = Z_External_single;
2775 r->u.single_ASN1_type =
2776 odr_create_Odr_oct(out,
2777 (unsigned char *)illRequest_buf,
2783 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2785 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2788 req->which = Z_IOItemOrder_esRequest;
2789 req->u.esRequest = (Z_IORequest *)
2790 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2792 /* to keep part ... */
2793 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2794 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2795 req->u.esRequest->toKeep->supplDescription = 0;
2796 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2797 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2799 str = ZOOM_options_get(p->options, "contact-name");
2800 req->u.esRequest->toKeep->contact->name = str ?
2801 nmem_strdup(p->odr_out->mem, str) : 0;
2803 str = ZOOM_options_get(p->options, "contact-phone");
2804 req->u.esRequest->toKeep->contact->phone = str ?
2805 nmem_strdup(p->odr_out->mem, str) : 0;
2807 str = ZOOM_options_get(p->options, "contact-email");
2808 req->u.esRequest->toKeep->contact->email = str ?
2809 nmem_strdup(p->odr_out->mem, str) : 0;
2811 req->u.esRequest->toKeep->addlBilling = 0;
2813 /* not to keep part ... */
2814 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2815 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2817 str = ZOOM_options_get(p->options, "itemorder-setname");
2822 req->u.esRequest->notToKeep->resultSetItem = 0;
2825 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2826 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2828 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2829 nmem_strdup(p->odr_out->mem, str);
2830 req->u.esRequest->notToKeep->resultSetItem->item =
2831 (int *) odr_malloc(p->odr_out, sizeof(int));
2833 str = ZOOM_options_get(p->options, "itemorder-item");
2834 *req->u.esRequest->notToKeep->resultSetItem->item =
2835 (str ? atoi(str) : 1);
2837 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2842 Z_APDU *create_admin_package(ZOOM_package p, int type,
2843 Z_ESAdminOriginPartToKeep **toKeepP,
2844 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2846 Z_APDU *apdu = create_es_package(p, VAL_ADMINSERVICE);
2849 Z_ESAdminOriginPartToKeep *toKeep;
2850 Z_ESAdminOriginPartNotToKeep *notToKeep;
2851 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
2852 const char *first_db = "Default";
2854 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2858 r->direct_reference =
2859 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2862 r->indirect_reference = 0;
2863 r->which = Z_External_ESAdmin;
2865 r->u.adminService = (Z_Admin *)
2866 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2867 r->u.adminService->which = Z_Admin_esRequest;
2868 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2869 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2871 toKeep = r->u.adminService->u.esRequest->toKeep =
2872 (Z_ESAdminOriginPartToKeep *)
2873 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2874 toKeep->which = type;
2875 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2876 toKeep->u.create = odr_nullval();
2877 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2879 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2880 (Z_ESAdminOriginPartNotToKeep *)
2881 odr_malloc(p->odr_out,
2882 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2883 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
2884 notToKeep->u.recordsWillFollow = odr_nullval();
2888 *notToKeepP = notToKeep;
2893 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
2895 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
2896 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2897 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
2898 const char *doc = ZOOM_options_get(p->options, "doc");
2903 req->taskSpecificParameters = ext;
2904 ext->direct_reference = req->packageType;
2905 ext->descriptor = 0;
2906 ext->indirect_reference = 0;
2908 ext->which = Z_External_octet;
2909 ext->u.single_ASN1_type =
2910 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
2915 static Z_APDU *create_update_package(ZOOM_package p)
2918 const char *first_db = "Default";
2920 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2921 const char *action = ZOOM_options_get(p->options, "action");
2922 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
2923 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
2924 const char *record_buf = ZOOM_options_get(p->options, "record");
2925 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
2926 int syntax_oid = VAL_NONE;
2930 syntax_oid = oid_getvalbyname(syntax_str);
2933 record_buf = "void";
2934 syntax_oid = VAL_SUTRS;
2936 if (syntax_oid == VAL_NONE)
2937 syntax_oid = VAL_TEXT_XML;
2943 action = "specialUpdate";
2945 if (!strcmp(action, "recordInsert"))
2946 action_no = Z_IUOriginPartToKeep_recordInsert;
2947 else if (!strcmp(action, "recordReplace"))
2948 action_no = Z_IUOriginPartToKeep_recordReplace;
2949 else if (!strcmp(action, "recordDelete"))
2950 action_no = Z_IUOriginPartToKeep_recordDelete;
2951 else if (!strcmp(action, "elementUpdate"))
2952 action_no = Z_IUOriginPartToKeep_elementUpdate;
2953 else if (!strcmp(action, "specialUpdate"))
2954 action_no = Z_IUOriginPartToKeep_specialUpdate;
2958 apdu = create_es_package(p, VAL_DBUPDATE);
2961 Z_IUOriginPartToKeep *toKeep;
2962 Z_IUSuppliedRecords *notToKeep;
2963 Z_External *r = (Z_External *)
2964 odr_malloc(p->odr_out, sizeof(*r));
2966 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2968 r->direct_reference =
2969 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2972 r->which = Z_External_update;
2973 r->indirect_reference = 0;
2974 r->u.update = (Z_IUUpdate *)
2975 odr_malloc(p->odr_out, sizeof(*r->u.update));
2977 r->u.update->which = Z_IUUpdate_esRequest;
2978 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
2979 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
2980 toKeep = r->u.update->u.esRequest->toKeep =
2981 (Z_IUOriginPartToKeep *)
2982 odr_malloc(p->odr_out, sizeof(*toKeep));
2984 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2986 toKeep->elementSetName = 0;
2987 toKeep->actionQualifier = 0;
2988 toKeep->action = odr_intdup(p->odr_out, action_no);
2990 notToKeep = r->u.update->u.esRequest->notToKeep =
2991 (Z_IUSuppliedRecords *)
2992 odr_malloc(p->odr_out, sizeof(*notToKeep));
2994 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
2995 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
2996 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
2997 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
2998 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3001 notToKeep->elements[0]->u.opaque =
3002 odr_create_Odr_oct(p->odr_out,
3003 (const unsigned char *) recordIdOpaque,
3004 strlen(recordIdOpaque));
3006 else if (recordIdNumber)
3008 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3010 notToKeep->elements[0]->u.number =
3011 odr_intdup(p->odr_out, atoi(recordIdNumber));
3014 notToKeep->elements[0]->u.opaque = 0;
3015 notToKeep->elements[0]->supplementalId = 0;
3016 notToKeep->elements[0]->correlationInfo = 0;
3017 notToKeep->elements[0]->record =
3018 z_ext_record(p->odr_out, syntax_oid,
3019 record_buf, strlen(record_buf));
3023 ODR print = odr_createmem(ODR_PRINT);
3025 z_APDU(print, &apdu, 0, 0);
3032 ZOOM_package_send(ZOOM_package p, const char *type)
3039 odr_reset(p->odr_out);
3042 if (!strcmp(type, "itemorder"))
3044 apdu = create_es_package(p, VAL_ITEMORDER);
3047 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3049 r->direct_reference =
3050 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3053 r->which = Z_External_itemOrder;
3054 r->indirect_reference = 0;
3055 r->u.itemOrder = encode_item_order(p);
3057 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3060 else if (!strcmp(type, "create")) /* create database */
3062 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3065 else if (!strcmp(type, "drop")) /* drop database */
3067 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3070 else if (!strcmp(type, "commit")) /* commit changes */
3072 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3075 else if (!strcmp(type, "update")) /* update record(s) */
3077 apdu = create_update_package(p);
3079 else if (!strcmp(type, "xmlupdate"))
3081 apdu = create_xmlupdate_package(p);
3085 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3089 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3090 task->u.package = p;
3091 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3092 p->buf_out = (char *) xmalloc(p->len_out);
3093 memcpy(p->buf_out, buf, p->len_out);
3098 while (ZOOM_event(1, &c))
3105 ZOOM_API(ZOOM_package)
3106 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3108 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3111 p->odr_out = odr_createmem(ODR_ENCODE);
3112 p->options = ZOOM_options_create_with_parent2(options, c->options);
3120 ZOOM_package_destroy(ZOOM_package p)
3125 if (p->refcount == 0)
3127 odr_destroy(p->odr_out);
3130 ZOOM_options_destroy(p->options);
3135 ZOOM_API(const char *)
3136 ZOOM_package_option_get(ZOOM_package p, const char *key)
3138 return ZOOM_options_get(p->options, key);
3143 ZOOM_package_option_set(ZOOM_package p, const char *key,
3146 ZOOM_options_set(p->options, key, val);
3149 static int ZOOM_connection_exec_task(ZOOM_connection c)
3151 ZOOM_task task = c->tasks;
3152 zoom_ret ret = zoom_complete;
3156 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3157 c, task->which, task->running);
3158 if (c->error != ZOOM_ERROR_NONE)
3160 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3161 "removing tasks because of error = %d", c, c->error);
3162 ZOOM_connection_remove_tasks(c);
3167 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3168 "task already running", c);
3172 ret = zoom_complete;
3173 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3175 switch (task->which)
3177 case ZOOM_TASK_SEARCH:
3178 if (c->proto == PROTO_HTTP)
3179 ret = ZOOM_connection_srw_send_search(c);
3181 ret = ZOOM_connection_send_search(c);
3183 case ZOOM_TASK_RETRIEVE:
3184 if (c->proto == PROTO_HTTP)
3185 ret = ZOOM_connection_srw_send_search(c);
3187 ret = send_present(c);
3189 case ZOOM_TASK_CONNECT:
3190 ret = do_connect(c);
3192 case ZOOM_TASK_SCAN:
3195 case ZOOM_TASK_PACKAGE:
3196 ret = send_package(c);
3198 case ZOOM_TASK_SORT:
3199 c->tasks->u.sort.resultset->r_sort_spec =
3200 c->tasks->u.sort.q->sort_spec;
3201 ret = send_sort(c, c->tasks->u.sort.resultset);
3207 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3208 "remove tasks because no connection exist", c);
3209 ZOOM_connection_remove_tasks(c);
3211 if (ret == zoom_complete)
3213 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3214 "task removed (complete)", c);
3215 ZOOM_connection_remove_task(c);
3218 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3223 static zoom_ret send_sort_present(ZOOM_connection c)
3225 zoom_ret r = zoom_complete;
3227 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3228 r = send_sort(c, c->tasks->u.search.resultset);
3229 if (r == zoom_complete)
3230 r = send_present(c);
3234 static int es_response(ZOOM_connection c,
3235 Z_ExtendedServicesResponse *res)
3237 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3239 if (res->diagnostics && res->num_diagnostics > 0)
3240 response_diag(c, res->diagnostics[0]);
3241 if (res->taskPackage &&
3242 res->taskPackage->which == Z_External_extendedService)
3244 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3245 Odr_oct *id = taskPackage->targetReference;
3248 ZOOM_options_setl(c->tasks->u.package->options,
3249 "targetReference", (char*) id->buf, id->len);
3251 if (res->taskPackage &&
3252 res->taskPackage->which == Z_External_octet)
3254 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3255 ZOOM_options_setl(c->tasks->u.package->options,
3256 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3261 static void interpret_init_diag(ZOOM_connection c,
3262 Z_DiagnosticFormat *diag)
3266 Z_DiagnosticFormat_s *ds = diag->elements[0];
3267 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3268 response_default_diag(c, ds->u.defaultDiagRec);
3273 static void interpret_otherinformation_field(ZOOM_connection c,
3274 Z_OtherInformation *ui)
3277 for (i = 0; i < ui->num_elements; i++)
3279 Z_OtherInformationUnit *unit = ui->list[i];
3280 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3281 unit->information.externallyDefinedInfo &&
3282 unit->information.externallyDefinedInfo->which ==
3285 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3290 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3292 Z_InitResponse *initrs;
3295 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3298 case Z_APDU_initResponse:
3299 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3300 initrs = apdu->u.initResponse;
3301 ZOOM_connection_option_set(c, "serverImplementationId",
3302 initrs->implementationId ?
3303 initrs->implementationId : "");
3304 ZOOM_connection_option_set(c, "serverImplementationName",
3305 initrs->implementationName ?
3306 initrs->implementationName : "");
3307 ZOOM_connection_option_set(c, "serverImplementationVersion",
3308 initrs->implementationVersion ?
3309 initrs->implementationVersion : "");
3310 /* Set the three old options too, for old applications */
3311 ZOOM_connection_option_set(c, "targetImplementationId",
3312 initrs->implementationId ?
3313 initrs->implementationId : "");
3314 ZOOM_connection_option_set(c, "targetImplementationName",
3315 initrs->implementationName ?
3316 initrs->implementationName : "");
3317 ZOOM_connection_option_set(c, "targetImplementationVersion",
3318 initrs->implementationVersion ?
3319 initrs->implementationVersion : "");
3320 if (!*initrs->result)
3322 Z_External *uif = initrs->userInformationField;
3324 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3326 if (uif && uif->which == Z_External_userInfo1)
3327 interpret_otherinformation_field(c, uif->u.userInfo1);
3332 yaz_oi_get_string_oidval(&apdu->u.initResponse->otherInfo,
3334 xfree(c->cookie_in);
3337 c->cookie_in = xstrdup(cookie);
3338 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3339 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3340 c->support_named_resultsets = 1;
3343 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3344 ZOOM_connection_remove_task(c);
3346 ZOOM_connection_exec_task(c);
3348 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3350 NMEM tmpmem = nmem_create();
3351 Z_CharSetandLanguageNegotiation *p =
3352 yaz_get_charneg_record(initrs->otherInfo);
3356 char *charset = NULL, *lang = NULL;
3359 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3360 yaz_log(log_details, "%p recv_apdu target accepted: "
3361 "charset %s, language %s, select %d",
3363 charset ? charset : "none", lang ? lang : "none", sel);
3365 ZOOM_connection_option_set(c, "negotiation-charset",
3368 ZOOM_connection_option_set(c, "negotiation-lang",
3371 ZOOM_connection_option_set(
3372 c, "negotiation-charset-in-effect-for-records",
3373 (sel != 0) ? "1" : "0");
3374 nmem_destroy(tmpmem);
3378 case Z_APDU_searchResponse:
3379 yaz_log(log_api, "%p recv_apdu Search response", c);
3380 handle_search_response(c, apdu->u.searchResponse);
3381 if (send_sort_present(c) == zoom_complete)
3382 ZOOM_connection_remove_task(c);
3384 case Z_APDU_presentResponse:
3385 yaz_log(log_api, "%p recv_apdu Present response", c);
3386 handle_present_response(c, apdu->u.presentResponse);
3387 if (send_present(c) == zoom_complete)
3388 ZOOM_connection_remove_task(c);
3390 case Z_APDU_sortResponse:
3391 yaz_log(log_api, "%p recv_apdu Sort response", c);
3392 sort_response(c, apdu->u.sortResponse);
3393 if (send_present(c) == zoom_complete)
3394 ZOOM_connection_remove_task(c);
3396 case Z_APDU_scanResponse:
3397 yaz_log(log_api, "%p recv_apdu Scan response", c);
3398 scan_response(c, apdu->u.scanResponse);
3399 ZOOM_connection_remove_task(c);
3401 case Z_APDU_extendedServicesResponse:
3402 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3403 es_response(c, apdu->u.extendedServicesResponse);
3404 ZOOM_connection_remove_task(c);
3407 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3408 if (c->reconnect_ok)
3411 c->tasks->running = 0;
3412 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
3416 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3421 yaz_log(log_api, "%p Received unknown PDU", c);
3422 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3428 static void handle_srw_response(ZOOM_connection c,
3429 Z_SRW_searchRetrieveResponse *res)
3431 ZOOM_resultset resultset = 0;
3440 if (c->tasks->which == ZOOM_TASK_SEARCH)
3442 resultset = c->tasks->u.search.resultset;
3443 start = &c->tasks->u.search.start;
3445 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
3447 resultset = c->tasks->u.retrieve.resultset;
3448 start = &c->tasks->u.retrieve.start;
3453 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3454 ZOOM_connection_put_event(c, event);
3456 resultset->size = 0;
3458 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3460 if (res->numberOfRecords)
3461 resultset->size = *res->numberOfRecords;
3463 for (i = 0; i<res->num_records; i++)
3467 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3468 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3470 if (res->records[i].recordPosition &&
3471 *res->records[i].recordPosition > 0)
3472 pos = *res->records[i].recordPosition - 1;
3476 npr->databaseName = 0;
3477 npr->which = Z_NamePlusRecord_databaseRecord;
3478 npr->u.databaseRecord = (Z_External *)
3479 odr_malloc(c->odr_in, sizeof(Z_External));
3480 npr->u.databaseRecord->descriptor = 0;
3481 npr->u.databaseRecord->direct_reference =
3482 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3483 npr->u.databaseRecord->which = Z_External_octet;
3485 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3486 odr_malloc(c->odr_in, sizeof(Odr_oct));
3487 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3488 res->records[i].recordData_buf;
3489 npr->u.databaseRecord->u.octet_aligned->len =
3490 npr->u.databaseRecord->u.octet_aligned->size =
3491 res->records[i].recordData_len;
3492 record_cache_add(resultset, npr, pos);
3494 if (res->num_diagnostics > 0)
3496 const char *uri = res->diagnostics[0].uri;
3501 if ((cp = strrchr(uri, '/')))
3503 set_dset_error(c, code, uri,
3504 res->diagnostics[0].details, 0);
3507 nmem = odr_extract_mem(c->odr_in);
3508 nmem_transfer(resultset->odr->mem, nmem);
3514 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3517 const char *content_type = z_HTTP_header_lookup(hres->headers,
3519 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3522 yaz_log(log_details, "%p handle_http", c);
3524 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3526 Z_SOAP *soap_package = 0;
3528 Z_SOAP_Handler soap_handlers[2] = {
3529 {"http://www.loc.gov/zing/srw/", 0,
3530 (Z_SOAP_fun) yaz_srw_codec},
3533 ret = z_soap_codec(o, &soap_package,
3534 &hres->content_buf, &hres->content_len,
3536 if (!ret && soap_package->which == Z_SOAP_generic &&
3537 soap_package->u.generic->no == 0)
3539 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3540 if (sr->which == Z_SRW_searchRetrieve_response)
3541 handle_srw_response(c, sr->u.response);
3545 else if (!ret && (soap_package->which == Z_SOAP_fault
3546 || soap_package->which == Z_SOAP_error))
3548 set_HTTP_error(c, hres->code,
3549 soap_package->u.fault->fault_code,
3550 soap_package->u.fault->fault_string);
3557 if (hres->code != 200)
3558 set_HTTP_error(c, hres->code, 0, 0);
3560 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3563 ZOOM_connection_remove_task(c);
3564 if (!strcmp(hres->version, "1.0"))
3566 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3567 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3572 /* HTTP 1.1: only if no close we stay alive .. */
3573 if (connection_head && !strcmp(connection_head, "close"))
3579 static int do_read(ZOOM_connection c)
3584 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3585 ZOOM_connection_put_event(c, event);
3587 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3588 more = cs_more(c->cs);
3589 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3594 if (c->reconnect_ok)
3597 c->reconnect_ok = 0;
3598 yaz_log(log_details, "%p do_read reconnect read", c);
3599 c->tasks->running = 0;
3600 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
3604 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3613 odr_reset(c->odr_in);
3614 odr_setbuf(c->odr_in, c->buf_in, r, 0);
3615 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3616 ZOOM_connection_put_event(c, event);
3618 if (!z_GDU(c->odr_in, &gdu, 0, 0))
3621 int err = odr_geterrorx(c->odr_in, &x);
3623 const char *element = odr_getelement(c->odr_in);
3624 sprintf(msg, "ODR code %d:%d element=%-20s",
3625 err, x, element ? element : "<unknown>");
3626 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3629 else if (gdu->which == Z_GDU_Z3950)
3630 recv_apdu(c, gdu->u.z3950);
3631 else if (gdu->which == Z_GDU_HTTP_Response)
3634 handle_http(c, gdu->u.HTTP_Response);
3636 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3640 c->reconnect_ok = 0;
3645 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3650 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3651 ZOOM_connection_put_event(c, event);
3653 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3654 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3656 yaz_log(log_details, "%p do_write_ex write failed", c);
3657 if (c->reconnect_ok)
3660 c->reconnect_ok = 0;
3661 yaz_log(log_details, "%p do_write_ex reconnect write", c);
3662 c->tasks->running = 0;
3663 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
3664 return zoom_pending;
3666 if (c->state == STATE_CONNECTING)
3667 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3669 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3671 return zoom_complete;
3675 c->mask = ZOOM_SELECT_EXCEPT;
3676 if (c->cs->io_pending & CS_WANT_WRITE)
3677 c->mask += ZOOM_SELECT_WRITE;
3678 if (c->cs->io_pending & CS_WANT_READ)
3679 c->mask += ZOOM_SELECT_READ;
3680 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3685 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3686 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3689 return zoom_pending;
3692 static zoom_ret do_write(ZOOM_connection c)
3694 return do_write_ex(c, c->buf_out, c->len_out);
3698 ZOOM_API(const char *)
3699 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3701 return ZOOM_options_get(c->options, key);
3704 ZOOM_API(const char *)
3705 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3707 return ZOOM_options_getl(c->options, key, lenp);
3711 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3714 ZOOM_options_set(c->options, key, val);
3718 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3719 const char *val, int len)
3721 ZOOM_options_setl(c->options, key, val, len);
3724 ZOOM_API(const char *)
3725 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3727 return ZOOM_options_get(r->options, key);
3731 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3734 ZOOM_options_set(r->options, key, val);
3739 ZOOM_connection_errcode(ZOOM_connection c)
3741 return ZOOM_connection_error(c, 0, 0);
3744 ZOOM_API(const char *)
3745 ZOOM_connection_errmsg(ZOOM_connection c)
3748 ZOOM_connection_error(c, &msg, 0);
3752 ZOOM_API(const char *)
3753 ZOOM_connection_addinfo(ZOOM_connection c)
3755 const char *addinfo;
3756 ZOOM_connection_error(c, 0, &addinfo);
3760 ZOOM_API(const char *)
3761 ZOOM_connection_diagset(ZOOM_connection c)
3763 const char *diagset;
3764 ZOOM_connection_error_x(c, 0, 0, &diagset);
3768 ZOOM_API(const char *)
3769 ZOOM_diag_str(int error)
3773 case ZOOM_ERROR_NONE:
3775 case ZOOM_ERROR_CONNECT:
3776 return "Connect failed";
3777 case ZOOM_ERROR_MEMORY:
3778 return "Out of memory";
3779 case ZOOM_ERROR_ENCODE:
3780 return "Encoding failed";
3781 case ZOOM_ERROR_DECODE:
3782 return "Decoding failed";
3783 case ZOOM_ERROR_CONNECTION_LOST:
3784 return "Connection lost";
3785 case ZOOM_ERROR_INIT:
3786 return "Init rejected";
3787 case ZOOM_ERROR_INTERNAL:
3788 return "Internal failure";
3789 case ZOOM_ERROR_TIMEOUT:
3791 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3792 return "Unsupported protocol";
3793 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3794 return "Unsupported query type";
3795 case ZOOM_ERROR_INVALID_QUERY:
3796 return "Invalid query";
3797 case ZOOM_ERROR_CQL_PARSE:
3798 return "CQL parsing error";
3799 case ZOOM_ERROR_CQL_TRANSFORM:
3800 return "CQL transformation error";
3801 case ZOOM_ERROR_CCL_CONFIG:
3802 return "CCL configuration error";
3803 case ZOOM_ERROR_CCL_PARSE:
3804 return "CCL parsing error";
3806 return diagbib1_str(error);
3811 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
3812 const char **addinfo, const char **diagset)
3814 int error = c->error;
3817 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3818 *cp = ZOOM_diag_str(error);
3819 else if (!strcmp(c->diagset, "HTTP"))
3820 *cp = z_HTTP_errmsg(c->error);
3821 else if (!strcmp(c->diagset, "Bib-1"))
3822 *cp = ZOOM_diag_str(error);
3823 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3824 *cp = yaz_diag_srw_str(c->error);
3826 *cp = "Unknown error and diagnostic set";
3829 *addinfo = c->addinfo ? c->addinfo : "";
3831 *diagset = c->diagset ? c->diagset : "";
3836 ZOOM_connection_error(ZOOM_connection c, const char **cp,
3837 const char **addinfo)
3839 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3842 static int ZOOM_connection_do_io(ZOOM_connection c, int mask)
3844 ZOOM_Event event = 0;
3845 int r = cs_look(c->cs);
3846 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
3851 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
3852 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3854 ZOOM_connection_put_event(c, event);
3856 else if (r == CS_CONNECT)
3859 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
3861 ret = cs_rcvconnect(c->cs);
3862 yaz_log(log_details, "%p ZOOM_connection_do_io "
3863 "cs_rcvconnect returned %d", c, ret);
3866 c->mask = ZOOM_SELECT_EXCEPT;
3867 if (c->cs->io_pending & CS_WANT_WRITE)
3868 c->mask += ZOOM_SELECT_WRITE;
3869 if (c->cs->io_pending & CS_WANT_READ)
3870 c->mask += ZOOM_SELECT_READ;
3871 ZOOM_connection_put_event(c, event);
3875 ZOOM_connection_put_event(c, event);
3877 if (c->proto == PROTO_Z3950)
3878 ZOOM_connection_send_init(c);
3881 /* no init request for SRW .. */
3882 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3883 ZOOM_connection_remove_task(c);
3885 ZOOM_connection_exec_task(c);
3887 c->state = STATE_ESTABLISHED;
3891 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3893 ZOOM_connection_put_event(c, event);
3898 if (mask & ZOOM_SELECT_READ)
3900 if (c->cs && (mask & ZOOM_SELECT_WRITE))
3907 ZOOM_connection_last_event(ZOOM_connection cs)
3910 return ZOOM_EVENT_NONE;
3911 return cs->last_event;
3915 ZOOM_event(int no, ZOOM_connection *cs)
3917 int timeout = 30; /* default timeout in seconds */
3918 int timeout_set = 0; /* whether it was overriden at all */
3920 struct pollfd pollfds[1024];
3921 ZOOM_connection poll_cs[1024];
3924 fd_set input, output, except;
3929 yaz_log(log_details, "ZOOM_event(no=%d,cs=%p)", no, cs);
3930 for (i = 0; i<no; i++)
3932 ZOOM_connection c = cs[i];
3934 if (c && (event = ZOOM_connection_get_event(c)))
3936 ZOOM_Event_destroy(event);
3940 for (i = 0; i<no; i++)
3942 ZOOM_connection c = cs[i];
3946 ZOOM_connection_exec_task(c);
3947 if ((event = ZOOM_connection_get_event(c)))
3949 ZOOM_Event_destroy(event);
3962 for (i = 0; i<no; i++)
3964 ZOOM_connection c = cs[i];
3970 fd = z3950_connection_socket(c);
3971 mask = z3950_connection_mask(c);
3978 /* -1 is used for indefinite timeout (no timeout), so -2 here. */
3979 this_timeout = ZOOM_options_get_int(c->options, "timeout", -2);
3980 if (this_timeout != -2)
3982 /* ensure the minimum timeout is used */
3984 timeout = this_timeout;
3985 else if (this_timeout != -1 && this_timeout < timeout)
3986 timeout = this_timeout;
3992 short poll_events = 0;
3994 if (mask & ZOOM_SELECT_READ)
3995 poll_events += POLLIN;
3996 if (mask & ZOOM_SELECT_WRITE)
3997 poll_events += POLLOUT;
3998 if (mask & ZOOM_SELECT_EXCEPT)
3999 poll_events += POLLERR;
4000 pollfds[nfds].fd = fd;
4001 pollfds[nfds].events = poll_events;
4002 pollfds[nfds].revents = 0;
4007 if (mask & ZOOM_SELECT_READ)
4012 if (mask & ZOOM_SELECT_WRITE)
4014 FD_SET(fd, &output);
4017 if (mask & ZOOM_SELECT_EXCEPT)
4019 FD_SET(fd, &except);
4028 r = poll(pollfds, nfds, (timeout == -1 ? -1 : timeout * 1000));
4029 for (i = 0; i<nfds; i++)
4031 ZOOM_connection c = poll_cs[i];
4035 if (pollfds[i].revents & POLLIN)
4036 mask += ZOOM_SELECT_READ;
4037 if (pollfds[i].revents & POLLOUT)
4038 mask += ZOOM_SELECT_WRITE;
4039 if (pollfds[i].revents & POLLERR)
4040 mask += ZOOM_SELECT_EXCEPT;
4042 ZOOM_connection_do_io(c, mask);
4044 else if (r == 0 && c->mask)
4046 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4047 /* timeout and this connection was waiting */
4048 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4050 ZOOM_connection_put_event(c, event);
4054 tv.tv_sec = timeout;
4056 r = select(max_fd+1, &input, &output, &except, (timeout == -1 ? 0 : &tv));
4057 for (i = 0; i<no; i++)
4059 ZOOM_connection c = cs[i];
4064 fd = z3950_connection_socket(c);
4068 /* no timeout and real socket */
4069 if (FD_ISSET(fd, &input))
4070 mask += ZOOM_SELECT_READ;
4071 if (FD_ISSET(fd, &output))
4072 mask += ZOOM_SELECT_WRITE;
4073 if (FD_ISSET(fd, &except))
4074 mask += ZOOM_SELECT_EXCEPT;
4076 ZOOM_connection_do_io(c, mask);
4078 if (r == 0 && c->mask)
4080 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4081 /* timeout and this connection was waiting */
4082 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4084 ZOOM_connection_put_event(c, event);
4088 for (i = 0; i<no; i++)
4090 ZOOM_connection c = cs[i];
4092 if (c && (event = ZOOM_connection_get_event(c)))
4094 ZOOM_Event_destroy(event);
4103 * Returns an xmalloc()d string containing RPN that corresponds to the
4104 * CQL passed in. On error, sets the Connection object's error state
4105 * and returns a null pointer.
4106 * ### We could cache CQL parser and/or transformer in Connection.
4108 static char *cql2pqf(ZOOM_connection c, const char *cql)
4112 struct cql_node *node;
4113 const char *cqlfile;
4114 static cql_transform_t trans;
4117 parser = cql_parser_create();
4118 if ((error = cql_parser_string(parser, cql)) != 0) {
4119 cql_parser_destroy(parser);
4120 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4124 node = cql_parser_result(parser);
4125 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4127 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4129 cql_parser_destroy(parser);
4130 cql_node_destroy(node);
4131 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4135 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4137 cql_parser_destroy(parser);
4138 cql_node_destroy(node);
4139 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4140 cqlfile, strerror(errno));
4141 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4145 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4146 cql_parser_destroy(parser);
4147 cql_node_destroy(node);
4150 const char *addinfo;
4151 error = cql_transform_error(trans, &addinfo);
4152 cql_transform_close(trans);
4153 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4154 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4158 cql_transform_close(trans);
4159 return xstrdup(pqfbuf);
4165 * indent-tabs-mode: nil
4167 * vim: shiftwidth=4 tabstop=8 expandtab