2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.64 2006-03-01 23:24:25 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 static int ZOOM_connection_exec_task (ZOOM_connection c);
253 void ZOOM_connection_remove_tasks (ZOOM_connection c)
256 ZOOM_connection_remove_task(c);
259 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos);
261 ZOOM_API(ZOOM_connection)
262 ZOOM_connection_create (ZOOM_options options)
264 ZOOM_connection c = (ZOOM_connection) xmalloc (sizeof(*c));
268 yaz_log(log_api, "%p ZOOM_connection_create", c);
270 c->proto = PROTO_Z3950;
274 c->state = STATE_IDLE;
277 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
284 c->options = ZOOM_options_create_with_parent(options);
290 c->charset = c->lang = 0;
297 c->odr_in = odr_createmem (ODR_DECODE);
298 c->odr_out = odr_createmem (ODR_ENCODE);
301 c->support_named_resultsets = 0;
302 c->last_event = ZOOM_EVENT_NONE;
304 c->m_queue_front = 0;
309 /* set database names. Take local databases (if set); otherwise
310 take databases given in ZURL (if set); otherwise use Default */
311 static char **set_DatabaseNames (ZOOM_connection con, ZOOM_options options,
314 char **databaseNames;
315 const char *cp = ZOOM_options_get (options, "databaseName");
319 if (strncmp (con->host_port, "unix:", 5) == 0)
320 cp = strchr(con->host_port+5, ':');
322 cp = strchr(con->host_port, '/');
328 nmem_strsplit(con->odr_out->mem, "+", cp, &databaseNames, num);
329 return databaseNames;
332 ZOOM_API(ZOOM_connection)
333 ZOOM_connection_new (const char *host, int portnum)
335 ZOOM_connection c = ZOOM_connection_create (0);
337 ZOOM_connection_connect (c, host, portnum);
341 static zoom_sru_mode get_sru_mode_from_string(const char *s)
344 return zoom_sru_soap;
345 if (!yaz_matchstr(s, "soap"))
346 return zoom_sru_soap;
347 else if (!yaz_matchstr(s, "get"))
349 else if (!yaz_matchstr(s, "post"))
350 return zoom_sru_post;
351 return zoom_sru_error;
355 ZOOM_connection_connect(ZOOM_connection c,
356 const char *host, int portnum)
363 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
368 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
372 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
374 val = ZOOM_options_get (c->options, "proxy");
377 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
378 c->proxy = xstrdup (val);
384 val = ZOOM_options_get (c->options, "charset");
387 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
388 c->charset = xstrdup (val);
394 val = ZOOM_options_get (c->options, "lang");
397 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
398 c->lang = xstrdup (val);
403 val = ZOOM_options_get (c->options, "sru");
404 c->sru_mode = get_sru_mode_from_string(val);
406 xfree (c->host_port);
410 sprintf (hostn, "%.80s:%d", host, portnum);
411 c->host_port = xstrdup(hostn);
414 c->host_port = xstrdup(host);
418 * If the "<scheme>:" part of the host string is preceded by one
419 * or more comma-separated <name>=<value> pairs, these are taken
420 * to be options to be set on the connection object. Among other
421 * applications, this facility can be used to embed authentication
423 * user=admin,password=secret,tcp:localhost:9999
425 char *remainder = c->host_port;
426 char *pcolon = strchr(remainder, ':');
429 while ((pcomma = strchr(remainder, ',')) != 0 &&
430 (pcolon == 0 || pcomma < pcolon)) {
432 if ((pequals = strchr(remainder, '=')) != 0) {
434 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
435 ZOOM_connection_option_set(c, remainder, pequals+1);
437 remainder = pcomma+1;
440 if (remainder != c->host_port) {
442 c->host_port = xstrdup(remainder);
443 /*printf("# reset hp='%s'\n", remainder);*/
447 ZOOM_options_set(c->options, "host", c->host_port);
449 val = ZOOM_options_get (c->options, "cookie");
452 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
453 c->cookie_out = xstrdup (val);
456 val = ZOOM_options_get (c->options, "clientIP");
459 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
461 c->client_IP = xstrdup (val);
464 c->async = ZOOM_options_get_bool (c->options, "async", 0);
465 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
467 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
469 task = ZOOM_connection_add_task (c, ZOOM_TASK_CONNECT);
473 while (ZOOM_event (1, &c))
479 ZOOM_query_create(void)
481 ZOOM_query s = (ZOOM_query) xmalloc (sizeof(*s));
483 yaz_log(log_details, "%p ZOOM_query_create", s);
487 s->odr = odr_createmem (ODR_ENCODE);
494 ZOOM_query_destroy(ZOOM_query s)
500 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
501 if (s->refcount == 0)
503 odr_destroy (s->odr);
509 ZOOM_query_prefix(ZOOM_query s, const char *str)
511 s->query_string = odr_strdup(s->odr, str);
512 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
513 s->z_query->which = Z_Query_type_1;
514 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
515 if (!s->z_query->u.type_1)
517 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
521 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
526 ZOOM_query_cql(ZOOM_query s, const char *str)
530 s->query_string = odr_strdup(s->odr, str);
532 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
533 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
534 ext->indirect_reference = 0;
536 ext->which = Z_External_CQL;
537 ext->u.cql = s->query_string;
539 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
540 s->z_query->which = Z_Query_type_104;
541 s->z_query->u.type_104 = ext;
543 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
549 * Translate the CQL string client-side into RPN which is passed to
550 * the server. This is useful for server's that don't themselves
551 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
552 * only as a place to stash diagnostics if compilation fails; if this
553 * information is not needed, a null pointer may be used.
556 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
561 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
563 conn = ZOOM_connection_create(0);
565 if ((rpn = cql2pqf(conn, str)) == 0)
568 ret = ZOOM_query_prefix(s, rpn);
574 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
576 s->sort_spec = yaz_sort_spec (s->odr, criteria);
579 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
583 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
587 static zoom_ret do_write(ZOOM_connection c);
590 ZOOM_connection_destroy(ZOOM_connection c)
595 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
598 for (r = c->resultsets; r; r = r->next)
604 odr_destroy (c->odr_in);
605 odr_destroy (c->odr_out);
606 ZOOM_options_destroy (c->options);
607 ZOOM_connection_remove_tasks (c);
608 xfree (c->host_port);
613 xfree (c->cookie_out);
614 xfree (c->cookie_in);
615 xfree (c->client_IP);
619 void ZOOM_resultset_addref (ZOOM_resultset r)
624 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
629 ZOOM_resultset ZOOM_resultset_create ()
631 ZOOM_resultset r = (ZOOM_resultset) xmalloc (sizeof(*r));
635 yaz_log(log_details, "%p ZOOM_resultset_create", r);
638 r->odr = odr_createmem (ODR_ENCODE);
653 ZOOM_API(ZOOM_resultset)
654 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
657 ZOOM_query s = ZOOM_query_create();
659 ZOOM_query_prefix (s, q);
661 r = ZOOM_connection_search (c, s);
662 ZOOM_query_destroy (s);
666 ZOOM_API(ZOOM_resultset)
667 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
669 ZOOM_resultset r = ZOOM_resultset_create ();
673 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
674 r->r_sort_spec = q->sort_spec;
677 r->options = ZOOM_options_create_with_parent(c->options);
679 r->start = ZOOM_options_get_int(r->options, "start", 0);
680 r->count = ZOOM_options_get_int(r->options, "count", 0);
682 /* If "presentChunk" is defined use that; otherwise "step" */
683 const char *cp = ZOOM_options_get (r->options, "presentChunk");
684 r->step = ZOOM_options_get_int(r->options,
685 (cp != 0 ? "presentChunk": "step"), 0);
687 r->piggyback = ZOOM_options_get_bool (r->options, "piggyback", 1);
688 cp = ZOOM_options_get (r->options, "setname");
690 r->setname = xstrdup(cp);
691 cp = ZOOM_options_get (r->options, "schema");
693 r->schema = xstrdup(cp);
697 r->next = c->resultsets;
700 if (c->host_port && c->proto == PROTO_HTTP)
704 yaz_log(log_details, "ZOOM_connection_search: no comstack");
705 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
709 yaz_log(log_details, "ZOOM_connection_search: reconnect");
714 task = ZOOM_connection_add_task (c, ZOOM_TASK_SEARCH);
715 task->u.search.resultset = r;
716 ZOOM_resultset_addref (r);
722 while (ZOOM_event (1, &c))
729 * This is the old result-set sorting API, which is maintained only
730 * for the sake of binary compatibility. There is no reason ever to
731 * use this rather than ZOOM_resultset_sort1().
734 ZOOM_resultset_sort(ZOOM_resultset r,
735 const char *sort_type, const char *sort_spec)
737 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
741 ZOOM_resultset_sort1(ZOOM_resultset r,
742 const char *sort_type, const char *sort_spec)
744 ZOOM_connection c = r->connection;
748 newq = ZOOM_query_create();
749 if (ZOOM_query_sortby(newq, sort_spec) < 0)
752 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
753 r, r, sort_type, sort_spec);
757 if (c->host_port && c->proto == PROTO_HTTP)
761 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
762 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
766 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
772 ZOOM_resultset_cache_reset(r);
773 task = ZOOM_connection_add_task (c, ZOOM_TASK_SORT);
774 task->u.sort.resultset = r;
775 task->u.sort.q = newq;
777 ZOOM_resultset_addref (r);
781 while (ZOOM_event (1, &c))
789 ZOOM_resultset_cache_reset(ZOOM_resultset r)
791 ZOOM_record_cache rc;
793 for (rc = r->record_cache; rc; rc = rc->next)
795 if (rc->rec.wrbuf_marc)
796 wrbuf_free (rc->rec.wrbuf_marc, 1);
797 if (rc->rec.wrbuf_iconv)
798 wrbuf_free (rc->rec.wrbuf_iconv, 1);
799 if (rc->rec.wrbuf_opac)
800 wrbuf_free (rc->rec.wrbuf_opac, 1);
806 ZOOM_resultset_destroy(ZOOM_resultset r)
811 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
813 if (r->refcount == 0)
815 ZOOM_resultset_cache_reset(r);
819 /* remove ourselves from the resultsets in connection */
820 ZOOM_resultset *rp = &r->connection->resultsets;
823 assert (*rp); /* we must be in this list!! */
825 { /* OK, we're here - take us out of it */
832 ZOOM_query_destroy (r->query);
833 ZOOM_options_destroy (r->options);
834 odr_destroy (r->odr);
842 ZOOM_resultset_size (ZOOM_resultset r)
847 static void do_close (ZOOM_connection c)
853 c->state = STATE_IDLE;
856 static void ZOOM_resultset_retrieve (ZOOM_resultset r,
857 int force_sync, int start, int count)
865 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
866 " count=%d", r, force_sync, start, count);
871 if (c->host_port && c->proto == PROTO_HTTP)
875 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
876 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
880 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
885 task = ZOOM_connection_add_task (c, ZOOM_TASK_RETRIEVE);
886 task->u.retrieve.resultset = r;
887 task->u.retrieve.start = start;
888 task->u.retrieve.count = count;
890 cp = ZOOM_options_get (r->options, "schema");
893 if (!r->schema || strcmp(r->schema, cp))
896 r->schema = xstrdup(cp);
900 ZOOM_resultset_addref (r);
902 if (!r->connection->async || force_sync)
903 while (r->connection && ZOOM_event (1, &r->connection))
908 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
909 size_t start, size_t count)
911 int force_present = 0;
915 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%d count=%d",
919 ZOOM_resultset_retrieve (r, force_present, start, count);
923 for (i = 0; i< count; i++)
924 recs[i] = ZOOM_resultset_record_immediate (r, i+start);
928 static void get_cert(ZOOM_connection c)
933 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
935 ZOOM_connection_option_setl(c, "sslPeerCert",
941 static zoom_ret do_connect (ZOOM_connection c)
944 const char *effective_host;
947 effective_host = c->proxy;
949 effective_host = c->host_port;
951 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
955 c->cs = cs_create_host (effective_host, 0, &add);
957 if (c->cs && c->cs->protocol == PROTO_HTTP)
960 const char *path = 0;
962 c->proto = PROTO_HTTP;
963 cs_get_host_args(c->host_port, &path);
965 c->path = (char*) xmalloc(strlen(path)+2);
967 strcpy (c->path+1, path);
969 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
971 return zoom_complete;
976 int ret = cs_connect (c->cs, add);
979 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
980 ZOOM_connection_put_event(c, event);
982 if (c->proto == PROTO_Z3950)
983 ZOOM_connection_send_init(c);
986 /* no init request for SRW .. */
987 assert (c->tasks->which == ZOOM_TASK_CONNECT);
988 ZOOM_connection_remove_task (c);
990 ZOOM_connection_exec_task (c);
992 c->state = STATE_ESTABLISHED;
997 c->state = STATE_CONNECTING;
998 c->mask = ZOOM_SELECT_EXCEPT;
999 if (c->cs->io_pending & CS_WANT_WRITE)
1000 c->mask += ZOOM_SELECT_WRITE;
1001 if (c->cs->io_pending & CS_WANT_READ)
1002 c->mask += ZOOM_SELECT_READ;
1003 return zoom_pending;
1006 c->state = STATE_IDLE;
1007 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1008 return zoom_complete;
1011 int z3950_connection_socket(ZOOM_connection c)
1014 return cs_fileno(c->cs);
1018 int z3950_connection_mask(ZOOM_connection c)
1025 static void otherInfo_attach (ZOOM_connection c, Z_APDU *a, ODR out)
1028 for (i = 0; i<200; i++)
1031 Z_OtherInformation **oi;
1037 sprintf (buf, "otherInfo%d", i);
1038 val = ZOOM_options_get (c->options, buf);
1041 cp = strchr(val, ':');
1045 if (len >= sizeof(buf))
1046 len = sizeof(buf)-1;
1047 memcpy (buf, val, len);
1049 oidval = oid_getvalbyname (buf);
1050 if (oidval == VAL_NONE)
1053 yaz_oi_APDU(a, &oi);
1054 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1058 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1063 Z_OtherInformation **oi;
1064 yaz_oi_APDU(a, &oi);
1065 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1069 Z_OtherInformation **oi;
1070 yaz_oi_APDU(a, &oi);
1071 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1073 otherInfo_attach (c, a, out);
1074 if (!z_APDU(out, &a, 0, 0))
1076 FILE *outf = fopen("/tmp/apdu.txt", "a");
1079 ODR odr_pr = odr_createmem(ODR_PRINT);
1080 fprintf (outf, "a=%p\n", a);
1081 odr_setprint(odr_pr, outf);
1082 z_APDU(odr_pr, &a, 0, 0);
1083 odr_destroy(odr_pr);
1085 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1086 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1090 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1094 static zoom_ret send_APDU (ZOOM_connection c, Z_APDU *a)
1098 if (encode_APDU(c, a, c->odr_out))
1099 return zoom_complete;
1100 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1101 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1102 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1103 ZOOM_connection_put_event (c, event);
1104 odr_reset(c->odr_out);
1105 return do_write (c);
1108 /* returns 1 if PDU was sent OK (still pending )
1109 0 if PDU was not sent OK (nothing to wait for)
1112 static zoom_ret ZOOM_connection_send_init (ZOOM_connection c)
1114 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1115 Z_InitRequest *ireq = apdu->u.initRequest;
1116 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1117 odr_malloc(c->odr_out, sizeof(*auth));
1118 const char *auth_groupId = ZOOM_options_get (c->options, "group");
1119 const char *auth_userId = ZOOM_options_get (c->options, "user");
1120 const char *auth_password = ZOOM_options_get (c->options, "password");
1123 /* support the pass for backwards compatibility */
1125 auth_password = ZOOM_options_get (c->options, "pass");
1127 ODR_MASK_SET(ireq->options, Z_Options_search);
1128 ODR_MASK_SET(ireq->options, Z_Options_present);
1129 ODR_MASK_SET(ireq->options, Z_Options_scan);
1130 ODR_MASK_SET(ireq->options, Z_Options_sort);
1131 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1132 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1134 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1135 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1136 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1138 /* Index Data's Z39.50 Implementor Id is 81 */
1139 ireq->implementationId = odr_prepend(c->odr_out,
1140 ZOOM_options_get(c->options, "implementationId"),
1141 odr_prepend(c->odr_out, "81", ireq->implementationId));
1143 ireq->implementationName = odr_prepend(c->odr_out,
1144 ZOOM_options_get(c->options, "implementationName"),
1145 odr_prepend(c->odr_out, "ZOOM-C", ireq->implementationName));
1147 version = odr_strdup(c->odr_out, "$Revision: 1.64 $");
1148 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1149 version[strlen(version)-2] = '\0';
1150 ireq->implementationVersion = odr_prepend(c->odr_out,
1151 ZOOM_options_get(c->options, "implementationVersion"),
1152 odr_prepend(c->odr_out, &version[11], ireq->implementationVersion));
1154 *ireq->maximumRecordSize =
1155 ZOOM_options_get_int (c->options, "maximumRecordSize", 1024*1024);
1156 *ireq->preferredMessageSize =
1157 ZOOM_options_get_int (c->options, "preferredMessageSize", 1024*1024);
1159 if (auth_groupId || auth_password)
1161 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1164 if (auth_groupId && *auth_groupId)
1166 pass->groupId = (char *)
1167 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1168 strcpy(pass->groupId, auth_groupId);
1172 if (auth_userId && *auth_userId)
1174 pass->userId = (char *)
1175 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1176 strcpy(pass->userId, auth_userId);
1180 if (auth_password && *auth_password)
1182 pass->password = (char *)
1183 odr_malloc(c->odr_out, strlen(auth_password)+1);
1184 strcpy(pass->password, auth_password);
1189 auth->which = Z_IdAuthentication_idPass;
1190 auth->u.idPass = pass;
1191 ireq->idAuthentication = auth;
1194 else if (auth_userId)
1196 auth->which = Z_IdAuthentication_open;
1197 auth->u.open = (char *)
1198 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1199 strcpy(auth->u.open, auth_userId);
1200 ireq->idAuthentication = auth;
1203 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1204 VAL_PROXY, 1, c->host_port);
1205 if (c->charset || c->lang)
1207 Z_OtherInformation **oi;
1208 Z_OtherInformationUnit *oi_unit;
1210 yaz_oi_APDU(apdu, &oi);
1212 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1214 char **charsets_addresses = 0;
1215 char **langs_addresses = 0;
1216 int charsets_count = 0;
1217 int langs_count = 0;
1220 nmem_strsplit_blank(c->odr_out->mem, c->charset,
1221 &charsets_addresses, &charsets_count);
1223 nmem_strsplit_blank(c->odr_out->mem, c->lang,
1224 &langs_addresses, &langs_count);
1225 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1226 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1227 oi_unit->information.externallyDefinedInfo =
1228 yaz_set_proposal_charneg(c->odr_out,
1229 (const char **) charsets_addresses,
1231 (const char **) langs_addresses,
1237 return send_APDU (c, apdu);
1241 static zoom_ret send_srw (ZOOM_connection c, Z_SRW_PDU *sr)
1243 Z_SOAP_Handler h[2] = {
1244 {"http://www.loc.gov/zing/srw/", 0, (Z_SOAP_fun) yaz_srw_codec},
1247 ODR o = odr_createmem(ODR_ENCODE);
1249 Z_SOAP *p = (Z_SOAP*) odr_malloc(o, sizeof(*p));
1253 gdu = z_get_HTTP_Request(c->odr_out);
1254 gdu->u.HTTP_Request->path = c->path;
1258 const char *cp0 = strstr(c->host_port, "://");
1259 const char *cp1 = 0;
1265 cp1 = strchr(cp0, '/');
1267 cp1 = cp0+strlen(cp0);
1271 char *h = (char*) odr_malloc(c->odr_out, cp1 - cp0 + 1);
1272 memcpy (h, cp0, cp1 - cp0);
1274 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1279 if (c->sru_mode == zoom_sru_get)
1281 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1283 else if (c->sru_mode == zoom_sru_post)
1285 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1287 else if (c->sru_mode == zoom_sru_soap)
1289 z_HTTP_header_add_content_type(c->odr_out,
1290 &gdu->u.HTTP_Request->headers,
1291 "text/xml", c->charset);
1293 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1294 "SOAPAction", "\"\"");
1295 p->which = Z_SOAP_generic;
1296 p->u.generic = (Z_SOAP_Generic *) odr_malloc(o, sizeof(*p->u.generic));
1297 p->u.generic->no = 0;
1298 p->u.generic->ns = 0;
1299 p->u.generic->p = sr;
1300 p->ns = "http://schemas.xmlsoap.org/soap/envelope/";
1302 ret = z_soap_codec_enc(o, &p,
1303 &gdu->u.HTTP_Request->content_buf,
1304 &gdu->u.HTTP_Request->content_len, h,
1308 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1309 return zoom_complete;
1310 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1313 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1314 ZOOM_connection_put_event (c, event);
1315 odr_reset(c->odr_out);
1316 return do_write (c);
1321 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1324 ZOOM_resultset resultset = 0;
1326 const char *recordPacking = 0;
1328 if (c->error) /* don't continue on error */
1329 return zoom_complete;
1331 if (c->tasks->which == ZOOM_TASK_SEARCH)
1333 resultset = c->tasks->u.search.resultset;
1334 resultset->setname = xstrdup ("default");
1335 ZOOM_options_set (resultset->options, "setname", resultset->setname);
1337 else if(c->tasks->which == ZOOM_TASK_RETRIEVE)
1339 resultset = c->tasks->u.retrieve.resultset;
1341 resultset->start = c->tasks->u.retrieve.start;
1342 resultset->count = c->tasks->u.retrieve.count;
1344 if (resultset->start >= resultset->size)
1345 return zoom_complete;
1346 if (resultset->start + resultset->count > resultset->size)
1347 resultset->count = resultset->size - resultset->start;
1349 for (i = 0; i<resultset->count; i++)
1352 record_cache_lookup (resultset, i + resultset->start);
1356 if (i == resultset->count)
1357 return zoom_complete;
1359 assert(resultset->query);
1361 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1363 if (resultset->query->z_query->which == Z_Query_type_104
1364 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1367 sr->u.request->query_type = Z_SRW_query_type_cql;
1368 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1370 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1371 resultset->query->z_query->u.type_1)
1373 sr->u.request->query_type = Z_SRW_query_type_pqf;
1374 sr->u.request->query.pqf = resultset->query->query_string;
1378 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1379 return zoom_complete;
1381 sr->u.request->startRecord = odr_intdup (c->odr_out, resultset->start + 1);
1382 sr->u.request->maximumRecords = odr_intdup (
1383 c->odr_out, resultset->step>0 ? resultset->step : resultset->count);
1384 sr->u.request->recordSchema = resultset->schema;
1386 recordPacking = ZOOM_resultset_option_get (resultset, "recordPacking");
1389 sr->u.request->recordPacking = odr_strdup(c->odr_out, recordPacking);
1391 return send_srw(c, sr);
1394 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1396 return zoom_complete;
1400 static zoom_ret ZOOM_connection_send_search (ZOOM_connection c)
1403 int lslb, ssub, mspn;
1405 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1406 Z_SearchRequest *search_req = apdu->u.searchRequest;
1407 const char *elementSetName;
1408 const char *smallSetElementSetName;
1409 const char *mediumSetElementSetName;
1412 assert (c->tasks->which == ZOOM_TASK_SEARCH);
1414 r = c->tasks->u.search.resultset;
1416 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1419 ZOOM_options_get (r->options, "elementSetName");
1420 smallSetElementSetName =
1421 ZOOM_options_get (r->options, "smallSetElementSetName");
1422 mediumSetElementSetName =
1423 ZOOM_options_get (r->options, "mediumSetElementSetName");
1425 if (!smallSetElementSetName)
1426 smallSetElementSetName = elementSetName;
1428 if (!mediumSetElementSetName)
1429 mediumSetElementSetName = elementSetName;
1434 /* prepare query for the search request */
1435 search_req->query = r->query->z_query;
1436 if (!search_req->query)
1438 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1439 return zoom_complete;
1442 search_req->databaseNames =
1443 set_DatabaseNames (c, r->options, &search_req->num_databaseNames);
1445 /* get syntax (no need to provide unless piggyback is in effect) */
1446 syntax = ZOOM_options_get (r->options, "preferredRecordSyntax");
1448 lslb = ZOOM_options_get_int (r->options, "largeSetLowerBound", -1);
1449 ssub = ZOOM_options_get_int (r->options, "smallSetUpperBound", -1);
1450 mspn = ZOOM_options_get_int (r->options, "mediumSetPresentNumber", -1);
1451 if (lslb != -1 && ssub != -1 && mspn != -1)
1453 /* So're a Z39.50 expert? Let's hope you don't do sort */
1454 *search_req->largeSetLowerBound = lslb;
1455 *search_req->smallSetUpperBound = ssub;
1456 *search_req->mediumSetPresentNumber = mspn;
1458 else if (r->start == 0 && r->count > 0
1459 && r->piggyback && !r->r_sort_spec && !r->schema)
1461 /* Regular piggyback - do it unless we're going to do sort */
1462 *search_req->largeSetLowerBound = 2000000000;
1463 *search_req->smallSetUpperBound = 1;
1464 *search_req->mediumSetPresentNumber = r->step>0 ? r->step : r->count;
1468 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1469 smallSetElementSetName = 0;
1470 mediumSetElementSetName = 0;
1473 if (smallSetElementSetName && *smallSetElementSetName)
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, smallSetElementSetName);
1480 search_req->smallSetElementSetNames = esn;
1482 if (mediumSetElementSetName && *mediumSetElementSetName)
1484 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1485 odr_malloc (c->odr_out, sizeof(*esn));
1487 esn->which = Z_ElementSetNames_generic;
1488 esn->u.generic = odr_strdup (c->odr_out, mediumSetElementSetName);
1489 search_req->mediumSetElementSetNames = esn;
1492 search_req->preferredRecordSyntax =
1493 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1497 if (c->support_named_resultsets)
1501 /* find the lowest unused ordinal so that we re-use
1502 result sets on the server. */
1503 for (ord = 1; ; ord++)
1506 sprintf (setname, "%d", ord);
1507 for (rp = c->resultsets; rp; rp = rp->next)
1508 if (rp->setname && !strcmp (rp->setname, setname))
1513 r->setname = xstrdup (setname);
1514 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1515 "set %s", c, r->setname);
1519 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1521 r->setname = xstrdup ("default");
1523 ZOOM_options_set (r->options, "setname", r->setname);
1525 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1526 return send_APDU (c, apdu);
1529 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1536 case Z_DefaultDiagFormat_v2Addinfo:
1537 addinfo = r->u.v2Addinfo;
1539 case Z_DefaultDiagFormat_v3Addinfo:
1540 addinfo = r->u.v3Addinfo;
1545 set_dset_error(c, *r->condition,
1546 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1550 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1552 if (p->which != Z_DiagRec_defaultFormat)
1553 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1555 response_default_diag(c, p->u.defaultFormat);
1558 ZOOM_API(ZOOM_record)
1559 ZOOM_record_clone (ZOOM_record srec)
1566 odr_enc = odr_createmem(ODR_ENCODE);
1567 if (!z_NamePlusRecord (odr_enc, &srec->npr, 0, 0))
1569 buf = odr_getbuf (odr_enc, &size, 0);
1571 nrec = (ZOOM_record) xmalloc (sizeof(*nrec));
1572 nrec->odr = odr_createmem(ODR_DECODE);
1573 nrec->wrbuf_marc = 0;
1574 nrec->wrbuf_iconv = 0;
1575 nrec->wrbuf_opac = 0;
1576 odr_setbuf (nrec->odr, buf, size, 0);
1577 z_NamePlusRecord (nrec->odr, &nrec->npr, 0, 0);
1579 odr_destroy (odr_enc);
1583 ZOOM_API(ZOOM_record)
1584 ZOOM_resultset_record_immediate (ZOOM_resultset s,size_t pos)
1586 return record_cache_lookup (s, pos);
1589 ZOOM_API(ZOOM_record)
1590 ZOOM_resultset_record (ZOOM_resultset r, size_t pos)
1592 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1596 ZOOM_resultset_retrieve (r, 1, pos, 1);
1597 rec = ZOOM_resultset_record_immediate (r, pos);
1603 ZOOM_record_destroy (ZOOM_record rec)
1607 if (rec->wrbuf_marc)
1608 wrbuf_free (rec->wrbuf_marc, 1);
1609 if (rec->wrbuf_iconv)
1610 wrbuf_free (rec->wrbuf_iconv, 1);
1611 if (rec->wrbuf_opac)
1612 wrbuf_free (rec->wrbuf_opac, 1);
1613 odr_destroy (rec->odr);
1617 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1619 const char *buf, int sz,
1620 const char *record_charset)
1625 yaz_marc_t mt = yaz_marc_create();
1628 strcpy(to, "UTF-8");
1629 if (record_charset && *record_charset)
1631 /* Use "from,to" or just "from" */
1632 const char *cp = strchr(record_charset, ',');
1633 int clen = strlen(record_charset);
1636 strncpy( to, cp+1, sizeof(to)-1);
1637 to[sizeof(to)-1] = '\0';
1638 clen = cp - record_charset;
1640 if (clen > sizeof(from)-1)
1641 clen = sizeof(from)-1;
1644 strncpy(from, record_charset, clen);
1650 cd = yaz_iconv_open(to, from);
1651 yaz_marc_iconv(mt, cd);
1654 yaz_marc_xml(mt, marc_type);
1655 if (!rec->wrbuf_marc)
1656 rec->wrbuf_marc = wrbuf_alloc();
1657 wrbuf_rewind (rec->wrbuf_marc);
1658 if (yaz_marc_decode_wrbuf (mt, buf, sz, rec->wrbuf_marc) > 0)
1660 yaz_marc_destroy(mt);
1662 yaz_iconv_close(cd);
1664 *len = wrbuf_len(rec->wrbuf_marc);
1665 return wrbuf_buf(rec->wrbuf_marc);
1667 yaz_marc_destroy(mt);
1669 yaz_iconv_close(cd);
1673 static const char *record_iconv_return(ZOOM_record rec, int *len,
1674 const char *buf, int sz,
1675 const char *record_charset)
1682 strcpy(to, "UTF-8");
1683 if (record_charset && *record_charset)
1685 /* Use "from,to" or just "from" */
1686 const char *cp = strchr(record_charset, ',');
1687 int clen = strlen(record_charset);
1690 strncpy( to, cp+1, sizeof(to)-1);
1691 to[sizeof(to)-1] = '\0';
1692 clen = cp - record_charset;
1694 if (clen > sizeof(from)-1)
1695 clen = sizeof(from)-1;
1698 strncpy(from, record_charset, clen);
1702 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1705 size_t inbytesleft = sz;
1706 const char *inp = buf;
1708 if (!rec->wrbuf_iconv)
1709 rec->wrbuf_iconv = wrbuf_alloc();
1711 wrbuf_rewind(rec->wrbuf_iconv);
1715 size_t outbytesleft = sizeof(outbuf);
1716 char *outp = outbuf;
1717 size_t r = yaz_iconv (cd, (char**) &inp,
1719 &outp, &outbytesleft);
1720 if (r == (size_t) (-1))
1722 int e = yaz_iconv_error(cd);
1723 if (e != YAZ_ICONV_E2BIG)
1726 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1728 wrbuf_puts(rec->wrbuf_iconv, "");
1729 buf = wrbuf_buf(rec->wrbuf_iconv);
1730 sz = wrbuf_len(rec->wrbuf_iconv);
1731 yaz_iconv_close(cd);
1738 ZOOM_API(const char *)
1739 ZOOM_record_get (ZOOM_record rec, const char *type_spec, int *len)
1746 Z_NamePlusRecord *npr;
1749 *len = 0; /* default return */
1758 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1760 if (cp[i] == ';' || cp[i] == ' ')
1766 while (type_spec[i] == ';')
1769 while (type_spec[i] == ' ')
1771 if (!strncmp(type_spec+i, "charset=", 8))
1774 i = i + 8; /* skip charset= */
1775 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1777 if (type_spec[i] == ';' || type_spec[i] == ' ')
1783 else if (!strncmp(type_spec+i, "xpath=", 6))
1787 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1791 while (type_spec[i] == ' ')
1794 if (!strcmp (type, "database"))
1797 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1798 return npr->databaseName;
1800 else if (!strcmp (type, "syntax"))
1802 const char *desc = 0;
1803 if (npr->which == Z_NamePlusRecord_databaseRecord)
1805 Z_External *r = (Z_External *) npr->u.databaseRecord;
1806 oident *ent = oid_getentbyoid(r->direct_reference);
1813 *len = strlen(desc);
1816 if (npr->which != Z_NamePlusRecord_databaseRecord)
1819 /* from now on - we have a database record .. */
1820 if (!strcmp (type, "render"))
1822 Z_External *r = (Z_External *) npr->u.databaseRecord;
1823 oident *ent = oid_getentbyoid(r->direct_reference);
1825 /* render bibliographic record .. */
1826 if (r->which == Z_External_OPAC)
1828 r = r->u.opac->bibliographicRecord;
1831 ent = oid_getentbyoid(r->direct_reference);
1833 if (r->which == Z_External_sutrs)
1834 return record_iconv_return(rec, len,
1835 (char*) r->u.sutrs->buf,
1838 else if (r->which == Z_External_octet)
1840 const char *ret_buf;
1848 case VAL_APPLICATION_XML:
1851 ret_buf = marc_iconv_return(
1852 rec, YAZ_MARC_LINE, len,
1853 (const char *) r->u.octet_aligned->buf,
1854 r->u.octet_aligned->len,
1859 return record_iconv_return(rec, len,
1860 (const char *) r->u.octet_aligned->buf,
1861 r->u.octet_aligned->len,
1864 else if (r->which == Z_External_grs1)
1866 if (!rec->wrbuf_marc)
1867 rec->wrbuf_marc = wrbuf_alloc();
1868 wrbuf_rewind (rec->wrbuf_marc);
1869 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1870 return record_iconv_return(rec, len,
1871 wrbuf_buf(rec->wrbuf_marc),
1872 wrbuf_len(rec->wrbuf_marc),
1877 else if (!strcmp (type, "xml") || !strcmp(type, "oai"))
1879 Z_External *r = (Z_External *) npr->u.databaseRecord;
1880 oident *ent = oid_getentbyoid(r->direct_reference);
1882 /* render bibliographic record .. */
1883 if (r->which == Z_External_OPAC)
1885 r = r->u.opac->bibliographicRecord;
1888 ent = oid_getentbyoid(r->direct_reference);
1891 if (r->which == Z_External_sutrs)
1892 return record_iconv_return(rec, len,
1893 (const char *) r->u.sutrs->buf,
1896 else if (r->which == Z_External_octet)
1898 const char *ret_buf;
1899 int marc_decode_type = YAZ_MARC_MARCXML;
1901 if (!strcmp(type, "oai"))
1902 marc_decode_type = YAZ_MARC_OAIMARC;
1910 case VAL_APPLICATION_XML:
1913 ret_buf = marc_iconv_return(
1914 rec, marc_decode_type, len,
1915 (const char *) r->u.octet_aligned->buf,
1916 r->u.octet_aligned->len,
1921 return record_iconv_return(rec, len,
1922 (const char *) r->u.octet_aligned->buf,
1923 r->u.octet_aligned->len,
1926 else if (r->which == Z_External_grs1)
1933 else if (!strcmp (type, "raw"))
1935 Z_External *r = (Z_External *) npr->u.databaseRecord;
1937 if (r->which == Z_External_sutrs)
1939 if (len) *len = r->u.sutrs->len;
1940 return (const char *) r->u.sutrs->buf;
1942 else if (r->which == Z_External_octet)
1944 if (len) *len = r->u.octet_aligned->len;
1945 return (const char *) r->u.octet_aligned->buf;
1947 else /* grs-1, explain, OPAC, ... */
1950 return (const char *) npr->u.databaseRecord;
1954 else if (!strcmp (type, "ext"))
1957 return (const char *) npr->u.databaseRecord;
1959 else if (!strcmp (type, "opac"))
1962 Z_External *r = (Z_External *) npr->u.databaseRecord;
1963 if (r->which == Z_External_OPAC)
1965 if (!rec->wrbuf_opac)
1966 rec->wrbuf_opac = wrbuf_alloc();
1967 wrbuf_rewind (rec->wrbuf_opac);
1968 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
1969 return record_iconv_return(rec, len,
1970 wrbuf_buf(rec->wrbuf_opac),
1971 wrbuf_len(rec->wrbuf_opac),
1978 static int strcmp_null(const char *v1, const char *v2)
1984 return strcmp(v1, v2);
1987 static void record_cache_add (ZOOM_resultset r, Z_NamePlusRecord *npr,
1990 ZOOM_record_cache rc;
1991 const char *elementSetName =
1992 ZOOM_resultset_option_get (r, "elementSetName");
1993 const char *syntax =
1994 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
1996 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1997 ZOOM_connection_put_event(r->connection, event);
1999 for (rc = r->record_cache; rc; rc = rc->next)
2003 if (strcmp_null(r->schema, rc->schema))
2005 if (strcmp_null(elementSetName,rc->elementSetName))
2007 if (strcmp_null(syntax, rc->syntax))
2009 /* not destroying rc->npr (it's handled by nmem )*/
2011 /* keeping wrbuf_marc too */
2015 rc = (ZOOM_record_cache) odr_malloc (r->odr, sizeof(*rc));
2018 rc->rec.wrbuf_marc = 0;
2019 rc->rec.wrbuf_iconv = 0;
2020 rc->rec.wrbuf_opac = 0;
2022 rc->elementSetName = odr_strdup (r->odr, elementSetName);
2024 rc->elementSetName = 0;
2027 rc->syntax = odr_strdup (r->odr, syntax);
2032 rc->schema = odr_strdup (r->odr, r->schema);
2037 rc->next = r->record_cache;
2038 r->record_cache = rc;
2041 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos)
2043 ZOOM_record_cache rc;
2044 const char *elementSetName =
2045 ZOOM_resultset_option_get (r, "elementSetName");
2046 const char *syntax =
2047 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
2049 for (rc = r->record_cache; rc; rc = rc->next)
2053 if (strcmp_null(r->schema, rc->schema))
2055 if (strcmp_null(elementSetName,rc->elementSetName))
2057 if (strcmp_null(syntax, rc->syntax))
2065 static void handle_records (ZOOM_connection c, Z_Records *sr,
2068 ZOOM_resultset resultset;
2072 switch (c->tasks->which)
2074 case ZOOM_TASK_SEARCH:
2075 resultset = c->tasks->u.search.resultset;
2077 case ZOOM_TASK_RETRIEVE:
2078 resultset = c->tasks->u.retrieve.resultset;
2083 if (sr && sr->which == Z_Records_NSD)
2084 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2085 else if (sr && sr->which == Z_Records_multipleNSD)
2087 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2088 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2090 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2094 if (resultset->count + resultset->start > resultset->size)
2095 resultset->count = resultset->size - resultset->start;
2096 if (resultset->count < 0)
2097 resultset->count = 0;
2098 if (sr && sr->which == Z_Records_DBOSD)
2101 NMEM nmem = odr_extract_mem (c->odr_in);
2102 Z_NamePlusRecordList *p =
2103 sr->u.databaseOrSurDiagnostics;
2104 for (i = 0; i<p->num_records; i++)
2106 record_cache_add (resultset, p->records[i],
2107 i+ resultset->start);
2109 /* transfer our response to search_nmem .. we need it later */
2110 nmem_transfer (resultset->odr->mem, nmem);
2111 nmem_destroy (nmem);
2112 if (present_phase && p->num_records == 0)
2114 /* present response and we didn't get any records! */
2115 Z_NamePlusRecord *myrec =
2116 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2117 record_cache_add(resultset, myrec, resultset->start);
2120 else if (present_phase)
2122 /* present response and we didn't get any records! */
2123 Z_NamePlusRecord *myrec =
2124 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2125 record_cache_add(resultset, myrec, resultset->start);
2130 static void handle_present_response (ZOOM_connection c, Z_PresentResponse *pr)
2132 handle_records (c, pr->records, 1);
2135 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2138 switch (term->which)
2140 case Z_Term_general:
2141 ZOOM_options_setl(opt, name,
2142 (const char *)(term->u.general->buf),
2143 term->u.general->len);
2145 case Z_Term_characterString:
2146 ZOOM_options_set(opt, name, term->u.characterString);
2148 case Z_Term_numeric:
2149 ZOOM_options_set_int(opt, name, *term->u.numeric);
2154 static void handle_queryExpression(ZOOM_options opt, const char *name,
2155 Z_QueryExpression *exp)
2161 case Z_QueryExpression_term:
2162 if (exp->u.term && exp->u.term->queryTerm)
2164 sprintf(opt_name, "%s.term", name);
2165 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2168 case Z_QueryExpression_query:
2173 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2174 Z_OtherInformation *o)
2177 for (i = 0; o && i < o->num_elements; i++)
2179 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2181 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2183 if (ext->which == Z_External_searchResult1)
2186 Z_SearchInfoReport *sr = ext->u.searchResult1;
2189 ZOOM_options_set_int(
2190 resultset->options, "searchresult.size", sr->num);
2192 for (j = 0; j < sr->num; j++)
2194 Z_SearchInfoReport_s *ent =
2195 ext->u.searchResult1->elements[j];
2198 sprintf(pref, "searchresult.%d", j);
2200 if (ent->subqueryId)
2203 sprintf(opt_name, "%s.id", pref);
2204 ZOOM_options_set(resultset->options, opt_name,
2207 if (ent->subqueryExpression)
2210 sprintf(opt_name, "%s.subquery", pref);
2211 handle_queryExpression(resultset->options, opt_name,
2212 ent->subqueryExpression);
2214 if (ent->subqueryInterpretation)
2217 sprintf(opt_name, "%s.interpretation", pref);
2218 handle_queryExpression(resultset->options, opt_name,
2219 ent->subqueryInterpretation);
2221 if (ent->subqueryRecommendation)
2224 sprintf(opt_name, "%s.recommendation", pref);
2225 handle_queryExpression(resultset->options, opt_name,
2226 ent->subqueryRecommendation);
2228 if (ent->subqueryCount)
2231 sprintf(opt_name, "%s.count", pref);
2232 ZOOM_options_set_int(resultset->options, opt_name,
2233 *ent->subqueryCount);
2241 static void handle_search_response (ZOOM_connection c, Z_SearchResponse *sr)
2243 ZOOM_resultset resultset;
2246 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2249 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2250 ZOOM_connection_put_event(c, event);
2252 resultset = c->tasks->u.search.resultset;
2254 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2256 resultset->size = *sr->resultCount;
2257 handle_records (c, sr->records, 0);
2260 static void sort_response (ZOOM_connection c, Z_SortResponse *res)
2262 if (res->diagnostics && res->num_diagnostics > 0)
2263 response_diag (c, res->diagnostics[0]);
2266 static int scan_response (ZOOM_connection c, Z_ScanResponse *res)
2268 NMEM nmem = odr_extract_mem (c->odr_in);
2271 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2273 scan = c->tasks->u.scan.scan;
2275 if (res->entries && res->entries->nonsurrogateDiagnostics)
2276 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2277 scan->scan_response = res;
2278 nmem_transfer (scan->odr->mem, nmem);
2280 ZOOM_options_set_int (scan->options, "stepSize", *res->stepSize);
2281 if (res->positionOfTerm)
2282 ZOOM_options_set_int (scan->options, "position", *res->positionOfTerm);
2283 if (res->scanStatus)
2284 ZOOM_options_set_int (scan->options, "scanStatus", *res->scanStatus);
2285 if (res->numberOfEntriesReturned)
2286 ZOOM_options_set_int (scan->options, "number",
2287 *res->numberOfEntriesReturned);
2288 nmem_destroy (nmem);
2292 static zoom_ret send_sort (ZOOM_connection c,
2293 ZOOM_resultset resultset)
2296 resultset->r_sort_spec = 0;
2297 if (resultset->r_sort_spec)
2299 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2300 Z_SortRequest *req = apdu->u.sortRequest;
2302 req->num_inputResultSetNames = 1;
2303 req->inputResultSetNames = (Z_InternationalString **)
2304 odr_malloc (c->odr_out, sizeof(*req->inputResultSetNames));
2305 req->inputResultSetNames[0] =
2306 odr_strdup (c->odr_out, resultset->setname);
2307 req->sortedResultSetName = odr_strdup (c->odr_out, resultset->setname);
2308 req->sortSequence = resultset->r_sort_spec;
2309 resultset->r_sort_spec = 0;
2310 return send_APDU (c, apdu);
2312 return zoom_complete;
2315 static zoom_ret send_present(ZOOM_connection c)
2318 Z_PresentRequest *req = 0;
2320 const char *syntax = 0;
2321 const char *elementSetName = 0;
2322 ZOOM_resultset resultset;
2326 yaz_log(log_details, "%p send_present no tasks", c);
2327 return zoom_complete;
2329 switch (c->tasks->which)
2331 case ZOOM_TASK_SEARCH:
2332 resultset = c->tasks->u.search.resultset;
2334 case ZOOM_TASK_RETRIEVE:
2335 resultset = c->tasks->u.retrieve.resultset;
2336 resultset->start = c->tasks->u.retrieve.start;
2337 resultset->count = c->tasks->u.retrieve.count;
2339 if (resultset->start >= resultset->size)
2341 yaz_log(log_details, "%p send_present start=%d >= size=%d",
2342 c, resultset->start, resultset->size);
2343 return zoom_complete;
2345 if (resultset->start + resultset->count > resultset->size)
2346 resultset->count = resultset->size - resultset->start;
2349 return zoom_complete;
2351 yaz_log(log_details, "%p send_present start=%d count=%d",
2352 c, resultset->start, resultset->count);
2354 syntax = ZOOM_resultset_option_get (resultset, "preferredRecordSyntax");
2355 elementSetName = ZOOM_resultset_option_get (resultset, "elementSetName");
2357 if (c->error) /* don't continue on error */
2358 return zoom_complete;
2359 if (resultset->start < 0)
2360 return zoom_complete;
2361 for (i = 0; i<resultset->count; i++)
2364 record_cache_lookup (resultset, i + resultset->start);
2368 if (i == resultset->count)
2370 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2371 return zoom_complete;
2374 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2375 req = apdu->u.presentRequest;
2377 resultset->start += i;
2378 resultset->count -= i;
2381 yaz_log(log_details, "%p send_present skip=%d", c, i);
2383 *req->resultSetStartPoint = resultset->start + 1;
2384 *req->numberOfRecordsRequested = resultset->step>0 ?
2385 resultset->step : resultset->count;
2386 assert (*req->numberOfRecordsRequested > 0);
2389 if (syntax && *syntax)
2390 req->preferredRecordSyntax =
2391 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
2393 if (resultset->schema && *resultset->schema)
2395 Z_RecordComposition *compo = (Z_RecordComposition *)
2396 odr_malloc (c->odr_out, sizeof(*compo));
2398 req->recordComposition = compo;
2399 compo->which = Z_RecordComp_complex;
2400 compo->u.complex = (Z_CompSpec *)
2401 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2402 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2403 odr_malloc(c->odr_out, sizeof(bool_t));
2404 *compo->u.complex->selectAlternativeSyntax = 0;
2406 compo->u.complex->generic = (Z_Specification *)
2407 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2409 compo->u.complex->generic->which = Z_Schema_oid;
2410 compo->u.complex->generic->schema.oid = (Odr_oid *)
2411 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2413 if (!compo->u.complex->generic->schema.oid)
2415 /* OID wasn't a schema! Try record syntax instead. */
2417 compo->u.complex->generic->schema.oid = (Odr_oid *)
2418 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2420 if (elementSetName && *elementSetName)
2422 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2423 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2424 compo->u.complex->generic->elementSpec->which =
2425 Z_ElementSpec_elementSetName;
2426 compo->u.complex->generic->elementSpec->u.elementSetName =
2427 odr_strdup (c->odr_out, elementSetName);
2430 compo->u.complex->generic->elementSpec = 0;
2431 compo->u.complex->num_dbSpecific = 0;
2432 compo->u.complex->dbSpecific = 0;
2433 compo->u.complex->num_recordSyntax = 0;
2434 compo->u.complex->recordSyntax = 0;
2436 else if (elementSetName && *elementSetName)
2438 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2439 odr_malloc (c->odr_out, sizeof(*esn));
2440 Z_RecordComposition *compo = (Z_RecordComposition *)
2441 odr_malloc (c->odr_out, sizeof(*compo));
2443 esn->which = Z_ElementSetNames_generic;
2444 esn->u.generic = odr_strdup (c->odr_out, elementSetName);
2445 compo->which = Z_RecordComp_simple;
2446 compo->u.simple = esn;
2447 req->recordComposition = compo;
2449 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2450 return send_APDU (c, apdu);
2453 ZOOM_API(ZOOM_scanset)
2454 ZOOM_connection_scan (ZOOM_connection c, const char *start)
2457 ZOOM_query q = ZOOM_query_create();
2459 ZOOM_query_prefix (q, start);
2461 s = ZOOM_connection_scan1(c, q);
2462 ZOOM_query_destroy (q);
2467 ZOOM_API(ZOOM_scanset)
2468 ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query q)
2470 ZOOM_scanset scan = (ZOOM_scanset) xmalloc (sizeof(*scan));
2474 scan->connection = c;
2475 scan->odr = odr_createmem (ODR_DECODE);
2476 scan->options = ZOOM_options_create_with_parent (c->options);
2478 scan->scan_response = 0;
2481 * We need to check the query-type, so we can recognise CQL and
2482 * compile it into a form that we can use here. The ZOOM_query
2483 * structure has no explicit `type' member, but inspection of the
2484 * ZOOM_query_prefix() and ZOOM_query_cql() functions shows how
2485 * the structure is set up in each case.
2488 if (q->z_query->which == Z_Query_type_1) {
2489 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2490 c, q, q->query_string);
2491 start = q->query_string;
2492 } else if (q->z_query->which == Z_Query_type_104) {
2493 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2494 c, q, q->query_string);
2495 start = freeme = cql2pqf(c, q->query_string);
2499 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2500 c, q, q->query_string);
2504 scan->termListAndStartPoint =
2505 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2507 if (scan->termListAndStartPoint != 0)
2509 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_SCAN);
2510 task->u.scan.scan = scan;
2515 while (ZOOM_event (1, &c))
2523 ZOOM_scanset_destroy (ZOOM_scanset scan)
2528 if (scan->refcount == 0)
2530 odr_destroy (scan->odr);
2532 ZOOM_options_destroy (scan->options);
2537 static zoom_ret send_package (ZOOM_connection c)
2541 yaz_log(log_details, "%p send_package", c);
2543 return zoom_complete;
2544 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2546 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
2547 ZOOM_connection_put_event (c, event);
2549 return do_write_ex (c, c->tasks->u.package->buf_out,
2550 c->tasks->u.package->len_out);
2553 static zoom_ret send_scan (ZOOM_connection c)
2556 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2557 Z_ScanRequest *req = apdu->u.scanRequest;
2559 yaz_log(log_details, "%p send_scan", c);
2561 return zoom_complete;
2562 assert (c->tasks->which == ZOOM_TASK_SCAN);
2563 scan = c->tasks->u.scan.scan;
2565 req->termListAndStartPoint = scan->termListAndStartPoint;
2566 req->attributeSet = scan->attributeSet;
2568 *req->numberOfTermsRequested =
2569 ZOOM_options_get_int(scan->options, "number", 10);
2571 req->preferredPositionInResponse =
2572 odr_intdup (c->odr_out,
2573 ZOOM_options_get_int(scan->options, "position", 1));
2576 odr_intdup (c->odr_out,
2577 ZOOM_options_get_int(scan->options, "stepSize", 0));
2579 req->databaseNames = set_DatabaseNames (c, scan->options,
2580 &req->num_databaseNames);
2582 return send_APDU (c, apdu);
2586 ZOOM_scanset_size (ZOOM_scanset scan)
2588 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2590 return scan->scan_response->entries->num_entries;
2593 ZOOM_API(const char *)
2594 ZOOM_scanset_term (ZOOM_scanset scan, size_t pos,
2597 const char *term = 0;
2598 size_t noent = ZOOM_scanset_size (scan);
2599 Z_ScanResponse *res = scan->scan_response;
2605 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2607 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2609 if (t->term->which == Z_Term_general)
2611 term = (const char *) t->term->u.general->buf;
2612 *len = t->term->u.general->len;
2614 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2619 ZOOM_API(const char *)
2620 ZOOM_scanset_display_term (ZOOM_scanset scan, size_t pos,
2623 const char *term = 0;
2624 size_t noent = ZOOM_scanset_size (scan);
2625 Z_ScanResponse *res = scan->scan_response;
2631 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2633 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2637 term = t->displayTerm;
2638 *len = strlen(term);
2640 else if (t->term->which == Z_Term_general)
2642 term = (const char *) t->term->u.general->buf;
2643 *len = t->term->u.general->len;
2645 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2650 ZOOM_API(const char *)
2651 ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key)
2653 return ZOOM_options_get (scan->options, key);
2657 ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
2660 ZOOM_options_set (scan->options, key, val);
2663 static Z_APDU *create_es_package (ZOOM_package p, int type)
2666 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2667 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2669 *req->function = Z_ExtendedServicesRequest_create;
2671 str = ZOOM_options_get(p->options, "package-name");
2673 req->packageName = nmem_strdup (p->odr_out->mem, str);
2675 str = ZOOM_options_get(p->options, "user-id");
2677 req->userId = nmem_strdup (p->odr_out->mem, str);
2679 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2682 str = ZOOM_options_get(p->options, "function");
2685 if (!strcmp (str, "create"))
2687 if (!strcmp (str, "delete"))
2689 if (!strcmp (str, "modify"))
2695 static const char *ill_array_lookup (void *clientData, const char *idx)
2697 ZOOM_package p = (ZOOM_package) clientData;
2698 return ZOOM_options_get (p->options, idx+4);
2701 static Z_External *encode_ill_request (ZOOM_package p)
2703 ODR out = p->odr_out;
2706 struct ill_get_ctl ctl;
2708 ctl.odr = p->odr_out;
2710 ctl.f = ill_array_lookup;
2712 req = ill_get_ILLRequest(&ctl, "ill", 0);
2714 if (!ill_Request (out, &req, 0, 0))
2716 int ill_request_size;
2717 char *ill_request_buf = odr_getbuf (out, &ill_request_size, 0);
2718 if (ill_request_buf)
2719 odr_setbuf (out, ill_request_buf, ill_request_size, 1);
2725 int illRequest_size = 0;
2726 char *illRequest_buf = odr_getbuf (out, &illRequest_size, 0);
2728 oid.proto = PROTO_GENERAL;
2729 oid.oclass = CLASS_GENERAL;
2730 oid.value = VAL_ISO_ILL_1;
2732 r = (Z_External *) odr_malloc (out, sizeof(*r));
2733 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2734 r->indirect_reference = 0;
2736 r->which = Z_External_single;
2738 r->u.single_ASN1_type =
2739 odr_create_Odr_oct(out,
2740 (unsigned char *)illRequest_buf,
2746 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2748 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc (p->odr_out, sizeof(*req));
2751 req->which = Z_IOItemOrder_esRequest;
2752 req->u.esRequest = (Z_IORequest *)
2753 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2755 /* to keep part ... */
2756 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2757 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2758 req->u.esRequest->toKeep->supplDescription = 0;
2759 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2760 odr_malloc (p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2762 str = ZOOM_options_get(p->options, "contact-name");
2763 req->u.esRequest->toKeep->contact->name = str ?
2764 nmem_strdup (p->odr_out->mem, str) : 0;
2766 str = ZOOM_options_get(p->options, "contact-phone");
2767 req->u.esRequest->toKeep->contact->phone = str ?
2768 nmem_strdup (p->odr_out->mem, str) : 0;
2770 str = ZOOM_options_get(p->options, "contact-email");
2771 req->u.esRequest->toKeep->contact->email = str ?
2772 nmem_strdup (p->odr_out->mem, str) : 0;
2774 req->u.esRequest->toKeep->addlBilling = 0;
2776 /* not to keep part ... */
2777 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2778 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2780 str = ZOOM_options_get(p->options, "itemorder-setname");
2785 req->u.esRequest->notToKeep->resultSetItem = 0;
2788 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2789 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2791 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2792 nmem_strdup (p->odr_out->mem, str);
2793 req->u.esRequest->notToKeep->resultSetItem->item =
2794 (int *) odr_malloc(p->odr_out, sizeof(int));
2796 str = ZOOM_options_get(p->options, "itemorder-item");
2797 *req->u.esRequest->notToKeep->resultSetItem->item =
2798 (str ? atoi(str) : 1);
2800 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2805 Z_APDU *create_admin_package(ZOOM_package p, int type,
2806 Z_ESAdminOriginPartToKeep **toKeepP,
2807 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2809 Z_APDU *apdu = create_es_package (p, VAL_ADMINSERVICE);
2812 Z_ESAdminOriginPartToKeep *toKeep;
2813 Z_ESAdminOriginPartNotToKeep *notToKeep;
2814 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2815 const char *first_db = "Default";
2817 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2821 r->direct_reference =
2822 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2825 r->indirect_reference = 0;
2826 r->which = Z_External_ESAdmin;
2828 r->u.adminService = (Z_Admin *)
2829 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2830 r->u.adminService->which = Z_Admin_esRequest;
2831 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2832 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2834 toKeep = r->u.adminService->u.esRequest->toKeep =
2835 (Z_ESAdminOriginPartToKeep *)
2836 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2837 toKeep->which = type;
2838 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2839 toKeep->u.create = odr_nullval();
2840 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2842 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2843 (Z_ESAdminOriginPartNotToKeep *)
2844 odr_malloc(p->odr_out,
2845 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2846 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
2847 notToKeep->u.recordsWillFollow = odr_nullval();
2851 *notToKeepP = notToKeep;
2856 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
2858 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
2859 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2860 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
2861 const char *doc = ZOOM_options_get(p->options, "doc");
2866 req->taskSpecificParameters = ext;
2867 ext->direct_reference = req->packageType;
2868 ext->descriptor = 0;
2869 ext->indirect_reference = 0;
2871 ext->which = Z_External_octet;
2872 ext->u.single_ASN1_type =
2873 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
2878 static Z_APDU *create_update_package(ZOOM_package p)
2881 const char *first_db = "Default";
2883 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2884 const char *action = ZOOM_options_get(p->options, "action");
2885 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
2886 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
2887 const char *record_buf = ZOOM_options_get(p->options, "record");
2888 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
2889 int syntax_oid = VAL_NONE;
2893 syntax_oid = oid_getvalbyname(syntax_str);
2896 record_buf = "void";
2897 syntax_oid = VAL_SUTRS;
2899 if (syntax_oid == VAL_NONE)
2900 syntax_oid = VAL_TEXT_XML;
2906 action = "specialUpdate";
2908 if (!strcmp(action, "recordInsert"))
2909 action_no = Z_IUOriginPartToKeep_recordInsert;
2910 else if (!strcmp(action, "recordReplace"))
2911 action_no = Z_IUOriginPartToKeep_recordReplace;
2912 else if (!strcmp(action, "recordDelete"))
2913 action_no = Z_IUOriginPartToKeep_recordDelete;
2914 else if (!strcmp(action, "elementUpdate"))
2915 action_no = Z_IUOriginPartToKeep_elementUpdate;
2916 else if (!strcmp(action, "specialUpdate"))
2917 action_no = Z_IUOriginPartToKeep_specialUpdate;
2921 apdu = create_es_package (p, VAL_DBUPDATE);
2924 Z_IUOriginPartToKeep *toKeep;
2925 Z_IUSuppliedRecords *notToKeep;
2926 Z_External *r = (Z_External *)
2927 odr_malloc (p->odr_out, sizeof(*r));
2929 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2931 r->direct_reference =
2932 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2935 r->which = Z_External_update;
2936 r->indirect_reference = 0;
2937 r->u.update = (Z_IUUpdate *)
2938 odr_malloc(p->odr_out, sizeof(*r->u.update));
2940 r->u.update->which = Z_IUUpdate_esRequest;
2941 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
2942 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
2943 toKeep = r->u.update->u.esRequest->toKeep =
2944 (Z_IUOriginPartToKeep *)
2945 odr_malloc(p->odr_out, sizeof(*toKeep));
2947 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2949 toKeep->elementSetName = 0;
2950 toKeep->actionQualifier = 0;
2951 toKeep->action = odr_intdup(p->odr_out, action_no);
2953 notToKeep = r->u.update->u.esRequest->notToKeep =
2954 (Z_IUSuppliedRecords *)
2955 odr_malloc(p->odr_out, sizeof(*notToKeep));
2957 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
2958 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
2959 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
2960 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
2961 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
2964 notToKeep->elements[0]->u.opaque =
2965 odr_create_Odr_oct(p->odr_out,
2966 (const unsigned char *) recordIdOpaque,
2967 strlen(recordIdOpaque));
2969 else if (recordIdNumber)
2971 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
2973 notToKeep->elements[0]->u.number =
2974 odr_intdup(p->odr_out, atoi(recordIdNumber));
2977 notToKeep->elements[0]->u.opaque = 0;
2978 notToKeep->elements[0]->supplementalId = 0;
2979 notToKeep->elements[0]->correlationInfo = 0;
2980 notToKeep->elements[0]->record =
2981 z_ext_record(p->odr_out, syntax_oid,
2982 record_buf, strlen(record_buf));
2986 ODR print = odr_createmem(ODR_PRINT);
2988 z_APDU(print, &apdu, 0, 0);
2995 ZOOM_package_send (ZOOM_package p, const char *type)
3002 odr_reset (p->odr_out);
3005 if (!strcmp(type, "itemorder"))
3007 apdu = create_es_package (p, VAL_ITEMORDER);
3010 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
3012 r->direct_reference =
3013 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3016 r->which = Z_External_itemOrder;
3017 r->indirect_reference = 0;
3018 r->u.itemOrder = encode_item_order (p);
3020 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3023 else if (!strcmp(type, "create")) /* create database */
3025 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3028 else if (!strcmp(type, "drop")) /* drop database */
3030 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3033 else if (!strcmp(type, "commit")) /* commit changes */
3035 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3038 else if (!strcmp(type, "update")) /* update record(s) */
3040 apdu = create_update_package(p);
3042 else if (!strcmp(type, "xmlupdate"))
3044 apdu = create_xmlupdate_package(p);
3048 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3052 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_PACKAGE);
3053 task->u.package = p;
3054 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3055 p->buf_out = (char *) xmalloc (p->len_out);
3056 memcpy (p->buf_out, buf, p->len_out);
3061 while (ZOOM_event (1, &c))
3068 ZOOM_API(ZOOM_package)
3069 ZOOM_connection_package (ZOOM_connection c, ZOOM_options options)
3071 ZOOM_package p = (ZOOM_package) xmalloc (sizeof(*p));
3074 p->odr_out = odr_createmem (ODR_ENCODE);
3075 p->options = ZOOM_options_create_with_parent2 (options, c->options);
3083 ZOOM_package_destroy(ZOOM_package p)
3088 if (p->refcount == 0)
3090 odr_destroy (p->odr_out);
3093 ZOOM_options_destroy (p->options);
3098 ZOOM_API(const char *)
3099 ZOOM_package_option_get (ZOOM_package p, const char *key)
3101 return ZOOM_options_get (p->options, key);
3106 ZOOM_package_option_set (ZOOM_package p, const char *key,
3109 ZOOM_options_set (p->options, key, val);
3112 static int ZOOM_connection_exec_task (ZOOM_connection c)
3114 ZOOM_task task = c->tasks;
3115 zoom_ret ret = zoom_complete;
3119 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3120 c, task->which, task->running);
3121 if (c->error != ZOOM_ERROR_NONE)
3123 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3124 "removing tasks because of error = %d", c, c->error);
3125 ZOOM_connection_remove_tasks (c);
3130 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3131 "task already running", c);
3135 ret = zoom_complete;
3136 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3138 switch (task->which)
3140 case ZOOM_TASK_SEARCH:
3141 if (c->proto == PROTO_HTTP)
3142 ret = ZOOM_connection_srw_send_search(c);
3144 ret = ZOOM_connection_send_search(c);
3146 case ZOOM_TASK_RETRIEVE:
3147 if (c->proto == PROTO_HTTP)
3148 ret = ZOOM_connection_srw_send_search(c);
3150 ret = send_present (c);
3152 case ZOOM_TASK_CONNECT:
3153 ret = do_connect(c);
3155 case ZOOM_TASK_SCAN:
3158 case ZOOM_TASK_PACKAGE:
3159 ret = send_package(c);
3161 case ZOOM_TASK_SORT:
3162 c->tasks->u.sort.resultset->r_sort_spec =
3163 c->tasks->u.sort.q->sort_spec;
3164 ret = send_sort(c, c->tasks->u.sort.resultset);
3170 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3171 "remove tasks because no connection exist", c);
3172 ZOOM_connection_remove_tasks (c);
3174 if (ret == zoom_complete)
3176 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3177 "task removed (complete)", c);
3178 ZOOM_connection_remove_task (c);
3181 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3186 static zoom_ret send_sort_present (ZOOM_connection c)
3188 zoom_ret r = zoom_complete;
3190 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3191 r = send_sort (c, c->tasks->u.search.resultset);
3192 if (r == zoom_complete)
3193 r = send_present (c);
3197 static int es_response (ZOOM_connection c,
3198 Z_ExtendedServicesResponse *res)
3200 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3202 if (res->diagnostics && res->num_diagnostics > 0)
3203 response_diag(c, res->diagnostics[0]);
3204 if (res->taskPackage &&
3205 res->taskPackage->which == Z_External_extendedService)
3207 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3208 Odr_oct *id = taskPackage->targetReference;
3211 ZOOM_options_setl (c->tasks->u.package->options,
3212 "targetReference", (char*) id->buf, id->len);
3214 if (res->taskPackage &&
3215 res->taskPackage->which == Z_External_octet)
3217 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3218 ZOOM_options_setl (c->tasks->u.package->options,
3219 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3224 static void interpret_init_diag(ZOOM_connection c,
3225 Z_DiagnosticFormat *diag)
3229 Z_DiagnosticFormat_s *ds = diag->elements[0];
3230 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3231 response_default_diag(c, ds->u.defaultDiagRec);
3236 static void interpret_otherinformation_field(ZOOM_connection c,
3237 Z_OtherInformation *ui)
3240 for (i = 0; i < ui->num_elements; i++)
3242 Z_OtherInformationUnit *unit = ui->list[i];
3243 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3244 unit->information.externallyDefinedInfo &&
3245 unit->information.externallyDefinedInfo->which ==
3248 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3253 static void recv_apdu (ZOOM_connection c, Z_APDU *apdu)
3255 Z_InitResponse *initrs;
3258 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3261 case Z_APDU_initResponse:
3262 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3263 initrs = apdu->u.initResponse;
3264 ZOOM_connection_option_set(c, "serverImplementationId",
3265 initrs->implementationId ?
3266 initrs->implementationId : "");
3267 ZOOM_connection_option_set(c, "serverImplementationName",
3268 initrs->implementationName ?
3269 initrs->implementationName : "");
3270 ZOOM_connection_option_set(c, "serverImplementationVersion",
3271 initrs->implementationVersion ?
3272 initrs->implementationVersion : "");
3273 /* Set the three old options too, for old applications */
3274 ZOOM_connection_option_set(c, "targetImplementationId",
3275 initrs->implementationId ?
3276 initrs->implementationId : "");
3277 ZOOM_connection_option_set(c, "targetImplementationName",
3278 initrs->implementationName ?
3279 initrs->implementationName : "");
3280 ZOOM_connection_option_set(c, "targetImplementationVersion",
3281 initrs->implementationVersion ?
3282 initrs->implementationVersion : "");
3283 if (!*initrs->result)
3285 Z_External *uif = initrs->userInformationField;
3287 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3289 if (uif && uif->which == Z_External_userInfo1)
3290 interpret_otherinformation_field(c, uif->u.userInfo1);
3295 yaz_oi_get_string_oidval (&apdu->u.initResponse->otherInfo,
3297 xfree (c->cookie_in);
3300 c->cookie_in = xstrdup(cookie);
3301 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3302 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3303 c->support_named_resultsets = 1;
3306 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3307 ZOOM_connection_remove_task (c);
3309 ZOOM_connection_exec_task (c);
3311 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3313 NMEM tmpmem = nmem_create();
3314 Z_CharSetandLanguageNegotiation *p =
3315 yaz_get_charneg_record(initrs->otherInfo);
3319 char *charset = NULL, *lang = NULL;
3322 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3323 yaz_log(log_details, "%p recv_apdu target accepted: "
3324 "charset %s, language %s, select %d",
3326 charset ? charset : "none", lang ? lang : "none", sel);
3328 ZOOM_connection_option_set (c, "negotiation-charset",
3331 ZOOM_connection_option_set (c, "negotiation-lang",
3334 ZOOM_connection_option_set (
3335 c, "negotiation-charset-in-effect-for-records",
3336 (sel != 0) ? "1" : "0");
3337 nmem_destroy(tmpmem);
3341 case Z_APDU_searchResponse:
3342 yaz_log(log_api, "%p recv_apdu Search response", c);
3343 handle_search_response (c, apdu->u.searchResponse);
3344 if (send_sort_present (c) == zoom_complete)
3345 ZOOM_connection_remove_task (c);
3347 case Z_APDU_presentResponse:
3348 yaz_log(log_api, "%p recv_apdu Present response", c);
3349 handle_present_response (c, apdu->u.presentResponse);
3350 if (send_present (c) == zoom_complete)
3351 ZOOM_connection_remove_task (c);
3353 case Z_APDU_sortResponse:
3354 yaz_log(log_api, "%p recv_apdu Sort response", c);
3355 sort_response (c, apdu->u.sortResponse);
3356 if (send_present (c) == zoom_complete)
3357 ZOOM_connection_remove_task (c);
3359 case Z_APDU_scanResponse:
3360 yaz_log(log_api, "%p recv_apdu Scan response", c);
3361 scan_response (c, apdu->u.scanResponse);
3362 ZOOM_connection_remove_task (c);
3364 case Z_APDU_extendedServicesResponse:
3365 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3366 es_response (c, apdu->u.extendedServicesResponse);
3367 ZOOM_connection_remove_task (c);
3370 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3371 if (c->reconnect_ok)
3374 c->tasks->running = 0;
3375 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3379 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3384 yaz_log(log_api, "%p Received unknown PDU", c);
3385 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3391 static void handle_srw_response(ZOOM_connection c,
3392 Z_SRW_searchRetrieveResponse *res)
3394 ZOOM_resultset resultset = 0;
3402 if (c->tasks->which == ZOOM_TASK_SEARCH)
3403 resultset = c->tasks->u.search.resultset;
3404 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
3405 resultset = c->tasks->u.retrieve.resultset;
3409 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3410 ZOOM_connection_put_event(c, event);
3412 resultset->size = 0;
3414 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3416 if (res->numberOfRecords)
3417 resultset->size = *res->numberOfRecords;
3419 for (i = 0; i<res->num_records; i++)
3423 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3424 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3426 if (res->records[i].recordPosition &&
3427 *res->records[i].recordPosition > 0)
3428 pos = *res->records[i].recordPosition - 1;
3430 pos = resultset->start + i;
3432 npr->databaseName = 0;
3433 npr->which = Z_NamePlusRecord_databaseRecord;
3434 npr->u.databaseRecord = (Z_External *)
3435 odr_malloc(c->odr_in, sizeof(Z_External));
3436 npr->u.databaseRecord->descriptor = 0;
3437 npr->u.databaseRecord->direct_reference =
3438 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3439 npr->u.databaseRecord->which = Z_External_octet;
3441 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3442 odr_malloc(c->odr_in, sizeof(Odr_oct));
3443 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3444 res->records[i].recordData_buf;
3445 npr->u.databaseRecord->u.octet_aligned->len =
3446 npr->u.databaseRecord->u.octet_aligned->size =
3447 res->records[i].recordData_len;
3448 record_cache_add (resultset, npr, pos);
3450 if (res->num_diagnostics > 0)
3452 const char *uri = res->diagnostics[0].uri;
3457 if ((cp = strrchr(uri, '/')))
3459 set_dset_error(c, code, uri,
3460 res->diagnostics[0].details, 0);
3463 nmem = odr_extract_mem(c->odr_in);
3464 nmem_transfer(resultset->odr->mem, nmem);
3470 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3473 const char *content_type = z_HTTP_header_lookup(hres->headers,
3475 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3478 yaz_log(log_details, "%p handle_http", c);
3480 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3482 Z_SOAP *soap_package = 0;
3484 Z_SOAP_Handler soap_handlers[2] = {
3485 {"http://www.loc.gov/zing/srw/", 0,
3486 (Z_SOAP_fun) yaz_srw_codec},
3489 ret = z_soap_codec(o, &soap_package,
3490 &hres->content_buf, &hres->content_len,
3492 if (!ret && soap_package->which == Z_SOAP_generic &&
3493 soap_package->u.generic->no == 0)
3495 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3496 if (sr->which == Z_SRW_searchRetrieve_response)
3497 handle_srw_response(c, sr->u.response);
3501 else if (!ret && (soap_package->which == Z_SOAP_fault
3502 || soap_package->which == Z_SOAP_error))
3504 set_HTTP_error(c, hres->code,
3505 soap_package->u.fault->fault_code,
3506 soap_package->u.fault->fault_string);
3513 if (hres->code != 200)
3514 set_HTTP_error(c, hres->code, 0, 0);
3516 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3519 ZOOM_connection_remove_task(c);
3520 if (!strcmp(hres->version, "1.0"))
3522 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3523 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3528 /* HTTP 1.1: only if no close we stay alive .. */
3529 if (connection_head && !strcmp(connection_head, "close"))
3535 static int do_read (ZOOM_connection c)
3540 event = ZOOM_Event_create (ZOOM_EVENT_RECV_DATA);
3541 ZOOM_connection_put_event (c, event);
3543 r = cs_get (c->cs, &c->buf_in, &c->len_in);
3544 more = cs_more(c->cs);
3545 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3550 if (c->reconnect_ok)
3553 c->reconnect_ok = 0;
3554 yaz_log(log_details, "%p do_read reconnect read", c);
3555 c->tasks->running = 0;
3556 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3560 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3569 odr_reset (c->odr_in);
3570 odr_setbuf (c->odr_in, c->buf_in, r, 0);
3571 event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);
3572 ZOOM_connection_put_event (c, event);
3574 if (!z_GDU (c->odr_in, &gdu, 0, 0))
3577 int err = odr_geterrorx(c->odr_in, &x);
3579 const char *element = odr_getelement(c->odr_in);
3580 sprintf (msg, "ODR code %d:%d element=%-20s",
3581 err, x, element ? element : "<unknown>");
3582 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3585 else if (gdu->which == Z_GDU_Z3950)
3586 recv_apdu (c, gdu->u.z3950);
3587 else if (gdu->which == Z_GDU_HTTP_Response)
3590 handle_http (c, gdu->u.HTTP_Response);
3592 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3596 c->reconnect_ok = 0;
3601 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out)
3606 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3607 ZOOM_connection_put_event (c, event);
3609 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3610 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3612 yaz_log(log_details, "%p do_write_ex write failed", c);
3613 if (c->reconnect_ok)
3616 c->reconnect_ok = 0;
3617 yaz_log(log_details, "%p do_write_ex reconnect write", c);
3618 c->tasks->running = 0;
3619 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3620 return zoom_pending;
3622 if (c->state == STATE_CONNECTING)
3623 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3625 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3627 return zoom_complete;
3631 c->mask = ZOOM_SELECT_EXCEPT;
3632 if (c->cs->io_pending & CS_WANT_WRITE)
3633 c->mask += ZOOM_SELECT_WRITE;
3634 if (c->cs->io_pending & CS_WANT_READ)
3635 c->mask += ZOOM_SELECT_READ;
3636 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3641 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3642 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3645 return zoom_pending;
3648 static zoom_ret do_write(ZOOM_connection c)
3650 return do_write_ex (c, c->buf_out, c->len_out);
3654 ZOOM_API(const char *)
3655 ZOOM_connection_option_get (ZOOM_connection c, const char *key)
3657 return ZOOM_options_get (c->options, key);
3660 ZOOM_API(const char *)
3661 ZOOM_connection_option_getl (ZOOM_connection c, const char *key, int *lenp)
3663 return ZOOM_options_getl (c->options, key, lenp);
3667 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
3670 ZOOM_options_set (c->options, key, val);
3674 ZOOM_connection_option_setl (ZOOM_connection c, const char *key,
3675 const char *val, int len)
3677 ZOOM_options_setl (c->options, key, val, len);
3680 ZOOM_API(const char *)
3681 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key)
3683 return ZOOM_options_get (r->options, key);
3687 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key,
3690 ZOOM_options_set (r->options, key, val);
3695 ZOOM_connection_errcode (ZOOM_connection c)
3697 return ZOOM_connection_error (c, 0, 0);
3700 ZOOM_API(const char *)
3701 ZOOM_connection_errmsg (ZOOM_connection c)
3704 ZOOM_connection_error (c, &msg, 0);
3708 ZOOM_API(const char *)
3709 ZOOM_connection_addinfo (ZOOM_connection c)
3711 const char *addinfo;
3712 ZOOM_connection_error (c, 0, &addinfo);
3716 ZOOM_API(const char *)
3717 ZOOM_connection_diagset (ZOOM_connection c)
3719 const char *diagset;
3720 ZOOM_connection_error_x (c, 0, 0, &diagset);
3724 ZOOM_API(const char *)
3725 ZOOM_diag_str (int error)
3729 case ZOOM_ERROR_NONE:
3731 case ZOOM_ERROR_CONNECT:
3732 return "Connect failed";
3733 case ZOOM_ERROR_MEMORY:
3734 return "Out of memory";
3735 case ZOOM_ERROR_ENCODE:
3736 return "Encoding failed";
3737 case ZOOM_ERROR_DECODE:
3738 return "Decoding failed";
3739 case ZOOM_ERROR_CONNECTION_LOST:
3740 return "Connection lost";
3741 case ZOOM_ERROR_INIT:
3742 return "Init rejected";
3743 case ZOOM_ERROR_INTERNAL:
3744 return "Internal failure";
3745 case ZOOM_ERROR_TIMEOUT:
3747 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3748 return "Unsupported protocol";
3749 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3750 return "Unsupported query type";
3751 case ZOOM_ERROR_INVALID_QUERY:
3752 return "Invalid query";
3753 case ZOOM_ERROR_CQL_PARSE:
3754 return "CQL parsing error";
3755 case ZOOM_ERROR_CQL_TRANSFORM:
3756 return "CQL transformation error";
3758 return diagbib1_str (error);
3763 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
3764 const char **addinfo, const char **diagset)
3766 int error = c->error;
3769 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3770 *cp = ZOOM_diag_str(error);
3771 else if (!strcmp(c->diagset, "HTTP"))
3772 *cp = z_HTTP_errmsg(c->error);
3773 else if (!strcmp(c->diagset, "Bib-1"))
3774 *cp = ZOOM_diag_str(error);
3775 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3776 *cp = yaz_diag_srw_str(c->error);
3778 *cp = "Unknown error and diagnostic set";
3781 *addinfo = c->addinfo ? c->addinfo : "";
3783 *diagset = c->diagset ? c->diagset : "";
3788 ZOOM_connection_error (ZOOM_connection c, const char **cp,
3789 const char **addinfo)
3791 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3794 static int ZOOM_connection_do_io(ZOOM_connection c, int mask)
3796 ZOOM_Event event = 0;
3797 int r = cs_look(c->cs);
3798 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
3803 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3804 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3806 ZOOM_connection_put_event (c, event);
3808 else if (r == CS_CONNECT)
3811 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3813 ret = cs_rcvconnect (c->cs);
3814 yaz_log(log_details, "%p ZOOM_connection_do_io "
3815 "cs_rcvconnect returned %d", c, ret);
3818 c->mask = ZOOM_SELECT_EXCEPT;
3819 if (c->cs->io_pending & CS_WANT_WRITE)
3820 c->mask += ZOOM_SELECT_WRITE;
3821 if (c->cs->io_pending & CS_WANT_READ)
3822 c->mask += ZOOM_SELECT_READ;
3823 ZOOM_connection_put_event (c, event);
3827 ZOOM_connection_put_event (c, event);
3829 if (c->proto == PROTO_Z3950)
3830 ZOOM_connection_send_init(c);
3833 /* no init request for SRW .. */
3834 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3835 ZOOM_connection_remove_task (c);
3837 ZOOM_connection_exec_task (c);
3839 c->state = STATE_ESTABLISHED;
3843 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3845 ZOOM_connection_put_event (c, event);
3850 if (mask & ZOOM_SELECT_READ)
3852 if (c->cs && (mask & ZOOM_SELECT_WRITE))
3859 ZOOM_connection_last_event(ZOOM_connection cs)
3862 return ZOOM_EVENT_NONE;
3863 return cs->last_event;
3867 ZOOM_event (int no, ZOOM_connection *cs)
3869 int timeout = 30; /* default timeout in seconds */
3870 int timeout_set = 0; /* whether it was overriden at all */
3872 struct pollfd pollfds[1024];
3873 ZOOM_connection poll_cs[1024];
3876 fd_set input, output, except;
3881 for (i = 0; i<no; i++)
3883 ZOOM_connection c = cs[i];
3885 if (c && (event = ZOOM_connection_get_event(c)))
3887 ZOOM_Event_destroy (event);
3891 for (i = 0; i<no; i++)
3893 ZOOM_connection c = cs[i];
3895 if (c && ZOOM_connection_exec_task (c))
3897 if ((event = ZOOM_connection_get_event(c)))
3899 ZOOM_Event_destroy (event);
3912 for (i = 0; i<no; i++)
3914 ZOOM_connection c = cs[i];
3920 fd = z3950_connection_socket(c);
3921 mask = z3950_connection_mask(c);
3928 /* -1 is used for indefinite timeout (no timeout), so -2 here. */
3929 this_timeout = ZOOM_options_get_int (c->options, "timeout", -2);
3930 if (this_timeout != -2)
3932 /* ensure the minimum timeout is used */
3934 timeout = this_timeout;
3935 else if (this_timeout != -1 && this_timeout < timeout)
3936 timeout = this_timeout;
3942 short poll_events = 0;
3944 if (mask & ZOOM_SELECT_READ)
3945 poll_events += POLLIN;
3946 if (mask & ZOOM_SELECT_WRITE)
3947 poll_events += POLLOUT;
3948 if (mask & ZOOM_SELECT_EXCEPT)
3949 poll_events += POLLERR;
3950 pollfds[nfds].fd = fd;
3951 pollfds[nfds].events = poll_events;
3952 pollfds[nfds].revents = 0;
3957 if (mask & ZOOM_SELECT_READ)
3959 FD_SET (fd, &input);
3962 if (mask & ZOOM_SELECT_WRITE)
3964 FD_SET (fd, &output);
3967 if (mask & ZOOM_SELECT_EXCEPT)
3969 FD_SET (fd, &except);
3978 r = poll (pollfds, nfds, (timeout == -1 ? -1 : timeout * 1000));
3979 for (i = 0; i<nfds; i++)
3981 ZOOM_connection c = poll_cs[i];
3985 if (pollfds[i].revents & POLLIN)
3986 mask += ZOOM_SELECT_READ;
3987 if (pollfds[i].revents & POLLOUT)
3988 mask += ZOOM_SELECT_WRITE;
3989 if (pollfds[i].revents & POLLERR)
3990 mask += ZOOM_SELECT_EXCEPT;
3992 ZOOM_connection_do_io(c, mask);
3994 else if (r == 0 && c->mask)
3996 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3997 /* timeout and this connection was waiting */
3998 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4000 ZOOM_connection_put_event(c, event);
4004 tv.tv_sec = timeout;
4006 r = select (max_fd+1, &input, &output, &except, (timeout == -1 ? 0 : &tv));
4007 for (i = 0; i<no; i++)
4009 ZOOM_connection c = cs[i];
4014 fd = z3950_connection_socket(c);
4018 /* no timeout and real socket */
4019 if (FD_ISSET(fd, &input))
4020 mask += ZOOM_SELECT_READ;
4021 if (FD_ISSET(fd, &output))
4022 mask += ZOOM_SELECT_WRITE;
4023 if (FD_ISSET(fd, &except))
4024 mask += ZOOM_SELECT_EXCEPT;
4026 ZOOM_connection_do_io(c, mask);
4028 if (r == 0 && c->mask)
4030 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4031 /* timeout and this connection was waiting */
4032 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4034 ZOOM_connection_put_event(c, event);
4038 for (i = 0; i<no; i++)
4040 ZOOM_connection c = cs[i];
4042 if (c && (event = ZOOM_connection_get_event(c)))
4044 ZOOM_Event_destroy (event);
4053 * Returns an xmalloc()d string containing RPN that corresponds to the
4054 * CQL passed in. On error, sets the Connection object's error state
4055 * and returns a null pointer.
4056 * ### We could cache CQL parser and/or transformer in Connection.
4058 static char *cql2pqf(ZOOM_connection c, const char *cql)
4062 struct cql_node *node;
4063 const char *cqlfile;
4064 static cql_transform_t trans;
4067 parser = cql_parser_create();
4068 if ((error = cql_parser_string(parser, cql)) != 0) {
4069 cql_parser_destroy(parser);
4070 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4074 node = cql_parser_result(parser);
4075 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4077 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4079 cql_parser_destroy(parser);
4080 cql_node_destroy(node);
4081 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4085 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4087 cql_parser_destroy(parser);
4088 cql_node_destroy(node);
4089 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4090 cqlfile, strerror(errno));
4091 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4095 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4096 cql_parser_destroy(parser);
4097 cql_node_destroy(node);
4100 const char *addinfo;
4101 error = cql_transform_error(trans, &addinfo);
4102 cql_transform_close(trans);
4103 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4104 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4108 cql_transform_close(trans);
4109 return xstrdup(pqfbuf);
4116 * indent-tabs-mode: nil
4118 * vim: shiftwidth=4 tabstop=8 expandtab