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;
1265 ZOOM_API(ZOOM_facet_field)
1266 ZOOM_resultset_get_facet_field(ZOOM_resultset r, const char *name) {
1267 int num = r->num_facets;
1268 ZOOM_facet_field *facets = r->facets;
1270 for (index = 0; index < num; index++) {
1271 if (!strcmp(facets[index]->facet_name, name)) {
1272 return facets[index];
1279 ZOOM_API(ZOOM_facet_field *)
1280 ZOOM_resultset_facets(ZOOM_resultset r)
1285 ZOOM_API(const char**)
1286 ZOOM_resultset_facet_names(ZOOM_resultset r)
1288 return (const char **) r->facets_names;
1291 ZOOM_API(const char*)
1292 ZOOM_facet_field_name(ZOOM_facet_field field)
1294 return field->facet_name;
1298 ZOOM_facet_field_term_count(ZOOM_facet_field field)
1300 return field->num_terms;
1303 ZOOM_API(const char*)
1304 ZOOM_facet_field_get_term(ZOOM_facet_field field, size_t idx, int *freq) {
1305 *freq = field->facet_terms[idx].frequency;
1306 return field->facet_terms[idx].term;
1310 static void get_cert(ZOOM_connection c)
1315 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1317 ZOOM_connection_option_setl(c, "sslPeerCert",
1318 cert_buf, cert_len);
1323 static zoom_ret do_connect_host(ZOOM_connection c,
1324 const char *effective_host,
1325 const char *logical_url);
1327 static zoom_ret do_connect(ZOOM_connection c)
1329 const char *effective_host;
1332 effective_host = c->proxy;
1334 effective_host = c->host_port;
1335 return do_connect_host(c, effective_host, c->host_port);
1338 static zoom_ret do_connect_host(ZOOM_connection c, const char *effective_host,
1339 const char *logical_url)
1343 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1347 c->cs = cs_create_host(effective_host, 0, &add);
1349 if (c->cs && c->cs->protocol == PROTO_HTTP)
1356 c->proto = PROTO_HTTP;
1357 cs_get_host_args(logical_url, &db);
1360 c->path = xmalloc(strlen(db) * 3 + 2);
1361 yaz_encode_sru_dbpath_buf(c->path, db);
1364 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1366 return zoom_complete;
1371 int ret = cs_connect(c->cs, add);
1374 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1375 ZOOM_connection_put_event(c, event);
1377 if (c->proto == PROTO_Z3950)
1378 ZOOM_connection_send_init(c);
1381 /* no init request for SRW .. */
1382 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1383 ZOOM_connection_remove_task(c);
1384 ZOOM_connection_set_mask(c, 0);
1385 ZOOM_connection_exec_task(c);
1387 c->state = STATE_ESTABLISHED;
1388 return zoom_pending;
1392 int mask = ZOOM_SELECT_EXCEPT;
1393 if (c->cs->io_pending & CS_WANT_WRITE)
1394 mask += ZOOM_SELECT_WRITE;
1395 if (c->cs->io_pending & CS_WANT_READ)
1396 mask += ZOOM_SELECT_READ;
1397 ZOOM_connection_set_mask(c, mask);
1398 c->state = STATE_CONNECTING;
1399 return zoom_pending;
1402 c->state = STATE_IDLE;
1403 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, logical_url);
1404 return zoom_complete;
1407 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1410 for (i = 0; i<200; i++)
1414 Z_OtherInformation **oi;
1419 sprintf(buf, "otherInfo%d", i);
1420 val = ZOOM_options_get(c->options, buf);
1423 cp = strchr(val, ':');
1427 if (len >= sizeof(buf))
1428 len = sizeof(buf)-1;
1429 memcpy(buf, val, len);
1432 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
1437 yaz_oi_APDU(a, &oi);
1438 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
1442 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1447 Z_OtherInformation **oi;
1448 yaz_oi_APDU(a, &oi);
1449 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
1454 Z_OtherInformation **oi;
1455 yaz_oi_APDU(a, &oi);
1456 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
1459 otherInfo_attach(c, a, out);
1460 if (!z_APDU(out, &a, 0, 0))
1462 FILE *outf = fopen("/tmp/apdu.txt", "a");
1465 ODR odr_pr = odr_createmem(ODR_PRINT);
1466 fprintf(outf, "a=%p\n", a);
1467 odr_setprint(odr_pr, outf);
1468 z_APDU(odr_pr, &a, 0, 0);
1469 odr_destroy(odr_pr);
1471 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1472 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1477 z_APDU(c->odr_print, &a, 0, 0);
1478 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1482 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1486 if (encode_APDU(c, a, c->odr_out))
1487 return zoom_complete;
1488 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1489 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1490 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1491 ZOOM_connection_put_event(c, event);
1492 odr_reset(c->odr_out);
1496 /* returns 1 if PDU was sent OK (still pending )
1497 0 if PDU was not sent OK (nothing to wait for)
1500 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1502 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1503 Z_InitRequest *ireq = apdu->u.initRequest;
1504 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1505 odr_malloc(c->odr_out, sizeof(*auth));
1507 ODR_MASK_SET(ireq->options, Z_Options_search);
1508 ODR_MASK_SET(ireq->options, Z_Options_present);
1509 ODR_MASK_SET(ireq->options, Z_Options_scan);
1510 ODR_MASK_SET(ireq->options, Z_Options_sort);
1511 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1512 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1514 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1515 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1516 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1518 ireq->implementationId =
1519 odr_prepend(c->odr_out,
1520 ZOOM_options_get(c->options, "implementationId"),
1521 ireq->implementationId);
1523 ireq->implementationName =
1524 odr_prepend(c->odr_out,
1525 ZOOM_options_get(c->options, "implementationName"),
1526 odr_prepend(c->odr_out, "ZOOM-C",
1527 ireq->implementationName));
1529 ireq->implementationVersion =
1530 odr_prepend(c->odr_out,
1531 ZOOM_options_get(c->options, "implementationVersion"),
1532 ireq->implementationVersion);
1534 *ireq->maximumRecordSize = c->maximum_record_size;
1535 *ireq->preferredMessageSize = c->preferred_message_size;
1537 if (c->group || c->password)
1539 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1540 pass->groupId = odr_strdup_null(c->odr_out, c->group);
1541 pass->userId = odr_strdup_null(c->odr_out, c->user);
1542 pass->password = odr_strdup_null(c->odr_out, c->password);
1543 auth->which = Z_IdAuthentication_idPass;
1544 auth->u.idPass = pass;
1545 ireq->idAuthentication = auth;
1549 auth->which = Z_IdAuthentication_open;
1550 auth->u.open = odr_strdup(c->odr_out, c->user);
1551 ireq->idAuthentication = auth;
1555 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
1556 yaz_oid_userinfo_proxy, 1, c->host_port);
1558 if (c->charset || c->lang)
1560 Z_OtherInformation **oi;
1561 Z_OtherInformationUnit *oi_unit;
1563 yaz_oi_APDU(apdu, &oi);
1565 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1567 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1568 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1569 oi_unit->information.externallyDefinedInfo =
1570 yaz_set_proposal_charneg_list(c->odr_out, " ",
1571 c->charset, c->lang, 1);
1575 return send_APDU(c, apdu);
1579 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1583 const char *database = ZOOM_options_get(c->options, "databaseName");
1584 char *fdatabase = 0;
1587 fdatabase = yaz_encode_sru_dbpath_odr(c->odr_out, database);
1588 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port,
1589 fdatabase ? fdatabase : c->path);
1591 if (c->sru_mode == zoom_sru_get)
1593 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1595 else if (c->sru_mode == zoom_sru_post)
1597 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1599 else if (c->sru_mode == zoom_sru_soap)
1601 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1603 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1604 return zoom_complete;
1606 z_GDU(c->odr_print, &gdu, 0, 0);
1607 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1609 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1610 ZOOM_connection_put_event(c, event);
1611 odr_reset(c->odr_out);
1617 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type)
1619 Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
1620 sr->username = c->user;
1621 sr->password = c->password;
1627 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1631 ZOOM_resultset resultset = 0;
1633 const char *option_val = 0;
1635 if (c->error) /* don't continue on error */
1636 return zoom_complete;
1638 switch(c->tasks->which)
1640 case ZOOM_TASK_SEARCH:
1641 resultset = c->tasks->u.search.resultset;
1642 if (!resultset->setname)
1643 resultset->setname = xstrdup("default");
1644 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1645 start = &c->tasks->u.search.start;
1646 count = &c->tasks->u.search.count;
1648 case ZOOM_TASK_RETRIEVE:
1649 resultset = c->tasks->u.retrieve.resultset;
1651 start = &c->tasks->u.retrieve.start;
1652 count = &c->tasks->u.retrieve.count;
1654 if (*start >= resultset->size)
1655 return zoom_complete;
1656 if (*start + *count > resultset->size)
1657 *count = resultset->size - *start;
1659 for (i = 0; i < *count; i++)
1662 record_cache_lookup(resultset, i + *start,
1663 c->tasks->u.retrieve.syntax,
1664 c->tasks->u.retrieve.elementSetName);
1669 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1670 ZOOM_connection_put_event(c, event);
1677 return zoom_complete;
1680 return zoom_complete;
1682 assert(resultset->query);
1684 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
1685 if (resultset->query->z_query->which == Z_Query_type_104
1686 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1688 sr->u.request->query_type = Z_SRW_query_type_cql;
1689 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1691 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1692 resultset->query->z_query->u.type_1)
1694 sr->u.request->query_type = Z_SRW_query_type_pqf;
1695 sr->u.request->query.pqf = resultset->query->query_string;
1699 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1700 return zoom_complete;
1702 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1703 sr->u.request->maximumRecords = odr_intdup(
1704 c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
1705 resultset->step : *count);
1706 sr->u.request->recordSchema = resultset->schema;
1708 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1710 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1712 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1713 yaz_encode_sru_extra(sr, c->odr_out, option_val);
1714 return send_srw(c, sr);
1717 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1719 return zoom_complete;
1723 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1726 int lslb, ssub, mspn;
1728 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1729 Z_SearchRequest *search_req = apdu->u.searchRequest;
1730 const char *elementSetName;
1731 const char *smallSetElementSetName;
1732 const char *mediumSetElementSetName;
1736 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1738 r = c->tasks->u.search.resultset;
1740 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1743 ZOOM_options_get(r->options, "elementSetName");
1744 smallSetElementSetName =
1745 ZOOM_options_get(r->options, "smallSetElementSetName");
1746 mediumSetElementSetName =
1747 ZOOM_options_get(r->options, "mediumSetElementSetName");
1749 if (!smallSetElementSetName)
1750 smallSetElementSetName = elementSetName;
1752 if (!mediumSetElementSetName)
1753 mediumSetElementSetName = elementSetName;
1755 facets = ZOOM_options_get(r->options, "facets");
1757 Z_FacetList *facet_list = yaz_pqf_parse_facet_list(c->odr_out, facets);
1759 Z_OtherInformation **oi;
1760 yaz_oi_APDU(apdu, &oi);
1762 yaz_oi_set_facetlist_oid(oi, c->odr_out, yaz_oid_userinfo_facet_1, 1, facet_list);
1770 /* prepare query for the search request */
1771 search_req->query = r->query->z_query;
1772 if (!search_req->query)
1774 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1775 return zoom_complete;
1777 if (r->query->z_query->which == Z_Query_type_1 ||
1778 r->query->z_query->which == Z_Query_type_101)
1780 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
1783 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
1787 search_req->query = yaz_copy_Z_Query(search_req->query,
1790 r = yaz_query_charset_convert_rpnquery_check(
1791 search_req->query->u.type_1,
1793 yaz_iconv_close(cd);
1795 { /* query could not be char converted */
1796 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1797 return zoom_complete;
1802 search_req->databaseNames = r->databaseNames;
1803 search_req->num_databaseNames = r->num_databaseNames;
1805 /* get syntax (no need to provide unless piggyback is in effect) */
1806 syntax = c->tasks->u.search.syntax;
1808 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1809 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1810 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1811 if (lslb != -1 && ssub != -1 && mspn != -1)
1813 /* So're a Z39.50 expert? Let's hope you don't do sort */
1814 *search_req->largeSetLowerBound = lslb;
1815 *search_req->smallSetUpperBound = ssub;
1816 *search_req->mediumSetPresentNumber = mspn;
1818 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1819 && r->piggyback && !r->r_sort_spec && !r->schema)
1821 /* Regular piggyback - do it unless we're going to do sort */
1822 *search_req->largeSetLowerBound = 2000000000;
1823 *search_req->smallSetUpperBound = 1;
1824 *search_req->mediumSetPresentNumber =
1825 r->step>0 ? r->step : c->tasks->u.search.count;
1829 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1830 smallSetElementSetName = 0;
1831 mediumSetElementSetName = 0;
1834 if (smallSetElementSetName && *smallSetElementSetName)
1836 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1837 odr_malloc(c->odr_out, sizeof(*esn));
1839 esn->which = Z_ElementSetNames_generic;
1840 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1841 search_req->smallSetElementSetNames = esn;
1843 if (mediumSetElementSetName && *mediumSetElementSetName)
1845 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1846 odr_malloc(c->odr_out, sizeof(*esn));
1848 esn->which = Z_ElementSetNames_generic;
1849 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1850 search_req->mediumSetElementSetNames = esn;
1853 search_req->preferredRecordSyntax =
1854 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1858 if (c->support_named_resultsets)
1862 /* find the lowest unused ordinal so that we re-use
1863 result sets on the server. */
1864 for (ord = 1; ; ord++)
1866 #if ZOOM_RESULT_LISTS
1867 ZOOM_resultsets rsp;
1868 sprintf(setname, "%d", ord);
1869 for (rsp = c->resultsets; rsp; rsp = rsp->next)
1870 if (rsp->resultset->setname && !strcmp(rsp->resultset->setname, setname))
1876 sprintf(setname, "%d", ord);
1877 for (rp = c->resultsets; rp; rp = rp->next)
1878 if (rp->setname && !strcmp(rp->setname, setname))
1885 r->setname = xstrdup(setname);
1886 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1887 "set %s", c, r->setname);
1891 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1893 r->setname = xstrdup("default");
1895 ZOOM_options_set(r->options, "setname", r->setname);
1897 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1898 return send_APDU(c, apdu);
1901 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1903 char oid_name_buf[OID_STR_MAX];
1904 const char *oid_name;
1907 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
1910 case Z_DefaultDiagFormat_v2Addinfo:
1911 addinfo = r->u.v2Addinfo;
1913 case Z_DefaultDiagFormat_v3Addinfo:
1914 addinfo = r->u.v3Addinfo;
1919 set_dset_error(c, *r->condition, oid_name, addinfo, 0);
1922 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1924 if (p->which != Z_DiagRec_defaultFormat)
1925 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1927 response_default_diag(c, p->u.defaultFormat);
1930 ZOOM_API(ZOOM_record)
1931 ZOOM_record_clone(ZOOM_record srec)
1938 odr_enc = odr_createmem(ODR_ENCODE);
1939 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1941 buf = odr_getbuf(odr_enc, &size, 0);
1943 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1944 yaz_log(log_details, "ZOOM_record create");
1945 nrec->odr = odr_createmem(ODR_DECODE);
1947 nrec->record_wrbuf = 0;
1951 odr_setbuf(nrec->odr, buf, size, 0);
1952 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1954 nrec->schema = odr_strdup_null(nrec->odr, srec->schema);
1955 nrec->diag_uri = odr_strdup_null(nrec->odr, srec->diag_uri);
1956 nrec->diag_message = odr_strdup_null(nrec->odr, srec->diag_message);
1957 nrec->diag_details = odr_strdup_null(nrec->odr, srec->diag_details);
1958 nrec->diag_set = odr_strdup_null(nrec->odr, srec->diag_set);
1959 odr_destroy(odr_enc);
1963 ZOOM_API(ZOOM_record)
1964 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1966 const char *syntax =
1967 ZOOM_options_get(s->options, "preferredRecordSyntax");
1968 const char *elementSetName =
1969 ZOOM_options_get(s->options, "elementSetName");
1971 return record_cache_lookup(s, pos, syntax, elementSetName);
1974 ZOOM_API(ZOOM_record)
1975 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1977 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1982 * MIKE: I think force_sync should always be zero, but I don't
1983 * want to make this change until I get the go-ahead from
1984 * Adam, in case something depends on the old synchronous
1988 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1989 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1990 rec = ZOOM_resultset_record_immediate(r, pos);
1996 ZOOM_record_destroy(ZOOM_record rec)
1998 ZOOM_record_release(rec);
1999 yaz_log(log_details, "ZOOM_record destroy");
2004 static yaz_iconv_t iconv_create_charset(const char *record_charset)
2011 strcpy(to, "UTF-8");
2012 if (record_charset && *record_charset)
2014 /* Use "from,to" or just "from" */
2015 const char *cp = strchr(record_charset, ',');
2016 size_t clen = strlen(record_charset);
2019 strncpy( to, cp+1, sizeof(to)-1);
2020 to[sizeof(to)-1] = '\0';
2021 clen = cp - record_charset;
2023 if (clen > sizeof(from)-1)
2024 clen = sizeof(from)-1;
2027 strncpy(from, record_charset, clen);
2031 cd = yaz_iconv_open(to, from);
2035 static const char *return_marc_record(WRBUF wrbuf,
2038 const char *buf, int sz,
2039 const char *record_charset)
2041 yaz_iconv_t cd = iconv_create_charset(record_charset);
2042 yaz_marc_t mt = yaz_marc_create();
2043 const char *ret_string = 0;
2046 yaz_marc_iconv(mt, cd);
2047 yaz_marc_xml(mt, marc_type);
2048 if (yaz_marc_decode_wrbuf(mt, buf, sz, wrbuf) > 0)
2051 *len = wrbuf_len(wrbuf);
2052 ret_string = wrbuf_cstr(wrbuf);
2054 yaz_marc_destroy(mt);
2056 yaz_iconv_close(cd);
2060 static const char *return_opac_record(WRBUF wrbuf,
2063 Z_OPACRecord *opac_rec,
2064 const char *record_charset)
2066 yaz_iconv_t cd = iconv_create_charset(record_charset);
2067 yaz_marc_t mt = yaz_marc_create();
2070 yaz_marc_iconv(mt, cd);
2071 yaz_marc_xml(mt, marc_type);
2073 yaz_opac_decode_wrbuf(mt, opac_rec, wrbuf);
2074 yaz_marc_destroy(mt);
2077 yaz_iconv_close(cd);
2079 *len = wrbuf_len(wrbuf);
2080 return wrbuf_cstr(wrbuf);
2083 static const char *return_string_record(WRBUF wrbuf,
2085 const char *buf, int sz,
2086 const char *record_charset)
2088 yaz_iconv_t cd = iconv_create_charset(record_charset);
2092 wrbuf_iconv_write(wrbuf, cd, buf, sz);
2093 wrbuf_iconv_reset(wrbuf, cd);
2095 buf = wrbuf_cstr(wrbuf);
2096 sz = wrbuf_len(wrbuf);
2097 yaz_iconv_close(cd);
2104 static const char *return_record_wrbuf(WRBUF wrbuf, int *len,
2105 Z_NamePlusRecord *npr,
2106 int marctype, const char *charset)
2108 Z_External *r = (Z_External *) npr->u.databaseRecord;
2109 const Odr_oid *oid = r->direct_reference;
2111 wrbuf_rewind(wrbuf);
2112 /* render bibliographic record .. */
2113 if (r->which == Z_External_OPAC)
2115 return return_opac_record(wrbuf, marctype, len,
2116 r->u.opac, charset);
2118 if (r->which == Z_External_sutrs)
2119 return return_string_record(wrbuf, len,
2120 (char*) r->u.sutrs->buf,
2123 else if (r->which == Z_External_octet)
2125 if (yaz_oid_is_iso2709(oid))
2127 const char *ret_buf = return_marc_record(
2128 wrbuf, marctype, len,
2129 (const char *) r->u.octet_aligned->buf,
2130 r->u.octet_aligned->len,
2134 /* bad ISO2709. Return fail unless raw (ISO2709) is wanted */
2135 if (marctype != YAZ_MARC_ISO2709)
2138 return return_string_record(wrbuf, len,
2139 (const char *) r->u.octet_aligned->buf,
2140 r->u.octet_aligned->len,
2143 else if (r->which == Z_External_grs1)
2145 yaz_display_grs1(wrbuf, r->u.grs1, 0);
2146 return return_string_record(wrbuf, len,
2155 ZOOM_record_error(ZOOM_record rec, const char **cp,
2156 const char **addinfo, const char **diagset)
2158 Z_NamePlusRecord *npr;
2167 *cp = rec->diag_message;
2169 *addinfo = rec->diag_details;
2171 *diagset = rec->diag_set;
2172 return uri_to_code(rec->diag_uri);
2174 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
2176 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
2177 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
2178 const char *add = 0;
2180 if (diag_rec->which == Z_DiagRec_defaultFormat)
2182 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
2185 error = *ddf->condition;
2188 case Z_DefaultDiagFormat_v2Addinfo:
2189 add = ddf->u.v2Addinfo;
2191 case Z_DefaultDiagFormat_v3Addinfo:
2192 add = ddf->u.v3Addinfo;
2197 yaz_oid_to_string(yaz_oid_std(),
2198 ddf->diagnosticSetId, &oclass);
2206 *addinfo = add ? add : "";
2208 *cp = diagbib1_str(error);
2214 static const char *get_record_format(WRBUF wrbuf, int *len,
2215 Z_NamePlusRecord *npr,
2216 int marctype, const char *charset,
2219 const char *res = return_record_wrbuf(wrbuf, len, npr, marctype, charset);
2221 if (*format == '1' && len)
2223 /* try to XML format res */
2225 xmlKeepBlanksDefault(0); /* get get xmlDocFormatMemory to work! */
2226 doc = xmlParseMemory(res, *len);
2231 xmlDocDumpFormatMemory(doc, &xml_mem, &xml_size, 1);
2232 wrbuf_rewind(wrbuf);
2233 wrbuf_write(wrbuf, (const char *) xml_mem, xml_size);
2236 res = wrbuf_cstr(wrbuf);
2237 *len = wrbuf_len(wrbuf);
2245 static const char *npr_format(Z_NamePlusRecord *npr, const char *schema,
2247 const char *type_spec, int *len)
2253 const char *cp = type_spec;
2255 for (i = 0; cp[i] && cp[i] != ';' && cp[i] != ' ' && i < sizeof(type)-1;
2263 while (cp[i] == ' ')
2268 while (cp[i] == ' ')
2270 if (!strncmp(cp + i, "charset=", 8))
2273 i = i + 8; /* skip charset= */
2274 for (j = 0; cp[i] && cp[i] != ';' && cp[i] != ' '; i++)
2276 if (j < sizeof(charset)-1)
2277 charset[j++] = cp[i];
2281 else if (!strncmp(cp + i, "format=", 7))
2285 for (j = 0; cp[i] && cp[i] != ';' && cp[i] != ' '; i++)
2287 if (j < sizeof(format)-1)
2288 format[j++] = cp[i];
2293 if (!strcmp(type, "database"))
2296 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
2297 return npr->databaseName;
2299 else if (!strcmp(type, "schema"))
2302 *len = schema ? strlen(schema) : 0;
2305 else if (!strcmp(type, "syntax"))
2307 const char *desc = 0;
2308 if (npr->which == Z_NamePlusRecord_databaseRecord)
2310 Z_External *r = (Z_External *) npr->u.databaseRecord;
2311 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
2316 *len = strlen(desc);
2319 if (npr->which != Z_NamePlusRecord_databaseRecord)
2322 /* from now on - we have a database record .. */
2323 if (!strcmp(type, "render"))
2325 return get_record_format(wrbuf, len, npr, YAZ_MARC_LINE, charset, format);
2327 else if (!strcmp(type, "xml"))
2329 return get_record_format(wrbuf, len, npr, YAZ_MARC_MARCXML, charset,
2332 else if (!strcmp(type, "txml"))
2334 return get_record_format(wrbuf, len, npr, YAZ_MARC_TURBOMARC, charset,
2337 else if (!strcmp(type, "raw"))
2339 return get_record_format(wrbuf, len, npr, YAZ_MARC_ISO2709, charset,
2342 else if (!strcmp(type, "ext"))
2345 return (const char *) npr->u.databaseRecord;
2347 else if (!strcmp(type, "opac"))
2349 if (npr->u.databaseRecord->which == Z_External_OPAC)
2350 return get_record_format(wrbuf, len, npr, YAZ_MARC_MARCXML, charset,
2356 ZOOM_API(const char *)
2357 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
2362 *len = 0; /* default return */
2364 if (!rec || !rec->npr)
2368 if (!rec->record_wrbuf)
2370 WRBUF w = wrbuf_alloc();
2371 YAZ_SHPTR_INIT(rec->record_wrbuf, w);
2373 wrbuf = rec->record_wrbuf->ptr;
2376 rec->wrbuf = wrbuf_alloc();
2379 return npr_format(rec->npr, rec->schema, wrbuf, type_spec, len);
2382 static int strcmp_null(const char *v1, const char *v2)
2388 return strcmp(v1, v2);
2391 static size_t record_hash(int pos)
2395 return pos % RECORD_HASH_SIZE;
2398 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2400 const char *syntax, const char *elementSetName,
2402 Z_SRW_diagnostic *diag)
2404 ZOOM_record_cache rc = 0;
2406 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2407 ZOOM_connection_put_event(r->connection, event);
2409 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2412 && strcmp_null(r->schema, rc->schema) == 0
2413 && strcmp_null(elementSetName,rc->elementSetName) == 0
2414 && strcmp_null(syntax, rc->syntax) == 0)
2419 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2422 YAZ_SHPTR_INC(r->record_wrbuf);
2423 rc->rec.record_wrbuf = r->record_wrbuf;
2427 rc->elementSetName = odr_strdup_null(r->odr, elementSetName);
2429 rc->syntax = odr_strdup_null(r->odr, syntax);
2431 rc->schema = odr_strdup_null(r->odr, r->schema);
2434 rc->next = r->record_hash[record_hash(pos)];
2435 r->record_hash[record_hash(pos)] = rc;
2438 rc->rec.schema = odr_strdup_null(r->odr, schema);
2439 rc->rec.diag_set = 0;
2440 rc->rec.diag_uri = 0;
2441 rc->rec.diag_message = 0;
2442 rc->rec.diag_details = 0;
2448 rc->rec.diag_set = odr_strdup(r->odr, diag->uri);
2449 if ((cp = strrchr(rc->rec.diag_set, '/')))
2451 rc->rec.diag_uri = odr_strdup(r->odr, diag->uri);
2453 rc->rec.diag_message = odr_strdup_null(r->odr, diag->message);
2454 rc->rec.diag_details = odr_strdup_null(r->odr, diag->details);
2458 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2460 const char *elementSetName)
2462 ZOOM_record_cache rc;
2464 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2468 if (strcmp_null(r->schema, rc->schema))
2470 if (strcmp_null(elementSetName,rc->elementSetName))
2472 if (strcmp_null(syntax, rc->syntax))
2480 static void handle_records(ZOOM_connection c, Z_Records *sr,
2483 ZOOM_resultset resultset;
2485 const char *syntax = 0, *elementSetName = 0;
2489 switch (c->tasks->which)
2491 case ZOOM_TASK_SEARCH:
2492 resultset = c->tasks->u.search.resultset;
2493 start = &c->tasks->u.search.start;
2494 count = &c->tasks->u.search.count;
2495 syntax = c->tasks->u.search.syntax;
2496 elementSetName = c->tasks->u.search.elementSetName;
2498 case ZOOM_TASK_RETRIEVE:
2499 resultset = c->tasks->u.retrieve.resultset;
2500 start = &c->tasks->u.retrieve.start;
2501 count = &c->tasks->u.retrieve.count;
2502 syntax = c->tasks->u.retrieve.syntax;
2503 elementSetName = c->tasks->u.retrieve.elementSetName;
2508 if (sr && sr->which == Z_Records_NSD)
2509 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2510 else if (sr && sr->which == Z_Records_multipleNSD)
2512 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2513 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2515 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2519 if (*count + *start > resultset->size)
2520 *count = resultset->size - *start;
2523 if (sr && sr->which == Z_Records_DBOSD)
2526 NMEM nmem = odr_extract_mem(c->odr_in);
2527 Z_NamePlusRecordList *p =
2528 sr->u.databaseOrSurDiagnostics;
2529 for (i = 0; i<p->num_records; i++)
2531 record_cache_add(resultset, p->records[i], i + *start,
2532 syntax, elementSetName,
2539 yaz_log(log_details,
2540 "handle_records resultset=%p start=%d count=%d",
2541 resultset, *start, *count);
2543 /* transfer our response to search_nmem .. we need it later */
2544 nmem_transfer(odr_getmem(resultset->odr), nmem);
2546 if (present_phase && p->num_records == 0)
2548 /* present response and we didn't get any records! */
2549 Z_NamePlusRecord *myrec =
2550 zget_surrogateDiagRec(
2552 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
2553 "ZOOM C generated. Present phase and no records");
2554 record_cache_add(resultset, myrec, *start,
2555 syntax, elementSetName, 0, 0);
2558 else if (present_phase)
2560 /* present response and we didn't get any records! */
2561 Z_NamePlusRecord *myrec =
2562 zget_surrogateDiagRec(
2564 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
2565 "ZOOM C generated: Present response and no records");
2566 record_cache_add(resultset, myrec, *start, syntax, elementSetName,
2572 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2574 handle_records(c, pr->records, 1);
2577 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2580 switch (term->which)
2582 case Z_Term_general:
2583 ZOOM_options_setl(opt, name,
2584 (const char *)(term->u.general->buf),
2585 term->u.general->len);
2587 case Z_Term_characterString:
2588 ZOOM_options_set(opt, name, term->u.characterString);
2590 case Z_Term_numeric:
2591 ZOOM_options_set_int(opt, name, *term->u.numeric);
2596 static void handle_queryExpression(ZOOM_options opt, const char *name,
2597 Z_QueryExpression *exp)
2603 case Z_QueryExpression_term:
2604 if (exp->u.term && exp->u.term->queryTerm)
2606 sprintf(opt_name, "%s.term", name);
2607 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2610 case Z_QueryExpression_query:
2615 static void handle_search_result(ZOOM_connection c, ZOOM_resultset resultset,
2616 Z_OtherInformation *o)
2619 for (i = 0; o && i < o->num_elements; i++)
2621 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2623 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2625 if (ext->which == Z_External_searchResult1)
2628 Z_SearchInfoReport *sr = ext->u.searchResult1;
2631 ZOOM_options_set_int(
2632 resultset->options, "searchresult.size", sr->num);
2634 for (j = 0; j < sr->num; j++)
2636 Z_SearchInfoReport_s *ent =
2637 ext->u.searchResult1->elements[j];
2640 sprintf(pref, "searchresult.%d", j);
2642 if (ent->subqueryId)
2645 sprintf(opt_name, "%s.id", pref);
2646 ZOOM_options_set(resultset->options, opt_name,
2649 if (ent->subqueryExpression)
2652 sprintf(opt_name, "%s.subquery", pref);
2653 handle_queryExpression(resultset->options, opt_name,
2654 ent->subqueryExpression);
2656 if (ent->subqueryInterpretation)
2659 sprintf(opt_name, "%s.interpretation", pref);
2660 handle_queryExpression(resultset->options, opt_name,
2661 ent->subqueryInterpretation);
2663 if (ent->subqueryRecommendation)
2666 sprintf(opt_name, "%s.recommendation", pref);
2667 handle_queryExpression(resultset->options, opt_name,
2668 ent->subqueryRecommendation);
2670 if (ent->subqueryCount)
2673 sprintf(opt_name, "%s.count", pref);
2674 ZOOM_options_set_int(resultset->options, opt_name,
2675 *ent->subqueryCount);
2683 static char *get_term_cstr(ODR odr, Z_Term *term) {
2685 switch (term->which) {
2686 case Z_Term_general:
2687 return odr_strdupn(odr, (const char *) term->u.general->buf, (size_t) term->u.general->len);
2689 case Z_Term_characterString:
2690 return odr_strdup(odr, term->u.characterString);
2695 static ZOOM_facet_field get_zoom_facet_field(ODR odr, Z_FacetField *facet) {
2697 struct attrvalues attr_values;
2698 ZOOM_facet_field facet_field = odr_malloc(odr, sizeof(*facet_field));
2699 memset(&attr_values, 0, sizeof(attr_values));
2700 facetattrs(facet->attributes, &attr_values);
2701 facet_field->facet_name = odr_strdup(odr, attr_values.useattr);
2702 facet_field->num_terms = facet->num_terms;
2703 facet_field->facet_terms = odr_malloc(odr, facet_field->num_terms * sizeof(*facet_field->facet_terms));
2704 for (term_index = 0 ; term_index < facet->num_terms; term_index++) {
2705 Z_FacetTerm *facetTerm = facet->terms[term_index];
2706 facet_field->facet_terms[term_index].frequency = *facetTerm->count;
2707 facet_field->facet_terms[term_index].term = get_term_cstr(odr, facetTerm->term);
2712 static void handle_facet_result(ZOOM_connection c, ZOOM_resultset r,
2713 Z_OtherInformation *o)
2716 for (i = 0; o && i < o->num_elements; i++)
2718 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2720 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2721 if (ext->which == Z_External_userFacets)
2724 Z_FacetList *fl = ext->u.facetList;
2725 r->num_facets = fl->num;
2726 r->facets = odr_malloc(r->odr, r->num_facets * sizeof(*r->facets));
2727 r->facets_names = odr_malloc(r->odr, r->num_facets * sizeof(*r->facets_names));
2728 for (j = 0; j < fl->num; j++)
2730 r->facets[j] = get_zoom_facet_field(r->odr, fl->elements[j]);
2731 r->facets_names[j] = (char *) ZOOM_facet_field_name(r->facets[j]);
2739 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2741 ZOOM_resultset resultset;
2744 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2747 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2748 ZOOM_connection_put_event(c, event);
2750 resultset = c->tasks->u.search.resultset;
2752 if (sr->resultSetStatus)
2754 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2755 *sr->resultSetStatus);
2757 if (sr->presentStatus)
2759 ZOOM_options_set_int(resultset->options, "presentStatus",
2760 *sr->presentStatus);
2762 handle_search_result(c, resultset, sr->additionalSearchInfo);
2764 handle_facet_result(c, resultset, sr->additionalSearchInfo);
2766 resultset->size = *sr->resultCount;
2767 handle_records(c, sr->records, 0);
2770 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2772 if (res->diagnostics && res->num_diagnostics > 0)
2773 response_diag(c, res->diagnostics[0]);
2776 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2778 NMEM nmem = odr_extract_mem(c->odr_in);
2781 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2783 scan = c->tasks->u.scan.scan;
2785 if (res->entries && res->entries->nonsurrogateDiagnostics)
2786 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2787 scan->scan_response = res;
2788 scan->srw_scan_response = 0;
2789 nmem_transfer(odr_getmem(scan->odr), nmem);
2791 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2792 if (res->positionOfTerm)
2793 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2794 if (res->scanStatus)
2795 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2796 if (res->numberOfEntriesReturned)
2797 ZOOM_options_set_int(scan->options, "number",
2798 *res->numberOfEntriesReturned);
2803 static zoom_ret send_sort(ZOOM_connection c,
2804 ZOOM_resultset resultset)
2807 resultset->r_sort_spec = 0;
2808 if (resultset->r_sort_spec)
2810 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2811 Z_SortRequest *req = apdu->u.sortRequest;
2813 req->num_inputResultSetNames = 1;
2814 req->inputResultSetNames = (Z_InternationalString **)
2815 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2816 req->inputResultSetNames[0] =
2817 odr_strdup(c->odr_out, resultset->setname);
2818 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2819 req->sortSequence = resultset->r_sort_spec;
2820 resultset->r_sort_spec = 0;
2821 return send_APDU(c, apdu);
2823 return zoom_complete;
2826 static zoom_ret send_present(ZOOM_connection c)
2829 Z_PresentRequest *req = 0;
2831 const char *syntax = 0;
2832 const char *elementSetName = 0;
2833 ZOOM_resultset resultset;
2838 yaz_log(log_details, "%p send_present no tasks", c);
2839 return zoom_complete;
2842 switch (c->tasks->which)
2844 case ZOOM_TASK_SEARCH:
2845 resultset = c->tasks->u.search.resultset;
2846 start = &c->tasks->u.search.start;
2847 count = &c->tasks->u.search.count;
2848 syntax = c->tasks->u.search.syntax;
2849 elementSetName = c->tasks->u.search.elementSetName;
2851 case ZOOM_TASK_RETRIEVE:
2852 resultset = c->tasks->u.retrieve.resultset;
2853 start = &c->tasks->u.retrieve.start;
2854 count = &c->tasks->u.retrieve.count;
2855 syntax = c->tasks->u.retrieve.syntax;
2856 elementSetName = c->tasks->u.retrieve.elementSetName;
2859 return zoom_complete;
2861 yaz_log(log_details, "%p send_present start=%d count=%d",
2864 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2866 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2869 if (c->error) /* don't continue on error */
2870 return zoom_complete;
2871 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2872 resultset, *start, *count);
2874 for (i = 0; i < *count; i++)
2877 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2882 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2883 ZOOM_connection_put_event(c, event);
2891 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2892 return zoom_complete;
2895 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2896 req = apdu->u.presentRequest;
2899 yaz_log(log_details, "%p send_present skip=%d", c, i);
2901 *req->resultSetStartPoint = *start + 1;
2903 if (resultset->step > 0 && resultset->step < *count)
2904 *req->numberOfRecordsRequested = resultset->step;
2906 *req->numberOfRecordsRequested = *count;
2908 if (*req->numberOfRecordsRequested + *start > resultset->size)
2909 *req->numberOfRecordsRequested = resultset->size - *start;
2910 assert(*req->numberOfRecordsRequested > 0);
2912 if (syntax && *syntax)
2913 req->preferredRecordSyntax =
2914 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2916 if (resultset->schema && *resultset->schema)
2918 Z_RecordComposition *compo = (Z_RecordComposition *)
2919 odr_malloc(c->odr_out, sizeof(*compo));
2921 req->recordComposition = compo;
2922 compo->which = Z_RecordComp_complex;
2923 compo->u.complex = (Z_CompSpec *)
2924 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2925 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2926 odr_malloc(c->odr_out, sizeof(bool_t));
2927 *compo->u.complex->selectAlternativeSyntax = 0;
2929 compo->u.complex->generic = (Z_Specification *)
2930 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2932 compo->u.complex->generic->which = Z_Schema_oid;
2933 compo->u.complex->generic->schema.oid = (Odr_oid *)
2934 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2936 if (!compo->u.complex->generic->schema.oid)
2938 /* OID wasn't a schema! Try record syntax instead. */
2940 compo->u.complex->generic->schema.oid = (Odr_oid *)
2941 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2943 if (elementSetName && *elementSetName)
2945 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2946 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2947 compo->u.complex->generic->elementSpec->which =
2948 Z_ElementSpec_elementSetName;
2949 compo->u.complex->generic->elementSpec->u.elementSetName =
2950 odr_strdup(c->odr_out, elementSetName);
2953 compo->u.complex->generic->elementSpec = 0;
2954 compo->u.complex->num_dbSpecific = 0;
2955 compo->u.complex->dbSpecific = 0;
2956 compo->u.complex->num_recordSyntax = 0;
2957 compo->u.complex->recordSyntax = 0;
2959 else if (elementSetName && *elementSetName)
2961 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2962 odr_malloc(c->odr_out, sizeof(*esn));
2963 Z_RecordComposition *compo = (Z_RecordComposition *)
2964 odr_malloc(c->odr_out, sizeof(*compo));
2966 esn->which = Z_ElementSetNames_generic;
2967 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2968 compo->which = Z_RecordComp_simple;
2969 compo->u.simple = esn;
2970 req->recordComposition = compo;
2972 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2973 return send_APDU(c, apdu);
2976 ZOOM_API(ZOOM_scanset)
2977 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2980 ZOOM_query q = ZOOM_query_create();
2982 ZOOM_query_prefix(q, start);
2984 s = ZOOM_connection_scan1(c, q);
2985 ZOOM_query_destroy(q);
2990 ZOOM_API(ZOOM_scanset)
2991 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2993 ZOOM_scanset scan = 0;
2997 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2998 scan->connection = c;
2999 scan->odr = odr_createmem(ODR_DECODE);
3000 scan->options = ZOOM_options_create_with_parent(c->options);
3002 scan->scan_response = 0;
3003 scan->srw_scan_response = 0;
3007 scan->databaseNames = set_DatabaseNames(c, c->options,
3008 &scan->num_databaseNames,
3013 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
3014 task->u.scan.scan = scan;
3019 while (ZOOM_event(1, &c))
3027 ZOOM_scanset_destroy(ZOOM_scanset scan)
3032 if (scan->refcount == 0)
3034 ZOOM_query_destroy(scan->query);
3036 odr_destroy(scan->odr);
3038 ZOOM_options_destroy(scan->options);
3043 static zoom_ret send_package(ZOOM_connection c)
3047 yaz_log(log_details, "%p send_package", c);
3049 return zoom_complete;
3050 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
3052 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
3053 ZOOM_connection_put_event(c, event);
3055 c->buf_out = c->tasks->u.package->buf_out;
3056 c->len_out = c->tasks->u.package->len_out;
3061 static zoom_ret ZOOM_connection_send_scan(ZOOM_connection c)
3064 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
3065 Z_ScanRequest *req = apdu->u.scanRequest;
3067 yaz_log(log_details, "%p send_scan", c);
3069 return zoom_complete;
3070 assert (c->tasks->which == ZOOM_TASK_SCAN);
3071 scan = c->tasks->u.scan.scan;
3073 /* Z39.50 scan can only carry RPN */
3074 if (scan->query->z_query->which == Z_Query_type_1 ||
3075 scan->query->z_query->which == Z_Query_type_101)
3077 Z_RPNQuery *rpn = scan->query->z_query->u.type_1;
3078 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
3081 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
3084 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
3086 yaz_query_charset_convert_rpnquery(
3087 rpn, c->odr_out, cd);
3088 yaz_iconv_close(cd);
3091 req->attributeSet = rpn->attributeSetId;
3092 if (!req->attributeSet)
3093 req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
3094 if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
3095 rpn->RPNStructure->u.simple->which == Z_Operand_APT)
3097 req->termListAndStartPoint =
3098 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
3102 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
3103 return zoom_complete;
3108 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
3109 return zoom_complete;
3112 *req->numberOfTermsRequested =
3113 ZOOM_options_get_int(scan->options, "number", 20);
3115 req->preferredPositionInResponse =
3116 odr_intdup(c->odr_out,
3117 ZOOM_options_get_int(scan->options, "position", 1));
3120 odr_intdup(c->odr_out,
3121 ZOOM_options_get_int(scan->options, "stepSize", 0));
3123 req->databaseNames = scan->databaseNames;
3124 req->num_databaseNames = scan->num_databaseNames;
3126 return send_APDU(c, apdu);
3130 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
3134 const char *option_val = 0;
3137 return zoom_complete;
3138 assert (c->tasks->which == ZOOM_TASK_SCAN);
3139 scan = c->tasks->u.scan.scan;
3141 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
3143 /* SRU scan can only carry CQL and PQF */
3144 if (scan->query->z_query->which == Z_Query_type_104)
3146 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
3147 sr->u.scan_request->scanClause.cql = scan->query->query_string;
3149 else if (scan->query->z_query->which == Z_Query_type_1
3150 || scan->query->z_query->which == Z_Query_type_101)
3152 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
3153 sr->u.scan_request->scanClause.pqf = scan->query->query_string;
3157 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
3158 return zoom_complete;
3161 sr->u.scan_request->maximumTerms = odr_intdup(
3162 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
3164 sr->u.scan_request->responsePosition = odr_intdup(
3165 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
3167 option_val = ZOOM_options_get(scan->options, "extraArgs");
3168 yaz_encode_sru_extra(sr, c->odr_out, option_val);
3169 return send_srw(c, sr);
3172 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
3174 return zoom_complete;
3180 ZOOM_scanset_size(ZOOM_scanset scan)
3185 if (scan->scan_response && scan->scan_response->entries)
3186 return scan->scan_response->entries->num_entries;
3187 else if (scan->srw_scan_response)
3188 return scan->srw_scan_response->num_terms;
3192 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
3194 const char **value_term, size_t *value_len,
3195 const char **disp_term, size_t *disp_len)
3197 size_t noent = ZOOM_scanset_size(scan);
3208 if (scan->scan_response)
3210 Z_ScanResponse *res = scan->scan_response;
3211 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
3213 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
3215 *value_term = (const char *) t->term->u.general->buf;
3216 *value_len = t->term->u.general->len;
3219 *disp_term = t->displayTerm;
3220 *disp_len = strlen(*disp_term);
3222 else if (t->term->which == Z_Term_general)
3224 *disp_term = (const char *) t->term->u.general->buf;
3225 *disp_len = t->term->u.general->len;
3227 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
3230 if (scan->srw_scan_response)
3232 Z_SRW_scanResponse *res = scan->srw_scan_response;
3233 Z_SRW_scanTerm *t = res->terms + pos;
3236 *value_term = t->value;
3237 *value_len = strlen(*value_term);
3240 *disp_term = t->displayTerm;
3242 *disp_term = t->value;
3243 *disp_len = strlen(*disp_term);
3244 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
3249 ZOOM_API(const char *)
3250 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
3251 size_t *occ, size_t *len)
3253 const char *value_term = 0;
3254 size_t value_len = 0;
3255 const char *disp_term = 0;
3256 size_t disp_len = 0;
3258 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3259 &disp_term, &disp_len);
3265 ZOOM_API(const char *)
3266 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
3267 size_t *occ, size_t *len)
3269 const char *value_term = 0;
3270 size_t value_len = 0;
3271 const char *disp_term = 0;
3272 size_t disp_len = 0;
3274 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3275 &disp_term, &disp_len);
3281 ZOOM_API(const char *)
3282 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
3284 return ZOOM_options_get(scan->options, key);
3288 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
3291 ZOOM_options_set(scan->options, key, val);
3294 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
3297 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
3298 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3300 str = ZOOM_options_get(p->options, "package-name");
3302 req->packageName = odr_strdup(p->odr_out, str);
3304 str = ZOOM_options_get(p->options, "user-id");
3306 req->userId = odr_strdup_null(p->odr_out, str);
3308 req->packageType = odr_oiddup(p->odr_out, oid);
3310 str = ZOOM_options_get(p->options, "function");
3313 if (!strcmp (str, "create"))
3314 *req->function = Z_ExtendedServicesRequest_create;
3315 if (!strcmp (str, "delete"))
3316 *req->function = Z_ExtendedServicesRequest_delete;
3317 if (!strcmp (str, "modify"))
3318 *req->function = Z_ExtendedServicesRequest_modify;
3321 str = ZOOM_options_get(p->options, "waitAction");
3324 if (!strcmp (str, "wait"))
3325 *req->waitAction = Z_ExtendedServicesRequest_wait;
3326 if (!strcmp (str, "waitIfPossible"))
3327 *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
3328 if (!strcmp (str, "dontWait"))
3329 *req->waitAction = Z_ExtendedServicesRequest_dontWait;
3330 if (!strcmp (str, "dontReturnPackage"))
3331 *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
3336 static const char *ill_array_lookup(void *clientData, const char *idx)
3338 ZOOM_package p = (ZOOM_package) clientData;
3339 return ZOOM_options_get(p->options, idx+4);
3342 static Z_External *encode_ill_request(ZOOM_package p)
3344 ODR out = p->odr_out;
3347 struct ill_get_ctl ctl;
3349 ctl.odr = p->odr_out;
3351 ctl.f = ill_array_lookup;
3353 req = ill_get_ILLRequest(&ctl, "ill", 0);
3355 if (!ill_Request(out, &req, 0, 0))
3357 int ill_request_size;
3358 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
3359 if (ill_request_buf)
3360 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
3365 int illRequest_size = 0;
3366 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
3368 r = (Z_External *) odr_malloc(out, sizeof(*r));
3369 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
3370 r->indirect_reference = 0;
3372 r->which = Z_External_single;
3374 r->u.single_ASN1_type =
3375 odr_create_Odr_oct(out,
3376 (unsigned char *)illRequest_buf,
3382 static Z_ItemOrder *encode_item_order(ZOOM_package p)
3384 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
3388 req->which = Z_IOItemOrder_esRequest;
3389 req->u.esRequest = (Z_IORequest *)
3390 odr_malloc(p->odr_out,sizeof(Z_IORequest));
3392 /* to keep part ... */
3393 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
3394 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
3395 req->u.esRequest->toKeep->supplDescription = 0;
3396 req->u.esRequest->toKeep->contact = (Z_IOContact *)
3397 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
3399 str = ZOOM_options_get(p->options, "contact-name");
3400 req->u.esRequest->toKeep->contact->name =
3401 odr_strdup_null(p->odr_out, str);
3403 str = ZOOM_options_get(p->options, "contact-phone");
3404 req->u.esRequest->toKeep->contact->phone =
3405 odr_strdup_null(p->odr_out, str);
3407 str = ZOOM_options_get(p->options, "contact-email");
3408 req->u.esRequest->toKeep->contact->email =
3409 odr_strdup_null(p->odr_out, str);
3411 req->u.esRequest->toKeep->addlBilling = 0;
3413 /* not to keep part ... */
3414 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
3415 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3417 str = ZOOM_options_get(p->options, "itemorder-setname");
3422 req->u.esRequest->notToKeep->resultSetItem = 0;
3425 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3426 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3428 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3429 odr_strdup(p->odr_out, str);
3430 req->u.esRequest->notToKeep->resultSetItem->item =
3431 odr_intdup(p->odr_out, 0);
3433 str = ZOOM_options_get(p->options, "itemorder-item");
3434 *req->u.esRequest->notToKeep->resultSetItem->item =
3435 (str ? atoi(str) : 1);
3438 str = ZOOM_options_getl(p->options, "doc", &len);
3441 req->u.esRequest->notToKeep->itemRequest =
3442 z_ext_record_xml(p->odr_out, str, len);
3445 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3450 Z_APDU *create_admin_package(ZOOM_package p, int type,
3451 Z_ESAdminOriginPartToKeep **toKeepP,
3452 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3454 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3457 Z_ESAdminOriginPartToKeep *toKeep;
3458 Z_ESAdminOriginPartNotToKeep *notToKeep;
3459 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3460 const char *first_db = "Default";
3462 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3467 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3469 r->indirect_reference = 0;
3470 r->which = Z_External_ESAdmin;
3472 r->u.adminService = (Z_Admin *)
3473 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3474 r->u.adminService->which = Z_Admin_esRequest;
3475 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3476 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3478 toKeep = r->u.adminService->u.esRequest->toKeep =
3479 (Z_ESAdminOriginPartToKeep *)
3480 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3481 toKeep->which = type;
3482 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3483 toKeep->u.create = odr_nullval();
3484 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3486 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3487 (Z_ESAdminOriginPartNotToKeep *)
3488 odr_malloc(p->odr_out,
3489 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3490 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3491 notToKeep->u.recordsWillFollow = odr_nullval();
3495 *notToKeepP = notToKeep;
3500 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3502 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3503 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3504 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3506 const char *doc = ZOOM_options_getl(p->options, "doc", &len);
3514 req->taskSpecificParameters = ext;
3515 ext->direct_reference = req->packageType;
3516 ext->descriptor = 0;
3517 ext->indirect_reference = 0;
3519 ext->which = Z_External_octet;
3520 ext->u.single_ASN1_type =
3521 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc, len);
3525 static Z_APDU *create_update_package(ZOOM_package p)
3528 const char *first_db = "Default";
3530 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3531 const char *action = ZOOM_options_get(p->options, "action");
3532 int recordIdOpaque_len;
3533 const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
3534 &recordIdOpaque_len);
3535 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3537 const char *record_buf = ZOOM_options_getl(p->options, "record",
3539 int recordOpaque_len;
3540 const char *recordOpaque_buf = ZOOM_options_getl(p->options, "recordOpaque",
3542 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3543 const char *version = ZOOM_options_get(p->options, "updateVersion");
3545 const char *correlationInfo_note =
3546 ZOOM_options_get(p->options, "correlationInfo.note");
3547 const char *correlationInfo_id =
3548 ZOOM_options_get(p->options, "correlationInfo.id");
3550 Odr_oid *syntax_oid = 0;
3551 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
3557 if (!record_buf && !recordOpaque_buf)
3559 record_buf = "void";
3561 syntax_str = "SUTRS";
3566 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3567 CLASS_RECSYN, syntax_str,
3579 package_oid = yaz_oid_extserv_database_update_first_version;
3580 /* old update does not support specialUpdate */
3582 action = "recordInsert";
3586 action = "specialUpdate";
3587 package_oid = yaz_oid_extserv_database_update_second_version;
3591 action = "specialUpdate";
3592 package_oid = yaz_oid_extserv_database_update;
3598 if (!strcmp(action, "recordInsert"))
3599 action_no = Z_IUOriginPartToKeep_recordInsert;
3600 else if (!strcmp(action, "recordReplace"))
3601 action_no = Z_IUOriginPartToKeep_recordReplace;
3602 else if (!strcmp(action, "recordDelete"))
3603 action_no = Z_IUOriginPartToKeep_recordDelete;
3604 else if (!strcmp(action, "elementUpdate"))
3605 action_no = Z_IUOriginPartToKeep_elementUpdate;
3606 else if (!strcmp(action, "specialUpdate"))
3607 action_no = Z_IUOriginPartToKeep_specialUpdate;
3611 apdu = create_es_package(p, package_oid);
3614 Z_IUOriginPartToKeep *toKeep;
3615 Z_IUSuppliedRecords *notToKeep;
3616 Z_External *r = (Z_External *)
3617 odr_malloc(p->odr_out, sizeof(*r));
3618 const char *elementSetName =
3619 ZOOM_options_get(p->options, "elementSetName");
3621 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3623 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
3625 r->which = Z_External_update;
3626 r->indirect_reference = 0;
3627 r->u.update = (Z_IUUpdate *)
3628 odr_malloc(p->odr_out, sizeof(*r->u.update));
3630 r->u.update->which = Z_IUUpdate_esRequest;
3631 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3632 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3633 toKeep = r->u.update->u.esRequest->toKeep =
3634 (Z_IUOriginPartToKeep *)
3635 odr_malloc(p->odr_out, sizeof(*toKeep));
3637 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3640 toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
3642 toKeep->actionQualifier = 0;
3643 toKeep->action = odr_intdup(p->odr_out, action_no);
3645 notToKeep = r->u.update->u.esRequest->notToKeep =
3646 (Z_IUSuppliedRecords *)
3647 odr_malloc(p->odr_out, sizeof(*notToKeep));
3649 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3650 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3651 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3652 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3653 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3656 notToKeep->elements[0]->u.opaque =
3657 odr_create_Odr_oct(p->odr_out,
3658 (const unsigned char *) recordIdOpaque,
3659 recordIdOpaque_len);
3661 else if (recordIdNumber)
3663 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3665 notToKeep->elements[0]->u.number =
3666 odr_intdup(p->odr_out, atoi(recordIdNumber));
3669 notToKeep->elements[0]->u.opaque = 0;
3670 notToKeep->elements[0]->supplementalId = 0;
3671 if (correlationInfo_note || correlationInfo_id)
3673 Z_IUCorrelationInfo *ci;
3674 ci = notToKeep->elements[0]->correlationInfo =
3675 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
3676 ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
3677 ci->id = correlationInfo_id ?
3678 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3681 notToKeep->elements[0]->correlationInfo = 0;
3682 if (recordOpaque_buf)
3684 notToKeep->elements[0]->record =
3685 z_ext_record_oid_any(p->odr_out, syntax_oid,
3686 recordOpaque_buf, recordOpaque_len);
3690 notToKeep->elements[0]->record =
3691 z_ext_record_oid(p->odr_out, syntax_oid,
3692 record_buf, record_len);
3697 ODR print = odr_createmem(ODR_PRINT);
3699 z_APDU(print, &apdu, 0, 0);
3706 ZOOM_package_send(ZOOM_package p, const char *type)
3713 odr_reset(p->odr_out);
3716 if (!strcmp(type, "itemorder"))
3718 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3721 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3723 r->direct_reference =
3724 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3726 r->which = Z_External_itemOrder;
3727 r->indirect_reference = 0;
3728 r->u.itemOrder = encode_item_order(p);
3730 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3733 else if (!strcmp(type, "create")) /* create database */
3735 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3738 else if (!strcmp(type, "drop")) /* drop database */
3740 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3743 else if (!strcmp(type, "commit")) /* commit changes */
3745 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3748 else if (!strcmp(type, "update")) /* update record(s) */
3750 apdu = create_update_package(p);
3752 else if (!strcmp(type, "xmlupdate"))
3754 apdu = create_xmlupdate_package(p);
3758 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3762 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3763 task->u.package = p;
3764 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3765 p->buf_out = (char *) xmalloc(p->len_out);
3766 memcpy(p->buf_out, buf, p->len_out);
3771 while (ZOOM_event(1, &c))
3778 ZOOM_API(ZOOM_package)
3779 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3781 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3784 p->odr_out = odr_createmem(ODR_ENCODE);
3785 p->options = ZOOM_options_create_with_parent2(options, c->options);
3793 ZOOM_package_destroy(ZOOM_package p)
3798 if (p->refcount == 0)
3800 odr_destroy(p->odr_out);
3803 ZOOM_options_destroy(p->options);
3808 ZOOM_API(const char *)
3809 ZOOM_package_option_get(ZOOM_package p, const char *key)
3811 return ZOOM_options_get(p->options, key);
3814 ZOOM_API(const char *)
3815 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
3817 return ZOOM_options_getl(p->options, key, lenp);
3821 ZOOM_package_option_set(ZOOM_package p, const char *key,
3824 ZOOM_options_set(p->options, key, val);
3828 ZOOM_package_option_setl(ZOOM_package p, const char *key,
3829 const char *val, int len)
3831 ZOOM_options_setl(p->options, key, val, len);
3835 ZOOM_connection_exec_task(ZOOM_connection c)
3837 ZOOM_task task = c->tasks;
3838 zoom_ret ret = zoom_complete;
3842 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3843 c, task->which, task->running);
3844 if (c->error != ZOOM_ERROR_NONE)
3846 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3847 "removing tasks because of error = %d", c, c->error);
3848 ZOOM_connection_remove_tasks(c);
3853 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3854 "task already running", c);
3858 ret = zoom_complete;
3859 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3861 switch (task->which)
3863 case ZOOM_TASK_SEARCH:
3864 if (c->proto == PROTO_HTTP)
3865 ret = ZOOM_connection_srw_send_search(c);
3867 ret = ZOOM_connection_send_search(c);
3869 case ZOOM_TASK_RETRIEVE:
3870 if (c->proto == PROTO_HTTP)
3871 ret = ZOOM_connection_srw_send_search(c);
3873 ret = send_present(c);
3875 case ZOOM_TASK_CONNECT:
3876 ret = do_connect(c);
3878 case ZOOM_TASK_SCAN:
3879 if (c->proto == PROTO_HTTP)
3880 ret = ZOOM_connection_srw_send_scan(c);
3882 ret = ZOOM_connection_send_scan(c);
3884 case ZOOM_TASK_PACKAGE:
3885 ret = send_package(c);
3887 case ZOOM_TASK_SORT:
3888 c->tasks->u.sort.resultset->r_sort_spec =
3889 c->tasks->u.sort.q->sort_spec;
3890 ret = send_sort(c, c->tasks->u.sort.resultset);
3896 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3897 "remove tasks because no connection exist", c);
3898 ZOOM_connection_remove_tasks(c);
3900 if (ret == zoom_complete)
3902 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3903 "task removed (complete)", c);
3904 ZOOM_connection_remove_task(c);
3907 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3912 static zoom_ret send_sort_present(ZOOM_connection c)
3914 zoom_ret r = zoom_complete;
3916 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3917 r = send_sort(c, c->tasks->u.search.resultset);
3918 if (r == zoom_complete)
3919 r = send_present(c);
3923 static int es_response_taskpackage_update(ZOOM_connection c,
3924 Z_IUUpdateTaskPackage *utp)
3926 if (utp && utp->targetPart)
3928 Z_IUTargetPart *targetPart = utp->targetPart;
3929 switch ( *targetPart->updateStatus ) {
3930 case Z_IUTargetPart_success:
3931 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
3933 case Z_IUTargetPart_partial:
3934 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
3936 case Z_IUTargetPart_failure:
3937 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
3938 if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
3939 response_diag(c, targetPart->globalDiagnostics[0]);
3942 // NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED.
3947 static int es_response_taskpackage(ZOOM_connection c,
3948 Z_TaskPackage *taskPackage)
3951 Odr_oct *id = taskPackage->targetReference;
3953 ZOOM_options_setl(c->tasks->u.package->options,
3954 "targetReference", (char*) id->buf, id->len);
3957 switch ( *taskPackage->taskStatus ) {
3958 case Z_TaskPackage_pending:
3959 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
3961 case Z_TaskPackage_active:
3962 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
3964 case Z_TaskPackage_complete:
3965 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
3967 case Z_TaskPackage_aborted:
3968 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
3969 if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
3970 response_diag(c, taskPackage->packageDiagnostics[0]);
3974 // taskSpecificParameters
3975 // NOTE: Only Update implemented, no others.
3976 if ( taskPackage->taskSpecificParameters->which == Z_External_update ) {
3977 Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
3978 es_response_taskpackage_update(c, utp);
3984 static int es_response(ZOOM_connection c,
3985 Z_ExtendedServicesResponse *res)
3987 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3989 switch (*res->operationStatus) {
3990 case Z_ExtendedServicesResponse_done:
3991 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
3993 case Z_ExtendedServicesResponse_accepted:
3994 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
3996 case Z_ExtendedServicesResponse_failure:
3997 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
3998 if (res->diagnostics && res->num_diagnostics > 0)
3999 response_diag(c, res->diagnostics[0]);
4002 if (res->taskPackage &&
4003 res->taskPackage->which == Z_External_extendedService)
4005 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
4006 es_response_taskpackage(c, taskPackage);
4008 if (res->taskPackage &&
4009 res->taskPackage->which == Z_External_octet)
4011 Odr_oct *doc = res->taskPackage->u.octet_aligned;
4012 ZOOM_options_setl(c->tasks->u.package->options,
4013 "xmlUpdateDoc", (char*) doc->buf, doc->len);
4018 static void interpret_init_diag(ZOOM_connection c,
4019 Z_DiagnosticFormat *diag)
4023 Z_DiagnosticFormat_s *ds = diag->elements[0];
4024 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
4025 response_default_diag(c, ds->u.defaultDiagRec);
4030 static void interpret_otherinformation_field(ZOOM_connection c,
4031 Z_OtherInformation *ui)
4034 for (i = 0; i < ui->num_elements; i++)
4036 Z_OtherInformationUnit *unit = ui->list[i];
4037 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
4038 unit->information.externallyDefinedInfo &&
4039 unit->information.externallyDefinedInfo->which ==
4042 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
4048 static void set_init_option(const char *name, void *clientData) {
4049 ZOOM_connection c = (ZOOM_connection) clientData;
4052 sprintf(buf, "init_opt_%.70s", name);
4053 ZOOM_connection_option_set(c, buf, "1");
4057 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
4059 Z_InitResponse *initrs;
4061 ZOOM_connection_set_mask(c, 0);
4062 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
4065 case Z_APDU_initResponse:
4066 yaz_log(log_api, "%p recv_apdu: Received Init response", c);
4067 initrs = apdu->u.initResponse;
4068 ZOOM_connection_option_set(c, "serverImplementationId",
4069 initrs->implementationId ?
4070 initrs->implementationId : "");
4071 ZOOM_connection_option_set(c, "serverImplementationName",
4072 initrs->implementationName ?
4073 initrs->implementationName : "");
4074 ZOOM_connection_option_set(c, "serverImplementationVersion",
4075 initrs->implementationVersion ?
4076 initrs->implementationVersion : "");
4077 /* Set the three old options too, for old applications */
4078 ZOOM_connection_option_set(c, "targetImplementationId",
4079 initrs->implementationId ?
4080 initrs->implementationId : "");
4081 ZOOM_connection_option_set(c, "targetImplementationName",
4082 initrs->implementationName ?
4083 initrs->implementationName : "");
4084 ZOOM_connection_option_set(c, "targetImplementationVersion",
4085 initrs->implementationVersion ?
4086 initrs->implementationVersion : "");
4088 /* Make initrs->options available as ZOOM-level options */
4089 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
4091 if (!*initrs->result)
4093 Z_External *uif = initrs->userInformationField;
4095 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
4097 if (uif && uif->which == Z_External_userInfo1)
4098 interpret_otherinformation_field(c, uif->u.userInfo1);
4103 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
4104 yaz_oid_userinfo_cookie, 1, 0);
4105 xfree(c->cookie_in);
4108 c->cookie_in = xstrdup(cookie);
4109 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
4110 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
4111 c->support_named_resultsets = 1;
4114 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4115 ZOOM_connection_remove_task(c);
4117 ZOOM_connection_exec_task(c);
4119 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
4121 NMEM tmpmem = nmem_create();
4122 Z_CharSetandLanguageNegotiation *p =
4123 yaz_get_charneg_record(initrs->otherInfo);
4127 char *charset = NULL, *lang = NULL;
4130 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
4131 yaz_log(log_details, "%p recv_apdu target accepted: "
4132 "charset %s, language %s, select %d",
4134 charset ? charset : "none", lang ? lang : "none", sel);
4136 ZOOM_connection_option_set(c, "negotiation-charset",
4139 ZOOM_connection_option_set(c, "negotiation-lang",
4142 ZOOM_connection_option_set(
4143 c, "negotiation-charset-in-effect-for-records",
4144 (sel != 0) ? "1" : "0");
4145 nmem_destroy(tmpmem);
4149 case Z_APDU_searchResponse:
4150 yaz_log(log_api, "%p recv_apdu Search response", c);
4151 handle_search_response(c, apdu->u.searchResponse);
4152 if (send_sort_present(c) == zoom_complete)
4153 ZOOM_connection_remove_task(c);
4155 case Z_APDU_presentResponse:
4156 yaz_log(log_api, "%p recv_apdu Present response", c);
4157 handle_present_response(c, apdu->u.presentResponse);
4158 if (send_present(c) == zoom_complete)
4159 ZOOM_connection_remove_task(c);
4161 case Z_APDU_sortResponse:
4162 yaz_log(log_api, "%p recv_apdu Sort response", c);
4163 sort_response(c, apdu->u.sortResponse);
4164 if (send_present(c) == zoom_complete)
4165 ZOOM_connection_remove_task(c);
4167 case Z_APDU_scanResponse:
4168 yaz_log(log_api, "%p recv_apdu Scan response", c);
4169 scan_response(c, apdu->u.scanResponse);
4170 ZOOM_connection_remove_task(c);
4172 case Z_APDU_extendedServicesResponse:
4173 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
4174 es_response(c, apdu->u.extendedServicesResponse);
4175 ZOOM_connection_remove_task(c);
4178 yaz_log(log_api, "%p recv_apdu Close PDU", c);
4179 if (!ZOOM_test_reconnect(c))
4181 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4186 yaz_log(log_api, "%p Received unknown PDU", c);
4187 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4193 static zoom_ret handle_srw_response(ZOOM_connection c,
4194 Z_SRW_searchRetrieveResponse *res)
4196 ZOOM_resultset resultset = 0;
4201 const char *syntax, *elementSetName;
4204 return zoom_complete;
4206 switch(c->tasks->which)
4208 case ZOOM_TASK_SEARCH:
4209 resultset = c->tasks->u.search.resultset;
4210 start = &c->tasks->u.search.start;
4211 count = &c->tasks->u.search.count;
4212 syntax = c->tasks->u.search.syntax;
4213 elementSetName = c->tasks->u.search.elementSetName;
4215 if (!c->tasks->u.search.recv_search_fired)
4217 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
4218 ZOOM_connection_put_event(c, event);
4219 c->tasks->u.search.recv_search_fired = 1;
4222 case ZOOM_TASK_RETRIEVE:
4223 resultset = c->tasks->u.retrieve.resultset;
4224 start = &c->tasks->u.retrieve.start;
4225 count = &c->tasks->u.retrieve.count;
4226 syntax = c->tasks->u.retrieve.syntax;
4227 elementSetName = c->tasks->u.retrieve.elementSetName;
4230 return zoom_complete;
4233 resultset->size = 0;
4235 if (res->resultSetId)
4236 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
4238 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
4240 if (res->num_diagnostics > 0)
4242 set_SRU_error(c, &res->diagnostics[0]);
4246 if (res->numberOfRecords)
4247 resultset->size = *res->numberOfRecords;
4248 for (i = 0; i<res->num_records; i++)
4251 Z_SRW_record *sru_rec;
4252 Z_SRW_diagnostic *diag = 0;
4255 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
4256 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
4258 if (res->records[i].recordPosition &&
4259 *res->records[i].recordPosition > 0)
4260 pos = *res->records[i].recordPosition - 1;
4264 sru_rec = &res->records[i];
4266 npr->databaseName = 0;
4267 npr->which = Z_NamePlusRecord_databaseRecord;
4268 npr->u.databaseRecord = (Z_External *)
4269 odr_malloc(c->odr_in, sizeof(Z_External));
4270 npr->u.databaseRecord->descriptor = 0;
4271 npr->u.databaseRecord->direct_reference =
4272 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
4273 npr->u.databaseRecord->which = Z_External_octet;
4275 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
4276 odr_malloc(c->odr_in, sizeof(Odr_oct));
4277 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
4278 sru_rec->recordData_buf;
4279 npr->u.databaseRecord->u.octet_aligned->len =
4280 npr->u.databaseRecord->u.octet_aligned->size =
4281 sru_rec->recordData_len;
4283 if (sru_rec->recordSchema
4284 && !strcmp(sru_rec->recordSchema,
4285 "info:srw/schema/1/diagnostics-v1.1"))
4287 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
4288 sru_rec->recordData_len,
4292 record_cache_add(resultset, npr, pos, syntax, elementSetName,
4293 sru_rec->recordSchema, diag);
4297 if (*count + *start > resultset->size)
4298 *count = resultset->size - *start;
4302 nmem = odr_extract_mem(c->odr_in);
4303 nmem_transfer(odr_getmem(resultset->odr), nmem);
4307 return ZOOM_connection_srw_send_search(c);
4309 return zoom_complete;
4314 static void handle_srw_scan_response(ZOOM_connection c,
4315 Z_SRW_scanResponse *res)
4317 NMEM nmem = odr_extract_mem(c->odr_in);
4320 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
4322 scan = c->tasks->u.scan.scan;
4324 if (res->num_diagnostics > 0)
4325 set_SRU_error(c, &res->diagnostics[0]);
4327 scan->scan_response = 0;
4328 scan->srw_scan_response = res;
4329 nmem_transfer(odr_getmem(scan->odr), nmem);
4331 ZOOM_options_set_int(scan->options, "number", res->num_terms);
4337 static Z_GDU *get_HTTP_Request_url(ODR odr, const char *url)
4339 Z_GDU *p = z_get_HTTP_Request(odr);
4340 const char *host = url;
4341 const char *cp0 = strstr(host, "://");
4342 const char *cp1 = 0;
4348 cp1 = strchr(cp0, '/');
4350 cp1 = cp0 + strlen(cp0);
4354 char *h = (char*) odr_malloc(odr, cp1 - cp0 + 1);
4355 memcpy (h, cp0, cp1 - cp0);
4357 z_HTTP_header_add(odr, &p->u.HTTP_Request->headers, "Host", h);
4359 p->u.HTTP_Request->path = odr_strdup(odr, *cp1 ? cp1 : "/");
4363 static zoom_ret send_SRW_redirect(ZOOM_connection c, const char *uri,
4364 Z_HTTP_Response *cookie_hres)
4366 struct Z_HTTP_Header *h;
4367 Z_GDU *gdu = get_HTTP_Request_url(c->odr_out, uri);
4368 char *combined_cookies;
4369 int combined_cookies_len = 0;
4371 gdu->u.HTTP_Request->method = odr_strdup(c->odr_out, "GET");
4372 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers, "Accept",
4375 for (h = cookie_hres->headers; h; h = h->next)
4377 if (!strcmp(h->name, "Set-Cookie"))
4381 if (!(cp = strchr(h->value, ';')))
4382 cp = h->value + strlen(h->value);
4383 if (cp - h->value >= 1) {
4384 combined_cookies = xrealloc(combined_cookies, combined_cookies_len + cp - h->value + 3);
4385 memcpy(combined_cookies+combined_cookies_len, h->value, cp - h->value);
4386 combined_cookies[combined_cookies_len + cp - h->value] = '\0';
4387 strcat(combined_cookies,"; ");
4388 combined_cookies_len = strlen(combined_cookies);
4393 if (combined_cookies_len)
4395 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
4396 "Cookie", combined_cookies);
4397 xfree(combined_cookies);
4400 if (c->user && c->password)
4402 z_HTTP_header_add_basic_auth(c->odr_out, &gdu->u.HTTP_Request->headers,
4403 c->user, c->password);
4405 if (!z_GDU(c->odr_out, &gdu, 0, 0))
4406 return zoom_complete;
4408 z_GDU(c->odr_print, &gdu, 0, 0);
4409 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
4411 odr_reset(c->odr_out);
4415 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
4417 zoom_ret cret = zoom_complete;
4419 const char *addinfo = 0;
4420 const char *connection_head = z_HTTP_header_lookup(hres->headers,
4422 const char *location;
4424 ZOOM_connection_set_mask(c, 0);
4425 yaz_log(log_details, "%p handle_http", c);
4427 if ((hres->code == 301 || hres->code == 302) && c->sru_mode == zoom_sru_get
4428 && (location = z_HTTP_header_lookup(hres->headers, "Location")))
4431 if (c->no_redirects > 10)
4433 set_HTTP_error(c, hres->code, 0, 0);
4434 c->no_redirects = 0;
4439 /* since redirect may change host we just reconnect. A smarter
4440 implementation might check whether it's the same server */
4441 do_connect_host(c, location, 0);
4442 send_SRW_redirect(c, location, hres);
4443 /* we're OK for now. Operation is not really complete */
4445 cret = zoom_pending;
4449 { /* not redirect (normal response) */
4450 if (!yaz_srw_check_content_type(hres))
4451 addinfo = "content-type";
4454 Z_SOAP *soap_package = 0;
4456 Z_SOAP_Handler soap_handlers[2] = {
4457 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
4460 ret = z_soap_codec(o, &soap_package,
4461 &hres->content_buf, &hres->content_len,
4463 if (!ret && soap_package->which == Z_SOAP_generic &&
4464 soap_package->u.generic->no == 0)
4466 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
4468 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
4469 ZOOM_options_setl(c->options, "sru_extra_response_data",
4470 sr->extraResponseData_buf, sr->extraResponseData_len);
4471 if (sr->which == Z_SRW_searchRetrieve_response)
4472 cret = handle_srw_response(c, sr->u.response);
4473 else if (sr->which == Z_SRW_scan_response)
4474 handle_srw_scan_response(c, sr->u.scan_response);
4478 else if (!ret && (soap_package->which == Z_SOAP_fault
4479 || soap_package->which == Z_SOAP_error))
4481 set_HTTP_error(c, hres->code,
4482 soap_package->u.fault->fault_code,
4483 soap_package->u.fault->fault_string);
4490 if (c->no_redirects) /* end of redirect. change hosts again */
4493 c->no_redirects = 0;
4497 if (hres->code != 200)
4498 set_HTTP_error(c, hres->code, 0, 0);
4500 set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
4503 if (cret == zoom_complete)
4505 yaz_log(YLOG_LOG, "removing tasks in handle_http");
4506 ZOOM_connection_remove_task(c);
4510 if (!strcmp(hres->version, "1.0"))
4512 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
4513 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
4518 /* HTTP 1.1: only if no close we stay alive.. */
4519 if (connection_head && !strcmp(connection_head, "close"))
4527 c->tasks->running = 0;
4528 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
4529 c->reconnect_ok = 0;
4536 static int do_read(ZOOM_connection c)
4541 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
4542 ZOOM_connection_put_event(c, event);
4544 r = cs_get(c->cs, &c->buf_in, &c->len_in);
4545 more = cs_more(c->cs);
4546 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
4551 if (!ZOOM_test_reconnect(c))
4553 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4562 odr_reset(c->odr_in);
4563 odr_setbuf(c->odr_in, c->buf_in, r, 0);
4564 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
4565 ZOOM_connection_put_event(c, event);
4567 if (!z_GDU(c->odr_in, &gdu, 0, 0))
4570 int err = odr_geterrorx(c->odr_in, &x);
4572 const char *element = odr_getelement(c->odr_in);
4573 yaz_snprintf(msg, sizeof(msg),
4574 "ODR code %d:%d element=%s offset=%d",
4575 err, x, element ? element : "<unknown>",
4576 odr_offset(c->odr_in));
4577 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
4580 FILE *ber_file = yaz_log_file();
4582 odr_dumpBER(ber_file, c->buf_in, r);
4589 z_GDU(c->odr_print, &gdu, 0, 0);
4590 if (gdu->which == Z_GDU_Z3950)
4591 recv_apdu(c, gdu->u.z3950);
4592 else if (gdu->which == Z_GDU_HTTP_Response)
4595 handle_http(c, gdu->u.HTTP_Response);
4597 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4602 c->reconnect_ok = 0;
4607 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
4612 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
4613 ZOOM_connection_put_event(c, event);
4615 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
4616 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
4618 yaz_log(log_details, "%p do_write_ex write failed", c);
4619 if (ZOOM_test_reconnect(c))
4621 return zoom_pending;
4623 if (c->state == STATE_CONNECTING)
4624 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4626 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4628 return zoom_complete;
4632 int mask = ZOOM_SELECT_EXCEPT;
4633 if (c->cs->io_pending & CS_WANT_WRITE)
4634 mask += ZOOM_SELECT_WRITE;
4635 if (c->cs->io_pending & CS_WANT_READ)
4636 mask += ZOOM_SELECT_READ;
4637 ZOOM_connection_set_mask(c, mask);
4638 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
4643 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
4644 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
4647 return zoom_pending;
4650 static zoom_ret do_write(ZOOM_connection c)
4652 return do_write_ex(c, c->buf_out, c->len_out);
4656 ZOOM_API(const char *)
4657 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
4659 return ZOOM_options_get(c->options, key);
4662 ZOOM_API(const char *)
4663 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
4665 return ZOOM_options_getl(c->options, key, lenp);
4669 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
4672 ZOOM_options_set(c->options, key, val);
4676 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
4677 const char *val, int len)
4679 ZOOM_options_setl(c->options, key, val, len);
4682 ZOOM_API(const char *)
4683 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
4685 return ZOOM_options_get(r->options, key);
4689 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
4692 ZOOM_options_set(r->options, key, val);
4697 ZOOM_connection_errcode(ZOOM_connection c)
4699 return ZOOM_connection_error(c, 0, 0);
4702 ZOOM_API(const char *)
4703 ZOOM_connection_errmsg(ZOOM_connection c)
4706 ZOOM_connection_error(c, &msg, 0);
4710 ZOOM_API(const char *)
4711 ZOOM_connection_addinfo(ZOOM_connection c)
4713 const char *addinfo;
4714 ZOOM_connection_error(c, 0, &addinfo);
4718 ZOOM_API(const char *)
4719 ZOOM_connection_diagset(ZOOM_connection c)
4721 const char *diagset;
4722 ZOOM_connection_error_x(c, 0, 0, &diagset);
4726 ZOOM_API(const char *)
4727 ZOOM_diag_str(int error)
4731 case ZOOM_ERROR_NONE:
4733 case ZOOM_ERROR_CONNECT:
4734 return "Connect failed";
4735 case ZOOM_ERROR_MEMORY:
4736 return "Out of memory";
4737 case ZOOM_ERROR_ENCODE:
4738 return "Encoding failed";
4739 case ZOOM_ERROR_DECODE:
4740 return "Decoding failed";
4741 case ZOOM_ERROR_CONNECTION_LOST:
4742 return "Connection lost";
4743 case ZOOM_ERROR_INIT:
4744 return "Init rejected";
4745 case ZOOM_ERROR_INTERNAL:
4746 return "Internal failure";
4747 case ZOOM_ERROR_TIMEOUT:
4749 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4750 return "Unsupported protocol";
4751 case ZOOM_ERROR_UNSUPPORTED_QUERY:
4752 return "Unsupported query type";
4753 case ZOOM_ERROR_INVALID_QUERY:
4754 return "Invalid query";
4755 case ZOOM_ERROR_CQL_PARSE:
4756 return "CQL parsing error";
4757 case ZOOM_ERROR_CQL_TRANSFORM:
4758 return "CQL transformation error";
4759 case ZOOM_ERROR_CCL_CONFIG:
4760 return "CCL configuration error";
4761 case ZOOM_ERROR_CCL_PARSE:
4762 return "CCL parsing error";
4764 return diagbib1_str(error);
4769 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4770 const char **addinfo, const char **diagset)
4772 int error = c->error;
4775 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4776 *cp = ZOOM_diag_str(error);
4777 else if (!strcmp(c->diagset, "HTTP"))
4778 *cp = z_HTTP_errmsg(c->error);
4779 else if (!strcmp(c->diagset, "Bib-1"))
4780 *cp = ZOOM_diag_str(error);
4781 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4782 *cp = yaz_diag_srw_str(c->error);
4784 *cp = "Unknown error and diagnostic set";
4787 *addinfo = c->addinfo ? c->addinfo : "";
4789 *diagset = c->diagset ? c->diagset : "";
4794 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4795 const char **addinfo)
4797 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4800 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4802 ZOOM_Event event = 0;
4803 int r = cs_look(c->cs);
4804 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4809 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4810 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4812 ZOOM_connection_put_event(c, event);
4814 else if (r == CS_CONNECT)
4816 int ret = ret = cs_rcvconnect(c->cs);
4817 yaz_log(log_details, "%p ZOOM_connection_do_io "
4818 "cs_rcvconnect returned %d", c, ret);
4821 int mask = ZOOM_SELECT_EXCEPT;
4822 if (c->cs->io_pending & CS_WANT_WRITE)
4823 mask += ZOOM_SELECT_WRITE;
4824 if (c->cs->io_pending & CS_WANT_READ)
4825 mask += ZOOM_SELECT_READ;
4826 ZOOM_connection_set_mask(c, mask);
4827 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
4828 ZOOM_connection_put_event(c, event);
4832 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4833 ZOOM_connection_put_event(c, event);
4835 if (c->proto == PROTO_Z3950)
4836 ZOOM_connection_send_init(c);
4839 /* no init request for SRW .. */
4840 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4841 ZOOM_connection_remove_task(c);
4842 ZOOM_connection_set_mask(c, 0);
4843 ZOOM_connection_exec_task(c);
4845 c->state = STATE_ESTABLISHED;
4849 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4855 if (mask & ZOOM_SELECT_EXCEPT)
4857 if (!ZOOM_test_reconnect(c))
4859 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4864 if (mask & ZOOM_SELECT_READ)
4866 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4872 ZOOM_connection_last_event(ZOOM_connection cs)
4875 return ZOOM_EVENT_NONE;
4876 return cs->last_event;
4880 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4882 WRBUF wrbuf = (WRBUF) client_data;
4883 wrbuf_puts(wrbuf, buf);
4887 * Returns an xmalloc()d string containing RPN that corresponds to the
4888 * CQL passed in. On error, sets the Connection object's error state
4889 * and returns a null pointer.
4890 * ### We could cache CQL parser and/or transformer in Connection.
4892 static char *cql2pqf(ZOOM_connection c, const char *cql)
4896 const char *cqlfile;
4897 cql_transform_t trans;
4900 parser = cql_parser_create();
4901 if ((error = cql_parser_string(parser, cql)) != 0) {
4902 cql_parser_destroy(parser);
4903 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4907 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4910 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4912 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4915 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4916 cqlfile, strerror(errno));
4917 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4921 WRBUF wrbuf_result = wrbuf_alloc();
4922 error = cql_transform(trans, cql_parser_result(parser),
4923 cql2pqf_wrbuf_puts, wrbuf_result);
4926 const char *addinfo;
4927 error = cql_transform_error(trans, &addinfo);
4928 sprintf(buf, "%.200s (addinfo=%.200s)",
4929 cql_strerror(error), addinfo);
4930 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4934 result = xstrdup(wrbuf_cstr(wrbuf_result));
4936 cql_transform_close(trans);
4937 wrbuf_destroy(wrbuf_result);
4939 cql_parser_destroy(parser);
4943 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4947 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4948 /* timeout and this connection was waiting */
4949 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4951 ZOOM_connection_put_event(c, event);
4957 ZOOM_connection_process(ZOOM_connection c)
4963 event = ZOOM_connection_get_event(c);
4966 ZOOM_Event_destroy(event);
4969 ZOOM_connection_exec_task(c);
4970 event = ZOOM_connection_get_event(c);
4973 ZOOM_Event_destroy(event);
4980 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4984 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4986 for (i = 0; i<no; i++)
4988 ZOOM_connection c = cs[i];
4990 if (c && ZOOM_connection_process(c))
4996 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4998 if (c->mask && mask)
4999 ZOOM_connection_do_io(c, mask);
5003 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
5006 return cs_fileno(c->cs);
5010 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
5018 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
5025 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
5027 return ZOOM_options_get_int(c->options, "timeout", 30);
5030 ZOOM_API(void) ZOOM_connection_close(ZOOM_connection c)
5038 * c-file-style: "Stroustrup"
5039 * indent-tabs-mode: nil
5041 * vim: shiftwidth=4 tabstop=8 expandtab