2 * Copyright (C) 1995-2006, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.94 2006-10-31 14:08:03 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>
31 #include <sys/types.h>
40 #include <sys/select.h>
44 #define FD_SETSIZE 512
49 static int log_api = 0;
50 static int log_details = 0;
57 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
58 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
59 static char *cql2pqf(ZOOM_connection c, const char *cql);
61 static void initlog(void)
63 static int log_level_initialized = 0;
64 if (!log_level_initialized)
66 log_api = yaz_log_module_level("zoom");
67 log_details = yaz_log_module_level("zoomdetails");
68 log_level_initialized = 1;
72 static ZOOM_Event ZOOM_Event_create(int kind)
74 ZOOM_Event event = (ZOOM_Event) xmalloc(sizeof(*event));
78 yaz_log(log_details, "ZOOM_Event_create(kind=%d)", kind);
82 static void ZOOM_Event_destroy(ZOOM_Event event)
87 static void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event)
91 c->m_queue_back->prev = event;
92 assert(c->m_queue_front);
96 assert(!c->m_queue_front);
97 c->m_queue_front = event;
99 event->next = c->m_queue_back;
101 c->m_queue_back = event;
104 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
106 ZOOM_Event event = c->m_queue_front;
109 c->last_event = ZOOM_EVENT_NONE;
112 assert(c->m_queue_back);
113 c->m_queue_front = event->prev;
114 if (c->m_queue_front)
116 assert(c->m_queue_back);
117 c->m_queue_front->next = 0;
121 c->last_event = event->kind;
126 static void set_dset_error(ZOOM_connection c, int error,
128 const char *addinfo, const char *addinfo2)
135 if (!c->diagset || strcmp(dset, c->diagset))
138 c->diagset = xstrdup(dset);
139 /* remove integer part from SRW diagset .. */
140 if ((cp = strrchr(c->diagset, '/')))
143 if (addinfo && addinfo2)
145 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
146 strcpy(c->addinfo, addinfo);
147 strcat(c->addinfo, addinfo2);
150 c->addinfo = xstrdup(addinfo);
152 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
153 c, c->host_port ? c->host_port : "<>", dset, error,
154 addinfo ? addinfo : "",
155 addinfo2 ? addinfo2 : "");
159 static void set_HTTP_error(ZOOM_connection c, int error,
160 const char *addinfo, const char *addinfo2)
162 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
166 static void set_ZOOM_error(ZOOM_connection c, int error,
169 set_dset_error(c, error, "ZOOM", addinfo, 0);
172 static void clear_error(ZOOM_connection c)
175 * If an error is tied to an operation then it's ok to clear: for
176 * example, a diagnostic returned from a search is cleared by a
177 * subsequent search. However, problems such as Connection Lost
178 * or Init Refused are not cleared, because they are not
179 * recoverable: doing another search doesn't help.
183 case ZOOM_ERROR_CONNECT:
184 case ZOOM_ERROR_MEMORY:
185 case ZOOM_ERROR_DECODE:
186 case ZOOM_ERROR_CONNECTION_LOST:
187 case ZOOM_ERROR_INIT:
188 case ZOOM_ERROR_INTERNAL:
189 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
192 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
196 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which)
198 ZOOM_task *taskp = &c->tasks;
200 taskp = &(*taskp)->next;
201 *taskp = (ZOOM_task) xmalloc(sizeof(**taskp));
202 (*taskp)->running = 0;
203 (*taskp)->which = which;
209 ZOOM_API(int) ZOOM_connection_is_idle(ZOOM_connection c)
211 return c->tasks ? 0 : 1;
214 ZOOM_task ZOOM_connection_insert_task(ZOOM_connection c, int which)
216 ZOOM_task task = (ZOOM_task) xmalloc(sizeof(*task));
218 task->next = c->tasks;
227 void ZOOM_connection_remove_task(ZOOM_connection c)
229 ZOOM_task task = c->tasks;
233 c->tasks = task->next;
236 case ZOOM_TASK_SEARCH:
237 ZOOM_resultset_destroy(task->u.search.resultset);
238 xfree(task->u.search.syntax);
239 xfree(task->u.search.elementSetName);
241 case ZOOM_TASK_RETRIEVE:
242 ZOOM_resultset_destroy(task->u.retrieve.resultset);
243 xfree(task->u.retrieve.syntax);
244 xfree(task->u.retrieve.elementSetName);
246 case ZOOM_TASK_CONNECT:
249 ZOOM_scanset_destroy(task->u.scan.scan);
251 case ZOOM_TASK_PACKAGE:
252 ZOOM_package_destroy(task->u.package);
255 ZOOM_resultset_destroy(task->u.sort.resultset);
256 ZOOM_query_destroy(task->u.sort.q);
265 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
266 ZOOM_connection_put_event(c, event);
271 static int ZOOM_connection_exec_task(ZOOM_connection c);
273 void ZOOM_connection_remove_tasks(ZOOM_connection c)
276 ZOOM_connection_remove_task(c);
279 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
281 const char *elementSetName);
283 ZOOM_API(ZOOM_connection)
284 ZOOM_connection_create(ZOOM_options options)
286 ZOOM_connection c = (ZOOM_connection) xmalloc(sizeof(*c));
290 yaz_log(log_api, "%p ZOOM_connection_create", c);
292 c->proto = PROTO_Z3950;
296 c->state = STATE_IDLE;
299 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
306 c->options = ZOOM_options_create_with_parent(options);
312 c->charset = c->lang = 0;
319 c->odr_in = odr_createmem(ODR_DECODE);
320 c->odr_out = odr_createmem(ODR_ENCODE);
323 c->support_named_resultsets = 0;
324 c->last_event = ZOOM_EVENT_NONE;
326 c->m_queue_front = 0;
332 /* set database names. Take local databases (if set); otherwise
333 take databases given in ZURL (if set); otherwise use Default */
334 static char **set_DatabaseNames(ZOOM_connection con, ZOOM_options options,
337 char **databaseNames;
338 const char *cp = ZOOM_options_get(options, "databaseName");
340 if ((!cp || !*cp) && con->host_port)
342 if (strncmp(con->host_port, "unix:", 5) == 0)
343 cp = strchr(con->host_port+5, ':');
345 cp = strchr(con->host_port, '/');
351 nmem_strsplit(con->odr_out->mem, "+", cp, &databaseNames, num);
352 return databaseNames;
355 ZOOM_API(ZOOM_connection)
356 ZOOM_connection_new(const char *host, int portnum)
358 ZOOM_connection c = ZOOM_connection_create(0);
360 ZOOM_connection_connect(c, host, portnum);
364 static zoom_sru_mode get_sru_mode_from_string(const char *s)
367 return zoom_sru_soap;
368 if (!yaz_matchstr(s, "soap"))
369 return zoom_sru_soap;
370 else if (!yaz_matchstr(s, "get"))
372 else if (!yaz_matchstr(s, "post"))
373 return zoom_sru_post;
374 return zoom_sru_error;
378 ZOOM_connection_connect(ZOOM_connection c,
379 const char *host, int portnum)
386 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
389 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
390 ZOOM_connection_remove_tasks(c);
394 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
398 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
400 val = ZOOM_options_get(c->options, "proxy");
403 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
404 c->proxy = xstrdup(val);
410 val = ZOOM_options_get(c->options, "charset");
413 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
414 c->charset = xstrdup(val);
420 val = ZOOM_options_get(c->options, "lang");
423 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
424 c->lang = xstrdup(val);
429 val = ZOOM_options_get(c->options, "sru");
430 c->sru_mode = get_sru_mode_from_string(val);
436 sprintf(hostn, "%.80s:%d", host, portnum);
437 c->host_port = xstrdup(hostn);
440 c->host_port = xstrdup(host);
444 * If the "<scheme>:" part of the host string is preceded by one
445 * or more comma-separated <name>=<value> pairs, these are taken
446 * to be options to be set on the connection object. Among other
447 * applications, this facility can be used to embed authentication
449 * user=admin,password=secret,tcp:localhost:9999
451 char *remainder = c->host_port;
452 char *pcolon = strchr(remainder, ':');
455 while ((pcomma = strchr(remainder, ',')) != 0 &&
456 (pcolon == 0 || pcomma < pcolon)) {
458 if ((pequals = strchr(remainder, '=')) != 0) {
460 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
461 ZOOM_connection_option_set(c, remainder, pequals+1);
463 remainder = pcomma+1;
466 if (remainder != c->host_port) {
468 c->host_port = xstrdup(remainder);
469 /*printf("# reset hp='%s'\n", remainder);*/
473 ZOOM_options_set(c->options, "host", c->host_port);
475 val = ZOOM_options_get(c->options, "cookie");
478 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
479 c->cookie_out = xstrdup(val);
482 val = ZOOM_options_get(c->options, "clientIP");
485 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
487 c->client_IP = xstrdup(val);
490 c->async = ZOOM_options_get_bool(c->options, "async", 0);
491 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
493 task = ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
497 while (ZOOM_event(1, &c))
503 ZOOM_query_create(void)
505 ZOOM_query s = (ZOOM_query) xmalloc(sizeof(*s));
507 yaz_log(log_details, "%p ZOOM_query_create", s);
511 s->odr = odr_createmem(ODR_ENCODE);
518 ZOOM_query_destroy(ZOOM_query s)
524 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
525 if (s->refcount == 0)
533 ZOOM_query_prefix(ZOOM_query s, const char *str)
535 s->query_string = odr_strdup(s->odr, str);
536 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
537 s->z_query->which = Z_Query_type_1;
538 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
539 if (!s->z_query->u.type_1)
541 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
545 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
550 ZOOM_query_cql(ZOOM_query s, const char *str)
554 s->query_string = odr_strdup(s->odr, str);
556 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
557 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
558 ext->indirect_reference = 0;
560 ext->which = Z_External_CQL;
561 ext->u.cql = s->query_string;
563 s->z_query = (Z_Query *) odr_malloc(s->odr, sizeof(*s->z_query));
564 s->z_query->which = Z_Query_type_104;
565 s->z_query->u.type_104 = ext;
567 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
573 * Translate the CQL string client-side into RPN which is passed to
574 * the server. This is useful for server's that don't themselves
575 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
576 * only as a place to stash diagnostics if compilation fails; if this
577 * information is not needed, a null pointer may be used.
580 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
584 ZOOM_connection freeme = 0;
586 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
588 conn = freeme = ZOOM_connection_create(0);
590 rpn = cql2pqf(conn, str);
592 ZOOM_connection_destroy(freeme);
596 ret = ZOOM_query_prefix(s, rpn);
602 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
603 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
604 * to the server, as the YAZ GFS doesn't know how to handle this.
607 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
608 int *ccl_error, const char **error_string,
612 struct ccl_rpn_node *rpn;
613 CCL_bibset bibset = ccl_qual_mk();
616 ccl_qual_buf(bibset, config);
618 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
621 *error_string = ccl_err_msg(*ccl_error);
626 WRBUF wr = wrbuf_alloc();
629 ret = ZOOM_query_prefix(s, wrbuf_buf(wr));
632 ccl_qual_rm(&bibset);
637 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
639 s->sort_spec = yaz_sort_spec(s->odr, criteria);
642 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
646 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
650 static zoom_ret do_write(ZOOM_connection c);
653 ZOOM_connection_destroy(ZOOM_connection c)
658 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
661 for (r = c->resultsets; r; r = r->next)
667 odr_destroy(c->odr_in);
668 odr_destroy(c->odr_out);
669 ZOOM_options_destroy(c->options);
670 ZOOM_connection_remove_tasks(c);
676 xfree(c->cookie_out);
682 void ZOOM_resultset_addref(ZOOM_resultset r)
687 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
692 ZOOM_resultset ZOOM_resultset_create(void)
695 ZOOM_resultset r = (ZOOM_resultset) xmalloc(sizeof(*r));
699 yaz_log(log_details, "%p ZOOM_resultset_create", r);
702 r->odr = odr_createmem(ODR_ENCODE);
707 for (i = 0; i<RECORD_HASH_SIZE; i++)
708 r->record_hash[i] = 0;
716 ZOOM_API(ZOOM_resultset)
717 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
720 ZOOM_query s = ZOOM_query_create();
722 ZOOM_query_prefix(s, q);
724 r = ZOOM_connection_search(c, s);
725 ZOOM_query_destroy(s);
729 ZOOM_API(ZOOM_resultset)
730 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
732 ZOOM_resultset r = ZOOM_resultset_create();
736 const char *syntax, *elementSetName;
738 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
739 r->r_sort_spec = q->sort_spec;
742 r->options = ZOOM_options_create_with_parent(c->options);
744 start = ZOOM_options_get_int(r->options, "start", 0);
745 count = ZOOM_options_get_int(r->options, "count", 0);
747 /* If "presentChunk" is defined use that; otherwise "step" */
748 const char *cp = ZOOM_options_get(r->options, "presentChunk");
749 r->step = ZOOM_options_get_int(r->options,
750 (cp != 0 ? "presentChunk": "step"), 0);
752 r->piggyback = ZOOM_options_get_bool(r->options, "piggyback", 1);
753 cp = ZOOM_options_get(r->options, "setname");
755 r->setname = xstrdup(cp);
756 cp = ZOOM_options_get(r->options, "schema");
758 r->schema = xstrdup(cp);
762 r->next = c->resultsets;
765 if (c->host_port && c->proto == PROTO_HTTP)
769 yaz_log(log_details, "ZOOM_connection_search: no comstack");
770 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
774 yaz_log(log_details, "ZOOM_connection_search: reconnect");
779 task = ZOOM_connection_add_task(c, ZOOM_TASK_SEARCH);
780 task->u.search.resultset = r;
781 task->u.search.start = start;
782 task->u.search.count = count;
784 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
785 task->u.search.syntax = syntax ? xstrdup(syntax) : 0;
786 elementSetName = ZOOM_options_get(r->options, "elementSetName");
787 task->u.search.elementSetName = elementSetName
788 ? xstrdup(elementSetName) : 0;
790 ZOOM_resultset_addref(r);
796 while (ZOOM_event(1, &c))
803 * This is the old result-set sorting API, which is maintained only
804 * for the sake of binary compatibility. There is no reason ever to
805 * use this rather than ZOOM_resultset_sort1().
808 ZOOM_resultset_sort(ZOOM_resultset r,
809 const char *sort_type, const char *sort_spec)
811 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
815 ZOOM_resultset_sort1(ZOOM_resultset r,
816 const char *sort_type, const char *sort_spec)
818 ZOOM_connection c = r->connection;
822 newq = ZOOM_query_create();
823 if (ZOOM_query_sortby(newq, sort_spec) < 0)
826 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
827 r, r, sort_type, sort_spec);
831 if (c->host_port && c->proto == PROTO_HTTP)
835 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
836 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
840 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
846 ZOOM_resultset_cache_reset(r);
847 task = ZOOM_connection_add_task(c, ZOOM_TASK_SORT);
848 task->u.sort.resultset = r;
849 task->u.sort.q = newq;
851 ZOOM_resultset_addref(r);
855 while (ZOOM_event(1, &c))
863 ZOOM_resultset_cache_reset(ZOOM_resultset r)
866 for (i = 0; i<RECORD_HASH_SIZE; i++)
868 ZOOM_record_cache rc;
869 for (rc = r->record_hash[i]; rc; rc = rc->next)
871 if (rc->rec.wrbuf_marc)
872 wrbuf_free(rc->rec.wrbuf_marc, 1);
873 if (rc->rec.wrbuf_iconv)
874 wrbuf_free(rc->rec.wrbuf_iconv, 1);
875 if (rc->rec.wrbuf_opac)
876 wrbuf_free(rc->rec.wrbuf_opac, 1);
878 r->record_hash[i] = 0;
883 ZOOM_resultset_destroy(ZOOM_resultset r)
888 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
890 if (r->refcount == 0)
892 ZOOM_resultset_cache_reset(r);
896 /* remove ourselves from the resultsets in connection */
897 ZOOM_resultset *rp = &r->connection->resultsets;
900 assert(*rp); /* we must be in this list!! */
902 { /* OK, we're here - take us out of it */
909 ZOOM_query_destroy(r->query);
910 ZOOM_options_destroy(r->options);
919 ZOOM_resultset_size(ZOOM_resultset r)
924 static void do_close(ZOOM_connection c)
930 c->state = STATE_IDLE;
933 static int ZOOM_test_reconnect(ZOOM_connection c)
935 if (!c->reconnect_ok)
939 c->tasks->running = 0;
940 ZOOM_connection_insert_task(c, ZOOM_TASK_CONNECT);
944 static void ZOOM_resultset_retrieve(ZOOM_resultset r,
945 int force_sync, int start, int count)
950 const char *syntax, *elementSetName;
954 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
955 " count=%d", r, force_sync, start, count);
960 if (c->host_port && c->proto == PROTO_HTTP)
964 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
965 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
969 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
974 task = ZOOM_connection_add_task(c, ZOOM_TASK_RETRIEVE);
975 task->u.retrieve.resultset = r;
976 task->u.retrieve.start = start;
977 task->u.retrieve.count = count;
979 syntax = ZOOM_options_get(r->options, "preferredRecordSyntax");
980 task->u.retrieve.syntax = syntax ? xstrdup(syntax) : 0;
981 elementSetName = ZOOM_options_get(r->options, "elementSetName");
982 task->u.retrieve.elementSetName = elementSetName
983 ? xstrdup(elementSetName) : 0;
985 cp = ZOOM_options_get(r->options, "schema");
988 if (!r->schema || strcmp(r->schema, cp))
991 r->schema = xstrdup(cp);
995 ZOOM_resultset_addref(r);
997 if (!r->connection->async || force_sync)
998 while (r->connection && ZOOM_event(1, &r->connection))
1003 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
1004 size_t start, size_t count)
1006 int force_present = 0;
1010 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
1011 r, r, (long) start, (long) count);
1014 ZOOM_resultset_retrieve(r, force_present, start, count);
1018 for (i = 0; i< count; i++)
1019 recs[i] = ZOOM_resultset_record_immediate(r, i+start);
1023 static void get_cert(ZOOM_connection c)
1028 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
1030 ZOOM_connection_option_setl(c, "sslPeerCert",
1031 cert_buf, cert_len);
1036 static zoom_ret do_connect(ZOOM_connection c)
1039 const char *effective_host;
1042 effective_host = c->proxy;
1044 effective_host = c->host_port;
1046 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1050 c->cs = cs_create_host(effective_host, 0, &add);
1052 if (c->cs && c->cs->protocol == PROTO_HTTP)
1055 const char *path = 0;
1057 c->proto = PROTO_HTTP;
1058 cs_get_host_args(c->host_port, &path);
1060 c->path = (char*) xmalloc(strlen(path)+2);
1062 strcpy(c->path+1, path);
1064 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1066 return zoom_complete;
1071 int ret = cs_connect(c->cs, add);
1074 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1075 ZOOM_connection_put_event(c, event);
1077 if (c->proto == PROTO_Z3950)
1078 ZOOM_connection_send_init(c);
1081 /* no init request for SRW .. */
1082 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1083 ZOOM_connection_remove_task(c);
1085 ZOOM_connection_exec_task(c);
1087 c->state = STATE_ESTABLISHED;
1088 return zoom_pending;
1092 c->state = STATE_CONNECTING;
1093 c->mask = ZOOM_SELECT_EXCEPT;
1094 if (c->cs->io_pending & CS_WANT_WRITE)
1095 c->mask += ZOOM_SELECT_WRITE;
1096 if (c->cs->io_pending & CS_WANT_READ)
1097 c->mask += ZOOM_SELECT_READ;
1098 return zoom_pending;
1101 c->state = STATE_IDLE;
1102 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1103 return zoom_complete;
1106 int z3950_connection_socket(ZOOM_connection c)
1109 return cs_fileno(c->cs);
1113 int z3950_connection_mask(ZOOM_connection c)
1120 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
1123 for (i = 0; i<200; i++)
1126 Z_OtherInformation **oi;
1132 sprintf(buf, "otherInfo%d", i);
1133 val = ZOOM_options_get(c->options, buf);
1136 cp = strchr(val, ':');
1140 if (len >= sizeof(buf))
1141 len = sizeof(buf)-1;
1142 memcpy(buf, val, len);
1144 oidval = oid_getvalbyname(buf);
1145 if (oidval == VAL_NONE)
1148 yaz_oi_APDU(a, &oi);
1149 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1153 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1158 Z_OtherInformation **oi;
1159 yaz_oi_APDU(a, &oi);
1160 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1164 Z_OtherInformation **oi;
1165 yaz_oi_APDU(a, &oi);
1166 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1168 otherInfo_attach(c, a, out);
1169 if (!z_APDU(out, &a, 0, 0))
1171 FILE *outf = fopen("/tmp/apdu.txt", "a");
1174 ODR odr_pr = odr_createmem(ODR_PRINT);
1175 fprintf(outf, "a=%p\n", a);
1176 odr_setprint(odr_pr, outf);
1177 z_APDU(odr_pr, &a, 0, 0);
1178 odr_destroy(odr_pr);
1180 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1181 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1185 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1189 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
1193 if (encode_APDU(c, a, c->odr_out))
1194 return zoom_complete;
1195 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1196 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1197 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1198 ZOOM_connection_put_event(c, event);
1199 odr_reset(c->odr_out);
1203 /* returns 1 if PDU was sent OK (still pending )
1204 0 if PDU was not sent OK (nothing to wait for)
1207 static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
1209 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1210 Z_InitRequest *ireq = apdu->u.initRequest;
1211 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1212 odr_malloc(c->odr_out, sizeof(*auth));
1213 const char *auth_groupId = ZOOM_options_get(c->options, "group");
1214 const char *auth_userId = ZOOM_options_get(c->options, "user");
1215 const char *auth_password = ZOOM_options_get(c->options, "password");
1218 /* support the pass for backwards compatibility */
1220 auth_password = ZOOM_options_get(c->options, "pass");
1222 ODR_MASK_SET(ireq->options, Z_Options_search);
1223 ODR_MASK_SET(ireq->options, Z_Options_present);
1224 ODR_MASK_SET(ireq->options, Z_Options_scan);
1225 ODR_MASK_SET(ireq->options, Z_Options_sort);
1226 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1227 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1229 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1230 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1231 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1233 /* Index Data's Z39.50 Implementor Id is 81 */
1234 ireq->implementationId =
1235 odr_prepend(c->odr_out,
1236 ZOOM_options_get(c->options, "implementationId"),
1237 odr_prepend(c->odr_out, "81", ireq->implementationId));
1239 ireq->implementationName =
1240 odr_prepend(c->odr_out,
1241 ZOOM_options_get(c->options, "implementationName"),
1242 odr_prepend(c->odr_out, "ZOOM-C",
1243 ireq->implementationName));
1245 version = odr_strdup(c->odr_out, "$Revision: 1.94 $");
1246 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1247 version[strlen(version)-2] = '\0';
1248 ireq->implementationVersion =
1249 odr_prepend(c->odr_out,
1250 ZOOM_options_get(c->options, "implementationVersion"),
1251 odr_prepend(c->odr_out, &version[11],
1252 ireq->implementationVersion));
1254 *ireq->maximumRecordSize =
1255 ZOOM_options_get_int(c->options, "maximumRecordSize", 1024*1024);
1256 *ireq->preferredMessageSize =
1257 ZOOM_options_get_int(c->options, "preferredMessageSize", 1024*1024);
1259 if (auth_groupId || auth_password)
1261 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1264 if (auth_groupId && *auth_groupId)
1266 pass->groupId = (char *)
1267 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1268 strcpy(pass->groupId, auth_groupId);
1272 if (auth_userId && *auth_userId)
1274 pass->userId = (char *)
1275 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1276 strcpy(pass->userId, auth_userId);
1280 if (auth_password && *auth_password)
1282 pass->password = (char *)
1283 odr_malloc(c->odr_out, strlen(auth_password)+1);
1284 strcpy(pass->password, auth_password);
1289 auth->which = Z_IdAuthentication_idPass;
1290 auth->u.idPass = pass;
1291 ireq->idAuthentication = auth;
1294 else if (auth_userId)
1296 auth->which = Z_IdAuthentication_open;
1297 auth->u.open = (char *)
1298 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1299 strcpy(auth->u.open, auth_userId);
1300 ireq->idAuthentication = auth;
1303 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1304 VAL_PROXY, 1, c->host_port);
1305 if (c->charset || c->lang)
1307 Z_OtherInformation **oi;
1308 Z_OtherInformationUnit *oi_unit;
1310 yaz_oi_APDU(apdu, &oi);
1312 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1314 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1315 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1316 oi_unit->information.externallyDefinedInfo =
1317 yaz_set_proposal_charneg_list(c->odr_out, " ",
1318 c->charset, c->lang, 1);
1322 return send_APDU(c, apdu);
1326 static zoom_ret send_srw(ZOOM_connection c, Z_SRW_PDU *sr)
1331 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1333 if (c->sru_mode == zoom_sru_get)
1335 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1337 else if (c->sru_mode == zoom_sru_post)
1339 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1341 else if (c->sru_mode == zoom_sru_soap)
1343 yaz_sru_soap_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1345 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1346 return zoom_complete;
1347 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1349 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
1350 ZOOM_connection_put_event(c, event);
1351 odr_reset(c->odr_out);
1357 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1361 ZOOM_resultset resultset = 0;
1363 const char *option_val = 0;
1365 if (c->error) /* don't continue on error */
1366 return zoom_complete;
1368 switch(c->tasks->which)
1370 case ZOOM_TASK_SEARCH:
1371 resultset = c->tasks->u.search.resultset;
1372 resultset->setname = xstrdup("default");
1373 ZOOM_options_set(resultset->options, "setname", resultset->setname);
1374 start = &c->tasks->u.search.start;
1375 count = &c->tasks->u.search.count;
1377 case ZOOM_TASK_RETRIEVE:
1378 resultset = c->tasks->u.retrieve.resultset;
1380 start = &c->tasks->u.retrieve.start;
1381 count = &c->tasks->u.retrieve.count;
1383 if (*start >= resultset->size)
1384 return zoom_complete;
1385 if (*start + *count > resultset->size)
1386 *count = resultset->size - *start;
1388 for (i = 0; i < *count; i++)
1391 record_cache_lookup(resultset, i + *start,
1392 c->tasks->u.retrieve.syntax,
1393 c->tasks->u.retrieve.elementSetName);
1398 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1399 ZOOM_connection_put_event(c, event);
1406 return zoom_complete;
1409 return zoom_complete;
1411 assert(resultset->query);
1413 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1415 if (resultset->query->z_query->which == Z_Query_type_104
1416 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1418 sr->u.request->query_type = Z_SRW_query_type_cql;
1419 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1421 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1422 resultset->query->z_query->u.type_1)
1424 sr->u.request->query_type = Z_SRW_query_type_pqf;
1425 sr->u.request->query.pqf = resultset->query->query_string;
1429 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1430 return zoom_complete;
1432 sr->u.request->startRecord = odr_intdup(c->odr_out, *start + 1);
1433 sr->u.request->maximumRecords = odr_intdup(
1434 c->odr_out, resultset->step>0 ? resultset->step : *count);
1435 sr->u.request->recordSchema = resultset->schema;
1437 option_val = ZOOM_resultset_option_get(resultset, "recordPacking");
1439 sr->u.request->recordPacking = odr_strdup(c->odr_out, option_val);
1441 option_val = ZOOM_resultset_option_get(resultset, "extraArgs");
1443 sr->extra_args = odr_strdup(c->odr_out, option_val);
1444 return send_srw(c, sr);
1447 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1449 return zoom_complete;
1453 static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
1456 int lslb, ssub, mspn;
1458 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1459 Z_SearchRequest *search_req = apdu->u.searchRequest;
1460 const char *elementSetName;
1461 const char *smallSetElementSetName;
1462 const char *mediumSetElementSetName;
1465 assert(c->tasks->which == ZOOM_TASK_SEARCH);
1467 r = c->tasks->u.search.resultset;
1469 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1472 ZOOM_options_get(r->options, "elementSetName");
1473 smallSetElementSetName =
1474 ZOOM_options_get(r->options, "smallSetElementSetName");
1475 mediumSetElementSetName =
1476 ZOOM_options_get(r->options, "mediumSetElementSetName");
1478 if (!smallSetElementSetName)
1479 smallSetElementSetName = elementSetName;
1481 if (!mediumSetElementSetName)
1482 mediumSetElementSetName = elementSetName;
1487 /* prepare query for the search request */
1488 search_req->query = r->query->z_query;
1489 if (!search_req->query)
1491 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1492 return zoom_complete;
1495 search_req->databaseNames =
1496 set_DatabaseNames(c, r->options, &search_req->num_databaseNames);
1498 /* get syntax (no need to provide unless piggyback is in effect) */
1499 syntax = c->tasks->u.search.syntax;
1501 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
1502 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
1503 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
1504 if (lslb != -1 && ssub != -1 && mspn != -1)
1506 /* So're a Z39.50 expert? Let's hope you don't do sort */
1507 *search_req->largeSetLowerBound = lslb;
1508 *search_req->smallSetUpperBound = ssub;
1509 *search_req->mediumSetPresentNumber = mspn;
1511 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
1512 && r->piggyback && !r->r_sort_spec && !r->schema)
1514 /* Regular piggyback - do it unless we're going to do sort */
1515 *search_req->largeSetLowerBound = 2000000000;
1516 *search_req->smallSetUpperBound = 1;
1517 *search_req->mediumSetPresentNumber =
1518 r->step>0 ? r->step : c->tasks->u.search.count;
1522 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1523 smallSetElementSetName = 0;
1524 mediumSetElementSetName = 0;
1527 if (smallSetElementSetName && *smallSetElementSetName)
1529 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1530 odr_malloc(c->odr_out, sizeof(*esn));
1532 esn->which = Z_ElementSetNames_generic;
1533 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
1534 search_req->smallSetElementSetNames = esn;
1536 if (mediumSetElementSetName && *mediumSetElementSetName)
1538 Z_ElementSetNames *esn =(Z_ElementSetNames *)
1539 odr_malloc(c->odr_out, sizeof(*esn));
1541 esn->which = Z_ElementSetNames_generic;
1542 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
1543 search_req->mediumSetElementSetNames = esn;
1546 search_req->preferredRecordSyntax =
1547 yaz_str_to_z3950oid(c->odr_out, CLASS_RECSYN, syntax);
1551 if (c->support_named_resultsets)
1555 /* find the lowest unused ordinal so that we re-use
1556 result sets on the server. */
1557 for (ord = 1; ; ord++)
1560 sprintf(setname, "%d", ord);
1561 for (rp = c->resultsets; rp; rp = rp->next)
1562 if (rp->setname && !strcmp(rp->setname, setname))
1567 r->setname = xstrdup(setname);
1568 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1569 "set %s", c, r->setname);
1573 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1575 r->setname = xstrdup("default");
1577 ZOOM_options_set(r->options, "setname", r->setname);
1579 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1580 return send_APDU(c, apdu);
1583 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1590 case Z_DefaultDiagFormat_v2Addinfo:
1591 addinfo = r->u.v2Addinfo;
1593 case Z_DefaultDiagFormat_v3Addinfo:
1594 addinfo = r->u.v3Addinfo;
1599 set_dset_error(c, *r->condition,
1600 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1604 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1606 if (p->which != Z_DiagRec_defaultFormat)
1607 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1609 response_default_diag(c, p->u.defaultFormat);
1612 ZOOM_API(ZOOM_record)
1613 ZOOM_record_clone(ZOOM_record srec)
1620 odr_enc = odr_createmem(ODR_ENCODE);
1621 if (!z_NamePlusRecord(odr_enc, &srec->npr, 0, 0))
1623 buf = odr_getbuf(odr_enc, &size, 0);
1625 nrec = (ZOOM_record) xmalloc(sizeof(*nrec));
1626 nrec->odr = odr_createmem(ODR_DECODE);
1627 nrec->wrbuf_marc = 0;
1628 nrec->wrbuf_iconv = 0;
1629 nrec->wrbuf_opac = 0;
1630 odr_setbuf(nrec->odr, buf, size, 0);
1631 z_NamePlusRecord(nrec->odr, &nrec->npr, 0, 0);
1633 odr_destroy(odr_enc);
1637 ZOOM_API(ZOOM_record)
1638 ZOOM_resultset_record_immediate(ZOOM_resultset s,size_t pos)
1640 const char *syntax =
1641 ZOOM_options_get(s->options, "preferredRecordSyntax");
1642 const char *elementSetName =
1643 ZOOM_options_get(s->options, "elementSetName");
1645 return record_cache_lookup(s, pos, syntax, elementSetName);
1648 ZOOM_API(ZOOM_record)
1649 ZOOM_resultset_record(ZOOM_resultset r, size_t pos)
1651 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1656 * MIKE: I think force_sync should always be zero, but I don't
1657 * want to make this change until I get the go-ahead from
1658 * Adam, in case something depends on the old synchronous
1662 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1663 ZOOM_resultset_retrieve(r, force_sync, pos, 1);
1664 rec = ZOOM_resultset_record_immediate(r, pos);
1670 ZOOM_record_destroy(ZOOM_record rec)
1674 if (rec->wrbuf_marc)
1675 wrbuf_free(rec->wrbuf_marc, 1);
1676 if (rec->wrbuf_iconv)
1677 wrbuf_free(rec->wrbuf_iconv, 1);
1678 if (rec->wrbuf_opac)
1679 wrbuf_free(rec->wrbuf_opac, 1);
1680 odr_destroy(rec->odr);
1684 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1686 const char *buf, int sz,
1687 const char *record_charset)
1692 yaz_marc_t mt = yaz_marc_create();
1695 strcpy(to, "UTF-8");
1696 if (record_charset && *record_charset)
1698 /* Use "from,to" or just "from" */
1699 const char *cp = strchr(record_charset, ',');
1700 int clen = strlen(record_charset);
1703 strncpy( to, cp+1, sizeof(to)-1);
1704 to[sizeof(to)-1] = '\0';
1705 clen = cp - record_charset;
1707 if (clen > sizeof(from)-1)
1708 clen = sizeof(from)-1;
1711 strncpy(from, record_charset, clen);
1717 cd = yaz_iconv_open(to, from);
1718 yaz_marc_iconv(mt, cd);
1721 yaz_marc_xml(mt, marc_type);
1722 if (!rec->wrbuf_marc)
1723 rec->wrbuf_marc = wrbuf_alloc();
1724 wrbuf_rewind(rec->wrbuf_marc);
1725 if (yaz_marc_decode_wrbuf(mt, buf, sz, rec->wrbuf_marc) > 0)
1727 yaz_marc_destroy(mt);
1729 yaz_iconv_close(cd);
1731 *len = wrbuf_len(rec->wrbuf_marc);
1732 return wrbuf_buf(rec->wrbuf_marc);
1734 yaz_marc_destroy(mt);
1736 yaz_iconv_close(cd);
1740 static const char *record_iconv_return(ZOOM_record rec, int *len,
1741 const char *buf, int sz,
1742 const char *record_charset)
1749 strcpy(to, "UTF-8");
1750 if (record_charset && *record_charset)
1752 /* Use "from,to" or just "from" */
1753 const char *cp = strchr(record_charset, ',');
1754 int clen = strlen(record_charset);
1757 strncpy( to, cp+1, sizeof(to)-1);
1758 to[sizeof(to)-1] = '\0';
1759 clen = cp - record_charset;
1761 if (clen > sizeof(from)-1)
1762 clen = sizeof(from)-1;
1765 strncpy(from, record_charset, clen);
1769 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1772 size_t inbytesleft = sz;
1773 const char *inp = buf;
1775 if (!rec->wrbuf_iconv)
1776 rec->wrbuf_iconv = wrbuf_alloc();
1778 wrbuf_rewind(rec->wrbuf_iconv);
1782 size_t outbytesleft = sizeof(outbuf);
1783 char *outp = outbuf;
1784 size_t r = yaz_iconv(cd, (char**) &inp,
1786 &outp, &outbytesleft);
1787 if (r == (size_t) (-1))
1789 int e = yaz_iconv_error(cd);
1790 if (e != YAZ_ICONV_E2BIG)
1793 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1795 wrbuf_puts(rec->wrbuf_iconv, "");
1796 buf = wrbuf_buf(rec->wrbuf_iconv);
1797 sz = wrbuf_len(rec->wrbuf_iconv);
1798 yaz_iconv_close(cd);
1806 ZOOM_record_error(ZOOM_record rec, const char **cp,
1807 const char **addinfo, const char **diagset)
1809 Z_NamePlusRecord *npr;
1814 if (npr && npr->which == Z_NamePlusRecord_surrogateDiagnostic)
1816 Z_DiagRec *diag_rec = npr->u.surrogateDiagnostic;
1817 int error = YAZ_BIB1_UNSPECIFIED_ERROR;
1818 const char *add = 0;
1820 if (diag_rec->which == Z_DiagRec_defaultFormat)
1822 Z_DefaultDiagFormat *ddf = diag_rec->u.defaultFormat;
1825 error = *ddf->condition;
1828 case Z_DefaultDiagFormat_v2Addinfo:
1829 add = ddf->u.v2Addinfo;
1831 case Z_DefaultDiagFormat_v3Addinfo:
1832 add = ddf->u.v3Addinfo;
1836 *diagset = yaz_z3950oid_to_str(ddf->diagnosticSetId, &oclass);
1844 *addinfo = add ? add : "";
1846 *cp = diagbib1_str(error);
1852 ZOOM_API(const char *)
1853 ZOOM_record_get(ZOOM_record rec, const char *type_spec, int *len)
1860 Z_NamePlusRecord *npr;
1863 *len = 0; /* default return */
1872 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1874 if (cp[i] == ';' || cp[i] == ' ')
1880 while (type_spec[i] == ';')
1883 while (type_spec[i] == ' ')
1885 if (!strncmp(type_spec+i, "charset=", 8))
1888 i = i + 8; /* skip charset= */
1889 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1891 if (type_spec[i] == ';' || type_spec[i] == ' ')
1897 else if (!strncmp(type_spec+i, "xpath=", 6))
1901 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1905 while (type_spec[i] == ' ')
1908 if (!strcmp(type, "database"))
1911 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1912 return npr->databaseName;
1914 else if (!strcmp(type, "syntax"))
1916 const char *desc = 0;
1917 if (npr->which == Z_NamePlusRecord_databaseRecord)
1919 Z_External *r = (Z_External *) npr->u.databaseRecord;
1920 oident *ent = oid_getentbyoid(r->direct_reference);
1927 *len = strlen(desc);
1930 if (npr->which != Z_NamePlusRecord_databaseRecord)
1933 /* from now on - we have a database record .. */
1934 if (!strcmp(type, "render"))
1936 Z_External *r = (Z_External *) npr->u.databaseRecord;
1937 oident *ent = oid_getentbyoid(r->direct_reference);
1939 /* render bibliographic record .. */
1940 if (r->which == Z_External_OPAC)
1942 r = r->u.opac->bibliographicRecord;
1945 ent = oid_getentbyoid(r->direct_reference);
1947 if (r->which == Z_External_sutrs)
1948 return record_iconv_return(rec, len,
1949 (char*) r->u.sutrs->buf,
1952 else if (r->which == Z_External_octet)
1954 const char *ret_buf;
1962 case VAL_APPLICATION_XML:
1965 ret_buf = marc_iconv_return(
1966 rec, YAZ_MARC_LINE, len,
1967 (const char *) r->u.octet_aligned->buf,
1968 r->u.octet_aligned->len,
1973 return record_iconv_return(rec, len,
1974 (const char *) r->u.octet_aligned->buf,
1975 r->u.octet_aligned->len,
1978 else if (r->which == Z_External_grs1)
1980 if (!rec->wrbuf_marc)
1981 rec->wrbuf_marc = wrbuf_alloc();
1982 wrbuf_rewind(rec->wrbuf_marc);
1983 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1984 return record_iconv_return(rec, len,
1985 wrbuf_buf(rec->wrbuf_marc),
1986 wrbuf_len(rec->wrbuf_marc),
1991 else if (!strcmp(type, "xml"))
1993 Z_External *r = (Z_External *) npr->u.databaseRecord;
1994 oident *ent = oid_getentbyoid(r->direct_reference);
1996 /* render bibliographic record .. */
1997 if (r->which == Z_External_OPAC)
1999 r = r->u.opac->bibliographicRecord;
2002 ent = oid_getentbyoid(r->direct_reference);
2005 if (r->which == Z_External_sutrs)
2006 return record_iconv_return(rec, len,
2007 (const char *) r->u.sutrs->buf,
2010 else if (r->which == Z_External_octet)
2012 const char *ret_buf;
2013 int marc_decode_type = YAZ_MARC_MARCXML;
2022 case VAL_APPLICATION_XML:
2025 ret_buf = marc_iconv_return(
2026 rec, marc_decode_type, len,
2027 (const char *) r->u.octet_aligned->buf,
2028 r->u.octet_aligned->len,
2033 return record_iconv_return(rec, len,
2034 (const char *) r->u.octet_aligned->buf,
2035 r->u.octet_aligned->len,
2038 else if (r->which == Z_External_grs1)
2045 else if (!strcmp(type, "raw"))
2047 Z_External *r = (Z_External *) npr->u.databaseRecord;
2049 if (r->which == Z_External_sutrs)
2051 if (len) *len = r->u.sutrs->len;
2052 return (const char *) r->u.sutrs->buf;
2054 else if (r->which == Z_External_octet)
2056 if (len) *len = r->u.octet_aligned->len;
2057 return (const char *) r->u.octet_aligned->buf;
2059 else /* grs-1, explain, OPAC, ... */
2062 return (const char *) npr->u.databaseRecord;
2066 else if (!strcmp (type, "ext"))
2069 return (const char *) npr->u.databaseRecord;
2071 else if (!strcmp (type, "opac"))
2074 Z_External *r = (Z_External *) npr->u.databaseRecord;
2075 if (r->which == Z_External_OPAC)
2077 if (!rec->wrbuf_opac)
2078 rec->wrbuf_opac = wrbuf_alloc();
2079 wrbuf_rewind(rec->wrbuf_opac);
2080 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
2081 return record_iconv_return(rec, len,
2082 wrbuf_buf(rec->wrbuf_opac),
2083 wrbuf_len(rec->wrbuf_opac),
2090 static int strcmp_null(const char *v1, const char *v2)
2096 return strcmp(v1, v2);
2099 static size_t record_hash(int pos)
2103 return pos % RECORD_HASH_SIZE;
2106 static void record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
2108 const char *syntax, const char *elementSetName)
2110 ZOOM_record_cache rc;
2112 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2113 ZOOM_connection_put_event(r->connection, event);
2115 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2119 if (strcmp_null(r->schema, rc->schema))
2121 if (strcmp_null(elementSetName,rc->elementSetName))
2123 if (strcmp_null(syntax, rc->syntax))
2125 /* not destroying rc->npr (it's handled by nmem )*/
2127 /* keeping wrbuf_marc too */
2131 rc = (ZOOM_record_cache) odr_malloc(r->odr, sizeof(*rc));
2134 rc->rec.wrbuf_marc = 0;
2135 rc->rec.wrbuf_iconv = 0;
2136 rc->rec.wrbuf_opac = 0;
2138 rc->elementSetName = odr_strdup(r->odr, elementSetName);
2140 rc->elementSetName = 0;
2143 rc->syntax = odr_strdup(r->odr, syntax);
2148 rc->schema = odr_strdup(r->odr, r->schema);
2153 rc->next = r->record_hash[record_hash(pos)];
2154 r->record_hash[record_hash(pos)] = rc;
2157 static ZOOM_record record_cache_lookup(ZOOM_resultset r, int pos,
2159 const char *elementSetName)
2161 ZOOM_record_cache rc;
2163 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2167 if (strcmp_null(r->schema, rc->schema))
2169 if (strcmp_null(elementSetName,rc->elementSetName))
2171 if (strcmp_null(syntax, rc->syntax))
2179 static void handle_records(ZOOM_connection c, Z_Records *sr,
2182 ZOOM_resultset resultset;
2184 const char *syntax = 0, *elementSetName = 0;
2188 switch (c->tasks->which)
2190 case ZOOM_TASK_SEARCH:
2191 resultset = c->tasks->u.search.resultset;
2192 start = &c->tasks->u.search.start;
2193 count = &c->tasks->u.search.count;
2194 syntax = c->tasks->u.search.syntax;
2195 elementSetName = c->tasks->u.search.elementSetName;
2197 case ZOOM_TASK_RETRIEVE:
2198 resultset = c->tasks->u.retrieve.resultset;
2199 start = &c->tasks->u.retrieve.start;
2200 count = &c->tasks->u.retrieve.count;
2201 syntax = c->tasks->u.retrieve.syntax;
2202 elementSetName = c->tasks->u.retrieve.elementSetName;
2207 if (sr && sr->which == Z_Records_NSD)
2208 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2209 else if (sr && sr->which == Z_Records_multipleNSD)
2211 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2212 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2214 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2218 if (*count + *start > resultset->size)
2219 *count = resultset->size - *start;
2222 if (sr && sr->which == Z_Records_DBOSD)
2225 NMEM nmem = odr_extract_mem(c->odr_in);
2226 Z_NamePlusRecordList *p =
2227 sr->u.databaseOrSurDiagnostics;
2228 for (i = 0; i<p->num_records; i++)
2230 record_cache_add(resultset, p->records[i], i + *start,
2231 syntax, elementSetName);
2235 yaz_log(log_details,
2236 "handle_records resultset=%p start=%d count=%d",
2237 resultset, *start, *count);
2239 /* transfer our response to search_nmem .. we need it later */
2240 nmem_transfer(resultset->odr->mem, nmem);
2242 if (present_phase && p->num_records == 0)
2244 /* present response and we didn't get any records! */
2245 Z_NamePlusRecord *myrec =
2246 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2247 record_cache_add(resultset, myrec, *start,
2248 syntax, elementSetName);
2251 else if (present_phase)
2253 /* present response and we didn't get any records! */
2254 Z_NamePlusRecord *myrec =
2255 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2256 record_cache_add(resultset, myrec, *start, syntax, elementSetName);
2261 static void handle_present_response(ZOOM_connection c, Z_PresentResponse *pr)
2263 handle_records(c, pr->records, 1);
2266 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2269 switch (term->which)
2271 case Z_Term_general:
2272 ZOOM_options_setl(opt, name,
2273 (const char *)(term->u.general->buf),
2274 term->u.general->len);
2276 case Z_Term_characterString:
2277 ZOOM_options_set(opt, name, term->u.characterString);
2279 case Z_Term_numeric:
2280 ZOOM_options_set_int(opt, name, *term->u.numeric);
2285 static void handle_queryExpression(ZOOM_options opt, const char *name,
2286 Z_QueryExpression *exp)
2292 case Z_QueryExpression_term:
2293 if (exp->u.term && exp->u.term->queryTerm)
2295 sprintf(opt_name, "%s.term", name);
2296 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2299 case Z_QueryExpression_query:
2304 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2305 Z_OtherInformation *o)
2308 for (i = 0; o && i < o->num_elements; i++)
2310 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2312 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2314 if (ext->which == Z_External_searchResult1)
2317 Z_SearchInfoReport *sr = ext->u.searchResult1;
2320 ZOOM_options_set_int(
2321 resultset->options, "searchresult.size", sr->num);
2323 for (j = 0; j < sr->num; j++)
2325 Z_SearchInfoReport_s *ent =
2326 ext->u.searchResult1->elements[j];
2329 sprintf(pref, "searchresult.%d", j);
2331 if (ent->subqueryId)
2334 sprintf(opt_name, "%s.id", pref);
2335 ZOOM_options_set(resultset->options, opt_name,
2338 if (ent->subqueryExpression)
2341 sprintf(opt_name, "%s.subquery", pref);
2342 handle_queryExpression(resultset->options, opt_name,
2343 ent->subqueryExpression);
2345 if (ent->subqueryInterpretation)
2348 sprintf(opt_name, "%s.interpretation", pref);
2349 handle_queryExpression(resultset->options, opt_name,
2350 ent->subqueryInterpretation);
2352 if (ent->subqueryRecommendation)
2355 sprintf(opt_name, "%s.recommendation", pref);
2356 handle_queryExpression(resultset->options, opt_name,
2357 ent->subqueryRecommendation);
2359 if (ent->subqueryCount)
2362 sprintf(opt_name, "%s.count", pref);
2363 ZOOM_options_set_int(resultset->options, opt_name,
2364 *ent->subqueryCount);
2372 static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
2374 ZOOM_resultset resultset;
2377 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2380 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2381 ZOOM_connection_put_event(c, event);
2383 resultset = c->tasks->u.search.resultset;
2385 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2387 resultset->size = *sr->resultCount;
2388 handle_records(c, sr->records, 0);
2391 static void sort_response(ZOOM_connection c, Z_SortResponse *res)
2393 if (res->diagnostics && res->num_diagnostics > 0)
2394 response_diag(c, res->diagnostics[0]);
2397 static int scan_response(ZOOM_connection c, Z_ScanResponse *res)
2399 NMEM nmem = odr_extract_mem(c->odr_in);
2402 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2404 scan = c->tasks->u.scan.scan;
2406 if (res->entries && res->entries->nonsurrogateDiagnostics)
2407 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2408 scan->scan_response = res;
2409 nmem_transfer(scan->odr->mem, nmem);
2411 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
2412 if (res->positionOfTerm)
2413 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
2414 if (res->scanStatus)
2415 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
2416 if (res->numberOfEntriesReturned)
2417 ZOOM_options_set_int(scan->options, "number",
2418 *res->numberOfEntriesReturned);
2423 static zoom_ret send_sort(ZOOM_connection c,
2424 ZOOM_resultset resultset)
2427 resultset->r_sort_spec = 0;
2428 if (resultset->r_sort_spec)
2430 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2431 Z_SortRequest *req = apdu->u.sortRequest;
2433 req->num_inputResultSetNames = 1;
2434 req->inputResultSetNames = (Z_InternationalString **)
2435 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
2436 req->inputResultSetNames[0] =
2437 odr_strdup(c->odr_out, resultset->setname);
2438 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
2439 req->sortSequence = resultset->r_sort_spec;
2440 resultset->r_sort_spec = 0;
2441 return send_APDU(c, apdu);
2443 return zoom_complete;
2446 static zoom_ret send_present(ZOOM_connection c)
2449 Z_PresentRequest *req = 0;
2451 const char *syntax = 0;
2452 const char *elementSetName = 0;
2453 ZOOM_resultset resultset;
2458 yaz_log(log_details, "%p send_present no tasks", c);
2459 return zoom_complete;
2462 switch (c->tasks->which)
2464 case ZOOM_TASK_SEARCH:
2465 resultset = c->tasks->u.search.resultset;
2466 start = &c->tasks->u.search.start;
2467 count = &c->tasks->u.search.count;
2468 syntax = c->tasks->u.search.syntax;
2469 elementSetName = c->tasks->u.search.elementSetName;
2471 case ZOOM_TASK_RETRIEVE:
2472 resultset = c->tasks->u.retrieve.resultset;
2473 start = &c->tasks->u.retrieve.start;
2474 count = &c->tasks->u.retrieve.count;
2475 syntax = c->tasks->u.retrieve.syntax;
2476 elementSetName = c->tasks->u.retrieve.elementSetName;
2478 if (*start >= resultset->size)
2480 yaz_log(log_details, "%p send_present start=%d >= size=%d",
2481 c, *start, resultset->size);
2482 return zoom_complete;
2484 if (*start + *count > resultset->size)
2485 *count = resultset->size - *start;
2488 return zoom_complete;
2490 yaz_log(log_details, "%p send_present start=%d count=%d",
2493 if (c->error) /* don't continue on error */
2494 return zoom_complete;
2496 return zoom_complete;
2497 yaz_log(log_details, "send_present resultset=%p start=%d count=%d",
2498 resultset, *start, *count);
2500 for (i = 0; i < *count; i++)
2503 record_cache_lookup(resultset, i + *start, syntax, elementSetName);
2508 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2509 ZOOM_connection_put_event(c, event);
2517 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2518 return zoom_complete;
2521 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2522 req = apdu->u.presentRequest;
2525 yaz_log(log_details, "%p send_present skip=%d", c, i);
2527 *req->resultSetStartPoint = *start + 1;
2528 *req->numberOfRecordsRequested = resultset->step>0 ?
2529 resultset->step : *count;
2530 if (*req->numberOfRecordsRequested + *start > resultset->size)
2531 *req->numberOfRecordsRequested = resultset->size - *start;
2532 assert(*req->numberOfRecordsRequested > 0);
2534 if (syntax && *syntax)
2535 req->preferredRecordSyntax =
2536 yaz_str_to_z3950oid(c->odr_out, CLASS_RECSYN, syntax);
2538 if (resultset->schema && *resultset->schema)
2540 Z_RecordComposition *compo = (Z_RecordComposition *)
2541 odr_malloc(c->odr_out, sizeof(*compo));
2543 req->recordComposition = compo;
2544 compo->which = Z_RecordComp_complex;
2545 compo->u.complex = (Z_CompSpec *)
2546 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2547 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2548 odr_malloc(c->odr_out, sizeof(bool_t));
2549 *compo->u.complex->selectAlternativeSyntax = 0;
2551 compo->u.complex->generic = (Z_Specification *)
2552 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2554 compo->u.complex->generic->which = Z_Schema_oid;
2555 compo->u.complex->generic->schema.oid = (Odr_oid *)
2556 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2558 if (!compo->u.complex->generic->schema.oid)
2560 /* OID wasn't a schema! Try record syntax instead. */
2562 compo->u.complex->generic->schema.oid = (Odr_oid *)
2563 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2565 if (elementSetName && *elementSetName)
2567 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2568 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2569 compo->u.complex->generic->elementSpec->which =
2570 Z_ElementSpec_elementSetName;
2571 compo->u.complex->generic->elementSpec->u.elementSetName =
2572 odr_strdup(c->odr_out, elementSetName);
2575 compo->u.complex->generic->elementSpec = 0;
2576 compo->u.complex->num_dbSpecific = 0;
2577 compo->u.complex->dbSpecific = 0;
2578 compo->u.complex->num_recordSyntax = 0;
2579 compo->u.complex->recordSyntax = 0;
2581 else if (elementSetName && *elementSetName)
2583 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2584 odr_malloc(c->odr_out, sizeof(*esn));
2585 Z_RecordComposition *compo = (Z_RecordComposition *)
2586 odr_malloc(c->odr_out, sizeof(*compo));
2588 esn->which = Z_ElementSetNames_generic;
2589 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
2590 compo->which = Z_RecordComp_simple;
2591 compo->u.simple = esn;
2592 req->recordComposition = compo;
2594 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2595 return send_APDU(c, apdu);
2598 ZOOM_API(ZOOM_scanset)
2599 ZOOM_connection_scan(ZOOM_connection c, const char *start)
2602 ZOOM_query q = ZOOM_query_create();
2604 ZOOM_query_prefix(q, start);
2606 s = ZOOM_connection_scan1(c, q);
2607 ZOOM_query_destroy(q);
2612 ZOOM_API(ZOOM_scanset)
2613 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q)
2617 ZOOM_scanset scan = 0;
2620 * We need to check the query-type, so we can recognise CQL and
2621 * CCL and compile them into a form that we can use here. The
2622 * ZOOM_query structure has no explicit `type' member, but
2623 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2624 * functions shows how the structure is set up in each case.
2628 else if (q->z_query->which == Z_Query_type_1)
2630 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2631 c, q, q->query_string);
2632 start = q->query_string;
2634 else if (q->z_query->which == Z_Query_type_104)
2636 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2637 c, q, q->query_string);
2638 start = freeme = cql2pqf(c, q->query_string);
2644 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2645 c, q, q->query_string);
2649 scan = (ZOOM_scanset) xmalloc(sizeof(*scan));
2650 scan->connection = c;
2651 scan->odr = odr_createmem(ODR_DECODE);
2652 scan->options = ZOOM_options_create_with_parent(c->options);
2654 scan->scan_response = 0;
2655 scan->termListAndStartPoint =
2656 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2658 if (scan->termListAndStartPoint != 0)
2660 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_SCAN);
2661 task->u.scan.scan = scan;
2666 while (ZOOM_event(1, &c))
2674 ZOOM_scanset_destroy(ZOOM_scanset scan)
2679 if (scan->refcount == 0)
2681 odr_destroy(scan->odr);
2683 ZOOM_options_destroy(scan->options);
2688 static zoom_ret send_package(ZOOM_connection c)
2692 yaz_log(log_details, "%p send_package", c);
2694 return zoom_complete;
2695 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2697 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
2698 ZOOM_connection_put_event(c, event);
2700 c->buf_out = c->tasks->u.package->buf_out;
2701 c->len_out = c->tasks->u.package->len_out;
2706 static zoom_ret send_scan(ZOOM_connection c)
2709 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2710 Z_ScanRequest *req = apdu->u.scanRequest;
2712 yaz_log(log_details, "%p send_scan", c);
2714 return zoom_complete;
2715 assert (c->tasks->which == ZOOM_TASK_SCAN);
2716 scan = c->tasks->u.scan.scan;
2718 req->termListAndStartPoint = scan->termListAndStartPoint;
2719 req->attributeSet = scan->attributeSet;
2721 *req->numberOfTermsRequested =
2722 ZOOM_options_get_int(scan->options, "number", 10);
2724 req->preferredPositionInResponse =
2725 odr_intdup(c->odr_out,
2726 ZOOM_options_get_int(scan->options, "position", 1));
2729 odr_intdup(c->odr_out,
2730 ZOOM_options_get_int(scan->options, "stepSize", 0));
2732 req->databaseNames = set_DatabaseNames(c, scan->options,
2733 &req->num_databaseNames);
2735 return send_APDU(c, apdu);
2739 ZOOM_scanset_size(ZOOM_scanset scan)
2741 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2743 return scan->scan_response->entries->num_entries;
2746 ZOOM_API(const char *)
2747 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2750 const char *term = 0;
2751 size_t noent = ZOOM_scanset_size(scan);
2752 Z_ScanResponse *res = scan->scan_response;
2758 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2760 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2762 if (t->term->which == Z_Term_general)
2764 term = (const char *) t->term->u.general->buf;
2765 *len = t->term->u.general->len;
2767 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2772 ZOOM_API(const char *)
2773 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2776 const char *term = 0;
2777 size_t noent = ZOOM_scanset_size(scan);
2778 Z_ScanResponse *res = scan->scan_response;
2784 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2786 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2790 term = t->displayTerm;
2791 *len = strlen(term);
2793 else if (t->term->which == Z_Term_general)
2795 term = (const char *) t->term->u.general->buf;
2796 *len = t->term->u.general->len;
2798 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2803 ZOOM_API(const char *)
2804 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
2806 return ZOOM_options_get(scan->options, key);
2810 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2813 ZOOM_options_set(scan->options, key, val);
2816 static Z_APDU *create_es_package(ZOOM_package p, int type)
2819 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2820 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2822 *req->function = Z_ExtendedServicesRequest_create;
2824 str = ZOOM_options_get(p->options, "package-name");
2826 req->packageName = nmem_strdup(p->odr_out->mem, str);
2828 str = ZOOM_options_get(p->options, "user-id");
2830 req->userId = nmem_strdup(p->odr_out->mem, str);
2832 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2835 str = ZOOM_options_get(p->options, "function");
2838 if (!strcmp (str, "create"))
2840 if (!strcmp (str, "delete"))
2842 if (!strcmp (str, "modify"))
2848 static const char *ill_array_lookup(void *clientData, const char *idx)
2850 ZOOM_package p = (ZOOM_package) clientData;
2851 return ZOOM_options_get(p->options, idx+4);
2854 static Z_External *encode_ill_request(ZOOM_package p)
2856 ODR out = p->odr_out;
2859 struct ill_get_ctl ctl;
2861 ctl.odr = p->odr_out;
2863 ctl.f = ill_array_lookup;
2865 req = ill_get_ILLRequest(&ctl, "ill", 0);
2867 if (!ill_Request(out, &req, 0, 0))
2869 int ill_request_size;
2870 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
2871 if (ill_request_buf)
2872 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
2878 int illRequest_size = 0;
2879 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
2881 oid.proto = PROTO_GENERAL;
2882 oid.oclass = CLASS_GENERAL;
2883 oid.value = VAL_ISO_ILL_1;
2885 r = (Z_External *) odr_malloc(out, sizeof(*r));
2886 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2887 r->indirect_reference = 0;
2889 r->which = Z_External_single;
2891 r->u.single_ASN1_type =
2892 odr_create_Odr_oct(out,
2893 (unsigned char *)illRequest_buf,
2899 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2901 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
2904 req->which = Z_IOItemOrder_esRequest;
2905 req->u.esRequest = (Z_IORequest *)
2906 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2908 /* to keep part ... */
2909 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2910 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2911 req->u.esRequest->toKeep->supplDescription = 0;
2912 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2913 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2915 str = ZOOM_options_get(p->options, "contact-name");
2916 req->u.esRequest->toKeep->contact->name = str ?
2917 nmem_strdup(p->odr_out->mem, str) : 0;
2919 str = ZOOM_options_get(p->options, "contact-phone");
2920 req->u.esRequest->toKeep->contact->phone = str ?
2921 nmem_strdup(p->odr_out->mem, str) : 0;
2923 str = ZOOM_options_get(p->options, "contact-email");
2924 req->u.esRequest->toKeep->contact->email = str ?
2925 nmem_strdup(p->odr_out->mem, str) : 0;
2927 req->u.esRequest->toKeep->addlBilling = 0;
2929 /* not to keep part ... */
2930 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2931 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2933 str = ZOOM_options_get(p->options, "itemorder-setname");
2938 req->u.esRequest->notToKeep->resultSetItem = 0;
2941 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2942 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2944 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2945 nmem_strdup(p->odr_out->mem, str);
2946 req->u.esRequest->notToKeep->resultSetItem->item =
2947 (int *) odr_malloc(p->odr_out, sizeof(int));
2949 str = ZOOM_options_get(p->options, "itemorder-item");
2950 *req->u.esRequest->notToKeep->resultSetItem->item =
2951 (str ? atoi(str) : 1);
2953 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2958 Z_APDU *create_admin_package(ZOOM_package p, int type,
2959 Z_ESAdminOriginPartToKeep **toKeepP,
2960 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2962 Z_APDU *apdu = create_es_package(p, VAL_ADMINSERVICE);
2965 Z_ESAdminOriginPartToKeep *toKeep;
2966 Z_ESAdminOriginPartNotToKeep *notToKeep;
2967 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
2968 const char *first_db = "Default";
2970 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2974 r->direct_reference =
2975 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2978 r->indirect_reference = 0;
2979 r->which = Z_External_ESAdmin;
2981 r->u.adminService = (Z_Admin *)
2982 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2983 r->u.adminService->which = Z_Admin_esRequest;
2984 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2985 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2987 toKeep = r->u.adminService->u.esRequest->toKeep =
2988 (Z_ESAdminOriginPartToKeep *)
2989 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2990 toKeep->which = type;
2991 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2992 toKeep->u.create = odr_nullval();
2993 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2995 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2996 (Z_ESAdminOriginPartNotToKeep *)
2997 odr_malloc(p->odr_out,
2998 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2999 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
3000 notToKeep->u.recordsWillFollow = odr_nullval();
3004 *notToKeepP = notToKeep;
3009 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
3011 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
3012 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
3013 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
3014 const char *doc = ZOOM_options_get(p->options, "doc");
3019 req->taskSpecificParameters = ext;
3020 ext->direct_reference = req->packageType;
3021 ext->descriptor = 0;
3022 ext->indirect_reference = 0;
3024 ext->which = Z_External_octet;
3025 ext->u.single_ASN1_type =
3026 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
3031 static Z_APDU *create_update_package(ZOOM_package p)
3034 const char *first_db = "Default";
3036 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
3037 const char *action = ZOOM_options_get(p->options, "action");
3038 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
3039 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
3040 const char *record_buf = ZOOM_options_get(p->options, "record");
3041 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
3042 int syntax_oid = VAL_NONE;
3046 syntax_oid = oid_getvalbyname(syntax_str);
3049 record_buf = "void";
3050 syntax_oid = VAL_SUTRS;
3052 if (syntax_oid == VAL_NONE)
3053 syntax_oid = VAL_TEXT_XML;
3059 action = "specialUpdate";
3061 if (!strcmp(action, "recordInsert"))
3062 action_no = Z_IUOriginPartToKeep_recordInsert;
3063 else if (!strcmp(action, "recordReplace"))
3064 action_no = Z_IUOriginPartToKeep_recordReplace;
3065 else if (!strcmp(action, "recordDelete"))
3066 action_no = Z_IUOriginPartToKeep_recordDelete;
3067 else if (!strcmp(action, "elementUpdate"))
3068 action_no = Z_IUOriginPartToKeep_elementUpdate;
3069 else if (!strcmp(action, "specialUpdate"))
3070 action_no = Z_IUOriginPartToKeep_specialUpdate;
3074 apdu = create_es_package(p, VAL_DBUPDATE);
3077 Z_IUOriginPartToKeep *toKeep;
3078 Z_IUSuppliedRecords *notToKeep;
3079 Z_External *r = (Z_External *)
3080 odr_malloc(p->odr_out, sizeof(*r));
3082 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3084 r->direct_reference =
3085 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3088 r->which = Z_External_update;
3089 r->indirect_reference = 0;
3090 r->u.update = (Z_IUUpdate *)
3091 odr_malloc(p->odr_out, sizeof(*r->u.update));
3093 r->u.update->which = Z_IUUpdate_esRequest;
3094 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
3095 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
3096 toKeep = r->u.update->u.esRequest->toKeep =
3097 (Z_IUOriginPartToKeep *)
3098 odr_malloc(p->odr_out, sizeof(*toKeep));
3100 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
3102 toKeep->elementSetName = 0;
3103 toKeep->actionQualifier = 0;
3104 toKeep->action = odr_intdup(p->odr_out, action_no);
3106 notToKeep = r->u.update->u.esRequest->notToKeep =
3107 (Z_IUSuppliedRecords *)
3108 odr_malloc(p->odr_out, sizeof(*notToKeep));
3110 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
3111 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
3112 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
3113 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
3114 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
3117 notToKeep->elements[0]->u.opaque =
3118 odr_create_Odr_oct(p->odr_out,
3119 (const unsigned char *) recordIdOpaque,
3120 strlen(recordIdOpaque));
3122 else if (recordIdNumber)
3124 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
3126 notToKeep->elements[0]->u.number =
3127 odr_intdup(p->odr_out, atoi(recordIdNumber));
3130 notToKeep->elements[0]->u.opaque = 0;
3131 notToKeep->elements[0]->supplementalId = 0;
3132 notToKeep->elements[0]->correlationInfo = 0;
3133 notToKeep->elements[0]->record =
3134 z_ext_record(p->odr_out, syntax_oid,
3135 record_buf, strlen(record_buf));
3139 ODR print = odr_createmem(ODR_PRINT);
3141 z_APDU(print, &apdu, 0, 0);
3148 ZOOM_package_send(ZOOM_package p, const char *type)
3155 odr_reset(p->odr_out);
3158 if (!strcmp(type, "itemorder"))
3160 apdu = create_es_package(p, VAL_ITEMORDER);
3163 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
3165 r->direct_reference =
3166 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3169 r->which = Z_External_itemOrder;
3170 r->indirect_reference = 0;
3171 r->u.itemOrder = encode_item_order(p);
3173 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3176 else if (!strcmp(type, "create")) /* create database */
3178 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3181 else if (!strcmp(type, "drop")) /* drop database */
3183 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3186 else if (!strcmp(type, "commit")) /* commit changes */
3188 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3191 else if (!strcmp(type, "update")) /* update record(s) */
3193 apdu = create_update_package(p);
3195 else if (!strcmp(type, "xmlupdate"))
3197 apdu = create_xmlupdate_package(p);
3201 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3205 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
3206 task->u.package = p;
3207 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3208 p->buf_out = (char *) xmalloc(p->len_out);
3209 memcpy(p->buf_out, buf, p->len_out);
3214 while (ZOOM_event(1, &c))
3221 ZOOM_API(ZOOM_package)
3222 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
3224 ZOOM_package p = (ZOOM_package) xmalloc(sizeof(*p));
3227 p->odr_out = odr_createmem(ODR_ENCODE);
3228 p->options = ZOOM_options_create_with_parent2(options, c->options);
3236 ZOOM_package_destroy(ZOOM_package p)
3241 if (p->refcount == 0)
3243 odr_destroy(p->odr_out);
3246 ZOOM_options_destroy(p->options);
3251 ZOOM_API(const char *)
3252 ZOOM_package_option_get(ZOOM_package p, const char *key)
3254 return ZOOM_options_get(p->options, key);
3259 ZOOM_package_option_set(ZOOM_package p, const char *key,
3262 ZOOM_options_set(p->options, key, val);
3265 static int ZOOM_connection_exec_task(ZOOM_connection c)
3267 ZOOM_task task = c->tasks;
3268 zoom_ret ret = zoom_complete;
3272 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3273 c, task->which, task->running);
3274 if (c->error != ZOOM_ERROR_NONE)
3276 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3277 "removing tasks because of error = %d", c, c->error);
3278 ZOOM_connection_remove_tasks(c);
3283 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3284 "task already running", c);
3288 ret = zoom_complete;
3289 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3291 switch (task->which)
3293 case ZOOM_TASK_SEARCH:
3294 if (c->proto == PROTO_HTTP)
3295 ret = ZOOM_connection_srw_send_search(c);
3297 ret = ZOOM_connection_send_search(c);
3299 case ZOOM_TASK_RETRIEVE:
3300 if (c->proto == PROTO_HTTP)
3301 ret = ZOOM_connection_srw_send_search(c);
3303 ret = send_present(c);
3305 case ZOOM_TASK_CONNECT:
3306 ret = do_connect(c);
3308 case ZOOM_TASK_SCAN:
3311 case ZOOM_TASK_PACKAGE:
3312 ret = send_package(c);
3314 case ZOOM_TASK_SORT:
3315 c->tasks->u.sort.resultset->r_sort_spec =
3316 c->tasks->u.sort.q->sort_spec;
3317 ret = send_sort(c, c->tasks->u.sort.resultset);
3323 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3324 "remove tasks because no connection exist", c);
3325 ZOOM_connection_remove_tasks(c);
3327 if (ret == zoom_complete)
3329 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3330 "task removed (complete)", c);
3331 ZOOM_connection_remove_task(c);
3334 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3339 static zoom_ret send_sort_present(ZOOM_connection c)
3341 zoom_ret r = zoom_complete;
3343 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3344 r = send_sort(c, c->tasks->u.search.resultset);
3345 if (r == zoom_complete)
3346 r = send_present(c);
3350 static int es_response(ZOOM_connection c,
3351 Z_ExtendedServicesResponse *res)
3353 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3355 if (res->diagnostics && res->num_diagnostics > 0)
3356 response_diag(c, res->diagnostics[0]);
3357 if (res->taskPackage &&
3358 res->taskPackage->which == Z_External_extendedService)
3360 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3361 Odr_oct *id = taskPackage->targetReference;
3364 ZOOM_options_setl(c->tasks->u.package->options,
3365 "targetReference", (char*) id->buf, id->len);
3367 if (res->taskPackage &&
3368 res->taskPackage->which == Z_External_octet)
3370 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3371 ZOOM_options_setl(c->tasks->u.package->options,
3372 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3377 static void interpret_init_diag(ZOOM_connection c,
3378 Z_DiagnosticFormat *diag)
3382 Z_DiagnosticFormat_s *ds = diag->elements[0];
3383 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3384 response_default_diag(c, ds->u.defaultDiagRec);
3389 static void interpret_otherinformation_field(ZOOM_connection c,
3390 Z_OtherInformation *ui)
3393 for (i = 0; i < ui->num_elements; i++)
3395 Z_OtherInformationUnit *unit = ui->list[i];
3396 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3397 unit->information.externallyDefinedInfo &&
3398 unit->information.externallyDefinedInfo->which ==
3401 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3406 static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
3408 Z_InitResponse *initrs;
3411 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3414 case Z_APDU_initResponse:
3415 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3416 initrs = apdu->u.initResponse;
3417 ZOOM_connection_option_set(c, "serverImplementationId",
3418 initrs->implementationId ?
3419 initrs->implementationId : "");
3420 ZOOM_connection_option_set(c, "serverImplementationName",
3421 initrs->implementationName ?
3422 initrs->implementationName : "");
3423 ZOOM_connection_option_set(c, "serverImplementationVersion",
3424 initrs->implementationVersion ?
3425 initrs->implementationVersion : "");
3426 /* Set the three old options too, for old applications */
3427 ZOOM_connection_option_set(c, "targetImplementationId",
3428 initrs->implementationId ?
3429 initrs->implementationId : "");
3430 ZOOM_connection_option_set(c, "targetImplementationName",
3431 initrs->implementationName ?
3432 initrs->implementationName : "");
3433 ZOOM_connection_option_set(c, "targetImplementationVersion",
3434 initrs->implementationVersion ?
3435 initrs->implementationVersion : "");
3436 if (!*initrs->result)
3438 Z_External *uif = initrs->userInformationField;
3440 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3442 if (uif && uif->which == Z_External_userInfo1)
3443 interpret_otherinformation_field(c, uif->u.userInfo1);
3448 yaz_oi_get_string_oidval(&apdu->u.initResponse->otherInfo,
3450 xfree(c->cookie_in);
3453 c->cookie_in = xstrdup(cookie);
3454 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3455 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3456 c->support_named_resultsets = 1;
3459 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3460 ZOOM_connection_remove_task(c);
3462 ZOOM_connection_exec_task(c);
3464 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3466 NMEM tmpmem = nmem_create();
3467 Z_CharSetandLanguageNegotiation *p =
3468 yaz_get_charneg_record(initrs->otherInfo);
3472 char *charset = NULL, *lang = NULL;
3475 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3476 yaz_log(log_details, "%p recv_apdu target accepted: "
3477 "charset %s, language %s, select %d",
3479 charset ? charset : "none", lang ? lang : "none", sel);
3481 ZOOM_connection_option_set(c, "negotiation-charset",
3484 ZOOM_connection_option_set(c, "negotiation-lang",
3487 ZOOM_connection_option_set(
3488 c, "negotiation-charset-in-effect-for-records",
3489 (sel != 0) ? "1" : "0");
3490 nmem_destroy(tmpmem);
3494 case Z_APDU_searchResponse:
3495 yaz_log(log_api, "%p recv_apdu Search response", c);
3496 handle_search_response(c, apdu->u.searchResponse);
3497 if (send_sort_present(c) == zoom_complete)
3498 ZOOM_connection_remove_task(c);
3500 case Z_APDU_presentResponse:
3501 yaz_log(log_api, "%p recv_apdu Present response", c);
3502 handle_present_response(c, apdu->u.presentResponse);
3503 if (send_present(c) == zoom_complete)
3504 ZOOM_connection_remove_task(c);
3506 case Z_APDU_sortResponse:
3507 yaz_log(log_api, "%p recv_apdu Sort response", c);
3508 sort_response(c, apdu->u.sortResponse);
3509 if (send_present(c) == zoom_complete)
3510 ZOOM_connection_remove_task(c);
3512 case Z_APDU_scanResponse:
3513 yaz_log(log_api, "%p recv_apdu Scan response", c);
3514 scan_response(c, apdu->u.scanResponse);
3515 ZOOM_connection_remove_task(c);
3517 case Z_APDU_extendedServicesResponse:
3518 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3519 es_response(c, apdu->u.extendedServicesResponse);
3520 ZOOM_connection_remove_task(c);
3523 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3524 if (!ZOOM_test_reconnect(c))
3526 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3531 yaz_log(log_api, "%p Received unknown PDU", c);
3532 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3538 static void handle_srw_response(ZOOM_connection c,
3539 Z_SRW_searchRetrieveResponse *res)
3541 ZOOM_resultset resultset = 0;
3546 const char *syntax, *elementSetName;
3551 switch(c->tasks->which)
3553 case ZOOM_TASK_SEARCH:
3554 resultset = c->tasks->u.search.resultset;
3555 start = &c->tasks->u.search.start;
3556 syntax = c->tasks->u.search.syntax;
3557 elementSetName = c->tasks->u.search.elementSetName;
3559 case ZOOM_TASK_RETRIEVE:
3560 resultset = c->tasks->u.retrieve.resultset;
3561 start = &c->tasks->u.retrieve.start;
3562 syntax = c->tasks->u.retrieve.syntax;
3563 elementSetName = c->tasks->u.retrieve.elementSetName;
3568 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3569 ZOOM_connection_put_event(c, event);
3571 resultset->size = 0;
3573 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3575 if (res->numberOfRecords)
3576 resultset->size = *res->numberOfRecords;
3578 for (i = 0; i<res->num_records; i++)
3582 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3583 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3585 if (res->records[i].recordPosition &&
3586 *res->records[i].recordPosition > 0)
3587 pos = *res->records[i].recordPosition - 1;
3591 npr->databaseName = 0;
3592 npr->which = Z_NamePlusRecord_databaseRecord;
3593 npr->u.databaseRecord = (Z_External *)
3594 odr_malloc(c->odr_in, sizeof(Z_External));
3595 npr->u.databaseRecord->descriptor = 0;
3596 npr->u.databaseRecord->direct_reference =
3597 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3598 npr->u.databaseRecord->which = Z_External_octet;
3600 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3601 odr_malloc(c->odr_in, sizeof(Odr_oct));
3602 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3603 res->records[i].recordData_buf;
3604 npr->u.databaseRecord->u.octet_aligned->len =
3605 npr->u.databaseRecord->u.octet_aligned->size =
3606 res->records[i].recordData_len;
3607 record_cache_add(resultset, npr, pos, syntax, elementSetName);
3609 if (res->num_diagnostics > 0)
3611 const char *uri = res->diagnostics[0].uri;
3616 if ((cp = strrchr(uri, '/')))
3618 set_dset_error(c, code, uri,
3619 res->diagnostics[0].details, 0);
3622 nmem = odr_extract_mem(c->odr_in);
3623 nmem_transfer(resultset->odr->mem, nmem);
3629 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3632 const char *content_type = z_HTTP_header_lookup(hres->headers,
3634 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3637 yaz_log(log_details, "%p handle_http", c);
3639 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3641 Z_SOAP *soap_package = 0;
3643 Z_SOAP_Handler soap_handlers[2] = {
3644 {"http://www.loc.gov/zing/srw/", 0,
3645 (Z_SOAP_fun) yaz_srw_codec},
3648 ret = z_soap_codec(o, &soap_package,
3649 &hres->content_buf, &hres->content_len,
3651 if (!ret && soap_package->which == Z_SOAP_generic &&
3652 soap_package->u.generic->no == 0)
3654 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3655 if (sr->which == Z_SRW_searchRetrieve_response)
3656 handle_srw_response(c, sr->u.response);
3660 else if (!ret && (soap_package->which == Z_SOAP_fault
3661 || soap_package->which == Z_SOAP_error))
3663 set_HTTP_error(c, hres->code,
3664 soap_package->u.fault->fault_code,
3665 soap_package->u.fault->fault_string);
3672 if (hres->code != 200)
3673 set_HTTP_error(c, hres->code, 0, 0);
3675 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3678 ZOOM_connection_remove_task(c);
3679 if (!strcmp(hres->version, "1.0"))
3681 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3682 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3687 /* HTTP 1.1: only if no close we stay alive .. */
3688 if (connection_head && !strcmp(connection_head, "close"))
3694 static int do_read(ZOOM_connection c)
3699 event = ZOOM_Event_create(ZOOM_EVENT_RECV_DATA);
3700 ZOOM_connection_put_event(c, event);
3702 r = cs_get(c->cs, &c->buf_in, &c->len_in);
3703 more = cs_more(c->cs);
3704 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3709 if (ZOOM_test_reconnect(c))
3711 yaz_log(log_details, "%p do_read reconnect read", c);
3715 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3724 odr_reset(c->odr_in);
3725 odr_setbuf(c->odr_in, c->buf_in, r, 0);
3726 event = ZOOM_Event_create(ZOOM_EVENT_RECV_APDU);
3727 ZOOM_connection_put_event(c, event);
3729 if (!z_GDU(c->odr_in, &gdu, 0, 0))
3732 int err = odr_geterrorx(c->odr_in, &x);
3734 const char *element = odr_getelement(c->odr_in);
3735 sprintf(msg, "ODR code %d:%d element=%-20s",
3736 err, x, element ? element : "<unknown>");
3737 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3740 else if (gdu->which == Z_GDU_Z3950)
3741 recv_apdu(c, gdu->u.z3950);
3742 else if (gdu->which == Z_GDU_HTTP_Response)
3745 handle_http(c, gdu->u.HTTP_Response);
3747 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3751 c->reconnect_ok = 0;
3756 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
3761 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3762 ZOOM_connection_put_event(c, event);
3764 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3765 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3767 yaz_log(log_details, "%p do_write_ex write failed", c);
3768 if (ZOOM_test_reconnect(c))
3770 return zoom_pending;
3772 if (c->state == STATE_CONNECTING)
3773 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3775 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3777 return zoom_complete;
3781 c->mask = ZOOM_SELECT_EXCEPT;
3782 if (c->cs->io_pending & CS_WANT_WRITE)
3783 c->mask += ZOOM_SELECT_WRITE;
3784 if (c->cs->io_pending & CS_WANT_READ)
3785 c->mask += ZOOM_SELECT_READ;
3786 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3791 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3792 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3795 return zoom_pending;
3798 static zoom_ret do_write(ZOOM_connection c)
3800 return do_write_ex(c, c->buf_out, c->len_out);
3804 ZOOM_API(const char *)
3805 ZOOM_connection_option_get(ZOOM_connection c, const char *key)
3807 return ZOOM_options_get(c->options, key);
3810 ZOOM_API(const char *)
3811 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
3813 return ZOOM_options_getl(c->options, key, lenp);
3817 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
3820 ZOOM_options_set(c->options, key, val);
3824 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
3825 const char *val, int len)
3827 ZOOM_options_setl(c->options, key, val, len);
3830 ZOOM_API(const char *)
3831 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
3833 return ZOOM_options_get(r->options, key);
3837 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key,
3840 ZOOM_options_set(r->options, key, val);
3845 ZOOM_connection_errcode(ZOOM_connection c)
3847 return ZOOM_connection_error(c, 0, 0);
3850 ZOOM_API(const char *)
3851 ZOOM_connection_errmsg(ZOOM_connection c)
3854 ZOOM_connection_error(c, &msg, 0);
3858 ZOOM_API(const char *)
3859 ZOOM_connection_addinfo(ZOOM_connection c)
3861 const char *addinfo;
3862 ZOOM_connection_error(c, 0, &addinfo);
3866 ZOOM_API(const char *)
3867 ZOOM_connection_diagset(ZOOM_connection c)
3869 const char *diagset;
3870 ZOOM_connection_error_x(c, 0, 0, &diagset);
3874 ZOOM_API(const char *)
3875 ZOOM_diag_str(int error)
3879 case ZOOM_ERROR_NONE:
3881 case ZOOM_ERROR_CONNECT:
3882 return "Connect failed";
3883 case ZOOM_ERROR_MEMORY:
3884 return "Out of memory";
3885 case ZOOM_ERROR_ENCODE:
3886 return "Encoding failed";
3887 case ZOOM_ERROR_DECODE:
3888 return "Decoding failed";
3889 case ZOOM_ERROR_CONNECTION_LOST:
3890 return "Connection lost";
3891 case ZOOM_ERROR_INIT:
3892 return "Init rejected";
3893 case ZOOM_ERROR_INTERNAL:
3894 return "Internal failure";
3895 case ZOOM_ERROR_TIMEOUT:
3897 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3898 return "Unsupported protocol";
3899 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3900 return "Unsupported query type";
3901 case ZOOM_ERROR_INVALID_QUERY:
3902 return "Invalid query";
3903 case ZOOM_ERROR_CQL_PARSE:
3904 return "CQL parsing error";
3905 case ZOOM_ERROR_CQL_TRANSFORM:
3906 return "CQL transformation error";
3907 case ZOOM_ERROR_CCL_CONFIG:
3908 return "CCL configuration error";
3909 case ZOOM_ERROR_CCL_PARSE:
3910 return "CCL parsing error";
3912 return diagbib1_str(error);
3917 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
3918 const char **addinfo, const char **diagset)
3920 int error = c->error;
3923 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3924 *cp = ZOOM_diag_str(error);
3925 else if (!strcmp(c->diagset, "HTTP"))
3926 *cp = z_HTTP_errmsg(c->error);
3927 else if (!strcmp(c->diagset, "Bib-1"))
3928 *cp = ZOOM_diag_str(error);
3929 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3930 *cp = yaz_diag_srw_str(c->error);
3932 *cp = "Unknown error and diagnostic set";
3935 *addinfo = c->addinfo ? c->addinfo : "";
3937 *diagset = c->diagset ? c->diagset : "";
3942 ZOOM_connection_error(ZOOM_connection c, const char **cp,
3943 const char **addinfo)
3945 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3948 static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
3950 ZOOM_Event event = 0;
3951 int r = cs_look(c->cs);
3952 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
3957 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
3958 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3960 ZOOM_connection_put_event(c, event);
3962 else if (r == CS_CONNECT)
3964 int ret = ret = cs_rcvconnect(c->cs);
3965 yaz_log(log_details, "%p ZOOM_connection_do_io "
3966 "cs_rcvconnect returned %d", c, ret);
3969 c->mask = ZOOM_SELECT_EXCEPT;
3970 if (c->cs->io_pending & CS_WANT_WRITE)
3971 c->mask += ZOOM_SELECT_WRITE;
3972 if (c->cs->io_pending & CS_WANT_READ)
3973 c->mask += ZOOM_SELECT_READ;
3977 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
3978 ZOOM_connection_put_event(c, event);
3980 if (c->proto == PROTO_Z3950)
3981 ZOOM_connection_send_init(c);
3984 /* no init request for SRW .. */
3985 assert(c->tasks->which == ZOOM_TASK_CONNECT);
3986 ZOOM_connection_remove_task(c);
3988 ZOOM_connection_exec_task(c);
3990 c->state = STATE_ESTABLISHED;
3994 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
4000 if (mask & ZOOM_SELECT_EXCEPT)
4002 if (ZOOM_test_reconnect(c))
4004 event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
4005 ZOOM_connection_put_event(c, event);
4009 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
4014 if (mask & ZOOM_SELECT_READ)
4016 if (c->cs && (mask & ZOOM_SELECT_WRITE))
4022 ZOOM_connection_last_event(ZOOM_connection cs)
4025 return ZOOM_EVENT_NONE;
4026 return cs->last_event;
4030 ZOOM_event(int no, ZOOM_connection *cs)
4032 int timeout = 30; /* default timeout in seconds */
4033 int timeout_set = 0; /* whether it was overriden at all */
4035 struct pollfd pollfds[1024];
4036 ZOOM_connection poll_cs[1024];
4039 fd_set input, output, except;
4044 yaz_log(log_details, "ZOOM_event(no=%d,cs=%p)", no, cs);
4045 for (i = 0; i<no; i++)
4047 ZOOM_connection c = cs[i];
4049 if (c && (event = ZOOM_connection_get_event(c)))
4051 ZOOM_Event_destroy(event);
4055 for (i = 0; i<no; i++)
4057 ZOOM_connection c = cs[i];
4061 ZOOM_connection_exec_task(c);
4062 if ((event = ZOOM_connection_get_event(c)))
4064 ZOOM_Event_destroy(event);
4077 for (i = 0; i<no; i++)
4079 ZOOM_connection c = cs[i];
4085 fd = z3950_connection_socket(c);
4086 mask = z3950_connection_mask(c);
4093 /* -1 is used for indefinite timeout (no timeout), so -2 here. */
4094 this_timeout = ZOOM_options_get_int(c->options, "timeout", -2);
4095 if (this_timeout != -2)
4097 /* ensure the minimum timeout is used */
4099 timeout = this_timeout;
4100 else if (this_timeout != -1 && this_timeout < timeout)
4101 timeout = this_timeout;
4107 short poll_events = 0;
4109 if (mask & ZOOM_SELECT_READ)
4110 poll_events += POLLIN;
4111 if (mask & ZOOM_SELECT_WRITE)
4112 poll_events += POLLOUT;
4113 if (mask & ZOOM_SELECT_EXCEPT)
4114 poll_events += POLLERR;
4115 pollfds[nfds].fd = fd;
4116 pollfds[nfds].events = poll_events;
4117 pollfds[nfds].revents = 0;
4122 if (mask & ZOOM_SELECT_READ)
4127 if (mask & ZOOM_SELECT_WRITE)
4129 FD_SET(fd, &output);
4132 if (mask & ZOOM_SELECT_EXCEPT)
4134 FD_SET(fd, &except);
4143 r = poll(pollfds, nfds, (timeout == -1 ? -1 : timeout * 1000));
4144 for (i = 0; i<nfds; i++)
4146 ZOOM_connection c = poll_cs[i];
4150 if (pollfds[i].revents & POLLIN)
4151 mask += ZOOM_SELECT_READ;
4152 if (pollfds[i].revents & POLLOUT)
4153 mask += ZOOM_SELECT_WRITE;
4154 if (pollfds[i].revents & POLLERR)
4155 mask += ZOOM_SELECT_EXCEPT;
4157 ZOOM_connection_do_io(c, mask);
4159 else if (r == 0 && c->mask)
4161 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4162 /* timeout and this connection was waiting */
4163 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4165 ZOOM_connection_put_event(c, event);
4169 tv.tv_sec = timeout;
4171 r = select(max_fd+1, &input, &output, &except, (timeout == -1 ? 0 : &tv));
4172 for (i = 0; i<no; i++)
4174 ZOOM_connection c = cs[i];
4179 fd = z3950_connection_socket(c);
4183 /* no timeout and real socket */
4184 if (FD_ISSET(fd, &input))
4185 mask += ZOOM_SELECT_READ;
4186 if (FD_ISSET(fd, &output))
4187 mask += ZOOM_SELECT_WRITE;
4188 if (FD_ISSET(fd, &except))
4189 mask += ZOOM_SELECT_EXCEPT;
4191 ZOOM_connection_do_io(c, mask);
4193 if (r == 0 && c->mask)
4195 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4196 /* timeout and this connection was waiting */
4197 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4199 ZOOM_connection_put_event(c, event);
4203 for (i = 0; i<no; i++)
4205 ZOOM_connection c = cs[i];
4207 if (c && (event = ZOOM_connection_get_event(c)))
4209 ZOOM_Event_destroy(event);
4218 * Returns an xmalloc()d string containing RPN that corresponds to the
4219 * CQL passed in. On error, sets the Connection object's error state
4220 * and returns a null pointer.
4221 * ### We could cache CQL parser and/or transformer in Connection.
4223 static char *cql2pqf(ZOOM_connection c, const char *cql)
4227 struct cql_node *node;
4228 const char *cqlfile;
4229 static cql_transform_t trans;
4232 parser = cql_parser_create();
4233 if ((error = cql_parser_string(parser, cql)) != 0) {
4234 cql_parser_destroy(parser);
4235 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4239 node = cql_parser_result(parser);
4240 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4242 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4244 cql_parser_destroy(parser);
4245 cql_node_destroy(node);
4246 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4250 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4252 cql_parser_destroy(parser);
4253 cql_node_destroy(node);
4254 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4255 cqlfile, strerror(errno));
4256 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4260 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4261 cql_parser_destroy(parser);
4262 cql_node_destroy(node);
4265 const char *addinfo;
4266 error = cql_transform_error(trans, &addinfo);
4267 cql_transform_close(trans);
4268 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4269 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4273 cql_transform_close(trans);
4274 return xstrdup(pqfbuf);
4280 * indent-tabs-mode: nil
4282 * vim: shiftwidth=4 tabstop=8 expandtab