2 * Copyright (C) 1995-2006, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.103 2006-12-17 16:03:01 adam Exp $
9 * \brief Implements ZOOM C interface.
17 #include <yaz/yaz-util.h>
18 #include <yaz/xmalloc.h>
19 #include <yaz/otherinfo.h>
21 #include <yaz/pquery.h>
22 #include <yaz/marcdisp.h>
23 #include <yaz/diagbib1.h>
24 #include <yaz/charneg.h>
31 #include <sys/types.h>
40 #include <sys/select.h>
44 #define FD_SETSIZE 512
49 static int log_api = 0;
50 static int log_details = 0;
57 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
58 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
59 static char *cql2pqf(ZOOM_connection c, const char *cql);
61 static void initlog(void)
63 static int log_level_initialized = 0;
64 if (!log_level_initialized)
66 log_api = yaz_log_module_level("zoom");
67 log_details = yaz_log_module_level("zoomdetails");
68 log_level_initialized = 1;
72 static ZOOM_Event ZOOM_Event_create(int kind)
74 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
78 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
82 static void ZOOM_Event_destroy(ZOOM_Event event)
87 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
91 c->m_queue_back->prev = event;
92 assert(c->m_queue_front);
96 assert(!c->m_queue_front);
97 c->m_queue_front = event;
99 event->next = c->m_queue_back;
101 c->m_queue_back = event;
104 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
106 ZOOM_Event event = c->m_queue_front;
109 c->last_event = ZOOM_EVENT_NONE;
112 assert(c->m_queue_back);
113 c->m_queue_front = event->prev;
114 if (c->m_queue_front)
116 assert(c->m_queue_back);
117 c->m_queue_front->next = 0;
121 c->last_event = event->kind;
126 static void set_dset_error(ZOOM_connection c, int error,
128 const char *addinfo, const char *addinfo2)
135 if (!c->diagset || strcmp(dset, c->diagset))
138 c->diagset = xstrdup(dset);
139 /* remove integer part from SRW diagset .. */
140 if ((cp = strrchr(c->diagset, '/')))
143 if (addinfo && addinfo2)
145 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
146 strcpy(c->addinfo, addinfo);
147 strcat(c->addinfo, addinfo2);
150 c->addinfo = xstrdup(addinfo);
152 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
153 c, c->host_port ? c->host_port : "<>", dset, error,
154 addinfo ? addinfo : "",
155 addinfo2 ? addinfo2 : "");
159 static void set_HTTP_error(ZOOM_connection c, int error,
160 const char *addinfo, const char *addinfo2)
162 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
166 static void set_ZOOM_error(ZOOM_connection c, int error,
169 set_dset_error(c, error, "ZOOM", addinfo, 0);
172 static void clear_error(ZOOM_connection c)
175 * If an error is tied to an operation then it's ok to clear: for
176 * example, a diagnostic returned from a search is cleared by a
177 * subsequent search. However, problems such as Connection Lost
178 * or Init Refused are not cleared, because they are not
179 * recoverable: doing another search doesn't help.
183 case ZOOM_ERROR_CONNECT:
184 case ZOOM_ERROR_MEMORY:
185 case ZOOM_ERROR_DECODE:
186 case ZOOM_ERROR_CONNECTION_LOST:
187 case ZOOM_ERROR_INIT:
188 case ZOOM_ERROR_INTERNAL:
189 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
192 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
196 void ZOOM_connection_show_task(ZOOM_task task)
200 case ZOOM_TASK_SEARCH:
201 yaz_log(YLOG_LOG, "search p=%p", task);
203 case ZOOM_TASK_RETRIEVE:
204 yaz_log(YLOG_LOG, "retrieve p=%p", task);
206 case ZOOM_TASK_CONNECT:
207 yaz_log(YLOG_LOG, "connect p=%p", task);
210 yaz_log(YLOG_LOG, "scant p=%p", task);
215 void ZOOM_connection_show_tasks(ZOOM_connection c)
218 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
219 for (task = c->tasks; task; task = task->next)
220 ZOOM_connection_show_task(task);
223 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
225 ZOOM_task *taskp = &c->tasks;
227 taskp = &(*taskp)->next;
228 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
229 (*taskp)->running = 0;
230 (*taskp)->which = which;
236 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
238 return c->tasks ? 0 : 1;
241 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
243 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
245 task->next = c->tasks;
254 void ZOOM_connection_remove_task(ZOOM_connection c)
256 ZOOM_task task = c->tasks;
260 c->tasks = task->next;
263 case ZOOM_TASK_SEARCH:
264 ZOOM_resultset_destroy(task->u.search.resultset);
265 xfree(task->u.search.syntax);
266 xfree(task->u.search.elementSetName);
268 case ZOOM_TASK_RETRIEVE:
269 ZOOM_resultset_destroy(task->u.retrieve.resultset);
270 xfree(task->u.retrieve.syntax);
271 xfree(task->u.retrieve.elementSetName);
273 case ZOOM_TASK_CONNECT:
276 ZOOM_scanset_destroy(task->u.scan.scan);
278 case ZOOM_TASK_PACKAGE:
279 ZOOM_package_destroy(task->u.package);
282 ZOOM_resultset_destroy(task->u.sort.resultset);
283 ZOOM_query_destroy(task->u.sort.q);
292 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
293 ZOOM_connection_put_event(c, event);
298 static int ZOOM_connection_exec_task(ZOOM_connection c);
300 void ZOOM_connection_remove_tasks(ZOOM_connection c)
303 ZOOM_connection_remove_task(c);
306 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
308 const char *elementSetName);
310 ZOOM_API(ZOOM_connection)
311 ZOOM_connection_create(ZOOM_options options)
313 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
317 yaz_log(log_api, "%p ZOOM_connection_create", c);
319 c->proto = PROTO_Z3950;
323 c->state = STATE_IDLE;
326 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
333 c->options = ZOOM_options_create_with_parent(options);
339 c->charset = c->lang = 0;
346 c->odr_in = odr_createmem(ODR_DECODE);
347 c->odr_out = odr_createmem(ODR_ENCODE);
350 c->support_named_resultsets = 0;
351 c->last_event = ZOOM_EVENT_NONE;
353 c->m_queue_front = 0;
359 /* set database names. Take local databases (if set); otherwise
360 take databases given in ZURL (if set); otherwise use Default */
361 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
364 char **databaseNames;
365 const char *cp = ZOOM_options_get(options, "databaseName");
367 if ((!cp || !*cp) && con->host_port)
369 if (strncmp(con->host_port, "unix:", 5) == 0)
370 cp = strchr(con->host_port+5, ':');
372 cp = strchr(con->host_port, '/');
378 nmem_strsplit(odr->mem, "+", cp, &databaseNames, num);
379 return databaseNames;
382 ZOOM_API(ZOOM_connection)
383 ZOOM_connection_new(const char *host, int portnum)
385 ZOOM_connection c = ZOOM_connection_create(0);
387 ZOOM_connection_connect(c, host, portnum);
391 static zoom_sru_mode get_sru_mode_from_string(const char *s)
394 return zoom_sru_soap;
395 if (!yaz_matchstr(s, "soap"))
396 return zoom_sru_soap;
397 else if (!yaz_matchstr(s, "get"))
399 else if (!yaz_matchstr(s, "post"))
400 return zoom_sru_post;
401 return zoom_sru_error;
405 ZOOM_connection_connect(ZOOM_connection c,
406 const char *host, int portnum)
413 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
416 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
417 ZOOM_connection_remove_tasks(c);
421 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
425 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
427 val = ZOOM_options_get(c->options, "proxy");
430 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
431 c->proxy = xstrdup(val);
437 val = ZOOM_options_get(c->options, "charset");
440 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
441 c->charset = xstrdup(val);
447 val = ZOOM_options_get(c->options, "lang");
450 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
451 c->lang = xstrdup(val);
460 sprintf(hostn, "%.80s:%d", host, portnum);
461 c->host_port = xstrdup(hostn);
464 c->host_port = xstrdup(host);
468 * If the "<scheme>:" part of the host string is preceded by one
469 * or more comma-separated <name>=<value> pairs, these are taken
470 * to be options to be set on the connection object. Among other
471 * applications, this facility can be used to embed authentication
473 * user=admin,password=secret,tcp:localhost:9999
475 char *remainder = c->host_port;
476 char *pcolon = strchr(remainder, ':');
479 while ((pcomma = strchr(remainder, ',')) != 0 &&
480 (pcolon == 0 || pcomma < pcolon)) {
482 if ((pequals = strchr(remainder, '=')) != 0) {
484 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
485 ZOOM_connection_option_set(c, remainder, pequals+1);
487 remainder = pcomma+1;
490 if (remainder != c->host_port) {
492 c->host_port = xstrdup(remainder);
493 /*printf("# reset hp='%s'\n", remainder);*/
497 val = ZOOM_options_get(c->options, "sru");
498 c->sru_mode = get_sru_mode_from_string(val);
500 ZOOM_options_set(c->options, "host", c->host_port);
502 val = ZOOM_options_get(c->options, "cookie");
505 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
506 c->cookie_out = xstrdup(val);
509 val = ZOOM_options_get(c->options, "clientIP");
512 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
514 c->client_IP = xstrdup(val);
517 c->async = ZOOM_options_get_bool(c->options, "async", 0);
518 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
520 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
524 while (ZOOM_event(1, &c))
530 ZOOM_query_create(void)
532 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
534 yaz_log(log_details, "%p ZOOM_query_create", s);
538 s->odr = odr_createmem(ODR_ENCODE);
545 ZOOM_query_destroy(ZOOM_query s)
551 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
552 if (s->refcount == 0)
560 ZOOM_query_prefix(ZOOM_query s, const char *str)
562 s->query_string = odr_strdup(s->odr, str);
563 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
564 s->z_query->which = Z_Query_type_1;
565 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
566 if (!s->z_query->u.type_1)
568 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
572 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
577 ZOOM_query_cql(ZOOM_query s, const char *str)
581 s->query_string = odr_strdup(s->odr, str);
583 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
584 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
585 ext->indirect_reference = 0;
587 ext->which = Z_External_CQL;
588 ext->u.cql = s->query_string;
590 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
591 s->z_query->which = Z_Query_type_104;
592 s->z_query->u.type_104 = ext;
594 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
600 * Translate the CQL string client-side into RPN which is passed to
601 * the server. This is useful for server's that don't themselves
602 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
603 * only as a place to stash diagnostics if compilation fails; if this
604 * information is not needed, a null pointer may be used.
607 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
611 ZOOM_connection freeme = 0;
613 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
615 conn = freeme = ZOOM_connection_create(0);
617 rpn = cql2pqf(conn, str);
619 ZOOM_connection_destroy(freeme);
623 ret = ZOOM_query_prefix(s, rpn);
629 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
630 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
631 * to the server, as the YAZ GFS doesn't know how to handle this.
634 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
635 int *ccl_error, const char **error_string,
639 struct ccl_rpn_node *rpn;
640 CCL_bibset bibset = ccl_qual_mk();
643 ccl_qual_buf(bibset, config);
645 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
648 *error_string = ccl_err_msg(*ccl_error);
653 WRBUF wr = wrbuf_alloc();
656 ret = ZOOM_query_prefix(s, wrbuf_buf(wr));
659 ccl_qual_rm(&bibset);
664 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
666 s->sort_spec = yaz_sort_spec(s->odr, criteria);
669 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
673 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
677 static zoom_ret do_write(ZOOM_connection c);
680 ZOOM_connection_destroy(ZOOM_connection c)
685 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
688 for (r = c->resultsets; r; r = r->next)
694 odr_destroy(c->odr_in);
695 odr_destroy(c->odr_out);
696 ZOOM_options_destroy(c->options);
697 ZOOM_connection_remove_tasks(c);
703 xfree(c->cookie_out);
709 void ZOOM_resultset_addref(ZOOM_resultset r)
714 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
719 ZOOM_resultset ZOOM_resultset_create(void)
722 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
726 yaz_log(log_details, "%p ZOOM_resultset_create", r);
729 r->odr = odr_createmem(ODR_ENCODE);
734 for (i = 0; i<RECORD_HASH_SIZE; i++)
735 r->record_hash[i] = 0;
740 r->databaseNames = 0;
741 r->num_databaseNames = 0;
745 ZOOM_API(ZOOM_resultset)
746 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
749 ZOOM_query s = ZOOM_query_create();
751 ZOOM_query_prefix(s, q);
753 r = ZOOM_connection_search(c, s);
754 ZOOM_query_destroy(s);
758 ZOOM_API(ZOOM_resultset)
759 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
761 ZOOM_resultset r = ZOOM_resultset_create();
765 const char *syntax, *elementSetName;
767 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
768 r->r_sort_spec = q->sort_spec;
771 r->options = ZOOM_options_create_with_parent(c->options);
773 start = ZOOM_options_get_int(r->options, "start", 0);
774 count = ZOOM_options_get_int(r->options, "count", 0);
776 /* If "presentChunk" is defined use that; otherwise "step" */
777 const char *cp = ZOOM_options_get(r->options, "presentChunk");
778 r->step = ZOOM_options_get_int(r->options,
779 (cp != 0 ? "presentChunk": "step"), 0);
781 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
782 cp = ZOOM_options_get(r->options, "setname");
784 r->setname = xstrdup(cp);
785 cp = ZOOM_options_get(r->options, "schema");
787 r->schema = xstrdup(cp);
789 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
794 r->next = c->resultsets;
797 if (c->host_port && c->proto == PROTO_HTTP)
801 yaz_log(log_details, "ZOOM_connection_search: no comstack");
802 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
806 yaz_log(log_details, "ZOOM_connection_search: reconnect");
811 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
812 task->u.search.resultset = r;
813 task->u.search.start = start;
814 task->u.search.count = count;
816 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
817 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
818 elementSetName = ZOOM_options_get(r->options, "elementSetName");
819 task->u.search.elementSetName = elementSetName
820 ? xstrdup(elementSetName) : 0;
822 ZOOM_resultset_addref(r);
828 while (ZOOM_event(1, &c))
835 * This is the old result-set sorting API, which is maintained only
836 * for the sake of binary compatibility. There is no reason ever to
837 * use this rather than ZOOM_resultset_sort1().
840 ZOOM_resultset_sort(ZOOM_resultset r,
841 const char *sort_type, const char *sort_spec)
843 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
847 ZOOM_resultset_sort1(ZOOM_resultset r,
848 const char *sort_type, const char *sort_spec)
850 ZOOM_connection c = r->connection;
854 newq = ZOOM_query_create();
855 if (ZOOM_query_sortby(newq, sort_spec) < 0)
858 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
859 r, r, sort_type, sort_spec);
863 if (c->host_port && c->proto == PROTO_HTTP)
867 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
868 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
872 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
878 ZOOM_resultset_cache_reset(r);
879 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
880 task->u.sort.resultset = r;
881 task->u.sort.q = newq;
883 ZOOM_resultset_addref(r);
887 while (ZOOM_event(1, &c))
895 ZOOM_resultset_cache_reset(ZOOM_resultset r)
898 for (i = 0; i<RECORD_HASH_SIZE; i++)
900 ZOOM_record_cache rc;
901 for (rc = r->record_hash[i]; rc; rc = rc->next)
903 if (rc->rec.wrbuf_marc)
904 wrbuf_free(rc->rec.wrbuf_marc, 1);
905 if (rc->rec.wrbuf_iconv)
906 wrbuf_free(rc->rec.wrbuf_iconv, 1);
907 if (rc->rec.wrbuf_opac)
908 wrbuf_free(rc->rec.wrbuf_opac, 1);
910 r->record_hash[i] = 0;
915 ZOOM_resultset_destroy(ZOOM_resultset r)
920 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
922 if (r->refcount == 0)
924 ZOOM_resultset_cache_reset(r);
928 /* remove ourselves from the resultsets in connection */
929 ZOOM_resultset *rp = &r->connection->resultsets;
932 assert(*rp); /* we must be in this list!! */
934 { /* OK, we're here - take us out of it */
941 ZOOM_query_destroy(r->query);
942 ZOOM_options_destroy(r->options);
951 ZOOM_resultset_size(ZOOM_resultset r)
953 yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
958 static void do_close(ZOOM_connection c)
964 c->state = STATE_IDLE;
967 static int ZOOM_test_reconnect(ZOOM_connection c)
969 if (!c->reconnect_ok)
973 c->tasks->running = 0;
974 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
978 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
979 int force_sync, int start, int count)
984 const char *syntax, *elementSetName;
988 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
989 " count=%d", r, force_sync, start, count);
994 if (c->host_port && c->proto == PROTO_HTTP)
998 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
999 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1003 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1005 c->reconnect_ok = 1;
1008 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1009 task->u.retrieve.resultset = r;
1010 task->u.retrieve.start = start;
1011 task->u.retrieve.count = count;
1013 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1014 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1015 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1016 task->u.retrieve.elementSetName = elementSetName
1017 ? xstrdup(elementSetName) : 0;
1019 cp = ZOOM_options_get(r->options, "schema");
1022 if (!r->schema || strcmp(r->schema, cp))
1025 r->schema = xstrdup(cp);
1029 ZOOM_resultset_addref(r);
1031 if (!r->connection->async || force_sync)
1032 while (r->connection && ZOOM_event(1, &r->connection))
1037 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1038 size_t start, size_t count)
1040 int force_present = 0;
1044 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1045 r, r, (long) start, (long) count);
1048 ZOOM_resultset_retrieve(r, force_present, start, count);
1052 for (i = 0; i< count; i++)
1053 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1057 static void get_cert(ZOOM_connection c)
1062 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1064 ZOOM_connection_option_setl(c, "sslPeerCert",
1065 cert_buf, cert_len);
1070 static zoom_ret do_connect(ZOOM_connection c)
1073 const char *effective_host;
1076 effective_host = c->proxy;
1078 effective_host = c->host_port;
1080 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1084 c->cs = cs_create_host(effective_host, 0, &add);
1086 if (c->cs && c->cs->protocol == PROTO_HTTP)
1089 const char *path = 0;
1091 c->proto = PROTO_HTTP;
1092 cs_get_host_args(c->host_port, &path);
1094 c->path = (char*) xmalloc(strlen(path)+2);
1096 strcpy(c->path+1, path);
1098 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1100 return zoom_complete;
1105 int ret = cs_connect(c->cs, add);
1108 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1109 ZOOM_connection_put_event(c, event);
1111 if (c->proto == PROTO_Z3950)
1112 ZOOM_connection_send_init(c);
1115 /* no init request for SRW .. */
1116 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1117 ZOOM_connection_remove_task(c);
1119 ZOOM_connection_exec_task(c);
1121 c->state = STATE_ESTABLISHED;
1122 return zoom_pending;
1126 c->state = STATE_CONNECTING;
1127 c->mask = ZOOM_SELECT_EXCEPT;
1128 if (c->cs->io_pending & CS_WANT_WRITE)
1129 c->mask += ZOOM_SELECT_WRITE;
1130 if (c->cs->io_pending & CS_WANT_READ)
1131 c->mask += ZOOM_SELECT_READ;
1132 return zoom_pending;
1135 c->state = STATE_IDLE;
1136 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1137 return zoom_complete;
1140 int z3950_connection_socket(ZOOM_connection c)
1143 return cs_fileno(c->cs);
1147 int z3950_connection_mask(ZOOM_connection c)
1154 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1157 for (i = 0; i<200; i++)
1160 Z_OtherInformation **oi;
1166 sprintf(buf, "otherInfo%d", i);
1167 val = ZOOM_options_get(c->options, buf);
1170 cp = strchr(val, ':');
1174 if (len >= sizeof(buf))
1175 len = sizeof(buf)-1;
1176 memcpy(buf, val, len);
1178 oidval = oid_getvalbyname(buf);
1179 if (oidval == VAL_NONE)
1182 yaz_oi_APDU(a, &oi);
1183 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1187 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1192 Z_OtherInformation **oi;
1193 yaz_oi_APDU(a, &oi);
1194 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1198 Z_OtherInformation **oi;
1199 yaz_oi_APDU(a, &oi);
1200 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1202 otherInfo_attach(c, a, out);
1203 if (!z_APDU(out, &a, 0, 0))
1205 FILE *outf = fopen("/tmp/apdu.txt", "a");
1208 ODR odr_pr = odr_createmem(ODR_PRINT);
1209 fprintf(outf, "a=%p\n", a);
1210 odr_setprint(odr_pr, outf);
1211 z_APDU(odr_pr, &a, 0, 0);
1212 odr_destroy(odr_pr);
1214 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1215 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1219 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1223 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1227 if (encode_APDU(c, a, c->odr_out))
1228 return zoom_complete;
1229 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1230 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1231 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1232 ZOOM_connection_put_event(c, event);
1233 odr_reset(c->odr_out);
1237 /* returns 1 if PDU was sent OK (still pending )
1238 0 if PDU was not sent OK (nothing to wait for)
1241 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1243 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1244 Z_InitRequest *ireq = apdu->u.initRequest;
1245 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1246 odr_malloc(c->odr_out, sizeof(*auth));
1247 const char *auth_groupId = ZOOM_options_get(c->options, "group");
1248 const char *auth_userId = ZOOM_options_get(c->options, "user");
1249 const char *auth_password = ZOOM_options_get(c->options, "password");
1252 /* support the pass for backwards compatibility */
1254 auth_password = ZOOM_options_get(c->options, "pass");
1256 ODR_MASK_SET(ireq->options, Z_Options_search);
1257 ODR_MASK_SET(ireq->options, Z_Options_present);
1258 ODR_MASK_SET(ireq->options, Z_Options_scan);
1259 ODR_MASK_SET(ireq->options, Z_Options_sort);
1260 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1261 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1263 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1264 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1265 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1267 /* Index Data's Z39.50 Implementor Id is 81 */
1268 ireq->implementationId =
1269 odr_prepend(c->odr_out,
1270 ZOOM_options_get(c->options, "implementationId"),
1271 odr_prepend(c->odr_out, "81", ireq->implementationId));
1273 ireq->implementationName =
1274 odr_prepend(c->odr_out,
1275 ZOOM_options_get(c->options, "implementationName"),
1276 odr_prepend(c->odr_out, "ZOOM-C",
1277 ireq->implementationName));
1279 version = odr_strdup(c->odr_out, "$Revision: 1.103 $");
1280 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1281 version[strlen(version)-2] = '\0';
1282 ireq->implementationVersion =
1283 odr_prepend(c->odr_out,
1284 ZOOM_options_get(c->options, "implementationVersion"),
1285 odr_prepend(c->odr_out, &version[11],
1286 ireq->implementationVersion));
1288 *ireq->maximumRecordSize =
1289 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
1290 *ireq->preferredMessageSize =
1291 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
1293 if (auth_groupId || auth_password)
1295 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1298 if (auth_groupId && *auth_groupId)
1300 pass->groupId = (char *)
1301 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1302 strcpy(pass->groupId, auth_groupId);
1306 if (auth_userId && *auth_userId)
1308 pass->userId = (char *)
1309 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1310 strcpy(pass->userId, auth_userId);
1314 if (auth_password && *auth_password)
1316 pass->password = (char *)
1317 odr_malloc(c->odr_out, strlen(auth_password)+1);
1318 strcpy(pass->password, auth_password);
1323 auth->which = Z_IdAuthentication_idPass;
1324 auth->u.idPass = pass;
1325 ireq->idAuthentication = auth;
1328 else if (auth_userId)
1330 auth->which = Z_IdAuthentication_open;
1331 auth->u.open = (char *)
1332 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1333 strcpy(auth->u.open, auth_userId);
1334 ireq->idAuthentication = auth;
1337 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1338 VAL_PROXY, 1, c->host_port);
1339 if (c->charset || c->lang)
1341 Z_OtherInformation **oi;
1342 Z_OtherInformationUnit *oi_unit;
1344 yaz_oi_APDU(apdu, &oi);
1346 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1348 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1349 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1350 oi_unit->information.externallyDefinedInfo =
1351 yaz_set_proposal_charneg_list(c->odr_out, " ",
1352 c->charset, c->lang, 1);
1356 return send_APDU(c, apdu);
1360 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1365 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1367 if (c->sru_mode == zoom_sru_get)
1369 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1371 else if (c->sru_mode == zoom_sru_post)
1373 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1375 else if (c->sru_mode == zoom_sru_soap)
1377 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1379 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1380 return zoom_complete;
1381 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1383 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1384 ZOOM_connection_put_event(c, event);
1385 odr_reset(c->odr_out);
1391 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1395 ZOOM_resultset resultset = 0;
1397 const char *option_val = 0;
1399 if (c->error) /* don't continue on error */
1400 return zoom_complete;
1402 switch(c->tasks->which)
1404 case ZOOM_TASK_SEARCH:
1405 resultset = c->tasks->u.search.resultset;
1406 resultset->setname = xstrdup("default");
1407 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1408 start = &c->tasks->u.search.start;
1409 count = &c->tasks->u.search.count;
1411 case ZOOM_TASK_RETRIEVE:
1412 resultset = c->tasks->u.retrieve.resultset;
1414 start = &c->tasks->u.retrieve.start;
1415 count = &c->tasks->u.retrieve.count;
1417 if (*start >= resultset->size)
1418 return zoom_complete;
1419 if (*start + *count > resultset->size)
1420 *count = resultset->size - *start;
1422 for (i = 0; i < *count; i++)
1425 record_cache_lookup(resultset, i + *start,
1426 c->tasks->u.retrieve.syntax,
1427 c->tasks->u.retrieve.elementSetName);
1432 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1433 ZOOM_connection_put_event(c, event);
1440 return zoom_complete;
1443 return zoom_complete;
1445 assert(resultset->query);
1447 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1449 if (resultset->query->z_query->which == Z_Query_type_104
1450 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1452 sr->u.request->query_type = Z_SRW_query_type_cql;
1453 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1455 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1456 resultset->query->z_query->u.type_1)
1458 sr->u.request->query_type = Z_SRW_query_type_pqf;
1459 sr->u.request->query.pqf = resultset->query->query_string;
1463 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1464 return zoom_complete;
1466 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1467 sr->u.request->maximumRecords = odr_intdup(
1468 c->odr_out, resultset->step>0 ? resultset->step : *count);
1469 sr->u.request->recordSchema = resultset->schema;
1471 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1473 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1475 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1477 sr->extra_args = odr_strdup(c->odr_out, option_val);
1478 return send_srw(c, sr);
1481 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1483 return zoom_complete;
1487 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1490 int lslb, ssub, mspn;
1492 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1493 Z_SearchRequest *search_req = apdu->u.searchRequest;
1494 const char *elementSetName;
1495 const char *smallSetElementSetName;
1496 const char *mediumSetElementSetName;
1499 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1501 r = c->tasks->u.search.resultset;
1503 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1506 ZOOM_options_get(r->options, "elementSetName");
1507 smallSetElementSetName =
1508 ZOOM_options_get(r->options, "smallSetElementSetName");
1509 mediumSetElementSetName =
1510 ZOOM_options_get(r->options, "mediumSetElementSetName");
1512 if (!smallSetElementSetName)
1513 smallSetElementSetName = elementSetName;
1515 if (!mediumSetElementSetName)
1516 mediumSetElementSetName = elementSetName;
1521 /* prepare query for the search request */
1522 search_req->query = r->query->z_query;
1523 if (!search_req->query)
1525 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1526 return zoom_complete;
1529 search_req->databaseNames = r->databaseNames;
1530 search_req->num_databaseNames = r->num_databaseNames;
1532 /* get syntax (no need to provide unless piggyback is in effect) */
1533 syntax = c->tasks->u.search.syntax;
1535 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1536 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1537 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1538 if (lslb != -1 && ssub != -1 && mspn != -1)
1540 /* So're a Z39.50 expert? Let's hope you don't do sort */
1541 *search_req->largeSetLowerBound = lslb;
1542 *search_req->smallSetUpperBound = ssub;
1543 *search_req->mediumSetPresentNumber = mspn;
1545 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1546 && r->piggyback && !r->r_sort_spec && !r->schema)
1548 /* Regular piggyback - do it unless we're going to do sort */
1549 *search_req->largeSetLowerBound = 2000000000;
1550 *search_req->smallSetUpperBound = 1;
1551 *search_req->mediumSetPresentNumber =
1552 r->step>0 ? r->step : c->tasks->u.search.count;
1556 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1557 smallSetElementSetName = 0;
1558 mediumSetElementSetName = 0;
1561 if (smallSetElementSetName && *smallSetElementSetName)
1563 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1564 odr_malloc(c->odr_out, sizeof(*esn));
1566 esn->which = Z_ElementSetNames_generic;
1567 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1568 search_req->smallSetElementSetNames = esn;
1570 if (mediumSetElementSetName && *mediumSetElementSetName)
1572 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1573 odr_malloc(c->odr_out, sizeof(*esn));
1575 esn->which = Z_ElementSetNames_generic;
1576 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1577 search_req->mediumSetElementSetNames = esn;
1580 search_req->preferredRecordSyntax =
1581 yaz_str_to_z3950oid(c->odr_out, CLASS_RECSYN, syntax);
1585 if (c->support_named_resultsets)
1589 /* find the lowest unused ordinal so that we re-use
1590 result sets on the server. */
1591 for (ord = 1; ; ord++)
1594 sprintf(setname, "%d", ord);
1595 for (rp = c->resultsets; rp; rp = rp->next)
1596 if (rp->setname && !strcmp(rp->setname, setname))
1601 r->setname = xstrdup(setname);
1602 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1603 "set %s", c, r->setname);
1607 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1609 r->setname = xstrdup("default");
1611 ZOOM_options_set(r->options, "setname", r->setname);
1613 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1614 return send_APDU(c, apdu);
1617 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1624 case Z_DefaultDiagFormat_v2Addinfo:
1625 addinfo = r->u.v2Addinfo;
1627 case Z_DefaultDiagFormat_v3Addinfo:
1628 addinfo = r->u.v3Addinfo;
1633 set_dset_error(c, *r->condition,
1634 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1638 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1640 if (p->which != Z_DiagRec_defaultFormat)
1641 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1643 response_default_diag(c, p->u.defaultFormat);
1646 ZOOM_API(ZOOM_record)
1647 ZOOM_record_clone(ZOOM_record srec)
1654 odr_enc = odr_createmem(ODR_ENCODE);
1655 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1657 buf = odr_getbuf(odr_enc, &size, 0);
1659 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1660 nrec->odr = odr_createmem(ODR_DECODE);
1661 nrec->wrbuf_marc = 0;
1662 nrec->wrbuf_iconv = 0;
1663 nrec->wrbuf_opac = 0;
1664 odr_setbuf(nrec->odr, buf, size, 0);
1665 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1667 odr_destroy(odr_enc);
1671 ZOOM_API(ZOOM_record)
1672 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1674 const char *syntax =
1675 ZOOM_options_get(s->options, "preferredRecordSyntax");
1676 const char *elementSetName =
1677 ZOOM_options_get(s->options, "elementSetName");
1679 return record_cache_lookup(s, pos, syntax, elementSetName);
1682 ZOOM_API(ZOOM_record)
1683 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1685 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1690 * MIKE: I think force_sync should always be zero, but I don't
1691 * want to make this change until I get the go-ahead from
1692 * Adam, in case something depends on the old synchronous
1696 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1697 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1698 rec = ZOOM_resultset_record_immediate(r, pos);
1704 ZOOM_record_destroy(ZOOM_record rec)
1708 if (rec->wrbuf_marc)
1709 wrbuf_free(rec->wrbuf_marc, 1);
1710 if (rec->wrbuf_iconv)
1711 wrbuf_free(rec->wrbuf_iconv, 1);
1712 if (rec->wrbuf_opac)
1713 wrbuf_free(rec->wrbuf_opac, 1);
1714 odr_destroy(rec->odr);
1718 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1720 const char *buf, int sz,
1721 const char *record_charset)
1726 yaz_marc_t mt = yaz_marc_create();
1729 strcpy(to, "UTF-8");
1730 if (record_charset && *record_charset)
1732 /* Use "from,to" or just "from" */
1733 const char *cp = strchr(record_charset, ',');
1734 int clen = strlen(record_charset);
1737 strncpy( to, cp+1, sizeof(to)-1);
1738 to[sizeof(to)-1] = '\0';
1739 clen = cp - record_charset;
1741 if (clen > sizeof(from)-1)
1742 clen = sizeof(from)-1;
1745 strncpy(from, record_charset, clen);
1751 cd = yaz_iconv_open(to, from);
1752 yaz_marc_iconv(mt, cd);
1755 yaz_marc_xml(mt, marc_type);
1756 if (!rec->wrbuf_marc)
1757 rec->wrbuf_marc = wrbuf_alloc();
1758 wrbuf_rewind(rec->wrbuf_marc);
1759 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1761 yaz_marc_destroy(mt);
1763 yaz_iconv_close(cd);
1765 *len = wrbuf_len(rec->wrbuf_marc);
1766 return wrbuf_buf(rec->wrbuf_marc);
1768 yaz_marc_destroy(mt);
1770 yaz_iconv_close(cd);
1774 static const char *record_iconv_return(ZOOM_record rec, int *len,
1775 const char *buf, int sz,
1776 const char *record_charset)
1783 strcpy(to, "UTF-8");
1784 if (record_charset && *record_charset)
1786 /* Use "from,to" or just "from" */
1787 const char *cp = strchr(record_charset, ',');
1788 int clen = strlen(record_charset);
1791 strncpy( to, cp+1, sizeof(to)-1);
1792 to[sizeof(to)-1] = '\0';
1793 clen = cp - record_charset;
1795 if (clen > sizeof(from)-1)
1796 clen = sizeof(from)-1;
1799 strncpy(from, record_charset, clen);
1803 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1806 size_t inbytesleft = sz;
1807 const char *inp = buf;
1809 if (!rec->wrbuf_iconv)
1810 rec->wrbuf_iconv = wrbuf_alloc();
1812 wrbuf_rewind(rec->wrbuf_iconv);
1816 size_t outbytesleft = sizeof(outbuf);
1817 char *outp = outbuf;
1818 size_t r = yaz_iconv(cd, (char**) &inp,
1820 &outp, &outbytesleft);
1821 if (r == (size_t) (-1))
1823 int e = yaz_iconv_error(cd);
1824 if (e != YAZ_ICONV_E2BIG)
1827 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1829 wrbuf_puts(rec->wrbuf_iconv, "");
1830 buf = wrbuf_buf(rec->wrbuf_iconv);
1831 sz = wrbuf_len(rec->wrbuf_iconv);
1832 yaz_iconv_close(cd);
1840 ZOOM_record_error(ZOOM_record rec, const char **cp,
1841 const char **addinfo, const char **diagset)
1843 Z_NamePlusRecord *npr;
1848 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1850 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1851 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1852 const char *add = 0;
1854 if (diag_rec->which == Z_DiagRec_defaultFormat)
1856 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1859 error = *ddf->condition;
1862 case Z_DefaultDiagFormat_v2Addinfo:
1863 add = ddf->u.v2Addinfo;
1865 case Z_DefaultDiagFormat_v3Addinfo:
1866 add = ddf->u.v3Addinfo;
1870 *diagset = yaz_z3950oid_to_str(ddf->diagnosticSetId, &oclass);
1878 *addinfo = add ? add : "";
1880 *cp = diagbib1_str(error);
1886 ZOOM_API(const char *)
1887 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1894 Z_NamePlusRecord *npr;
1897 *len = 0; /* default return */
1906 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1908 if (cp[i] == ';' || cp[i] == ' ')
1914 while (type_spec[i] == ';')
1917 while (type_spec[i] == ' ')
1919 if (!strncmp(type_spec+i, "charset=", 8))
1922 i = i + 8; /* skip charset= */
1923 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1925 if (type_spec[i] == ';' || type_spec[i] == ' ')
1931 else if (!strncmp(type_spec+i, "xpath=", 6))
1935 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1939 while (type_spec[i] == ' ')
1942 if (!strcmp(type, "database"))
1945 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1946 return npr->databaseName;
1948 else if (!strcmp(type, "syntax"))
1950 const char *desc = 0;
1951 if (npr->which == Z_NamePlusRecord_databaseRecord)
1953 Z_External *r = (Z_External *) npr->u.databaseRecord;
1954 oident *ent = oid_getentbyoid(r->direct_reference);
1961 *len = strlen(desc);
1964 if (npr->which != Z_NamePlusRecord_databaseRecord)
1967 /* from now on - we have a database record .. */
1968 if (!strcmp(type, "render"))
1970 Z_External *r = (Z_External *) npr->u.databaseRecord;
1971 oident *ent = oid_getentbyoid(r->direct_reference);
1973 /* render bibliographic record .. */
1974 if (r->which == Z_External_OPAC)
1976 r = r->u.opac->bibliographicRecord;
1979 ent = oid_getentbyoid(r->direct_reference);
1981 if (r->which == Z_External_sutrs)
1982 return record_iconv_return(rec, len,
1983 (char*) r->u.sutrs->buf,
1986 else if (r->which == Z_External_octet)
1988 const char *ret_buf;
1996 case VAL_APPLICATION_XML:
1999 ret_buf = marc_iconv_return(
2000 rec, YAZ_MARC_LINE, len,
2001 (const char *) r->u.octet_aligned->buf,
2002 r->u.octet_aligned->len,
2007 return record_iconv_return(rec, len,
2008 (const char *) r->u.octet_aligned->buf,
2009 r->u.octet_aligned->len,
2012 else if (r->which == Z_External_grs1)
2014 if (!rec->wrbuf_marc)
2015 rec->wrbuf_marc = wrbuf_alloc();
2016 wrbuf_rewind(rec->wrbuf_marc);
2017 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
2018 return record_iconv_return(rec, len,
2019 wrbuf_buf(rec->wrbuf_marc),
2020 wrbuf_len(rec->wrbuf_marc),
2025 else if (!strcmp(type, "xml"))
2027 Z_External *r = (Z_External *) npr->u.databaseRecord;
2028 oident *ent = oid_getentbyoid(r->direct_reference);
2030 /* render bibliographic record .. */
2031 if (r->which == Z_External_OPAC)
2033 r = r->u.opac->bibliographicRecord;
2036 ent = oid_getentbyoid(r->direct_reference);
2039 if (r->which == Z_External_sutrs)
2040 return record_iconv_return(rec, len,
2041 (const char *) r->u.sutrs->buf,
2044 else if (r->which == Z_External_octet)
2046 const char *ret_buf;
2047 int marc_decode_type = YAZ_MARC_MARCXML;
2056 case VAL_APPLICATION_XML:
2059 ret_buf = marc_iconv_return(
2060 rec, marc_decode_type, len,
2061 (const char *) r->u.octet_aligned->buf,
2062 r->u.octet_aligned->len,
2067 return record_iconv_return(rec, len,
2068 (const char *) r->u.octet_aligned->buf,
2069 r->u.octet_aligned->len,
2072 else if (r->which == Z_External_grs1)
2079 else if (!strcmp(type, "raw"))
2081 Z_External *r = (Z_External *) npr->u.databaseRecord;
2083 if (r->which == Z_External_sutrs)
2085 if (len) *len = r->u.sutrs->len;
2086 return (const char *) r->u.sutrs->buf;
2088 else if (r->which == Z_External_octet)
2090 if (len) *len = r->u.octet_aligned->len;
2091 return (const char *) r->u.octet_aligned->buf;
2093 else /* grs-1, explain, OPAC, ... */
2096 return (const char *) npr->u.databaseRecord;
2100 else if (!strcmp (type, "ext"))
2103 return (const char *) npr->u.databaseRecord;
2105 else if (!strcmp (type, "opac"))
2108 Z_External *r = (Z_External *) npr->u.databaseRecord;
2109 if (r->which == Z_External_OPAC)
2111 if (!rec->wrbuf_opac)
2112 rec->wrbuf_opac = wrbuf_alloc();
2113 wrbuf_rewind(rec->wrbuf_opac);
2114 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2115 return record_iconv_return(rec, len,
2116 wrbuf_buf(rec->wrbuf_opac),
2117 wrbuf_len(rec->wrbuf_opac),
2124 static int strcmp_null(const char *v1, const char *v2)
2130 return strcmp(v1, v2);
2133 static size_t record_hash(int pos)
2137 return pos % RECORD_HASH_SIZE;
2140 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2142 const char *syntax, const char *elementSetName)
2144 ZOOM_record_cache rc;
2146 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2147 ZOOM_connection_put_event(r->connection, event);
2149 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2153 if (strcmp_null(r->schema, rc->schema))
2155 if (strcmp_null(elementSetName,rc->elementSetName))
2157 if (strcmp_null(syntax, rc->syntax))
2159 /* not destroying rc->npr (it's handled by nmem )*/
2161 /* keeping wrbuf_marc too */
2165 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2168 rc->rec.wrbuf_marc = 0;
2169 rc->rec.wrbuf_iconv = 0;
2170 rc->rec.wrbuf_opac = 0;
2172 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2174 rc->elementSetName = 0;
2177 rc->syntax = odr_strdup(r->odr, syntax);
2182 rc->schema = odr_strdup(r->odr, r->schema);
2187 rc->next = r->record_hash[record_hash(pos)];
2188 r->record_hash[record_hash(pos)] = rc;
2191 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2193 const char *elementSetName)
2195 ZOOM_record_cache rc;
2197 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2201 if (strcmp_null(r->schema, rc->schema))
2203 if (strcmp_null(elementSetName,rc->elementSetName))
2205 if (strcmp_null(syntax, rc->syntax))
2213 static void handle_records(ZOOM_connection c, Z_Records *sr,
2216 ZOOM_resultset resultset;
2218 const char *syntax = 0, *elementSetName = 0;
2222 switch (c->tasks->which)
2224 case ZOOM_TASK_SEARCH:
2225 resultset = c->tasks->u.search.resultset;
2226 start = &c->tasks->u.search.start;
2227 count = &c->tasks->u.search.count;
2228 syntax = c->tasks->u.search.syntax;
2229 elementSetName = c->tasks->u.search.elementSetName;
2231 case ZOOM_TASK_RETRIEVE:
2232 resultset = c->tasks->u.retrieve.resultset;
2233 start = &c->tasks->u.retrieve.start;
2234 count = &c->tasks->u.retrieve.count;
2235 syntax = c->tasks->u.retrieve.syntax;
2236 elementSetName = c->tasks->u.retrieve.elementSetName;
2241 if (sr && sr->which == Z_Records_NSD)
2242 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2243 else if (sr && sr->which == Z_Records_multipleNSD)
2245 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2246 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2248 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2252 if (*count + *start > resultset->size)
2253 *count = resultset->size - *start;
2256 if (sr && sr->which == Z_Records_DBOSD)
2259 NMEM nmem = odr_extract_mem(c->odr_in);
2260 Z_NamePlusRecordList *p =
2261 sr->u.databaseOrSurDiagnostics;
2262 for (i = 0; i<p->num_records; i++)
2264 record_cache_add(resultset, p->records[i], i + *start,
2265 syntax, elementSetName);
2271 yaz_log(log_details,
2272 "handle_records resultset=%p start=%d count=%d",
2273 resultset, *start, *count);
2275 /* transfer our response to search_nmem .. we need it later */
2276 nmem_transfer(resultset->odr->mem, nmem);
2278 if (present_phase && p->num_records == 0)
2280 /* present response and we didn't get any records! */
2281 Z_NamePlusRecord *myrec =
2282 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2283 record_cache_add(resultset, myrec, *start,
2284 syntax, elementSetName);
2287 else if (present_phase)
2289 /* present response and we didn't get any records! */
2290 Z_NamePlusRecord *myrec =
2291 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2292 record_cache_add(resultset, myrec, *start, syntax, elementSetName);
2297 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2299 handle_records(c, pr->records, 1);
2302 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2305 switch (term->which)
2307 case Z_Term_general:
2308 ZOOM_options_setl(opt, name,
2309 (const char *)(term->u.general->buf),
2310 term->u.general->len);
2312 case Z_Term_characterString:
2313 ZOOM_options_set(opt, name, term->u.characterString);
2315 case Z_Term_numeric:
2316 ZOOM_options_set_int(opt, name, *term->u.numeric);
2321 static void handle_queryExpression(ZOOM_options opt, const char *name,
2322 Z_QueryExpression *exp)
2328 case Z_QueryExpression_term:
2329 if (exp->u.term && exp->u.term->queryTerm)
2331 sprintf(opt_name, "%s.term", name);
2332 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2335 case Z_QueryExpression_query:
2340 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2341 Z_OtherInformation *o)
2344 for (i = 0; o && i < o->num_elements; i++)
2346 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2348 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2350 if (ext->which == Z_External_searchResult1)
2353 Z_SearchInfoReport *sr = ext->u.searchResult1;
2356 ZOOM_options_set_int(
2357 resultset->options, "searchresult.size", sr->num);
2359 for (j = 0; j < sr->num; j++)
2361 Z_SearchInfoReport_s *ent =
2362 ext->u.searchResult1->elements[j];
2365 sprintf(pref, "searchresult.%d", j);
2367 if (ent->subqueryId)
2370 sprintf(opt_name, "%s.id", pref);
2371 ZOOM_options_set(resultset->options, opt_name,
2374 if (ent->subqueryExpression)
2377 sprintf(opt_name, "%s.subquery", pref);
2378 handle_queryExpression(resultset->options, opt_name,
2379 ent->subqueryExpression);
2381 if (ent->subqueryInterpretation)
2384 sprintf(opt_name, "%s.interpretation", pref);
2385 handle_queryExpression(resultset->options, opt_name,
2386 ent->subqueryInterpretation);
2388 if (ent->subqueryRecommendation)
2391 sprintf(opt_name, "%s.recommendation", pref);
2392 handle_queryExpression(resultset->options, opt_name,
2393 ent->subqueryRecommendation);
2395 if (ent->subqueryCount)
2398 sprintf(opt_name, "%s.count", pref);
2399 ZOOM_options_set_int(resultset->options, opt_name,
2400 *ent->subqueryCount);
2408 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2410 ZOOM_resultset resultset;
2413 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2416 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2417 ZOOM_connection_put_event(c, event);
2419 resultset = c->tasks->u.search.resultset;
2421 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2423 resultset->size = *sr->resultCount;
2424 handle_records(c, sr->records, 0);
2427 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2429 if (res->diagnostics && res->num_diagnostics > 0)
2430 response_diag(c, res->diagnostics[0]);
2433 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2435 NMEM nmem = odr_extract_mem(c->odr_in);
2438 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2440 scan = c->tasks->u.scan.scan;
2442 if (res->entries && res->entries->nonsurrogateDiagnostics)
2443 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2444 scan->scan_response = res;
2445 nmem_transfer(scan->odr->mem, nmem);
2447 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2448 if (res->positionOfTerm)
2449 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2450 if (res->scanStatus)
2451 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2452 if (res->numberOfEntriesReturned)
2453 ZOOM_options_set_int(scan->options, "number",
2454 *res->numberOfEntriesReturned);
2459 static zoom_ret send_sort(ZOOM_connection c,
2460 ZOOM_resultset resultset)
2463 resultset->r_sort_spec = 0;
2464 if (resultset->r_sort_spec)
2466 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2467 Z_SortRequest *req = apdu->u.sortRequest;
2469 req->num_inputResultSetNames = 1;
2470 req->inputResultSetNames = (Z_InternationalString **)
2471 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2472 req->inputResultSetNames[0] =
2473 odr_strdup(c->odr_out, resultset->setname);
2474 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2475 req->sortSequence = resultset->r_sort_spec;
2476 resultset->r_sort_spec = 0;
2477 return send_APDU(c, apdu);
2479 return zoom_complete;
2482 static zoom_ret send_present(ZOOM_connection c)
2485 Z_PresentRequest *req = 0;
2487 const char *syntax = 0;
2488 const char *elementSetName = 0;
2489 ZOOM_resultset resultset;
2494 yaz_log(log_details, "%p send_present no tasks", c);
2495 return zoom_complete;
2498 switch (c->tasks->which)
2500 case ZOOM_TASK_SEARCH:
2501 resultset = c->tasks->u.search.resultset;
2502 start = &c->tasks->u.search.start;
2503 count = &c->tasks->u.search.count;
2504 syntax = c->tasks->u.search.syntax;
2505 elementSetName = c->tasks->u.search.elementSetName;
2507 case ZOOM_TASK_RETRIEVE:
2508 resultset = c->tasks->u.retrieve.resultset;
2509 start = &c->tasks->u.retrieve.start;
2510 count = &c->tasks->u.retrieve.count;
2511 syntax = c->tasks->u.retrieve.syntax;
2512 elementSetName = c->tasks->u.retrieve.elementSetName;
2515 return zoom_complete;
2517 yaz_log(log_details, "%p send_present start=%d count=%d",
2520 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2522 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2525 if (c->error) /* don't continue on error */
2526 return zoom_complete;
2527 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2528 resultset, *start, *count);
2530 for (i = 0; i < *count; i++)
2533 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2538 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2539 ZOOM_connection_put_event(c, event);
2547 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2548 return zoom_complete;
2551 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2552 req = apdu->u.presentRequest;
2555 yaz_log(log_details, "%p send_present skip=%d", c, i);
2557 *req->resultSetStartPoint = *start + 1;
2558 *req->numberOfRecordsRequested = resultset->step>0 ?
2559 resultset->step : *count;
2560 if (*req->numberOfRecordsRequested + *start > resultset->size)
2561 *req->numberOfRecordsRequested = resultset->size - *start;
2562 assert(*req->numberOfRecordsRequested > 0);
2564 if (syntax && *syntax)
2565 req->preferredRecordSyntax =
2566 yaz_str_to_z3950oid(c->odr_out, CLASS_RECSYN, syntax);
2568 if (resultset->schema && *resultset->schema)
2570 Z_RecordComposition *compo = (Z_RecordComposition *)
2571 odr_malloc(c->odr_out, sizeof(*compo));
2573 req->recordComposition = compo;
2574 compo->which = Z_RecordComp_complex;
2575 compo->u.complex = (Z_CompSpec *)
2576 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2577 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2578 odr_malloc(c->odr_out, sizeof(bool_t));
2579 *compo->u.complex->selectAlternativeSyntax = 0;
2581 compo->u.complex->generic = (Z_Specification *)
2582 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2584 compo->u.complex->generic->which = Z_Schema_oid;
2585 compo->u.complex->generic->schema.oid = (Odr_oid *)
2586 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2588 if (!compo->u.complex->generic->schema.oid)
2590 /* OID wasn't a schema! Try record syntax instead. */
2592 compo->u.complex->generic->schema.oid = (Odr_oid *)
2593 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2595 if (elementSetName && *elementSetName)
2597 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2598 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2599 compo->u.complex->generic->elementSpec->which =
2600 Z_ElementSpec_elementSetName;
2601 compo->u.complex->generic->elementSpec->u.elementSetName =
2602 odr_strdup(c->odr_out, elementSetName);
2605 compo->u.complex->generic->elementSpec = 0;
2606 compo->u.complex->num_dbSpecific = 0;
2607 compo->u.complex->dbSpecific = 0;
2608 compo->u.complex->num_recordSyntax = 0;
2609 compo->u.complex->recordSyntax = 0;
2611 else if (elementSetName && *elementSetName)
2613 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2614 odr_malloc(c->odr_out, sizeof(*esn));
2615 Z_RecordComposition *compo = (Z_RecordComposition *)
2616 odr_malloc(c->odr_out, sizeof(*compo));
2618 esn->which = Z_ElementSetNames_generic;
2619 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2620 compo->which = Z_RecordComp_simple;
2621 compo->u.simple = esn;
2622 req->recordComposition = compo;
2624 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2625 return send_APDU(c, apdu);
2628 ZOOM_API(ZOOM_scanset)
2629 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2632 ZOOM_query q = ZOOM_query_create();
2634 ZOOM_query_prefix(q, start);
2636 s = ZOOM_connection_scan1(c, q);
2637 ZOOM_query_destroy(q);
2642 ZOOM_API(ZOOM_scanset)
2643 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2647 ZOOM_scanset scan = 0;
2650 * We need to check the query-type, so we can recognise CQL and
2651 * CCL and compile them into a form that we can use here. The
2652 * ZOOM_query structure has no explicit `type' member, but
2653 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2654 * functions shows how the structure is set up in each case.
2658 else if (q->z_query->which == Z_Query_type_1)
2660 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2661 c, q, q->query_string);
2662 start = q->query_string;
2664 else if (q->z_query->which == Z_Query_type_104)
2666 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2667 c, q, q->query_string);
2668 start = freeme = cql2pqf(c, q->query_string);
2674 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2675 c, q, q->query_string);
2679 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2680 scan->connection = c;
2681 scan->odr = odr_createmem(ODR_DECODE);
2682 scan->options = ZOOM_options_create_with_parent(c->options);
2684 scan->scan_response = 0;
2685 scan->termListAndStartPoint =
2686 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2689 scan->databaseNames = set_DatabaseNames(c, c->options,
2690 &scan->num_databaseNames,
2692 if (scan->termListAndStartPoint != 0)
2694 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2695 task->u.scan.scan = scan;
2700 while (ZOOM_event(1, &c))
2708 ZOOM_scanset_destroy(ZOOM_scanset scan)
2713 if (scan->refcount == 0)
2715 odr_destroy(scan->odr);
2717 ZOOM_options_destroy(scan->options);
2722 static zoom_ret send_package(ZOOM_connection c)
2726 yaz_log(log_details, "%p send_package", c);
2728 return zoom_complete;
2729 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2731 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2732 ZOOM_connection_put_event(c, event);
2734 c->buf_out = c->tasks->u.package->buf_out;
2735 c->len_out = c->tasks->u.package->len_out;
2740 static zoom_ret send_scan(ZOOM_connection c)
2743 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2744 Z_ScanRequest *req = apdu->u.scanRequest;
2746 yaz_log(log_details, "%p send_scan", c);
2748 return zoom_complete;
2749 assert (c->tasks->which == ZOOM_TASK_SCAN);
2750 scan = c->tasks->u.scan.scan;
2752 req->termListAndStartPoint = scan->termListAndStartPoint;
2753 req->attributeSet = scan->attributeSet;
2755 *req->numberOfTermsRequested =
2756 ZOOM_options_get_int(scan->options, "number", 10);
2758 req->preferredPositionInResponse =
2759 odr_intdup(c->odr_out,
2760 ZOOM_options_get_int(scan->options, "position", 1));
2763 odr_intdup(c->odr_out,
2764 ZOOM_options_get_int(scan->options, "stepSize", 0));
2766 req->databaseNames = scan->databaseNames;
2767 req->num_databaseNames = scan->num_databaseNames;
2769 return send_APDU(c, apdu);
2773 ZOOM_scanset_size(ZOOM_scanset scan)
2775 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2777 return scan->scan_response->entries->num_entries;
2780 ZOOM_API(const char *)
2781 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2784 const char *term = 0;
2785 size_t noent = ZOOM_scanset_size(scan);
2786 Z_ScanResponse *res = scan->scan_response;
2792 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2794 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2796 if (t->term->which == Z_Term_general)
2798 term = (const char *) t->term->u.general->buf;
2799 *len = t->term->u.general->len;
2801 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2806 ZOOM_API(const char *)
2807 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2810 const char *term = 0;
2811 size_t noent = ZOOM_scanset_size(scan);
2812 Z_ScanResponse *res = scan->scan_response;
2818 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2820 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2824 term = t->displayTerm;
2825 *len = strlen(term);
2827 else if (t->term->which == Z_Term_general)
2829 term = (const char *) t->term->u.general->buf;
2830 *len = t->term->u.general->len;
2832 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2837 ZOOM_API(const char *)
2838 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2840 return ZOOM_options_get(scan->options, key);
2844 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2847 ZOOM_options_set(scan->options, key, val);
2850 static Z_APDU *create_es_package(ZOOM_package p, int type)
2853 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2854 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2856 *req->function = Z_ExtendedServicesRequest_create;
2858 str = ZOOM_options_get(p->options, "package-name");
2860 req->packageName = nmem_strdup(p->odr_out->mem, str);
2862 str = ZOOM_options_get(p->options, "user-id");
2864 req->userId = nmem_strdup(p->odr_out->mem, str);
2866 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2869 str = ZOOM_options_get(p->options, "function");
2872 if (!strcmp (str, "create"))
2874 if (!strcmp (str, "delete"))
2876 if (!strcmp (str, "modify"))
2882 static const char *ill_array_lookup(void *clientData, const char *idx)
2884 ZOOM_package p = (ZOOM_package) clientData;
2885 return ZOOM_options_get(p->options, idx+4);
2888 static Z_External *encode_ill_request(ZOOM_package p)
2890 ODR out = p->odr_out;
2893 struct ill_get_ctl ctl;
2895 ctl.odr = p->odr_out;
2897 ctl.f = ill_array_lookup;
2899 req = ill_get_ILLRequest(&ctl, "ill", 0);
2901 if (!ill_Request(out, &req, 0, 0))
2903 int ill_request_size;
2904 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2905 if (ill_request_buf)
2906 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2912 int illRequest_size = 0;
2913 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2915 oid.proto = PROTO_GENERAL;
2916 oid.oclass = CLASS_GENERAL;
2917 oid.value = VAL_ISO_ILL_1;
2919 r = (Z_External *) odr_malloc(out, sizeof(*r));
2920 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2921 r->indirect_reference = 0;
2923 r->which = Z_External_single;
2925 r->u.single_ASN1_type =
2926 odr_create_Odr_oct(out,
2927 (unsigned char *)illRequest_buf,
2933 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2935 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2938 req->which = Z_IOItemOrder_esRequest;
2939 req->u.esRequest = (Z_IORequest *)
2940 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2942 /* to keep part ... */
2943 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2944 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2945 req->u.esRequest->toKeep->supplDescription = 0;
2946 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2947 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2949 str = ZOOM_options_get(p->options, "contact-name");
2950 req->u.esRequest->toKeep->contact->name = str ?
2951 nmem_strdup(p->odr_out->mem, str) : 0;
2953 str = ZOOM_options_get(p->options, "contact-phone");
2954 req->u.esRequest->toKeep->contact->phone = str ?
2955 nmem_strdup(p->odr_out->mem, str) : 0;
2957 str = ZOOM_options_get(p->options, "contact-email");
2958 req->u.esRequest->toKeep->contact->email = str ?
2959 nmem_strdup(p->odr_out->mem, str) : 0;
2961 req->u.esRequest->toKeep->addlBilling = 0;
2963 /* not to keep part ... */
2964 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2965 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2967 str = ZOOM_options_get(p->options, "itemorder-setname");
2972 req->u.esRequest->notToKeep->resultSetItem = 0;
2975 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2976 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2978 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2979 nmem_strdup(p->odr_out->mem, str);
2980 req->u.esRequest->notToKeep->resultSetItem->item =
2981 (int *) odr_malloc(p->odr_out, sizeof(int));
2983 str = ZOOM_options_get(p->options, "itemorder-item");
2984 *req->u.esRequest->notToKeep->resultSetItem->item =
2985 (str ? atoi(str) : 1);
2987 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2992 Z_APDU *create_admin_package(ZOOM_package p, int type,
2993 Z_ESAdminOriginPartToKeep **toKeepP,
2994 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2996 Z_APDU *apdu = create_es_package(p, VAL_ADMINSERVICE);
2999 Z_ESAdminOriginPartToKeep *toKeep;
3000 Z_ESAdminOriginPartNotToKeep *notToKeep;
3001 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3002 const char *first_db = "Default";
3004 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3009 r->direct_reference =
3010 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3013 r->indirect_reference = 0;
3014 r->which = Z_External_ESAdmin;
3016 r->u.adminService = (Z_Admin *)
3017 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3018 r->u.adminService->which = Z_Admin_esRequest;
3019 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3020 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3022 toKeep = r->u.adminService->u.esRequest->toKeep =
3023 (Z_ESAdminOriginPartToKeep *)
3024 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3025 toKeep->which = type;
3026 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3027 toKeep->u.create = odr_nullval();
3028 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3030 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3031 (Z_ESAdminOriginPartNotToKeep *)
3032 odr_malloc(p->odr_out,
3033 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3034 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3035 notToKeep->u.recordsWillFollow = odr_nullval();
3039 *notToKeepP = notToKeep;
3044 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3046 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
3047 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3048 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3049 const char *doc = ZOOM_options_get(p->options, "doc");
3054 req->taskSpecificParameters = ext;
3055 ext->direct_reference = req->packageType;
3056 ext->descriptor = 0;
3057 ext->indirect_reference = 0;
3059 ext->which = Z_External_octet;
3060 ext->u.single_ASN1_type =
3061 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
3066 static Z_APDU *create_update_package(ZOOM_package p)
3069 const char *first_db = "Default";
3071 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3072 const char *action = ZOOM_options_get(p->options, "action");
3073 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
3074 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3075 const char *record_buf = ZOOM_options_get(p->options, "record");
3076 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3077 int syntax_oid = VAL_NONE;
3081 syntax_oid = oid_getvalbyname(syntax_str);
3084 record_buf = "void";
3085 syntax_oid = VAL_SUTRS;
3087 if (syntax_oid == VAL_NONE)
3088 syntax_oid = VAL_TEXT_XML;
3094 action = "specialUpdate";
3096 if (!strcmp(action, "recordInsert"))
3097 action_no = Z_IUOriginPartToKeep_recordInsert;
3098 else if (!strcmp(action, "recordReplace"))
3099 action_no = Z_IUOriginPartToKeep_recordReplace;
3100 else if (!strcmp(action, "recordDelete"))
3101 action_no = Z_IUOriginPartToKeep_recordDelete;
3102 else if (!strcmp(action, "elementUpdate"))
3103 action_no = Z_IUOriginPartToKeep_elementUpdate;
3104 else if (!strcmp(action, "specialUpdate"))
3105 action_no = Z_IUOriginPartToKeep_specialUpdate;
3109 apdu = create_es_package(p, VAL_DBUPDATE);
3112 Z_IUOriginPartToKeep *toKeep;
3113 Z_IUSuppliedRecords *notToKeep;
3114 Z_External *r = (Z_External *)
3115 odr_malloc(p->odr_out, sizeof(*r));
3117 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3119 r->direct_reference =
3120 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3123 r->which = Z_External_update;
3124 r->indirect_reference = 0;
3125 r->u.update = (Z_IUUpdate *)
3126 odr_malloc(p->odr_out, sizeof(*r->u.update));
3128 r->u.update->which = Z_IUUpdate_esRequest;
3129 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3130 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3131 toKeep = r->u.update->u.esRequest->toKeep =
3132 (Z_IUOriginPartToKeep *)
3133 odr_malloc(p->odr_out, sizeof(*toKeep));
3135 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3137 toKeep->elementSetName = 0;
3138 toKeep->actionQualifier = 0;
3139 toKeep->action = odr_intdup(p->odr_out, action_no);
3141 notToKeep = r->u.update->u.esRequest->notToKeep =
3142 (Z_IUSuppliedRecords *)
3143 odr_malloc(p->odr_out, sizeof(*notToKeep));
3145 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3146 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3147 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3148 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3149 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3152 notToKeep->elements[0]->u.opaque =
3153 odr_create_Odr_oct(p->odr_out,
3154 (const unsigned char *) recordIdOpaque,
3155 strlen(recordIdOpaque));
3157 else if (recordIdNumber)
3159 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3161 notToKeep->elements[0]->u.number =
3162 odr_intdup(p->odr_out, atoi(recordIdNumber));
3165 notToKeep->elements[0]->u.opaque = 0;
3166 notToKeep->elements[0]->supplementalId = 0;
3167 notToKeep->elements[0]->correlationInfo = 0;
3168 notToKeep->elements[0]->record =
3169 z_ext_record(p->odr_out, syntax_oid,
3170 record_buf, strlen(record_buf));
3174 ODR print = odr_createmem(ODR_PRINT);
3176 z_APDU(print, &apdu, 0, 0);
3183 ZOOM_package_send(ZOOM_package p, const char *type)
3190 odr_reset(p->odr_out);
3193 if (!strcmp(type, "itemorder"))
3195 apdu = create_es_package(p, VAL_ITEMORDER);
3198 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3200 r->direct_reference =
3201 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3204 r->which = Z_External_itemOrder;
3205 r->indirect_reference = 0;
3206 r->u.itemOrder = encode_item_order(p);
3208 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3211 else if (!strcmp(type, "create")) /* create database */
3213 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3216 else if (!strcmp(type, "drop")) /* drop database */
3218 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3221 else if (!strcmp(type, "commit")) /* commit changes */
3223 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3226 else if (!strcmp(type, "update")) /* update record(s) */
3228 apdu = create_update_package(p);
3230 else if (!strcmp(type, "xmlupdate"))
3232 apdu = create_xmlupdate_package(p);
3236 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3240 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3241 task->u.package = p;
3242 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3243 p->buf_out = (char *) xmalloc(p->len_out);
3244 memcpy(p->buf_out, buf, p->len_out);
3249 while (ZOOM_event(1, &c))
3256 ZOOM_API(ZOOM_package)
3257 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3259 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3262 p->odr_out = odr_createmem(ODR_ENCODE);
3263 p->options = ZOOM_options_create_with_parent2(options, c->options);
3271 ZOOM_package_destroy(ZOOM_package p)
3276 if (p->refcount == 0)
3278 odr_destroy(p->odr_out);
3281 ZOOM_options_destroy(p->options);
3286 ZOOM_API(const char *)
3287 ZOOM_package_option_get(ZOOM_package p, const char *key)
3289 return ZOOM_options_get(p->options, key);
3294 ZOOM_package_option_set(ZOOM_package p, const char *key,
3297 ZOOM_options_set(p->options, key, val);
3300 static int ZOOM_connection_exec_task(ZOOM_connection c)
3302 ZOOM_task task = c->tasks;
3303 zoom_ret ret = zoom_complete;
3307 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3308 c, task->which, task->running);
3309 if (c->error != ZOOM_ERROR_NONE)
3311 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3312 "removing tasks because of error = %d", c, c->error);
3313 ZOOM_connection_remove_tasks(c);
3318 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3319 "task already running", c);
3323 ret = zoom_complete;
3324 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3326 switch (task->which)
3328 case ZOOM_TASK_SEARCH:
3329 if (c->proto == PROTO_HTTP)
3330 ret = ZOOM_connection_srw_send_search(c);
3332 ret = ZOOM_connection_send_search(c);
3334 case ZOOM_TASK_RETRIEVE:
3335 if (c->proto == PROTO_HTTP)
3336 ret = ZOOM_connection_srw_send_search(c);
3338 ret = send_present(c);
3340 case ZOOM_TASK_CONNECT:
3341 ret = do_connect(c);
3343 case ZOOM_TASK_SCAN:
3346 case ZOOM_TASK_PACKAGE:
3347 ret = send_package(c);
3349 case ZOOM_TASK_SORT:
3350 c->tasks->u.sort.resultset->r_sort_spec =
3351 c->tasks->u.sort.q->sort_spec;
3352 ret = send_sort(c, c->tasks->u.sort.resultset);
3358 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3359 "remove tasks because no connection exist", c);
3360 ZOOM_connection_remove_tasks(c);
3362 if (ret == zoom_complete)
3364 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3365 "task removed (complete)", c);
3366 ZOOM_connection_remove_task(c);
3369 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3374 static zoom_ret send_sort_present(ZOOM_connection c)
3376 zoom_ret r = zoom_complete;
3378 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3379 r = send_sort(c, c->tasks->u.search.resultset);
3380 if (r == zoom_complete)
3381 r = send_present(c);
3385 static int es_response(ZOOM_connection c,
3386 Z_ExtendedServicesResponse *res)
3388 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3390 if (res->diagnostics && res->num_diagnostics > 0)
3391 response_diag(c, res->diagnostics[0]);
3392 if (res->taskPackage &&
3393 res->taskPackage->which == Z_External_extendedService)
3395 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3396 Odr_oct *id = taskPackage->targetReference;
3399 ZOOM_options_setl(c->tasks->u.package->options,
3400 "targetReference", (char*) id->buf, id->len);
3402 if (res->taskPackage &&
3403 res->taskPackage->which == Z_External_octet)
3405 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3406 ZOOM_options_setl(c->tasks->u.package->options,
3407 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3412 static void interpret_init_diag(ZOOM_connection c,
3413 Z_DiagnosticFormat *diag)
3417 Z_DiagnosticFormat_s *ds = diag->elements[0];
3418 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3419 response_default_diag(c, ds->u.defaultDiagRec);
3424 static void interpret_otherinformation_field(ZOOM_connection c,
3425 Z_OtherInformation *ui)
3428 for (i = 0; i < ui->num_elements; i++)
3430 Z_OtherInformationUnit *unit = ui->list[i];
3431 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3432 unit->information.externallyDefinedInfo &&
3433 unit->information.externallyDefinedInfo->which ==
3436 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3442 static void set_init_option(const char *name, void *clientData) {
3443 ZOOM_connection c = clientData;
3446 sprintf(buf, "init_opt_%.70s", name);
3447 ZOOM_connection_option_set(c, buf, "1");
3451 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3453 Z_InitResponse *initrs;
3456 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3459 case Z_APDU_initResponse:
3460 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3461 initrs = apdu->u.initResponse;
3462 ZOOM_connection_option_set(c, "serverImplementationId",
3463 initrs->implementationId ?
3464 initrs->implementationId : "");
3465 ZOOM_connection_option_set(c, "serverImplementationName",
3466 initrs->implementationName ?
3467 initrs->implementationName : "");
3468 ZOOM_connection_option_set(c, "serverImplementationVersion",
3469 initrs->implementationVersion ?
3470 initrs->implementationVersion : "");
3471 /* Set the three old options too, for old applications */
3472 ZOOM_connection_option_set(c, "targetImplementationId",
3473 initrs->implementationId ?
3474 initrs->implementationId : "");
3475 ZOOM_connection_option_set(c, "targetImplementationName",
3476 initrs->implementationName ?
3477 initrs->implementationName : "");
3478 ZOOM_connection_option_set(c, "targetImplementationVersion",
3479 initrs->implementationVersion ?
3480 initrs->implementationVersion : "");
3482 /* Make initrs->options available as ZOOM-level options */
3483 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3485 if (!*initrs->result)
3487 Z_External *uif = initrs->userInformationField;
3489 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3491 if (uif && uif->which == Z_External_userInfo1)
3492 interpret_otherinformation_field(c, uif->u.userInfo1);
3497 yaz_oi_get_string_oidval(&apdu->u.initResponse->otherInfo,
3499 xfree(c->cookie_in);
3502 c->cookie_in = xstrdup(cookie);
3503 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3504 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3505 c->support_named_resultsets = 1;
3508 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3509 ZOOM_connection_remove_task(c);
3511 ZOOM_connection_exec_task(c);
3513 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3515 NMEM tmpmem = nmem_create();
3516 Z_CharSetandLanguageNegotiation *p =
3517 yaz_get_charneg_record(initrs->otherInfo);
3521 char *charset = NULL, *lang = NULL;
3524 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3525 yaz_log(log_details, "%p recv_apdu target accepted: "
3526 "charset %s, language %s, select %d",
3528 charset ? charset : "none", lang ? lang : "none", sel);
3530 ZOOM_connection_option_set(c, "negotiation-charset",
3533 ZOOM_connection_option_set(c, "negotiation-lang",
3536 ZOOM_connection_option_set(
3537 c, "negotiation-charset-in-effect-for-records",
3538 (sel != 0) ? "1" : "0");
3539 nmem_destroy(tmpmem);
3543 case Z_APDU_searchResponse:
3544 yaz_log(log_api, "%p recv_apdu Search response", c);
3545 handle_search_response(c, apdu->u.searchResponse);
3546 if (send_sort_present(c) == zoom_complete)
3547 ZOOM_connection_remove_task(c);
3549 case Z_APDU_presentResponse:
3550 yaz_log(log_api, "%p recv_apdu Present response", c);
3551 handle_present_response(c, apdu->u.presentResponse);
3552 if (send_present(c) == zoom_complete)
3553 ZOOM_connection_remove_task(c);
3555 case Z_APDU_sortResponse:
3556 yaz_log(log_api, "%p recv_apdu Sort response", c);
3557 sort_response(c, apdu->u.sortResponse);
3558 if (send_present(c) == zoom_complete)
3559 ZOOM_connection_remove_task(c);
3561 case Z_APDU_scanResponse:
3562 yaz_log(log_api, "%p recv_apdu Scan response", c);
3563 scan_response(c, apdu->u.scanResponse);
3564 ZOOM_connection_remove_task(c);
3566 case Z_APDU_extendedServicesResponse:
3567 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3568 es_response(c, apdu->u.extendedServicesResponse);
3569 ZOOM_connection_remove_task(c);
3572 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3573 if (!ZOOM_test_reconnect(c))
3575 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3580 yaz_log(log_api, "%p Received unknown PDU", c);
3581 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3587 static void handle_srw_response(ZOOM_connection c,
3588 Z_SRW_searchRetrieveResponse *res)
3590 ZOOM_resultset resultset = 0;
3595 const char *syntax, *elementSetName;
3600 switch(c->tasks->which)
3602 case ZOOM_TASK_SEARCH:
3603 resultset = c->tasks->u.search.resultset;
3604 start = &c->tasks->u.search.start;
3605 syntax = c->tasks->u.search.syntax;
3606 elementSetName = c->tasks->u.search.elementSetName;
3608 case ZOOM_TASK_RETRIEVE:
3609 resultset = c->tasks->u.retrieve.resultset;
3610 start = &c->tasks->u.retrieve.start;
3611 syntax = c->tasks->u.retrieve.syntax;
3612 elementSetName = c->tasks->u.retrieve.elementSetName;
3617 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3618 ZOOM_connection_put_event(c, event);
3620 resultset->size = 0;
3622 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3624 if (res->numberOfRecords)
3625 resultset->size = *res->numberOfRecords;
3627 for (i = 0; i<res->num_records; i++)
3631 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3632 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3634 if (res->records[i].recordPosition &&
3635 *res->records[i].recordPosition > 0)
3636 pos = *res->records[i].recordPosition - 1;
3640 npr->databaseName = 0;
3641 npr->which = Z_NamePlusRecord_databaseRecord;
3642 npr->u.databaseRecord = (Z_External *)
3643 odr_malloc(c->odr_in, sizeof(Z_External));
3644 npr->u.databaseRecord->descriptor = 0;
3645 npr->u.databaseRecord->direct_reference =
3646 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3647 npr->u.databaseRecord->which = Z_External_octet;
3649 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3650 odr_malloc(c->odr_in, sizeof(Odr_oct));
3651 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3652 res->records[i].recordData_buf;
3653 npr->u.databaseRecord->u.octet_aligned->len =
3654 npr->u.databaseRecord->u.octet_aligned->size =
3655 res->records[i].recordData_len;
3656 record_cache_add(resultset, npr, pos, syntax, elementSetName);
3658 if (res->num_diagnostics > 0)
3660 const char *uri = res->diagnostics[0].uri;
3665 if ((cp = strrchr(uri, '/')))
3667 set_dset_error(c, code, uri,
3668 res->diagnostics[0].details, 0);
3671 nmem = odr_extract_mem(c->odr_in);
3672 nmem_transfer(resultset->odr->mem, nmem);
3678 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3681 const char *content_type = z_HTTP_header_lookup(hres->headers,
3683 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3686 yaz_log(log_details, "%p handle_http", c);
3688 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3690 Z_SOAP *soap_package = 0;
3692 Z_SOAP_Handler soap_handlers[2] = {
3693 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
3696 ret = z_soap_codec(o, &soap_package,
3697 &hres->content_buf, &hres->content_len,
3699 if (!ret && soap_package->which == Z_SOAP_generic &&
3700 soap_package->u.generic->no == 0)
3702 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3703 if (sr->which == Z_SRW_searchRetrieve_response)
3704 handle_srw_response(c, sr->u.response);
3708 else if (!ret && (soap_package->which == Z_SOAP_fault
3709 || soap_package->which == Z_SOAP_error))
3711 set_HTTP_error(c, hres->code,
3712 soap_package->u.fault->fault_code,
3713 soap_package->u.fault->fault_string);
3720 if (hres->code != 200)
3721 set_HTTP_error(c, hres->code, 0, 0);
3723 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3726 ZOOM_connection_remove_task(c);
3727 if (!strcmp(hres->version, "1.0"))
3729 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3730 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3735 /* HTTP 1.1: only if no close we stay alive .. */
3736 if (connection_head && !strcmp(connection_head, "close"))
3742 static int do_read(ZOOM_connection c)
3747 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3748 ZOOM_connection_put_event(c, event);
3750 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3751 more = cs_more(c->cs);
3752 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3757 if (ZOOM_test_reconnect(c))
3759 yaz_log(log_details, "%p do_read reconnect read", c);
3763 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3772 odr_reset(c->odr_in);
3773 odr_setbuf(c->odr_in, c->buf_in, r, 0);
3774 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3775 ZOOM_connection_put_event(c, event);
3777 if (!z_GDU(c->odr_in, &gdu, 0, 0))
3780 int err = odr_geterrorx(c->odr_in, &x);
3782 const char *element = odr_getelement(c->odr_in);
3783 sprintf(msg, "ODR code %d:%d element=%-20s",
3784 err, x, element ? element : "<unknown>");
3785 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3788 else if (gdu->which == Z_GDU_Z3950)
3789 recv_apdu(c, gdu->u.z3950);
3790 else if (gdu->which == Z_GDU_HTTP_Response)
3793 handle_http(c, gdu->u.HTTP_Response);
3795 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3799 c->reconnect_ok = 0;
3804 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3809 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3810 ZOOM_connection_put_event(c, event);
3812 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3813 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3815 yaz_log(log_details, "%p do_write_ex write failed", c);
3816 if (ZOOM_test_reconnect(c))
3818 return zoom_pending;
3820 if (c->state == STATE_CONNECTING)
3821 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3823 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3825 return zoom_complete;
3829 c->mask = ZOOM_SELECT_EXCEPT;
3830 if (c->cs->io_pending & CS_WANT_WRITE)
3831 c->mask += ZOOM_SELECT_WRITE;
3832 if (c->cs->io_pending & CS_WANT_READ)
3833 c->mask += ZOOM_SELECT_READ;
3834 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3839 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3840 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3843 return zoom_pending;
3846 static zoom_ret do_write(ZOOM_connection c)
3848 return do_write_ex(c, c->buf_out, c->len_out);
3852 ZOOM_API(const char *)
3853 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3855 return ZOOM_options_get(c->options, key);
3858 ZOOM_API(const char *)
3859 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3861 return ZOOM_options_getl(c->options, key, lenp);
3865 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3868 ZOOM_options_set(c->options, key, val);
3872 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3873 const char *val, int len)
3875 ZOOM_options_setl(c->options, key, val, len);
3878 ZOOM_API(const char *)
3879 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3881 return ZOOM_options_get(r->options, key);
3885 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3888 ZOOM_options_set(r->options, key, val);
3893 ZOOM_connection_errcode(ZOOM_connection c)
3895 return ZOOM_connection_error(c, 0, 0);
3898 ZOOM_API(const char *)
3899 ZOOM_connection_errmsg(ZOOM_connection c)
3902 ZOOM_connection_error(c, &msg, 0);
3906 ZOOM_API(const char *)
3907 ZOOM_connection_addinfo(ZOOM_connection c)
3909 const char *addinfo;
3910 ZOOM_connection_error(c, 0, &addinfo);
3914 ZOOM_API(const char *)
3915 ZOOM_connection_diagset(ZOOM_connection c)
3917 const char *diagset;
3918 ZOOM_connection_error_x(c, 0, 0, &diagset);
3922 ZOOM_API(const char *)
3923 ZOOM_diag_str(int error)
3927 case ZOOM_ERROR_NONE:
3929 case ZOOM_ERROR_CONNECT:
3930 return "Connect failed";
3931 case ZOOM_ERROR_MEMORY:
3932 return "Out of memory";
3933 case ZOOM_ERROR_ENCODE:
3934 return "Encoding failed";
3935 case ZOOM_ERROR_DECODE:
3936 return "Decoding failed";
3937 case ZOOM_ERROR_CONNECTION_LOST:
3938 return "Connection lost";
3939 case ZOOM_ERROR_INIT:
3940 return "Init rejected";
3941 case ZOOM_ERROR_INTERNAL:
3942 return "Internal failure";
3943 case ZOOM_ERROR_TIMEOUT:
3945 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3946 return "Unsupported protocol";
3947 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3948 return "Unsupported query type";
3949 case ZOOM_ERROR_INVALID_QUERY:
3950 return "Invalid query";
3951 case ZOOM_ERROR_CQL_PARSE:
3952 return "CQL parsing error";
3953 case ZOOM_ERROR_CQL_TRANSFORM:
3954 return "CQL transformation error";
3955 case ZOOM_ERROR_CCL_CONFIG:
3956 return "CCL configuration error";
3957 case ZOOM_ERROR_CCL_PARSE:
3958 return "CCL parsing error";
3960 return diagbib1_str(error);
3965 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
3966 const char **addinfo, const char **diagset)
3968 int error = c->error;
3971 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3972 *cp = ZOOM_diag_str(error);
3973 else if (!strcmp(c->diagset, "HTTP"))
3974 *cp = z_HTTP_errmsg(c->error);
3975 else if (!strcmp(c->diagset, "Bib-1"))
3976 *cp = ZOOM_diag_str(error);
3977 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3978 *cp = yaz_diag_srw_str(c->error);
3980 *cp = "Unknown error and diagnostic set";
3983 *addinfo = c->addinfo ? c->addinfo : "";
3985 *diagset = c->diagset ? c->diagset : "";
3990 ZOOM_connection_error(ZOOM_connection c, const char **cp,
3991 const char **addinfo)
3993 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3996 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
3998 ZOOM_Event event = 0;
3999 int r = cs_look(c->cs);
4000 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4005 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4006 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4008 ZOOM_connection_put_event(c, event);
4010 else if (r == CS_CONNECT)
4012 int ret = ret = cs_rcvconnect(c->cs);
4013 yaz_log(log_details, "%p ZOOM_connection_do_io "
4014 "cs_rcvconnect returned %d", c, ret);
4017 c->mask = ZOOM_SELECT_EXCEPT;
4018 if (c->cs->io_pending & CS_WANT_WRITE)
4019 c->mask += ZOOM_SELECT_WRITE;
4020 if (c->cs->io_pending & CS_WANT_READ)
4021 c->mask += ZOOM_SELECT_READ;
4025 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4026 ZOOM_connection_put_event(c, event);
4028 if (c->proto == PROTO_Z3950)
4029 ZOOM_connection_send_init(c);
4032 /* no init request for SRW .. */
4033 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4034 ZOOM_connection_remove_task(c);
4036 ZOOM_connection_exec_task(c);
4038 c->state = STATE_ESTABLISHED;
4042 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4048 if (mask & ZOOM_SELECT_EXCEPT)
4050 if (ZOOM_test_reconnect(c))
4052 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4053 ZOOM_connection_put_event(c, event);
4057 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4062 if (mask & ZOOM_SELECT_READ)
4064 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4070 ZOOM_connection_last_event(ZOOM_connection cs)
4073 return ZOOM_EVENT_NONE;
4074 return cs->last_event;
4078 ZOOM_event(int no, ZOOM_connection *cs)
4080 int timeout = 30; /* default timeout in seconds */
4081 int timeout_set = 0; /* whether it was overriden at all */
4083 struct pollfd pollfds[1024];
4084 ZOOM_connection poll_cs[1024];
4087 fd_set input, output, except;
4092 yaz_log(log_details, "ZOOM_event(no=%d,cs=%p)", no, cs);
4094 for (i = 0; i<no; i++)
4096 ZOOM_connection c = cs[i];
4101 ZOOM_connection_show_tasks(c);
4104 if (c && (event = ZOOM_connection_get_event(c)))
4106 ZOOM_Event_destroy(event);
4110 for (i = 0; i<no; i++)
4112 ZOOM_connection c = cs[i];
4116 ZOOM_connection_exec_task(c);
4117 if ((event = ZOOM_connection_get_event(c)))
4119 ZOOM_Event_destroy(event);
4132 for (i = 0; i<no; i++)
4134 ZOOM_connection c = cs[i];
4140 fd = z3950_connection_socket(c);
4141 mask = z3950_connection_mask(c);
4148 /* -1 is used for indefinite timeout (no timeout), so -2 here. */
4149 this_timeout = ZOOM_options_get_int(c->options, "timeout", -2);
4150 if (this_timeout != -2)
4152 /* ensure the minimum timeout is used */
4154 timeout = this_timeout;
4155 else if (this_timeout != -1 && this_timeout < timeout)
4156 timeout = this_timeout;
4162 short poll_events = 0;
4164 if (mask & ZOOM_SELECT_READ)
4165 poll_events += POLLIN;
4166 if (mask & ZOOM_SELECT_WRITE)
4167 poll_events += POLLOUT;
4168 if (mask & ZOOM_SELECT_EXCEPT)
4169 poll_events += POLLERR;
4170 pollfds[nfds].fd = fd;
4171 pollfds[nfds].events = poll_events;
4172 pollfds[nfds].revents = 0;
4177 if (mask & ZOOM_SELECT_READ)
4182 if (mask & ZOOM_SELECT_WRITE)
4184 FD_SET(fd, &output);
4187 if (mask & ZOOM_SELECT_EXCEPT)
4189 FD_SET(fd, &except);
4198 while ((r = poll(pollfds, nfds,
4199 (timeout == -1 ? -1 : timeout * 1000))) < 0
4205 yaz_log(YLOG_WARN|YLOG_ERRNO, "ZOOM_event: poll");
4206 for (i = 0; i<nfds; i++)
4208 ZOOM_connection c = poll_cs[i];
4212 if (pollfds[i].revents & POLLIN)
4213 mask += ZOOM_SELECT_READ;
4214 if (pollfds[i].revents & POLLOUT)
4215 mask += ZOOM_SELECT_WRITE;
4216 if (pollfds[i].revents & POLLERR)
4217 mask += ZOOM_SELECT_EXCEPT;
4219 ZOOM_connection_do_io(c, mask);
4221 else if (r == 0 && c->mask)
4223 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4224 /* timeout and this connection was waiting */
4225 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4227 ZOOM_connection_put_event(c, event);
4231 tv.tv_sec = timeout;
4234 while ((r = select(max_fd+1, &input, &output, &except,
4235 (timeout == -1 ? 0 : &tv))) < 0 && errno == EINTR)
4240 yaz_log(YLOG_WARN|YLOG_ERRNO, "ZOOM_event: select");
4242 r = select(max_fd+1, &input, &output, &except, (timeout == -1 ? 0 : &tv));
4243 for (i = 0; i<no; i++)
4245 ZOOM_connection c = cs[i];
4250 fd = z3950_connection_socket(c);
4254 /* no timeout and real socket */
4255 if (FD_ISSET(fd, &input))
4256 mask += ZOOM_SELECT_READ;
4257 if (FD_ISSET(fd, &output))
4258 mask += ZOOM_SELECT_WRITE;
4259 if (FD_ISSET(fd, &except))
4260 mask += ZOOM_SELECT_EXCEPT;
4262 ZOOM_connection_do_io(c, mask);
4264 if (r == 0 && c->mask)
4266 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4267 /* timeout and this connection was waiting */
4268 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4270 ZOOM_connection_put_event(c, event);
4274 for (i = 0; i<no; i++)
4276 ZOOM_connection c = cs[i];
4278 if (c && (event = ZOOM_connection_get_event(c)))
4280 ZOOM_Event_destroy(event);
4289 * Returns an xmalloc()d string containing RPN that corresponds to the
4290 * CQL passed in. On error, sets the Connection object's error state
4291 * and returns a null pointer.
4292 * ### We could cache CQL parser and/or transformer in Connection.
4294 static char *cql2pqf(ZOOM_connection c, const char *cql)
4298 struct cql_node *node;
4299 const char *cqlfile;
4300 static cql_transform_t trans;
4303 parser = cql_parser_create();
4304 if ((error = cql_parser_string(parser, cql)) != 0) {
4305 cql_parser_destroy(parser);
4306 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4310 node = cql_parser_result(parser);
4311 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4313 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4315 cql_parser_destroy(parser);
4316 cql_node_destroy(node);
4317 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4321 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4323 cql_parser_destroy(parser);
4324 cql_node_destroy(node);
4325 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4326 cqlfile, strerror(errno));
4327 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4331 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4332 cql_parser_destroy(parser);
4333 cql_node_destroy(node);
4336 const char *addinfo;
4337 error = cql_transform_error(trans, &addinfo);
4338 cql_transform_close(trans);
4339 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4340 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4344 cql_transform_close(trans);
4345 return xstrdup(pqfbuf);
4351 * indent-tabs-mode: nil
4353 * vim: shiftwidth=4 tabstop=8 expandtab