2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.68 2006-04-07 11:27:24 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>
30 #include <sys/types.h>
39 #include <sys/select.h>
45 static int log_api = 0;
46 static int log_details = 0;
53 static zoom_ret ZOOM_connection_send_init (ZOOM_connection c);
54 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out);
55 static char *cql2pqf(ZOOM_connection c, const char *cql);
59 static int log_level_initialized = 0;
60 if (!log_level_initialized)
62 log_api = yaz_log_module_level("zoom");
63 log_details = yaz_log_module_level("zoomdetails");
64 log_level_initialized = 1;
68 static ZOOM_Event ZOOM_Event_create (int kind)
70 ZOOM_Event event = (ZOOM_Event) xmalloc (sizeof(*event));
77 static void ZOOM_Event_destroy (ZOOM_Event event)
82 static void ZOOM_connection_put_event (ZOOM_connection c, ZOOM_Event event)
86 c->m_queue_back->prev = event;
87 assert (c->m_queue_front);
91 assert (!c->m_queue_front);
92 c->m_queue_front = event;
94 event->next = c->m_queue_back;
96 c->m_queue_back = event;
99 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
101 ZOOM_Event event = c->m_queue_front;
104 c->last_event = ZOOM_EVENT_NONE;
107 assert (c->m_queue_back);
108 c->m_queue_front = event->prev;
109 if (c->m_queue_front)
111 assert (c->m_queue_back);
112 c->m_queue_front->next = 0;
116 c->last_event = event->kind;
121 static void set_dset_error (ZOOM_connection c, int error,
123 const char *addinfo, const char *addinfo2)
130 if (!c->diagset || strcmp(dset, c->diagset))
133 c->diagset = xstrdup(dset);
134 /* remove integer part from SRW diagset .. */
135 if ((cp = strrchr(c->diagset, '/')))
138 if (addinfo && addinfo2)
140 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
141 strcpy(c->addinfo, addinfo);
142 strcat(c->addinfo, addinfo2);
145 c->addinfo = xstrdup(addinfo);
147 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
148 c, c->host_port ? c->host_port : "<>", dset, error,
149 addinfo ? addinfo : "",
150 addinfo2 ? addinfo2 : "");
154 static void set_HTTP_error (ZOOM_connection c, int error,
155 const char *addinfo, const char *addinfo2)
157 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
161 static void set_ZOOM_error (ZOOM_connection c, int error,
164 set_dset_error(c, error, "ZOOM", addinfo, 0);
167 static void clear_error (ZOOM_connection c)
170 * If an error is tied to an operation then it's ok to clear: for
171 * example, a diagnostic returned from a search is cleared by a
172 * subsequent search. However, problems such as Connection Lost
173 * or Init Refused are not cleared, because they are not
174 * recoverable: doing another search doesn't help.
178 case ZOOM_ERROR_CONNECT:
179 case ZOOM_ERROR_MEMORY:
180 case ZOOM_ERROR_DECODE:
181 case ZOOM_ERROR_CONNECTION_LOST:
182 case ZOOM_ERROR_INIT:
183 case ZOOM_ERROR_INTERNAL:
184 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
187 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
191 ZOOM_task ZOOM_connection_add_task (ZOOM_connection c, int which)
193 ZOOM_task *taskp = &c->tasks;
195 taskp = &(*taskp)->next;
196 *taskp = (ZOOM_task) xmalloc (sizeof(**taskp));
197 (*taskp)->running = 0;
198 (*taskp)->which = which;
204 ZOOM_task ZOOM_connection_insert_task (ZOOM_connection c, int which)
206 ZOOM_task task = (ZOOM_task) xmalloc (sizeof(*task));
208 task->next = c->tasks;
217 void ZOOM_connection_remove_task (ZOOM_connection c)
219 ZOOM_task task = c->tasks;
223 c->tasks = task->next;
226 case ZOOM_TASK_SEARCH:
227 ZOOM_resultset_destroy (task->u.search.resultset);
229 case ZOOM_TASK_RETRIEVE:
230 ZOOM_resultset_destroy (task->u.retrieve.resultset);
232 case ZOOM_TASK_CONNECT:
235 ZOOM_scanset_destroy (task->u.scan.scan);
237 case ZOOM_TASK_PACKAGE:
238 ZOOM_package_destroy (task->u.package);
241 ZOOM_resultset_destroy (task->u.sort.resultset);
242 ZOOM_query_destroy(task->u.sort.q);
251 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
252 ZOOM_connection_put_event(c, event);
257 static int ZOOM_connection_exec_task (ZOOM_connection c);
259 void ZOOM_connection_remove_tasks (ZOOM_connection c)
262 ZOOM_connection_remove_task(c);
265 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos);
267 ZOOM_API(ZOOM_connection)
268 ZOOM_connection_create (ZOOM_options options)
270 ZOOM_connection c = (ZOOM_connection) xmalloc (sizeof(*c));
274 yaz_log(log_api, "%p ZOOM_connection_create", c);
276 c->proto = PROTO_Z3950;
280 c->state = STATE_IDLE;
283 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
290 c->options = ZOOM_options_create_with_parent(options);
296 c->charset = c->lang = 0;
303 c->odr_in = odr_createmem (ODR_DECODE);
304 c->odr_out = odr_createmem (ODR_ENCODE);
307 c->support_named_resultsets = 0;
308 c->last_event = ZOOM_EVENT_NONE;
310 c->m_queue_front = 0;
315 /* set database names. Take local databases (if set); otherwise
316 take databases given in ZURL (if set); otherwise use Default */
317 static char **set_DatabaseNames (ZOOM_connection con, ZOOM_options options,
320 char **databaseNames;
321 const char *cp = ZOOM_options_get (options, "databaseName");
323 if ((!cp || !*cp) && con->host_port)
325 if (strncmp (con->host_port, "unix:", 5) == 0)
326 cp = strchr(con->host_port+5, ':');
328 cp = strchr(con->host_port, '/');
334 nmem_strsplit(con->odr_out->mem, "+", cp, &databaseNames, num);
335 return databaseNames;
338 ZOOM_API(ZOOM_connection)
339 ZOOM_connection_new (const char *host, int portnum)
341 ZOOM_connection c = ZOOM_connection_create (0);
343 ZOOM_connection_connect (c, host, portnum);
347 static zoom_sru_mode get_sru_mode_from_string(const char *s)
350 return zoom_sru_soap;
351 if (!yaz_matchstr(s, "soap"))
352 return zoom_sru_soap;
353 else if (!yaz_matchstr(s, "get"))
355 else if (!yaz_matchstr(s, "post"))
356 return zoom_sru_post;
357 return zoom_sru_error;
361 ZOOM_connection_connect(ZOOM_connection c,
362 const char *host, int portnum)
369 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
374 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
378 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
380 val = ZOOM_options_get (c->options, "proxy");
383 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
384 c->proxy = xstrdup (val);
390 val = ZOOM_options_get (c->options, "charset");
393 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
394 c->charset = xstrdup (val);
400 val = ZOOM_options_get (c->options, "lang");
403 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
404 c->lang = xstrdup (val);
409 val = ZOOM_options_get (c->options, "sru");
410 c->sru_mode = get_sru_mode_from_string(val);
412 xfree (c->host_port);
416 sprintf (hostn, "%.80s:%d", host, portnum);
417 c->host_port = xstrdup(hostn);
420 c->host_port = xstrdup(host);
424 * If the "<scheme>:" part of the host string is preceded by one
425 * or more comma-separated <name>=<value> pairs, these are taken
426 * to be options to be set on the connection object. Among other
427 * applications, this facility can be used to embed authentication
429 * user=admin,password=secret,tcp:localhost:9999
431 char *remainder = c->host_port;
432 char *pcolon = strchr(remainder, ':');
435 while ((pcomma = strchr(remainder, ',')) != 0 &&
436 (pcolon == 0 || pcomma < pcolon)) {
438 if ((pequals = strchr(remainder, '=')) != 0) {
440 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
441 ZOOM_connection_option_set(c, remainder, pequals+1);
443 remainder = pcomma+1;
446 if (remainder != c->host_port) {
448 c->host_port = xstrdup(remainder);
449 /*printf("# reset hp='%s'\n", remainder);*/
453 ZOOM_options_set(c->options, "host", c->host_port);
455 val = ZOOM_options_get (c->options, "cookie");
458 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
459 c->cookie_out = xstrdup (val);
462 val = ZOOM_options_get (c->options, "clientIP");
465 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
467 c->client_IP = xstrdup (val);
470 c->async = ZOOM_options_get_bool (c->options, "async", 0);
471 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
473 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
475 task = ZOOM_connection_add_task (c, ZOOM_TASK_CONNECT);
479 while (ZOOM_event (1, &c))
485 ZOOM_query_create(void)
487 ZOOM_query s = (ZOOM_query) xmalloc (sizeof(*s));
489 yaz_log(log_details, "%p ZOOM_query_create", s);
493 s->odr = odr_createmem (ODR_ENCODE);
500 ZOOM_query_destroy(ZOOM_query s)
506 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
507 if (s->refcount == 0)
509 odr_destroy (s->odr);
515 ZOOM_query_prefix(ZOOM_query s, const char *str)
517 s->query_string = odr_strdup(s->odr, str);
518 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
519 s->z_query->which = Z_Query_type_1;
520 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
521 if (!s->z_query->u.type_1)
523 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
527 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
532 ZOOM_query_cql(ZOOM_query s, const char *str)
536 s->query_string = odr_strdup(s->odr, str);
538 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
539 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
540 ext->indirect_reference = 0;
542 ext->which = Z_External_CQL;
543 ext->u.cql = s->query_string;
545 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
546 s->z_query->which = Z_Query_type_104;
547 s->z_query->u.type_104 = ext;
549 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
555 * Translate the CQL string client-side into RPN which is passed to
556 * the server. This is useful for server's that don't themselves
557 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
558 * only as a place to stash diagnostics if compilation fails; if this
559 * information is not needed, a null pointer may be used.
562 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
567 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
569 conn = ZOOM_connection_create(0);
571 if ((rpn = cql2pqf(conn, str)) == 0)
574 ret = ZOOM_query_prefix(s, rpn);
580 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
582 s->sort_spec = yaz_sort_spec (s->odr, criteria);
585 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
589 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
593 static zoom_ret do_write(ZOOM_connection c);
596 ZOOM_connection_destroy(ZOOM_connection c)
601 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
604 for (r = c->resultsets; r; r = r->next)
610 odr_destroy (c->odr_in);
611 odr_destroy (c->odr_out);
612 ZOOM_options_destroy (c->options);
613 ZOOM_connection_remove_tasks (c);
614 xfree (c->host_port);
619 xfree (c->cookie_out);
620 xfree (c->cookie_in);
621 xfree (c->client_IP);
625 void ZOOM_resultset_addref (ZOOM_resultset r)
630 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
635 ZOOM_resultset ZOOM_resultset_create ()
637 ZOOM_resultset r = (ZOOM_resultset) xmalloc (sizeof(*r));
641 yaz_log(log_details, "%p ZOOM_resultset_create", r);
644 r->odr = odr_createmem (ODR_ENCODE);
659 ZOOM_API(ZOOM_resultset)
660 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
663 ZOOM_query s = ZOOM_query_create();
665 ZOOM_query_prefix (s, q);
667 r = ZOOM_connection_search (c, s);
668 ZOOM_query_destroy (s);
672 ZOOM_API(ZOOM_resultset)
673 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
675 ZOOM_resultset r = ZOOM_resultset_create ();
679 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
680 r->r_sort_spec = q->sort_spec;
683 r->options = ZOOM_options_create_with_parent(c->options);
685 r->start = ZOOM_options_get_int(r->options, "start", 0);
686 r->count = ZOOM_options_get_int(r->options, "count", 0);
688 /* If "presentChunk" is defined use that; otherwise "step" */
689 const char *cp = ZOOM_options_get (r->options, "presentChunk");
690 r->step = ZOOM_options_get_int(r->options,
691 (cp != 0 ? "presentChunk": "step"), 0);
693 r->piggyback = ZOOM_options_get_bool (r->options, "piggyback", 1);
694 cp = ZOOM_options_get (r->options, "setname");
696 r->setname = xstrdup(cp);
697 cp = ZOOM_options_get (r->options, "schema");
699 r->schema = xstrdup(cp);
703 r->next = c->resultsets;
706 if (c->host_port && c->proto == PROTO_HTTP)
710 yaz_log(log_details, "ZOOM_connection_search: no comstack");
711 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
715 yaz_log(log_details, "ZOOM_connection_search: reconnect");
720 task = ZOOM_connection_add_task (c, ZOOM_TASK_SEARCH);
721 task->u.search.resultset = r;
722 ZOOM_resultset_addref (r);
728 while (ZOOM_event (1, &c))
735 * This is the old result-set sorting API, which is maintained only
736 * for the sake of binary compatibility. There is no reason ever to
737 * use this rather than ZOOM_resultset_sort1().
740 ZOOM_resultset_sort(ZOOM_resultset r,
741 const char *sort_type, const char *sort_spec)
743 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
747 ZOOM_resultset_sort1(ZOOM_resultset r,
748 const char *sort_type, const char *sort_spec)
750 ZOOM_connection c = r->connection;
754 newq = ZOOM_query_create();
755 if (ZOOM_query_sortby(newq, sort_spec) < 0)
758 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
759 r, r, sort_type, sort_spec);
763 if (c->host_port && c->proto == PROTO_HTTP)
767 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
768 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
772 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
778 ZOOM_resultset_cache_reset(r);
779 task = ZOOM_connection_add_task (c, ZOOM_TASK_SORT);
780 task->u.sort.resultset = r;
781 task->u.sort.q = newq;
783 ZOOM_resultset_addref (r);
787 while (ZOOM_event (1, &c))
795 ZOOM_resultset_cache_reset(ZOOM_resultset r)
797 ZOOM_record_cache rc;
799 for (rc = r->record_cache; rc; rc = rc->next)
801 if (rc->rec.wrbuf_marc)
802 wrbuf_free (rc->rec.wrbuf_marc, 1);
803 if (rc->rec.wrbuf_iconv)
804 wrbuf_free (rc->rec.wrbuf_iconv, 1);
805 if (rc->rec.wrbuf_opac)
806 wrbuf_free (rc->rec.wrbuf_opac, 1);
812 ZOOM_resultset_destroy(ZOOM_resultset r)
817 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
819 if (r->refcount == 0)
821 ZOOM_resultset_cache_reset(r);
825 /* remove ourselves from the resultsets in connection */
826 ZOOM_resultset *rp = &r->connection->resultsets;
829 assert (*rp); /* we must be in this list!! */
831 { /* OK, we're here - take us out of it */
838 ZOOM_query_destroy (r->query);
839 ZOOM_options_destroy (r->options);
840 odr_destroy (r->odr);
848 ZOOM_resultset_size (ZOOM_resultset r)
853 static void do_close (ZOOM_connection c)
859 c->state = STATE_IDLE;
862 static void ZOOM_resultset_retrieve (ZOOM_resultset r,
863 int force_sync, int start, int count)
871 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
872 " count=%d", r, force_sync, start, count);
877 if (c->host_port && c->proto == PROTO_HTTP)
881 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
882 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
886 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
891 task = ZOOM_connection_add_task (c, ZOOM_TASK_RETRIEVE);
892 task->u.retrieve.resultset = r;
893 task->u.retrieve.start = start;
894 task->u.retrieve.count = count;
896 cp = ZOOM_options_get (r->options, "schema");
899 if (!r->schema || strcmp(r->schema, cp))
902 r->schema = xstrdup(cp);
906 ZOOM_resultset_addref (r);
908 if (!r->connection->async || force_sync)
909 while (r->connection && ZOOM_event (1, &r->connection))
914 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
915 size_t start, size_t count)
917 int force_present = 0;
921 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%d count=%d",
925 ZOOM_resultset_retrieve (r, force_present, start, count);
929 for (i = 0; i< count; i++)
930 recs[i] = ZOOM_resultset_record_immediate (r, i+start);
934 static void get_cert(ZOOM_connection c)
939 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
941 ZOOM_connection_option_setl(c, "sslPeerCert",
947 static zoom_ret do_connect (ZOOM_connection c)
950 const char *effective_host;
953 effective_host = c->proxy;
955 effective_host = c->host_port;
957 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
961 c->cs = cs_create_host (effective_host, 0, &add);
963 if (c->cs && c->cs->protocol == PROTO_HTTP)
966 const char *path = 0;
968 c->proto = PROTO_HTTP;
969 cs_get_host_args(c->host_port, &path);
971 c->path = (char*) xmalloc(strlen(path)+2);
973 strcpy (c->path+1, path);
975 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
977 return zoom_complete;
982 int ret = cs_connect (c->cs, add);
985 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
986 ZOOM_connection_put_event(c, event);
988 if (c->proto == PROTO_Z3950)
989 ZOOM_connection_send_init(c);
992 /* no init request for SRW .. */
993 assert (c->tasks->which == ZOOM_TASK_CONNECT);
994 ZOOM_connection_remove_task (c);
996 ZOOM_connection_exec_task (c);
998 c->state = STATE_ESTABLISHED;
1003 c->state = STATE_CONNECTING;
1004 c->mask = ZOOM_SELECT_EXCEPT;
1005 if (c->cs->io_pending & CS_WANT_WRITE)
1006 c->mask += ZOOM_SELECT_WRITE;
1007 if (c->cs->io_pending & CS_WANT_READ)
1008 c->mask += ZOOM_SELECT_READ;
1009 return zoom_pending;
1012 c->state = STATE_IDLE;
1013 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1014 return zoom_complete;
1017 int z3950_connection_socket(ZOOM_connection c)
1020 return cs_fileno(c->cs);
1024 int z3950_connection_mask(ZOOM_connection c)
1031 static void otherInfo_attach (ZOOM_connection c, Z_APDU *a, ODR out)
1034 for (i = 0; i<200; i++)
1037 Z_OtherInformation **oi;
1043 sprintf (buf, "otherInfo%d", i);
1044 val = ZOOM_options_get (c->options, buf);
1047 cp = strchr(val, ':');
1051 if (len >= sizeof(buf))
1052 len = sizeof(buf)-1;
1053 memcpy (buf, val, len);
1055 oidval = oid_getvalbyname (buf);
1056 if (oidval == VAL_NONE)
1059 yaz_oi_APDU(a, &oi);
1060 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1064 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1069 Z_OtherInformation **oi;
1070 yaz_oi_APDU(a, &oi);
1071 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1075 Z_OtherInformation **oi;
1076 yaz_oi_APDU(a, &oi);
1077 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1079 otherInfo_attach (c, a, out);
1080 if (!z_APDU(out, &a, 0, 0))
1082 FILE *outf = fopen("/tmp/apdu.txt", "a");
1085 ODR odr_pr = odr_createmem(ODR_PRINT);
1086 fprintf (outf, "a=%p\n", a);
1087 odr_setprint(odr_pr, outf);
1088 z_APDU(odr_pr, &a, 0, 0);
1089 odr_destroy(odr_pr);
1091 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1092 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1096 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1100 static zoom_ret send_APDU (ZOOM_connection c, Z_APDU *a)
1104 if (encode_APDU(c, a, c->odr_out))
1105 return zoom_complete;
1106 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1107 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1108 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1109 ZOOM_connection_put_event (c, event);
1110 odr_reset(c->odr_out);
1111 return do_write (c);
1114 /* returns 1 if PDU was sent OK (still pending )
1115 0 if PDU was not sent OK (nothing to wait for)
1118 static zoom_ret ZOOM_connection_send_init (ZOOM_connection c)
1120 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1121 Z_InitRequest *ireq = apdu->u.initRequest;
1122 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1123 odr_malloc(c->odr_out, sizeof(*auth));
1124 const char *auth_groupId = ZOOM_options_get (c->options, "group");
1125 const char *auth_userId = ZOOM_options_get (c->options, "user");
1126 const char *auth_password = ZOOM_options_get (c->options, "password");
1129 /* support the pass for backwards compatibility */
1131 auth_password = ZOOM_options_get (c->options, "pass");
1133 ODR_MASK_SET(ireq->options, Z_Options_search);
1134 ODR_MASK_SET(ireq->options, Z_Options_present);
1135 ODR_MASK_SET(ireq->options, Z_Options_scan);
1136 ODR_MASK_SET(ireq->options, Z_Options_sort);
1137 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1138 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1140 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1141 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1142 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1144 /* Index Data's Z39.50 Implementor Id is 81 */
1145 ireq->implementationId = odr_prepend(c->odr_out,
1146 ZOOM_options_get(c->options, "implementationId"),
1147 odr_prepend(c->odr_out, "81", ireq->implementationId));
1149 ireq->implementationName = odr_prepend(c->odr_out,
1150 ZOOM_options_get(c->options, "implementationName"),
1151 odr_prepend(c->odr_out, "ZOOM-C", ireq->implementationName));
1153 version = odr_strdup(c->odr_out, "$Revision: 1.68 $");
1154 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1155 version[strlen(version)-2] = '\0';
1156 ireq->implementationVersion = odr_prepend(c->odr_out,
1157 ZOOM_options_get(c->options, "implementationVersion"),
1158 odr_prepend(c->odr_out, &version[11], ireq->implementationVersion));
1160 *ireq->maximumRecordSize =
1161 ZOOM_options_get_int (c->options, "maximumRecordSize", 1024*1024);
1162 *ireq->preferredMessageSize =
1163 ZOOM_options_get_int (c->options, "preferredMessageSize", 1024*1024);
1165 if (auth_groupId || auth_password)
1167 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1170 if (auth_groupId && *auth_groupId)
1172 pass->groupId = (char *)
1173 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1174 strcpy(pass->groupId, auth_groupId);
1178 if (auth_userId && *auth_userId)
1180 pass->userId = (char *)
1181 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1182 strcpy(pass->userId, auth_userId);
1186 if (auth_password && *auth_password)
1188 pass->password = (char *)
1189 odr_malloc(c->odr_out, strlen(auth_password)+1);
1190 strcpy(pass->password, auth_password);
1195 auth->which = Z_IdAuthentication_idPass;
1196 auth->u.idPass = pass;
1197 ireq->idAuthentication = auth;
1200 else if (auth_userId)
1202 auth->which = Z_IdAuthentication_open;
1203 auth->u.open = (char *)
1204 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1205 strcpy(auth->u.open, auth_userId);
1206 ireq->idAuthentication = auth;
1209 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1210 VAL_PROXY, 1, c->host_port);
1211 if (c->charset || c->lang)
1213 Z_OtherInformation **oi;
1214 Z_OtherInformationUnit *oi_unit;
1216 yaz_oi_APDU(apdu, &oi);
1218 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1220 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1221 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1222 oi_unit->information.externallyDefinedInfo =
1223 yaz_set_proposal_charneg_list(c->odr_out, " ",
1224 c->charset, c->lang, 1);
1228 return send_APDU (c, apdu);
1232 static zoom_ret send_srw (ZOOM_connection c, Z_SRW_PDU *sr)
1234 Z_SOAP_Handler h[2] = {
1235 {"http://www.loc.gov/zing/srw/", 0, (Z_SOAP_fun) yaz_srw_codec},
1238 ODR o = odr_createmem(ODR_ENCODE);
1240 Z_SOAP *p = (Z_SOAP*) odr_malloc(o, sizeof(*p));
1244 gdu = z_get_HTTP_Request(c->odr_out);
1245 gdu->u.HTTP_Request->path = c->path;
1249 const char *cp0 = strstr(c->host_port, "://");
1250 const char *cp1 = 0;
1256 cp1 = strchr(cp0, '/');
1258 cp1 = cp0+strlen(cp0);
1262 char *h = (char*) odr_malloc(c->odr_out, cp1 - cp0 + 1);
1263 memcpy (h, cp0, cp1 - cp0);
1265 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1270 if (c->sru_mode == zoom_sru_get)
1272 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1274 else if (c->sru_mode == zoom_sru_post)
1276 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1278 else if (c->sru_mode == zoom_sru_soap)
1280 z_HTTP_header_add_content_type(c->odr_out,
1281 &gdu->u.HTTP_Request->headers,
1282 "text/xml", c->charset);
1284 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1285 "SOAPAction", "\"\"");
1286 p->which = Z_SOAP_generic;
1287 p->u.generic = (Z_SOAP_Generic *) odr_malloc(o, sizeof(*p->u.generic));
1288 p->u.generic->no = 0;
1289 p->u.generic->ns = 0;
1290 p->u.generic->p = sr;
1291 p->ns = "http://schemas.xmlsoap.org/soap/envelope/";
1293 ret = z_soap_codec_enc(o, &p,
1294 &gdu->u.HTTP_Request->content_buf,
1295 &gdu->u.HTTP_Request->content_len, h,
1299 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1300 return zoom_complete;
1301 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1304 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1305 ZOOM_connection_put_event (c, event);
1306 odr_reset(c->odr_out);
1307 return do_write (c);
1312 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1315 ZOOM_resultset resultset = 0;
1317 const char *recordPacking = 0;
1319 if (c->error) /* don't continue on error */
1320 return zoom_complete;
1322 if (c->tasks->which == ZOOM_TASK_SEARCH)
1324 resultset = c->tasks->u.search.resultset;
1325 resultset->setname = xstrdup ("default");
1326 ZOOM_options_set (resultset->options, "setname", resultset->setname);
1328 else if(c->tasks->which == ZOOM_TASK_RETRIEVE)
1330 resultset = c->tasks->u.retrieve.resultset;
1332 resultset->start = c->tasks->u.retrieve.start;
1333 resultset->count = c->tasks->u.retrieve.count;
1335 if (resultset->start >= resultset->size)
1336 return zoom_complete;
1337 if (resultset->start + resultset->count > resultset->size)
1338 resultset->count = resultset->size - resultset->start;
1340 for (i = 0; i<resultset->count; i++)
1343 record_cache_lookup (resultset, i + resultset->start);
1347 if (i == resultset->count)
1348 return zoom_complete;
1350 assert(resultset->query);
1352 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1354 if (resultset->query->z_query->which == Z_Query_type_104
1355 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1358 sr->u.request->query_type = Z_SRW_query_type_cql;
1359 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1361 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1362 resultset->query->z_query->u.type_1)
1364 sr->u.request->query_type = Z_SRW_query_type_pqf;
1365 sr->u.request->query.pqf = resultset->query->query_string;
1369 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1370 return zoom_complete;
1372 sr->u.request->startRecord = odr_intdup (c->odr_out, resultset->start + 1);
1373 sr->u.request->maximumRecords = odr_intdup (
1374 c->odr_out, resultset->step>0 ? resultset->step : resultset->count);
1375 sr->u.request->recordSchema = resultset->schema;
1377 recordPacking = ZOOM_resultset_option_get (resultset, "recordPacking");
1380 sr->u.request->recordPacking = odr_strdup(c->odr_out, recordPacking);
1382 return send_srw(c, sr);
1385 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1387 return zoom_complete;
1391 static zoom_ret ZOOM_connection_send_search (ZOOM_connection c)
1394 int lslb, ssub, mspn;
1396 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1397 Z_SearchRequest *search_req = apdu->u.searchRequest;
1398 const char *elementSetName;
1399 const char *smallSetElementSetName;
1400 const char *mediumSetElementSetName;
1403 assert (c->tasks->which == ZOOM_TASK_SEARCH);
1405 r = c->tasks->u.search.resultset;
1407 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1410 ZOOM_options_get (r->options, "elementSetName");
1411 smallSetElementSetName =
1412 ZOOM_options_get (r->options, "smallSetElementSetName");
1413 mediumSetElementSetName =
1414 ZOOM_options_get (r->options, "mediumSetElementSetName");
1416 if (!smallSetElementSetName)
1417 smallSetElementSetName = elementSetName;
1419 if (!mediumSetElementSetName)
1420 mediumSetElementSetName = elementSetName;
1425 /* prepare query for the search request */
1426 search_req->query = r->query->z_query;
1427 if (!search_req->query)
1429 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1430 return zoom_complete;
1433 search_req->databaseNames =
1434 set_DatabaseNames (c, r->options, &search_req->num_databaseNames);
1436 /* get syntax (no need to provide unless piggyback is in effect) */
1437 syntax = ZOOM_options_get (r->options, "preferredRecordSyntax");
1439 lslb = ZOOM_options_get_int (r->options, "largeSetLowerBound", -1);
1440 ssub = ZOOM_options_get_int (r->options, "smallSetUpperBound", -1);
1441 mspn = ZOOM_options_get_int (r->options, "mediumSetPresentNumber", -1);
1442 if (lslb != -1 && ssub != -1 && mspn != -1)
1444 /* So're a Z39.50 expert? Let's hope you don't do sort */
1445 *search_req->largeSetLowerBound = lslb;
1446 *search_req->smallSetUpperBound = ssub;
1447 *search_req->mediumSetPresentNumber = mspn;
1449 else if (r->start == 0 && r->count > 0
1450 && r->piggyback && !r->r_sort_spec && !r->schema)
1452 /* Regular piggyback - do it unless we're going to do sort */
1453 *search_req->largeSetLowerBound = 2000000000;
1454 *search_req->smallSetUpperBound = 1;
1455 *search_req->mediumSetPresentNumber = r->step>0 ? r->step : r->count;
1459 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1460 smallSetElementSetName = 0;
1461 mediumSetElementSetName = 0;
1464 if (smallSetElementSetName && *smallSetElementSetName)
1466 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1467 odr_malloc (c->odr_out, sizeof(*esn));
1469 esn->which = Z_ElementSetNames_generic;
1470 esn->u.generic = odr_strdup (c->odr_out, smallSetElementSetName);
1471 search_req->smallSetElementSetNames = esn;
1473 if (mediumSetElementSetName && *mediumSetElementSetName)
1475 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1476 odr_malloc (c->odr_out, sizeof(*esn));
1478 esn->which = Z_ElementSetNames_generic;
1479 esn->u.generic = odr_strdup (c->odr_out, mediumSetElementSetName);
1480 search_req->mediumSetElementSetNames = esn;
1483 search_req->preferredRecordSyntax =
1484 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1488 if (c->support_named_resultsets)
1492 /* find the lowest unused ordinal so that we re-use
1493 result sets on the server. */
1494 for (ord = 1; ; ord++)
1497 sprintf (setname, "%d", ord);
1498 for (rp = c->resultsets; rp; rp = rp->next)
1499 if (rp->setname && !strcmp (rp->setname, setname))
1504 r->setname = xstrdup (setname);
1505 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1506 "set %s", c, r->setname);
1510 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1512 r->setname = xstrdup ("default");
1514 ZOOM_options_set (r->options, "setname", r->setname);
1516 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1517 return send_APDU (c, apdu);
1520 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1527 case Z_DefaultDiagFormat_v2Addinfo:
1528 addinfo = r->u.v2Addinfo;
1530 case Z_DefaultDiagFormat_v3Addinfo:
1531 addinfo = r->u.v3Addinfo;
1536 set_dset_error(c, *r->condition,
1537 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1541 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1543 if (p->which != Z_DiagRec_defaultFormat)
1544 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1546 response_default_diag(c, p->u.defaultFormat);
1549 ZOOM_API(ZOOM_record)
1550 ZOOM_record_clone (ZOOM_record srec)
1557 odr_enc = odr_createmem(ODR_ENCODE);
1558 if (!z_NamePlusRecord (odr_enc, &srec->npr, 0, 0))
1560 buf = odr_getbuf (odr_enc, &size, 0);
1562 nrec = (ZOOM_record) xmalloc (sizeof(*nrec));
1563 nrec->odr = odr_createmem(ODR_DECODE);
1564 nrec->wrbuf_marc = 0;
1565 nrec->wrbuf_iconv = 0;
1566 nrec->wrbuf_opac = 0;
1567 odr_setbuf (nrec->odr, buf, size, 0);
1568 z_NamePlusRecord (nrec->odr, &nrec->npr, 0, 0);
1570 odr_destroy (odr_enc);
1574 ZOOM_API(ZOOM_record)
1575 ZOOM_resultset_record_immediate (ZOOM_resultset s,size_t pos)
1577 return record_cache_lookup (s, pos);
1580 ZOOM_API(ZOOM_record)
1581 ZOOM_resultset_record (ZOOM_resultset r, size_t pos)
1583 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1587 ZOOM_resultset_retrieve (r, 1, pos, 1);
1588 rec = ZOOM_resultset_record_immediate (r, pos);
1594 ZOOM_record_destroy (ZOOM_record rec)
1598 if (rec->wrbuf_marc)
1599 wrbuf_free (rec->wrbuf_marc, 1);
1600 if (rec->wrbuf_iconv)
1601 wrbuf_free (rec->wrbuf_iconv, 1);
1602 if (rec->wrbuf_opac)
1603 wrbuf_free (rec->wrbuf_opac, 1);
1604 odr_destroy (rec->odr);
1608 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1610 const char *buf, int sz,
1611 const char *record_charset)
1616 yaz_marc_t mt = yaz_marc_create();
1619 strcpy(to, "UTF-8");
1620 if (record_charset && *record_charset)
1622 /* Use "from,to" or just "from" */
1623 const char *cp = strchr(record_charset, ',');
1624 int clen = strlen(record_charset);
1627 strncpy( to, cp+1, sizeof(to)-1);
1628 to[sizeof(to)-1] = '\0';
1629 clen = cp - record_charset;
1631 if (clen > sizeof(from)-1)
1632 clen = sizeof(from)-1;
1635 strncpy(from, record_charset, clen);
1641 cd = yaz_iconv_open(to, from);
1642 yaz_marc_iconv(mt, cd);
1645 yaz_marc_xml(mt, marc_type);
1646 if (!rec->wrbuf_marc)
1647 rec->wrbuf_marc = wrbuf_alloc();
1648 wrbuf_rewind (rec->wrbuf_marc);
1649 if (yaz_marc_decode_wrbuf (mt, buf, sz, rec->wrbuf_marc) > 0)
1651 yaz_marc_destroy(mt);
1653 yaz_iconv_close(cd);
1655 *len = wrbuf_len(rec->wrbuf_marc);
1656 return wrbuf_buf(rec->wrbuf_marc);
1658 yaz_marc_destroy(mt);
1660 yaz_iconv_close(cd);
1664 static const char *record_iconv_return(ZOOM_record rec, int *len,
1665 const char *buf, int sz,
1666 const char *record_charset)
1673 strcpy(to, "UTF-8");
1674 if (record_charset && *record_charset)
1676 /* Use "from,to" or just "from" */
1677 const char *cp = strchr(record_charset, ',');
1678 int clen = strlen(record_charset);
1681 strncpy( to, cp+1, sizeof(to)-1);
1682 to[sizeof(to)-1] = '\0';
1683 clen = cp - record_charset;
1685 if (clen > sizeof(from)-1)
1686 clen = sizeof(from)-1;
1689 strncpy(from, record_charset, clen);
1693 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1696 size_t inbytesleft = sz;
1697 const char *inp = buf;
1699 if (!rec->wrbuf_iconv)
1700 rec->wrbuf_iconv = wrbuf_alloc();
1702 wrbuf_rewind(rec->wrbuf_iconv);
1706 size_t outbytesleft = sizeof(outbuf);
1707 char *outp = outbuf;
1708 size_t r = yaz_iconv (cd, (char**) &inp,
1710 &outp, &outbytesleft);
1711 if (r == (size_t) (-1))
1713 int e = yaz_iconv_error(cd);
1714 if (e != YAZ_ICONV_E2BIG)
1717 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1719 wrbuf_puts(rec->wrbuf_iconv, "");
1720 buf = wrbuf_buf(rec->wrbuf_iconv);
1721 sz = wrbuf_len(rec->wrbuf_iconv);
1722 yaz_iconv_close(cd);
1729 ZOOM_API(const char *)
1730 ZOOM_record_get (ZOOM_record rec, const char *type_spec, int *len)
1737 Z_NamePlusRecord *npr;
1740 *len = 0; /* default return */
1749 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1751 if (cp[i] == ';' || cp[i] == ' ')
1757 while (type_spec[i] == ';')
1760 while (type_spec[i] == ' ')
1762 if (!strncmp(type_spec+i, "charset=", 8))
1765 i = i + 8; /* skip charset= */
1766 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1768 if (type_spec[i] == ';' || type_spec[i] == ' ')
1774 else if (!strncmp(type_spec+i, "xpath=", 6))
1778 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1782 while (type_spec[i] == ' ')
1785 if (!strcmp (type, "database"))
1788 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1789 return npr->databaseName;
1791 else if (!strcmp (type, "syntax"))
1793 const char *desc = 0;
1794 if (npr->which == Z_NamePlusRecord_databaseRecord)
1796 Z_External *r = (Z_External *) npr->u.databaseRecord;
1797 oident *ent = oid_getentbyoid(r->direct_reference);
1804 *len = strlen(desc);
1807 if (npr->which != Z_NamePlusRecord_databaseRecord)
1810 /* from now on - we have a database record .. */
1811 if (!strcmp (type, "render"))
1813 Z_External *r = (Z_External *) npr->u.databaseRecord;
1814 oident *ent = oid_getentbyoid(r->direct_reference);
1816 /* render bibliographic record .. */
1817 if (r->which == Z_External_OPAC)
1819 r = r->u.opac->bibliographicRecord;
1822 ent = oid_getentbyoid(r->direct_reference);
1824 if (r->which == Z_External_sutrs)
1825 return record_iconv_return(rec, len,
1826 (char*) r->u.sutrs->buf,
1829 else if (r->which == Z_External_octet)
1831 const char *ret_buf;
1839 case VAL_APPLICATION_XML:
1842 ret_buf = marc_iconv_return(
1843 rec, YAZ_MARC_LINE, len,
1844 (const char *) r->u.octet_aligned->buf,
1845 r->u.octet_aligned->len,
1850 return record_iconv_return(rec, len,
1851 (const char *) r->u.octet_aligned->buf,
1852 r->u.octet_aligned->len,
1855 else if (r->which == Z_External_grs1)
1857 if (!rec->wrbuf_marc)
1858 rec->wrbuf_marc = wrbuf_alloc();
1859 wrbuf_rewind (rec->wrbuf_marc);
1860 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1861 return record_iconv_return(rec, len,
1862 wrbuf_buf(rec->wrbuf_marc),
1863 wrbuf_len(rec->wrbuf_marc),
1868 else if (!strcmp (type, "xml") || !strcmp(type, "oai"))
1870 Z_External *r = (Z_External *) npr->u.databaseRecord;
1871 oident *ent = oid_getentbyoid(r->direct_reference);
1873 /* render bibliographic record .. */
1874 if (r->which == Z_External_OPAC)
1876 r = r->u.opac->bibliographicRecord;
1879 ent = oid_getentbyoid(r->direct_reference);
1882 if (r->which == Z_External_sutrs)
1883 return record_iconv_return(rec, len,
1884 (const char *) r->u.sutrs->buf,
1887 else if (r->which == Z_External_octet)
1889 const char *ret_buf;
1890 int marc_decode_type = YAZ_MARC_MARCXML;
1892 if (!strcmp(type, "oai"))
1893 marc_decode_type = YAZ_MARC_OAIMARC;
1901 case VAL_APPLICATION_XML:
1904 ret_buf = marc_iconv_return(
1905 rec, marc_decode_type, len,
1906 (const char *) r->u.octet_aligned->buf,
1907 r->u.octet_aligned->len,
1912 return record_iconv_return(rec, len,
1913 (const char *) r->u.octet_aligned->buf,
1914 r->u.octet_aligned->len,
1917 else if (r->which == Z_External_grs1)
1924 else if (!strcmp (type, "raw"))
1926 Z_External *r = (Z_External *) npr->u.databaseRecord;
1928 if (r->which == Z_External_sutrs)
1930 if (len) *len = r->u.sutrs->len;
1931 return (const char *) r->u.sutrs->buf;
1933 else if (r->which == Z_External_octet)
1935 if (len) *len = r->u.octet_aligned->len;
1936 return (const char *) r->u.octet_aligned->buf;
1938 else /* grs-1, explain, OPAC, ... */
1941 return (const char *) npr->u.databaseRecord;
1945 else if (!strcmp (type, "ext"))
1948 return (const char *) npr->u.databaseRecord;
1950 else if (!strcmp (type, "opac"))
1953 Z_External *r = (Z_External *) npr->u.databaseRecord;
1954 if (r->which == Z_External_OPAC)
1956 if (!rec->wrbuf_opac)
1957 rec->wrbuf_opac = wrbuf_alloc();
1958 wrbuf_rewind (rec->wrbuf_opac);
1959 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
1960 return record_iconv_return(rec, len,
1961 wrbuf_buf(rec->wrbuf_opac),
1962 wrbuf_len(rec->wrbuf_opac),
1969 static int strcmp_null(const char *v1, const char *v2)
1975 return strcmp(v1, v2);
1978 static void record_cache_add (ZOOM_resultset r, Z_NamePlusRecord *npr,
1981 ZOOM_record_cache rc;
1982 const char *elementSetName =
1983 ZOOM_resultset_option_get (r, "elementSetName");
1984 const char *syntax =
1985 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
1987 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1988 ZOOM_connection_put_event(r->connection, event);
1990 for (rc = r->record_cache; rc; rc = rc->next)
1994 if (strcmp_null(r->schema, rc->schema))
1996 if (strcmp_null(elementSetName,rc->elementSetName))
1998 if (strcmp_null(syntax, rc->syntax))
2000 /* not destroying rc->npr (it's handled by nmem )*/
2002 /* keeping wrbuf_marc too */
2006 rc = (ZOOM_record_cache) odr_malloc (r->odr, sizeof(*rc));
2009 rc->rec.wrbuf_marc = 0;
2010 rc->rec.wrbuf_iconv = 0;
2011 rc->rec.wrbuf_opac = 0;
2013 rc->elementSetName = odr_strdup (r->odr, elementSetName);
2015 rc->elementSetName = 0;
2018 rc->syntax = odr_strdup (r->odr, syntax);
2023 rc->schema = odr_strdup (r->odr, r->schema);
2028 rc->next = r->record_cache;
2029 r->record_cache = rc;
2032 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos)
2034 ZOOM_record_cache rc;
2035 const char *elementSetName =
2036 ZOOM_resultset_option_get (r, "elementSetName");
2037 const char *syntax =
2038 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
2040 for (rc = r->record_cache; rc; rc = rc->next)
2044 if (strcmp_null(r->schema, rc->schema))
2046 if (strcmp_null(elementSetName,rc->elementSetName))
2048 if (strcmp_null(syntax, rc->syntax))
2056 static void handle_records (ZOOM_connection c, Z_Records *sr,
2059 ZOOM_resultset resultset;
2063 switch (c->tasks->which)
2065 case ZOOM_TASK_SEARCH:
2066 resultset = c->tasks->u.search.resultset;
2068 case ZOOM_TASK_RETRIEVE:
2069 resultset = c->tasks->u.retrieve.resultset;
2074 if (sr && sr->which == Z_Records_NSD)
2075 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2076 else if (sr && sr->which == Z_Records_multipleNSD)
2078 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2079 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2081 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2085 if (resultset->count + resultset->start > resultset->size)
2086 resultset->count = resultset->size - resultset->start;
2087 if (resultset->count < 0)
2088 resultset->count = 0;
2089 if (sr && sr->which == Z_Records_DBOSD)
2092 NMEM nmem = odr_extract_mem (c->odr_in);
2093 Z_NamePlusRecordList *p =
2094 sr->u.databaseOrSurDiagnostics;
2095 for (i = 0; i<p->num_records; i++)
2097 record_cache_add (resultset, p->records[i],
2098 i+ resultset->start);
2100 /* transfer our response to search_nmem .. we need it later */
2101 nmem_transfer (resultset->odr->mem, nmem);
2102 nmem_destroy (nmem);
2103 if (present_phase && p->num_records == 0)
2105 /* present response and we didn't get any records! */
2106 Z_NamePlusRecord *myrec =
2107 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2108 record_cache_add(resultset, myrec, resultset->start);
2111 else if (present_phase)
2113 /* present response and we didn't get any records! */
2114 Z_NamePlusRecord *myrec =
2115 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2116 record_cache_add(resultset, myrec, resultset->start);
2121 static void handle_present_response (ZOOM_connection c, Z_PresentResponse *pr)
2123 handle_records (c, pr->records, 1);
2126 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2129 switch (term->which)
2131 case Z_Term_general:
2132 ZOOM_options_setl(opt, name,
2133 (const char *)(term->u.general->buf),
2134 term->u.general->len);
2136 case Z_Term_characterString:
2137 ZOOM_options_set(opt, name, term->u.characterString);
2139 case Z_Term_numeric:
2140 ZOOM_options_set_int(opt, name, *term->u.numeric);
2145 static void handle_queryExpression(ZOOM_options opt, const char *name,
2146 Z_QueryExpression *exp)
2152 case Z_QueryExpression_term:
2153 if (exp->u.term && exp->u.term->queryTerm)
2155 sprintf(opt_name, "%s.term", name);
2156 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2159 case Z_QueryExpression_query:
2164 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2165 Z_OtherInformation *o)
2168 for (i = 0; o && i < o->num_elements; i++)
2170 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2172 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2174 if (ext->which == Z_External_searchResult1)
2177 Z_SearchInfoReport *sr = ext->u.searchResult1;
2180 ZOOM_options_set_int(
2181 resultset->options, "searchresult.size", sr->num);
2183 for (j = 0; j < sr->num; j++)
2185 Z_SearchInfoReport_s *ent =
2186 ext->u.searchResult1->elements[j];
2189 sprintf(pref, "searchresult.%d", j);
2191 if (ent->subqueryId)
2194 sprintf(opt_name, "%s.id", pref);
2195 ZOOM_options_set(resultset->options, opt_name,
2198 if (ent->subqueryExpression)
2201 sprintf(opt_name, "%s.subquery", pref);
2202 handle_queryExpression(resultset->options, opt_name,
2203 ent->subqueryExpression);
2205 if (ent->subqueryInterpretation)
2208 sprintf(opt_name, "%s.interpretation", pref);
2209 handle_queryExpression(resultset->options, opt_name,
2210 ent->subqueryInterpretation);
2212 if (ent->subqueryRecommendation)
2215 sprintf(opt_name, "%s.recommendation", pref);
2216 handle_queryExpression(resultset->options, opt_name,
2217 ent->subqueryRecommendation);
2219 if (ent->subqueryCount)
2222 sprintf(opt_name, "%s.count", pref);
2223 ZOOM_options_set_int(resultset->options, opt_name,
2224 *ent->subqueryCount);
2232 static void handle_search_response (ZOOM_connection c, Z_SearchResponse *sr)
2234 ZOOM_resultset resultset;
2237 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2240 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2241 ZOOM_connection_put_event(c, event);
2243 resultset = c->tasks->u.search.resultset;
2245 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2247 resultset->size = *sr->resultCount;
2248 handle_records (c, sr->records, 0);
2251 static void sort_response (ZOOM_connection c, Z_SortResponse *res)
2253 if (res->diagnostics && res->num_diagnostics > 0)
2254 response_diag (c, res->diagnostics[0]);
2257 static int scan_response (ZOOM_connection c, Z_ScanResponse *res)
2259 NMEM nmem = odr_extract_mem (c->odr_in);
2262 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2264 scan = c->tasks->u.scan.scan;
2266 if (res->entries && res->entries->nonsurrogateDiagnostics)
2267 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2268 scan->scan_response = res;
2269 nmem_transfer (scan->odr->mem, nmem);
2271 ZOOM_options_set_int (scan->options, "stepSize", *res->stepSize);
2272 if (res->positionOfTerm)
2273 ZOOM_options_set_int (scan->options, "position", *res->positionOfTerm);
2274 if (res->scanStatus)
2275 ZOOM_options_set_int (scan->options, "scanStatus", *res->scanStatus);
2276 if (res->numberOfEntriesReturned)
2277 ZOOM_options_set_int (scan->options, "number",
2278 *res->numberOfEntriesReturned);
2279 nmem_destroy (nmem);
2283 static zoom_ret send_sort (ZOOM_connection c,
2284 ZOOM_resultset resultset)
2287 resultset->r_sort_spec = 0;
2288 if (resultset->r_sort_spec)
2290 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2291 Z_SortRequest *req = apdu->u.sortRequest;
2293 req->num_inputResultSetNames = 1;
2294 req->inputResultSetNames = (Z_InternationalString **)
2295 odr_malloc (c->odr_out, sizeof(*req->inputResultSetNames));
2296 req->inputResultSetNames[0] =
2297 odr_strdup (c->odr_out, resultset->setname);
2298 req->sortedResultSetName = odr_strdup (c->odr_out, resultset->setname);
2299 req->sortSequence = resultset->r_sort_spec;
2300 resultset->r_sort_spec = 0;
2301 return send_APDU (c, apdu);
2303 return zoom_complete;
2306 static zoom_ret send_present(ZOOM_connection c)
2309 Z_PresentRequest *req = 0;
2311 const char *syntax = 0;
2312 const char *elementSetName = 0;
2313 ZOOM_resultset resultset;
2317 yaz_log(log_details, "%p send_present no tasks", c);
2318 return zoom_complete;
2320 switch (c->tasks->which)
2322 case ZOOM_TASK_SEARCH:
2323 resultset = c->tasks->u.search.resultset;
2325 case ZOOM_TASK_RETRIEVE:
2326 resultset = c->tasks->u.retrieve.resultset;
2327 resultset->start = c->tasks->u.retrieve.start;
2328 resultset->count = c->tasks->u.retrieve.count;
2330 if (resultset->start >= resultset->size)
2332 yaz_log(log_details, "%p send_present start=%d >= size=%d",
2333 c, resultset->start, resultset->size);
2334 return zoom_complete;
2336 if (resultset->start + resultset->count > resultset->size)
2337 resultset->count = resultset->size - resultset->start;
2340 return zoom_complete;
2342 yaz_log(log_details, "%p send_present start=%d count=%d",
2343 c, resultset->start, resultset->count);
2345 syntax = ZOOM_resultset_option_get (resultset, "preferredRecordSyntax");
2346 elementSetName = ZOOM_resultset_option_get (resultset, "elementSetName");
2348 if (c->error) /* don't continue on error */
2349 return zoom_complete;
2350 if (resultset->start < 0)
2351 return zoom_complete;
2352 for (i = 0; i<resultset->count; i++)
2355 record_cache_lookup (resultset, i + resultset->start);
2359 if (i == resultset->count)
2361 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2362 return zoom_complete;
2365 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2366 req = apdu->u.presentRequest;
2368 resultset->start += i;
2369 resultset->count -= i;
2372 yaz_log(log_details, "%p send_present skip=%d", c, i);
2374 *req->resultSetStartPoint = resultset->start + 1;
2375 *req->numberOfRecordsRequested = resultset->step>0 ?
2376 resultset->step : resultset->count;
2377 if (*req->numberOfRecordsRequested + resultset->start > resultset->size)
2378 *req->numberOfRecordsRequested = resultset->size - resultset->start;
2379 assert (*req->numberOfRecordsRequested > 0);
2381 if (syntax && *syntax)
2382 req->preferredRecordSyntax =
2383 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
2385 if (resultset->schema && *resultset->schema)
2387 Z_RecordComposition *compo = (Z_RecordComposition *)
2388 odr_malloc (c->odr_out, sizeof(*compo));
2390 req->recordComposition = compo;
2391 compo->which = Z_RecordComp_complex;
2392 compo->u.complex = (Z_CompSpec *)
2393 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2394 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2395 odr_malloc(c->odr_out, sizeof(bool_t));
2396 *compo->u.complex->selectAlternativeSyntax = 0;
2398 compo->u.complex->generic = (Z_Specification *)
2399 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2401 compo->u.complex->generic->which = Z_Schema_oid;
2402 compo->u.complex->generic->schema.oid = (Odr_oid *)
2403 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2405 if (!compo->u.complex->generic->schema.oid)
2407 /* OID wasn't a schema! Try record syntax instead. */
2409 compo->u.complex->generic->schema.oid = (Odr_oid *)
2410 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2412 if (elementSetName && *elementSetName)
2414 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2415 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2416 compo->u.complex->generic->elementSpec->which =
2417 Z_ElementSpec_elementSetName;
2418 compo->u.complex->generic->elementSpec->u.elementSetName =
2419 odr_strdup (c->odr_out, elementSetName);
2422 compo->u.complex->generic->elementSpec = 0;
2423 compo->u.complex->num_dbSpecific = 0;
2424 compo->u.complex->dbSpecific = 0;
2425 compo->u.complex->num_recordSyntax = 0;
2426 compo->u.complex->recordSyntax = 0;
2428 else if (elementSetName && *elementSetName)
2430 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2431 odr_malloc (c->odr_out, sizeof(*esn));
2432 Z_RecordComposition *compo = (Z_RecordComposition *)
2433 odr_malloc (c->odr_out, sizeof(*compo));
2435 esn->which = Z_ElementSetNames_generic;
2436 esn->u.generic = odr_strdup (c->odr_out, elementSetName);
2437 compo->which = Z_RecordComp_simple;
2438 compo->u.simple = esn;
2439 req->recordComposition = compo;
2441 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2442 return send_APDU (c, apdu);
2445 ZOOM_API(ZOOM_scanset)
2446 ZOOM_connection_scan (ZOOM_connection c, const char *start)
2449 ZOOM_query q = ZOOM_query_create();
2451 ZOOM_query_prefix (q, start);
2453 s = ZOOM_connection_scan1(c, q);
2454 ZOOM_query_destroy (q);
2459 ZOOM_API(ZOOM_scanset)
2460 ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query q)
2462 ZOOM_scanset scan = (ZOOM_scanset) xmalloc (sizeof(*scan));
2466 scan->connection = c;
2467 scan->odr = odr_createmem (ODR_DECODE);
2468 scan->options = ZOOM_options_create_with_parent (c->options);
2470 scan->scan_response = 0;
2473 * We need to check the query-type, so we can recognise CQL and
2474 * compile it into a form that we can use here. The ZOOM_query
2475 * structure has no explicit `type' member, but inspection of the
2476 * ZOOM_query_prefix() and ZOOM_query_cql() functions shows how
2477 * the structure is set up in each case.
2480 if (q->z_query->which == Z_Query_type_1) {
2481 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2482 c, q, q->query_string);
2483 start = q->query_string;
2484 } else if (q->z_query->which == Z_Query_type_104) {
2485 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2486 c, q, q->query_string);
2487 start = freeme = cql2pqf(c, q->query_string);
2491 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2492 c, q, q->query_string);
2496 scan->termListAndStartPoint =
2497 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2499 if (scan->termListAndStartPoint != 0)
2501 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_SCAN);
2502 task->u.scan.scan = scan;
2507 while (ZOOM_event (1, &c))
2515 ZOOM_scanset_destroy (ZOOM_scanset scan)
2520 if (scan->refcount == 0)
2522 odr_destroy (scan->odr);
2524 ZOOM_options_destroy (scan->options);
2529 static zoom_ret send_package (ZOOM_connection c)
2533 yaz_log(log_details, "%p send_package", c);
2535 return zoom_complete;
2536 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2538 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
2539 ZOOM_connection_put_event (c, event);
2541 return do_write_ex (c, c->tasks->u.package->buf_out,
2542 c->tasks->u.package->len_out);
2545 static zoom_ret send_scan (ZOOM_connection c)
2548 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2549 Z_ScanRequest *req = apdu->u.scanRequest;
2551 yaz_log(log_details, "%p send_scan", c);
2553 return zoom_complete;
2554 assert (c->tasks->which == ZOOM_TASK_SCAN);
2555 scan = c->tasks->u.scan.scan;
2557 req->termListAndStartPoint = scan->termListAndStartPoint;
2558 req->attributeSet = scan->attributeSet;
2560 *req->numberOfTermsRequested =
2561 ZOOM_options_get_int(scan->options, "number", 10);
2563 req->preferredPositionInResponse =
2564 odr_intdup (c->odr_out,
2565 ZOOM_options_get_int(scan->options, "position", 1));
2568 odr_intdup (c->odr_out,
2569 ZOOM_options_get_int(scan->options, "stepSize", 0));
2571 req->databaseNames = set_DatabaseNames (c, scan->options,
2572 &req->num_databaseNames);
2574 return send_APDU (c, apdu);
2578 ZOOM_scanset_size (ZOOM_scanset scan)
2580 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2582 return scan->scan_response->entries->num_entries;
2585 ZOOM_API(const char *)
2586 ZOOM_scanset_term (ZOOM_scanset scan, size_t pos,
2589 const char *term = 0;
2590 size_t noent = ZOOM_scanset_size (scan);
2591 Z_ScanResponse *res = scan->scan_response;
2597 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2599 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2601 if (t->term->which == Z_Term_general)
2603 term = (const char *) t->term->u.general->buf;
2604 *len = t->term->u.general->len;
2606 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2611 ZOOM_API(const char *)
2612 ZOOM_scanset_display_term (ZOOM_scanset scan, size_t pos,
2615 const char *term = 0;
2616 size_t noent = ZOOM_scanset_size (scan);
2617 Z_ScanResponse *res = scan->scan_response;
2623 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2625 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2629 term = t->displayTerm;
2630 *len = strlen(term);
2632 else if (t->term->which == Z_Term_general)
2634 term = (const char *) t->term->u.general->buf;
2635 *len = t->term->u.general->len;
2637 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2642 ZOOM_API(const char *)
2643 ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key)
2645 return ZOOM_options_get (scan->options, key);
2649 ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
2652 ZOOM_options_set (scan->options, key, val);
2655 static Z_APDU *create_es_package (ZOOM_package p, int type)
2658 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2659 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2661 *req->function = Z_ExtendedServicesRequest_create;
2663 str = ZOOM_options_get(p->options, "package-name");
2665 req->packageName = nmem_strdup (p->odr_out->mem, str);
2667 str = ZOOM_options_get(p->options, "user-id");
2669 req->userId = nmem_strdup (p->odr_out->mem, str);
2671 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2674 str = ZOOM_options_get(p->options, "function");
2677 if (!strcmp (str, "create"))
2679 if (!strcmp (str, "delete"))
2681 if (!strcmp (str, "modify"))
2687 static const char *ill_array_lookup (void *clientData, const char *idx)
2689 ZOOM_package p = (ZOOM_package) clientData;
2690 return ZOOM_options_get (p->options, idx+4);
2693 static Z_External *encode_ill_request (ZOOM_package p)
2695 ODR out = p->odr_out;
2698 struct ill_get_ctl ctl;
2700 ctl.odr = p->odr_out;
2702 ctl.f = ill_array_lookup;
2704 req = ill_get_ILLRequest(&ctl, "ill", 0);
2706 if (!ill_Request (out, &req, 0, 0))
2708 int ill_request_size;
2709 char *ill_request_buf = odr_getbuf (out, &ill_request_size, 0);
2710 if (ill_request_buf)
2711 odr_setbuf (out, ill_request_buf, ill_request_size, 1);
2717 int illRequest_size = 0;
2718 char *illRequest_buf = odr_getbuf (out, &illRequest_size, 0);
2720 oid.proto = PROTO_GENERAL;
2721 oid.oclass = CLASS_GENERAL;
2722 oid.value = VAL_ISO_ILL_1;
2724 r = (Z_External *) odr_malloc (out, sizeof(*r));
2725 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2726 r->indirect_reference = 0;
2728 r->which = Z_External_single;
2730 r->u.single_ASN1_type =
2731 odr_create_Odr_oct(out,
2732 (unsigned char *)illRequest_buf,
2738 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2740 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc (p->odr_out, sizeof(*req));
2743 req->which = Z_IOItemOrder_esRequest;
2744 req->u.esRequest = (Z_IORequest *)
2745 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2747 /* to keep part ... */
2748 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2749 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2750 req->u.esRequest->toKeep->supplDescription = 0;
2751 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2752 odr_malloc (p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2754 str = ZOOM_options_get(p->options, "contact-name");
2755 req->u.esRequest->toKeep->contact->name = str ?
2756 nmem_strdup (p->odr_out->mem, str) : 0;
2758 str = ZOOM_options_get(p->options, "contact-phone");
2759 req->u.esRequest->toKeep->contact->phone = str ?
2760 nmem_strdup (p->odr_out->mem, str) : 0;
2762 str = ZOOM_options_get(p->options, "contact-email");
2763 req->u.esRequest->toKeep->contact->email = str ?
2764 nmem_strdup (p->odr_out->mem, str) : 0;
2766 req->u.esRequest->toKeep->addlBilling = 0;
2768 /* not to keep part ... */
2769 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2770 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2772 str = ZOOM_options_get(p->options, "itemorder-setname");
2777 req->u.esRequest->notToKeep->resultSetItem = 0;
2780 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2781 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2783 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2784 nmem_strdup (p->odr_out->mem, str);
2785 req->u.esRequest->notToKeep->resultSetItem->item =
2786 (int *) odr_malloc(p->odr_out, sizeof(int));
2788 str = ZOOM_options_get(p->options, "itemorder-item");
2789 *req->u.esRequest->notToKeep->resultSetItem->item =
2790 (str ? atoi(str) : 1);
2792 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2797 Z_APDU *create_admin_package(ZOOM_package p, int type,
2798 Z_ESAdminOriginPartToKeep **toKeepP,
2799 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2801 Z_APDU *apdu = create_es_package (p, VAL_ADMINSERVICE);
2804 Z_ESAdminOriginPartToKeep *toKeep;
2805 Z_ESAdminOriginPartNotToKeep *notToKeep;
2806 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2807 const char *first_db = "Default";
2809 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2813 r->direct_reference =
2814 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2817 r->indirect_reference = 0;
2818 r->which = Z_External_ESAdmin;
2820 r->u.adminService = (Z_Admin *)
2821 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2822 r->u.adminService->which = Z_Admin_esRequest;
2823 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2824 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2826 toKeep = r->u.adminService->u.esRequest->toKeep =
2827 (Z_ESAdminOriginPartToKeep *)
2828 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2829 toKeep->which = type;
2830 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2831 toKeep->u.create = odr_nullval();
2832 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2834 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2835 (Z_ESAdminOriginPartNotToKeep *)
2836 odr_malloc(p->odr_out,
2837 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2838 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
2839 notToKeep->u.recordsWillFollow = odr_nullval();
2843 *notToKeepP = notToKeep;
2848 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
2850 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
2851 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2852 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
2853 const char *doc = ZOOM_options_get(p->options, "doc");
2858 req->taskSpecificParameters = ext;
2859 ext->direct_reference = req->packageType;
2860 ext->descriptor = 0;
2861 ext->indirect_reference = 0;
2863 ext->which = Z_External_octet;
2864 ext->u.single_ASN1_type =
2865 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
2870 static Z_APDU *create_update_package(ZOOM_package p)
2873 const char *first_db = "Default";
2875 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2876 const char *action = ZOOM_options_get(p->options, "action");
2877 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
2878 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
2879 const char *record_buf = ZOOM_options_get(p->options, "record");
2880 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
2881 int syntax_oid = VAL_NONE;
2885 syntax_oid = oid_getvalbyname(syntax_str);
2888 record_buf = "void";
2889 syntax_oid = VAL_SUTRS;
2891 if (syntax_oid == VAL_NONE)
2892 syntax_oid = VAL_TEXT_XML;
2898 action = "specialUpdate";
2900 if (!strcmp(action, "recordInsert"))
2901 action_no = Z_IUOriginPartToKeep_recordInsert;
2902 else if (!strcmp(action, "recordReplace"))
2903 action_no = Z_IUOriginPartToKeep_recordReplace;
2904 else if (!strcmp(action, "recordDelete"))
2905 action_no = Z_IUOriginPartToKeep_recordDelete;
2906 else if (!strcmp(action, "elementUpdate"))
2907 action_no = Z_IUOriginPartToKeep_elementUpdate;
2908 else if (!strcmp(action, "specialUpdate"))
2909 action_no = Z_IUOriginPartToKeep_specialUpdate;
2913 apdu = create_es_package (p, VAL_DBUPDATE);
2916 Z_IUOriginPartToKeep *toKeep;
2917 Z_IUSuppliedRecords *notToKeep;
2918 Z_External *r = (Z_External *)
2919 odr_malloc (p->odr_out, sizeof(*r));
2921 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2923 r->direct_reference =
2924 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2927 r->which = Z_External_update;
2928 r->indirect_reference = 0;
2929 r->u.update = (Z_IUUpdate *)
2930 odr_malloc(p->odr_out, sizeof(*r->u.update));
2932 r->u.update->which = Z_IUUpdate_esRequest;
2933 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
2934 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
2935 toKeep = r->u.update->u.esRequest->toKeep =
2936 (Z_IUOriginPartToKeep *)
2937 odr_malloc(p->odr_out, sizeof(*toKeep));
2939 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2941 toKeep->elementSetName = 0;
2942 toKeep->actionQualifier = 0;
2943 toKeep->action = odr_intdup(p->odr_out, action_no);
2945 notToKeep = r->u.update->u.esRequest->notToKeep =
2946 (Z_IUSuppliedRecords *)
2947 odr_malloc(p->odr_out, sizeof(*notToKeep));
2949 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
2950 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
2951 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
2952 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
2953 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
2956 notToKeep->elements[0]->u.opaque =
2957 odr_create_Odr_oct(p->odr_out,
2958 (const unsigned char *) recordIdOpaque,
2959 strlen(recordIdOpaque));
2961 else if (recordIdNumber)
2963 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
2965 notToKeep->elements[0]->u.number =
2966 odr_intdup(p->odr_out, atoi(recordIdNumber));
2969 notToKeep->elements[0]->u.opaque = 0;
2970 notToKeep->elements[0]->supplementalId = 0;
2971 notToKeep->elements[0]->correlationInfo = 0;
2972 notToKeep->elements[0]->record =
2973 z_ext_record(p->odr_out, syntax_oid,
2974 record_buf, strlen(record_buf));
2978 ODR print = odr_createmem(ODR_PRINT);
2980 z_APDU(print, &apdu, 0, 0);
2987 ZOOM_package_send (ZOOM_package p, const char *type)
2994 odr_reset (p->odr_out);
2997 if (!strcmp(type, "itemorder"))
2999 apdu = create_es_package (p, VAL_ITEMORDER);
3002 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
3004 r->direct_reference =
3005 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3008 r->which = Z_External_itemOrder;
3009 r->indirect_reference = 0;
3010 r->u.itemOrder = encode_item_order (p);
3012 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3015 else if (!strcmp(type, "create")) /* create database */
3017 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3020 else if (!strcmp(type, "drop")) /* drop database */
3022 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3025 else if (!strcmp(type, "commit")) /* commit changes */
3027 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3030 else if (!strcmp(type, "update")) /* update record(s) */
3032 apdu = create_update_package(p);
3034 else if (!strcmp(type, "xmlupdate"))
3036 apdu = create_xmlupdate_package(p);
3040 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3044 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_PACKAGE);
3045 task->u.package = p;
3046 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3047 p->buf_out = (char *) xmalloc (p->len_out);
3048 memcpy (p->buf_out, buf, p->len_out);
3053 while (ZOOM_event (1, &c))
3060 ZOOM_API(ZOOM_package)
3061 ZOOM_connection_package (ZOOM_connection c, ZOOM_options options)
3063 ZOOM_package p = (ZOOM_package) xmalloc (sizeof(*p));
3066 p->odr_out = odr_createmem (ODR_ENCODE);
3067 p->options = ZOOM_options_create_with_parent2 (options, c->options);
3075 ZOOM_package_destroy(ZOOM_package p)
3080 if (p->refcount == 0)
3082 odr_destroy (p->odr_out);
3085 ZOOM_options_destroy (p->options);
3090 ZOOM_API(const char *)
3091 ZOOM_package_option_get (ZOOM_package p, const char *key)
3093 return ZOOM_options_get (p->options, key);
3098 ZOOM_package_option_set (ZOOM_package p, const char *key,
3101 ZOOM_options_set (p->options, key, val);
3104 static int ZOOM_connection_exec_task (ZOOM_connection c)
3106 ZOOM_task task = c->tasks;
3107 zoom_ret ret = zoom_complete;
3111 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3112 c, task->which, task->running);
3113 if (c->error != ZOOM_ERROR_NONE)
3115 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3116 "removing tasks because of error = %d", c, c->error);
3117 ZOOM_connection_remove_tasks (c);
3122 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3123 "task already running", c);
3127 ret = zoom_complete;
3128 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3130 switch (task->which)
3132 case ZOOM_TASK_SEARCH:
3133 if (c->proto == PROTO_HTTP)
3134 ret = ZOOM_connection_srw_send_search(c);
3136 ret = ZOOM_connection_send_search(c);
3138 case ZOOM_TASK_RETRIEVE:
3139 if (c->proto == PROTO_HTTP)
3140 ret = ZOOM_connection_srw_send_search(c);
3142 ret = send_present (c);
3144 case ZOOM_TASK_CONNECT:
3145 ret = do_connect(c);
3147 case ZOOM_TASK_SCAN:
3150 case ZOOM_TASK_PACKAGE:
3151 ret = send_package(c);
3153 case ZOOM_TASK_SORT:
3154 c->tasks->u.sort.resultset->r_sort_spec =
3155 c->tasks->u.sort.q->sort_spec;
3156 ret = send_sort(c, c->tasks->u.sort.resultset);
3162 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3163 "remove tasks because no connection exist", c);
3164 ZOOM_connection_remove_tasks (c);
3166 if (ret == zoom_complete)
3168 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3169 "task removed (complete)", c);
3170 ZOOM_connection_remove_task (c);
3173 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3178 static zoom_ret send_sort_present (ZOOM_connection c)
3180 zoom_ret r = zoom_complete;
3182 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3183 r = send_sort (c, c->tasks->u.search.resultset);
3184 if (r == zoom_complete)
3185 r = send_present (c);
3189 static int es_response (ZOOM_connection c,
3190 Z_ExtendedServicesResponse *res)
3192 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3194 if (res->diagnostics && res->num_diagnostics > 0)
3195 response_diag(c, res->diagnostics[0]);
3196 if (res->taskPackage &&
3197 res->taskPackage->which == Z_External_extendedService)
3199 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3200 Odr_oct *id = taskPackage->targetReference;
3203 ZOOM_options_setl (c->tasks->u.package->options,
3204 "targetReference", (char*) id->buf, id->len);
3206 if (res->taskPackage &&
3207 res->taskPackage->which == Z_External_octet)
3209 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3210 ZOOM_options_setl (c->tasks->u.package->options,
3211 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3216 static void interpret_init_diag(ZOOM_connection c,
3217 Z_DiagnosticFormat *diag)
3221 Z_DiagnosticFormat_s *ds = diag->elements[0];
3222 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3223 response_default_diag(c, ds->u.defaultDiagRec);
3228 static void interpret_otherinformation_field(ZOOM_connection c,
3229 Z_OtherInformation *ui)
3232 for (i = 0; i < ui->num_elements; i++)
3234 Z_OtherInformationUnit *unit = ui->list[i];
3235 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3236 unit->information.externallyDefinedInfo &&
3237 unit->information.externallyDefinedInfo->which ==
3240 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3245 static void recv_apdu (ZOOM_connection c, Z_APDU *apdu)
3247 Z_InitResponse *initrs;
3250 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3253 case Z_APDU_initResponse:
3254 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3255 initrs = apdu->u.initResponse;
3256 ZOOM_connection_option_set(c, "serverImplementationId",
3257 initrs->implementationId ?
3258 initrs->implementationId : "");
3259 ZOOM_connection_option_set(c, "serverImplementationName",
3260 initrs->implementationName ?
3261 initrs->implementationName : "");
3262 ZOOM_connection_option_set(c, "serverImplementationVersion",
3263 initrs->implementationVersion ?
3264 initrs->implementationVersion : "");
3265 /* Set the three old options too, for old applications */
3266 ZOOM_connection_option_set(c, "targetImplementationId",
3267 initrs->implementationId ?
3268 initrs->implementationId : "");
3269 ZOOM_connection_option_set(c, "targetImplementationName",
3270 initrs->implementationName ?
3271 initrs->implementationName : "");
3272 ZOOM_connection_option_set(c, "targetImplementationVersion",
3273 initrs->implementationVersion ?
3274 initrs->implementationVersion : "");
3275 if (!*initrs->result)
3277 Z_External *uif = initrs->userInformationField;
3279 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3281 if (uif && uif->which == Z_External_userInfo1)
3282 interpret_otherinformation_field(c, uif->u.userInfo1);
3287 yaz_oi_get_string_oidval (&apdu->u.initResponse->otherInfo,
3289 xfree (c->cookie_in);
3292 c->cookie_in = xstrdup(cookie);
3293 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3294 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3295 c->support_named_resultsets = 1;
3298 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3299 ZOOM_connection_remove_task (c);
3301 ZOOM_connection_exec_task (c);
3303 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3305 NMEM tmpmem = nmem_create();
3306 Z_CharSetandLanguageNegotiation *p =
3307 yaz_get_charneg_record(initrs->otherInfo);
3311 char *charset = NULL, *lang = NULL;
3314 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3315 yaz_log(log_details, "%p recv_apdu target accepted: "
3316 "charset %s, language %s, select %d",
3318 charset ? charset : "none", lang ? lang : "none", sel);
3320 ZOOM_connection_option_set (c, "negotiation-charset",
3323 ZOOM_connection_option_set (c, "negotiation-lang",
3326 ZOOM_connection_option_set (
3327 c, "negotiation-charset-in-effect-for-records",
3328 (sel != 0) ? "1" : "0");
3329 nmem_destroy(tmpmem);
3333 case Z_APDU_searchResponse:
3334 yaz_log(log_api, "%p recv_apdu Search response", c);
3335 handle_search_response (c, apdu->u.searchResponse);
3336 if (send_sort_present (c) == zoom_complete)
3337 ZOOM_connection_remove_task (c);
3339 case Z_APDU_presentResponse:
3340 yaz_log(log_api, "%p recv_apdu Present response", c);
3341 handle_present_response (c, apdu->u.presentResponse);
3342 if (send_present (c) == zoom_complete)
3343 ZOOM_connection_remove_task (c);
3345 case Z_APDU_sortResponse:
3346 yaz_log(log_api, "%p recv_apdu Sort response", c);
3347 sort_response (c, apdu->u.sortResponse);
3348 if (send_present (c) == zoom_complete)
3349 ZOOM_connection_remove_task (c);
3351 case Z_APDU_scanResponse:
3352 yaz_log(log_api, "%p recv_apdu Scan response", c);
3353 scan_response (c, apdu->u.scanResponse);
3354 ZOOM_connection_remove_task (c);
3356 case Z_APDU_extendedServicesResponse:
3357 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3358 es_response (c, apdu->u.extendedServicesResponse);
3359 ZOOM_connection_remove_task (c);
3362 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3363 if (c->reconnect_ok)
3366 c->tasks->running = 0;
3367 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3371 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3376 yaz_log(log_api, "%p Received unknown PDU", c);
3377 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3383 static void handle_srw_response(ZOOM_connection c,
3384 Z_SRW_searchRetrieveResponse *res)
3386 ZOOM_resultset resultset = 0;
3394 if (c->tasks->which == ZOOM_TASK_SEARCH)
3395 resultset = c->tasks->u.search.resultset;
3396 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
3397 resultset = c->tasks->u.retrieve.resultset;
3401 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3402 ZOOM_connection_put_event(c, event);
3404 resultset->size = 0;
3406 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3408 if (res->numberOfRecords)
3409 resultset->size = *res->numberOfRecords;
3411 for (i = 0; i<res->num_records; i++)
3415 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3416 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3418 if (res->records[i].recordPosition &&
3419 *res->records[i].recordPosition > 0)
3420 pos = *res->records[i].recordPosition - 1;
3422 pos = resultset->start + i;
3424 npr->databaseName = 0;
3425 npr->which = Z_NamePlusRecord_databaseRecord;
3426 npr->u.databaseRecord = (Z_External *)
3427 odr_malloc(c->odr_in, sizeof(Z_External));
3428 npr->u.databaseRecord->descriptor = 0;
3429 npr->u.databaseRecord->direct_reference =
3430 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3431 npr->u.databaseRecord->which = Z_External_octet;
3433 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3434 odr_malloc(c->odr_in, sizeof(Odr_oct));
3435 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3436 res->records[i].recordData_buf;
3437 npr->u.databaseRecord->u.octet_aligned->len =
3438 npr->u.databaseRecord->u.octet_aligned->size =
3439 res->records[i].recordData_len;
3440 record_cache_add (resultset, npr, pos);
3442 if (res->num_diagnostics > 0)
3444 const char *uri = res->diagnostics[0].uri;
3449 if ((cp = strrchr(uri, '/')))
3451 set_dset_error(c, code, uri,
3452 res->diagnostics[0].details, 0);
3455 nmem = odr_extract_mem(c->odr_in);
3456 nmem_transfer(resultset->odr->mem, nmem);
3462 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3465 const char *content_type = z_HTTP_header_lookup(hres->headers,
3467 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3470 yaz_log(log_details, "%p handle_http", c);
3472 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3474 Z_SOAP *soap_package = 0;
3476 Z_SOAP_Handler soap_handlers[2] = {
3477 {"http://www.loc.gov/zing/srw/", 0,
3478 (Z_SOAP_fun) yaz_srw_codec},
3481 ret = z_soap_codec(o, &soap_package,
3482 &hres->content_buf, &hres->content_len,
3484 if (!ret && soap_package->which == Z_SOAP_generic &&
3485 soap_package->u.generic->no == 0)
3487 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3488 if (sr->which == Z_SRW_searchRetrieve_response)
3489 handle_srw_response(c, sr->u.response);
3493 else if (!ret && (soap_package->which == Z_SOAP_fault
3494 || soap_package->which == Z_SOAP_error))
3496 set_HTTP_error(c, hres->code,
3497 soap_package->u.fault->fault_code,
3498 soap_package->u.fault->fault_string);
3505 if (hres->code != 200)
3506 set_HTTP_error(c, hres->code, 0, 0);
3508 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3511 ZOOM_connection_remove_task(c);
3512 if (!strcmp(hres->version, "1.0"))
3514 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3515 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3520 /* HTTP 1.1: only if no close we stay alive .. */
3521 if (connection_head && !strcmp(connection_head, "close"))
3527 static int do_read (ZOOM_connection c)
3532 event = ZOOM_Event_create (ZOOM_EVENT_RECV_DATA);
3533 ZOOM_connection_put_event (c, event);
3535 r = cs_get (c->cs, &c->buf_in, &c->len_in);
3536 more = cs_more(c->cs);
3537 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3542 if (c->reconnect_ok)
3545 c->reconnect_ok = 0;
3546 yaz_log(log_details, "%p do_read reconnect read", c);
3547 c->tasks->running = 0;
3548 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3552 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3561 odr_reset (c->odr_in);
3562 odr_setbuf (c->odr_in, c->buf_in, r, 0);
3563 event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);
3564 ZOOM_connection_put_event (c, event);
3566 if (!z_GDU (c->odr_in, &gdu, 0, 0))
3569 int err = odr_geterrorx(c->odr_in, &x);
3571 const char *element = odr_getelement(c->odr_in);
3572 sprintf (msg, "ODR code %d:%d element=%-20s",
3573 err, x, element ? element : "<unknown>");
3574 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3577 else if (gdu->which == Z_GDU_Z3950)
3578 recv_apdu (c, gdu->u.z3950);
3579 else if (gdu->which == Z_GDU_HTTP_Response)
3582 handle_http (c, gdu->u.HTTP_Response);
3584 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3588 c->reconnect_ok = 0;
3593 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out)
3598 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3599 ZOOM_connection_put_event (c, event);
3601 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3602 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3604 yaz_log(log_details, "%p do_write_ex write failed", c);
3605 if (c->reconnect_ok)
3608 c->reconnect_ok = 0;
3609 yaz_log(log_details, "%p do_write_ex reconnect write", c);
3610 c->tasks->running = 0;
3611 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3612 return zoom_pending;
3614 if (c->state == STATE_CONNECTING)
3615 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3617 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3619 return zoom_complete;
3623 c->mask = ZOOM_SELECT_EXCEPT;
3624 if (c->cs->io_pending & CS_WANT_WRITE)
3625 c->mask += ZOOM_SELECT_WRITE;
3626 if (c->cs->io_pending & CS_WANT_READ)
3627 c->mask += ZOOM_SELECT_READ;
3628 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3633 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3634 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3637 return zoom_pending;
3640 static zoom_ret do_write(ZOOM_connection c)
3642 return do_write_ex (c, c->buf_out, c->len_out);
3646 ZOOM_API(const char *)
3647 ZOOM_connection_option_get (ZOOM_connection c, const char *key)
3649 return ZOOM_options_get (c->options, key);
3652 ZOOM_API(const char *)
3653 ZOOM_connection_option_getl (ZOOM_connection c, const char *key, int *lenp)
3655 return ZOOM_options_getl (c->options, key, lenp);
3659 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
3662 ZOOM_options_set (c->options, key, val);
3666 ZOOM_connection_option_setl (ZOOM_connection c, const char *key,
3667 const char *val, int len)
3669 ZOOM_options_setl (c->options, key, val, len);
3672 ZOOM_API(const char *)
3673 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key)
3675 return ZOOM_options_get (r->options, key);
3679 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key,
3682 ZOOM_options_set (r->options, key, val);
3687 ZOOM_connection_errcode (ZOOM_connection c)
3689 return ZOOM_connection_error (c, 0, 0);
3692 ZOOM_API(const char *)
3693 ZOOM_connection_errmsg (ZOOM_connection c)
3696 ZOOM_connection_error (c, &msg, 0);
3700 ZOOM_API(const char *)
3701 ZOOM_connection_addinfo (ZOOM_connection c)
3703 const char *addinfo;
3704 ZOOM_connection_error (c, 0, &addinfo);
3708 ZOOM_API(const char *)
3709 ZOOM_connection_diagset (ZOOM_connection c)
3711 const char *diagset;
3712 ZOOM_connection_error_x (c, 0, 0, &diagset);
3716 ZOOM_API(const char *)
3717 ZOOM_diag_str (int error)
3721 case ZOOM_ERROR_NONE:
3723 case ZOOM_ERROR_CONNECT:
3724 return "Connect failed";
3725 case ZOOM_ERROR_MEMORY:
3726 return "Out of memory";
3727 case ZOOM_ERROR_ENCODE:
3728 return "Encoding failed";
3729 case ZOOM_ERROR_DECODE:
3730 return "Decoding failed";
3731 case ZOOM_ERROR_CONNECTION_LOST:
3732 return "Connection lost";
3733 case ZOOM_ERROR_INIT:
3734 return "Init rejected";
3735 case ZOOM_ERROR_INTERNAL:
3736 return "Internal failure";
3737 case ZOOM_ERROR_TIMEOUT:
3739 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3740 return "Unsupported protocol";
3741 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3742 return "Unsupported query type";
3743 case ZOOM_ERROR_INVALID_QUERY:
3744 return "Invalid query";
3745 case ZOOM_ERROR_CQL_PARSE:
3746 return "CQL parsing error";
3747 case ZOOM_ERROR_CQL_TRANSFORM:
3748 return "CQL transformation error";
3750 return diagbib1_str (error);
3755 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
3756 const char **addinfo, const char **diagset)
3758 int error = c->error;
3761 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3762 *cp = ZOOM_diag_str(error);
3763 else if (!strcmp(c->diagset, "HTTP"))
3764 *cp = z_HTTP_errmsg(c->error);
3765 else if (!strcmp(c->diagset, "Bib-1"))
3766 *cp = ZOOM_diag_str(error);
3767 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3768 *cp = yaz_diag_srw_str(c->error);
3770 *cp = "Unknown error and diagnostic set";
3773 *addinfo = c->addinfo ? c->addinfo : "";
3775 *diagset = c->diagset ? c->diagset : "";
3780 ZOOM_connection_error (ZOOM_connection c, const char **cp,
3781 const char **addinfo)
3783 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3786 static int ZOOM_connection_do_io(ZOOM_connection c, int mask)
3788 ZOOM_Event event = 0;
3789 int r = cs_look(c->cs);
3790 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
3795 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3796 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3798 ZOOM_connection_put_event (c, event);
3800 else if (r == CS_CONNECT)
3803 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3805 ret = cs_rcvconnect (c->cs);
3806 yaz_log(log_details, "%p ZOOM_connection_do_io "
3807 "cs_rcvconnect returned %d", c, ret);
3810 c->mask = ZOOM_SELECT_EXCEPT;
3811 if (c->cs->io_pending & CS_WANT_WRITE)
3812 c->mask += ZOOM_SELECT_WRITE;
3813 if (c->cs->io_pending & CS_WANT_READ)
3814 c->mask += ZOOM_SELECT_READ;
3815 ZOOM_connection_put_event (c, event);
3819 ZOOM_connection_put_event (c, event);
3821 if (c->proto == PROTO_Z3950)
3822 ZOOM_connection_send_init(c);
3825 /* no init request for SRW .. */
3826 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3827 ZOOM_connection_remove_task (c);
3829 ZOOM_connection_exec_task (c);
3831 c->state = STATE_ESTABLISHED;
3835 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3837 ZOOM_connection_put_event (c, event);
3842 if (mask & ZOOM_SELECT_READ)
3844 if (c->cs && (mask & ZOOM_SELECT_WRITE))
3851 ZOOM_connection_last_event(ZOOM_connection cs)
3854 return ZOOM_EVENT_NONE;
3855 return cs->last_event;
3859 ZOOM_event (int no, ZOOM_connection *cs)
3861 int timeout = 30; /* default timeout in seconds */
3862 int timeout_set = 0; /* whether it was overriden at all */
3864 struct pollfd pollfds[1024];
3865 ZOOM_connection poll_cs[1024];
3868 fd_set input, output, except;
3873 for (i = 0; i<no; i++)
3875 ZOOM_connection c = cs[i];
3877 if (c && (event = ZOOM_connection_get_event(c)))
3879 ZOOM_Event_destroy (event);
3883 for (i = 0; i<no; i++)
3885 ZOOM_connection c = cs[i];
3887 if (c && ZOOM_connection_exec_task (c))
3889 if ((event = ZOOM_connection_get_event(c)))
3891 ZOOM_Event_destroy (event);
3904 for (i = 0; i<no; i++)
3906 ZOOM_connection c = cs[i];
3912 fd = z3950_connection_socket(c);
3913 mask = z3950_connection_mask(c);
3920 /* -1 is used for indefinite timeout (no timeout), so -2 here. */
3921 this_timeout = ZOOM_options_get_int (c->options, "timeout", -2);
3922 if (this_timeout != -2)
3924 /* ensure the minimum timeout is used */
3926 timeout = this_timeout;
3927 else if (this_timeout != -1 && this_timeout < timeout)
3928 timeout = this_timeout;
3934 short poll_events = 0;
3936 if (mask & ZOOM_SELECT_READ)
3937 poll_events += POLLIN;
3938 if (mask & ZOOM_SELECT_WRITE)
3939 poll_events += POLLOUT;
3940 if (mask & ZOOM_SELECT_EXCEPT)
3941 poll_events += POLLERR;
3942 pollfds[nfds].fd = fd;
3943 pollfds[nfds].events = poll_events;
3944 pollfds[nfds].revents = 0;
3949 if (mask & ZOOM_SELECT_READ)
3951 FD_SET (fd, &input);
3954 if (mask & ZOOM_SELECT_WRITE)
3956 FD_SET (fd, &output);
3959 if (mask & ZOOM_SELECT_EXCEPT)
3961 FD_SET (fd, &except);
3970 r = poll (pollfds, nfds, (timeout == -1 ? -1 : timeout * 1000));
3971 for (i = 0; i<nfds; i++)
3973 ZOOM_connection c = poll_cs[i];
3977 if (pollfds[i].revents & POLLIN)
3978 mask += ZOOM_SELECT_READ;
3979 if (pollfds[i].revents & POLLOUT)
3980 mask += ZOOM_SELECT_WRITE;
3981 if (pollfds[i].revents & POLLERR)
3982 mask += ZOOM_SELECT_EXCEPT;
3984 ZOOM_connection_do_io(c, mask);
3986 else if (r == 0 && c->mask)
3988 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3989 /* timeout and this connection was waiting */
3990 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3992 ZOOM_connection_put_event(c, event);
3996 tv.tv_sec = timeout;
3998 r = select (max_fd+1, &input, &output, &except, (timeout == -1 ? 0 : &tv));
3999 for (i = 0; i<no; i++)
4001 ZOOM_connection c = cs[i];
4006 fd = z3950_connection_socket(c);
4010 /* no timeout and real socket */
4011 if (FD_ISSET(fd, &input))
4012 mask += ZOOM_SELECT_READ;
4013 if (FD_ISSET(fd, &output))
4014 mask += ZOOM_SELECT_WRITE;
4015 if (FD_ISSET(fd, &except))
4016 mask += ZOOM_SELECT_EXCEPT;
4018 ZOOM_connection_do_io(c, mask);
4020 if (r == 0 && c->mask)
4022 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4023 /* timeout and this connection was waiting */
4024 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4026 ZOOM_connection_put_event(c, event);
4030 for (i = 0; i<no; i++)
4032 ZOOM_connection c = cs[i];
4034 if (c && (event = ZOOM_connection_get_event(c)))
4036 ZOOM_Event_destroy (event);
4045 * Returns an xmalloc()d string containing RPN that corresponds to the
4046 * CQL passed in. On error, sets the Connection object's error state
4047 * and returns a null pointer.
4048 * ### We could cache CQL parser and/or transformer in Connection.
4050 static char *cql2pqf(ZOOM_connection c, const char *cql)
4054 struct cql_node *node;
4055 const char *cqlfile;
4056 static cql_transform_t trans;
4059 parser = cql_parser_create();
4060 if ((error = cql_parser_string(parser, cql)) != 0) {
4061 cql_parser_destroy(parser);
4062 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4066 node = cql_parser_result(parser);
4067 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4069 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4071 cql_parser_destroy(parser);
4072 cql_node_destroy(node);
4073 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4077 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4079 cql_parser_destroy(parser);
4080 cql_node_destroy(node);
4081 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4082 cqlfile, strerror(errno));
4083 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4087 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4088 cql_parser_destroy(parser);
4089 cql_node_destroy(node);
4092 const char *addinfo;
4093 error = cql_transform_error(trans, &addinfo);
4094 cql_transform_close(trans);
4095 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4096 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4100 cql_transform_close(trans);
4101 return xstrdup(pqfbuf);
4108 * indent-tabs-mode: nil
4110 * vim: shiftwidth=4 tabstop=8 expandtab