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;
914 yaz_mutex_create(&r->mutex);
917 WRBUF w = wrbuf_alloc();
918 YAZ_SHPTR_INIT(r->record_wrbuf, w);
924 ZOOM_API(ZOOM_resultset)
925 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
928 ZOOM_query s = ZOOM_query_create();
930 ZOOM_query_prefix(s, q);
932 r = ZOOM_connection_search(c, s);
933 ZOOM_query_destroy(s);
937 ZOOM_API(ZOOM_resultset)
938 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
940 ZOOM_resultset r = ZOOM_resultset_create();
944 const char *syntax, *elementSetName;
945 #if ZOOM_RESULT_LISTS
949 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
950 r->r_sort_spec = q->sort_spec;
953 r->options = ZOOM_options_create_with_parent(c->options);
955 start = ZOOM_options_get_int(r->options, "start", 0);
956 count = ZOOM_options_get_int(r->options, "count", 0);
958 /* If "presentChunk" is defined use that; otherwise "step" */
959 const char *cp = ZOOM_options_get(r->options, "presentChunk");
960 r->step = ZOOM_options_get_int(r->options,
961 (cp != 0 ? "presentChunk": "step"), 0);
963 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
964 cp = ZOOM_options_get(r->options, "setname");
966 r->setname = xstrdup(cp);
967 cp = ZOOM_options_get(r->options, "schema");
969 r->schema = xstrdup(cp);
971 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
976 #if ZOOM_RESULT_LISTS
977 yaz_log(log_details, "%p ZOOM_connection_search: Adding new resultset (%p) to resultsets (%p) ", c, r, c->resultsets);
978 set = xmalloc(sizeof(*set));
979 ZOOM_resultset_addref(r);
981 set->next = c->resultsets;
984 r->next = c->resultsets;
987 if (c->host_port && c->proto == PROTO_HTTP)
991 yaz_log(log_details, "ZOOM_connection_search: no comstack");
992 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
996 yaz_log(log_details, "ZOOM_connection_search: reconnect");
1001 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
1002 task->u.search.resultset = r;
1003 task->u.search.start = start;
1004 task->u.search.count = count;
1005 task->u.search.recv_search_fired = 0;
1007 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1008 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
1009 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1010 task->u.search.elementSetName = elementSetName
1011 ? xstrdup(elementSetName) : 0;
1013 ZOOM_resultset_addref(r);
1019 while (ZOOM_event(1, &c))
1026 ZOOM_resultset_sort(ZOOM_resultset r,
1027 const char *sort_type, const char *sort_spec)
1029 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
1033 ZOOM_resultset_sort1(ZOOM_resultset r,
1034 const char *sort_type, const char *sort_spec)
1036 ZOOM_connection c = r->connection;
1040 newq = ZOOM_query_create();
1041 if (ZOOM_query_sortby(newq, sort_spec) < 0)
1044 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
1045 r, r, sort_type, sort_spec);
1049 if (c->host_port && c->proto == PROTO_HTTP)
1053 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
1054 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1058 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
1060 c->reconnect_ok = 1;
1064 ZOOM_resultset_cache_reset(r);
1065 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
1066 task->u.sort.resultset = r;
1067 task->u.sort.q = newq;
1069 ZOOM_resultset_addref(r);
1073 while (ZOOM_event(1, &c))
1080 static void ZOOM_record_release(ZOOM_record rec)
1086 if (rec->record_wrbuf)
1087 YAZ_SHPTR_DEC(rec->record_wrbuf, wrbuf_destroy);
1090 wrbuf_destroy(rec->wrbuf);
1094 odr_destroy(rec->odr);
1098 ZOOM_resultset_cache_reset(ZOOM_resultset r)
1101 for (i = 0; i<RECORD_HASH_SIZE; i++)
1103 ZOOM_record_cache rc;
1104 for (rc = r->record_hash[i]; rc; rc = rc->next)
1106 ZOOM_record_release(&rc->rec);
1108 r->record_hash[i] = 0;
1113 ZOOM_resultset_destroy(ZOOM_resultset r)
1115 resultset_destroy(r);
1118 static void resultset_destroy(ZOOM_resultset r)
1122 yaz_mutex_enter(r->mutex);
1124 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
1126 if (r->refcount == 0)
1128 yaz_mutex_leave(r->mutex);
1130 yaz_log(log_details, "%p ZOOM_connection resultset_destroy: Deleting resultset (%p) ", r->connection, r);
1131 ZOOM_resultset_cache_reset(r);
1132 ZOOM_resultset_release(r);
1133 ZOOM_query_destroy(r->query);
1134 ZOOM_options_destroy(r->options);
1135 odr_destroy(r->odr);
1138 yaz_mutex_destroy(&r->mutex);
1140 YAZ_SHPTR_DEC(r->record_wrbuf, wrbuf_destroy);
1145 yaz_mutex_leave(r->mutex);
1149 ZOOM_resultset_size(ZOOM_resultset r)
1151 yaz_log(log_details, "ZOOM_resultset_size r=%p count=" ODR_INT_PRINTF,
1156 static void do_close(ZOOM_connection c)
1161 ZOOM_connection_set_mask(c, 0);
1162 c->state = STATE_IDLE;
1165 static int ZOOM_test_reconnect(ZOOM_connection c)
1169 if (!c->reconnect_ok)
1172 c->reconnect_ok = 0;
1173 c->tasks->running = 0;
1174 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
1176 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1177 ZOOM_connection_put_event(c, event);
1182 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
1183 int force_sync, int start, int count)
1188 const char *syntax, *elementSetName;
1192 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1193 " count=%d", r, force_sync, start, count);
1198 if (c->host_port && c->proto == PROTO_HTTP)
1202 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1203 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1207 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1209 c->reconnect_ok = 1;
1212 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1213 task->u.retrieve.resultset = r;
1214 task->u.retrieve.start = start;
1215 task->u.retrieve.count = count;
1217 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1218 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1219 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1220 task->u.retrieve.elementSetName = elementSetName
1221 ? xstrdup(elementSetName) : 0;
1223 cp = ZOOM_options_get(r->options, "schema");
1226 if (!r->schema || strcmp(r->schema, cp))
1229 r->schema = xstrdup(cp);
1233 ZOOM_resultset_addref(r);
1235 if (!r->connection->async || force_sync)
1236 while (r->connection && ZOOM_event(1, &r->connection))
1241 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1242 size_t start, size_t count)
1244 int force_present = 0;
1248 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1249 r, r, (long) start, (long) count);
1252 ZOOM_resultset_retrieve(r, force_present, start, count);
1256 for (i = 0; i< count; i++)
1257 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1262 ZOOM_resultset_facets_size(ZOOM_resultset r) {
1263 return r->num_facets;
1266 ZOOM_API(ZOOM_facet_field)
1267 ZOOM_resultset_get_facet_field(ZOOM_resultset r, const char *name) {
1268 int num = r->num_facets;
1269 ZOOM_facet_field *facets = r->facets;
1271 for (index = 0; index < num; index++) {
1272 if (!strcmp(facets[index]->facet_name, name)) {
1273 return facets[index];
1280 ZOOM_API(ZOOM_facet_field *)
1281 ZOOM_resultset_facets(ZOOM_resultset r)
1286 ZOOM_API(const char**)
1287 ZOOM_resultset_facet_names(ZOOM_resultset r)
1289 return (const char **) r->facets_names;
1292 ZOOM_API(const char*)
1293 ZOOM_facet_field_name(ZOOM_facet_field field)
1295 return field->facet_name;
1299 ZOOM_facet_field_term_count(ZOOM_facet_field field)
1301 return field->num_terms;
1304 ZOOM_API(const char*)
1305 ZOOM_facet_field_get_term(ZOOM_facet_field field, size_t idx, int *freq) {
1306 *freq = field->facet_terms[idx].frequency;
1307 return field->facet_terms[idx].term;
1311 static void get_cert(ZOOM_connection c)
1316 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1318 ZOOM_connection_option_setl(c, "sslPeerCert",
1319 cert_buf, cert_len);
1324 static zoom_ret do_connect_host(ZOOM_connection c,
1325 const char *effective_host,
1326 const char *logical_url);
1328 static zoom_ret do_connect(ZOOM_connection c)
1330 const char *effective_host;
1333 effective_host = c->proxy;
1335 effective_host = c->host_port;
1336 return do_connect_host(c, effective_host, c->host_port);
1339 static zoom_ret do_connect_host(ZOOM_connection c, const char *effective_host,
1340 const char *logical_url)
1344 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1348 c->cs = cs_create_host(effective_host, 0, &add);
1350 if (c->cs && c->cs->protocol == PROTO_HTTP)
1357 c->proto = PROTO_HTTP;
1358 cs_get_host_args(logical_url, &db);
1361 c->path = xmalloc(strlen(db) * 3 + 2);
1362 yaz_encode_sru_dbpath_buf(c->path, db);
1365 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1367 return zoom_complete;
1372 int ret = cs_connect(c->cs, add);
1375 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1376 ZOOM_connection_put_event(c, event);
1378 if (c->proto == PROTO_Z3950)
1379 ZOOM_connection_send_init(c);
1382 /* no init request for SRW .. */
1383 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1384 ZOOM_connection_remove_task(c);
1385 ZOOM_connection_set_mask(c, 0);
1386 ZOOM_connection_exec_task(c);
1388 c->state = STATE_ESTABLISHED;
1389 return zoom_pending;
1393 int mask = ZOOM_SELECT_EXCEPT;
1394 if (c->cs->io_pending & CS_WANT_WRITE)
1395 mask += ZOOM_SELECT_WRITE;
1396 if (c->cs->io_pending & CS_WANT_READ)
1397 mask += ZOOM_SELECT_READ;
1398 ZOOM_connection_set_mask(c, mask);
1399 c->state = STATE_CONNECTING;
1400 return zoom_pending;
1403 c->state = STATE_IDLE;
1404 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, logical_url);
1405 return zoom_complete;
1408 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1411 for (i = 0; i<200; i++)
1415 Z_OtherInformation **oi;
1420 sprintf(buf, "otherInfo%d", i);
1421 val = ZOOM_options_get(c->options, buf);
1424 cp = strchr(val, ':');
1428 if (len >= sizeof(buf))
1429 len = sizeof(buf)-1;
1430 memcpy(buf, val, len);
1433 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
1438 yaz_oi_APDU(a, &oi);
1439 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
1443 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1448 Z_OtherInformation **oi;
1449 yaz_oi_APDU(a, &oi);
1450 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
1455 Z_OtherInformation **oi;
1456 yaz_oi_APDU(a, &oi);
1457 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
1460 otherInfo_attach(c, a, out);
1461 if (!z_APDU(out, &a, 0, 0))
1463 FILE *outf = fopen("/tmp/apdu.txt", "a");
1466 ODR odr_pr = odr_createmem(ODR_PRINT);
1467 fprintf(outf, "a=%p\n", a);
1468 odr_setprint(odr_pr, outf);
1469 z_APDU(odr_pr, &a, 0, 0);
1470 odr_destroy(odr_pr);
1472 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1473 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1478 z_APDU(c->odr_print, &a, 0, 0);
1479 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1483 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1487 if (encode_APDU(c, a, c->odr_out))
1488 return zoom_complete;
1489 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1490 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1491 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1492 ZOOM_connection_put_event(c, event);
1493 odr_reset(c->odr_out);
1497 /* returns 1 if PDU was sent OK (still pending )
1498 0 if PDU was not sent OK (nothing to wait for)
1501 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1503 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1504 Z_InitRequest *ireq = apdu->u.initRequest;
1505 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1506 odr_malloc(c->odr_out, sizeof(*auth));
1508 ODR_MASK_SET(ireq->options, Z_Options_search);
1509 ODR_MASK_SET(ireq->options, Z_Options_present);
1510 ODR_MASK_SET(ireq->options, Z_Options_scan);
1511 ODR_MASK_SET(ireq->options, Z_Options_sort);
1512 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1513 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1515 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1516 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1517 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1519 ireq->implementationId =
1520 odr_prepend(c->odr_out,
1521 ZOOM_options_get(c->options, "implementationId"),
1522 ireq->implementationId);
1524 ireq->implementationName =
1525 odr_prepend(c->odr_out,
1526 ZOOM_options_get(c->options, "implementationName"),
1527 odr_prepend(c->odr_out, "ZOOM-C",
1528 ireq->implementationName));
1530 ireq->implementationVersion =
1531 odr_prepend(c->odr_out,
1532 ZOOM_options_get(c->options, "implementationVersion"),
1533 ireq->implementationVersion);
1535 *ireq->maximumRecordSize = c->maximum_record_size;
1536 *ireq->preferredMessageSize = c->preferred_message_size;
1538 if (c->group || c->password)
1540 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1541 pass->groupId = odr_strdup_null(c->odr_out, c->group);
1542 pass->userId = odr_strdup_null(c->odr_out, c->user);
1543 pass->password = odr_strdup_null(c->odr_out, c->password);
1544 auth->which = Z_IdAuthentication_idPass;
1545 auth->u.idPass = pass;
1546 ireq->idAuthentication = auth;
1550 auth->which = Z_IdAuthentication_open;
1551 auth->u.open = odr_strdup(c->odr_out, c->user);
1552 ireq->idAuthentication = auth;
1556 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
1557 yaz_oid_userinfo_proxy, 1, c->host_port);
1559 if (c->charset || c->lang)
1561 Z_OtherInformation **oi;
1562 Z_OtherInformationUnit *oi_unit;
1564 yaz_oi_APDU(apdu, &oi);
1566 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1568 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1569 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1570 oi_unit->information.externallyDefinedInfo =
1571 yaz_set_proposal_charneg_list(c->odr_out, " ",
1572 c->charset, c->lang, 1);
1576 return send_APDU(c, apdu);
1580 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1584 const char *database = ZOOM_options_get(c->options, "databaseName");
1585 char *fdatabase = 0;
1588 fdatabase = yaz_encode_sru_dbpath_odr(c->odr_out, database);
1589 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port,
1590 fdatabase ? fdatabase : c->path);
1592 if (c->sru_mode == zoom_sru_get)
1594 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1596 else if (c->sru_mode == zoom_sru_post)
1598 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1600 else if (c->sru_mode == zoom_sru_soap)
1602 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1604 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1605 return zoom_complete;
1607 z_GDU(c->odr_print, &gdu, 0, 0);
1608 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1610 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1611 ZOOM_connection_put_event(c, event);
1612 odr_reset(c->odr_out);
1618 static Z_SRW_PDU *ZOOM_srw_get_pdu(ZOOM_connection c, int type)
1620 Z_SRW_PDU *sr = yaz_srw_get_pdu(c->odr_out, type, c->sru_version);
1621 sr->username = c->user;
1622 sr->password = c->password;
1628 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1632 ZOOM_resultset resultset = 0;
1634 const char *option_val = 0;
1636 if (c->error) /* don't continue on error */
1637 return zoom_complete;
1639 switch(c->tasks->which)
1641 case ZOOM_TASK_SEARCH:
1642 resultset = c->tasks->u.search.resultset;
1643 if (!resultset->setname)
1644 resultset->setname = xstrdup("default");
1645 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1646 start = &c->tasks->u.search.start;
1647 count = &c->tasks->u.search.count;
1649 case ZOOM_TASK_RETRIEVE:
1650 resultset = c->tasks->u.retrieve.resultset;
1652 start = &c->tasks->u.retrieve.start;
1653 count = &c->tasks->u.retrieve.count;
1655 if (*start >= resultset->size)
1656 return zoom_complete;
1657 if (*start + *count > resultset->size)
1658 *count = resultset->size - *start;
1660 for (i = 0; i < *count; i++)
1663 record_cache_lookup(resultset, i + *start,
1664 c->tasks->u.retrieve.syntax,
1665 c->tasks->u.retrieve.elementSetName);
1670 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1671 ZOOM_connection_put_event(c, event);
1678 return zoom_complete;
1681 return zoom_complete;
1683 assert(resultset->query);
1685 sr = ZOOM_srw_get_pdu(c, Z_SRW_searchRetrieve_request);
1686 if (resultset->query->z_query->which == Z_Query_type_104
1687 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1689 sr->u.request->query_type = Z_SRW_query_type_cql;
1690 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1692 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1693 resultset->query->z_query->u.type_1)
1695 sr->u.request->query_type = Z_SRW_query_type_pqf;
1696 sr->u.request->query.pqf = resultset->query->query_string;
1700 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1701 return zoom_complete;
1703 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1704 sr->u.request->maximumRecords = odr_intdup(
1705 c->odr_out, (resultset->step > 0 && resultset->step < *count) ?
1706 resultset->step : *count);
1707 sr->u.request->recordSchema = resultset->schema;
1709 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1711 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1713 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1714 yaz_encode_sru_extra(sr, c->odr_out, option_val);
1715 return send_srw(c, sr);
1718 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1720 return zoom_complete;
1724 static zoom_ret ZOOM_connection_Z3950_send_search(ZOOM_connection c)
1727 int lslb, ssub, mspn;
1729 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1730 Z_SearchRequest *search_req = apdu->u.searchRequest;
1731 const char *elementSetName;
1732 const char *smallSetElementSetName;
1733 const char *mediumSetElementSetName;
1737 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1739 r = c->tasks->u.search.resultset;
1741 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1744 ZOOM_options_get(r->options, "elementSetName");
1745 smallSetElementSetName =
1746 ZOOM_options_get(r->options, "smallSetElementSetName");
1747 mediumSetElementSetName =
1748 ZOOM_options_get(r->options, "mediumSetElementSetName");
1750 if (!smallSetElementSetName)
1751 smallSetElementSetName = elementSetName;
1753 if (!mediumSetElementSetName)
1754 mediumSetElementSetName = elementSetName;
1756 facets = ZOOM_options_get(r->options, "facets");
1758 Z_FacetList *facet_list = yaz_pqf_parse_facet_list(c->odr_out, facets);
1760 Z_OtherInformation **oi;
1761 yaz_oi_APDU(apdu, &oi);
1763 yaz_oi_set_facetlist(oi, c->odr_out, facet_list);
1771 /* prepare query for the search request */
1772 search_req->query = r->query->z_query;
1773 if (!search_req->query)
1775 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1776 return zoom_complete;
1778 if (r->query->z_query->which == Z_Query_type_1 ||
1779 r->query->z_query->which == Z_Query_type_101)
1781 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
1784 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
1788 search_req->query = yaz_copy_Z_Query(search_req->query,
1791 r = yaz_query_charset_convert_rpnquery_check(
1792 search_req->query->u.type_1,
1794 yaz_iconv_close(cd);
1796 { /* query could not be char converted */
1797 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1798 return zoom_complete;
1803 search_req->databaseNames = r->databaseNames;
1804 search_req->num_databaseNames = r->num_databaseNames;
1806 /* get syntax (no need to provide unless piggyback is in effect) */
1807 syntax = c->tasks->u.search.syntax;
1809 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1810 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1811 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1812 if (lslb != -1 && ssub != -1 && mspn != -1)
1814 /* So're a Z39.50 expert? Let's hope you don't do sort */
1815 *search_req->largeSetLowerBound = lslb;
1816 *search_req->smallSetUpperBound = ssub;
1817 *search_req->mediumSetPresentNumber = mspn;
1819 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1820 && r->piggyback && !r->r_sort_spec && !r->schema)
1822 /* Regular piggyback - do it unless we're going to do sort */
1823 *search_req->largeSetLowerBound = 2000000000;
1824 *search_req->smallSetUpperBound = 1;
1825 *search_req->mediumSetPresentNumber =
1826 r->step>0 ? r->step : c->tasks->u.search.count;
1830 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1831 smallSetElementSetName = 0;
1832 mediumSetElementSetName = 0;
1835 if (smallSetElementSetName && *smallSetElementSetName)
1837 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1838 odr_malloc(c->odr_out, sizeof(*esn));
1840 esn->which = Z_ElementSetNames_generic;
1841 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1842 search_req->smallSetElementSetNames = esn;
1844 if (mediumSetElementSetName && *mediumSetElementSetName)
1846 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1847 odr_malloc(c->odr_out, sizeof(*esn));
1849 esn->which = Z_ElementSetNames_generic;
1850 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1851 search_req->mediumSetElementSetNames = esn;
1854 search_req->preferredRecordSyntax =
1855 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1859 if (c->support_named_resultsets)
1863 /* find the lowest unused ordinal so that we re-use
1864 result sets on the server. */
1865 for (ord = 1; ; ord++)
1867 #if ZOOM_RESULT_LISTS
1868 ZOOM_resultsets rsp;
1869 sprintf(setname, "%d", ord);
1870 for (rsp = c->resultsets; rsp; rsp = rsp->next)
1871 if (rsp->resultset->setname && !strcmp(rsp->resultset->setname, setname))
1877 sprintf(setname, "%d", ord);
1878 for (rp = c->resultsets; rp; rp = rp->next)
1879 if (rp->setname && !strcmp(rp->setname, setname))
1886 r->setname = xstrdup(setname);
1887 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1888 "set %s", c, r->setname);
1892 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1894 r->setname = xstrdup("default");
1896 ZOOM_options_set(r->options, "setname", r->setname);
1898 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1899 return send_APDU(c, apdu);
1902 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1904 char oid_name_buf[OID_STR_MAX];
1905 const char *oid_name;
1908 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
1911 case Z_DefaultDiagFormat_v2Addinfo:
1912 addinfo = r->u.v2Addinfo;
1914 case Z_DefaultDiagFormat_v3Addinfo:
1915 addinfo = r->u.v3Addinfo;
1920 set_dset_error(c, *r->condition, oid_name, addinfo, 0);
1923 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1925 if (p->which != Z_DiagRec_defaultFormat)
1926 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1928 response_default_diag(c, p->u.defaultFormat);
1931 ZOOM_API(ZOOM_record)
1932 ZOOM_record_clone(ZOOM_record srec)
1939 odr_enc = odr_createmem(ODR_ENCODE);
1940 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1942 buf = odr_getbuf(odr_enc, &size, 0);
1944 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1945 yaz_log(log_details, "ZOOM_record create");
1946 nrec->odr = odr_createmem(ODR_DECODE);
1948 nrec->record_wrbuf = 0;
1952 odr_setbuf(nrec->odr, buf, size, 0);
1953 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1955 nrec->schema = odr_strdup_null(nrec->odr, srec->schema);
1956 nrec->diag_uri = odr_strdup_null(nrec->odr, srec->diag_uri);
1957 nrec->diag_message = odr_strdup_null(nrec->odr, srec->diag_message);
1958 nrec->diag_details = odr_strdup_null(nrec->odr, srec->diag_details);
1959 nrec->diag_set = odr_strdup_null(nrec->odr, srec->diag_set);
1960 odr_destroy(odr_enc);
1964 ZOOM_API(ZOOM_record)
1965 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1967 const char *syntax =
1968 ZOOM_options_get(s->options, "preferredRecordSyntax");
1969 const char *elementSetName =
1970 ZOOM_options_get(s->options, "elementSetName");
1972 return record_cache_lookup(s, pos, syntax, elementSetName);
1975 ZOOM_API(ZOOM_record)
1976 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1978 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1983 * MIKE: I think force_sync should always be zero, but I don't
1984 * want to make this change until I get the go-ahead from
1985 * Adam, in case something depends on the old synchronous
1989 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1990 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1991 rec = ZOOM_resultset_record_immediate(r, pos);
1997 ZOOM_record_destroy(ZOOM_record rec)
1999 ZOOM_record_release(rec);
2000 yaz_log(log_details, "ZOOM_record destroy");
2005 static yaz_iconv_t iconv_create_charset(const char *record_charset)
2012 strcpy(to, "UTF-8");
2013 if (record_charset && *record_charset)
2015 /* Use "from,to" or just "from" */
2016 const char *cp = strchr(record_charset, ',');
2017 size_t clen = strlen(record_charset);
2020 strncpy( to, cp+1, sizeof(to)-1);
2021 to[sizeof(to)-1] = '\0';
2022 clen = cp - record_charset;
2024 if (clen > sizeof(from)-1)
2025 clen = sizeof(from)-1;
2028 strncpy(from, record_charset, clen);
2032 cd = yaz_iconv_open(to, from);
2036 static const char *return_marc_record(WRBUF wrbuf,
2039 const char *buf, int sz,
2040 const char *record_charset)
2042 yaz_iconv_t cd = iconv_create_charset(record_charset);
2043 yaz_marc_t mt = yaz_marc_create();
2044 const char *ret_string = 0;
2047 yaz_marc_iconv(mt, cd);
2048 yaz_marc_xml(mt, marc_type);
2049 if (yaz_marc_decode_wrbuf(mt, buf, sz, wrbuf) > 0)
2052 *len = wrbuf_len(wrbuf);
2053 ret_string = wrbuf_cstr(wrbuf);
2055 yaz_marc_destroy(mt);
2057 yaz_iconv_close(cd);
2061 static const char *return_opac_record(WRBUF wrbuf,
2064 Z_OPACRecord *opac_rec,
2065 const char *record_charset)
2067 yaz_iconv_t cd = iconv_create_charset(record_charset);
2068 yaz_marc_t mt = yaz_marc_create();
2071 yaz_marc_iconv(mt, cd);
2072 yaz_marc_xml(mt, marc_type);
2074 yaz_opac_decode_wrbuf(mt, opac_rec, wrbuf);
2075 yaz_marc_destroy(mt);
2078 yaz_iconv_close(cd);
2080 *len = wrbuf_len(wrbuf);
2081 return wrbuf_cstr(wrbuf);
2084 static const char *return_string_record(WRBUF wrbuf,
2086 const char *buf, int sz,
2087 const char *record_charset)
2089 yaz_iconv_t cd = iconv_create_charset(record_charset);
2093 wrbuf_iconv_write(wrbuf, cd, buf, sz);
2094 wrbuf_iconv_reset(wrbuf, cd);
2096 buf = wrbuf_cstr(wrbuf);
2097 sz = wrbuf_len(wrbuf);
2098 yaz_iconv_close(cd);
2105 static const char *return_record_wrbuf(WRBUF wrbuf, int *len,
2106 Z_NamePlusRecord *npr,
2107 int marctype, const char *charset)
2109 Z_External *r = (Z_External *) npr->u.databaseRecord;
2110 const Odr_oid *oid = r->direct_reference;
2112 wrbuf_rewind(wrbuf);
2113 /* render bibliographic record .. */
2114 if (r->which == Z_External_OPAC)
2116 return return_opac_record(wrbuf, marctype, len,
2117 r->u.opac, charset);
2119 if (r->which == Z_External_sutrs)
2120 return return_string_record(wrbuf, len,
2121 (char*) r->u.sutrs->buf,
2124 else if (r->which == Z_External_octet)
2126 if (yaz_oid_is_iso2709(oid))
2128 const char *ret_buf = return_marc_record(
2129 wrbuf, marctype, len,
2130 (const char *) r->u.octet_aligned->buf,
2131 r->u.octet_aligned->len,
2135 /* bad ISO2709. Return fail unless raw (ISO2709) is wanted */
2136 if (marctype != YAZ_MARC_ISO2709)
2139 return return_string_record(wrbuf, len,
2140 (const char *) r->u.octet_aligned->buf,
2141 r->u.octet_aligned->len,
2144 else if (r->which == Z_External_grs1)
2146 yaz_display_grs1(wrbuf, r->u.grs1, 0);
2147 return return_string_record(wrbuf, len,
2156 ZOOM_record_error(ZOOM_record rec, const char **cp,
2157 const char **addinfo, const char **diagset)
2159 Z_NamePlusRecord *npr;
2168 *cp = rec->diag_message;
2170 *addinfo = rec->diag_details;
2172 *diagset = rec->diag_set;
2173 return uri_to_code(rec->diag_uri);
2175 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
2177 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
2178 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
2179 const char *add = 0;
2181 if (diag_rec->which == Z_DiagRec_defaultFormat)
2183 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
2186 error = *ddf->condition;
2189 case Z_DefaultDiagFormat_v2Addinfo:
2190 add = ddf->u.v2Addinfo;
2192 case Z_DefaultDiagFormat_v3Addinfo:
2193 add = ddf->u.v3Addinfo;
2198 yaz_oid_to_string(yaz_oid_std(),
2199 ddf->diagnosticSetId, &oclass);
2207 *addinfo = add ? add : "";
2209 *cp = diagbib1_str(error);
2215 static const char *get_record_format(WRBUF wrbuf, int *len,
2216 Z_NamePlusRecord *npr,
2217 int marctype, const char *charset,
2220 const char *res = return_record_wrbuf(wrbuf, len, npr, marctype, charset);
2222 if (*format == '1' && len)
2224 /* try to XML format res */
2226 xmlKeepBlanksDefault(0); /* get get xmlDocFormatMemory to work! */
2227 doc = xmlParseMemory(res, *len);
2232 xmlDocDumpFormatMemory(doc, &xml_mem, &xml_size, 1);
2233 wrbuf_rewind(wrbuf);
2234 wrbuf_write(wrbuf, (const char *) xml_mem, xml_size);
2237 res = wrbuf_cstr(wrbuf);
2238 *len = wrbuf_len(wrbuf);
2246 static const char *npr_format(Z_NamePlusRecord *npr, const char *schema,
2248 const char *type_spec, int *len)
2254 const char *cp = type_spec;
2256 for (i = 0; cp[i] && cp[i] != ';' && cp[i] != ' ' && i < sizeof(type)-1;
2264 while (cp[i] == ' ')
2269 while (cp[i] == ' ')
2271 if (!strncmp(cp + i, "charset=", 8))
2274 i = i + 8; /* skip charset= */
2275 for (j = 0; cp[i] && cp[i] != ';' && cp[i] != ' '; i++)
2277 if (j < sizeof(charset)-1)
2278 charset[j++] = cp[i];
2282 else if (!strncmp(cp + i, "format=", 7))
2286 for (j = 0; cp[i] && cp[i] != ';' && cp[i] != ' '; i++)
2288 if (j < sizeof(format)-1)
2289 format[j++] = cp[i];
2294 if (!strcmp(type, "database"))
2297 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
2298 return npr->databaseName;
2300 else if (!strcmp(type, "schema"))
2303 *len = schema ? strlen(schema) : 0;
2306 else if (!strcmp(type, "syntax"))
2308 const char *desc = 0;
2309 if (npr->which == Z_NamePlusRecord_databaseRecord)
2311 Z_External *r = (Z_External *) npr->u.databaseRecord;
2312 desc = yaz_oid_to_string(yaz_oid_std(), r->direct_reference, 0);
2317 *len = strlen(desc);
2320 if (npr->which != Z_NamePlusRecord_databaseRecord)
2323 /* from now on - we have a database record .. */
2324 if (!strcmp(type, "render"))
2326 return get_record_format(wrbuf, len, npr, YAZ_MARC_LINE, charset, format);
2328 else if (!strcmp(type, "xml"))
2330 return get_record_format(wrbuf, len, npr, YAZ_MARC_MARCXML, charset,
2333 else if (!strcmp(type, "txml"))
2335 return get_record_format(wrbuf, len, npr, YAZ_MARC_TURBOMARC, charset,
2338 else if (!strcmp(type, "raw"))
2340 return get_record_format(wrbuf, len, npr, YAZ_MARC_ISO2709, charset,
2343 else if (!strcmp(type, "ext"))
2346 return (const char *) npr->u.databaseRecord;
2348 else if (!strcmp(type, "opac"))
2350 if (npr->u.databaseRecord->which == Z_External_OPAC)
2351 return get_record_format(wrbuf, len, npr, YAZ_MARC_MARCXML, charset,
2357 ZOOM_API(const char *)
2358 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
2363 *len = 0; /* default return */
2365 if (!rec || !rec->npr)
2369 if (!rec->record_wrbuf)
2371 WRBUF w = wrbuf_alloc();
2372 YAZ_SHPTR_INIT(rec->record_wrbuf, w);
2374 wrbuf = rec->record_wrbuf->ptr;
2377 rec->wrbuf = wrbuf_alloc();
2380 return npr_format(rec->npr, rec->schema, wrbuf, type_spec, len);
2383 static int strcmp_null(const char *v1, const char *v2)
2389 return strcmp(v1, v2);
2392 static size_t record_hash(int pos)
2396 return pos % RECORD_HASH_SIZE;
2399 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2401 const char *syntax, const char *elementSetName,
2403 Z_SRW_diagnostic *diag)
2405 ZOOM_record_cache rc = 0;
2407 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2408 ZOOM_connection_put_event(r->connection, event);
2410 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2413 && strcmp_null(r->schema, rc->schema) == 0
2414 && strcmp_null(elementSetName,rc->elementSetName) == 0
2415 && strcmp_null(syntax, rc->syntax) == 0)
2420 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2423 YAZ_SHPTR_INC(r->record_wrbuf);
2424 rc->rec.record_wrbuf = r->record_wrbuf;
2428 rc->elementSetName = odr_strdup_null(r->odr, elementSetName);
2430 rc->syntax = odr_strdup_null(r->odr, syntax);
2432 rc->schema = odr_strdup_null(r->odr, r->schema);
2435 rc->next = r->record_hash[record_hash(pos)];
2436 r->record_hash[record_hash(pos)] = rc;
2439 rc->rec.schema = odr_strdup_null(r->odr, schema);
2440 rc->rec.diag_set = 0;
2441 rc->rec.diag_uri = 0;
2442 rc->rec.diag_message = 0;
2443 rc->rec.diag_details = 0;
2449 rc->rec.diag_set = odr_strdup(r->odr, diag->uri);
2450 if ((cp = strrchr(rc->rec.diag_set, '/')))
2452 rc->rec.diag_uri = odr_strdup(r->odr, diag->uri);
2454 rc->rec.diag_message = odr_strdup_null(r->odr, diag->message);
2455 rc->rec.diag_details = odr_strdup_null(r->odr, diag->details);
2459 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2461 const char *elementSetName)
2463 ZOOM_record_cache rc;
2465 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2469 if (strcmp_null(r->schema, rc->schema))
2471 if (strcmp_null(elementSetName,rc->elementSetName))
2473 if (strcmp_null(syntax, rc->syntax))
2481 static void handle_Z3950_records(ZOOM_connection c, Z_Records *sr,
2484 ZOOM_resultset resultset;
2486 const char *syntax = 0, *elementSetName = 0;
2490 switch (c->tasks->which)
2492 case ZOOM_TASK_SEARCH:
2493 resultset = c->tasks->u.search.resultset;
2494 start = &c->tasks->u.search.start;
2495 count = &c->tasks->u.search.count;
2496 syntax = c->tasks->u.search.syntax;
2497 elementSetName = c->tasks->u.search.elementSetName;
2499 case ZOOM_TASK_RETRIEVE:
2500 resultset = c->tasks->u.retrieve.resultset;
2501 start = &c->tasks->u.retrieve.start;
2502 count = &c->tasks->u.retrieve.count;
2503 syntax = c->tasks->u.retrieve.syntax;
2504 elementSetName = c->tasks->u.retrieve.elementSetName;
2509 if (sr && sr->which == Z_Records_NSD)
2510 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2511 else if (sr && sr->which == Z_Records_multipleNSD)
2513 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2514 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2516 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2520 if (*count + *start > resultset->size)
2521 *count = resultset->size - *start;
2524 if (sr && sr->which == Z_Records_DBOSD)
2527 NMEM nmem = odr_extract_mem(c->odr_in);
2528 Z_NamePlusRecordList *p =
2529 sr->u.databaseOrSurDiagnostics;
2530 for (i = 0; i<p->num_records; i++)
2532 record_cache_add(resultset, p->records[i], i + *start,
2533 syntax, elementSetName,
2540 yaz_log(log_details,
2541 "handle_records resultset=%p start=%d count=%d",
2542 resultset, *start, *count);
2544 /* transfer our response to search_nmem .. we need it later */
2545 nmem_transfer(odr_getmem(resultset->odr), nmem);
2547 if (present_phase && p->num_records == 0)
2549 /* present response and we didn't get any records! */
2550 Z_NamePlusRecord *myrec =
2551 zget_surrogateDiagRec(
2553 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
2554 "ZOOM C generated. Present phase and no records");
2555 record_cache_add(resultset, myrec, *start,
2556 syntax, elementSetName, 0, 0);
2559 else if (present_phase)
2561 /* present response and we didn't get any records! */
2562 Z_NamePlusRecord *myrec =
2563 zget_surrogateDiagRec(
2565 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
2566 "ZOOM C generated: Present response and no records");
2567 record_cache_add(resultset, myrec, *start, syntax, elementSetName,
2573 static void handle_Z3950_present_response(ZOOM_connection c,
2574 Z_PresentResponse *pr)
2576 handle_Z3950_records(c, pr->records, 1);
2579 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2582 switch (term->which)
2584 case Z_Term_general:
2585 ZOOM_options_setl(opt, name,
2586 (const char *)(term->u.general->buf),
2587 term->u.general->len);
2589 case Z_Term_characterString:
2590 ZOOM_options_set(opt, name, term->u.characterString);
2592 case Z_Term_numeric:
2593 ZOOM_options_set_int(opt, name, *term->u.numeric);
2598 static void handle_queryExpression(ZOOM_options opt, const char *name,
2599 Z_QueryExpression *exp)
2605 case Z_QueryExpression_term:
2606 if (exp->u.term && exp->u.term->queryTerm)
2608 sprintf(opt_name, "%s.term", name);
2609 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2612 case Z_QueryExpression_query:
2617 static void handle_search_result(ZOOM_connection c, ZOOM_resultset resultset,
2618 Z_OtherInformation *o)
2621 for (i = 0; o && i < o->num_elements; i++)
2623 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2625 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2627 if (ext->which == Z_External_searchResult1)
2630 Z_SearchInfoReport *sr = ext->u.searchResult1;
2633 ZOOM_options_set_int(
2634 resultset->options, "searchresult.size", sr->num);
2636 for (j = 0; j < sr->num; j++)
2638 Z_SearchInfoReport_s *ent =
2639 ext->u.searchResult1->elements[j];
2642 sprintf(pref, "searchresult.%d", j);
2644 if (ent->subqueryId)
2647 sprintf(opt_name, "%s.id", pref);
2648 ZOOM_options_set(resultset->options, opt_name,
2651 if (ent->subqueryExpression)
2654 sprintf(opt_name, "%s.subquery", pref);
2655 handle_queryExpression(resultset->options, opt_name,
2656 ent->subqueryExpression);
2658 if (ent->subqueryInterpretation)
2661 sprintf(opt_name, "%s.interpretation", pref);
2662 handle_queryExpression(resultset->options, opt_name,
2663 ent->subqueryInterpretation);
2665 if (ent->subqueryRecommendation)
2668 sprintf(opt_name, "%s.recommendation", pref);
2669 handle_queryExpression(resultset->options, opt_name,
2670 ent->subqueryRecommendation);
2672 if (ent->subqueryCount)
2675 sprintf(opt_name, "%s.count", pref);
2676 ZOOM_options_set_int(resultset->options, opt_name,
2677 *ent->subqueryCount);
2685 static char *get_term_cstr(ODR odr, Z_Term *term) {
2687 switch (term->which) {
2688 case Z_Term_general:
2689 return odr_strdupn(odr, (const char *) term->u.general->buf, (size_t) term->u.general->len);
2691 case Z_Term_characterString:
2692 return odr_strdup(odr, term->u.characterString);
2697 static ZOOM_facet_field get_zoom_facet_field(ODR odr, Z_FacetField *facet) {
2699 struct yaz_facet_attr attr_values;
2700 ZOOM_facet_field facet_field = odr_malloc(odr, sizeof(*facet_field));
2701 yaz_facet_attr_init(&attr_values);
2702 yaz_facet_attr_get_z_attributes(facet->attributes, &attr_values);
2703 facet_field->facet_name = odr_strdup(odr, attr_values.useattr);
2704 facet_field->num_terms = facet->num_terms;
2705 yaz_log(YLOG_DEBUG, "ZOOM_facet_field %s %d terms %d", attr_values.useattr, attr_values.limit, facet->num_terms);
2706 facet_field->facet_terms = odr_malloc(odr, facet_field->num_terms * sizeof(*facet_field->facet_terms));
2707 for (term_index = 0 ; term_index < facet->num_terms; term_index++) {
2708 Z_FacetTerm *facetTerm = facet->terms[term_index];
2709 facet_field->facet_terms[term_index].frequency = *facetTerm->count;
2710 facet_field->facet_terms[term_index].term = get_term_cstr(odr, facetTerm->term);
2711 yaz_log(YLOG_DEBUG, " term[%d] %s %d",
2712 term_index, facet_field->facet_terms[term_index].term, facet_field->facet_terms[term_index].frequency);
2717 static void handle_facet_result(ZOOM_connection c, ZOOM_resultset r,
2718 Z_OtherInformation *o)
2721 for (i = 0; o && i < o->num_elements; i++)
2723 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2725 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2726 if (ext->which == Z_External_userFacets)
2729 Z_FacetList *fl = ext->u.facetList;
2730 r->num_facets = fl->num;
2731 yaz_log(YLOG_DEBUG, "Facets found: %d", fl->num);
2732 r->facets = odr_malloc(r->odr, r->num_facets * sizeof(*r->facets));
2733 r->facets_names = odr_malloc(r->odr, r->num_facets * sizeof(*r->facets_names));
2734 for (j = 0; j < fl->num; j++)
2736 r->facets[j] = get_zoom_facet_field(r->odr, fl->elements[j]);
2738 yaz_log(YLOG_DEBUG, "Facet field missing on index %d !", j);
2739 r->facets_names[j] = (char *) ZOOM_facet_field_name(r->facets[j]);
2746 static void handle_Z3950_search_response(ZOOM_connection c,
2747 Z_SearchResponse *sr)
2749 ZOOM_resultset resultset;
2752 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2755 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2756 ZOOM_connection_put_event(c, event);
2758 resultset = c->tasks->u.search.resultset;
2760 if (sr->resultSetStatus)
2762 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2763 *sr->resultSetStatus);
2765 if (sr->presentStatus)
2767 ZOOM_options_set_int(resultset->options, "presentStatus",
2768 *sr->presentStatus);
2770 handle_search_result(c, resultset, sr->additionalSearchInfo);
2772 handle_facet_result(c, resultset, sr->additionalSearchInfo);
2774 resultset->size = *sr->resultCount;
2775 handle_Z3950_records(c, sr->records, 0);
2778 static void handle_Z3950_sort_response(ZOOM_connection c, Z_SortResponse *res)
2780 if (res->diagnostics && res->num_diagnostics > 0)
2781 response_diag(c, res->diagnostics[0]);
2784 static int handle_Z3950_scan_response(ZOOM_connection c, Z_ScanResponse *res)
2786 NMEM nmem = odr_extract_mem(c->odr_in);
2789 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2791 scan = c->tasks->u.scan.scan;
2793 if (res->entries && res->entries->nonsurrogateDiagnostics)
2794 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2795 scan->scan_response = res;
2796 scan->srw_scan_response = 0;
2797 nmem_transfer(odr_getmem(scan->odr), nmem);
2799 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2800 if (res->positionOfTerm)
2801 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2802 if (res->scanStatus)
2803 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2804 if (res->numberOfEntriesReturned)
2805 ZOOM_options_set_int(scan->options, "number",
2806 *res->numberOfEntriesReturned);
2811 static zoom_ret send_Z3950_sort(ZOOM_connection c,
2812 ZOOM_resultset resultset)
2815 resultset->r_sort_spec = 0;
2816 if (resultset->r_sort_spec)
2818 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2819 Z_SortRequest *req = apdu->u.sortRequest;
2821 req->num_inputResultSetNames = 1;
2822 req->inputResultSetNames = (Z_InternationalString **)
2823 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2824 req->inputResultSetNames[0] =
2825 odr_strdup(c->odr_out, resultset->setname);
2826 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2827 req->sortSequence = resultset->r_sort_spec;
2828 resultset->r_sort_spec = 0;
2829 return send_APDU(c, apdu);
2831 return zoom_complete;
2834 static zoom_ret send_Z3950_present(ZOOM_connection c)
2837 Z_PresentRequest *req = 0;
2839 const char *syntax = 0;
2840 const char *elementSetName = 0;
2841 ZOOM_resultset resultset;
2846 yaz_log(log_details, "%p send_present no tasks", c);
2847 return zoom_complete;
2850 switch (c->tasks->which)
2852 case ZOOM_TASK_SEARCH:
2853 resultset = c->tasks->u.search.resultset;
2854 start = &c->tasks->u.search.start;
2855 count = &c->tasks->u.search.count;
2856 syntax = c->tasks->u.search.syntax;
2857 elementSetName = c->tasks->u.search.elementSetName;
2859 case ZOOM_TASK_RETRIEVE:
2860 resultset = c->tasks->u.retrieve.resultset;
2861 start = &c->tasks->u.retrieve.start;
2862 count = &c->tasks->u.retrieve.count;
2863 syntax = c->tasks->u.retrieve.syntax;
2864 elementSetName = c->tasks->u.retrieve.elementSetName;
2867 return zoom_complete;
2869 yaz_log(log_details, "%p send_present start=%d count=%d",
2872 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2874 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2877 if (c->error) /* don't continue on error */
2878 return zoom_complete;
2879 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2880 resultset, *start, *count);
2882 for (i = 0; i < *count; i++)
2885 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2890 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2891 ZOOM_connection_put_event(c, event);
2899 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2900 return zoom_complete;
2903 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2904 req = apdu->u.presentRequest;
2907 yaz_log(log_details, "%p send_present skip=%d", c, i);
2909 *req->resultSetStartPoint = *start + 1;
2911 if (resultset->step > 0 && resultset->step < *count)
2912 *req->numberOfRecordsRequested = resultset->step;
2914 *req->numberOfRecordsRequested = *count;
2916 if (*req->numberOfRecordsRequested + *start > resultset->size)
2917 *req->numberOfRecordsRequested = resultset->size - *start;
2918 assert(*req->numberOfRecordsRequested > 0);
2920 if (syntax && *syntax)
2921 req->preferredRecordSyntax =
2922 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2924 if (resultset->schema && *resultset->schema)
2926 Z_RecordComposition *compo = (Z_RecordComposition *)
2927 odr_malloc(c->odr_out, sizeof(*compo));
2929 req->recordComposition = compo;
2930 compo->which = Z_RecordComp_complex;
2931 compo->u.complex = (Z_CompSpec *)
2932 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2933 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2934 odr_malloc(c->odr_out, sizeof(bool_t));
2935 *compo->u.complex->selectAlternativeSyntax = 0;
2937 compo->u.complex->generic = (Z_Specification *)
2938 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2940 compo->u.complex->generic->which = Z_Schema_oid;
2941 compo->u.complex->generic->schema.oid = (Odr_oid *)
2942 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2944 if (!compo->u.complex->generic->schema.oid)
2946 /* OID wasn't a schema! Try record syntax instead. */
2948 compo->u.complex->generic->schema.oid = (Odr_oid *)
2949 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2951 if (elementSetName && *elementSetName)
2953 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2954 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2955 compo->u.complex->generic->elementSpec->which =
2956 Z_ElementSpec_elementSetName;
2957 compo->u.complex->generic->elementSpec->u.elementSetName =
2958 odr_strdup(c->odr_out, elementSetName);
2961 compo->u.complex->generic->elementSpec = 0;
2962 compo->u.complex->num_dbSpecific = 0;
2963 compo->u.complex->dbSpecific = 0;
2964 compo->u.complex->num_recordSyntax = 0;
2965 compo->u.complex->recordSyntax = 0;
2967 else if (elementSetName && *elementSetName)
2969 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2970 odr_malloc(c->odr_out, sizeof(*esn));
2971 Z_RecordComposition *compo = (Z_RecordComposition *)
2972 odr_malloc(c->odr_out, sizeof(*compo));
2974 esn->which = Z_ElementSetNames_generic;
2975 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2976 compo->which = Z_RecordComp_simple;
2977 compo->u.simple = esn;
2978 req->recordComposition = compo;
2980 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2981 return send_APDU(c, apdu);
2984 ZOOM_API(ZOOM_scanset)
2985 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2988 ZOOM_query q = ZOOM_query_create();
2990 ZOOM_query_prefix(q, start);
2992 s = ZOOM_connection_scan1(c, q);
2993 ZOOM_query_destroy(q);
2998 ZOOM_API(ZOOM_scanset)
2999 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
3001 ZOOM_scanset scan = 0;
3005 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
3006 scan->connection = c;
3007 scan->odr = odr_createmem(ODR_DECODE);
3008 scan->options = ZOOM_options_create_with_parent(c->options);
3010 scan->scan_response = 0;
3011 scan->srw_scan_response = 0;
3015 scan->databaseNames = set_DatabaseNames(c, c->options,
3016 &scan->num_databaseNames,
3021 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
3022 task->u.scan.scan = scan;
3027 while (ZOOM_event(1, &c))
3035 ZOOM_scanset_destroy(ZOOM_scanset scan)
3040 if (scan->refcount == 0)
3042 ZOOM_query_destroy(scan->query);
3044 odr_destroy(scan->odr);
3046 ZOOM_options_destroy(scan->options);
3051 static zoom_ret send_package(ZOOM_connection c)
3055 yaz_log(log_details, "%p send_package", c);
3057 return zoom_complete;
3058 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
3060 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
3061 ZOOM_connection_put_event(c, event);
3063 c->buf_out = c->tasks->u.package->buf_out;
3064 c->len_out = c->tasks->u.package->len_out;
3069 static zoom_ret ZOOM_connection_Z3950_send_scan(ZOOM_connection c)
3072 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
3073 Z_ScanRequest *req = apdu->u.scanRequest;
3075 yaz_log(log_details, "%p send_scan", c);
3077 return zoom_complete;
3078 assert (c->tasks->which == ZOOM_TASK_SCAN);
3079 scan = c->tasks->u.scan.scan;
3081 /* Z39.50 scan can only carry RPN */
3082 if (scan->query->z_query->which == Z_Query_type_1 ||
3083 scan->query->z_query->which == Z_Query_type_101)
3085 Z_RPNQuery *rpn = scan->query->z_query->u.type_1;
3086 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
3089 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
3092 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
3094 yaz_query_charset_convert_rpnquery(
3095 rpn, c->odr_out, cd);
3096 yaz_iconv_close(cd);
3099 req->attributeSet = rpn->attributeSetId;
3100 if (!req->attributeSet)
3101 req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
3102 if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
3103 rpn->RPNStructure->u.simple->which == Z_Operand_APT)
3105 req->termListAndStartPoint =
3106 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
3110 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
3111 return zoom_complete;
3116 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
3117 return zoom_complete;
3120 *req->numberOfTermsRequested =
3121 ZOOM_options_get_int(scan->options, "number", 20);
3123 req->preferredPositionInResponse =
3124 odr_intdup(c->odr_out,
3125 ZOOM_options_get_int(scan->options, "position", 1));
3128 odr_intdup(c->odr_out,
3129 ZOOM_options_get_int(scan->options, "stepSize", 0));
3131 req->databaseNames = scan->databaseNames;
3132 req->num_databaseNames = scan->num_databaseNames;
3134 return send_APDU(c, apdu);
3138 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
3142 const char *option_val = 0;
3145 return zoom_complete;
3146 assert (c->tasks->which == ZOOM_TASK_SCAN);
3147 scan = c->tasks->u.scan.scan;
3149 sr = ZOOM_srw_get_pdu(c, Z_SRW_scan_request);
3151 /* SRU scan can only carry CQL and PQF */
3152 if (scan->query->z_query->which == Z_Query_type_104)
3154 sr->u.scan_request->query_type = Z_SRW_query_type_cql;
3155 sr->u.scan_request->scanClause.cql = scan->query->query_string;
3157 else if (scan->query->z_query->which == Z_Query_type_1
3158 || scan->query->z_query->which == Z_Query_type_101)
3160 sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
3161 sr->u.scan_request->scanClause.pqf = scan->query->query_string;
3165 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
3166 return zoom_complete;
3169 sr->u.scan_request->maximumTerms = odr_intdup(
3170 c->odr_out, ZOOM_options_get_int(scan->options, "number", 10));
3172 sr->u.scan_request->responsePosition = odr_intdup(
3173 c->odr_out, ZOOM_options_get_int(scan->options, "position", 1));
3175 option_val = ZOOM_options_get(scan->options, "extraArgs");
3176 yaz_encode_sru_extra(sr, c->odr_out, option_val);
3177 return send_srw(c, sr);
3180 static zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c)
3182 return zoom_complete;
3188 ZOOM_scanset_size(ZOOM_scanset scan)
3193 if (scan->scan_response && scan->scan_response->entries)
3194 return scan->scan_response->entries->num_entries;
3195 else if (scan->srw_scan_response)
3196 return scan->srw_scan_response->num_terms;
3200 static void ZOOM_scanset_term_x(ZOOM_scanset scan, size_t pos,
3202 const char **value_term, size_t *value_len,
3203 const char **disp_term, size_t *disp_len)
3205 size_t noent = ZOOM_scanset_size(scan);
3216 if (scan->scan_response)
3218 Z_ScanResponse *res = scan->scan_response;
3219 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
3221 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
3223 *value_term = (const char *) t->term->u.general->buf;
3224 *value_len = t->term->u.general->len;
3227 *disp_term = t->displayTerm;
3228 *disp_len = strlen(*disp_term);
3230 else if (t->term->which == Z_Term_general)
3232 *disp_term = (const char *) t->term->u.general->buf;
3233 *disp_len = t->term->u.general->len;
3235 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
3238 if (scan->srw_scan_response)
3240 Z_SRW_scanResponse *res = scan->srw_scan_response;
3241 Z_SRW_scanTerm *t = res->terms + pos;
3244 *value_term = t->value;
3245 *value_len = strlen(*value_term);
3248 *disp_term = t->displayTerm;
3250 *disp_term = t->value;
3251 *disp_len = strlen(*disp_term);
3252 *occ = t->numberOfRecords ? *t->numberOfRecords : 0;
3257 ZOOM_API(const char *)
3258 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
3259 size_t *occ, size_t *len)
3261 const char *value_term = 0;
3262 size_t value_len = 0;
3263 const char *disp_term = 0;
3264 size_t disp_len = 0;
3266 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3267 &disp_term, &disp_len);
3273 ZOOM_API(const char *)
3274 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
3275 size_t *occ, size_t *len)
3277 const char *value_term = 0;
3278 size_t value_len = 0;
3279 const char *disp_term = 0;
3280 size_t disp_len = 0;
3282 ZOOM_scanset_term_x(scan, pos, occ, &value_term, &value_len,
3283 &disp_term, &disp_len);
3289 ZOOM_API(const char *)
3290 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
3292 return ZOOM_options_get(scan->options, key);
3296 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
3299 ZOOM_options_set(scan->options, key, val);
3302 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
3305 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
3306 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3308 str = ZOOM_options_get(p->options, "package-name");
3310 req->packageName = odr_strdup(p->odr_out, str);
3312 str = ZOOM_options_get(p->options, "user-id");
3314 req->userId = odr_strdup_null(p->odr_out, str);
3316 req->packageType = odr_oiddup(p->odr_out, oid);
3318 str = ZOOM_options_get(p->options, "function");
3321 if (!strcmp (str, "create"))
3322 *req->function = Z_ExtendedServicesRequest_create;
3323 if (!strcmp (str, "delete"))
3324 *req->function = Z_ExtendedServicesRequest_delete;
3325 if (!strcmp (str, "modify"))
3326 *req->function = Z_ExtendedServicesRequest_modify;
3329 str = ZOOM_options_get(p->options, "waitAction");
3332 if (!strcmp (str, "wait"))
3333 *req->waitAction = Z_ExtendedServicesRequest_wait;
3334 if (!strcmp (str, "waitIfPossible"))
3335 *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
3336 if (!strcmp (str, "dontWait"))
3337 *req->waitAction = Z_ExtendedServicesRequest_dontWait;
3338 if (!strcmp (str, "dontReturnPackage"))
3339 *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
3344 static const char *ill_array_lookup(void *clientData, const char *idx)
3346 ZOOM_package p = (ZOOM_package) clientData;
3347 return ZOOM_options_get(p->options, idx+4);
3350 static Z_External *encode_ill_request(ZOOM_package p)
3352 ODR out = p->odr_out;
3355 struct ill_get_ctl ctl;
3357 ctl.odr = p->odr_out;
3359 ctl.f = ill_array_lookup;
3361 req = ill_get_ILLRequest(&ctl, "ill", 0);
3363 if (!ill_Request(out, &req, 0, 0))
3365 int ill_request_size;
3366 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
3367 if (ill_request_buf)
3368 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
3373 int illRequest_size = 0;
3374 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
3376 r = (Z_External *) odr_malloc(out, sizeof(*r));
3377 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
3378 r->indirect_reference = 0;
3380 r->which = Z_External_single;
3382 r->u.single_ASN1_type =
3383 odr_create_Odr_oct(out,
3384 (unsigned char *)illRequest_buf,
3390 static Z_ItemOrder *encode_item_order(ZOOM_package p)
3392 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
3396 req->which = Z_IOItemOrder_esRequest;
3397 req->u.esRequest = (Z_IORequest *)
3398 odr_malloc(p->odr_out,sizeof(Z_IORequest));
3400 /* to keep part ... */
3401 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
3402 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
3403 req->u.esRequest->toKeep->supplDescription = 0;
3404 req->u.esRequest->toKeep->contact = (Z_IOContact *)
3405 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
3407 str = ZOOM_options_get(p->options, "contact-name");
3408 req->u.esRequest->toKeep->contact->name =
3409 odr_strdup_null(p->odr_out, str);
3411 str = ZOOM_options_get(p->options, "contact-phone");
3412 req->u.esRequest->toKeep->contact->phone =
3413 odr_strdup_null(p->odr_out, str);
3415 str = ZOOM_options_get(p->options, "contact-email");
3416 req->u.esRequest->toKeep->contact->email =
3417 odr_strdup_null(p->odr_out, str);
3419 req->u.esRequest->toKeep->addlBilling = 0;
3421 /* not to keep part ... */
3422 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
3423 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
3425 str = ZOOM_options_get(p->options, "itemorder-setname");
3430 req->u.esRequest->notToKeep->resultSetItem = 0;
3433 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
3434 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
3436 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
3437 odr_strdup(p->odr_out, str);
3438 req->u.esRequest->notToKeep->resultSetItem->item =
3439 odr_intdup(p->odr_out, 0);
3441 str = ZOOM_options_get(p->options, "itemorder-item");
3442 *req->u.esRequest->notToKeep->resultSetItem->item =
3443 (str ? atoi(str) : 1);
3446 str = ZOOM_options_getl(p->options, "doc", &len);
3449 req->u.esRequest->notToKeep->itemRequest =
3450 z_ext_record_xml(p->odr_out, str, len);
3453 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3458 Z_APDU *create_admin_package(ZOOM_package p, int type,
3459 Z_ESAdminOriginPartToKeep **toKeepP,
3460 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3462 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
3465 Z_ESAdminOriginPartToKeep *toKeep;
3466 Z_ESAdminOriginPartNotToKeep *notToKeep;
3467 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3468 const char *first_db = "Default";
3470 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3475 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
3477 r->indirect_reference = 0;
3478 r->which = Z_External_ESAdmin;
3480 r->u.adminService = (Z_Admin *)
3481 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3482 r->u.adminService->which = Z_Admin_esRequest;
3483 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3484 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3486 toKeep = r->u.adminService->u.esRequest->toKeep =
3487 (Z_ESAdminOriginPartToKeep *)
3488 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3489 toKeep->which = type;
3490 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3491 toKeep->u.create = odr_nullval();
3492 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3494 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3495 (Z_ESAdminOriginPartNotToKeep *)
3496 odr_malloc(p->odr_out,
3497 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3498 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3499 notToKeep->u.recordsWillFollow = odr_nullval();
3503 *notToKeepP = notToKeep;
3508 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3510 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
3511 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3512 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3514 const char *doc = ZOOM_options_getl(p->options, "doc", &len);
3522 req->taskSpecificParameters = ext;
3523 ext->direct_reference = req->packageType;
3524 ext->descriptor = 0;
3525 ext->indirect_reference = 0;
3527 ext->which = Z_External_octet;
3528 ext->u.single_ASN1_type =
3529 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc, len);
3533 static Z_APDU *create_update_package(ZOOM_package p)
3536 const char *first_db = "Default";
3538 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3539 const char *action = ZOOM_options_get(p->options, "action");
3540 int recordIdOpaque_len;
3541 const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
3542 &recordIdOpaque_len);
3543 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3545 const char *record_buf = ZOOM_options_getl(p->options, "record",
3547 int recordOpaque_len;
3548 const char *recordOpaque_buf = ZOOM_options_getl(p->options, "recordOpaque",
3550 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3551 const char *version = ZOOM_options_get(p->options, "updateVersion");
3553 const char *correlationInfo_note =
3554 ZOOM_options_get(p->options, "correlationInfo.note");
3555 const char *correlationInfo_id =
3556 ZOOM_options_get(p->options, "correlationInfo.id");
3558 Odr_oid *syntax_oid = 0;
3559 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
3565 if (!record_buf && !recordOpaque_buf)
3567 record_buf = "void";
3569 syntax_str = "SUTRS";
3574 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
3575 CLASS_RECSYN, syntax_str,
3587 package_oid = yaz_oid_extserv_database_update_first_version;
3588 /* old update does not support specialUpdate */
3590 action = "recordInsert";
3594 action = "specialUpdate";
3595 package_oid = yaz_oid_extserv_database_update_second_version;
3599 action = "specialUpdate";
3600 package_oid = yaz_oid_extserv_database_update;
3606 if (!strcmp(action, "recordInsert"))
3607 action_no = Z_IUOriginPartToKeep_recordInsert;
3608 else if (!strcmp(action, "recordReplace"))
3609 action_no = Z_IUOriginPartToKeep_recordReplace;
3610 else if (!strcmp(action, "recordDelete"))
3611 action_no = Z_IUOriginPartToKeep_recordDelete;
3612 else if (!strcmp(action, "elementUpdate"))
3613 action_no = Z_IUOriginPartToKeep_elementUpdate;
3614 else if (!strcmp(action, "specialUpdate"))
3615 action_no = Z_IUOriginPartToKeep_specialUpdate;
3619 apdu = create_es_package(p, package_oid);
3622 Z_IUOriginPartToKeep *toKeep;
3623 Z_IUSuppliedRecords *notToKeep;
3624 Z_External *r = (Z_External *)
3625 odr_malloc(p->odr_out, sizeof(*r));
3626 const char *elementSetName =
3627 ZOOM_options_get(p->options, "elementSetName");
3629 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3631 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
3633 r->which = Z_External_update;
3634 r->indirect_reference = 0;
3635 r->u.update = (Z_IUUpdate *)
3636 odr_malloc(p->odr_out, sizeof(*r->u.update));
3638 r->u.update->which = Z_IUUpdate_esRequest;
3639 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3640 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3641 toKeep = r->u.update->u.esRequest->toKeep =
3642 (Z_IUOriginPartToKeep *)
3643 odr_malloc(p->odr_out, sizeof(*toKeep));
3645 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3648 toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
3650 toKeep->actionQualifier = 0;
3651 toKeep->action = odr_intdup(p->odr_out, action_no);
3653 notToKeep = r->u.update->u.esRequest->notToKeep =
3654 (Z_IUSuppliedRecords *)
3655 odr_malloc(p->odr_out, sizeof(*notToKeep));
3657 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3658 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3659 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3660 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3661 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3664 notToKeep->elements[0]->u.opaque =
3665 odr_create_Odr_oct(p->odr_out,
3666 (const unsigned char *) recordIdOpaque,
3667 recordIdOpaque_len);
3669 else if (recordIdNumber)
3671 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3673 notToKeep->elements[0]->u.number =
3674 odr_intdup(p->odr_out, atoi(recordIdNumber));
3677 notToKeep->elements[0]->u.opaque = 0;
3678 notToKeep->elements[0]->supplementalId = 0;
3679 if (correlationInfo_note || correlationInfo_id)
3681 Z_IUCorrelationInfo *ci;
3682 ci = notToKeep->elements[0]->correlationInfo =
3683 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
3684 ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
3685 ci->id = correlationInfo_id ?
3686 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
3689 notToKeep->elements[0]->correlationInfo = 0;
3690 if (recordOpaque_buf)
3692 notToKeep->elements[0]->record =
3693 z_ext_record_oid_any(p->odr_out, syntax_oid,
3694 recordOpaque_buf, recordOpaque_len);
3698 notToKeep->elements[0]->record =
3699 z_ext_record_oid(p->odr_out, syntax_oid,
3700 record_buf, record_len);
3705 ODR print = odr_createmem(ODR_PRINT);
3707 z_APDU(print, &apdu, 0, 0);
3714 ZOOM_package_send(ZOOM_package p, const char *type)
3721 odr_reset(p->odr_out);
3724 if (!strcmp(type, "itemorder"))
3726 apdu = create_es_package(p, yaz_oid_extserv_item_order);
3729 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3731 r->direct_reference =
3732 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
3734 r->which = Z_External_itemOrder;
3735 r->indirect_reference = 0;
3736 r->u.itemOrder = encode_item_order(p);
3738 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3741 else if (!strcmp(type, "create")) /* create database */
3743 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3746 else if (!strcmp(type, "drop")) /* drop database */
3748 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3751 else if (!strcmp(type, "commit")) /* commit changes */
3753 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3756 else if (!strcmp(type, "update")) /* update record(s) */
3758 apdu = create_update_package(p);
3760 else if (!strcmp(type, "xmlupdate"))
3762 apdu = create_xmlupdate_package(p);
3766 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3770 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3771 task->u.package = p;
3772 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3773 p->buf_out = (char *) xmalloc(p->len_out);
3774 memcpy(p->buf_out, buf, p->len_out);
3779 while (ZOOM_event(1, &c))
3786 ZOOM_API(ZOOM_package)
3787 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3789 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3792 p->odr_out = odr_createmem(ODR_ENCODE);
3793 p->options = ZOOM_options_create_with_parent2(options, c->options);
3801 ZOOM_package_destroy(ZOOM_package p)
3806 if (p->refcount == 0)
3808 odr_destroy(p->odr_out);
3811 ZOOM_options_destroy(p->options);
3816 ZOOM_API(const char *)
3817 ZOOM_package_option_get(ZOOM_package p, const char *key)
3819 return ZOOM_options_get(p->options, key);
3822 ZOOM_API(const char *)
3823 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
3825 return ZOOM_options_getl(p->options, key, lenp);
3829 ZOOM_package_option_set(ZOOM_package p, const char *key,
3832 ZOOM_options_set(p->options, key, val);
3836 ZOOM_package_option_setl(ZOOM_package p, const char *key,
3837 const char *val, int len)
3839 ZOOM_options_setl(p->options, key, val, len);
3843 ZOOM_connection_exec_task(ZOOM_connection c)
3845 ZOOM_task task = c->tasks;
3846 zoom_ret ret = zoom_complete;
3850 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3851 c, task->which, task->running);
3852 if (c->error != ZOOM_ERROR_NONE)
3854 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3855 "removing tasks because of error = %d", c, c->error);
3856 ZOOM_connection_remove_tasks(c);
3861 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3862 "task already running", c);
3866 ret = zoom_complete;
3867 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3869 switch (task->which)
3871 case ZOOM_TASK_SEARCH:
3872 if (c->proto == PROTO_HTTP)
3873 ret = ZOOM_connection_srw_send_search(c);
3875 ret = ZOOM_connection_Z3950_send_search(c);
3877 case ZOOM_TASK_RETRIEVE:
3878 if (c->proto == PROTO_HTTP)
3879 ret = ZOOM_connection_srw_send_search(c);
3881 ret = send_Z3950_present(c);
3883 case ZOOM_TASK_CONNECT:
3884 ret = do_connect(c);
3886 case ZOOM_TASK_SCAN:
3887 if (c->proto == PROTO_HTTP)
3888 ret = ZOOM_connection_srw_send_scan(c);
3890 ret = ZOOM_connection_Z3950_send_scan(c);
3892 case ZOOM_TASK_PACKAGE:
3893 ret = send_package(c);
3895 case ZOOM_TASK_SORT:
3896 c->tasks->u.sort.resultset->r_sort_spec =
3897 c->tasks->u.sort.q->sort_spec;
3898 ret = send_Z3950_sort(c, c->tasks->u.sort.resultset);
3904 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3905 "remove tasks because no connection exist", c);
3906 ZOOM_connection_remove_tasks(c);
3908 if (ret == zoom_complete)
3910 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3911 "task removed (complete)", c);
3912 ZOOM_connection_remove_task(c);
3915 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3920 static zoom_ret send_Z3950_sort_present(ZOOM_connection c)
3922 zoom_ret r = zoom_complete;
3924 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3925 r = send_Z3950_sort(c, c->tasks->u.search.resultset);
3926 if (r == zoom_complete)
3927 r = send_Z3950_present(c);
3931 static int es_response_taskpackage_update(ZOOM_connection c,
3932 Z_IUUpdateTaskPackage *utp)
3934 if (utp && utp->targetPart)
3936 Z_IUTargetPart *targetPart = utp->targetPart;
3937 switch ( *targetPart->updateStatus ) {
3938 case Z_IUTargetPart_success:
3939 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
3941 case Z_IUTargetPart_partial:
3942 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
3944 case Z_IUTargetPart_failure:
3945 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
3946 if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
3947 response_diag(c, targetPart->globalDiagnostics[0]);
3950 // NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED.
3955 static int es_response_taskpackage(ZOOM_connection c,
3956 Z_TaskPackage *taskPackage)
3959 Odr_oct *id = taskPackage->targetReference;
3961 ZOOM_options_setl(c->tasks->u.package->options,
3962 "targetReference", (char*) id->buf, id->len);
3965 switch ( *taskPackage->taskStatus ) {
3966 case Z_TaskPackage_pending:
3967 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
3969 case Z_TaskPackage_active:
3970 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
3972 case Z_TaskPackage_complete:
3973 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
3975 case Z_TaskPackage_aborted:
3976 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
3977 if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
3978 response_diag(c, taskPackage->packageDiagnostics[0]);
3982 // taskSpecificParameters
3983 // NOTE: Only Update implemented, no others.
3984 if ( taskPackage->taskSpecificParameters->which == Z_External_update ) {
3985 Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
3986 es_response_taskpackage_update(c, utp);
3992 static int handle_Z3950_es_response(ZOOM_connection c,
3993 Z_ExtendedServicesResponse *res)
3995 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3997 switch (*res->operationStatus) {
3998 case Z_ExtendedServicesResponse_done:
3999 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
4001 case Z_ExtendedServicesResponse_accepted:
4002 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
4004 case Z_ExtendedServicesResponse_failure:
4005 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
4006 if (res->diagnostics && res->num_diagnostics > 0)
4007 response_diag(c, res->diagnostics[0]);
4010 if (res->taskPackage &&
4011 res->taskPackage->which == Z_External_extendedService)
4013 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
4014 es_response_taskpackage(c, taskPackage);
4016 if (res->taskPackage &&
4017 res->taskPackage->which == Z_External_octet)
4019 Odr_oct *doc = res->taskPackage->u.octet_aligned;
4020 ZOOM_options_setl(c->tasks->u.package->options,
4021 "xmlUpdateDoc", (char*) doc->buf, doc->len);
4026 static void interpret_init_diag(ZOOM_connection c,
4027 Z_DiagnosticFormat *diag)
4031 Z_DiagnosticFormat_s *ds = diag->elements[0];
4032 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
4033 response_default_diag(c, ds->u.defaultDiagRec);
4038 static void interpret_otherinformation_field(ZOOM_connection c,
4039 Z_OtherInformation *ui)
4042 for (i = 0; i < ui->num_elements; i++)
4044 Z_OtherInformationUnit *unit = ui->list[i];
4045 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
4046 unit->information.externallyDefinedInfo &&
4047 unit->information.externallyDefinedInfo->which ==
4050 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
4056 static void set_init_option(const char *name, void *clientData) {
4057 ZOOM_connection c = (ZOOM_connection) clientData;
4060 sprintf(buf, "init_opt_%.70s", name);
4061 ZOOM_connection_option_set(c, buf, "1");
4065 static void handle_Z3950_apdu(ZOOM_connection c, Z_APDU *apdu)
4067 Z_InitResponse *initrs;
4069 ZOOM_connection_set_mask(c, 0);
4070 yaz_log(log_details, "%p handle_Z3950_apdu apdu->which=%d", c, apdu->which);
4071 switch (apdu->which)
4073 case Z_APDU_initResponse:
4074 yaz_log(log_api, "%p handle_Z3950_apdu: Received Init response", c);
4075 initrs = apdu->u.initResponse;
4076 ZOOM_connection_option_set(c, "serverImplementationId",
4077 initrs->implementationId ?
4078 initrs->implementationId : "");
4079 ZOOM_connection_option_set(c, "serverImplementationName",
4080 initrs->implementationName ?
4081 initrs->implementationName : "");
4082 ZOOM_connection_option_set(c, "serverImplementationVersion",
4083 initrs->implementationVersion ?
4084 initrs->implementationVersion : "");
4085 /* Set the three old options too, for old applications */
4086 ZOOM_connection_option_set(c, "targetImplementationId",
4087 initrs->implementationId ?
4088 initrs->implementationId : "");
4089 ZOOM_connection_option_set(c, "targetImplementationName",
4090 initrs->implementationName ?
4091 initrs->implementationName : "");
4092 ZOOM_connection_option_set(c, "targetImplementationVersion",
4093 initrs->implementationVersion ?
4094 initrs->implementationVersion : "");
4096 /* Make initrs->options available as ZOOM-level options */
4097 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
4099 if (!*initrs->result)
4101 Z_External *uif = initrs->userInformationField;
4103 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
4105 if (uif && uif->which == Z_External_userInfo1)
4106 interpret_otherinformation_field(c, uif->u.userInfo1);
4111 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
4112 yaz_oid_userinfo_cookie, 1, 0);
4113 xfree(c->cookie_in);
4116 c->cookie_in = xstrdup(cookie);
4117 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
4118 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
4119 c->support_named_resultsets = 1;
4122 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4123 ZOOM_connection_remove_task(c);
4125 ZOOM_connection_exec_task(c);
4127 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
4129 NMEM tmpmem = nmem_create();
4130 Z_CharSetandLanguageNegotiation *p =
4131 yaz_get_charneg_record(initrs->otherInfo);
4135 char *charset = NULL, *lang = NULL;
4138 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
4139 yaz_log(log_details, "%p handle_Z3950_apdu target accepted: "
4140 "charset %s, language %s, select %d",
4142 charset ? charset : "none", lang ? lang : "none", sel);
4144 ZOOM_connection_option_set(c, "negotiation-charset",
4147 ZOOM_connection_option_set(c, "negotiation-lang",
4150 ZOOM_connection_option_set(
4151 c, "negotiation-charset-in-effect-for-records",
4152 (sel != 0) ? "1" : "0");
4153 nmem_destroy(tmpmem);
4157 case Z_APDU_searchResponse:
4158 yaz_log(log_api, "%p handle_Z3950_apdu Search response", c);
4159 handle_Z3950_search_response(c, apdu->u.searchResponse);
4160 if (send_Z3950_sort_present(c) == zoom_complete)
4161 ZOOM_connection_remove_task(c);
4163 case Z_APDU_presentResponse:
4164 yaz_log(log_api, "%p handle_Z3950_apdu Present response", c);
4165 handle_Z3950_present_response(c, apdu->u.presentResponse);
4166 if (send_Z3950_present(c) == zoom_complete)
4167 ZOOM_connection_remove_task(c);
4169 case Z_APDU_sortResponse:
4170 yaz_log(log_api, "%p handle_Z3950_apdu Sort response", c);
4171 handle_Z3950_sort_response(c, apdu->u.sortResponse);
4172 if (send_Z3950_present(c) == zoom_complete)
4173 ZOOM_connection_remove_task(c);
4175 case Z_APDU_scanResponse:
4176 yaz_log(log_api, "%p handle_Z3950_apdu Scan response", c);
4177 handle_Z3950_scan_response(c, apdu->u.scanResponse);
4178 ZOOM_connection_remove_task(c);
4180 case Z_APDU_extendedServicesResponse:
4181 yaz_log(log_api, "%p handle_Z3950_apdu Extended Services response", c);
4182 handle_Z3950_es_response(c, apdu->u.extendedServicesResponse);
4183 ZOOM_connection_remove_task(c);
4186 yaz_log(log_api, "%p handle_Z3950_apdu Close PDU", c);
4187 if (!ZOOM_test_reconnect(c))
4189 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4194 yaz_log(log_api, "%p Received unknown PDU", c);
4195 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4201 static zoom_ret handle_srw_response(ZOOM_connection c,
4202 Z_SRW_searchRetrieveResponse *res)
4204 ZOOM_resultset resultset = 0;
4209 const char *syntax, *elementSetName;
4212 return zoom_complete;
4214 switch(c->tasks->which)
4216 case ZOOM_TASK_SEARCH:
4217 resultset = c->tasks->u.search.resultset;
4218 start = &c->tasks->u.search.start;
4219 count = &c->tasks->u.search.count;
4220 syntax = c->tasks->u.search.syntax;
4221 elementSetName = c->tasks->u.search.elementSetName;
4223 if (!c->tasks->u.search.recv_search_fired)
4225 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
4226 ZOOM_connection_put_event(c, event);
4227 c->tasks->u.search.recv_search_fired = 1;
4230 case ZOOM_TASK_RETRIEVE:
4231 resultset = c->tasks->u.retrieve.resultset;
4232 start = &c->tasks->u.retrieve.start;
4233 count = &c->tasks->u.retrieve.count;
4234 syntax = c->tasks->u.retrieve.syntax;
4235 elementSetName = c->tasks->u.retrieve.elementSetName;
4238 return zoom_complete;
4241 resultset->size = 0;
4243 if (res->resultSetId)
4244 ZOOM_resultset_option_set(resultset, "resultSetId", res->resultSetId);
4246 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
4248 if (res->num_diagnostics > 0)
4250 set_SRU_error(c, &res->diagnostics[0]);
4254 if (res->numberOfRecords)
4255 resultset->size = *res->numberOfRecords;
4256 for (i = 0; i<res->num_records; i++)
4259 Z_SRW_record *sru_rec;
4260 Z_SRW_diagnostic *diag = 0;
4263 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
4264 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
4266 if (res->records[i].recordPosition &&
4267 *res->records[i].recordPosition > 0)
4268 pos = *res->records[i].recordPosition - 1;
4272 sru_rec = &res->records[i];
4274 npr->databaseName = 0;
4275 npr->which = Z_NamePlusRecord_databaseRecord;
4276 npr->u.databaseRecord = (Z_External *)
4277 odr_malloc(c->odr_in, sizeof(Z_External));
4278 npr->u.databaseRecord->descriptor = 0;
4279 npr->u.databaseRecord->direct_reference =
4280 odr_oiddup(c->odr_in, yaz_oid_recsyn_xml);
4281 npr->u.databaseRecord->which = Z_External_octet;
4283 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
4284 odr_malloc(c->odr_in, sizeof(Odr_oct));
4285 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
4286 sru_rec->recordData_buf;
4287 npr->u.databaseRecord->u.octet_aligned->len =
4288 npr->u.databaseRecord->u.octet_aligned->size =
4289 sru_rec->recordData_len;
4291 if (sru_rec->recordSchema
4292 && !strcmp(sru_rec->recordSchema,
4293 "info:srw/schema/1/diagnostics-v1.1"))
4295 sru_decode_surrogate_diagnostics(sru_rec->recordData_buf,
4296 sru_rec->recordData_len,
4300 record_cache_add(resultset, npr, pos, syntax, elementSetName,
4301 sru_rec->recordSchema, diag);
4305 if (*count + *start > resultset->size)
4306 *count = resultset->size - *start;
4310 nmem = odr_extract_mem(c->odr_in);
4311 nmem_transfer(odr_getmem(resultset->odr), nmem);
4315 return ZOOM_connection_srw_send_search(c);
4317 return zoom_complete;
4322 static void handle_srw_scan_response(ZOOM_connection c,
4323 Z_SRW_scanResponse *res)
4325 NMEM nmem = odr_extract_mem(c->odr_in);
4328 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
4330 scan = c->tasks->u.scan.scan;
4332 if (res->num_diagnostics > 0)
4333 set_SRU_error(c, &res->diagnostics[0]);
4335 scan->scan_response = 0;
4336 scan->srw_scan_response = res;
4337 nmem_transfer(odr_getmem(scan->odr), nmem);
4339 ZOOM_options_set_int(scan->options, "number", res->num_terms);
4345 static Z_GDU *get_HTTP_Request_url(ODR odr, const char *url)
4347 Z_GDU *p = z_get_HTTP_Request(odr);
4348 const char *host = url;
4349 const char *cp0 = strstr(host, "://");
4350 const char *cp1 = 0;
4356 cp1 = strchr(cp0, '/');
4358 cp1 = cp0 + strlen(cp0);
4362 char *h = (char*) odr_malloc(odr, cp1 - cp0 + 1);
4363 memcpy (h, cp0, cp1 - cp0);
4365 z_HTTP_header_add(odr, &p->u.HTTP_Request->headers, "Host", h);
4367 p->u.HTTP_Request->path = odr_strdup(odr, *cp1 ? cp1 : "/");
4371 static zoom_ret send_SRW_redirect(ZOOM_connection c, const char *uri,
4372 Z_HTTP_Response *cookie_hres)
4374 struct Z_HTTP_Header *h;
4375 Z_GDU *gdu = get_HTTP_Request_url(c->odr_out, uri);
4376 char *combined_cookies;
4377 int combined_cookies_len = 0;
4379 gdu->u.HTTP_Request->method = odr_strdup(c->odr_out, "GET");
4380 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers, "Accept",
4383 for (h = cookie_hres->headers; h; h = h->next)
4385 if (!strcmp(h->name, "Set-Cookie"))
4389 if (!(cp = strchr(h->value, ';')))
4390 cp = h->value + strlen(h->value);
4391 if (cp - h->value >= 1) {
4392 combined_cookies = xrealloc(combined_cookies, combined_cookies_len + cp - h->value + 3);
4393 memcpy(combined_cookies+combined_cookies_len, h->value, cp - h->value);
4394 combined_cookies[combined_cookies_len + cp - h->value] = '\0';
4395 strcat(combined_cookies,"; ");
4396 combined_cookies_len = strlen(combined_cookies);
4401 if (combined_cookies_len)
4403 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
4404 "Cookie", combined_cookies);
4405 xfree(combined_cookies);
4408 if (c->user && c->password)
4410 z_HTTP_header_add_basic_auth(c->odr_out, &gdu->u.HTTP_Request->headers,
4411 c->user, c->password);
4413 if (!z_GDU(c->odr_out, &gdu, 0, 0))
4414 return zoom_complete;
4416 z_GDU(c->odr_print, &gdu, 0, 0);
4417 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
4419 odr_reset(c->odr_out);
4423 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
4425 zoom_ret cret = zoom_complete;
4427 const char *addinfo = 0;
4428 const char *connection_head = z_HTTP_header_lookup(hres->headers,
4430 const char *location;
4432 ZOOM_connection_set_mask(c, 0);
4433 yaz_log(log_details, "%p handle_http", c);
4435 if ((hres->code == 301 || hres->code == 302) && c->sru_mode == zoom_sru_get
4436 && (location = z_HTTP_header_lookup(hres->headers, "Location")))
4439 if (c->no_redirects > 10)
4441 set_HTTP_error(c, hres->code, 0, 0);
4442 c->no_redirects = 0;
4447 /* since redirect may change host we just reconnect. A smarter
4448 implementation might check whether it's the same server */
4449 do_connect_host(c, location, 0);
4450 send_SRW_redirect(c, location, hres);
4451 /* we're OK for now. Operation is not really complete */
4453 cret = zoom_pending;
4457 { /* not redirect (normal response) */
4458 if (!yaz_srw_check_content_type(hres))
4459 addinfo = "content-type";
4462 Z_SOAP *soap_package = 0;
4464 Z_SOAP_Handler soap_handlers[2] = {
4465 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
4468 ret = z_soap_codec(o, &soap_package,
4469 &hres->content_buf, &hres->content_len,
4471 if (!ret && soap_package->which == Z_SOAP_generic &&
4472 soap_package->u.generic->no == 0)
4474 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
4476 ZOOM_options_set(c->options, "sru_version", sr->srw_version);
4477 ZOOM_options_setl(c->options, "sru_extra_response_data",
4478 sr->extraResponseData_buf, sr->extraResponseData_len);
4479 if (sr->which == Z_SRW_searchRetrieve_response)
4480 cret = handle_srw_response(c, sr->u.response);
4481 else if (sr->which == Z_SRW_scan_response)
4482 handle_srw_scan_response(c, sr->u.scan_response);
4486 else if (!ret && (soap_package->which == Z_SOAP_fault
4487 || soap_package->which == Z_SOAP_error))
4489 set_HTTP_error(c, hres->code,
4490 soap_package->u.fault->fault_code,
4491 soap_package->u.fault->fault_string);
4498 if (c->no_redirects) /* end of redirect. change hosts again */
4501 c->no_redirects = 0;
4505 if (hres->code != 200)
4506 set_HTTP_error(c, hres->code, 0, 0);
4508 set_ZOOM_error(c, ZOOM_ERROR_DECODE, addinfo);
4511 if (cret == zoom_complete)
4513 yaz_log(YLOG_LOG, "removing tasks in handle_http");
4514 ZOOM_connection_remove_task(c);
4518 if (!strcmp(hres->version, "1.0"))
4520 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
4521 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
4526 /* HTTP 1.1: only if no close we stay alive.. */
4527 if (connection_head && !strcmp(connection_head, "close"))
4535 c->tasks->running = 0;
4536 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
4537 c->reconnect_ok = 0;
4544 static int do_read(ZOOM_connection c)
4549 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
4550 ZOOM_connection_put_event(c, event);
4552 r = cs_get(c->cs, &c->buf_in, &c->len_in);
4553 more = cs_more(c->cs);
4554 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
4559 if (!ZOOM_test_reconnect(c))
4561 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4570 odr_reset(c->odr_in);
4571 odr_setbuf(c->odr_in, c->buf_in, r, 0);
4572 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
4573 ZOOM_connection_put_event(c, event);
4575 if (!z_GDU(c->odr_in, &gdu, 0, 0))
4578 int err = odr_geterrorx(c->odr_in, &x);
4580 const char *element = odr_getelement(c->odr_in);
4581 yaz_snprintf(msg, sizeof(msg),
4582 "ODR code %d:%d element=%s offset=%d",
4583 err, x, element ? element : "<unknown>",
4584 odr_offset(c->odr_in));
4585 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
4588 FILE *ber_file = yaz_log_file();
4590 odr_dumpBER(ber_file, c->buf_in, r);
4597 z_GDU(c->odr_print, &gdu, 0, 0);
4598 if (gdu->which == Z_GDU_Z3950)
4599 handle_Z3950_apdu(c, gdu->u.z3950);
4600 else if (gdu->which == Z_GDU_HTTP_Response)
4603 handle_http(c, gdu->u.HTTP_Response);
4605 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
4610 c->reconnect_ok = 0;
4615 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
4620 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
4621 ZOOM_connection_put_event(c, event);
4623 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
4624 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
4626 yaz_log(log_details, "%p do_write_ex write failed", c);
4627 if (ZOOM_test_reconnect(c))
4629 return zoom_pending;
4631 if (c->state == STATE_CONNECTING)
4632 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4634 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4636 return zoom_complete;
4640 int mask = ZOOM_SELECT_EXCEPT;
4641 if (c->cs->io_pending & CS_WANT_WRITE)
4642 mask += ZOOM_SELECT_WRITE;
4643 if (c->cs->io_pending & CS_WANT_READ)
4644 mask += ZOOM_SELECT_READ;
4645 ZOOM_connection_set_mask(c, mask);
4646 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
4651 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
4652 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
4655 return zoom_pending;
4658 static zoom_ret do_write(ZOOM_connection c)
4660 return do_write_ex(c, c->buf_out, c->len_out);
4664 ZOOM_API(const char *)
4665 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
4667 return ZOOM_options_get(c->options, key);
4670 ZOOM_API(const char *)
4671 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
4673 return ZOOM_options_getl(c->options, key, lenp);
4677 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
4680 ZOOM_options_set(c->options, key, val);
4684 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
4685 const char *val, int len)
4687 ZOOM_options_setl(c->options, key, val, len);
4690 ZOOM_API(const char *)
4691 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
4693 return ZOOM_options_get(r->options, key);
4697 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
4700 ZOOM_options_set(r->options, key, val);
4705 ZOOM_connection_errcode(ZOOM_connection c)
4707 return ZOOM_connection_error(c, 0, 0);
4710 ZOOM_API(const char *)
4711 ZOOM_connection_errmsg(ZOOM_connection c)
4714 ZOOM_connection_error(c, &msg, 0);
4718 ZOOM_API(const char *)
4719 ZOOM_connection_addinfo(ZOOM_connection c)
4721 const char *addinfo;
4722 ZOOM_connection_error(c, 0, &addinfo);
4726 ZOOM_API(const char *)
4727 ZOOM_connection_diagset(ZOOM_connection c)
4729 const char *diagset;
4730 ZOOM_connection_error_x(c, 0, 0, &diagset);
4734 ZOOM_API(const char *)
4735 ZOOM_diag_str(int error)
4739 case ZOOM_ERROR_NONE:
4741 case ZOOM_ERROR_CONNECT:
4742 return "Connect failed";
4743 case ZOOM_ERROR_MEMORY:
4744 return "Out of memory";
4745 case ZOOM_ERROR_ENCODE:
4746 return "Encoding failed";
4747 case ZOOM_ERROR_DECODE:
4748 return "Decoding failed";
4749 case ZOOM_ERROR_CONNECTION_LOST:
4750 return "Connection lost";
4751 case ZOOM_ERROR_INIT:
4752 return "Init rejected";
4753 case ZOOM_ERROR_INTERNAL:
4754 return "Internal failure";
4755 case ZOOM_ERROR_TIMEOUT:
4757 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
4758 return "Unsupported protocol";
4759 case ZOOM_ERROR_UNSUPPORTED_QUERY:
4760 return "Unsupported query type";
4761 case ZOOM_ERROR_INVALID_QUERY:
4762 return "Invalid query";
4763 case ZOOM_ERROR_CQL_PARSE:
4764 return "CQL parsing error";
4765 case ZOOM_ERROR_CQL_TRANSFORM:
4766 return "CQL transformation error";
4767 case ZOOM_ERROR_CCL_CONFIG:
4768 return "CCL configuration error";
4769 case ZOOM_ERROR_CCL_PARSE:
4770 return "CCL parsing error";
4772 return diagbib1_str(error);
4777 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
4778 const char **addinfo, const char **diagset)
4780 int error = c->error;
4783 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
4784 *cp = ZOOM_diag_str(error);
4785 else if (!strcmp(c->diagset, "HTTP"))
4786 *cp = z_HTTP_errmsg(c->error);
4787 else if (!strcmp(c->diagset, "Bib-1"))
4788 *cp = ZOOM_diag_str(error);
4789 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
4790 *cp = yaz_diag_srw_str(c->error);
4792 *cp = "Unknown error and diagnostic set";
4795 *addinfo = c->addinfo ? c->addinfo : "";
4797 *diagset = c->diagset ? c->diagset : "";
4802 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4803 const char **addinfo)
4805 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4808 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4810 ZOOM_Event event = 0;
4811 int r = cs_look(c->cs);
4812 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4817 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4818 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4820 ZOOM_connection_put_event(c, event);
4822 else if (r == CS_CONNECT)
4824 int ret = ret = cs_rcvconnect(c->cs);
4825 yaz_log(log_details, "%p ZOOM_connection_do_io "
4826 "cs_rcvconnect returned %d", c, ret);
4829 int mask = ZOOM_SELECT_EXCEPT;
4830 if (c->cs->io_pending & CS_WANT_WRITE)
4831 mask += ZOOM_SELECT_WRITE;
4832 if (c->cs->io_pending & CS_WANT_READ)
4833 mask += ZOOM_SELECT_READ;
4834 ZOOM_connection_set_mask(c, mask);
4835 event = ZOOM_Event_create(ZOOM_EVENT_NONE);
4836 ZOOM_connection_put_event(c, event);
4840 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4841 ZOOM_connection_put_event(c, event);
4843 if (c->proto == PROTO_Z3950)
4844 ZOOM_connection_send_init(c);
4847 /* no init request for SRW .. */
4848 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4849 ZOOM_connection_remove_task(c);
4850 ZOOM_connection_set_mask(c, 0);
4851 ZOOM_connection_exec_task(c);
4853 c->state = STATE_ESTABLISHED;
4857 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4863 if (mask & ZOOM_SELECT_EXCEPT)
4865 if (!ZOOM_test_reconnect(c))
4867 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4872 if (mask & ZOOM_SELECT_READ)
4874 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4880 ZOOM_connection_last_event(ZOOM_connection cs)
4883 return ZOOM_EVENT_NONE;
4884 return cs->last_event;
4888 static void cql2pqf_wrbuf_puts(const char *buf, void *client_data)
4890 WRBUF wrbuf = (WRBUF) client_data;
4891 wrbuf_puts(wrbuf, buf);
4895 * Returns an xmalloc()d string containing RPN that corresponds to the
4896 * CQL passed in. On error, sets the Connection object's error state
4897 * and returns a null pointer.
4898 * ### We could cache CQL parser and/or transformer in Connection.
4900 static char *cql2pqf(ZOOM_connection c, const char *cql)
4904 const char *cqlfile;
4905 cql_transform_t trans;
4908 parser = cql_parser_create();
4909 if ((error = cql_parser_string(parser, cql)) != 0) {
4910 cql_parser_destroy(parser);
4911 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4915 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4918 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4920 else if ((trans = cql_transform_open_fname(cqlfile)) == 0)
4923 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4924 cqlfile, strerror(errno));
4925 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4929 WRBUF wrbuf_result = wrbuf_alloc();
4930 error = cql_transform(trans, cql_parser_result(parser),
4931 cql2pqf_wrbuf_puts, wrbuf_result);
4934 const char *addinfo;
4935 error = cql_transform_error(trans, &addinfo);
4936 sprintf(buf, "%.200s (addinfo=%.200s)",
4937 cql_strerror(error), addinfo);
4938 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4942 result = xstrdup(wrbuf_cstr(wrbuf_result));
4944 cql_transform_close(trans);
4945 wrbuf_destroy(wrbuf_result);
4947 cql_parser_destroy(parser);
4951 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4955 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4956 /* timeout and this connection was waiting */
4957 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4959 ZOOM_connection_put_event(c, event);
4965 ZOOM_connection_process(ZOOM_connection c)
4971 event = ZOOM_connection_get_event(c);
4974 ZOOM_Event_destroy(event);
4977 ZOOM_connection_exec_task(c);
4978 event = ZOOM_connection_get_event(c);
4981 ZOOM_Event_destroy(event);
4988 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4992 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4994 for (i = 0; i<no; i++)
4996 ZOOM_connection c = cs[i];
4998 if (c && ZOOM_connection_process(c))
5004 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
5006 if (c->mask && mask)
5007 ZOOM_connection_do_io(c, mask);
5011 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
5014 return cs_fileno(c->cs);
5018 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
5026 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
5033 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
5035 return ZOOM_options_get_int(c->options, "timeout", 30);
5038 ZOOM_API(void) ZOOM_connection_close(ZOOM_connection c)
5046 * c-file-style: "Stroustrup"
5047 * indent-tabs-mode: nil
5049 * vim: shiftwidth=4 tabstop=8 expandtab