2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.115 2007-03-07 14:26:44 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>
32 static int log_api = 0;
33 static int log_details = 0;
40 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
41 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
42 static char *cql2pqf(ZOOM_connection c, const char *cql);
46 * This wrapper is just for logging failed lookups. It would be nicer
47 * if it could cause failure when a lookup fails, but that's hard.
49 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
50 int oid_class, const char *str) {
51 Odr_oid *res = yaz_str_to_z3950oid(c->odr_out, oid_class, str);
53 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
54 c, (int) oid_class, str);
59 static void initlog(void)
61 static int log_level_initialized = 0;
62 if (!log_level_initialized)
64 log_api = yaz_log_module_level("zoom");
65 log_details = yaz_log_module_level("zoomdetails");
66 log_level_initialized = 1;
70 static ZOOM_Event ZOOM_Event_create(int kind)
72 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
76 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
80 static void ZOOM_Event_destroy(ZOOM_Event event)
85 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
89 c->m_queue_back->prev = event;
90 assert(c->m_queue_front);
94 assert(!c->m_queue_front);
95 c->m_queue_front = event;
97 event->next = c->m_queue_back;
99 c->m_queue_back = event;
102 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
104 ZOOM_Event event = c->m_queue_front;
107 c->last_event = ZOOM_EVENT_NONE;
110 assert(c->m_queue_back);
111 c->m_queue_front = event->prev;
112 if (c->m_queue_front)
114 assert(c->m_queue_back);
115 c->m_queue_front->next = 0;
119 c->last_event = event->kind;
123 static void ZOOM_connection_remove_events(ZOOM_connection c)
126 while ((event = ZOOM_connection_get_event(c)))
127 ZOOM_Event_destroy(event);
130 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
132 ZOOM_Event event = c->m_queue_front;
134 return event ? event->kind : ZOOM_EVENT_NONE;
137 void ZOOM_connection_remove_tasks(ZOOM_connection c);
139 static void set_dset_error(ZOOM_connection c, int error,
141 const char *addinfo, const char *addinfo2)
148 if (!c->diagset || strcmp(dset, c->diagset))
151 c->diagset = xstrdup(dset);
152 /* remove integer part from SRW diagset .. */
153 if ((cp = strrchr(c->diagset, '/')))
156 if (addinfo && addinfo2)
158 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
159 strcpy(c->addinfo, addinfo);
160 strcat(c->addinfo, addinfo2);
163 c->addinfo = xstrdup(addinfo);
164 if (error != ZOOM_ERROR_NONE)
166 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
167 c, c->host_port ? c->host_port : "<>", dset, error,
168 addinfo ? addinfo : "",
169 addinfo2 ? addinfo2 : "");
171 ZOOM_connection_remove_tasks(c);
177 static void set_HTTP_error(ZOOM_connection c, int error,
178 const char *addinfo, const char *addinfo2)
180 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
185 static void set_ZOOM_error(ZOOM_connection c, int error,
188 set_dset_error(c, error, "ZOOM", addinfo, 0);
191 static void clear_error(ZOOM_connection c)
194 * If an error is tied to an operation then it's ok to clear: for
195 * example, a diagnostic returned from a search is cleared by a
196 * subsequent search. However, problems such as Connection Lost
197 * or Init Refused are not cleared, because they are not
198 * recoverable: doing another search doesn't help.
201 ZOOM_connection_remove_events(c);
204 case ZOOM_ERROR_CONNECT:
205 case ZOOM_ERROR_MEMORY:
206 case ZOOM_ERROR_DECODE:
207 case ZOOM_ERROR_CONNECTION_LOST:
208 case ZOOM_ERROR_INIT:
209 case ZOOM_ERROR_INTERNAL:
210 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
213 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
217 void ZOOM_connection_show_task(ZOOM_task task)
221 case ZOOM_TASK_SEARCH:
222 yaz_log(YLOG_LOG, "search p=%p", task);
224 case ZOOM_TASK_RETRIEVE:
225 yaz_log(YLOG_LOG, "retrieve p=%p", task);
227 case ZOOM_TASK_CONNECT:
228 yaz_log(YLOG_LOG, "connect p=%p", task);
231 yaz_log(YLOG_LOG, "scant p=%p", task);
236 void ZOOM_connection_show_tasks(ZOOM_connection c)
239 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
240 for (task = c->tasks; task; task = task->next)
241 ZOOM_connection_show_task(task);
244 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
246 ZOOM_task *taskp = &c->tasks;
248 taskp = &(*taskp)->next;
249 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
250 (*taskp)->running = 0;
251 (*taskp)->which = which;
257 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
259 return c->tasks ? 0 : 1;
262 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
264 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
266 task->next = c->tasks;
275 void ZOOM_connection_remove_task(ZOOM_connection c)
277 ZOOM_task task = c->tasks;
281 c->tasks = task->next;
284 case ZOOM_TASK_SEARCH:
285 ZOOM_resultset_destroy(task->u.search.resultset);
286 xfree(task->u.search.syntax);
287 xfree(task->u.search.elementSetName);
289 case ZOOM_TASK_RETRIEVE:
290 ZOOM_resultset_destroy(task->u.retrieve.resultset);
291 xfree(task->u.retrieve.syntax);
292 xfree(task->u.retrieve.elementSetName);
294 case ZOOM_TASK_CONNECT:
297 ZOOM_scanset_destroy(task->u.scan.scan);
299 case ZOOM_TASK_PACKAGE:
300 ZOOM_package_destroy(task->u.package);
303 ZOOM_resultset_destroy(task->u.sort.resultset);
304 ZOOM_query_destroy(task->u.sort.q);
313 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
314 ZOOM_connection_put_event(c, event);
319 static int ZOOM_connection_exec_task(ZOOM_connection c);
321 void ZOOM_connection_remove_tasks(ZOOM_connection c)
324 ZOOM_connection_remove_task(c);
327 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
329 const char *elementSetName);
331 ZOOM_API(ZOOM_connection)
332 ZOOM_connection_create(ZOOM_options options)
334 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
338 yaz_log(log_api, "%p ZOOM_connection_create", c);
340 c->proto = PROTO_Z3950;
342 ZOOM_connection_set_mask(c, 0);
344 c->state = STATE_IDLE;
347 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
354 c->options = ZOOM_options_create_with_parent(options);
360 c->charset = c->lang = 0;
367 c->odr_in = odr_createmem(ODR_DECODE);
368 c->odr_out = odr_createmem(ODR_ENCODE);
371 c->support_named_resultsets = 0;
372 c->last_event = ZOOM_EVENT_NONE;
374 c->m_queue_front = 0;
380 /* set database names. Take local databases (if set); otherwise
381 take databases given in ZURL (if set); otherwise use Default */
382 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
385 char **databaseNames;
386 const char *cp = ZOOM_options_get(options, "databaseName");
388 if ((!cp || !*cp) && con->host_port)
390 if (strncmp(con->host_port, "unix:", 5) == 0)
391 cp = strchr(con->host_port+5, ':');
393 cp = strchr(con->host_port, '/');
399 nmem_strsplit(odr->mem, "+", cp, &databaseNames, num);
400 return databaseNames;
403 ZOOM_API(ZOOM_connection)
404 ZOOM_connection_new(const char *host, int portnum)
406 ZOOM_connection c = ZOOM_connection_create(0);
408 ZOOM_connection_connect(c, host, portnum);
412 static zoom_sru_mode get_sru_mode_from_string(const char *s)
415 return zoom_sru_soap;
416 if (!yaz_matchstr(s, "soap"))
417 return zoom_sru_soap;
418 else if (!yaz_matchstr(s, "get"))
420 else if (!yaz_matchstr(s, "post"))
421 return zoom_sru_post;
422 return zoom_sru_error;
426 ZOOM_connection_connect(ZOOM_connection c,
427 const char *host, int portnum)
434 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
435 c, host ? host : "null", portnum);
437 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
438 ZOOM_connection_remove_tasks(c);
442 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
446 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
448 val = ZOOM_options_get(c->options, "proxy");
451 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
452 c->proxy = xstrdup(val);
458 val = ZOOM_options_get(c->options, "charset");
461 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
462 c->charset = xstrdup(val);
468 val = ZOOM_options_get(c->options, "lang");
471 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
472 c->lang = xstrdup(val);
483 sprintf(hostn, "%.80s:%d", host, portnum);
484 c->host_port = xstrdup(hostn);
487 c->host_port = xstrdup(host);
492 * If the "<scheme>:" part of the host string is preceded by one
493 * or more comma-separated <name>=<value> pairs, these are taken
494 * to be options to be set on the connection object. Among other
495 * applications, this facility can be used to embed authentication
497 * user=admin,password=secret,tcp:localhost:9999
499 char *remainder = c->host_port;
500 char *pcolon = strchr(remainder, ':');
503 while ((pcomma = strchr(remainder, ',')) != 0 &&
504 (pcolon == 0 || pcomma < pcolon)) {
506 if ((pequals = strchr(remainder, '=')) != 0) {
508 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
509 ZOOM_connection_option_set(c, remainder, pequals+1);
511 remainder = pcomma+1;
514 if (remainder != c->host_port) {
516 c->host_port = xstrdup(remainder);
517 /*printf("# reset hp='%s'\n", remainder);*/
521 val = ZOOM_options_get(c->options, "sru");
522 c->sru_mode = get_sru_mode_from_string(val);
524 ZOOM_options_set(c->options, "host", c->host_port);
526 val = ZOOM_options_get(c->options, "cookie");
529 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
530 c->cookie_out = xstrdup(val);
533 val = ZOOM_options_get(c->options, "clientIP");
536 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
538 c->client_IP = xstrdup(val);
541 c->async = ZOOM_options_get_bool(c->options, "async", 0);
542 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
544 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
548 while (ZOOM_event(1, &c))
554 ZOOM_query_create(void)
556 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
558 yaz_log(log_details, "%p ZOOM_query_create", s);
562 s->odr = odr_createmem(ODR_ENCODE);
569 ZOOM_query_destroy(ZOOM_query s)
575 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
576 if (s->refcount == 0)
584 ZOOM_query_prefix(ZOOM_query s, const char *str)
586 s->query_string = odr_strdup(s->odr, str);
587 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
588 s->z_query->which = Z_Query_type_1;
589 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
590 if (!s->z_query->u.type_1)
592 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
596 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
601 ZOOM_query_cql(ZOOM_query s, const char *str)
605 s->query_string = odr_strdup(s->odr, str);
607 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
608 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
609 ext->indirect_reference = 0;
611 ext->which = Z_External_CQL;
612 ext->u.cql = s->query_string;
614 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
615 s->z_query->which = Z_Query_type_104;
616 s->z_query->u.type_104 = ext;
618 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
624 * Translate the CQL string client-side into RPN which is passed to
625 * the server. This is useful for server's that don't themselves
626 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
627 * only as a place to stash diagnostics if compilation fails; if this
628 * information is not needed, a null pointer may be used.
631 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
635 ZOOM_connection freeme = 0;
637 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
639 conn = freeme = ZOOM_connection_create(0);
641 rpn = cql2pqf(conn, str);
643 ZOOM_connection_destroy(freeme);
647 ret = ZOOM_query_prefix(s, rpn);
653 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
654 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
655 * to the server, as the YAZ GFS doesn't know how to handle this.
658 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
659 int *ccl_error, const char **error_string,
663 struct ccl_rpn_node *rpn;
664 CCL_bibset bibset = ccl_qual_mk();
667 ccl_qual_buf(bibset, config);
669 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
672 *error_string = ccl_err_msg(*ccl_error);
677 WRBUF wr = wrbuf_alloc();
680 ret = ZOOM_query_prefix(s, wrbuf_buf(wr));
683 ccl_qual_rm(&bibset);
688 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
690 s->sort_spec = yaz_sort_spec(s->odr, criteria);
693 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
697 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
701 static zoom_ret do_write(ZOOM_connection c);
704 ZOOM_connection_destroy(ZOOM_connection c)
709 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
712 for (r = c->resultsets; r; r = r->next)
718 odr_destroy(c->odr_in);
719 odr_destroy(c->odr_out);
720 ZOOM_options_destroy(c->options);
721 ZOOM_connection_remove_tasks(c);
722 ZOOM_connection_remove_events(c);
728 xfree(c->cookie_out);
734 void ZOOM_resultset_addref(ZOOM_resultset r)
739 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
744 ZOOM_resultset ZOOM_resultset_create(void)
747 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
751 yaz_log(log_details, "%p ZOOM_resultset_create", r);
754 r->odr = odr_createmem(ODR_ENCODE);
759 for (i = 0; i<RECORD_HASH_SIZE; i++)
760 r->record_hash[i] = 0;
765 r->databaseNames = 0;
766 r->num_databaseNames = 0;
770 ZOOM_API(ZOOM_resultset)
771 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
774 ZOOM_query s = ZOOM_query_create();
776 ZOOM_query_prefix(s, q);
778 r = ZOOM_connection_search(c, s);
779 ZOOM_query_destroy(s);
783 ZOOM_API(ZOOM_resultset)
784 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
786 ZOOM_resultset r = ZOOM_resultset_create();
790 const char *syntax, *elementSetName;
792 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
793 r->r_sort_spec = q->sort_spec;
796 r->options = ZOOM_options_create_with_parent(c->options);
798 start = ZOOM_options_get_int(r->options, "start", 0);
799 count = ZOOM_options_get_int(r->options, "count", 0);
801 /* If "presentChunk" is defined use that; otherwise "step" */
802 const char *cp = ZOOM_options_get(r->options, "presentChunk");
803 r->step = ZOOM_options_get_int(r->options,
804 (cp != 0 ? "presentChunk": "step"), 0);
806 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
807 cp = ZOOM_options_get(r->options, "setname");
809 r->setname = xstrdup(cp);
810 cp = ZOOM_options_get(r->options, "schema");
812 r->schema = xstrdup(cp);
814 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
819 r->next = c->resultsets;
822 if (c->host_port && c->proto == PROTO_HTTP)
826 yaz_log(log_details, "ZOOM_connection_search: no comstack");
827 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
831 yaz_log(log_details, "ZOOM_connection_search: reconnect");
836 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
837 task->u.search.resultset = r;
838 task->u.search.start = start;
839 task->u.search.count = count;
841 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
842 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
843 elementSetName = ZOOM_options_get(r->options, "elementSetName");
844 task->u.search.elementSetName = elementSetName
845 ? xstrdup(elementSetName) : 0;
847 ZOOM_resultset_addref(r);
853 while (ZOOM_event(1, &c))
860 * This is the old result-set sorting API, which is maintained only
861 * for the sake of binary compatibility. There is no reason ever to
862 * use this rather than ZOOM_resultset_sort1().
865 ZOOM_resultset_sort(ZOOM_resultset r,
866 const char *sort_type, const char *sort_spec)
868 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
872 ZOOM_resultset_sort1(ZOOM_resultset r,
873 const char *sort_type, const char *sort_spec)
875 ZOOM_connection c = r->connection;
879 newq = ZOOM_query_create();
880 if (ZOOM_query_sortby(newq, sort_spec) < 0)
883 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
884 r, r, sort_type, sort_spec);
888 if (c->host_port && c->proto == PROTO_HTTP)
892 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
893 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
897 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
903 ZOOM_resultset_cache_reset(r);
904 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
905 task->u.sort.resultset = r;
906 task->u.sort.q = newq;
908 ZOOM_resultset_addref(r);
912 while (ZOOM_event(1, &c))
920 ZOOM_resultset_cache_reset(ZOOM_resultset r)
923 for (i = 0; i<RECORD_HASH_SIZE; i++)
925 ZOOM_record_cache rc;
926 for (rc = r->record_hash[i]; rc; rc = rc->next)
928 if (rc->rec.wrbuf_marc)
929 wrbuf_free(rc->rec.wrbuf_marc, 1);
930 if (rc->rec.wrbuf_iconv)
931 wrbuf_free(rc->rec.wrbuf_iconv, 1);
932 if (rc->rec.wrbuf_opac)
933 wrbuf_free(rc->rec.wrbuf_opac, 1);
935 r->record_hash[i] = 0;
940 ZOOM_resultset_destroy(ZOOM_resultset r)
945 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
947 if (r->refcount == 0)
949 ZOOM_resultset_cache_reset(r);
953 /* remove ourselves from the resultsets in connection */
954 ZOOM_resultset *rp = &r->connection->resultsets;
957 assert(*rp); /* we must be in this list!! */
959 { /* OK, we're here - take us out of it */
966 ZOOM_query_destroy(r->query);
967 ZOOM_options_destroy(r->options);
976 ZOOM_resultset_size(ZOOM_resultset r)
978 yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
983 static void do_close(ZOOM_connection c)
988 ZOOM_connection_set_mask(c, 0);
989 c->state = STATE_IDLE;
992 static int ZOOM_test_reconnect(ZOOM_connection c)
996 if (!c->reconnect_ok)
1000 c->tasks->running = 0;
1001 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1003 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1004 ZOOM_connection_put_event(c, event);
1009 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1010 int force_sync, int start, int count)
1015 const char *syntax, *elementSetName;
1019 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1020 " count=%d", r, force_sync, start, count);
1025 if (c->host_port && c->proto == PROTO_HTTP)
1029 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1030 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1034 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1036 c->reconnect_ok = 1;
1039 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1040 task->u.retrieve.resultset = r;
1041 task->u.retrieve.start = start;
1042 task->u.retrieve.count = count;
1044 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1045 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1046 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1047 task->u.retrieve.elementSetName = elementSetName
1048 ? xstrdup(elementSetName) : 0;
1050 cp = ZOOM_options_get(r->options, "schema");
1053 if (!r->schema || strcmp(r->schema, cp))
1056 r->schema = xstrdup(cp);
1060 ZOOM_resultset_addref(r);
1062 if (!r->connection->async || force_sync)
1063 while (r->connection && ZOOM_event(1, &r->connection))
1068 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1069 size_t start, size_t count)
1071 int force_present = 0;
1075 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1076 r, r, (long) start, (long) count);
1079 ZOOM_resultset_retrieve(r, force_present, start, count);
1083 for (i = 0; i< count; i++)
1084 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1088 static void get_cert(ZOOM_connection c)
1093 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1095 ZOOM_connection_option_setl(c, "sslPeerCert",
1096 cert_buf, cert_len);
1101 static zoom_ret do_connect(ZOOM_connection c)
1104 const char *effective_host;
1107 effective_host = c->proxy;
1109 effective_host = c->host_port;
1111 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1115 c->cs = cs_create_host(effective_host, 0, &add);
1117 if (c->cs && c->cs->protocol == PROTO_HTTP)
1120 const char *path = 0;
1122 c->proto = PROTO_HTTP;
1123 cs_get_host_args(c->host_port, &path);
1125 c->path = (char*) xmalloc(strlen(path)+2);
1127 strcpy(c->path+1, path);
1129 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1131 return zoom_complete;
1136 int ret = cs_connect(c->cs, add);
1139 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1140 ZOOM_connection_put_event(c, event);
1142 if (c->proto == PROTO_Z3950)
1143 ZOOM_connection_send_init(c);
1146 /* no init request for SRW .. */
1147 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1148 ZOOM_connection_remove_task(c);
1149 ZOOM_connection_set_mask(c, 0);
1150 ZOOM_connection_exec_task(c);
1152 c->state = STATE_ESTABLISHED;
1153 return zoom_pending;
1157 int mask = ZOOM_SELECT_EXCEPT;
1158 if (c->cs->io_pending & CS_WANT_WRITE)
1159 mask += ZOOM_SELECT_WRITE;
1160 if (c->cs->io_pending & CS_WANT_READ)
1161 mask += ZOOM_SELECT_READ;
1162 ZOOM_connection_set_mask(c, mask);
1163 c->state = STATE_CONNECTING;
1164 return zoom_pending;
1167 c->state = STATE_IDLE;
1168 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1169 return zoom_complete;
1172 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1175 for (i = 0; i<200; i++)
1178 Z_OtherInformation **oi;
1184 sprintf(buf, "otherInfo%d", i);
1185 val = ZOOM_options_get(c->options, buf);
1188 cp = strchr(val, ':');
1192 if (len >= sizeof(buf))
1193 len = sizeof(buf)-1;
1194 memcpy(buf, val, len);
1196 oidval = oid_getvalbyname(buf);
1197 if (oidval == VAL_NONE)
1200 yaz_oi_APDU(a, &oi);
1201 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1205 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1210 Z_OtherInformation **oi;
1211 yaz_oi_APDU(a, &oi);
1212 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1216 Z_OtherInformation **oi;
1217 yaz_oi_APDU(a, &oi);
1218 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1220 otherInfo_attach(c, a, out);
1221 if (!z_APDU(out, &a, 0, 0))
1223 FILE *outf = fopen("/tmp/apdu.txt", "a");
1226 ODR odr_pr = odr_createmem(ODR_PRINT);
1227 fprintf(outf, "a=%p\n", a);
1228 odr_setprint(odr_pr, outf);
1229 z_APDU(odr_pr, &a, 0, 0);
1230 odr_destroy(odr_pr);
1232 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1233 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1237 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1241 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1245 if (encode_APDU(c, a, c->odr_out))
1246 return zoom_complete;
1247 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1248 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1249 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1250 ZOOM_connection_put_event(c, event);
1251 odr_reset(c->odr_out);
1255 /* returns 1 if PDU was sent OK (still pending )
1256 0 if PDU was not sent OK (nothing to wait for)
1259 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1261 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1262 Z_InitRequest *ireq = apdu->u.initRequest;
1263 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1264 odr_malloc(c->odr_out, sizeof(*auth));
1265 const char *auth_groupId = ZOOM_options_get(c->options, "group");
1266 const char *auth_userId = ZOOM_options_get(c->options, "user");
1267 const char *auth_password = ZOOM_options_get(c->options, "password");
1270 /* support the pass for backwards compatibility */
1272 auth_password = ZOOM_options_get(c->options, "pass");
1274 ODR_MASK_SET(ireq->options, Z_Options_search);
1275 ODR_MASK_SET(ireq->options, Z_Options_present);
1276 ODR_MASK_SET(ireq->options, Z_Options_scan);
1277 ODR_MASK_SET(ireq->options, Z_Options_sort);
1278 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1279 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1281 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1282 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1283 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1285 /* Index Data's Z39.50 Implementor Id is 81 */
1286 ireq->implementationId =
1287 odr_prepend(c->odr_out,
1288 ZOOM_options_get(c->options, "implementationId"),
1289 odr_prepend(c->odr_out, "81", ireq->implementationId));
1291 ireq->implementationName =
1292 odr_prepend(c->odr_out,
1293 ZOOM_options_get(c->options, "implementationName"),
1294 odr_prepend(c->odr_out, "ZOOM-C",
1295 ireq->implementationName));
1297 version = odr_strdup(c->odr_out, "$Revision: 1.115 $");
1298 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1299 version[strlen(version)-2] = '\0';
1300 ireq->implementationVersion =
1301 odr_prepend(c->odr_out,
1302 ZOOM_options_get(c->options, "implementationVersion"),
1303 odr_prepend(c->odr_out, &version[11],
1304 ireq->implementationVersion));
1306 *ireq->maximumRecordSize =
1307 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
1308 *ireq->preferredMessageSize =
1309 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
1311 if (auth_groupId || auth_password)
1313 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1316 if (auth_groupId && *auth_groupId)
1318 pass->groupId = (char *)
1319 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1320 strcpy(pass->groupId, auth_groupId);
1324 if (auth_userId && *auth_userId)
1326 pass->userId = (char *)
1327 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1328 strcpy(pass->userId, auth_userId);
1332 if (auth_password && *auth_password)
1334 pass->password = (char *)
1335 odr_malloc(c->odr_out, strlen(auth_password)+1);
1336 strcpy(pass->password, auth_password);
1341 auth->which = Z_IdAuthentication_idPass;
1342 auth->u.idPass = pass;
1343 ireq->idAuthentication = auth;
1346 else if (auth_userId)
1348 auth->which = Z_IdAuthentication_open;
1349 auth->u.open = (char *)
1350 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1351 strcpy(auth->u.open, auth_userId);
1352 ireq->idAuthentication = auth;
1355 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1356 VAL_PROXY, 1, c->host_port);
1357 if (c->charset || c->lang)
1359 Z_OtherInformation **oi;
1360 Z_OtherInformationUnit *oi_unit;
1362 yaz_oi_APDU(apdu, &oi);
1364 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1366 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1367 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1368 oi_unit->information.externallyDefinedInfo =
1369 yaz_set_proposal_charneg_list(c->odr_out, " ",
1370 c->charset, c->lang, 1);
1374 return send_APDU(c, apdu);
1378 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1383 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1385 if (c->sru_mode == zoom_sru_get)
1387 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1389 else if (c->sru_mode == zoom_sru_post)
1391 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1393 else if (c->sru_mode == zoom_sru_soap)
1395 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1397 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1398 return zoom_complete;
1399 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1401 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1402 ZOOM_connection_put_event(c, event);
1403 odr_reset(c->odr_out);
1409 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1413 ZOOM_resultset resultset = 0;
1415 const char *option_val = 0;
1417 if (c->error) /* don't continue on error */
1418 return zoom_complete;
1420 switch(c->tasks->which)
1422 case ZOOM_TASK_SEARCH:
1423 resultset = c->tasks->u.search.resultset;
1424 resultset->setname = xstrdup("default");
1425 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1426 start = &c->tasks->u.search.start;
1427 count = &c->tasks->u.search.count;
1429 case ZOOM_TASK_RETRIEVE:
1430 resultset = c->tasks->u.retrieve.resultset;
1432 start = &c->tasks->u.retrieve.start;
1433 count = &c->tasks->u.retrieve.count;
1435 if (*start >= resultset->size)
1436 return zoom_complete;
1437 if (*start + *count > resultset->size)
1438 *count = resultset->size - *start;
1440 for (i = 0; i < *count; i++)
1443 record_cache_lookup(resultset, i + *start,
1444 c->tasks->u.retrieve.syntax,
1445 c->tasks->u.retrieve.elementSetName);
1450 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1451 ZOOM_connection_put_event(c, event);
1458 return zoom_complete;
1461 return zoom_complete;
1463 assert(resultset->query);
1465 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1467 if (resultset->query->z_query->which == Z_Query_type_104
1468 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1470 sr->u.request->query_type = Z_SRW_query_type_cql;
1471 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1473 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1474 resultset->query->z_query->u.type_1)
1476 sr->u.request->query_type = Z_SRW_query_type_pqf;
1477 sr->u.request->query.pqf = resultset->query->query_string;
1481 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1482 return zoom_complete;
1484 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1485 sr->u.request->maximumRecords = odr_intdup(
1486 c->odr_out, resultset->step>0 ? resultset->step : *count);
1487 sr->u.request->recordSchema = resultset->schema;
1489 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1491 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1493 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1495 sr->extra_args = odr_strdup(c->odr_out, option_val);
1496 return send_srw(c, sr);
1499 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1501 return zoom_complete;
1505 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1508 int lslb, ssub, mspn;
1510 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1511 Z_SearchRequest *search_req = apdu->u.searchRequest;
1512 const char *elementSetName;
1513 const char *smallSetElementSetName;
1514 const char *mediumSetElementSetName;
1517 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1519 r = c->tasks->u.search.resultset;
1521 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1524 ZOOM_options_get(r->options, "elementSetName");
1525 smallSetElementSetName =
1526 ZOOM_options_get(r->options, "smallSetElementSetName");
1527 mediumSetElementSetName =
1528 ZOOM_options_get(r->options, "mediumSetElementSetName");
1530 if (!smallSetElementSetName)
1531 smallSetElementSetName = elementSetName;
1533 if (!mediumSetElementSetName)
1534 mediumSetElementSetName = elementSetName;
1539 /* prepare query for the search request */
1540 search_req->query = r->query->z_query;
1541 if (!search_req->query)
1543 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1544 return zoom_complete;
1547 search_req->databaseNames = r->databaseNames;
1548 search_req->num_databaseNames = r->num_databaseNames;
1550 /* get syntax (no need to provide unless piggyback is in effect) */
1551 syntax = c->tasks->u.search.syntax;
1553 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1554 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1555 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1556 if (lslb != -1 && ssub != -1 && mspn != -1)
1558 /* So're a Z39.50 expert? Let's hope you don't do sort */
1559 *search_req->largeSetLowerBound = lslb;
1560 *search_req->smallSetUpperBound = ssub;
1561 *search_req->mediumSetPresentNumber = mspn;
1563 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1564 && r->piggyback && !r->r_sort_spec && !r->schema)
1566 /* Regular piggyback - do it unless we're going to do sort */
1567 *search_req->largeSetLowerBound = 2000000000;
1568 *search_req->smallSetUpperBound = 1;
1569 *search_req->mediumSetPresentNumber =
1570 r->step>0 ? r->step : c->tasks->u.search.count;
1574 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1575 smallSetElementSetName = 0;
1576 mediumSetElementSetName = 0;
1579 if (smallSetElementSetName && *smallSetElementSetName)
1581 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1582 odr_malloc(c->odr_out, sizeof(*esn));
1584 esn->which = Z_ElementSetNames_generic;
1585 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1586 search_req->smallSetElementSetNames = esn;
1588 if (mediumSetElementSetName && *mediumSetElementSetName)
1590 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1591 odr_malloc(c->odr_out, sizeof(*esn));
1593 esn->which = Z_ElementSetNames_generic;
1594 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1595 search_req->mediumSetElementSetNames = esn;
1598 search_req->preferredRecordSyntax =
1599 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1603 if (c->support_named_resultsets)
1607 /* find the lowest unused ordinal so that we re-use
1608 result sets on the server. */
1609 for (ord = 1; ; ord++)
1612 sprintf(setname, "%d", ord);
1613 for (rp = c->resultsets; rp; rp = rp->next)
1614 if (rp->setname && !strcmp(rp->setname, setname))
1619 r->setname = xstrdup(setname);
1620 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1621 "set %s", c, r->setname);
1625 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1627 r->setname = xstrdup("default");
1629 ZOOM_options_set(r->options, "setname", r->setname);
1631 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1632 return send_APDU(c, apdu);
1635 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1642 case Z_DefaultDiagFormat_v2Addinfo:
1643 addinfo = r->u.v2Addinfo;
1645 case Z_DefaultDiagFormat_v3Addinfo:
1646 addinfo = r->u.v3Addinfo;
1651 set_dset_error(c, *r->condition,
1652 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1656 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1658 if (p->which != Z_DiagRec_defaultFormat)
1659 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1661 response_default_diag(c, p->u.defaultFormat);
1664 ZOOM_API(ZOOM_record)
1665 ZOOM_record_clone(ZOOM_record srec)
1672 odr_enc = odr_createmem(ODR_ENCODE);
1673 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1675 buf = odr_getbuf(odr_enc, &size, 0);
1677 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1678 nrec->odr = odr_createmem(ODR_DECODE);
1679 nrec->wrbuf_marc = 0;
1680 nrec->wrbuf_iconv = 0;
1681 nrec->wrbuf_opac = 0;
1682 odr_setbuf(nrec->odr, buf, size, 0);
1683 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1685 odr_destroy(odr_enc);
1689 ZOOM_API(ZOOM_record)
1690 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1692 const char *syntax =
1693 ZOOM_options_get(s->options, "preferredRecordSyntax");
1694 const char *elementSetName =
1695 ZOOM_options_get(s->options, "elementSetName");
1697 return record_cache_lookup(s, pos, syntax, elementSetName);
1700 ZOOM_API(ZOOM_record)
1701 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1703 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1708 * MIKE: I think force_sync should always be zero, but I don't
1709 * want to make this change until I get the go-ahead from
1710 * Adam, in case something depends on the old synchronous
1714 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1715 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1716 rec = ZOOM_resultset_record_immediate(r, pos);
1722 ZOOM_record_destroy(ZOOM_record rec)
1726 if (rec->wrbuf_marc)
1727 wrbuf_free(rec->wrbuf_marc, 1);
1728 if (rec->wrbuf_iconv)
1729 wrbuf_free(rec->wrbuf_iconv, 1);
1730 if (rec->wrbuf_opac)
1731 wrbuf_free(rec->wrbuf_opac, 1);
1732 odr_destroy(rec->odr);
1736 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1738 const char *buf, int sz,
1739 const char *record_charset)
1744 yaz_marc_t mt = yaz_marc_create();
1747 strcpy(to, "UTF-8");
1748 if (record_charset && *record_charset)
1750 /* Use "from,to" or just "from" */
1751 const char *cp = strchr(record_charset, ',');
1752 int clen = strlen(record_charset);
1755 strncpy( to, cp+1, sizeof(to)-1);
1756 to[sizeof(to)-1] = '\0';
1757 clen = cp - record_charset;
1759 if (clen > sizeof(from)-1)
1760 clen = sizeof(from)-1;
1763 strncpy(from, record_charset, clen);
1769 cd = yaz_iconv_open(to, from);
1770 yaz_marc_iconv(mt, cd);
1773 yaz_marc_xml(mt, marc_type);
1774 if (!rec->wrbuf_marc)
1775 rec->wrbuf_marc = wrbuf_alloc();
1776 wrbuf_rewind(rec->wrbuf_marc);
1777 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1779 yaz_marc_destroy(mt);
1781 yaz_iconv_close(cd);
1783 *len = wrbuf_len(rec->wrbuf_marc);
1784 return wrbuf_buf(rec->wrbuf_marc);
1786 yaz_marc_destroy(mt);
1788 yaz_iconv_close(cd);
1792 static const char *record_iconv_return(ZOOM_record rec, int *len,
1793 const char *buf, int sz,
1794 const char *record_charset)
1801 strcpy(to, "UTF-8");
1802 if (record_charset && *record_charset)
1804 /* Use "from,to" or just "from" */
1805 const char *cp = strchr(record_charset, ',');
1806 int clen = strlen(record_charset);
1809 strncpy( to, cp+1, sizeof(to)-1);
1810 to[sizeof(to)-1] = '\0';
1811 clen = cp - record_charset;
1813 if (clen > sizeof(from)-1)
1814 clen = sizeof(from)-1;
1817 strncpy(from, record_charset, clen);
1821 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1824 size_t inbytesleft = sz;
1825 const char *inp = buf;
1827 if (!rec->wrbuf_iconv)
1828 rec->wrbuf_iconv = wrbuf_alloc();
1830 wrbuf_rewind(rec->wrbuf_iconv);
1834 size_t outbytesleft = sizeof(outbuf);
1835 char *outp = outbuf;
1836 size_t r = yaz_iconv(cd, (char**) &inp,
1838 &outp, &outbytesleft);
1839 if (r == (size_t) (-1))
1841 int e = yaz_iconv_error(cd);
1842 if (e != YAZ_ICONV_E2BIG)
1845 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1847 wrbuf_puts(rec->wrbuf_iconv, "");
1848 buf = wrbuf_buf(rec->wrbuf_iconv);
1849 sz = wrbuf_len(rec->wrbuf_iconv);
1850 yaz_iconv_close(cd);
1858 ZOOM_record_error(ZOOM_record rec, const char **cp,
1859 const char **addinfo, const char **diagset)
1861 Z_NamePlusRecord *npr;
1866 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1868 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1869 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1870 const char *add = 0;
1872 if (diag_rec->which == Z_DiagRec_defaultFormat)
1874 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1877 error = *ddf->condition;
1880 case Z_DefaultDiagFormat_v2Addinfo:
1881 add = ddf->u.v2Addinfo;
1883 case Z_DefaultDiagFormat_v3Addinfo:
1884 add = ddf->u.v3Addinfo;
1888 *diagset = yaz_z3950oid_to_str(ddf->diagnosticSetId, &oclass);
1896 *addinfo = add ? add : "";
1898 *cp = diagbib1_str(error);
1904 ZOOM_API(const char *)
1905 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1912 Z_NamePlusRecord *npr;
1915 *len = 0; /* default return */
1924 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1926 if (cp[i] == ';' || cp[i] == ' ')
1932 while (type_spec[i] == ';')
1935 while (type_spec[i] == ' ')
1937 if (!strncmp(type_spec+i, "charset=", 8))
1940 i = i + 8; /* skip charset= */
1941 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1943 if (type_spec[i] == ';' || type_spec[i] == ' ')
1949 else if (!strncmp(type_spec+i, "xpath=", 6))
1953 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1957 while (type_spec[i] == ' ')
1960 if (!strcmp(type, "database"))
1963 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1964 return npr->databaseName;
1966 else if (!strcmp(type, "syntax"))
1968 const char *desc = 0;
1969 if (npr->which == Z_NamePlusRecord_databaseRecord)
1971 Z_External *r = (Z_External *) npr->u.databaseRecord;
1972 oident *ent = oid_getentbyoid(r->direct_reference);
1979 *len = strlen(desc);
1982 if (npr->which != Z_NamePlusRecord_databaseRecord)
1985 /* from now on - we have a database record .. */
1986 if (!strcmp(type, "render"))
1988 Z_External *r = (Z_External *) npr->u.databaseRecord;
1989 oident *ent = oid_getentbyoid(r->direct_reference);
1991 /* render bibliographic record .. */
1992 if (r->which == Z_External_OPAC)
1994 r = r->u.opac->bibliographicRecord;
1997 ent = oid_getentbyoid(r->direct_reference);
1999 if (r->which == Z_External_sutrs)
2000 return record_iconv_return(rec, len,
2001 (char*) r->u.sutrs->buf,
2004 else if (r->which == Z_External_octet)
2006 const char *ret_buf;
2014 case VAL_APPLICATION_XML:
2017 ret_buf = marc_iconv_return(
2018 rec, YAZ_MARC_LINE, len,
2019 (const char *) r->u.octet_aligned->buf,
2020 r->u.octet_aligned->len,
2025 return record_iconv_return(rec, len,
2026 (const char *) r->u.octet_aligned->buf,
2027 r->u.octet_aligned->len,
2030 else if (r->which == Z_External_grs1)
2032 if (!rec->wrbuf_marc)
2033 rec->wrbuf_marc = wrbuf_alloc();
2034 wrbuf_rewind(rec->wrbuf_marc);
2035 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
2036 return record_iconv_return(rec, len,
2037 wrbuf_buf(rec->wrbuf_marc),
2038 wrbuf_len(rec->wrbuf_marc),
2043 else if (!strcmp(type, "xml"))
2045 Z_External *r = (Z_External *) npr->u.databaseRecord;
2046 oident *ent = oid_getentbyoid(r->direct_reference);
2048 /* render bibliographic record .. */
2049 if (r->which == Z_External_OPAC)
2051 r = r->u.opac->bibliographicRecord;
2054 ent = oid_getentbyoid(r->direct_reference);
2057 if (r->which == Z_External_sutrs)
2058 return record_iconv_return(rec, len,
2059 (const char *) r->u.sutrs->buf,
2062 else if (r->which == Z_External_octet)
2064 const char *ret_buf;
2065 int marc_decode_type = YAZ_MARC_MARCXML;
2074 case VAL_APPLICATION_XML:
2077 ret_buf = marc_iconv_return(
2078 rec, marc_decode_type, len,
2079 (const char *) r->u.octet_aligned->buf,
2080 r->u.octet_aligned->len,
2085 return record_iconv_return(rec, len,
2086 (const char *) r->u.octet_aligned->buf,
2087 r->u.octet_aligned->len,
2090 else if (r->which == Z_External_grs1)
2097 else if (!strcmp(type, "raw"))
2099 Z_External *r = (Z_External *) npr->u.databaseRecord;
2101 if (r->which == Z_External_sutrs)
2103 if (len) *len = r->u.sutrs->len;
2104 return (const char *) r->u.sutrs->buf;
2106 else if (r->which == Z_External_octet)
2108 if (len) *len = r->u.octet_aligned->len;
2109 return (const char *) r->u.octet_aligned->buf;
2111 else /* grs-1, explain, OPAC, ... */
2114 return (const char *) npr->u.databaseRecord;
2118 else if (!strcmp (type, "ext"))
2121 return (const char *) npr->u.databaseRecord;
2123 else if (!strcmp (type, "opac"))
2126 Z_External *r = (Z_External *) npr->u.databaseRecord;
2127 if (r->which == Z_External_OPAC)
2129 if (!rec->wrbuf_opac)
2130 rec->wrbuf_opac = wrbuf_alloc();
2131 wrbuf_rewind(rec->wrbuf_opac);
2132 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2133 return record_iconv_return(rec, len,
2134 wrbuf_buf(rec->wrbuf_opac),
2135 wrbuf_len(rec->wrbuf_opac),
2142 static int strcmp_null(const char *v1, const char *v2)
2148 return strcmp(v1, v2);
2151 static size_t record_hash(int pos)
2155 return pos % RECORD_HASH_SIZE;
2158 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2160 const char *syntax, const char *elementSetName)
2162 ZOOM_record_cache rc;
2164 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2165 ZOOM_connection_put_event(r->connection, event);
2167 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2171 if (strcmp_null(r->schema, rc->schema))
2173 if (strcmp_null(elementSetName,rc->elementSetName))
2175 if (strcmp_null(syntax, rc->syntax))
2177 /* not destroying rc->npr (it's handled by nmem )*/
2179 /* keeping wrbuf_marc too */
2183 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2186 rc->rec.wrbuf_marc = 0;
2187 rc->rec.wrbuf_iconv = 0;
2188 rc->rec.wrbuf_opac = 0;
2190 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2192 rc->elementSetName = 0;
2195 rc->syntax = odr_strdup(r->odr, syntax);
2200 rc->schema = odr_strdup(r->odr, r->schema);
2205 rc->next = r->record_hash[record_hash(pos)];
2206 r->record_hash[record_hash(pos)] = rc;
2209 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2211 const char *elementSetName)
2213 ZOOM_record_cache rc;
2215 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2219 if (strcmp_null(r->schema, rc->schema))
2221 if (strcmp_null(elementSetName,rc->elementSetName))
2223 if (strcmp_null(syntax, rc->syntax))
2231 static void handle_records(ZOOM_connection c, Z_Records *sr,
2234 ZOOM_resultset resultset;
2236 const char *syntax = 0, *elementSetName = 0;
2240 switch (c->tasks->which)
2242 case ZOOM_TASK_SEARCH:
2243 resultset = c->tasks->u.search.resultset;
2244 start = &c->tasks->u.search.start;
2245 count = &c->tasks->u.search.count;
2246 syntax = c->tasks->u.search.syntax;
2247 elementSetName = c->tasks->u.search.elementSetName;
2249 case ZOOM_TASK_RETRIEVE:
2250 resultset = c->tasks->u.retrieve.resultset;
2251 start = &c->tasks->u.retrieve.start;
2252 count = &c->tasks->u.retrieve.count;
2253 syntax = c->tasks->u.retrieve.syntax;
2254 elementSetName = c->tasks->u.retrieve.elementSetName;
2259 if (sr && sr->which == Z_Records_NSD)
2260 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2261 else if (sr && sr->which == Z_Records_multipleNSD)
2263 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2264 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2266 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2270 if (*count + *start > resultset->size)
2271 *count = resultset->size - *start;
2274 if (sr && sr->which == Z_Records_DBOSD)
2277 NMEM nmem = odr_extract_mem(c->odr_in);
2278 Z_NamePlusRecordList *p =
2279 sr->u.databaseOrSurDiagnostics;
2280 for (i = 0; i<p->num_records; i++)
2282 record_cache_add(resultset, p->records[i], i + *start,
2283 syntax, elementSetName);
2289 yaz_log(log_details,
2290 "handle_records resultset=%p start=%d count=%d",
2291 resultset, *start, *count);
2293 /* transfer our response to search_nmem .. we need it later */
2294 nmem_transfer(resultset->odr->mem, nmem);
2296 if (present_phase && p->num_records == 0)
2298 /* present response and we didn't get any records! */
2299 Z_NamePlusRecord *myrec =
2300 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2301 record_cache_add(resultset, myrec, *start,
2302 syntax, elementSetName);
2305 else if (present_phase)
2307 /* present response and we didn't get any records! */
2308 Z_NamePlusRecord *myrec =
2309 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2310 record_cache_add(resultset, myrec, *start, syntax, elementSetName);
2315 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2317 handle_records(c, pr->records, 1);
2320 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2323 switch (term->which)
2325 case Z_Term_general:
2326 ZOOM_options_setl(opt, name,
2327 (const char *)(term->u.general->buf),
2328 term->u.general->len);
2330 case Z_Term_characterString:
2331 ZOOM_options_set(opt, name, term->u.characterString);
2333 case Z_Term_numeric:
2334 ZOOM_options_set_int(opt, name, *term->u.numeric);
2339 static void handle_queryExpression(ZOOM_options opt, const char *name,
2340 Z_QueryExpression *exp)
2346 case Z_QueryExpression_term:
2347 if (exp->u.term && exp->u.term->queryTerm)
2349 sprintf(opt_name, "%s.term", name);
2350 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2353 case Z_QueryExpression_query:
2358 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2359 Z_OtherInformation *o)
2362 for (i = 0; o && i < o->num_elements; i++)
2364 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2366 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2368 if (ext->which == Z_External_searchResult1)
2371 Z_SearchInfoReport *sr = ext->u.searchResult1;
2374 ZOOM_options_set_int(
2375 resultset->options, "searchresult.size", sr->num);
2377 for (j = 0; j < sr->num; j++)
2379 Z_SearchInfoReport_s *ent =
2380 ext->u.searchResult1->elements[j];
2383 sprintf(pref, "searchresult.%d", j);
2385 if (ent->subqueryId)
2388 sprintf(opt_name, "%s.id", pref);
2389 ZOOM_options_set(resultset->options, opt_name,
2392 if (ent->subqueryExpression)
2395 sprintf(opt_name, "%s.subquery", pref);
2396 handle_queryExpression(resultset->options, opt_name,
2397 ent->subqueryExpression);
2399 if (ent->subqueryInterpretation)
2402 sprintf(opt_name, "%s.interpretation", pref);
2403 handle_queryExpression(resultset->options, opt_name,
2404 ent->subqueryInterpretation);
2406 if (ent->subqueryRecommendation)
2409 sprintf(opt_name, "%s.recommendation", pref);
2410 handle_queryExpression(resultset->options, opt_name,
2411 ent->subqueryRecommendation);
2413 if (ent->subqueryCount)
2416 sprintf(opt_name, "%s.count", pref);
2417 ZOOM_options_set_int(resultset->options, opt_name,
2418 *ent->subqueryCount);
2426 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2428 ZOOM_resultset resultset;
2431 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2434 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2435 ZOOM_connection_put_event(c, event);
2437 resultset = c->tasks->u.search.resultset;
2439 if (sr->resultSetStatus)
2441 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2442 *sr->resultSetStatus);
2444 if (sr->presentStatus)
2446 ZOOM_options_set_int(resultset->options, "presentStatus",
2447 *sr->presentStatus);
2449 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2451 resultset->size = *sr->resultCount;
2452 handle_records(c, sr->records, 0);
2455 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2457 if (res->diagnostics && res->num_diagnostics > 0)
2458 response_diag(c, res->diagnostics[0]);
2461 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2463 NMEM nmem = odr_extract_mem(c->odr_in);
2466 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2468 scan = c->tasks->u.scan.scan;
2470 if (res->entries && res->entries->nonsurrogateDiagnostics)
2471 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2472 scan->scan_response = res;
2473 nmem_transfer(scan->odr->mem, nmem);
2475 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2476 if (res->positionOfTerm)
2477 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2478 if (res->scanStatus)
2479 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2480 if (res->numberOfEntriesReturned)
2481 ZOOM_options_set_int(scan->options, "number",
2482 *res->numberOfEntriesReturned);
2487 static zoom_ret send_sort(ZOOM_connection c,
2488 ZOOM_resultset resultset)
2491 resultset->r_sort_spec = 0;
2492 if (resultset->r_sort_spec)
2494 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2495 Z_SortRequest *req = apdu->u.sortRequest;
2497 req->num_inputResultSetNames = 1;
2498 req->inputResultSetNames = (Z_InternationalString **)
2499 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2500 req->inputResultSetNames[0] =
2501 odr_strdup(c->odr_out, resultset->setname);
2502 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2503 req->sortSequence = resultset->r_sort_spec;
2504 resultset->r_sort_spec = 0;
2505 return send_APDU(c, apdu);
2507 return zoom_complete;
2510 static zoom_ret send_present(ZOOM_connection c)
2513 Z_PresentRequest *req = 0;
2515 const char *syntax = 0;
2516 const char *elementSetName = 0;
2517 ZOOM_resultset resultset;
2522 yaz_log(log_details, "%p send_present no tasks", c);
2523 return zoom_complete;
2526 switch (c->tasks->which)
2528 case ZOOM_TASK_SEARCH:
2529 resultset = c->tasks->u.search.resultset;
2530 start = &c->tasks->u.search.start;
2531 count = &c->tasks->u.search.count;
2532 syntax = c->tasks->u.search.syntax;
2533 elementSetName = c->tasks->u.search.elementSetName;
2535 case ZOOM_TASK_RETRIEVE:
2536 resultset = c->tasks->u.retrieve.resultset;
2537 start = &c->tasks->u.retrieve.start;
2538 count = &c->tasks->u.retrieve.count;
2539 syntax = c->tasks->u.retrieve.syntax;
2540 elementSetName = c->tasks->u.retrieve.elementSetName;
2543 return zoom_complete;
2545 yaz_log(log_details, "%p send_present start=%d count=%d",
2548 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2550 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2553 if (c->error) /* don't continue on error */
2554 return zoom_complete;
2555 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2556 resultset, *start, *count);
2558 for (i = 0; i < *count; i++)
2561 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2566 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2567 ZOOM_connection_put_event(c, event);
2575 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2576 return zoom_complete;
2579 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2580 req = apdu->u.presentRequest;
2583 yaz_log(log_details, "%p send_present skip=%d", c, i);
2585 *req->resultSetStartPoint = *start + 1;
2586 *req->numberOfRecordsRequested = resultset->step>0 ?
2587 resultset->step : *count;
2588 if (*req->numberOfRecordsRequested + *start > resultset->size)
2589 *req->numberOfRecordsRequested = resultset->size - *start;
2590 assert(*req->numberOfRecordsRequested > 0);
2592 if (syntax && *syntax)
2593 req->preferredRecordSyntax =
2594 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2596 if (resultset->schema && *resultset->schema)
2598 Z_RecordComposition *compo = (Z_RecordComposition *)
2599 odr_malloc(c->odr_out, sizeof(*compo));
2601 req->recordComposition = compo;
2602 compo->which = Z_RecordComp_complex;
2603 compo->u.complex = (Z_CompSpec *)
2604 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2605 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2606 odr_malloc(c->odr_out, sizeof(bool_t));
2607 *compo->u.complex->selectAlternativeSyntax = 0;
2609 compo->u.complex->generic = (Z_Specification *)
2610 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2612 compo->u.complex->generic->which = Z_Schema_oid;
2613 compo->u.complex->generic->schema.oid = (Odr_oid *)
2614 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2616 if (!compo->u.complex->generic->schema.oid)
2618 /* OID wasn't a schema! Try record syntax instead. */
2620 compo->u.complex->generic->schema.oid = (Odr_oid *)
2621 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2623 if (elementSetName && *elementSetName)
2625 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2626 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2627 compo->u.complex->generic->elementSpec->which =
2628 Z_ElementSpec_elementSetName;
2629 compo->u.complex->generic->elementSpec->u.elementSetName =
2630 odr_strdup(c->odr_out, elementSetName);
2633 compo->u.complex->generic->elementSpec = 0;
2634 compo->u.complex->num_dbSpecific = 0;
2635 compo->u.complex->dbSpecific = 0;
2636 compo->u.complex->num_recordSyntax = 0;
2637 compo->u.complex->recordSyntax = 0;
2639 else if (elementSetName && *elementSetName)
2641 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2642 odr_malloc(c->odr_out, sizeof(*esn));
2643 Z_RecordComposition *compo = (Z_RecordComposition *)
2644 odr_malloc(c->odr_out, sizeof(*compo));
2646 esn->which = Z_ElementSetNames_generic;
2647 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2648 compo->which = Z_RecordComp_simple;
2649 compo->u.simple = esn;
2650 req->recordComposition = compo;
2652 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2653 return send_APDU(c, apdu);
2656 ZOOM_API(ZOOM_scanset)
2657 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2660 ZOOM_query q = ZOOM_query_create();
2662 ZOOM_query_prefix(q, start);
2664 s = ZOOM_connection_scan1(c, q);
2665 ZOOM_query_destroy(q);
2670 ZOOM_API(ZOOM_scanset)
2671 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2675 ZOOM_scanset scan = 0;
2678 * We need to check the query-type, so we can recognise CQL and
2679 * CCL and compile them into a form that we can use here. The
2680 * ZOOM_query structure has no explicit `type' member, but
2681 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2682 * functions shows how the structure is set up in each case.
2686 else if (q->z_query->which == Z_Query_type_1)
2688 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2689 c, q, q->query_string);
2690 start = q->query_string;
2692 else if (q->z_query->which == Z_Query_type_104)
2694 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2695 c, q, q->query_string);
2696 start = freeme = cql2pqf(c, q->query_string);
2702 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2703 c, q, q->query_string);
2707 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2708 scan->connection = c;
2709 scan->odr = odr_createmem(ODR_DECODE);
2710 scan->options = ZOOM_options_create_with_parent(c->options);
2712 scan->scan_response = 0;
2713 scan->termListAndStartPoint =
2714 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2717 scan->databaseNames = set_DatabaseNames(c, c->options,
2718 &scan->num_databaseNames,
2720 if (scan->termListAndStartPoint != 0)
2722 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2723 task->u.scan.scan = scan;
2728 while (ZOOM_event(1, &c))
2736 ZOOM_scanset_destroy(ZOOM_scanset scan)
2741 if (scan->refcount == 0)
2743 odr_destroy(scan->odr);
2745 ZOOM_options_destroy(scan->options);
2750 static zoom_ret send_package(ZOOM_connection c)
2754 yaz_log(log_details, "%p send_package", c);
2756 return zoom_complete;
2757 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2759 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2760 ZOOM_connection_put_event(c, event);
2762 c->buf_out = c->tasks->u.package->buf_out;
2763 c->len_out = c->tasks->u.package->len_out;
2768 static zoom_ret send_scan(ZOOM_connection c)
2771 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2772 Z_ScanRequest *req = apdu->u.scanRequest;
2774 yaz_log(log_details, "%p send_scan", c);
2776 return zoom_complete;
2777 assert (c->tasks->which == ZOOM_TASK_SCAN);
2778 scan = c->tasks->u.scan.scan;
2780 req->termListAndStartPoint = scan->termListAndStartPoint;
2781 req->attributeSet = scan->attributeSet;
2783 *req->numberOfTermsRequested =
2784 ZOOM_options_get_int(scan->options, "number", 10);
2786 req->preferredPositionInResponse =
2787 odr_intdup(c->odr_out,
2788 ZOOM_options_get_int(scan->options, "position", 1));
2791 odr_intdup(c->odr_out,
2792 ZOOM_options_get_int(scan->options, "stepSize", 0));
2794 req->databaseNames = scan->databaseNames;
2795 req->num_databaseNames = scan->num_databaseNames;
2797 return send_APDU(c, apdu);
2801 ZOOM_scanset_size(ZOOM_scanset scan)
2803 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2805 return scan->scan_response->entries->num_entries;
2808 ZOOM_API(const char *)
2809 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2812 const char *term = 0;
2813 size_t noent = ZOOM_scanset_size(scan);
2814 Z_ScanResponse *res = scan->scan_response;
2820 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2822 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2824 if (t->term->which == Z_Term_general)
2826 term = (const char *) t->term->u.general->buf;
2827 *len = t->term->u.general->len;
2829 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2834 ZOOM_API(const char *)
2835 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2838 const char *term = 0;
2839 size_t noent = ZOOM_scanset_size(scan);
2840 Z_ScanResponse *res = scan->scan_response;
2846 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2848 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2852 term = t->displayTerm;
2853 *len = strlen(term);
2855 else if (t->term->which == Z_Term_general)
2857 term = (const char *) t->term->u.general->buf;
2858 *len = t->term->u.general->len;
2860 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2865 ZOOM_API(const char *)
2866 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2868 return ZOOM_options_get(scan->options, key);
2872 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2875 ZOOM_options_set(scan->options, key, val);
2878 static Z_APDU *create_es_package(ZOOM_package p, int type)
2881 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2882 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2884 *req->function = Z_ExtendedServicesRequest_create;
2886 str = ZOOM_options_get(p->options, "package-name");
2888 req->packageName = nmem_strdup(p->odr_out->mem, str);
2890 str = ZOOM_options_get(p->options, "user-id");
2892 req->userId = nmem_strdup(p->odr_out->mem, str);
2894 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2897 str = ZOOM_options_get(p->options, "function");
2900 if (!strcmp (str, "create"))
2902 if (!strcmp (str, "delete"))
2904 if (!strcmp (str, "modify"))
2910 static const char *ill_array_lookup(void *clientData, const char *idx)
2912 ZOOM_package p = (ZOOM_package) clientData;
2913 return ZOOM_options_get(p->options, idx+4);
2916 static Z_External *encode_ill_request(ZOOM_package p)
2918 ODR out = p->odr_out;
2921 struct ill_get_ctl ctl;
2923 ctl.odr = p->odr_out;
2925 ctl.f = ill_array_lookup;
2927 req = ill_get_ILLRequest(&ctl, "ill", 0);
2929 if (!ill_Request(out, &req, 0, 0))
2931 int ill_request_size;
2932 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2933 if (ill_request_buf)
2934 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2940 int illRequest_size = 0;
2941 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2943 oid.proto = PROTO_GENERAL;
2944 oid.oclass = CLASS_GENERAL;
2945 oid.value = VAL_ISO_ILL_1;
2947 r = (Z_External *) odr_malloc(out, sizeof(*r));
2948 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2949 r->indirect_reference = 0;
2951 r->which = Z_External_single;
2953 r->u.single_ASN1_type =
2954 odr_create_Odr_oct(out,
2955 (unsigned char *)illRequest_buf,
2961 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2963 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2966 req->which = Z_IOItemOrder_esRequest;
2967 req->u.esRequest = (Z_IORequest *)
2968 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2970 /* to keep part ... */
2971 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2972 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2973 req->u.esRequest->toKeep->supplDescription = 0;
2974 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2975 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2977 str = ZOOM_options_get(p->options, "contact-name");
2978 req->u.esRequest->toKeep->contact->name = str ?
2979 nmem_strdup(p->odr_out->mem, str) : 0;
2981 str = ZOOM_options_get(p->options, "contact-phone");
2982 req->u.esRequest->toKeep->contact->phone = str ?
2983 nmem_strdup(p->odr_out->mem, str) : 0;
2985 str = ZOOM_options_get(p->options, "contact-email");
2986 req->u.esRequest->toKeep->contact->email = str ?
2987 nmem_strdup(p->odr_out->mem, str) : 0;
2989 req->u.esRequest->toKeep->addlBilling = 0;
2991 /* not to keep part ... */
2992 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2993 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2995 str = ZOOM_options_get(p->options, "itemorder-setname");
3000 req->u.esRequest->notToKeep->resultSetItem = 0;
3003 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3004 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3006 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3007 nmem_strdup(p->odr_out->mem, str);
3008 req->u.esRequest->notToKeep->resultSetItem->item =
3009 (int *) odr_malloc(p->odr_out, sizeof(int));
3011 str = ZOOM_options_get(p->options, "itemorder-item");
3012 *req->u.esRequest->notToKeep->resultSetItem->item =
3013 (str ? atoi(str) : 1);
3016 str = ZOOM_options_get(p->options, "doc");
3018 req->u.esRequest->notToKeep->itemRequest =
3019 z_ext_record(p->odr_out, VAL_TEXT_XML, str, strlen(str));
3021 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3026 Z_APDU *create_admin_package(ZOOM_package p, int type,
3027 Z_ESAdminOriginPartToKeep **toKeepP,
3028 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3030 Z_APDU *apdu = create_es_package(p, VAL_ADMINSERVICE);
3033 Z_ESAdminOriginPartToKeep *toKeep;
3034 Z_ESAdminOriginPartNotToKeep *notToKeep;
3035 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3036 const char *first_db = "Default";
3038 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3043 r->direct_reference =
3044 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3047 r->indirect_reference = 0;
3048 r->which = Z_External_ESAdmin;
3050 r->u.adminService = (Z_Admin *)
3051 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3052 r->u.adminService->which = Z_Admin_esRequest;
3053 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3054 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3056 toKeep = r->u.adminService->u.esRequest->toKeep =
3057 (Z_ESAdminOriginPartToKeep *)
3058 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3059 toKeep->which = type;
3060 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3061 toKeep->u.create = odr_nullval();
3062 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3064 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3065 (Z_ESAdminOriginPartNotToKeep *)
3066 odr_malloc(p->odr_out,
3067 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3068 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3069 notToKeep->u.recordsWillFollow = odr_nullval();
3073 *notToKeepP = notToKeep;
3078 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3080 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
3081 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3082 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3083 const char *doc = ZOOM_options_get(p->options, "doc");
3088 req->taskSpecificParameters = ext;
3089 ext->direct_reference = req->packageType;
3090 ext->descriptor = 0;
3091 ext->indirect_reference = 0;
3093 ext->which = Z_External_octet;
3094 ext->u.single_ASN1_type =
3095 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
3100 static Z_APDU *create_update_package(ZOOM_package p)
3103 const char *first_db = "Default";
3105 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3106 const char *action = ZOOM_options_get(p->options, "action");
3107 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
3108 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3109 const char *record_buf = ZOOM_options_get(p->options, "record");
3110 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3111 int syntax_oid = VAL_NONE;
3115 syntax_oid = oid_getvalbyname(syntax_str);
3118 record_buf = "void";
3119 syntax_oid = VAL_SUTRS;
3121 if (syntax_oid == VAL_NONE)
3122 syntax_oid = VAL_TEXT_XML;
3128 action = "specialUpdate";
3130 if (!strcmp(action, "recordInsert"))
3131 action_no = Z_IUOriginPartToKeep_recordInsert;
3132 else if (!strcmp(action, "recordReplace"))
3133 action_no = Z_IUOriginPartToKeep_recordReplace;
3134 else if (!strcmp(action, "recordDelete"))
3135 action_no = Z_IUOriginPartToKeep_recordDelete;
3136 else if (!strcmp(action, "elementUpdate"))
3137 action_no = Z_IUOriginPartToKeep_elementUpdate;
3138 else if (!strcmp(action, "specialUpdate"))
3139 action_no = Z_IUOriginPartToKeep_specialUpdate;
3143 apdu = create_es_package(p, VAL_DBUPDATE);
3146 Z_IUOriginPartToKeep *toKeep;
3147 Z_IUSuppliedRecords *notToKeep;
3148 Z_External *r = (Z_External *)
3149 odr_malloc(p->odr_out, sizeof(*r));
3151 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3153 r->direct_reference =
3154 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3157 r->which = Z_External_update;
3158 r->indirect_reference = 0;
3159 r->u.update = (Z_IUUpdate *)
3160 odr_malloc(p->odr_out, sizeof(*r->u.update));
3162 r->u.update->which = Z_IUUpdate_esRequest;
3163 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3164 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3165 toKeep = r->u.update->u.esRequest->toKeep =
3166 (Z_IUOriginPartToKeep *)
3167 odr_malloc(p->odr_out, sizeof(*toKeep));
3169 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3171 toKeep->elementSetName = 0;
3172 toKeep->actionQualifier = 0;
3173 toKeep->action = odr_intdup(p->odr_out, action_no);
3175 notToKeep = r->u.update->u.esRequest->notToKeep =
3176 (Z_IUSuppliedRecords *)
3177 odr_malloc(p->odr_out, sizeof(*notToKeep));
3179 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3180 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3181 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3182 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3183 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3186 notToKeep->elements[0]->u.opaque =
3187 odr_create_Odr_oct(p->odr_out,
3188 (const unsigned char *) recordIdOpaque,
3189 strlen(recordIdOpaque));
3191 else if (recordIdNumber)
3193 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3195 notToKeep->elements[0]->u.number =
3196 odr_intdup(p->odr_out, atoi(recordIdNumber));
3199 notToKeep->elements[0]->u.opaque = 0;
3200 notToKeep->elements[0]->supplementalId = 0;
3201 notToKeep->elements[0]->correlationInfo = 0;
3202 notToKeep->elements[0]->record =
3203 z_ext_record(p->odr_out, syntax_oid,
3204 record_buf, strlen(record_buf));
3208 ODR print = odr_createmem(ODR_PRINT);
3210 z_APDU(print, &apdu, 0, 0);
3217 ZOOM_package_send(ZOOM_package p, const char *type)
3224 odr_reset(p->odr_out);
3227 if (!strcmp(type, "itemorder"))
3229 apdu = create_es_package(p, VAL_ITEMORDER);
3232 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3234 r->direct_reference =
3235 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3238 r->which = Z_External_itemOrder;
3239 r->indirect_reference = 0;
3240 r->u.itemOrder = encode_item_order(p);
3242 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3245 else if (!strcmp(type, "create")) /* create database */
3247 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3250 else if (!strcmp(type, "drop")) /* drop database */
3252 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3255 else if (!strcmp(type, "commit")) /* commit changes */
3257 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3260 else if (!strcmp(type, "update")) /* update record(s) */
3262 apdu = create_update_package(p);
3264 else if (!strcmp(type, "xmlupdate"))
3266 apdu = create_xmlupdate_package(p);
3270 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3274 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3275 task->u.package = p;
3276 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3277 p->buf_out = (char *) xmalloc(p->len_out);
3278 memcpy(p->buf_out, buf, p->len_out);
3283 while (ZOOM_event(1, &c))
3290 ZOOM_API(ZOOM_package)
3291 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3293 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3296 p->odr_out = odr_createmem(ODR_ENCODE);
3297 p->options = ZOOM_options_create_with_parent2(options, c->options);
3305 ZOOM_package_destroy(ZOOM_package p)
3310 if (p->refcount == 0)
3312 odr_destroy(p->odr_out);
3315 ZOOM_options_destroy(p->options);
3320 ZOOM_API(const char *)
3321 ZOOM_package_option_get(ZOOM_package p, const char *key)
3323 return ZOOM_options_get(p->options, key);
3328 ZOOM_package_option_set(ZOOM_package p, const char *key,
3331 ZOOM_options_set(p->options, key, val);
3334 static int ZOOM_connection_exec_task(ZOOM_connection c)
3336 ZOOM_task task = c->tasks;
3337 zoom_ret ret = zoom_complete;
3341 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3342 c, task->which, task->running);
3343 if (c->error != ZOOM_ERROR_NONE)
3345 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3346 "removing tasks because of error = %d", c, c->error);
3347 ZOOM_connection_remove_tasks(c);
3352 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3353 "task already running", c);
3357 ret = zoom_complete;
3358 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3360 switch (task->which)
3362 case ZOOM_TASK_SEARCH:
3363 if (c->proto == PROTO_HTTP)
3364 ret = ZOOM_connection_srw_send_search(c);
3366 ret = ZOOM_connection_send_search(c);
3368 case ZOOM_TASK_RETRIEVE:
3369 if (c->proto == PROTO_HTTP)
3370 ret = ZOOM_connection_srw_send_search(c);
3372 ret = send_present(c);
3374 case ZOOM_TASK_CONNECT:
3375 ret = do_connect(c);
3377 case ZOOM_TASK_SCAN:
3380 case ZOOM_TASK_PACKAGE:
3381 ret = send_package(c);
3383 case ZOOM_TASK_SORT:
3384 c->tasks->u.sort.resultset->r_sort_spec =
3385 c->tasks->u.sort.q->sort_spec;
3386 ret = send_sort(c, c->tasks->u.sort.resultset);
3392 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3393 "remove tasks because no connection exist", c);
3394 ZOOM_connection_remove_tasks(c);
3396 if (ret == zoom_complete)
3398 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3399 "task removed (complete)", c);
3400 ZOOM_connection_remove_task(c);
3403 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3408 static zoom_ret send_sort_present(ZOOM_connection c)
3410 zoom_ret r = zoom_complete;
3412 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3413 r = send_sort(c, c->tasks->u.search.resultset);
3414 if (r == zoom_complete)
3415 r = send_present(c);
3419 static int es_response(ZOOM_connection c,
3420 Z_ExtendedServicesResponse *res)
3422 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3424 if (res->diagnostics && res->num_diagnostics > 0)
3425 response_diag(c, res->diagnostics[0]);
3426 if (res->taskPackage &&
3427 res->taskPackage->which == Z_External_extendedService)
3429 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3430 Odr_oct *id = taskPackage->targetReference;
3433 ZOOM_options_setl(c->tasks->u.package->options,
3434 "targetReference", (char*) id->buf, id->len);
3436 if (res->taskPackage &&
3437 res->taskPackage->which == Z_External_octet)
3439 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3440 ZOOM_options_setl(c->tasks->u.package->options,
3441 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3446 static void interpret_init_diag(ZOOM_connection c,
3447 Z_DiagnosticFormat *diag)
3451 Z_DiagnosticFormat_s *ds = diag->elements[0];
3452 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3453 response_default_diag(c, ds->u.defaultDiagRec);
3458 static void interpret_otherinformation_field(ZOOM_connection c,
3459 Z_OtherInformation *ui)
3462 for (i = 0; i < ui->num_elements; i++)
3464 Z_OtherInformationUnit *unit = ui->list[i];
3465 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3466 unit->information.externallyDefinedInfo &&
3467 unit->information.externallyDefinedInfo->which ==
3470 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3476 static void set_init_option(const char *name, void *clientData) {
3477 ZOOM_connection c = clientData;
3480 sprintf(buf, "init_opt_%.70s", name);
3481 ZOOM_connection_option_set(c, buf, "1");
3485 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3487 Z_InitResponse *initrs;
3489 ZOOM_connection_set_mask(c, 0);
3490 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3493 case Z_APDU_initResponse:
3494 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3495 initrs = apdu->u.initResponse;
3496 ZOOM_connection_option_set(c, "serverImplementationId",
3497 initrs->implementationId ?
3498 initrs->implementationId : "");
3499 ZOOM_connection_option_set(c, "serverImplementationName",
3500 initrs->implementationName ?
3501 initrs->implementationName : "");
3502 ZOOM_connection_option_set(c, "serverImplementationVersion",
3503 initrs->implementationVersion ?
3504 initrs->implementationVersion : "");
3505 /* Set the three old options too, for old applications */
3506 ZOOM_connection_option_set(c, "targetImplementationId",
3507 initrs->implementationId ?
3508 initrs->implementationId : "");
3509 ZOOM_connection_option_set(c, "targetImplementationName",
3510 initrs->implementationName ?
3511 initrs->implementationName : "");
3512 ZOOM_connection_option_set(c, "targetImplementationVersion",
3513 initrs->implementationVersion ?
3514 initrs->implementationVersion : "");
3516 /* Make initrs->options available as ZOOM-level options */
3517 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3519 if (!*initrs->result)
3521 Z_External *uif = initrs->userInformationField;
3523 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3525 if (uif && uif->which == Z_External_userInfo1)
3526 interpret_otherinformation_field(c, uif->u.userInfo1);
3531 yaz_oi_get_string_oidval(&apdu->u.initResponse->otherInfo,
3533 xfree(c->cookie_in);
3536 c->cookie_in = xstrdup(cookie);
3537 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3538 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3539 c->support_named_resultsets = 1;
3542 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3543 ZOOM_connection_remove_task(c);
3545 ZOOM_connection_exec_task(c);
3547 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3549 NMEM tmpmem = nmem_create();
3550 Z_CharSetandLanguageNegotiation *p =
3551 yaz_get_charneg_record(initrs->otherInfo);
3555 char *charset = NULL, *lang = NULL;
3558 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3559 yaz_log(log_details, "%p recv_apdu target accepted: "
3560 "charset %s, language %s, select %d",
3562 charset ? charset : "none", lang ? lang : "none", sel);
3564 ZOOM_connection_option_set(c, "negotiation-charset",
3567 ZOOM_connection_option_set(c, "negotiation-lang",
3570 ZOOM_connection_option_set(
3571 c, "negotiation-charset-in-effect-for-records",
3572 (sel != 0) ? "1" : "0");
3573 nmem_destroy(tmpmem);
3577 case Z_APDU_searchResponse:
3578 yaz_log(log_api, "%p recv_apdu Search response", c);
3579 handle_search_response(c, apdu->u.searchResponse);
3580 if (send_sort_present(c) == zoom_complete)
3581 ZOOM_connection_remove_task(c);
3583 case Z_APDU_presentResponse:
3584 yaz_log(log_api, "%p recv_apdu Present response", c);
3585 handle_present_response(c, apdu->u.presentResponse);
3586 if (send_present(c) == zoom_complete)
3587 ZOOM_connection_remove_task(c);
3589 case Z_APDU_sortResponse:
3590 yaz_log(log_api, "%p recv_apdu Sort response", c);
3591 sort_response(c, apdu->u.sortResponse);
3592 if (send_present(c) == zoom_complete)
3593 ZOOM_connection_remove_task(c);
3595 case Z_APDU_scanResponse:
3596 yaz_log(log_api, "%p recv_apdu Scan response", c);
3597 scan_response(c, apdu->u.scanResponse);
3598 ZOOM_connection_remove_task(c);
3600 case Z_APDU_extendedServicesResponse:
3601 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3602 es_response(c, apdu->u.extendedServicesResponse);
3603 ZOOM_connection_remove_task(c);
3606 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3607 if (!ZOOM_test_reconnect(c))
3609 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3614 yaz_log(log_api, "%p Received unknown PDU", c);
3615 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3621 static void handle_srw_response(ZOOM_connection c,
3622 Z_SRW_searchRetrieveResponse *res)
3624 ZOOM_resultset resultset = 0;
3629 const char *syntax, *elementSetName;
3634 switch(c->tasks->which)
3636 case ZOOM_TASK_SEARCH:
3637 resultset = c->tasks->u.search.resultset;
3638 start = &c->tasks->u.search.start;
3639 syntax = c->tasks->u.search.syntax;
3640 elementSetName = c->tasks->u.search.elementSetName;
3642 case ZOOM_TASK_RETRIEVE:
3643 resultset = c->tasks->u.retrieve.resultset;
3644 start = &c->tasks->u.retrieve.start;
3645 syntax = c->tasks->u.retrieve.syntax;
3646 elementSetName = c->tasks->u.retrieve.elementSetName;
3651 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3652 ZOOM_connection_put_event(c, event);
3654 resultset->size = 0;
3656 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3658 if (res->numberOfRecords)
3659 resultset->size = *res->numberOfRecords;
3661 for (i = 0; i<res->num_records; i++)
3665 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3666 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3668 if (res->records[i].recordPosition &&
3669 *res->records[i].recordPosition > 0)
3670 pos = *res->records[i].recordPosition - 1;
3674 npr->databaseName = 0;
3675 npr->which = Z_NamePlusRecord_databaseRecord;
3676 npr->u.databaseRecord = (Z_External *)
3677 odr_malloc(c->odr_in, sizeof(Z_External));
3678 npr->u.databaseRecord->descriptor = 0;
3679 npr->u.databaseRecord->direct_reference =
3680 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3681 npr->u.databaseRecord->which = Z_External_octet;
3683 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3684 odr_malloc(c->odr_in, sizeof(Odr_oct));
3685 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3686 res->records[i].recordData_buf;
3687 npr->u.databaseRecord->u.octet_aligned->len =
3688 npr->u.databaseRecord->u.octet_aligned->size =
3689 res->records[i].recordData_len;
3690 record_cache_add(resultset, npr, pos, syntax, elementSetName);
3692 if (res->num_diagnostics > 0)
3694 const char *uri = res->diagnostics[0].uri;
3699 if ((cp = strrchr(uri, '/')))
3701 set_dset_error(c, code, uri,
3702 res->diagnostics[0].details, 0);
3705 nmem = odr_extract_mem(c->odr_in);
3706 nmem_transfer(resultset->odr->mem, nmem);
3712 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3715 const char *content_type = z_HTTP_header_lookup(hres->headers,
3717 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3719 ZOOM_connection_set_mask(c, 0);
3720 yaz_log(log_details, "%p handle_http", c);
3722 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3724 Z_SOAP *soap_package = 0;
3726 Z_SOAP_Handler soap_handlers[2] = {
3727 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
3730 ret = z_soap_codec(o, &soap_package,
3731 &hres->content_buf, &hres->content_len,
3733 if (!ret && soap_package->which == Z_SOAP_generic &&
3734 soap_package->u.generic->no == 0)
3736 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3737 if (sr->which == Z_SRW_searchRetrieve_response)
3738 handle_srw_response(c, sr->u.response);
3742 else if (!ret && (soap_package->which == Z_SOAP_fault
3743 || soap_package->which == Z_SOAP_error))
3745 set_HTTP_error(c, hres->code,
3746 soap_package->u.fault->fault_code,
3747 soap_package->u.fault->fault_string);
3754 if (hres->code != 200)
3755 set_HTTP_error(c, hres->code, 0, 0);
3757 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3760 ZOOM_connection_remove_task(c);
3761 if (!strcmp(hres->version, "1.0"))
3763 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3764 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3769 /* HTTP 1.1: only if no close we stay alive .. */
3770 if (connection_head && !strcmp(connection_head, "close"))
3776 static int do_read(ZOOM_connection c)
3781 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3782 ZOOM_connection_put_event(c, event);
3784 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3785 more = cs_more(c->cs);
3786 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3791 if (!ZOOM_test_reconnect(c))
3793 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3802 odr_reset(c->odr_in);
3803 odr_setbuf(c->odr_in, c->buf_in, r, 0);
3804 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3805 ZOOM_connection_put_event(c, event);
3807 if (!z_GDU(c->odr_in, &gdu, 0, 0))
3810 int err = odr_geterrorx(c->odr_in, &x);
3812 const char *element = odr_getelement(c->odr_in);
3813 sprintf(msg, "ODR code %d:%d element=%-20s",
3814 err, x, element ? element : "<unknown>");
3815 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3818 else if (gdu->which == Z_GDU_Z3950)
3819 recv_apdu(c, gdu->u.z3950);
3820 else if (gdu->which == Z_GDU_HTTP_Response)
3823 handle_http(c, gdu->u.HTTP_Response);
3825 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3829 c->reconnect_ok = 0;
3834 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3839 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3840 ZOOM_connection_put_event(c, event);
3842 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3843 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3845 yaz_log(log_details, "%p do_write_ex write failed", c);
3846 if (ZOOM_test_reconnect(c))
3848 return zoom_pending;
3850 if (c->state == STATE_CONNECTING)
3851 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3853 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3855 return zoom_complete;
3859 int mask = ZOOM_SELECT_EXCEPT;
3860 if (c->cs->io_pending & CS_WANT_WRITE)
3861 mask += ZOOM_SELECT_WRITE;
3862 if (c->cs->io_pending & CS_WANT_READ)
3863 mask += ZOOM_SELECT_READ;
3864 ZOOM_connection_set_mask(c, mask);
3865 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3870 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
3871 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3874 return zoom_pending;
3877 static zoom_ret do_write(ZOOM_connection c)
3879 return do_write_ex(c, c->buf_out, c->len_out);
3883 ZOOM_API(const char *)
3884 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3886 return ZOOM_options_get(c->options, key);
3889 ZOOM_API(const char *)
3890 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3892 return ZOOM_options_getl(c->options, key, lenp);
3896 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3899 ZOOM_options_set(c->options, key, val);
3903 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3904 const char *val, int len)
3906 ZOOM_options_setl(c->options, key, val, len);
3909 ZOOM_API(const char *)
3910 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3912 return ZOOM_options_get(r->options, key);
3916 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3919 ZOOM_options_set(r->options, key, val);
3924 ZOOM_connection_errcode(ZOOM_connection c)
3926 return ZOOM_connection_error(c, 0, 0);
3929 ZOOM_API(const char *)
3930 ZOOM_connection_errmsg(ZOOM_connection c)
3933 ZOOM_connection_error(c, &msg, 0);
3937 ZOOM_API(const char *)
3938 ZOOM_connection_addinfo(ZOOM_connection c)
3940 const char *addinfo;
3941 ZOOM_connection_error(c, 0, &addinfo);
3945 ZOOM_API(const char *)
3946 ZOOM_connection_diagset(ZOOM_connection c)
3948 const char *diagset;
3949 ZOOM_connection_error_x(c, 0, 0, &diagset);
3953 ZOOM_API(const char *)
3954 ZOOM_diag_str(int error)
3958 case ZOOM_ERROR_NONE:
3960 case ZOOM_ERROR_CONNECT:
3961 return "Connect failed";
3962 case ZOOM_ERROR_MEMORY:
3963 return "Out of memory";
3964 case ZOOM_ERROR_ENCODE:
3965 return "Encoding failed";
3966 case ZOOM_ERROR_DECODE:
3967 return "Decoding failed";
3968 case ZOOM_ERROR_CONNECTION_LOST:
3969 return "Connection lost";
3970 case ZOOM_ERROR_INIT:
3971 return "Init rejected";
3972 case ZOOM_ERROR_INTERNAL:
3973 return "Internal failure";
3974 case ZOOM_ERROR_TIMEOUT:
3976 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3977 return "Unsupported protocol";
3978 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3979 return "Unsupported query type";
3980 case ZOOM_ERROR_INVALID_QUERY:
3981 return "Invalid query";
3982 case ZOOM_ERROR_CQL_PARSE:
3983 return "CQL parsing error";
3984 case ZOOM_ERROR_CQL_TRANSFORM:
3985 return "CQL transformation error";
3986 case ZOOM_ERROR_CCL_CONFIG:
3987 return "CCL configuration error";
3988 case ZOOM_ERROR_CCL_PARSE:
3989 return "CCL parsing error";
3991 return diagbib1_str(error);
3996 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
3997 const char **addinfo, const char **diagset)
3999 int error = c->error;
4002 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4003 *cp = ZOOM_diag_str(error);
4004 else if (!strcmp(c->diagset, "HTTP"))
4005 *cp = z_HTTP_errmsg(c->error);
4006 else if (!strcmp(c->diagset, "Bib-1"))
4007 *cp = ZOOM_diag_str(error);
4008 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4009 *cp = yaz_diag_srw_str(c->error);
4011 *cp = "Unknown error and diagnostic set";
4014 *addinfo = c->addinfo ? c->addinfo : "";
4016 *diagset = c->diagset ? c->diagset : "";
4021 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4022 const char **addinfo)
4024 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4027 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4029 ZOOM_Event event = 0;
4030 int r = cs_look(c->cs);
4031 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4036 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4037 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4039 ZOOM_connection_put_event(c, event);
4041 else if (r == CS_CONNECT)
4043 int ret = ret = cs_rcvconnect(c->cs);
4044 yaz_log(log_details, "%p ZOOM_connection_do_io "
4045 "cs_rcvconnect returned %d", c, ret);
4048 int mask = ZOOM_SELECT_EXCEPT;
4049 if (c->cs->io_pending & CS_WANT_WRITE)
4050 mask += ZOOM_SELECT_WRITE;
4051 if (c->cs->io_pending & CS_WANT_READ)
4052 mask += ZOOM_SELECT_READ;
4053 ZOOM_connection_set_mask(c, mask);
4057 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4058 ZOOM_connection_put_event(c, event);
4060 if (c->proto == PROTO_Z3950)
4061 ZOOM_connection_send_init(c);
4064 /* no init request for SRW .. */
4065 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4066 ZOOM_connection_remove_task(c);
4067 ZOOM_connection_set_mask(c, 0);
4068 ZOOM_connection_exec_task(c);
4070 c->state = STATE_ESTABLISHED;
4074 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4080 if (mask & ZOOM_SELECT_EXCEPT)
4082 if (!ZOOM_test_reconnect(c))
4084 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4089 if (mask & ZOOM_SELECT_READ)
4091 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4097 ZOOM_connection_last_event(ZOOM_connection cs)
4100 return ZOOM_EVENT_NONE;
4101 return cs->last_event;
4106 * Returns an xmalloc()d string containing RPN that corresponds to the
4107 * CQL passed in. On error, sets the Connection object's error state
4108 * and returns a null pointer.
4109 * ### We could cache CQL parser and/or transformer in Connection.
4111 static char *cql2pqf(ZOOM_connection c, const char *cql)
4115 struct cql_node *node;
4116 const char *cqlfile;
4117 static cql_transform_t trans;
4120 parser = cql_parser_create();
4121 if ((error = cql_parser_string(parser, cql)) != 0) {
4122 cql_parser_destroy(parser);
4123 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4127 node = cql_parser_result(parser);
4128 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4130 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4132 cql_parser_destroy(parser);
4133 cql_node_destroy(node);
4134 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4138 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4140 cql_parser_destroy(parser);
4141 cql_node_destroy(node);
4142 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4143 cqlfile, strerror(errno));
4144 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4148 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4149 cql_parser_destroy(parser);
4150 cql_node_destroy(node);
4153 const char *addinfo;
4154 error = cql_transform_error(trans, &addinfo);
4155 cql_transform_close(trans);
4156 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4157 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4161 cql_transform_close(trans);
4162 return xstrdup(pqfbuf);
4165 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4169 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4170 /* timeout and this connection was waiting */
4171 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4173 ZOOM_connection_put_event(c, event);
4179 ZOOM_connection_process(ZOOM_connection c)
4185 event = ZOOM_connection_get_event(c);
4188 ZOOM_Event_destroy(event);
4191 ZOOM_connection_exec_task(c);
4192 event = ZOOM_connection_get_event(c);
4195 ZOOM_Event_destroy(event);
4202 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4206 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4208 for (i = 0; i<no; i++)
4210 ZOOM_connection c = cs[i];
4212 if (c && ZOOM_connection_process(c))
4218 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4220 if (c->mask && mask)
4221 ZOOM_connection_do_io(c, mask);
4225 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4228 return cs_fileno(c->cs);
4232 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4240 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4247 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4249 return ZOOM_options_get_int(c->options, "timeout", 30);
4255 * indent-tabs-mode: nil
4257 * vim: shiftwidth=4 tabstop=8 expandtab