2 * Copyright (C) 1995-2006, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.95 2006-11-01 15:39:05 adam Exp $
9 * \brief Implements ZOOM C interface.
17 #include <yaz/yaz-util.h>
18 #include <yaz/xmalloc.h>
19 #include <yaz/otherinfo.h>
21 #include <yaz/pquery.h>
22 #include <yaz/marcdisp.h>
23 #include <yaz/diagbib1.h>
24 #include <yaz/charneg.h>
31 #include <sys/types.h>
40 #include <sys/select.h>
44 #define FD_SETSIZE 512
49 static int log_api = 0;
50 static int log_details = 0;
57 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
58 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
59 static char *cql2pqf(ZOOM_connection c, const char *cql);
61 static void initlog(void)
63 static int log_level_initialized = 0;
64 if (!log_level_initialized)
66 log_api = yaz_log_module_level("zoom");
67 log_details = yaz_log_module_level("zoomdetails");
68 log_level_initialized = 1;
72 static ZOOM_Event ZOOM_Event_create(int kind)
74 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
78 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
82 static void ZOOM_Event_destroy(ZOOM_Event event)
87 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
91 c->m_queue_back->prev = event;
92 assert(c->m_queue_front);
96 assert(!c->m_queue_front);
97 c->m_queue_front = event;
99 event->next = c->m_queue_back;
101 c->m_queue_back = event;
104 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
106 ZOOM_Event event = c->m_queue_front;
109 c->last_event = ZOOM_EVENT_NONE;
112 assert(c->m_queue_back);
113 c->m_queue_front = event->prev;
114 if (c->m_queue_front)
116 assert(c->m_queue_back);
117 c->m_queue_front->next = 0;
121 c->last_event = event->kind;
126 static void set_dset_error(ZOOM_connection c, int error,
128 const char *addinfo, const char *addinfo2)
135 if (!c->diagset || strcmp(dset, c->diagset))
138 c->diagset = xstrdup(dset);
139 /* remove integer part from SRW diagset .. */
140 if ((cp = strrchr(c->diagset, '/')))
143 if (addinfo && addinfo2)
145 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
146 strcpy(c->addinfo, addinfo);
147 strcat(c->addinfo, addinfo2);
150 c->addinfo = xstrdup(addinfo);
152 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
153 c, c->host_port ? c->host_port : "<>", dset, error,
154 addinfo ? addinfo : "",
155 addinfo2 ? addinfo2 : "");
159 static void set_HTTP_error(ZOOM_connection c, int error,
160 const char *addinfo, const char *addinfo2)
162 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
166 static void set_ZOOM_error(ZOOM_connection c, int error,
169 set_dset_error(c, error, "ZOOM", addinfo, 0);
172 static void clear_error(ZOOM_connection c)
175 * If an error is tied to an operation then it's ok to clear: for
176 * example, a diagnostic returned from a search is cleared by a
177 * subsequent search. However, problems such as Connection Lost
178 * or Init Refused are not cleared, because they are not
179 * recoverable: doing another search doesn't help.
183 case ZOOM_ERROR_CONNECT:
184 case ZOOM_ERROR_MEMORY:
185 case ZOOM_ERROR_DECODE:
186 case ZOOM_ERROR_CONNECTION_LOST:
187 case ZOOM_ERROR_INIT:
188 case ZOOM_ERROR_INTERNAL:
189 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
192 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
196 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);
456 val = ZOOM_options_get(c->options, "sru");
457 c->sru_mode = get_sru_mode_from_string(val);
463 sprintf(hostn, "%.80s:%d", host, portnum);
464 c->host_port = xstrdup(hostn);
467 c->host_port = xstrdup(host);
471 * If the "<scheme>:" part of the host string is preceded by one
472 * or more comma-separated <name>=<value> pairs, these are taken
473 * to be options to be set on the connection object. Among other
474 * applications, this facility can be used to embed authentication
476 * user=admin,password=secret,tcp:localhost:9999
478 char *remainder = c->host_port;
479 char *pcolon = strchr(remainder, ':');
482 while ((pcomma = strchr(remainder, ',')) != 0 &&
483 (pcolon == 0 || pcomma < pcolon)) {
485 if ((pequals = strchr(remainder, '=')) != 0) {
487 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
488 ZOOM_connection_option_set(c, remainder, pequals+1);
490 remainder = pcomma+1;
493 if (remainder != c->host_port) {
495 c->host_port = xstrdup(remainder);
496 /*printf("# reset hp='%s'\n", remainder);*/
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)
956 static void do_close(ZOOM_connection c)
962 c->state = STATE_IDLE;
965 static int ZOOM_test_reconnect(ZOOM_connection c)
967 if (!c->reconnect_ok)
971 c->tasks->running = 0;
972 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
976 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
977 int force_sync, int start, int count)
982 const char *syntax, *elementSetName;
986 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
987 " count=%d", r, force_sync, start, count);
992 if (c->host_port && c->proto == PROTO_HTTP)
996 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
997 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1001 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1003 c->reconnect_ok = 1;
1006 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1007 task->u.retrieve.resultset = r;
1008 task->u.retrieve.start = start;
1009 task->u.retrieve.count = count;
1011 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1012 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1013 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1014 task->u.retrieve.elementSetName = elementSetName
1015 ? xstrdup(elementSetName) : 0;
1017 cp = ZOOM_options_get(r->options, "schema");
1020 if (!r->schema || strcmp(r->schema, cp))
1023 r->schema = xstrdup(cp);
1027 ZOOM_resultset_addref(r);
1029 if (!r->connection->async || force_sync)
1030 while (r->connection && ZOOM_event(1, &r->connection))
1035 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1036 size_t start, size_t count)
1038 int force_present = 0;
1042 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1043 r, r, (long) start, (long) count);
1046 ZOOM_resultset_retrieve(r, force_present, start, count);
1050 for (i = 0; i< count; i++)
1051 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1055 static void get_cert(ZOOM_connection c)
1060 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1062 ZOOM_connection_option_setl(c, "sslPeerCert",
1063 cert_buf, cert_len);
1068 static zoom_ret do_connect(ZOOM_connection c)
1071 const char *effective_host;
1074 effective_host = c->proxy;
1076 effective_host = c->host_port;
1078 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1082 c->cs = cs_create_host(effective_host, 0, &add);
1084 if (c->cs && c->cs->protocol == PROTO_HTTP)
1087 const char *path = 0;
1089 c->proto = PROTO_HTTP;
1090 cs_get_host_args(c->host_port, &path);
1092 c->path = (char*) xmalloc(strlen(path)+2);
1094 strcpy(c->path+1, path);
1096 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1098 return zoom_complete;
1103 int ret = cs_connect(c->cs, add);
1106 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1107 ZOOM_connection_put_event(c, event);
1109 if (c->proto == PROTO_Z3950)
1110 ZOOM_connection_send_init(c);
1113 /* no init request for SRW .. */
1114 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1115 ZOOM_connection_remove_task(c);
1117 ZOOM_connection_exec_task(c);
1119 c->state = STATE_ESTABLISHED;
1120 return zoom_pending;
1124 c->state = STATE_CONNECTING;
1125 c->mask = ZOOM_SELECT_EXCEPT;
1126 if (c->cs->io_pending & CS_WANT_WRITE)
1127 c->mask += ZOOM_SELECT_WRITE;
1128 if (c->cs->io_pending & CS_WANT_READ)
1129 c->mask += ZOOM_SELECT_READ;
1130 return zoom_pending;
1133 c->state = STATE_IDLE;
1134 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1135 return zoom_complete;
1138 int z3950_connection_socket(ZOOM_connection c)
1141 return cs_fileno(c->cs);
1145 int z3950_connection_mask(ZOOM_connection c)
1152 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1155 for (i = 0; i<200; i++)
1158 Z_OtherInformation **oi;
1164 sprintf(buf, "otherInfo%d", i);
1165 val = ZOOM_options_get(c->options, buf);
1168 cp = strchr(val, ':');
1172 if (len >= sizeof(buf))
1173 len = sizeof(buf)-1;
1174 memcpy(buf, val, len);
1176 oidval = oid_getvalbyname(buf);
1177 if (oidval == VAL_NONE)
1180 yaz_oi_APDU(a, &oi);
1181 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1185 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1190 Z_OtherInformation **oi;
1191 yaz_oi_APDU(a, &oi);
1192 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1196 Z_OtherInformation **oi;
1197 yaz_oi_APDU(a, &oi);
1198 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1200 otherInfo_attach(c, a, out);
1201 if (!z_APDU(out, &a, 0, 0))
1203 FILE *outf = fopen("/tmp/apdu.txt", "a");
1206 ODR odr_pr = odr_createmem(ODR_PRINT);
1207 fprintf(outf, "a=%p\n", a);
1208 odr_setprint(odr_pr, outf);
1209 z_APDU(odr_pr, &a, 0, 0);
1210 odr_destroy(odr_pr);
1212 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1213 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1217 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1221 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1225 if (encode_APDU(c, a, c->odr_out))
1226 return zoom_complete;
1227 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1228 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1229 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1230 ZOOM_connection_put_event(c, event);
1231 odr_reset(c->odr_out);
1235 /* returns 1 if PDU was sent OK (still pending )
1236 0 if PDU was not sent OK (nothing to wait for)
1239 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1241 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1242 Z_InitRequest *ireq = apdu->u.initRequest;
1243 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1244 odr_malloc(c->odr_out, sizeof(*auth));
1245 const char *auth_groupId = ZOOM_options_get(c->options, "group");
1246 const char *auth_userId = ZOOM_options_get(c->options, "user");
1247 const char *auth_password = ZOOM_options_get(c->options, "password");
1250 /* support the pass for backwards compatibility */
1252 auth_password = ZOOM_options_get(c->options, "pass");
1254 ODR_MASK_SET(ireq->options, Z_Options_search);
1255 ODR_MASK_SET(ireq->options, Z_Options_present);
1256 ODR_MASK_SET(ireq->options, Z_Options_scan);
1257 ODR_MASK_SET(ireq->options, Z_Options_sort);
1258 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1259 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1261 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1262 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1263 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1265 /* Index Data's Z39.50 Implementor Id is 81 */
1266 ireq->implementationId =
1267 odr_prepend(c->odr_out,
1268 ZOOM_options_get(c->options, "implementationId"),
1269 odr_prepend(c->odr_out, "81", ireq->implementationId));
1271 ireq->implementationName =
1272 odr_prepend(c->odr_out,
1273 ZOOM_options_get(c->options, "implementationName"),
1274 odr_prepend(c->odr_out, "ZOOM-C",
1275 ireq->implementationName));
1277 version = odr_strdup(c->odr_out, "$Revision: 1.95 $");
1278 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1279 version[strlen(version)-2] = '\0';
1280 ireq->implementationVersion =
1281 odr_prepend(c->odr_out,
1282 ZOOM_options_get(c->options, "implementationVersion"),
1283 odr_prepend(c->odr_out, &version[11],
1284 ireq->implementationVersion));
1286 *ireq->maximumRecordSize =
1287 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
1288 *ireq->preferredMessageSize =
1289 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
1291 if (auth_groupId || auth_password)
1293 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1296 if (auth_groupId && *auth_groupId)
1298 pass->groupId = (char *)
1299 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1300 strcpy(pass->groupId, auth_groupId);
1304 if (auth_userId && *auth_userId)
1306 pass->userId = (char *)
1307 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1308 strcpy(pass->userId, auth_userId);
1312 if (auth_password && *auth_password)
1314 pass->password = (char *)
1315 odr_malloc(c->odr_out, strlen(auth_password)+1);
1316 strcpy(pass->password, auth_password);
1321 auth->which = Z_IdAuthentication_idPass;
1322 auth->u.idPass = pass;
1323 ireq->idAuthentication = auth;
1326 else if (auth_userId)
1328 auth->which = Z_IdAuthentication_open;
1329 auth->u.open = (char *)
1330 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1331 strcpy(auth->u.open, auth_userId);
1332 ireq->idAuthentication = auth;
1335 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1336 VAL_PROXY, 1, c->host_port);
1337 if (c->charset || c->lang)
1339 Z_OtherInformation **oi;
1340 Z_OtherInformationUnit *oi_unit;
1342 yaz_oi_APDU(apdu, &oi);
1344 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1346 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1347 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1348 oi_unit->information.externallyDefinedInfo =
1349 yaz_set_proposal_charneg_list(c->odr_out, " ",
1350 c->charset, c->lang, 1);
1354 return send_APDU(c, apdu);
1358 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1363 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1365 if (c->sru_mode == zoom_sru_get)
1367 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1369 else if (c->sru_mode == zoom_sru_post)
1371 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1373 else if (c->sru_mode == zoom_sru_soap)
1375 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1377 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1378 return zoom_complete;
1379 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1381 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1382 ZOOM_connection_put_event(c, event);
1383 odr_reset(c->odr_out);
1389 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1393 ZOOM_resultset resultset = 0;
1395 const char *option_val = 0;
1397 if (c->error) /* don't continue on error */
1398 return zoom_complete;
1400 switch(c->tasks->which)
1402 case ZOOM_TASK_SEARCH:
1403 resultset = c->tasks->u.search.resultset;
1404 resultset->setname = xstrdup("default");
1405 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1406 start = &c->tasks->u.search.start;
1407 count = &c->tasks->u.search.count;
1409 case ZOOM_TASK_RETRIEVE:
1410 resultset = c->tasks->u.retrieve.resultset;
1412 start = &c->tasks->u.retrieve.start;
1413 count = &c->tasks->u.retrieve.count;
1415 if (*start >= resultset->size)
1416 return zoom_complete;
1417 if (*start + *count > resultset->size)
1418 *count = resultset->size - *start;
1420 for (i = 0; i < *count; i++)
1423 record_cache_lookup(resultset, i + *start,
1424 c->tasks->u.retrieve.syntax,
1425 c->tasks->u.retrieve.elementSetName);
1430 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1431 ZOOM_connection_put_event(c, event);
1438 return zoom_complete;
1441 return zoom_complete;
1443 assert(resultset->query);
1445 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1447 if (resultset->query->z_query->which == Z_Query_type_104
1448 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1450 sr->u.request->query_type = Z_SRW_query_type_cql;
1451 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1453 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1454 resultset->query->z_query->u.type_1)
1456 sr->u.request->query_type = Z_SRW_query_type_pqf;
1457 sr->u.request->query.pqf = resultset->query->query_string;
1461 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1462 return zoom_complete;
1464 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1465 sr->u.request->maximumRecords = odr_intdup(
1466 c->odr_out, resultset->step>0 ? resultset->step : *count);
1467 sr->u.request->recordSchema = resultset->schema;
1469 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1471 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1473 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1475 sr->extra_args = odr_strdup(c->odr_out, option_val);
1476 return send_srw(c, sr);
1479 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1481 return zoom_complete;
1485 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1488 int lslb, ssub, mspn;
1490 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1491 Z_SearchRequest *search_req = apdu->u.searchRequest;
1492 const char *elementSetName;
1493 const char *smallSetElementSetName;
1494 const char *mediumSetElementSetName;
1497 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1499 r = c->tasks->u.search.resultset;
1501 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1504 ZOOM_options_get(r->options, "elementSetName");
1505 smallSetElementSetName =
1506 ZOOM_options_get(r->options, "smallSetElementSetName");
1507 mediumSetElementSetName =
1508 ZOOM_options_get(r->options, "mediumSetElementSetName");
1510 if (!smallSetElementSetName)
1511 smallSetElementSetName = elementSetName;
1513 if (!mediumSetElementSetName)
1514 mediumSetElementSetName = elementSetName;
1519 /* prepare query for the search request */
1520 search_req->query = r->query->z_query;
1521 if (!search_req->query)
1523 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1524 return zoom_complete;
1527 search_req->databaseNames = r->databaseNames;
1528 search_req->num_databaseNames = r->num_databaseNames;
1530 /* get syntax (no need to provide unless piggyback is in effect) */
1531 syntax = c->tasks->u.search.syntax;
1533 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1534 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1535 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1536 if (lslb != -1 && ssub != -1 && mspn != -1)
1538 /* So're a Z39.50 expert? Let's hope you don't do sort */
1539 *search_req->largeSetLowerBound = lslb;
1540 *search_req->smallSetUpperBound = ssub;
1541 *search_req->mediumSetPresentNumber = mspn;
1543 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1544 && r->piggyback && !r->r_sort_spec && !r->schema)
1546 /* Regular piggyback - do it unless we're going to do sort */
1547 *search_req->largeSetLowerBound = 2000000000;
1548 *search_req->smallSetUpperBound = 1;
1549 *search_req->mediumSetPresentNumber =
1550 r->step>0 ? r->step : c->tasks->u.search.count;
1554 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1555 smallSetElementSetName = 0;
1556 mediumSetElementSetName = 0;
1559 if (smallSetElementSetName && *smallSetElementSetName)
1561 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1562 odr_malloc(c->odr_out, sizeof(*esn));
1564 esn->which = Z_ElementSetNames_generic;
1565 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1566 search_req->smallSetElementSetNames = esn;
1568 if (mediumSetElementSetName && *mediumSetElementSetName)
1570 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1571 odr_malloc(c->odr_out, sizeof(*esn));
1573 esn->which = Z_ElementSetNames_generic;
1574 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1575 search_req->mediumSetElementSetNames = esn;
1578 search_req->preferredRecordSyntax =
1579 yaz_str_to_z3950oid(c->odr_out, CLASS_RECSYN, syntax);
1583 if (c->support_named_resultsets)
1587 /* find the lowest unused ordinal so that we re-use
1588 result sets on the server. */
1589 for (ord = 1; ; ord++)
1592 sprintf(setname, "%d", ord);
1593 for (rp = c->resultsets; rp; rp = rp->next)
1594 if (rp->setname && !strcmp(rp->setname, setname))
1599 r->setname = xstrdup(setname);
1600 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1601 "set %s", c, r->setname);
1605 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1607 r->setname = xstrdup("default");
1609 ZOOM_options_set(r->options, "setname", r->setname);
1611 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1612 return send_APDU(c, apdu);
1615 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1622 case Z_DefaultDiagFormat_v2Addinfo:
1623 addinfo = r->u.v2Addinfo;
1625 case Z_DefaultDiagFormat_v3Addinfo:
1626 addinfo = r->u.v3Addinfo;
1631 set_dset_error(c, *r->condition,
1632 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1636 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1638 if (p->which != Z_DiagRec_defaultFormat)
1639 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1641 response_default_diag(c, p->u.defaultFormat);
1644 ZOOM_API(ZOOM_record)
1645 ZOOM_record_clone(ZOOM_record srec)
1652 odr_enc = odr_createmem(ODR_ENCODE);
1653 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1655 buf = odr_getbuf(odr_enc, &size, 0);
1657 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1658 nrec->odr = odr_createmem(ODR_DECODE);
1659 nrec->wrbuf_marc = 0;
1660 nrec->wrbuf_iconv = 0;
1661 nrec->wrbuf_opac = 0;
1662 odr_setbuf(nrec->odr, buf, size, 0);
1663 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1665 odr_destroy(odr_enc);
1669 ZOOM_API(ZOOM_record)
1670 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1672 const char *syntax =
1673 ZOOM_options_get(s->options, "preferredRecordSyntax");
1674 const char *elementSetName =
1675 ZOOM_options_get(s->options, "elementSetName");
1677 return record_cache_lookup(s, pos, syntax, elementSetName);
1680 ZOOM_API(ZOOM_record)
1681 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1683 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1688 * MIKE: I think force_sync should always be zero, but I don't
1689 * want to make this change until I get the go-ahead from
1690 * Adam, in case something depends on the old synchronous
1694 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1695 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1696 rec = ZOOM_resultset_record_immediate(r, pos);
1702 ZOOM_record_destroy(ZOOM_record rec)
1706 if (rec->wrbuf_marc)
1707 wrbuf_free(rec->wrbuf_marc, 1);
1708 if (rec->wrbuf_iconv)
1709 wrbuf_free(rec->wrbuf_iconv, 1);
1710 if (rec->wrbuf_opac)
1711 wrbuf_free(rec->wrbuf_opac, 1);
1712 odr_destroy(rec->odr);
1716 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1718 const char *buf, int sz,
1719 const char *record_charset)
1724 yaz_marc_t mt = yaz_marc_create();
1727 strcpy(to, "UTF-8");
1728 if (record_charset && *record_charset)
1730 /* Use "from,to" or just "from" */
1731 const char *cp = strchr(record_charset, ',');
1732 int clen = strlen(record_charset);
1735 strncpy( to, cp+1, sizeof(to)-1);
1736 to[sizeof(to)-1] = '\0';
1737 clen = cp - record_charset;
1739 if (clen > sizeof(from)-1)
1740 clen = sizeof(from)-1;
1743 strncpy(from, record_charset, clen);
1749 cd = yaz_iconv_open(to, from);
1750 yaz_marc_iconv(mt, cd);
1753 yaz_marc_xml(mt, marc_type);
1754 if (!rec->wrbuf_marc)
1755 rec->wrbuf_marc = wrbuf_alloc();
1756 wrbuf_rewind(rec->wrbuf_marc);
1757 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1759 yaz_marc_destroy(mt);
1761 yaz_iconv_close(cd);
1763 *len = wrbuf_len(rec->wrbuf_marc);
1764 return wrbuf_buf(rec->wrbuf_marc);
1766 yaz_marc_destroy(mt);
1768 yaz_iconv_close(cd);
1772 static const char *record_iconv_return(ZOOM_record rec, int *len,
1773 const char *buf, int sz,
1774 const char *record_charset)
1781 strcpy(to, "UTF-8");
1782 if (record_charset && *record_charset)
1784 /* Use "from,to" or just "from" */
1785 const char *cp = strchr(record_charset, ',');
1786 int clen = strlen(record_charset);
1789 strncpy( to, cp+1, sizeof(to)-1);
1790 to[sizeof(to)-1] = '\0';
1791 clen = cp - record_charset;
1793 if (clen > sizeof(from)-1)
1794 clen = sizeof(from)-1;
1797 strncpy(from, record_charset, clen);
1801 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1804 size_t inbytesleft = sz;
1805 const char *inp = buf;
1807 if (!rec->wrbuf_iconv)
1808 rec->wrbuf_iconv = wrbuf_alloc();
1810 wrbuf_rewind(rec->wrbuf_iconv);
1814 size_t outbytesleft = sizeof(outbuf);
1815 char *outp = outbuf;
1816 size_t r = yaz_iconv(cd, (char**) &inp,
1818 &outp, &outbytesleft);
1819 if (r == (size_t) (-1))
1821 int e = yaz_iconv_error(cd);
1822 if (e != YAZ_ICONV_E2BIG)
1825 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1827 wrbuf_puts(rec->wrbuf_iconv, "");
1828 buf = wrbuf_buf(rec->wrbuf_iconv);
1829 sz = wrbuf_len(rec->wrbuf_iconv);
1830 yaz_iconv_close(cd);
1838 ZOOM_record_error(ZOOM_record rec, const char **cp,
1839 const char **addinfo, const char **diagset)
1841 Z_NamePlusRecord *npr;
1846 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1848 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1849 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1850 const char *add = 0;
1852 if (diag_rec->which == Z_DiagRec_defaultFormat)
1854 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1857 error = *ddf->condition;
1860 case Z_DefaultDiagFormat_v2Addinfo:
1861 add = ddf->u.v2Addinfo;
1863 case Z_DefaultDiagFormat_v3Addinfo:
1864 add = ddf->u.v3Addinfo;
1868 *diagset = yaz_z3950oid_to_str(ddf->diagnosticSetId, &oclass);
1876 *addinfo = add ? add : "";
1878 *cp = diagbib1_str(error);
1884 ZOOM_API(const char *)
1885 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1892 Z_NamePlusRecord *npr;
1895 *len = 0; /* default return */
1904 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1906 if (cp[i] == ';' || cp[i] == ' ')
1912 while (type_spec[i] == ';')
1915 while (type_spec[i] == ' ')
1917 if (!strncmp(type_spec+i, "charset=", 8))
1920 i = i + 8; /* skip charset= */
1921 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1923 if (type_spec[i] == ';' || type_spec[i] == ' ')
1929 else if (!strncmp(type_spec+i, "xpath=", 6))
1933 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1937 while (type_spec[i] == ' ')
1940 if (!strcmp(type, "database"))
1943 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1944 return npr->databaseName;
1946 else if (!strcmp(type, "syntax"))
1948 const char *desc = 0;
1949 if (npr->which == Z_NamePlusRecord_databaseRecord)
1951 Z_External *r = (Z_External *) npr->u.databaseRecord;
1952 oident *ent = oid_getentbyoid(r->direct_reference);
1959 *len = strlen(desc);
1962 if (npr->which != Z_NamePlusRecord_databaseRecord)
1965 /* from now on - we have a database record .. */
1966 if (!strcmp(type, "render"))
1968 Z_External *r = (Z_External *) npr->u.databaseRecord;
1969 oident *ent = oid_getentbyoid(r->direct_reference);
1971 /* render bibliographic record .. */
1972 if (r->which == Z_External_OPAC)
1974 r = r->u.opac->bibliographicRecord;
1977 ent = oid_getentbyoid(r->direct_reference);
1979 if (r->which == Z_External_sutrs)
1980 return record_iconv_return(rec, len,
1981 (char*) r->u.sutrs->buf,
1984 else if (r->which == Z_External_octet)
1986 const char *ret_buf;
1994 case VAL_APPLICATION_XML:
1997 ret_buf = marc_iconv_return(
1998 rec, YAZ_MARC_LINE, len,
1999 (const char *) r->u.octet_aligned->buf,
2000 r->u.octet_aligned->len,
2005 return record_iconv_return(rec, len,
2006 (const char *) r->u.octet_aligned->buf,
2007 r->u.octet_aligned->len,
2010 else if (r->which == Z_External_grs1)
2012 if (!rec->wrbuf_marc)
2013 rec->wrbuf_marc = wrbuf_alloc();
2014 wrbuf_rewind(rec->wrbuf_marc);
2015 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
2016 return record_iconv_return(rec, len,
2017 wrbuf_buf(rec->wrbuf_marc),
2018 wrbuf_len(rec->wrbuf_marc),
2023 else if (!strcmp(type, "xml"))
2025 Z_External *r = (Z_External *) npr->u.databaseRecord;
2026 oident *ent = oid_getentbyoid(r->direct_reference);
2028 /* render bibliographic record .. */
2029 if (r->which == Z_External_OPAC)
2031 r = r->u.opac->bibliographicRecord;
2034 ent = oid_getentbyoid(r->direct_reference);
2037 if (r->which == Z_External_sutrs)
2038 return record_iconv_return(rec, len,
2039 (const char *) r->u.sutrs->buf,
2042 else if (r->which == Z_External_octet)
2044 const char *ret_buf;
2045 int marc_decode_type = YAZ_MARC_MARCXML;
2054 case VAL_APPLICATION_XML:
2057 ret_buf = marc_iconv_return(
2058 rec, marc_decode_type, len,
2059 (const char *) r->u.octet_aligned->buf,
2060 r->u.octet_aligned->len,
2065 return record_iconv_return(rec, len,
2066 (const char *) r->u.octet_aligned->buf,
2067 r->u.octet_aligned->len,
2070 else if (r->which == Z_External_grs1)
2077 else if (!strcmp(type, "raw"))
2079 Z_External *r = (Z_External *) npr->u.databaseRecord;
2081 if (r->which == Z_External_sutrs)
2083 if (len) *len = r->u.sutrs->len;
2084 return (const char *) r->u.sutrs->buf;
2086 else if (r->which == Z_External_octet)
2088 if (len) *len = r->u.octet_aligned->len;
2089 return (const char *) r->u.octet_aligned->buf;
2091 else /* grs-1, explain, OPAC, ... */
2094 return (const char *) npr->u.databaseRecord;
2098 else if (!strcmp (type, "ext"))
2101 return (const char *) npr->u.databaseRecord;
2103 else if (!strcmp (type, "opac"))
2106 Z_External *r = (Z_External *) npr->u.databaseRecord;
2107 if (r->which == Z_External_OPAC)
2109 if (!rec->wrbuf_opac)
2110 rec->wrbuf_opac = wrbuf_alloc();
2111 wrbuf_rewind(rec->wrbuf_opac);
2112 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2113 return record_iconv_return(rec, len,
2114 wrbuf_buf(rec->wrbuf_opac),
2115 wrbuf_len(rec->wrbuf_opac),
2122 static int strcmp_null(const char *v1, const char *v2)
2128 return strcmp(v1, v2);
2131 static size_t record_hash(int pos)
2135 return pos % RECORD_HASH_SIZE;
2138 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2140 const char *syntax, const char *elementSetName)
2142 ZOOM_record_cache rc;
2144 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2145 ZOOM_connection_put_event(r->connection, event);
2147 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2151 if (strcmp_null(r->schema, rc->schema))
2153 if (strcmp_null(elementSetName,rc->elementSetName))
2155 if (strcmp_null(syntax, rc->syntax))
2157 /* not destroying rc->npr (it's handled by nmem )*/
2159 /* keeping wrbuf_marc too */
2163 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2166 rc->rec.wrbuf_marc = 0;
2167 rc->rec.wrbuf_iconv = 0;
2168 rc->rec.wrbuf_opac = 0;
2170 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2172 rc->elementSetName = 0;
2175 rc->syntax = odr_strdup(r->odr, syntax);
2180 rc->schema = odr_strdup(r->odr, r->schema);
2185 rc->next = r->record_hash[record_hash(pos)];
2186 r->record_hash[record_hash(pos)] = rc;
2189 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2191 const char *elementSetName)
2193 ZOOM_record_cache rc;
2195 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2199 if (strcmp_null(r->schema, rc->schema))
2201 if (strcmp_null(elementSetName,rc->elementSetName))
2203 if (strcmp_null(syntax, rc->syntax))
2211 static void handle_records(ZOOM_connection c, Z_Records *sr,
2214 ZOOM_resultset resultset;
2216 const char *syntax = 0, *elementSetName = 0;
2220 switch (c->tasks->which)
2222 case ZOOM_TASK_SEARCH:
2223 resultset = c->tasks->u.search.resultset;
2224 start = &c->tasks->u.search.start;
2225 count = &c->tasks->u.search.count;
2226 syntax = c->tasks->u.search.syntax;
2227 elementSetName = c->tasks->u.search.elementSetName;
2229 case ZOOM_TASK_RETRIEVE:
2230 resultset = c->tasks->u.retrieve.resultset;
2231 start = &c->tasks->u.retrieve.start;
2232 count = &c->tasks->u.retrieve.count;
2233 syntax = c->tasks->u.retrieve.syntax;
2234 elementSetName = c->tasks->u.retrieve.elementSetName;
2239 if (sr && sr->which == Z_Records_NSD)
2240 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2241 else if (sr && sr->which == Z_Records_multipleNSD)
2243 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2244 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2246 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2250 if (*count + *start > resultset->size)
2251 *count = resultset->size - *start;
2254 if (sr && sr->which == Z_Records_DBOSD)
2257 NMEM nmem = odr_extract_mem(c->odr_in);
2258 Z_NamePlusRecordList *p =
2259 sr->u.databaseOrSurDiagnostics;
2260 for (i = 0; i<p->num_records; i++)
2262 record_cache_add(resultset, p->records[i], i + *start,
2263 syntax, elementSetName);
2267 yaz_log(log_details,
2268 "handle_records resultset=%p start=%d count=%d",
2269 resultset, *start, *count);
2271 /* transfer our response to search_nmem .. we need it later */
2272 nmem_transfer(resultset->odr->mem, nmem);
2274 if (present_phase && p->num_records == 0)
2276 /* present response and we didn't get any records! */
2277 Z_NamePlusRecord *myrec =
2278 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2279 record_cache_add(resultset, myrec, *start,
2280 syntax, elementSetName);
2283 else if (present_phase)
2285 /* present response and we didn't get any records! */
2286 Z_NamePlusRecord *myrec =
2287 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2288 record_cache_add(resultset, myrec, *start, syntax, elementSetName);
2293 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2295 handle_records(c, pr->records, 1);
2298 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2301 switch (term->which)
2303 case Z_Term_general:
2304 ZOOM_options_setl(opt, name,
2305 (const char *)(term->u.general->buf),
2306 term->u.general->len);
2308 case Z_Term_characterString:
2309 ZOOM_options_set(opt, name, term->u.characterString);
2311 case Z_Term_numeric:
2312 ZOOM_options_set_int(opt, name, *term->u.numeric);
2317 static void handle_queryExpression(ZOOM_options opt, const char *name,
2318 Z_QueryExpression *exp)
2324 case Z_QueryExpression_term:
2325 if (exp->u.term && exp->u.term->queryTerm)
2327 sprintf(opt_name, "%s.term", name);
2328 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2331 case Z_QueryExpression_query:
2336 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2337 Z_OtherInformation *o)
2340 for (i = 0; o && i < o->num_elements; i++)
2342 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2344 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2346 if (ext->which == Z_External_searchResult1)
2349 Z_SearchInfoReport *sr = ext->u.searchResult1;
2352 ZOOM_options_set_int(
2353 resultset->options, "searchresult.size", sr->num);
2355 for (j = 0; j < sr->num; j++)
2357 Z_SearchInfoReport_s *ent =
2358 ext->u.searchResult1->elements[j];
2361 sprintf(pref, "searchresult.%d", j);
2363 if (ent->subqueryId)
2366 sprintf(opt_name, "%s.id", pref);
2367 ZOOM_options_set(resultset->options, opt_name,
2370 if (ent->subqueryExpression)
2373 sprintf(opt_name, "%s.subquery", pref);
2374 handle_queryExpression(resultset->options, opt_name,
2375 ent->subqueryExpression);
2377 if (ent->subqueryInterpretation)
2380 sprintf(opt_name, "%s.interpretation", pref);
2381 handle_queryExpression(resultset->options, opt_name,
2382 ent->subqueryInterpretation);
2384 if (ent->subqueryRecommendation)
2387 sprintf(opt_name, "%s.recommendation", pref);
2388 handle_queryExpression(resultset->options, opt_name,
2389 ent->subqueryRecommendation);
2391 if (ent->subqueryCount)
2394 sprintf(opt_name, "%s.count", pref);
2395 ZOOM_options_set_int(resultset->options, opt_name,
2396 *ent->subqueryCount);
2404 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2406 ZOOM_resultset resultset;
2409 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2412 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2413 ZOOM_connection_put_event(c, event);
2415 resultset = c->tasks->u.search.resultset;
2417 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2419 resultset->size = *sr->resultCount;
2420 handle_records(c, sr->records, 0);
2423 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2425 if (res->diagnostics && res->num_diagnostics > 0)
2426 response_diag(c, res->diagnostics[0]);
2429 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2431 NMEM nmem = odr_extract_mem(c->odr_in);
2434 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2436 scan = c->tasks->u.scan.scan;
2438 if (res->entries && res->entries->nonsurrogateDiagnostics)
2439 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2440 scan->scan_response = res;
2441 nmem_transfer(scan->odr->mem, nmem);
2443 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2444 if (res->positionOfTerm)
2445 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2446 if (res->scanStatus)
2447 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2448 if (res->numberOfEntriesReturned)
2449 ZOOM_options_set_int(scan->options, "number",
2450 *res->numberOfEntriesReturned);
2455 static zoom_ret send_sort(ZOOM_connection c,
2456 ZOOM_resultset resultset)
2459 resultset->r_sort_spec = 0;
2460 if (resultset->r_sort_spec)
2462 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2463 Z_SortRequest *req = apdu->u.sortRequest;
2465 req->num_inputResultSetNames = 1;
2466 req->inputResultSetNames = (Z_InternationalString **)
2467 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2468 req->inputResultSetNames[0] =
2469 odr_strdup(c->odr_out, resultset->setname);
2470 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2471 req->sortSequence = resultset->r_sort_spec;
2472 resultset->r_sort_spec = 0;
2473 return send_APDU(c, apdu);
2475 return zoom_complete;
2478 static zoom_ret send_present(ZOOM_connection c)
2481 Z_PresentRequest *req = 0;
2483 const char *syntax = 0;
2484 const char *elementSetName = 0;
2485 ZOOM_resultset resultset;
2490 yaz_log(log_details, "%p send_present no tasks", c);
2491 return zoom_complete;
2494 switch (c->tasks->which)
2496 case ZOOM_TASK_SEARCH:
2497 resultset = c->tasks->u.search.resultset;
2498 start = &c->tasks->u.search.start;
2499 count = &c->tasks->u.search.count;
2500 syntax = c->tasks->u.search.syntax;
2501 elementSetName = c->tasks->u.search.elementSetName;
2503 case ZOOM_TASK_RETRIEVE:
2504 resultset = c->tasks->u.retrieve.resultset;
2505 start = &c->tasks->u.retrieve.start;
2506 count = &c->tasks->u.retrieve.count;
2507 syntax = c->tasks->u.retrieve.syntax;
2508 elementSetName = c->tasks->u.retrieve.elementSetName;
2510 if (*start >= resultset->size)
2512 yaz_log(log_details, "%p send_present start=%d >= size=%d",
2513 c, *start, resultset->size);
2514 return zoom_complete;
2516 if (*start + *count > resultset->size)
2517 *count = resultset->size - *start;
2520 return zoom_complete;
2522 yaz_log(log_details, "%p send_present start=%d count=%d",
2525 if (c->error) /* don't continue on error */
2526 return zoom_complete;
2528 return zoom_complete;
2529 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2530 resultset, *start, *count);
2532 for (i = 0; i < *count; i++)
2535 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2540 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2541 ZOOM_connection_put_event(c, event);
2549 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2550 return zoom_complete;
2553 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2554 req = apdu->u.presentRequest;
2557 yaz_log(log_details, "%p send_present skip=%d", c, i);
2559 *req->resultSetStartPoint = *start + 1;
2560 *req->numberOfRecordsRequested = resultset->step>0 ?
2561 resultset->step : *count;
2562 if (*req->numberOfRecordsRequested + *start > resultset->size)
2563 *req->numberOfRecordsRequested = resultset->size - *start;
2564 assert(*req->numberOfRecordsRequested > 0);
2566 if (syntax && *syntax)
2567 req->preferredRecordSyntax =
2568 yaz_str_to_z3950oid(c->odr_out, CLASS_RECSYN, syntax);
2570 if (resultset->schema && *resultset->schema)
2572 Z_RecordComposition *compo = (Z_RecordComposition *)
2573 odr_malloc(c->odr_out, sizeof(*compo));
2575 req->recordComposition = compo;
2576 compo->which = Z_RecordComp_complex;
2577 compo->u.complex = (Z_CompSpec *)
2578 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2579 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2580 odr_malloc(c->odr_out, sizeof(bool_t));
2581 *compo->u.complex->selectAlternativeSyntax = 0;
2583 compo->u.complex->generic = (Z_Specification *)
2584 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2586 compo->u.complex->generic->which = Z_Schema_oid;
2587 compo->u.complex->generic->schema.oid = (Odr_oid *)
2588 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2590 if (!compo->u.complex->generic->schema.oid)
2592 /* OID wasn't a schema! Try record syntax instead. */
2594 compo->u.complex->generic->schema.oid = (Odr_oid *)
2595 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2597 if (elementSetName && *elementSetName)
2599 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2600 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2601 compo->u.complex->generic->elementSpec->which =
2602 Z_ElementSpec_elementSetName;
2603 compo->u.complex->generic->elementSpec->u.elementSetName =
2604 odr_strdup(c->odr_out, elementSetName);
2607 compo->u.complex->generic->elementSpec = 0;
2608 compo->u.complex->num_dbSpecific = 0;
2609 compo->u.complex->dbSpecific = 0;
2610 compo->u.complex->num_recordSyntax = 0;
2611 compo->u.complex->recordSyntax = 0;
2613 else if (elementSetName && *elementSetName)
2615 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2616 odr_malloc(c->odr_out, sizeof(*esn));
2617 Z_RecordComposition *compo = (Z_RecordComposition *)
2618 odr_malloc(c->odr_out, sizeof(*compo));
2620 esn->which = Z_ElementSetNames_generic;
2621 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2622 compo->which = Z_RecordComp_simple;
2623 compo->u.simple = esn;
2624 req->recordComposition = compo;
2626 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2627 return send_APDU(c, apdu);
2630 ZOOM_API(ZOOM_scanset)
2631 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2634 ZOOM_query q = ZOOM_query_create();
2636 ZOOM_query_prefix(q, start);
2638 s = ZOOM_connection_scan1(c, q);
2639 ZOOM_query_destroy(q);
2644 ZOOM_API(ZOOM_scanset)
2645 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2649 ZOOM_scanset scan = 0;
2652 * We need to check the query-type, so we can recognise CQL and
2653 * CCL and compile them into a form that we can use here. The
2654 * ZOOM_query structure has no explicit `type' member, but
2655 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2656 * functions shows how the structure is set up in each case.
2660 else if (q->z_query->which == Z_Query_type_1)
2662 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2663 c, q, q->query_string);
2664 start = q->query_string;
2666 else if (q->z_query->which == Z_Query_type_104)
2668 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2669 c, q, q->query_string);
2670 start = freeme = cql2pqf(c, q->query_string);
2676 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2677 c, q, q->query_string);
2681 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2682 scan->connection = c;
2683 scan->odr = odr_createmem(ODR_DECODE);
2684 scan->options = ZOOM_options_create_with_parent(c->options);
2686 scan->scan_response = 0;
2687 scan->termListAndStartPoint =
2688 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2691 scan->databaseNames = set_DatabaseNames(c, c->options,
2692 &scan->num_databaseNames,
2694 if (scan->termListAndStartPoint != 0)
2696 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2697 task->u.scan.scan = scan;
2702 while (ZOOM_event(1, &c))
2710 ZOOM_scanset_destroy(ZOOM_scanset scan)
2715 if (scan->refcount == 0)
2717 odr_destroy(scan->odr);
2719 ZOOM_options_destroy(scan->options);
2724 static zoom_ret send_package(ZOOM_connection c)
2728 yaz_log(log_details, "%p send_package", c);
2730 return zoom_complete;
2731 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2733 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2734 ZOOM_connection_put_event(c, event);
2736 c->buf_out = c->tasks->u.package->buf_out;
2737 c->len_out = c->tasks->u.package->len_out;
2742 static zoom_ret send_scan(ZOOM_connection c)
2745 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2746 Z_ScanRequest *req = apdu->u.scanRequest;
2748 yaz_log(log_details, "%p send_scan", c);
2750 return zoom_complete;
2751 assert (c->tasks->which == ZOOM_TASK_SCAN);
2752 scan = c->tasks->u.scan.scan;
2754 req->termListAndStartPoint = scan->termListAndStartPoint;
2755 req->attributeSet = scan->attributeSet;
2757 *req->numberOfTermsRequested =
2758 ZOOM_options_get_int(scan->options, "number", 10);
2760 req->preferredPositionInResponse =
2761 odr_intdup(c->odr_out,
2762 ZOOM_options_get_int(scan->options, "position", 1));
2765 odr_intdup(c->odr_out,
2766 ZOOM_options_get_int(scan->options, "stepSize", 0));
2768 req->databaseNames = scan->databaseNames;
2769 req->num_databaseNames = scan->num_databaseNames;
2771 return send_APDU(c, apdu);
2775 ZOOM_scanset_size(ZOOM_scanset scan)
2777 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2779 return scan->scan_response->entries->num_entries;
2782 ZOOM_API(const char *)
2783 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2786 const char *term = 0;
2787 size_t noent = ZOOM_scanset_size(scan);
2788 Z_ScanResponse *res = scan->scan_response;
2794 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2796 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2798 if (t->term->which == Z_Term_general)
2800 term = (const char *) t->term->u.general->buf;
2801 *len = t->term->u.general->len;
2803 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2808 ZOOM_API(const char *)
2809 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2812 const char *term = 0;
2813 size_t noent = ZOOM_scanset_size(scan);
2814 Z_ScanResponse *res = scan->scan_response;
2820 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2822 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2826 term = t->displayTerm;
2827 *len = strlen(term);
2829 else if (t->term->which == Z_Term_general)
2831 term = (const char *) t->term->u.general->buf;
2832 *len = t->term->u.general->len;
2834 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2839 ZOOM_API(const char *)
2840 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2842 return ZOOM_options_get(scan->options, key);
2846 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2849 ZOOM_options_set(scan->options, key, val);
2852 static Z_APDU *create_es_package(ZOOM_package p, int type)
2855 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2856 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2858 *req->function = Z_ExtendedServicesRequest_create;
2860 str = ZOOM_options_get(p->options, "package-name");
2862 req->packageName = nmem_strdup(p->odr_out->mem, str);
2864 str = ZOOM_options_get(p->options, "user-id");
2866 req->userId = nmem_strdup(p->odr_out->mem, str);
2868 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2871 str = ZOOM_options_get(p->options, "function");
2874 if (!strcmp (str, "create"))
2876 if (!strcmp (str, "delete"))
2878 if (!strcmp (str, "modify"))
2884 static const char *ill_array_lookup(void *clientData, const char *idx)
2886 ZOOM_package p = (ZOOM_package) clientData;
2887 return ZOOM_options_get(p->options, idx+4);
2890 static Z_External *encode_ill_request(ZOOM_package p)
2892 ODR out = p->odr_out;
2895 struct ill_get_ctl ctl;
2897 ctl.odr = p->odr_out;
2899 ctl.f = ill_array_lookup;
2901 req = ill_get_ILLRequest(&ctl, "ill", 0);
2903 if (!ill_Request(out, &req, 0, 0))
2905 int ill_request_size;
2906 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2907 if (ill_request_buf)
2908 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2914 int illRequest_size = 0;
2915 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2917 oid.proto = PROTO_GENERAL;
2918 oid.oclass = CLASS_GENERAL;
2919 oid.value = VAL_ISO_ILL_1;
2921 r = (Z_External *) odr_malloc(out, sizeof(*r));
2922 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2923 r->indirect_reference = 0;
2925 r->which = Z_External_single;
2927 r->u.single_ASN1_type =
2928 odr_create_Odr_oct(out,
2929 (unsigned char *)illRequest_buf,
2935 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2937 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2940 req->which = Z_IOItemOrder_esRequest;
2941 req->u.esRequest = (Z_IORequest *)
2942 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2944 /* to keep part ... */
2945 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2946 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2947 req->u.esRequest->toKeep->supplDescription = 0;
2948 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2949 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2951 str = ZOOM_options_get(p->options, "contact-name");
2952 req->u.esRequest->toKeep->contact->name = str ?
2953 nmem_strdup(p->odr_out->mem, str) : 0;
2955 str = ZOOM_options_get(p->options, "contact-phone");
2956 req->u.esRequest->toKeep->contact->phone = str ?
2957 nmem_strdup(p->odr_out->mem, str) : 0;
2959 str = ZOOM_options_get(p->options, "contact-email");
2960 req->u.esRequest->toKeep->contact->email = str ?
2961 nmem_strdup(p->odr_out->mem, str) : 0;
2963 req->u.esRequest->toKeep->addlBilling = 0;
2965 /* not to keep part ... */
2966 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2967 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2969 str = ZOOM_options_get(p->options, "itemorder-setname");
2974 req->u.esRequest->notToKeep->resultSetItem = 0;
2977 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2978 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2980 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2981 nmem_strdup(p->odr_out->mem, str);
2982 req->u.esRequest->notToKeep->resultSetItem->item =
2983 (int *) odr_malloc(p->odr_out, sizeof(int));
2985 str = ZOOM_options_get(p->options, "itemorder-item");
2986 *req->u.esRequest->notToKeep->resultSetItem->item =
2987 (str ? atoi(str) : 1);
2989 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2994 Z_APDU *create_admin_package(ZOOM_package p, int type,
2995 Z_ESAdminOriginPartToKeep **toKeepP,
2996 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2998 Z_APDU *apdu = create_es_package(p, VAL_ADMINSERVICE);
3001 Z_ESAdminOriginPartToKeep *toKeep;
3002 Z_ESAdminOriginPartNotToKeep *notToKeep;
3003 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3004 const char *first_db = "Default";
3006 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3011 r->direct_reference =
3012 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3015 r->indirect_reference = 0;
3016 r->which = Z_External_ESAdmin;
3018 r->u.adminService = (Z_Admin *)
3019 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3020 r->u.adminService->which = Z_Admin_esRequest;
3021 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3022 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3024 toKeep = r->u.adminService->u.esRequest->toKeep =
3025 (Z_ESAdminOriginPartToKeep *)
3026 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3027 toKeep->which = type;
3028 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3029 toKeep->u.create = odr_nullval();
3030 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3032 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3033 (Z_ESAdminOriginPartNotToKeep *)
3034 odr_malloc(p->odr_out,
3035 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3036 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3037 notToKeep->u.recordsWillFollow = odr_nullval();
3041 *notToKeepP = notToKeep;
3046 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3048 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
3049 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3050 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3051 const char *doc = ZOOM_options_get(p->options, "doc");
3056 req->taskSpecificParameters = ext;
3057 ext->direct_reference = req->packageType;
3058 ext->descriptor = 0;
3059 ext->indirect_reference = 0;
3061 ext->which = Z_External_octet;
3062 ext->u.single_ASN1_type =
3063 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
3068 static Z_APDU *create_update_package(ZOOM_package p)
3071 const char *first_db = "Default";
3073 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3074 const char *action = ZOOM_options_get(p->options, "action");
3075 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
3076 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3077 const char *record_buf = ZOOM_options_get(p->options, "record");
3078 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3079 int syntax_oid = VAL_NONE;
3083 syntax_oid = oid_getvalbyname(syntax_str);
3086 record_buf = "void";
3087 syntax_oid = VAL_SUTRS;
3089 if (syntax_oid == VAL_NONE)
3090 syntax_oid = VAL_TEXT_XML;
3096 action = "specialUpdate";
3098 if (!strcmp(action, "recordInsert"))
3099 action_no = Z_IUOriginPartToKeep_recordInsert;
3100 else if (!strcmp(action, "recordReplace"))
3101 action_no = Z_IUOriginPartToKeep_recordReplace;
3102 else if (!strcmp(action, "recordDelete"))
3103 action_no = Z_IUOriginPartToKeep_recordDelete;
3104 else if (!strcmp(action, "elementUpdate"))
3105 action_no = Z_IUOriginPartToKeep_elementUpdate;
3106 else if (!strcmp(action, "specialUpdate"))
3107 action_no = Z_IUOriginPartToKeep_specialUpdate;
3111 apdu = create_es_package(p, VAL_DBUPDATE);
3114 Z_IUOriginPartToKeep *toKeep;
3115 Z_IUSuppliedRecords *notToKeep;
3116 Z_External *r = (Z_External *)
3117 odr_malloc(p->odr_out, sizeof(*r));
3119 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3121 r->direct_reference =
3122 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3125 r->which = Z_External_update;
3126 r->indirect_reference = 0;
3127 r->u.update = (Z_IUUpdate *)
3128 odr_malloc(p->odr_out, sizeof(*r->u.update));
3130 r->u.update->which = Z_IUUpdate_esRequest;
3131 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3132 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3133 toKeep = r->u.update->u.esRequest->toKeep =
3134 (Z_IUOriginPartToKeep *)
3135 odr_malloc(p->odr_out, sizeof(*toKeep));
3137 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3139 toKeep->elementSetName = 0;
3140 toKeep->actionQualifier = 0;
3141 toKeep->action = odr_intdup(p->odr_out, action_no);
3143 notToKeep = r->u.update->u.esRequest->notToKeep =
3144 (Z_IUSuppliedRecords *)
3145 odr_malloc(p->odr_out, sizeof(*notToKeep));
3147 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3148 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3149 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3150 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3151 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3154 notToKeep->elements[0]->u.opaque =
3155 odr_create_Odr_oct(p->odr_out,
3156 (const unsigned char *) recordIdOpaque,
3157 strlen(recordIdOpaque));
3159 else if (recordIdNumber)
3161 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3163 notToKeep->elements[0]->u.number =
3164 odr_intdup(p->odr_out, atoi(recordIdNumber));
3167 notToKeep->elements[0]->u.opaque = 0;
3168 notToKeep->elements[0]->supplementalId = 0;
3169 notToKeep->elements[0]->correlationInfo = 0;
3170 notToKeep->elements[0]->record =
3171 z_ext_record(p->odr_out, syntax_oid,
3172 record_buf, strlen(record_buf));
3176 ODR print = odr_createmem(ODR_PRINT);
3178 z_APDU(print, &apdu, 0, 0);
3185 ZOOM_package_send(ZOOM_package p, const char *type)
3192 odr_reset(p->odr_out);
3195 if (!strcmp(type, "itemorder"))
3197 apdu = create_es_package(p, VAL_ITEMORDER);
3200 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3202 r->direct_reference =
3203 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3206 r->which = Z_External_itemOrder;
3207 r->indirect_reference = 0;
3208 r->u.itemOrder = encode_item_order(p);
3210 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3213 else if (!strcmp(type, "create")) /* create database */
3215 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3218 else if (!strcmp(type, "drop")) /* drop database */
3220 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3223 else if (!strcmp(type, "commit")) /* commit changes */
3225 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3228 else if (!strcmp(type, "update")) /* update record(s) */
3230 apdu = create_update_package(p);
3232 else if (!strcmp(type, "xmlupdate"))
3234 apdu = create_xmlupdate_package(p);
3238 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3242 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3243 task->u.package = p;
3244 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3245 p->buf_out = (char *) xmalloc(p->len_out);
3246 memcpy(p->buf_out, buf, p->len_out);
3251 while (ZOOM_event(1, &c))
3258 ZOOM_API(ZOOM_package)
3259 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3261 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3264 p->odr_out = odr_createmem(ODR_ENCODE);
3265 p->options = ZOOM_options_create_with_parent2(options, c->options);
3273 ZOOM_package_destroy(ZOOM_package p)
3278 if (p->refcount == 0)
3280 odr_destroy(p->odr_out);
3283 ZOOM_options_destroy(p->options);
3288 ZOOM_API(const char *)
3289 ZOOM_package_option_get(ZOOM_package p, const char *key)
3291 return ZOOM_options_get(p->options, key);
3296 ZOOM_package_option_set(ZOOM_package p, const char *key,
3299 ZOOM_options_set(p->options, key, val);
3302 static int ZOOM_connection_exec_task(ZOOM_connection c)
3304 ZOOM_task task = c->tasks;
3305 zoom_ret ret = zoom_complete;
3309 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3310 c, task->which, task->running);
3311 if (c->error != ZOOM_ERROR_NONE)
3313 yaz_log(YLOG_LOG, "%p ZOOM_connection_exec_task "
3314 "removing tasks because of error = %d", c, c->error);
3315 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3316 "removing tasks because of error = %d", c, c->error);
3317 ZOOM_connection_remove_tasks(c);
3322 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3323 "task already running", c);
3327 ret = zoom_complete;
3328 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3330 switch (task->which)
3332 case ZOOM_TASK_SEARCH:
3333 if (c->proto == PROTO_HTTP)
3334 ret = ZOOM_connection_srw_send_search(c);
3336 ret = ZOOM_connection_send_search(c);
3338 case ZOOM_TASK_RETRIEVE:
3339 if (c->proto == PROTO_HTTP)
3340 ret = ZOOM_connection_srw_send_search(c);
3342 ret = send_present(c);
3344 case ZOOM_TASK_CONNECT:
3345 ret = do_connect(c);
3347 case ZOOM_TASK_SCAN:
3350 case ZOOM_TASK_PACKAGE:
3351 ret = send_package(c);
3353 case ZOOM_TASK_SORT:
3354 c->tasks->u.sort.resultset->r_sort_spec =
3355 c->tasks->u.sort.q->sort_spec;
3356 ret = send_sort(c, c->tasks->u.sort.resultset);
3362 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3363 "remove tasks because no connection exist", c);
3364 ZOOM_connection_remove_tasks(c);
3366 if (ret == zoom_complete)
3368 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3369 "task removed (complete)", c);
3370 ZOOM_connection_remove_task(c);
3373 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3378 static zoom_ret send_sort_present(ZOOM_connection c)
3380 zoom_ret r = zoom_complete;
3382 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3383 r = send_sort(c, c->tasks->u.search.resultset);
3384 if (r == zoom_complete)
3385 r = send_present(c);
3389 static int es_response(ZOOM_connection c,
3390 Z_ExtendedServicesResponse *res)
3392 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3394 if (res->diagnostics && res->num_diagnostics > 0)
3395 response_diag(c, res->diagnostics[0]);
3396 if (res->taskPackage &&
3397 res->taskPackage->which == Z_External_extendedService)
3399 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3400 Odr_oct *id = taskPackage->targetReference;
3403 ZOOM_options_setl(c->tasks->u.package->options,
3404 "targetReference", (char*) id->buf, id->len);
3406 if (res->taskPackage &&
3407 res->taskPackage->which == Z_External_octet)
3409 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3410 ZOOM_options_setl(c->tasks->u.package->options,
3411 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3416 static void interpret_init_diag(ZOOM_connection c,
3417 Z_DiagnosticFormat *diag)
3421 Z_DiagnosticFormat_s *ds = diag->elements[0];
3422 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3423 response_default_diag(c, ds->u.defaultDiagRec);
3428 static void interpret_otherinformation_field(ZOOM_connection c,
3429 Z_OtherInformation *ui)
3432 for (i = 0; i < ui->num_elements; i++)
3434 Z_OtherInformationUnit *unit = ui->list[i];
3435 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3436 unit->information.externallyDefinedInfo &&
3437 unit->information.externallyDefinedInfo->which ==
3440 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3445 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3447 Z_InitResponse *initrs;
3450 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3453 case Z_APDU_initResponse:
3454 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3455 initrs = apdu->u.initResponse;
3456 ZOOM_connection_option_set(c, "serverImplementationId",
3457 initrs->implementationId ?
3458 initrs->implementationId : "");
3459 ZOOM_connection_option_set(c, "serverImplementationName",
3460 initrs->implementationName ?
3461 initrs->implementationName : "");
3462 ZOOM_connection_option_set(c, "serverImplementationVersion",
3463 initrs->implementationVersion ?
3464 initrs->implementationVersion : "");
3465 /* Set the three old options too, for old applications */
3466 ZOOM_connection_option_set(c, "targetImplementationId",
3467 initrs->implementationId ?
3468 initrs->implementationId : "");
3469 ZOOM_connection_option_set(c, "targetImplementationName",
3470 initrs->implementationName ?
3471 initrs->implementationName : "");
3472 ZOOM_connection_option_set(c, "targetImplementationVersion",
3473 initrs->implementationVersion ?
3474 initrs->implementationVersion : "");
3475 if (!*initrs->result)
3477 Z_External *uif = initrs->userInformationField;
3479 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3481 if (uif && uif->which == Z_External_userInfo1)
3482 interpret_otherinformation_field(c, uif->u.userInfo1);
3487 yaz_oi_get_string_oidval(&apdu->u.initResponse->otherInfo,
3489 xfree(c->cookie_in);
3492 c->cookie_in = xstrdup(cookie);
3493 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3494 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3495 c->support_named_resultsets = 1;
3498 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3499 ZOOM_connection_remove_task(c);
3501 ZOOM_connection_exec_task(c);
3503 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3505 NMEM tmpmem = nmem_create();
3506 Z_CharSetandLanguageNegotiation *p =
3507 yaz_get_charneg_record(initrs->otherInfo);
3511 char *charset = NULL, *lang = NULL;
3514 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3515 yaz_log(log_details, "%p recv_apdu target accepted: "
3516 "charset %s, language %s, select %d",
3518 charset ? charset : "none", lang ? lang : "none", sel);
3520 ZOOM_connection_option_set(c, "negotiation-charset",
3523 ZOOM_connection_option_set(c, "negotiation-lang",
3526 ZOOM_connection_option_set(
3527 c, "negotiation-charset-in-effect-for-records",
3528 (sel != 0) ? "1" : "0");
3529 nmem_destroy(tmpmem);
3533 case Z_APDU_searchResponse:
3534 yaz_log(log_api, "%p recv_apdu Search response", c);
3535 handle_search_response(c, apdu->u.searchResponse);
3536 if (send_sort_present(c) == zoom_complete)
3537 ZOOM_connection_remove_task(c);
3539 case Z_APDU_presentResponse:
3540 yaz_log(log_api, "%p recv_apdu Present response", c);
3541 handle_present_response(c, apdu->u.presentResponse);
3542 if (send_present(c) == zoom_complete)
3543 ZOOM_connection_remove_task(c);
3545 case Z_APDU_sortResponse:
3546 yaz_log(log_api, "%p recv_apdu Sort response", c);
3547 sort_response(c, apdu->u.sortResponse);
3548 if (send_present(c) == zoom_complete)
3549 ZOOM_connection_remove_task(c);
3551 case Z_APDU_scanResponse:
3552 yaz_log(log_api, "%p recv_apdu Scan response", c);
3553 scan_response(c, apdu->u.scanResponse);
3554 ZOOM_connection_remove_task(c);
3556 case Z_APDU_extendedServicesResponse:
3557 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3558 es_response(c, apdu->u.extendedServicesResponse);
3559 ZOOM_connection_remove_task(c);
3562 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3563 if (!ZOOM_test_reconnect(c))
3565 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3570 yaz_log(log_api, "%p Received unknown PDU", c);
3571 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3577 static void handle_srw_response(ZOOM_connection c,
3578 Z_SRW_searchRetrieveResponse *res)
3580 ZOOM_resultset resultset = 0;
3585 const char *syntax, *elementSetName;
3590 switch(c->tasks->which)
3592 case ZOOM_TASK_SEARCH:
3593 resultset = c->tasks->u.search.resultset;
3594 start = &c->tasks->u.search.start;
3595 syntax = c->tasks->u.search.syntax;
3596 elementSetName = c->tasks->u.search.elementSetName;
3598 case ZOOM_TASK_RETRIEVE:
3599 resultset = c->tasks->u.retrieve.resultset;
3600 start = &c->tasks->u.retrieve.start;
3601 syntax = c->tasks->u.retrieve.syntax;
3602 elementSetName = c->tasks->u.retrieve.elementSetName;
3607 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3608 ZOOM_connection_put_event(c, event);
3610 resultset->size = 0;
3612 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3614 if (res->numberOfRecords)
3615 resultset->size = *res->numberOfRecords;
3617 for (i = 0; i<res->num_records; i++)
3621 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3622 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3624 if (res->records[i].recordPosition &&
3625 *res->records[i].recordPosition > 0)
3626 pos = *res->records[i].recordPosition - 1;
3630 npr->databaseName = 0;
3631 npr->which = Z_NamePlusRecord_databaseRecord;
3632 npr->u.databaseRecord = (Z_External *)
3633 odr_malloc(c->odr_in, sizeof(Z_External));
3634 npr->u.databaseRecord->descriptor = 0;
3635 npr->u.databaseRecord->direct_reference =
3636 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3637 npr->u.databaseRecord->which = Z_External_octet;
3639 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3640 odr_malloc(c->odr_in, sizeof(Odr_oct));
3641 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3642 res->records[i].recordData_buf;
3643 npr->u.databaseRecord->u.octet_aligned->len =
3644 npr->u.databaseRecord->u.octet_aligned->size =
3645 res->records[i].recordData_len;
3646 record_cache_add(resultset, npr, pos, syntax, elementSetName);
3648 if (res->num_diagnostics > 0)
3650 const char *uri = res->diagnostics[0].uri;
3655 if ((cp = strrchr(uri, '/')))
3657 set_dset_error(c, code, uri,
3658 res->diagnostics[0].details, 0);
3661 nmem = odr_extract_mem(c->odr_in);
3662 nmem_transfer(resultset->odr->mem, nmem);
3668 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3671 const char *content_type = z_HTTP_header_lookup(hres->headers,
3673 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3676 yaz_log(log_details, "%p handle_http", c);
3678 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3680 Z_SOAP *soap_package = 0;
3682 Z_SOAP_Handler soap_handlers[2] = {
3683 {"http://www.loc.gov/zing/srw/", 0,
3684 (Z_SOAP_fun) yaz_srw_codec},
3687 ret = z_soap_codec(o, &soap_package,
3688 &hres->content_buf, &hres->content_len,
3690 if (!ret && soap_package->which == Z_SOAP_generic &&
3691 soap_package->u.generic->no == 0)
3693 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3694 if (sr->which == Z_SRW_searchRetrieve_response)
3695 handle_srw_response(c, sr->u.response);
3699 else if (!ret && (soap_package->which == Z_SOAP_fault
3700 || soap_package->which == Z_SOAP_error))
3702 set_HTTP_error(c, hres->code,
3703 soap_package->u.fault->fault_code,
3704 soap_package->u.fault->fault_string);
3711 if (hres->code != 200)
3712 set_HTTP_error(c, hres->code, 0, 0);
3714 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3717 ZOOM_connection_remove_task(c);
3718 if (!strcmp(hres->version, "1.0"))
3720 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3721 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3726 /* HTTP 1.1: only if no close we stay alive .. */
3727 if (connection_head && !strcmp(connection_head, "close"))
3733 static int do_read(ZOOM_connection c)
3738 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3739 ZOOM_connection_put_event(c, event);
3741 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3742 more = cs_more(c->cs);
3743 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3748 if (ZOOM_test_reconnect(c))
3750 yaz_log(log_details, "%p do_read reconnect read", c);
3754 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3763 odr_reset(c->odr_in);
3764 odr_setbuf(c->odr_in, c->buf_in, r, 0);
3765 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3766 ZOOM_connection_put_event(c, event);
3768 if (!z_GDU(c->odr_in, &gdu, 0, 0))
3771 int err = odr_geterrorx(c->odr_in, &x);
3773 const char *element = odr_getelement(c->odr_in);
3774 sprintf(msg, "ODR code %d:%d element=%-20s",
3775 err, x, element ? element : "<unknown>");
3776 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3779 else if (gdu->which == Z_GDU_Z3950)
3780 recv_apdu(c, gdu->u.z3950);
3781 else if (gdu->which == Z_GDU_HTTP_Response)
3784 handle_http(c, gdu->u.HTTP_Response);
3786 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3790 c->reconnect_ok = 0;
3795 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3800 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3801 ZOOM_connection_put_event(c, event);
3803 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3804 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3806 yaz_log(log_details, "%p do_write_ex write failed", c);
3807 if (ZOOM_test_reconnect(c))
3809 return zoom_pending;
3811 if (c->state == STATE_CONNECTING)
3812 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3814 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3816 return zoom_complete;
3820 c->mask = ZOOM_SELECT_EXCEPT;
3821 if (c->cs->io_pending & CS_WANT_WRITE)
3822 c->mask += ZOOM_SELECT_WRITE;
3823 if (c->cs->io_pending & CS_WANT_READ)
3824 c->mask += ZOOM_SELECT_READ;
3825 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3830 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3831 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3834 return zoom_pending;
3837 static zoom_ret do_write(ZOOM_connection c)
3839 return do_write_ex(c, c->buf_out, c->len_out);
3843 ZOOM_API(const char *)
3844 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3846 return ZOOM_options_get(c->options, key);
3849 ZOOM_API(const char *)
3850 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3852 return ZOOM_options_getl(c->options, key, lenp);
3856 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3859 ZOOM_options_set(c->options, key, val);
3863 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3864 const char *val, int len)
3866 ZOOM_options_setl(c->options, key, val, len);
3869 ZOOM_API(const char *)
3870 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3872 return ZOOM_options_get(r->options, key);
3876 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3879 ZOOM_options_set(r->options, key, val);
3884 ZOOM_connection_errcode(ZOOM_connection c)
3886 return ZOOM_connection_error(c, 0, 0);
3889 ZOOM_API(const char *)
3890 ZOOM_connection_errmsg(ZOOM_connection c)
3893 ZOOM_connection_error(c, &msg, 0);
3897 ZOOM_API(const char *)
3898 ZOOM_connection_addinfo(ZOOM_connection c)
3900 const char *addinfo;
3901 ZOOM_connection_error(c, 0, &addinfo);
3905 ZOOM_API(const char *)
3906 ZOOM_connection_diagset(ZOOM_connection c)
3908 const char *diagset;
3909 ZOOM_connection_error_x(c, 0, 0, &diagset);
3913 ZOOM_API(const char *)
3914 ZOOM_diag_str(int error)
3918 case ZOOM_ERROR_NONE:
3920 case ZOOM_ERROR_CONNECT:
3921 return "Connect failed";
3922 case ZOOM_ERROR_MEMORY:
3923 return "Out of memory";
3924 case ZOOM_ERROR_ENCODE:
3925 return "Encoding failed";
3926 case ZOOM_ERROR_DECODE:
3927 return "Decoding failed";
3928 case ZOOM_ERROR_CONNECTION_LOST:
3929 return "Connection lost";
3930 case ZOOM_ERROR_INIT:
3931 return "Init rejected";
3932 case ZOOM_ERROR_INTERNAL:
3933 return "Internal failure";
3934 case ZOOM_ERROR_TIMEOUT:
3936 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3937 return "Unsupported protocol";
3938 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3939 return "Unsupported query type";
3940 case ZOOM_ERROR_INVALID_QUERY:
3941 return "Invalid query";
3942 case ZOOM_ERROR_CQL_PARSE:
3943 return "CQL parsing error";
3944 case ZOOM_ERROR_CQL_TRANSFORM:
3945 return "CQL transformation error";
3946 case ZOOM_ERROR_CCL_CONFIG:
3947 return "CCL configuration error";
3948 case ZOOM_ERROR_CCL_PARSE:
3949 return "CCL parsing error";
3951 return diagbib1_str(error);
3956 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
3957 const char **addinfo, const char **diagset)
3959 int error = c->error;
3962 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3963 *cp = ZOOM_diag_str(error);
3964 else if (!strcmp(c->diagset, "HTTP"))
3965 *cp = z_HTTP_errmsg(c->error);
3966 else if (!strcmp(c->diagset, "Bib-1"))
3967 *cp = ZOOM_diag_str(error);
3968 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3969 *cp = yaz_diag_srw_str(c->error);
3971 *cp = "Unknown error and diagnostic set";
3974 *addinfo = c->addinfo ? c->addinfo : "";
3976 *diagset = c->diagset ? c->diagset : "";
3981 ZOOM_connection_error(ZOOM_connection c, const char **cp,
3982 const char **addinfo)
3984 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3987 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
3989 ZOOM_Event event = 0;
3990 int r = cs_look(c->cs);
3991 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
3996 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
3997 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3999 ZOOM_connection_put_event(c, event);
4001 else if (r == CS_CONNECT)
4003 int ret = ret = cs_rcvconnect(c->cs);
4004 yaz_log(log_details, "%p ZOOM_connection_do_io "
4005 "cs_rcvconnect returned %d", c, ret);
4008 c->mask = ZOOM_SELECT_EXCEPT;
4009 if (c->cs->io_pending & CS_WANT_WRITE)
4010 c->mask += ZOOM_SELECT_WRITE;
4011 if (c->cs->io_pending & CS_WANT_READ)
4012 c->mask += ZOOM_SELECT_READ;
4016 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4017 ZOOM_connection_put_event(c, event);
4019 if (c->proto == PROTO_Z3950)
4020 ZOOM_connection_send_init(c);
4023 /* no init request for SRW .. */
4024 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4025 ZOOM_connection_remove_task(c);
4027 ZOOM_connection_exec_task(c);
4029 c->state = STATE_ESTABLISHED;
4033 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4039 if (mask & ZOOM_SELECT_EXCEPT)
4041 if (ZOOM_test_reconnect(c))
4043 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4044 ZOOM_connection_put_event(c, event);
4048 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4053 if (mask & ZOOM_SELECT_READ)
4055 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4061 ZOOM_connection_last_event(ZOOM_connection cs)
4064 return ZOOM_EVENT_NONE;
4065 return cs->last_event;
4069 ZOOM_event(int no, ZOOM_connection *cs)
4071 int timeout = 30; /* default timeout in seconds */
4072 int timeout_set = 0; /* whether it was overriden at all */
4074 struct pollfd pollfds[1024];
4075 ZOOM_connection poll_cs[1024];
4078 fd_set input, output, except;
4083 yaz_log(log_details, "ZOOM_event(no=%d,cs=%p)", no, cs);
4085 for (i = 0; i<no; i++)
4087 ZOOM_connection c = cs[i];
4092 ZOOM_connection_show_tasks(c);
4095 if (c && (event = ZOOM_connection_get_event(c)))
4097 ZOOM_Event_destroy(event);
4101 for (i = 0; i<no; i++)
4103 ZOOM_connection c = cs[i];
4107 ZOOM_connection_exec_task(c);
4108 if ((event = ZOOM_connection_get_event(c)))
4110 ZOOM_Event_destroy(event);
4123 for (i = 0; i<no; i++)
4125 ZOOM_connection c = cs[i];
4131 fd = z3950_connection_socket(c);
4132 mask = z3950_connection_mask(c);
4139 /* -1 is used for indefinite timeout (no timeout), so -2 here. */
4140 this_timeout = ZOOM_options_get_int(c->options, "timeout", -2);
4141 if (this_timeout != -2)
4143 /* ensure the minimum timeout is used */
4145 timeout = this_timeout;
4146 else if (this_timeout != -1 && this_timeout < timeout)
4147 timeout = this_timeout;
4153 short poll_events = 0;
4155 if (mask & ZOOM_SELECT_READ)
4156 poll_events += POLLIN;
4157 if (mask & ZOOM_SELECT_WRITE)
4158 poll_events += POLLOUT;
4159 if (mask & ZOOM_SELECT_EXCEPT)
4160 poll_events += POLLERR;
4161 pollfds[nfds].fd = fd;
4162 pollfds[nfds].events = poll_events;
4163 pollfds[nfds].revents = 0;
4168 if (mask & ZOOM_SELECT_READ)
4173 if (mask & ZOOM_SELECT_WRITE)
4175 FD_SET(fd, &output);
4178 if (mask & ZOOM_SELECT_EXCEPT)
4180 FD_SET(fd, &except);
4189 r = poll(pollfds, nfds, (timeout == -1 ? -1 : timeout * 1000));
4190 for (i = 0; i<nfds; i++)
4192 ZOOM_connection c = poll_cs[i];
4196 if (pollfds[i].revents & POLLIN)
4197 mask += ZOOM_SELECT_READ;
4198 if (pollfds[i].revents & POLLOUT)
4199 mask += ZOOM_SELECT_WRITE;
4200 if (pollfds[i].revents & POLLERR)
4201 mask += ZOOM_SELECT_EXCEPT;
4203 ZOOM_connection_do_io(c, mask);
4205 else if (r == 0 && c->mask)
4207 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4208 /* timeout and this connection was waiting */
4209 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4211 ZOOM_connection_put_event(c, event);
4215 tv.tv_sec = timeout;
4217 r = select(max_fd+1, &input, &output, &except, (timeout == -1 ? 0 : &tv));
4218 for (i = 0; i<no; i++)
4220 ZOOM_connection c = cs[i];
4225 fd = z3950_connection_socket(c);
4229 /* no timeout and real socket */
4230 if (FD_ISSET(fd, &input))
4231 mask += ZOOM_SELECT_READ;
4232 if (FD_ISSET(fd, &output))
4233 mask += ZOOM_SELECT_WRITE;
4234 if (FD_ISSET(fd, &except))
4235 mask += ZOOM_SELECT_EXCEPT;
4237 ZOOM_connection_do_io(c, mask);
4239 if (r == 0 && c->mask)
4241 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4242 /* timeout and this connection was waiting */
4243 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4245 ZOOM_connection_put_event(c, event);
4249 for (i = 0; i<no; i++)
4251 ZOOM_connection c = cs[i];
4253 if (c && (event = ZOOM_connection_get_event(c)))
4255 ZOOM_Event_destroy(event);
4264 * Returns an xmalloc()d string containing RPN that corresponds to the
4265 * CQL passed in. On error, sets the Connection object's error state
4266 * and returns a null pointer.
4267 * ### We could cache CQL parser and/or transformer in Connection.
4269 static char *cql2pqf(ZOOM_connection c, const char *cql)
4273 struct cql_node *node;
4274 const char *cqlfile;
4275 static cql_transform_t trans;
4278 parser = cql_parser_create();
4279 if ((error = cql_parser_string(parser, cql)) != 0) {
4280 cql_parser_destroy(parser);
4281 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4285 node = cql_parser_result(parser);
4286 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4288 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4290 cql_parser_destroy(parser);
4291 cql_node_destroy(node);
4292 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4296 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4298 cql_parser_destroy(parser);
4299 cql_node_destroy(node);
4300 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4301 cqlfile, strerror(errno));
4302 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4306 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4307 cql_parser_destroy(parser);
4308 cql_node_destroy(node);
4311 const char *addinfo;
4312 error = cql_transform_error(trans, &addinfo);
4313 cql_transform_close(trans);
4314 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4315 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4319 cql_transform_close(trans);
4320 return xstrdup(pqfbuf);
4326 * indent-tabs-mode: nil
4328 * vim: shiftwidth=4 tabstop=8 expandtab