1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2008 Index Data
3 * See the file LICENSE for details.
7 * \brief Implements ZOOM C interface.
15 #include <yaz/yaz-util.h>
16 #include <yaz/xmalloc.h>
17 #include <yaz/otherinfo.h>
19 #include <yaz/pquery.h>
20 #include <yaz/marcdisp.h>
21 #include <yaz/diagbib1.h>
22 #include <yaz/charneg.h>
27 #include <yaz/query-charset.h>
28 #include <yaz/copy_types.h>
29 #include <yaz/snprintf.h>
31 static int log_api = 0;
32 static int log_details = 0;
39 static void resultset_destroy(ZOOM_resultset r);
40 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
41 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
42 static char *cql2pqf(ZOOM_connection c, const char *cql);
46 * This wrapper is just for logging failed lookups. It would be nicer
47 * if it could cause failure when a lookup fails, but that's hard.
49 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
50 oid_class oid_class, const char *str) {
51 Odr_oid *res = yaz_string_to_oid_odr(yaz_oid_std(), oid_class, str,
54 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
55 c, (int) oid_class, str);
60 static void initlog(void)
62 static int log_level_initialized = 0;
63 if (!log_level_initialized)
65 log_api = yaz_log_module_level("zoom");
66 log_details = yaz_log_module_level("zoomdetails");
67 log_level_initialized = 1;
71 static ZOOM_Event ZOOM_Event_create(int kind)
73 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
77 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
81 static void ZOOM_Event_destroy(ZOOM_Event event)
86 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
90 c->m_queue_back->prev = event;
91 assert(c->m_queue_front);
95 assert(!c->m_queue_front);
96 c->m_queue_front = event;
98 event->next = c->m_queue_back;
100 c->m_queue_back = event;
103 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
105 ZOOM_Event event = c->m_queue_front;
108 c->last_event = ZOOM_EVENT_NONE;
111 assert(c->m_queue_back);
112 c->m_queue_front = event->prev;
113 if (c->m_queue_front)
115 assert(c->m_queue_back);
116 c->m_queue_front->next = 0;
120 c->last_event = event->kind;
124 static void ZOOM_connection_remove_events(ZOOM_connection c)
127 while ((event = ZOOM_connection_get_event(c)))
128 ZOOM_Event_destroy(event);
131 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
133 ZOOM_Event event = c->m_queue_front;
135 return event ? event->kind : ZOOM_EVENT_NONE;
138 void ZOOM_connection_remove_tasks(ZOOM_connection c);
140 static void set_dset_error(ZOOM_connection c, int error,
142 const char *addinfo, const char *addinfo2)
149 if (!c->diagset || strcmp(dset, c->diagset))
152 c->diagset = xstrdup(dset);
153 /* remove integer part from SRW diagset .. */
154 if ((cp = strrchr(c->diagset, '/')))
157 if (addinfo && addinfo2)
159 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
160 strcpy(c->addinfo, addinfo);
161 strcat(c->addinfo, addinfo2);
164 c->addinfo = xstrdup(addinfo);
165 if (error != ZOOM_ERROR_NONE)
167 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
168 c, c->host_port ? c->host_port : "<>", dset, error,
169 addinfo ? addinfo : "",
170 addinfo2 ? addinfo2 : "");
171 ZOOM_connection_remove_tasks(c);
175 static int uri_to_code(const char *uri)
179 if ((cp = strrchr(uri, '/')))
185 static void set_HTTP_error(ZOOM_connection c, int error,
186 const char *addinfo, const char *addinfo2)
188 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
191 static void set_SRU_error(ZOOM_connection c, Z_SRW_diagnostic *d)
193 const char *uri = d->uri;
195 set_dset_error(c, uri_to_code(uri), uri, d->details, 0);
201 static void set_ZOOM_error(ZOOM_connection c, int error,
204 set_dset_error(c, error, "ZOOM", addinfo, 0);
207 static void clear_error(ZOOM_connection c)
210 * If an error is tied to an operation then it's ok to clear: for
211 * example, a diagnostic returned from a search is cleared by a
212 * subsequent search. However, problems such as Connection Lost
213 * or Init Refused are not cleared, because they are not
214 * recoverable: doing another search doesn't help.
217 ZOOM_connection_remove_events(c);
220 case ZOOM_ERROR_CONNECT:
221 case ZOOM_ERROR_MEMORY:
222 case ZOOM_ERROR_DECODE:
223 case ZOOM_ERROR_CONNECTION_LOST:
224 case ZOOM_ERROR_INIT:
225 case ZOOM_ERROR_INTERNAL:
226 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
229 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
233 void ZOOM_connection_show_task(ZOOM_task task)
237 case ZOOM_TASK_SEARCH:
238 yaz_log(YLOG_LOG, "search p=%p", task);
240 case ZOOM_TASK_RETRIEVE:
241 yaz_log(YLOG_LOG, "retrieve p=%p", task);
243 case ZOOM_TASK_CONNECT:
244 yaz_log(YLOG_LOG, "connect p=%p", task);
247 yaz_log(YLOG_LOG, "scant p=%p", task);
252 void ZOOM_connection_show_tasks(ZOOM_connection c)
255 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
256 for (task = c->tasks; task; task = task->next)
257 ZOOM_connection_show_task(task);
260 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
262 ZOOM_task *taskp = &c->tasks;
264 taskp = &(*taskp)->next;
265 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
266 (*taskp)->running = 0;
267 (*taskp)->which = which;
273 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
275 return c->tasks ? 0 : 1;
278 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
280 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
282 task->next = c->tasks;
291 void ZOOM_connection_remove_task(ZOOM_connection c)
293 ZOOM_task task = c->tasks;
297 c->tasks = task->next;
300 case ZOOM_TASK_SEARCH:
301 resultset_destroy(task->u.search.resultset);
302 xfree(task->u.search.syntax);
303 xfree(task->u.search.elementSetName);
305 case ZOOM_TASK_RETRIEVE:
306 resultset_destroy(task->u.retrieve.resultset);
307 xfree(task->u.retrieve.syntax);
308 xfree(task->u.retrieve.elementSetName);
310 case ZOOM_TASK_CONNECT:
313 ZOOM_scanset_destroy(task->u.scan.scan);
315 case ZOOM_TASK_PACKAGE:
316 ZOOM_package_destroy(task->u.package);
319 resultset_destroy(task->u.sort.resultset);
320 ZOOM_query_destroy(task->u.sort.q);
329 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
330 ZOOM_connection_put_event(c, event);
335 static int ZOOM_connection_exec_task(ZOOM_connection c);
337 void ZOOM_connection_remove_tasks(ZOOM_connection c)
340 ZOOM_connection_remove_task(c);
343 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
345 const char *elementSetName);
347 ZOOM_API(ZOOM_connection)
348 ZOOM_connection_create(ZOOM_options options)
350 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
354 yaz_log(log_api, "%p ZOOM_connection_create", c);
356 c->proto = PROTO_Z3950;
358 ZOOM_connection_set_mask(c, 0);
360 c->state = STATE_IDLE;
363 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
370 c->options = ZOOM_options_create_with_parent(options);
376 c->charset = c->lang = 0;
387 c->maximum_record_size = 0;
388 c->preferred_message_size = 0;
390 c->odr_in = odr_createmem(ODR_DECODE);
391 c->odr_out = odr_createmem(ODR_ENCODE);
394 c->support_named_resultsets = 0;
395 c->last_event = ZOOM_EVENT_NONE;
397 c->m_queue_front = 0;
405 /* set database names. Take local databases (if set); otherwise
406 take databases given in ZURL (if set); otherwise use Default */
407 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
410 char **databaseNames;
411 const char *cp = ZOOM_options_get(options, "databaseName");
413 if ((!cp || !*cp) && con->host_port)
415 if (strncmp(con->host_port, "unix:", 5) == 0)
416 cp = strchr(con->host_port+5, ':');
418 cp = strchr(con->host_port, '/');
424 nmem_strsplit(odr_getmem(odr), "+", cp, &databaseNames, num);
425 return databaseNames;
428 ZOOM_API(ZOOM_connection)
429 ZOOM_connection_new(const char *host, int portnum)
431 ZOOM_connection c = ZOOM_connection_create(0);
433 ZOOM_connection_connect(c, host, portnum);
437 static zoom_sru_mode get_sru_mode_from_string(const char *s)
440 return zoom_sru_soap;
441 if (!yaz_matchstr(s, "soap"))
442 return zoom_sru_soap;
443 else if (!yaz_matchstr(s, "get"))
445 else if (!yaz_matchstr(s, "post"))
446 return zoom_sru_post;
447 return zoom_sru_error;
451 ZOOM_connection_connect(ZOOM_connection c,
452 const char *host, int portnum)
459 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
460 c, host ? host : "null", portnum);
462 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
463 ZOOM_connection_remove_tasks(c);
467 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
471 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
474 val = ZOOM_options_get(c->options, "proxy");
477 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
478 c->proxy = xstrdup(val);
483 val = ZOOM_options_get(c->options, "charset");
486 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
487 c->charset = xstrdup(val);
491 val = ZOOM_options_get(c->options, "lang");
494 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
495 c->lang = xstrdup(val);
506 sprintf(hostn, "%.80s:%d", host, portnum);
507 c->host_port = xstrdup(hostn);
510 c->host_port = xstrdup(host);
515 * If the "<scheme>:" part of the host string is preceded by one
516 * or more comma-separated <name>=<value> pairs, these are taken
517 * to be options to be set on the connection object. Among other
518 * applications, this facility can be used to embed authentication
520 * user=admin,password=secret,tcp:localhost:9999
522 char *remainder = c->host_port;
523 char *pcolon = strchr(remainder, ':');
526 while ((pcomma = strchr(remainder, ',')) != 0 &&
527 (pcolon == 0 || pcomma < pcolon)) {
529 if ((pequals = strchr(remainder, '=')) != 0) {
531 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
532 ZOOM_connection_option_set(c, remainder, pequals+1);
534 remainder = pcomma+1;
537 if (remainder != c->host_port) {
539 c->host_port = xstrdup(remainder);
540 /*printf("# reset hp='%s'\n", remainder);*/
544 val = ZOOM_options_get(c->options, "sru");
545 c->sru_mode = get_sru_mode_from_string(val);
547 xfree(c->sru_version);
548 val = ZOOM_options_get(c->options, "sru_version");
549 c->sru_version = xstrdup(val ? val : "1.2");
551 ZOOM_options_set(c->options, "host", c->host_port);
553 xfree(c->cookie_out);
555 val = ZOOM_options_get(c->options, "cookie");
558 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
559 c->cookie_out = xstrdup(val);
564 val = ZOOM_options_get(c->options, "clientIP");
567 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
569 c->client_IP = xstrdup(val);
574 val = ZOOM_options_get(c->options, "group");
576 c->group = xstrdup(val);
580 val = ZOOM_options_get(c->options, "user");
582 c->user = xstrdup(val);
586 val = ZOOM_options_get(c->options, "password");
588 val = ZOOM_options_get(c->options, "pass");
591 c->password = xstrdup(val);
593 c->maximum_record_size =
594 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
595 c->preferred_message_size =
596 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
598 c->async = ZOOM_options_get_bool(c->options, "async", 0);
599 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
601 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
605 while (ZOOM_event(1, &c))
611 ZOOM_query_create(void)
613 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
615 yaz_log(log_details, "%p ZOOM_query_create", s);
619 s->odr = odr_createmem(ODR_ENCODE);
626 ZOOM_query_destroy(ZOOM_query s)
632 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
633 if (s->refcount == 0)
641 ZOOM_query_prefix(ZOOM_query s, const char *str)
643 s->query_string = odr_strdup(s->odr, str);
644 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
645 s->z_query->which = Z_Query_type_1;
646 s->z_query->u.type_1 = p_query_rpn(s->odr, str);
647 if (!s->z_query->u.type_1)
649 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
653 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
658 ZOOM_query_cql(ZOOM_query s, const char *str)
662 s->query_string = odr_strdup(s->odr, str);
664 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
665 ext->direct_reference = odr_oiddup(s->odr, yaz_oid_userinfo_cql);
666 ext->indirect_reference = 0;
668 ext->which = Z_External_CQL;
669 ext->u.cql = s->query_string;
671 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
672 s->z_query->which = Z_Query_type_104;
673 s->z_query->u.type_104 = ext;
675 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
681 * Translate the CQL string client-side into RPN which is passed to
682 * the server. This is useful for server's that don't themselves
683 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
684 * only as a place to stash diagnostics if compilation fails; if this
685 * information is not needed, a null pointer may be used.
688 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
692 ZOOM_connection freeme = 0;
694 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
696 conn = freeme = ZOOM_connection_create(0);
698 rpn = cql2pqf(conn, str);
700 ZOOM_connection_destroy(freeme);
704 ret = ZOOM_query_prefix(s, rpn);
710 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
711 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
712 * to the server, as the YAZ GFS doesn't know how to handle this.
715 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
716 int *ccl_error, const char **error_string,
720 struct ccl_rpn_node *rpn;
721 CCL_bibset bibset = ccl_qual_mk();
724 ccl_qual_buf(bibset, config);
726 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
729 *error_string = ccl_err_msg(*ccl_error);
734 WRBUF wr = wrbuf_alloc();
737 ret = ZOOM_query_prefix(s, wrbuf_cstr(wr));
740 ccl_qual_rm(&bibset);
745 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
747 s->sort_spec = yaz_sort_spec(s->odr, criteria);
750 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
754 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
758 static zoom_ret do_write(ZOOM_connection c);
761 ZOOM_connection_destroy(ZOOM_connection c)
766 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
769 for (r = c->resultsets; r; r = r->next)
775 odr_destroy(c->odr_in);
776 odr_destroy(c->odr_out);
777 ZOOM_options_destroy(c->options);
778 ZOOM_connection_remove_tasks(c);
779 ZOOM_connection_remove_events(c);
785 xfree(c->cookie_out);
791 xfree(c->sru_version);
795 void ZOOM_resultset_addref(ZOOM_resultset r)
800 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
805 ZOOM_resultset ZOOM_resultset_create(void)
808 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
812 yaz_log(log_details, "%p ZOOM_resultset_create", r);
815 r->odr = odr_createmem(ODR_ENCODE);
820 for (i = 0; i<RECORD_HASH_SIZE; i++)
821 r->record_hash[i] = 0;
826 r->databaseNames = 0;
827 r->num_databaseNames = 0;
831 ZOOM_API(ZOOM_resultset)
832 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
835 ZOOM_query s = ZOOM_query_create();
837 ZOOM_query_prefix(s, q);
839 r = ZOOM_connection_search(c, s);
840 ZOOM_query_destroy(s);
844 ZOOM_API(ZOOM_resultset)
845 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
847 ZOOM_resultset r = ZOOM_resultset_create();
851 const char *syntax, *elementSetName;
853 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
854 r->r_sort_spec = q->sort_spec;
857 r->options = ZOOM_options_create_with_parent(c->options);
859 start = ZOOM_options_get_int(r->options, "start", 0);
860 count = ZOOM_options_get_int(r->options, "count", 0);
862 /* If "presentChunk" is defined use that; otherwise "step" */
863 const char *cp = ZOOM_options_get(r->options, "presentChunk");
864 r->step = ZOOM_options_get_int(r->options,
865 (cp != 0 ? "presentChunk": "step"), 0);
867 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
868 cp = ZOOM_options_get(r->options, "setname");
870 r->setname = xstrdup(cp);
871 cp = ZOOM_options_get(r->options, "schema");
873 r->schema = xstrdup(cp);
875 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
880 r->next = c->resultsets;
885 if (c->host_port && c->proto == PROTO_HTTP)
889 yaz_log(log_details, "ZOOM_connection_search: no comstack");
890 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
894 yaz_log(log_details, "ZOOM_connection_search: reconnect");
899 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
900 task->u.search.resultset = r;
901 task->u.search.start = start;
902 task->u.search.count = count;
904 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
905 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
906 elementSetName = ZOOM_options_get(r->options, "elementSetName");
907 task->u.search.elementSetName = elementSetName
908 ? xstrdup(elementSetName) : 0;
910 ZOOM_resultset_addref(r);
916 while (ZOOM_event(1, &c))
923 ZOOM_resultset_sort(ZOOM_resultset r,
924 const char *sort_type, const char *sort_spec)
926 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
930 ZOOM_resultset_sort1(ZOOM_resultset r,
931 const char *sort_type, const char *sort_spec)
933 ZOOM_connection c = r->connection;
937 newq = ZOOM_query_create();
938 if (ZOOM_query_sortby(newq, sort_spec) < 0)
941 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
942 r, r, sort_type, sort_spec);
946 if (c->host_port && c->proto == PROTO_HTTP)
950 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
951 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
955 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
961 ZOOM_resultset_cache_reset(r);
962 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
963 task->u.sort.resultset = r;
964 task->u.sort.q = newq;
966 ZOOM_resultset_addref(r);
970 while (ZOOM_event(1, &c))
978 ZOOM_resultset_cache_reset(ZOOM_resultset r)
981 for (i = 0; i<RECORD_HASH_SIZE; i++)
983 ZOOM_record_cache rc;
984 for (rc = r->record_hash[i]; rc; rc = rc->next)
986 if (rc->rec.wrbuf_marc)
987 wrbuf_destroy(rc->rec.wrbuf_marc);
988 if (rc->rec.wrbuf_iconv)
989 wrbuf_destroy(rc->rec.wrbuf_iconv);
990 if (rc->rec.wrbuf_opac)
991 wrbuf_destroy(rc->rec.wrbuf_opac);
993 r->record_hash[i] = 0;
998 ZOOM_resultset_destroy(ZOOM_resultset r)
1000 resultset_destroy(r);
1003 static void resultset_destroy(ZOOM_resultset r)
1008 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
1010 if (r->refcount == 0)
1012 ZOOM_resultset_cache_reset(r);
1016 /* remove ourselves from the resultsets in connection */
1017 ZOOM_resultset *rp = &r->connection->resultsets;
1020 assert(*rp); /* we must be in this list!! */
1022 { /* OK, we're here - take us out of it */
1029 ZOOM_query_destroy(r->query);
1030 ZOOM_options_destroy(r->options);
1031 odr_destroy(r->odr);
1039 ZOOM_resultset_size(ZOOM_resultset r)
1041 yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
1046 static void do_close(ZOOM_connection c)
1051 ZOOM_connection_set_mask(c, 0);
1052 c->state = STATE_IDLE;
1055 static int ZOOM_test_reconnect(ZOOM_connection c)
1059 if (!c->reconnect_ok)
1062 c->reconnect_ok = 0;
1063 c->tasks->running = 0;
1064 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1066 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1067 ZOOM_connection_put_event(c, event);
1072 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1073 int force_sync, int start, int count)
1078 const char *syntax, *elementSetName;
1082 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1083 " count=%d", r, force_sync, start, count);
1088 if (c->host_port && c->proto == PROTO_HTTP)
1092 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1093 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1097 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1099 c->reconnect_ok = 1;
1102 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1103 task->u.retrieve.resultset = r;
1104 task->u.retrieve.start = start;
1105 task->u.retrieve.count = count;
1107 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1108 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1109 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1110 task->u.retrieve.elementSetName = elementSetName
1111 ? xstrdup(elementSetName) : 0;
1113 cp = ZOOM_options_get(r->options, "schema");
1116 if (!r->schema || strcmp(r->schema, cp))
1119 r->schema = xstrdup(cp);
1123 ZOOM_resultset_addref(r);
1125 if (!r->connection->async || force_sync)
1126 while (r->connection && ZOOM_event(1, &r->connection))
1131 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1132 size_t start, size_t count)
1134 int force_present = 0;
1138 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1139 r, r, (long) start, (long) count);
1142 ZOOM_resultset_retrieve(r, force_present, start, count);
1146 for (i = 0; i< count; i++)
1147 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1151 static void get_cert(ZOOM_connection c)
1156 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1158 ZOOM_connection_option_setl(c, "sslPeerCert",
1159 cert_buf, cert_len);
1164 static zoom_ret do_connect(ZOOM_connection c)
1167 const char *effective_host;
1170 effective_host = c->proxy;
1172 effective_host = c->host_port;
1174 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1178 c->cs = cs_create_host(effective_host, 0, &add);
1180 if (c->cs && c->cs->protocol == PROTO_HTTP)
1183 const char *path = 0;
1185 c->proto = PROTO_HTTP;
1186 cs_get_host_args(c->host_port, &path);
1188 c->path = (char*) xmalloc(strlen(path)+2);
1190 strcpy(c->path+1, path);
1192 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1194 return zoom_complete;
1199 int ret = cs_connect(c->cs, add);
1202 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1203 ZOOM_connection_put_event(c, event);
1205 if (c->proto == PROTO_Z3950)
1206 ZOOM_connection_send_init(c);
1209 /* no init request for SRW .. */
1210 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1211 ZOOM_connection_remove_task(c);
1212 ZOOM_connection_set_mask(c, 0);
1213 ZOOM_connection_exec_task(c);
1215 c->state = STATE_ESTABLISHED;
1216 return zoom_pending;
1220 int mask = ZOOM_SELECT_EXCEPT;
1221 if (c->cs->io_pending & CS_WANT_WRITE)
1222 mask += ZOOM_SELECT_WRITE;
1223 if (c->cs->io_pending & CS_WANT_READ)
1224 mask += ZOOM_SELECT_READ;
1225 ZOOM_connection_set_mask(c, mask);
1226 c->state = STATE_CONNECTING;
1227 return zoom_pending;
1230 c->state = STATE_IDLE;
1231 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1232 return zoom_complete;
1235 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1238 for (i = 0; i<200; i++)
1242 Z_OtherInformation **oi;
1247 sprintf(buf, "otherInfo%d", i);
1248 val = ZOOM_options_get(c->options, buf);
1251 cp = strchr(val, ':');
1255 if (len >= sizeof(buf))
1256 len = sizeof(buf)-1;
1257 memcpy(buf, val, len);
1260 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
1265 yaz_oi_APDU(a, &oi);
1266 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
1270 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1275 Z_OtherInformation **oi;
1276 yaz_oi_APDU(a, &oi);
1277 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
1282 Z_OtherInformation **oi;
1283 yaz_oi_APDU(a, &oi);
1284 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
1287 otherInfo_attach(c, a, out);
1288 if (!z_APDU(out, &a, 0, 0))
1290 FILE *outf = fopen("/tmp/apdu.txt", "a");
1293 ODR odr_pr = odr_createmem(ODR_PRINT);
1294 fprintf(outf, "a=%p\n", a);
1295 odr_setprint(odr_pr, outf);
1296 z_APDU(odr_pr, &a, 0, 0);
1297 odr_destroy(odr_pr);
1299 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1300 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1304 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1308 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1312 if (encode_APDU(c, a, c->odr_out))
1313 return zoom_complete;
1314 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1315 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1316 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1317 ZOOM_connection_put_event(c, event);
1318 odr_reset(c->odr_out);
1322 /* returns 1 if PDU was sent OK (still pending )
1323 0 if PDU was not sent OK (nothing to wait for)
1326 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1328 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1329 Z_InitRequest *ireq = apdu->u.initRequest;
1330 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1331 odr_malloc(c->odr_out, sizeof(*auth));
1334 ODR_MASK_SET(ireq->options, Z_Options_search);
1335 ODR_MASK_SET(ireq->options, Z_Options_present);
1336 ODR_MASK_SET(ireq->options, Z_Options_scan);
1337 ODR_MASK_SET(ireq->options, Z_Options_sort);
1338 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1339 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1341 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1342 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1343 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1345 /* Index Data's Z39.50 Implementor Id is 81 */
1346 ireq->implementationId =
1347 odr_prepend(c->odr_out,
1348 ZOOM_options_get(c->options, "implementationId"),
1349 odr_prepend(c->odr_out, "81", ireq->implementationId));
1351 ireq->implementationName =
1352 odr_prepend(c->odr_out,
1353 ZOOM_options_get(c->options, "implementationName"),
1354 odr_prepend(c->odr_out, "ZOOM-C",
1355 ireq->implementationName));
1357 version = odr_strdup(c->odr_out, "$Revision: 1.154 $");
1358 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1359 version[strlen(version)-2] = '\0';
1360 ireq->implementationVersion =
1361 odr_prepend(c->odr_out,
1362 ZOOM_options_get(c->options, "implementationVersion"),
1363 odr_prepend(c->odr_out, &version[11],
1364 ireq->implementationVersion));
1366 *ireq->maximumRecordSize = c->maximum_record_size;
1367 *ireq->preferredMessageSize = c->preferred_message_size;
1369 if (c->group || c->password)
1371 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1372 pass->groupId = odr_strdup_null(c->odr_out, c->group);
1373 pass->userId = odr_strdup_null(c->odr_out, c->user);
1374 pass->password = odr_strdup_null(c->odr_out, c->password);
1375 auth->which = Z_IdAuthentication_idPass;
1376 auth->u.idPass = pass;
1377 ireq->idAuthentication = auth;
1381 auth->which = Z_IdAuthentication_open;
1382 auth->u.open = odr_strdup(c->odr_out, c->user);
1383 ireq->idAuthentication = auth;
1387 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
1388 yaz_oid_userinfo_proxy, 1, c->host_port);
1390 if (c->charset || c->lang)
1392 Z_OtherInformation **oi;
1393 Z_OtherInformationUnit *oi_unit;
1395 yaz_oi_APDU(apdu, &oi);
1397 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1399 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1400 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1401 oi_unit->information.externallyDefinedInfo =
1402 yaz_set_proposal_charneg_list(c->odr_out, " ",
1403 c->charset, c->lang, 1);
1407 return send_APDU(c, apdu);
1411 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1416 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1418 if (c->sru_mode == zoom_sru_get)
1420 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1422 else if (c->sru_mode == zoom_sru_post)
1424 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1426 else if (c->sru_mode == zoom_sru_soap)
1428 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1430 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1431 return zoom_complete;
1432 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1434 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1435 ZOOM_connection_put_event(c, event);
1436 odr_reset(c->odr_out);
1442 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type) {
1443 Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
1444 sr->username = c->user;
1445 sr->password = c->password;
1450 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1454 ZOOM_resultset resultset = 0;
1456 const char *option_val = 0;
1458 if (c->error) /* don't continue on error */
1459 return zoom_complete;
1461 switch(c->tasks->which)
1463 case ZOOM_TASK_SEARCH:
1464 resultset = c->tasks->u.search.resultset;
1465 resultset->setname = xstrdup("default");
1466 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1467 start = &c->tasks->u.search.start;
1468 count = &c->tasks->u.search.count;
1470 case ZOOM_TASK_RETRIEVE:
1471 resultset = c->tasks->u.retrieve.resultset;
1473 start = &c->tasks->u.retrieve.start;
1474 count = &c->tasks->u.retrieve.count;
1476 if (*start >= resultset->size)
1477 return zoom_complete;
1478 if (*start + *count > resultset->size)
1479 *count = resultset->size - *start;
1481 for (i = 0; i < *count; i++)
1484 record_cache_lookup(resultset, i + *start,
1485 c->tasks->u.retrieve.syntax,
1486 c->tasks->u.retrieve.elementSetName);
1491 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1492 ZOOM_connection_put_event(c, event);
1499 return zoom_complete;
1502 return zoom_complete;
1504 assert(resultset->query);
1506 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
1507 if (resultset->query->z_query->which == Z_Query_type_104
1508 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1510 sr->u.request->query_type = Z_SRW_query_type_cql;
1511 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1513 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1514 resultset->query->z_query->u.type_1)
1516 sr->u.request->query_type = Z_SRW_query_type_pqf;
1517 sr->u.request->query.pqf = resultset->query->query_string;
1521 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1522 return zoom_complete;
1524 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1525 sr->u.request->maximumRecords = odr_intdup(
1526 c->odr_out, resultset->step>0 ? resultset->step : *count);
1527 sr->u.request->recordSchema = resultset->schema;
1529 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1531 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1533 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1534 yaz_encode_sru_extra(sr, c->odr_out, option_val);
1535 return send_srw(c, sr);
1538 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1540 return zoom_complete;
1544 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1547 int lslb, ssub, mspn;
1549 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1550 Z_SearchRequest *search_req = apdu->u.searchRequest;
1551 const char *elementSetName;
1552 const char *smallSetElementSetName;
1553 const char *mediumSetElementSetName;
1556 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1558 r = c->tasks->u.search.resultset;
1560 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1563 ZOOM_options_get(r->options, "elementSetName");
1564 smallSetElementSetName =
1565 ZOOM_options_get(r->options, "smallSetElementSetName");
1566 mediumSetElementSetName =
1567 ZOOM_options_get(r->options, "mediumSetElementSetName");
1569 if (!smallSetElementSetName)
1570 smallSetElementSetName = elementSetName;
1572 if (!mediumSetElementSetName)
1573 mediumSetElementSetName = elementSetName;
1578 /* prepare query for the search request */
1579 search_req->query = r->query->z_query;
1580 if (!search_req->query)
1582 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1583 return zoom_complete;
1585 if (r->query->z_query->which == Z_Query_type_1 ||
1586 r->query->z_query->which == Z_Query_type_101)
1588 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
1591 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
1594 search_req->query = yaz_copy_Z_Query(search_req->query,
1597 yaz_query_charset_convert_rpnquery(search_req->query->u.type_1,
1599 yaz_iconv_close(cd);
1603 search_req->databaseNames = r->databaseNames;
1604 search_req->num_databaseNames = r->num_databaseNames;
1606 /* get syntax (no need to provide unless piggyback is in effect) */
1607 syntax = c->tasks->u.search.syntax;
1609 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1610 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1611 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1612 if (lslb != -1 && ssub != -1 && mspn != -1)
1614 /* So're a Z39.50 expert? Let's hope you don't do sort */
1615 *search_req->largeSetLowerBound = lslb;
1616 *search_req->smallSetUpperBound = ssub;
1617 *search_req->mediumSetPresentNumber = mspn;
1619 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1620 && r->piggyback && !r->r_sort_spec && !r->schema)
1622 /* Regular piggyback - do it unless we're going to do sort */
1623 *search_req->largeSetLowerBound = 2000000000;
1624 *search_req->smallSetUpperBound = 1;
1625 *search_req->mediumSetPresentNumber =
1626 r->step>0 ? r->step : c->tasks->u.search.count;
1630 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1631 smallSetElementSetName = 0;
1632 mediumSetElementSetName = 0;
1635 if (smallSetElementSetName && *smallSetElementSetName)
1637 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1638 odr_malloc(c->odr_out, sizeof(*esn));
1640 esn->which = Z_ElementSetNames_generic;
1641 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1642 search_req->smallSetElementSetNames = esn;
1644 if (mediumSetElementSetName && *mediumSetElementSetName)
1646 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1647 odr_malloc(c->odr_out, sizeof(*esn));
1649 esn->which = Z_ElementSetNames_generic;
1650 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1651 search_req->mediumSetElementSetNames = esn;
1654 search_req->preferredRecordSyntax =
1655 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1659 if (c->support_named_resultsets)
1663 /* find the lowest unused ordinal so that we re-use
1664 result sets on the server. */
1665 for (ord = 1; ; ord++)
1668 sprintf(setname, "%d", ord);
1669 for (rp = c->resultsets; rp; rp = rp->next)
1670 if (rp->setname && !strcmp(rp->setname, setname))
1675 r->setname = xstrdup(setname);
1676 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1677 "set %s", c, r->setname);
1681 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1683 r->setname = xstrdup("default");
1685 ZOOM_options_set(r->options, "setname", r->setname);
1687 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1688 return send_APDU(c, apdu);
1691 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1693 char oid_name_buf[OID_STR_MAX];
1694 const char *oid_name;
1697 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
1700 case Z_DefaultDiagFormat_v2Addinfo:
1701 addinfo = r->u.v2Addinfo;
1703 case Z_DefaultDiagFormat_v3Addinfo:
1704 addinfo = r->u.v3Addinfo;
1709 set_dset_error(c, *r->condition, oid_name, addinfo, 0);
1712 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1714 if (p->which != Z_DiagRec_defaultFormat)
1715 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1717 response_default_diag(c, p->u.defaultFormat);
1720 ZOOM_API(ZOOM_record)
1721 ZOOM_record_clone(ZOOM_record srec)
1728 odr_enc = odr_createmem(ODR_ENCODE);
1729 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1731 buf = odr_getbuf(odr_enc, &size, 0);
1733 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1734 nrec->odr = odr_createmem(ODR_DECODE);
1735 nrec->wrbuf_marc = 0;
1736 nrec->wrbuf_iconv = 0;
1737 nrec->wrbuf_opac = 0;
1738 odr_setbuf(nrec->odr, buf, size, 0);
1739 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1741 nrec->schema = odr_strdup_null(nrec->odr, srec->schema);
1742 nrec->diag_uri = odr_strdup_null(nrec->odr, srec->diag_uri);
1743 nrec->diag_message = odr_strdup_null(nrec->odr, srec->diag_message);
1744 nrec->diag_details = odr_strdup_null(nrec->odr, srec->diag_details);
1745 nrec->diag_set = odr_strdup_null(nrec->odr, srec->diag_set);
1746 odr_destroy(odr_enc);
1750 ZOOM_API(ZOOM_record)
1751 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1753 const char *syntax =
1754 ZOOM_options_get(s->options, "preferredRecordSyntax");
1755 const char *elementSetName =
1756 ZOOM_options_get(s->options, "elementSetName");
1758 return record_cache_lookup(s, pos, syntax, elementSetName);
1761 ZOOM_API(ZOOM_record)
1762 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1764 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1769 * MIKE: I think force_sync should always be zero, but I don't
1770 * want to make this change until I get the go-ahead from
1771 * Adam, in case something depends on the old synchronous
1775 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1776 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1777 rec = ZOOM_resultset_record_immediate(r, pos);
1783 ZOOM_record_destroy(ZOOM_record rec)
1787 if (rec->wrbuf_marc)
1788 wrbuf_destroy(rec->wrbuf_marc);
1789 if (rec->wrbuf_iconv)
1790 wrbuf_destroy(rec->wrbuf_iconv);
1791 if (rec->wrbuf_opac)
1792 wrbuf_destroy(rec->wrbuf_opac);
1793 odr_destroy(rec->odr);
1797 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1799 const char *buf, int sz,
1800 const char *record_charset)
1805 yaz_marc_t mt = yaz_marc_create();
1808 strcpy(to, "UTF-8");
1809 if (record_charset && *record_charset)
1811 /* Use "from,to" or just "from" */
1812 const char *cp = strchr(record_charset, ',');
1813 int clen = strlen(record_charset);
1816 strncpy( to, cp+1, sizeof(to)-1);
1817 to[sizeof(to)-1] = '\0';
1818 clen = cp - record_charset;
1820 if (clen > sizeof(from)-1)
1821 clen = sizeof(from)-1;
1824 strncpy(from, record_charset, clen);
1830 cd = yaz_iconv_open(to, from);
1831 yaz_marc_iconv(mt, cd);
1834 yaz_marc_xml(mt, marc_type);
1835 if (!rec->wrbuf_marc)
1836 rec->wrbuf_marc = wrbuf_alloc();
1837 wrbuf_rewind(rec->wrbuf_marc);
1838 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1840 yaz_marc_destroy(mt);
1842 yaz_iconv_close(cd);
1844 *len = wrbuf_len(rec->wrbuf_marc);
1845 return wrbuf_cstr(rec->wrbuf_marc);
1847 yaz_marc_destroy(mt);
1849 yaz_iconv_close(cd);
1853 static const char *record_iconv_return(ZOOM_record rec, int *len,
1854 const char *buf, int sz,
1855 const char *record_charset)
1862 strcpy(to, "UTF-8");
1864 if (record_charset && *record_charset)
1866 /* Use "from,to" or just "from" */
1867 const char *cp = strchr(record_charset, ',');
1868 int clen = strlen(record_charset);
1871 strncpy( to, cp+1, sizeof(to)-1);
1872 to[sizeof(to)-1] = '\0';
1873 clen = cp - record_charset;
1875 if (clen > sizeof(from)-1)
1876 clen = sizeof(from)-1;
1879 strncpy(from, record_charset, clen);
1883 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1885 if (!rec->wrbuf_iconv)
1886 rec->wrbuf_iconv = wrbuf_alloc();
1888 wrbuf_rewind(rec->wrbuf_iconv);
1890 wrbuf_iconv_write(rec->wrbuf_iconv, cd, buf, sz);
1891 wrbuf_iconv_reset(rec->wrbuf_iconv, cd);
1893 buf = wrbuf_cstr(rec->wrbuf_iconv);
1894 sz = wrbuf_len(rec->wrbuf_iconv);
1895 yaz_iconv_close(cd);
1904 ZOOM_record_error(ZOOM_record rec, const char **cp,
1905 const char **addinfo, const char **diagset)
1907 Z_NamePlusRecord *npr;
1916 *cp = rec->diag_message;
1918 *addinfo = rec->diag_details;
1920 *diagset = rec->diag_set;
1921 return uri_to_code(rec->diag_uri);
1923 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1925 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1926 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1927 const char *add = 0;
1929 if (diag_rec->which == Z_DiagRec_defaultFormat)
1931 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1934 error = *ddf->condition;
1937 case Z_DefaultDiagFormat_v2Addinfo:
1938 add = ddf->u.v2Addinfo;
1940 case Z_DefaultDiagFormat_v3Addinfo:
1941 add = ddf->u.v3Addinfo;
1946 yaz_oid_to_string(yaz_oid_std(),
1947 ddf->diagnosticSetId, &oclass);
1955 *addinfo = add ? add : "";
1957 *cp = diagbib1_str(error);
1963 ZOOM_API(const char *)
1964 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1971 Z_NamePlusRecord *npr;
1974 *len = 0; /* default return */
1983 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1985 if (cp[i] == ';' || cp[i] == ' ')
1991 while (type_spec[i] == ';')
1994 while (type_spec[i] == ' ')
1996 if (!strncmp(type_spec+i, "charset=", 8))
1999 i = i + 8; /* skip charset= */
2000 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
2002 if (type_spec[i] == ';' || type_spec[i] == ' ')
2008 else if (!strncmp(type_spec+i, "xpath=", 6))
2012 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
2016 while (type_spec[i] == ' ')
2019 if (!strcmp(type, "database"))
2022 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
2023 return npr->databaseName;
2025 else if (!strcmp(type, "schema"))
2028 *len = rec->schema ? strlen(rec->schema) : 0;
2031 else if (!strcmp(type, "syntax"))
2033 const char *desc = 0;
2034 if (npr->which == Z_NamePlusRecord_databaseRecord)
2036 Z_External *r = (Z_External *) npr->u.databaseRecord;
2037 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
2042 *len = strlen(desc);
2045 if (npr->which != Z_NamePlusRecord_databaseRecord)
2048 /* from now on - we have a database record .. */
2049 if (!strcmp(type, "render"))
2051 Z_External *r = (Z_External *) npr->u.databaseRecord;
2052 const Odr_oid *oid = r->direct_reference;
2054 /* render bibliographic record .. */
2055 if (r->which == Z_External_OPAC)
2057 r = r->u.opac->bibliographicRecord;
2060 oid = r->direct_reference;
2062 if (r->which == Z_External_sutrs)
2063 return record_iconv_return(rec, len,
2064 (char*) r->u.sutrs->buf,
2067 else if (r->which == Z_External_octet)
2069 if (yaz_oid_is_iso2709(oid))
2071 const char *ret_buf = marc_iconv_return(
2072 rec, YAZ_MARC_LINE, len,
2073 (const char *) r->u.octet_aligned->buf,
2074 r->u.octet_aligned->len,
2079 return record_iconv_return(rec, len,
2080 (const char *) r->u.octet_aligned->buf,
2081 r->u.octet_aligned->len,
2084 else if (r->which == Z_External_grs1)
2086 if (!rec->wrbuf_marc)
2087 rec->wrbuf_marc = wrbuf_alloc();
2088 wrbuf_rewind(rec->wrbuf_marc);
2089 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
2090 return record_iconv_return(rec, len,
2091 wrbuf_buf(rec->wrbuf_marc),
2092 wrbuf_len(rec->wrbuf_marc),
2097 else if (!strcmp(type, "xml"))
2099 Z_External *r = (Z_External *) npr->u.databaseRecord;
2100 const Odr_oid *oid = r->direct_reference;
2102 /* render bibliographic record .. */
2103 if (r->which == Z_External_OPAC)
2105 r = r->u.opac->bibliographicRecord;
2108 oid = r->direct_reference;
2111 if (r->which == Z_External_sutrs)
2112 return record_iconv_return(rec, len,
2113 (const char *) r->u.sutrs->buf,
2116 else if (r->which == Z_External_octet)
2118 int marc_decode_type = YAZ_MARC_MARCXML;
2119 if (yaz_oid_is_iso2709(oid))
2121 const char *ret_buf = marc_iconv_return(
2122 rec, marc_decode_type, len,
2123 (const char *) r->u.octet_aligned->buf,
2124 r->u.octet_aligned->len,
2129 return record_iconv_return(rec, len,
2130 (const char *) r->u.octet_aligned->buf,
2131 r->u.octet_aligned->len,
2134 else if (r->which == Z_External_grs1)
2141 else if (!strcmp(type, "raw"))
2143 Z_External *r = (Z_External *) npr->u.databaseRecord;
2145 if (r->which == Z_External_sutrs)
2147 if (len) *len = r->u.sutrs->len;
2148 return (const char *) r->u.sutrs->buf;
2150 else if (r->which == Z_External_octet)
2152 if (len) *len = r->u.octet_aligned->len;
2153 return (const char *) r->u.octet_aligned->buf;
2155 else /* grs-1, explain, OPAC, ... */
2158 return (const char *) npr->u.databaseRecord;
2162 else if (!strcmp (type, "ext"))
2165 return (const char *) npr->u.databaseRecord;
2167 else if (!strcmp (type, "opac"))
2170 Z_External *r = (Z_External *) npr->u.databaseRecord;
2171 if (r->which == Z_External_OPAC)
2173 if (!rec->wrbuf_opac)
2174 rec->wrbuf_opac = wrbuf_alloc();
2175 wrbuf_rewind(rec->wrbuf_opac);
2176 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2177 return record_iconv_return(rec, len,
2178 wrbuf_buf(rec->wrbuf_opac),
2179 wrbuf_len(rec->wrbuf_opac),
2186 static int strcmp_null(const char *v1, const char *v2)
2192 return strcmp(v1, v2);
2195 static size_t record_hash(int pos)
2199 return pos % RECORD_HASH_SIZE;
2202 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2204 const char *syntax, const char *elementSetName,
2206 Z_SRW_diagnostic *diag)
2208 ZOOM_record_cache rc = 0;
2210 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2211 ZOOM_connection_put_event(r->connection, event);
2213 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2216 && strcmp_null(r->schema, rc->schema) == 0
2217 && strcmp_null(elementSetName,rc->elementSetName) == 0
2218 && strcmp_null(syntax, rc->syntax) == 0)
2223 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2225 rc->rec.wrbuf_marc = 0;
2226 rc->rec.wrbuf_iconv = 0;
2227 rc->rec.wrbuf_opac = 0;
2228 rc->elementSetName = odr_strdup_null(r->odr, elementSetName);
2230 rc->syntax = odr_strdup_null(r->odr, syntax);
2232 rc->schema = odr_strdup_null(r->odr, r->schema);
2235 rc->next = r->record_hash[record_hash(pos)];
2236 r->record_hash[record_hash(pos)] = rc;
2239 rc->rec.schema = odr_strdup_null(r->odr, schema);
2240 rc->rec.diag_set = 0;
2241 rc->rec.diag_uri = 0;
2242 rc->rec.diag_message = 0;
2243 rc->rec.diag_details = 0;
2249 rc->rec.diag_set = odr_strdup(r->odr, diag->uri);
2250 if ((cp = strrchr(rc->rec.diag_set, '/')))
2252 rc->rec.diag_uri = odr_strdup(r->odr, diag->uri);
2254 rc->rec.diag_message = odr_strdup_null(r->odr, diag->message);
2255 rc->rec.diag_details = odr_strdup_null(r->odr, diag->details);
2259 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2261 const char *elementSetName)
2263 ZOOM_record_cache rc;
2265 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2269 if (strcmp_null(r->schema, rc->schema))
2271 if (strcmp_null(elementSetName,rc->elementSetName))
2273 if (strcmp_null(syntax, rc->syntax))
2281 static void handle_records(ZOOM_connection c, Z_Records *sr,
2284 ZOOM_resultset resultset;
2286 const char *syntax = 0, *elementSetName = 0;
2290 switch (c->tasks->which)
2292 case ZOOM_TASK_SEARCH:
2293 resultset = c->tasks->u.search.resultset;
2294 start = &c->tasks->u.search.start;
2295 count = &c->tasks->u.search.count;
2296 syntax = c->tasks->u.search.syntax;
2297 elementSetName = c->tasks->u.search.elementSetName;
2299 case ZOOM_TASK_RETRIEVE:
2300 resultset = c->tasks->u.retrieve.resultset;
2301 start = &c->tasks->u.retrieve.start;
2302 count = &c->tasks->u.retrieve.count;
2303 syntax = c->tasks->u.retrieve.syntax;
2304 elementSetName = c->tasks->u.retrieve.elementSetName;
2309 if (sr && sr->which == Z_Records_NSD)
2310 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2311 else if (sr && sr->which == Z_Records_multipleNSD)
2313 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2314 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2316 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2320 if (*count + *start > resultset->size)
2321 *count = resultset->size - *start;
2324 if (sr && sr->which == Z_Records_DBOSD)
2327 NMEM nmem = odr_extract_mem(c->odr_in);
2328 Z_NamePlusRecordList *p =
2329 sr->u.databaseOrSurDiagnostics;
2330 for (i = 0; i<p->num_records; i++)
2332 record_cache_add(resultset, p->records[i], i + *start,
2333 syntax, elementSetName,
2340 yaz_log(log_details,
2341 "handle_records resultset=%p start=%d count=%d",
2342 resultset, *start, *count);
2344 /* transfer our response to search_nmem .. we need it later */
2345 nmem_transfer(odr_getmem(resultset->odr), nmem);
2347 if (present_phase && p->num_records == 0)
2349 /* present response and we didn't get any records! */
2350 Z_NamePlusRecord *myrec =
2351 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2352 record_cache_add(resultset, myrec, *start,
2353 syntax, elementSetName, 0, 0);
2356 else if (present_phase)
2358 /* present response and we didn't get any records! */
2359 Z_NamePlusRecord *myrec =
2360 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2361 record_cache_add(resultset, myrec, *start, syntax, elementSetName,
2367 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2369 handle_records(c, pr->records, 1);
2372 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2375 switch (term->which)
2377 case Z_Term_general:
2378 ZOOM_options_setl(opt, name,
2379 (const char *)(term->u.general->buf),
2380 term->u.general->len);
2382 case Z_Term_characterString:
2383 ZOOM_options_set(opt, name, term->u.characterString);
2385 case Z_Term_numeric:
2386 ZOOM_options_set_int(opt, name, *term->u.numeric);
2391 static void handle_queryExpression(ZOOM_options opt, const char *name,
2392 Z_QueryExpression *exp)
2398 case Z_QueryExpression_term:
2399 if (exp->u.term && exp->u.term->queryTerm)
2401 sprintf(opt_name, "%s.term", name);
2402 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2405 case Z_QueryExpression_query:
2410 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2411 Z_OtherInformation *o)
2414 for (i = 0; o && i < o->num_elements; i++)
2416 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2418 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2420 if (ext->which == Z_External_searchResult1)
2423 Z_SearchInfoReport *sr = ext->u.searchResult1;
2426 ZOOM_options_set_int(
2427 resultset->options, "searchresult.size", sr->num);
2429 for (j = 0; j < sr->num; j++)
2431 Z_SearchInfoReport_s *ent =
2432 ext->u.searchResult1->elements[j];
2435 sprintf(pref, "searchresult.%d", j);
2437 if (ent->subqueryId)
2440 sprintf(opt_name, "%s.id", pref);
2441 ZOOM_options_set(resultset->options, opt_name,
2444 if (ent->subqueryExpression)
2447 sprintf(opt_name, "%s.subquery", pref);
2448 handle_queryExpression(resultset->options, opt_name,
2449 ent->subqueryExpression);
2451 if (ent->subqueryInterpretation)
2454 sprintf(opt_name, "%s.interpretation", pref);
2455 handle_queryExpression(resultset->options, opt_name,
2456 ent->subqueryInterpretation);
2458 if (ent->subqueryRecommendation)
2461 sprintf(opt_name, "%s.recommendation", pref);
2462 handle_queryExpression(resultset->options, opt_name,
2463 ent->subqueryRecommendation);
2465 if (ent->subqueryCount)
2468 sprintf(opt_name, "%s.count", pref);
2469 ZOOM_options_set_int(resultset->options, opt_name,
2470 *ent->subqueryCount);
2478 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2480 ZOOM_resultset resultset;
2483 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2486 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2487 ZOOM_connection_put_event(c, event);
2489 resultset = c->tasks->u.search.resultset;
2491 if (sr->resultSetStatus)
2493 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2494 *sr->resultSetStatus);
2496 if (sr->presentStatus)
2498 ZOOM_options_set_int(resultset->options, "presentStatus",
2499 *sr->presentStatus);
2501 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2503 resultset->size = *sr->resultCount;
2504 handle_records(c, sr->records, 0);
2507 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2509 if (res->diagnostics && res->num_diagnostics > 0)
2510 response_diag(c, res->diagnostics[0]);
2513 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2515 NMEM nmem = odr_extract_mem(c->odr_in);
2518 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2520 scan = c->tasks->u.scan.scan;
2522 if (res->entries && res->entries->nonsurrogateDiagnostics)
2523 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2524 scan->scan_response = res;
2525 scan->srw_scan_response = 0;
2526 nmem_transfer(odr_getmem(scan->odr), nmem);
2528 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2529 if (res->positionOfTerm)
2530 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2531 if (res->scanStatus)
2532 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2533 if (res->numberOfEntriesReturned)
2534 ZOOM_options_set_int(scan->options, "number",
2535 *res->numberOfEntriesReturned);
2540 static zoom_ret send_sort(ZOOM_connection c,
2541 ZOOM_resultset resultset)
2544 resultset->r_sort_spec = 0;
2545 if (resultset->r_sort_spec)
2547 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2548 Z_SortRequest *req = apdu->u.sortRequest;
2550 req->num_inputResultSetNames = 1;
2551 req->inputResultSetNames = (Z_InternationalString **)
2552 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2553 req->inputResultSetNames[0] =
2554 odr_strdup(c->odr_out, resultset->setname);
2555 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2556 req->sortSequence = resultset->r_sort_spec;
2557 resultset->r_sort_spec = 0;
2558 return send_APDU(c, apdu);
2560 return zoom_complete;
2563 static zoom_ret send_present(ZOOM_connection c)
2566 Z_PresentRequest *req = 0;
2568 const char *syntax = 0;
2569 const char *elementSetName = 0;
2570 ZOOM_resultset resultset;
2575 yaz_log(log_details, "%p send_present no tasks", c);
2576 return zoom_complete;
2579 switch (c->tasks->which)
2581 case ZOOM_TASK_SEARCH:
2582 resultset = c->tasks->u.search.resultset;
2583 start = &c->tasks->u.search.start;
2584 count = &c->tasks->u.search.count;
2585 syntax = c->tasks->u.search.syntax;
2586 elementSetName = c->tasks->u.search.elementSetName;
2588 case ZOOM_TASK_RETRIEVE:
2589 resultset = c->tasks->u.retrieve.resultset;
2590 start = &c->tasks->u.retrieve.start;
2591 count = &c->tasks->u.retrieve.count;
2592 syntax = c->tasks->u.retrieve.syntax;
2593 elementSetName = c->tasks->u.retrieve.elementSetName;
2596 return zoom_complete;
2598 yaz_log(log_details, "%p send_present start=%d count=%d",
2601 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2603 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2606 if (c->error) /* don't continue on error */
2607 return zoom_complete;
2608 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2609 resultset, *start, *count);
2611 for (i = 0; i < *count; i++)
2614 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2619 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2620 ZOOM_connection_put_event(c, event);
2628 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2629 return zoom_complete;
2632 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2633 req = apdu->u.presentRequest;
2636 yaz_log(log_details, "%p send_present skip=%d", c, i);
2638 *req->resultSetStartPoint = *start + 1;
2639 *req->numberOfRecordsRequested = resultset->step>0 ?
2640 resultset->step : *count;
2641 if (*req->numberOfRecordsRequested + *start > resultset->size)
2642 *req->numberOfRecordsRequested = resultset->size - *start;
2643 assert(*req->numberOfRecordsRequested > 0);
2645 if (syntax && *syntax)
2646 req->preferredRecordSyntax =
2647 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2649 if (resultset->schema && *resultset->schema)
2651 Z_RecordComposition *compo = (Z_RecordComposition *)
2652 odr_malloc(c->odr_out, sizeof(*compo));
2654 req->recordComposition = compo;
2655 compo->which = Z_RecordComp_complex;
2656 compo->u.complex = (Z_CompSpec *)
2657 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2658 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2659 odr_malloc(c->odr_out, sizeof(bool_t));
2660 *compo->u.complex->selectAlternativeSyntax = 0;
2662 compo->u.complex->generic = (Z_Specification *)
2663 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2665 compo->u.complex->generic->which = Z_Schema_oid;
2666 compo->u.complex->generic->schema.oid = (Odr_oid *)
2667 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2669 if (!compo->u.complex->generic->schema.oid)
2671 /* OID wasn't a schema! Try record syntax instead. */
2673 compo->u.complex->generic->schema.oid = (Odr_oid *)
2674 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2676 if (elementSetName && *elementSetName)
2678 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2679 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2680 compo->u.complex->generic->elementSpec->which =
2681 Z_ElementSpec_elementSetName;
2682 compo->u.complex->generic->elementSpec->u.elementSetName =
2683 odr_strdup(c->odr_out, elementSetName);
2686 compo->u.complex->generic->elementSpec = 0;
2687 compo->u.complex->num_dbSpecific = 0;
2688 compo->u.complex->dbSpecific = 0;
2689 compo->u.complex->num_recordSyntax = 0;
2690 compo->u.complex->recordSyntax = 0;
2692 else if (elementSetName && *elementSetName)
2694 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2695 odr_malloc(c->odr_out, sizeof(*esn));
2696 Z_RecordComposition *compo = (Z_RecordComposition *)
2697 odr_malloc(c->odr_out, sizeof(*compo));
2699 esn->which = Z_ElementSetNames_generic;
2700 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2701 compo->which = Z_RecordComp_simple;
2702 compo->u.simple = esn;
2703 req->recordComposition = compo;
2705 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2706 return send_APDU(c, apdu);
2709 ZOOM_API(ZOOM_scanset)
2710 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2713 ZOOM_query q = ZOOM_query_create();
2715 ZOOM_query_prefix(q, start);
2717 s = ZOOM_connection_scan1(c, q);
2718 ZOOM_query_destroy(q);
2723 ZOOM_API(ZOOM_scanset)
2724 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2726 ZOOM_scanset scan = 0;
2730 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2731 scan->connection = c;
2732 scan->odr = odr_createmem(ODR_DECODE);
2733 scan->options = ZOOM_options_create_with_parent(c->options);
2735 scan->scan_response = 0;
2736 scan->srw_scan_response = 0;
2740 scan->databaseNames = set_DatabaseNames(c, c->options,
2741 &scan->num_databaseNames,
2746 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2747 task->u.scan.scan = scan;
2752 while (ZOOM_event(1, &c))
2760 ZOOM_scanset_destroy(ZOOM_scanset scan)
2765 if (scan->refcount == 0)
2767 ZOOM_query_destroy(scan->query);
2769 odr_destroy(scan->odr);
2771 ZOOM_options_destroy(scan->options);
2776 static zoom_ret send_package(ZOOM_connection c)
2780 yaz_log(log_details, "%p send_package", c);
2782 return zoom_complete;
2783 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2785 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2786 ZOOM_connection_put_event(c, event);
2788 c->buf_out = c->tasks->u.package->buf_out;
2789 c->len_out = c->tasks->u.package->len_out;
2794 static zoom_ret ZOOM_connection_send_scan(ZOOM_connection c)
2797 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2798 Z_ScanRequest *req = apdu->u.scanRequest;
2800 yaz_log(log_details, "%p send_scan", c);
2802 return zoom_complete;
2803 assert (c->tasks->which == ZOOM_TASK_SCAN);
2804 scan = c->tasks->u.scan.scan;
2806 /* Z39.50 scan can only carry RPN */
2807 if (scan->query->z_query->which == Z_Query_type_1 ||
2808 scan->query->z_query->which == Z_Query_type_101)
2810 Z_RPNQuery *rpn = scan->query->z_query->u.type_1;
2811 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
2814 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
2817 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
2819 yaz_query_charset_convert_rpnquery(
2820 rpn, c->odr_out, cd);
2821 yaz_iconv_close(cd);
2824 req->attributeSet = rpn->attributeSetId;
2825 if (!req->attributeSet)
2826 req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
2827 if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
2828 rpn->RPNStructure->u.simple->which == Z_Operand_APT)
2830 req->termListAndStartPoint =
2831 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
2835 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
2836 return zoom_complete;
2841 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2842 return zoom_complete;
2845 *req->numberOfTermsRequested =
2846 ZOOM_options_get_int(scan->options, "number", 10);
2848 req->preferredPositionInResponse =
2849 odr_intdup(c->odr_out,
2850 ZOOM_options_get_int(scan->options, "position", 1));
2853 odr_intdup(c->odr_out,
2854 ZOOM_options_get_int(scan->options, "stepSize", 0));
2856 req->databaseNames = scan->databaseNames;
2857 req->num_databaseNames = scan->num_databaseNames;
2859 return send_APDU(c, apdu);
2863 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2867 const char *option_val = 0;
2870 return zoom_complete;
2871 assert (c->tasks->which == ZOOM_TASK_SCAN);
2872 scan = c->tasks->u.scan.scan;
2874 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
2876 /* SRU scan can only carry CQL and PQF */
2877 if (scan->query->z_query->which == Z_Query_type_104)
2879 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
2880 sr->u.scan_request->scanClause.cql = scan->query->query_string;
2882 else if (scan->query->z_query->which == Z_Query_type_1
2883 || scan->query->z_query->which == Z_Query_type_101)
2885 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
2886 sr->u.scan_request->scanClause.pqf = scan->query->query_string;
2890 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
2891 return zoom_complete;
2894 sr->u.scan_request->maximumTerms = odr_intdup(
2895 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
2897 sr->u.scan_request->responsePosition = odr_intdup(
2898 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
2900 option_val = ZOOM_options_get(scan->options, "extraArgs");
2901 yaz_encode_sru_extra(sr, c->odr_out, option_val);
2902 return send_srw(c, sr);
2905 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
2907 return zoom_complete;
2913 ZOOM_scanset_size(ZOOM_scanset scan)
2918 if (scan->scan_response && scan->scan_response->entries)
2919 return scan->scan_response->entries->num_entries;
2920 else if (scan->srw_scan_response)
2921 return scan->srw_scan_response->num_terms;
2925 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
2927 const char **value_term, size_t *value_len,
2928 const char **disp_term, size_t *disp_len)
2930 size_t noent = ZOOM_scanset_size(scan);
2939 if (pos >= noent || pos < 0)
2941 if (scan->scan_response)
2943 Z_ScanResponse *res = scan->scan_response;
2944 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2946 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2948 *value_term = (const char *) t->term->u.general->buf;
2949 *value_len = t->term->u.general->len;
2952 *disp_term = t->displayTerm;
2953 *disp_len = strlen(*disp_term);
2955 else if (t->term->which == Z_Term_general)
2957 *disp_term = (const char *) t->term->u.general->buf;
2958 *disp_len = t->term->u.general->len;
2960 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2963 if (scan->srw_scan_response)
2965 Z_SRW_scanResponse *res = scan->srw_scan_response;
2966 Z_SRW_scanTerm *t = res->terms + pos;
2969 *value_term = t->value;
2970 *value_len = strlen(*value_term);
2973 *disp_term = t->displayTerm;
2975 *disp_term = t->value;
2976 *disp_len = strlen(*disp_term);
2977 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
2982 ZOOM_API(const char *)
2983 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2986 const char *value_term = 0;
2987 size_t value_len = 0;
2988 const char *disp_term = 0;
2989 size_t disp_len = 0;
2991 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
2992 &disp_term, &disp_len);
2998 ZOOM_API(const char *)
2999 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
3002 const char *value_term = 0;
3003 size_t value_len = 0;
3004 const char *disp_term = 0;
3005 size_t disp_len = 0;
3007 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3008 &disp_term, &disp_len);
3014 ZOOM_API(const char *)
3015 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
3017 return ZOOM_options_get(scan->options, key);
3021 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
3024 ZOOM_options_set(scan->options, key, val);
3027 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
3030 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
3031 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3033 str = ZOOM_options_get(p->options, "package-name");
3035 req->packageName = odr_strdup(p->odr_out, str);
3037 str = ZOOM_options_get(p->options, "user-id");
3039 req->userId = odr_strdup_null(p->odr_out, str);
3041 req->packageType = odr_oiddup(p->odr_out, oid);
3043 str = ZOOM_options_get(p->options, "function");
3046 if (!strcmp (str, "create"))
3047 *req->function = Z_ExtendedServicesRequest_create;
3048 if (!strcmp (str, "delete"))
3049 *req->function = Z_ExtendedServicesRequest_delete;
3050 if (!strcmp (str, "modify"))
3051 *req->function = Z_ExtendedServicesRequest_modify;
3054 str = ZOOM_options_get(p->options, "waitAction");
3057 if (!strcmp (str, "wait"))
3058 *req->waitAction = Z_ExtendedServicesRequest_wait;
3059 if (!strcmp (str, "waitIfPossible"))
3060 *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
3061 if (!strcmp (str, "dontWait"))
3062 *req->waitAction = Z_ExtendedServicesRequest_dontWait;
3063 if (!strcmp (str, "dontReturnPackage"))
3064 *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
3069 static const char *ill_array_lookup(void *clientData, const char *idx)
3071 ZOOM_package p = (ZOOM_package) clientData;
3072 return ZOOM_options_get(p->options, idx+4);
3075 static Z_External *encode_ill_request(ZOOM_package p)
3077 ODR out = p->odr_out;
3080 struct ill_get_ctl ctl;
3082 ctl.odr = p->odr_out;
3084 ctl.f = ill_array_lookup;
3086 req = ill_get_ILLRequest(&ctl, "ill", 0);
3088 if (!ill_Request(out, &req, 0, 0))
3090 int ill_request_size;
3091 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
3092 if (ill_request_buf)
3093 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
3098 int illRequest_size = 0;
3099 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
3101 r = (Z_External *) odr_malloc(out, sizeof(*r));
3102 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
3103 r->indirect_reference = 0;
3105 r->which = Z_External_single;
3107 r->u.single_ASN1_type =
3108 odr_create_Odr_oct(out,
3109 (unsigned char *)illRequest_buf,
3115 static Z_ItemOrder *encode_item_order(ZOOM_package p)
3117 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
3121 req->which = Z_IOItemOrder_esRequest;
3122 req->u.esRequest = (Z_IORequest *)
3123 odr_malloc(p->odr_out,sizeof(Z_IORequest));
3125 /* to keep part ... */
3126 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
3127 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
3128 req->u.esRequest->toKeep->supplDescription = 0;
3129 req->u.esRequest->toKeep->contact = (Z_IOContact *)
3130 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
3132 str = ZOOM_options_get(p->options, "contact-name");
3133 req->u.esRequest->toKeep->contact->name =
3134 odr_strdup_null(p->odr_out, str);
3136 str = ZOOM_options_get(p->options, "contact-phone");
3137 req->u.esRequest->toKeep->contact->phone =
3138 odr_strdup_null(p->odr_out, str);
3140 str = ZOOM_options_get(p->options, "contact-email");
3141 req->u.esRequest->toKeep->contact->email =
3142 odr_strdup_null(p->odr_out, str);
3144 req->u.esRequest->toKeep->addlBilling = 0;
3146 /* not to keep part ... */
3147 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
3148 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3150 str = ZOOM_options_get(p->options, "itemorder-setname");
3155 req->u.esRequest->notToKeep->resultSetItem = 0;
3158 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3159 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3161 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3162 odr_strdup(p->odr_out, str);
3163 req->u.esRequest->notToKeep->resultSetItem->item =
3164 (int *) odr_malloc(p->odr_out, sizeof(int));
3166 str = ZOOM_options_get(p->options, "itemorder-item");
3167 *req->u.esRequest->notToKeep->resultSetItem->item =
3168 (str ? atoi(str) : 1);
3171 str = ZOOM_options_getl(p->options, "doc", &len);
3174 req->u.esRequest->notToKeep->itemRequest =
3175 z_ext_record_xml(p->odr_out, str, len);
3178 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3183 Z_APDU *create_admin_package(ZOOM_package p, int type,
3184 Z_ESAdminOriginPartToKeep **toKeepP,
3185 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3187 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3190 Z_ESAdminOriginPartToKeep *toKeep;
3191 Z_ESAdminOriginPartNotToKeep *notToKeep;
3192 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3193 const char *first_db = "Default";
3195 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3200 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3202 r->indirect_reference = 0;
3203 r->which = Z_External_ESAdmin;
3205 r->u.adminService = (Z_Admin *)
3206 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3207 r->u.adminService->which = Z_Admin_esRequest;
3208 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3209 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3211 toKeep = r->u.adminService->u.esRequest->toKeep =
3212 (Z_ESAdminOriginPartToKeep *)
3213 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3214 toKeep->which = type;
3215 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3216 toKeep->u.create = odr_nullval();
3217 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3219 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3220 (Z_ESAdminOriginPartNotToKeep *)
3221 odr_malloc(p->odr_out,
3222 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3223 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3224 notToKeep->u.recordsWillFollow = odr_nullval();
3228 *notToKeepP = notToKeep;
3233 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3235 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3236 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3237 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3239 const char *doc = ZOOM_options_getl(p->options, "doc", &len);
3247 req->taskSpecificParameters = ext;
3248 ext->direct_reference = req->packageType;
3249 ext->descriptor = 0;
3250 ext->indirect_reference = 0;
3252 ext->which = Z_External_octet;
3253 ext->u.single_ASN1_type =
3254 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc, len);
3258 static Z_APDU *create_update_package(ZOOM_package p)
3261 const char *first_db = "Default";
3263 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3264 const char *action = ZOOM_options_get(p->options, "action");
3265 int recordIdOpaque_len;
3266 const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
3267 &recordIdOpaque_len);
3268 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3270 const char *record_buf = ZOOM_options_getl(p->options, "record",
3272 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3273 const char *version = ZOOM_options_get(p->options, "updateVersion");
3275 const char *correlationInfo_note =
3276 ZOOM_options_get(p->options, "correlationInfo.note");
3277 const char *correlationInfo_id =
3278 ZOOM_options_get(p->options, "correlationInfo.id");
3280 Odr_oid *syntax_oid = 0;
3281 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
3289 record_buf = "void";
3291 syntax_str = "SUTRS";
3296 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3297 CLASS_RECSYN, syntax_str,
3309 package_oid = yaz_oid_extserv_database_update_first_version;
3310 /* old update does not support specialUpdate */
3312 action = "recordInsert";
3316 action = "specialUpdate";
3317 package_oid = yaz_oid_extserv_database_update_second_version;
3321 action = "specialUpdate";
3322 package_oid = yaz_oid_extserv_database_update;
3328 if (!strcmp(action, "recordInsert"))
3329 action_no = Z_IUOriginPartToKeep_recordInsert;
3330 else if (!strcmp(action, "recordReplace"))
3331 action_no = Z_IUOriginPartToKeep_recordReplace;
3332 else if (!strcmp(action, "recordDelete"))
3333 action_no = Z_IUOriginPartToKeep_recordDelete;
3334 else if (!strcmp(action, "elementUpdate"))
3335 action_no = Z_IUOriginPartToKeep_elementUpdate;
3336 else if (!strcmp(action, "specialUpdate"))
3337 action_no = Z_IUOriginPartToKeep_specialUpdate;
3341 apdu = create_es_package(p, package_oid);
3344 Z_IUOriginPartToKeep *toKeep;
3345 Z_IUSuppliedRecords *notToKeep;
3346 Z_External *r = (Z_External *)
3347 odr_malloc(p->odr_out, sizeof(*r));
3348 const char *elementSetName =
3349 ZOOM_options_get(p->options, "elementSetName");
3351 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3353 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
3355 r->which = Z_External_update;
3356 r->indirect_reference = 0;
3357 r->u.update = (Z_IUUpdate *)
3358 odr_malloc(p->odr_out, sizeof(*r->u.update));
3360 r->u.update->which = Z_IUUpdate_esRequest;
3361 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3362 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3363 toKeep = r->u.update->u.esRequest->toKeep =
3364 (Z_IUOriginPartToKeep *)
3365 odr_malloc(p->odr_out, sizeof(*toKeep));
3367 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3370 toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
3372 toKeep->actionQualifier = 0;
3373 toKeep->action = odr_intdup(p->odr_out, action_no);
3375 notToKeep = r->u.update->u.esRequest->notToKeep =
3376 (Z_IUSuppliedRecords *)
3377 odr_malloc(p->odr_out, sizeof(*notToKeep));
3379 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3380 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3381 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3382 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3383 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3386 notToKeep->elements[0]->u.opaque =
3387 odr_create_Odr_oct(p->odr_out,
3388 (const unsigned char *) recordIdOpaque,
3389 recordIdOpaque_len);
3391 else if (recordIdNumber)
3393 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3395 notToKeep->elements[0]->u.number =
3396 odr_intdup(p->odr_out, atoi(recordIdNumber));
3399 notToKeep->elements[0]->u.opaque = 0;
3400 notToKeep->elements[0]->supplementalId = 0;
3401 if (correlationInfo_note || correlationInfo_id)
3403 Z_IUCorrelationInfo *ci;
3404 ci = notToKeep->elements[0]->correlationInfo =
3405 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
3406 ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
3407 ci->id = correlationInfo_id ?
3408 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3411 notToKeep->elements[0]->correlationInfo = 0;
3412 notToKeep->elements[0]->record =
3413 z_ext_record_oid(p->odr_out, syntax_oid,
3414 record_buf, record_len);
3418 ODR print = odr_createmem(ODR_PRINT);
3420 z_APDU(print, &apdu, 0, 0);
3427 ZOOM_package_send(ZOOM_package p, const char *type)
3434 odr_reset(p->odr_out);
3437 if (!strcmp(type, "itemorder"))
3439 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3442 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3444 r->direct_reference =
3445 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3447 r->which = Z_External_itemOrder;
3448 r->indirect_reference = 0;
3449 r->u.itemOrder = encode_item_order(p);
3451 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3454 else if (!strcmp(type, "create")) /* create database */
3456 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3459 else if (!strcmp(type, "drop")) /* drop database */
3461 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3464 else if (!strcmp(type, "commit")) /* commit changes */
3466 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3469 else if (!strcmp(type, "update")) /* update record(s) */
3471 apdu = create_update_package(p);
3473 else if (!strcmp(type, "xmlupdate"))
3475 apdu = create_xmlupdate_package(p);
3479 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3483 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3484 task->u.package = p;
3485 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3486 p->buf_out = (char *) xmalloc(p->len_out);
3487 memcpy(p->buf_out, buf, p->len_out);
3492 while (ZOOM_event(1, &c))
3499 ZOOM_API(ZOOM_package)
3500 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3502 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3505 p->odr_out = odr_createmem(ODR_ENCODE);
3506 p->options = ZOOM_options_create_with_parent2(options, c->options);
3514 ZOOM_package_destroy(ZOOM_package p)
3519 if (p->refcount == 0)
3521 odr_destroy(p->odr_out);
3524 ZOOM_options_destroy(p->options);
3529 ZOOM_API(const char *)
3530 ZOOM_package_option_get(ZOOM_package p, const char *key)
3532 return ZOOM_options_get(p->options, key);
3535 ZOOM_API(const char *)
3536 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
3538 return ZOOM_options_getl(p->options, key, lenp);
3542 ZOOM_package_option_set(ZOOM_package p, const char *key,
3545 ZOOM_options_set(p->options, key, val);
3549 ZOOM_package_option_setl(ZOOM_package p, const char *key,
3550 const char *val, int len)
3552 ZOOM_options_setl(p->options, key, val, len);
3555 static int ZOOM_connection_exec_task(ZOOM_connection c)
3557 ZOOM_task task = c->tasks;
3558 zoom_ret ret = zoom_complete;
3562 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3563 c, task->which, task->running);
3564 if (c->error != ZOOM_ERROR_NONE)
3566 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3567 "removing tasks because of error = %d", c, c->error);
3568 ZOOM_connection_remove_tasks(c);
3573 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3574 "task already running", c);
3578 ret = zoom_complete;
3579 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3581 switch (task->which)
3583 case ZOOM_TASK_SEARCH:
3584 if (c->proto == PROTO_HTTP)
3585 ret = ZOOM_connection_srw_send_search(c);
3587 ret = ZOOM_connection_send_search(c);
3589 case ZOOM_TASK_RETRIEVE:
3590 if (c->proto == PROTO_HTTP)
3591 ret = ZOOM_connection_srw_send_search(c);
3593 ret = send_present(c);
3595 case ZOOM_TASK_CONNECT:
3596 ret = do_connect(c);
3598 case ZOOM_TASK_SCAN:
3599 if (c->proto == PROTO_HTTP)
3600 ret = ZOOM_connection_srw_send_scan(c);
3602 ret = ZOOM_connection_send_scan(c);
3604 case ZOOM_TASK_PACKAGE:
3605 ret = send_package(c);
3607 case ZOOM_TASK_SORT:
3608 c->tasks->u.sort.resultset->r_sort_spec =
3609 c->tasks->u.sort.q->sort_spec;
3610 ret = send_sort(c, c->tasks->u.sort.resultset);
3616 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3617 "remove tasks because no connection exist", c);
3618 ZOOM_connection_remove_tasks(c);
3620 if (ret == zoom_complete)
3622 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3623 "task removed (complete)", c);
3624 ZOOM_connection_remove_task(c);
3627 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3632 static zoom_ret send_sort_present(ZOOM_connection c)
3634 zoom_ret r = zoom_complete;
3636 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3637 r = send_sort(c, c->tasks->u.search.resultset);
3638 if (r == zoom_complete)
3639 r = send_present(c);
3643 static int es_response(ZOOM_connection c,
3644 Z_ExtendedServicesResponse *res)
3646 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3648 if (res->diagnostics && res->num_diagnostics > 0)
3649 response_diag(c, res->diagnostics[0]);
3650 if (res->taskPackage &&
3651 res->taskPackage->which == Z_External_extendedService)
3653 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3654 Odr_oct *id = taskPackage->targetReference;
3657 ZOOM_options_setl(c->tasks->u.package->options,
3658 "targetReference", (char*) id->buf, id->len);
3660 if (res->taskPackage &&
3661 res->taskPackage->which == Z_External_octet)
3663 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3664 ZOOM_options_setl(c->tasks->u.package->options,
3665 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3670 static void interpret_init_diag(ZOOM_connection c,
3671 Z_DiagnosticFormat *diag)
3675 Z_DiagnosticFormat_s *ds = diag->elements[0];
3676 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3677 response_default_diag(c, ds->u.defaultDiagRec);
3682 static void interpret_otherinformation_field(ZOOM_connection c,
3683 Z_OtherInformation *ui)
3686 for (i = 0; i < ui->num_elements; i++)
3688 Z_OtherInformationUnit *unit = ui->list[i];
3689 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3690 unit->information.externallyDefinedInfo &&
3691 unit->information.externallyDefinedInfo->which ==
3694 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3700 static void set_init_option(const char *name, void *clientData) {
3701 ZOOM_connection c = (ZOOM_connection) clientData;
3704 sprintf(buf, "init_opt_%.70s", name);
3705 ZOOM_connection_option_set(c, buf, "1");
3709 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3711 Z_InitResponse *initrs;
3713 ZOOM_connection_set_mask(c, 0);
3714 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3717 case Z_APDU_initResponse:
3718 yaz_log(log_api, "%p recv_apdu: Received Init response", c);
3719 initrs = apdu->u.initResponse;
3720 ZOOM_connection_option_set(c, "serverImplementationId",
3721 initrs->implementationId ?
3722 initrs->implementationId : "");
3723 ZOOM_connection_option_set(c, "serverImplementationName",
3724 initrs->implementationName ?
3725 initrs->implementationName : "");
3726 ZOOM_connection_option_set(c, "serverImplementationVersion",
3727 initrs->implementationVersion ?
3728 initrs->implementationVersion : "");
3729 /* Set the three old options too, for old applications */
3730 ZOOM_connection_option_set(c, "targetImplementationId",
3731 initrs->implementationId ?
3732 initrs->implementationId : "");
3733 ZOOM_connection_option_set(c, "targetImplementationName",
3734 initrs->implementationName ?
3735 initrs->implementationName : "");
3736 ZOOM_connection_option_set(c, "targetImplementationVersion",
3737 initrs->implementationVersion ?
3738 initrs->implementationVersion : "");
3740 /* Make initrs->options available as ZOOM-level options */
3741 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3743 if (!*initrs->result)
3745 Z_External *uif = initrs->userInformationField;
3747 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3749 if (uif && uif->which == Z_External_userInfo1)
3750 interpret_otherinformation_field(c, uif->u.userInfo1);
3755 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
3756 yaz_oid_userinfo_cookie, 1, 0);
3757 xfree(c->cookie_in);
3760 c->cookie_in = xstrdup(cookie);
3761 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3762 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3763 c->support_named_resultsets = 1;
3766 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3767 ZOOM_connection_remove_task(c);
3769 ZOOM_connection_exec_task(c);
3771 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3773 NMEM tmpmem = nmem_create();
3774 Z_CharSetandLanguageNegotiation *p =
3775 yaz_get_charneg_record(initrs->otherInfo);
3779 char *charset = NULL, *lang = NULL;
3782 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3783 yaz_log(log_details, "%p recv_apdu target accepted: "
3784 "charset %s, language %s, select %d",
3786 charset ? charset : "none", lang ? lang : "none", sel);
3788 ZOOM_connection_option_set(c, "negotiation-charset",
3791 ZOOM_connection_option_set(c, "negotiation-lang",
3794 ZOOM_connection_option_set(
3795 c, "negotiation-charset-in-effect-for-records",
3796 (sel != 0) ? "1" : "0");
3797 nmem_destroy(tmpmem);
3801 case Z_APDU_searchResponse:
3802 yaz_log(log_api, "%p recv_apdu Search response", c);
3803 handle_search_response(c, apdu->u.searchResponse);
3804 if (send_sort_present(c) == zoom_complete)
3805 ZOOM_connection_remove_task(c);
3807 case Z_APDU_presentResponse:
3808 yaz_log(log_api, "%p recv_apdu Present response", c);
3809 handle_present_response(c, apdu->u.presentResponse);
3810 if (send_present(c) == zoom_complete)
3811 ZOOM_connection_remove_task(c);
3813 case Z_APDU_sortResponse:
3814 yaz_log(log_api, "%p recv_apdu Sort response", c);
3815 sort_response(c, apdu->u.sortResponse);
3816 if (send_present(c) == zoom_complete)
3817 ZOOM_connection_remove_task(c);
3819 case Z_APDU_scanResponse:
3820 yaz_log(log_api, "%p recv_apdu Scan response", c);
3821 scan_response(c, apdu->u.scanResponse);
3822 ZOOM_connection_remove_task(c);
3824 case Z_APDU_extendedServicesResponse:
3825 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3826 es_response(c, apdu->u.extendedServicesResponse);
3827 ZOOM_connection_remove_task(c);
3830 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3831 if (!ZOOM_test_reconnect(c))
3833 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3838 yaz_log(log_api, "%p Received unknown PDU", c);
3839 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3845 static void handle_srw_response(ZOOM_connection c,
3846 Z_SRW_searchRetrieveResponse *res)
3848 ZOOM_resultset resultset = 0;
3853 const char *syntax, *elementSetName;
3858 switch(c->tasks->which)
3860 case ZOOM_TASK_SEARCH:
3861 resultset = c->tasks->u.search.resultset;
3862 start = &c->tasks->u.search.start;
3863 syntax = c->tasks->u.search.syntax;
3864 elementSetName = c->tasks->u.search.elementSetName;
3866 case ZOOM_TASK_RETRIEVE:
3867 resultset = c->tasks->u.retrieve.resultset;
3868 start = &c->tasks->u.retrieve.start;
3869 syntax = c->tasks->u.retrieve.syntax;
3870 elementSetName = c->tasks->u.retrieve.elementSetName;
3875 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3876 ZOOM_connection_put_event(c, event);
3878 resultset->size = 0;
3880 if (res->resultSetId)
3881 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
3883 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3885 if (res->numberOfRecords)
3886 resultset->size = *res->numberOfRecords;
3888 for (i = 0; i<res->num_records; i++)
3891 Z_SRW_record *sru_rec;
3892 Z_SRW_diagnostic *diag = 0;
3895 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3896 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3898 if (res->records[i].recordPosition &&
3899 *res->records[i].recordPosition > 0)
3900 pos = *res->records[i].recordPosition - 1;
3904 sru_rec = &res->records[i];
3906 npr->databaseName = 0;
3907 npr->which = Z_NamePlusRecord_databaseRecord;
3908 npr->u.databaseRecord = (Z_External *)
3909 odr_malloc(c->odr_in, sizeof(Z_External));
3910 npr->u.databaseRecord->descriptor = 0;
3911 npr->u.databaseRecord->direct_reference =
3912 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
3913 npr->u.databaseRecord->which = Z_External_octet;
3915 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3916 odr_malloc(c->odr_in, sizeof(Odr_oct));
3917 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3918 sru_rec->recordData_buf;
3919 npr->u.databaseRecord->u.octet_aligned->len =
3920 npr->u.databaseRecord->u.octet_aligned->size =
3921 sru_rec->recordData_len;
3923 if (sru_rec->recordSchema
3924 && !strcmp(sru_rec->recordSchema,
3925 "info:srw/schema/1/diagnostics-v1.1"))
3927 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
3928 sru_rec->recordData_len,
3932 record_cache_add(resultset, npr, pos, syntax, elementSetName,
3933 sru_rec->recordSchema, diag);
3935 if (res->num_diagnostics > 0)
3936 set_SRU_error(c, &res->diagnostics[0]);
3937 nmem = odr_extract_mem(c->odr_in);
3938 nmem_transfer(odr_getmem(resultset->odr), nmem);
3944 static void handle_srw_scan_response(ZOOM_connection c,
3945 Z_SRW_scanResponse *res)
3947 NMEM nmem = odr_extract_mem(c->odr_in);
3950 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
3952 scan = c->tasks->u.scan.scan;
3954 if (res->num_diagnostics > 0)
3955 set_SRU_error(c, &res->diagnostics[0]);
3957 scan->scan_response = 0;
3958 scan->srw_scan_response = res;
3959 nmem_transfer(odr_getmem(scan->odr), nmem);
3961 ZOOM_options_set_int(scan->options, "number", res->num_terms);
3967 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3970 const char *addinfo = 0;
3971 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3973 ZOOM_connection_set_mask(c, 0);
3974 yaz_log(log_details, "%p handle_http", c);
3976 if (!yaz_srw_check_content_type(hres))
3977 addinfo = "content-type";
3980 Z_SOAP *soap_package = 0;
3982 Z_SOAP_Handler soap_handlers[2] = {
3983 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
3986 ret = z_soap_codec(o, &soap_package,
3987 &hres->content_buf, &hres->content_len,
3989 if (!ret && soap_package->which == Z_SOAP_generic &&
3990 soap_package->u.generic->no == 0)
3992 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3994 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
3995 if (sr->which == Z_SRW_searchRetrieve_response)
3996 handle_srw_response(c, sr->u.response);
3997 else if (sr->which == Z_SRW_scan_response)
3998 handle_srw_scan_response(c, sr->u.scan_response);
4002 else if (!ret && (soap_package->which == Z_SOAP_fault
4003 || soap_package->which == Z_SOAP_error))
4005 set_HTTP_error(c, hres->code,
4006 soap_package->u.fault->fault_code,
4007 soap_package->u.fault->fault_string);
4014 if (hres->code != 200)
4015 set_HTTP_error(c, hres->code, 0, 0);
4017 set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
4020 ZOOM_connection_remove_task(c);
4021 if (!strcmp(hres->version, "1.0"))
4023 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
4024 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
4029 /* HTTP 1.1: only if no close we stay alive .. */
4030 if (connection_head && !strcmp(connection_head, "close"))
4036 static int do_read(ZOOM_connection c)
4041 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
4042 ZOOM_connection_put_event(c, event);
4044 r = cs_get(c->cs, &c->buf_in, &c->len_in);
4045 more = cs_more(c->cs);
4046 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
4051 if (!ZOOM_test_reconnect(c))
4053 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4062 odr_reset(c->odr_in);
4063 odr_setbuf(c->odr_in, c->buf_in, r, 0);
4064 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
4065 ZOOM_connection_put_event(c, event);
4067 if (!z_GDU(c->odr_in, &gdu, 0, 0))
4070 int err = odr_geterrorx(c->odr_in, &x);
4072 const char *element = odr_getelement(c->odr_in);
4073 yaz_snprintf(msg, sizeof(msg),
4074 "ODR code %d:%d element=%s offset=%d",
4075 err, x, element ? element : "<unknown>",
4076 odr_offset(c->odr_in));
4077 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
4080 FILE *ber_file = yaz_log_file();
4082 odr_dumpBER(ber_file, c->buf_in, r);
4086 else if (gdu->which == Z_GDU_Z3950)
4087 recv_apdu(c, gdu->u.z3950);
4088 else if (gdu->which == Z_GDU_HTTP_Response)
4091 handle_http(c, gdu->u.HTTP_Response);
4093 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4097 c->reconnect_ok = 0;
4102 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
4107 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
4108 ZOOM_connection_put_event(c, event);
4110 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
4111 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
4113 yaz_log(log_details, "%p do_write_ex write failed", c);
4114 if (ZOOM_test_reconnect(c))
4116 return zoom_pending;
4118 if (c->state == STATE_CONNECTING)
4119 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4121 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4123 return zoom_complete;
4127 int mask = ZOOM_SELECT_EXCEPT;
4128 if (c->cs->io_pending & CS_WANT_WRITE)
4129 mask += ZOOM_SELECT_WRITE;
4130 if (c->cs->io_pending & CS_WANT_READ)
4131 mask += ZOOM_SELECT_READ;
4132 ZOOM_connection_set_mask(c, mask);
4133 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
4138 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
4139 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
4142 return zoom_pending;
4145 static zoom_ret do_write(ZOOM_connection c)
4147 return do_write_ex(c, c->buf_out, c->len_out);
4151 ZOOM_API(const char *)
4152 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
4154 return ZOOM_options_get(c->options, key);
4157 ZOOM_API(const char *)
4158 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
4160 return ZOOM_options_getl(c->options, key, lenp);
4164 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
4167 ZOOM_options_set(c->options, key, val);
4171 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
4172 const char *val, int len)
4174 ZOOM_options_setl(c->options, key, val, len);
4177 ZOOM_API(const char *)
4178 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
4180 return ZOOM_options_get(r->options, key);
4184 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
4187 ZOOM_options_set(r->options, key, val);
4192 ZOOM_connection_errcode(ZOOM_connection c)
4194 return ZOOM_connection_error(c, 0, 0);
4197 ZOOM_API(const char *)
4198 ZOOM_connection_errmsg(ZOOM_connection c)
4201 ZOOM_connection_error(c, &msg, 0);
4205 ZOOM_API(const char *)
4206 ZOOM_connection_addinfo(ZOOM_connection c)
4208 const char *addinfo;
4209 ZOOM_connection_error(c, 0, &addinfo);
4213 ZOOM_API(const char *)
4214 ZOOM_connection_diagset(ZOOM_connection c)
4216 const char *diagset;
4217 ZOOM_connection_error_x(c, 0, 0, &diagset);
4221 ZOOM_API(const char *)
4222 ZOOM_diag_str(int error)
4226 case ZOOM_ERROR_NONE:
4228 case ZOOM_ERROR_CONNECT:
4229 return "Connect failed";
4230 case ZOOM_ERROR_MEMORY:
4231 return "Out of memory";
4232 case ZOOM_ERROR_ENCODE:
4233 return "Encoding failed";
4234 case ZOOM_ERROR_DECODE:
4235 return "Decoding failed";
4236 case ZOOM_ERROR_CONNECTION_LOST:
4237 return "Connection lost";
4238 case ZOOM_ERROR_INIT:
4239 return "Init rejected";
4240 case ZOOM_ERROR_INTERNAL:
4241 return "Internal failure";
4242 case ZOOM_ERROR_TIMEOUT:
4244 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4245 return "Unsupported protocol";
4246 case ZOOM_ERROR_UNSUPPORTED_QUERY:
4247 return "Unsupported query type";
4248 case ZOOM_ERROR_INVALID_QUERY:
4249 return "Invalid query";
4250 case ZOOM_ERROR_CQL_PARSE:
4251 return "CQL parsing error";
4252 case ZOOM_ERROR_CQL_TRANSFORM:
4253 return "CQL transformation error";
4254 case ZOOM_ERROR_CCL_CONFIG:
4255 return "CCL configuration error";
4256 case ZOOM_ERROR_CCL_PARSE:
4257 return "CCL parsing error";
4259 return diagbib1_str(error);
4264 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4265 const char **addinfo, const char **diagset)
4267 int error = c->error;
4270 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4271 *cp = ZOOM_diag_str(error);
4272 else if (!strcmp(c->diagset, "HTTP"))
4273 *cp = z_HTTP_errmsg(c->error);
4274 else if (!strcmp(c->diagset, "Bib-1"))
4275 *cp = ZOOM_diag_str(error);
4276 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4277 *cp = yaz_diag_srw_str(c->error);
4279 *cp = "Unknown error and diagnostic set";
4282 *addinfo = c->addinfo ? c->addinfo : "";
4284 *diagset = c->diagset ? c->diagset : "";
4289 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4290 const char **addinfo)
4292 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4295 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4297 ZOOM_Event event = 0;
4298 int r = cs_look(c->cs);
4299 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4304 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4305 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4307 ZOOM_connection_put_event(c, event);
4309 else if (r == CS_CONNECT)
4311 int ret = ret = cs_rcvconnect(c->cs);
4312 yaz_log(log_details, "%p ZOOM_connection_do_io "
4313 "cs_rcvconnect returned %d", c, ret);
4316 int mask = ZOOM_SELECT_EXCEPT;
4317 if (c->cs->io_pending & CS_WANT_WRITE)
4318 mask += ZOOM_SELECT_WRITE;
4319 if (c->cs->io_pending & CS_WANT_READ)
4320 mask += ZOOM_SELECT_READ;
4321 ZOOM_connection_set_mask(c, mask);
4322 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
4323 ZOOM_connection_put_event(c, event);
4327 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4328 ZOOM_connection_put_event(c, event);
4330 if (c->proto == PROTO_Z3950)
4331 ZOOM_connection_send_init(c);
4334 /* no init request for SRW .. */
4335 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4336 ZOOM_connection_remove_task(c);
4337 ZOOM_connection_set_mask(c, 0);
4338 ZOOM_connection_exec_task(c);
4340 c->state = STATE_ESTABLISHED;
4344 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4350 if (mask & ZOOM_SELECT_EXCEPT)
4352 if (!ZOOM_test_reconnect(c))
4354 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4359 if (mask & ZOOM_SELECT_READ)
4361 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4367 ZOOM_connection_last_event(ZOOM_connection cs)
4370 return ZOOM_EVENT_NONE;
4371 return cs->last_event;
4375 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4377 WRBUF wrbuf = (WRBUF) client_data;
4378 wrbuf_puts(wrbuf, buf);
4382 * Returns an xmalloc()d string containing RPN that corresponds to the
4383 * CQL passed in. On error, sets the Connection object's error state
4384 * and returns a null pointer.
4385 * ### We could cache CQL parser and/or transformer in Connection.
4387 static char *cql2pqf(ZOOM_connection c, const char *cql)
4391 const char *cqlfile;
4392 cql_transform_t trans;
4395 parser = cql_parser_create();
4396 if ((error = cql_parser_string(parser, cql)) != 0) {
4397 cql_parser_destroy(parser);
4398 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4402 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4405 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4407 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4410 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4411 cqlfile, strerror(errno));
4412 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4416 WRBUF wrbuf_result = wrbuf_alloc();
4417 error = cql_transform(trans, cql_parser_result(parser),
4418 cql2pqf_wrbuf_puts, wrbuf_result);
4421 const char *addinfo;
4422 error = cql_transform_error(trans, &addinfo);
4423 sprintf(buf, "%.200s (addinfo=%.200s)",
4424 cql_strerror(error), addinfo);
4425 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4429 result = xstrdup(wrbuf_cstr(wrbuf_result));
4431 cql_transform_close(trans);
4432 wrbuf_destroy(wrbuf_result);
4434 cql_parser_destroy(parser);
4438 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4442 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4443 /* timeout and this connection was waiting */
4444 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4446 ZOOM_connection_put_event(c, event);
4452 ZOOM_connection_process(ZOOM_connection c)
4458 event = ZOOM_connection_get_event(c);
4461 ZOOM_Event_destroy(event);
4464 ZOOM_connection_exec_task(c);
4465 event = ZOOM_connection_get_event(c);
4468 ZOOM_Event_destroy(event);
4475 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4479 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4481 for (i = 0; i<no; i++)
4483 ZOOM_connection c = cs[i];
4485 if (c && ZOOM_connection_process(c))
4491 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4493 if (c->mask && mask)
4494 ZOOM_connection_do_io(c, mask);
4498 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4501 return cs_fileno(c->cs);
4505 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4513 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4520 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4522 return ZOOM_options_get_int(c->options, "timeout", 30);
4528 * indent-tabs-mode: nil
4530 * vim: shiftwidth=4 tabstop=8 expandtab