2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.59 2005-12-21 00:06:34 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)
173 case ZOOM_ERROR_CONNECT:
174 case ZOOM_ERROR_MEMORY:
175 case ZOOM_ERROR_DECODE:
176 case ZOOM_ERROR_CONNECTION_LOST:
177 case ZOOM_ERROR_INIT:
178 case ZOOM_ERROR_INTERNAL:
179 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
182 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
186 ZOOM_task ZOOM_connection_add_task (ZOOM_connection c, int which)
188 ZOOM_task *taskp = &c->tasks;
190 taskp = &(*taskp)->next;
191 *taskp = (ZOOM_task) xmalloc (sizeof(**taskp));
192 (*taskp)->running = 0;
193 (*taskp)->which = which;
199 ZOOM_task ZOOM_connection_insert_task (ZOOM_connection c, int which)
201 ZOOM_task task = (ZOOM_task) xmalloc (sizeof(*task));
203 task->next = c->tasks;
212 void ZOOM_connection_remove_task (ZOOM_connection c)
214 ZOOM_task task = c->tasks;
218 c->tasks = task->next;
221 case ZOOM_TASK_SEARCH:
222 ZOOM_resultset_destroy (task->u.search.resultset);
224 case ZOOM_TASK_RETRIEVE:
225 ZOOM_resultset_destroy (task->u.retrieve.resultset);
227 case ZOOM_TASK_CONNECT:
230 ZOOM_scanset_destroy (task->u.scan.scan);
232 case ZOOM_TASK_PACKAGE:
233 ZOOM_package_destroy (task->u.package);
236 ZOOM_resultset_destroy (task->u.sort.resultset);
237 ZOOM_query_destroy(task->u.sort.q);
246 static int ZOOM_connection_exec_task (ZOOM_connection c);
248 void ZOOM_connection_remove_tasks (ZOOM_connection c)
251 ZOOM_connection_remove_task(c);
254 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos);
256 ZOOM_API(ZOOM_connection)
257 ZOOM_connection_create (ZOOM_options options)
259 ZOOM_connection c = (ZOOM_connection) xmalloc (sizeof(*c));
263 yaz_log(log_api, "%p ZOOM_connection_create", c);
265 c->proto = PROTO_Z3950;
269 c->state = STATE_IDLE;
272 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
279 c->options = ZOOM_options_create_with_parent(options);
285 c->charset = c->lang = 0;
292 c->odr_in = odr_createmem (ODR_DECODE);
293 c->odr_out = odr_createmem (ODR_ENCODE);
296 c->support_named_resultsets = 0;
297 c->last_event = ZOOM_EVENT_NONE;
299 c->m_queue_front = 0;
304 /* set database names. Take local databases (if set); otherwise
305 take databases given in ZURL (if set); otherwise use Default */
306 static char **set_DatabaseNames (ZOOM_connection con, ZOOM_options options,
309 char **databaseNames;
310 const char *cp = ZOOM_options_get (options, "databaseName");
314 if (strncmp (con->host_port, "unix:", 5) == 0)
315 cp = strchr(con->host_port+5, ':');
317 cp = strchr(con->host_port, '/');
323 nmem_strsplit(con->odr_out->mem, "+", cp, &databaseNames, num);
324 return databaseNames;
327 ZOOM_API(ZOOM_connection)
328 ZOOM_connection_new (const char *host, int portnum)
330 ZOOM_connection c = ZOOM_connection_create (0);
332 ZOOM_connection_connect (c, host, portnum);
337 ZOOM_connection_connect(ZOOM_connection c,
338 const char *host, int portnum)
345 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
350 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
354 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
356 val = ZOOM_options_get (c->options, "proxy");
359 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
360 c->proxy = xstrdup (val);
366 val = ZOOM_options_get (c->options, "charset");
369 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
370 c->charset = xstrdup (val);
376 val = ZOOM_options_get (c->options, "lang");
379 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
380 c->lang = xstrdup (val);
385 xfree (c->host_port);
389 sprintf (hostn, "%.80s:%d", host, portnum);
390 c->host_port = xstrdup(hostn);
393 c->host_port = xstrdup(host);
397 * If the "<scheme>:" part of the host string is preceded by one
398 * or more comma-separated <name>=<value> pairs, these are taken
399 * to be options to be set on the connection object. Among other
400 * applications, this facility can be used to embed authentication
402 * user=admin,password=secret,tcp:localhost:9999
404 char *remainder = c->host_port;
405 char *pcolon = strchr(remainder, ':');
408 while ((pcomma = strchr(remainder, ',')) != 0 &&
409 (pcolon == 0 || pcomma < pcolon)) {
411 if ((pequals = strchr(remainder, '=')) != 0) {
413 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
414 ZOOM_connection_option_set(c, remainder, pequals+1);
416 remainder = pcomma+1;
419 if (remainder != c->host_port) {
421 c->host_port = xstrdup(remainder);
422 /*printf("# reset hp='%s'\n", remainder);*/
426 ZOOM_options_set(c->options, "host", c->host_port);
428 val = ZOOM_options_get (c->options, "cookie");
431 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
432 c->cookie_out = xstrdup (val);
435 val = ZOOM_options_get (c->options, "clientIP");
438 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
440 c->client_IP = xstrdup (val);
443 c->async = ZOOM_options_get_bool (c->options, "async", 0);
444 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
446 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
448 task = ZOOM_connection_add_task (c, ZOOM_TASK_CONNECT);
452 while (ZOOM_event (1, &c))
458 ZOOM_query_create(void)
460 ZOOM_query s = (ZOOM_query) xmalloc (sizeof(*s));
462 yaz_log(log_details, "%p ZOOM_query_create", s);
466 s->odr = odr_createmem (ODR_ENCODE);
473 ZOOM_query_destroy(ZOOM_query s)
479 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
480 if (s->refcount == 0)
482 odr_destroy (s->odr);
488 ZOOM_query_prefix(ZOOM_query s, const char *str)
490 s->query_string = odr_strdup(s->odr, str);
491 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
492 s->z_query->which = Z_Query_type_1;
493 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
494 if (!s->z_query->u.type_1)
496 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
500 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
505 ZOOM_query_cql(ZOOM_query s, const char *str)
509 s->query_string = odr_strdup(s->odr, str);
511 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
512 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
513 ext->indirect_reference = 0;
515 ext->which = Z_External_CQL;
516 ext->u.cql = s->query_string;
518 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
519 s->z_query->which = Z_Query_type_104;
520 s->z_query->u.type_104 = ext;
522 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
528 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
530 s->sort_spec = yaz_sort_spec (s->odr, criteria);
533 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
537 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
541 static zoom_ret do_write(ZOOM_connection c);
544 ZOOM_connection_destroy(ZOOM_connection c)
549 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
552 for (r = c->resultsets; r; r = r->next)
558 odr_destroy (c->odr_in);
559 odr_destroy (c->odr_out);
560 ZOOM_options_destroy (c->options);
561 ZOOM_connection_remove_tasks (c);
562 xfree (c->host_port);
567 xfree (c->cookie_out);
568 xfree (c->cookie_in);
569 xfree (c->client_IP);
573 void ZOOM_resultset_addref (ZOOM_resultset r)
578 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
583 ZOOM_resultset ZOOM_resultset_create ()
585 ZOOM_resultset r = (ZOOM_resultset) xmalloc (sizeof(*r));
589 yaz_log(log_details, "%p ZOOM_resultset_create", r);
592 r->odr = odr_createmem (ODR_ENCODE);
607 ZOOM_API(ZOOM_resultset)
608 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
611 ZOOM_query s = ZOOM_query_create();
613 ZOOM_query_prefix (s, q);
615 r = ZOOM_connection_search (c, s);
616 ZOOM_query_destroy (s);
620 ZOOM_API(ZOOM_resultset)
621 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
623 ZOOM_resultset r = ZOOM_resultset_create ();
627 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
628 r->r_sort_spec = q->sort_spec;
631 r->options = ZOOM_options_create_with_parent(c->options);
633 r->start = ZOOM_options_get_int(r->options, "start", 0);
634 r->count = ZOOM_options_get_int(r->options, "count", 0);
636 /* If "presentChunk" is defined use that; otherwise "step" */
637 const char *cp = ZOOM_options_get (r->options, "presentChunk");
638 r->step = ZOOM_options_get_int(r->options,
639 (cp != 0 ? "presentChunk": "step"), 0);
641 r->piggyback = ZOOM_options_get_bool (r->options, "piggyback", 1);
642 cp = ZOOM_options_get (r->options, "setname");
644 r->setname = xstrdup(cp);
645 cp = ZOOM_options_get (r->options, "schema");
647 r->schema = xstrdup(cp);
651 r->next = c->resultsets;
654 if (c->host_port && c->proto == PROTO_HTTP)
658 yaz_log(log_details, "ZOOM_connection_search: no comstack");
659 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
663 yaz_log(log_details, "ZOOM_connection_search: reconnect");
668 task = ZOOM_connection_add_task (c, ZOOM_TASK_SEARCH);
669 task->u.search.resultset = r;
670 ZOOM_resultset_addref (r);
676 while (ZOOM_event (1, &c))
683 * This is the old result-set sorting API, which is maintained only
684 * for the sake of binary compatibility. There is no reason ever to
685 * use this rather than ZOOM_resultset_sort1().
688 ZOOM_resultset_sort(ZOOM_resultset r,
689 const char *sort_type, const char *sort_spec)
691 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
695 ZOOM_resultset_sort1(ZOOM_resultset r,
696 const char *sort_type, const char *sort_spec)
698 ZOOM_connection c = r->connection;
702 newq = ZOOM_query_create();
703 if (ZOOM_query_sortby(newq, sort_spec) < 0)
706 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
707 r, r, sort_type, sort_spec);
711 if (c->host_port && c->proto == PROTO_HTTP)
715 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
716 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
720 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
726 ZOOM_resultset_cache_reset(r);
727 task = ZOOM_connection_add_task (c, ZOOM_TASK_SORT);
728 task->u.sort.resultset = r;
729 task->u.sort.q = newq;
731 ZOOM_resultset_addref (r);
735 while (ZOOM_event (1, &c))
743 ZOOM_resultset_cache_reset(ZOOM_resultset r)
745 ZOOM_record_cache rc;
747 for (rc = r->record_cache; rc; rc = rc->next)
749 if (rc->rec.wrbuf_marc)
750 wrbuf_free (rc->rec.wrbuf_marc, 1);
751 if (rc->rec.wrbuf_iconv)
752 wrbuf_free (rc->rec.wrbuf_iconv, 1);
753 if (rc->rec.wrbuf_opac)
754 wrbuf_free (rc->rec.wrbuf_opac, 1);
760 ZOOM_resultset_destroy(ZOOM_resultset r)
765 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
767 if (r->refcount == 0)
769 ZOOM_resultset_cache_reset(r);
773 /* remove ourselves from the resultsets in connection */
774 ZOOM_resultset *rp = &r->connection->resultsets;
777 assert (*rp); /* we must be in this list!! */
779 { /* OK, we're here - take us out of it */
786 ZOOM_query_destroy (r->query);
787 ZOOM_options_destroy (r->options);
788 odr_destroy (r->odr);
796 ZOOM_resultset_size (ZOOM_resultset r)
801 static void do_close (ZOOM_connection c)
807 c->state = STATE_IDLE;
810 static void ZOOM_resultset_retrieve (ZOOM_resultset r,
811 int force_sync, int start, int count)
819 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
820 " count=%d", r, force_sync, start, count);
825 if (c->host_port && c->proto == PROTO_HTTP)
829 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
830 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
834 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
839 task = ZOOM_connection_add_task (c, ZOOM_TASK_RETRIEVE);
840 task->u.retrieve.resultset = r;
841 task->u.retrieve.start = start;
842 task->u.retrieve.count = count;
844 cp = ZOOM_options_get (r->options, "schema");
847 if (!r->schema || strcmp(r->schema, cp))
850 r->schema = xstrdup(cp);
854 ZOOM_resultset_addref (r);
856 if (!r->connection->async || force_sync)
857 while (r->connection && ZOOM_event (1, &r->connection))
862 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
863 size_t start, size_t count)
865 int force_present = 0;
869 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%d count=%d",
873 ZOOM_resultset_retrieve (r, force_present, start, count);
877 for (i = 0; i< count; i++)
878 recs[i] = ZOOM_resultset_record_immediate (r, i+start);
882 static void get_cert(ZOOM_connection c)
887 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
889 ZOOM_connection_option_setl(c, "sslPeerCert",
895 static zoom_ret do_connect (ZOOM_connection c)
898 const char *effective_host;
901 effective_host = c->proxy;
903 effective_host = c->host_port;
905 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
909 c->cs = cs_create_host (effective_host, 0, &add);
911 if (c->cs && c->cs->protocol == PROTO_HTTP)
914 const char *path = 0;
916 c->proto = PROTO_HTTP;
917 cs_get_host_args(c->host_port, &path);
919 c->path = (char*) xmalloc(strlen(path)+2);
921 strcpy (c->path+1, path);
923 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
925 return zoom_complete;
930 int ret = cs_connect (c->cs, add);
933 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
934 ZOOM_connection_put_event(c, event);
936 if (c->proto == PROTO_Z3950)
937 ZOOM_connection_send_init(c);
940 /* no init request for SRW .. */
941 assert (c->tasks->which == ZOOM_TASK_CONNECT);
942 ZOOM_connection_remove_task (c);
944 ZOOM_connection_exec_task (c);
946 c->state = STATE_ESTABLISHED;
951 c->state = STATE_CONNECTING;
952 c->mask = ZOOM_SELECT_EXCEPT;
953 if (c->cs->io_pending & CS_WANT_WRITE)
954 c->mask += ZOOM_SELECT_WRITE;
955 if (c->cs->io_pending & CS_WANT_READ)
956 c->mask += ZOOM_SELECT_READ;
960 c->state = STATE_IDLE;
961 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
962 return zoom_complete;
965 int z3950_connection_socket(ZOOM_connection c)
968 return cs_fileno(c->cs);
972 int z3950_connection_mask(ZOOM_connection c)
979 static void otherInfo_attach (ZOOM_connection c, Z_APDU *a, ODR out)
982 for (i = 0; i<200; i++)
985 Z_OtherInformation **oi;
991 sprintf (buf, "otherInfo%d", i);
992 val = ZOOM_options_get (c->options, buf);
995 cp = strchr(val, ':');
999 if (len >= sizeof(buf))
1000 len = sizeof(buf)-1;
1001 memcpy (buf, val, len);
1003 oidval = oid_getvalbyname (buf);
1004 if (oidval == VAL_NONE)
1007 yaz_oi_APDU(a, &oi);
1008 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1012 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1017 Z_OtherInformation **oi;
1018 yaz_oi_APDU(a, &oi);
1019 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1023 Z_OtherInformation **oi;
1024 yaz_oi_APDU(a, &oi);
1025 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1027 otherInfo_attach (c, a, out);
1028 if (!z_APDU(out, &a, 0, 0))
1030 FILE *outf = fopen("/tmp/apdu.txt", "a");
1033 ODR odr_pr = odr_createmem(ODR_PRINT);
1034 fprintf (outf, "a=%p\n", a);
1035 odr_setprint(odr_pr, outf);
1036 z_APDU(odr_pr, &a, 0, 0);
1037 odr_destroy(odr_pr);
1039 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1040 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1044 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1048 static zoom_ret send_APDU (ZOOM_connection c, Z_APDU *a)
1052 if (encode_APDU(c, a, c->odr_out))
1053 return zoom_complete;
1054 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1055 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1056 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1057 ZOOM_connection_put_event (c, event);
1058 odr_reset(c->odr_out);
1059 return do_write (c);
1062 /* returns 1 if PDU was sent OK (still pending )
1063 0 if PDU was not sent OK (nothing to wait for)
1066 static zoom_ret ZOOM_connection_send_init (ZOOM_connection c)
1068 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1069 Z_InitRequest *ireq = apdu->u.initRequest;
1070 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1071 odr_malloc(c->odr_out, sizeof(*auth));
1072 const char *auth_groupId = ZOOM_options_get (c->options, "group");
1073 const char *auth_userId = ZOOM_options_get (c->options, "user");
1074 const char *auth_password = ZOOM_options_get (c->options, "password");
1077 /* support the pass for backwards compatibility */
1079 auth_password = ZOOM_options_get (c->options, "pass");
1081 ODR_MASK_SET(ireq->options, Z_Options_search);
1082 ODR_MASK_SET(ireq->options, Z_Options_present);
1083 ODR_MASK_SET(ireq->options, Z_Options_scan);
1084 ODR_MASK_SET(ireq->options, Z_Options_sort);
1085 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1086 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1088 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1089 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1090 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1092 /* Index Data's Z39.50 Implementor Id is 81 */
1093 ireq->implementationId = odr_prepend(c->odr_out,
1094 ZOOM_options_get(c->options, "implementationId"),
1095 odr_prepend(c->odr_out, "81", ireq->implementationId));
1097 ireq->implementationName = odr_prepend(c->odr_out,
1098 ZOOM_options_get(c->options, "implementationName"),
1099 odr_prepend(c->odr_out, "ZOOM-C", ireq->implementationName));
1101 version = odr_strdup(c->odr_out, "$Revision: 1.59 $");
1102 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1103 version[strlen(version)-2] = '\0';
1104 ireq->implementationVersion = odr_prepend(c->odr_out,
1105 ZOOM_options_get(c->options, "implementationVersion"),
1106 odr_prepend(c->odr_out, &version[11], ireq->implementationVersion));
1108 *ireq->maximumRecordSize =
1109 ZOOM_options_get_int (c->options, "maximumRecordSize", 1024*1024);
1110 *ireq->preferredMessageSize =
1111 ZOOM_options_get_int (c->options, "preferredMessageSize", 1024*1024);
1113 if (auth_groupId || auth_password)
1115 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1118 if (auth_groupId && *auth_groupId)
1120 pass->groupId = (char *)
1121 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1122 strcpy(pass->groupId, auth_groupId);
1126 if (auth_userId && *auth_userId)
1128 pass->userId = (char *)
1129 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1130 strcpy(pass->userId, auth_userId);
1134 if (auth_password && *auth_password)
1136 pass->password = (char *)
1137 odr_malloc(c->odr_out, strlen(auth_password)+1);
1138 strcpy(pass->password, auth_password);
1143 auth->which = Z_IdAuthentication_idPass;
1144 auth->u.idPass = pass;
1145 ireq->idAuthentication = auth;
1148 else if (auth_userId)
1150 auth->which = Z_IdAuthentication_open;
1151 auth->u.open = (char *)
1152 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1153 strcpy(auth->u.open, auth_userId);
1154 ireq->idAuthentication = auth;
1157 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1158 VAL_PROXY, 1, c->host_port);
1159 if (c->charset || c->lang)
1161 Z_OtherInformation **oi;
1162 Z_OtherInformationUnit *oi_unit;
1164 yaz_oi_APDU(apdu, &oi);
1166 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1168 char **charsets_addresses = 0;
1169 char **langs_addresses = 0;
1170 int charsets_count = 0;
1171 int langs_count = 0;
1174 nmem_strsplit_blank(c->odr_out->mem, c->charset,
1175 &charsets_addresses, &charsets_count);
1177 nmem_strsplit_blank(c->odr_out->mem, c->lang,
1178 &langs_addresses, &langs_count);
1179 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1180 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1181 oi_unit->information.externallyDefinedInfo =
1182 yaz_set_proposal_charneg(c->odr_out,
1183 (const char **) charsets_addresses,
1185 (const char **) langs_addresses,
1191 return send_APDU (c, apdu);
1195 static zoom_ret send_srw (ZOOM_connection c, Z_SRW_PDU *sr)
1198 Z_SOAP_Handler h[2] = {
1199 {"http://www.loc.gov/zing/srw/", 0, (Z_SOAP_fun) yaz_srw_codec},
1202 ODR o = odr_createmem(ODR_ENCODE);
1204 Z_SOAP *p = (Z_SOAP*) odr_malloc(o, sizeof(*p));
1208 gdu = z_get_HTTP_Request(c->odr_out);
1209 gdu->u.HTTP_Request->path = c->path;
1213 const char *cp0 = strstr(c->host_port, "://");
1214 const char *cp1 = 0;
1220 cp1 = strchr(cp0, '/');
1222 cp1 = cp0+strlen(cp0);
1226 char *h = (char*) odr_malloc(c->odr_out, cp1 - cp0 + 1);
1227 memcpy (h, cp0, cp1 - cp0);
1229 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1234 strcpy(ctype, "text/xml");
1235 if (c->charset && strlen(c->charset) < 20)
1237 strcat(ctype, "; charset=");
1238 strcat(ctype, c->charset);
1240 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1241 "Content-Type", ctype);
1242 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1243 "SOAPAction", "\"\"");
1244 p->which = Z_SOAP_generic;
1245 p->u.generic = (Z_SOAP_Generic *) odr_malloc(o, sizeof(*p->u.generic));
1246 p->u.generic->no = 0;
1247 p->u.generic->ns = 0;
1248 p->u.generic->p = sr;
1249 p->ns = "http://schemas.xmlsoap.org/soap/envelope/";
1251 ret = z_soap_codec_enc(o, &p,
1252 &gdu->u.HTTP_Request->content_buf,
1253 &gdu->u.HTTP_Request->content_len, h,
1256 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1257 return zoom_complete;
1258 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1262 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1263 ZOOM_connection_put_event (c, event);
1264 odr_reset(c->odr_out);
1265 return do_write (c);
1270 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1273 ZOOM_resultset resultset = 0;
1275 const char *recordPacking = 0;
1277 if (c->error) /* don't continue on error */
1278 return zoom_complete;
1280 if (c->tasks->which == ZOOM_TASK_SEARCH)
1282 resultset = c->tasks->u.search.resultset;
1283 resultset->setname = xstrdup ("default");
1284 ZOOM_options_set (resultset->options, "setname", resultset->setname);
1286 else if(c->tasks->which == ZOOM_TASK_RETRIEVE)
1288 resultset = c->tasks->u.retrieve.resultset;
1290 resultset->start = c->tasks->u.retrieve.start;
1291 resultset->count = c->tasks->u.retrieve.count;
1293 if (resultset->start >= resultset->size)
1294 return zoom_complete;
1295 if (resultset->start + resultset->count > resultset->size)
1296 resultset->count = resultset->size - resultset->start;
1298 for (i = 0; i<resultset->count; i++)
1301 record_cache_lookup (resultset, i + resultset->start);
1305 if (i == resultset->count)
1306 return zoom_complete;
1308 assert(resultset->query);
1310 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1312 if (resultset->query->z_query->which == Z_Query_type_104
1313 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1316 sr->u.request->query_type = Z_SRW_query_type_cql;
1317 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1319 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1320 resultset->query->z_query->u.type_1)
1322 sr->u.request->query_type = Z_SRW_query_type_pqf;
1323 sr->u.request->query.pqf = resultset->query->query_string;
1327 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1328 return zoom_complete;
1330 sr->u.request->startRecord = odr_intdup (c->odr_out, resultset->start + 1);
1331 sr->u.request->maximumRecords = odr_intdup (
1332 c->odr_out, resultset->step>0 ? resultset->step : resultset->count);
1333 sr->u.request->recordSchema = resultset->schema;
1335 recordPacking = ZOOM_resultset_option_get (resultset, "recordPacking");
1338 sr->u.request->recordPacking = odr_strdup(c->odr_out, recordPacking);
1340 return send_srw(c, sr);
1343 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1345 return zoom_complete;
1349 static zoom_ret ZOOM_connection_send_search (ZOOM_connection c)
1352 int lslb, ssub, mspn;
1354 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1355 Z_SearchRequest *search_req = apdu->u.searchRequest;
1356 const char *elementSetName;
1357 const char *smallSetElementSetName;
1358 const char *mediumSetElementSetName;
1361 assert (c->tasks->which == ZOOM_TASK_SEARCH);
1363 r = c->tasks->u.search.resultset;
1365 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1368 ZOOM_options_get (r->options, "elementSetName");
1369 smallSetElementSetName =
1370 ZOOM_options_get (r->options, "smallSetElementSetName");
1371 mediumSetElementSetName =
1372 ZOOM_options_get (r->options, "mediumSetElementSetName");
1374 if (!smallSetElementSetName)
1375 smallSetElementSetName = elementSetName;
1377 if (!mediumSetElementSetName)
1378 mediumSetElementSetName = elementSetName;
1383 /* prepare query for the search request */
1384 search_req->query = r->query->z_query;
1385 if (!search_req->query)
1387 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1388 return zoom_complete;
1391 search_req->databaseNames =
1392 set_DatabaseNames (c, r->options, &search_req->num_databaseNames);
1394 /* get syntax (no need to provide unless piggyback is in effect) */
1395 syntax = ZOOM_options_get (r->options, "preferredRecordSyntax");
1397 lslb = ZOOM_options_get_int (r->options, "largeSetLowerBound", -1);
1398 ssub = ZOOM_options_get_int (r->options, "smallSetUpperBound", -1);
1399 mspn = ZOOM_options_get_int (r->options, "mediumSetPresentNumber", -1);
1400 if (lslb != -1 && ssub != -1 && mspn != -1)
1402 /* So're a Z39.50 expert? Let's hope you don't do sort */
1403 *search_req->largeSetLowerBound = lslb;
1404 *search_req->smallSetUpperBound = ssub;
1405 *search_req->mediumSetPresentNumber = mspn;
1407 else if (r->start == 0 && r->count > 0
1408 && r->piggyback && !r->r_sort_spec && !r->schema)
1410 /* Regular piggyback - do it unless we're going to do sort */
1411 *search_req->largeSetLowerBound = 2000000000;
1412 *search_req->smallSetUpperBound = 1;
1413 *search_req->mediumSetPresentNumber = r->step>0 ? r->step : r->count;
1417 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1418 smallSetElementSetName = 0;
1419 mediumSetElementSetName = 0;
1422 if (smallSetElementSetName && *smallSetElementSetName)
1424 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1425 odr_malloc (c->odr_out, sizeof(*esn));
1427 esn->which = Z_ElementSetNames_generic;
1428 esn->u.generic = odr_strdup (c->odr_out, smallSetElementSetName);
1429 search_req->smallSetElementSetNames = esn;
1431 if (mediumSetElementSetName && *mediumSetElementSetName)
1433 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1434 odr_malloc (c->odr_out, sizeof(*esn));
1436 esn->which = Z_ElementSetNames_generic;
1437 esn->u.generic = odr_strdup (c->odr_out, mediumSetElementSetName);
1438 search_req->mediumSetElementSetNames = esn;
1441 search_req->preferredRecordSyntax =
1442 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1446 if (c->support_named_resultsets)
1450 /* find the lowest unused ordinal so that we re-use
1451 result sets on the server. */
1452 for (ord = 1; ; ord++)
1455 sprintf (setname, "%d", ord);
1456 for (rp = c->resultsets; rp; rp = rp->next)
1457 if (rp->setname && !strcmp (rp->setname, setname))
1462 r->setname = xstrdup (setname);
1463 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1464 "set %s", c, r->setname);
1468 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1470 r->setname = xstrdup ("default");
1472 ZOOM_options_set (r->options, "setname", r->setname);
1474 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1475 return send_APDU (c, apdu);
1478 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1485 case Z_DefaultDiagFormat_v2Addinfo:
1486 addinfo = r->u.v2Addinfo;
1488 case Z_DefaultDiagFormat_v3Addinfo:
1489 addinfo = r->u.v3Addinfo;
1494 set_dset_error(c, *r->condition,
1495 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1499 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1501 if (p->which != Z_DiagRec_defaultFormat)
1502 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1504 response_default_diag(c, p->u.defaultFormat);
1507 ZOOM_API(ZOOM_record)
1508 ZOOM_record_clone (ZOOM_record srec)
1515 odr_enc = odr_createmem(ODR_ENCODE);
1516 if (!z_NamePlusRecord (odr_enc, &srec->npr, 0, 0))
1518 buf = odr_getbuf (odr_enc, &size, 0);
1520 nrec = (ZOOM_record) xmalloc (sizeof(*nrec));
1521 nrec->odr = odr_createmem(ODR_DECODE);
1522 nrec->wrbuf_marc = 0;
1523 nrec->wrbuf_iconv = 0;
1524 nrec->wrbuf_opac = 0;
1525 odr_setbuf (nrec->odr, buf, size, 0);
1526 z_NamePlusRecord (nrec->odr, &nrec->npr, 0, 0);
1528 odr_destroy (odr_enc);
1532 ZOOM_API(ZOOM_record)
1533 ZOOM_resultset_record_immediate (ZOOM_resultset s,size_t pos)
1535 return record_cache_lookup (s, pos);
1538 ZOOM_API(ZOOM_record)
1539 ZOOM_resultset_record (ZOOM_resultset r, size_t pos)
1541 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1545 ZOOM_resultset_retrieve (r, 1, pos, 1);
1546 rec = ZOOM_resultset_record_immediate (r, pos);
1552 ZOOM_record_destroy (ZOOM_record rec)
1556 if (rec->wrbuf_marc)
1557 wrbuf_free (rec->wrbuf_marc, 1);
1558 if (rec->wrbuf_iconv)
1559 wrbuf_free (rec->wrbuf_iconv, 1);
1560 if (rec->wrbuf_opac)
1561 wrbuf_free (rec->wrbuf_opac, 1);
1562 odr_destroy (rec->odr);
1566 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1568 const char *buf, int sz,
1569 const char *record_charset)
1574 yaz_marc_t mt = yaz_marc_create();
1577 strcpy(to, "UTF-8");
1578 if (record_charset && *record_charset)
1580 /* Use "from,to" or just "from" */
1581 const char *cp = strchr(record_charset, ',');
1582 int clen = strlen(record_charset);
1585 strncpy( to, cp+1, sizeof(to)-1);
1586 to[sizeof(to)-1] = '\0';
1587 clen = cp - record_charset;
1589 if (clen > sizeof(from)-1)
1590 clen = sizeof(from)-1;
1593 strncpy(from, record_charset, clen);
1599 cd = yaz_iconv_open(to, from);
1600 yaz_marc_iconv(mt, cd);
1603 yaz_marc_xml(mt, marc_type);
1604 if (!rec->wrbuf_marc)
1605 rec->wrbuf_marc = wrbuf_alloc();
1606 wrbuf_rewind (rec->wrbuf_marc);
1607 if (yaz_marc_decode_wrbuf (mt, buf, sz, rec->wrbuf_marc) > 0)
1609 yaz_marc_destroy(mt);
1611 yaz_iconv_close(cd);
1613 *len = wrbuf_len(rec->wrbuf_marc);
1614 return wrbuf_buf(rec->wrbuf_marc);
1616 yaz_marc_destroy(mt);
1618 yaz_iconv_close(cd);
1622 static const char *record_iconv_return(ZOOM_record rec, int *len,
1623 const char *buf, int sz,
1624 const char *record_charset)
1631 strcpy(to, "UTF-8");
1632 if (record_charset && *record_charset)
1634 /* Use "from,to" or just "from" */
1635 const char *cp = strchr(record_charset, ',');
1636 int clen = strlen(record_charset);
1639 strncpy( to, cp+1, sizeof(to)-1);
1640 to[sizeof(to)-1] = '\0';
1641 clen = cp - record_charset;
1643 if (clen > sizeof(from)-1)
1644 clen = sizeof(from)-1;
1647 strncpy(from, record_charset, clen);
1651 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1654 size_t inbytesleft = sz;
1655 const char *inp = buf;
1657 if (!rec->wrbuf_iconv)
1658 rec->wrbuf_iconv = wrbuf_alloc();
1660 wrbuf_rewind(rec->wrbuf_iconv);
1664 size_t outbytesleft = sizeof(outbuf);
1665 char *outp = outbuf;
1666 size_t r = yaz_iconv (cd, (char**) &inp,
1668 &outp, &outbytesleft);
1669 if (r == (size_t) (-1))
1671 int e = yaz_iconv_error(cd);
1672 if (e != YAZ_ICONV_E2BIG)
1675 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1677 wrbuf_puts(rec->wrbuf_iconv, "");
1678 buf = wrbuf_buf(rec->wrbuf_iconv);
1679 sz = wrbuf_len(rec->wrbuf_iconv);
1680 yaz_iconv_close(cd);
1687 ZOOM_API(const char *)
1688 ZOOM_record_get (ZOOM_record rec, const char *type_spec, int *len)
1695 Z_NamePlusRecord *npr;
1698 *len = 0; /* default return */
1707 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1709 if (cp[i] == ';' || cp[i] == ' ')
1715 while (type_spec[i] == ';')
1718 while (type_spec[i] == ' ')
1720 if (!strncmp(type_spec+i, "charset=", 8))
1723 i = i + 8; /* skip charset= */
1724 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1726 if (type_spec[i] == ';' || type_spec[i] == ' ')
1732 else if (!strncmp(type_spec+i, "xpath=", 6))
1736 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1740 while (type_spec[i] == ' ')
1743 if (!strcmp (type, "database"))
1746 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1747 return npr->databaseName;
1749 else if (!strcmp (type, "syntax"))
1751 const char *desc = 0;
1752 if (npr->which == Z_NamePlusRecord_databaseRecord)
1754 Z_External *r = (Z_External *) npr->u.databaseRecord;
1755 oident *ent = oid_getentbyoid(r->direct_reference);
1762 *len = strlen(desc);
1765 if (npr->which != Z_NamePlusRecord_databaseRecord)
1768 /* from now on - we have a database record .. */
1769 if (!strcmp (type, "render"))
1771 Z_External *r = (Z_External *) npr->u.databaseRecord;
1772 oident *ent = oid_getentbyoid(r->direct_reference);
1774 /* render bibliographic record .. */
1775 if (r->which == Z_External_OPAC)
1777 r = r->u.opac->bibliographicRecord;
1780 ent = oid_getentbyoid(r->direct_reference);
1782 if (r->which == Z_External_sutrs)
1783 return record_iconv_return(rec, len,
1784 (char*) r->u.sutrs->buf,
1787 else if (r->which == Z_External_octet)
1789 const char *ret_buf;
1797 case VAL_APPLICATION_XML:
1800 ret_buf = marc_iconv_return(
1801 rec, YAZ_MARC_LINE, len,
1802 (const char *) r->u.octet_aligned->buf,
1803 r->u.octet_aligned->len,
1808 return record_iconv_return(rec, len,
1809 (const char *) r->u.octet_aligned->buf,
1810 r->u.octet_aligned->len,
1813 else if (r->which == Z_External_grs1)
1815 if (!rec->wrbuf_marc)
1816 rec->wrbuf_marc = wrbuf_alloc();
1817 wrbuf_rewind (rec->wrbuf_marc);
1818 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1819 return record_iconv_return(rec, len,
1820 wrbuf_buf(rec->wrbuf_marc),
1821 wrbuf_len(rec->wrbuf_marc),
1826 else if (!strcmp (type, "xml") || !strcmp(type, "oai"))
1828 Z_External *r = (Z_External *) npr->u.databaseRecord;
1829 oident *ent = oid_getentbyoid(r->direct_reference);
1831 /* render bibliographic record .. */
1832 if (r->which == Z_External_OPAC)
1834 r = r->u.opac->bibliographicRecord;
1837 ent = oid_getentbyoid(r->direct_reference);
1840 if (r->which == Z_External_sutrs)
1841 return record_iconv_return(rec, len,
1842 (const char *) r->u.sutrs->buf,
1845 else if (r->which == Z_External_octet)
1847 const char *ret_buf;
1848 int marc_decode_type = YAZ_MARC_MARCXML;
1850 if (!strcmp(type, "oai"))
1851 marc_decode_type = YAZ_MARC_OAIMARC;
1859 case VAL_APPLICATION_XML:
1862 ret_buf = marc_iconv_return(
1863 rec, marc_decode_type, len,
1864 (const char *) r->u.octet_aligned->buf,
1865 r->u.octet_aligned->len,
1870 return record_iconv_return(rec, len,
1871 (const char *) r->u.octet_aligned->buf,
1872 r->u.octet_aligned->len,
1875 else if (r->which == Z_External_grs1)
1882 else if (!strcmp (type, "raw"))
1884 Z_External *r = (Z_External *) npr->u.databaseRecord;
1886 if (r->which == Z_External_sutrs)
1888 if (len) *len = r->u.sutrs->len;
1889 return (const char *) r->u.sutrs->buf;
1891 else if (r->which == Z_External_octet)
1893 if (len) *len = r->u.octet_aligned->len;
1894 return (const char *) r->u.octet_aligned->buf;
1896 else /* grs-1, explain, OPAC, ... */
1899 return (const char *) npr->u.databaseRecord;
1903 else if (!strcmp (type, "ext"))
1906 return (const char *) npr->u.databaseRecord;
1908 else if (!strcmp (type, "opac"))
1911 Z_External *r = (Z_External *) npr->u.databaseRecord;
1912 if (r->which == Z_External_OPAC)
1914 if (!rec->wrbuf_opac)
1915 rec->wrbuf_opac = wrbuf_alloc();
1916 wrbuf_rewind (rec->wrbuf_opac);
1917 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
1918 return record_iconv_return(rec, len,
1919 wrbuf_buf(rec->wrbuf_opac),
1920 wrbuf_len(rec->wrbuf_opac),
1927 static int strcmp_null(const char *v1, const char *v2)
1933 return strcmp(v1, v2);
1936 static void record_cache_add (ZOOM_resultset r, Z_NamePlusRecord *npr,
1939 ZOOM_record_cache rc;
1940 const char *elementSetName =
1941 ZOOM_resultset_option_get (r, "elementSetName");
1942 const char *syntax =
1943 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
1945 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1946 ZOOM_connection_put_event(r->connection, event);
1948 for (rc = r->record_cache; rc; rc = rc->next)
1952 if (strcmp_null(r->schema, rc->schema))
1954 if (strcmp_null(elementSetName,rc->elementSetName))
1956 if (strcmp_null(syntax, rc->syntax))
1958 /* not destroying rc->npr (it's handled by nmem )*/
1960 /* keeping wrbuf_marc too */
1964 rc = (ZOOM_record_cache) odr_malloc (r->odr, sizeof(*rc));
1967 rc->rec.wrbuf_marc = 0;
1968 rc->rec.wrbuf_iconv = 0;
1969 rc->rec.wrbuf_opac = 0;
1971 rc->elementSetName = odr_strdup (r->odr, elementSetName);
1973 rc->elementSetName = 0;
1976 rc->syntax = odr_strdup (r->odr, syntax);
1981 rc->schema = odr_strdup (r->odr, r->schema);
1986 rc->next = r->record_cache;
1987 r->record_cache = rc;
1990 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos)
1992 ZOOM_record_cache rc;
1993 const char *elementSetName =
1994 ZOOM_resultset_option_get (r, "elementSetName");
1995 const char *syntax =
1996 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
1998 for (rc = r->record_cache; rc; rc = rc->next)
2002 if (strcmp_null(r->schema, rc->schema))
2004 if (strcmp_null(elementSetName,rc->elementSetName))
2006 if (strcmp_null(syntax, rc->syntax))
2014 static void handle_records (ZOOM_connection c, Z_Records *sr,
2017 ZOOM_resultset resultset;
2021 switch (c->tasks->which)
2023 case ZOOM_TASK_SEARCH:
2024 resultset = c->tasks->u.search.resultset;
2026 case ZOOM_TASK_RETRIEVE:
2027 resultset = c->tasks->u.retrieve.resultset;
2032 if (sr && sr->which == Z_Records_NSD)
2033 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2034 else if (sr && sr->which == Z_Records_multipleNSD)
2036 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2037 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2039 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2043 if (resultset->count + resultset->start > resultset->size)
2044 resultset->count = resultset->size - resultset->start;
2045 if (resultset->count < 0)
2046 resultset->count = 0;
2047 if (sr && sr->which == Z_Records_DBOSD)
2050 NMEM nmem = odr_extract_mem (c->odr_in);
2051 Z_NamePlusRecordList *p =
2052 sr->u.databaseOrSurDiagnostics;
2053 for (i = 0; i<p->num_records; i++)
2055 record_cache_add (resultset, p->records[i],
2056 i+ resultset->start);
2058 /* transfer our response to search_nmem .. we need it later */
2059 nmem_transfer (resultset->odr->mem, nmem);
2060 nmem_destroy (nmem);
2061 if (present_phase && p->num_records == 0)
2063 /* present response and we didn't get any records! */
2064 Z_NamePlusRecord *myrec =
2065 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2066 record_cache_add(resultset, myrec, resultset->start);
2069 else if (present_phase)
2071 /* present response and we didn't get any records! */
2072 Z_NamePlusRecord *myrec =
2073 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2074 record_cache_add(resultset, myrec, resultset->start);
2079 static void handle_present_response (ZOOM_connection c, Z_PresentResponse *pr)
2081 handle_records (c, pr->records, 1);
2084 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2087 switch (term->which)
2089 case Z_Term_general:
2090 ZOOM_options_setl(opt, name,
2091 (const char *)(term->u.general->buf),
2092 term->u.general->len);
2094 case Z_Term_characterString:
2095 ZOOM_options_set(opt, name, term->u.characterString);
2097 case Z_Term_numeric:
2098 ZOOM_options_set_int(opt, name, *term->u.numeric);
2103 static void handle_queryExpression(ZOOM_options opt, const char *name,
2104 Z_QueryExpression *exp)
2110 case Z_QueryExpression_term:
2111 if (exp->u.term && exp->u.term->queryTerm)
2113 sprintf(opt_name, "%s.term", name);
2114 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2117 case Z_QueryExpression_query:
2122 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2123 Z_OtherInformation *o)
2126 for (i = 0; o && i < o->num_elements; i++)
2128 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2130 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2132 if (ext->which == Z_External_searchResult1)
2135 Z_SearchInfoReport *sr = ext->u.searchResult1;
2138 ZOOM_options_set_int(
2139 resultset->options, "searchresult.size", sr->num);
2141 for (j = 0; j < sr->num; j++)
2143 Z_SearchInfoReport_s *ent =
2144 ext->u.searchResult1->elements[j];
2147 sprintf(pref, "searchresult.%d", j);
2149 if (ent->subqueryId)
2152 sprintf(opt_name, "%s.id", pref);
2153 ZOOM_options_set(resultset->options, opt_name,
2156 if (ent->subqueryExpression)
2159 sprintf(opt_name, "%s.subquery", pref);
2160 handle_queryExpression(resultset->options, opt_name,
2161 ent->subqueryExpression);
2163 if (ent->subqueryInterpretation)
2166 sprintf(opt_name, "%s.interpretation", pref);
2167 handle_queryExpression(resultset->options, opt_name,
2168 ent->subqueryInterpretation);
2170 if (ent->subqueryRecommendation)
2173 sprintf(opt_name, "%s.recommendation", pref);
2174 handle_queryExpression(resultset->options, opt_name,
2175 ent->subqueryRecommendation);
2177 if (ent->subqueryCount)
2180 sprintf(opt_name, "%s.count", pref);
2181 ZOOM_options_set_int(resultset->options, opt_name,
2182 *ent->subqueryCount);
2190 static void handle_search_response (ZOOM_connection c, Z_SearchResponse *sr)
2192 ZOOM_resultset resultset;
2195 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2198 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2199 ZOOM_connection_put_event(c, event);
2201 resultset = c->tasks->u.search.resultset;
2203 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2205 resultset->size = *sr->resultCount;
2206 handle_records (c, sr->records, 0);
2209 static void sort_response (ZOOM_connection c, Z_SortResponse *res)
2211 if (res->diagnostics && res->num_diagnostics > 0)
2212 response_diag (c, res->diagnostics[0]);
2215 static int scan_response (ZOOM_connection c, Z_ScanResponse *res)
2217 NMEM nmem = odr_extract_mem (c->odr_in);
2220 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2222 scan = c->tasks->u.scan.scan;
2224 if (res->entries && res->entries->nonsurrogateDiagnostics)
2225 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2226 scan->scan_response = res;
2227 nmem_transfer (scan->odr->mem, nmem);
2229 ZOOM_options_set_int (scan->options, "stepSize", *res->stepSize);
2230 if (res->positionOfTerm)
2231 ZOOM_options_set_int (scan->options, "position", *res->positionOfTerm);
2232 if (res->scanStatus)
2233 ZOOM_options_set_int (scan->options, "scanStatus", *res->scanStatus);
2234 if (res->numberOfEntriesReturned)
2235 ZOOM_options_set_int (scan->options, "number",
2236 *res->numberOfEntriesReturned);
2237 nmem_destroy (nmem);
2241 static zoom_ret send_sort (ZOOM_connection c,
2242 ZOOM_resultset resultset)
2245 resultset->r_sort_spec = 0;
2246 if (resultset->r_sort_spec)
2248 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2249 Z_SortRequest *req = apdu->u.sortRequest;
2251 req->num_inputResultSetNames = 1;
2252 req->inputResultSetNames = (Z_InternationalString **)
2253 odr_malloc (c->odr_out, sizeof(*req->inputResultSetNames));
2254 req->inputResultSetNames[0] =
2255 odr_strdup (c->odr_out, resultset->setname);
2256 req->sortedResultSetName = odr_strdup (c->odr_out, resultset->setname);
2257 req->sortSequence = resultset->r_sort_spec;
2258 resultset->r_sort_spec = 0;
2259 return send_APDU (c, apdu);
2261 return zoom_complete;
2264 static zoom_ret send_present(ZOOM_connection c)
2267 Z_PresentRequest *req = 0;
2269 const char *syntax = 0;
2270 const char *elementSetName = 0;
2271 ZOOM_resultset resultset;
2275 yaz_log(log_details, "%p send_present no tasks", c);
2276 return zoom_complete;
2278 switch (c->tasks->which)
2280 case ZOOM_TASK_SEARCH:
2281 resultset = c->tasks->u.search.resultset;
2283 case ZOOM_TASK_RETRIEVE:
2284 resultset = c->tasks->u.retrieve.resultset;
2285 resultset->start = c->tasks->u.retrieve.start;
2286 resultset->count = c->tasks->u.retrieve.count;
2288 if (resultset->start >= resultset->size)
2290 yaz_log(log_details, "%p send_present start=%d >= size=%d",
2291 c, resultset->start, resultset->size);
2292 return zoom_complete;
2294 if (resultset->start + resultset->count > resultset->size)
2295 resultset->count = resultset->size - resultset->start;
2298 return zoom_complete;
2300 yaz_log(log_details, "%p send_present start=%d count=%d",
2301 c, resultset->start, resultset->count);
2303 syntax = ZOOM_resultset_option_get (resultset, "preferredRecordSyntax");
2304 elementSetName = ZOOM_resultset_option_get (resultset, "elementSetName");
2306 if (c->error) /* don't continue on error */
2307 return zoom_complete;
2308 if (resultset->start < 0)
2309 return zoom_complete;
2310 for (i = 0; i<resultset->count; i++)
2313 record_cache_lookup (resultset, i + resultset->start);
2317 if (i == resultset->count)
2319 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2320 return zoom_complete;
2323 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2324 req = apdu->u.presentRequest;
2326 resultset->start += i;
2327 resultset->count -= i;
2330 yaz_log(log_details, "%p send_present skip=%d", c, i);
2332 *req->resultSetStartPoint = resultset->start + 1;
2333 *req->numberOfRecordsRequested = resultset->step>0 ?
2334 resultset->step : resultset->count;
2335 assert (*req->numberOfRecordsRequested > 0);
2338 if (syntax && *syntax)
2339 req->preferredRecordSyntax =
2340 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
2342 if (resultset->schema && *resultset->schema)
2344 Z_RecordComposition *compo = (Z_RecordComposition *)
2345 odr_malloc (c->odr_out, sizeof(*compo));
2347 req->recordComposition = compo;
2348 compo->which = Z_RecordComp_complex;
2349 compo->u.complex = (Z_CompSpec *)
2350 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2351 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2352 odr_malloc(c->odr_out, sizeof(bool_t));
2353 *compo->u.complex->selectAlternativeSyntax = 0;
2355 compo->u.complex->generic = (Z_Specification *)
2356 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2358 compo->u.complex->generic->which = Z_Schema_oid;
2359 compo->u.complex->generic->schema.oid = (Odr_oid *)
2360 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2362 if (!compo->u.complex->generic->schema.oid)
2364 /* OID wasn't a schema! Try record syntax instead. */
2366 compo->u.complex->generic->schema.oid = (Odr_oid *)
2367 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2369 if (elementSetName && *elementSetName)
2371 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2372 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2373 compo->u.complex->generic->elementSpec->which =
2374 Z_ElementSpec_elementSetName;
2375 compo->u.complex->generic->elementSpec->u.elementSetName =
2376 odr_strdup (c->odr_out, elementSetName);
2379 compo->u.complex->generic->elementSpec = 0;
2380 compo->u.complex->num_dbSpecific = 0;
2381 compo->u.complex->dbSpecific = 0;
2382 compo->u.complex->num_recordSyntax = 0;
2383 compo->u.complex->recordSyntax = 0;
2385 else if (elementSetName && *elementSetName)
2387 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2388 odr_malloc (c->odr_out, sizeof(*esn));
2389 Z_RecordComposition *compo = (Z_RecordComposition *)
2390 odr_malloc (c->odr_out, sizeof(*compo));
2392 esn->which = Z_ElementSetNames_generic;
2393 esn->u.generic = odr_strdup (c->odr_out, elementSetName);
2394 compo->which = Z_RecordComp_simple;
2395 compo->u.simple = esn;
2396 req->recordComposition = compo;
2398 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2399 return send_APDU (c, apdu);
2402 ZOOM_API(ZOOM_scanset)
2403 ZOOM_connection_scan (ZOOM_connection c, const char *start)
2406 ZOOM_query q = ZOOM_query_create();
2408 ZOOM_query_prefix (q, start);
2410 s = ZOOM_connection_scan1(c, q);
2411 ZOOM_query_destroy (q);
2416 ZOOM_API(ZOOM_scanset)
2417 ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query q)
2419 ZOOM_scanset scan = (ZOOM_scanset) xmalloc (sizeof(*scan));
2423 scan->connection = c;
2424 scan->odr = odr_createmem (ODR_DECODE);
2425 scan->options = ZOOM_options_create_with_parent (c->options);
2427 scan->scan_response = 0;
2430 * We need to check the query-type, so we can recognise CQL and
2431 * compile it into a form that we can use here. The ZOOM_query
2432 * structure has no explicit `type' member, but inspection of the
2433 * ZOOM_query_prefix() and ZOOM_query_cql() functions shows how
2434 * the structure is set up in each case.
2437 if (q->z_query->which == Z_Query_type_1) {
2438 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2439 c, q, q->query_string);
2440 start = q->query_string;
2441 } else if (q->z_query->which == Z_Query_type_104) {
2442 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2443 c, q, q->query_string);
2444 start = freeme = cql2pqf(c, q->query_string);
2448 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2449 c, q, q->query_string);
2453 scan->termListAndStartPoint =
2454 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2456 if (scan->termListAndStartPoint != 0)
2458 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_SCAN);
2459 task->u.scan.scan = scan;
2464 while (ZOOM_event (1, &c))
2472 ZOOM_scanset_destroy (ZOOM_scanset scan)
2477 if (scan->refcount == 0)
2479 odr_destroy (scan->odr);
2481 ZOOM_options_destroy (scan->options);
2486 static zoom_ret send_package (ZOOM_connection c)
2490 yaz_log(log_details, "%p send_package", c);
2492 return zoom_complete;
2493 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2495 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
2496 ZOOM_connection_put_event (c, event);
2498 return do_write_ex (c, c->tasks->u.package->buf_out,
2499 c->tasks->u.package->len_out);
2502 static zoom_ret send_scan (ZOOM_connection c)
2505 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2506 Z_ScanRequest *req = apdu->u.scanRequest;
2508 yaz_log(log_details, "%p send_scan", c);
2510 return zoom_complete;
2511 assert (c->tasks->which == ZOOM_TASK_SCAN);
2512 scan = c->tasks->u.scan.scan;
2514 req->termListAndStartPoint = scan->termListAndStartPoint;
2515 req->attributeSet = scan->attributeSet;
2517 *req->numberOfTermsRequested =
2518 ZOOM_options_get_int(scan->options, "number", 10);
2520 req->preferredPositionInResponse =
2521 odr_intdup (c->odr_out,
2522 ZOOM_options_get_int(scan->options, "position", 1));
2525 odr_intdup (c->odr_out,
2526 ZOOM_options_get_int(scan->options, "stepSize", 0));
2528 req->databaseNames = set_DatabaseNames (c, scan->options,
2529 &req->num_databaseNames);
2531 return send_APDU (c, apdu);
2535 ZOOM_scanset_size (ZOOM_scanset scan)
2537 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2539 return scan->scan_response->entries->num_entries;
2542 ZOOM_API(const char *)
2543 ZOOM_scanset_term (ZOOM_scanset scan, size_t pos,
2546 const char *term = 0;
2547 size_t noent = ZOOM_scanset_size (scan);
2548 Z_ScanResponse *res = scan->scan_response;
2554 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2556 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2558 if (t->term->which == Z_Term_general)
2560 term = (const char *) t->term->u.general->buf;
2561 *len = t->term->u.general->len;
2563 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2568 ZOOM_API(const char *)
2569 ZOOM_scanset_display_term (ZOOM_scanset scan, size_t pos,
2572 const char *term = 0;
2573 size_t noent = ZOOM_scanset_size (scan);
2574 Z_ScanResponse *res = scan->scan_response;
2580 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2582 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2586 term = t->displayTerm;
2587 *len = strlen(term);
2589 else 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_option_get (ZOOM_scanset scan, const char *key)
2602 return ZOOM_options_get (scan->options, key);
2606 ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
2609 ZOOM_options_set (scan->options, key, val);
2612 static Z_APDU *create_es_package (ZOOM_package p, int type)
2615 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2616 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2618 *req->function = Z_ExtendedServicesRequest_create;
2620 str = ZOOM_options_get(p->options, "package-name");
2622 req->packageName = nmem_strdup (p->odr_out->mem, str);
2624 str = ZOOM_options_get(p->options, "user-id");
2626 req->userId = nmem_strdup (p->odr_out->mem, str);
2628 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2631 str = ZOOM_options_get(p->options, "function");
2634 if (!strcmp (str, "create"))
2636 if (!strcmp (str, "delete"))
2638 if (!strcmp (str, "modify"))
2644 static const char *ill_array_lookup (void *clientData, const char *idx)
2646 ZOOM_package p = (ZOOM_package) clientData;
2647 return ZOOM_options_get (p->options, idx+4);
2650 static Z_External *encode_ill_request (ZOOM_package p)
2652 ODR out = p->odr_out;
2655 struct ill_get_ctl ctl;
2657 ctl.odr = p->odr_out;
2659 ctl.f = ill_array_lookup;
2661 req = ill_get_ILLRequest(&ctl, "ill", 0);
2663 if (!ill_Request (out, &req, 0, 0))
2665 int ill_request_size;
2666 char *ill_request_buf = odr_getbuf (out, &ill_request_size, 0);
2667 if (ill_request_buf)
2668 odr_setbuf (out, ill_request_buf, ill_request_size, 1);
2674 int illRequest_size = 0;
2675 char *illRequest_buf = odr_getbuf (out, &illRequest_size, 0);
2677 oid.proto = PROTO_GENERAL;
2678 oid.oclass = CLASS_GENERAL;
2679 oid.value = VAL_ISO_ILL_1;
2681 r = (Z_External *) odr_malloc (out, sizeof(*r));
2682 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2683 r->indirect_reference = 0;
2685 r->which = Z_External_single;
2687 r->u.single_ASN1_type = (Odr_oct *)
2688 odr_malloc (out, sizeof(*r->u.single_ASN1_type));
2689 r->u.single_ASN1_type->buf = (unsigned char*)
2690 odr_malloc (out, illRequest_size);
2691 r->u.single_ASN1_type->len = illRequest_size;
2692 r->u.single_ASN1_type->size = illRequest_size;
2693 memcpy (r->u.single_ASN1_type->buf, illRequest_buf, illRequest_size);
2698 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2700 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc (p->odr_out, sizeof(*req));
2703 req->which = Z_IOItemOrder_esRequest;
2704 req->u.esRequest = (Z_IORequest *)
2705 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2707 /* to keep part ... */
2708 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2709 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2710 req->u.esRequest->toKeep->supplDescription = 0;
2711 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2712 odr_malloc (p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2714 str = ZOOM_options_get(p->options, "contact-name");
2715 req->u.esRequest->toKeep->contact->name = str ?
2716 nmem_strdup (p->odr_out->mem, str) : 0;
2718 str = ZOOM_options_get(p->options, "contact-phone");
2719 req->u.esRequest->toKeep->contact->phone = str ?
2720 nmem_strdup (p->odr_out->mem, str) : 0;
2722 str = ZOOM_options_get(p->options, "contact-email");
2723 req->u.esRequest->toKeep->contact->email = str ?
2724 nmem_strdup (p->odr_out->mem, str) : 0;
2726 req->u.esRequest->toKeep->addlBilling = 0;
2728 /* not to keep part ... */
2729 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2730 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2732 str = ZOOM_options_get(p->options, "itemorder-setname");
2737 req->u.esRequest->notToKeep->resultSetItem = 0;
2740 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2741 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2743 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2744 nmem_strdup (p->odr_out->mem, str);
2745 req->u.esRequest->notToKeep->resultSetItem->item =
2746 (int *) odr_malloc(p->odr_out, sizeof(int));
2748 str = ZOOM_options_get(p->options, "itemorder-item");
2749 *req->u.esRequest->notToKeep->resultSetItem->item =
2750 (str ? atoi(str) : 1);
2752 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2757 Z_APDU *create_admin_package(ZOOM_package p, int type,
2758 Z_ESAdminOriginPartToKeep **toKeepP,
2759 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2761 Z_APDU *apdu = create_es_package (p, VAL_ADMINSERVICE);
2764 Z_ESAdminOriginPartToKeep *toKeep;
2765 Z_ESAdminOriginPartNotToKeep *notToKeep;
2766 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2767 const char *first_db = "Default";
2769 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2773 r->direct_reference =
2774 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2777 r->indirect_reference = 0;
2778 r->which = Z_External_ESAdmin;
2780 r->u.adminService = (Z_Admin *)
2781 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2782 r->u.adminService->which = Z_Admin_esRequest;
2783 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2784 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2786 toKeep = r->u.adminService->u.esRequest->toKeep =
2787 (Z_ESAdminOriginPartToKeep *)
2788 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2789 toKeep->which = type;
2790 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2791 toKeep->u.create = odr_nullval();
2792 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2794 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2795 (Z_ESAdminOriginPartNotToKeep *)
2796 odr_malloc(p->odr_out,
2797 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2798 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
2799 notToKeep->u.recordsWillFollow = odr_nullval();
2803 *notToKeepP = notToKeep;
2808 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
2810 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
2811 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2812 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
2813 const char *doc = ZOOM_options_get(p->options, "doc");
2815 req->taskSpecificParameters = ext;
2816 ext->direct_reference = req->packageType;
2817 ext->descriptor = 0;
2818 ext->indirect_reference = 0;
2820 ext->which = Z_External_octet;
2821 ext->u.single_ASN1_type = (Odr_oct *)
2822 odr_malloc (p->odr_out, sizeof(Odr_oct));
2826 ext->u.single_ASN1_type->buf = (unsigned char*)
2827 odr_strdup(p->odr_out, doc);
2828 ext->u.single_ASN1_type->size = ext->u.single_ASN1_type->len = strlen(doc);
2832 static Z_APDU *create_update_package(ZOOM_package p)
2835 const char *first_db = "Default";
2837 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2838 const char *action = ZOOM_options_get(p->options, "action");
2839 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
2840 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
2841 const char *record_buf = ZOOM_options_get(p->options, "record");
2842 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
2843 int syntax_oid = VAL_NONE;
2847 syntax_oid = oid_getvalbyname(syntax_str);
2850 record_buf = "void";
2851 syntax_oid = VAL_SUTRS;
2853 if (syntax_oid == VAL_NONE)
2854 syntax_oid = VAL_TEXT_XML;
2860 action = "specialUpdate";
2862 if (!strcmp(action, "recordInsert"))
2863 action_no = Z_IUOriginPartToKeep_recordInsert;
2864 else if (!strcmp(action, "recordReplace"))
2865 action_no = Z_IUOriginPartToKeep_recordReplace;
2866 else if (!strcmp(action, "recordDelete"))
2867 action_no = Z_IUOriginPartToKeep_recordDelete;
2868 else if (!strcmp(action, "elementUpdate"))
2869 action_no = Z_IUOriginPartToKeep_elementUpdate;
2870 else if (!strcmp(action, "specialUpdate"))
2871 action_no = Z_IUOriginPartToKeep_specialUpdate;
2875 apdu = create_es_package (p, VAL_DBUPDATE);
2878 Z_IUOriginPartToKeep *toKeep;
2879 Z_IUSuppliedRecords *notToKeep;
2880 Z_External *r = (Z_External *)
2881 odr_malloc (p->odr_out, sizeof(*r));
2883 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2885 r->direct_reference =
2886 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2889 r->which = Z_External_update;
2890 r->indirect_reference = 0;
2891 r->u.update = (Z_IUUpdate *)
2892 odr_malloc(p->odr_out, sizeof(*r->u.update));
2894 r->u.update->which = Z_IUUpdate_esRequest;
2895 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
2896 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
2897 toKeep = r->u.update->u.esRequest->toKeep =
2898 (Z_IUOriginPartToKeep *)
2899 odr_malloc(p->odr_out, sizeof(*toKeep));
2901 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2903 toKeep->elementSetName = 0;
2904 toKeep->actionQualifier = 0;
2905 toKeep->action = odr_intdup(p->odr_out, action_no);
2907 notToKeep = r->u.update->u.esRequest->notToKeep =
2908 (Z_IUSuppliedRecords *)
2909 odr_malloc(p->odr_out, sizeof(*notToKeep));
2911 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
2912 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
2913 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
2914 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
2915 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
2918 notToKeep->elements[0]->u.opaque = (Odr_oct *)
2919 odr_malloc (p->odr_out, sizeof(Odr_oct));
2920 notToKeep->elements[0]->u.opaque->size =
2921 notToKeep->elements[0]->u.opaque->len = strlen(recordIdOpaque);
2922 notToKeep->elements[0]->u.opaque->buf = (unsigned char*)
2923 odr_strdup(p->odr_out, recordIdOpaque);
2925 else if (recordIdNumber)
2927 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
2929 notToKeep->elements[0]->u.number =
2930 odr_intdup(p->odr_out, atoi(recordIdNumber));
2933 notToKeep->elements[0]->u.opaque = 0;
2934 notToKeep->elements[0]->supplementalId = 0;
2935 notToKeep->elements[0]->correlationInfo = 0;
2936 notToKeep->elements[0]->record =
2937 z_ext_record(p->odr_out, syntax_oid,
2938 record_buf, strlen(record_buf));
2942 ODR print = odr_createmem(ODR_PRINT);
2944 z_APDU(print, &apdu, 0, 0);
2951 ZOOM_package_send (ZOOM_package p, const char *type)
2958 odr_reset (p->odr_out);
2961 if (!strcmp(type, "itemorder"))
2963 apdu = create_es_package (p, VAL_ITEMORDER);
2966 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2968 r->direct_reference =
2969 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2972 r->which = Z_External_itemOrder;
2973 r->indirect_reference = 0;
2974 r->u.itemOrder = encode_item_order (p);
2976 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2979 else if (!strcmp(type, "create")) /* create database */
2981 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
2984 else if (!strcmp(type, "drop")) /* drop database */
2986 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
2989 else if (!strcmp(type, "commit")) /* commit changes */
2991 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
2994 else if (!strcmp(type, "update")) /* update record(s) */
2996 apdu = create_update_package(p);
2998 else if (!strcmp(type, "xmlupdate"))
3000 apdu = create_xmlupdate_package(p);
3004 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3008 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_PACKAGE);
3009 task->u.package = p;
3010 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3011 p->buf_out = (char *) xmalloc (p->len_out);
3012 memcpy (p->buf_out, buf, p->len_out);
3017 while (ZOOM_event (1, &c))
3024 ZOOM_API(ZOOM_package)
3025 ZOOM_connection_package (ZOOM_connection c, ZOOM_options options)
3027 ZOOM_package p = (ZOOM_package) xmalloc (sizeof(*p));
3030 p->odr_out = odr_createmem (ODR_ENCODE);
3031 p->options = ZOOM_options_create_with_parent2 (options, c->options);
3039 ZOOM_package_destroy(ZOOM_package p)
3044 if (p->refcount == 0)
3046 odr_destroy (p->odr_out);
3049 ZOOM_options_destroy (p->options);
3054 ZOOM_API(const char *)
3055 ZOOM_package_option_get (ZOOM_package p, const char *key)
3057 return ZOOM_options_get (p->options, key);
3062 ZOOM_package_option_set (ZOOM_package p, const char *key,
3065 ZOOM_options_set (p->options, key, val);
3068 static int ZOOM_connection_exec_task (ZOOM_connection c)
3070 ZOOM_task task = c->tasks;
3071 zoom_ret ret = zoom_complete;
3075 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3076 c, task->which, task->running);
3077 if (c->error != ZOOM_ERROR_NONE)
3079 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3080 "removing tasks because of error = %d", c, c->error);
3081 ZOOM_connection_remove_tasks (c);
3086 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3087 "task already running", c);
3091 ret = zoom_complete;
3092 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3094 switch (task->which)
3096 case ZOOM_TASK_SEARCH:
3097 if (c->proto == PROTO_HTTP)
3098 ret = ZOOM_connection_srw_send_search(c);
3100 ret = ZOOM_connection_send_search(c);
3102 case ZOOM_TASK_RETRIEVE:
3103 if (c->proto == PROTO_HTTP)
3104 ret = ZOOM_connection_srw_send_search(c);
3106 ret = send_present (c);
3108 case ZOOM_TASK_CONNECT:
3109 ret = do_connect(c);
3111 case ZOOM_TASK_SCAN:
3114 case ZOOM_TASK_PACKAGE:
3115 ret = send_package(c);
3117 case ZOOM_TASK_SORT:
3118 c->tasks->u.sort.resultset->r_sort_spec =
3119 c->tasks->u.sort.q->sort_spec;
3120 ret = send_sort(c, c->tasks->u.sort.resultset);
3126 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3127 "remove tasks because no connection exist", c);
3128 ZOOM_connection_remove_tasks (c);
3130 if (ret == zoom_complete)
3132 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3133 "task removed (complete)", c);
3134 ZOOM_connection_remove_task (c);
3137 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3142 static zoom_ret send_sort_present (ZOOM_connection c)
3144 zoom_ret r = zoom_complete;
3146 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3147 r = send_sort (c, c->tasks->u.search.resultset);
3148 if (r == zoom_complete)
3149 r = send_present (c);
3153 static int es_response (ZOOM_connection c,
3154 Z_ExtendedServicesResponse *res)
3156 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3158 if (res->diagnostics && res->num_diagnostics > 0)
3159 response_diag(c, res->diagnostics[0]);
3160 if (res->taskPackage &&
3161 res->taskPackage->which == Z_External_extendedService)
3163 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3164 Odr_oct *id = taskPackage->targetReference;
3167 ZOOM_options_setl (c->tasks->u.package->options,
3168 "targetReference", (char*) id->buf, id->len);
3170 if (res->taskPackage &&
3171 res->taskPackage->which == Z_External_octet)
3173 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3174 ZOOM_options_setl (c->tasks->u.package->options,
3175 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3180 static void interpret_init_diag(ZOOM_connection c,
3181 Z_DiagnosticFormat *diag)
3185 Z_DiagnosticFormat_s *ds = diag->elements[0];
3186 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3187 response_default_diag(c, ds->u.defaultDiagRec);
3192 static void interpret_otherinformation_field(ZOOM_connection c,
3193 Z_OtherInformation *ui)
3196 for (i = 0; i < ui->num_elements; i++)
3198 Z_OtherInformationUnit *unit = ui->list[i];
3199 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3200 unit->information.externallyDefinedInfo &&
3201 unit->information.externallyDefinedInfo->which ==
3204 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3209 static void recv_apdu (ZOOM_connection c, Z_APDU *apdu)
3211 Z_InitResponse *initrs;
3214 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3217 case Z_APDU_initResponse:
3218 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3219 initrs = apdu->u.initResponse;
3220 ZOOM_connection_option_set(c, "serverImplementationId",
3221 initrs->implementationId ?
3222 initrs->implementationId : "");
3223 ZOOM_connection_option_set(c, "serverImplementationName",
3224 initrs->implementationName ?
3225 initrs->implementationName : "");
3226 ZOOM_connection_option_set(c, "serverImplementationVersion",
3227 initrs->implementationVersion ?
3228 initrs->implementationVersion : "");
3229 /* Set the three old options too, for old applications */
3230 ZOOM_connection_option_set(c, "targetImplementationId",
3231 initrs->implementationId ?
3232 initrs->implementationId : "");
3233 ZOOM_connection_option_set(c, "targetImplementationName",
3234 initrs->implementationName ?
3235 initrs->implementationName : "");
3236 ZOOM_connection_option_set(c, "targetImplementationVersion",
3237 initrs->implementationVersion ?
3238 initrs->implementationVersion : "");
3239 if (!*initrs->result)
3241 Z_External *uif = initrs->userInformationField;
3243 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3245 if (uif && uif->which == Z_External_userInfo1)
3246 interpret_otherinformation_field(c, uif->u.userInfo1);
3251 yaz_oi_get_string_oidval (&apdu->u.initResponse->otherInfo,
3253 xfree (c->cookie_in);
3256 c->cookie_in = xstrdup(cookie);
3257 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3258 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3259 c->support_named_resultsets = 1;
3262 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3263 ZOOM_connection_remove_task (c);
3265 ZOOM_connection_exec_task (c);
3267 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3269 NMEM tmpmem = nmem_create();
3270 Z_CharSetandLanguageNegotiation *p =
3271 yaz_get_charneg_record(initrs->otherInfo);
3275 char *charset = NULL, *lang = NULL;
3278 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3279 yaz_log(log_details, "%p recv_apdu target accepted: "
3280 "charset %s, language %s, select %d",
3282 charset ? charset : "none", lang ? lang : "none", sel);
3284 ZOOM_connection_option_set (c, "negotiation-charset",
3287 ZOOM_connection_option_set (c, "negotiation-lang",
3290 ZOOM_connection_option_set (
3291 c, "negotiation-charset-in-effect-for-records",
3292 (sel != 0) ? "1" : "0");
3293 nmem_destroy(tmpmem);
3297 case Z_APDU_searchResponse:
3298 yaz_log(log_api, "%p recv_apdu Search response", c);
3299 handle_search_response (c, apdu->u.searchResponse);
3300 if (send_sort_present (c) == zoom_complete)
3301 ZOOM_connection_remove_task (c);
3303 case Z_APDU_presentResponse:
3304 yaz_log(log_api, "%p recv_apdu Present response", c);
3305 handle_present_response (c, apdu->u.presentResponse);
3306 if (send_present (c) == zoom_complete)
3307 ZOOM_connection_remove_task (c);
3309 case Z_APDU_sortResponse:
3310 yaz_log(log_api, "%p recv_apdu Sort response", c);
3311 sort_response (c, apdu->u.sortResponse);
3312 if (send_present (c) == zoom_complete)
3313 ZOOM_connection_remove_task (c);
3315 case Z_APDU_scanResponse:
3316 yaz_log(log_api, "%p recv_apdu Scan response", c);
3317 scan_response (c, apdu->u.scanResponse);
3318 ZOOM_connection_remove_task (c);
3320 case Z_APDU_extendedServicesResponse:
3321 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3322 es_response (c, apdu->u.extendedServicesResponse);
3323 ZOOM_connection_remove_task (c);
3326 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3327 if (c->reconnect_ok)
3330 c->tasks->running = 0;
3331 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3335 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3340 yaz_log(log_api, "%p Received unknown PDU", c);
3341 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3347 static void handle_srw_response(ZOOM_connection c,
3348 Z_SRW_searchRetrieveResponse *res)
3350 ZOOM_resultset resultset = 0;
3358 if (c->tasks->which == ZOOM_TASK_SEARCH)
3359 resultset = c->tasks->u.search.resultset;
3360 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
3361 resultset = c->tasks->u.retrieve.resultset;
3365 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3366 ZOOM_connection_put_event(c, event);
3368 resultset->size = 0;
3370 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3372 if (res->numberOfRecords)
3373 resultset->size = *res->numberOfRecords;
3375 for (i = 0; i<res->num_records; i++)
3379 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3380 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3382 if (res->records[i].recordPosition &&
3383 *res->records[i].recordPosition > 0)
3384 pos = *res->records[i].recordPosition - 1;
3386 pos = resultset->start + i;
3388 npr->databaseName = 0;
3389 npr->which = Z_NamePlusRecord_databaseRecord;
3390 npr->u.databaseRecord = (Z_External *)
3391 odr_malloc(c->odr_in, sizeof(Z_External));
3392 npr->u.databaseRecord->descriptor = 0;
3393 npr->u.databaseRecord->direct_reference =
3394 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3395 npr->u.databaseRecord->which = Z_External_octet;
3396 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3397 odr_malloc(c->odr_in, sizeof(Odr_oct));
3398 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3399 res->records[i].recordData_buf;
3400 npr->u.databaseRecord->u.octet_aligned->len =
3401 npr->u.databaseRecord->u.octet_aligned->size =
3402 res->records[i].recordData_len;
3403 record_cache_add (resultset, npr, pos);
3405 if (res->num_diagnostics > 0)
3407 const char *uri = res->diagnostics[0].uri;
3412 if ((cp = strrchr(uri, '/')))
3414 set_dset_error(c, code, uri,
3415 res->diagnostics[0].details, 0);
3418 nmem = odr_extract_mem(c->odr_in);
3419 nmem_transfer(resultset->odr->mem, nmem);
3425 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3428 const char *content_type = z_HTTP_header_lookup(hres->headers,
3430 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3433 yaz_log(log_details, "%p handle_http", c);
3435 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3437 Z_SOAP *soap_package = 0;
3439 Z_SOAP_Handler soap_handlers[2] = {
3440 {"http://www.loc.gov/zing/srw/", 0,
3441 (Z_SOAP_fun) yaz_srw_codec},
3444 ret = z_soap_codec(o, &soap_package,
3445 &hres->content_buf, &hres->content_len,
3447 if (!ret && soap_package->which == Z_SOAP_generic &&
3448 soap_package->u.generic->no == 0)
3450 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3451 if (sr->which == Z_SRW_searchRetrieve_response)
3452 handle_srw_response(c, sr->u.response);
3456 else if (!ret && (soap_package->which == Z_SOAP_fault
3457 || soap_package->which == Z_SOAP_error))
3459 set_HTTP_error(c, hres->code,
3460 soap_package->u.fault->fault_code,
3461 soap_package->u.fault->fault_string);
3468 if (hres->code != 200)
3469 set_HTTP_error(c, hres->code, 0, 0);
3471 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3474 ZOOM_connection_remove_task(c);
3475 if (!strcmp(hres->version, "1.0"))
3477 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3478 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3483 /* HTTP 1.1: only if no close we stay alive .. */
3484 if (connection_head && !strcmp(connection_head, "close"))
3490 static int do_read (ZOOM_connection c)
3495 event = ZOOM_Event_create (ZOOM_EVENT_RECV_DATA);
3496 ZOOM_connection_put_event (c, event);
3498 r = cs_get (c->cs, &c->buf_in, &c->len_in);
3499 more = cs_more(c->cs);
3500 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3505 if (c->reconnect_ok)
3508 c->reconnect_ok = 0;
3509 yaz_log(log_details, "%p do_read reconnect read", c);
3510 c->tasks->running = 0;
3511 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3515 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3524 odr_reset (c->odr_in);
3525 odr_setbuf (c->odr_in, c->buf_in, r, 0);
3526 event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);
3527 ZOOM_connection_put_event (c, event);
3529 if (!z_GDU (c->odr_in, &gdu, 0, 0))
3532 int err = odr_geterrorx(c->odr_in, &x);
3534 const char *element = odr_getelement(c->odr_in);
3535 sprintf (msg, "ODR code %d:%d element=%-20s",
3536 err, x, element ? element : "<unknown>");
3537 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3540 else if (gdu->which == Z_GDU_Z3950)
3541 recv_apdu (c, gdu->u.z3950);
3542 else if (gdu->which == Z_GDU_HTTP_Response)
3545 handle_http (c, gdu->u.HTTP_Response);
3547 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3551 c->reconnect_ok = 0;
3556 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out)
3561 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3562 ZOOM_connection_put_event (c, event);
3564 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3565 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3567 yaz_log(log_details, "%p do_write_ex write failed", c);
3568 if (c->reconnect_ok)
3571 c->reconnect_ok = 0;
3572 yaz_log(log_details, "%p do_write_ex reconnect write", c);
3573 c->tasks->running = 0;
3574 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3575 return zoom_pending;
3577 if (c->state == STATE_CONNECTING)
3578 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3580 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3582 return zoom_complete;
3586 c->mask = ZOOM_SELECT_EXCEPT;
3587 if (c->cs->io_pending & CS_WANT_WRITE)
3588 c->mask += ZOOM_SELECT_WRITE;
3589 if (c->cs->io_pending & CS_WANT_READ)
3590 c->mask += ZOOM_SELECT_READ;
3591 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3596 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3597 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3600 return zoom_pending;
3603 static zoom_ret do_write(ZOOM_connection c)
3605 return do_write_ex (c, c->buf_out, c->len_out);
3609 ZOOM_API(const char *)
3610 ZOOM_connection_option_get (ZOOM_connection c, const char *key)
3612 return ZOOM_options_get (c->options, key);
3615 ZOOM_API(const char *)
3616 ZOOM_connection_option_getl (ZOOM_connection c, const char *key, int *lenp)
3618 return ZOOM_options_getl (c->options, key, lenp);
3622 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
3625 ZOOM_options_set (c->options, key, val);
3629 ZOOM_connection_option_setl (ZOOM_connection c, const char *key,
3630 const char *val, int len)
3632 ZOOM_options_setl (c->options, key, val, len);
3635 ZOOM_API(const char *)
3636 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key)
3638 return ZOOM_options_get (r->options, key);
3642 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key,
3645 ZOOM_options_set (r->options, key, val);
3650 ZOOM_connection_errcode (ZOOM_connection c)
3652 return ZOOM_connection_error (c, 0, 0);
3655 ZOOM_API(const char *)
3656 ZOOM_connection_errmsg (ZOOM_connection c)
3659 ZOOM_connection_error (c, &msg, 0);
3663 ZOOM_API(const char *)
3664 ZOOM_connection_addinfo (ZOOM_connection c)
3666 const char *addinfo;
3667 ZOOM_connection_error (c, 0, &addinfo);
3671 ZOOM_API(const char *)
3672 ZOOM_connection_diagset (ZOOM_connection c)
3674 const char *diagset;
3675 ZOOM_connection_error_x (c, 0, 0, &diagset);
3679 ZOOM_API(const char *)
3680 ZOOM_diag_str (int error)
3684 case ZOOM_ERROR_NONE:
3686 case ZOOM_ERROR_CONNECT:
3687 return "Connect failed";
3688 case ZOOM_ERROR_MEMORY:
3689 return "Out of memory";
3690 case ZOOM_ERROR_ENCODE:
3691 return "Encoding failed";
3692 case ZOOM_ERROR_DECODE:
3693 return "Decoding failed";
3694 case ZOOM_ERROR_CONNECTION_LOST:
3695 return "Connection lost";
3696 case ZOOM_ERROR_INIT:
3697 return "Init rejected";
3698 case ZOOM_ERROR_INTERNAL:
3699 return "Internal failure";
3700 case ZOOM_ERROR_TIMEOUT:
3702 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3703 return "Unsupported protocol";
3704 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3705 return "Unsupported query type";
3706 case ZOOM_ERROR_INVALID_QUERY:
3707 return "Invalid query";
3708 case ZOOM_ERROR_CQL_PARSE:
3709 return "CQL parsing error";
3710 case ZOOM_ERROR_CQL_TRANSFORM:
3711 return "CQL transformation error";
3713 return diagbib1_str (error);
3718 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
3719 const char **addinfo, const char **diagset)
3721 int error = c->error;
3724 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3725 *cp = ZOOM_diag_str(error);
3726 else if (!strcmp(c->diagset, "HTTP"))
3727 *cp = z_HTTP_errmsg(c->error);
3728 else if (!strcmp(c->diagset, "Bib-1"))
3729 *cp = ZOOM_diag_str(error);
3730 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3731 *cp = yaz_diag_srw_str(c->error);
3733 *cp = "Unknown error and diagnostic set";
3736 *addinfo = c->addinfo ? c->addinfo : "";
3738 *diagset = c->diagset ? c->diagset : "";
3743 ZOOM_connection_error (ZOOM_connection c, const char **cp,
3744 const char **addinfo)
3746 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3749 static int ZOOM_connection_do_io(ZOOM_connection c, int mask)
3751 ZOOM_Event event = 0;
3752 int r = cs_look(c->cs);
3753 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
3758 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3759 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3761 ZOOM_connection_put_event (c, event);
3763 else if (r == CS_CONNECT)
3766 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3768 ret = cs_rcvconnect (c->cs);
3769 yaz_log(log_details, "%p ZOOM_connection_do_io "
3770 "cs_rcvconnect returned %d", c, ret);
3773 c->mask = ZOOM_SELECT_EXCEPT;
3774 if (c->cs->io_pending & CS_WANT_WRITE)
3775 c->mask += ZOOM_SELECT_WRITE;
3776 if (c->cs->io_pending & CS_WANT_READ)
3777 c->mask += ZOOM_SELECT_READ;
3778 ZOOM_connection_put_event (c, event);
3782 ZOOM_connection_put_event (c, event);
3784 if (c->proto == PROTO_Z3950)
3785 ZOOM_connection_send_init(c);
3788 /* no init request for SRW .. */
3789 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3790 ZOOM_connection_remove_task (c);
3792 ZOOM_connection_exec_task (c);
3794 c->state = STATE_ESTABLISHED;
3798 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3800 ZOOM_connection_put_event (c, event);
3805 if (mask & ZOOM_SELECT_READ)
3807 if (c->cs && (mask & ZOOM_SELECT_WRITE))
3814 ZOOM_connection_last_event(ZOOM_connection cs)
3817 return ZOOM_EVENT_NONE;
3818 return cs->last_event;
3822 ZOOM_event (int no, ZOOM_connection *cs)
3824 int timeout = 30; /* default timeout in seconds */
3825 int timeout_set = 0; /* whether it was overriden at all */
3827 struct pollfd pollfds[1024];
3828 ZOOM_connection poll_cs[1024];
3831 fd_set input, output, except;
3836 for (i = 0; i<no; i++)
3838 ZOOM_connection c = cs[i];
3840 if (c && (event = ZOOM_connection_get_event(c)))
3842 ZOOM_Event_destroy (event);
3846 for (i = 0; i<no; i++)
3848 ZOOM_connection c = cs[i];
3850 if (c && ZOOM_connection_exec_task (c))
3852 if ((event = ZOOM_connection_get_event(c)))
3854 ZOOM_Event_destroy (event);
3867 for (i = 0; i<no; i++)
3869 ZOOM_connection c = cs[i];
3875 fd = z3950_connection_socket(c);
3876 mask = z3950_connection_mask(c);
3883 /* -1 is used for indefinite timeout (no timeout), so -2 here. */
3884 this_timeout = ZOOM_options_get_int (c->options, "timeout", -2);
3885 if (this_timeout != -2)
3887 /* ensure the minimum timeout is used */
3889 timeout = this_timeout;
3890 else if (this_timeout != -1 && this_timeout < timeout)
3891 timeout = this_timeout;
3897 short poll_events = 0;
3899 if (mask & ZOOM_SELECT_READ)
3900 poll_events += POLLIN;
3901 if (mask & ZOOM_SELECT_WRITE)
3902 poll_events += POLLOUT;
3903 if (mask & ZOOM_SELECT_EXCEPT)
3904 poll_events += POLLERR;
3905 pollfds[nfds].fd = fd;
3906 pollfds[nfds].events = poll_events;
3907 pollfds[nfds].revents = 0;
3912 if (mask & ZOOM_SELECT_READ)
3914 FD_SET (fd, &input);
3917 if (mask & ZOOM_SELECT_WRITE)
3919 FD_SET (fd, &output);
3922 if (mask & ZOOM_SELECT_EXCEPT)
3924 FD_SET (fd, &except);
3933 r = poll (pollfds, nfds, (timeout == -1 ? -1 : timeout * 1000));
3934 for (i = 0; i<nfds; i++)
3936 ZOOM_connection c = poll_cs[i];
3940 if (pollfds[i].revents & POLLIN)
3941 mask += ZOOM_SELECT_READ;
3942 if (pollfds[i].revents & POLLOUT)
3943 mask += ZOOM_SELECT_WRITE;
3944 if (pollfds[i].revents & POLLERR)
3945 mask += ZOOM_SELECT_EXCEPT;
3947 ZOOM_connection_do_io(c, mask);
3949 else if (r == 0 && c->mask)
3951 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3952 /* timeout and this connection was waiting */
3953 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3955 ZOOM_connection_put_event(c, event);
3959 tv.tv_sec = timeout;
3961 r = select (max_fd+1, &input, &output, &except, (timeout == -1 ? 0 : &tv));
3962 for (i = 0; i<no; i++)
3964 ZOOM_connection c = cs[i];
3969 fd = z3950_connection_socket(c);
3973 /* no timeout and real socket */
3974 if (FD_ISSET(fd, &input))
3975 mask += ZOOM_SELECT_READ;
3976 if (FD_ISSET(fd, &output))
3977 mask += ZOOM_SELECT_WRITE;
3978 if (FD_ISSET(fd, &except))
3979 mask += ZOOM_SELECT_EXCEPT;
3981 ZOOM_connection_do_io(c, mask);
3983 if (r == 0 && c->mask)
3985 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3986 /* timeout and this connection was waiting */
3987 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3989 ZOOM_connection_put_event(c, event);
3993 for (i = 0; i<no; i++)
3995 ZOOM_connection c = cs[i];
3997 if (c && (event = ZOOM_connection_get_event(c)))
3999 ZOOM_Event_destroy (event);
4008 * Returns an xmalloc()d string containing RPN that corresponds to the
4009 * CQL passed in. On error, sets the Connection object's error state
4010 * and returns a null pointer.
4011 * ### We could cache CQL parser and/or transformer in Connection.
4013 static char *cql2pqf(ZOOM_connection c, const char *cql)
4017 struct cql_node *node;
4018 const char *cqlfile;
4019 static cql_transform_t trans;
4022 parser = cql_parser_create();
4023 /*printf("*** got CQL parser %p\n", parser);*/
4024 if ((error = cql_parser_string(parser, cql)) != 0) {
4025 cql_parser_destroy(parser);
4026 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4030 node = cql_parser_result(parser);
4031 /*printf("*** got CQL node %p\n", node);*/
4032 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4034 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4035 /*printf("*** cqlfile is %p\n", cqlfile);*/
4037 /*printf("*** cqlfile is null\n");*/
4038 cql_parser_destroy(parser);
4039 cql_node_destroy(node);
4040 /*printf("*** destroyed node\n");*/
4041 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4042 /*printf("*** set ZOOM_error\n");*/
4045 /*printf("*** got CQL file %s\n", cqlfile);*/
4047 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4049 cql_parser_destroy(parser);
4050 cql_node_destroy(node);
4051 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4052 cqlfile, strerror(errno));
4053 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4057 /*printf("*** got trans %p\n", trans);*/
4058 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4059 cql_parser_destroy(parser);
4060 /*printf("*** destroyed parser\n");*/
4061 /*printf("*** got cql_transform_buf() retval %d\n", error);*/
4062 cql_node_destroy(node);
4065 const char *addinfo;
4066 error = cql_transform_error(trans, &addinfo);
4067 cql_transform_close(trans);
4068 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4069 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4073 cql_transform_close(trans);
4075 char *s = xstrdup(pqfbuf);
4076 /*printf("*** translated '%s' to '%s'\n", cql, s);*/
4085 * indent-tabs-mode: nil
4087 * vim: shiftwidth=4 tabstop=8 expandtab