2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.67 2006-04-01 07:21:12 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");
317 if ((!cp || !*cp) && con->host_port)
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.67 $");
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 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1215 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1216 oi_unit->information.externallyDefinedInfo =
1217 yaz_set_proposal_charneg_list(c->odr_out, " ",
1218 c->charset, c->lang, 1);
1222 return send_APDU (c, apdu);
1226 static zoom_ret send_srw (ZOOM_connection c, Z_SRW_PDU *sr)
1228 Z_SOAP_Handler h[2] = {
1229 {"http://www.loc.gov/zing/srw/", 0, (Z_SOAP_fun) yaz_srw_codec},
1232 ODR o = odr_createmem(ODR_ENCODE);
1234 Z_SOAP *p = (Z_SOAP*) odr_malloc(o, sizeof(*p));
1238 gdu = z_get_HTTP_Request(c->odr_out);
1239 gdu->u.HTTP_Request->path = c->path;
1243 const char *cp0 = strstr(c->host_port, "://");
1244 const char *cp1 = 0;
1250 cp1 = strchr(cp0, '/');
1252 cp1 = cp0+strlen(cp0);
1256 char *h = (char*) odr_malloc(c->odr_out, cp1 - cp0 + 1);
1257 memcpy (h, cp0, cp1 - cp0);
1259 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1264 if (c->sru_mode == zoom_sru_get)
1266 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1268 else if (c->sru_mode == zoom_sru_post)
1270 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1272 else if (c->sru_mode == zoom_sru_soap)
1274 z_HTTP_header_add_content_type(c->odr_out,
1275 &gdu->u.HTTP_Request->headers,
1276 "text/xml", c->charset);
1278 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1279 "SOAPAction", "\"\"");
1280 p->which = Z_SOAP_generic;
1281 p->u.generic = (Z_SOAP_Generic *) odr_malloc(o, sizeof(*p->u.generic));
1282 p->u.generic->no = 0;
1283 p->u.generic->ns = 0;
1284 p->u.generic->p = sr;
1285 p->ns = "http://schemas.xmlsoap.org/soap/envelope/";
1287 ret = z_soap_codec_enc(o, &p,
1288 &gdu->u.HTTP_Request->content_buf,
1289 &gdu->u.HTTP_Request->content_len, h,
1293 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1294 return zoom_complete;
1295 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1298 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1299 ZOOM_connection_put_event (c, event);
1300 odr_reset(c->odr_out);
1301 return do_write (c);
1306 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1309 ZOOM_resultset resultset = 0;
1311 const char *recordPacking = 0;
1313 if (c->error) /* don't continue on error */
1314 return zoom_complete;
1316 if (c->tasks->which == ZOOM_TASK_SEARCH)
1318 resultset = c->tasks->u.search.resultset;
1319 resultset->setname = xstrdup ("default");
1320 ZOOM_options_set (resultset->options, "setname", resultset->setname);
1322 else if(c->tasks->which == ZOOM_TASK_RETRIEVE)
1324 resultset = c->tasks->u.retrieve.resultset;
1326 resultset->start = c->tasks->u.retrieve.start;
1327 resultset->count = c->tasks->u.retrieve.count;
1329 if (resultset->start >= resultset->size)
1330 return zoom_complete;
1331 if (resultset->start + resultset->count > resultset->size)
1332 resultset->count = resultset->size - resultset->start;
1334 for (i = 0; i<resultset->count; i++)
1337 record_cache_lookup (resultset, i + resultset->start);
1341 if (i == resultset->count)
1342 return zoom_complete;
1344 assert(resultset->query);
1346 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1348 if (resultset->query->z_query->which == Z_Query_type_104
1349 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1352 sr->u.request->query_type = Z_SRW_query_type_cql;
1353 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1355 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1356 resultset->query->z_query->u.type_1)
1358 sr->u.request->query_type = Z_SRW_query_type_pqf;
1359 sr->u.request->query.pqf = resultset->query->query_string;
1363 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1364 return zoom_complete;
1366 sr->u.request->startRecord = odr_intdup (c->odr_out, resultset->start + 1);
1367 sr->u.request->maximumRecords = odr_intdup (
1368 c->odr_out, resultset->step>0 ? resultset->step : resultset->count);
1369 sr->u.request->recordSchema = resultset->schema;
1371 recordPacking = ZOOM_resultset_option_get (resultset, "recordPacking");
1374 sr->u.request->recordPacking = odr_strdup(c->odr_out, recordPacking);
1376 return send_srw(c, sr);
1379 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1381 return zoom_complete;
1385 static zoom_ret ZOOM_connection_send_search (ZOOM_connection c)
1388 int lslb, ssub, mspn;
1390 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1391 Z_SearchRequest *search_req = apdu->u.searchRequest;
1392 const char *elementSetName;
1393 const char *smallSetElementSetName;
1394 const char *mediumSetElementSetName;
1397 assert (c->tasks->which == ZOOM_TASK_SEARCH);
1399 r = c->tasks->u.search.resultset;
1401 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1404 ZOOM_options_get (r->options, "elementSetName");
1405 smallSetElementSetName =
1406 ZOOM_options_get (r->options, "smallSetElementSetName");
1407 mediumSetElementSetName =
1408 ZOOM_options_get (r->options, "mediumSetElementSetName");
1410 if (!smallSetElementSetName)
1411 smallSetElementSetName = elementSetName;
1413 if (!mediumSetElementSetName)
1414 mediumSetElementSetName = elementSetName;
1419 /* prepare query for the search request */
1420 search_req->query = r->query->z_query;
1421 if (!search_req->query)
1423 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1424 return zoom_complete;
1427 search_req->databaseNames =
1428 set_DatabaseNames (c, r->options, &search_req->num_databaseNames);
1430 /* get syntax (no need to provide unless piggyback is in effect) */
1431 syntax = ZOOM_options_get (r->options, "preferredRecordSyntax");
1433 lslb = ZOOM_options_get_int (r->options, "largeSetLowerBound", -1);
1434 ssub = ZOOM_options_get_int (r->options, "smallSetUpperBound", -1);
1435 mspn = ZOOM_options_get_int (r->options, "mediumSetPresentNumber", -1);
1436 if (lslb != -1 && ssub != -1 && mspn != -1)
1438 /* So're a Z39.50 expert? Let's hope you don't do sort */
1439 *search_req->largeSetLowerBound = lslb;
1440 *search_req->smallSetUpperBound = ssub;
1441 *search_req->mediumSetPresentNumber = mspn;
1443 else if (r->start == 0 && r->count > 0
1444 && r->piggyback && !r->r_sort_spec && !r->schema)
1446 /* Regular piggyback - do it unless we're going to do sort */
1447 *search_req->largeSetLowerBound = 2000000000;
1448 *search_req->smallSetUpperBound = 1;
1449 *search_req->mediumSetPresentNumber = r->step>0 ? r->step : r->count;
1453 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1454 smallSetElementSetName = 0;
1455 mediumSetElementSetName = 0;
1458 if (smallSetElementSetName && *smallSetElementSetName)
1460 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1461 odr_malloc (c->odr_out, sizeof(*esn));
1463 esn->which = Z_ElementSetNames_generic;
1464 esn->u.generic = odr_strdup (c->odr_out, smallSetElementSetName);
1465 search_req->smallSetElementSetNames = esn;
1467 if (mediumSetElementSetName && *mediumSetElementSetName)
1469 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1470 odr_malloc (c->odr_out, sizeof(*esn));
1472 esn->which = Z_ElementSetNames_generic;
1473 esn->u.generic = odr_strdup (c->odr_out, mediumSetElementSetName);
1474 search_req->mediumSetElementSetNames = esn;
1477 search_req->preferredRecordSyntax =
1478 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1482 if (c->support_named_resultsets)
1486 /* find the lowest unused ordinal so that we re-use
1487 result sets on the server. */
1488 for (ord = 1; ; ord++)
1491 sprintf (setname, "%d", ord);
1492 for (rp = c->resultsets; rp; rp = rp->next)
1493 if (rp->setname && !strcmp (rp->setname, setname))
1498 r->setname = xstrdup (setname);
1499 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1500 "set %s", c, r->setname);
1504 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1506 r->setname = xstrdup ("default");
1508 ZOOM_options_set (r->options, "setname", r->setname);
1510 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1511 return send_APDU (c, apdu);
1514 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1521 case Z_DefaultDiagFormat_v2Addinfo:
1522 addinfo = r->u.v2Addinfo;
1524 case Z_DefaultDiagFormat_v3Addinfo:
1525 addinfo = r->u.v3Addinfo;
1530 set_dset_error(c, *r->condition,
1531 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1535 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1537 if (p->which != Z_DiagRec_defaultFormat)
1538 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1540 response_default_diag(c, p->u.defaultFormat);
1543 ZOOM_API(ZOOM_record)
1544 ZOOM_record_clone (ZOOM_record srec)
1551 odr_enc = odr_createmem(ODR_ENCODE);
1552 if (!z_NamePlusRecord (odr_enc, &srec->npr, 0, 0))
1554 buf = odr_getbuf (odr_enc, &size, 0);
1556 nrec = (ZOOM_record) xmalloc (sizeof(*nrec));
1557 nrec->odr = odr_createmem(ODR_DECODE);
1558 nrec->wrbuf_marc = 0;
1559 nrec->wrbuf_iconv = 0;
1560 nrec->wrbuf_opac = 0;
1561 odr_setbuf (nrec->odr, buf, size, 0);
1562 z_NamePlusRecord (nrec->odr, &nrec->npr, 0, 0);
1564 odr_destroy (odr_enc);
1568 ZOOM_API(ZOOM_record)
1569 ZOOM_resultset_record_immediate (ZOOM_resultset s,size_t pos)
1571 return record_cache_lookup (s, pos);
1574 ZOOM_API(ZOOM_record)
1575 ZOOM_resultset_record (ZOOM_resultset r, size_t pos)
1577 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1581 ZOOM_resultset_retrieve (r, 1, pos, 1);
1582 rec = ZOOM_resultset_record_immediate (r, pos);
1588 ZOOM_record_destroy (ZOOM_record rec)
1592 if (rec->wrbuf_marc)
1593 wrbuf_free (rec->wrbuf_marc, 1);
1594 if (rec->wrbuf_iconv)
1595 wrbuf_free (rec->wrbuf_iconv, 1);
1596 if (rec->wrbuf_opac)
1597 wrbuf_free (rec->wrbuf_opac, 1);
1598 odr_destroy (rec->odr);
1602 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1604 const char *buf, int sz,
1605 const char *record_charset)
1610 yaz_marc_t mt = yaz_marc_create();
1613 strcpy(to, "UTF-8");
1614 if (record_charset && *record_charset)
1616 /* Use "from,to" or just "from" */
1617 const char *cp = strchr(record_charset, ',');
1618 int clen = strlen(record_charset);
1621 strncpy( to, cp+1, sizeof(to)-1);
1622 to[sizeof(to)-1] = '\0';
1623 clen = cp - record_charset;
1625 if (clen > sizeof(from)-1)
1626 clen = sizeof(from)-1;
1629 strncpy(from, record_charset, clen);
1635 cd = yaz_iconv_open(to, from);
1636 yaz_marc_iconv(mt, cd);
1639 yaz_marc_xml(mt, marc_type);
1640 if (!rec->wrbuf_marc)
1641 rec->wrbuf_marc = wrbuf_alloc();
1642 wrbuf_rewind (rec->wrbuf_marc);
1643 if (yaz_marc_decode_wrbuf (mt, buf, sz, rec->wrbuf_marc) > 0)
1645 yaz_marc_destroy(mt);
1647 yaz_iconv_close(cd);
1649 *len = wrbuf_len(rec->wrbuf_marc);
1650 return wrbuf_buf(rec->wrbuf_marc);
1652 yaz_marc_destroy(mt);
1654 yaz_iconv_close(cd);
1658 static const char *record_iconv_return(ZOOM_record rec, int *len,
1659 const char *buf, int sz,
1660 const char *record_charset)
1667 strcpy(to, "UTF-8");
1668 if (record_charset && *record_charset)
1670 /* Use "from,to" or just "from" */
1671 const char *cp = strchr(record_charset, ',');
1672 int clen = strlen(record_charset);
1675 strncpy( to, cp+1, sizeof(to)-1);
1676 to[sizeof(to)-1] = '\0';
1677 clen = cp - record_charset;
1679 if (clen > sizeof(from)-1)
1680 clen = sizeof(from)-1;
1683 strncpy(from, record_charset, clen);
1687 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1690 size_t inbytesleft = sz;
1691 const char *inp = buf;
1693 if (!rec->wrbuf_iconv)
1694 rec->wrbuf_iconv = wrbuf_alloc();
1696 wrbuf_rewind(rec->wrbuf_iconv);
1700 size_t outbytesleft = sizeof(outbuf);
1701 char *outp = outbuf;
1702 size_t r = yaz_iconv (cd, (char**) &inp,
1704 &outp, &outbytesleft);
1705 if (r == (size_t) (-1))
1707 int e = yaz_iconv_error(cd);
1708 if (e != YAZ_ICONV_E2BIG)
1711 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1713 wrbuf_puts(rec->wrbuf_iconv, "");
1714 buf = wrbuf_buf(rec->wrbuf_iconv);
1715 sz = wrbuf_len(rec->wrbuf_iconv);
1716 yaz_iconv_close(cd);
1723 ZOOM_API(const char *)
1724 ZOOM_record_get (ZOOM_record rec, const char *type_spec, int *len)
1731 Z_NamePlusRecord *npr;
1734 *len = 0; /* default return */
1743 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1745 if (cp[i] == ';' || cp[i] == ' ')
1751 while (type_spec[i] == ';')
1754 while (type_spec[i] == ' ')
1756 if (!strncmp(type_spec+i, "charset=", 8))
1759 i = i + 8; /* skip charset= */
1760 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1762 if (type_spec[i] == ';' || type_spec[i] == ' ')
1768 else if (!strncmp(type_spec+i, "xpath=", 6))
1772 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1776 while (type_spec[i] == ' ')
1779 if (!strcmp (type, "database"))
1782 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1783 return npr->databaseName;
1785 else if (!strcmp (type, "syntax"))
1787 const char *desc = 0;
1788 if (npr->which == Z_NamePlusRecord_databaseRecord)
1790 Z_External *r = (Z_External *) npr->u.databaseRecord;
1791 oident *ent = oid_getentbyoid(r->direct_reference);
1798 *len = strlen(desc);
1801 if (npr->which != Z_NamePlusRecord_databaseRecord)
1804 /* from now on - we have a database record .. */
1805 if (!strcmp (type, "render"))
1807 Z_External *r = (Z_External *) npr->u.databaseRecord;
1808 oident *ent = oid_getentbyoid(r->direct_reference);
1810 /* render bibliographic record .. */
1811 if (r->which == Z_External_OPAC)
1813 r = r->u.opac->bibliographicRecord;
1816 ent = oid_getentbyoid(r->direct_reference);
1818 if (r->which == Z_External_sutrs)
1819 return record_iconv_return(rec, len,
1820 (char*) r->u.sutrs->buf,
1823 else if (r->which == Z_External_octet)
1825 const char *ret_buf;
1833 case VAL_APPLICATION_XML:
1836 ret_buf = marc_iconv_return(
1837 rec, YAZ_MARC_LINE, len,
1838 (const char *) r->u.octet_aligned->buf,
1839 r->u.octet_aligned->len,
1844 return record_iconv_return(rec, len,
1845 (const char *) r->u.octet_aligned->buf,
1846 r->u.octet_aligned->len,
1849 else if (r->which == Z_External_grs1)
1851 if (!rec->wrbuf_marc)
1852 rec->wrbuf_marc = wrbuf_alloc();
1853 wrbuf_rewind (rec->wrbuf_marc);
1854 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1855 return record_iconv_return(rec, len,
1856 wrbuf_buf(rec->wrbuf_marc),
1857 wrbuf_len(rec->wrbuf_marc),
1862 else if (!strcmp (type, "xml") || !strcmp(type, "oai"))
1864 Z_External *r = (Z_External *) npr->u.databaseRecord;
1865 oident *ent = oid_getentbyoid(r->direct_reference);
1867 /* render bibliographic record .. */
1868 if (r->which == Z_External_OPAC)
1870 r = r->u.opac->bibliographicRecord;
1873 ent = oid_getentbyoid(r->direct_reference);
1876 if (r->which == Z_External_sutrs)
1877 return record_iconv_return(rec, len,
1878 (const char *) r->u.sutrs->buf,
1881 else if (r->which == Z_External_octet)
1883 const char *ret_buf;
1884 int marc_decode_type = YAZ_MARC_MARCXML;
1886 if (!strcmp(type, "oai"))
1887 marc_decode_type = YAZ_MARC_OAIMARC;
1895 case VAL_APPLICATION_XML:
1898 ret_buf = marc_iconv_return(
1899 rec, marc_decode_type, len,
1900 (const char *) r->u.octet_aligned->buf,
1901 r->u.octet_aligned->len,
1906 return record_iconv_return(rec, len,
1907 (const char *) r->u.octet_aligned->buf,
1908 r->u.octet_aligned->len,
1911 else if (r->which == Z_External_grs1)
1918 else if (!strcmp (type, "raw"))
1920 Z_External *r = (Z_External *) npr->u.databaseRecord;
1922 if (r->which == Z_External_sutrs)
1924 if (len) *len = r->u.sutrs->len;
1925 return (const char *) r->u.sutrs->buf;
1927 else if (r->which == Z_External_octet)
1929 if (len) *len = r->u.octet_aligned->len;
1930 return (const char *) r->u.octet_aligned->buf;
1932 else /* grs-1, explain, OPAC, ... */
1935 return (const char *) npr->u.databaseRecord;
1939 else if (!strcmp (type, "ext"))
1942 return (const char *) npr->u.databaseRecord;
1944 else if (!strcmp (type, "opac"))
1947 Z_External *r = (Z_External *) npr->u.databaseRecord;
1948 if (r->which == Z_External_OPAC)
1950 if (!rec->wrbuf_opac)
1951 rec->wrbuf_opac = wrbuf_alloc();
1952 wrbuf_rewind (rec->wrbuf_opac);
1953 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
1954 return record_iconv_return(rec, len,
1955 wrbuf_buf(rec->wrbuf_opac),
1956 wrbuf_len(rec->wrbuf_opac),
1963 static int strcmp_null(const char *v1, const char *v2)
1969 return strcmp(v1, v2);
1972 static void record_cache_add (ZOOM_resultset r, Z_NamePlusRecord *npr,
1975 ZOOM_record_cache rc;
1976 const char *elementSetName =
1977 ZOOM_resultset_option_get (r, "elementSetName");
1978 const char *syntax =
1979 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
1981 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1982 ZOOM_connection_put_event(r->connection, event);
1984 for (rc = r->record_cache; rc; rc = rc->next)
1988 if (strcmp_null(r->schema, rc->schema))
1990 if (strcmp_null(elementSetName,rc->elementSetName))
1992 if (strcmp_null(syntax, rc->syntax))
1994 /* not destroying rc->npr (it's handled by nmem )*/
1996 /* keeping wrbuf_marc too */
2000 rc = (ZOOM_record_cache) odr_malloc (r->odr, sizeof(*rc));
2003 rc->rec.wrbuf_marc = 0;
2004 rc->rec.wrbuf_iconv = 0;
2005 rc->rec.wrbuf_opac = 0;
2007 rc->elementSetName = odr_strdup (r->odr, elementSetName);
2009 rc->elementSetName = 0;
2012 rc->syntax = odr_strdup (r->odr, syntax);
2017 rc->schema = odr_strdup (r->odr, r->schema);
2022 rc->next = r->record_cache;
2023 r->record_cache = rc;
2026 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos)
2028 ZOOM_record_cache rc;
2029 const char *elementSetName =
2030 ZOOM_resultset_option_get (r, "elementSetName");
2031 const char *syntax =
2032 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
2034 for (rc = r->record_cache; rc; rc = rc->next)
2038 if (strcmp_null(r->schema, rc->schema))
2040 if (strcmp_null(elementSetName,rc->elementSetName))
2042 if (strcmp_null(syntax, rc->syntax))
2050 static void handle_records (ZOOM_connection c, Z_Records *sr,
2053 ZOOM_resultset resultset;
2057 switch (c->tasks->which)
2059 case ZOOM_TASK_SEARCH:
2060 resultset = c->tasks->u.search.resultset;
2062 case ZOOM_TASK_RETRIEVE:
2063 resultset = c->tasks->u.retrieve.resultset;
2068 if (sr && sr->which == Z_Records_NSD)
2069 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2070 else if (sr && sr->which == Z_Records_multipleNSD)
2072 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2073 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2075 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2079 if (resultset->count + resultset->start > resultset->size)
2080 resultset->count = resultset->size - resultset->start;
2081 if (resultset->count < 0)
2082 resultset->count = 0;
2083 if (sr && sr->which == Z_Records_DBOSD)
2086 NMEM nmem = odr_extract_mem (c->odr_in);
2087 Z_NamePlusRecordList *p =
2088 sr->u.databaseOrSurDiagnostics;
2089 for (i = 0; i<p->num_records; i++)
2091 record_cache_add (resultset, p->records[i],
2092 i+ resultset->start);
2094 /* transfer our response to search_nmem .. we need it later */
2095 nmem_transfer (resultset->odr->mem, nmem);
2096 nmem_destroy (nmem);
2097 if (present_phase && p->num_records == 0)
2099 /* present response and we didn't get any records! */
2100 Z_NamePlusRecord *myrec =
2101 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2102 record_cache_add(resultset, myrec, resultset->start);
2105 else if (present_phase)
2107 /* present response and we didn't get any records! */
2108 Z_NamePlusRecord *myrec =
2109 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2110 record_cache_add(resultset, myrec, resultset->start);
2115 static void handle_present_response (ZOOM_connection c, Z_PresentResponse *pr)
2117 handle_records (c, pr->records, 1);
2120 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2123 switch (term->which)
2125 case Z_Term_general:
2126 ZOOM_options_setl(opt, name,
2127 (const char *)(term->u.general->buf),
2128 term->u.general->len);
2130 case Z_Term_characterString:
2131 ZOOM_options_set(opt, name, term->u.characterString);
2133 case Z_Term_numeric:
2134 ZOOM_options_set_int(opt, name, *term->u.numeric);
2139 static void handle_queryExpression(ZOOM_options opt, const char *name,
2140 Z_QueryExpression *exp)
2146 case Z_QueryExpression_term:
2147 if (exp->u.term && exp->u.term->queryTerm)
2149 sprintf(opt_name, "%s.term", name);
2150 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2153 case Z_QueryExpression_query:
2158 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2159 Z_OtherInformation *o)
2162 for (i = 0; o && i < o->num_elements; i++)
2164 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2166 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2168 if (ext->which == Z_External_searchResult1)
2171 Z_SearchInfoReport *sr = ext->u.searchResult1;
2174 ZOOM_options_set_int(
2175 resultset->options, "searchresult.size", sr->num);
2177 for (j = 0; j < sr->num; j++)
2179 Z_SearchInfoReport_s *ent =
2180 ext->u.searchResult1->elements[j];
2183 sprintf(pref, "searchresult.%d", j);
2185 if (ent->subqueryId)
2188 sprintf(opt_name, "%s.id", pref);
2189 ZOOM_options_set(resultset->options, opt_name,
2192 if (ent->subqueryExpression)
2195 sprintf(opt_name, "%s.subquery", pref);
2196 handle_queryExpression(resultset->options, opt_name,
2197 ent->subqueryExpression);
2199 if (ent->subqueryInterpretation)
2202 sprintf(opt_name, "%s.interpretation", pref);
2203 handle_queryExpression(resultset->options, opt_name,
2204 ent->subqueryInterpretation);
2206 if (ent->subqueryRecommendation)
2209 sprintf(opt_name, "%s.recommendation", pref);
2210 handle_queryExpression(resultset->options, opt_name,
2211 ent->subqueryRecommendation);
2213 if (ent->subqueryCount)
2216 sprintf(opt_name, "%s.count", pref);
2217 ZOOM_options_set_int(resultset->options, opt_name,
2218 *ent->subqueryCount);
2226 static void handle_search_response (ZOOM_connection c, Z_SearchResponse *sr)
2228 ZOOM_resultset resultset;
2231 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2234 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2235 ZOOM_connection_put_event(c, event);
2237 resultset = c->tasks->u.search.resultset;
2239 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2241 resultset->size = *sr->resultCount;
2242 handle_records (c, sr->records, 0);
2245 static void sort_response (ZOOM_connection c, Z_SortResponse *res)
2247 if (res->diagnostics && res->num_diagnostics > 0)
2248 response_diag (c, res->diagnostics[0]);
2251 static int scan_response (ZOOM_connection c, Z_ScanResponse *res)
2253 NMEM nmem = odr_extract_mem (c->odr_in);
2256 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2258 scan = c->tasks->u.scan.scan;
2260 if (res->entries && res->entries->nonsurrogateDiagnostics)
2261 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2262 scan->scan_response = res;
2263 nmem_transfer (scan->odr->mem, nmem);
2265 ZOOM_options_set_int (scan->options, "stepSize", *res->stepSize);
2266 if (res->positionOfTerm)
2267 ZOOM_options_set_int (scan->options, "position", *res->positionOfTerm);
2268 if (res->scanStatus)
2269 ZOOM_options_set_int (scan->options, "scanStatus", *res->scanStatus);
2270 if (res->numberOfEntriesReturned)
2271 ZOOM_options_set_int (scan->options, "number",
2272 *res->numberOfEntriesReturned);
2273 nmem_destroy (nmem);
2277 static zoom_ret send_sort (ZOOM_connection c,
2278 ZOOM_resultset resultset)
2281 resultset->r_sort_spec = 0;
2282 if (resultset->r_sort_spec)
2284 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2285 Z_SortRequest *req = apdu->u.sortRequest;
2287 req->num_inputResultSetNames = 1;
2288 req->inputResultSetNames = (Z_InternationalString **)
2289 odr_malloc (c->odr_out, sizeof(*req->inputResultSetNames));
2290 req->inputResultSetNames[0] =
2291 odr_strdup (c->odr_out, resultset->setname);
2292 req->sortedResultSetName = odr_strdup (c->odr_out, resultset->setname);
2293 req->sortSequence = resultset->r_sort_spec;
2294 resultset->r_sort_spec = 0;
2295 return send_APDU (c, apdu);
2297 return zoom_complete;
2300 static zoom_ret send_present(ZOOM_connection c)
2303 Z_PresentRequest *req = 0;
2305 const char *syntax = 0;
2306 const char *elementSetName = 0;
2307 ZOOM_resultset resultset;
2311 yaz_log(log_details, "%p send_present no tasks", c);
2312 return zoom_complete;
2314 switch (c->tasks->which)
2316 case ZOOM_TASK_SEARCH:
2317 resultset = c->tasks->u.search.resultset;
2319 case ZOOM_TASK_RETRIEVE:
2320 resultset = c->tasks->u.retrieve.resultset;
2321 resultset->start = c->tasks->u.retrieve.start;
2322 resultset->count = c->tasks->u.retrieve.count;
2324 if (resultset->start >= resultset->size)
2326 yaz_log(log_details, "%p send_present start=%d >= size=%d",
2327 c, resultset->start, resultset->size);
2328 return zoom_complete;
2330 if (resultset->start + resultset->count > resultset->size)
2331 resultset->count = resultset->size - resultset->start;
2334 return zoom_complete;
2336 yaz_log(log_details, "%p send_present start=%d count=%d",
2337 c, resultset->start, resultset->count);
2339 syntax = ZOOM_resultset_option_get (resultset, "preferredRecordSyntax");
2340 elementSetName = ZOOM_resultset_option_get (resultset, "elementSetName");
2342 if (c->error) /* don't continue on error */
2343 return zoom_complete;
2344 if (resultset->start < 0)
2345 return zoom_complete;
2346 for (i = 0; i<resultset->count; i++)
2349 record_cache_lookup (resultset, i + resultset->start);
2353 if (i == resultset->count)
2355 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2356 return zoom_complete;
2359 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2360 req = apdu->u.presentRequest;
2362 resultset->start += i;
2363 resultset->count -= i;
2366 yaz_log(log_details, "%p send_present skip=%d", c, i);
2368 *req->resultSetStartPoint = resultset->start + 1;
2369 *req->numberOfRecordsRequested = resultset->step>0 ?
2370 resultset->step : resultset->count;
2371 if (*req->numberOfRecordsRequested + resultset->start > resultset->size)
2372 *req->numberOfRecordsRequested = resultset->size - resultset->start;
2373 assert (*req->numberOfRecordsRequested > 0);
2375 if (syntax && *syntax)
2376 req->preferredRecordSyntax =
2377 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
2379 if (resultset->schema && *resultset->schema)
2381 Z_RecordComposition *compo = (Z_RecordComposition *)
2382 odr_malloc (c->odr_out, sizeof(*compo));
2384 req->recordComposition = compo;
2385 compo->which = Z_RecordComp_complex;
2386 compo->u.complex = (Z_CompSpec *)
2387 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2388 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2389 odr_malloc(c->odr_out, sizeof(bool_t));
2390 *compo->u.complex->selectAlternativeSyntax = 0;
2392 compo->u.complex->generic = (Z_Specification *)
2393 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2395 compo->u.complex->generic->which = Z_Schema_oid;
2396 compo->u.complex->generic->schema.oid = (Odr_oid *)
2397 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2399 if (!compo->u.complex->generic->schema.oid)
2401 /* OID wasn't a schema! Try record syntax instead. */
2403 compo->u.complex->generic->schema.oid = (Odr_oid *)
2404 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2406 if (elementSetName && *elementSetName)
2408 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2409 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2410 compo->u.complex->generic->elementSpec->which =
2411 Z_ElementSpec_elementSetName;
2412 compo->u.complex->generic->elementSpec->u.elementSetName =
2413 odr_strdup (c->odr_out, elementSetName);
2416 compo->u.complex->generic->elementSpec = 0;
2417 compo->u.complex->num_dbSpecific = 0;
2418 compo->u.complex->dbSpecific = 0;
2419 compo->u.complex->num_recordSyntax = 0;
2420 compo->u.complex->recordSyntax = 0;
2422 else if (elementSetName && *elementSetName)
2424 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2425 odr_malloc (c->odr_out, sizeof(*esn));
2426 Z_RecordComposition *compo = (Z_RecordComposition *)
2427 odr_malloc (c->odr_out, sizeof(*compo));
2429 esn->which = Z_ElementSetNames_generic;
2430 esn->u.generic = odr_strdup (c->odr_out, elementSetName);
2431 compo->which = Z_RecordComp_simple;
2432 compo->u.simple = esn;
2433 req->recordComposition = compo;
2435 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2436 return send_APDU (c, apdu);
2439 ZOOM_API(ZOOM_scanset)
2440 ZOOM_connection_scan (ZOOM_connection c, const char *start)
2443 ZOOM_query q = ZOOM_query_create();
2445 ZOOM_query_prefix (q, start);
2447 s = ZOOM_connection_scan1(c, q);
2448 ZOOM_query_destroy (q);
2453 ZOOM_API(ZOOM_scanset)
2454 ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query q)
2456 ZOOM_scanset scan = (ZOOM_scanset) xmalloc (sizeof(*scan));
2460 scan->connection = c;
2461 scan->odr = odr_createmem (ODR_DECODE);
2462 scan->options = ZOOM_options_create_with_parent (c->options);
2464 scan->scan_response = 0;
2467 * We need to check the query-type, so we can recognise CQL and
2468 * compile it into a form that we can use here. The ZOOM_query
2469 * structure has no explicit `type' member, but inspection of the
2470 * ZOOM_query_prefix() and ZOOM_query_cql() functions shows how
2471 * the structure is set up in each case.
2474 if (q->z_query->which == Z_Query_type_1) {
2475 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2476 c, q, q->query_string);
2477 start = q->query_string;
2478 } else if (q->z_query->which == Z_Query_type_104) {
2479 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2480 c, q, q->query_string);
2481 start = freeme = cql2pqf(c, q->query_string);
2485 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2486 c, q, q->query_string);
2490 scan->termListAndStartPoint =
2491 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2493 if (scan->termListAndStartPoint != 0)
2495 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_SCAN);
2496 task->u.scan.scan = scan;
2501 while (ZOOM_event (1, &c))
2509 ZOOM_scanset_destroy (ZOOM_scanset scan)
2514 if (scan->refcount == 0)
2516 odr_destroy (scan->odr);
2518 ZOOM_options_destroy (scan->options);
2523 static zoom_ret send_package (ZOOM_connection c)
2527 yaz_log(log_details, "%p send_package", c);
2529 return zoom_complete;
2530 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2532 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
2533 ZOOM_connection_put_event (c, event);
2535 return do_write_ex (c, c->tasks->u.package->buf_out,
2536 c->tasks->u.package->len_out);
2539 static zoom_ret send_scan (ZOOM_connection c)
2542 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2543 Z_ScanRequest *req = apdu->u.scanRequest;
2545 yaz_log(log_details, "%p send_scan", c);
2547 return zoom_complete;
2548 assert (c->tasks->which == ZOOM_TASK_SCAN);
2549 scan = c->tasks->u.scan.scan;
2551 req->termListAndStartPoint = scan->termListAndStartPoint;
2552 req->attributeSet = scan->attributeSet;
2554 *req->numberOfTermsRequested =
2555 ZOOM_options_get_int(scan->options, "number", 10);
2557 req->preferredPositionInResponse =
2558 odr_intdup (c->odr_out,
2559 ZOOM_options_get_int(scan->options, "position", 1));
2562 odr_intdup (c->odr_out,
2563 ZOOM_options_get_int(scan->options, "stepSize", 0));
2565 req->databaseNames = set_DatabaseNames (c, scan->options,
2566 &req->num_databaseNames);
2568 return send_APDU (c, apdu);
2572 ZOOM_scanset_size (ZOOM_scanset scan)
2574 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2576 return scan->scan_response->entries->num_entries;
2579 ZOOM_API(const char *)
2580 ZOOM_scanset_term (ZOOM_scanset scan, size_t pos,
2583 const char *term = 0;
2584 size_t noent = ZOOM_scanset_size (scan);
2585 Z_ScanResponse *res = scan->scan_response;
2591 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2593 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2595 if (t->term->which == Z_Term_general)
2597 term = (const char *) t->term->u.general->buf;
2598 *len = t->term->u.general->len;
2600 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2605 ZOOM_API(const char *)
2606 ZOOM_scanset_display_term (ZOOM_scanset scan, size_t pos,
2609 const char *term = 0;
2610 size_t noent = ZOOM_scanset_size (scan);
2611 Z_ScanResponse *res = scan->scan_response;
2617 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2619 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2623 term = t->displayTerm;
2624 *len = strlen(term);
2626 else if (t->term->which == Z_Term_general)
2628 term = (const char *) t->term->u.general->buf;
2629 *len = t->term->u.general->len;
2631 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2636 ZOOM_API(const char *)
2637 ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key)
2639 return ZOOM_options_get (scan->options, key);
2643 ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
2646 ZOOM_options_set (scan->options, key, val);
2649 static Z_APDU *create_es_package (ZOOM_package p, int type)
2652 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2653 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2655 *req->function = Z_ExtendedServicesRequest_create;
2657 str = ZOOM_options_get(p->options, "package-name");
2659 req->packageName = nmem_strdup (p->odr_out->mem, str);
2661 str = ZOOM_options_get(p->options, "user-id");
2663 req->userId = nmem_strdup (p->odr_out->mem, str);
2665 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2668 str = ZOOM_options_get(p->options, "function");
2671 if (!strcmp (str, "create"))
2673 if (!strcmp (str, "delete"))
2675 if (!strcmp (str, "modify"))
2681 static const char *ill_array_lookup (void *clientData, const char *idx)
2683 ZOOM_package p = (ZOOM_package) clientData;
2684 return ZOOM_options_get (p->options, idx+4);
2687 static Z_External *encode_ill_request (ZOOM_package p)
2689 ODR out = p->odr_out;
2692 struct ill_get_ctl ctl;
2694 ctl.odr = p->odr_out;
2696 ctl.f = ill_array_lookup;
2698 req = ill_get_ILLRequest(&ctl, "ill", 0);
2700 if (!ill_Request (out, &req, 0, 0))
2702 int ill_request_size;
2703 char *ill_request_buf = odr_getbuf (out, &ill_request_size, 0);
2704 if (ill_request_buf)
2705 odr_setbuf (out, ill_request_buf, ill_request_size, 1);
2711 int illRequest_size = 0;
2712 char *illRequest_buf = odr_getbuf (out, &illRequest_size, 0);
2714 oid.proto = PROTO_GENERAL;
2715 oid.oclass = CLASS_GENERAL;
2716 oid.value = VAL_ISO_ILL_1;
2718 r = (Z_External *) odr_malloc (out, sizeof(*r));
2719 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2720 r->indirect_reference = 0;
2722 r->which = Z_External_single;
2724 r->u.single_ASN1_type =
2725 odr_create_Odr_oct(out,
2726 (unsigned char *)illRequest_buf,
2732 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2734 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc (p->odr_out, sizeof(*req));
2737 req->which = Z_IOItemOrder_esRequest;
2738 req->u.esRequest = (Z_IORequest *)
2739 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2741 /* to keep part ... */
2742 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2743 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2744 req->u.esRequest->toKeep->supplDescription = 0;
2745 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2746 odr_malloc (p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2748 str = ZOOM_options_get(p->options, "contact-name");
2749 req->u.esRequest->toKeep->contact->name = str ?
2750 nmem_strdup (p->odr_out->mem, str) : 0;
2752 str = ZOOM_options_get(p->options, "contact-phone");
2753 req->u.esRequest->toKeep->contact->phone = str ?
2754 nmem_strdup (p->odr_out->mem, str) : 0;
2756 str = ZOOM_options_get(p->options, "contact-email");
2757 req->u.esRequest->toKeep->contact->email = str ?
2758 nmem_strdup (p->odr_out->mem, str) : 0;
2760 req->u.esRequest->toKeep->addlBilling = 0;
2762 /* not to keep part ... */
2763 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2764 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2766 str = ZOOM_options_get(p->options, "itemorder-setname");
2771 req->u.esRequest->notToKeep->resultSetItem = 0;
2774 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2775 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2777 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2778 nmem_strdup (p->odr_out->mem, str);
2779 req->u.esRequest->notToKeep->resultSetItem->item =
2780 (int *) odr_malloc(p->odr_out, sizeof(int));
2782 str = ZOOM_options_get(p->options, "itemorder-item");
2783 *req->u.esRequest->notToKeep->resultSetItem->item =
2784 (str ? atoi(str) : 1);
2786 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2791 Z_APDU *create_admin_package(ZOOM_package p, int type,
2792 Z_ESAdminOriginPartToKeep **toKeepP,
2793 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2795 Z_APDU *apdu = create_es_package (p, VAL_ADMINSERVICE);
2798 Z_ESAdminOriginPartToKeep *toKeep;
2799 Z_ESAdminOriginPartNotToKeep *notToKeep;
2800 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2801 const char *first_db = "Default";
2803 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2807 r->direct_reference =
2808 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2811 r->indirect_reference = 0;
2812 r->which = Z_External_ESAdmin;
2814 r->u.adminService = (Z_Admin *)
2815 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2816 r->u.adminService->which = Z_Admin_esRequest;
2817 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2818 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2820 toKeep = r->u.adminService->u.esRequest->toKeep =
2821 (Z_ESAdminOriginPartToKeep *)
2822 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2823 toKeep->which = type;
2824 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2825 toKeep->u.create = odr_nullval();
2826 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2828 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2829 (Z_ESAdminOriginPartNotToKeep *)
2830 odr_malloc(p->odr_out,
2831 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2832 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
2833 notToKeep->u.recordsWillFollow = odr_nullval();
2837 *notToKeepP = notToKeep;
2842 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
2844 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
2845 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2846 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
2847 const char *doc = ZOOM_options_get(p->options, "doc");
2852 req->taskSpecificParameters = ext;
2853 ext->direct_reference = req->packageType;
2854 ext->descriptor = 0;
2855 ext->indirect_reference = 0;
2857 ext->which = Z_External_octet;
2858 ext->u.single_ASN1_type =
2859 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
2864 static Z_APDU *create_update_package(ZOOM_package p)
2867 const char *first_db = "Default";
2869 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2870 const char *action = ZOOM_options_get(p->options, "action");
2871 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
2872 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
2873 const char *record_buf = ZOOM_options_get(p->options, "record");
2874 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
2875 int syntax_oid = VAL_NONE;
2879 syntax_oid = oid_getvalbyname(syntax_str);
2882 record_buf = "void";
2883 syntax_oid = VAL_SUTRS;
2885 if (syntax_oid == VAL_NONE)
2886 syntax_oid = VAL_TEXT_XML;
2892 action = "specialUpdate";
2894 if (!strcmp(action, "recordInsert"))
2895 action_no = Z_IUOriginPartToKeep_recordInsert;
2896 else if (!strcmp(action, "recordReplace"))
2897 action_no = Z_IUOriginPartToKeep_recordReplace;
2898 else if (!strcmp(action, "recordDelete"))
2899 action_no = Z_IUOriginPartToKeep_recordDelete;
2900 else if (!strcmp(action, "elementUpdate"))
2901 action_no = Z_IUOriginPartToKeep_elementUpdate;
2902 else if (!strcmp(action, "specialUpdate"))
2903 action_no = Z_IUOriginPartToKeep_specialUpdate;
2907 apdu = create_es_package (p, VAL_DBUPDATE);
2910 Z_IUOriginPartToKeep *toKeep;
2911 Z_IUSuppliedRecords *notToKeep;
2912 Z_External *r = (Z_External *)
2913 odr_malloc (p->odr_out, sizeof(*r));
2915 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2917 r->direct_reference =
2918 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2921 r->which = Z_External_update;
2922 r->indirect_reference = 0;
2923 r->u.update = (Z_IUUpdate *)
2924 odr_malloc(p->odr_out, sizeof(*r->u.update));
2926 r->u.update->which = Z_IUUpdate_esRequest;
2927 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
2928 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
2929 toKeep = r->u.update->u.esRequest->toKeep =
2930 (Z_IUOriginPartToKeep *)
2931 odr_malloc(p->odr_out, sizeof(*toKeep));
2933 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2935 toKeep->elementSetName = 0;
2936 toKeep->actionQualifier = 0;
2937 toKeep->action = odr_intdup(p->odr_out, action_no);
2939 notToKeep = r->u.update->u.esRequest->notToKeep =
2940 (Z_IUSuppliedRecords *)
2941 odr_malloc(p->odr_out, sizeof(*notToKeep));
2943 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
2944 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
2945 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
2946 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
2947 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
2950 notToKeep->elements[0]->u.opaque =
2951 odr_create_Odr_oct(p->odr_out,
2952 (const unsigned char *) recordIdOpaque,
2953 strlen(recordIdOpaque));
2955 else if (recordIdNumber)
2957 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
2959 notToKeep->elements[0]->u.number =
2960 odr_intdup(p->odr_out, atoi(recordIdNumber));
2963 notToKeep->elements[0]->u.opaque = 0;
2964 notToKeep->elements[0]->supplementalId = 0;
2965 notToKeep->elements[0]->correlationInfo = 0;
2966 notToKeep->elements[0]->record =
2967 z_ext_record(p->odr_out, syntax_oid,
2968 record_buf, strlen(record_buf));
2972 ODR print = odr_createmem(ODR_PRINT);
2974 z_APDU(print, &apdu, 0, 0);
2981 ZOOM_package_send (ZOOM_package p, const char *type)
2988 odr_reset (p->odr_out);
2991 if (!strcmp(type, "itemorder"))
2993 apdu = create_es_package (p, VAL_ITEMORDER);
2996 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2998 r->direct_reference =
2999 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3002 r->which = Z_External_itemOrder;
3003 r->indirect_reference = 0;
3004 r->u.itemOrder = encode_item_order (p);
3006 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3009 else if (!strcmp(type, "create")) /* create database */
3011 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3014 else if (!strcmp(type, "drop")) /* drop database */
3016 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3019 else if (!strcmp(type, "commit")) /* commit changes */
3021 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3024 else if (!strcmp(type, "update")) /* update record(s) */
3026 apdu = create_update_package(p);
3028 else if (!strcmp(type, "xmlupdate"))
3030 apdu = create_xmlupdate_package(p);
3034 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3038 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_PACKAGE);
3039 task->u.package = p;
3040 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3041 p->buf_out = (char *) xmalloc (p->len_out);
3042 memcpy (p->buf_out, buf, p->len_out);
3047 while (ZOOM_event (1, &c))
3054 ZOOM_API(ZOOM_package)
3055 ZOOM_connection_package (ZOOM_connection c, ZOOM_options options)
3057 ZOOM_package p = (ZOOM_package) xmalloc (sizeof(*p));
3060 p->odr_out = odr_createmem (ODR_ENCODE);
3061 p->options = ZOOM_options_create_with_parent2 (options, c->options);
3069 ZOOM_package_destroy(ZOOM_package p)
3074 if (p->refcount == 0)
3076 odr_destroy (p->odr_out);
3079 ZOOM_options_destroy (p->options);
3084 ZOOM_API(const char *)
3085 ZOOM_package_option_get (ZOOM_package p, const char *key)
3087 return ZOOM_options_get (p->options, key);
3092 ZOOM_package_option_set (ZOOM_package p, const char *key,
3095 ZOOM_options_set (p->options, key, val);
3098 static int ZOOM_connection_exec_task (ZOOM_connection c)
3100 ZOOM_task task = c->tasks;
3101 zoom_ret ret = zoom_complete;
3105 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3106 c, task->which, task->running);
3107 if (c->error != ZOOM_ERROR_NONE)
3109 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3110 "removing tasks because of error = %d", c, c->error);
3111 ZOOM_connection_remove_tasks (c);
3116 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3117 "task already running", c);
3121 ret = zoom_complete;
3122 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3124 switch (task->which)
3126 case ZOOM_TASK_SEARCH:
3127 if (c->proto == PROTO_HTTP)
3128 ret = ZOOM_connection_srw_send_search(c);
3130 ret = ZOOM_connection_send_search(c);
3132 case ZOOM_TASK_RETRIEVE:
3133 if (c->proto == PROTO_HTTP)
3134 ret = ZOOM_connection_srw_send_search(c);
3136 ret = send_present (c);
3138 case ZOOM_TASK_CONNECT:
3139 ret = do_connect(c);
3141 case ZOOM_TASK_SCAN:
3144 case ZOOM_TASK_PACKAGE:
3145 ret = send_package(c);
3147 case ZOOM_TASK_SORT:
3148 c->tasks->u.sort.resultset->r_sort_spec =
3149 c->tasks->u.sort.q->sort_spec;
3150 ret = send_sort(c, c->tasks->u.sort.resultset);
3156 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3157 "remove tasks because no connection exist", c);
3158 ZOOM_connection_remove_tasks (c);
3160 if (ret == zoom_complete)
3162 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3163 "task removed (complete)", c);
3164 ZOOM_connection_remove_task (c);
3167 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3172 static zoom_ret send_sort_present (ZOOM_connection c)
3174 zoom_ret r = zoom_complete;
3176 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3177 r = send_sort (c, c->tasks->u.search.resultset);
3178 if (r == zoom_complete)
3179 r = send_present (c);
3183 static int es_response (ZOOM_connection c,
3184 Z_ExtendedServicesResponse *res)
3186 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3188 if (res->diagnostics && res->num_diagnostics > 0)
3189 response_diag(c, res->diagnostics[0]);
3190 if (res->taskPackage &&
3191 res->taskPackage->which == Z_External_extendedService)
3193 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3194 Odr_oct *id = taskPackage->targetReference;
3197 ZOOM_options_setl (c->tasks->u.package->options,
3198 "targetReference", (char*) id->buf, id->len);
3200 if (res->taskPackage &&
3201 res->taskPackage->which == Z_External_octet)
3203 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3204 ZOOM_options_setl (c->tasks->u.package->options,
3205 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3210 static void interpret_init_diag(ZOOM_connection c,
3211 Z_DiagnosticFormat *diag)
3215 Z_DiagnosticFormat_s *ds = diag->elements[0];
3216 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3217 response_default_diag(c, ds->u.defaultDiagRec);
3222 static void interpret_otherinformation_field(ZOOM_connection c,
3223 Z_OtherInformation *ui)
3226 for (i = 0; i < ui->num_elements; i++)
3228 Z_OtherInformationUnit *unit = ui->list[i];
3229 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3230 unit->information.externallyDefinedInfo &&
3231 unit->information.externallyDefinedInfo->which ==
3234 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3239 static void recv_apdu (ZOOM_connection c, Z_APDU *apdu)
3241 Z_InitResponse *initrs;
3244 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3247 case Z_APDU_initResponse:
3248 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3249 initrs = apdu->u.initResponse;
3250 ZOOM_connection_option_set(c, "serverImplementationId",
3251 initrs->implementationId ?
3252 initrs->implementationId : "");
3253 ZOOM_connection_option_set(c, "serverImplementationName",
3254 initrs->implementationName ?
3255 initrs->implementationName : "");
3256 ZOOM_connection_option_set(c, "serverImplementationVersion",
3257 initrs->implementationVersion ?
3258 initrs->implementationVersion : "");
3259 /* Set the three old options too, for old applications */
3260 ZOOM_connection_option_set(c, "targetImplementationId",
3261 initrs->implementationId ?
3262 initrs->implementationId : "");
3263 ZOOM_connection_option_set(c, "targetImplementationName",
3264 initrs->implementationName ?
3265 initrs->implementationName : "");
3266 ZOOM_connection_option_set(c, "targetImplementationVersion",
3267 initrs->implementationVersion ?
3268 initrs->implementationVersion : "");
3269 if (!*initrs->result)
3271 Z_External *uif = initrs->userInformationField;
3273 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3275 if (uif && uif->which == Z_External_userInfo1)
3276 interpret_otherinformation_field(c, uif->u.userInfo1);
3281 yaz_oi_get_string_oidval (&apdu->u.initResponse->otherInfo,
3283 xfree (c->cookie_in);
3286 c->cookie_in = xstrdup(cookie);
3287 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3288 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3289 c->support_named_resultsets = 1;
3292 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3293 ZOOM_connection_remove_task (c);
3295 ZOOM_connection_exec_task (c);
3297 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3299 NMEM tmpmem = nmem_create();
3300 Z_CharSetandLanguageNegotiation *p =
3301 yaz_get_charneg_record(initrs->otherInfo);
3305 char *charset = NULL, *lang = NULL;
3308 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3309 yaz_log(log_details, "%p recv_apdu target accepted: "
3310 "charset %s, language %s, select %d",
3312 charset ? charset : "none", lang ? lang : "none", sel);
3314 ZOOM_connection_option_set (c, "negotiation-charset",
3317 ZOOM_connection_option_set (c, "negotiation-lang",
3320 ZOOM_connection_option_set (
3321 c, "negotiation-charset-in-effect-for-records",
3322 (sel != 0) ? "1" : "0");
3323 nmem_destroy(tmpmem);
3327 case Z_APDU_searchResponse:
3328 yaz_log(log_api, "%p recv_apdu Search response", c);
3329 handle_search_response (c, apdu->u.searchResponse);
3330 if (send_sort_present (c) == zoom_complete)
3331 ZOOM_connection_remove_task (c);
3333 case Z_APDU_presentResponse:
3334 yaz_log(log_api, "%p recv_apdu Present response", c);
3335 handle_present_response (c, apdu->u.presentResponse);
3336 if (send_present (c) == zoom_complete)
3337 ZOOM_connection_remove_task (c);
3339 case Z_APDU_sortResponse:
3340 yaz_log(log_api, "%p recv_apdu Sort response", c);
3341 sort_response (c, apdu->u.sortResponse);
3342 if (send_present (c) == zoom_complete)
3343 ZOOM_connection_remove_task (c);
3345 case Z_APDU_scanResponse:
3346 yaz_log(log_api, "%p recv_apdu Scan response", c);
3347 scan_response (c, apdu->u.scanResponse);
3348 ZOOM_connection_remove_task (c);
3350 case Z_APDU_extendedServicesResponse:
3351 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3352 es_response (c, apdu->u.extendedServicesResponse);
3353 ZOOM_connection_remove_task (c);
3356 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3357 if (c->reconnect_ok)
3360 c->tasks->running = 0;
3361 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3365 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3370 yaz_log(log_api, "%p Received unknown PDU", c);
3371 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3377 static void handle_srw_response(ZOOM_connection c,
3378 Z_SRW_searchRetrieveResponse *res)
3380 ZOOM_resultset resultset = 0;
3388 if (c->tasks->which == ZOOM_TASK_SEARCH)
3389 resultset = c->tasks->u.search.resultset;
3390 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
3391 resultset = c->tasks->u.retrieve.resultset;
3395 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3396 ZOOM_connection_put_event(c, event);
3398 resultset->size = 0;
3400 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3402 if (res->numberOfRecords)
3403 resultset->size = *res->numberOfRecords;
3405 for (i = 0; i<res->num_records; i++)
3409 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3410 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3412 if (res->records[i].recordPosition &&
3413 *res->records[i].recordPosition > 0)
3414 pos = *res->records[i].recordPosition - 1;
3416 pos = resultset->start + i;
3418 npr->databaseName = 0;
3419 npr->which = Z_NamePlusRecord_databaseRecord;
3420 npr->u.databaseRecord = (Z_External *)
3421 odr_malloc(c->odr_in, sizeof(Z_External));
3422 npr->u.databaseRecord->descriptor = 0;
3423 npr->u.databaseRecord->direct_reference =
3424 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3425 npr->u.databaseRecord->which = Z_External_octet;
3427 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3428 odr_malloc(c->odr_in, sizeof(Odr_oct));
3429 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3430 res->records[i].recordData_buf;
3431 npr->u.databaseRecord->u.octet_aligned->len =
3432 npr->u.databaseRecord->u.octet_aligned->size =
3433 res->records[i].recordData_len;
3434 record_cache_add (resultset, npr, pos);
3436 if (res->num_diagnostics > 0)
3438 const char *uri = res->diagnostics[0].uri;
3443 if ((cp = strrchr(uri, '/')))
3445 set_dset_error(c, code, uri,
3446 res->diagnostics[0].details, 0);
3449 nmem = odr_extract_mem(c->odr_in);
3450 nmem_transfer(resultset->odr->mem, nmem);
3456 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3459 const char *content_type = z_HTTP_header_lookup(hres->headers,
3461 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3464 yaz_log(log_details, "%p handle_http", c);
3466 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3468 Z_SOAP *soap_package = 0;
3470 Z_SOAP_Handler soap_handlers[2] = {
3471 {"http://www.loc.gov/zing/srw/", 0,
3472 (Z_SOAP_fun) yaz_srw_codec},
3475 ret = z_soap_codec(o, &soap_package,
3476 &hres->content_buf, &hres->content_len,
3478 if (!ret && soap_package->which == Z_SOAP_generic &&
3479 soap_package->u.generic->no == 0)
3481 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3482 if (sr->which == Z_SRW_searchRetrieve_response)
3483 handle_srw_response(c, sr->u.response);
3487 else if (!ret && (soap_package->which == Z_SOAP_fault
3488 || soap_package->which == Z_SOAP_error))
3490 set_HTTP_error(c, hres->code,
3491 soap_package->u.fault->fault_code,
3492 soap_package->u.fault->fault_string);
3499 if (hres->code != 200)
3500 set_HTTP_error(c, hres->code, 0, 0);
3502 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3505 ZOOM_connection_remove_task(c);
3506 if (!strcmp(hres->version, "1.0"))
3508 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3509 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3514 /* HTTP 1.1: only if no close we stay alive .. */
3515 if (connection_head && !strcmp(connection_head, "close"))
3521 static int do_read (ZOOM_connection c)
3526 event = ZOOM_Event_create (ZOOM_EVENT_RECV_DATA);
3527 ZOOM_connection_put_event (c, event);
3529 r = cs_get (c->cs, &c->buf_in, &c->len_in);
3530 more = cs_more(c->cs);
3531 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3536 if (c->reconnect_ok)
3539 c->reconnect_ok = 0;
3540 yaz_log(log_details, "%p do_read reconnect read", c);
3541 c->tasks->running = 0;
3542 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3546 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3555 odr_reset (c->odr_in);
3556 odr_setbuf (c->odr_in, c->buf_in, r, 0);
3557 event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);
3558 ZOOM_connection_put_event (c, event);
3560 if (!z_GDU (c->odr_in, &gdu, 0, 0))
3563 int err = odr_geterrorx(c->odr_in, &x);
3565 const char *element = odr_getelement(c->odr_in);
3566 sprintf (msg, "ODR code %d:%d element=%-20s",
3567 err, x, element ? element : "<unknown>");
3568 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3571 else if (gdu->which == Z_GDU_Z3950)
3572 recv_apdu (c, gdu->u.z3950);
3573 else if (gdu->which == Z_GDU_HTTP_Response)
3576 handle_http (c, gdu->u.HTTP_Response);
3578 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3582 c->reconnect_ok = 0;
3587 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out)
3592 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3593 ZOOM_connection_put_event (c, event);
3595 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3596 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3598 yaz_log(log_details, "%p do_write_ex write failed", c);
3599 if (c->reconnect_ok)
3602 c->reconnect_ok = 0;
3603 yaz_log(log_details, "%p do_write_ex reconnect write", c);
3604 c->tasks->running = 0;
3605 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3606 return zoom_pending;
3608 if (c->state == STATE_CONNECTING)
3609 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3611 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3613 return zoom_complete;
3617 c->mask = ZOOM_SELECT_EXCEPT;
3618 if (c->cs->io_pending & CS_WANT_WRITE)
3619 c->mask += ZOOM_SELECT_WRITE;
3620 if (c->cs->io_pending & CS_WANT_READ)
3621 c->mask += ZOOM_SELECT_READ;
3622 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3627 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3628 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3631 return zoom_pending;
3634 static zoom_ret do_write(ZOOM_connection c)
3636 return do_write_ex (c, c->buf_out, c->len_out);
3640 ZOOM_API(const char *)
3641 ZOOM_connection_option_get (ZOOM_connection c, const char *key)
3643 return ZOOM_options_get (c->options, key);
3646 ZOOM_API(const char *)
3647 ZOOM_connection_option_getl (ZOOM_connection c, const char *key, int *lenp)
3649 return ZOOM_options_getl (c->options, key, lenp);
3653 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
3656 ZOOM_options_set (c->options, key, val);
3660 ZOOM_connection_option_setl (ZOOM_connection c, const char *key,
3661 const char *val, int len)
3663 ZOOM_options_setl (c->options, key, val, len);
3666 ZOOM_API(const char *)
3667 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key)
3669 return ZOOM_options_get (r->options, key);
3673 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key,
3676 ZOOM_options_set (r->options, key, val);
3681 ZOOM_connection_errcode (ZOOM_connection c)
3683 return ZOOM_connection_error (c, 0, 0);
3686 ZOOM_API(const char *)
3687 ZOOM_connection_errmsg (ZOOM_connection c)
3690 ZOOM_connection_error (c, &msg, 0);
3694 ZOOM_API(const char *)
3695 ZOOM_connection_addinfo (ZOOM_connection c)
3697 const char *addinfo;
3698 ZOOM_connection_error (c, 0, &addinfo);
3702 ZOOM_API(const char *)
3703 ZOOM_connection_diagset (ZOOM_connection c)
3705 const char *diagset;
3706 ZOOM_connection_error_x (c, 0, 0, &diagset);
3710 ZOOM_API(const char *)
3711 ZOOM_diag_str (int error)
3715 case ZOOM_ERROR_NONE:
3717 case ZOOM_ERROR_CONNECT:
3718 return "Connect failed";
3719 case ZOOM_ERROR_MEMORY:
3720 return "Out of memory";
3721 case ZOOM_ERROR_ENCODE:
3722 return "Encoding failed";
3723 case ZOOM_ERROR_DECODE:
3724 return "Decoding failed";
3725 case ZOOM_ERROR_CONNECTION_LOST:
3726 return "Connection lost";
3727 case ZOOM_ERROR_INIT:
3728 return "Init rejected";
3729 case ZOOM_ERROR_INTERNAL:
3730 return "Internal failure";
3731 case ZOOM_ERROR_TIMEOUT:
3733 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3734 return "Unsupported protocol";
3735 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3736 return "Unsupported query type";
3737 case ZOOM_ERROR_INVALID_QUERY:
3738 return "Invalid query";
3739 case ZOOM_ERROR_CQL_PARSE:
3740 return "CQL parsing error";
3741 case ZOOM_ERROR_CQL_TRANSFORM:
3742 return "CQL transformation error";
3744 return diagbib1_str (error);
3749 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
3750 const char **addinfo, const char **diagset)
3752 int error = c->error;
3755 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3756 *cp = ZOOM_diag_str(error);
3757 else if (!strcmp(c->diagset, "HTTP"))
3758 *cp = z_HTTP_errmsg(c->error);
3759 else if (!strcmp(c->diagset, "Bib-1"))
3760 *cp = ZOOM_diag_str(error);
3761 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3762 *cp = yaz_diag_srw_str(c->error);
3764 *cp = "Unknown error and diagnostic set";
3767 *addinfo = c->addinfo ? c->addinfo : "";
3769 *diagset = c->diagset ? c->diagset : "";
3774 ZOOM_connection_error (ZOOM_connection c, const char **cp,
3775 const char **addinfo)
3777 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3780 static int ZOOM_connection_do_io(ZOOM_connection c, int mask)
3782 ZOOM_Event event = 0;
3783 int r = cs_look(c->cs);
3784 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
3789 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3790 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3792 ZOOM_connection_put_event (c, event);
3794 else if (r == CS_CONNECT)
3797 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3799 ret = cs_rcvconnect (c->cs);
3800 yaz_log(log_details, "%p ZOOM_connection_do_io "
3801 "cs_rcvconnect returned %d", c, ret);
3804 c->mask = ZOOM_SELECT_EXCEPT;
3805 if (c->cs->io_pending & CS_WANT_WRITE)
3806 c->mask += ZOOM_SELECT_WRITE;
3807 if (c->cs->io_pending & CS_WANT_READ)
3808 c->mask += ZOOM_SELECT_READ;
3809 ZOOM_connection_put_event (c, event);
3813 ZOOM_connection_put_event (c, event);
3815 if (c->proto == PROTO_Z3950)
3816 ZOOM_connection_send_init(c);
3819 /* no init request for SRW .. */
3820 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3821 ZOOM_connection_remove_task (c);
3823 ZOOM_connection_exec_task (c);
3825 c->state = STATE_ESTABLISHED;
3829 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3831 ZOOM_connection_put_event (c, event);
3836 if (mask & ZOOM_SELECT_READ)
3838 if (c->cs && (mask & ZOOM_SELECT_WRITE))
3845 ZOOM_connection_last_event(ZOOM_connection cs)
3848 return ZOOM_EVENT_NONE;
3849 return cs->last_event;
3853 ZOOM_event (int no, ZOOM_connection *cs)
3855 int timeout = 30; /* default timeout in seconds */
3856 int timeout_set = 0; /* whether it was overriden at all */
3858 struct pollfd pollfds[1024];
3859 ZOOM_connection poll_cs[1024];
3862 fd_set input, output, except;
3867 for (i = 0; i<no; i++)
3869 ZOOM_connection c = cs[i];
3871 if (c && (event = ZOOM_connection_get_event(c)))
3873 ZOOM_Event_destroy (event);
3877 for (i = 0; i<no; i++)
3879 ZOOM_connection c = cs[i];
3881 if (c && ZOOM_connection_exec_task (c))
3883 if ((event = ZOOM_connection_get_event(c)))
3885 ZOOM_Event_destroy (event);
3898 for (i = 0; i<no; i++)
3900 ZOOM_connection c = cs[i];
3906 fd = z3950_connection_socket(c);
3907 mask = z3950_connection_mask(c);
3914 /* -1 is used for indefinite timeout (no timeout), so -2 here. */
3915 this_timeout = ZOOM_options_get_int (c->options, "timeout", -2);
3916 if (this_timeout != -2)
3918 /* ensure the minimum timeout is used */
3920 timeout = this_timeout;
3921 else if (this_timeout != -1 && this_timeout < timeout)
3922 timeout = this_timeout;
3928 short poll_events = 0;
3930 if (mask & ZOOM_SELECT_READ)
3931 poll_events += POLLIN;
3932 if (mask & ZOOM_SELECT_WRITE)
3933 poll_events += POLLOUT;
3934 if (mask & ZOOM_SELECT_EXCEPT)
3935 poll_events += POLLERR;
3936 pollfds[nfds].fd = fd;
3937 pollfds[nfds].events = poll_events;
3938 pollfds[nfds].revents = 0;
3943 if (mask & ZOOM_SELECT_READ)
3945 FD_SET (fd, &input);
3948 if (mask & ZOOM_SELECT_WRITE)
3950 FD_SET (fd, &output);
3953 if (mask & ZOOM_SELECT_EXCEPT)
3955 FD_SET (fd, &except);
3964 r = poll (pollfds, nfds, (timeout == -1 ? -1 : timeout * 1000));
3965 for (i = 0; i<nfds; i++)
3967 ZOOM_connection c = poll_cs[i];
3971 if (pollfds[i].revents & POLLIN)
3972 mask += ZOOM_SELECT_READ;
3973 if (pollfds[i].revents & POLLOUT)
3974 mask += ZOOM_SELECT_WRITE;
3975 if (pollfds[i].revents & POLLERR)
3976 mask += ZOOM_SELECT_EXCEPT;
3978 ZOOM_connection_do_io(c, mask);
3980 else if (r == 0 && c->mask)
3982 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3983 /* timeout and this connection was waiting */
3984 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3986 ZOOM_connection_put_event(c, event);
3990 tv.tv_sec = timeout;
3992 r = select (max_fd+1, &input, &output, &except, (timeout == -1 ? 0 : &tv));
3993 for (i = 0; i<no; i++)
3995 ZOOM_connection c = cs[i];
4000 fd = z3950_connection_socket(c);
4004 /* no timeout and real socket */
4005 if (FD_ISSET(fd, &input))
4006 mask += ZOOM_SELECT_READ;
4007 if (FD_ISSET(fd, &output))
4008 mask += ZOOM_SELECT_WRITE;
4009 if (FD_ISSET(fd, &except))
4010 mask += ZOOM_SELECT_EXCEPT;
4012 ZOOM_connection_do_io(c, mask);
4014 if (r == 0 && c->mask)
4016 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4017 /* timeout and this connection was waiting */
4018 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4020 ZOOM_connection_put_event(c, event);
4024 for (i = 0; i<no; i++)
4026 ZOOM_connection c = cs[i];
4028 if (c && (event = ZOOM_connection_get_event(c)))
4030 ZOOM_Event_destroy (event);
4039 * Returns an xmalloc()d string containing RPN that corresponds to the
4040 * CQL passed in. On error, sets the Connection object's error state
4041 * and returns a null pointer.
4042 * ### We could cache CQL parser and/or transformer in Connection.
4044 static char *cql2pqf(ZOOM_connection c, const char *cql)
4048 struct cql_node *node;
4049 const char *cqlfile;
4050 static cql_transform_t trans;
4053 parser = cql_parser_create();
4054 if ((error = cql_parser_string(parser, cql)) != 0) {
4055 cql_parser_destroy(parser);
4056 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4060 node = cql_parser_result(parser);
4061 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4063 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4065 cql_parser_destroy(parser);
4066 cql_node_destroy(node);
4067 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4071 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4073 cql_parser_destroy(parser);
4074 cql_node_destroy(node);
4075 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4076 cqlfile, strerror(errno));
4077 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4081 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4082 cql_parser_destroy(parser);
4083 cql_node_destroy(node);
4086 const char *addinfo;
4087 error = cql_transform_error(trans, &addinfo);
4088 cql_transform_close(trans);
4089 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4090 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4094 cql_transform_close(trans);
4095 return xstrdup(pqfbuf);
4102 * indent-tabs-mode: nil
4104 * vim: shiftwidth=4 tabstop=8 expandtab