2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.62 2005-12-21 16:41:36 mike 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);
60 static int log_level_initialized = 0;
61 if (!log_level_initialized)
63 log_api = yaz_log_module_level("zoom");
64 log_details = yaz_log_module_level("zoomdetails");
65 log_level_initialized = 1;
69 static ZOOM_Event ZOOM_Event_create (int kind)
71 ZOOM_Event event = (ZOOM_Event) xmalloc (sizeof(*event));
78 static void ZOOM_Event_destroy (ZOOM_Event event)
83 static void ZOOM_connection_put_event (ZOOM_connection c, ZOOM_Event event)
87 c->m_queue_back->prev = event;
88 assert (c->m_queue_front);
92 assert (!c->m_queue_front);
93 c->m_queue_front = event;
95 event->next = c->m_queue_back;
97 c->m_queue_back = event;
100 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
102 ZOOM_Event event = c->m_queue_front;
105 c->last_event = ZOOM_EVENT_NONE;
108 assert (c->m_queue_back);
109 c->m_queue_front = event->prev;
110 if (c->m_queue_front)
112 assert (c->m_queue_back);
113 c->m_queue_front->next = 0;
117 c->last_event = event->kind;
122 static void set_dset_error (ZOOM_connection c, int error,
124 const char *addinfo, const char *addinfo2)
131 if (!c->diagset || strcmp(dset, c->diagset))
134 c->diagset = xstrdup(dset);
135 /* remove integer part from SRW diagset .. */
136 if ((cp = strrchr(c->diagset, '/')))
139 if (addinfo && addinfo2)
141 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
142 strcpy(c->addinfo, addinfo);
143 strcat(c->addinfo, addinfo2);
146 c->addinfo = xstrdup(addinfo);
148 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
149 c, c->host_port ? c->host_port : "<>", dset, error,
150 addinfo ? addinfo : "",
151 addinfo2 ? addinfo2 : "");
155 static void set_HTTP_error (ZOOM_connection c, int error,
156 const char *addinfo, const char *addinfo2)
158 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
162 static void set_ZOOM_error (ZOOM_connection c, int error,
165 set_dset_error(c, error, "ZOOM", addinfo, 0);
168 static void clear_error (ZOOM_connection c)
171 * If an error is tied to an operation then it's ok to clear: for
172 * example, a diagnostic returned from a search is cleared by a
173 * subsequent search. However, problems such as Connection Lost
174 * or Init Refused are not cleared, because they are not
175 * recoverable: doing another search doesn't help.
179 case ZOOM_ERROR_CONNECT:
180 case ZOOM_ERROR_MEMORY:
181 case ZOOM_ERROR_DECODE:
182 case ZOOM_ERROR_CONNECTION_LOST:
183 case ZOOM_ERROR_INIT:
184 case ZOOM_ERROR_INTERNAL:
185 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
188 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
192 ZOOM_task ZOOM_connection_add_task (ZOOM_connection c, int which)
194 ZOOM_task *taskp = &c->tasks;
196 taskp = &(*taskp)->next;
197 *taskp = (ZOOM_task) xmalloc (sizeof(**taskp));
198 (*taskp)->running = 0;
199 (*taskp)->which = which;
205 ZOOM_task ZOOM_connection_insert_task (ZOOM_connection c, int which)
207 ZOOM_task task = (ZOOM_task) xmalloc (sizeof(*task));
209 task->next = c->tasks;
218 void ZOOM_connection_remove_task (ZOOM_connection c)
220 ZOOM_task task = c->tasks;
224 c->tasks = task->next;
227 case ZOOM_TASK_SEARCH:
228 ZOOM_resultset_destroy (task->u.search.resultset);
230 case ZOOM_TASK_RETRIEVE:
231 ZOOM_resultset_destroy (task->u.retrieve.resultset);
233 case ZOOM_TASK_CONNECT:
236 ZOOM_scanset_destroy (task->u.scan.scan);
238 case ZOOM_TASK_PACKAGE:
239 ZOOM_package_destroy (task->u.package);
242 ZOOM_resultset_destroy (task->u.sort.resultset);
243 ZOOM_query_destroy(task->u.sort.q);
252 static int ZOOM_connection_exec_task (ZOOM_connection c);
254 void ZOOM_connection_remove_tasks (ZOOM_connection c)
257 ZOOM_connection_remove_task(c);
260 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos);
262 ZOOM_API(ZOOM_connection)
263 ZOOM_connection_create (ZOOM_options options)
265 ZOOM_connection c = (ZOOM_connection) xmalloc (sizeof(*c));
269 yaz_log(log_api, "%p ZOOM_connection_create", c);
271 c->proto = PROTO_Z3950;
275 c->state = STATE_IDLE;
278 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
285 c->options = ZOOM_options_create_with_parent(options);
291 c->charset = c->lang = 0;
298 c->odr_in = odr_createmem (ODR_DECODE);
299 c->odr_out = odr_createmem (ODR_ENCODE);
302 c->support_named_resultsets = 0;
303 c->last_event = ZOOM_EVENT_NONE;
305 c->m_queue_front = 0;
310 /* set database names. Take local databases (if set); otherwise
311 take databases given in ZURL (if set); otherwise use Default */
312 static char **set_DatabaseNames (ZOOM_connection con, ZOOM_options options,
315 char **databaseNames;
316 const char *cp = ZOOM_options_get (options, "databaseName");
320 if (strncmp (con->host_port, "unix:", 5) == 0)
321 cp = strchr(con->host_port+5, ':');
323 cp = strchr(con->host_port, '/');
329 nmem_strsplit(con->odr_out->mem, "+", cp, &databaseNames, num);
330 return databaseNames;
333 ZOOM_API(ZOOM_connection)
334 ZOOM_connection_new (const char *host, int portnum)
336 ZOOM_connection c = ZOOM_connection_create (0);
338 ZOOM_connection_connect (c, host, portnum);
343 ZOOM_connection_connect(ZOOM_connection c,
344 const char *host, int portnum)
351 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
356 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
360 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
362 val = ZOOM_options_get (c->options, "proxy");
365 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
366 c->proxy = xstrdup (val);
372 val = ZOOM_options_get (c->options, "charset");
375 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
376 c->charset = xstrdup (val);
382 val = ZOOM_options_get (c->options, "lang");
385 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
386 c->lang = xstrdup (val);
391 xfree (c->host_port);
395 sprintf (hostn, "%.80s:%d", host, portnum);
396 c->host_port = xstrdup(hostn);
399 c->host_port = xstrdup(host);
403 * If the "<scheme>:" part of the host string is preceded by one
404 * or more comma-separated <name>=<value> pairs, these are taken
405 * to be options to be set on the connection object. Among other
406 * applications, this facility can be used to embed authentication
408 * user=admin,password=secret,tcp:localhost:9999
410 char *remainder = c->host_port;
411 char *pcolon = strchr(remainder, ':');
414 while ((pcomma = strchr(remainder, ',')) != 0 &&
415 (pcolon == 0 || pcomma < pcolon)) {
417 if ((pequals = strchr(remainder, '=')) != 0) {
419 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
420 ZOOM_connection_option_set(c, remainder, pequals+1);
422 remainder = pcomma+1;
425 if (remainder != c->host_port) {
427 c->host_port = xstrdup(remainder);
428 /*printf("# reset hp='%s'\n", remainder);*/
432 ZOOM_options_set(c->options, "host", c->host_port);
434 val = ZOOM_options_get (c->options, "cookie");
437 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
438 c->cookie_out = xstrdup (val);
441 val = ZOOM_options_get (c->options, "clientIP");
444 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
446 c->client_IP = xstrdup (val);
449 c->async = ZOOM_options_get_bool (c->options, "async", 0);
450 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
452 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
454 task = ZOOM_connection_add_task (c, ZOOM_TASK_CONNECT);
458 while (ZOOM_event (1, &c))
464 ZOOM_query_create(void)
466 ZOOM_query s = (ZOOM_query) xmalloc (sizeof(*s));
468 yaz_log(log_details, "%p ZOOM_query_create", s);
472 s->odr = odr_createmem (ODR_ENCODE);
479 ZOOM_query_destroy(ZOOM_query s)
485 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
486 if (s->refcount == 0)
488 odr_destroy (s->odr);
494 ZOOM_query_prefix(ZOOM_query s, const char *str)
496 s->query_string = odr_strdup(s->odr, str);
497 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
498 s->z_query->which = Z_Query_type_1;
499 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
500 if (!s->z_query->u.type_1)
502 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
506 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
511 ZOOM_query_cql(ZOOM_query s, const char *str)
515 s->query_string = odr_strdup(s->odr, str);
517 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
518 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
519 ext->indirect_reference = 0;
521 ext->which = Z_External_CQL;
522 ext->u.cql = s->query_string;
524 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
525 s->z_query->which = Z_Query_type_104;
526 s->z_query->u.type_104 = ext;
528 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
534 * Translate the CQL string client-side into RPN which is passed to
535 * the server. This is useful for server's that don't themselves
536 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
537 * only as a place to stash diagnostics if compilation fails; if this
538 * information is not needed, a null pointer may be used.
541 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
546 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
548 conn = ZOOM_connection_create(0);
550 if ((rpn = cql2pqf(conn, str)) == 0)
553 ret = ZOOM_query_prefix(s, rpn);
559 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
561 s->sort_spec = yaz_sort_spec (s->odr, criteria);
564 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
568 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
572 static zoom_ret do_write(ZOOM_connection c);
575 ZOOM_connection_destroy(ZOOM_connection c)
580 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
583 for (r = c->resultsets; r; r = r->next)
589 odr_destroy (c->odr_in);
590 odr_destroy (c->odr_out);
591 ZOOM_options_destroy (c->options);
592 ZOOM_connection_remove_tasks (c);
593 xfree (c->host_port);
598 xfree (c->cookie_out);
599 xfree (c->cookie_in);
600 xfree (c->client_IP);
604 void ZOOM_resultset_addref (ZOOM_resultset r)
609 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
614 ZOOM_resultset ZOOM_resultset_create ()
616 ZOOM_resultset r = (ZOOM_resultset) xmalloc (sizeof(*r));
620 yaz_log(log_details, "%p ZOOM_resultset_create", r);
623 r->odr = odr_createmem (ODR_ENCODE);
638 ZOOM_API(ZOOM_resultset)
639 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
642 ZOOM_query s = ZOOM_query_create();
644 ZOOM_query_prefix (s, q);
646 r = ZOOM_connection_search (c, s);
647 ZOOM_query_destroy (s);
651 ZOOM_API(ZOOM_resultset)
652 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
654 ZOOM_resultset r = ZOOM_resultset_create ();
658 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
659 r->r_sort_spec = q->sort_spec;
662 r->options = ZOOM_options_create_with_parent(c->options);
664 r->start = ZOOM_options_get_int(r->options, "start", 0);
665 r->count = ZOOM_options_get_int(r->options, "count", 0);
667 /* If "presentChunk" is defined use that; otherwise "step" */
668 const char *cp = ZOOM_options_get (r->options, "presentChunk");
669 r->step = ZOOM_options_get_int(r->options,
670 (cp != 0 ? "presentChunk": "step"), 0);
672 r->piggyback = ZOOM_options_get_bool (r->options, "piggyback", 1);
673 cp = ZOOM_options_get (r->options, "setname");
675 r->setname = xstrdup(cp);
676 cp = ZOOM_options_get (r->options, "schema");
678 r->schema = xstrdup(cp);
682 r->next = c->resultsets;
685 if (c->host_port && c->proto == PROTO_HTTP)
689 yaz_log(log_details, "ZOOM_connection_search: no comstack");
690 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
694 yaz_log(log_details, "ZOOM_connection_search: reconnect");
699 task = ZOOM_connection_add_task (c, ZOOM_TASK_SEARCH);
700 task->u.search.resultset = r;
701 ZOOM_resultset_addref (r);
707 while (ZOOM_event (1, &c))
714 * This is the old result-set sorting API, which is maintained only
715 * for the sake of binary compatibility. There is no reason ever to
716 * use this rather than ZOOM_resultset_sort1().
719 ZOOM_resultset_sort(ZOOM_resultset r,
720 const char *sort_type, const char *sort_spec)
722 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
726 ZOOM_resultset_sort1(ZOOM_resultset r,
727 const char *sort_type, const char *sort_spec)
729 ZOOM_connection c = r->connection;
733 newq = ZOOM_query_create();
734 if (ZOOM_query_sortby(newq, sort_spec) < 0)
737 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
738 r, r, sort_type, sort_spec);
742 if (c->host_port && c->proto == PROTO_HTTP)
746 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
747 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
751 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
757 ZOOM_resultset_cache_reset(r);
758 task = ZOOM_connection_add_task (c, ZOOM_TASK_SORT);
759 task->u.sort.resultset = r;
760 task->u.sort.q = newq;
762 ZOOM_resultset_addref (r);
766 while (ZOOM_event (1, &c))
774 ZOOM_resultset_cache_reset(ZOOM_resultset r)
776 ZOOM_record_cache rc;
778 for (rc = r->record_cache; rc; rc = rc->next)
780 if (rc->rec.wrbuf_marc)
781 wrbuf_free (rc->rec.wrbuf_marc, 1);
782 if (rc->rec.wrbuf_iconv)
783 wrbuf_free (rc->rec.wrbuf_iconv, 1);
784 if (rc->rec.wrbuf_opac)
785 wrbuf_free (rc->rec.wrbuf_opac, 1);
791 ZOOM_resultset_destroy(ZOOM_resultset r)
796 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
798 if (r->refcount == 0)
800 ZOOM_resultset_cache_reset(r);
804 /* remove ourselves from the resultsets in connection */
805 ZOOM_resultset *rp = &r->connection->resultsets;
808 assert (*rp); /* we must be in this list!! */
810 { /* OK, we're here - take us out of it */
817 ZOOM_query_destroy (r->query);
818 ZOOM_options_destroy (r->options);
819 odr_destroy (r->odr);
827 ZOOM_resultset_size (ZOOM_resultset r)
832 static void do_close (ZOOM_connection c)
838 c->state = STATE_IDLE;
841 static void ZOOM_resultset_retrieve (ZOOM_resultset r,
842 int force_sync, int start, int count)
850 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
851 " count=%d", r, force_sync, start, count);
856 if (c->host_port && c->proto == PROTO_HTTP)
860 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
861 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
865 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
870 task = ZOOM_connection_add_task (c, ZOOM_TASK_RETRIEVE);
871 task->u.retrieve.resultset = r;
872 task->u.retrieve.start = start;
873 task->u.retrieve.count = count;
875 cp = ZOOM_options_get (r->options, "schema");
878 if (!r->schema || strcmp(r->schema, cp))
881 r->schema = xstrdup(cp);
885 ZOOM_resultset_addref (r);
887 if (!r->connection->async || force_sync)
888 while (r->connection && ZOOM_event (1, &r->connection))
893 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
894 size_t start, size_t count)
896 int force_present = 0;
900 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%d count=%d",
904 ZOOM_resultset_retrieve (r, force_present, start, count);
908 for (i = 0; i< count; i++)
909 recs[i] = ZOOM_resultset_record_immediate (r, i+start);
913 static void get_cert(ZOOM_connection c)
918 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
920 ZOOM_connection_option_setl(c, "sslPeerCert",
926 static zoom_ret do_connect (ZOOM_connection c)
929 const char *effective_host;
932 effective_host = c->proxy;
934 effective_host = c->host_port;
936 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
940 c->cs = cs_create_host (effective_host, 0, &add);
942 if (c->cs && c->cs->protocol == PROTO_HTTP)
945 const char *path = 0;
947 c->proto = PROTO_HTTP;
948 cs_get_host_args(c->host_port, &path);
950 c->path = (char*) xmalloc(strlen(path)+2);
952 strcpy (c->path+1, path);
954 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
956 return zoom_complete;
961 int ret = cs_connect (c->cs, add);
964 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
965 ZOOM_connection_put_event(c, event);
967 if (c->proto == PROTO_Z3950)
968 ZOOM_connection_send_init(c);
971 /* no init request for SRW .. */
972 assert (c->tasks->which == ZOOM_TASK_CONNECT);
973 ZOOM_connection_remove_task (c);
975 ZOOM_connection_exec_task (c);
977 c->state = STATE_ESTABLISHED;
982 c->state = STATE_CONNECTING;
983 c->mask = ZOOM_SELECT_EXCEPT;
984 if (c->cs->io_pending & CS_WANT_WRITE)
985 c->mask += ZOOM_SELECT_WRITE;
986 if (c->cs->io_pending & CS_WANT_READ)
987 c->mask += ZOOM_SELECT_READ;
991 c->state = STATE_IDLE;
992 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
993 return zoom_complete;
996 int z3950_connection_socket(ZOOM_connection c)
999 return cs_fileno(c->cs);
1003 int z3950_connection_mask(ZOOM_connection c)
1010 static void otherInfo_attach (ZOOM_connection c, Z_APDU *a, ODR out)
1013 for (i = 0; i<200; i++)
1016 Z_OtherInformation **oi;
1022 sprintf (buf, "otherInfo%d", i);
1023 val = ZOOM_options_get (c->options, buf);
1026 cp = strchr(val, ':');
1030 if (len >= sizeof(buf))
1031 len = sizeof(buf)-1;
1032 memcpy (buf, val, len);
1034 oidval = oid_getvalbyname (buf);
1035 if (oidval == VAL_NONE)
1038 yaz_oi_APDU(a, &oi);
1039 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1043 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1048 Z_OtherInformation **oi;
1049 yaz_oi_APDU(a, &oi);
1050 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1054 Z_OtherInformation **oi;
1055 yaz_oi_APDU(a, &oi);
1056 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1058 otherInfo_attach (c, a, out);
1059 if (!z_APDU(out, &a, 0, 0))
1061 FILE *outf = fopen("/tmp/apdu.txt", "a");
1064 ODR odr_pr = odr_createmem(ODR_PRINT);
1065 fprintf (outf, "a=%p\n", a);
1066 odr_setprint(odr_pr, outf);
1067 z_APDU(odr_pr, &a, 0, 0);
1068 odr_destroy(odr_pr);
1070 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1071 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1075 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1079 static zoom_ret send_APDU (ZOOM_connection c, Z_APDU *a)
1083 if (encode_APDU(c, a, c->odr_out))
1084 return zoom_complete;
1085 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1086 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1087 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1088 ZOOM_connection_put_event (c, event);
1089 odr_reset(c->odr_out);
1090 return do_write (c);
1093 /* returns 1 if PDU was sent OK (still pending )
1094 0 if PDU was not sent OK (nothing to wait for)
1097 static zoom_ret ZOOM_connection_send_init (ZOOM_connection c)
1099 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1100 Z_InitRequest *ireq = apdu->u.initRequest;
1101 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1102 odr_malloc(c->odr_out, sizeof(*auth));
1103 const char *auth_groupId = ZOOM_options_get (c->options, "group");
1104 const char *auth_userId = ZOOM_options_get (c->options, "user");
1105 const char *auth_password = ZOOM_options_get (c->options, "password");
1108 /* support the pass for backwards compatibility */
1110 auth_password = ZOOM_options_get (c->options, "pass");
1112 ODR_MASK_SET(ireq->options, Z_Options_search);
1113 ODR_MASK_SET(ireq->options, Z_Options_present);
1114 ODR_MASK_SET(ireq->options, Z_Options_scan);
1115 ODR_MASK_SET(ireq->options, Z_Options_sort);
1116 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1117 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1119 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1120 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1121 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1123 /* Index Data's Z39.50 Implementor Id is 81 */
1124 ireq->implementationId = odr_prepend(c->odr_out,
1125 ZOOM_options_get(c->options, "implementationId"),
1126 odr_prepend(c->odr_out, "81", ireq->implementationId));
1128 ireq->implementationName = odr_prepend(c->odr_out,
1129 ZOOM_options_get(c->options, "implementationName"),
1130 odr_prepend(c->odr_out, "ZOOM-C", ireq->implementationName));
1132 version = odr_strdup(c->odr_out, "$Revision: 1.62 $");
1133 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1134 version[strlen(version)-2] = '\0';
1135 ireq->implementationVersion = odr_prepend(c->odr_out,
1136 ZOOM_options_get(c->options, "implementationVersion"),
1137 odr_prepend(c->odr_out, &version[11], ireq->implementationVersion));
1139 *ireq->maximumRecordSize =
1140 ZOOM_options_get_int (c->options, "maximumRecordSize", 1024*1024);
1141 *ireq->preferredMessageSize =
1142 ZOOM_options_get_int (c->options, "preferredMessageSize", 1024*1024);
1144 if (auth_groupId || auth_password)
1146 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1149 if (auth_groupId && *auth_groupId)
1151 pass->groupId = (char *)
1152 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1153 strcpy(pass->groupId, auth_groupId);
1157 if (auth_userId && *auth_userId)
1159 pass->userId = (char *)
1160 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1161 strcpy(pass->userId, auth_userId);
1165 if (auth_password && *auth_password)
1167 pass->password = (char *)
1168 odr_malloc(c->odr_out, strlen(auth_password)+1);
1169 strcpy(pass->password, auth_password);
1174 auth->which = Z_IdAuthentication_idPass;
1175 auth->u.idPass = pass;
1176 ireq->idAuthentication = auth;
1179 else if (auth_userId)
1181 auth->which = Z_IdAuthentication_open;
1182 auth->u.open = (char *)
1183 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1184 strcpy(auth->u.open, auth_userId);
1185 ireq->idAuthentication = auth;
1188 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1189 VAL_PROXY, 1, c->host_port);
1190 if (c->charset || c->lang)
1192 Z_OtherInformation **oi;
1193 Z_OtherInformationUnit *oi_unit;
1195 yaz_oi_APDU(apdu, &oi);
1197 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1199 char **charsets_addresses = 0;
1200 char **langs_addresses = 0;
1201 int charsets_count = 0;
1202 int langs_count = 0;
1205 nmem_strsplit_blank(c->odr_out->mem, c->charset,
1206 &charsets_addresses, &charsets_count);
1208 nmem_strsplit_blank(c->odr_out->mem, c->lang,
1209 &langs_addresses, &langs_count);
1210 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1211 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1212 oi_unit->information.externallyDefinedInfo =
1213 yaz_set_proposal_charneg(c->odr_out,
1214 (const char **) charsets_addresses,
1216 (const char **) langs_addresses,
1222 return send_APDU (c, apdu);
1226 static zoom_ret send_srw (ZOOM_connection c, Z_SRW_PDU *sr)
1229 Z_SOAP_Handler h[2] = {
1230 {"http://www.loc.gov/zing/srw/", 0, (Z_SOAP_fun) yaz_srw_codec},
1233 ODR o = odr_createmem(ODR_ENCODE);
1235 Z_SOAP *p = (Z_SOAP*) odr_malloc(o, sizeof(*p));
1239 gdu = z_get_HTTP_Request(c->odr_out);
1240 gdu->u.HTTP_Request->path = c->path;
1244 const char *cp0 = strstr(c->host_port, "://");
1245 const char *cp1 = 0;
1251 cp1 = strchr(cp0, '/');
1253 cp1 = cp0+strlen(cp0);
1257 char *h = (char*) odr_malloc(c->odr_out, cp1 - cp0 + 1);
1258 memcpy (h, cp0, cp1 - cp0);
1260 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1265 strcpy(ctype, "text/xml");
1266 if (c->charset && strlen(c->charset) < 20)
1268 strcat(ctype, "; charset=");
1269 strcat(ctype, c->charset);
1271 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1272 "Content-Type", ctype);
1273 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1274 "SOAPAction", "\"\"");
1275 p->which = Z_SOAP_generic;
1276 p->u.generic = (Z_SOAP_Generic *) odr_malloc(o, sizeof(*p->u.generic));
1277 p->u.generic->no = 0;
1278 p->u.generic->ns = 0;
1279 p->u.generic->p = sr;
1280 p->ns = "http://schemas.xmlsoap.org/soap/envelope/";
1282 ret = z_soap_codec_enc(o, &p,
1283 &gdu->u.HTTP_Request->content_buf,
1284 &gdu->u.HTTP_Request->content_len, h,
1287 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1288 return zoom_complete;
1289 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1293 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1294 ZOOM_connection_put_event (c, event);
1295 odr_reset(c->odr_out);
1296 return do_write (c);
1301 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1304 ZOOM_resultset resultset = 0;
1306 const char *recordPacking = 0;
1308 if (c->error) /* don't continue on error */
1309 return zoom_complete;
1311 if (c->tasks->which == ZOOM_TASK_SEARCH)
1313 resultset = c->tasks->u.search.resultset;
1314 resultset->setname = xstrdup ("default");
1315 ZOOM_options_set (resultset->options, "setname", resultset->setname);
1317 else if(c->tasks->which == ZOOM_TASK_RETRIEVE)
1319 resultset = c->tasks->u.retrieve.resultset;
1321 resultset->start = c->tasks->u.retrieve.start;
1322 resultset->count = c->tasks->u.retrieve.count;
1324 if (resultset->start >= resultset->size)
1325 return zoom_complete;
1326 if (resultset->start + resultset->count > resultset->size)
1327 resultset->count = resultset->size - resultset->start;
1329 for (i = 0; i<resultset->count; i++)
1332 record_cache_lookup (resultset, i + resultset->start);
1336 if (i == resultset->count)
1337 return zoom_complete;
1339 assert(resultset->query);
1341 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1343 if (resultset->query->z_query->which == Z_Query_type_104
1344 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1347 sr->u.request->query_type = Z_SRW_query_type_cql;
1348 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1350 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1351 resultset->query->z_query->u.type_1)
1353 sr->u.request->query_type = Z_SRW_query_type_pqf;
1354 sr->u.request->query.pqf = resultset->query->query_string;
1358 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1359 return zoom_complete;
1361 sr->u.request->startRecord = odr_intdup (c->odr_out, resultset->start + 1);
1362 sr->u.request->maximumRecords = odr_intdup (
1363 c->odr_out, resultset->step>0 ? resultset->step : resultset->count);
1364 sr->u.request->recordSchema = resultset->schema;
1366 recordPacking = ZOOM_resultset_option_get (resultset, "recordPacking");
1369 sr->u.request->recordPacking = odr_strdup(c->odr_out, recordPacking);
1371 return send_srw(c, sr);
1374 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1376 return zoom_complete;
1380 static zoom_ret ZOOM_connection_send_search (ZOOM_connection c)
1383 int lslb, ssub, mspn;
1385 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1386 Z_SearchRequest *search_req = apdu->u.searchRequest;
1387 const char *elementSetName;
1388 const char *smallSetElementSetName;
1389 const char *mediumSetElementSetName;
1392 assert (c->tasks->which == ZOOM_TASK_SEARCH);
1394 r = c->tasks->u.search.resultset;
1396 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1399 ZOOM_options_get (r->options, "elementSetName");
1400 smallSetElementSetName =
1401 ZOOM_options_get (r->options, "smallSetElementSetName");
1402 mediumSetElementSetName =
1403 ZOOM_options_get (r->options, "mediumSetElementSetName");
1405 if (!smallSetElementSetName)
1406 smallSetElementSetName = elementSetName;
1408 if (!mediumSetElementSetName)
1409 mediumSetElementSetName = elementSetName;
1414 /* prepare query for the search request */
1415 search_req->query = r->query->z_query;
1416 if (!search_req->query)
1418 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1419 return zoom_complete;
1422 search_req->databaseNames =
1423 set_DatabaseNames (c, r->options, &search_req->num_databaseNames);
1425 /* get syntax (no need to provide unless piggyback is in effect) */
1426 syntax = ZOOM_options_get (r->options, "preferredRecordSyntax");
1428 lslb = ZOOM_options_get_int (r->options, "largeSetLowerBound", -1);
1429 ssub = ZOOM_options_get_int (r->options, "smallSetUpperBound", -1);
1430 mspn = ZOOM_options_get_int (r->options, "mediumSetPresentNumber", -1);
1431 if (lslb != -1 && ssub != -1 && mspn != -1)
1433 /* So're a Z39.50 expert? Let's hope you don't do sort */
1434 *search_req->largeSetLowerBound = lslb;
1435 *search_req->smallSetUpperBound = ssub;
1436 *search_req->mediumSetPresentNumber = mspn;
1438 else if (r->start == 0 && r->count > 0
1439 && r->piggyback && !r->r_sort_spec && !r->schema)
1441 /* Regular piggyback - do it unless we're going to do sort */
1442 *search_req->largeSetLowerBound = 2000000000;
1443 *search_req->smallSetUpperBound = 1;
1444 *search_req->mediumSetPresentNumber = r->step>0 ? r->step : r->count;
1448 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1449 smallSetElementSetName = 0;
1450 mediumSetElementSetName = 0;
1453 if (smallSetElementSetName && *smallSetElementSetName)
1455 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1456 odr_malloc (c->odr_out, sizeof(*esn));
1458 esn->which = Z_ElementSetNames_generic;
1459 esn->u.generic = odr_strdup (c->odr_out, smallSetElementSetName);
1460 search_req->smallSetElementSetNames = esn;
1462 if (mediumSetElementSetName && *mediumSetElementSetName)
1464 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1465 odr_malloc (c->odr_out, sizeof(*esn));
1467 esn->which = Z_ElementSetNames_generic;
1468 esn->u.generic = odr_strdup (c->odr_out, mediumSetElementSetName);
1469 search_req->mediumSetElementSetNames = esn;
1472 search_req->preferredRecordSyntax =
1473 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1477 if (c->support_named_resultsets)
1481 /* find the lowest unused ordinal so that we re-use
1482 result sets on the server. */
1483 for (ord = 1; ; ord++)
1486 sprintf (setname, "%d", ord);
1487 for (rp = c->resultsets; rp; rp = rp->next)
1488 if (rp->setname && !strcmp (rp->setname, setname))
1493 r->setname = xstrdup (setname);
1494 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1495 "set %s", c, r->setname);
1499 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1501 r->setname = xstrdup ("default");
1503 ZOOM_options_set (r->options, "setname", r->setname);
1505 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1506 return send_APDU (c, apdu);
1509 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1516 case Z_DefaultDiagFormat_v2Addinfo:
1517 addinfo = r->u.v2Addinfo;
1519 case Z_DefaultDiagFormat_v3Addinfo:
1520 addinfo = r->u.v3Addinfo;
1525 set_dset_error(c, *r->condition,
1526 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1530 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1532 if (p->which != Z_DiagRec_defaultFormat)
1533 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1535 response_default_diag(c, p->u.defaultFormat);
1538 ZOOM_API(ZOOM_record)
1539 ZOOM_record_clone (ZOOM_record srec)
1546 odr_enc = odr_createmem(ODR_ENCODE);
1547 if (!z_NamePlusRecord (odr_enc, &srec->npr, 0, 0))
1549 buf = odr_getbuf (odr_enc, &size, 0);
1551 nrec = (ZOOM_record) xmalloc (sizeof(*nrec));
1552 nrec->odr = odr_createmem(ODR_DECODE);
1553 nrec->wrbuf_marc = 0;
1554 nrec->wrbuf_iconv = 0;
1555 nrec->wrbuf_opac = 0;
1556 odr_setbuf (nrec->odr, buf, size, 0);
1557 z_NamePlusRecord (nrec->odr, &nrec->npr, 0, 0);
1559 odr_destroy (odr_enc);
1563 ZOOM_API(ZOOM_record)
1564 ZOOM_resultset_record_immediate (ZOOM_resultset s,size_t pos)
1566 return record_cache_lookup (s, pos);
1569 ZOOM_API(ZOOM_record)
1570 ZOOM_resultset_record (ZOOM_resultset r, size_t pos)
1572 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1576 ZOOM_resultset_retrieve (r, 1, pos, 1);
1577 rec = ZOOM_resultset_record_immediate (r, pos);
1583 ZOOM_record_destroy (ZOOM_record rec)
1587 if (rec->wrbuf_marc)
1588 wrbuf_free (rec->wrbuf_marc, 1);
1589 if (rec->wrbuf_iconv)
1590 wrbuf_free (rec->wrbuf_iconv, 1);
1591 if (rec->wrbuf_opac)
1592 wrbuf_free (rec->wrbuf_opac, 1);
1593 odr_destroy (rec->odr);
1597 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1599 const char *buf, int sz,
1600 const char *record_charset)
1605 yaz_marc_t mt = yaz_marc_create();
1608 strcpy(to, "UTF-8");
1609 if (record_charset && *record_charset)
1611 /* Use "from,to" or just "from" */
1612 const char *cp = strchr(record_charset, ',');
1613 int clen = strlen(record_charset);
1616 strncpy( to, cp+1, sizeof(to)-1);
1617 to[sizeof(to)-1] = '\0';
1618 clen = cp - record_charset;
1620 if (clen > sizeof(from)-1)
1621 clen = sizeof(from)-1;
1624 strncpy(from, record_charset, clen);
1630 cd = yaz_iconv_open(to, from);
1631 yaz_marc_iconv(mt, cd);
1634 yaz_marc_xml(mt, marc_type);
1635 if (!rec->wrbuf_marc)
1636 rec->wrbuf_marc = wrbuf_alloc();
1637 wrbuf_rewind (rec->wrbuf_marc);
1638 if (yaz_marc_decode_wrbuf (mt, buf, sz, rec->wrbuf_marc) > 0)
1640 yaz_marc_destroy(mt);
1642 yaz_iconv_close(cd);
1644 *len = wrbuf_len(rec->wrbuf_marc);
1645 return wrbuf_buf(rec->wrbuf_marc);
1647 yaz_marc_destroy(mt);
1649 yaz_iconv_close(cd);
1653 static const char *record_iconv_return(ZOOM_record rec, int *len,
1654 const char *buf, int sz,
1655 const char *record_charset)
1662 strcpy(to, "UTF-8");
1663 if (record_charset && *record_charset)
1665 /* Use "from,to" or just "from" */
1666 const char *cp = strchr(record_charset, ',');
1667 int clen = strlen(record_charset);
1670 strncpy( to, cp+1, sizeof(to)-1);
1671 to[sizeof(to)-1] = '\0';
1672 clen = cp - record_charset;
1674 if (clen > sizeof(from)-1)
1675 clen = sizeof(from)-1;
1678 strncpy(from, record_charset, clen);
1682 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1685 size_t inbytesleft = sz;
1686 const char *inp = buf;
1688 if (!rec->wrbuf_iconv)
1689 rec->wrbuf_iconv = wrbuf_alloc();
1691 wrbuf_rewind(rec->wrbuf_iconv);
1695 size_t outbytesleft = sizeof(outbuf);
1696 char *outp = outbuf;
1697 size_t r = yaz_iconv (cd, (char**) &inp,
1699 &outp, &outbytesleft);
1700 if (r == (size_t) (-1))
1702 int e = yaz_iconv_error(cd);
1703 if (e != YAZ_ICONV_E2BIG)
1706 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1708 wrbuf_puts(rec->wrbuf_iconv, "");
1709 buf = wrbuf_buf(rec->wrbuf_iconv);
1710 sz = wrbuf_len(rec->wrbuf_iconv);
1711 yaz_iconv_close(cd);
1718 ZOOM_API(const char *)
1719 ZOOM_record_get (ZOOM_record rec, const char *type_spec, int *len)
1726 Z_NamePlusRecord *npr;
1729 *len = 0; /* default return */
1738 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1740 if (cp[i] == ';' || cp[i] == ' ')
1746 while (type_spec[i] == ';')
1749 while (type_spec[i] == ' ')
1751 if (!strncmp(type_spec+i, "charset=", 8))
1754 i = i + 8; /* skip charset= */
1755 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1757 if (type_spec[i] == ';' || type_spec[i] == ' ')
1763 else if (!strncmp(type_spec+i, "xpath=", 6))
1767 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1771 while (type_spec[i] == ' ')
1774 if (!strcmp (type, "database"))
1777 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1778 return npr->databaseName;
1780 else if (!strcmp (type, "syntax"))
1782 const char *desc = 0;
1783 if (npr->which == Z_NamePlusRecord_databaseRecord)
1785 Z_External *r = (Z_External *) npr->u.databaseRecord;
1786 oident *ent = oid_getentbyoid(r->direct_reference);
1793 *len = strlen(desc);
1796 if (npr->which != Z_NamePlusRecord_databaseRecord)
1799 /* from now on - we have a database record .. */
1800 if (!strcmp (type, "render"))
1802 Z_External *r = (Z_External *) npr->u.databaseRecord;
1803 oident *ent = oid_getentbyoid(r->direct_reference);
1805 /* render bibliographic record .. */
1806 if (r->which == Z_External_OPAC)
1808 r = r->u.opac->bibliographicRecord;
1811 ent = oid_getentbyoid(r->direct_reference);
1813 if (r->which == Z_External_sutrs)
1814 return record_iconv_return(rec, len,
1815 (char*) r->u.sutrs->buf,
1818 else if (r->which == Z_External_octet)
1820 const char *ret_buf;
1828 case VAL_APPLICATION_XML:
1831 ret_buf = marc_iconv_return(
1832 rec, YAZ_MARC_LINE, len,
1833 (const char *) r->u.octet_aligned->buf,
1834 r->u.octet_aligned->len,
1839 return record_iconv_return(rec, len,
1840 (const char *) r->u.octet_aligned->buf,
1841 r->u.octet_aligned->len,
1844 else if (r->which == Z_External_grs1)
1846 if (!rec->wrbuf_marc)
1847 rec->wrbuf_marc = wrbuf_alloc();
1848 wrbuf_rewind (rec->wrbuf_marc);
1849 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1850 return record_iconv_return(rec, len,
1851 wrbuf_buf(rec->wrbuf_marc),
1852 wrbuf_len(rec->wrbuf_marc),
1857 else if (!strcmp (type, "xml") || !strcmp(type, "oai"))
1859 Z_External *r = (Z_External *) npr->u.databaseRecord;
1860 oident *ent = oid_getentbyoid(r->direct_reference);
1862 /* render bibliographic record .. */
1863 if (r->which == Z_External_OPAC)
1865 r = r->u.opac->bibliographicRecord;
1868 ent = oid_getentbyoid(r->direct_reference);
1871 if (r->which == Z_External_sutrs)
1872 return record_iconv_return(rec, len,
1873 (const char *) r->u.sutrs->buf,
1876 else if (r->which == Z_External_octet)
1878 const char *ret_buf;
1879 int marc_decode_type = YAZ_MARC_MARCXML;
1881 if (!strcmp(type, "oai"))
1882 marc_decode_type = YAZ_MARC_OAIMARC;
1890 case VAL_APPLICATION_XML:
1893 ret_buf = marc_iconv_return(
1894 rec, marc_decode_type, len,
1895 (const char *) r->u.octet_aligned->buf,
1896 r->u.octet_aligned->len,
1901 return record_iconv_return(rec, len,
1902 (const char *) r->u.octet_aligned->buf,
1903 r->u.octet_aligned->len,
1906 else if (r->which == Z_External_grs1)
1913 else if (!strcmp (type, "raw"))
1915 Z_External *r = (Z_External *) npr->u.databaseRecord;
1917 if (r->which == Z_External_sutrs)
1919 if (len) *len = r->u.sutrs->len;
1920 return (const char *) r->u.sutrs->buf;
1922 else if (r->which == Z_External_octet)
1924 if (len) *len = r->u.octet_aligned->len;
1925 return (const char *) r->u.octet_aligned->buf;
1927 else /* grs-1, explain, OPAC, ... */
1930 return (const char *) npr->u.databaseRecord;
1934 else if (!strcmp (type, "ext"))
1937 return (const char *) npr->u.databaseRecord;
1939 else if (!strcmp (type, "opac"))
1942 Z_External *r = (Z_External *) npr->u.databaseRecord;
1943 if (r->which == Z_External_OPAC)
1945 if (!rec->wrbuf_opac)
1946 rec->wrbuf_opac = wrbuf_alloc();
1947 wrbuf_rewind (rec->wrbuf_opac);
1948 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
1949 return record_iconv_return(rec, len,
1950 wrbuf_buf(rec->wrbuf_opac),
1951 wrbuf_len(rec->wrbuf_opac),
1958 static int strcmp_null(const char *v1, const char *v2)
1964 return strcmp(v1, v2);
1967 static void record_cache_add (ZOOM_resultset r, Z_NamePlusRecord *npr,
1970 ZOOM_record_cache rc;
1971 const char *elementSetName =
1972 ZOOM_resultset_option_get (r, "elementSetName");
1973 const char *syntax =
1974 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
1976 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1977 ZOOM_connection_put_event(r->connection, event);
1979 for (rc = r->record_cache; rc; rc = rc->next)
1983 if (strcmp_null(r->schema, rc->schema))
1985 if (strcmp_null(elementSetName,rc->elementSetName))
1987 if (strcmp_null(syntax, rc->syntax))
1989 /* not destroying rc->npr (it's handled by nmem )*/
1991 /* keeping wrbuf_marc too */
1995 rc = (ZOOM_record_cache) odr_malloc (r->odr, sizeof(*rc));
1998 rc->rec.wrbuf_marc = 0;
1999 rc->rec.wrbuf_iconv = 0;
2000 rc->rec.wrbuf_opac = 0;
2002 rc->elementSetName = odr_strdup (r->odr, elementSetName);
2004 rc->elementSetName = 0;
2007 rc->syntax = odr_strdup (r->odr, syntax);
2012 rc->schema = odr_strdup (r->odr, r->schema);
2017 rc->next = r->record_cache;
2018 r->record_cache = rc;
2021 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos)
2023 ZOOM_record_cache rc;
2024 const char *elementSetName =
2025 ZOOM_resultset_option_get (r, "elementSetName");
2026 const char *syntax =
2027 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
2029 for (rc = r->record_cache; rc; rc = rc->next)
2033 if (strcmp_null(r->schema, rc->schema))
2035 if (strcmp_null(elementSetName,rc->elementSetName))
2037 if (strcmp_null(syntax, rc->syntax))
2045 static void handle_records (ZOOM_connection c, Z_Records *sr,
2048 ZOOM_resultset resultset;
2052 switch (c->tasks->which)
2054 case ZOOM_TASK_SEARCH:
2055 resultset = c->tasks->u.search.resultset;
2057 case ZOOM_TASK_RETRIEVE:
2058 resultset = c->tasks->u.retrieve.resultset;
2063 if (sr && sr->which == Z_Records_NSD)
2064 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2065 else if (sr && sr->which == Z_Records_multipleNSD)
2067 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2068 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2070 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2074 if (resultset->count + resultset->start > resultset->size)
2075 resultset->count = resultset->size - resultset->start;
2076 if (resultset->count < 0)
2077 resultset->count = 0;
2078 if (sr && sr->which == Z_Records_DBOSD)
2081 NMEM nmem = odr_extract_mem (c->odr_in);
2082 Z_NamePlusRecordList *p =
2083 sr->u.databaseOrSurDiagnostics;
2084 for (i = 0; i<p->num_records; i++)
2086 record_cache_add (resultset, p->records[i],
2087 i+ resultset->start);
2089 /* transfer our response to search_nmem .. we need it later */
2090 nmem_transfer (resultset->odr->mem, nmem);
2091 nmem_destroy (nmem);
2092 if (present_phase && p->num_records == 0)
2094 /* present response and we didn't get any records! */
2095 Z_NamePlusRecord *myrec =
2096 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2097 record_cache_add(resultset, myrec, resultset->start);
2100 else if (present_phase)
2102 /* present response and we didn't get any records! */
2103 Z_NamePlusRecord *myrec =
2104 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2105 record_cache_add(resultset, myrec, resultset->start);
2110 static void handle_present_response (ZOOM_connection c, Z_PresentResponse *pr)
2112 handle_records (c, pr->records, 1);
2115 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2118 switch (term->which)
2120 case Z_Term_general:
2121 ZOOM_options_setl(opt, name,
2122 (const char *)(term->u.general->buf),
2123 term->u.general->len);
2125 case Z_Term_characterString:
2126 ZOOM_options_set(opt, name, term->u.characterString);
2128 case Z_Term_numeric:
2129 ZOOM_options_set_int(opt, name, *term->u.numeric);
2134 static void handle_queryExpression(ZOOM_options opt, const char *name,
2135 Z_QueryExpression *exp)
2141 case Z_QueryExpression_term:
2142 if (exp->u.term && exp->u.term->queryTerm)
2144 sprintf(opt_name, "%s.term", name);
2145 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2148 case Z_QueryExpression_query:
2153 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2154 Z_OtherInformation *o)
2157 for (i = 0; o && i < o->num_elements; i++)
2159 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2161 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2163 if (ext->which == Z_External_searchResult1)
2166 Z_SearchInfoReport *sr = ext->u.searchResult1;
2169 ZOOM_options_set_int(
2170 resultset->options, "searchresult.size", sr->num);
2172 for (j = 0; j < sr->num; j++)
2174 Z_SearchInfoReport_s *ent =
2175 ext->u.searchResult1->elements[j];
2178 sprintf(pref, "searchresult.%d", j);
2180 if (ent->subqueryId)
2183 sprintf(opt_name, "%s.id", pref);
2184 ZOOM_options_set(resultset->options, opt_name,
2187 if (ent->subqueryExpression)
2190 sprintf(opt_name, "%s.subquery", pref);
2191 handle_queryExpression(resultset->options, opt_name,
2192 ent->subqueryExpression);
2194 if (ent->subqueryInterpretation)
2197 sprintf(opt_name, "%s.interpretation", pref);
2198 handle_queryExpression(resultset->options, opt_name,
2199 ent->subqueryInterpretation);
2201 if (ent->subqueryRecommendation)
2204 sprintf(opt_name, "%s.recommendation", pref);
2205 handle_queryExpression(resultset->options, opt_name,
2206 ent->subqueryRecommendation);
2208 if (ent->subqueryCount)
2211 sprintf(opt_name, "%s.count", pref);
2212 ZOOM_options_set_int(resultset->options, opt_name,
2213 *ent->subqueryCount);
2221 static void handle_search_response (ZOOM_connection c, Z_SearchResponse *sr)
2223 ZOOM_resultset resultset;
2226 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2229 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2230 ZOOM_connection_put_event(c, event);
2232 resultset = c->tasks->u.search.resultset;
2234 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2236 resultset->size = *sr->resultCount;
2237 handle_records (c, sr->records, 0);
2240 static void sort_response (ZOOM_connection c, Z_SortResponse *res)
2242 if (res->diagnostics && res->num_diagnostics > 0)
2243 response_diag (c, res->diagnostics[0]);
2246 static int scan_response (ZOOM_connection c, Z_ScanResponse *res)
2248 NMEM nmem = odr_extract_mem (c->odr_in);
2251 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2253 scan = c->tasks->u.scan.scan;
2255 if (res->entries && res->entries->nonsurrogateDiagnostics)
2256 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2257 scan->scan_response = res;
2258 nmem_transfer (scan->odr->mem, nmem);
2260 ZOOM_options_set_int (scan->options, "stepSize", *res->stepSize);
2261 if (res->positionOfTerm)
2262 ZOOM_options_set_int (scan->options, "position", *res->positionOfTerm);
2263 if (res->scanStatus)
2264 ZOOM_options_set_int (scan->options, "scanStatus", *res->scanStatus);
2265 if (res->numberOfEntriesReturned)
2266 ZOOM_options_set_int (scan->options, "number",
2267 *res->numberOfEntriesReturned);
2268 nmem_destroy (nmem);
2272 static zoom_ret send_sort (ZOOM_connection c,
2273 ZOOM_resultset resultset)
2276 resultset->r_sort_spec = 0;
2277 if (resultset->r_sort_spec)
2279 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2280 Z_SortRequest *req = apdu->u.sortRequest;
2282 req->num_inputResultSetNames = 1;
2283 req->inputResultSetNames = (Z_InternationalString **)
2284 odr_malloc (c->odr_out, sizeof(*req->inputResultSetNames));
2285 req->inputResultSetNames[0] =
2286 odr_strdup (c->odr_out, resultset->setname);
2287 req->sortedResultSetName = odr_strdup (c->odr_out, resultset->setname);
2288 req->sortSequence = resultset->r_sort_spec;
2289 resultset->r_sort_spec = 0;
2290 return send_APDU (c, apdu);
2292 return zoom_complete;
2295 static zoom_ret send_present(ZOOM_connection c)
2298 Z_PresentRequest *req = 0;
2300 const char *syntax = 0;
2301 const char *elementSetName = 0;
2302 ZOOM_resultset resultset;
2306 yaz_log(log_details, "%p send_present no tasks", c);
2307 return zoom_complete;
2309 switch (c->tasks->which)
2311 case ZOOM_TASK_SEARCH:
2312 resultset = c->tasks->u.search.resultset;
2314 case ZOOM_TASK_RETRIEVE:
2315 resultset = c->tasks->u.retrieve.resultset;
2316 resultset->start = c->tasks->u.retrieve.start;
2317 resultset->count = c->tasks->u.retrieve.count;
2319 if (resultset->start >= resultset->size)
2321 yaz_log(log_details, "%p send_present start=%d >= size=%d",
2322 c, resultset->start, resultset->size);
2323 return zoom_complete;
2325 if (resultset->start + resultset->count > resultset->size)
2326 resultset->count = resultset->size - resultset->start;
2329 return zoom_complete;
2331 yaz_log(log_details, "%p send_present start=%d count=%d",
2332 c, resultset->start, resultset->count);
2334 syntax = ZOOM_resultset_option_get (resultset, "preferredRecordSyntax");
2335 elementSetName = ZOOM_resultset_option_get (resultset, "elementSetName");
2337 if (c->error) /* don't continue on error */
2338 return zoom_complete;
2339 if (resultset->start < 0)
2340 return zoom_complete;
2341 for (i = 0; i<resultset->count; i++)
2344 record_cache_lookup (resultset, i + resultset->start);
2348 if (i == resultset->count)
2350 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2351 return zoom_complete;
2354 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2355 req = apdu->u.presentRequest;
2357 resultset->start += i;
2358 resultset->count -= i;
2361 yaz_log(log_details, "%p send_present skip=%d", c, i);
2363 *req->resultSetStartPoint = resultset->start + 1;
2364 *req->numberOfRecordsRequested = resultset->step>0 ?
2365 resultset->step : resultset->count;
2366 assert (*req->numberOfRecordsRequested > 0);
2369 if (syntax && *syntax)
2370 req->preferredRecordSyntax =
2371 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
2373 if (resultset->schema && *resultset->schema)
2375 Z_RecordComposition *compo = (Z_RecordComposition *)
2376 odr_malloc (c->odr_out, sizeof(*compo));
2378 req->recordComposition = compo;
2379 compo->which = Z_RecordComp_complex;
2380 compo->u.complex = (Z_CompSpec *)
2381 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2382 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2383 odr_malloc(c->odr_out, sizeof(bool_t));
2384 *compo->u.complex->selectAlternativeSyntax = 0;
2386 compo->u.complex->generic = (Z_Specification *)
2387 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2389 compo->u.complex->generic->which = Z_Schema_oid;
2390 compo->u.complex->generic->schema.oid = (Odr_oid *)
2391 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2393 if (!compo->u.complex->generic->schema.oid)
2395 /* OID wasn't a schema! Try record syntax instead. */
2397 compo->u.complex->generic->schema.oid = (Odr_oid *)
2398 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2400 if (elementSetName && *elementSetName)
2402 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2403 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2404 compo->u.complex->generic->elementSpec->which =
2405 Z_ElementSpec_elementSetName;
2406 compo->u.complex->generic->elementSpec->u.elementSetName =
2407 odr_strdup (c->odr_out, elementSetName);
2410 compo->u.complex->generic->elementSpec = 0;
2411 compo->u.complex->num_dbSpecific = 0;
2412 compo->u.complex->dbSpecific = 0;
2413 compo->u.complex->num_recordSyntax = 0;
2414 compo->u.complex->recordSyntax = 0;
2416 else if (elementSetName && *elementSetName)
2418 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2419 odr_malloc (c->odr_out, sizeof(*esn));
2420 Z_RecordComposition *compo = (Z_RecordComposition *)
2421 odr_malloc (c->odr_out, sizeof(*compo));
2423 esn->which = Z_ElementSetNames_generic;
2424 esn->u.generic = odr_strdup (c->odr_out, elementSetName);
2425 compo->which = Z_RecordComp_simple;
2426 compo->u.simple = esn;
2427 req->recordComposition = compo;
2429 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2430 return send_APDU (c, apdu);
2433 ZOOM_API(ZOOM_scanset)
2434 ZOOM_connection_scan (ZOOM_connection c, const char *start)
2437 ZOOM_query q = ZOOM_query_create();
2439 ZOOM_query_prefix (q, start);
2441 s = ZOOM_connection_scan1(c, q);
2442 ZOOM_query_destroy (q);
2447 ZOOM_API(ZOOM_scanset)
2448 ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query q)
2450 ZOOM_scanset scan = (ZOOM_scanset) xmalloc (sizeof(*scan));
2454 scan->connection = c;
2455 scan->odr = odr_createmem (ODR_DECODE);
2456 scan->options = ZOOM_options_create_with_parent (c->options);
2458 scan->scan_response = 0;
2461 * We need to check the query-type, so we can recognise CQL and
2462 * compile it into a form that we can use here. The ZOOM_query
2463 * structure has no explicit `type' member, but inspection of the
2464 * ZOOM_query_prefix() and ZOOM_query_cql() functions shows how
2465 * the structure is set up in each case.
2468 if (q->z_query->which == Z_Query_type_1) {
2469 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2470 c, q, q->query_string);
2471 start = q->query_string;
2472 } else if (q->z_query->which == Z_Query_type_104) {
2473 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2474 c, q, q->query_string);
2475 start = freeme = cql2pqf(c, q->query_string);
2479 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2480 c, q, q->query_string);
2484 scan->termListAndStartPoint =
2485 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2487 if (scan->termListAndStartPoint != 0)
2489 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_SCAN);
2490 task->u.scan.scan = scan;
2495 while (ZOOM_event (1, &c))
2503 ZOOM_scanset_destroy (ZOOM_scanset scan)
2508 if (scan->refcount == 0)
2510 odr_destroy (scan->odr);
2512 ZOOM_options_destroy (scan->options);
2517 static zoom_ret send_package (ZOOM_connection c)
2521 yaz_log(log_details, "%p send_package", c);
2523 return zoom_complete;
2524 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2526 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
2527 ZOOM_connection_put_event (c, event);
2529 return do_write_ex (c, c->tasks->u.package->buf_out,
2530 c->tasks->u.package->len_out);
2533 static zoom_ret send_scan (ZOOM_connection c)
2536 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2537 Z_ScanRequest *req = apdu->u.scanRequest;
2539 yaz_log(log_details, "%p send_scan", c);
2541 return zoom_complete;
2542 assert (c->tasks->which == ZOOM_TASK_SCAN);
2543 scan = c->tasks->u.scan.scan;
2545 req->termListAndStartPoint = scan->termListAndStartPoint;
2546 req->attributeSet = scan->attributeSet;
2548 *req->numberOfTermsRequested =
2549 ZOOM_options_get_int(scan->options, "number", 10);
2551 req->preferredPositionInResponse =
2552 odr_intdup (c->odr_out,
2553 ZOOM_options_get_int(scan->options, "position", 1));
2556 odr_intdup (c->odr_out,
2557 ZOOM_options_get_int(scan->options, "stepSize", 0));
2559 req->databaseNames = set_DatabaseNames (c, scan->options,
2560 &req->num_databaseNames);
2562 return send_APDU (c, apdu);
2566 ZOOM_scanset_size (ZOOM_scanset scan)
2568 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2570 return scan->scan_response->entries->num_entries;
2573 ZOOM_API(const char *)
2574 ZOOM_scanset_term (ZOOM_scanset scan, size_t pos,
2577 const char *term = 0;
2578 size_t noent = ZOOM_scanset_size (scan);
2579 Z_ScanResponse *res = scan->scan_response;
2585 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2587 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2589 if (t->term->which == Z_Term_general)
2591 term = (const char *) t->term->u.general->buf;
2592 *len = t->term->u.general->len;
2594 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2599 ZOOM_API(const char *)
2600 ZOOM_scanset_display_term (ZOOM_scanset scan, size_t pos,
2603 const char *term = 0;
2604 size_t noent = ZOOM_scanset_size (scan);
2605 Z_ScanResponse *res = scan->scan_response;
2611 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2613 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2617 term = t->displayTerm;
2618 *len = strlen(term);
2620 else if (t->term->which == Z_Term_general)
2622 term = (const char *) t->term->u.general->buf;
2623 *len = t->term->u.general->len;
2625 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2630 ZOOM_API(const char *)
2631 ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key)
2633 return ZOOM_options_get (scan->options, key);
2637 ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
2640 ZOOM_options_set (scan->options, key, val);
2643 static Z_APDU *create_es_package (ZOOM_package p, int type)
2646 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2647 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2649 *req->function = Z_ExtendedServicesRequest_create;
2651 str = ZOOM_options_get(p->options, "package-name");
2653 req->packageName = nmem_strdup (p->odr_out->mem, str);
2655 str = ZOOM_options_get(p->options, "user-id");
2657 req->userId = nmem_strdup (p->odr_out->mem, str);
2659 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2662 str = ZOOM_options_get(p->options, "function");
2665 if (!strcmp (str, "create"))
2667 if (!strcmp (str, "delete"))
2669 if (!strcmp (str, "modify"))
2675 static const char *ill_array_lookup (void *clientData, const char *idx)
2677 ZOOM_package p = (ZOOM_package) clientData;
2678 return ZOOM_options_get (p->options, idx+4);
2681 static Z_External *encode_ill_request (ZOOM_package p)
2683 ODR out = p->odr_out;
2686 struct ill_get_ctl ctl;
2688 ctl.odr = p->odr_out;
2690 ctl.f = ill_array_lookup;
2692 req = ill_get_ILLRequest(&ctl, "ill", 0);
2694 if (!ill_Request (out, &req, 0, 0))
2696 int ill_request_size;
2697 char *ill_request_buf = odr_getbuf (out, &ill_request_size, 0);
2698 if (ill_request_buf)
2699 odr_setbuf (out, ill_request_buf, ill_request_size, 1);
2705 int illRequest_size = 0;
2706 char *illRequest_buf = odr_getbuf (out, &illRequest_size, 0);
2708 oid.proto = PROTO_GENERAL;
2709 oid.oclass = CLASS_GENERAL;
2710 oid.value = VAL_ISO_ILL_1;
2712 r = (Z_External *) odr_malloc (out, sizeof(*r));
2713 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2714 r->indirect_reference = 0;
2716 r->which = Z_External_single;
2718 r->u.single_ASN1_type = (Odr_oct *)
2719 odr_malloc (out, sizeof(*r->u.single_ASN1_type));
2720 r->u.single_ASN1_type->buf = (unsigned char*)
2721 odr_malloc (out, illRequest_size);
2722 r->u.single_ASN1_type->len = illRequest_size;
2723 r->u.single_ASN1_type->size = illRequest_size;
2724 memcpy (r->u.single_ASN1_type->buf, illRequest_buf, illRequest_size);
2729 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2731 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc (p->odr_out, sizeof(*req));
2734 req->which = Z_IOItemOrder_esRequest;
2735 req->u.esRequest = (Z_IORequest *)
2736 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2738 /* to keep part ... */
2739 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2740 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2741 req->u.esRequest->toKeep->supplDescription = 0;
2742 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2743 odr_malloc (p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2745 str = ZOOM_options_get(p->options, "contact-name");
2746 req->u.esRequest->toKeep->contact->name = str ?
2747 nmem_strdup (p->odr_out->mem, str) : 0;
2749 str = ZOOM_options_get(p->options, "contact-phone");
2750 req->u.esRequest->toKeep->contact->phone = str ?
2751 nmem_strdup (p->odr_out->mem, str) : 0;
2753 str = ZOOM_options_get(p->options, "contact-email");
2754 req->u.esRequest->toKeep->contact->email = str ?
2755 nmem_strdup (p->odr_out->mem, str) : 0;
2757 req->u.esRequest->toKeep->addlBilling = 0;
2759 /* not to keep part ... */
2760 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2761 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2763 str = ZOOM_options_get(p->options, "itemorder-setname");
2768 req->u.esRequest->notToKeep->resultSetItem = 0;
2771 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2772 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2774 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2775 nmem_strdup (p->odr_out->mem, str);
2776 req->u.esRequest->notToKeep->resultSetItem->item =
2777 (int *) odr_malloc(p->odr_out, sizeof(int));
2779 str = ZOOM_options_get(p->options, "itemorder-item");
2780 *req->u.esRequest->notToKeep->resultSetItem->item =
2781 (str ? atoi(str) : 1);
2783 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2788 Z_APDU *create_admin_package(ZOOM_package p, int type,
2789 Z_ESAdminOriginPartToKeep **toKeepP,
2790 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2792 Z_APDU *apdu = create_es_package (p, VAL_ADMINSERVICE);
2795 Z_ESAdminOriginPartToKeep *toKeep;
2796 Z_ESAdminOriginPartNotToKeep *notToKeep;
2797 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2798 const char *first_db = "Default";
2800 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2804 r->direct_reference =
2805 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2808 r->indirect_reference = 0;
2809 r->which = Z_External_ESAdmin;
2811 r->u.adminService = (Z_Admin *)
2812 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2813 r->u.adminService->which = Z_Admin_esRequest;
2814 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2815 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2817 toKeep = r->u.adminService->u.esRequest->toKeep =
2818 (Z_ESAdminOriginPartToKeep *)
2819 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2820 toKeep->which = type;
2821 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2822 toKeep->u.create = odr_nullval();
2823 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2825 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2826 (Z_ESAdminOriginPartNotToKeep *)
2827 odr_malloc(p->odr_out,
2828 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2829 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
2830 notToKeep->u.recordsWillFollow = odr_nullval();
2834 *notToKeepP = notToKeep;
2839 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
2841 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
2842 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2843 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
2844 const char *doc = ZOOM_options_get(p->options, "doc");
2846 req->taskSpecificParameters = ext;
2847 ext->direct_reference = req->packageType;
2848 ext->descriptor = 0;
2849 ext->indirect_reference = 0;
2851 ext->which = Z_External_octet;
2852 ext->u.single_ASN1_type = (Odr_oct *)
2853 odr_malloc (p->odr_out, sizeof(Odr_oct));
2857 ext->u.single_ASN1_type->buf = (unsigned char*)
2858 odr_strdup(p->odr_out, doc);
2859 ext->u.single_ASN1_type->size = ext->u.single_ASN1_type->len = strlen(doc);
2863 static Z_APDU *create_update_package(ZOOM_package p)
2866 const char *first_db = "Default";
2868 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2869 const char *action = ZOOM_options_get(p->options, "action");
2870 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
2871 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
2872 const char *record_buf = ZOOM_options_get(p->options, "record");
2873 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
2874 int syntax_oid = VAL_NONE;
2878 syntax_oid = oid_getvalbyname(syntax_str);
2881 record_buf = "void";
2882 syntax_oid = VAL_SUTRS;
2884 if (syntax_oid == VAL_NONE)
2885 syntax_oid = VAL_TEXT_XML;
2891 action = "specialUpdate";
2893 if (!strcmp(action, "recordInsert"))
2894 action_no = Z_IUOriginPartToKeep_recordInsert;
2895 else if (!strcmp(action, "recordReplace"))
2896 action_no = Z_IUOriginPartToKeep_recordReplace;
2897 else if (!strcmp(action, "recordDelete"))
2898 action_no = Z_IUOriginPartToKeep_recordDelete;
2899 else if (!strcmp(action, "elementUpdate"))
2900 action_no = Z_IUOriginPartToKeep_elementUpdate;
2901 else if (!strcmp(action, "specialUpdate"))
2902 action_no = Z_IUOriginPartToKeep_specialUpdate;
2906 apdu = create_es_package (p, VAL_DBUPDATE);
2909 Z_IUOriginPartToKeep *toKeep;
2910 Z_IUSuppliedRecords *notToKeep;
2911 Z_External *r = (Z_External *)
2912 odr_malloc (p->odr_out, sizeof(*r));
2914 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2916 r->direct_reference =
2917 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2920 r->which = Z_External_update;
2921 r->indirect_reference = 0;
2922 r->u.update = (Z_IUUpdate *)
2923 odr_malloc(p->odr_out, sizeof(*r->u.update));
2925 r->u.update->which = Z_IUUpdate_esRequest;
2926 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
2927 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
2928 toKeep = r->u.update->u.esRequest->toKeep =
2929 (Z_IUOriginPartToKeep *)
2930 odr_malloc(p->odr_out, sizeof(*toKeep));
2932 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2934 toKeep->elementSetName = 0;
2935 toKeep->actionQualifier = 0;
2936 toKeep->action = odr_intdup(p->odr_out, action_no);
2938 notToKeep = r->u.update->u.esRequest->notToKeep =
2939 (Z_IUSuppliedRecords *)
2940 odr_malloc(p->odr_out, sizeof(*notToKeep));
2942 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
2943 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
2944 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
2945 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
2946 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
2949 notToKeep->elements[0]->u.opaque = (Odr_oct *)
2950 odr_malloc (p->odr_out, sizeof(Odr_oct));
2951 notToKeep->elements[0]->u.opaque->size =
2952 notToKeep->elements[0]->u.opaque->len = strlen(recordIdOpaque);
2953 notToKeep->elements[0]->u.opaque->buf = (unsigned char*)
2954 odr_strdup(p->odr_out, recordIdOpaque);
2956 else if (recordIdNumber)
2958 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
2960 notToKeep->elements[0]->u.number =
2961 odr_intdup(p->odr_out, atoi(recordIdNumber));
2964 notToKeep->elements[0]->u.opaque = 0;
2965 notToKeep->elements[0]->supplementalId = 0;
2966 notToKeep->elements[0]->correlationInfo = 0;
2967 notToKeep->elements[0]->record =
2968 z_ext_record(p->odr_out, syntax_oid,
2969 record_buf, strlen(record_buf));
2973 ODR print = odr_createmem(ODR_PRINT);
2975 z_APDU(print, &apdu, 0, 0);
2982 ZOOM_package_send (ZOOM_package p, const char *type)
2989 odr_reset (p->odr_out);
2992 if (!strcmp(type, "itemorder"))
2994 apdu = create_es_package (p, VAL_ITEMORDER);
2997 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2999 r->direct_reference =
3000 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3003 r->which = Z_External_itemOrder;
3004 r->indirect_reference = 0;
3005 r->u.itemOrder = encode_item_order (p);
3007 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3010 else if (!strcmp(type, "create")) /* create database */
3012 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3015 else if (!strcmp(type, "drop")) /* drop database */
3017 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3020 else if (!strcmp(type, "commit")) /* commit changes */
3022 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3025 else if (!strcmp(type, "update")) /* update record(s) */
3027 apdu = create_update_package(p);
3029 else if (!strcmp(type, "xmlupdate"))
3031 apdu = create_xmlupdate_package(p);
3035 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3039 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_PACKAGE);
3040 task->u.package = p;
3041 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3042 p->buf_out = (char *) xmalloc (p->len_out);
3043 memcpy (p->buf_out, buf, p->len_out);
3048 while (ZOOM_event (1, &c))
3055 ZOOM_API(ZOOM_package)
3056 ZOOM_connection_package (ZOOM_connection c, ZOOM_options options)
3058 ZOOM_package p = (ZOOM_package) xmalloc (sizeof(*p));
3061 p->odr_out = odr_createmem (ODR_ENCODE);
3062 p->options = ZOOM_options_create_with_parent2 (options, c->options);
3070 ZOOM_package_destroy(ZOOM_package p)
3075 if (p->refcount == 0)
3077 odr_destroy (p->odr_out);
3080 ZOOM_options_destroy (p->options);
3085 ZOOM_API(const char *)
3086 ZOOM_package_option_get (ZOOM_package p, const char *key)
3088 return ZOOM_options_get (p->options, key);
3093 ZOOM_package_option_set (ZOOM_package p, const char *key,
3096 ZOOM_options_set (p->options, key, val);
3099 static int ZOOM_connection_exec_task (ZOOM_connection c)
3101 ZOOM_task task = c->tasks;
3102 zoom_ret ret = zoom_complete;
3106 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3107 c, task->which, task->running);
3108 if (c->error != ZOOM_ERROR_NONE)
3110 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3111 "removing tasks because of error = %d", c, c->error);
3112 ZOOM_connection_remove_tasks (c);
3117 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3118 "task already running", c);
3122 ret = zoom_complete;
3123 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3125 switch (task->which)
3127 case ZOOM_TASK_SEARCH:
3128 if (c->proto == PROTO_HTTP)
3129 ret = ZOOM_connection_srw_send_search(c);
3131 ret = ZOOM_connection_send_search(c);
3133 case ZOOM_TASK_RETRIEVE:
3134 if (c->proto == PROTO_HTTP)
3135 ret = ZOOM_connection_srw_send_search(c);
3137 ret = send_present (c);
3139 case ZOOM_TASK_CONNECT:
3140 ret = do_connect(c);
3142 case ZOOM_TASK_SCAN:
3145 case ZOOM_TASK_PACKAGE:
3146 ret = send_package(c);
3148 case ZOOM_TASK_SORT:
3149 c->tasks->u.sort.resultset->r_sort_spec =
3150 c->tasks->u.sort.q->sort_spec;
3151 ret = send_sort(c, c->tasks->u.sort.resultset);
3157 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3158 "remove tasks because no connection exist", c);
3159 ZOOM_connection_remove_tasks (c);
3161 if (ret == zoom_complete)
3163 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3164 "task removed (complete)", c);
3165 ZOOM_connection_remove_task (c);
3168 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3173 static zoom_ret send_sort_present (ZOOM_connection c)
3175 zoom_ret r = zoom_complete;
3177 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3178 r = send_sort (c, c->tasks->u.search.resultset);
3179 if (r == zoom_complete)
3180 r = send_present (c);
3184 static int es_response (ZOOM_connection c,
3185 Z_ExtendedServicesResponse *res)
3187 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3189 if (res->diagnostics && res->num_diagnostics > 0)
3190 response_diag(c, res->diagnostics[0]);
3191 if (res->taskPackage &&
3192 res->taskPackage->which == Z_External_extendedService)
3194 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3195 Odr_oct *id = taskPackage->targetReference;
3198 ZOOM_options_setl (c->tasks->u.package->options,
3199 "targetReference", (char*) id->buf, id->len);
3201 if (res->taskPackage &&
3202 res->taskPackage->which == Z_External_octet)
3204 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3205 ZOOM_options_setl (c->tasks->u.package->options,
3206 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3211 static void interpret_init_diag(ZOOM_connection c,
3212 Z_DiagnosticFormat *diag)
3216 Z_DiagnosticFormat_s *ds = diag->elements[0];
3217 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3218 response_default_diag(c, ds->u.defaultDiagRec);
3223 static void interpret_otherinformation_field(ZOOM_connection c,
3224 Z_OtherInformation *ui)
3227 for (i = 0; i < ui->num_elements; i++)
3229 Z_OtherInformationUnit *unit = ui->list[i];
3230 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3231 unit->information.externallyDefinedInfo &&
3232 unit->information.externallyDefinedInfo->which ==
3235 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3240 static void recv_apdu (ZOOM_connection c, Z_APDU *apdu)
3242 Z_InitResponse *initrs;
3245 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3248 case Z_APDU_initResponse:
3249 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3250 initrs = apdu->u.initResponse;
3251 ZOOM_connection_option_set(c, "serverImplementationId",
3252 initrs->implementationId ?
3253 initrs->implementationId : "");
3254 ZOOM_connection_option_set(c, "serverImplementationName",
3255 initrs->implementationName ?
3256 initrs->implementationName : "");
3257 ZOOM_connection_option_set(c, "serverImplementationVersion",
3258 initrs->implementationVersion ?
3259 initrs->implementationVersion : "");
3260 /* Set the three old options too, for old applications */
3261 ZOOM_connection_option_set(c, "targetImplementationId",
3262 initrs->implementationId ?
3263 initrs->implementationId : "");
3264 ZOOM_connection_option_set(c, "targetImplementationName",
3265 initrs->implementationName ?
3266 initrs->implementationName : "");
3267 ZOOM_connection_option_set(c, "targetImplementationVersion",
3268 initrs->implementationVersion ?
3269 initrs->implementationVersion : "");
3270 if (!*initrs->result)
3272 Z_External *uif = initrs->userInformationField;
3274 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3276 if (uif && uif->which == Z_External_userInfo1)
3277 interpret_otherinformation_field(c, uif->u.userInfo1);
3282 yaz_oi_get_string_oidval (&apdu->u.initResponse->otherInfo,
3284 xfree (c->cookie_in);
3287 c->cookie_in = xstrdup(cookie);
3288 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3289 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3290 c->support_named_resultsets = 1;
3293 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3294 ZOOM_connection_remove_task (c);
3296 ZOOM_connection_exec_task (c);
3298 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3300 NMEM tmpmem = nmem_create();
3301 Z_CharSetandLanguageNegotiation *p =
3302 yaz_get_charneg_record(initrs->otherInfo);
3306 char *charset = NULL, *lang = NULL;
3309 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3310 yaz_log(log_details, "%p recv_apdu target accepted: "
3311 "charset %s, language %s, select %d",
3313 charset ? charset : "none", lang ? lang : "none", sel);
3315 ZOOM_connection_option_set (c, "negotiation-charset",
3318 ZOOM_connection_option_set (c, "negotiation-lang",
3321 ZOOM_connection_option_set (
3322 c, "negotiation-charset-in-effect-for-records",
3323 (sel != 0) ? "1" : "0");
3324 nmem_destroy(tmpmem);
3328 case Z_APDU_searchResponse:
3329 yaz_log(log_api, "%p recv_apdu Search response", c);
3330 handle_search_response (c, apdu->u.searchResponse);
3331 if (send_sort_present (c) == zoom_complete)
3332 ZOOM_connection_remove_task (c);
3334 case Z_APDU_presentResponse:
3335 yaz_log(log_api, "%p recv_apdu Present response", c);
3336 handle_present_response (c, apdu->u.presentResponse);
3337 if (send_present (c) == zoom_complete)
3338 ZOOM_connection_remove_task (c);
3340 case Z_APDU_sortResponse:
3341 yaz_log(log_api, "%p recv_apdu Sort response", c);
3342 sort_response (c, apdu->u.sortResponse);
3343 if (send_present (c) == zoom_complete)
3344 ZOOM_connection_remove_task (c);
3346 case Z_APDU_scanResponse:
3347 yaz_log(log_api, "%p recv_apdu Scan response", c);
3348 scan_response (c, apdu->u.scanResponse);
3349 ZOOM_connection_remove_task (c);
3351 case Z_APDU_extendedServicesResponse:
3352 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3353 es_response (c, apdu->u.extendedServicesResponse);
3354 ZOOM_connection_remove_task (c);
3357 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3358 if (c->reconnect_ok)
3361 c->tasks->running = 0;
3362 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3366 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3371 yaz_log(log_api, "%p Received unknown PDU", c);
3372 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3378 static void handle_srw_response(ZOOM_connection c,
3379 Z_SRW_searchRetrieveResponse *res)
3381 ZOOM_resultset resultset = 0;
3389 if (c->tasks->which == ZOOM_TASK_SEARCH)
3390 resultset = c->tasks->u.search.resultset;
3391 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
3392 resultset = c->tasks->u.retrieve.resultset;
3396 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3397 ZOOM_connection_put_event(c, event);
3399 resultset->size = 0;
3401 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3403 if (res->numberOfRecords)
3404 resultset->size = *res->numberOfRecords;
3406 for (i = 0; i<res->num_records; i++)
3410 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3411 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3413 if (res->records[i].recordPosition &&
3414 *res->records[i].recordPosition > 0)
3415 pos = *res->records[i].recordPosition - 1;
3417 pos = resultset->start + i;
3419 npr->databaseName = 0;
3420 npr->which = Z_NamePlusRecord_databaseRecord;
3421 npr->u.databaseRecord = (Z_External *)
3422 odr_malloc(c->odr_in, sizeof(Z_External));
3423 npr->u.databaseRecord->descriptor = 0;
3424 npr->u.databaseRecord->direct_reference =
3425 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3426 npr->u.databaseRecord->which = Z_External_octet;
3427 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3428 odr_malloc(c->odr_in, sizeof(Odr_oct));
3429 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3430 res->records[i].recordData_buf;
3431 npr->u.databaseRecord->u.octet_aligned->len =
3432 npr->u.databaseRecord->u.octet_aligned->size =
3433 res->records[i].recordData_len;
3434 record_cache_add (resultset, npr, pos);
3436 if (res->num_diagnostics > 0)
3438 const char *uri = res->diagnostics[0].uri;
3443 if ((cp = strrchr(uri, '/')))
3445 set_dset_error(c, code, uri,
3446 res->diagnostics[0].details, 0);
3449 nmem = odr_extract_mem(c->odr_in);
3450 nmem_transfer(resultset->odr->mem, nmem);
3456 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3459 const char *content_type = z_HTTP_header_lookup(hres->headers,
3461 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3464 yaz_log(log_details, "%p handle_http", c);
3466 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3468 Z_SOAP *soap_package = 0;
3470 Z_SOAP_Handler soap_handlers[2] = {
3471 {"http://www.loc.gov/zing/srw/", 0,
3472 (Z_SOAP_fun) yaz_srw_codec},
3475 ret = z_soap_codec(o, &soap_package,
3476 &hres->content_buf, &hres->content_len,
3478 if (!ret && soap_package->which == Z_SOAP_generic &&
3479 soap_package->u.generic->no == 0)
3481 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3482 if (sr->which == Z_SRW_searchRetrieve_response)
3483 handle_srw_response(c, sr->u.response);
3487 else if (!ret && (soap_package->which == Z_SOAP_fault
3488 || soap_package->which == Z_SOAP_error))
3490 set_HTTP_error(c, hres->code,
3491 soap_package->u.fault->fault_code,
3492 soap_package->u.fault->fault_string);
3499 if (hres->code != 200)
3500 set_HTTP_error(c, hres->code, 0, 0);
3502 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3505 ZOOM_connection_remove_task(c);
3506 if (!strcmp(hres->version, "1.0"))
3508 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3509 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3514 /* HTTP 1.1: only if no close we stay alive .. */
3515 if (connection_head && !strcmp(connection_head, "close"))
3521 static int do_read (ZOOM_connection c)
3526 event = ZOOM_Event_create (ZOOM_EVENT_RECV_DATA);
3527 ZOOM_connection_put_event (c, event);
3529 r = cs_get (c->cs, &c->buf_in, &c->len_in);
3530 more = cs_more(c->cs);
3531 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3536 if (c->reconnect_ok)
3539 c->reconnect_ok = 0;
3540 yaz_log(log_details, "%p do_read reconnect read", c);
3541 c->tasks->running = 0;
3542 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3546 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3555 odr_reset (c->odr_in);
3556 odr_setbuf (c->odr_in, c->buf_in, r, 0);
3557 event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);
3558 ZOOM_connection_put_event (c, event);
3560 if (!z_GDU (c->odr_in, &gdu, 0, 0))
3563 int err = odr_geterrorx(c->odr_in, &x);
3565 const char *element = odr_getelement(c->odr_in);
3566 sprintf (msg, "ODR code %d:%d element=%-20s",
3567 err, x, element ? element : "<unknown>");
3568 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3571 else if (gdu->which == Z_GDU_Z3950)
3572 recv_apdu (c, gdu->u.z3950);
3573 else if (gdu->which == Z_GDU_HTTP_Response)
3576 handle_http (c, gdu->u.HTTP_Response);
3578 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3582 c->reconnect_ok = 0;
3587 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out)
3592 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3593 ZOOM_connection_put_event (c, event);
3595 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3596 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3598 yaz_log(log_details, "%p do_write_ex write failed", c);
3599 if (c->reconnect_ok)
3602 c->reconnect_ok = 0;
3603 yaz_log(log_details, "%p do_write_ex reconnect write", c);
3604 c->tasks->running = 0;
3605 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3606 return zoom_pending;
3608 if (c->state == STATE_CONNECTING)
3609 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3611 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3613 return zoom_complete;
3617 c->mask = ZOOM_SELECT_EXCEPT;
3618 if (c->cs->io_pending & CS_WANT_WRITE)
3619 c->mask += ZOOM_SELECT_WRITE;
3620 if (c->cs->io_pending & CS_WANT_READ)
3621 c->mask += ZOOM_SELECT_READ;
3622 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3627 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3628 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3631 return zoom_pending;
3634 static zoom_ret do_write(ZOOM_connection c)
3636 return do_write_ex (c, c->buf_out, c->len_out);
3640 ZOOM_API(const char *)
3641 ZOOM_connection_option_get (ZOOM_connection c, const char *key)
3643 return ZOOM_options_get (c->options, key);
3646 ZOOM_API(const char *)
3647 ZOOM_connection_option_getl (ZOOM_connection c, const char *key, int *lenp)
3649 return ZOOM_options_getl (c->options, key, lenp);
3653 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
3656 ZOOM_options_set (c->options, key, val);
3660 ZOOM_connection_option_setl (ZOOM_connection c, const char *key,
3661 const char *val, int len)
3663 ZOOM_options_setl (c->options, key, val, len);
3666 ZOOM_API(const char *)
3667 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key)
3669 return ZOOM_options_get (r->options, key);
3673 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key,
3676 ZOOM_options_set (r->options, key, val);
3681 ZOOM_connection_errcode (ZOOM_connection c)
3683 return ZOOM_connection_error (c, 0, 0);
3686 ZOOM_API(const char *)
3687 ZOOM_connection_errmsg (ZOOM_connection c)
3690 ZOOM_connection_error (c, &msg, 0);
3694 ZOOM_API(const char *)
3695 ZOOM_connection_addinfo (ZOOM_connection c)
3697 const char *addinfo;
3698 ZOOM_connection_error (c, 0, &addinfo);
3702 ZOOM_API(const char *)
3703 ZOOM_connection_diagset (ZOOM_connection c)
3705 const char *diagset;
3706 ZOOM_connection_error_x (c, 0, 0, &diagset);
3710 ZOOM_API(const char *)
3711 ZOOM_diag_str (int error)
3715 case ZOOM_ERROR_NONE:
3717 case ZOOM_ERROR_CONNECT:
3718 return "Connect failed";
3719 case ZOOM_ERROR_MEMORY:
3720 return "Out of memory";
3721 case ZOOM_ERROR_ENCODE:
3722 return "Encoding failed";
3723 case ZOOM_ERROR_DECODE:
3724 return "Decoding failed";
3725 case ZOOM_ERROR_CONNECTION_LOST:
3726 return "Connection lost";
3727 case ZOOM_ERROR_INIT:
3728 return "Init rejected";
3729 case ZOOM_ERROR_INTERNAL:
3730 return "Internal failure";
3731 case ZOOM_ERROR_TIMEOUT:
3733 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3734 return "Unsupported protocol";
3735 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3736 return "Unsupported query type";
3737 case ZOOM_ERROR_INVALID_QUERY:
3738 return "Invalid query";
3739 case ZOOM_ERROR_CQL_PARSE:
3740 return "CQL parsing error";
3741 case ZOOM_ERROR_CQL_TRANSFORM:
3742 return "CQL transformation error";
3744 return diagbib1_str (error);
3749 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
3750 const char **addinfo, const char **diagset)
3752 int error = c->error;
3755 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3756 *cp = ZOOM_diag_str(error);
3757 else if (!strcmp(c->diagset, "HTTP"))
3758 *cp = z_HTTP_errmsg(c->error);
3759 else if (!strcmp(c->diagset, "Bib-1"))
3760 *cp = ZOOM_diag_str(error);
3761 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3762 *cp = yaz_diag_srw_str(c->error);
3764 *cp = "Unknown error and diagnostic set";
3767 *addinfo = c->addinfo ? c->addinfo : "";
3769 *diagset = c->diagset ? c->diagset : "";
3774 ZOOM_connection_error (ZOOM_connection c, const char **cp,
3775 const char **addinfo)
3777 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3780 static int ZOOM_connection_do_io(ZOOM_connection c, int mask)
3782 ZOOM_Event event = 0;
3783 int r = cs_look(c->cs);
3784 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
3789 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3790 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3792 ZOOM_connection_put_event (c, event);
3794 else if (r == CS_CONNECT)
3797 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3799 ret = cs_rcvconnect (c->cs);
3800 yaz_log(log_details, "%p ZOOM_connection_do_io "
3801 "cs_rcvconnect returned %d", c, ret);
3804 c->mask = ZOOM_SELECT_EXCEPT;
3805 if (c->cs->io_pending & CS_WANT_WRITE)
3806 c->mask += ZOOM_SELECT_WRITE;
3807 if (c->cs->io_pending & CS_WANT_READ)
3808 c->mask += ZOOM_SELECT_READ;
3809 ZOOM_connection_put_event (c, event);
3813 ZOOM_connection_put_event (c, event);
3815 if (c->proto == PROTO_Z3950)
3816 ZOOM_connection_send_init(c);
3819 /* no init request for SRW .. */
3820 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3821 ZOOM_connection_remove_task (c);
3823 ZOOM_connection_exec_task (c);
3825 c->state = STATE_ESTABLISHED;
3829 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3831 ZOOM_connection_put_event (c, event);
3836 if (mask & ZOOM_SELECT_READ)
3838 if (c->cs && (mask & ZOOM_SELECT_WRITE))
3845 ZOOM_connection_last_event(ZOOM_connection cs)
3848 return ZOOM_EVENT_NONE;
3849 return cs->last_event;
3853 ZOOM_event (int no, ZOOM_connection *cs)
3855 int timeout = 30; /* default timeout in seconds */
3856 int timeout_set = 0; /* whether it was overriden at all */
3858 struct pollfd pollfds[1024];
3859 ZOOM_connection poll_cs[1024];
3862 fd_set input, output, except;
3867 for (i = 0; i<no; i++)
3869 ZOOM_connection c = cs[i];
3871 if (c && (event = ZOOM_connection_get_event(c)))
3873 ZOOM_Event_destroy (event);
3877 for (i = 0; i<no; i++)
3879 ZOOM_connection c = cs[i];
3881 if (c && ZOOM_connection_exec_task (c))
3883 if ((event = ZOOM_connection_get_event(c)))
3885 ZOOM_Event_destroy (event);
3898 for (i = 0; i<no; i++)
3900 ZOOM_connection c = cs[i];
3906 fd = z3950_connection_socket(c);
3907 mask = z3950_connection_mask(c);
3914 /* -1 is used for indefinite timeout (no timeout), so -2 here. */
3915 this_timeout = ZOOM_options_get_int (c->options, "timeout", -2);
3916 if (this_timeout != -2)
3918 /* ensure the minimum timeout is used */
3920 timeout = this_timeout;
3921 else if (this_timeout != -1 && this_timeout < timeout)
3922 timeout = this_timeout;
3928 short poll_events = 0;
3930 if (mask & ZOOM_SELECT_READ)
3931 poll_events += POLLIN;
3932 if (mask & ZOOM_SELECT_WRITE)
3933 poll_events += POLLOUT;
3934 if (mask & ZOOM_SELECT_EXCEPT)
3935 poll_events += POLLERR;
3936 pollfds[nfds].fd = fd;
3937 pollfds[nfds].events = poll_events;
3938 pollfds[nfds].revents = 0;
3943 if (mask & ZOOM_SELECT_READ)
3945 FD_SET (fd, &input);
3948 if (mask & ZOOM_SELECT_WRITE)
3950 FD_SET (fd, &output);
3953 if (mask & ZOOM_SELECT_EXCEPT)
3955 FD_SET (fd, &except);
3964 r = poll (pollfds, nfds, (timeout == -1 ? -1 : timeout * 1000));
3965 for (i = 0; i<nfds; i++)
3967 ZOOM_connection c = poll_cs[i];
3971 if (pollfds[i].revents & POLLIN)
3972 mask += ZOOM_SELECT_READ;
3973 if (pollfds[i].revents & POLLOUT)
3974 mask += ZOOM_SELECT_WRITE;
3975 if (pollfds[i].revents & POLLERR)
3976 mask += ZOOM_SELECT_EXCEPT;
3978 ZOOM_connection_do_io(c, mask);
3980 else if (r == 0 && c->mask)
3982 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3983 /* timeout and this connection was waiting */
3984 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3986 ZOOM_connection_put_event(c, event);
3990 tv.tv_sec = timeout;
3992 r = select (max_fd+1, &input, &output, &except, (timeout == -1 ? 0 : &tv));
3993 for (i = 0; i<no; i++)
3995 ZOOM_connection c = cs[i];
4000 fd = z3950_connection_socket(c);
4004 /* no timeout and real socket */
4005 if (FD_ISSET(fd, &input))
4006 mask += ZOOM_SELECT_READ;
4007 if (FD_ISSET(fd, &output))
4008 mask += ZOOM_SELECT_WRITE;
4009 if (FD_ISSET(fd, &except))
4010 mask += ZOOM_SELECT_EXCEPT;
4012 ZOOM_connection_do_io(c, mask);
4014 if (r == 0 && c->mask)
4016 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4017 /* timeout and this connection was waiting */
4018 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4020 ZOOM_connection_put_event(c, event);
4024 for (i = 0; i<no; i++)
4026 ZOOM_connection c = cs[i];
4028 if (c && (event = ZOOM_connection_get_event(c)))
4030 ZOOM_Event_destroy (event);
4039 * Returns an xmalloc()d string containing RPN that corresponds to the
4040 * CQL passed in. On error, sets the Connection object's error state
4041 * and returns a null pointer.
4042 * ### We could cache CQL parser and/or transformer in Connection.
4044 static char *cql2pqf(ZOOM_connection c, const char *cql)
4048 struct cql_node *node;
4049 const char *cqlfile;
4050 static cql_transform_t trans;
4053 parser = cql_parser_create();
4054 if ((error = cql_parser_string(parser, cql)) != 0) {
4055 cql_parser_destroy(parser);
4056 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4060 node = cql_parser_result(parser);
4061 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4063 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4065 cql_parser_destroy(parser);
4066 cql_node_destroy(node);
4067 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4071 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4073 cql_parser_destroy(parser);
4074 cql_node_destroy(node);
4075 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4076 cqlfile, strerror(errno));
4077 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4081 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4082 cql_parser_destroy(parser);
4083 cql_node_destroy(node);
4086 const char *addinfo;
4087 error = cql_transform_error(trans, &addinfo);
4088 cql_transform_close(trans);
4089 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4090 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4094 cql_transform_close(trans);
4095 return xstrdup(pqfbuf);
4102 * indent-tabs-mode: nil
4104 * vim: shiftwidth=4 tabstop=8 expandtab