2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.112 2007-02-21 09:17:51 adam Exp $
9 * \brief Implements ZOOM C interface.
17 #include <yaz/yaz-util.h>
18 #include <yaz/xmalloc.h>
19 #include <yaz/otherinfo.h>
21 #include <yaz/pquery.h>
22 #include <yaz/marcdisp.h>
23 #include <yaz/diagbib1.h>
24 #include <yaz/charneg.h>
32 static int log_api = 0;
33 static int log_details = 0;
40 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
41 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
42 static char *cql2pqf(ZOOM_connection c, const char *cql);
46 * This wrapper is just for logging failed lookups. It would be nicer
47 * if it could cause failure when a lookup fails, but that's hard.
49 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
50 int oid_class, const char *str) {
51 Odr_oid *res = yaz_str_to_z3950oid(c->odr_out, oid_class, str);
53 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
54 c, (int) oid_class, str);
59 static void initlog(void)
61 static int log_level_initialized = 0;
62 if (!log_level_initialized)
64 log_api = yaz_log_module_level("zoom");
65 log_details = yaz_log_module_level("zoomdetails");
66 log_level_initialized = 1;
70 static ZOOM_Event ZOOM_Event_create(int kind)
72 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
76 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
80 static void ZOOM_Event_destroy(ZOOM_Event event)
85 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
89 c->m_queue_back->prev = event;
90 assert(c->m_queue_front);
94 assert(!c->m_queue_front);
95 c->m_queue_front = event;
97 event->next = c->m_queue_back;
99 c->m_queue_back = event;
102 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
104 ZOOM_Event event = c->m_queue_front;
107 c->last_event = ZOOM_EVENT_NONE;
110 assert(c->m_queue_back);
111 c->m_queue_front = event->prev;
112 if (c->m_queue_front)
114 assert(c->m_queue_back);
115 c->m_queue_front->next = 0;
119 c->last_event = event->kind;
123 ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
125 ZOOM_Event event = c->m_queue_front;
127 return event ? event->kind : ZOOM_EVENT_NONE;
130 static void set_dset_error(ZOOM_connection c, int error,
132 const char *addinfo, const char *addinfo2)
139 if (!c->diagset || strcmp(dset, c->diagset))
142 c->diagset = xstrdup(dset);
143 /* remove integer part from SRW diagset .. */
144 if ((cp = strrchr(c->diagset, '/')))
147 if (addinfo && addinfo2)
149 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
150 strcpy(c->addinfo, addinfo);
151 strcat(c->addinfo, addinfo2);
154 c->addinfo = xstrdup(addinfo);
155 if (error != ZOOM_ERROR_NONE)
157 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
158 c, c->host_port ? c->host_port : "<>", dset, error,
159 addinfo ? addinfo : "",
160 addinfo2 ? addinfo2 : "");
162 ZOOM_connection_remove_tasks(c);
168 static void set_HTTP_error(ZOOM_connection c, int error,
169 const char *addinfo, const char *addinfo2)
171 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
175 void ZOOM_connection_remove_tasks(ZOOM_connection c);
177 static void set_ZOOM_error(ZOOM_connection c, int error,
180 set_dset_error(c, error, "ZOOM", addinfo, 0);
183 static void clear_error(ZOOM_connection c)
186 * If an error is tied to an operation then it's ok to clear: for
187 * example, a diagnostic returned from a search is cleared by a
188 * subsequent search. However, problems such as Connection Lost
189 * or Init Refused are not cleared, because they are not
190 * recoverable: doing another search doesn't help.
194 case ZOOM_ERROR_CONNECT:
195 case ZOOM_ERROR_MEMORY:
196 case ZOOM_ERROR_DECODE:
197 case ZOOM_ERROR_CONNECTION_LOST:
198 case ZOOM_ERROR_INIT:
199 case ZOOM_ERROR_INTERNAL:
200 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
203 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
207 void ZOOM_connection_show_task(ZOOM_task task)
211 case ZOOM_TASK_SEARCH:
212 yaz_log(YLOG_LOG, "search p=%p", task);
214 case ZOOM_TASK_RETRIEVE:
215 yaz_log(YLOG_LOG, "retrieve p=%p", task);
217 case ZOOM_TASK_CONNECT:
218 yaz_log(YLOG_LOG, "connect p=%p", task);
221 yaz_log(YLOG_LOG, "scant p=%p", task);
226 void ZOOM_connection_show_tasks(ZOOM_connection c)
229 yaz_log(YLOG_LOG, "connection p=%p tasks", c);
230 for (task = c->tasks; task; task = task->next)
231 ZOOM_connection_show_task(task);
234 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
236 ZOOM_task *taskp = &c->tasks;
238 taskp = &(*taskp)->next;
239 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
240 (*taskp)->running = 0;
241 (*taskp)->which = which;
247 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
249 return c->tasks ? 0 : 1;
252 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
254 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
256 task->next = c->tasks;
265 void ZOOM_connection_remove_task(ZOOM_connection c)
267 ZOOM_task task = c->tasks;
271 c->tasks = task->next;
274 case ZOOM_TASK_SEARCH:
275 ZOOM_resultset_destroy(task->u.search.resultset);
276 xfree(task->u.search.syntax);
277 xfree(task->u.search.elementSetName);
279 case ZOOM_TASK_RETRIEVE:
280 ZOOM_resultset_destroy(task->u.retrieve.resultset);
281 xfree(task->u.retrieve.syntax);
282 xfree(task->u.retrieve.elementSetName);
284 case ZOOM_TASK_CONNECT:
287 ZOOM_scanset_destroy(task->u.scan.scan);
289 case ZOOM_TASK_PACKAGE:
290 ZOOM_package_destroy(task->u.package);
293 ZOOM_resultset_destroy(task->u.sort.resultset);
294 ZOOM_query_destroy(task->u.sort.q);
303 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
304 ZOOM_connection_put_event(c, event);
309 static int ZOOM_connection_exec_task(ZOOM_connection c);
311 void ZOOM_connection_remove_tasks(ZOOM_connection c)
314 ZOOM_connection_remove_task(c);
317 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
319 const char *elementSetName);
321 ZOOM_API(ZOOM_connection)
322 ZOOM_connection_create(ZOOM_options options)
324 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
328 yaz_log(log_api, "%p ZOOM_connection_create", c);
330 c->proto = PROTO_Z3950;
332 ZOOM_connection_set_mask(c, 0);
334 c->state = STATE_IDLE;
337 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
344 c->options = ZOOM_options_create_with_parent(options);
350 c->charset = c->lang = 0;
357 c->odr_in = odr_createmem(ODR_DECODE);
358 c->odr_out = odr_createmem(ODR_ENCODE);
361 c->support_named_resultsets = 0;
362 c->last_event = ZOOM_EVENT_NONE;
364 c->m_queue_front = 0;
370 /* set database names. Take local databases (if set); otherwise
371 take databases given in ZURL (if set); otherwise use Default */
372 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
375 char **databaseNames;
376 const char *cp = ZOOM_options_get(options, "databaseName");
378 if ((!cp || !*cp) && con->host_port)
380 if (strncmp(con->host_port, "unix:", 5) == 0)
381 cp = strchr(con->host_port+5, ':');
383 cp = strchr(con->host_port, '/');
389 nmem_strsplit(odr->mem, "+", cp, &databaseNames, num);
390 return databaseNames;
393 ZOOM_API(ZOOM_connection)
394 ZOOM_connection_new(const char *host, int portnum)
396 ZOOM_connection c = ZOOM_connection_create(0);
398 ZOOM_connection_connect(c, host, portnum);
402 static zoom_sru_mode get_sru_mode_from_string(const char *s)
405 return zoom_sru_soap;
406 if (!yaz_matchstr(s, "soap"))
407 return zoom_sru_soap;
408 else if (!yaz_matchstr(s, "get"))
410 else if (!yaz_matchstr(s, "post"))
411 return zoom_sru_post;
412 return zoom_sru_error;
416 ZOOM_connection_connect(ZOOM_connection c,
417 const char *host, int portnum)
424 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
427 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
428 ZOOM_connection_remove_tasks(c);
432 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
436 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
438 val = ZOOM_options_get(c->options, "proxy");
441 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
442 c->proxy = xstrdup(val);
448 val = ZOOM_options_get(c->options, "charset");
451 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
452 c->charset = xstrdup(val);
458 val = ZOOM_options_get(c->options, "lang");
461 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
462 c->lang = xstrdup(val);
471 sprintf(hostn, "%.80s:%d", host, portnum);
472 c->host_port = xstrdup(hostn);
475 c->host_port = xstrdup(host);
479 * If the "<scheme>:" part of the host string is preceded by one
480 * or more comma-separated <name>=<value> pairs, these are taken
481 * to be options to be set on the connection object. Among other
482 * applications, this facility can be used to embed authentication
484 * user=admin,password=secret,tcp:localhost:9999
486 char *remainder = c->host_port;
487 char *pcolon = strchr(remainder, ':');
490 while ((pcomma = strchr(remainder, ',')) != 0 &&
491 (pcolon == 0 || pcomma < pcolon)) {
493 if ((pequals = strchr(remainder, '=')) != 0) {
495 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
496 ZOOM_connection_option_set(c, remainder, pequals+1);
498 remainder = pcomma+1;
501 if (remainder != c->host_port) {
503 c->host_port = xstrdup(remainder);
504 /*printf("# reset hp='%s'\n", remainder);*/
508 val = ZOOM_options_get(c->options, "sru");
509 c->sru_mode = get_sru_mode_from_string(val);
511 ZOOM_options_set(c->options, "host", c->host_port);
513 val = ZOOM_options_get(c->options, "cookie");
516 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
517 c->cookie_out = xstrdup(val);
520 val = ZOOM_options_get(c->options, "clientIP");
523 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
525 c->client_IP = xstrdup(val);
528 c->async = ZOOM_options_get_bool(c->options, "async", 0);
529 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
531 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
535 while (ZOOM_event(1, &c))
541 ZOOM_query_create(void)
543 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
545 yaz_log(log_details, "%p ZOOM_query_create", s);
549 s->odr = odr_createmem(ODR_ENCODE);
556 ZOOM_query_destroy(ZOOM_query s)
562 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
563 if (s->refcount == 0)
571 ZOOM_query_prefix(ZOOM_query s, const char *str)
573 s->query_string = odr_strdup(s->odr, str);
574 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
575 s->z_query->which = Z_Query_type_1;
576 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
577 if (!s->z_query->u.type_1)
579 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
583 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
588 ZOOM_query_cql(ZOOM_query s, const char *str)
592 s->query_string = odr_strdup(s->odr, str);
594 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
595 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
596 ext->indirect_reference = 0;
598 ext->which = Z_External_CQL;
599 ext->u.cql = s->query_string;
601 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
602 s->z_query->which = Z_Query_type_104;
603 s->z_query->u.type_104 = ext;
605 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
611 * Translate the CQL string client-side into RPN which is passed to
612 * the server. This is useful for server's that don't themselves
613 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
614 * only as a place to stash diagnostics if compilation fails; if this
615 * information is not needed, a null pointer may be used.
618 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
622 ZOOM_connection freeme = 0;
624 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
626 conn = freeme = ZOOM_connection_create(0);
628 rpn = cql2pqf(conn, str);
630 ZOOM_connection_destroy(freeme);
634 ret = ZOOM_query_prefix(s, rpn);
640 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
641 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
642 * to the server, as the YAZ GFS doesn't know how to handle this.
645 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
646 int *ccl_error, const char **error_string,
650 struct ccl_rpn_node *rpn;
651 CCL_bibset bibset = ccl_qual_mk();
654 ccl_qual_buf(bibset, config);
656 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
659 *error_string = ccl_err_msg(*ccl_error);
664 WRBUF wr = wrbuf_alloc();
667 ret = ZOOM_query_prefix(s, wrbuf_buf(wr));
670 ccl_qual_rm(&bibset);
675 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
677 s->sort_spec = yaz_sort_spec(s->odr, criteria);
680 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
684 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
688 static zoom_ret do_write(ZOOM_connection c);
691 ZOOM_connection_destroy(ZOOM_connection c)
696 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
699 for (r = c->resultsets; r; r = r->next)
705 odr_destroy(c->odr_in);
706 odr_destroy(c->odr_out);
707 ZOOM_options_destroy(c->options);
708 ZOOM_connection_remove_tasks(c);
714 xfree(c->cookie_out);
720 void ZOOM_resultset_addref(ZOOM_resultset r)
725 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
730 ZOOM_resultset ZOOM_resultset_create(void)
733 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
737 yaz_log(log_details, "%p ZOOM_resultset_create", r);
740 r->odr = odr_createmem(ODR_ENCODE);
745 for (i = 0; i<RECORD_HASH_SIZE; i++)
746 r->record_hash[i] = 0;
751 r->databaseNames = 0;
752 r->num_databaseNames = 0;
756 ZOOM_API(ZOOM_resultset)
757 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
760 ZOOM_query s = ZOOM_query_create();
762 ZOOM_query_prefix(s, q);
764 r = ZOOM_connection_search(c, s);
765 ZOOM_query_destroy(s);
769 ZOOM_API(ZOOM_resultset)
770 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
772 ZOOM_resultset r = ZOOM_resultset_create();
776 const char *syntax, *elementSetName;
778 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
779 r->r_sort_spec = q->sort_spec;
782 r->options = ZOOM_options_create_with_parent(c->options);
784 start = ZOOM_options_get_int(r->options, "start", 0);
785 count = ZOOM_options_get_int(r->options, "count", 0);
787 /* If "presentChunk" is defined use that; otherwise "step" */
788 const char *cp = ZOOM_options_get(r->options, "presentChunk");
789 r->step = ZOOM_options_get_int(r->options,
790 (cp != 0 ? "presentChunk": "step"), 0);
792 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
793 cp = ZOOM_options_get(r->options, "setname");
795 r->setname = xstrdup(cp);
796 cp = ZOOM_options_get(r->options, "schema");
798 r->schema = xstrdup(cp);
800 r->databaseNames = set_DatabaseNames(c, c->options, &r->num_databaseNames,
805 r->next = c->resultsets;
808 if (c->host_port && c->proto == PROTO_HTTP)
812 yaz_log(log_details, "ZOOM_connection_search: no comstack");
813 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
817 yaz_log(log_details, "ZOOM_connection_search: reconnect");
822 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
823 task->u.search.resultset = r;
824 task->u.search.start = start;
825 task->u.search.count = count;
827 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
828 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
829 elementSetName = ZOOM_options_get(r->options, "elementSetName");
830 task->u.search.elementSetName = elementSetName
831 ? xstrdup(elementSetName) : 0;
833 ZOOM_resultset_addref(r);
839 while (ZOOM_event(1, &c))
846 * This is the old result-set sorting API, which is maintained only
847 * for the sake of binary compatibility. There is no reason ever to
848 * use this rather than ZOOM_resultset_sort1().
851 ZOOM_resultset_sort(ZOOM_resultset r,
852 const char *sort_type, const char *sort_spec)
854 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
858 ZOOM_resultset_sort1(ZOOM_resultset r,
859 const char *sort_type, const char *sort_spec)
861 ZOOM_connection c = r->connection;
865 newq = ZOOM_query_create();
866 if (ZOOM_query_sortby(newq, sort_spec) < 0)
869 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
870 r, r, sort_type, sort_spec);
874 if (c->host_port && c->proto == PROTO_HTTP)
878 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
879 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
883 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
889 ZOOM_resultset_cache_reset(r);
890 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
891 task->u.sort.resultset = r;
892 task->u.sort.q = newq;
894 ZOOM_resultset_addref(r);
898 while (ZOOM_event(1, &c))
906 ZOOM_resultset_cache_reset(ZOOM_resultset r)
909 for (i = 0; i<RECORD_HASH_SIZE; i++)
911 ZOOM_record_cache rc;
912 for (rc = r->record_hash[i]; rc; rc = rc->next)
914 if (rc->rec.wrbuf_marc)
915 wrbuf_free(rc->rec.wrbuf_marc, 1);
916 if (rc->rec.wrbuf_iconv)
917 wrbuf_free(rc->rec.wrbuf_iconv, 1);
918 if (rc->rec.wrbuf_opac)
919 wrbuf_free(rc->rec.wrbuf_opac, 1);
921 r->record_hash[i] = 0;
926 ZOOM_resultset_destroy(ZOOM_resultset r)
931 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
933 if (r->refcount == 0)
935 ZOOM_resultset_cache_reset(r);
939 /* remove ourselves from the resultsets in connection */
940 ZOOM_resultset *rp = &r->connection->resultsets;
943 assert(*rp); /* we must be in this list!! */
945 { /* OK, we're here - take us out of it */
952 ZOOM_query_destroy(r->query);
953 ZOOM_options_destroy(r->options);
962 ZOOM_resultset_size(ZOOM_resultset r)
964 yaz_log(log_details, "ZOOM_resultset_size r=%p count=%d",
969 static void do_close(ZOOM_connection c)
974 ZOOM_connection_set_mask(c, 0);
975 c->state = STATE_IDLE;
978 static int ZOOM_test_reconnect(ZOOM_connection c)
980 if (!c->reconnect_ok)
984 c->tasks->running = 0;
985 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
989 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
990 int force_sync, int start, int count)
995 const char *syntax, *elementSetName;
999 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
1000 " count=%d", r, force_sync, start, count);
1005 if (c->host_port && c->proto == PROTO_HTTP)
1009 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
1010 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
1014 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
1016 c->reconnect_ok = 1;
1019 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
1020 task->u.retrieve.resultset = r;
1021 task->u.retrieve.start = start;
1022 task->u.retrieve.count = count;
1024 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
1025 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
1026 elementSetName = ZOOM_options_get(r->options, "elementSetName");
1027 task->u.retrieve.elementSetName = elementSetName
1028 ? xstrdup(elementSetName) : 0;
1030 cp = ZOOM_options_get(r->options, "schema");
1033 if (!r->schema || strcmp(r->schema, cp))
1036 r->schema = xstrdup(cp);
1040 ZOOM_resultset_addref(r);
1042 if (!r->connection->async || force_sync)
1043 while (r->connection && ZOOM_event(1, &r->connection))
1048 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1049 size_t start, size_t count)
1051 int force_present = 0;
1055 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1056 r, r, (long) start, (long) count);
1059 ZOOM_resultset_retrieve(r, force_present, start, count);
1063 for (i = 0; i< count; i++)
1064 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1068 static void get_cert(ZOOM_connection c)
1073 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1075 ZOOM_connection_option_setl(c, "sslPeerCert",
1076 cert_buf, cert_len);
1081 static zoom_ret do_connect(ZOOM_connection c)
1084 const char *effective_host;
1087 effective_host = c->proxy;
1089 effective_host = c->host_port;
1091 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1095 c->cs = cs_create_host(effective_host, 0, &add);
1097 if (c->cs && c->cs->protocol == PROTO_HTTP)
1100 const char *path = 0;
1102 c->proto = PROTO_HTTP;
1103 cs_get_host_args(c->host_port, &path);
1105 c->path = (char*) xmalloc(strlen(path)+2);
1107 strcpy(c->path+1, path);
1109 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1111 return zoom_complete;
1116 int ret = cs_connect(c->cs, add);
1119 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1120 ZOOM_connection_put_event(c, event);
1122 if (c->proto == PROTO_Z3950)
1123 ZOOM_connection_send_init(c);
1126 /* no init request for SRW .. */
1127 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1128 ZOOM_connection_remove_task(c);
1129 ZOOM_connection_set_mask(c, 0);
1130 ZOOM_connection_exec_task(c);
1132 c->state = STATE_ESTABLISHED;
1133 return zoom_pending;
1137 int mask = ZOOM_SELECT_EXCEPT;
1138 if (c->cs->io_pending & CS_WANT_WRITE)
1139 mask += ZOOM_SELECT_WRITE;
1140 if (c->cs->io_pending & CS_WANT_READ)
1141 mask += ZOOM_SELECT_READ;
1142 ZOOM_connection_set_mask(c, mask);
1143 c->state = STATE_CONNECTING;
1144 return zoom_pending;
1147 c->state = STATE_IDLE;
1148 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1149 return zoom_complete;
1152 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1155 for (i = 0; i<200; i++)
1158 Z_OtherInformation **oi;
1164 sprintf(buf, "otherInfo%d", i);
1165 val = ZOOM_options_get(c->options, buf);
1168 cp = strchr(val, ':');
1172 if (len >= sizeof(buf))
1173 len = sizeof(buf)-1;
1174 memcpy(buf, val, len);
1176 oidval = oid_getvalbyname(buf);
1177 if (oidval == VAL_NONE)
1180 yaz_oi_APDU(a, &oi);
1181 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1185 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1190 Z_OtherInformation **oi;
1191 yaz_oi_APDU(a, &oi);
1192 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1196 Z_OtherInformation **oi;
1197 yaz_oi_APDU(a, &oi);
1198 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1200 otherInfo_attach(c, a, out);
1201 if (!z_APDU(out, &a, 0, 0))
1203 FILE *outf = fopen("/tmp/apdu.txt", "a");
1206 ODR odr_pr = odr_createmem(ODR_PRINT);
1207 fprintf(outf, "a=%p\n", a);
1208 odr_setprint(odr_pr, outf);
1209 z_APDU(odr_pr, &a, 0, 0);
1210 odr_destroy(odr_pr);
1212 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1213 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1217 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1221 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1225 if (encode_APDU(c, a, c->odr_out))
1226 return zoom_complete;
1227 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1228 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1229 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1230 ZOOM_connection_put_event(c, event);
1231 odr_reset(c->odr_out);
1235 /* returns 1 if PDU was sent OK (still pending )
1236 0 if PDU was not sent OK (nothing to wait for)
1239 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1241 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1242 Z_InitRequest *ireq = apdu->u.initRequest;
1243 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1244 odr_malloc(c->odr_out, sizeof(*auth));
1245 const char *auth_groupId = ZOOM_options_get(c->options, "group");
1246 const char *auth_userId = ZOOM_options_get(c->options, "user");
1247 const char *auth_password = ZOOM_options_get(c->options, "password");
1250 /* support the pass for backwards compatibility */
1252 auth_password = ZOOM_options_get(c->options, "pass");
1254 ODR_MASK_SET(ireq->options, Z_Options_search);
1255 ODR_MASK_SET(ireq->options, Z_Options_present);
1256 ODR_MASK_SET(ireq->options, Z_Options_scan);
1257 ODR_MASK_SET(ireq->options, Z_Options_sort);
1258 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1259 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1261 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1262 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1263 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1265 /* Index Data's Z39.50 Implementor Id is 81 */
1266 ireq->implementationId =
1267 odr_prepend(c->odr_out,
1268 ZOOM_options_get(c->options, "implementationId"),
1269 odr_prepend(c->odr_out, "81", ireq->implementationId));
1271 ireq->implementationName =
1272 odr_prepend(c->odr_out,
1273 ZOOM_options_get(c->options, "implementationName"),
1274 odr_prepend(c->odr_out, "ZOOM-C",
1275 ireq->implementationName));
1277 version = odr_strdup(c->odr_out, "$Revision: 1.112 $");
1278 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1279 version[strlen(version)-2] = '\0';
1280 ireq->implementationVersion =
1281 odr_prepend(c->odr_out,
1282 ZOOM_options_get(c->options, "implementationVersion"),
1283 odr_prepend(c->odr_out, &version[11],
1284 ireq->implementationVersion));
1286 *ireq->maximumRecordSize =
1287 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
1288 *ireq->preferredMessageSize =
1289 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
1291 if (auth_groupId || auth_password)
1293 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1296 if (auth_groupId && *auth_groupId)
1298 pass->groupId = (char *)
1299 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1300 strcpy(pass->groupId, auth_groupId);
1304 if (auth_userId && *auth_userId)
1306 pass->userId = (char *)
1307 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1308 strcpy(pass->userId, auth_userId);
1312 if (auth_password && *auth_password)
1314 pass->password = (char *)
1315 odr_malloc(c->odr_out, strlen(auth_password)+1);
1316 strcpy(pass->password, auth_password);
1321 auth->which = Z_IdAuthentication_idPass;
1322 auth->u.idPass = pass;
1323 ireq->idAuthentication = auth;
1326 else if (auth_userId)
1328 auth->which = Z_IdAuthentication_open;
1329 auth->u.open = (char *)
1330 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1331 strcpy(auth->u.open, auth_userId);
1332 ireq->idAuthentication = auth;
1335 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1336 VAL_PROXY, 1, c->host_port);
1337 if (c->charset || c->lang)
1339 Z_OtherInformation **oi;
1340 Z_OtherInformationUnit *oi_unit;
1342 yaz_oi_APDU(apdu, &oi);
1344 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1346 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1347 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1348 oi_unit->information.externallyDefinedInfo =
1349 yaz_set_proposal_charneg_list(c->odr_out, " ",
1350 c->charset, c->lang, 1);
1354 return send_APDU(c, apdu);
1358 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1363 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1365 if (c->sru_mode == zoom_sru_get)
1367 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1369 else if (c->sru_mode == zoom_sru_post)
1371 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1373 else if (c->sru_mode == zoom_sru_soap)
1375 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1377 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1378 return zoom_complete;
1379 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1381 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1382 ZOOM_connection_put_event(c, event);
1383 odr_reset(c->odr_out);
1389 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1393 ZOOM_resultset resultset = 0;
1395 const char *option_val = 0;
1397 if (c->error) /* don't continue on error */
1398 return zoom_complete;
1400 switch(c->tasks->which)
1402 case ZOOM_TASK_SEARCH:
1403 resultset = c->tasks->u.search.resultset;
1404 resultset->setname = xstrdup("default");
1405 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1406 start = &c->tasks->u.search.start;
1407 count = &c->tasks->u.search.count;
1409 case ZOOM_TASK_RETRIEVE:
1410 resultset = c->tasks->u.retrieve.resultset;
1412 start = &c->tasks->u.retrieve.start;
1413 count = &c->tasks->u.retrieve.count;
1415 if (*start >= resultset->size)
1416 return zoom_complete;
1417 if (*start + *count > resultset->size)
1418 *count = resultset->size - *start;
1420 for (i = 0; i < *count; i++)
1423 record_cache_lookup(resultset, i + *start,
1424 c->tasks->u.retrieve.syntax,
1425 c->tasks->u.retrieve.elementSetName);
1430 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1431 ZOOM_connection_put_event(c, event);
1438 return zoom_complete;
1441 return zoom_complete;
1443 assert(resultset->query);
1445 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1447 if (resultset->query->z_query->which == Z_Query_type_104
1448 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1450 sr->u.request->query_type = Z_SRW_query_type_cql;
1451 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1453 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1454 resultset->query->z_query->u.type_1)
1456 sr->u.request->query_type = Z_SRW_query_type_pqf;
1457 sr->u.request->query.pqf = resultset->query->query_string;
1461 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1462 return zoom_complete;
1464 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1465 sr->u.request->maximumRecords = odr_intdup(
1466 c->odr_out, resultset->step>0 ? resultset->step : *count);
1467 sr->u.request->recordSchema = resultset->schema;
1469 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1471 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1473 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1475 sr->extra_args = odr_strdup(c->odr_out, option_val);
1476 return send_srw(c, sr);
1479 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1481 return zoom_complete;
1485 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1488 int lslb, ssub, mspn;
1490 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1491 Z_SearchRequest *search_req = apdu->u.searchRequest;
1492 const char *elementSetName;
1493 const char *smallSetElementSetName;
1494 const char *mediumSetElementSetName;
1497 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1499 r = c->tasks->u.search.resultset;
1501 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1504 ZOOM_options_get(r->options, "elementSetName");
1505 smallSetElementSetName =
1506 ZOOM_options_get(r->options, "smallSetElementSetName");
1507 mediumSetElementSetName =
1508 ZOOM_options_get(r->options, "mediumSetElementSetName");
1510 if (!smallSetElementSetName)
1511 smallSetElementSetName = elementSetName;
1513 if (!mediumSetElementSetName)
1514 mediumSetElementSetName = elementSetName;
1519 /* prepare query for the search request */
1520 search_req->query = r->query->z_query;
1521 if (!search_req->query)
1523 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1524 return zoom_complete;
1527 search_req->databaseNames = r->databaseNames;
1528 search_req->num_databaseNames = r->num_databaseNames;
1530 /* get syntax (no need to provide unless piggyback is in effect) */
1531 syntax = c->tasks->u.search.syntax;
1533 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1534 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1535 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1536 if (lslb != -1 && ssub != -1 && mspn != -1)
1538 /* So're a Z39.50 expert? Let's hope you don't do sort */
1539 *search_req->largeSetLowerBound = lslb;
1540 *search_req->smallSetUpperBound = ssub;
1541 *search_req->mediumSetPresentNumber = mspn;
1543 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1544 && r->piggyback && !r->r_sort_spec && !r->schema)
1546 /* Regular piggyback - do it unless we're going to do sort */
1547 *search_req->largeSetLowerBound = 2000000000;
1548 *search_req->smallSetUpperBound = 1;
1549 *search_req->mediumSetPresentNumber =
1550 r->step>0 ? r->step : c->tasks->u.search.count;
1554 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1555 smallSetElementSetName = 0;
1556 mediumSetElementSetName = 0;
1559 if (smallSetElementSetName && *smallSetElementSetName)
1561 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1562 odr_malloc(c->odr_out, sizeof(*esn));
1564 esn->which = Z_ElementSetNames_generic;
1565 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1566 search_req->smallSetElementSetNames = esn;
1568 if (mediumSetElementSetName && *mediumSetElementSetName)
1570 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1571 odr_malloc(c->odr_out, sizeof(*esn));
1573 esn->which = Z_ElementSetNames_generic;
1574 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1575 search_req->mediumSetElementSetNames = esn;
1578 search_req->preferredRecordSyntax =
1579 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1583 if (c->support_named_resultsets)
1587 /* find the lowest unused ordinal so that we re-use
1588 result sets on the server. */
1589 for (ord = 1; ; ord++)
1592 sprintf(setname, "%d", ord);
1593 for (rp = c->resultsets; rp; rp = rp->next)
1594 if (rp->setname && !strcmp(rp->setname, setname))
1599 r->setname = xstrdup(setname);
1600 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1601 "set %s", c, r->setname);
1605 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1607 r->setname = xstrdup("default");
1609 ZOOM_options_set(r->options, "setname", r->setname);
1611 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1612 return send_APDU(c, apdu);
1615 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1622 case Z_DefaultDiagFormat_v2Addinfo:
1623 addinfo = r->u.v2Addinfo;
1625 case Z_DefaultDiagFormat_v3Addinfo:
1626 addinfo = r->u.v3Addinfo;
1631 set_dset_error(c, *r->condition,
1632 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1636 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1638 if (p->which != Z_DiagRec_defaultFormat)
1639 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1641 response_default_diag(c, p->u.defaultFormat);
1644 ZOOM_API(ZOOM_record)
1645 ZOOM_record_clone(ZOOM_record srec)
1652 odr_enc = odr_createmem(ODR_ENCODE);
1653 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1655 buf = odr_getbuf(odr_enc, &size, 0);
1657 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1658 nrec->odr = odr_createmem(ODR_DECODE);
1659 nrec->wrbuf_marc = 0;
1660 nrec->wrbuf_iconv = 0;
1661 nrec->wrbuf_opac = 0;
1662 odr_setbuf(nrec->odr, buf, size, 0);
1663 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1665 odr_destroy(odr_enc);
1669 ZOOM_API(ZOOM_record)
1670 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1672 const char *syntax =
1673 ZOOM_options_get(s->options, "preferredRecordSyntax");
1674 const char *elementSetName =
1675 ZOOM_options_get(s->options, "elementSetName");
1677 return record_cache_lookup(s, pos, syntax, elementSetName);
1680 ZOOM_API(ZOOM_record)
1681 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1683 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1688 * MIKE: I think force_sync should always be zero, but I don't
1689 * want to make this change until I get the go-ahead from
1690 * Adam, in case something depends on the old synchronous
1694 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1695 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1696 rec = ZOOM_resultset_record_immediate(r, pos);
1702 ZOOM_record_destroy(ZOOM_record rec)
1706 if (rec->wrbuf_marc)
1707 wrbuf_free(rec->wrbuf_marc, 1);
1708 if (rec->wrbuf_iconv)
1709 wrbuf_free(rec->wrbuf_iconv, 1);
1710 if (rec->wrbuf_opac)
1711 wrbuf_free(rec->wrbuf_opac, 1);
1712 odr_destroy(rec->odr);
1716 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1718 const char *buf, int sz,
1719 const char *record_charset)
1724 yaz_marc_t mt = yaz_marc_create();
1727 strcpy(to, "UTF-8");
1728 if (record_charset && *record_charset)
1730 /* Use "from,to" or just "from" */
1731 const char *cp = strchr(record_charset, ',');
1732 int clen = strlen(record_charset);
1735 strncpy( to, cp+1, sizeof(to)-1);
1736 to[sizeof(to)-1] = '\0';
1737 clen = cp - record_charset;
1739 if (clen > sizeof(from)-1)
1740 clen = sizeof(from)-1;
1743 strncpy(from, record_charset, clen);
1749 cd = yaz_iconv_open(to, from);
1750 yaz_marc_iconv(mt, cd);
1753 yaz_marc_xml(mt, marc_type);
1754 if (!rec->wrbuf_marc)
1755 rec->wrbuf_marc = wrbuf_alloc();
1756 wrbuf_rewind(rec->wrbuf_marc);
1757 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1759 yaz_marc_destroy(mt);
1761 yaz_iconv_close(cd);
1763 *len = wrbuf_len(rec->wrbuf_marc);
1764 return wrbuf_buf(rec->wrbuf_marc);
1766 yaz_marc_destroy(mt);
1768 yaz_iconv_close(cd);
1772 static const char *record_iconv_return(ZOOM_record rec, int *len,
1773 const char *buf, int sz,
1774 const char *record_charset)
1781 strcpy(to, "UTF-8");
1782 if (record_charset && *record_charset)
1784 /* Use "from,to" or just "from" */
1785 const char *cp = strchr(record_charset, ',');
1786 int clen = strlen(record_charset);
1789 strncpy( to, cp+1, sizeof(to)-1);
1790 to[sizeof(to)-1] = '\0';
1791 clen = cp - record_charset;
1793 if (clen > sizeof(from)-1)
1794 clen = sizeof(from)-1;
1797 strncpy(from, record_charset, clen);
1801 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1804 size_t inbytesleft = sz;
1805 const char *inp = buf;
1807 if (!rec->wrbuf_iconv)
1808 rec->wrbuf_iconv = wrbuf_alloc();
1810 wrbuf_rewind(rec->wrbuf_iconv);
1814 size_t outbytesleft = sizeof(outbuf);
1815 char *outp = outbuf;
1816 size_t r = yaz_iconv(cd, (char**) &inp,
1818 &outp, &outbytesleft);
1819 if (r == (size_t) (-1))
1821 int e = yaz_iconv_error(cd);
1822 if (e != YAZ_ICONV_E2BIG)
1825 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1827 wrbuf_puts(rec->wrbuf_iconv, "");
1828 buf = wrbuf_buf(rec->wrbuf_iconv);
1829 sz = wrbuf_len(rec->wrbuf_iconv);
1830 yaz_iconv_close(cd);
1838 ZOOM_record_error(ZOOM_record rec, const char **cp,
1839 const char **addinfo, const char **diagset)
1841 Z_NamePlusRecord *npr;
1846 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1848 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1849 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1850 const char *add = 0;
1852 if (diag_rec->which == Z_DiagRec_defaultFormat)
1854 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1857 error = *ddf->condition;
1860 case Z_DefaultDiagFormat_v2Addinfo:
1861 add = ddf->u.v2Addinfo;
1863 case Z_DefaultDiagFormat_v3Addinfo:
1864 add = ddf->u.v3Addinfo;
1868 *diagset = yaz_z3950oid_to_str(ddf->diagnosticSetId, &oclass);
1876 *addinfo = add ? add : "";
1878 *cp = diagbib1_str(error);
1884 ZOOM_API(const char *)
1885 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1892 Z_NamePlusRecord *npr;
1895 *len = 0; /* default return */
1904 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1906 if (cp[i] == ';' || cp[i] == ' ')
1912 while (type_spec[i] == ';')
1915 while (type_spec[i] == ' ')
1917 if (!strncmp(type_spec+i, "charset=", 8))
1920 i = i + 8; /* skip charset= */
1921 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1923 if (type_spec[i] == ';' || type_spec[i] == ' ')
1929 else if (!strncmp(type_spec+i, "xpath=", 6))
1933 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1937 while (type_spec[i] == ' ')
1940 if (!strcmp(type, "database"))
1943 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1944 return npr->databaseName;
1946 else if (!strcmp(type, "syntax"))
1948 const char *desc = 0;
1949 if (npr->which == Z_NamePlusRecord_databaseRecord)
1951 Z_External *r = (Z_External *) npr->u.databaseRecord;
1952 oident *ent = oid_getentbyoid(r->direct_reference);
1959 *len = strlen(desc);
1962 if (npr->which != Z_NamePlusRecord_databaseRecord)
1965 /* from now on - we have a database record .. */
1966 if (!strcmp(type, "render"))
1968 Z_External *r = (Z_External *) npr->u.databaseRecord;
1969 oident *ent = oid_getentbyoid(r->direct_reference);
1971 /* render bibliographic record .. */
1972 if (r->which == Z_External_OPAC)
1974 r = r->u.opac->bibliographicRecord;
1977 ent = oid_getentbyoid(r->direct_reference);
1979 if (r->which == Z_External_sutrs)
1980 return record_iconv_return(rec, len,
1981 (char*) r->u.sutrs->buf,
1984 else if (r->which == Z_External_octet)
1986 const char *ret_buf;
1994 case VAL_APPLICATION_XML:
1997 ret_buf = marc_iconv_return(
1998 rec, YAZ_MARC_LINE, len,
1999 (const char *) r->u.octet_aligned->buf,
2000 r->u.octet_aligned->len,
2005 return record_iconv_return(rec, len,
2006 (const char *) r->u.octet_aligned->buf,
2007 r->u.octet_aligned->len,
2010 else if (r->which == Z_External_grs1)
2012 if (!rec->wrbuf_marc)
2013 rec->wrbuf_marc = wrbuf_alloc();
2014 wrbuf_rewind(rec->wrbuf_marc);
2015 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
2016 return record_iconv_return(rec, len,
2017 wrbuf_buf(rec->wrbuf_marc),
2018 wrbuf_len(rec->wrbuf_marc),
2023 else if (!strcmp(type, "xml"))
2025 Z_External *r = (Z_External *) npr->u.databaseRecord;
2026 oident *ent = oid_getentbyoid(r->direct_reference);
2028 /* render bibliographic record .. */
2029 if (r->which == Z_External_OPAC)
2031 r = r->u.opac->bibliographicRecord;
2034 ent = oid_getentbyoid(r->direct_reference);
2037 if (r->which == Z_External_sutrs)
2038 return record_iconv_return(rec, len,
2039 (const char *) r->u.sutrs->buf,
2042 else if (r->which == Z_External_octet)
2044 const char *ret_buf;
2045 int marc_decode_type = YAZ_MARC_MARCXML;
2054 case VAL_APPLICATION_XML:
2057 ret_buf = marc_iconv_return(
2058 rec, marc_decode_type, len,
2059 (const char *) r->u.octet_aligned->buf,
2060 r->u.octet_aligned->len,
2065 return record_iconv_return(rec, len,
2066 (const char *) r->u.octet_aligned->buf,
2067 r->u.octet_aligned->len,
2070 else if (r->which == Z_External_grs1)
2077 else if (!strcmp(type, "raw"))
2079 Z_External *r = (Z_External *) npr->u.databaseRecord;
2081 if (r->which == Z_External_sutrs)
2083 if (len) *len = r->u.sutrs->len;
2084 return (const char *) r->u.sutrs->buf;
2086 else if (r->which == Z_External_octet)
2088 if (len) *len = r->u.octet_aligned->len;
2089 return (const char *) r->u.octet_aligned->buf;
2091 else /* grs-1, explain, OPAC, ... */
2094 return (const char *) npr->u.databaseRecord;
2098 else if (!strcmp (type, "ext"))
2101 return (const char *) npr->u.databaseRecord;
2103 else if (!strcmp (type, "opac"))
2106 Z_External *r = (Z_External *) npr->u.databaseRecord;
2107 if (r->which == Z_External_OPAC)
2109 if (!rec->wrbuf_opac)
2110 rec->wrbuf_opac = wrbuf_alloc();
2111 wrbuf_rewind(rec->wrbuf_opac);
2112 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2113 return record_iconv_return(rec, len,
2114 wrbuf_buf(rec->wrbuf_opac),
2115 wrbuf_len(rec->wrbuf_opac),
2122 static int strcmp_null(const char *v1, const char *v2)
2128 return strcmp(v1, v2);
2131 static size_t record_hash(int pos)
2135 return pos % RECORD_HASH_SIZE;
2138 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2140 const char *syntax, const char *elementSetName)
2142 ZOOM_record_cache rc;
2144 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2145 ZOOM_connection_put_event(r->connection, event);
2147 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2151 if (strcmp_null(r->schema, rc->schema))
2153 if (strcmp_null(elementSetName,rc->elementSetName))
2155 if (strcmp_null(syntax, rc->syntax))
2157 /* not destroying rc->npr (it's handled by nmem )*/
2159 /* keeping wrbuf_marc too */
2163 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2166 rc->rec.wrbuf_marc = 0;
2167 rc->rec.wrbuf_iconv = 0;
2168 rc->rec.wrbuf_opac = 0;
2170 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2172 rc->elementSetName = 0;
2175 rc->syntax = odr_strdup(r->odr, syntax);
2180 rc->schema = odr_strdup(r->odr, r->schema);
2185 rc->next = r->record_hash[record_hash(pos)];
2186 r->record_hash[record_hash(pos)] = rc;
2189 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2191 const char *elementSetName)
2193 ZOOM_record_cache rc;
2195 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2199 if (strcmp_null(r->schema, rc->schema))
2201 if (strcmp_null(elementSetName,rc->elementSetName))
2203 if (strcmp_null(syntax, rc->syntax))
2211 static void handle_records(ZOOM_connection c, Z_Records *sr,
2214 ZOOM_resultset resultset;
2216 const char *syntax = 0, *elementSetName = 0;
2220 switch (c->tasks->which)
2222 case ZOOM_TASK_SEARCH:
2223 resultset = c->tasks->u.search.resultset;
2224 start = &c->tasks->u.search.start;
2225 count = &c->tasks->u.search.count;
2226 syntax = c->tasks->u.search.syntax;
2227 elementSetName = c->tasks->u.search.elementSetName;
2229 case ZOOM_TASK_RETRIEVE:
2230 resultset = c->tasks->u.retrieve.resultset;
2231 start = &c->tasks->u.retrieve.start;
2232 count = &c->tasks->u.retrieve.count;
2233 syntax = c->tasks->u.retrieve.syntax;
2234 elementSetName = c->tasks->u.retrieve.elementSetName;
2239 if (sr && sr->which == Z_Records_NSD)
2240 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2241 else if (sr && sr->which == Z_Records_multipleNSD)
2243 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2244 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2246 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2250 if (*count + *start > resultset->size)
2251 *count = resultset->size - *start;
2254 if (sr && sr->which == Z_Records_DBOSD)
2257 NMEM nmem = odr_extract_mem(c->odr_in);
2258 Z_NamePlusRecordList *p =
2259 sr->u.databaseOrSurDiagnostics;
2260 for (i = 0; i<p->num_records; i++)
2262 record_cache_add(resultset, p->records[i], i + *start,
2263 syntax, elementSetName);
2269 yaz_log(log_details,
2270 "handle_records resultset=%p start=%d count=%d",
2271 resultset, *start, *count);
2273 /* transfer our response to search_nmem .. we need it later */
2274 nmem_transfer(resultset->odr->mem, nmem);
2276 if (present_phase && p->num_records == 0)
2278 /* present response and we didn't get any records! */
2279 Z_NamePlusRecord *myrec =
2280 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2281 record_cache_add(resultset, myrec, *start,
2282 syntax, elementSetName);
2285 else if (present_phase)
2287 /* present response and we didn't get any records! */
2288 Z_NamePlusRecord *myrec =
2289 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2290 record_cache_add(resultset, myrec, *start, syntax, elementSetName);
2295 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2297 handle_records(c, pr->records, 1);
2300 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2303 switch (term->which)
2305 case Z_Term_general:
2306 ZOOM_options_setl(opt, name,
2307 (const char *)(term->u.general->buf),
2308 term->u.general->len);
2310 case Z_Term_characterString:
2311 ZOOM_options_set(opt, name, term->u.characterString);
2313 case Z_Term_numeric:
2314 ZOOM_options_set_int(opt, name, *term->u.numeric);
2319 static void handle_queryExpression(ZOOM_options opt, const char *name,
2320 Z_QueryExpression *exp)
2326 case Z_QueryExpression_term:
2327 if (exp->u.term && exp->u.term->queryTerm)
2329 sprintf(opt_name, "%s.term", name);
2330 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2333 case Z_QueryExpression_query:
2338 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2339 Z_OtherInformation *o)
2342 for (i = 0; o && i < o->num_elements; i++)
2344 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2346 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2348 if (ext->which == Z_External_searchResult1)
2351 Z_SearchInfoReport *sr = ext->u.searchResult1;
2354 ZOOM_options_set_int(
2355 resultset->options, "searchresult.size", sr->num);
2357 for (j = 0; j < sr->num; j++)
2359 Z_SearchInfoReport_s *ent =
2360 ext->u.searchResult1->elements[j];
2363 sprintf(pref, "searchresult.%d", j);
2365 if (ent->subqueryId)
2368 sprintf(opt_name, "%s.id", pref);
2369 ZOOM_options_set(resultset->options, opt_name,
2372 if (ent->subqueryExpression)
2375 sprintf(opt_name, "%s.subquery", pref);
2376 handle_queryExpression(resultset->options, opt_name,
2377 ent->subqueryExpression);
2379 if (ent->subqueryInterpretation)
2382 sprintf(opt_name, "%s.interpretation", pref);
2383 handle_queryExpression(resultset->options, opt_name,
2384 ent->subqueryInterpretation);
2386 if (ent->subqueryRecommendation)
2389 sprintf(opt_name, "%s.recommendation", pref);
2390 handle_queryExpression(resultset->options, opt_name,
2391 ent->subqueryRecommendation);
2393 if (ent->subqueryCount)
2396 sprintf(opt_name, "%s.count", pref);
2397 ZOOM_options_set_int(resultset->options, opt_name,
2398 *ent->subqueryCount);
2406 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2408 ZOOM_resultset resultset;
2411 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2414 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2415 ZOOM_connection_put_event(c, event);
2417 resultset = c->tasks->u.search.resultset;
2419 if (sr->resultSetStatus)
2421 ZOOM_options_set_int(resultset->options, "resultSetStatus",
2422 *sr->resultSetStatus);
2424 if (sr->presentStatus)
2426 ZOOM_options_set_int(resultset->options, "presentStatus",
2427 *sr->presentStatus);
2429 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2431 resultset->size = *sr->resultCount;
2432 handle_records(c, sr->records, 0);
2435 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2437 if (res->diagnostics && res->num_diagnostics > 0)
2438 response_diag(c, res->diagnostics[0]);
2441 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2443 NMEM nmem = odr_extract_mem(c->odr_in);
2446 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2448 scan = c->tasks->u.scan.scan;
2450 if (res->entries && res->entries->nonsurrogateDiagnostics)
2451 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2452 scan->scan_response = res;
2453 nmem_transfer(scan->odr->mem, nmem);
2455 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2456 if (res->positionOfTerm)
2457 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2458 if (res->scanStatus)
2459 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2460 if (res->numberOfEntriesReturned)
2461 ZOOM_options_set_int(scan->options, "number",
2462 *res->numberOfEntriesReturned);
2467 static zoom_ret send_sort(ZOOM_connection c,
2468 ZOOM_resultset resultset)
2471 resultset->r_sort_spec = 0;
2472 if (resultset->r_sort_spec)
2474 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2475 Z_SortRequest *req = apdu->u.sortRequest;
2477 req->num_inputResultSetNames = 1;
2478 req->inputResultSetNames = (Z_InternationalString **)
2479 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2480 req->inputResultSetNames[0] =
2481 odr_strdup(c->odr_out, resultset->setname);
2482 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2483 req->sortSequence = resultset->r_sort_spec;
2484 resultset->r_sort_spec = 0;
2485 return send_APDU(c, apdu);
2487 return zoom_complete;
2490 static zoom_ret send_present(ZOOM_connection c)
2493 Z_PresentRequest *req = 0;
2495 const char *syntax = 0;
2496 const char *elementSetName = 0;
2497 ZOOM_resultset resultset;
2502 yaz_log(log_details, "%p send_present no tasks", c);
2503 return zoom_complete;
2506 switch (c->tasks->which)
2508 case ZOOM_TASK_SEARCH:
2509 resultset = c->tasks->u.search.resultset;
2510 start = &c->tasks->u.search.start;
2511 count = &c->tasks->u.search.count;
2512 syntax = c->tasks->u.search.syntax;
2513 elementSetName = c->tasks->u.search.elementSetName;
2515 case ZOOM_TASK_RETRIEVE:
2516 resultset = c->tasks->u.retrieve.resultset;
2517 start = &c->tasks->u.retrieve.start;
2518 count = &c->tasks->u.retrieve.count;
2519 syntax = c->tasks->u.retrieve.syntax;
2520 elementSetName = c->tasks->u.retrieve.elementSetName;
2523 return zoom_complete;
2525 yaz_log(log_details, "%p send_present start=%d count=%d",
2528 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
2530 set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
2533 if (c->error) /* don't continue on error */
2534 return zoom_complete;
2535 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2536 resultset, *start, *count);
2538 for (i = 0; i < *count; i++)
2541 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2546 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2547 ZOOM_connection_put_event(c, event);
2555 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2556 return zoom_complete;
2559 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2560 req = apdu->u.presentRequest;
2563 yaz_log(log_details, "%p send_present skip=%d", c, i);
2565 *req->resultSetStartPoint = *start + 1;
2566 *req->numberOfRecordsRequested = resultset->step>0 ?
2567 resultset->step : *count;
2568 if (*req->numberOfRecordsRequested + *start > resultset->size)
2569 *req->numberOfRecordsRequested = resultset->size - *start;
2570 assert(*req->numberOfRecordsRequested > 0);
2572 if (syntax && *syntax)
2573 req->preferredRecordSyntax =
2574 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
2576 if (resultset->schema && *resultset->schema)
2578 Z_RecordComposition *compo = (Z_RecordComposition *)
2579 odr_malloc(c->odr_out, sizeof(*compo));
2581 req->recordComposition = compo;
2582 compo->which = Z_RecordComp_complex;
2583 compo->u.complex = (Z_CompSpec *)
2584 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2585 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2586 odr_malloc(c->odr_out, sizeof(bool_t));
2587 *compo->u.complex->selectAlternativeSyntax = 0;
2589 compo->u.complex->generic = (Z_Specification *)
2590 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2592 compo->u.complex->generic->which = Z_Schema_oid;
2593 compo->u.complex->generic->schema.oid = (Odr_oid *)
2594 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
2596 if (!compo->u.complex->generic->schema.oid)
2598 /* OID wasn't a schema! Try record syntax instead. */
2600 compo->u.complex->generic->schema.oid = (Odr_oid *)
2601 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
2603 if (elementSetName && *elementSetName)
2605 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2606 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2607 compo->u.complex->generic->elementSpec->which =
2608 Z_ElementSpec_elementSetName;
2609 compo->u.complex->generic->elementSpec->u.elementSetName =
2610 odr_strdup(c->odr_out, elementSetName);
2613 compo->u.complex->generic->elementSpec = 0;
2614 compo->u.complex->num_dbSpecific = 0;
2615 compo->u.complex->dbSpecific = 0;
2616 compo->u.complex->num_recordSyntax = 0;
2617 compo->u.complex->recordSyntax = 0;
2619 else if (elementSetName && *elementSetName)
2621 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2622 odr_malloc(c->odr_out, sizeof(*esn));
2623 Z_RecordComposition *compo = (Z_RecordComposition *)
2624 odr_malloc(c->odr_out, sizeof(*compo));
2626 esn->which = Z_ElementSetNames_generic;
2627 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2628 compo->which = Z_RecordComp_simple;
2629 compo->u.simple = esn;
2630 req->recordComposition = compo;
2632 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2633 return send_APDU(c, apdu);
2636 ZOOM_API(ZOOM_scanset)
2637 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2640 ZOOM_query q = ZOOM_query_create();
2642 ZOOM_query_prefix(q, start);
2644 s = ZOOM_connection_scan1(c, q);
2645 ZOOM_query_destroy(q);
2650 ZOOM_API(ZOOM_scanset)
2651 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2655 ZOOM_scanset scan = 0;
2658 * We need to check the query-type, so we can recognise CQL and
2659 * CCL and compile them into a form that we can use here. The
2660 * ZOOM_query structure has no explicit `type' member, but
2661 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2662 * functions shows how the structure is set up in each case.
2666 else if (q->z_query->which == Z_Query_type_1)
2668 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2669 c, q, q->query_string);
2670 start = q->query_string;
2672 else if (q->z_query->which == Z_Query_type_104)
2674 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2675 c, q, q->query_string);
2676 start = freeme = cql2pqf(c, q->query_string);
2682 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2683 c, q, q->query_string);
2687 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2688 scan->connection = c;
2689 scan->odr = odr_createmem(ODR_DECODE);
2690 scan->options = ZOOM_options_create_with_parent(c->options);
2692 scan->scan_response = 0;
2693 scan->termListAndStartPoint =
2694 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2697 scan->databaseNames = set_DatabaseNames(c, c->options,
2698 &scan->num_databaseNames,
2700 if (scan->termListAndStartPoint != 0)
2702 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2703 task->u.scan.scan = scan;
2708 while (ZOOM_event(1, &c))
2716 ZOOM_scanset_destroy(ZOOM_scanset scan)
2721 if (scan->refcount == 0)
2723 odr_destroy(scan->odr);
2725 ZOOM_options_destroy(scan->options);
2730 static zoom_ret send_package(ZOOM_connection c)
2734 yaz_log(log_details, "%p send_package", c);
2736 return zoom_complete;
2737 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2739 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2740 ZOOM_connection_put_event(c, event);
2742 c->buf_out = c->tasks->u.package->buf_out;
2743 c->len_out = c->tasks->u.package->len_out;
2748 static zoom_ret send_scan(ZOOM_connection c)
2751 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2752 Z_ScanRequest *req = apdu->u.scanRequest;
2754 yaz_log(log_details, "%p send_scan", c);
2756 return zoom_complete;
2757 assert (c->tasks->which == ZOOM_TASK_SCAN);
2758 scan = c->tasks->u.scan.scan;
2760 req->termListAndStartPoint = scan->termListAndStartPoint;
2761 req->attributeSet = scan->attributeSet;
2763 *req->numberOfTermsRequested =
2764 ZOOM_options_get_int(scan->options, "number", 10);
2766 req->preferredPositionInResponse =
2767 odr_intdup(c->odr_out,
2768 ZOOM_options_get_int(scan->options, "position", 1));
2771 odr_intdup(c->odr_out,
2772 ZOOM_options_get_int(scan->options, "stepSize", 0));
2774 req->databaseNames = scan->databaseNames;
2775 req->num_databaseNames = scan->num_databaseNames;
2777 return send_APDU(c, apdu);
2781 ZOOM_scanset_size(ZOOM_scanset scan)
2783 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2785 return scan->scan_response->entries->num_entries;
2788 ZOOM_API(const char *)
2789 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2792 const char *term = 0;
2793 size_t noent = ZOOM_scanset_size(scan);
2794 Z_ScanResponse *res = scan->scan_response;
2800 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2802 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2804 if (t->term->which == Z_Term_general)
2806 term = (const char *) t->term->u.general->buf;
2807 *len = t->term->u.general->len;
2809 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2814 ZOOM_API(const char *)
2815 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2818 const char *term = 0;
2819 size_t noent = ZOOM_scanset_size(scan);
2820 Z_ScanResponse *res = scan->scan_response;
2826 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2828 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2832 term = t->displayTerm;
2833 *len = strlen(term);
2835 else if (t->term->which == Z_Term_general)
2837 term = (const char *) t->term->u.general->buf;
2838 *len = t->term->u.general->len;
2840 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2845 ZOOM_API(const char *)
2846 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2848 return ZOOM_options_get(scan->options, key);
2852 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2855 ZOOM_options_set(scan->options, key, val);
2858 static Z_APDU *create_es_package(ZOOM_package p, int type)
2861 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2862 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2864 *req->function = Z_ExtendedServicesRequest_create;
2866 str = ZOOM_options_get(p->options, "package-name");
2868 req->packageName = nmem_strdup(p->odr_out->mem, str);
2870 str = ZOOM_options_get(p->options, "user-id");
2872 req->userId = nmem_strdup(p->odr_out->mem, str);
2874 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2877 str = ZOOM_options_get(p->options, "function");
2880 if (!strcmp (str, "create"))
2882 if (!strcmp (str, "delete"))
2884 if (!strcmp (str, "modify"))
2890 static const char *ill_array_lookup(void *clientData, const char *idx)
2892 ZOOM_package p = (ZOOM_package) clientData;
2893 return ZOOM_options_get(p->options, idx+4);
2896 static Z_External *encode_ill_request(ZOOM_package p)
2898 ODR out = p->odr_out;
2901 struct ill_get_ctl ctl;
2903 ctl.odr = p->odr_out;
2905 ctl.f = ill_array_lookup;
2907 req = ill_get_ILLRequest(&ctl, "ill", 0);
2909 if (!ill_Request(out, &req, 0, 0))
2911 int ill_request_size;
2912 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2913 if (ill_request_buf)
2914 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2920 int illRequest_size = 0;
2921 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2923 oid.proto = PROTO_GENERAL;
2924 oid.oclass = CLASS_GENERAL;
2925 oid.value = VAL_ISO_ILL_1;
2927 r = (Z_External *) odr_malloc(out, sizeof(*r));
2928 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2929 r->indirect_reference = 0;
2931 r->which = Z_External_single;
2933 r->u.single_ASN1_type =
2934 odr_create_Odr_oct(out,
2935 (unsigned char *)illRequest_buf,
2941 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2943 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2946 req->which = Z_IOItemOrder_esRequest;
2947 req->u.esRequest = (Z_IORequest *)
2948 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2950 /* to keep part ... */
2951 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2952 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2953 req->u.esRequest->toKeep->supplDescription = 0;
2954 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2955 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2957 str = ZOOM_options_get(p->options, "contact-name");
2958 req->u.esRequest->toKeep->contact->name = str ?
2959 nmem_strdup(p->odr_out->mem, str) : 0;
2961 str = ZOOM_options_get(p->options, "contact-phone");
2962 req->u.esRequest->toKeep->contact->phone = str ?
2963 nmem_strdup(p->odr_out->mem, str) : 0;
2965 str = ZOOM_options_get(p->options, "contact-email");
2966 req->u.esRequest->toKeep->contact->email = str ?
2967 nmem_strdup(p->odr_out->mem, str) : 0;
2969 req->u.esRequest->toKeep->addlBilling = 0;
2971 /* not to keep part ... */
2972 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2973 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2975 str = ZOOM_options_get(p->options, "itemorder-setname");
2980 req->u.esRequest->notToKeep->resultSetItem = 0;
2983 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2984 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2986 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2987 nmem_strdup(p->odr_out->mem, str);
2988 req->u.esRequest->notToKeep->resultSetItem->item =
2989 (int *) odr_malloc(p->odr_out, sizeof(int));
2991 str = ZOOM_options_get(p->options, "itemorder-item");
2992 *req->u.esRequest->notToKeep->resultSetItem->item =
2993 (str ? atoi(str) : 1);
2996 str = ZOOM_options_get(p->options, "doc");
2998 req->u.esRequest->notToKeep->itemRequest =
2999 z_ext_record(p->odr_out, VAL_TEXT_XML, str, strlen(str));
3001 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
3006 Z_APDU *create_admin_package(ZOOM_package p, int type,
3007 Z_ESAdminOriginPartToKeep **toKeepP,
3008 Z_ESAdminOriginPartNotToKeep **notToKeepP)
3010 Z_APDU *apdu = create_es_package(p, VAL_ADMINSERVICE);
3013 Z_ESAdminOriginPartToKeep *toKeep;
3014 Z_ESAdminOriginPartNotToKeep *notToKeep;
3015 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3016 const char *first_db = "Default";
3018 char **db = set_DatabaseNames(p->connection, p->options, &num_db,
3023 r->direct_reference =
3024 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3027 r->indirect_reference = 0;
3028 r->which = Z_External_ESAdmin;
3030 r->u.adminService = (Z_Admin *)
3031 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
3032 r->u.adminService->which = Z_Admin_esRequest;
3033 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
3034 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
3036 toKeep = r->u.adminService->u.esRequest->toKeep =
3037 (Z_ESAdminOriginPartToKeep *)
3038 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
3039 toKeep->which = type;
3040 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3041 toKeep->u.create = odr_nullval();
3042 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3044 r->u.adminService->u.esRequest->notToKeep = notToKeep =
3045 (Z_ESAdminOriginPartNotToKeep *)
3046 odr_malloc(p->odr_out,
3047 sizeof(*r->u.adminService->u.esRequest->notToKeep));
3048 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3049 notToKeep->u.recordsWillFollow = odr_nullval();
3053 *notToKeepP = notToKeep;
3058 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3060 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
3061 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3062 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3063 const char *doc = ZOOM_options_get(p->options, "doc");
3068 req->taskSpecificParameters = ext;
3069 ext->direct_reference = req->packageType;
3070 ext->descriptor = 0;
3071 ext->indirect_reference = 0;
3073 ext->which = Z_External_octet;
3074 ext->u.single_ASN1_type =
3075 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
3080 static Z_APDU *create_update_package(ZOOM_package p)
3083 const char *first_db = "Default";
3085 char **db = set_DatabaseNames(p->connection, p->options, &num_db, p->odr_out);
3086 const char *action = ZOOM_options_get(p->options, "action");
3087 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
3088 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3089 const char *record_buf = ZOOM_options_get(p->options, "record");
3090 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3091 int syntax_oid = VAL_NONE;
3095 syntax_oid = oid_getvalbyname(syntax_str);
3098 record_buf = "void";
3099 syntax_oid = VAL_SUTRS;
3101 if (syntax_oid == VAL_NONE)
3102 syntax_oid = VAL_TEXT_XML;
3108 action = "specialUpdate";
3110 if (!strcmp(action, "recordInsert"))
3111 action_no = Z_IUOriginPartToKeep_recordInsert;
3112 else if (!strcmp(action, "recordReplace"))
3113 action_no = Z_IUOriginPartToKeep_recordReplace;
3114 else if (!strcmp(action, "recordDelete"))
3115 action_no = Z_IUOriginPartToKeep_recordDelete;
3116 else if (!strcmp(action, "elementUpdate"))
3117 action_no = Z_IUOriginPartToKeep_elementUpdate;
3118 else if (!strcmp(action, "specialUpdate"))
3119 action_no = Z_IUOriginPartToKeep_specialUpdate;
3123 apdu = create_es_package(p, VAL_DBUPDATE);
3126 Z_IUOriginPartToKeep *toKeep;
3127 Z_IUSuppliedRecords *notToKeep;
3128 Z_External *r = (Z_External *)
3129 odr_malloc(p->odr_out, sizeof(*r));
3131 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3133 r->direct_reference =
3134 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3137 r->which = Z_External_update;
3138 r->indirect_reference = 0;
3139 r->u.update = (Z_IUUpdate *)
3140 odr_malloc(p->odr_out, sizeof(*r->u.update));
3142 r->u.update->which = Z_IUUpdate_esRequest;
3143 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3144 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3145 toKeep = r->u.update->u.esRequest->toKeep =
3146 (Z_IUOriginPartToKeep *)
3147 odr_malloc(p->odr_out, sizeof(*toKeep));
3149 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3151 toKeep->elementSetName = 0;
3152 toKeep->actionQualifier = 0;
3153 toKeep->action = odr_intdup(p->odr_out, action_no);
3155 notToKeep = r->u.update->u.esRequest->notToKeep =
3156 (Z_IUSuppliedRecords *)
3157 odr_malloc(p->odr_out, sizeof(*notToKeep));
3159 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3160 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3161 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3162 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3163 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3166 notToKeep->elements[0]->u.opaque =
3167 odr_create_Odr_oct(p->odr_out,
3168 (const unsigned char *) recordIdOpaque,
3169 strlen(recordIdOpaque));
3171 else if (recordIdNumber)
3173 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3175 notToKeep->elements[0]->u.number =
3176 odr_intdup(p->odr_out, atoi(recordIdNumber));
3179 notToKeep->elements[0]->u.opaque = 0;
3180 notToKeep->elements[0]->supplementalId = 0;
3181 notToKeep->elements[0]->correlationInfo = 0;
3182 notToKeep->elements[0]->record =
3183 z_ext_record(p->odr_out, syntax_oid,
3184 record_buf, strlen(record_buf));
3188 ODR print = odr_createmem(ODR_PRINT);
3190 z_APDU(print, &apdu, 0, 0);
3197 ZOOM_package_send(ZOOM_package p, const char *type)
3204 odr_reset(p->odr_out);
3207 if (!strcmp(type, "itemorder"))
3209 apdu = create_es_package(p, VAL_ITEMORDER);
3212 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3214 r->direct_reference =
3215 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3218 r->which = Z_External_itemOrder;
3219 r->indirect_reference = 0;
3220 r->u.itemOrder = encode_item_order(p);
3222 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3225 else if (!strcmp(type, "create")) /* create database */
3227 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3230 else if (!strcmp(type, "drop")) /* drop database */
3232 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3235 else if (!strcmp(type, "commit")) /* commit changes */
3237 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3240 else if (!strcmp(type, "update")) /* update record(s) */
3242 apdu = create_update_package(p);
3244 else if (!strcmp(type, "xmlupdate"))
3246 apdu = create_xmlupdate_package(p);
3250 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3254 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3255 task->u.package = p;
3256 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3257 p->buf_out = (char *) xmalloc(p->len_out);
3258 memcpy(p->buf_out, buf, p->len_out);
3263 while (ZOOM_event(1, &c))
3270 ZOOM_API(ZOOM_package)
3271 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3273 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3276 p->odr_out = odr_createmem(ODR_ENCODE);
3277 p->options = ZOOM_options_create_with_parent2(options, c->options);
3285 ZOOM_package_destroy(ZOOM_package p)
3290 if (p->refcount == 0)
3292 odr_destroy(p->odr_out);
3295 ZOOM_options_destroy(p->options);
3300 ZOOM_API(const char *)
3301 ZOOM_package_option_get(ZOOM_package p, const char *key)
3303 return ZOOM_options_get(p->options, key);
3308 ZOOM_package_option_set(ZOOM_package p, const char *key,
3311 ZOOM_options_set(p->options, key, val);
3314 static int ZOOM_connection_exec_task(ZOOM_connection c)
3316 ZOOM_task task = c->tasks;
3317 zoom_ret ret = zoom_complete;
3321 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3322 c, task->which, task->running);
3323 if (c->error != ZOOM_ERROR_NONE)
3325 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3326 "removing tasks because of error = %d", c, c->error);
3327 ZOOM_connection_remove_tasks(c);
3332 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3333 "task already running", c);
3337 ret = zoom_complete;
3338 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3340 switch (task->which)
3342 case ZOOM_TASK_SEARCH:
3343 if (c->proto == PROTO_HTTP)
3344 ret = ZOOM_connection_srw_send_search(c);
3346 ret = ZOOM_connection_send_search(c);
3348 case ZOOM_TASK_RETRIEVE:
3349 if (c->proto == PROTO_HTTP)
3350 ret = ZOOM_connection_srw_send_search(c);
3352 ret = send_present(c);
3354 case ZOOM_TASK_CONNECT:
3355 ret = do_connect(c);
3357 case ZOOM_TASK_SCAN:
3360 case ZOOM_TASK_PACKAGE:
3361 ret = send_package(c);
3363 case ZOOM_TASK_SORT:
3364 c->tasks->u.sort.resultset->r_sort_spec =
3365 c->tasks->u.sort.q->sort_spec;
3366 ret = send_sort(c, c->tasks->u.sort.resultset);
3372 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3373 "remove tasks because no connection exist", c);
3374 ZOOM_connection_remove_tasks(c);
3376 if (ret == zoom_complete)
3378 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3379 "task removed (complete)", c);
3380 ZOOM_connection_remove_task(c);
3383 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3388 static zoom_ret send_sort_present(ZOOM_connection c)
3390 zoom_ret r = zoom_complete;
3392 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3393 r = send_sort(c, c->tasks->u.search.resultset);
3394 if (r == zoom_complete)
3395 r = send_present(c);
3399 static int es_response(ZOOM_connection c,
3400 Z_ExtendedServicesResponse *res)
3402 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3404 if (res->diagnostics && res->num_diagnostics > 0)
3405 response_diag(c, res->diagnostics[0]);
3406 if (res->taskPackage &&
3407 res->taskPackage->which == Z_External_extendedService)
3409 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3410 Odr_oct *id = taskPackage->targetReference;
3413 ZOOM_options_setl(c->tasks->u.package->options,
3414 "targetReference", (char*) id->buf, id->len);
3416 if (res->taskPackage &&
3417 res->taskPackage->which == Z_External_octet)
3419 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3420 ZOOM_options_setl(c->tasks->u.package->options,
3421 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3426 static void interpret_init_diag(ZOOM_connection c,
3427 Z_DiagnosticFormat *diag)
3431 Z_DiagnosticFormat_s *ds = diag->elements[0];
3432 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3433 response_default_diag(c, ds->u.defaultDiagRec);
3438 static void interpret_otherinformation_field(ZOOM_connection c,
3439 Z_OtherInformation *ui)
3442 for (i = 0; i < ui->num_elements; i++)
3444 Z_OtherInformationUnit *unit = ui->list[i];
3445 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3446 unit->information.externallyDefinedInfo &&
3447 unit->information.externallyDefinedInfo->which ==
3450 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3456 static void set_init_option(const char *name, void *clientData) {
3457 ZOOM_connection c = clientData;
3460 sprintf(buf, "init_opt_%.70s", name);
3461 ZOOM_connection_option_set(c, buf, "1");
3465 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3467 Z_InitResponse *initrs;
3469 ZOOM_connection_set_mask(c, 0);
3470 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3473 case Z_APDU_initResponse:
3474 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3475 initrs = apdu->u.initResponse;
3476 ZOOM_connection_option_set(c, "serverImplementationId",
3477 initrs->implementationId ?
3478 initrs->implementationId : "");
3479 ZOOM_connection_option_set(c, "serverImplementationName",
3480 initrs->implementationName ?
3481 initrs->implementationName : "");
3482 ZOOM_connection_option_set(c, "serverImplementationVersion",
3483 initrs->implementationVersion ?
3484 initrs->implementationVersion : "");
3485 /* Set the three old options too, for old applications */
3486 ZOOM_connection_option_set(c, "targetImplementationId",
3487 initrs->implementationId ?
3488 initrs->implementationId : "");
3489 ZOOM_connection_option_set(c, "targetImplementationName",
3490 initrs->implementationName ?
3491 initrs->implementationName : "");
3492 ZOOM_connection_option_set(c, "targetImplementationVersion",
3493 initrs->implementationVersion ?
3494 initrs->implementationVersion : "");
3496 /* Make initrs->options available as ZOOM-level options */
3497 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
3499 if (!*initrs->result)
3501 Z_External *uif = initrs->userInformationField;
3503 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3505 if (uif && uif->which == Z_External_userInfo1)
3506 interpret_otherinformation_field(c, uif->u.userInfo1);
3511 yaz_oi_get_string_oidval(&apdu->u.initResponse->otherInfo,
3513 xfree(c->cookie_in);
3516 c->cookie_in = xstrdup(cookie);
3517 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3518 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3519 c->support_named_resultsets = 1;
3522 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3523 ZOOM_connection_remove_task(c);
3525 ZOOM_connection_exec_task(c);
3527 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3529 NMEM tmpmem = nmem_create();
3530 Z_CharSetandLanguageNegotiation *p =
3531 yaz_get_charneg_record(initrs->otherInfo);
3535 char *charset = NULL, *lang = NULL;
3538 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3539 yaz_log(log_details, "%p recv_apdu target accepted: "
3540 "charset %s, language %s, select %d",
3542 charset ? charset : "none", lang ? lang : "none", sel);
3544 ZOOM_connection_option_set(c, "negotiation-charset",
3547 ZOOM_connection_option_set(c, "negotiation-lang",
3550 ZOOM_connection_option_set(
3551 c, "negotiation-charset-in-effect-for-records",
3552 (sel != 0) ? "1" : "0");
3553 nmem_destroy(tmpmem);
3557 case Z_APDU_searchResponse:
3558 yaz_log(log_api, "%p recv_apdu Search response", c);
3559 handle_search_response(c, apdu->u.searchResponse);
3560 if (send_sort_present(c) == zoom_complete)
3561 ZOOM_connection_remove_task(c);
3563 case Z_APDU_presentResponse:
3564 yaz_log(log_api, "%p recv_apdu Present response", c);
3565 handle_present_response(c, apdu->u.presentResponse);
3566 if (send_present(c) == zoom_complete)
3567 ZOOM_connection_remove_task(c);
3569 case Z_APDU_sortResponse:
3570 yaz_log(log_api, "%p recv_apdu Sort response", c);
3571 sort_response(c, apdu->u.sortResponse);
3572 if (send_present(c) == zoom_complete)
3573 ZOOM_connection_remove_task(c);
3575 case Z_APDU_scanResponse:
3576 yaz_log(log_api, "%p recv_apdu Scan response", c);
3577 scan_response(c, apdu->u.scanResponse);
3578 ZOOM_connection_remove_task(c);
3580 case Z_APDU_extendedServicesResponse:
3581 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3582 es_response(c, apdu->u.extendedServicesResponse);
3583 ZOOM_connection_remove_task(c);
3586 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3587 if (!ZOOM_test_reconnect(c))
3589 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3594 yaz_log(log_api, "%p Received unknown PDU", c);
3595 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3601 static void handle_srw_response(ZOOM_connection c,
3602 Z_SRW_searchRetrieveResponse *res)
3604 ZOOM_resultset resultset = 0;
3609 const char *syntax, *elementSetName;
3614 switch(c->tasks->which)
3616 case ZOOM_TASK_SEARCH:
3617 resultset = c->tasks->u.search.resultset;
3618 start = &c->tasks->u.search.start;
3619 syntax = c->tasks->u.search.syntax;
3620 elementSetName = c->tasks->u.search.elementSetName;
3622 case ZOOM_TASK_RETRIEVE:
3623 resultset = c->tasks->u.retrieve.resultset;
3624 start = &c->tasks->u.retrieve.start;
3625 syntax = c->tasks->u.retrieve.syntax;
3626 elementSetName = c->tasks->u.retrieve.elementSetName;
3631 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3632 ZOOM_connection_put_event(c, event);
3634 resultset->size = 0;
3636 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3638 if (res->numberOfRecords)
3639 resultset->size = *res->numberOfRecords;
3641 for (i = 0; i<res->num_records; i++)
3645 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3646 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3648 if (res->records[i].recordPosition &&
3649 *res->records[i].recordPosition > 0)
3650 pos = *res->records[i].recordPosition - 1;
3654 npr->databaseName = 0;
3655 npr->which = Z_NamePlusRecord_databaseRecord;
3656 npr->u.databaseRecord = (Z_External *)
3657 odr_malloc(c->odr_in, sizeof(Z_External));
3658 npr->u.databaseRecord->descriptor = 0;
3659 npr->u.databaseRecord->direct_reference =
3660 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3661 npr->u.databaseRecord->which = Z_External_octet;
3663 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3664 odr_malloc(c->odr_in, sizeof(Odr_oct));
3665 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3666 res->records[i].recordData_buf;
3667 npr->u.databaseRecord->u.octet_aligned->len =
3668 npr->u.databaseRecord->u.octet_aligned->size =
3669 res->records[i].recordData_len;
3670 record_cache_add(resultset, npr, pos, syntax, elementSetName);
3672 if (res->num_diagnostics > 0)
3674 const char *uri = res->diagnostics[0].uri;
3679 if ((cp = strrchr(uri, '/')))
3681 set_dset_error(c, code, uri,
3682 res->diagnostics[0].details, 0);
3685 nmem = odr_extract_mem(c->odr_in);
3686 nmem_transfer(resultset->odr->mem, nmem);
3692 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3695 const char *content_type = z_HTTP_header_lookup(hres->headers,
3697 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3699 ZOOM_connection_set_mask(c, 0);
3700 yaz_log(log_details, "%p handle_http", c);
3702 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3704 Z_SOAP *soap_package = 0;
3706 Z_SOAP_Handler soap_handlers[2] = {
3707 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
3710 ret = z_soap_codec(o, &soap_package,
3711 &hres->content_buf, &hres->content_len,
3713 if (!ret && soap_package->which == Z_SOAP_generic &&
3714 soap_package->u.generic->no == 0)
3716 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3717 if (sr->which == Z_SRW_searchRetrieve_response)
3718 handle_srw_response(c, sr->u.response);
3722 else if (!ret && (soap_package->which == Z_SOAP_fault
3723 || soap_package->which == Z_SOAP_error))
3725 set_HTTP_error(c, hres->code,
3726 soap_package->u.fault->fault_code,
3727 soap_package->u.fault->fault_string);
3734 if (hres->code != 200)
3735 set_HTTP_error(c, hres->code, 0, 0);
3737 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3740 ZOOM_connection_remove_task(c);
3741 if (!strcmp(hres->version, "1.0"))
3743 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3744 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3749 /* HTTP 1.1: only if no close we stay alive .. */
3750 if (connection_head && !strcmp(connection_head, "close"))
3756 static int do_read(ZOOM_connection c)
3761 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3762 ZOOM_connection_put_event(c, event);
3764 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3765 more = cs_more(c->cs);
3766 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3771 if (ZOOM_test_reconnect(c))
3773 yaz_log(log_details, "%p do_read reconnect read", c);
3777 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3786 odr_reset(c->odr_in);
3787 odr_setbuf(c->odr_in, c->buf_in, r, 0);
3788 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3789 ZOOM_connection_put_event(c, event);
3791 if (!z_GDU(c->odr_in, &gdu, 0, 0))
3794 int err = odr_geterrorx(c->odr_in, &x);
3796 const char *element = odr_getelement(c->odr_in);
3797 sprintf(msg, "ODR code %d:%d element=%-20s",
3798 err, x, element ? element : "<unknown>");
3799 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3802 else if (gdu->which == Z_GDU_Z3950)
3803 recv_apdu(c, gdu->u.z3950);
3804 else if (gdu->which == Z_GDU_HTTP_Response)
3807 handle_http(c, gdu->u.HTTP_Response);
3809 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3813 c->reconnect_ok = 0;
3818 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3823 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3824 ZOOM_connection_put_event(c, event);
3826 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3827 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3829 yaz_log(log_details, "%p do_write_ex write failed", c);
3830 if (ZOOM_test_reconnect(c))
3832 return zoom_pending;
3834 if (c->state == STATE_CONNECTING)
3835 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3837 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3839 return zoom_complete;
3843 int mask = ZOOM_SELECT_EXCEPT;
3844 if (c->cs->io_pending & CS_WANT_WRITE)
3845 mask += ZOOM_SELECT_WRITE;
3846 if (c->cs->io_pending & CS_WANT_READ)
3847 mask += ZOOM_SELECT_READ;
3848 ZOOM_connection_set_mask(c, mask);
3849 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3854 ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
3855 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3858 return zoom_pending;
3861 static zoom_ret do_write(ZOOM_connection c)
3863 return do_write_ex(c, c->buf_out, c->len_out);
3867 ZOOM_API(const char *)
3868 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3870 return ZOOM_options_get(c->options, key);
3873 ZOOM_API(const char *)
3874 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3876 return ZOOM_options_getl(c->options, key, lenp);
3880 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3883 ZOOM_options_set(c->options, key, val);
3887 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3888 const char *val, int len)
3890 ZOOM_options_setl(c->options, key, val, len);
3893 ZOOM_API(const char *)
3894 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3896 return ZOOM_options_get(r->options, key);
3900 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3903 ZOOM_options_set(r->options, key, val);
3908 ZOOM_connection_errcode(ZOOM_connection c)
3910 return ZOOM_connection_error(c, 0, 0);
3913 ZOOM_API(const char *)
3914 ZOOM_connection_errmsg(ZOOM_connection c)
3917 ZOOM_connection_error(c, &msg, 0);
3921 ZOOM_API(const char *)
3922 ZOOM_connection_addinfo(ZOOM_connection c)
3924 const char *addinfo;
3925 ZOOM_connection_error(c, 0, &addinfo);
3929 ZOOM_API(const char *)
3930 ZOOM_connection_diagset(ZOOM_connection c)
3932 const char *diagset;
3933 ZOOM_connection_error_x(c, 0, 0, &diagset);
3937 ZOOM_API(const char *)
3938 ZOOM_diag_str(int error)
3942 case ZOOM_ERROR_NONE:
3944 case ZOOM_ERROR_CONNECT:
3945 return "Connect failed";
3946 case ZOOM_ERROR_MEMORY:
3947 return "Out of memory";
3948 case ZOOM_ERROR_ENCODE:
3949 return "Encoding failed";
3950 case ZOOM_ERROR_DECODE:
3951 return "Decoding failed";
3952 case ZOOM_ERROR_CONNECTION_LOST:
3953 return "Connection lost";
3954 case ZOOM_ERROR_INIT:
3955 return "Init rejected";
3956 case ZOOM_ERROR_INTERNAL:
3957 return "Internal failure";
3958 case ZOOM_ERROR_TIMEOUT:
3960 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3961 return "Unsupported protocol";
3962 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3963 return "Unsupported query type";
3964 case ZOOM_ERROR_INVALID_QUERY:
3965 return "Invalid query";
3966 case ZOOM_ERROR_CQL_PARSE:
3967 return "CQL parsing error";
3968 case ZOOM_ERROR_CQL_TRANSFORM:
3969 return "CQL transformation error";
3970 case ZOOM_ERROR_CCL_CONFIG:
3971 return "CCL configuration error";
3972 case ZOOM_ERROR_CCL_PARSE:
3973 return "CCL parsing error";
3975 return diagbib1_str(error);
3980 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
3981 const char **addinfo, const char **diagset)
3983 int error = c->error;
3986 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3987 *cp = ZOOM_diag_str(error);
3988 else if (!strcmp(c->diagset, "HTTP"))
3989 *cp = z_HTTP_errmsg(c->error);
3990 else if (!strcmp(c->diagset, "Bib-1"))
3991 *cp = ZOOM_diag_str(error);
3992 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3993 *cp = yaz_diag_srw_str(c->error);
3995 *cp = "Unknown error and diagnostic set";
3998 *addinfo = c->addinfo ? c->addinfo : "";
4000 *diagset = c->diagset ? c->diagset : "";
4005 ZOOM_connection_error(ZOOM_connection c, const char **cp,
4006 const char **addinfo)
4008 return ZOOM_connection_error_x(c, cp, addinfo, 0);
4011 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
4013 ZOOM_Event event = 0;
4014 int r = cs_look(c->cs);
4015 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
4020 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4021 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4023 ZOOM_connection_put_event(c, event);
4025 else if (r == CS_CONNECT)
4027 int ret = ret = cs_rcvconnect(c->cs);
4028 yaz_log(log_details, "%p ZOOM_connection_do_io "
4029 "cs_rcvconnect returned %d", c, ret);
4032 int mask = ZOOM_SELECT_EXCEPT;
4033 if (c->cs->io_pending & CS_WANT_WRITE)
4034 mask += ZOOM_SELECT_WRITE;
4035 if (c->cs->io_pending & CS_WANT_READ)
4036 mask += ZOOM_SELECT_READ;
4037 ZOOM_connection_set_mask(c, mask);
4041 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4042 ZOOM_connection_put_event(c, event);
4044 if (c->proto == PROTO_Z3950)
4045 ZOOM_connection_send_init(c);
4048 /* no init request for SRW .. */
4049 assert(c->tasks->which == ZOOM_TASK_CONNECT);
4050 ZOOM_connection_remove_task(c);
4051 ZOOM_connection_set_mask(c, 0);
4052 ZOOM_connection_exec_task(c);
4054 c->state = STATE_ESTABLISHED;
4058 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4064 if (mask & ZOOM_SELECT_EXCEPT)
4066 if (ZOOM_test_reconnect(c))
4068 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4069 ZOOM_connection_put_event(c, event);
4073 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4078 if (mask & ZOOM_SELECT_READ)
4080 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4086 ZOOM_connection_last_event(ZOOM_connection cs)
4089 return ZOOM_EVENT_NONE;
4090 return cs->last_event;
4095 * Returns an xmalloc()d string containing RPN that corresponds to the
4096 * CQL passed in. On error, sets the Connection object's error state
4097 * and returns a null pointer.
4098 * ### We could cache CQL parser and/or transformer in Connection.
4100 static char *cql2pqf(ZOOM_connection c, const char *cql)
4104 struct cql_node *node;
4105 const char *cqlfile;
4106 static cql_transform_t trans;
4109 parser = cql_parser_create();
4110 if ((error = cql_parser_string(parser, cql)) != 0) {
4111 cql_parser_destroy(parser);
4112 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4116 node = cql_parser_result(parser);
4117 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4119 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4121 cql_parser_destroy(parser);
4122 cql_node_destroy(node);
4123 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4127 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4129 cql_parser_destroy(parser);
4130 cql_node_destroy(node);
4131 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4132 cqlfile, strerror(errno));
4133 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4137 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4138 cql_parser_destroy(parser);
4139 cql_node_destroy(node);
4142 const char *addinfo;
4143 error = cql_transform_error(trans, &addinfo);
4144 cql_transform_close(trans);
4145 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4146 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4150 cql_transform_close(trans);
4151 return xstrdup(pqfbuf);
4154 ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
4158 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4159 /* timeout and this connection was waiting */
4160 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4162 ZOOM_connection_put_event(c, event);
4168 ZOOM_connection_process(ZOOM_connection c)
4174 event = ZOOM_connection_get_event(c);
4177 ZOOM_Event_destroy(event);
4180 ZOOM_connection_exec_task(c);
4181 event = ZOOM_connection_get_event(c);
4184 ZOOM_Event_destroy(event);
4191 ZOOM_event_nonblock(int no, ZOOM_connection *cs)
4195 yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
4197 for (i = 0; i<no; i++)
4199 ZOOM_connection c = cs[i];
4201 if (c && ZOOM_connection_process(c))
4207 ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
4209 if (c->mask && mask)
4210 ZOOM_connection_do_io(c, mask);
4214 ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
4217 return cs_fileno(c->cs);
4221 ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
4229 ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
4236 ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
4238 return ZOOM_options_get_int(c->options, "timeout", 30);
4244 * indent-tabs-mode: nil
4246 * vim: shiftwidth=4 tabstop=8 expandtab