2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.75 2006-06-13 16:21:42 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>
31 #include <sys/types.h>
40 #include <sys/select.h>
46 static int log_api = 0;
47 static int log_details = 0;
54 static zoom_ret ZOOM_connection_send_init (ZOOM_connection c);
55 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out);
56 static char *cql2pqf(ZOOM_connection c, const char *cql);
57 static char *ccl2pqf(ZOOM_connection c, const char *ccl);
61 static int log_level_initialized = 0;
62 if (!log_level_initialized)
64 log_api = yaz_log_module_level("zoom");
65 log_details = yaz_log_module_level("zoomdetails");
66 log_level_initialized = 1;
70 static ZOOM_Event ZOOM_Event_create (int kind)
72 ZOOM_Event event = (ZOOM_Event) xmalloc (sizeof(*event));
79 static void ZOOM_Event_destroy (ZOOM_Event event)
84 static void ZOOM_connection_put_event (ZOOM_connection c, ZOOM_Event event)
88 c->m_queue_back->prev = event;
89 assert (c->m_queue_front);
93 assert (!c->m_queue_front);
94 c->m_queue_front = event;
96 event->next = c->m_queue_back;
98 c->m_queue_back = event;
101 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
103 ZOOM_Event event = c->m_queue_front;
106 c->last_event = ZOOM_EVENT_NONE;
109 assert (c->m_queue_back);
110 c->m_queue_front = event->prev;
111 if (c->m_queue_front)
113 assert (c->m_queue_back);
114 c->m_queue_front->next = 0;
118 c->last_event = event->kind;
123 static void set_dset_error (ZOOM_connection c, int error,
125 const char *addinfo, const char *addinfo2)
132 if (!c->diagset || strcmp(dset, c->diagset))
135 c->diagset = xstrdup(dset);
136 /* remove integer part from SRW diagset .. */
137 if ((cp = strrchr(c->diagset, '/')))
140 if (addinfo && addinfo2)
142 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
143 strcpy(c->addinfo, addinfo);
144 strcat(c->addinfo, addinfo2);
147 c->addinfo = xstrdup(addinfo);
149 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
150 c, c->host_port ? c->host_port : "<>", dset, error,
151 addinfo ? addinfo : "",
152 addinfo2 ? addinfo2 : "");
156 static void set_HTTP_error (ZOOM_connection c, int error,
157 const char *addinfo, const char *addinfo2)
159 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
163 static void set_ZOOM_error (ZOOM_connection c, int error,
166 set_dset_error(c, error, "ZOOM", addinfo, 0);
169 static void clear_error (ZOOM_connection c)
172 * If an error is tied to an operation then it's ok to clear: for
173 * example, a diagnostic returned from a search is cleared by a
174 * subsequent search. However, problems such as Connection Lost
175 * or Init Refused are not cleared, because they are not
176 * recoverable: doing another search doesn't help.
180 case ZOOM_ERROR_CONNECT:
181 case ZOOM_ERROR_MEMORY:
182 case ZOOM_ERROR_DECODE:
183 case ZOOM_ERROR_CONNECTION_LOST:
184 case ZOOM_ERROR_INIT:
185 case ZOOM_ERROR_INTERNAL:
186 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
189 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
193 ZOOM_task ZOOM_connection_add_task (ZOOM_connection c, int which)
195 ZOOM_task *taskp = &c->tasks;
197 taskp = &(*taskp)->next;
198 *taskp = (ZOOM_task) xmalloc (sizeof(**taskp));
199 (*taskp)->running = 0;
200 (*taskp)->which = which;
206 ZOOM_task ZOOM_connection_insert_task (ZOOM_connection c, int which)
208 ZOOM_task task = (ZOOM_task) xmalloc (sizeof(*task));
210 task->next = c->tasks;
219 void ZOOM_connection_remove_task (ZOOM_connection c)
221 ZOOM_task task = c->tasks;
225 c->tasks = task->next;
228 case ZOOM_TASK_SEARCH:
229 ZOOM_resultset_destroy (task->u.search.resultset);
231 case ZOOM_TASK_RETRIEVE:
232 ZOOM_resultset_destroy (task->u.retrieve.resultset);
234 case ZOOM_TASK_CONNECT:
237 ZOOM_scanset_destroy (task->u.scan.scan);
239 case ZOOM_TASK_PACKAGE:
240 ZOOM_package_destroy (task->u.package);
243 ZOOM_resultset_destroy (task->u.sort.resultset);
244 ZOOM_query_destroy(task->u.sort.q);
253 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
254 ZOOM_connection_put_event(c, event);
259 static int ZOOM_connection_exec_task (ZOOM_connection c);
261 void ZOOM_connection_remove_tasks (ZOOM_connection c)
264 ZOOM_connection_remove_task(c);
267 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos);
269 ZOOM_API(ZOOM_connection)
270 ZOOM_connection_create (ZOOM_options options)
272 ZOOM_connection c = (ZOOM_connection) xmalloc (sizeof(*c));
276 yaz_log(log_api, "%p ZOOM_connection_create", c);
278 c->proto = PROTO_Z3950;
282 c->state = STATE_IDLE;
285 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
292 c->options = ZOOM_options_create_with_parent(options);
298 c->charset = c->lang = 0;
305 c->odr_in = odr_createmem (ODR_DECODE);
306 c->odr_out = odr_createmem (ODR_ENCODE);
309 c->support_named_resultsets = 0;
310 c->last_event = ZOOM_EVENT_NONE;
312 c->m_queue_front = 0;
317 /* set database names. Take local databases (if set); otherwise
318 take databases given in ZURL (if set); otherwise use Default */
319 static char **set_DatabaseNames (ZOOM_connection con, ZOOM_options options,
322 char **databaseNames;
323 const char *cp = ZOOM_options_get (options, "databaseName");
325 if ((!cp || !*cp) && con->host_port)
327 if (strncmp (con->host_port, "unix:", 5) == 0)
328 cp = strchr(con->host_port+5, ':');
330 cp = strchr(con->host_port, '/');
336 nmem_strsplit(con->odr_out->mem, "+", cp, &databaseNames, num);
337 return databaseNames;
340 ZOOM_API(ZOOM_connection)
341 ZOOM_connection_new (const char *host, int portnum)
343 ZOOM_connection c = ZOOM_connection_create (0);
345 ZOOM_connection_connect (c, host, portnum);
349 static zoom_sru_mode get_sru_mode_from_string(const char *s)
352 return zoom_sru_soap;
353 if (!yaz_matchstr(s, "soap"))
354 return zoom_sru_soap;
355 else if (!yaz_matchstr(s, "get"))
357 else if (!yaz_matchstr(s, "post"))
358 return zoom_sru_post;
359 return zoom_sru_error;
363 ZOOM_connection_connect(ZOOM_connection c,
364 const char *host, int portnum)
371 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
376 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
380 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
382 val = ZOOM_options_get (c->options, "proxy");
385 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
386 c->proxy = xstrdup (val);
392 val = ZOOM_options_get (c->options, "charset");
395 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
396 c->charset = xstrdup (val);
402 val = ZOOM_options_get (c->options, "lang");
405 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
406 c->lang = xstrdup (val);
411 val = ZOOM_options_get (c->options, "sru");
412 c->sru_mode = get_sru_mode_from_string(val);
414 xfree (c->host_port);
418 sprintf (hostn, "%.80s:%d", host, portnum);
419 c->host_port = xstrdup(hostn);
422 c->host_port = xstrdup(host);
426 * If the "<scheme>:" part of the host string is preceded by one
427 * or more comma-separated <name>=<value> pairs, these are taken
428 * to be options to be set on the connection object. Among other
429 * applications, this facility can be used to embed authentication
431 * user=admin,password=secret,tcp:localhost:9999
433 char *remainder = c->host_port;
434 char *pcolon = strchr(remainder, ':');
437 while ((pcomma = strchr(remainder, ',')) != 0 &&
438 (pcolon == 0 || pcomma < pcolon)) {
440 if ((pequals = strchr(remainder, '=')) != 0) {
442 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
443 ZOOM_connection_option_set(c, remainder, pequals+1);
445 remainder = pcomma+1;
448 if (remainder != c->host_port) {
450 c->host_port = xstrdup(remainder);
451 /*printf("# reset hp='%s'\n", remainder);*/
455 ZOOM_options_set(c->options, "host", c->host_port);
457 val = ZOOM_options_get (c->options, "cookie");
460 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
461 c->cookie_out = xstrdup (val);
464 val = ZOOM_options_get (c->options, "clientIP");
467 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
469 c->client_IP = xstrdup (val);
472 c->async = ZOOM_options_get_bool (c->options, "async", 0);
473 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
475 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
477 task = ZOOM_connection_add_task (c, ZOOM_TASK_CONNECT);
481 while (ZOOM_event (1, &c))
487 ZOOM_query_create(void)
489 ZOOM_query s = (ZOOM_query) xmalloc (sizeof(*s));
491 yaz_log(log_details, "%p ZOOM_query_create", s);
495 s->odr = odr_createmem (ODR_ENCODE);
502 ZOOM_query_destroy(ZOOM_query s)
508 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
509 if (s->refcount == 0)
511 odr_destroy (s->odr);
517 ZOOM_query_prefix(ZOOM_query s, const char *str)
519 s->query_string = odr_strdup(s->odr, str);
520 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
521 s->z_query->which = Z_Query_type_1;
522 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
523 if (!s->z_query->u.type_1)
525 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
529 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
534 ZOOM_query_cql(ZOOM_query s, const char *str)
538 s->query_string = odr_strdup(s->odr, str);
540 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
541 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
542 ext->indirect_reference = 0;
544 ext->which = Z_External_CQL;
545 ext->u.cql = s->query_string;
547 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
548 s->z_query->which = Z_Query_type_104;
549 s->z_query->u.type_104 = ext;
551 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
557 * Translate the CQL string client-side into RPN which is passed to
558 * the server. This is useful for server's that don't themselves
559 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
560 * only as a place to stash diagnostics if compilation fails; if this
561 * information is not needed, a null pointer may be used.
564 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
569 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
571 conn = ZOOM_connection_create(0);
573 if ((rpn = cql2pqf(conn, str)) == 0)
576 ret = ZOOM_query_prefix(s, rpn);
582 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
583 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
584 * to the server, as the YAZ GFS doesn't know how to handle this.
587 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
592 yaz_log(log_details, "%p ZOOM_query_ccl2rpn str=%s conn=%p", s, str, conn);
594 conn = ZOOM_connection_create(0);
596 if ((rpn = ccl2pqf(conn, str)) == 0)
599 ret = ZOOM_query_prefix(s, rpn);
605 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
607 s->sort_spec = yaz_sort_spec (s->odr, criteria);
610 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
614 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
618 static zoom_ret do_write(ZOOM_connection c);
621 ZOOM_connection_destroy(ZOOM_connection c)
626 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
629 for (r = c->resultsets; r; r = r->next)
635 odr_destroy (c->odr_in);
636 odr_destroy (c->odr_out);
637 ZOOM_options_destroy (c->options);
638 ZOOM_connection_remove_tasks (c);
639 xfree (c->host_port);
644 xfree (c->cookie_out);
645 xfree (c->cookie_in);
646 xfree (c->client_IP);
650 void ZOOM_resultset_addref (ZOOM_resultset r)
655 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
660 ZOOM_resultset ZOOM_resultset_create ()
663 ZOOM_resultset r = (ZOOM_resultset) xmalloc (sizeof(*r));
667 yaz_log(log_details, "%p ZOOM_resultset_create", r);
670 r->odr = odr_createmem (ODR_ENCODE);
677 for (i = 0; i<RECORD_HASH_SIZE; i++)
678 r->record_hash[i] = 0;
686 ZOOM_API(ZOOM_resultset)
687 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
690 ZOOM_query s = ZOOM_query_create();
692 ZOOM_query_prefix (s, q);
694 r = ZOOM_connection_search (c, s);
695 ZOOM_query_destroy (s);
699 ZOOM_API(ZOOM_resultset)
700 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
702 ZOOM_resultset r = ZOOM_resultset_create ();
706 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
707 r->r_sort_spec = q->sort_spec;
710 r->options = ZOOM_options_create_with_parent(c->options);
712 r->start = ZOOM_options_get_int(r->options, "start", 0);
713 r->count = ZOOM_options_get_int(r->options, "count", 0);
715 /* If "presentChunk" is defined use that; otherwise "step" */
716 const char *cp = ZOOM_options_get (r->options, "presentChunk");
717 r->step = ZOOM_options_get_int(r->options,
718 (cp != 0 ? "presentChunk": "step"), 0);
720 r->piggyback = ZOOM_options_get_bool (r->options, "piggyback", 1);
721 cp = ZOOM_options_get (r->options, "setname");
723 r->setname = xstrdup(cp);
724 cp = ZOOM_options_get (r->options, "schema");
726 r->schema = xstrdup(cp);
730 r->next = c->resultsets;
733 if (c->host_port && c->proto == PROTO_HTTP)
737 yaz_log(log_details, "ZOOM_connection_search: no comstack");
738 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
742 yaz_log(log_details, "ZOOM_connection_search: reconnect");
747 task = ZOOM_connection_add_task (c, ZOOM_TASK_SEARCH);
748 task->u.search.resultset = r;
749 ZOOM_resultset_addref (r);
755 while (ZOOM_event (1, &c))
762 * This is the old result-set sorting API, which is maintained only
763 * for the sake of binary compatibility. There is no reason ever to
764 * use this rather than ZOOM_resultset_sort1().
767 ZOOM_resultset_sort(ZOOM_resultset r,
768 const char *sort_type, const char *sort_spec)
770 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
774 ZOOM_resultset_sort1(ZOOM_resultset r,
775 const char *sort_type, const char *sort_spec)
777 ZOOM_connection c = r->connection;
781 newq = ZOOM_query_create();
782 if (ZOOM_query_sortby(newq, sort_spec) < 0)
785 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
786 r, r, sort_type, sort_spec);
790 if (c->host_port && c->proto == PROTO_HTTP)
794 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
795 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
799 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
805 ZOOM_resultset_cache_reset(r);
806 task = ZOOM_connection_add_task (c, ZOOM_TASK_SORT);
807 task->u.sort.resultset = r;
808 task->u.sort.q = newq;
810 ZOOM_resultset_addref (r);
814 while (ZOOM_event (1, &c))
822 ZOOM_resultset_cache_reset(ZOOM_resultset r)
825 for (i = 0; i<RECORD_HASH_SIZE; i++)
827 ZOOM_record_cache rc;
828 for (rc = r->record_hash[i]; rc; rc = rc->next)
830 if (rc->rec.wrbuf_marc)
831 wrbuf_free (rc->rec.wrbuf_marc, 1);
832 if (rc->rec.wrbuf_iconv)
833 wrbuf_free (rc->rec.wrbuf_iconv, 1);
834 if (rc->rec.wrbuf_opac)
835 wrbuf_free (rc->rec.wrbuf_opac, 1);
837 r->record_hash[i] = 0;
842 ZOOM_resultset_destroy(ZOOM_resultset r)
847 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
849 if (r->refcount == 0)
851 ZOOM_resultset_cache_reset(r);
855 /* remove ourselves from the resultsets in connection */
856 ZOOM_resultset *rp = &r->connection->resultsets;
859 assert (*rp); /* we must be in this list!! */
861 { /* OK, we're here - take us out of it */
868 ZOOM_query_destroy (r->query);
869 ZOOM_options_destroy (r->options);
870 odr_destroy (r->odr);
878 ZOOM_resultset_size (ZOOM_resultset r)
883 static void do_close (ZOOM_connection c)
889 c->state = STATE_IDLE;
892 static void ZOOM_resultset_retrieve (ZOOM_resultset r,
893 int force_sync, int start, int count)
901 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
902 " count=%d", r, force_sync, start, count);
907 if (c->host_port && c->proto == PROTO_HTTP)
911 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
912 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
916 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
921 task = ZOOM_connection_add_task (c, ZOOM_TASK_RETRIEVE);
922 task->u.retrieve.resultset = r;
923 task->u.retrieve.start = start;
924 task->u.retrieve.count = count;
926 cp = ZOOM_options_get (r->options, "schema");
929 if (!r->schema || strcmp(r->schema, cp))
932 r->schema = xstrdup(cp);
936 ZOOM_resultset_addref (r);
938 if (!r->connection->async || force_sync)
939 while (r->connection && ZOOM_event (1, &r->connection))
944 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
945 size_t start, size_t count)
947 int force_present = 0;
951 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
952 r, r, (long) start, (long) count);
955 ZOOM_resultset_retrieve (r, force_present, start, count);
959 for (i = 0; i< count; i++)
960 recs[i] = ZOOM_resultset_record_immediate (r, i+start);
964 static void get_cert(ZOOM_connection c)
969 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
971 ZOOM_connection_option_setl(c, "sslPeerCert",
977 static zoom_ret do_connect (ZOOM_connection c)
980 const char *effective_host;
983 effective_host = c->proxy;
985 effective_host = c->host_port;
987 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
991 c->cs = cs_create_host (effective_host, 0, &add);
993 if (c->cs && c->cs->protocol == PROTO_HTTP)
996 const char *path = 0;
998 c->proto = PROTO_HTTP;
999 cs_get_host_args(c->host_port, &path);
1001 c->path = (char*) xmalloc(strlen(path)+2);
1003 strcpy (c->path+1, path);
1005 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1007 return zoom_complete;
1012 int ret = cs_connect (c->cs, add);
1015 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1016 ZOOM_connection_put_event(c, event);
1018 if (c->proto == PROTO_Z3950)
1019 ZOOM_connection_send_init(c);
1022 /* no init request for SRW .. */
1023 assert (c->tasks->which == ZOOM_TASK_CONNECT);
1024 ZOOM_connection_remove_task (c);
1026 ZOOM_connection_exec_task (c);
1028 c->state = STATE_ESTABLISHED;
1029 return zoom_pending;
1033 c->state = STATE_CONNECTING;
1034 c->mask = ZOOM_SELECT_EXCEPT;
1035 if (c->cs->io_pending & CS_WANT_WRITE)
1036 c->mask += ZOOM_SELECT_WRITE;
1037 if (c->cs->io_pending & CS_WANT_READ)
1038 c->mask += ZOOM_SELECT_READ;
1039 return zoom_pending;
1042 c->state = STATE_IDLE;
1043 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1044 return zoom_complete;
1047 int z3950_connection_socket(ZOOM_connection c)
1050 return cs_fileno(c->cs);
1054 int z3950_connection_mask(ZOOM_connection c)
1061 static void otherInfo_attach (ZOOM_connection c, Z_APDU *a, ODR out)
1064 for (i = 0; i<200; i++)
1067 Z_OtherInformation **oi;
1073 sprintf (buf, "otherInfo%d", i);
1074 val = ZOOM_options_get (c->options, buf);
1077 cp = strchr(val, ':');
1081 if (len >= sizeof(buf))
1082 len = sizeof(buf)-1;
1083 memcpy (buf, val, len);
1085 oidval = oid_getvalbyname (buf);
1086 if (oidval == VAL_NONE)
1089 yaz_oi_APDU(a, &oi);
1090 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1094 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1099 Z_OtherInformation **oi;
1100 yaz_oi_APDU(a, &oi);
1101 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1105 Z_OtherInformation **oi;
1106 yaz_oi_APDU(a, &oi);
1107 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1109 otherInfo_attach (c, a, out);
1110 if (!z_APDU(out, &a, 0, 0))
1112 FILE *outf = fopen("/tmp/apdu.txt", "a");
1115 ODR odr_pr = odr_createmem(ODR_PRINT);
1116 fprintf (outf, "a=%p\n", a);
1117 odr_setprint(odr_pr, outf);
1118 z_APDU(odr_pr, &a, 0, 0);
1119 odr_destroy(odr_pr);
1121 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1122 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1126 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1130 static zoom_ret send_APDU (ZOOM_connection c, Z_APDU *a)
1134 if (encode_APDU(c, a, c->odr_out))
1135 return zoom_complete;
1136 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1137 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1138 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1139 ZOOM_connection_put_event (c, event);
1140 odr_reset(c->odr_out);
1141 return do_write (c);
1144 /* returns 1 if PDU was sent OK (still pending )
1145 0 if PDU was not sent OK (nothing to wait for)
1148 static zoom_ret ZOOM_connection_send_init (ZOOM_connection c)
1150 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1151 Z_InitRequest *ireq = apdu->u.initRequest;
1152 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1153 odr_malloc(c->odr_out, sizeof(*auth));
1154 const char *auth_groupId = ZOOM_options_get (c->options, "group");
1155 const char *auth_userId = ZOOM_options_get (c->options, "user");
1156 const char *auth_password = ZOOM_options_get (c->options, "password");
1159 /* support the pass for backwards compatibility */
1161 auth_password = ZOOM_options_get (c->options, "pass");
1163 ODR_MASK_SET(ireq->options, Z_Options_search);
1164 ODR_MASK_SET(ireq->options, Z_Options_present);
1165 ODR_MASK_SET(ireq->options, Z_Options_scan);
1166 ODR_MASK_SET(ireq->options, Z_Options_sort);
1167 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1168 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1170 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1171 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1172 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1174 /* Index Data's Z39.50 Implementor Id is 81 */
1175 ireq->implementationId = odr_prepend(c->odr_out,
1176 ZOOM_options_get(c->options, "implementationId"),
1177 odr_prepend(c->odr_out, "81", ireq->implementationId));
1179 ireq->implementationName = odr_prepend(c->odr_out,
1180 ZOOM_options_get(c->options, "implementationName"),
1181 odr_prepend(c->odr_out, "ZOOM-C", ireq->implementationName));
1183 version = odr_strdup(c->odr_out, "$Revision: 1.75 $");
1184 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1185 version[strlen(version)-2] = '\0';
1186 ireq->implementationVersion = odr_prepend(c->odr_out,
1187 ZOOM_options_get(c->options, "implementationVersion"),
1188 odr_prepend(c->odr_out, &version[11], ireq->implementationVersion));
1190 *ireq->maximumRecordSize =
1191 ZOOM_options_get_int (c->options, "maximumRecordSize", 1024*1024);
1192 *ireq->preferredMessageSize =
1193 ZOOM_options_get_int (c->options, "preferredMessageSize", 1024*1024);
1195 if (auth_groupId || auth_password)
1197 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1200 if (auth_groupId && *auth_groupId)
1202 pass->groupId = (char *)
1203 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1204 strcpy(pass->groupId, auth_groupId);
1208 if (auth_userId && *auth_userId)
1210 pass->userId = (char *)
1211 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1212 strcpy(pass->userId, auth_userId);
1216 if (auth_password && *auth_password)
1218 pass->password = (char *)
1219 odr_malloc(c->odr_out, strlen(auth_password)+1);
1220 strcpy(pass->password, auth_password);
1225 auth->which = Z_IdAuthentication_idPass;
1226 auth->u.idPass = pass;
1227 ireq->idAuthentication = auth;
1230 else if (auth_userId)
1232 auth->which = Z_IdAuthentication_open;
1233 auth->u.open = (char *)
1234 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1235 strcpy(auth->u.open, auth_userId);
1236 ireq->idAuthentication = auth;
1239 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1240 VAL_PROXY, 1, c->host_port);
1241 if (c->charset || c->lang)
1243 Z_OtherInformation **oi;
1244 Z_OtherInformationUnit *oi_unit;
1246 yaz_oi_APDU(apdu, &oi);
1248 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1250 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1251 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1252 oi_unit->information.externallyDefinedInfo =
1253 yaz_set_proposal_charneg_list(c->odr_out, " ",
1254 c->charset, c->lang, 1);
1258 return send_APDU (c, apdu);
1262 static zoom_ret send_srw (ZOOM_connection c, Z_SRW_PDU *sr)
1267 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1269 if (c->sru_mode == zoom_sru_get)
1271 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1273 else if (c->sru_mode == zoom_sru_post)
1275 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1277 else if (c->sru_mode == zoom_sru_soap)
1279 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1281 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1282 return zoom_complete;
1283 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1285 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1286 ZOOM_connection_put_event (c, event);
1287 odr_reset(c->odr_out);
1288 return do_write (c);
1293 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1296 ZOOM_resultset resultset = 0;
1298 const char *recordPacking = 0;
1300 if (c->error) /* don't continue on error */
1301 return zoom_complete;
1303 if (c->tasks->which == ZOOM_TASK_SEARCH)
1305 resultset = c->tasks->u.search.resultset;
1306 resultset->setname = xstrdup ("default");
1307 ZOOM_options_set (resultset->options, "setname", resultset->setname);
1309 else if(c->tasks->which == ZOOM_TASK_RETRIEVE)
1311 resultset = c->tasks->u.retrieve.resultset;
1313 resultset->start = c->tasks->u.retrieve.start;
1314 resultset->count = c->tasks->u.retrieve.count;
1316 if (resultset->start >= resultset->size)
1317 return zoom_complete;
1318 if (resultset->start + resultset->count > resultset->size)
1319 resultset->count = resultset->size - resultset->start;
1321 for (i = 0; i<resultset->count; i++)
1324 record_cache_lookup (resultset, i + resultset->start);
1328 if (i == resultset->count)
1329 return zoom_complete;
1331 assert(resultset->query);
1333 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1335 if (resultset->query->z_query->which == Z_Query_type_104
1336 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1339 sr->u.request->query_type = Z_SRW_query_type_cql;
1340 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1342 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1343 resultset->query->z_query->u.type_1)
1345 sr->u.request->query_type = Z_SRW_query_type_pqf;
1346 sr->u.request->query.pqf = resultset->query->query_string;
1350 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1351 return zoom_complete;
1353 sr->u.request->startRecord = odr_intdup (c->odr_out, resultset->start + 1);
1354 sr->u.request->maximumRecords = odr_intdup (
1355 c->odr_out, resultset->step>0 ? resultset->step : resultset->count);
1356 sr->u.request->recordSchema = resultset->schema;
1358 recordPacking = ZOOM_resultset_option_get (resultset, "recordPacking");
1361 sr->u.request->recordPacking = odr_strdup(c->odr_out, recordPacking);
1363 return send_srw(c, sr);
1366 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1368 return zoom_complete;
1372 static zoom_ret ZOOM_connection_send_search (ZOOM_connection c)
1375 int lslb, ssub, mspn;
1377 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1378 Z_SearchRequest *search_req = apdu->u.searchRequest;
1379 const char *elementSetName;
1380 const char *smallSetElementSetName;
1381 const char *mediumSetElementSetName;
1384 assert (c->tasks->which == ZOOM_TASK_SEARCH);
1386 r = c->tasks->u.search.resultset;
1388 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1391 ZOOM_options_get (r->options, "elementSetName");
1392 smallSetElementSetName =
1393 ZOOM_options_get (r->options, "smallSetElementSetName");
1394 mediumSetElementSetName =
1395 ZOOM_options_get (r->options, "mediumSetElementSetName");
1397 if (!smallSetElementSetName)
1398 smallSetElementSetName = elementSetName;
1400 if (!mediumSetElementSetName)
1401 mediumSetElementSetName = elementSetName;
1406 /* prepare query for the search request */
1407 search_req->query = r->query->z_query;
1408 if (!search_req->query)
1410 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1411 return zoom_complete;
1414 search_req->databaseNames =
1415 set_DatabaseNames (c, r->options, &search_req->num_databaseNames);
1417 /* get syntax (no need to provide unless piggyback is in effect) */
1418 syntax = ZOOM_options_get (r->options, "preferredRecordSyntax");
1420 lslb = ZOOM_options_get_int (r->options, "largeSetLowerBound", -1);
1421 ssub = ZOOM_options_get_int (r->options, "smallSetUpperBound", -1);
1422 mspn = ZOOM_options_get_int (r->options, "mediumSetPresentNumber", -1);
1423 if (lslb != -1 && ssub != -1 && mspn != -1)
1425 /* So're a Z39.50 expert? Let's hope you don't do sort */
1426 *search_req->largeSetLowerBound = lslb;
1427 *search_req->smallSetUpperBound = ssub;
1428 *search_req->mediumSetPresentNumber = mspn;
1430 else if (r->start == 0 && r->count > 0
1431 && r->piggyback && !r->r_sort_spec && !r->schema)
1433 /* Regular piggyback - do it unless we're going to do sort */
1434 *search_req->largeSetLowerBound = 2000000000;
1435 *search_req->smallSetUpperBound = 1;
1436 *search_req->mediumSetPresentNumber = r->step>0 ? r->step : r->count;
1440 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1441 smallSetElementSetName = 0;
1442 mediumSetElementSetName = 0;
1445 if (smallSetElementSetName && *smallSetElementSetName)
1447 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1448 odr_malloc (c->odr_out, sizeof(*esn));
1450 esn->which = Z_ElementSetNames_generic;
1451 esn->u.generic = odr_strdup (c->odr_out, smallSetElementSetName);
1452 search_req->smallSetElementSetNames = esn;
1454 if (mediumSetElementSetName && *mediumSetElementSetName)
1456 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1457 odr_malloc (c->odr_out, sizeof(*esn));
1459 esn->which = Z_ElementSetNames_generic;
1460 esn->u.generic = odr_strdup (c->odr_out, mediumSetElementSetName);
1461 search_req->mediumSetElementSetNames = esn;
1464 search_req->preferredRecordSyntax =
1465 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1469 if (c->support_named_resultsets)
1473 /* find the lowest unused ordinal so that we re-use
1474 result sets on the server. */
1475 for (ord = 1; ; ord++)
1478 sprintf (setname, "%d", ord);
1479 for (rp = c->resultsets; rp; rp = rp->next)
1480 if (rp->setname && !strcmp (rp->setname, setname))
1485 r->setname = xstrdup (setname);
1486 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1487 "set %s", c, r->setname);
1491 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1493 r->setname = xstrdup ("default");
1495 ZOOM_options_set (r->options, "setname", r->setname);
1497 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1498 return send_APDU (c, apdu);
1501 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1508 case Z_DefaultDiagFormat_v2Addinfo:
1509 addinfo = r->u.v2Addinfo;
1511 case Z_DefaultDiagFormat_v3Addinfo:
1512 addinfo = r->u.v3Addinfo;
1517 set_dset_error(c, *r->condition,
1518 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1522 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1524 if (p->which != Z_DiagRec_defaultFormat)
1525 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1527 response_default_diag(c, p->u.defaultFormat);
1530 ZOOM_API(ZOOM_record)
1531 ZOOM_record_clone (ZOOM_record srec)
1538 odr_enc = odr_createmem(ODR_ENCODE);
1539 if (!z_NamePlusRecord (odr_enc, &srec->npr, 0, 0))
1541 buf = odr_getbuf (odr_enc, &size, 0);
1543 nrec = (ZOOM_record) xmalloc (sizeof(*nrec));
1544 nrec->odr = odr_createmem(ODR_DECODE);
1545 nrec->wrbuf_marc = 0;
1546 nrec->wrbuf_iconv = 0;
1547 nrec->wrbuf_opac = 0;
1548 odr_setbuf (nrec->odr, buf, size, 0);
1549 z_NamePlusRecord (nrec->odr, &nrec->npr, 0, 0);
1551 odr_destroy (odr_enc);
1555 ZOOM_API(ZOOM_record)
1556 ZOOM_resultset_record_immediate (ZOOM_resultset s,size_t pos)
1558 return record_cache_lookup (s, pos);
1561 ZOOM_API(ZOOM_record)
1562 ZOOM_resultset_record (ZOOM_resultset r, size_t pos)
1564 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1569 * MIKE: I think force_sync should always be zero, but I don't
1570 * want to make this change until I get the go-ahead from
1571 * Adam, in case something depends on the old synchronous
1575 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1576 ZOOM_resultset_retrieve (r, force_sync, pos, 1);
1577 rec = ZOOM_resultset_record_immediate (r, pos);
1583 ZOOM_record_destroy (ZOOM_record rec)
1587 if (rec->wrbuf_marc)
1588 wrbuf_free (rec->wrbuf_marc, 1);
1589 if (rec->wrbuf_iconv)
1590 wrbuf_free (rec->wrbuf_iconv, 1);
1591 if (rec->wrbuf_opac)
1592 wrbuf_free (rec->wrbuf_opac, 1);
1593 odr_destroy (rec->odr);
1597 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1599 const char *buf, int sz,
1600 const char *record_charset)
1605 yaz_marc_t mt = yaz_marc_create();
1608 strcpy(to, "UTF-8");
1609 if (record_charset && *record_charset)
1611 /* Use "from,to" or just "from" */
1612 const char *cp = strchr(record_charset, ',');
1613 int clen = strlen(record_charset);
1616 strncpy( to, cp+1, sizeof(to)-1);
1617 to[sizeof(to)-1] = '\0';
1618 clen = cp - record_charset;
1620 if (clen > sizeof(from)-1)
1621 clen = sizeof(from)-1;
1624 strncpy(from, record_charset, clen);
1630 cd = yaz_iconv_open(to, from);
1631 yaz_marc_iconv(mt, cd);
1634 yaz_marc_xml(mt, marc_type);
1635 if (!rec->wrbuf_marc)
1636 rec->wrbuf_marc = wrbuf_alloc();
1637 wrbuf_rewind (rec->wrbuf_marc);
1638 if (yaz_marc_decode_wrbuf (mt, buf, sz, rec->wrbuf_marc) > 0)
1640 yaz_marc_destroy(mt);
1642 yaz_iconv_close(cd);
1644 *len = wrbuf_len(rec->wrbuf_marc);
1645 return wrbuf_buf(rec->wrbuf_marc);
1647 yaz_marc_destroy(mt);
1649 yaz_iconv_close(cd);
1653 static const char *record_iconv_return(ZOOM_record rec, int *len,
1654 const char *buf, int sz,
1655 const char *record_charset)
1662 strcpy(to, "UTF-8");
1663 if (record_charset && *record_charset)
1665 /* Use "from,to" or just "from" */
1666 const char *cp = strchr(record_charset, ',');
1667 int clen = strlen(record_charset);
1670 strncpy( to, cp+1, sizeof(to)-1);
1671 to[sizeof(to)-1] = '\0';
1672 clen = cp - record_charset;
1674 if (clen > sizeof(from)-1)
1675 clen = sizeof(from)-1;
1678 strncpy(from, record_charset, clen);
1682 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1685 size_t inbytesleft = sz;
1686 const char *inp = buf;
1688 if (!rec->wrbuf_iconv)
1689 rec->wrbuf_iconv = wrbuf_alloc();
1691 wrbuf_rewind(rec->wrbuf_iconv);
1695 size_t outbytesleft = sizeof(outbuf);
1696 char *outp = outbuf;
1697 size_t r = yaz_iconv (cd, (char**) &inp,
1699 &outp, &outbytesleft);
1700 if (r == (size_t) (-1))
1702 int e = yaz_iconv_error(cd);
1703 if (e != YAZ_ICONV_E2BIG)
1706 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1708 wrbuf_puts(rec->wrbuf_iconv, "");
1709 buf = wrbuf_buf(rec->wrbuf_iconv);
1710 sz = wrbuf_len(rec->wrbuf_iconv);
1711 yaz_iconv_close(cd);
1718 ZOOM_API(const char *)
1719 ZOOM_record_get (ZOOM_record rec, const char *type_spec, int *len)
1726 Z_NamePlusRecord *npr;
1729 *len = 0; /* default return */
1738 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1740 if (cp[i] == ';' || cp[i] == ' ')
1746 while (type_spec[i] == ';')
1749 while (type_spec[i] == ' ')
1751 if (!strncmp(type_spec+i, "charset=", 8))
1754 i = i + 8; /* skip charset= */
1755 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1757 if (type_spec[i] == ';' || type_spec[i] == ' ')
1763 else if (!strncmp(type_spec+i, "xpath=", 6))
1767 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1771 while (type_spec[i] == ' ')
1774 if (!strcmp (type, "database"))
1777 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1778 return npr->databaseName;
1780 else if (!strcmp (type, "syntax"))
1782 const char *desc = 0;
1783 if (npr->which == Z_NamePlusRecord_databaseRecord)
1785 Z_External *r = (Z_External *) npr->u.databaseRecord;
1786 oident *ent = oid_getentbyoid(r->direct_reference);
1793 *len = strlen(desc);
1796 if (npr->which != Z_NamePlusRecord_databaseRecord)
1799 /* from now on - we have a database record .. */
1800 if (!strcmp (type, "render"))
1802 Z_External *r = (Z_External *) npr->u.databaseRecord;
1803 oident *ent = oid_getentbyoid(r->direct_reference);
1805 /* render bibliographic record .. */
1806 if (r->which == Z_External_OPAC)
1808 r = r->u.opac->bibliographicRecord;
1811 ent = oid_getentbyoid(r->direct_reference);
1813 if (r->which == Z_External_sutrs)
1814 return record_iconv_return(rec, len,
1815 (char*) r->u.sutrs->buf,
1818 else if (r->which == Z_External_octet)
1820 const char *ret_buf;
1828 case VAL_APPLICATION_XML:
1831 ret_buf = marc_iconv_return(
1832 rec, YAZ_MARC_LINE, len,
1833 (const char *) r->u.octet_aligned->buf,
1834 r->u.octet_aligned->len,
1839 return record_iconv_return(rec, len,
1840 (const char *) r->u.octet_aligned->buf,
1841 r->u.octet_aligned->len,
1844 else if (r->which == Z_External_grs1)
1846 if (!rec->wrbuf_marc)
1847 rec->wrbuf_marc = wrbuf_alloc();
1848 wrbuf_rewind (rec->wrbuf_marc);
1849 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1850 return record_iconv_return(rec, len,
1851 wrbuf_buf(rec->wrbuf_marc),
1852 wrbuf_len(rec->wrbuf_marc),
1857 else if (!strcmp (type, "xml"))
1859 Z_External *r = (Z_External *) npr->u.databaseRecord;
1860 oident *ent = oid_getentbyoid(r->direct_reference);
1862 /* render bibliographic record .. */
1863 if (r->which == Z_External_OPAC)
1865 r = r->u.opac->bibliographicRecord;
1868 ent = oid_getentbyoid(r->direct_reference);
1871 if (r->which == Z_External_sutrs)
1872 return record_iconv_return(rec, len,
1873 (const char *) r->u.sutrs->buf,
1876 else if (r->which == Z_External_octet)
1878 const char *ret_buf;
1879 int marc_decode_type = YAZ_MARC_MARCXML;
1888 case VAL_APPLICATION_XML:
1891 ret_buf = marc_iconv_return(
1892 rec, marc_decode_type, len,
1893 (const char *) r->u.octet_aligned->buf,
1894 r->u.octet_aligned->len,
1899 return record_iconv_return(rec, len,
1900 (const char *) r->u.octet_aligned->buf,
1901 r->u.octet_aligned->len,
1904 else if (r->which == Z_External_grs1)
1911 else if (!strcmp (type, "raw"))
1913 Z_External *r = (Z_External *) npr->u.databaseRecord;
1915 if (r->which == Z_External_sutrs)
1917 if (len) *len = r->u.sutrs->len;
1918 return (const char *) r->u.sutrs->buf;
1920 else if (r->which == Z_External_octet)
1922 if (len) *len = r->u.octet_aligned->len;
1923 return (const char *) r->u.octet_aligned->buf;
1925 else /* grs-1, explain, OPAC, ... */
1928 return (const char *) npr->u.databaseRecord;
1932 else if (!strcmp (type, "ext"))
1935 return (const char *) npr->u.databaseRecord;
1937 else if (!strcmp (type, "opac"))
1940 Z_External *r = (Z_External *) npr->u.databaseRecord;
1941 if (r->which == Z_External_OPAC)
1943 if (!rec->wrbuf_opac)
1944 rec->wrbuf_opac = wrbuf_alloc();
1945 wrbuf_rewind (rec->wrbuf_opac);
1946 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
1947 return record_iconv_return(rec, len,
1948 wrbuf_buf(rec->wrbuf_opac),
1949 wrbuf_len(rec->wrbuf_opac),
1956 static int strcmp_null(const char *v1, const char *v2)
1962 return strcmp(v1, v2);
1965 static size_t record_hash(int pos)
1969 return pos % RECORD_HASH_SIZE;
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_hash[record_hash(pos)]; 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_hash[record_hash(pos)];
2023 r->record_hash[record_hash(pos)] = 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_hash[record_hash(pos)]; 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.
2472 * ### should add support for CCL here
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 c->buf_out = c->tasks->u.package->buf_out;
2536 c->len_out = c->tasks->u.package->len_out;
2541 static zoom_ret send_scan (ZOOM_connection c)
2544 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2545 Z_ScanRequest *req = apdu->u.scanRequest;
2547 yaz_log(log_details, "%p send_scan", c);
2549 return zoom_complete;
2550 assert (c->tasks->which == ZOOM_TASK_SCAN);
2551 scan = c->tasks->u.scan.scan;
2553 req->termListAndStartPoint = scan->termListAndStartPoint;
2554 req->attributeSet = scan->attributeSet;
2556 *req->numberOfTermsRequested =
2557 ZOOM_options_get_int(scan->options, "number", 10);
2559 req->preferredPositionInResponse =
2560 odr_intdup (c->odr_out,
2561 ZOOM_options_get_int(scan->options, "position", 1));
2564 odr_intdup (c->odr_out,
2565 ZOOM_options_get_int(scan->options, "stepSize", 0));
2567 req->databaseNames = set_DatabaseNames (c, scan->options,
2568 &req->num_databaseNames);
2570 return send_APDU (c, apdu);
2574 ZOOM_scanset_size (ZOOM_scanset scan)
2576 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2578 return scan->scan_response->entries->num_entries;
2581 ZOOM_API(const char *)
2582 ZOOM_scanset_term (ZOOM_scanset scan, size_t pos,
2585 const char *term = 0;
2586 size_t noent = ZOOM_scanset_size (scan);
2587 Z_ScanResponse *res = scan->scan_response;
2593 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2595 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2597 if (t->term->which == Z_Term_general)
2599 term = (const char *) t->term->u.general->buf;
2600 *len = t->term->u.general->len;
2602 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2607 ZOOM_API(const char *)
2608 ZOOM_scanset_display_term (ZOOM_scanset scan, size_t pos,
2611 const char *term = 0;
2612 size_t noent = ZOOM_scanset_size (scan);
2613 Z_ScanResponse *res = scan->scan_response;
2619 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2621 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2625 term = t->displayTerm;
2626 *len = strlen(term);
2628 else if (t->term->which == Z_Term_general)
2630 term = (const char *) t->term->u.general->buf;
2631 *len = t->term->u.general->len;
2633 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2638 ZOOM_API(const char *)
2639 ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key)
2641 return ZOOM_options_get (scan->options, key);
2645 ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
2648 ZOOM_options_set (scan->options, key, val);
2651 static Z_APDU *create_es_package (ZOOM_package p, int type)
2654 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2655 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2657 *req->function = Z_ExtendedServicesRequest_create;
2659 str = ZOOM_options_get(p->options, "package-name");
2661 req->packageName = nmem_strdup (p->odr_out->mem, str);
2663 str = ZOOM_options_get(p->options, "user-id");
2665 req->userId = nmem_strdup (p->odr_out->mem, str);
2667 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2670 str = ZOOM_options_get(p->options, "function");
2673 if (!strcmp (str, "create"))
2675 if (!strcmp (str, "delete"))
2677 if (!strcmp (str, "modify"))
2683 static const char *ill_array_lookup (void *clientData, const char *idx)
2685 ZOOM_package p = (ZOOM_package) clientData;
2686 return ZOOM_options_get (p->options, idx+4);
2689 static Z_External *encode_ill_request (ZOOM_package p)
2691 ODR out = p->odr_out;
2694 struct ill_get_ctl ctl;
2696 ctl.odr = p->odr_out;
2698 ctl.f = ill_array_lookup;
2700 req = ill_get_ILLRequest(&ctl, "ill", 0);
2702 if (!ill_Request (out, &req, 0, 0))
2704 int ill_request_size;
2705 char *ill_request_buf = odr_getbuf (out, &ill_request_size, 0);
2706 if (ill_request_buf)
2707 odr_setbuf (out, ill_request_buf, ill_request_size, 1);
2713 int illRequest_size = 0;
2714 char *illRequest_buf = odr_getbuf (out, &illRequest_size, 0);
2716 oid.proto = PROTO_GENERAL;
2717 oid.oclass = CLASS_GENERAL;
2718 oid.value = VAL_ISO_ILL_1;
2720 r = (Z_External *) odr_malloc (out, sizeof(*r));
2721 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2722 r->indirect_reference = 0;
2724 r->which = Z_External_single;
2726 r->u.single_ASN1_type =
2727 odr_create_Odr_oct(out,
2728 (unsigned char *)illRequest_buf,
2734 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2736 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc (p->odr_out, sizeof(*req));
2739 req->which = Z_IOItemOrder_esRequest;
2740 req->u.esRequest = (Z_IORequest *)
2741 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2743 /* to keep part ... */
2744 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2745 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2746 req->u.esRequest->toKeep->supplDescription = 0;
2747 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2748 odr_malloc (p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2750 str = ZOOM_options_get(p->options, "contact-name");
2751 req->u.esRequest->toKeep->contact->name = str ?
2752 nmem_strdup (p->odr_out->mem, str) : 0;
2754 str = ZOOM_options_get(p->options, "contact-phone");
2755 req->u.esRequest->toKeep->contact->phone = str ?
2756 nmem_strdup (p->odr_out->mem, str) : 0;
2758 str = ZOOM_options_get(p->options, "contact-email");
2759 req->u.esRequest->toKeep->contact->email = str ?
2760 nmem_strdup (p->odr_out->mem, str) : 0;
2762 req->u.esRequest->toKeep->addlBilling = 0;
2764 /* not to keep part ... */
2765 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2766 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2768 str = ZOOM_options_get(p->options, "itemorder-setname");
2773 req->u.esRequest->notToKeep->resultSetItem = 0;
2776 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2777 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2779 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2780 nmem_strdup (p->odr_out->mem, str);
2781 req->u.esRequest->notToKeep->resultSetItem->item =
2782 (int *) odr_malloc(p->odr_out, sizeof(int));
2784 str = ZOOM_options_get(p->options, "itemorder-item");
2785 *req->u.esRequest->notToKeep->resultSetItem->item =
2786 (str ? atoi(str) : 1);
2788 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2793 Z_APDU *create_admin_package(ZOOM_package p, int type,
2794 Z_ESAdminOriginPartToKeep **toKeepP,
2795 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2797 Z_APDU *apdu = create_es_package (p, VAL_ADMINSERVICE);
2800 Z_ESAdminOriginPartToKeep *toKeep;
2801 Z_ESAdminOriginPartNotToKeep *notToKeep;
2802 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2803 const char *first_db = "Default";
2805 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2809 r->direct_reference =
2810 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2813 r->indirect_reference = 0;
2814 r->which = Z_External_ESAdmin;
2816 r->u.adminService = (Z_Admin *)
2817 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2818 r->u.adminService->which = Z_Admin_esRequest;
2819 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2820 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2822 toKeep = r->u.adminService->u.esRequest->toKeep =
2823 (Z_ESAdminOriginPartToKeep *)
2824 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2825 toKeep->which = type;
2826 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2827 toKeep->u.create = odr_nullval();
2828 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2830 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2831 (Z_ESAdminOriginPartNotToKeep *)
2832 odr_malloc(p->odr_out,
2833 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2834 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
2835 notToKeep->u.recordsWillFollow = odr_nullval();
2839 *notToKeepP = notToKeep;
2844 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
2846 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
2847 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2848 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
2849 const char *doc = ZOOM_options_get(p->options, "doc");
2854 req->taskSpecificParameters = ext;
2855 ext->direct_reference = req->packageType;
2856 ext->descriptor = 0;
2857 ext->indirect_reference = 0;
2859 ext->which = Z_External_octet;
2860 ext->u.single_ASN1_type =
2861 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
2866 static Z_APDU *create_update_package(ZOOM_package p)
2869 const char *first_db = "Default";
2871 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2872 const char *action = ZOOM_options_get(p->options, "action");
2873 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
2874 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
2875 const char *record_buf = ZOOM_options_get(p->options, "record");
2876 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
2877 int syntax_oid = VAL_NONE;
2881 syntax_oid = oid_getvalbyname(syntax_str);
2884 record_buf = "void";
2885 syntax_oid = VAL_SUTRS;
2887 if (syntax_oid == VAL_NONE)
2888 syntax_oid = VAL_TEXT_XML;
2894 action = "specialUpdate";
2896 if (!strcmp(action, "recordInsert"))
2897 action_no = Z_IUOriginPartToKeep_recordInsert;
2898 else if (!strcmp(action, "recordReplace"))
2899 action_no = Z_IUOriginPartToKeep_recordReplace;
2900 else if (!strcmp(action, "recordDelete"))
2901 action_no = Z_IUOriginPartToKeep_recordDelete;
2902 else if (!strcmp(action, "elementUpdate"))
2903 action_no = Z_IUOriginPartToKeep_elementUpdate;
2904 else if (!strcmp(action, "specialUpdate"))
2905 action_no = Z_IUOriginPartToKeep_specialUpdate;
2909 apdu = create_es_package (p, VAL_DBUPDATE);
2912 Z_IUOriginPartToKeep *toKeep;
2913 Z_IUSuppliedRecords *notToKeep;
2914 Z_External *r = (Z_External *)
2915 odr_malloc (p->odr_out, sizeof(*r));
2917 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2919 r->direct_reference =
2920 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2923 r->which = Z_External_update;
2924 r->indirect_reference = 0;
2925 r->u.update = (Z_IUUpdate *)
2926 odr_malloc(p->odr_out, sizeof(*r->u.update));
2928 r->u.update->which = Z_IUUpdate_esRequest;
2929 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
2930 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
2931 toKeep = r->u.update->u.esRequest->toKeep =
2932 (Z_IUOriginPartToKeep *)
2933 odr_malloc(p->odr_out, sizeof(*toKeep));
2935 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2937 toKeep->elementSetName = 0;
2938 toKeep->actionQualifier = 0;
2939 toKeep->action = odr_intdup(p->odr_out, action_no);
2941 notToKeep = r->u.update->u.esRequest->notToKeep =
2942 (Z_IUSuppliedRecords *)
2943 odr_malloc(p->odr_out, sizeof(*notToKeep));
2945 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
2946 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
2947 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
2948 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
2949 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
2952 notToKeep->elements[0]->u.opaque =
2953 odr_create_Odr_oct(p->odr_out,
2954 (const unsigned char *) recordIdOpaque,
2955 strlen(recordIdOpaque));
2957 else if (recordIdNumber)
2959 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
2961 notToKeep->elements[0]->u.number =
2962 odr_intdup(p->odr_out, atoi(recordIdNumber));
2965 notToKeep->elements[0]->u.opaque = 0;
2966 notToKeep->elements[0]->supplementalId = 0;
2967 notToKeep->elements[0]->correlationInfo = 0;
2968 notToKeep->elements[0]->record =
2969 z_ext_record(p->odr_out, syntax_oid,
2970 record_buf, strlen(record_buf));
2974 ODR print = odr_createmem(ODR_PRINT);
2976 z_APDU(print, &apdu, 0, 0);
2983 ZOOM_package_send (ZOOM_package p, const char *type)
2990 odr_reset (p->odr_out);
2993 if (!strcmp(type, "itemorder"))
2995 apdu = create_es_package (p, VAL_ITEMORDER);
2998 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
3000 r->direct_reference =
3001 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3004 r->which = Z_External_itemOrder;
3005 r->indirect_reference = 0;
3006 r->u.itemOrder = encode_item_order (p);
3008 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3011 else if (!strcmp(type, "create")) /* create database */
3013 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3016 else if (!strcmp(type, "drop")) /* drop database */
3018 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3021 else if (!strcmp(type, "commit")) /* commit changes */
3023 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3026 else if (!strcmp(type, "update")) /* update record(s) */
3028 apdu = create_update_package(p);
3030 else if (!strcmp(type, "xmlupdate"))
3032 apdu = create_xmlupdate_package(p);
3036 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3040 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_PACKAGE);
3041 task->u.package = p;
3042 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3043 p->buf_out = (char *) xmalloc (p->len_out);
3044 memcpy (p->buf_out, buf, p->len_out);
3049 while (ZOOM_event (1, &c))
3056 ZOOM_API(ZOOM_package)
3057 ZOOM_connection_package (ZOOM_connection c, ZOOM_options options)
3059 ZOOM_package p = (ZOOM_package) xmalloc (sizeof(*p));
3062 p->odr_out = odr_createmem (ODR_ENCODE);
3063 p->options = ZOOM_options_create_with_parent2 (options, c->options);
3071 ZOOM_package_destroy(ZOOM_package p)
3076 if (p->refcount == 0)
3078 odr_destroy (p->odr_out);
3081 ZOOM_options_destroy (p->options);
3086 ZOOM_API(const char *)
3087 ZOOM_package_option_get (ZOOM_package p, const char *key)
3089 return ZOOM_options_get (p->options, key);
3094 ZOOM_package_option_set (ZOOM_package p, const char *key,
3097 ZOOM_options_set (p->options, key, val);
3100 static int ZOOM_connection_exec_task (ZOOM_connection c)
3102 ZOOM_task task = c->tasks;
3103 zoom_ret ret = zoom_complete;
3107 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3108 c, task->which, task->running);
3109 if (c->error != ZOOM_ERROR_NONE)
3111 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3112 "removing tasks because of error = %d", c, c->error);
3113 ZOOM_connection_remove_tasks (c);
3118 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3119 "task already running", c);
3123 ret = zoom_complete;
3124 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3126 switch (task->which)
3128 case ZOOM_TASK_SEARCH:
3129 if (c->proto == PROTO_HTTP)
3130 ret = ZOOM_connection_srw_send_search(c);
3132 ret = ZOOM_connection_send_search(c);
3134 case ZOOM_TASK_RETRIEVE:
3135 if (c->proto == PROTO_HTTP)
3136 ret = ZOOM_connection_srw_send_search(c);
3138 ret = send_present (c);
3140 case ZOOM_TASK_CONNECT:
3141 ret = do_connect(c);
3143 case ZOOM_TASK_SCAN:
3146 case ZOOM_TASK_PACKAGE:
3147 ret = send_package(c);
3149 case ZOOM_TASK_SORT:
3150 c->tasks->u.sort.resultset->r_sort_spec =
3151 c->tasks->u.sort.q->sort_spec;
3152 ret = send_sort(c, c->tasks->u.sort.resultset);
3158 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3159 "remove tasks because no connection exist", c);
3160 ZOOM_connection_remove_tasks (c);
3162 if (ret == zoom_complete)
3164 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3165 "task removed (complete)", c);
3166 ZOOM_connection_remove_task (c);
3169 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3174 static zoom_ret send_sort_present (ZOOM_connection c)
3176 zoom_ret r = zoom_complete;
3178 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3179 r = send_sort (c, c->tasks->u.search.resultset);
3180 if (r == zoom_complete)
3181 r = send_present (c);
3185 static int es_response (ZOOM_connection c,
3186 Z_ExtendedServicesResponse *res)
3188 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3190 if (res->diagnostics && res->num_diagnostics > 0)
3191 response_diag(c, res->diagnostics[0]);
3192 if (res->taskPackage &&
3193 res->taskPackage->which == Z_External_extendedService)
3195 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3196 Odr_oct *id = taskPackage->targetReference;
3199 ZOOM_options_setl (c->tasks->u.package->options,
3200 "targetReference", (char*) id->buf, id->len);
3202 if (res->taskPackage &&
3203 res->taskPackage->which == Z_External_octet)
3205 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3206 ZOOM_options_setl (c->tasks->u.package->options,
3207 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3212 static void interpret_init_diag(ZOOM_connection c,
3213 Z_DiagnosticFormat *diag)
3217 Z_DiagnosticFormat_s *ds = diag->elements[0];
3218 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3219 response_default_diag(c, ds->u.defaultDiagRec);
3224 static void interpret_otherinformation_field(ZOOM_connection c,
3225 Z_OtherInformation *ui)
3228 for (i = 0; i < ui->num_elements; i++)
3230 Z_OtherInformationUnit *unit = ui->list[i];
3231 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3232 unit->information.externallyDefinedInfo &&
3233 unit->information.externallyDefinedInfo->which ==
3236 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3241 static void recv_apdu (ZOOM_connection c, Z_APDU *apdu)
3243 Z_InitResponse *initrs;
3246 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3249 case Z_APDU_initResponse:
3250 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3251 initrs = apdu->u.initResponse;
3252 ZOOM_connection_option_set(c, "serverImplementationId",
3253 initrs->implementationId ?
3254 initrs->implementationId : "");
3255 ZOOM_connection_option_set(c, "serverImplementationName",
3256 initrs->implementationName ?
3257 initrs->implementationName : "");
3258 ZOOM_connection_option_set(c, "serverImplementationVersion",
3259 initrs->implementationVersion ?
3260 initrs->implementationVersion : "");
3261 /* Set the three old options too, for old applications */
3262 ZOOM_connection_option_set(c, "targetImplementationId",
3263 initrs->implementationId ?
3264 initrs->implementationId : "");
3265 ZOOM_connection_option_set(c, "targetImplementationName",
3266 initrs->implementationName ?
3267 initrs->implementationName : "");
3268 ZOOM_connection_option_set(c, "targetImplementationVersion",
3269 initrs->implementationVersion ?
3270 initrs->implementationVersion : "");
3271 if (!*initrs->result)
3273 Z_External *uif = initrs->userInformationField;
3275 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3277 if (uif && uif->which == Z_External_userInfo1)
3278 interpret_otherinformation_field(c, uif->u.userInfo1);
3283 yaz_oi_get_string_oidval (&apdu->u.initResponse->otherInfo,
3285 xfree (c->cookie_in);
3288 c->cookie_in = xstrdup(cookie);
3289 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3290 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3291 c->support_named_resultsets = 1;
3294 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3295 ZOOM_connection_remove_task (c);
3297 ZOOM_connection_exec_task (c);
3299 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3301 NMEM tmpmem = nmem_create();
3302 Z_CharSetandLanguageNegotiation *p =
3303 yaz_get_charneg_record(initrs->otherInfo);
3307 char *charset = NULL, *lang = NULL;
3310 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3311 yaz_log(log_details, "%p recv_apdu target accepted: "
3312 "charset %s, language %s, select %d",
3314 charset ? charset : "none", lang ? lang : "none", sel);
3316 ZOOM_connection_option_set (c, "negotiation-charset",
3319 ZOOM_connection_option_set (c, "negotiation-lang",
3322 ZOOM_connection_option_set (
3323 c, "negotiation-charset-in-effect-for-records",
3324 (sel != 0) ? "1" : "0");
3325 nmem_destroy(tmpmem);
3329 case Z_APDU_searchResponse:
3330 yaz_log(log_api, "%p recv_apdu Search response", c);
3331 handle_search_response (c, apdu->u.searchResponse);
3332 if (send_sort_present (c) == zoom_complete)
3333 ZOOM_connection_remove_task (c);
3335 case Z_APDU_presentResponse:
3336 yaz_log(log_api, "%p recv_apdu Present response", c);
3337 handle_present_response (c, apdu->u.presentResponse);
3338 if (send_present (c) == zoom_complete)
3339 ZOOM_connection_remove_task (c);
3341 case Z_APDU_sortResponse:
3342 yaz_log(log_api, "%p recv_apdu Sort response", c);
3343 sort_response (c, apdu->u.sortResponse);
3344 if (send_present (c) == zoom_complete)
3345 ZOOM_connection_remove_task (c);
3347 case Z_APDU_scanResponse:
3348 yaz_log(log_api, "%p recv_apdu Scan response", c);
3349 scan_response (c, apdu->u.scanResponse);
3350 ZOOM_connection_remove_task (c);
3352 case Z_APDU_extendedServicesResponse:
3353 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3354 es_response (c, apdu->u.extendedServicesResponse);
3355 ZOOM_connection_remove_task (c);
3358 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3359 if (c->reconnect_ok)
3362 c->tasks->running = 0;
3363 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3367 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3372 yaz_log(log_api, "%p Received unknown PDU", c);
3373 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3379 static void handle_srw_response(ZOOM_connection c,
3380 Z_SRW_searchRetrieveResponse *res)
3382 ZOOM_resultset resultset = 0;
3390 if (c->tasks->which == ZOOM_TASK_SEARCH)
3391 resultset = c->tasks->u.search.resultset;
3392 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
3393 resultset = c->tasks->u.retrieve.resultset;
3397 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3398 ZOOM_connection_put_event(c, event);
3400 resultset->size = 0;
3402 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3404 if (res->numberOfRecords)
3405 resultset->size = *res->numberOfRecords;
3407 for (i = 0; i<res->num_records; i++)
3411 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3412 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3414 if (res->records[i].recordPosition &&
3415 *res->records[i].recordPosition > 0)
3416 pos = *res->records[i].recordPosition - 1;
3418 pos = resultset->start + i;
3420 npr->databaseName = 0;
3421 npr->which = Z_NamePlusRecord_databaseRecord;
3422 npr->u.databaseRecord = (Z_External *)
3423 odr_malloc(c->odr_in, sizeof(Z_External));
3424 npr->u.databaseRecord->descriptor = 0;
3425 npr->u.databaseRecord->direct_reference =
3426 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3427 npr->u.databaseRecord->which = Z_External_octet;
3429 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3430 odr_malloc(c->odr_in, sizeof(Odr_oct));
3431 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3432 res->records[i].recordData_buf;
3433 npr->u.databaseRecord->u.octet_aligned->len =
3434 npr->u.databaseRecord->u.octet_aligned->size =
3435 res->records[i].recordData_len;
3436 record_cache_add (resultset, npr, pos);
3438 if (res->num_diagnostics > 0)
3440 const char *uri = res->diagnostics[0].uri;
3445 if ((cp = strrchr(uri, '/')))
3447 set_dset_error(c, code, uri,
3448 res->diagnostics[0].details, 0);
3451 nmem = odr_extract_mem(c->odr_in);
3452 nmem_transfer(resultset->odr->mem, nmem);
3458 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3461 const char *content_type = z_HTTP_header_lookup(hres->headers,
3463 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3466 yaz_log(log_details, "%p handle_http", c);
3468 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3470 Z_SOAP *soap_package = 0;
3472 Z_SOAP_Handler soap_handlers[2] = {
3473 {"http://www.loc.gov/zing/srw/", 0,
3474 (Z_SOAP_fun) yaz_srw_codec},
3477 ret = z_soap_codec(o, &soap_package,
3478 &hres->content_buf, &hres->content_len,
3480 if (!ret && soap_package->which == Z_SOAP_generic &&
3481 soap_package->u.generic->no == 0)
3483 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3484 if (sr->which == Z_SRW_searchRetrieve_response)
3485 handle_srw_response(c, sr->u.response);
3489 else if (!ret && (soap_package->which == Z_SOAP_fault
3490 || soap_package->which == Z_SOAP_error))
3492 set_HTTP_error(c, hres->code,
3493 soap_package->u.fault->fault_code,
3494 soap_package->u.fault->fault_string);
3501 if (hres->code != 200)
3502 set_HTTP_error(c, hres->code, 0, 0);
3504 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3507 ZOOM_connection_remove_task(c);
3508 if (!strcmp(hres->version, "1.0"))
3510 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3511 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3516 /* HTTP 1.1: only if no close we stay alive .. */
3517 if (connection_head && !strcmp(connection_head, "close"))
3523 static int do_read (ZOOM_connection c)
3528 event = ZOOM_Event_create (ZOOM_EVENT_RECV_DATA);
3529 ZOOM_connection_put_event (c, event);
3531 r = cs_get (c->cs, &c->buf_in, &c->len_in);
3532 more = cs_more(c->cs);
3533 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3538 if (c->reconnect_ok)
3541 c->reconnect_ok = 0;
3542 yaz_log(log_details, "%p do_read reconnect read", c);
3543 c->tasks->running = 0;
3544 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3548 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3557 odr_reset (c->odr_in);
3558 odr_setbuf (c->odr_in, c->buf_in, r, 0);
3559 event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);
3560 ZOOM_connection_put_event (c, event);
3562 if (!z_GDU (c->odr_in, &gdu, 0, 0))
3565 int err = odr_geterrorx(c->odr_in, &x);
3567 const char *element = odr_getelement(c->odr_in);
3568 sprintf (msg, "ODR code %d:%d element=%-20s",
3569 err, x, element ? element : "<unknown>");
3570 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3573 else if (gdu->which == Z_GDU_Z3950)
3574 recv_apdu (c, gdu->u.z3950);
3575 else if (gdu->which == Z_GDU_HTTP_Response)
3578 handle_http (c, gdu->u.HTTP_Response);
3580 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3584 c->reconnect_ok = 0;
3589 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out)
3594 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3595 ZOOM_connection_put_event (c, event);
3597 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3598 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3600 yaz_log(log_details, "%p do_write_ex write failed", c);
3601 if (c->reconnect_ok)
3604 c->reconnect_ok = 0;
3605 yaz_log(log_details, "%p do_write_ex reconnect write", c);
3606 c->tasks->running = 0;
3607 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3608 return zoom_pending;
3610 if (c->state == STATE_CONNECTING)
3611 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3613 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3615 return zoom_complete;
3619 c->mask = ZOOM_SELECT_EXCEPT;
3620 if (c->cs->io_pending & CS_WANT_WRITE)
3621 c->mask += ZOOM_SELECT_WRITE;
3622 if (c->cs->io_pending & CS_WANT_READ)
3623 c->mask += ZOOM_SELECT_READ;
3624 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3629 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3630 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3633 return zoom_pending;
3636 static zoom_ret do_write(ZOOM_connection c)
3638 return do_write_ex (c, c->buf_out, c->len_out);
3642 ZOOM_API(const char *)
3643 ZOOM_connection_option_get (ZOOM_connection c, const char *key)
3645 return ZOOM_options_get (c->options, key);
3648 ZOOM_API(const char *)
3649 ZOOM_connection_option_getl (ZOOM_connection c, const char *key, int *lenp)
3651 return ZOOM_options_getl (c->options, key, lenp);
3655 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
3658 ZOOM_options_set (c->options, key, val);
3662 ZOOM_connection_option_setl (ZOOM_connection c, const char *key,
3663 const char *val, int len)
3665 ZOOM_options_setl (c->options, key, val, len);
3668 ZOOM_API(const char *)
3669 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key)
3671 return ZOOM_options_get (r->options, key);
3675 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key,
3678 ZOOM_options_set (r->options, key, val);
3683 ZOOM_connection_errcode (ZOOM_connection c)
3685 return ZOOM_connection_error (c, 0, 0);
3688 ZOOM_API(const char *)
3689 ZOOM_connection_errmsg (ZOOM_connection c)
3692 ZOOM_connection_error (c, &msg, 0);
3696 ZOOM_API(const char *)
3697 ZOOM_connection_addinfo (ZOOM_connection c)
3699 const char *addinfo;
3700 ZOOM_connection_error (c, 0, &addinfo);
3704 ZOOM_API(const char *)
3705 ZOOM_connection_diagset (ZOOM_connection c)
3707 const char *diagset;
3708 ZOOM_connection_error_x (c, 0, 0, &diagset);
3712 ZOOM_API(const char *)
3713 ZOOM_diag_str (int error)
3717 case ZOOM_ERROR_NONE:
3719 case ZOOM_ERROR_CONNECT:
3720 return "Connect failed";
3721 case ZOOM_ERROR_MEMORY:
3722 return "Out of memory";
3723 case ZOOM_ERROR_ENCODE:
3724 return "Encoding failed";
3725 case ZOOM_ERROR_DECODE:
3726 return "Decoding failed";
3727 case ZOOM_ERROR_CONNECTION_LOST:
3728 return "Connection lost";
3729 case ZOOM_ERROR_INIT:
3730 return "Init rejected";
3731 case ZOOM_ERROR_INTERNAL:
3732 return "Internal failure";
3733 case ZOOM_ERROR_TIMEOUT:
3735 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3736 return "Unsupported protocol";
3737 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3738 return "Unsupported query type";
3739 case ZOOM_ERROR_INVALID_QUERY:
3740 return "Invalid query";
3741 case ZOOM_ERROR_CQL_PARSE:
3742 return "CQL parsing error";
3743 case ZOOM_ERROR_CQL_TRANSFORM:
3744 return "CQL transformation error";
3745 case ZOOM_ERROR_CCL_CONFIG:
3746 return "CCL configuration error";
3747 case ZOOM_ERROR_CCL_PARSE:
3748 return "CCL parsing error";
3750 return diagbib1_str (error);
3755 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
3756 const char **addinfo, const char **diagset)
3758 int error = c->error;
3761 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3762 *cp = ZOOM_diag_str(error);
3763 else if (!strcmp(c->diagset, "HTTP"))
3764 *cp = z_HTTP_errmsg(c->error);
3765 else if (!strcmp(c->diagset, "Bib-1"))
3766 *cp = ZOOM_diag_str(error);
3767 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3768 *cp = yaz_diag_srw_str(c->error);
3770 *cp = "Unknown error and diagnostic set";
3773 *addinfo = c->addinfo ? c->addinfo : "";
3775 *diagset = c->diagset ? c->diagset : "";
3780 ZOOM_connection_error (ZOOM_connection c, const char **cp,
3781 const char **addinfo)
3783 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3786 static int ZOOM_connection_do_io(ZOOM_connection c, int mask)
3788 ZOOM_Event event = 0;
3789 int r = cs_look(c->cs);
3790 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
3795 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3796 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3798 ZOOM_connection_put_event (c, event);
3800 else if (r == CS_CONNECT)
3803 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3805 ret = cs_rcvconnect (c->cs);
3806 yaz_log(log_details, "%p ZOOM_connection_do_io "
3807 "cs_rcvconnect returned %d", c, ret);
3810 c->mask = ZOOM_SELECT_EXCEPT;
3811 if (c->cs->io_pending & CS_WANT_WRITE)
3812 c->mask += ZOOM_SELECT_WRITE;
3813 if (c->cs->io_pending & CS_WANT_READ)
3814 c->mask += ZOOM_SELECT_READ;
3815 ZOOM_connection_put_event (c, event);
3819 ZOOM_connection_put_event (c, event);
3821 if (c->proto == PROTO_Z3950)
3822 ZOOM_connection_send_init(c);
3825 /* no init request for SRW .. */
3826 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3827 ZOOM_connection_remove_task (c);
3829 ZOOM_connection_exec_task (c);
3831 c->state = STATE_ESTABLISHED;
3835 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3837 ZOOM_connection_put_event (c, event);
3842 if (mask & ZOOM_SELECT_READ)
3844 if (c->cs && (mask & ZOOM_SELECT_WRITE))
3851 ZOOM_connection_last_event(ZOOM_connection cs)
3854 return ZOOM_EVENT_NONE;
3855 return cs->last_event;
3859 ZOOM_event (int no, ZOOM_connection *cs)
3861 int timeout = 30; /* default timeout in seconds */
3862 int timeout_set = 0; /* whether it was overriden at all */
3864 struct pollfd pollfds[1024];
3865 ZOOM_connection poll_cs[1024];
3868 fd_set input, output, except;
3873 for (i = 0; i<no; i++)
3875 ZOOM_connection c = cs[i];
3877 if (c && (event = ZOOM_connection_get_event(c)))
3879 ZOOM_Event_destroy (event);
3883 for (i = 0; i<no; i++)
3885 ZOOM_connection c = cs[i];
3887 if (c && ZOOM_connection_exec_task (c))
3889 if ((event = ZOOM_connection_get_event(c)))
3891 ZOOM_Event_destroy (event);
3904 for (i = 0; i<no; i++)
3906 ZOOM_connection c = cs[i];
3912 fd = z3950_connection_socket(c);
3913 mask = z3950_connection_mask(c);
3920 /* -1 is used for indefinite timeout (no timeout), so -2 here. */
3921 this_timeout = ZOOM_options_get_int (c->options, "timeout", -2);
3922 if (this_timeout != -2)
3924 /* ensure the minimum timeout is used */
3926 timeout = this_timeout;
3927 else if (this_timeout != -1 && this_timeout < timeout)
3928 timeout = this_timeout;
3934 short poll_events = 0;
3936 if (mask & ZOOM_SELECT_READ)
3937 poll_events += POLLIN;
3938 if (mask & ZOOM_SELECT_WRITE)
3939 poll_events += POLLOUT;
3940 if (mask & ZOOM_SELECT_EXCEPT)
3941 poll_events += POLLERR;
3942 pollfds[nfds].fd = fd;
3943 pollfds[nfds].events = poll_events;
3944 pollfds[nfds].revents = 0;
3949 if (mask & ZOOM_SELECT_READ)
3951 FD_SET (fd, &input);
3954 if (mask & ZOOM_SELECT_WRITE)
3956 FD_SET (fd, &output);
3959 if (mask & ZOOM_SELECT_EXCEPT)
3961 FD_SET (fd, &except);
3970 r = poll (pollfds, nfds, (timeout == -1 ? -1 : timeout * 1000));
3971 for (i = 0; i<nfds; i++)
3973 ZOOM_connection c = poll_cs[i];
3977 if (pollfds[i].revents & POLLIN)
3978 mask += ZOOM_SELECT_READ;
3979 if (pollfds[i].revents & POLLOUT)
3980 mask += ZOOM_SELECT_WRITE;
3981 if (pollfds[i].revents & POLLERR)
3982 mask += ZOOM_SELECT_EXCEPT;
3984 ZOOM_connection_do_io(c, mask);
3986 else if (r == 0 && c->mask)
3988 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3989 /* timeout and this connection was waiting */
3990 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3992 ZOOM_connection_put_event(c, event);
3996 tv.tv_sec = timeout;
3998 r = select (max_fd+1, &input, &output, &except, (timeout == -1 ? 0 : &tv));
3999 for (i = 0; i<no; i++)
4001 ZOOM_connection c = cs[i];
4006 fd = z3950_connection_socket(c);
4010 /* no timeout and real socket */
4011 if (FD_ISSET(fd, &input))
4012 mask += ZOOM_SELECT_READ;
4013 if (FD_ISSET(fd, &output))
4014 mask += ZOOM_SELECT_WRITE;
4015 if (FD_ISSET(fd, &except))
4016 mask += ZOOM_SELECT_EXCEPT;
4018 ZOOM_connection_do_io(c, mask);
4020 if (r == 0 && c->mask)
4022 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4023 /* timeout and this connection was waiting */
4024 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4026 ZOOM_connection_put_event(c, event);
4030 for (i = 0; i<no; i++)
4032 ZOOM_connection c = cs[i];
4034 if (c && (event = ZOOM_connection_get_event(c)))
4036 ZOOM_Event_destroy (event);
4045 * Returns an xmalloc()d string containing RPN that corresponds to the
4046 * CQL passed in. On error, sets the Connection object's error state
4047 * and returns a null pointer.
4048 * ### We could cache CQL parser and/or transformer in Connection.
4050 static char *cql2pqf(ZOOM_connection c, const char *cql)
4054 struct cql_node *node;
4055 const char *cqlfile;
4056 static cql_transform_t trans;
4059 parser = cql_parser_create();
4060 if ((error = cql_parser_string(parser, cql)) != 0) {
4061 cql_parser_destroy(parser);
4062 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4066 node = cql_parser_result(parser);
4067 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4069 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4071 cql_parser_destroy(parser);
4072 cql_node_destroy(node);
4073 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4077 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4079 cql_parser_destroy(parser);
4080 cql_node_destroy(node);
4081 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4082 cqlfile, strerror(errno));
4083 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4087 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4088 cql_parser_destroy(parser);
4089 cql_node_destroy(node);
4092 const char *addinfo;
4093 error = cql_transform_error(trans, &addinfo);
4094 cql_transform_close(trans);
4095 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4096 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4100 cql_transform_close(trans);
4101 return xstrdup(pqfbuf);
4105 /* ### Could cache `bibset' */
4106 static char *ccl2pqf(ZOOM_connection c, const char *ccl)
4108 const char *cclfile;
4110 struct ccl_rpn_node *node;
4116 if ((cclfile = ZOOM_connection_option_get(c, "cclfile")) == 0) {
4117 set_ZOOM_error(c, ZOOM_ERROR_CCL_CONFIG, "no CCL qualifier file");
4121 bibset = ccl_qual_mk();
4122 if (ccl_qual_fname(bibset, cclfile) < 0) {
4124 ccl_qual_rm(&bibset);
4125 sprintf(buf, "can't open CCL qualifier file '%.200s': %.200s",
4126 cclfile, strerror(errno));
4127 set_ZOOM_error(c, ZOOM_ERROR_CCL_CONFIG, buf);
4131 node = ccl_find_str (bibset, ccl, &errorcode, &errorpos);
4132 ccl_qual_rm(&bibset);
4134 /* code is one of the CCL_ERR_* constants; pos is unused here */
4135 set_ZOOM_error(c, ZOOM_ERROR_CCL_PARSE, ccl_err_msg(errorcode));
4140 ccl_pquery(w, node);
4141 ccl_rpn_delete(node);
4142 pqf = xstrdup(wrbuf_buf(w));
4152 * indent-tabs-mode: nil
4154 * vim: shiftwidth=4 tabstop=8 expandtab