2 * Copyright (C) 1995-2006, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.91 2006-10-04 16:24:05 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>
44 #define FD_SETSIZE 512
49 static int log_api = 0;
50 static int log_details = 0;
57 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
58 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
59 static char *cql2pqf(ZOOM_connection c, const char *cql);
61 static void initlog(void)
63 static int log_level_initialized = 0;
64 if (!log_level_initialized)
66 log_api = yaz_log_module_level("zoom");
67 log_details = yaz_log_module_level("zoomdetails");
68 log_level_initialized = 1;
72 static ZOOM_Event ZOOM_Event_create(int kind)
74 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
78 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
82 static void ZOOM_Event_destroy(ZOOM_Event event)
87 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
91 c->m_queue_back->prev = event;
92 assert(c->m_queue_front);
96 assert(!c->m_queue_front);
97 c->m_queue_front = event;
99 event->next = c->m_queue_back;
101 c->m_queue_back = event;
104 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
106 ZOOM_Event event = c->m_queue_front;
109 c->last_event = ZOOM_EVENT_NONE;
112 assert(c->m_queue_back);
113 c->m_queue_front = event->prev;
114 if (c->m_queue_front)
116 assert(c->m_queue_back);
117 c->m_queue_front->next = 0;
121 c->last_event = event->kind;
126 static void set_dset_error(ZOOM_connection c, int error,
128 const char *addinfo, const char *addinfo2)
135 if (!c->diagset || strcmp(dset, c->diagset))
138 c->diagset = xstrdup(dset);
139 /* remove integer part from SRW diagset .. */
140 if ((cp = strrchr(c->diagset, '/')))
143 if (addinfo && addinfo2)
145 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
146 strcpy(c->addinfo, addinfo);
147 strcat(c->addinfo, addinfo2);
150 c->addinfo = xstrdup(addinfo);
152 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
153 c, c->host_port ? c->host_port : "<>", dset, error,
154 addinfo ? addinfo : "",
155 addinfo2 ? addinfo2 : "");
159 static void set_HTTP_error(ZOOM_connection c, int error,
160 const char *addinfo, const char *addinfo2)
162 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
166 static void set_ZOOM_error(ZOOM_connection c, int error,
169 set_dset_error(c, error, "ZOOM", addinfo, 0);
172 static void clear_error(ZOOM_connection c)
175 * If an error is tied to an operation then it's ok to clear: for
176 * example, a diagnostic returned from a search is cleared by a
177 * subsequent search. However, problems such as Connection Lost
178 * or Init Refused are not cleared, because they are not
179 * recoverable: doing another search doesn't help.
183 case ZOOM_ERROR_CONNECT:
184 case ZOOM_ERROR_MEMORY:
185 case ZOOM_ERROR_DECODE:
186 case ZOOM_ERROR_CONNECTION_LOST:
187 case ZOOM_ERROR_INIT:
188 case ZOOM_ERROR_INTERNAL:
189 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
192 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
196 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
198 ZOOM_task *taskp = &c->tasks;
200 taskp = &(*taskp)->next;
201 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
202 (*taskp)->running = 0;
203 (*taskp)->which = which;
209 int ZOOM_connection_is_idle(ZOOM_connection c)
211 return c->tasks ? 0 : 1;
214 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
216 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
218 task->next = c->tasks;
227 void ZOOM_connection_remove_task(ZOOM_connection c)
229 ZOOM_task task = c->tasks;
233 c->tasks = task->next;
236 case ZOOM_TASK_SEARCH:
237 ZOOM_resultset_destroy(task->u.search.resultset);
239 case ZOOM_TASK_RETRIEVE:
240 ZOOM_resultset_destroy(task->u.retrieve.resultset);
242 case ZOOM_TASK_CONNECT:
245 ZOOM_scanset_destroy(task->u.scan.scan);
247 case ZOOM_TASK_PACKAGE:
248 ZOOM_package_destroy(task->u.package);
251 ZOOM_resultset_destroy(task->u.sort.resultset);
252 ZOOM_query_destroy(task->u.sort.q);
261 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
262 ZOOM_connection_put_event(c, event);
267 static int ZOOM_connection_exec_task(ZOOM_connection c);
269 void ZOOM_connection_remove_tasks(ZOOM_connection c)
272 ZOOM_connection_remove_task(c);
275 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos);
277 ZOOM_API(ZOOM_connection)
278 ZOOM_connection_create(ZOOM_options options)
280 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
284 yaz_log(log_api, "%p ZOOM_connection_create", c);
286 c->proto = PROTO_Z3950;
290 c->state = STATE_IDLE;
293 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
300 c->options = ZOOM_options_create_with_parent(options);
306 c->charset = c->lang = 0;
313 c->odr_in = odr_createmem(ODR_DECODE);
314 c->odr_out = odr_createmem(ODR_ENCODE);
317 c->support_named_resultsets = 0;
318 c->last_event = ZOOM_EVENT_NONE;
320 c->m_queue_front = 0;
326 /* set database names. Take local databases (if set); otherwise
327 take databases given in ZURL (if set); otherwise use Default */
328 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
331 char **databaseNames;
332 const char *cp = ZOOM_options_get(options, "databaseName");
334 if ((!cp || !*cp) && con->host_port)
336 if (strncmp(con->host_port, "unix:", 5) == 0)
337 cp = strchr(con->host_port+5, ':');
339 cp = strchr(con->host_port, '/');
345 nmem_strsplit(con->odr_out->mem, "+", cp, &databaseNames, num);
346 return databaseNames;
349 ZOOM_API(ZOOM_connection)
350 ZOOM_connection_new(const char *host, int portnum)
352 ZOOM_connection c = ZOOM_connection_create(0);
354 ZOOM_connection_connect(c, host, portnum);
358 static zoom_sru_mode get_sru_mode_from_string(const char *s)
361 return zoom_sru_soap;
362 if (!yaz_matchstr(s, "soap"))
363 return zoom_sru_soap;
364 else if (!yaz_matchstr(s, "get"))
366 else if (!yaz_matchstr(s, "post"))
367 return zoom_sru_post;
368 return zoom_sru_error;
372 ZOOM_connection_connect(ZOOM_connection c,
373 const char *host, int portnum)
380 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
383 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
384 ZOOM_connection_remove_tasks(c);
388 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
392 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
394 val = ZOOM_options_get(c->options, "proxy");
397 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
398 c->proxy = xstrdup(val);
404 val = ZOOM_options_get(c->options, "charset");
407 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
408 c->charset = xstrdup(val);
414 val = ZOOM_options_get(c->options, "lang");
417 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
418 c->lang = xstrdup(val);
423 val = ZOOM_options_get(c->options, "sru");
424 c->sru_mode = get_sru_mode_from_string(val);
430 sprintf(hostn, "%.80s:%d", host, portnum);
431 c->host_port = xstrdup(hostn);
434 c->host_port = xstrdup(host);
438 * If the "<scheme>:" part of the host string is preceded by one
439 * or more comma-separated <name>=<value> pairs, these are taken
440 * to be options to be set on the connection object. Among other
441 * applications, this facility can be used to embed authentication
443 * user=admin,password=secret,tcp:localhost:9999
445 char *remainder = c->host_port;
446 char *pcolon = strchr(remainder, ':');
449 while ((pcomma = strchr(remainder, ',')) != 0 &&
450 (pcolon == 0 || pcomma < pcolon)) {
452 if ((pequals = strchr(remainder, '=')) != 0) {
454 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
455 ZOOM_connection_option_set(c, remainder, pequals+1);
457 remainder = pcomma+1;
460 if (remainder != c->host_port) {
462 c->host_port = xstrdup(remainder);
463 /*printf("# reset hp='%s'\n", remainder);*/
467 ZOOM_options_set(c->options, "host", c->host_port);
469 val = ZOOM_options_get(c->options, "cookie");
472 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
473 c->cookie_out = xstrdup(val);
476 val = ZOOM_options_get(c->options, "clientIP");
479 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
481 c->client_IP = xstrdup(val);
484 c->async = ZOOM_options_get_bool(c->options, "async", 0);
485 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
487 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
491 while (ZOOM_event(1, &c))
497 ZOOM_query_create(void)
499 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
501 yaz_log(log_details, "%p ZOOM_query_create", s);
505 s->odr = odr_createmem(ODR_ENCODE);
512 ZOOM_query_destroy(ZOOM_query s)
518 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
519 if (s->refcount == 0)
527 ZOOM_query_prefix(ZOOM_query s, const char *str)
529 s->query_string = odr_strdup(s->odr, str);
530 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
531 s->z_query->which = Z_Query_type_1;
532 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
533 if (!s->z_query->u.type_1)
535 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
539 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
544 ZOOM_query_cql(ZOOM_query s, const char *str)
548 s->query_string = odr_strdup(s->odr, str);
550 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
551 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
552 ext->indirect_reference = 0;
554 ext->which = Z_External_CQL;
555 ext->u.cql = s->query_string;
557 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
558 s->z_query->which = Z_Query_type_104;
559 s->z_query->u.type_104 = ext;
561 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
567 * Translate the CQL string client-side into RPN which is passed to
568 * the server. This is useful for server's that don't themselves
569 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
570 * only as a place to stash diagnostics if compilation fails; if this
571 * information is not needed, a null pointer may be used.
574 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
578 ZOOM_connection freeme = 0;
580 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
582 conn = freeme = ZOOM_connection_create(0);
584 rpn = cql2pqf(conn, str);
586 ZOOM_connection_destroy(freeme);
590 ret = ZOOM_query_prefix(s, rpn);
596 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
597 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
598 * to the server, as the YAZ GFS doesn't know how to handle this.
601 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
602 int *ccl_error, const char **error_string,
606 struct ccl_rpn_node *rpn;
607 CCL_bibset bibset = ccl_qual_mk();
610 ccl_qual_buf(bibset, config);
612 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
615 *error_string = ccl_err_msg(*ccl_error);
620 WRBUF wr = wrbuf_alloc();
623 ret = ZOOM_query_prefix(s, wrbuf_buf(wr));
626 ccl_qual_rm(&bibset);
631 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
633 s->sort_spec = yaz_sort_spec(s->odr, criteria);
636 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
640 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
644 static zoom_ret do_write(ZOOM_connection c);
647 ZOOM_connection_destroy(ZOOM_connection c)
652 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
655 for (r = c->resultsets; r; r = r->next)
661 odr_destroy(c->odr_in);
662 odr_destroy(c->odr_out);
663 ZOOM_options_destroy(c->options);
664 ZOOM_connection_remove_tasks(c);
670 xfree(c->cookie_out);
676 void ZOOM_resultset_addref(ZOOM_resultset r)
681 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
686 ZOOM_resultset ZOOM_resultset_create(void)
689 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
693 yaz_log(log_details, "%p ZOOM_resultset_create", r);
696 r->odr = odr_createmem(ODR_ENCODE);
701 for (i = 0; i<RECORD_HASH_SIZE; i++)
702 r->record_hash[i] = 0;
710 ZOOM_API(ZOOM_resultset)
711 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
714 ZOOM_query s = ZOOM_query_create();
716 ZOOM_query_prefix(s, q);
718 r = ZOOM_connection_search(c, s);
719 ZOOM_query_destroy(s);
723 ZOOM_API(ZOOM_resultset)
724 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
726 ZOOM_resultset r = ZOOM_resultset_create();
731 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
732 r->r_sort_spec = q->sort_spec;
735 r->options = ZOOM_options_create_with_parent(c->options);
737 start = ZOOM_options_get_int(r->options, "start", 0);
738 count = ZOOM_options_get_int(r->options, "count", 0);
740 /* If "presentChunk" is defined use that; otherwise "step" */
741 const char *cp = ZOOM_options_get(r->options, "presentChunk");
742 r->step = ZOOM_options_get_int(r->options,
743 (cp != 0 ? "presentChunk": "step"), 0);
745 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
746 cp = ZOOM_options_get(r->options, "setname");
748 r->setname = xstrdup(cp);
749 cp = ZOOM_options_get(r->options, "schema");
751 r->schema = xstrdup(cp);
755 r->next = c->resultsets;
758 if (c->host_port && c->proto == PROTO_HTTP)
762 yaz_log(log_details, "ZOOM_connection_search: no comstack");
763 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
767 yaz_log(log_details, "ZOOM_connection_search: reconnect");
772 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
773 task->u.search.resultset = r;
774 task->u.search.start = start;
775 task->u.search.count = count;
776 ZOOM_resultset_addref(r);
782 while (ZOOM_event(1, &c))
789 * This is the old result-set sorting API, which is maintained only
790 * for the sake of binary compatibility. There is no reason ever to
791 * use this rather than ZOOM_resultset_sort1().
794 ZOOM_resultset_sort(ZOOM_resultset r,
795 const char *sort_type, const char *sort_spec)
797 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
801 ZOOM_resultset_sort1(ZOOM_resultset r,
802 const char *sort_type, const char *sort_spec)
804 ZOOM_connection c = r->connection;
808 newq = ZOOM_query_create();
809 if (ZOOM_query_sortby(newq, sort_spec) < 0)
812 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
813 r, r, sort_type, sort_spec);
817 if (c->host_port && c->proto == PROTO_HTTP)
821 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
822 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
826 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
832 ZOOM_resultset_cache_reset(r);
833 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
834 task->u.sort.resultset = r;
835 task->u.sort.q = newq;
837 ZOOM_resultset_addref(r);
841 while (ZOOM_event(1, &c))
849 ZOOM_resultset_cache_reset(ZOOM_resultset r)
852 for (i = 0; i<RECORD_HASH_SIZE; i++)
854 ZOOM_record_cache rc;
855 for (rc = r->record_hash[i]; rc; rc = rc->next)
857 if (rc->rec.wrbuf_marc)
858 wrbuf_free(rc->rec.wrbuf_marc, 1);
859 if (rc->rec.wrbuf_iconv)
860 wrbuf_free(rc->rec.wrbuf_iconv, 1);
861 if (rc->rec.wrbuf_opac)
862 wrbuf_free(rc->rec.wrbuf_opac, 1);
864 r->record_hash[i] = 0;
869 ZOOM_resultset_destroy(ZOOM_resultset r)
874 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
876 if (r->refcount == 0)
878 ZOOM_resultset_cache_reset(r);
882 /* remove ourselves from the resultsets in connection */
883 ZOOM_resultset *rp = &r->connection->resultsets;
886 assert(*rp); /* we must be in this list!! */
888 { /* OK, we're here - take us out of it */
895 ZOOM_query_destroy(r->query);
896 ZOOM_options_destroy(r->options);
905 ZOOM_resultset_size(ZOOM_resultset r)
910 static void do_close(ZOOM_connection c)
916 c->state = STATE_IDLE;
919 static int ZOOM_test_reconnect(ZOOM_connection c)
921 if (!c->reconnect_ok)
925 c->tasks->running = 0;
926 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
930 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
931 int force_sync, int start, int count)
939 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
940 " count=%d", r, force_sync, start, count);
945 if (c->host_port && c->proto == PROTO_HTTP)
949 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
950 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
954 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
959 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
960 task->u.retrieve.resultset = r;
961 task->u.retrieve.start = start;
962 task->u.retrieve.count = count;
964 cp = ZOOM_options_get(r->options, "schema");
967 if (!r->schema || strcmp(r->schema, cp))
970 r->schema = xstrdup(cp);
974 ZOOM_resultset_addref(r);
976 if (!r->connection->async || force_sync)
977 while (r->connection && ZOOM_event(1, &r->connection))
982 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
983 size_t start, size_t count)
985 int force_present = 0;
989 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
990 r, r, (long) start, (long) count);
993 ZOOM_resultset_retrieve(r, force_present, start, count);
997 for (i = 0; i< count; i++)
998 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1002 static void get_cert(ZOOM_connection c)
1007 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1009 ZOOM_connection_option_setl(c, "sslPeerCert",
1010 cert_buf, cert_len);
1015 static zoom_ret do_connect(ZOOM_connection c)
1018 const char *effective_host;
1021 effective_host = c->proxy;
1023 effective_host = c->host_port;
1025 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1029 c->cs = cs_create_host(effective_host, 0, &add);
1031 if (c->cs && c->cs->protocol == PROTO_HTTP)
1034 const char *path = 0;
1036 c->proto = PROTO_HTTP;
1037 cs_get_host_args(c->host_port, &path);
1039 c->path = (char*) xmalloc(strlen(path)+2);
1041 strcpy(c->path+1, path);
1043 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1045 return zoom_complete;
1050 int ret = cs_connect(c->cs, add);
1053 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1054 ZOOM_connection_put_event(c, event);
1056 if (c->proto == PROTO_Z3950)
1057 ZOOM_connection_send_init(c);
1060 /* no init request for SRW .. */
1061 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1062 ZOOM_connection_remove_task(c);
1064 ZOOM_connection_exec_task(c);
1066 c->state = STATE_ESTABLISHED;
1067 return zoom_pending;
1071 c->state = STATE_CONNECTING;
1072 c->mask = ZOOM_SELECT_EXCEPT;
1073 if (c->cs->io_pending & CS_WANT_WRITE)
1074 c->mask += ZOOM_SELECT_WRITE;
1075 if (c->cs->io_pending & CS_WANT_READ)
1076 c->mask += ZOOM_SELECT_READ;
1077 return zoom_pending;
1080 c->state = STATE_IDLE;
1081 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1082 return zoom_complete;
1085 int z3950_connection_socket(ZOOM_connection c)
1088 return cs_fileno(c->cs);
1092 int z3950_connection_mask(ZOOM_connection c)
1099 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1102 for (i = 0; i<200; i++)
1105 Z_OtherInformation **oi;
1111 sprintf(buf, "otherInfo%d", i);
1112 val = ZOOM_options_get(c->options, buf);
1115 cp = strchr(val, ':');
1119 if (len >= sizeof(buf))
1120 len = sizeof(buf)-1;
1121 memcpy(buf, val, len);
1123 oidval = oid_getvalbyname(buf);
1124 if (oidval == VAL_NONE)
1127 yaz_oi_APDU(a, &oi);
1128 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1132 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1137 Z_OtherInformation **oi;
1138 yaz_oi_APDU(a, &oi);
1139 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1143 Z_OtherInformation **oi;
1144 yaz_oi_APDU(a, &oi);
1145 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1147 otherInfo_attach(c, a, out);
1148 if (!z_APDU(out, &a, 0, 0))
1150 FILE *outf = fopen("/tmp/apdu.txt", "a");
1153 ODR odr_pr = odr_createmem(ODR_PRINT);
1154 fprintf(outf, "a=%p\n", a);
1155 odr_setprint(odr_pr, outf);
1156 z_APDU(odr_pr, &a, 0, 0);
1157 odr_destroy(odr_pr);
1159 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1160 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1164 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1168 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1172 if (encode_APDU(c, a, c->odr_out))
1173 return zoom_complete;
1174 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1175 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1176 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1177 ZOOM_connection_put_event(c, event);
1178 odr_reset(c->odr_out);
1182 /* returns 1 if PDU was sent OK (still pending )
1183 0 if PDU was not sent OK (nothing to wait for)
1186 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1188 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1189 Z_InitRequest *ireq = apdu->u.initRequest;
1190 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1191 odr_malloc(c->odr_out, sizeof(*auth));
1192 const char *auth_groupId = ZOOM_options_get(c->options, "group");
1193 const char *auth_userId = ZOOM_options_get(c->options, "user");
1194 const char *auth_password = ZOOM_options_get(c->options, "password");
1197 /* support the pass for backwards compatibility */
1199 auth_password = ZOOM_options_get(c->options, "pass");
1201 ODR_MASK_SET(ireq->options, Z_Options_search);
1202 ODR_MASK_SET(ireq->options, Z_Options_present);
1203 ODR_MASK_SET(ireq->options, Z_Options_scan);
1204 ODR_MASK_SET(ireq->options, Z_Options_sort);
1205 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1206 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1208 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1209 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1210 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1212 /* Index Data's Z39.50 Implementor Id is 81 */
1213 ireq->implementationId =
1214 odr_prepend(c->odr_out,
1215 ZOOM_options_get(c->options, "implementationId"),
1216 odr_prepend(c->odr_out, "81", ireq->implementationId));
1218 ireq->implementationName =
1219 odr_prepend(c->odr_out,
1220 ZOOM_options_get(c->options, "implementationName"),
1221 odr_prepend(c->odr_out, "ZOOM-C",
1222 ireq->implementationName));
1224 version = odr_strdup(c->odr_out, "$Revision: 1.91 $");
1225 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1226 version[strlen(version)-2] = '\0';
1227 ireq->implementationVersion =
1228 odr_prepend(c->odr_out,
1229 ZOOM_options_get(c->options, "implementationVersion"),
1230 odr_prepend(c->odr_out, &version[11],
1231 ireq->implementationVersion));
1233 *ireq->maximumRecordSize =
1234 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
1235 *ireq->preferredMessageSize =
1236 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
1238 if (auth_groupId || auth_password)
1240 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1243 if (auth_groupId && *auth_groupId)
1245 pass->groupId = (char *)
1246 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1247 strcpy(pass->groupId, auth_groupId);
1251 if (auth_userId && *auth_userId)
1253 pass->userId = (char *)
1254 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1255 strcpy(pass->userId, auth_userId);
1259 if (auth_password && *auth_password)
1261 pass->password = (char *)
1262 odr_malloc(c->odr_out, strlen(auth_password)+1);
1263 strcpy(pass->password, auth_password);
1268 auth->which = Z_IdAuthentication_idPass;
1269 auth->u.idPass = pass;
1270 ireq->idAuthentication = auth;
1273 else if (auth_userId)
1275 auth->which = Z_IdAuthentication_open;
1276 auth->u.open = (char *)
1277 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1278 strcpy(auth->u.open, auth_userId);
1279 ireq->idAuthentication = auth;
1282 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1283 VAL_PROXY, 1, c->host_port);
1284 if (c->charset || c->lang)
1286 Z_OtherInformation **oi;
1287 Z_OtherInformationUnit *oi_unit;
1289 yaz_oi_APDU(apdu, &oi);
1291 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1293 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1294 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1295 oi_unit->information.externallyDefinedInfo =
1296 yaz_set_proposal_charneg_list(c->odr_out, " ",
1297 c->charset, c->lang, 1);
1301 return send_APDU(c, apdu);
1305 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1310 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1312 if (c->sru_mode == zoom_sru_get)
1314 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1316 else if (c->sru_mode == zoom_sru_post)
1318 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1320 else if (c->sru_mode == zoom_sru_soap)
1322 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1324 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1325 return zoom_complete;
1326 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1328 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1329 ZOOM_connection_put_event(c, event);
1330 odr_reset(c->odr_out);
1336 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1340 ZOOM_resultset resultset = 0;
1342 const char *option_val = 0;
1344 if (c->error) /* don't continue on error */
1345 return zoom_complete;
1347 if (c->tasks->which == ZOOM_TASK_SEARCH)
1349 resultset = c->tasks->u.search.resultset;
1350 resultset->setname = xstrdup("default");
1351 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1352 start = &c->tasks->u.search.start;
1353 count = &c->tasks->u.search.count;
1355 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
1357 resultset = c->tasks->u.retrieve.resultset;
1359 start = &c->tasks->u.retrieve.start;
1360 count = &c->tasks->u.retrieve.count;
1362 if (*start >= resultset->size)
1363 return zoom_complete;
1364 if (*start + *count > resultset->size)
1365 *count = resultset->size - *start;
1367 for (i = 0; i < *count; i++)
1370 record_cache_lookup(resultset, i + *start);
1375 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1376 ZOOM_connection_put_event(c, event);
1383 return zoom_complete;
1385 assert(resultset->query);
1387 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1389 if (resultset->query->z_query->which == Z_Query_type_104
1390 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1392 sr->u.request->query_type = Z_SRW_query_type_cql;
1393 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1395 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1396 resultset->query->z_query->u.type_1)
1398 sr->u.request->query_type = Z_SRW_query_type_pqf;
1399 sr->u.request->query.pqf = resultset->query->query_string;
1403 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1404 return zoom_complete;
1406 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1407 sr->u.request->maximumRecords = odr_intdup(
1408 c->odr_out, resultset->step>0 ? resultset->step : *count);
1409 sr->u.request->recordSchema = resultset->schema;
1411 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1413 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1415 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1417 sr->extra_args = odr_strdup(c->odr_out, option_val);
1418 return send_srw(c, sr);
1421 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1423 return zoom_complete;
1427 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1430 int lslb, ssub, mspn;
1432 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1433 Z_SearchRequest *search_req = apdu->u.searchRequest;
1434 const char *elementSetName;
1435 const char *smallSetElementSetName;
1436 const char *mediumSetElementSetName;
1439 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1441 r = c->tasks->u.search.resultset;
1443 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1446 ZOOM_options_get(r->options, "elementSetName");
1447 smallSetElementSetName =
1448 ZOOM_options_get(r->options, "smallSetElementSetName");
1449 mediumSetElementSetName =
1450 ZOOM_options_get(r->options, "mediumSetElementSetName");
1452 if (!smallSetElementSetName)
1453 smallSetElementSetName = elementSetName;
1455 if (!mediumSetElementSetName)
1456 mediumSetElementSetName = elementSetName;
1461 /* prepare query for the search request */
1462 search_req->query = r->query->z_query;
1463 if (!search_req->query)
1465 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1466 return zoom_complete;
1469 search_req->databaseNames =
1470 set_DatabaseNames(c, r->options, &search_req->num_databaseNames);
1472 /* get syntax (no need to provide unless piggyback is in effect) */
1473 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1475 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1476 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1477 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1478 if (lslb != -1 && ssub != -1 && mspn != -1)
1480 /* So're a Z39.50 expert? Let's hope you don't do sort */
1481 *search_req->largeSetLowerBound = lslb;
1482 *search_req->smallSetUpperBound = ssub;
1483 *search_req->mediumSetPresentNumber = mspn;
1485 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1486 && r->piggyback && !r->r_sort_spec && !r->schema)
1488 /* Regular piggyback - do it unless we're going to do sort */
1489 *search_req->largeSetLowerBound = 2000000000;
1490 *search_req->smallSetUpperBound = 1;
1491 *search_req->mediumSetPresentNumber =
1492 r->step>0 ? r->step : c->tasks->u.search.count;
1496 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1497 smallSetElementSetName = 0;
1498 mediumSetElementSetName = 0;
1501 if (smallSetElementSetName && *smallSetElementSetName)
1503 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1504 odr_malloc(c->odr_out, sizeof(*esn));
1506 esn->which = Z_ElementSetNames_generic;
1507 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1508 search_req->smallSetElementSetNames = esn;
1510 if (mediumSetElementSetName && *mediumSetElementSetName)
1512 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1513 odr_malloc(c->odr_out, sizeof(*esn));
1515 esn->which = Z_ElementSetNames_generic;
1516 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1517 search_req->mediumSetElementSetNames = esn;
1520 search_req->preferredRecordSyntax =
1521 yaz_str_to_z3950oid(c->odr_out, CLASS_RECSYN, syntax);
1525 if (c->support_named_resultsets)
1529 /* find the lowest unused ordinal so that we re-use
1530 result sets on the server. */
1531 for (ord = 1; ; ord++)
1534 sprintf(setname, "%d", ord);
1535 for (rp = c->resultsets; rp; rp = rp->next)
1536 if (rp->setname && !strcmp(rp->setname, setname))
1541 r->setname = xstrdup(setname);
1542 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1543 "set %s", c, r->setname);
1547 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1549 r->setname = xstrdup("default");
1551 ZOOM_options_set(r->options, "setname", r->setname);
1553 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1554 return send_APDU(c, apdu);
1557 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1564 case Z_DefaultDiagFormat_v2Addinfo:
1565 addinfo = r->u.v2Addinfo;
1567 case Z_DefaultDiagFormat_v3Addinfo:
1568 addinfo = r->u.v3Addinfo;
1573 set_dset_error(c, *r->condition,
1574 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1578 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1580 if (p->which != Z_DiagRec_defaultFormat)
1581 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1583 response_default_diag(c, p->u.defaultFormat);
1586 ZOOM_API(ZOOM_record)
1587 ZOOM_record_clone(ZOOM_record srec)
1594 odr_enc = odr_createmem(ODR_ENCODE);
1595 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1597 buf = odr_getbuf(odr_enc, &size, 0);
1599 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1600 nrec->odr = odr_createmem(ODR_DECODE);
1601 nrec->wrbuf_marc = 0;
1602 nrec->wrbuf_iconv = 0;
1603 nrec->wrbuf_opac = 0;
1604 odr_setbuf(nrec->odr, buf, size, 0);
1605 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1607 odr_destroy(odr_enc);
1611 ZOOM_API(ZOOM_record)
1612 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1614 return record_cache_lookup(s, pos);
1617 ZOOM_API(ZOOM_record)
1618 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1620 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1625 * MIKE: I think force_sync should always be zero, but I don't
1626 * want to make this change until I get the go-ahead from
1627 * Adam, in case something depends on the old synchronous
1631 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1632 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1633 rec = ZOOM_resultset_record_immediate(r, pos);
1639 ZOOM_record_destroy(ZOOM_record rec)
1643 if (rec->wrbuf_marc)
1644 wrbuf_free(rec->wrbuf_marc, 1);
1645 if (rec->wrbuf_iconv)
1646 wrbuf_free(rec->wrbuf_iconv, 1);
1647 if (rec->wrbuf_opac)
1648 wrbuf_free(rec->wrbuf_opac, 1);
1649 odr_destroy(rec->odr);
1653 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1655 const char *buf, int sz,
1656 const char *record_charset)
1661 yaz_marc_t mt = yaz_marc_create();
1664 strcpy(to, "UTF-8");
1665 if (record_charset && *record_charset)
1667 /* Use "from,to" or just "from" */
1668 const char *cp = strchr(record_charset, ',');
1669 int clen = strlen(record_charset);
1672 strncpy( to, cp+1, sizeof(to)-1);
1673 to[sizeof(to)-1] = '\0';
1674 clen = cp - record_charset;
1676 if (clen > sizeof(from)-1)
1677 clen = sizeof(from)-1;
1680 strncpy(from, record_charset, clen);
1686 cd = yaz_iconv_open(to, from);
1687 yaz_marc_iconv(mt, cd);
1690 yaz_marc_xml(mt, marc_type);
1691 if (!rec->wrbuf_marc)
1692 rec->wrbuf_marc = wrbuf_alloc();
1693 wrbuf_rewind(rec->wrbuf_marc);
1694 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1696 yaz_marc_destroy(mt);
1698 yaz_iconv_close(cd);
1700 *len = wrbuf_len(rec->wrbuf_marc);
1701 return wrbuf_buf(rec->wrbuf_marc);
1703 yaz_marc_destroy(mt);
1705 yaz_iconv_close(cd);
1709 static const char *record_iconv_return(ZOOM_record rec, int *len,
1710 const char *buf, int sz,
1711 const char *record_charset)
1718 strcpy(to, "UTF-8");
1719 if (record_charset && *record_charset)
1721 /* Use "from,to" or just "from" */
1722 const char *cp = strchr(record_charset, ',');
1723 int clen = strlen(record_charset);
1726 strncpy( to, cp+1, sizeof(to)-1);
1727 to[sizeof(to)-1] = '\0';
1728 clen = cp - record_charset;
1730 if (clen > sizeof(from)-1)
1731 clen = sizeof(from)-1;
1734 strncpy(from, record_charset, clen);
1738 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1741 size_t inbytesleft = sz;
1742 const char *inp = buf;
1744 if (!rec->wrbuf_iconv)
1745 rec->wrbuf_iconv = wrbuf_alloc();
1747 wrbuf_rewind(rec->wrbuf_iconv);
1751 size_t outbytesleft = sizeof(outbuf);
1752 char *outp = outbuf;
1753 size_t r = yaz_iconv(cd, (char**) &inp,
1755 &outp, &outbytesleft);
1756 if (r == (size_t) (-1))
1758 int e = yaz_iconv_error(cd);
1759 if (e != YAZ_ICONV_E2BIG)
1762 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1764 wrbuf_puts(rec->wrbuf_iconv, "");
1765 buf = wrbuf_buf(rec->wrbuf_iconv);
1766 sz = wrbuf_len(rec->wrbuf_iconv);
1767 yaz_iconv_close(cd);
1774 ZOOM_API(const char *)
1775 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1782 Z_NamePlusRecord *npr;
1785 *len = 0; /* default return */
1794 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1796 if (cp[i] == ';' || cp[i] == ' ')
1802 while (type_spec[i] == ';')
1805 while (type_spec[i] == ' ')
1807 if (!strncmp(type_spec+i, "charset=", 8))
1810 i = i + 8; /* skip charset= */
1811 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1813 if (type_spec[i] == ';' || type_spec[i] == ' ')
1819 else if (!strncmp(type_spec+i, "xpath=", 6))
1823 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1827 while (type_spec[i] == ' ')
1830 if (!strcmp(type, "database"))
1833 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1834 return npr->databaseName;
1836 else if (!strcmp(type, "syntax"))
1838 const char *desc = 0;
1839 if (npr->which == Z_NamePlusRecord_databaseRecord)
1841 Z_External *r = (Z_External *) npr->u.databaseRecord;
1842 oident *ent = oid_getentbyoid(r->direct_reference);
1849 *len = strlen(desc);
1852 if (npr->which != Z_NamePlusRecord_databaseRecord)
1855 /* from now on - we have a database record .. */
1856 if (!strcmp(type, "render"))
1858 Z_External *r = (Z_External *) npr->u.databaseRecord;
1859 oident *ent = oid_getentbyoid(r->direct_reference);
1861 /* render bibliographic record .. */
1862 if (r->which == Z_External_OPAC)
1864 r = r->u.opac->bibliographicRecord;
1867 ent = oid_getentbyoid(r->direct_reference);
1869 if (r->which == Z_External_sutrs)
1870 return record_iconv_return(rec, len,
1871 (char*) r->u.sutrs->buf,
1874 else if (r->which == Z_External_octet)
1876 const char *ret_buf;
1884 case VAL_APPLICATION_XML:
1887 ret_buf = marc_iconv_return(
1888 rec, YAZ_MARC_LINE, len,
1889 (const char *) r->u.octet_aligned->buf,
1890 r->u.octet_aligned->len,
1895 return record_iconv_return(rec, len,
1896 (const char *) r->u.octet_aligned->buf,
1897 r->u.octet_aligned->len,
1900 else if (r->which == Z_External_grs1)
1902 if (!rec->wrbuf_marc)
1903 rec->wrbuf_marc = wrbuf_alloc();
1904 wrbuf_rewind(rec->wrbuf_marc);
1905 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1906 return record_iconv_return(rec, len,
1907 wrbuf_buf(rec->wrbuf_marc),
1908 wrbuf_len(rec->wrbuf_marc),
1913 else if (!strcmp(type, "xml"))
1915 Z_External *r = (Z_External *) npr->u.databaseRecord;
1916 oident *ent = oid_getentbyoid(r->direct_reference);
1918 /* render bibliographic record .. */
1919 if (r->which == Z_External_OPAC)
1921 r = r->u.opac->bibliographicRecord;
1924 ent = oid_getentbyoid(r->direct_reference);
1927 if (r->which == Z_External_sutrs)
1928 return record_iconv_return(rec, len,
1929 (const char *) r->u.sutrs->buf,
1932 else if (r->which == Z_External_octet)
1934 const char *ret_buf;
1935 int marc_decode_type = YAZ_MARC_MARCXML;
1944 case VAL_APPLICATION_XML:
1947 ret_buf = marc_iconv_return(
1948 rec, marc_decode_type, len,
1949 (const char *) r->u.octet_aligned->buf,
1950 r->u.octet_aligned->len,
1955 return record_iconv_return(rec, len,
1956 (const char *) r->u.octet_aligned->buf,
1957 r->u.octet_aligned->len,
1960 else if (r->which == Z_External_grs1)
1967 else if (!strcmp(type, "raw"))
1969 Z_External *r = (Z_External *) npr->u.databaseRecord;
1971 if (r->which == Z_External_sutrs)
1973 if (len) *len = r->u.sutrs->len;
1974 return (const char *) r->u.sutrs->buf;
1976 else if (r->which == Z_External_octet)
1978 if (len) *len = r->u.octet_aligned->len;
1979 return (const char *) r->u.octet_aligned->buf;
1981 else /* grs-1, explain, OPAC, ... */
1984 return (const char *) npr->u.databaseRecord;
1988 else if (!strcmp (type, "ext"))
1991 return (const char *) npr->u.databaseRecord;
1993 else if (!strcmp (type, "opac"))
1996 Z_External *r = (Z_External *) npr->u.databaseRecord;
1997 if (r->which == Z_External_OPAC)
1999 if (!rec->wrbuf_opac)
2000 rec->wrbuf_opac = wrbuf_alloc();
2001 wrbuf_rewind(rec->wrbuf_opac);
2002 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2003 return record_iconv_return(rec, len,
2004 wrbuf_buf(rec->wrbuf_opac),
2005 wrbuf_len(rec->wrbuf_opac),
2012 static int strcmp_null(const char *v1, const char *v2)
2018 return strcmp(v1, v2);
2021 static size_t record_hash(int pos)
2025 return pos % RECORD_HASH_SIZE;
2028 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2031 ZOOM_record_cache rc;
2032 const char *elementSetName =
2033 ZOOM_resultset_option_get(r, "elementSetName");
2034 const char *syntax =
2035 ZOOM_resultset_option_get(r, "preferredRecordSyntax");
2037 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2038 ZOOM_connection_put_event(r->connection, event);
2040 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2044 if (strcmp_null(r->schema, rc->schema))
2046 if (strcmp_null(elementSetName,rc->elementSetName))
2048 if (strcmp_null(syntax, rc->syntax))
2050 /* not destroying rc->npr (it's handled by nmem )*/
2052 /* keeping wrbuf_marc too */
2056 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2059 rc->rec.wrbuf_marc = 0;
2060 rc->rec.wrbuf_iconv = 0;
2061 rc->rec.wrbuf_opac = 0;
2063 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2065 rc->elementSetName = 0;
2068 rc->syntax = odr_strdup(r->odr, syntax);
2073 rc->schema = odr_strdup(r->odr, r->schema);
2078 rc->next = r->record_hash[record_hash(pos)];
2079 r->record_hash[record_hash(pos)] = rc;
2082 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos)
2084 ZOOM_record_cache rc;
2085 const char *elementSetName =
2086 ZOOM_resultset_option_get(r, "elementSetName");
2087 const char *syntax =
2088 ZOOM_resultset_option_get(r, "preferredRecordSyntax");
2090 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2094 if (strcmp_null(r->schema, rc->schema))
2096 if (strcmp_null(elementSetName,rc->elementSetName))
2098 if (strcmp_null(syntax, rc->syntax))
2106 static void handle_records(ZOOM_connection c, Z_Records *sr,
2109 ZOOM_resultset resultset;
2114 switch (c->tasks->which)
2116 case ZOOM_TASK_SEARCH:
2117 resultset = c->tasks->u.search.resultset;
2118 start = &c->tasks->u.search.start;
2119 count = &c->tasks->u.search.count;
2121 case ZOOM_TASK_RETRIEVE:
2122 resultset = c->tasks->u.retrieve.resultset;
2123 start = &c->tasks->u.retrieve.start;
2124 count = &c->tasks->u.retrieve.count;
2129 if (sr && sr->which == Z_Records_NSD)
2130 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2131 else if (sr && sr->which == Z_Records_multipleNSD)
2133 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2134 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2136 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2140 if (*count + *start > resultset->size)
2141 *count = resultset->size - *start;
2144 if (sr && sr->which == Z_Records_DBOSD)
2147 NMEM nmem = odr_extract_mem(c->odr_in);
2148 Z_NamePlusRecordList *p =
2149 sr->u.databaseOrSurDiagnostics;
2150 for (i = 0; i<p->num_records; i++)
2152 record_cache_add(resultset, p->records[i], i + *start);
2156 yaz_log(log_details,
2157 "handle_records resultset=%p start=%d count=%d",
2158 resultset, *start, *count);
2160 /* transfer our response to search_nmem .. we need it later */
2161 nmem_transfer(resultset->odr->mem, nmem);
2163 if (present_phase && p->num_records == 0)
2165 /* present response and we didn't get any records! */
2166 Z_NamePlusRecord *myrec =
2167 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2168 record_cache_add(resultset, myrec, *start);
2171 else if (present_phase)
2173 /* present response and we didn't get any records! */
2174 Z_NamePlusRecord *myrec =
2175 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2176 record_cache_add(resultset, myrec, *start);
2181 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2183 handle_records(c, pr->records, 1);
2186 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2189 switch (term->which)
2191 case Z_Term_general:
2192 ZOOM_options_setl(opt, name,
2193 (const char *)(term->u.general->buf),
2194 term->u.general->len);
2196 case Z_Term_characterString:
2197 ZOOM_options_set(opt, name, term->u.characterString);
2199 case Z_Term_numeric:
2200 ZOOM_options_set_int(opt, name, *term->u.numeric);
2205 static void handle_queryExpression(ZOOM_options opt, const char *name,
2206 Z_QueryExpression *exp)
2212 case Z_QueryExpression_term:
2213 if (exp->u.term && exp->u.term->queryTerm)
2215 sprintf(opt_name, "%s.term", name);
2216 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2219 case Z_QueryExpression_query:
2224 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2225 Z_OtherInformation *o)
2228 for (i = 0; o && i < o->num_elements; i++)
2230 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2232 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2234 if (ext->which == Z_External_searchResult1)
2237 Z_SearchInfoReport *sr = ext->u.searchResult1;
2240 ZOOM_options_set_int(
2241 resultset->options, "searchresult.size", sr->num);
2243 for (j = 0; j < sr->num; j++)
2245 Z_SearchInfoReport_s *ent =
2246 ext->u.searchResult1->elements[j];
2249 sprintf(pref, "searchresult.%d", j);
2251 if (ent->subqueryId)
2254 sprintf(opt_name, "%s.id", pref);
2255 ZOOM_options_set(resultset->options, opt_name,
2258 if (ent->subqueryExpression)
2261 sprintf(opt_name, "%s.subquery", pref);
2262 handle_queryExpression(resultset->options, opt_name,
2263 ent->subqueryExpression);
2265 if (ent->subqueryInterpretation)
2268 sprintf(opt_name, "%s.interpretation", pref);
2269 handle_queryExpression(resultset->options, opt_name,
2270 ent->subqueryInterpretation);
2272 if (ent->subqueryRecommendation)
2275 sprintf(opt_name, "%s.recommendation", pref);
2276 handle_queryExpression(resultset->options, opt_name,
2277 ent->subqueryRecommendation);
2279 if (ent->subqueryCount)
2282 sprintf(opt_name, "%s.count", pref);
2283 ZOOM_options_set_int(resultset->options, opt_name,
2284 *ent->subqueryCount);
2292 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2294 ZOOM_resultset resultset;
2297 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2300 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2301 ZOOM_connection_put_event(c, event);
2303 resultset = c->tasks->u.search.resultset;
2305 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2307 resultset->size = *sr->resultCount;
2308 handle_records(c, sr->records, 0);
2311 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2313 if (res->diagnostics && res->num_diagnostics > 0)
2314 response_diag(c, res->diagnostics[0]);
2317 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2319 NMEM nmem = odr_extract_mem(c->odr_in);
2322 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2324 scan = c->tasks->u.scan.scan;
2326 if (res->entries && res->entries->nonsurrogateDiagnostics)
2327 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2328 scan->scan_response = res;
2329 nmem_transfer(scan->odr->mem, nmem);
2331 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2332 if (res->positionOfTerm)
2333 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2334 if (res->scanStatus)
2335 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2336 if (res->numberOfEntriesReturned)
2337 ZOOM_options_set_int(scan->options, "number",
2338 *res->numberOfEntriesReturned);
2343 static zoom_ret send_sort(ZOOM_connection c,
2344 ZOOM_resultset resultset)
2347 resultset->r_sort_spec = 0;
2348 if (resultset->r_sort_spec)
2350 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2351 Z_SortRequest *req = apdu->u.sortRequest;
2353 req->num_inputResultSetNames = 1;
2354 req->inputResultSetNames = (Z_InternationalString **)
2355 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2356 req->inputResultSetNames[0] =
2357 odr_strdup(c->odr_out, resultset->setname);
2358 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2359 req->sortSequence = resultset->r_sort_spec;
2360 resultset->r_sort_spec = 0;
2361 return send_APDU(c, apdu);
2363 return zoom_complete;
2366 static zoom_ret send_present(ZOOM_connection c)
2369 Z_PresentRequest *req = 0;
2371 const char *syntax = 0;
2372 const char *elementSetName = 0;
2373 ZOOM_resultset resultset;
2378 yaz_log(log_details, "%p send_present no tasks", c);
2379 return zoom_complete;
2382 switch (c->tasks->which)
2384 case ZOOM_TASK_SEARCH:
2385 resultset = c->tasks->u.search.resultset;
2386 start = &c->tasks->u.search.start;
2387 count = &c->tasks->u.search.count;
2389 case ZOOM_TASK_RETRIEVE:
2390 resultset = c->tasks->u.retrieve.resultset;
2391 start = &c->tasks->u.retrieve.start;
2392 count = &c->tasks->u.retrieve.count;
2394 if (*start >= resultset->size)
2396 yaz_log(log_details, "%p send_present start=%d >= size=%d",
2397 c, *start, resultset->size);
2398 return zoom_complete;
2400 if (*start + *count > resultset->size)
2401 *count = resultset->size - *start;
2404 return zoom_complete;
2406 yaz_log(log_details, "%p send_present start=%d count=%d",
2409 syntax = ZOOM_resultset_option_get(resultset, "preferredRecordSyntax");
2410 elementSetName = ZOOM_resultset_option_get(resultset, "elementSetName");
2412 if (c->error) /* don't continue on error */
2413 return zoom_complete;
2415 return zoom_complete;
2416 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2417 resultset, *start, *count);
2419 for (i = 0; i < *count; i++)
2422 record_cache_lookup(resultset, i + *start);
2427 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2428 ZOOM_connection_put_event(c, event);
2436 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2437 return zoom_complete;
2440 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2441 req = apdu->u.presentRequest;
2444 yaz_log(log_details, "%p send_present skip=%d", c, i);
2446 *req->resultSetStartPoint = *start + 1;
2447 *req->numberOfRecordsRequested = resultset->step>0 ?
2448 resultset->step : *count;
2449 if (*req->numberOfRecordsRequested + *start > resultset->size)
2450 *req->numberOfRecordsRequested = resultset->size - *start;
2451 assert(*req->numberOfRecordsRequested > 0);
2453 if (syntax && *syntax)
2454 req->preferredRecordSyntax =
2455 yaz_str_to_z3950oid(c->odr_out, CLASS_RECSYN, syntax);
2457 if (resultset->schema && *resultset->schema)
2459 Z_RecordComposition *compo = (Z_RecordComposition *)
2460 odr_malloc(c->odr_out, sizeof(*compo));
2462 req->recordComposition = compo;
2463 compo->which = Z_RecordComp_complex;
2464 compo->u.complex = (Z_CompSpec *)
2465 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2466 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2467 odr_malloc(c->odr_out, sizeof(bool_t));
2468 *compo->u.complex->selectAlternativeSyntax = 0;
2470 compo->u.complex->generic = (Z_Specification *)
2471 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2473 compo->u.complex->generic->which = Z_Schema_oid;
2474 compo->u.complex->generic->schema.oid = (Odr_oid *)
2475 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2477 if (!compo->u.complex->generic->schema.oid)
2479 /* OID wasn't a schema! Try record syntax instead. */
2481 compo->u.complex->generic->schema.oid = (Odr_oid *)
2482 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2484 if (elementSetName && *elementSetName)
2486 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2487 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2488 compo->u.complex->generic->elementSpec->which =
2489 Z_ElementSpec_elementSetName;
2490 compo->u.complex->generic->elementSpec->u.elementSetName =
2491 odr_strdup(c->odr_out, elementSetName);
2494 compo->u.complex->generic->elementSpec = 0;
2495 compo->u.complex->num_dbSpecific = 0;
2496 compo->u.complex->dbSpecific = 0;
2497 compo->u.complex->num_recordSyntax = 0;
2498 compo->u.complex->recordSyntax = 0;
2500 else if (elementSetName && *elementSetName)
2502 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2503 odr_malloc(c->odr_out, sizeof(*esn));
2504 Z_RecordComposition *compo = (Z_RecordComposition *)
2505 odr_malloc(c->odr_out, sizeof(*compo));
2507 esn->which = Z_ElementSetNames_generic;
2508 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2509 compo->which = Z_RecordComp_simple;
2510 compo->u.simple = esn;
2511 req->recordComposition = compo;
2513 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2514 return send_APDU(c, apdu);
2517 ZOOM_API(ZOOM_scanset)
2518 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2521 ZOOM_query q = ZOOM_query_create();
2523 ZOOM_query_prefix(q, start);
2525 s = ZOOM_connection_scan1(c, q);
2526 ZOOM_query_destroy(q);
2531 ZOOM_API(ZOOM_scanset)
2532 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2536 ZOOM_scanset scan = 0;
2539 * We need to check the query-type, so we can recognise CQL and
2540 * CCL and compile them into a form that we can use here. The
2541 * ZOOM_query structure has no explicit `type' member, but
2542 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2543 * functions shows how the structure is set up in each case.
2547 else if (q->z_query->which == Z_Query_type_1)
2549 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2550 c, q, q->query_string);
2551 start = q->query_string;
2553 else if (q->z_query->which == Z_Query_type_104)
2555 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2556 c, q, q->query_string);
2557 start = freeme = cql2pqf(c, q->query_string);
2563 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2564 c, q, q->query_string);
2568 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2569 scan->connection = c;
2570 scan->odr = odr_createmem(ODR_DECODE);
2571 scan->options = ZOOM_options_create_with_parent(c->options);
2573 scan->scan_response = 0;
2574 scan->termListAndStartPoint =
2575 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2577 if (scan->termListAndStartPoint != 0)
2579 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2580 task->u.scan.scan = scan;
2585 while (ZOOM_event(1, &c))
2593 ZOOM_scanset_destroy(ZOOM_scanset scan)
2598 if (scan->refcount == 0)
2600 odr_destroy(scan->odr);
2602 ZOOM_options_destroy(scan->options);
2607 static zoom_ret send_package(ZOOM_connection c)
2611 yaz_log(log_details, "%p send_package", c);
2613 return zoom_complete;
2614 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2616 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2617 ZOOM_connection_put_event(c, event);
2619 c->buf_out = c->tasks->u.package->buf_out;
2620 c->len_out = c->tasks->u.package->len_out;
2625 static zoom_ret send_scan(ZOOM_connection c)
2628 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2629 Z_ScanRequest *req = apdu->u.scanRequest;
2631 yaz_log(log_details, "%p send_scan", c);
2633 return zoom_complete;
2634 assert (c->tasks->which == ZOOM_TASK_SCAN);
2635 scan = c->tasks->u.scan.scan;
2637 req->termListAndStartPoint = scan->termListAndStartPoint;
2638 req->attributeSet = scan->attributeSet;
2640 *req->numberOfTermsRequested =
2641 ZOOM_options_get_int(scan->options, "number", 10);
2643 req->preferredPositionInResponse =
2644 odr_intdup(c->odr_out,
2645 ZOOM_options_get_int(scan->options, "position", 1));
2648 odr_intdup(c->odr_out,
2649 ZOOM_options_get_int(scan->options, "stepSize", 0));
2651 req->databaseNames = set_DatabaseNames(c, scan->options,
2652 &req->num_databaseNames);
2654 return send_APDU(c, apdu);
2658 ZOOM_scanset_size(ZOOM_scanset scan)
2660 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2662 return scan->scan_response->entries->num_entries;
2665 ZOOM_API(const char *)
2666 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2669 const char *term = 0;
2670 size_t noent = ZOOM_scanset_size(scan);
2671 Z_ScanResponse *res = scan->scan_response;
2677 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2679 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2681 if (t->term->which == Z_Term_general)
2683 term = (const char *) t->term->u.general->buf;
2684 *len = t->term->u.general->len;
2686 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2691 ZOOM_API(const char *)
2692 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2695 const char *term = 0;
2696 size_t noent = ZOOM_scanset_size(scan);
2697 Z_ScanResponse *res = scan->scan_response;
2703 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2705 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2709 term = t->displayTerm;
2710 *len = strlen(term);
2712 else if (t->term->which == Z_Term_general)
2714 term = (const char *) t->term->u.general->buf;
2715 *len = t->term->u.general->len;
2717 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2722 ZOOM_API(const char *)
2723 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2725 return ZOOM_options_get(scan->options, key);
2729 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2732 ZOOM_options_set(scan->options, key, val);
2735 static Z_APDU *create_es_package(ZOOM_package p, int type)
2738 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2739 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2741 *req->function = Z_ExtendedServicesRequest_create;
2743 str = ZOOM_options_get(p->options, "package-name");
2745 req->packageName = nmem_strdup(p->odr_out->mem, str);
2747 str = ZOOM_options_get(p->options, "user-id");
2749 req->userId = nmem_strdup(p->odr_out->mem, str);
2751 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2754 str = ZOOM_options_get(p->options, "function");
2757 if (!strcmp (str, "create"))
2759 if (!strcmp (str, "delete"))
2761 if (!strcmp (str, "modify"))
2767 static const char *ill_array_lookup(void *clientData, const char *idx)
2769 ZOOM_package p = (ZOOM_package) clientData;
2770 return ZOOM_options_get(p->options, idx+4);
2773 static Z_External *encode_ill_request(ZOOM_package p)
2775 ODR out = p->odr_out;
2778 struct ill_get_ctl ctl;
2780 ctl.odr = p->odr_out;
2782 ctl.f = ill_array_lookup;
2784 req = ill_get_ILLRequest(&ctl, "ill", 0);
2786 if (!ill_Request(out, &req, 0, 0))
2788 int ill_request_size;
2789 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2790 if (ill_request_buf)
2791 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2797 int illRequest_size = 0;
2798 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2800 oid.proto = PROTO_GENERAL;
2801 oid.oclass = CLASS_GENERAL;
2802 oid.value = VAL_ISO_ILL_1;
2804 r = (Z_External *) odr_malloc(out, sizeof(*r));
2805 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2806 r->indirect_reference = 0;
2808 r->which = Z_External_single;
2810 r->u.single_ASN1_type =
2811 odr_create_Odr_oct(out,
2812 (unsigned char *)illRequest_buf,
2818 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2820 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2823 req->which = Z_IOItemOrder_esRequest;
2824 req->u.esRequest = (Z_IORequest *)
2825 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2827 /* to keep part ... */
2828 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2829 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2830 req->u.esRequest->toKeep->supplDescription = 0;
2831 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2832 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2834 str = ZOOM_options_get(p->options, "contact-name");
2835 req->u.esRequest->toKeep->contact->name = str ?
2836 nmem_strdup(p->odr_out->mem, str) : 0;
2838 str = ZOOM_options_get(p->options, "contact-phone");
2839 req->u.esRequest->toKeep->contact->phone = str ?
2840 nmem_strdup(p->odr_out->mem, str) : 0;
2842 str = ZOOM_options_get(p->options, "contact-email");
2843 req->u.esRequest->toKeep->contact->email = str ?
2844 nmem_strdup(p->odr_out->mem, str) : 0;
2846 req->u.esRequest->toKeep->addlBilling = 0;
2848 /* not to keep part ... */
2849 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2850 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2852 str = ZOOM_options_get(p->options, "itemorder-setname");
2857 req->u.esRequest->notToKeep->resultSetItem = 0;
2860 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2861 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2863 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2864 nmem_strdup(p->odr_out->mem, str);
2865 req->u.esRequest->notToKeep->resultSetItem->item =
2866 (int *) odr_malloc(p->odr_out, sizeof(int));
2868 str = ZOOM_options_get(p->options, "itemorder-item");
2869 *req->u.esRequest->notToKeep->resultSetItem->item =
2870 (str ? atoi(str) : 1);
2872 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2877 Z_APDU *create_admin_package(ZOOM_package p, int type,
2878 Z_ESAdminOriginPartToKeep **toKeepP,
2879 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2881 Z_APDU *apdu = create_es_package(p, VAL_ADMINSERVICE);
2884 Z_ESAdminOriginPartToKeep *toKeep;
2885 Z_ESAdminOriginPartNotToKeep *notToKeep;
2886 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
2887 const char *first_db = "Default";
2889 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2893 r->direct_reference =
2894 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2897 r->indirect_reference = 0;
2898 r->which = Z_External_ESAdmin;
2900 r->u.adminService = (Z_Admin *)
2901 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2902 r->u.adminService->which = Z_Admin_esRequest;
2903 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2904 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2906 toKeep = r->u.adminService->u.esRequest->toKeep =
2907 (Z_ESAdminOriginPartToKeep *)
2908 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2909 toKeep->which = type;
2910 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2911 toKeep->u.create = odr_nullval();
2912 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2914 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2915 (Z_ESAdminOriginPartNotToKeep *)
2916 odr_malloc(p->odr_out,
2917 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2918 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
2919 notToKeep->u.recordsWillFollow = odr_nullval();
2923 *notToKeepP = notToKeep;
2928 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
2930 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
2931 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2932 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
2933 const char *doc = ZOOM_options_get(p->options, "doc");
2938 req->taskSpecificParameters = ext;
2939 ext->direct_reference = req->packageType;
2940 ext->descriptor = 0;
2941 ext->indirect_reference = 0;
2943 ext->which = Z_External_octet;
2944 ext->u.single_ASN1_type =
2945 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
2950 static Z_APDU *create_update_package(ZOOM_package p)
2953 const char *first_db = "Default";
2955 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2956 const char *action = ZOOM_options_get(p->options, "action");
2957 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
2958 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
2959 const char *record_buf = ZOOM_options_get(p->options, "record");
2960 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
2961 int syntax_oid = VAL_NONE;
2965 syntax_oid = oid_getvalbyname(syntax_str);
2968 record_buf = "void";
2969 syntax_oid = VAL_SUTRS;
2971 if (syntax_oid == VAL_NONE)
2972 syntax_oid = VAL_TEXT_XML;
2978 action = "specialUpdate";
2980 if (!strcmp(action, "recordInsert"))
2981 action_no = Z_IUOriginPartToKeep_recordInsert;
2982 else if (!strcmp(action, "recordReplace"))
2983 action_no = Z_IUOriginPartToKeep_recordReplace;
2984 else if (!strcmp(action, "recordDelete"))
2985 action_no = Z_IUOriginPartToKeep_recordDelete;
2986 else if (!strcmp(action, "elementUpdate"))
2987 action_no = Z_IUOriginPartToKeep_elementUpdate;
2988 else if (!strcmp(action, "specialUpdate"))
2989 action_no = Z_IUOriginPartToKeep_specialUpdate;
2993 apdu = create_es_package(p, VAL_DBUPDATE);
2996 Z_IUOriginPartToKeep *toKeep;
2997 Z_IUSuppliedRecords *notToKeep;
2998 Z_External *r = (Z_External *)
2999 odr_malloc(p->odr_out, sizeof(*r));
3001 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3003 r->direct_reference =
3004 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3007 r->which = Z_External_update;
3008 r->indirect_reference = 0;
3009 r->u.update = (Z_IUUpdate *)
3010 odr_malloc(p->odr_out, sizeof(*r->u.update));
3012 r->u.update->which = Z_IUUpdate_esRequest;
3013 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3014 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3015 toKeep = r->u.update->u.esRequest->toKeep =
3016 (Z_IUOriginPartToKeep *)
3017 odr_malloc(p->odr_out, sizeof(*toKeep));
3019 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3021 toKeep->elementSetName = 0;
3022 toKeep->actionQualifier = 0;
3023 toKeep->action = odr_intdup(p->odr_out, action_no);
3025 notToKeep = r->u.update->u.esRequest->notToKeep =
3026 (Z_IUSuppliedRecords *)
3027 odr_malloc(p->odr_out, sizeof(*notToKeep));
3029 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3030 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3031 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3032 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3033 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3036 notToKeep->elements[0]->u.opaque =
3037 odr_create_Odr_oct(p->odr_out,
3038 (const unsigned char *) recordIdOpaque,
3039 strlen(recordIdOpaque));
3041 else if (recordIdNumber)
3043 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3045 notToKeep->elements[0]->u.number =
3046 odr_intdup(p->odr_out, atoi(recordIdNumber));
3049 notToKeep->elements[0]->u.opaque = 0;
3050 notToKeep->elements[0]->supplementalId = 0;
3051 notToKeep->elements[0]->correlationInfo = 0;
3052 notToKeep->elements[0]->record =
3053 z_ext_record(p->odr_out, syntax_oid,
3054 record_buf, strlen(record_buf));
3058 ODR print = odr_createmem(ODR_PRINT);
3060 z_APDU(print, &apdu, 0, 0);
3067 ZOOM_package_send(ZOOM_package p, const char *type)
3074 odr_reset(p->odr_out);
3077 if (!strcmp(type, "itemorder"))
3079 apdu = create_es_package(p, VAL_ITEMORDER);
3082 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3084 r->direct_reference =
3085 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3088 r->which = Z_External_itemOrder;
3089 r->indirect_reference = 0;
3090 r->u.itemOrder = encode_item_order(p);
3092 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3095 else if (!strcmp(type, "create")) /* create database */
3097 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3100 else if (!strcmp(type, "drop")) /* drop database */
3102 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3105 else if (!strcmp(type, "commit")) /* commit changes */
3107 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3110 else if (!strcmp(type, "update")) /* update record(s) */
3112 apdu = create_update_package(p);
3114 else if (!strcmp(type, "xmlupdate"))
3116 apdu = create_xmlupdate_package(p);
3120 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3124 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3125 task->u.package = p;
3126 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3127 p->buf_out = (char *) xmalloc(p->len_out);
3128 memcpy(p->buf_out, buf, p->len_out);
3133 while (ZOOM_event(1, &c))
3140 ZOOM_API(ZOOM_package)
3141 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3143 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3146 p->odr_out = odr_createmem(ODR_ENCODE);
3147 p->options = ZOOM_options_create_with_parent2(options, c->options);
3155 ZOOM_package_destroy(ZOOM_package p)
3160 if (p->refcount == 0)
3162 odr_destroy(p->odr_out);
3165 ZOOM_options_destroy(p->options);
3170 ZOOM_API(const char *)
3171 ZOOM_package_option_get(ZOOM_package p, const char *key)
3173 return ZOOM_options_get(p->options, key);
3178 ZOOM_package_option_set(ZOOM_package p, const char *key,
3181 ZOOM_options_set(p->options, key, val);
3184 static int ZOOM_connection_exec_task(ZOOM_connection c)
3186 ZOOM_task task = c->tasks;
3187 zoom_ret ret = zoom_complete;
3191 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3192 c, task->which, task->running);
3193 if (c->error != ZOOM_ERROR_NONE)
3195 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3196 "removing tasks because of error = %d", c, c->error);
3197 ZOOM_connection_remove_tasks(c);
3202 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3203 "task already running", c);
3207 ret = zoom_complete;
3208 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3210 switch (task->which)
3212 case ZOOM_TASK_SEARCH:
3213 if (c->proto == PROTO_HTTP)
3214 ret = ZOOM_connection_srw_send_search(c);
3216 ret = ZOOM_connection_send_search(c);
3218 case ZOOM_TASK_RETRIEVE:
3219 if (c->proto == PROTO_HTTP)
3220 ret = ZOOM_connection_srw_send_search(c);
3222 ret = send_present(c);
3224 case ZOOM_TASK_CONNECT:
3225 ret = do_connect(c);
3227 case ZOOM_TASK_SCAN:
3230 case ZOOM_TASK_PACKAGE:
3231 ret = send_package(c);
3233 case ZOOM_TASK_SORT:
3234 c->tasks->u.sort.resultset->r_sort_spec =
3235 c->tasks->u.sort.q->sort_spec;
3236 ret = send_sort(c, c->tasks->u.sort.resultset);
3242 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3243 "remove tasks because no connection exist", c);
3244 ZOOM_connection_remove_tasks(c);
3246 if (ret == zoom_complete)
3248 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3249 "task removed (complete)", c);
3250 ZOOM_connection_remove_task(c);
3253 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3258 static zoom_ret send_sort_present(ZOOM_connection c)
3260 zoom_ret r = zoom_complete;
3262 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3263 r = send_sort(c, c->tasks->u.search.resultset);
3264 if (r == zoom_complete)
3265 r = send_present(c);
3269 static int es_response(ZOOM_connection c,
3270 Z_ExtendedServicesResponse *res)
3272 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3274 if (res->diagnostics && res->num_diagnostics > 0)
3275 response_diag(c, res->diagnostics[0]);
3276 if (res->taskPackage &&
3277 res->taskPackage->which == Z_External_extendedService)
3279 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3280 Odr_oct *id = taskPackage->targetReference;
3283 ZOOM_options_setl(c->tasks->u.package->options,
3284 "targetReference", (char*) id->buf, id->len);
3286 if (res->taskPackage &&
3287 res->taskPackage->which == Z_External_octet)
3289 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3290 ZOOM_options_setl(c->tasks->u.package->options,
3291 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3296 static void interpret_init_diag(ZOOM_connection c,
3297 Z_DiagnosticFormat *diag)
3301 Z_DiagnosticFormat_s *ds = diag->elements[0];
3302 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3303 response_default_diag(c, ds->u.defaultDiagRec);
3308 static void interpret_otherinformation_field(ZOOM_connection c,
3309 Z_OtherInformation *ui)
3312 for (i = 0; i < ui->num_elements; i++)
3314 Z_OtherInformationUnit *unit = ui->list[i];
3315 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3316 unit->information.externallyDefinedInfo &&
3317 unit->information.externallyDefinedInfo->which ==
3320 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3325 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3327 Z_InitResponse *initrs;
3330 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3333 case Z_APDU_initResponse:
3334 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3335 initrs = apdu->u.initResponse;
3336 ZOOM_connection_option_set(c, "serverImplementationId",
3337 initrs->implementationId ?
3338 initrs->implementationId : "");
3339 ZOOM_connection_option_set(c, "serverImplementationName",
3340 initrs->implementationName ?
3341 initrs->implementationName : "");
3342 ZOOM_connection_option_set(c, "serverImplementationVersion",
3343 initrs->implementationVersion ?
3344 initrs->implementationVersion : "");
3345 /* Set the three old options too, for old applications */
3346 ZOOM_connection_option_set(c, "targetImplementationId",
3347 initrs->implementationId ?
3348 initrs->implementationId : "");
3349 ZOOM_connection_option_set(c, "targetImplementationName",
3350 initrs->implementationName ?
3351 initrs->implementationName : "");
3352 ZOOM_connection_option_set(c, "targetImplementationVersion",
3353 initrs->implementationVersion ?
3354 initrs->implementationVersion : "");
3355 if (!*initrs->result)
3357 Z_External *uif = initrs->userInformationField;
3359 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3361 if (uif && uif->which == Z_External_userInfo1)
3362 interpret_otherinformation_field(c, uif->u.userInfo1);
3367 yaz_oi_get_string_oidval(&apdu->u.initResponse->otherInfo,
3369 xfree(c->cookie_in);
3372 c->cookie_in = xstrdup(cookie);
3373 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3374 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3375 c->support_named_resultsets = 1;
3378 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3379 ZOOM_connection_remove_task(c);
3381 ZOOM_connection_exec_task(c);
3383 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3385 NMEM tmpmem = nmem_create();
3386 Z_CharSetandLanguageNegotiation *p =
3387 yaz_get_charneg_record(initrs->otherInfo);
3391 char *charset = NULL, *lang = NULL;
3394 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3395 yaz_log(log_details, "%p recv_apdu target accepted: "
3396 "charset %s, language %s, select %d",
3398 charset ? charset : "none", lang ? lang : "none", sel);
3400 ZOOM_connection_option_set(c, "negotiation-charset",
3403 ZOOM_connection_option_set(c, "negotiation-lang",
3406 ZOOM_connection_option_set(
3407 c, "negotiation-charset-in-effect-for-records",
3408 (sel != 0) ? "1" : "0");
3409 nmem_destroy(tmpmem);
3413 case Z_APDU_searchResponse:
3414 yaz_log(log_api, "%p recv_apdu Search response", c);
3415 handle_search_response(c, apdu->u.searchResponse);
3416 if (send_sort_present(c) == zoom_complete)
3417 ZOOM_connection_remove_task(c);
3419 case Z_APDU_presentResponse:
3420 yaz_log(log_api, "%p recv_apdu Present response", c);
3421 handle_present_response(c, apdu->u.presentResponse);
3422 if (send_present(c) == zoom_complete)
3423 ZOOM_connection_remove_task(c);
3425 case Z_APDU_sortResponse:
3426 yaz_log(log_api, "%p recv_apdu Sort response", c);
3427 sort_response(c, apdu->u.sortResponse);
3428 if (send_present(c) == zoom_complete)
3429 ZOOM_connection_remove_task(c);
3431 case Z_APDU_scanResponse:
3432 yaz_log(log_api, "%p recv_apdu Scan response", c);
3433 scan_response(c, apdu->u.scanResponse);
3434 ZOOM_connection_remove_task(c);
3436 case Z_APDU_extendedServicesResponse:
3437 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3438 es_response(c, apdu->u.extendedServicesResponse);
3439 ZOOM_connection_remove_task(c);
3442 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3443 if (!ZOOM_test_reconnect(c))
3445 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3450 yaz_log(log_api, "%p Received unknown PDU", c);
3451 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3457 static void handle_srw_response(ZOOM_connection c,
3458 Z_SRW_searchRetrieveResponse *res)
3460 ZOOM_resultset resultset = 0;
3469 if (c->tasks->which == ZOOM_TASK_SEARCH)
3471 resultset = c->tasks->u.search.resultset;
3472 start = &c->tasks->u.search.start;
3474 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
3476 resultset = c->tasks->u.retrieve.resultset;
3477 start = &c->tasks->u.retrieve.start;
3482 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3483 ZOOM_connection_put_event(c, event);
3485 resultset->size = 0;
3487 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3489 if (res->numberOfRecords)
3490 resultset->size = *res->numberOfRecords;
3492 for (i = 0; i<res->num_records; i++)
3496 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3497 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3499 if (res->records[i].recordPosition &&
3500 *res->records[i].recordPosition > 0)
3501 pos = *res->records[i].recordPosition - 1;
3505 npr->databaseName = 0;
3506 npr->which = Z_NamePlusRecord_databaseRecord;
3507 npr->u.databaseRecord = (Z_External *)
3508 odr_malloc(c->odr_in, sizeof(Z_External));
3509 npr->u.databaseRecord->descriptor = 0;
3510 npr->u.databaseRecord->direct_reference =
3511 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3512 npr->u.databaseRecord->which = Z_External_octet;
3514 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3515 odr_malloc(c->odr_in, sizeof(Odr_oct));
3516 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3517 res->records[i].recordData_buf;
3518 npr->u.databaseRecord->u.octet_aligned->len =
3519 npr->u.databaseRecord->u.octet_aligned->size =
3520 res->records[i].recordData_len;
3521 record_cache_add(resultset, npr, pos);
3523 if (res->num_diagnostics > 0)
3525 const char *uri = res->diagnostics[0].uri;
3530 if ((cp = strrchr(uri, '/')))
3532 set_dset_error(c, code, uri,
3533 res->diagnostics[0].details, 0);
3536 nmem = odr_extract_mem(c->odr_in);
3537 nmem_transfer(resultset->odr->mem, nmem);
3543 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3546 const char *content_type = z_HTTP_header_lookup(hres->headers,
3548 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3551 yaz_log(log_details, "%p handle_http", c);
3553 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3555 Z_SOAP *soap_package = 0;
3557 Z_SOAP_Handler soap_handlers[2] = {
3558 {"http://www.loc.gov/zing/srw/", 0,
3559 (Z_SOAP_fun) yaz_srw_codec},
3562 ret = z_soap_codec(o, &soap_package,
3563 &hres->content_buf, &hres->content_len,
3565 if (!ret && soap_package->which == Z_SOAP_generic &&
3566 soap_package->u.generic->no == 0)
3568 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3569 if (sr->which == Z_SRW_searchRetrieve_response)
3570 handle_srw_response(c, sr->u.response);
3574 else if (!ret && (soap_package->which == Z_SOAP_fault
3575 || soap_package->which == Z_SOAP_error))
3577 set_HTTP_error(c, hres->code,
3578 soap_package->u.fault->fault_code,
3579 soap_package->u.fault->fault_string);
3586 if (hres->code != 200)
3587 set_HTTP_error(c, hres->code, 0, 0);
3589 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3592 ZOOM_connection_remove_task(c);
3593 if (!strcmp(hres->version, "1.0"))
3595 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3596 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3601 /* HTTP 1.1: only if no close we stay alive .. */
3602 if (connection_head && !strcmp(connection_head, "close"))
3608 static int do_read(ZOOM_connection c)
3613 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3614 ZOOM_connection_put_event(c, event);
3616 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3617 more = cs_more(c->cs);
3618 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3623 if (ZOOM_test_reconnect(c))
3625 yaz_log(log_details, "%p do_read reconnect read", c);
3629 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3638 odr_reset(c->odr_in);
3639 odr_setbuf(c->odr_in, c->buf_in, r, 0);
3640 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3641 ZOOM_connection_put_event(c, event);
3643 if (!z_GDU(c->odr_in, &gdu, 0, 0))
3646 int err = odr_geterrorx(c->odr_in, &x);
3648 const char *element = odr_getelement(c->odr_in);
3649 sprintf(msg, "ODR code %d:%d element=%-20s",
3650 err, x, element ? element : "<unknown>");
3651 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3654 else if (gdu->which == Z_GDU_Z3950)
3655 recv_apdu(c, gdu->u.z3950);
3656 else if (gdu->which == Z_GDU_HTTP_Response)
3659 handle_http(c, gdu->u.HTTP_Response);
3661 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3665 c->reconnect_ok = 0;
3670 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3675 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3676 ZOOM_connection_put_event(c, event);
3678 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3679 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3681 yaz_log(log_details, "%p do_write_ex write failed", c);
3682 if (ZOOM_test_reconnect(c))
3684 return zoom_pending;
3686 if (c->state == STATE_CONNECTING)
3687 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3689 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3691 return zoom_complete;
3695 c->mask = ZOOM_SELECT_EXCEPT;
3696 if (c->cs->io_pending & CS_WANT_WRITE)
3697 c->mask += ZOOM_SELECT_WRITE;
3698 if (c->cs->io_pending & CS_WANT_READ)
3699 c->mask += ZOOM_SELECT_READ;
3700 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3705 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3706 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3709 return zoom_pending;
3712 static zoom_ret do_write(ZOOM_connection c)
3714 return do_write_ex(c, c->buf_out, c->len_out);
3718 ZOOM_API(const char *)
3719 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3721 return ZOOM_options_get(c->options, key);
3724 ZOOM_API(const char *)
3725 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3727 return ZOOM_options_getl(c->options, key, lenp);
3731 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3734 ZOOM_options_set(c->options, key, val);
3738 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3739 const char *val, int len)
3741 ZOOM_options_setl(c->options, key, val, len);
3744 ZOOM_API(const char *)
3745 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3747 return ZOOM_options_get(r->options, key);
3751 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3754 ZOOM_options_set(r->options, key, val);
3759 ZOOM_connection_errcode(ZOOM_connection c)
3761 return ZOOM_connection_error(c, 0, 0);
3764 ZOOM_API(const char *)
3765 ZOOM_connection_errmsg(ZOOM_connection c)
3768 ZOOM_connection_error(c, &msg, 0);
3772 ZOOM_API(const char *)
3773 ZOOM_connection_addinfo(ZOOM_connection c)
3775 const char *addinfo;
3776 ZOOM_connection_error(c, 0, &addinfo);
3780 ZOOM_API(const char *)
3781 ZOOM_connection_diagset(ZOOM_connection c)
3783 const char *diagset;
3784 ZOOM_connection_error_x(c, 0, 0, &diagset);
3788 ZOOM_API(const char *)
3789 ZOOM_diag_str(int error)
3793 case ZOOM_ERROR_NONE:
3795 case ZOOM_ERROR_CONNECT:
3796 return "Connect failed";
3797 case ZOOM_ERROR_MEMORY:
3798 return "Out of memory";
3799 case ZOOM_ERROR_ENCODE:
3800 return "Encoding failed";
3801 case ZOOM_ERROR_DECODE:
3802 return "Decoding failed";
3803 case ZOOM_ERROR_CONNECTION_LOST:
3804 return "Connection lost";
3805 case ZOOM_ERROR_INIT:
3806 return "Init rejected";
3807 case ZOOM_ERROR_INTERNAL:
3808 return "Internal failure";
3809 case ZOOM_ERROR_TIMEOUT:
3811 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3812 return "Unsupported protocol";
3813 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3814 return "Unsupported query type";
3815 case ZOOM_ERROR_INVALID_QUERY:
3816 return "Invalid query";
3817 case ZOOM_ERROR_CQL_PARSE:
3818 return "CQL parsing error";
3819 case ZOOM_ERROR_CQL_TRANSFORM:
3820 return "CQL transformation error";
3821 case ZOOM_ERROR_CCL_CONFIG:
3822 return "CCL configuration error";
3823 case ZOOM_ERROR_CCL_PARSE:
3824 return "CCL parsing error";
3826 return diagbib1_str(error);
3831 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
3832 const char **addinfo, const char **diagset)
3834 int error = c->error;
3837 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3838 *cp = ZOOM_diag_str(error);
3839 else if (!strcmp(c->diagset, "HTTP"))
3840 *cp = z_HTTP_errmsg(c->error);
3841 else if (!strcmp(c->diagset, "Bib-1"))
3842 *cp = ZOOM_diag_str(error);
3843 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3844 *cp = yaz_diag_srw_str(c->error);
3846 *cp = "Unknown error and diagnostic set";
3849 *addinfo = c->addinfo ? c->addinfo : "";
3851 *diagset = c->diagset ? c->diagset : "";
3856 ZOOM_connection_error(ZOOM_connection c, const char **cp,
3857 const char **addinfo)
3859 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3862 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
3864 ZOOM_Event event = 0;
3865 int r = cs_look(c->cs);
3866 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
3871 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
3872 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3874 ZOOM_connection_put_event(c, event);
3876 else if (r == CS_CONNECT)
3878 int ret = ret = cs_rcvconnect(c->cs);
3879 yaz_log(log_details, "%p ZOOM_connection_do_io "
3880 "cs_rcvconnect returned %d", c, ret);
3883 c->mask = ZOOM_SELECT_EXCEPT;
3884 if (c->cs->io_pending & CS_WANT_WRITE)
3885 c->mask += ZOOM_SELECT_WRITE;
3886 if (c->cs->io_pending & CS_WANT_READ)
3887 c->mask += ZOOM_SELECT_READ;
3891 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
3892 ZOOM_connection_put_event(c, event);
3894 if (c->proto == PROTO_Z3950)
3895 ZOOM_connection_send_init(c);
3898 /* no init request for SRW .. */
3899 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3900 ZOOM_connection_remove_task(c);
3902 ZOOM_connection_exec_task(c);
3904 c->state = STATE_ESTABLISHED;
3908 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3914 if (mask & ZOOM_SELECT_EXCEPT)
3916 if (ZOOM_test_reconnect(c))
3918 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
3919 ZOOM_connection_put_event(c, event);
3923 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3928 if (mask & ZOOM_SELECT_READ)
3930 if (c->cs && (mask & ZOOM_SELECT_WRITE))
3936 ZOOM_connection_last_event(ZOOM_connection cs)
3939 return ZOOM_EVENT_NONE;
3940 return cs->last_event;
3944 ZOOM_event(int no, ZOOM_connection *cs)
3946 int timeout = 30; /* default timeout in seconds */
3947 int timeout_set = 0; /* whether it was overriden at all */
3949 struct pollfd pollfds[1024];
3950 ZOOM_connection poll_cs[1024];
3953 fd_set input, output, except;
3958 yaz_log(log_details, "ZOOM_event(no=%d,cs=%p)", no, cs);
3959 for (i = 0; i<no; i++)
3961 ZOOM_connection c = cs[i];
3963 if (c && (event = ZOOM_connection_get_event(c)))
3965 ZOOM_Event_destroy(event);
3969 for (i = 0; i<no; i++)
3971 ZOOM_connection c = cs[i];
3975 ZOOM_connection_exec_task(c);
3976 if ((event = ZOOM_connection_get_event(c)))
3978 ZOOM_Event_destroy(event);
3991 for (i = 0; i<no; i++)
3993 ZOOM_connection c = cs[i];
3999 fd = z3950_connection_socket(c);
4000 mask = z3950_connection_mask(c);
4007 /* -1 is used for indefinite timeout (no timeout), so -2 here. */
4008 this_timeout = ZOOM_options_get_int(c->options, "timeout", -2);
4009 if (this_timeout != -2)
4011 /* ensure the minimum timeout is used */
4013 timeout = this_timeout;
4014 else if (this_timeout != -1 && this_timeout < timeout)
4015 timeout = this_timeout;
4021 short poll_events = 0;
4023 if (mask & ZOOM_SELECT_READ)
4024 poll_events += POLLIN;
4025 if (mask & ZOOM_SELECT_WRITE)
4026 poll_events += POLLOUT;
4027 if (mask & ZOOM_SELECT_EXCEPT)
4028 poll_events += POLLERR;
4029 pollfds[nfds].fd = fd;
4030 pollfds[nfds].events = poll_events;
4031 pollfds[nfds].revents = 0;
4036 if (mask & ZOOM_SELECT_READ)
4041 if (mask & ZOOM_SELECT_WRITE)
4043 FD_SET(fd, &output);
4046 if (mask & ZOOM_SELECT_EXCEPT)
4048 FD_SET(fd, &except);
4057 r = poll(pollfds, nfds, (timeout == -1 ? -1 : timeout * 1000));
4058 for (i = 0; i<nfds; i++)
4060 ZOOM_connection c = poll_cs[i];
4064 if (pollfds[i].revents & POLLIN)
4065 mask += ZOOM_SELECT_READ;
4066 if (pollfds[i].revents & POLLOUT)
4067 mask += ZOOM_SELECT_WRITE;
4068 if (pollfds[i].revents & POLLERR)
4069 mask += ZOOM_SELECT_EXCEPT;
4071 ZOOM_connection_do_io(c, mask);
4073 else if (r == 0 && c->mask)
4075 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4076 /* timeout and this connection was waiting */
4077 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4079 ZOOM_connection_put_event(c, event);
4083 tv.tv_sec = timeout;
4085 r = select(max_fd+1, &input, &output, &except, (timeout == -1 ? 0 : &tv));
4086 for (i = 0; i<no; i++)
4088 ZOOM_connection c = cs[i];
4093 fd = z3950_connection_socket(c);
4097 /* no timeout and real socket */
4098 if (FD_ISSET(fd, &input))
4099 mask += ZOOM_SELECT_READ;
4100 if (FD_ISSET(fd, &output))
4101 mask += ZOOM_SELECT_WRITE;
4102 if (FD_ISSET(fd, &except))
4103 mask += ZOOM_SELECT_EXCEPT;
4105 ZOOM_connection_do_io(c, mask);
4107 if (r == 0 && c->mask)
4109 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4110 /* timeout and this connection was waiting */
4111 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4113 ZOOM_connection_put_event(c, event);
4117 for (i = 0; i<no; i++)
4119 ZOOM_connection c = cs[i];
4121 if (c && (event = ZOOM_connection_get_event(c)))
4123 ZOOM_Event_destroy(event);
4132 * Returns an xmalloc()d string containing RPN that corresponds to the
4133 * CQL passed in. On error, sets the Connection object's error state
4134 * and returns a null pointer.
4135 * ### We could cache CQL parser and/or transformer in Connection.
4137 static char *cql2pqf(ZOOM_connection c, const char *cql)
4141 struct cql_node *node;
4142 const char *cqlfile;
4143 static cql_transform_t trans;
4146 parser = cql_parser_create();
4147 if ((error = cql_parser_string(parser, cql)) != 0) {
4148 cql_parser_destroy(parser);
4149 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4153 node = cql_parser_result(parser);
4154 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4156 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4158 cql_parser_destroy(parser);
4159 cql_node_destroy(node);
4160 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4164 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4166 cql_parser_destroy(parser);
4167 cql_node_destroy(node);
4168 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4169 cqlfile, strerror(errno));
4170 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4174 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4175 cql_parser_destroy(parser);
4176 cql_node_destroy(node);
4179 const char *addinfo;
4180 error = cql_transform_error(trans, &addinfo);
4181 cql_transform_close(trans);
4182 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4183 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4187 cql_transform_close(trans);
4188 return xstrdup(pqfbuf);
4194 * indent-tabs-mode: nil
4196 * vim: shiftwidth=4 tabstop=8 expandtab