1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2010 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>
30 #include <yaz/facet.h>
32 #include <yaz/shptr.h>
38 static int log_api = 0;
39 static int log_details = 0;
46 static void resultset_destroy(ZOOM_resultset r);
47 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
48 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
49 static char *cql2pqf(ZOOM_connection c, const char *cql);
51 ZOOM_API(const char *) ZOOM_get_event_str(int event)
53 static const char *ar[] = {
70 * This wrapper is just for logging failed lookups. It would be nicer
71 * if it could cause failure when a lookup fails, but that's hard.
73 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
74 oid_class oid_class, const char *str) {
75 Odr_oid *res = yaz_string_to_oid_odr(yaz_oid_std(), oid_class, str,
78 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
79 c, (int) oid_class, str);
84 static void initlog(void)
86 static int log_level_initialized = 0;
87 if (!log_level_initialized)
89 log_api = yaz_log_module_level("zoom");
90 log_details = yaz_log_module_level("zoomdetails");
91 log_level_initialized = 1;
95 static ZOOM_Event ZOOM_Event_create(int kind)
97 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
101 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
105 static void ZOOM_Event_destroy(ZOOM_Event event)
110 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
114 c->m_queue_back->prev = event;
115 assert(c->m_queue_front);
119 assert(!c->m_queue_front);
120 c->m_queue_front = event;
122 event->next = c->m_queue_back;
124 c->m_queue_back = event;
127 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
129 ZOOM_Event event = c->m_queue_front;
132 c->last_event = ZOOM_EVENT_NONE;
135 assert(c->m_queue_back);
136 c->m_queue_front = event->prev;
137 if (c->m_queue_front)
139 assert(c->m_queue_back);
140 c->m_queue_front->next = 0;
144 c->last_event = event->kind;
148 static void ZOOM_connection_remove_events(ZOOM_connection c)
151 while ((event = ZOOM_connection_get_event(c)))
152 ZOOM_Event_destroy(event);
155 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
157 ZOOM_Event event = c->m_queue_front;
159 return event ? event->kind : ZOOM_EVENT_NONE;
162 void ZOOM_connection_remove_tasks(ZOOM_connection c);
164 static void set_dset_error(ZOOM_connection c, int error,
166 const char *addinfo, const char *addinfo2)
173 if (!c->diagset || strcmp(dset, c->diagset))
176 c->diagset = xstrdup(dset);
177 /* remove integer part from SRW diagset .. */
178 if ((cp = strrchr(c->diagset, '/')))
181 if (addinfo && addinfo2)
183 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
184 strcpy(c->addinfo, addinfo);
185 strcat(c->addinfo, addinfo2);
188 c->addinfo = xstrdup(addinfo);
189 if (error != ZOOM_ERROR_NONE)
191 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
192 c, c->host_port ? c->host_port : "<>", dset, error,
193 addinfo ? addinfo : "",
194 addinfo2 ? addinfo2 : "");
195 ZOOM_connection_remove_tasks(c);
199 static int uri_to_code(const char *uri)
203 if ((cp = strrchr(uri, '/')))
209 static void set_HTTP_error(ZOOM_connection c, int error,
210 const char *addinfo, const char *addinfo2)
212 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
215 static void set_SRU_error(ZOOM_connection c, Z_SRW_diagnostic *d)
217 const char *uri = d->uri;
219 set_dset_error(c, uri_to_code(uri), uri, d->details, 0);
225 static void set_ZOOM_error(ZOOM_connection c, int error,
228 set_dset_error(c, error, "ZOOM", addinfo, 0);
231 static void clear_error(ZOOM_connection c)
234 * If an error is tied to an operation then it's ok to clear: for
235 * example, a diagnostic returned from a search is cleared by a
236 * subsequent search. However, problems such as Connection Lost
237 * or Init Refused are not cleared, because they are not
238 * recoverable: doing another search doesn't help.
241 ZOOM_connection_remove_events(c);
244 case ZOOM_ERROR_CONNECT:
245 case ZOOM_ERROR_MEMORY:
246 case ZOOM_ERROR_DECODE:
247 case ZOOM_ERROR_CONNECTION_LOST:
248 case ZOOM_ERROR_INIT:
249 case ZOOM_ERROR_INTERNAL:
250 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
253 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
257 void ZOOM_connection_show_task(ZOOM_task task)
261 case ZOOM_TASK_SEARCH:
262 yaz_log(YLOG_LOG, "search p=%p", task);
264 case ZOOM_TASK_RETRIEVE:
265 yaz_log(YLOG_LOG, "retrieve p=%p", task);
267 case ZOOM_TASK_CONNECT:
268 yaz_log(YLOG_LOG, "connect p=%p", task);
271 yaz_log(YLOG_LOG, "scan p=%p", task);
276 void ZOOM_connection_show_tasks(ZOOM_connection c)
279 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
280 for (task = c->tasks; task; task = task->next)
281 ZOOM_connection_show_task(task);
284 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
286 ZOOM_task *taskp = &c->tasks;
288 taskp = &(*taskp)->next;
289 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
290 (*taskp)->running = 0;
291 (*taskp)->which = which;
297 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
299 return c->tasks ? 0 : 1;
302 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
304 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
306 task->next = c->tasks;
315 void ZOOM_connection_remove_task(ZOOM_connection c)
317 ZOOM_task task = c->tasks;
321 c->tasks = task->next;
324 case ZOOM_TASK_SEARCH:
325 resultset_destroy(task->u.search.resultset);
326 xfree(task->u.search.syntax);
327 xfree(task->u.search.elementSetName);
329 case ZOOM_TASK_RETRIEVE:
330 resultset_destroy(task->u.retrieve.resultset);
331 xfree(task->u.retrieve.syntax);
332 xfree(task->u.retrieve.elementSetName);
334 case ZOOM_TASK_CONNECT:
337 ZOOM_scanset_destroy(task->u.scan.scan);
339 case ZOOM_TASK_PACKAGE:
340 ZOOM_package_destroy(task->u.package);
343 resultset_destroy(task->u.sort.resultset);
344 ZOOM_query_destroy(task->u.sort.q);
353 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
354 ZOOM_connection_put_event(c, event);
359 void ZOOM_connection_remove_tasks(ZOOM_connection c)
362 ZOOM_connection_remove_task(c);
365 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
367 const char *elementSetName);
369 ZOOM_API(ZOOM_connection)
370 ZOOM_connection_create(ZOOM_options options)
372 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
376 yaz_log(log_api, "%p ZOOM_connection_create", c);
378 c->proto = PROTO_Z3950;
380 ZOOM_connection_set_mask(c, 0);
382 c->state = STATE_IDLE;
385 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
392 c->options = ZOOM_options_create_with_parent(options);
398 c->charset = c->lang = 0;
409 c->maximum_record_size = 0;
410 c->preferred_message_size = 0;
412 c->odr_in = odr_createmem(ODR_DECODE);
413 c->odr_out = odr_createmem(ODR_ENCODE);
417 c->support_named_resultsets = 0;
418 c->last_event = ZOOM_EVENT_NONE;
420 c->m_queue_front = 0;
429 /* set database names. Take local databases (if set); otherwise
430 take databases given in ZURL (if set); otherwise use Default */
431 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
434 char **databaseNames;
435 const char *cp = ZOOM_options_get(options, "databaseName");
437 if ((!cp || !*cp) && con->host_port)
439 if (strncmp(con->host_port, "unix:", 5) == 0)
440 cp = strchr(con->host_port+5, ':');
442 cp = strchr(con->host_port, '/');
448 nmem_strsplit(odr_getmem(odr), "+", cp, &databaseNames, num);
449 return databaseNames;
452 ZOOM_API(ZOOM_connection)
453 ZOOM_connection_new(const char *host, int portnum)
455 ZOOM_connection c = ZOOM_connection_create(0);
457 ZOOM_connection_connect(c, host, portnum);
461 static zoom_sru_mode get_sru_mode_from_string(const char *s)
464 return zoom_sru_soap;
465 if (!yaz_matchstr(s, "soap"))
466 return zoom_sru_soap;
467 else if (!yaz_matchstr(s, "get"))
469 else if (!yaz_matchstr(s, "post"))
470 return zoom_sru_post;
471 return zoom_sru_error;
475 ZOOM_connection_connect(ZOOM_connection c,
476 const char *host, int portnum)
483 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
484 c, host ? host : "null", portnum);
486 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
487 ZOOM_connection_remove_tasks(c);
491 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
492 odr_destroy(c->odr_print);
494 if (ZOOM_options_get_bool(c->options, "apdulog", 0))
496 c->odr_print = odr_createmem(ODR_PRINT);
497 odr_setprint(c->odr_print, yaz_log_file());
504 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
508 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
511 val = ZOOM_options_get(c->options, "proxy");
514 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
515 c->proxy = xstrdup(val);
520 val = ZOOM_options_get(c->options, "charset");
523 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
524 c->charset = xstrdup(val);
528 val = ZOOM_options_get(c->options, "lang");
531 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
532 c->lang = xstrdup(val);
543 sprintf(hostn, "%.80s:%d", host, portnum);
544 c->host_port = xstrdup(hostn);
547 c->host_port = xstrdup(host);
552 * If the "<scheme>:" part of the host string is preceded by one
553 * or more comma-separated <name>=<value> pairs, these are taken
554 * to be options to be set on the connection object. Among other
555 * applications, this facility can be used to embed authentication
557 * user=admin,password=secret,tcp:localhost:9999
559 char *remainder = c->host_port;
560 char *pcolon = strchr(remainder, ':');
563 while ((pcomma = strchr(remainder, ',')) != 0 &&
564 (pcolon == 0 || pcomma < pcolon)) {
566 if ((pequals = strchr(remainder, '=')) != 0) {
568 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
569 ZOOM_connection_option_set(c, remainder, pequals+1);
571 remainder = pcomma+1;
574 if (remainder != c->host_port) {
576 c->host_port = xstrdup(remainder);
577 /*printf("# reset hp='%s'\n", remainder);*/
581 val = ZOOM_options_get(c->options, "sru");
582 c->sru_mode = get_sru_mode_from_string(val);
584 xfree(c->sru_version);
585 val = ZOOM_options_get(c->options, "sru_version");
586 c->sru_version = xstrdup(val ? val : "1.2");
588 ZOOM_options_set(c->options, "host", c->host_port);
590 xfree(c->cookie_out);
592 val = ZOOM_options_get(c->options, "cookie");
595 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
596 c->cookie_out = xstrdup(val);
601 val = ZOOM_options_get(c->options, "clientIP");
604 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
606 c->client_IP = xstrdup(val);
611 val = ZOOM_options_get(c->options, "group");
613 c->group = xstrdup(val);
617 val = ZOOM_options_get(c->options, "user");
619 c->user = xstrdup(val);
623 val = ZOOM_options_get(c->options, "password");
625 val = ZOOM_options_get(c->options, "pass");
628 c->password = xstrdup(val);
630 c->maximum_record_size =
631 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
632 c->preferred_message_size =
633 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
635 c->async = ZOOM_options_get_bool(c->options, "async", 0);
636 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
638 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
642 while (ZOOM_event(1, &c))
648 ZOOM_query_create(void)
650 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
652 yaz_log(log_details, "%p ZOOM_query_create", s);
656 s->odr = odr_createmem(ODR_ENCODE);
663 ZOOM_query_destroy(ZOOM_query s)
669 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
670 if (s->refcount == 0)
678 ZOOM_query_prefix(ZOOM_query s, const char *str)
680 s->query_string = odr_strdup(s->odr, str);
681 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
682 s->z_query->which = Z_Query_type_1;
683 s->z_query->u.type_1 = p_query_rpn(s->odr, str);
684 if (!s->z_query->u.type_1)
686 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
690 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
695 ZOOM_query_cql(ZOOM_query s, const char *str)
699 s->query_string = odr_strdup(s->odr, str);
701 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
702 ext->direct_reference = odr_oiddup(s->odr, yaz_oid_userinfo_cql);
703 ext->indirect_reference = 0;
705 ext->which = Z_External_CQL;
706 ext->u.cql = s->query_string;
708 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
709 s->z_query->which = Z_Query_type_104;
710 s->z_query->u.type_104 = ext;
712 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
718 * Translate the CQL string client-side into RPN which is passed to
719 * the server. This is useful for server's that don't themselves
720 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
721 * only as a place to stash diagnostics if compilation fails; if this
722 * information is not needed, a null pointer may be used.
725 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
729 ZOOM_connection freeme = 0;
731 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
733 conn = freeme = ZOOM_connection_create(0);
735 rpn = cql2pqf(conn, str);
737 ZOOM_connection_destroy(freeme);
741 ret = ZOOM_query_prefix(s, rpn);
747 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
748 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
749 * to the server, as the YAZ GFS doesn't know how to handle this.
752 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
753 int *ccl_error, const char **error_string,
757 struct ccl_rpn_node *rpn;
758 CCL_bibset bibset = ccl_qual_mk();
761 ccl_qual_buf(bibset, config);
763 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
766 *error_string = ccl_err_msg(*ccl_error);
771 WRBUF wr = wrbuf_alloc();
774 ret = ZOOM_query_prefix(s, wrbuf_cstr(wr));
777 ccl_qual_rm(&bibset);
782 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
784 s->sort_spec = yaz_sort_spec(s->odr, criteria);
787 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
791 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
795 static zoom_ret do_write(ZOOM_connection c);
797 ZOOM_API(void) ZOOM_resultset_release(ZOOM_resultset r)
799 #if ZOOM_RESULT_LISTS
803 /* remove ourselves from the resultsets in connection */
804 ZOOM_resultset *rp = &r->connection->resultsets;
807 assert(*rp); /* we must be in this list!! */
809 { /* OK, we're here - take us out of it */
821 ZOOM_connection_destroy(ZOOM_connection c)
823 #if ZOOM_RESULT_LISTS
824 ZOOM_resultsets list;
830 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
834 #if ZOOM_RESULT_LISTS
835 // Remove the connection's usage of resultsets
836 list = c->resultsets;
838 ZOOM_resultsets removed = list;
839 ZOOM_resultset_destroy(list->resultset);
844 for (r = c->resultsets; r; r = r->next)
851 odr_destroy(c->odr_in);
852 odr_destroy(c->odr_out);
855 odr_setprint(c->odr_print, 0); /* prevent destroy from fclose'ing */
856 odr_destroy(c->odr_print);
858 ZOOM_options_destroy(c->options);
859 ZOOM_connection_remove_tasks(c);
860 ZOOM_connection_remove_events(c);
866 xfree(c->cookie_out);
872 xfree(c->sru_version);
876 void ZOOM_resultset_addref(ZOOM_resultset r)
880 yaz_mutex_enter(r->mutex);
882 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
884 yaz_mutex_leave(r->mutex);
888 ZOOM_resultset ZOOM_resultset_create(void)
891 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
895 yaz_log(log_details, "%p ZOOM_resultset_create", r);
898 r->odr = odr_createmem(ODR_ENCODE);
903 for (i = 0; i<RECORD_HASH_SIZE; i++)
904 r->record_hash[i] = 0;
908 r->databaseNames = 0;
909 r->num_databaseNames = 0;
913 yaz_mutex_create(&r->mutex);
916 WRBUF w = wrbuf_alloc();
917 YAZ_SHPTR_INIT(r->record_wrbuf, w);
923 ZOOM_API(ZOOM_resultset)
924 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
927 ZOOM_query s = ZOOM_query_create();
929 ZOOM_query_prefix(s, q);
931 r = ZOOM_connection_search(c, s);
932 ZOOM_query_destroy(s);
936 ZOOM_API(ZOOM_resultset)
937 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
939 ZOOM_resultset r = ZOOM_resultset_create();
943 const char *syntax, *elementSetName;
944 #if ZOOM_RESULT_LISTS
948 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
949 r->r_sort_spec = q->sort_spec;
952 r->options = ZOOM_options_create_with_parent(c->options);
954 start = ZOOM_options_get_int(r->options, "start", 0);
955 count = ZOOM_options_get_int(r->options, "count", 0);
957 /* If "presentChunk" is defined use that; otherwise "step" */
958 const char *cp = ZOOM_options_get(r->options, "presentChunk");
959 r->step = ZOOM_options_get_int(r->options,
960 (cp != 0 ? "presentChunk": "step"), 0);
962 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
963 cp = ZOOM_options_get(r->options, "setname");
965 r->setname = xstrdup(cp);
966 cp = ZOOM_options_get(r->options, "schema");
968 r->schema = xstrdup(cp);
970 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
975 #if ZOOM_RESULT_LISTS
976 yaz_log(log_details, "%p ZOOM_connection_search: Adding new resultset (%p) to resultsets (%p) ", c, r, c->resultsets);
977 set = xmalloc(sizeof(*set));
978 ZOOM_resultset_addref(r);
980 set->next = c->resultsets;
983 r->next = c->resultsets;
986 if (c->host_port && c->proto == PROTO_HTTP)
990 yaz_log(log_details, "ZOOM_connection_search: no comstack");
991 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
995 yaz_log(log_details, "ZOOM_connection_search: reconnect");
1000 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
1001 task->u.search.resultset = r;
1002 task->u.search.start = start;
1003 task->u.search.count = count;
1004 task->u.search.recv_search_fired = 0;
1006 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1007 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
1008 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1009 task->u.search.elementSetName = elementSetName
1010 ? xstrdup(elementSetName) : 0;
1012 ZOOM_resultset_addref(r);
1018 while (ZOOM_event(1, &c))
1025 ZOOM_resultset_sort(ZOOM_resultset r,
1026 const char *sort_type, const char *sort_spec)
1028 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
1032 ZOOM_resultset_sort1(ZOOM_resultset r,
1033 const char *sort_type, const char *sort_spec)
1035 ZOOM_connection c = r->connection;
1039 newq = ZOOM_query_create();
1040 if (ZOOM_query_sortby(newq, sort_spec) < 0)
1043 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
1044 r, r, sort_type, sort_spec);
1048 if (c->host_port && c->proto == PROTO_HTTP)
1052 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
1053 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1057 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
1059 c->reconnect_ok = 1;
1063 ZOOM_resultset_cache_reset(r);
1064 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
1065 task->u.sort.resultset = r;
1066 task->u.sort.q = newq;
1068 ZOOM_resultset_addref(r);
1072 while (ZOOM_event(1, &c))
1079 static void ZOOM_record_release(ZOOM_record rec)
1085 if (rec->record_wrbuf)
1086 YAZ_SHPTR_DEC(rec->record_wrbuf, wrbuf_destroy);
1089 wrbuf_destroy(rec->wrbuf);
1093 odr_destroy(rec->odr);
1097 ZOOM_resultset_cache_reset(ZOOM_resultset r)
1100 for (i = 0; i<RECORD_HASH_SIZE; i++)
1102 ZOOM_record_cache rc;
1103 for (rc = r->record_hash[i]; rc; rc = rc->next)
1105 ZOOM_record_release(&rc->rec);
1107 r->record_hash[i] = 0;
1112 ZOOM_resultset_destroy(ZOOM_resultset r)
1114 resultset_destroy(r);
1117 static void resultset_destroy(ZOOM_resultset r)
1121 yaz_mutex_enter(r->mutex);
1123 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
1125 if (r->refcount == 0)
1127 yaz_mutex_leave(r->mutex);
1129 yaz_log(log_details, "%p ZOOM_connection resultset_destroy: Deleting resultset (%p) ", r->connection, r);
1130 ZOOM_resultset_cache_reset(r);
1131 ZOOM_resultset_release(r);
1132 ZOOM_query_destroy(r->query);
1133 ZOOM_options_destroy(r->options);
1134 odr_destroy(r->odr);
1137 yaz_mutex_destroy(&r->mutex);
1139 YAZ_SHPTR_DEC(r->record_wrbuf, wrbuf_destroy);
1144 yaz_mutex_leave(r->mutex);
1148 ZOOM_resultset_size(ZOOM_resultset r)
1150 yaz_log(log_details, "ZOOM_resultset_size r=%p count=" ODR_INT_PRINTF,
1155 static void do_close(ZOOM_connection c)
1160 ZOOM_connection_set_mask(c, 0);
1161 c->state = STATE_IDLE;
1164 static int ZOOM_test_reconnect(ZOOM_connection c)
1168 if (!c->reconnect_ok)
1171 c->reconnect_ok = 0;
1172 c->tasks->running = 0;
1173 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1175 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1176 ZOOM_connection_put_event(c, event);
1181 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1182 int force_sync, int start, int count)
1187 const char *syntax, *elementSetName;
1191 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1192 " count=%d", r, force_sync, start, count);
1197 if (c->host_port && c->proto == PROTO_HTTP)
1201 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1202 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1206 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1208 c->reconnect_ok = 1;
1211 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1212 task->u.retrieve.resultset = r;
1213 task->u.retrieve.start = start;
1214 task->u.retrieve.count = count;
1216 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1217 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1218 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1219 task->u.retrieve.elementSetName = elementSetName
1220 ? xstrdup(elementSetName) : 0;
1222 cp = ZOOM_options_get(r->options, "schema");
1225 if (!r->schema || strcmp(r->schema, cp))
1228 r->schema = xstrdup(cp);
1232 ZOOM_resultset_addref(r);
1234 if (!r->connection->async || force_sync)
1235 while (r->connection && ZOOM_event(1, &r->connection))
1240 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1241 size_t start, size_t count)
1243 int force_present = 0;
1247 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1248 r, r, (long) start, (long) count);
1251 ZOOM_resultset_retrieve(r, force_present, start, count);
1255 for (i = 0; i< count; i++)
1256 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1261 ZOOM_resultset_facets_size(ZOOM_resultset r) {
1262 return r->num_facets;
1266 ZOOM_API(ZOOM_facet_field *)
1267 ZOOM_resultset_facets(ZOOM_resultset r)
1272 ZOOM_API(const char**)
1273 ZOOM_resultset_facet_names(ZOOM_resultset r)
1275 return (const char **) r->facets_names;
1278 ZOOM_API(const char*)
1279 ZOOM_facet_field_name(ZOOM_facet_field field)
1281 return field->facet_name;
1285 ZOOM_facet_field_term_count(ZOOM_facet_field field)
1287 return field->num_terms;
1290 ZOOM_API(const char*)
1291 ZOOM_facet_field_get_term(ZOOM_facet_field field, size_t idx, int *freq) {
1292 *freq = field->facet_terms[idx].frequency;
1293 return field->facet_terms[idx].term;
1297 static void get_cert(ZOOM_connection c)
1302 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1304 ZOOM_connection_option_setl(c, "sslPeerCert",
1305 cert_buf, cert_len);
1310 static zoom_ret do_connect_host(ZOOM_connection c,
1311 const char *effective_host,
1312 const char *logical_url);
1314 static zoom_ret do_connect(ZOOM_connection c)
1316 const char *effective_host;
1319 effective_host = c->proxy;
1321 effective_host = c->host_port;
1322 return do_connect_host(c, effective_host, c->host_port);
1325 static zoom_ret do_connect_host(ZOOM_connection c, const char *effective_host,
1326 const char *logical_url)
1330 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1334 c->cs = cs_create_host(effective_host, 0, &add);
1336 if (c->cs && c->cs->protocol == PROTO_HTTP)
1343 c->proto = PROTO_HTTP;
1344 cs_get_host_args(logical_url, &db);
1347 c->path = xmalloc(strlen(db) * 3 + 2);
1348 yaz_encode_sru_dbpath_buf(c->path, db);
1351 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1353 return zoom_complete;
1358 int ret = cs_connect(c->cs, add);
1361 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1362 ZOOM_connection_put_event(c, event);
1364 if (c->proto == PROTO_Z3950)
1365 ZOOM_connection_send_init(c);
1368 /* no init request for SRW .. */
1369 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1370 ZOOM_connection_remove_task(c);
1371 ZOOM_connection_set_mask(c, 0);
1372 ZOOM_connection_exec_task(c);
1374 c->state = STATE_ESTABLISHED;
1375 return zoom_pending;
1379 int mask = ZOOM_SELECT_EXCEPT;
1380 if (c->cs->io_pending & CS_WANT_WRITE)
1381 mask += ZOOM_SELECT_WRITE;
1382 if (c->cs->io_pending & CS_WANT_READ)
1383 mask += ZOOM_SELECT_READ;
1384 ZOOM_connection_set_mask(c, mask);
1385 c->state = STATE_CONNECTING;
1386 return zoom_pending;
1389 c->state = STATE_IDLE;
1390 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, logical_url);
1391 return zoom_complete;
1394 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1397 for (i = 0; i<200; i++)
1401 Z_OtherInformation **oi;
1406 sprintf(buf, "otherInfo%d", i);
1407 val = ZOOM_options_get(c->options, buf);
1410 cp = strchr(val, ':');
1414 if (len >= sizeof(buf))
1415 len = sizeof(buf)-1;
1416 memcpy(buf, val, len);
1419 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
1424 yaz_oi_APDU(a, &oi);
1425 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
1429 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1434 Z_OtherInformation **oi;
1435 yaz_oi_APDU(a, &oi);
1436 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
1441 Z_OtherInformation **oi;
1442 yaz_oi_APDU(a, &oi);
1443 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
1446 otherInfo_attach(c, a, out);
1447 if (!z_APDU(out, &a, 0, 0))
1449 FILE *outf = fopen("/tmp/apdu.txt", "a");
1452 ODR odr_pr = odr_createmem(ODR_PRINT);
1453 fprintf(outf, "a=%p\n", a);
1454 odr_setprint(odr_pr, outf);
1455 z_APDU(odr_pr, &a, 0, 0);
1456 odr_destroy(odr_pr);
1458 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1459 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1464 z_APDU(c->odr_print, &a, 0, 0);
1465 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1469 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1473 if (encode_APDU(c, a, c->odr_out))
1474 return zoom_complete;
1475 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1476 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1477 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1478 ZOOM_connection_put_event(c, event);
1479 odr_reset(c->odr_out);
1483 /* returns 1 if PDU was sent OK (still pending )
1484 0 if PDU was not sent OK (nothing to wait for)
1487 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1489 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1490 Z_InitRequest *ireq = apdu->u.initRequest;
1491 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1492 odr_malloc(c->odr_out, sizeof(*auth));
1494 ODR_MASK_SET(ireq->options, Z_Options_search);
1495 ODR_MASK_SET(ireq->options, Z_Options_present);
1496 ODR_MASK_SET(ireq->options, Z_Options_scan);
1497 ODR_MASK_SET(ireq->options, Z_Options_sort);
1498 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1499 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1501 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1502 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1503 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1505 ireq->implementationId =
1506 odr_prepend(c->odr_out,
1507 ZOOM_options_get(c->options, "implementationId"),
1508 ireq->implementationId);
1510 ireq->implementationName =
1511 odr_prepend(c->odr_out,
1512 ZOOM_options_get(c->options, "implementationName"),
1513 odr_prepend(c->odr_out, "ZOOM-C",
1514 ireq->implementationName));
1516 ireq->implementationVersion =
1517 odr_prepend(c->odr_out,
1518 ZOOM_options_get(c->options, "implementationVersion"),
1519 ireq->implementationVersion);
1521 *ireq->maximumRecordSize = c->maximum_record_size;
1522 *ireq->preferredMessageSize = c->preferred_message_size;
1524 if (c->group || c->password)
1526 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1527 pass->groupId = odr_strdup_null(c->odr_out, c->group);
1528 pass->userId = odr_strdup_null(c->odr_out, c->user);
1529 pass->password = odr_strdup_null(c->odr_out, c->password);
1530 auth->which = Z_IdAuthentication_idPass;
1531 auth->u.idPass = pass;
1532 ireq->idAuthentication = auth;
1536 auth->which = Z_IdAuthentication_open;
1537 auth->u.open = odr_strdup(c->odr_out, c->user);
1538 ireq->idAuthentication = auth;
1542 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
1543 yaz_oid_userinfo_proxy, 1, c->host_port);
1545 if (c->charset || c->lang)
1547 Z_OtherInformation **oi;
1548 Z_OtherInformationUnit *oi_unit;
1550 yaz_oi_APDU(apdu, &oi);
1552 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1554 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1555 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1556 oi_unit->information.externallyDefinedInfo =
1557 yaz_set_proposal_charneg_list(c->odr_out, " ",
1558 c->charset, c->lang, 1);
1562 return send_APDU(c, apdu);
1566 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1570 const char *database = ZOOM_options_get(c->options, "databaseName");
1571 char *fdatabase = 0;
1574 fdatabase = yaz_encode_sru_dbpath_odr(c->odr_out, database);
1575 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port,
1576 fdatabase ? fdatabase : c->path);
1578 if (c->sru_mode == zoom_sru_get)
1580 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1582 else if (c->sru_mode == zoom_sru_post)
1584 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1586 else if (c->sru_mode == zoom_sru_soap)
1588 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1590 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1591 return zoom_complete;
1593 z_GDU(c->odr_print, &gdu, 0, 0);
1594 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1596 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1597 ZOOM_connection_put_event(c, event);
1598 odr_reset(c->odr_out);
1604 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type)
1606 Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
1607 sr->username = c->user;
1608 sr->password = c->password;
1614 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1618 ZOOM_resultset resultset = 0;
1620 const char *option_val = 0;
1622 if (c->error) /* don't continue on error */
1623 return zoom_complete;
1625 switch(c->tasks->which)
1627 case ZOOM_TASK_SEARCH:
1628 resultset = c->tasks->u.search.resultset;
1629 if (!resultset->setname)
1630 resultset->setname = xstrdup("default");
1631 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1632 start = &c->tasks->u.search.start;
1633 count = &c->tasks->u.search.count;
1635 case ZOOM_TASK_RETRIEVE:
1636 resultset = c->tasks->u.retrieve.resultset;
1638 start = &c->tasks->u.retrieve.start;
1639 count = &c->tasks->u.retrieve.count;
1641 if (*start >= resultset->size)
1642 return zoom_complete;
1643 if (*start + *count > resultset->size)
1644 *count = resultset->size - *start;
1646 for (i = 0; i < *count; i++)
1649 record_cache_lookup(resultset, i + *start,
1650 c->tasks->u.retrieve.syntax,
1651 c->tasks->u.retrieve.elementSetName);
1656 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1657 ZOOM_connection_put_event(c, event);
1664 return zoom_complete;
1667 return zoom_complete;
1669 assert(resultset->query);
1671 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
1672 if (resultset->query->z_query->which == Z_Query_type_104
1673 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1675 sr->u.request->query_type = Z_SRW_query_type_cql;
1676 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1678 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1679 resultset->query->z_query->u.type_1)
1681 sr->u.request->query_type = Z_SRW_query_type_pqf;
1682 sr->u.request->query.pqf = resultset->query->query_string;
1686 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1687 return zoom_complete;
1689 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1690 sr->u.request->maximumRecords = odr_intdup(
1691 c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
1692 resultset->step : *count);
1693 sr->u.request->recordSchema = resultset->schema;
1695 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1697 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1699 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1700 yaz_encode_sru_extra(sr, c->odr_out, option_val);
1701 return send_srw(c, sr);
1704 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1706 return zoom_complete;
1710 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1713 int lslb, ssub, mspn;
1715 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1716 Z_SearchRequest *search_req = apdu->u.searchRequest;
1717 const char *elementSetName;
1718 const char *smallSetElementSetName;
1719 const char *mediumSetElementSetName;
1723 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1725 r = c->tasks->u.search.resultset;
1727 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1730 ZOOM_options_get(r->options, "elementSetName");
1731 smallSetElementSetName =
1732 ZOOM_options_get(r->options, "smallSetElementSetName");
1733 mediumSetElementSetName =
1734 ZOOM_options_get(r->options, "mediumSetElementSetName");
1736 if (!smallSetElementSetName)
1737 smallSetElementSetName = elementSetName;
1739 if (!mediumSetElementSetName)
1740 mediumSetElementSetName = elementSetName;
1742 facets = ZOOM_options_get(r->options, "facets");
1744 Z_FacetList *facet_list = yaz_pqf_parse_facet_list(c->odr_out, facets);
1746 Z_OtherInformation **oi;
1747 yaz_oi_APDU(apdu, &oi);
1749 yaz_oi_set_facetlist_oid(oi, c->odr_out, yaz_oid_userinfo_facet_1, 1, facet_list);
1757 /* prepare query for the search request */
1758 search_req->query = r->query->z_query;
1759 if (!search_req->query)
1761 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1762 return zoom_complete;
1764 if (r->query->z_query->which == Z_Query_type_1 ||
1765 r->query->z_query->which == Z_Query_type_101)
1767 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
1770 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
1774 search_req->query = yaz_copy_Z_Query(search_req->query,
1777 r = yaz_query_charset_convert_rpnquery_check(
1778 search_req->query->u.type_1,
1780 yaz_iconv_close(cd);
1782 { /* query could not be char converted */
1783 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1784 return zoom_complete;
1789 search_req->databaseNames = r->databaseNames;
1790 search_req->num_databaseNames = r->num_databaseNames;
1792 /* get syntax (no need to provide unless piggyback is in effect) */
1793 syntax = c->tasks->u.search.syntax;
1795 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1796 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1797 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1798 if (lslb != -1 && ssub != -1 && mspn != -1)
1800 /* So're a Z39.50 expert? Let's hope you don't do sort */
1801 *search_req->largeSetLowerBound = lslb;
1802 *search_req->smallSetUpperBound = ssub;
1803 *search_req->mediumSetPresentNumber = mspn;
1805 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1806 && r->piggyback && !r->r_sort_spec && !r->schema)
1808 /* Regular piggyback - do it unless we're going to do sort */
1809 *search_req->largeSetLowerBound = 2000000000;
1810 *search_req->smallSetUpperBound = 1;
1811 *search_req->mediumSetPresentNumber =
1812 r->step>0 ? r->step : c->tasks->u.search.count;
1816 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1817 smallSetElementSetName = 0;
1818 mediumSetElementSetName = 0;
1821 if (smallSetElementSetName && *smallSetElementSetName)
1823 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1824 odr_malloc(c->odr_out, sizeof(*esn));
1826 esn->which = Z_ElementSetNames_generic;
1827 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1828 search_req->smallSetElementSetNames = esn;
1830 if (mediumSetElementSetName && *mediumSetElementSetName)
1832 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1833 odr_malloc(c->odr_out, sizeof(*esn));
1835 esn->which = Z_ElementSetNames_generic;
1836 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1837 search_req->mediumSetElementSetNames = esn;
1840 search_req->preferredRecordSyntax =
1841 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1845 if (c->support_named_resultsets)
1849 /* find the lowest unused ordinal so that we re-use
1850 result sets on the server. */
1851 for (ord = 1; ; ord++)
1853 #if ZOOM_RESULT_LISTS
1854 ZOOM_resultsets rsp;
1855 sprintf(setname, "%d", ord);
1856 for (rsp = c->resultsets; rsp; rsp = rsp->next)
1857 if (rsp->resultset->setname && !strcmp(rsp->resultset->setname, setname))
1863 sprintf(setname, "%d", ord);
1864 for (rp = c->resultsets; rp; rp = rp->next)
1865 if (rp->setname && !strcmp(rp->setname, setname))
1872 r->setname = xstrdup(setname);
1873 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1874 "set %s", c, r->setname);
1878 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1880 r->setname = xstrdup("default");
1882 ZOOM_options_set(r->options, "setname", r->setname);
1884 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1885 return send_APDU(c, apdu);
1888 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1890 char oid_name_buf[OID_STR_MAX];
1891 const char *oid_name;
1894 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
1897 case Z_DefaultDiagFormat_v2Addinfo:
1898 addinfo = r->u.v2Addinfo;
1900 case Z_DefaultDiagFormat_v3Addinfo:
1901 addinfo = r->u.v3Addinfo;
1906 set_dset_error(c, *r->condition, oid_name, addinfo, 0);
1909 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1911 if (p->which != Z_DiagRec_defaultFormat)
1912 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1914 response_default_diag(c, p->u.defaultFormat);
1917 ZOOM_API(ZOOM_record)
1918 ZOOM_record_clone(ZOOM_record srec)
1925 odr_enc = odr_createmem(ODR_ENCODE);
1926 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1928 buf = odr_getbuf(odr_enc, &size, 0);
1930 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1931 yaz_log(log_details, "ZOOM_record create");
1932 nrec->odr = odr_createmem(ODR_DECODE);
1934 nrec->record_wrbuf = 0;
1938 odr_setbuf(nrec->odr, buf, size, 0);
1939 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1941 nrec->schema = odr_strdup_null(nrec->odr, srec->schema);
1942 nrec->diag_uri = odr_strdup_null(nrec->odr, srec->diag_uri);
1943 nrec->diag_message = odr_strdup_null(nrec->odr, srec->diag_message);
1944 nrec->diag_details = odr_strdup_null(nrec->odr, srec->diag_details);
1945 nrec->diag_set = odr_strdup_null(nrec->odr, srec->diag_set);
1946 odr_destroy(odr_enc);
1950 ZOOM_API(ZOOM_record)
1951 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1953 const char *syntax =
1954 ZOOM_options_get(s->options, "preferredRecordSyntax");
1955 const char *elementSetName =
1956 ZOOM_options_get(s->options, "elementSetName");
1958 return record_cache_lookup(s, pos, syntax, elementSetName);
1961 ZOOM_API(ZOOM_record)
1962 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1964 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1969 * MIKE: I think force_sync should always be zero, but I don't
1970 * want to make this change until I get the go-ahead from
1971 * Adam, in case something depends on the old synchronous
1975 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1976 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1977 rec = ZOOM_resultset_record_immediate(r, pos);
1983 ZOOM_record_destroy(ZOOM_record rec)
1985 ZOOM_record_release(rec);
1986 yaz_log(log_details, "ZOOM_record destroy");
1991 static yaz_iconv_t iconv_create_charset(const char *record_charset)
1998 strcpy(to, "UTF-8");
1999 if (record_charset && *record_charset)
2001 /* Use "from,to" or just "from" */
2002 const char *cp = strchr(record_charset, ',');
2003 size_t clen = strlen(record_charset);
2006 strncpy( to, cp+1, sizeof(to)-1);
2007 to[sizeof(to)-1] = '\0';
2008 clen = cp - record_charset;
2010 if (clen > sizeof(from)-1)
2011 clen = sizeof(from)-1;
2014 strncpy(from, record_charset, clen);
2018 cd = yaz_iconv_open(to, from);
2022 static const char *return_marc_record(WRBUF wrbuf,
2025 const char *buf, int sz,
2026 const char *record_charset)
2028 yaz_iconv_t cd = iconv_create_charset(record_charset);
2029 yaz_marc_t mt = yaz_marc_create();
2030 const char *ret_string = 0;
2033 yaz_marc_iconv(mt, cd);
2034 yaz_marc_xml(mt, marc_type);
2035 if (yaz_marc_decode_wrbuf(mt, buf, sz, wrbuf) > 0)
2038 *len = wrbuf_len(wrbuf);
2039 ret_string = wrbuf_cstr(wrbuf);
2041 yaz_marc_destroy(mt);
2043 yaz_iconv_close(cd);
2047 static const char *return_opac_record(WRBUF wrbuf,
2050 Z_OPACRecord *opac_rec,
2051 const char *record_charset)
2053 yaz_iconv_t cd = iconv_create_charset(record_charset);
2054 yaz_marc_t mt = yaz_marc_create();
2057 yaz_marc_iconv(mt, cd);
2058 yaz_marc_xml(mt, marc_type);
2060 yaz_opac_decode_wrbuf(mt, opac_rec, wrbuf);
2061 yaz_marc_destroy(mt);
2064 yaz_iconv_close(cd);
2066 *len = wrbuf_len(wrbuf);
2067 return wrbuf_cstr(wrbuf);
2070 static const char *return_string_record(WRBUF wrbuf,
2072 const char *buf, int sz,
2073 const char *record_charset)
2075 yaz_iconv_t cd = iconv_create_charset(record_charset);
2079 wrbuf_iconv_write(wrbuf, cd, buf, sz);
2080 wrbuf_iconv_reset(wrbuf, cd);
2082 buf = wrbuf_cstr(wrbuf);
2083 sz = wrbuf_len(wrbuf);
2084 yaz_iconv_close(cd);
2091 static const char *return_record_wrbuf(WRBUF wrbuf, int *len,
2092 Z_NamePlusRecord *npr,
2093 int marctype, const char *charset)
2095 Z_External *r = (Z_External *) npr->u.databaseRecord;
2096 const Odr_oid *oid = r->direct_reference;
2098 wrbuf_rewind(wrbuf);
2099 /* render bibliographic record .. */
2100 if (r->which == Z_External_OPAC)
2102 return return_opac_record(wrbuf, marctype, len,
2103 r->u.opac, charset);
2105 if (r->which == Z_External_sutrs)
2106 return return_string_record(wrbuf, len,
2107 (char*) r->u.sutrs->buf,
2110 else if (r->which == Z_External_octet)
2112 if (yaz_oid_is_iso2709(oid))
2114 const char *ret_buf = return_marc_record(
2115 wrbuf, marctype, len,
2116 (const char *) r->u.octet_aligned->buf,
2117 r->u.octet_aligned->len,
2121 /* bad ISO2709. Return fail unless raw (ISO2709) is wanted */
2122 if (marctype != YAZ_MARC_ISO2709)
2125 return return_string_record(wrbuf, len,
2126 (const char *) r->u.octet_aligned->buf,
2127 r->u.octet_aligned->len,
2130 else if (r->which == Z_External_grs1)
2132 yaz_display_grs1(wrbuf, r->u.grs1, 0);
2133 return return_string_record(wrbuf, len,
2142 ZOOM_record_error(ZOOM_record rec, const char **cp,
2143 const char **addinfo, const char **diagset)
2145 Z_NamePlusRecord *npr;
2154 *cp = rec->diag_message;
2156 *addinfo = rec->diag_details;
2158 *diagset = rec->diag_set;
2159 return uri_to_code(rec->diag_uri);
2161 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
2163 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
2164 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
2165 const char *add = 0;
2167 if (diag_rec->which == Z_DiagRec_defaultFormat)
2169 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
2172 error = *ddf->condition;
2175 case Z_DefaultDiagFormat_v2Addinfo:
2176 add = ddf->u.v2Addinfo;
2178 case Z_DefaultDiagFormat_v3Addinfo:
2179 add = ddf->u.v3Addinfo;
2184 yaz_oid_to_string(yaz_oid_std(),
2185 ddf->diagnosticSetId, &oclass);
2193 *addinfo = add ? add : "";
2195 *cp = diagbib1_str(error);
2201 static const char *get_record_format(WRBUF wrbuf, int *len,
2202 Z_NamePlusRecord *npr,
2203 int marctype, const char *charset,
2206 const char *res = return_record_wrbuf(wrbuf, len, npr, marctype, charset);
2208 if (*format == '1' && len)
2210 /* try to XML format res */
2212 xmlKeepBlanksDefault(0); /* get get xmlDocFormatMemory to work! */
2213 doc = xmlParseMemory(res, *len);
2218 xmlDocDumpFormatMemory(doc, &xml_mem, &xml_size, 1);
2219 wrbuf_rewind(wrbuf);
2220 wrbuf_write(wrbuf, (const char *) xml_mem, xml_size);
2223 res = wrbuf_cstr(wrbuf);
2224 *len = wrbuf_len(wrbuf);
2232 static const char *npr_format(Z_NamePlusRecord *npr, const char *schema,
2234 const char *type_spec, int *len)
2240 const char *cp = type_spec;
2242 for (i = 0; cp[i] && cp[i] != ';' && cp[i] != ' ' && i < sizeof(type)-1;
2250 while (cp[i] == ' ')
2255 while (cp[i] == ' ')
2257 if (!strncmp(cp + i, "charset=", 8))
2260 i = i + 8; /* skip charset= */
2261 for (j = 0; cp[i] && cp[i] != ';' && cp[i] != ' '; i++)
2263 if (j < sizeof(charset)-1)
2264 charset[j++] = cp[i];
2268 else if (!strncmp(cp + i, "format=", 7))
2272 for (j = 0; cp[i] && cp[i] != ';' && cp[i] != ' '; i++)
2274 if (j < sizeof(format)-1)
2275 format[j++] = cp[i];
2280 if (!strcmp(type, "database"))
2283 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
2284 return npr->databaseName;
2286 else if (!strcmp(type, "schema"))
2289 *len = schema ? strlen(schema) : 0;
2292 else if (!strcmp(type, "syntax"))
2294 const char *desc = 0;
2295 if (npr->which == Z_NamePlusRecord_databaseRecord)
2297 Z_External *r = (Z_External *) npr->u.databaseRecord;
2298 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
2303 *len = strlen(desc);
2306 if (npr->which != Z_NamePlusRecord_databaseRecord)
2309 /* from now on - we have a database record .. */
2310 if (!strcmp(type, "render"))
2312 return get_record_format(wrbuf, len, npr, YAZ_MARC_LINE, charset, format);
2314 else if (!strcmp(type, "xml"))
2316 return get_record_format(wrbuf, len, npr, YAZ_MARC_MARCXML, charset,
2319 else if (!strcmp(type, "txml"))
2321 return get_record_format(wrbuf, len, npr, YAZ_MARC_TURBOMARC, charset,
2324 else if (!strcmp(type, "raw"))
2326 return get_record_format(wrbuf, len, npr, YAZ_MARC_ISO2709, charset,
2329 else if (!strcmp(type, "ext"))
2332 return (const char *) npr->u.databaseRecord;
2334 else if (!strcmp(type, "opac"))
2336 if (npr->u.databaseRecord->which == Z_External_OPAC)
2337 return get_record_format(wrbuf, len, npr, YAZ_MARC_MARCXML, charset,
2343 ZOOM_API(const char *)
2344 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
2349 *len = 0; /* default return */
2351 if (!rec || !rec->npr)
2355 if (!rec->record_wrbuf)
2357 WRBUF w = wrbuf_alloc();
2358 YAZ_SHPTR_INIT(rec->record_wrbuf, w);
2360 wrbuf = rec->record_wrbuf->ptr;
2363 rec->wrbuf = wrbuf_alloc();
2366 return npr_format(rec->npr, rec->schema, wrbuf, type_spec, len);
2369 static int strcmp_null(const char *v1, const char *v2)
2375 return strcmp(v1, v2);
2378 static size_t record_hash(int pos)
2382 return pos % RECORD_HASH_SIZE;
2385 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2387 const char *syntax, const char *elementSetName,
2389 Z_SRW_diagnostic *diag)
2391 ZOOM_record_cache rc = 0;
2393 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2394 ZOOM_connection_put_event(r->connection, event);
2396 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2399 && strcmp_null(r->schema, rc->schema) == 0
2400 && strcmp_null(elementSetName,rc->elementSetName) == 0
2401 && strcmp_null(syntax, rc->syntax) == 0)
2406 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2409 YAZ_SHPTR_INC(r->record_wrbuf);
2410 rc->rec.record_wrbuf = r->record_wrbuf;
2414 rc->elementSetName = odr_strdup_null(r->odr, elementSetName);
2416 rc->syntax = odr_strdup_null(r->odr, syntax);
2418 rc->schema = odr_strdup_null(r->odr, r->schema);
2421 rc->next = r->record_hash[record_hash(pos)];
2422 r->record_hash[record_hash(pos)] = rc;
2425 rc->rec.schema = odr_strdup_null(r->odr, schema);
2426 rc->rec.diag_set = 0;
2427 rc->rec.diag_uri = 0;
2428 rc->rec.diag_message = 0;
2429 rc->rec.diag_details = 0;
2435 rc->rec.diag_set = odr_strdup(r->odr, diag->uri);
2436 if ((cp = strrchr(rc->rec.diag_set, '/')))
2438 rc->rec.diag_uri = odr_strdup(r->odr, diag->uri);
2440 rc->rec.diag_message = odr_strdup_null(r->odr, diag->message);
2441 rc->rec.diag_details = odr_strdup_null(r->odr, diag->details);
2445 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2447 const char *elementSetName)
2449 ZOOM_record_cache rc;
2451 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2455 if (strcmp_null(r->schema, rc->schema))
2457 if (strcmp_null(elementSetName,rc->elementSetName))
2459 if (strcmp_null(syntax, rc->syntax))
2467 static void handle_records(ZOOM_connection c, Z_Records *sr,
2470 ZOOM_resultset resultset;
2472 const char *syntax = 0, *elementSetName = 0;
2476 switch (c->tasks->which)
2478 case ZOOM_TASK_SEARCH:
2479 resultset = c->tasks->u.search.resultset;
2480 start = &c->tasks->u.search.start;
2481 count = &c->tasks->u.search.count;
2482 syntax = c->tasks->u.search.syntax;
2483 elementSetName = c->tasks->u.search.elementSetName;
2485 case ZOOM_TASK_RETRIEVE:
2486 resultset = c->tasks->u.retrieve.resultset;
2487 start = &c->tasks->u.retrieve.start;
2488 count = &c->tasks->u.retrieve.count;
2489 syntax = c->tasks->u.retrieve.syntax;
2490 elementSetName = c->tasks->u.retrieve.elementSetName;
2495 if (sr && sr->which == Z_Records_NSD)
2496 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2497 else if (sr && sr->which == Z_Records_multipleNSD)
2499 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2500 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2502 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2506 if (*count + *start > resultset->size)
2507 *count = resultset->size - *start;
2510 if (sr && sr->which == Z_Records_DBOSD)
2513 NMEM nmem = odr_extract_mem(c->odr_in);
2514 Z_NamePlusRecordList *p =
2515 sr->u.databaseOrSurDiagnostics;
2516 for (i = 0; i<p->num_records; i++)
2518 record_cache_add(resultset, p->records[i], i + *start,
2519 syntax, elementSetName,
2526 yaz_log(log_details,
2527 "handle_records resultset=%p start=%d count=%d",
2528 resultset, *start, *count);
2530 /* transfer our response to search_nmem .. we need it later */
2531 nmem_transfer(odr_getmem(resultset->odr), nmem);
2533 if (present_phase && p->num_records == 0)
2535 /* present response and we didn't get any records! */
2536 Z_NamePlusRecord *myrec =
2537 zget_surrogateDiagRec(
2539 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
2540 "ZOOM C generated. Present phase and no records");
2541 record_cache_add(resultset, myrec, *start,
2542 syntax, elementSetName, 0, 0);
2545 else if (present_phase)
2547 /* present response and we didn't get any records! */
2548 Z_NamePlusRecord *myrec =
2549 zget_surrogateDiagRec(
2551 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
2552 "ZOOM C generated: Present response and no records");
2553 record_cache_add(resultset, myrec, *start, syntax, elementSetName,
2559 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2561 handle_records(c, pr->records, 1);
2564 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2567 switch (term->which)
2569 case Z_Term_general:
2570 ZOOM_options_setl(opt, name,
2571 (const char *)(term->u.general->buf),
2572 term->u.general->len);
2574 case Z_Term_characterString:
2575 ZOOM_options_set(opt, name, term->u.characterString);
2577 case Z_Term_numeric:
2578 ZOOM_options_set_int(opt, name, *term->u.numeric);
2583 static void handle_queryExpression(ZOOM_options opt, const char *name,
2584 Z_QueryExpression *exp)
2590 case Z_QueryExpression_term:
2591 if (exp->u.term && exp->u.term->queryTerm)
2593 sprintf(opt_name, "%s.term", name);
2594 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2597 case Z_QueryExpression_query:
2602 static void handle_search_result(ZOOM_connection c, ZOOM_resultset resultset,
2603 Z_OtherInformation *o)
2606 for (i = 0; o && i < o->num_elements; i++)
2608 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2610 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2612 if (ext->which == Z_External_searchResult1)
2615 Z_SearchInfoReport *sr = ext->u.searchResult1;
2618 ZOOM_options_set_int(
2619 resultset->options, "searchresult.size", sr->num);
2621 for (j = 0; j < sr->num; j++)
2623 Z_SearchInfoReport_s *ent =
2624 ext->u.searchResult1->elements[j];
2627 sprintf(pref, "searchresult.%d", j);
2629 if (ent->subqueryId)
2632 sprintf(opt_name, "%s.id", pref);
2633 ZOOM_options_set(resultset->options, opt_name,
2636 if (ent->subqueryExpression)
2639 sprintf(opt_name, "%s.subquery", pref);
2640 handle_queryExpression(resultset->options, opt_name,
2641 ent->subqueryExpression);
2643 if (ent->subqueryInterpretation)
2646 sprintf(opt_name, "%s.interpretation", pref);
2647 handle_queryExpression(resultset->options, opt_name,
2648 ent->subqueryInterpretation);
2650 if (ent->subqueryRecommendation)
2653 sprintf(opt_name, "%s.recommendation", pref);
2654 handle_queryExpression(resultset->options, opt_name,
2655 ent->subqueryRecommendation);
2657 if (ent->subqueryCount)
2660 sprintf(opt_name, "%s.count", pref);
2661 ZOOM_options_set_int(resultset->options, opt_name,
2662 *ent->subqueryCount);
2670 static char *get_term_cstr(ODR odr, Z_Term *term) {
2672 switch (term->which) {
2673 case Z_Term_general:
2674 return odr_strdupn(odr, (const char *) term->u.general->buf, (size_t) term->u.general->len);
2676 case Z_Term_characterString:
2677 return odr_strdup(odr, term->u.characterString);
2682 static ZOOM_facet_field get_zoom_facet_field(ODR odr, Z_FacetField *facet) {
2684 struct attrvalues attr_values;
2685 ZOOM_facet_field facet_field = odr_malloc(odr, sizeof(*facet_field));
2686 memset(&attr_values, 0, sizeof(attr_values));
2687 facetattrs(facet->attributes, &attr_values);
2688 facet_field->facet_name = odr_strdup(odr, attr_values.useattr);
2689 facet_field->num_terms = facet->num_terms;
2690 facet_field->facet_terms = odr_malloc(odr, facet_field->num_terms * sizeof(*facet_field->facet_terms));
2691 for (term_index = 0 ; term_index < facet->num_terms; term_index++) {
2692 Z_FacetTerm *facetTerm = facet->terms[term_index];
2693 facet_field->facet_terms[term_index].frequency = *facetTerm->count;
2694 facet_field->facet_terms[term_index].term = get_term_cstr(odr, facetTerm->term);
2699 static void handle_facet_result(ZOOM_connection c, ZOOM_resultset r,
2700 Z_OtherInformation *o)
2703 for (i = 0; o && i < o->num_elements; i++)
2705 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2707 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2708 if (ext->which == Z_External_userFacets)
2711 Z_FacetList *fl = ext->u.facetList;
2712 r->num_facets = fl->num;
2713 r->facets = odr_malloc(r->odr, r->num_facets * sizeof(*r->facets));
2714 r->facets_names = odr_malloc(r->odr, r->num_facets * sizeof(*r->facets_names));
2715 for (j = 0; j < fl->num; j++)
2717 r->facets[j] = get_zoom_facet_field(r->odr, fl->elements[j]);
2718 r->facets_names[j] = (char *) ZOOM_facet_field_name(r->facets[j]);
2726 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2728 ZOOM_resultset resultset;
2731 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2734 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2735 ZOOM_connection_put_event(c, event);
2737 resultset = c->tasks->u.search.resultset;
2739 if (sr->resultSetStatus)
2741 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2742 *sr->resultSetStatus);
2744 if (sr->presentStatus)
2746 ZOOM_options_set_int(resultset->options, "presentStatus",
2747 *sr->presentStatus);
2749 handle_search_result(c, resultset, sr->additionalSearchInfo);
2751 handle_facet_result(c, resultset, sr->additionalSearchInfo);
2753 resultset->size = *sr->resultCount;
2754 handle_records(c, sr->records, 0);
2757 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2759 if (res->diagnostics && res->num_diagnostics > 0)
2760 response_diag(c, res->diagnostics[0]);
2763 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2765 NMEM nmem = odr_extract_mem(c->odr_in);
2768 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2770 scan = c->tasks->u.scan.scan;
2772 if (res->entries && res->entries->nonsurrogateDiagnostics)
2773 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2774 scan->scan_response = res;
2775 scan->srw_scan_response = 0;
2776 nmem_transfer(odr_getmem(scan->odr), nmem);
2778 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2779 if (res->positionOfTerm)
2780 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2781 if (res->scanStatus)
2782 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2783 if (res->numberOfEntriesReturned)
2784 ZOOM_options_set_int(scan->options, "number",
2785 *res->numberOfEntriesReturned);
2790 static zoom_ret send_sort(ZOOM_connection c,
2791 ZOOM_resultset resultset)
2794 resultset->r_sort_spec = 0;
2795 if (resultset->r_sort_spec)
2797 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2798 Z_SortRequest *req = apdu->u.sortRequest;
2800 req->num_inputResultSetNames = 1;
2801 req->inputResultSetNames = (Z_InternationalString **)
2802 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2803 req->inputResultSetNames[0] =
2804 odr_strdup(c->odr_out, resultset->setname);
2805 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2806 req->sortSequence = resultset->r_sort_spec;
2807 resultset->r_sort_spec = 0;
2808 return send_APDU(c, apdu);
2810 return zoom_complete;
2813 static zoom_ret send_present(ZOOM_connection c)
2816 Z_PresentRequest *req = 0;
2818 const char *syntax = 0;
2819 const char *elementSetName = 0;
2820 ZOOM_resultset resultset;
2825 yaz_log(log_details, "%p send_present no tasks", c);
2826 return zoom_complete;
2829 switch (c->tasks->which)
2831 case ZOOM_TASK_SEARCH:
2832 resultset = c->tasks->u.search.resultset;
2833 start = &c->tasks->u.search.start;
2834 count = &c->tasks->u.search.count;
2835 syntax = c->tasks->u.search.syntax;
2836 elementSetName = c->tasks->u.search.elementSetName;
2838 case ZOOM_TASK_RETRIEVE:
2839 resultset = c->tasks->u.retrieve.resultset;
2840 start = &c->tasks->u.retrieve.start;
2841 count = &c->tasks->u.retrieve.count;
2842 syntax = c->tasks->u.retrieve.syntax;
2843 elementSetName = c->tasks->u.retrieve.elementSetName;
2846 return zoom_complete;
2848 yaz_log(log_details, "%p send_present start=%d count=%d",
2851 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2853 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2856 if (c->error) /* don't continue on error */
2857 return zoom_complete;
2858 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2859 resultset, *start, *count);
2861 for (i = 0; i < *count; i++)
2864 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2869 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2870 ZOOM_connection_put_event(c, event);
2878 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2879 return zoom_complete;
2882 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2883 req = apdu->u.presentRequest;
2886 yaz_log(log_details, "%p send_present skip=%d", c, i);
2888 *req->resultSetStartPoint = *start + 1;
2890 if (resultset->step > 0 && resultset->step < *count)
2891 *req->numberOfRecordsRequested = resultset->step;
2893 *req->numberOfRecordsRequested = *count;
2895 if (*req->numberOfRecordsRequested + *start > resultset->size)
2896 *req->numberOfRecordsRequested = resultset->size - *start;
2897 assert(*req->numberOfRecordsRequested > 0);
2899 if (syntax && *syntax)
2900 req->preferredRecordSyntax =
2901 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2903 if (resultset->schema && *resultset->schema)
2905 Z_RecordComposition *compo = (Z_RecordComposition *)
2906 odr_malloc(c->odr_out, sizeof(*compo));
2908 req->recordComposition = compo;
2909 compo->which = Z_RecordComp_complex;
2910 compo->u.complex = (Z_CompSpec *)
2911 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2912 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2913 odr_malloc(c->odr_out, sizeof(bool_t));
2914 *compo->u.complex->selectAlternativeSyntax = 0;
2916 compo->u.complex->generic = (Z_Specification *)
2917 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2919 compo->u.complex->generic->which = Z_Schema_oid;
2920 compo->u.complex->generic->schema.oid = (Odr_oid *)
2921 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2923 if (!compo->u.complex->generic->schema.oid)
2925 /* OID wasn't a schema! Try record syntax instead. */
2927 compo->u.complex->generic->schema.oid = (Odr_oid *)
2928 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2930 if (elementSetName && *elementSetName)
2932 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2933 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2934 compo->u.complex->generic->elementSpec->which =
2935 Z_ElementSpec_elementSetName;
2936 compo->u.complex->generic->elementSpec->u.elementSetName =
2937 odr_strdup(c->odr_out, elementSetName);
2940 compo->u.complex->generic->elementSpec = 0;
2941 compo->u.complex->num_dbSpecific = 0;
2942 compo->u.complex->dbSpecific = 0;
2943 compo->u.complex->num_recordSyntax = 0;
2944 compo->u.complex->recordSyntax = 0;
2946 else if (elementSetName && *elementSetName)
2948 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2949 odr_malloc(c->odr_out, sizeof(*esn));
2950 Z_RecordComposition *compo = (Z_RecordComposition *)
2951 odr_malloc(c->odr_out, sizeof(*compo));
2953 esn->which = Z_ElementSetNames_generic;
2954 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2955 compo->which = Z_RecordComp_simple;
2956 compo->u.simple = esn;
2957 req->recordComposition = compo;
2959 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2960 return send_APDU(c, apdu);
2963 ZOOM_API(ZOOM_scanset)
2964 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2967 ZOOM_query q = ZOOM_query_create();
2969 ZOOM_query_prefix(q, start);
2971 s = ZOOM_connection_scan1(c, q);
2972 ZOOM_query_destroy(q);
2977 ZOOM_API(ZOOM_scanset)
2978 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2980 ZOOM_scanset scan = 0;
2984 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2985 scan->connection = c;
2986 scan->odr = odr_createmem(ODR_DECODE);
2987 scan->options = ZOOM_options_create_with_parent(c->options);
2989 scan->scan_response = 0;
2990 scan->srw_scan_response = 0;
2994 scan->databaseNames = set_DatabaseNames(c, c->options,
2995 &scan->num_databaseNames,
3000 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
3001 task->u.scan.scan = scan;
3006 while (ZOOM_event(1, &c))
3014 ZOOM_scanset_destroy(ZOOM_scanset scan)
3019 if (scan->refcount == 0)
3021 ZOOM_query_destroy(scan->query);
3023 odr_destroy(scan->odr);
3025 ZOOM_options_destroy(scan->options);
3030 static zoom_ret send_package(ZOOM_connection c)
3034 yaz_log(log_details, "%p send_package", c);
3036 return zoom_complete;
3037 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
3039 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
3040 ZOOM_connection_put_event(c, event);
3042 c->buf_out = c->tasks->u.package->buf_out;
3043 c->len_out = c->tasks->u.package->len_out;
3048 static zoom_ret ZOOM_connection_send_scan(ZOOM_connection c)
3051 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
3052 Z_ScanRequest *req = apdu->u.scanRequest;
3054 yaz_log(log_details, "%p send_scan", c);
3056 return zoom_complete;
3057 assert (c->tasks->which == ZOOM_TASK_SCAN);
3058 scan = c->tasks->u.scan.scan;
3060 /* Z39.50 scan can only carry RPN */
3061 if (scan->query->z_query->which == Z_Query_type_1 ||
3062 scan->query->z_query->which == Z_Query_type_101)
3064 Z_RPNQuery *rpn = scan->query->z_query->u.type_1;
3065 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
3068 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
3071 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
3073 yaz_query_charset_convert_rpnquery(
3074 rpn, c->odr_out, cd);
3075 yaz_iconv_close(cd);
3078 req->attributeSet = rpn->attributeSetId;
3079 if (!req->attributeSet)
3080 req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
3081 if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
3082 rpn->RPNStructure->u.simple->which == Z_Operand_APT)
3084 req->termListAndStartPoint =
3085 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
3089 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
3090 return zoom_complete;
3095 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
3096 return zoom_complete;
3099 *req->numberOfTermsRequested =
3100 ZOOM_options_get_int(scan->options, "number", 20);
3102 req->preferredPositionInResponse =
3103 odr_intdup(c->odr_out,
3104 ZOOM_options_get_int(scan->options, "position", 1));
3107 odr_intdup(c->odr_out,
3108 ZOOM_options_get_int(scan->options, "stepSize", 0));
3110 req->databaseNames = scan->databaseNames;
3111 req->num_databaseNames = scan->num_databaseNames;
3113 return send_APDU(c, apdu);
3117 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
3121 const char *option_val = 0;
3124 return zoom_complete;
3125 assert (c->tasks->which == ZOOM_TASK_SCAN);
3126 scan = c->tasks->u.scan.scan;
3128 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
3130 /* SRU scan can only carry CQL and PQF */
3131 if (scan->query->z_query->which == Z_Query_type_104)
3133 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
3134 sr->u.scan_request->scanClause.cql = scan->query->query_string;
3136 else if (scan->query->z_query->which == Z_Query_type_1
3137 || scan->query->z_query->which == Z_Query_type_101)
3139 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
3140 sr->u.scan_request->scanClause.pqf = scan->query->query_string;
3144 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
3145 return zoom_complete;
3148 sr->u.scan_request->maximumTerms = odr_intdup(
3149 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
3151 sr->u.scan_request->responsePosition = odr_intdup(
3152 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
3154 option_val = ZOOM_options_get(scan->options, "extraArgs");
3155 yaz_encode_sru_extra(sr, c->odr_out, option_val);
3156 return send_srw(c, sr);
3159 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
3161 return zoom_complete;
3167 ZOOM_scanset_size(ZOOM_scanset scan)
3172 if (scan->scan_response && scan->scan_response->entries)
3173 return scan->scan_response->entries->num_entries;
3174 else if (scan->srw_scan_response)
3175 return scan->srw_scan_response->num_terms;
3179 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
3181 const char **value_term, size_t *value_len,
3182 const char **disp_term, size_t *disp_len)
3184 size_t noent = ZOOM_scanset_size(scan);
3195 if (scan->scan_response)
3197 Z_ScanResponse *res = scan->scan_response;
3198 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
3200 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
3202 *value_term = (const char *) t->term->u.general->buf;
3203 *value_len = t->term->u.general->len;
3206 *disp_term = t->displayTerm;
3207 *disp_len = strlen(*disp_term);
3209 else if (t->term->which == Z_Term_general)
3211 *disp_term = (const char *) t->term->u.general->buf;
3212 *disp_len = t->term->u.general->len;
3214 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
3217 if (scan->srw_scan_response)
3219 Z_SRW_scanResponse *res = scan->srw_scan_response;
3220 Z_SRW_scanTerm *t = res->terms + pos;
3223 *value_term = t->value;
3224 *value_len = strlen(*value_term);
3227 *disp_term = t->displayTerm;
3229 *disp_term = t->value;
3230 *disp_len = strlen(*disp_term);
3231 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
3236 ZOOM_API(const char *)
3237 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
3238 size_t *occ, size_t *len)
3240 const char *value_term = 0;
3241 size_t value_len = 0;
3242 const char *disp_term = 0;
3243 size_t disp_len = 0;
3245 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3246 &disp_term, &disp_len);
3252 ZOOM_API(const char *)
3253 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
3254 size_t *occ, size_t *len)
3256 const char *value_term = 0;
3257 size_t value_len = 0;
3258 const char *disp_term = 0;
3259 size_t disp_len = 0;
3261 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3262 &disp_term, &disp_len);
3268 ZOOM_API(const char *)
3269 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
3271 return ZOOM_options_get(scan->options, key);
3275 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
3278 ZOOM_options_set(scan->options, key, val);
3281 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
3284 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
3285 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3287 str = ZOOM_options_get(p->options, "package-name");
3289 req->packageName = odr_strdup(p->odr_out, str);
3291 str = ZOOM_options_get(p->options, "user-id");
3293 req->userId = odr_strdup_null(p->odr_out, str);
3295 req->packageType = odr_oiddup(p->odr_out, oid);
3297 str = ZOOM_options_get(p->options, "function");
3300 if (!strcmp (str, "create"))
3301 *req->function = Z_ExtendedServicesRequest_create;
3302 if (!strcmp (str, "delete"))
3303 *req->function = Z_ExtendedServicesRequest_delete;
3304 if (!strcmp (str, "modify"))
3305 *req->function = Z_ExtendedServicesRequest_modify;
3308 str = ZOOM_options_get(p->options, "waitAction");
3311 if (!strcmp (str, "wait"))
3312 *req->waitAction = Z_ExtendedServicesRequest_wait;
3313 if (!strcmp (str, "waitIfPossible"))
3314 *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
3315 if (!strcmp (str, "dontWait"))
3316 *req->waitAction = Z_ExtendedServicesRequest_dontWait;
3317 if (!strcmp (str, "dontReturnPackage"))
3318 *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
3323 static const char *ill_array_lookup(void *clientData, const char *idx)
3325 ZOOM_package p = (ZOOM_package) clientData;
3326 return ZOOM_options_get(p->options, idx+4);
3329 static Z_External *encode_ill_request(ZOOM_package p)
3331 ODR out = p->odr_out;
3334 struct ill_get_ctl ctl;
3336 ctl.odr = p->odr_out;
3338 ctl.f = ill_array_lookup;
3340 req = ill_get_ILLRequest(&ctl, "ill", 0);
3342 if (!ill_Request(out, &req, 0, 0))
3344 int ill_request_size;
3345 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
3346 if (ill_request_buf)
3347 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
3352 int illRequest_size = 0;
3353 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
3355 r = (Z_External *) odr_malloc(out, sizeof(*r));
3356 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
3357 r->indirect_reference = 0;
3359 r->which = Z_External_single;
3361 r->u.single_ASN1_type =
3362 odr_create_Odr_oct(out,
3363 (unsigned char *)illRequest_buf,
3369 static Z_ItemOrder *encode_item_order(ZOOM_package p)
3371 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
3375 req->which = Z_IOItemOrder_esRequest;
3376 req->u.esRequest = (Z_IORequest *)
3377 odr_malloc(p->odr_out,sizeof(Z_IORequest));
3379 /* to keep part ... */
3380 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
3381 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
3382 req->u.esRequest->toKeep->supplDescription = 0;
3383 req->u.esRequest->toKeep->contact = (Z_IOContact *)
3384 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
3386 str = ZOOM_options_get(p->options, "contact-name");
3387 req->u.esRequest->toKeep->contact->name =
3388 odr_strdup_null(p->odr_out, str);
3390 str = ZOOM_options_get(p->options, "contact-phone");
3391 req->u.esRequest->toKeep->contact->phone =
3392 odr_strdup_null(p->odr_out, str);
3394 str = ZOOM_options_get(p->options, "contact-email");
3395 req->u.esRequest->toKeep->contact->email =
3396 odr_strdup_null(p->odr_out, str);
3398 req->u.esRequest->toKeep->addlBilling = 0;
3400 /* not to keep part ... */
3401 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
3402 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3404 str = ZOOM_options_get(p->options, "itemorder-setname");
3409 req->u.esRequest->notToKeep->resultSetItem = 0;
3412 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3413 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3415 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3416 odr_strdup(p->odr_out, str);
3417 req->u.esRequest->notToKeep->resultSetItem->item =
3418 odr_intdup(p->odr_out, 0);
3420 str = ZOOM_options_get(p->options, "itemorder-item");
3421 *req->u.esRequest->notToKeep->resultSetItem->item =
3422 (str ? atoi(str) : 1);
3425 str = ZOOM_options_getl(p->options, "doc", &len);
3428 req->u.esRequest->notToKeep->itemRequest =
3429 z_ext_record_xml(p->odr_out, str, len);
3432 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3437 Z_APDU *create_admin_package(ZOOM_package p, int type,
3438 Z_ESAdminOriginPartToKeep **toKeepP,
3439 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3441 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3444 Z_ESAdminOriginPartToKeep *toKeep;
3445 Z_ESAdminOriginPartNotToKeep *notToKeep;
3446 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3447 const char *first_db = "Default";
3449 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3454 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3456 r->indirect_reference = 0;
3457 r->which = Z_External_ESAdmin;
3459 r->u.adminService = (Z_Admin *)
3460 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3461 r->u.adminService->which = Z_Admin_esRequest;
3462 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3463 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3465 toKeep = r->u.adminService->u.esRequest->toKeep =
3466 (Z_ESAdminOriginPartToKeep *)
3467 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3468 toKeep->which = type;
3469 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3470 toKeep->u.create = odr_nullval();
3471 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3473 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3474 (Z_ESAdminOriginPartNotToKeep *)
3475 odr_malloc(p->odr_out,
3476 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3477 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3478 notToKeep->u.recordsWillFollow = odr_nullval();
3482 *notToKeepP = notToKeep;
3487 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3489 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3490 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3491 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3493 const char *doc = ZOOM_options_getl(p->options, "doc", &len);
3501 req->taskSpecificParameters = ext;
3502 ext->direct_reference = req->packageType;
3503 ext->descriptor = 0;
3504 ext->indirect_reference = 0;
3506 ext->which = Z_External_octet;
3507 ext->u.single_ASN1_type =
3508 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc, len);
3512 static Z_APDU *create_update_package(ZOOM_package p)
3515 const char *first_db = "Default";
3517 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3518 const char *action = ZOOM_options_get(p->options, "action");
3519 int recordIdOpaque_len;
3520 const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
3521 &recordIdOpaque_len);
3522 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3524 const char *record_buf = ZOOM_options_getl(p->options, "record",
3526 int recordOpaque_len;
3527 const char *recordOpaque_buf = ZOOM_options_getl(p->options, "recordOpaque",
3529 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3530 const char *version = ZOOM_options_get(p->options, "updateVersion");
3532 const char *correlationInfo_note =
3533 ZOOM_options_get(p->options, "correlationInfo.note");
3534 const char *correlationInfo_id =
3535 ZOOM_options_get(p->options, "correlationInfo.id");
3537 Odr_oid *syntax_oid = 0;
3538 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
3544 if (!record_buf && !recordOpaque_buf)
3546 record_buf = "void";
3548 syntax_str = "SUTRS";
3553 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3554 CLASS_RECSYN, syntax_str,
3566 package_oid = yaz_oid_extserv_database_update_first_version;
3567 /* old update does not support specialUpdate */
3569 action = "recordInsert";
3573 action = "specialUpdate";
3574 package_oid = yaz_oid_extserv_database_update_second_version;
3578 action = "specialUpdate";
3579 package_oid = yaz_oid_extserv_database_update;
3585 if (!strcmp(action, "recordInsert"))
3586 action_no = Z_IUOriginPartToKeep_recordInsert;
3587 else if (!strcmp(action, "recordReplace"))
3588 action_no = Z_IUOriginPartToKeep_recordReplace;
3589 else if (!strcmp(action, "recordDelete"))
3590 action_no = Z_IUOriginPartToKeep_recordDelete;
3591 else if (!strcmp(action, "elementUpdate"))
3592 action_no = Z_IUOriginPartToKeep_elementUpdate;
3593 else if (!strcmp(action, "specialUpdate"))
3594 action_no = Z_IUOriginPartToKeep_specialUpdate;
3598 apdu = create_es_package(p, package_oid);
3601 Z_IUOriginPartToKeep *toKeep;
3602 Z_IUSuppliedRecords *notToKeep;
3603 Z_External *r = (Z_External *)
3604 odr_malloc(p->odr_out, sizeof(*r));
3605 const char *elementSetName =
3606 ZOOM_options_get(p->options, "elementSetName");
3608 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3610 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
3612 r->which = Z_External_update;
3613 r->indirect_reference = 0;
3614 r->u.update = (Z_IUUpdate *)
3615 odr_malloc(p->odr_out, sizeof(*r->u.update));
3617 r->u.update->which = Z_IUUpdate_esRequest;
3618 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3619 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3620 toKeep = r->u.update->u.esRequest->toKeep =
3621 (Z_IUOriginPartToKeep *)
3622 odr_malloc(p->odr_out, sizeof(*toKeep));
3624 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3627 toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
3629 toKeep->actionQualifier = 0;
3630 toKeep->action = odr_intdup(p->odr_out, action_no);
3632 notToKeep = r->u.update->u.esRequest->notToKeep =
3633 (Z_IUSuppliedRecords *)
3634 odr_malloc(p->odr_out, sizeof(*notToKeep));
3636 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3637 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3638 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3639 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3640 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3643 notToKeep->elements[0]->u.opaque =
3644 odr_create_Odr_oct(p->odr_out,
3645 (const unsigned char *) recordIdOpaque,
3646 recordIdOpaque_len);
3648 else if (recordIdNumber)
3650 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3652 notToKeep->elements[0]->u.number =
3653 odr_intdup(p->odr_out, atoi(recordIdNumber));
3656 notToKeep->elements[0]->u.opaque = 0;
3657 notToKeep->elements[0]->supplementalId = 0;
3658 if (correlationInfo_note || correlationInfo_id)
3660 Z_IUCorrelationInfo *ci;
3661 ci = notToKeep->elements[0]->correlationInfo =
3662 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
3663 ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
3664 ci->id = correlationInfo_id ?
3665 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3668 notToKeep->elements[0]->correlationInfo = 0;
3669 if (recordOpaque_buf)
3671 notToKeep->elements[0]->record =
3672 z_ext_record_oid_any(p->odr_out, syntax_oid,
3673 recordOpaque_buf, recordOpaque_len);
3677 notToKeep->elements[0]->record =
3678 z_ext_record_oid(p->odr_out, syntax_oid,
3679 record_buf, record_len);
3684 ODR print = odr_createmem(ODR_PRINT);
3686 z_APDU(print, &apdu, 0, 0);
3693 ZOOM_package_send(ZOOM_package p, const char *type)
3700 odr_reset(p->odr_out);
3703 if (!strcmp(type, "itemorder"))
3705 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3708 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3710 r->direct_reference =
3711 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3713 r->which = Z_External_itemOrder;
3714 r->indirect_reference = 0;
3715 r->u.itemOrder = encode_item_order(p);
3717 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3720 else if (!strcmp(type, "create")) /* create database */
3722 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3725 else if (!strcmp(type, "drop")) /* drop database */
3727 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3730 else if (!strcmp(type, "commit")) /* commit changes */
3732 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3735 else if (!strcmp(type, "update")) /* update record(s) */
3737 apdu = create_update_package(p);
3739 else if (!strcmp(type, "xmlupdate"))
3741 apdu = create_xmlupdate_package(p);
3745 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3749 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3750 task->u.package = p;
3751 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3752 p->buf_out = (char *) xmalloc(p->len_out);
3753 memcpy(p->buf_out, buf, p->len_out);
3758 while (ZOOM_event(1, &c))
3765 ZOOM_API(ZOOM_package)
3766 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3768 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3771 p->odr_out = odr_createmem(ODR_ENCODE);
3772 p->options = ZOOM_options_create_with_parent2(options, c->options);
3780 ZOOM_package_destroy(ZOOM_package p)
3785 if (p->refcount == 0)
3787 odr_destroy(p->odr_out);
3790 ZOOM_options_destroy(p->options);
3795 ZOOM_API(const char *)
3796 ZOOM_package_option_get(ZOOM_package p, const char *key)
3798 return ZOOM_options_get(p->options, key);
3801 ZOOM_API(const char *)
3802 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
3804 return ZOOM_options_getl(p->options, key, lenp);
3808 ZOOM_package_option_set(ZOOM_package p, const char *key,
3811 ZOOM_options_set(p->options, key, val);
3815 ZOOM_package_option_setl(ZOOM_package p, const char *key,
3816 const char *val, int len)
3818 ZOOM_options_setl(p->options, key, val, len);
3822 ZOOM_connection_exec_task(ZOOM_connection c)
3824 ZOOM_task task = c->tasks;
3825 zoom_ret ret = zoom_complete;
3829 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3830 c, task->which, task->running);
3831 if (c->error != ZOOM_ERROR_NONE)
3833 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3834 "removing tasks because of error = %d", c, c->error);
3835 ZOOM_connection_remove_tasks(c);
3840 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3841 "task already running", c);
3845 ret = zoom_complete;
3846 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3848 switch (task->which)
3850 case ZOOM_TASK_SEARCH:
3851 if (c->proto == PROTO_HTTP)
3852 ret = ZOOM_connection_srw_send_search(c);
3854 ret = ZOOM_connection_send_search(c);
3856 case ZOOM_TASK_RETRIEVE:
3857 if (c->proto == PROTO_HTTP)
3858 ret = ZOOM_connection_srw_send_search(c);
3860 ret = send_present(c);
3862 case ZOOM_TASK_CONNECT:
3863 ret = do_connect(c);
3865 case ZOOM_TASK_SCAN:
3866 if (c->proto == PROTO_HTTP)
3867 ret = ZOOM_connection_srw_send_scan(c);
3869 ret = ZOOM_connection_send_scan(c);
3871 case ZOOM_TASK_PACKAGE:
3872 ret = send_package(c);
3874 case ZOOM_TASK_SORT:
3875 c->tasks->u.sort.resultset->r_sort_spec =
3876 c->tasks->u.sort.q->sort_spec;
3877 ret = send_sort(c, c->tasks->u.sort.resultset);
3883 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3884 "remove tasks because no connection exist", c);
3885 ZOOM_connection_remove_tasks(c);
3887 if (ret == zoom_complete)
3889 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3890 "task removed (complete)", c);
3891 ZOOM_connection_remove_task(c);
3894 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3899 static zoom_ret send_sort_present(ZOOM_connection c)
3901 zoom_ret r = zoom_complete;
3903 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3904 r = send_sort(c, c->tasks->u.search.resultset);
3905 if (r == zoom_complete)
3906 r = send_present(c);
3910 static int es_response_taskpackage_update(ZOOM_connection c,
3911 Z_IUUpdateTaskPackage *utp)
3913 if (utp && utp->targetPart)
3915 Z_IUTargetPart *targetPart = utp->targetPart;
3916 switch ( *targetPart->updateStatus ) {
3917 case Z_IUTargetPart_success:
3918 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
3920 case Z_IUTargetPart_partial:
3921 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
3923 case Z_IUTargetPart_failure:
3924 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
3925 if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
3926 response_diag(c, targetPart->globalDiagnostics[0]);
3929 // NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED.
3934 static int es_response_taskpackage(ZOOM_connection c,
3935 Z_TaskPackage *taskPackage)
3938 Odr_oct *id = taskPackage->targetReference;
3940 ZOOM_options_setl(c->tasks->u.package->options,
3941 "targetReference", (char*) id->buf, id->len);
3944 switch ( *taskPackage->taskStatus ) {
3945 case Z_TaskPackage_pending:
3946 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
3948 case Z_TaskPackage_active:
3949 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
3951 case Z_TaskPackage_complete:
3952 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
3954 case Z_TaskPackage_aborted:
3955 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
3956 if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
3957 response_diag(c, taskPackage->packageDiagnostics[0]);
3961 // taskSpecificParameters
3962 // NOTE: Only Update implemented, no others.
3963 if ( taskPackage->taskSpecificParameters->which == Z_External_update ) {
3964 Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
3965 es_response_taskpackage_update(c, utp);
3971 static int es_response(ZOOM_connection c,
3972 Z_ExtendedServicesResponse *res)
3974 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3976 switch (*res->operationStatus) {
3977 case Z_ExtendedServicesResponse_done:
3978 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
3980 case Z_ExtendedServicesResponse_accepted:
3981 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
3983 case Z_ExtendedServicesResponse_failure:
3984 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
3985 if (res->diagnostics && res->num_diagnostics > 0)
3986 response_diag(c, res->diagnostics[0]);
3989 if (res->taskPackage &&
3990 res->taskPackage->which == Z_External_extendedService)
3992 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3993 es_response_taskpackage(c, taskPackage);
3995 if (res->taskPackage &&
3996 res->taskPackage->which == Z_External_octet)
3998 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3999 ZOOM_options_setl(c->tasks->u.package->options,
4000 "xmlUpdateDoc", (char*) doc->buf, doc->len);
4005 static void interpret_init_diag(ZOOM_connection c,
4006 Z_DiagnosticFormat *diag)
4010 Z_DiagnosticFormat_s *ds = diag->elements[0];
4011 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
4012 response_default_diag(c, ds->u.defaultDiagRec);
4017 static void interpret_otherinformation_field(ZOOM_connection c,
4018 Z_OtherInformation *ui)
4021 for (i = 0; i < ui->num_elements; i++)
4023 Z_OtherInformationUnit *unit = ui->list[i];
4024 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
4025 unit->information.externallyDefinedInfo &&
4026 unit->information.externallyDefinedInfo->which ==
4029 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
4035 static void set_init_option(const char *name, void *clientData) {
4036 ZOOM_connection c = (ZOOM_connection) clientData;
4039 sprintf(buf, "init_opt_%.70s", name);
4040 ZOOM_connection_option_set(c, buf, "1");
4044 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
4046 Z_InitResponse *initrs;
4048 ZOOM_connection_set_mask(c, 0);
4049 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
4052 case Z_APDU_initResponse:
4053 yaz_log(log_api, "%p recv_apdu: Received Init response", c);
4054 initrs = apdu->u.initResponse;
4055 ZOOM_connection_option_set(c, "serverImplementationId",
4056 initrs->implementationId ?
4057 initrs->implementationId : "");
4058 ZOOM_connection_option_set(c, "serverImplementationName",
4059 initrs->implementationName ?
4060 initrs->implementationName : "");
4061 ZOOM_connection_option_set(c, "serverImplementationVersion",
4062 initrs->implementationVersion ?
4063 initrs->implementationVersion : "");
4064 /* Set the three old options too, for old applications */
4065 ZOOM_connection_option_set(c, "targetImplementationId",
4066 initrs->implementationId ?
4067 initrs->implementationId : "");
4068 ZOOM_connection_option_set(c, "targetImplementationName",
4069 initrs->implementationName ?
4070 initrs->implementationName : "");
4071 ZOOM_connection_option_set(c, "targetImplementationVersion",
4072 initrs->implementationVersion ?
4073 initrs->implementationVersion : "");
4075 /* Make initrs->options available as ZOOM-level options */
4076 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
4078 if (!*initrs->result)
4080 Z_External *uif = initrs->userInformationField;
4082 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
4084 if (uif && uif->which == Z_External_userInfo1)
4085 interpret_otherinformation_field(c, uif->u.userInfo1);
4090 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
4091 yaz_oid_userinfo_cookie, 1, 0);
4092 xfree(c->cookie_in);
4095 c->cookie_in = xstrdup(cookie);
4096 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
4097 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
4098 c->support_named_resultsets = 1;
4101 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4102 ZOOM_connection_remove_task(c);
4104 ZOOM_connection_exec_task(c);
4106 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
4108 NMEM tmpmem = nmem_create();
4109 Z_CharSetandLanguageNegotiation *p =
4110 yaz_get_charneg_record(initrs->otherInfo);
4114 char *charset = NULL, *lang = NULL;
4117 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
4118 yaz_log(log_details, "%p recv_apdu target accepted: "
4119 "charset %s, language %s, select %d",
4121 charset ? charset : "none", lang ? lang : "none", sel);
4123 ZOOM_connection_option_set(c, "negotiation-charset",
4126 ZOOM_connection_option_set(c, "negotiation-lang",
4129 ZOOM_connection_option_set(
4130 c, "negotiation-charset-in-effect-for-records",
4131 (sel != 0) ? "1" : "0");
4132 nmem_destroy(tmpmem);
4136 case Z_APDU_searchResponse:
4137 yaz_log(log_api, "%p recv_apdu Search response", c);
4138 handle_search_response(c, apdu->u.searchResponse);
4139 if (send_sort_present(c) == zoom_complete)
4140 ZOOM_connection_remove_task(c);
4142 case Z_APDU_presentResponse:
4143 yaz_log(log_api, "%p recv_apdu Present response", c);
4144 handle_present_response(c, apdu->u.presentResponse);
4145 if (send_present(c) == zoom_complete)
4146 ZOOM_connection_remove_task(c);
4148 case Z_APDU_sortResponse:
4149 yaz_log(log_api, "%p recv_apdu Sort response", c);
4150 sort_response(c, apdu->u.sortResponse);
4151 if (send_present(c) == zoom_complete)
4152 ZOOM_connection_remove_task(c);
4154 case Z_APDU_scanResponse:
4155 yaz_log(log_api, "%p recv_apdu Scan response", c);
4156 scan_response(c, apdu->u.scanResponse);
4157 ZOOM_connection_remove_task(c);
4159 case Z_APDU_extendedServicesResponse:
4160 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
4161 es_response(c, apdu->u.extendedServicesResponse);
4162 ZOOM_connection_remove_task(c);
4165 yaz_log(log_api, "%p recv_apdu Close PDU", c);
4166 if (!ZOOM_test_reconnect(c))
4168 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4173 yaz_log(log_api, "%p Received unknown PDU", c);
4174 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4180 static zoom_ret handle_srw_response(ZOOM_connection c,
4181 Z_SRW_searchRetrieveResponse *res)
4183 ZOOM_resultset resultset = 0;
4188 const char *syntax, *elementSetName;
4191 return zoom_complete;
4193 switch(c->tasks->which)
4195 case ZOOM_TASK_SEARCH:
4196 resultset = c->tasks->u.search.resultset;
4197 start = &c->tasks->u.search.start;
4198 count = &c->tasks->u.search.count;
4199 syntax = c->tasks->u.search.syntax;
4200 elementSetName = c->tasks->u.search.elementSetName;
4202 if (!c->tasks->u.search.recv_search_fired)
4204 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
4205 ZOOM_connection_put_event(c, event);
4206 c->tasks->u.search.recv_search_fired = 1;
4209 case ZOOM_TASK_RETRIEVE:
4210 resultset = c->tasks->u.retrieve.resultset;
4211 start = &c->tasks->u.retrieve.start;
4212 count = &c->tasks->u.retrieve.count;
4213 syntax = c->tasks->u.retrieve.syntax;
4214 elementSetName = c->tasks->u.retrieve.elementSetName;
4217 return zoom_complete;
4220 resultset->size = 0;
4222 if (res->resultSetId)
4223 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
4225 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
4227 if (res->num_diagnostics > 0)
4229 set_SRU_error(c, &res->diagnostics[0]);
4233 if (res->numberOfRecords)
4234 resultset->size = *res->numberOfRecords;
4235 for (i = 0; i<res->num_records; i++)
4238 Z_SRW_record *sru_rec;
4239 Z_SRW_diagnostic *diag = 0;
4242 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
4243 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
4245 if (res->records[i].recordPosition &&
4246 *res->records[i].recordPosition > 0)
4247 pos = *res->records[i].recordPosition - 1;
4251 sru_rec = &res->records[i];
4253 npr->databaseName = 0;
4254 npr->which = Z_NamePlusRecord_databaseRecord;
4255 npr->u.databaseRecord = (Z_External *)
4256 odr_malloc(c->odr_in, sizeof(Z_External));
4257 npr->u.databaseRecord->descriptor = 0;
4258 npr->u.databaseRecord->direct_reference =
4259 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
4260 npr->u.databaseRecord->which = Z_External_octet;
4262 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
4263 odr_malloc(c->odr_in, sizeof(Odr_oct));
4264 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
4265 sru_rec->recordData_buf;
4266 npr->u.databaseRecord->u.octet_aligned->len =
4267 npr->u.databaseRecord->u.octet_aligned->size =
4268 sru_rec->recordData_len;
4270 if (sru_rec->recordSchema
4271 && !strcmp(sru_rec->recordSchema,
4272 "info:srw/schema/1/diagnostics-v1.1"))
4274 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
4275 sru_rec->recordData_len,
4279 record_cache_add(resultset, npr, pos, syntax, elementSetName,
4280 sru_rec->recordSchema, diag);
4284 if (*count + *start > resultset->size)
4285 *count = resultset->size - *start;
4289 nmem = odr_extract_mem(c->odr_in);
4290 nmem_transfer(odr_getmem(resultset->odr), nmem);
4294 return ZOOM_connection_srw_send_search(c);
4296 return zoom_complete;
4301 static void handle_srw_scan_response(ZOOM_connection c,
4302 Z_SRW_scanResponse *res)
4304 NMEM nmem = odr_extract_mem(c->odr_in);
4307 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
4309 scan = c->tasks->u.scan.scan;
4311 if (res->num_diagnostics > 0)
4312 set_SRU_error(c, &res->diagnostics[0]);
4314 scan->scan_response = 0;
4315 scan->srw_scan_response = res;
4316 nmem_transfer(odr_getmem(scan->odr), nmem);
4318 ZOOM_options_set_int(scan->options, "number", res->num_terms);
4324 static Z_GDU *get_HTTP_Request_url(ODR odr, const char *url)
4326 Z_GDU *p = z_get_HTTP_Request(odr);
4327 const char *host = url;
4328 const char *cp0 = strstr(host, "://");
4329 const char *cp1 = 0;
4335 cp1 = strchr(cp0, '/');
4337 cp1 = cp0 + strlen(cp0);
4341 char *h = (char*) odr_malloc(odr, cp1 - cp0 + 1);
4342 memcpy (h, cp0, cp1 - cp0);
4344 z_HTTP_header_add(odr, &p->u.HTTP_Request->headers, "Host", h);
4346 p->u.HTTP_Request->path = odr_strdup(odr, *cp1 ? cp1 : "/");
4350 static zoom_ret send_SRW_redirect(ZOOM_connection c, const char *uri,
4351 Z_HTTP_Response *cookie_hres)
4353 struct Z_HTTP_Header *h;
4354 Z_GDU *gdu = get_HTTP_Request_url(c->odr_out, uri);
4355 char *combined_cookies;
4356 int combined_cookies_len = 0;
4358 gdu->u.HTTP_Request->method = odr_strdup(c->odr_out, "GET");
4359 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers, "Accept",
4362 for (h = cookie_hres->headers; h; h = h->next)
4364 if (!strcmp(h->name, "Set-Cookie"))
4368 if (!(cp = strchr(h->value, ';')))
4369 cp = h->value + strlen(h->value);
4370 if (cp - h->value >= 1) {
4371 combined_cookies = xrealloc(combined_cookies, combined_cookies_len + cp - h->value + 3);
4372 memcpy(combined_cookies+combined_cookies_len, h->value, cp - h->value);
4373 combined_cookies[combined_cookies_len + cp - h->value] = '\0';
4374 strcat(combined_cookies,"; ");
4375 combined_cookies_len = strlen(combined_cookies);
4380 if (combined_cookies_len)
4382 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
4383 "Cookie", combined_cookies);
4384 xfree(combined_cookies);
4387 if (c->user && c->password)
4389 z_HTTP_header_add_basic_auth(c->odr_out, &gdu->u.HTTP_Request->headers,
4390 c->user, c->password);
4392 if (!z_GDU(c->odr_out, &gdu, 0, 0))
4393 return zoom_complete;
4395 z_GDU(c->odr_print, &gdu, 0, 0);
4396 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
4398 odr_reset(c->odr_out);
4402 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
4404 zoom_ret cret = zoom_complete;
4406 const char *addinfo = 0;
4407 const char *connection_head = z_HTTP_header_lookup(hres->headers,
4409 const char *location;
4411 ZOOM_connection_set_mask(c, 0);
4412 yaz_log(log_details, "%p handle_http", c);
4414 if ((hres->code == 301 || hres->code == 302) && c->sru_mode == zoom_sru_get
4415 && (location = z_HTTP_header_lookup(hres->headers, "Location")))
4418 if (c->no_redirects > 10)
4420 set_HTTP_error(c, hres->code, 0, 0);
4421 c->no_redirects = 0;
4426 /* since redirect may change host we just reconnect. A smarter
4427 implementation might check whether it's the same server */
4428 do_connect_host(c, location, 0);
4429 send_SRW_redirect(c, location, hres);
4430 /* we're OK for now. Operation is not really complete */
4432 cret = zoom_pending;
4436 { /* not redirect (normal response) */
4437 if (!yaz_srw_check_content_type(hres))
4438 addinfo = "content-type";
4441 Z_SOAP *soap_package = 0;
4443 Z_SOAP_Handler soap_handlers[2] = {
4444 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
4447 ret = z_soap_codec(o, &soap_package,
4448 &hres->content_buf, &hres->content_len,
4450 if (!ret && soap_package->which == Z_SOAP_generic &&
4451 soap_package->u.generic->no == 0)
4453 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
4455 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
4456 ZOOM_options_setl(c->options, "sru_extra_response_data",
4457 sr->extraResponseData_buf, sr->extraResponseData_len);
4458 if (sr->which == Z_SRW_searchRetrieve_response)
4459 cret = handle_srw_response(c, sr->u.response);
4460 else if (sr->which == Z_SRW_scan_response)
4461 handle_srw_scan_response(c, sr->u.scan_response);
4465 else if (!ret && (soap_package->which == Z_SOAP_fault
4466 || soap_package->which == Z_SOAP_error))
4468 set_HTTP_error(c, hres->code,
4469 soap_package->u.fault->fault_code,
4470 soap_package->u.fault->fault_string);
4477 if (c->no_redirects) /* end of redirect. change hosts again */
4480 c->no_redirects = 0;
4484 if (hres->code != 200)
4485 set_HTTP_error(c, hres->code, 0, 0);
4487 set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
4490 if (cret == zoom_complete)
4492 yaz_log(YLOG_LOG, "removing tasks in handle_http");
4493 ZOOM_connection_remove_task(c);
4497 if (!strcmp(hres->version, "1.0"))
4499 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
4500 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
4505 /* HTTP 1.1: only if no close we stay alive.. */
4506 if (connection_head && !strcmp(connection_head, "close"))
4514 c->tasks->running = 0;
4515 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
4516 c->reconnect_ok = 0;
4523 static int do_read(ZOOM_connection c)
4528 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
4529 ZOOM_connection_put_event(c, event);
4531 r = cs_get(c->cs, &c->buf_in, &c->len_in);
4532 more = cs_more(c->cs);
4533 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
4538 if (!ZOOM_test_reconnect(c))
4540 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4549 odr_reset(c->odr_in);
4550 odr_setbuf(c->odr_in, c->buf_in, r, 0);
4551 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
4552 ZOOM_connection_put_event(c, event);
4554 if (!z_GDU(c->odr_in, &gdu, 0, 0))
4557 int err = odr_geterrorx(c->odr_in, &x);
4559 const char *element = odr_getelement(c->odr_in);
4560 yaz_snprintf(msg, sizeof(msg),
4561 "ODR code %d:%d element=%s offset=%d",
4562 err, x, element ? element : "<unknown>",
4563 odr_offset(c->odr_in));
4564 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
4567 FILE *ber_file = yaz_log_file();
4569 odr_dumpBER(ber_file, c->buf_in, r);
4576 z_GDU(c->odr_print, &gdu, 0, 0);
4577 if (gdu->which == Z_GDU_Z3950)
4578 recv_apdu(c, gdu->u.z3950);
4579 else if (gdu->which == Z_GDU_HTTP_Response)
4582 handle_http(c, gdu->u.HTTP_Response);
4584 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4589 c->reconnect_ok = 0;
4594 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
4599 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
4600 ZOOM_connection_put_event(c, event);
4602 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
4603 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
4605 yaz_log(log_details, "%p do_write_ex write failed", c);
4606 if (ZOOM_test_reconnect(c))
4608 return zoom_pending;
4610 if (c->state == STATE_CONNECTING)
4611 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4613 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4615 return zoom_complete;
4619 int mask = ZOOM_SELECT_EXCEPT;
4620 if (c->cs->io_pending & CS_WANT_WRITE)
4621 mask += ZOOM_SELECT_WRITE;
4622 if (c->cs->io_pending & CS_WANT_READ)
4623 mask += ZOOM_SELECT_READ;
4624 ZOOM_connection_set_mask(c, mask);
4625 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
4630 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
4631 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
4634 return zoom_pending;
4637 static zoom_ret do_write(ZOOM_connection c)
4639 return do_write_ex(c, c->buf_out, c->len_out);
4643 ZOOM_API(const char *)
4644 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
4646 return ZOOM_options_get(c->options, key);
4649 ZOOM_API(const char *)
4650 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
4652 return ZOOM_options_getl(c->options, key, lenp);
4656 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
4659 ZOOM_options_set(c->options, key, val);
4663 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
4664 const char *val, int len)
4666 ZOOM_options_setl(c->options, key, val, len);
4669 ZOOM_API(const char *)
4670 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
4672 return ZOOM_options_get(r->options, key);
4676 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
4679 ZOOM_options_set(r->options, key, val);
4684 ZOOM_connection_errcode(ZOOM_connection c)
4686 return ZOOM_connection_error(c, 0, 0);
4689 ZOOM_API(const char *)
4690 ZOOM_connection_errmsg(ZOOM_connection c)
4693 ZOOM_connection_error(c, &msg, 0);
4697 ZOOM_API(const char *)
4698 ZOOM_connection_addinfo(ZOOM_connection c)
4700 const char *addinfo;
4701 ZOOM_connection_error(c, 0, &addinfo);
4705 ZOOM_API(const char *)
4706 ZOOM_connection_diagset(ZOOM_connection c)
4708 const char *diagset;
4709 ZOOM_connection_error_x(c, 0, 0, &diagset);
4713 ZOOM_API(const char *)
4714 ZOOM_diag_str(int error)
4718 case ZOOM_ERROR_NONE:
4720 case ZOOM_ERROR_CONNECT:
4721 return "Connect failed";
4722 case ZOOM_ERROR_MEMORY:
4723 return "Out of memory";
4724 case ZOOM_ERROR_ENCODE:
4725 return "Encoding failed";
4726 case ZOOM_ERROR_DECODE:
4727 return "Decoding failed";
4728 case ZOOM_ERROR_CONNECTION_LOST:
4729 return "Connection lost";
4730 case ZOOM_ERROR_INIT:
4731 return "Init rejected";
4732 case ZOOM_ERROR_INTERNAL:
4733 return "Internal failure";
4734 case ZOOM_ERROR_TIMEOUT:
4736 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4737 return "Unsupported protocol";
4738 case ZOOM_ERROR_UNSUPPORTED_QUERY:
4739 return "Unsupported query type";
4740 case ZOOM_ERROR_INVALID_QUERY:
4741 return "Invalid query";
4742 case ZOOM_ERROR_CQL_PARSE:
4743 return "CQL parsing error";
4744 case ZOOM_ERROR_CQL_TRANSFORM:
4745 return "CQL transformation error";
4746 case ZOOM_ERROR_CCL_CONFIG:
4747 return "CCL configuration error";
4748 case ZOOM_ERROR_CCL_PARSE:
4749 return "CCL parsing error";
4751 return diagbib1_str(error);
4756 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4757 const char **addinfo, const char **diagset)
4759 int error = c->error;
4762 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4763 *cp = ZOOM_diag_str(error);
4764 else if (!strcmp(c->diagset, "HTTP"))
4765 *cp = z_HTTP_errmsg(c->error);
4766 else if (!strcmp(c->diagset, "Bib-1"))
4767 *cp = ZOOM_diag_str(error);
4768 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4769 *cp = yaz_diag_srw_str(c->error);
4771 *cp = "Unknown error and diagnostic set";
4774 *addinfo = c->addinfo ? c->addinfo : "";
4776 *diagset = c->diagset ? c->diagset : "";
4781 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4782 const char **addinfo)
4784 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4787 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4789 ZOOM_Event event = 0;
4790 int r = cs_look(c->cs);
4791 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4796 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4797 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4799 ZOOM_connection_put_event(c, event);
4801 else if (r == CS_CONNECT)
4803 int ret = ret = cs_rcvconnect(c->cs);
4804 yaz_log(log_details, "%p ZOOM_connection_do_io "
4805 "cs_rcvconnect returned %d", c, ret);
4808 int mask = ZOOM_SELECT_EXCEPT;
4809 if (c->cs->io_pending & CS_WANT_WRITE)
4810 mask += ZOOM_SELECT_WRITE;
4811 if (c->cs->io_pending & CS_WANT_READ)
4812 mask += ZOOM_SELECT_READ;
4813 ZOOM_connection_set_mask(c, mask);
4814 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
4815 ZOOM_connection_put_event(c, event);
4819 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4820 ZOOM_connection_put_event(c, event);
4822 if (c->proto == PROTO_Z3950)
4823 ZOOM_connection_send_init(c);
4826 /* no init request for SRW .. */
4827 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4828 ZOOM_connection_remove_task(c);
4829 ZOOM_connection_set_mask(c, 0);
4830 ZOOM_connection_exec_task(c);
4832 c->state = STATE_ESTABLISHED;
4836 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4842 if (mask & ZOOM_SELECT_EXCEPT)
4844 if (!ZOOM_test_reconnect(c))
4846 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4851 if (mask & ZOOM_SELECT_READ)
4853 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4859 ZOOM_connection_last_event(ZOOM_connection cs)
4862 return ZOOM_EVENT_NONE;
4863 return cs->last_event;
4867 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4869 WRBUF wrbuf = (WRBUF) client_data;
4870 wrbuf_puts(wrbuf, buf);
4874 * Returns an xmalloc()d string containing RPN that corresponds to the
4875 * CQL passed in. On error, sets the Connection object's error state
4876 * and returns a null pointer.
4877 * ### We could cache CQL parser and/or transformer in Connection.
4879 static char *cql2pqf(ZOOM_connection c, const char *cql)
4883 const char *cqlfile;
4884 cql_transform_t trans;
4887 parser = cql_parser_create();
4888 if ((error = cql_parser_string(parser, cql)) != 0) {
4889 cql_parser_destroy(parser);
4890 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4894 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4897 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4899 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4902 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4903 cqlfile, strerror(errno));
4904 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4908 WRBUF wrbuf_result = wrbuf_alloc();
4909 error = cql_transform(trans, cql_parser_result(parser),
4910 cql2pqf_wrbuf_puts, wrbuf_result);
4913 const char *addinfo;
4914 error = cql_transform_error(trans, &addinfo);
4915 sprintf(buf, "%.200s (addinfo=%.200s)",
4916 cql_strerror(error), addinfo);
4917 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4921 result = xstrdup(wrbuf_cstr(wrbuf_result));
4923 cql_transform_close(trans);
4924 wrbuf_destroy(wrbuf_result);
4926 cql_parser_destroy(parser);
4930 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4934 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4935 /* timeout and this connection was waiting */
4936 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4938 ZOOM_connection_put_event(c, event);
4944 ZOOM_connection_process(ZOOM_connection c)
4950 event = ZOOM_connection_get_event(c);
4953 ZOOM_Event_destroy(event);
4956 ZOOM_connection_exec_task(c);
4957 event = ZOOM_connection_get_event(c);
4960 ZOOM_Event_destroy(event);
4967 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4971 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4973 for (i = 0; i<no; i++)
4975 ZOOM_connection c = cs[i];
4977 if (c && ZOOM_connection_process(c))
4983 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4985 if (c->mask && mask)
4986 ZOOM_connection_do_io(c, mask);
4990 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4993 return cs_fileno(c->cs);
4997 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
5005 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
5012 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
5014 return ZOOM_options_get_int(c->options, "timeout", 30);
5017 ZOOM_API(void) ZOOM_connection_close(ZOOM_connection c)
5025 * c-file-style: "Stroustrup"
5026 * indent-tabs-mode: nil
5028 * vim: shiftwidth=4 tabstop=8 expandtab