2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.73 2006-05-31 15:32:43 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 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_END);
252 ZOOM_connection_put_event(c, event);
257 static int ZOOM_connection_exec_task (ZOOM_connection c);
259 void ZOOM_connection_remove_tasks (ZOOM_connection c)
262 ZOOM_connection_remove_task(c);
265 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos);
267 ZOOM_API(ZOOM_connection)
268 ZOOM_connection_create (ZOOM_options options)
270 ZOOM_connection c = (ZOOM_connection) xmalloc (sizeof(*c));
274 yaz_log(log_api, "%p ZOOM_connection_create", c);
276 c->proto = PROTO_Z3950;
280 c->state = STATE_IDLE;
283 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
290 c->options = ZOOM_options_create_with_parent(options);
296 c->charset = c->lang = 0;
303 c->odr_in = odr_createmem (ODR_DECODE);
304 c->odr_out = odr_createmem (ODR_ENCODE);
307 c->support_named_resultsets = 0;
308 c->last_event = ZOOM_EVENT_NONE;
310 c->m_queue_front = 0;
315 /* set database names. Take local databases (if set); otherwise
316 take databases given in ZURL (if set); otherwise use Default */
317 static char **set_DatabaseNames (ZOOM_connection con, ZOOM_options options,
320 char **databaseNames;
321 const char *cp = ZOOM_options_get (options, "databaseName");
323 if ((!cp || !*cp) && con->host_port)
325 if (strncmp (con->host_port, "unix:", 5) == 0)
326 cp = strchr(con->host_port+5, ':');
328 cp = strchr(con->host_port, '/');
334 nmem_strsplit(con->odr_out->mem, "+", cp, &databaseNames, num);
335 return databaseNames;
338 ZOOM_API(ZOOM_connection)
339 ZOOM_connection_new (const char *host, int portnum)
341 ZOOM_connection c = ZOOM_connection_create (0);
343 ZOOM_connection_connect (c, host, portnum);
347 static zoom_sru_mode get_sru_mode_from_string(const char *s)
350 return zoom_sru_soap;
351 if (!yaz_matchstr(s, "soap"))
352 return zoom_sru_soap;
353 else if (!yaz_matchstr(s, "get"))
355 else if (!yaz_matchstr(s, "post"))
356 return zoom_sru_post;
357 return zoom_sru_error;
361 ZOOM_connection_connect(ZOOM_connection c,
362 const char *host, int portnum)
369 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
374 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
378 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
380 val = ZOOM_options_get (c->options, "proxy");
383 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
384 c->proxy = xstrdup (val);
390 val = ZOOM_options_get (c->options, "charset");
393 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
394 c->charset = xstrdup (val);
400 val = ZOOM_options_get (c->options, "lang");
403 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
404 c->lang = xstrdup (val);
409 val = ZOOM_options_get (c->options, "sru");
410 c->sru_mode = get_sru_mode_from_string(val);
412 xfree (c->host_port);
416 sprintf (hostn, "%.80s:%d", host, portnum);
417 c->host_port = xstrdup(hostn);
420 c->host_port = xstrdup(host);
424 * If the "<scheme>:" part of the host string is preceded by one
425 * or more comma-separated <name>=<value> pairs, these are taken
426 * to be options to be set on the connection object. Among other
427 * applications, this facility can be used to embed authentication
429 * user=admin,password=secret,tcp:localhost:9999
431 char *remainder = c->host_port;
432 char *pcolon = strchr(remainder, ':');
435 while ((pcomma = strchr(remainder, ',')) != 0 &&
436 (pcolon == 0 || pcomma < pcolon)) {
438 if ((pequals = strchr(remainder, '=')) != 0) {
440 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
441 ZOOM_connection_option_set(c, remainder, pequals+1);
443 remainder = pcomma+1;
446 if (remainder != c->host_port) {
448 c->host_port = xstrdup(remainder);
449 /*printf("# reset hp='%s'\n", remainder);*/
453 ZOOM_options_set(c->options, "host", c->host_port);
455 val = ZOOM_options_get (c->options, "cookie");
458 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
459 c->cookie_out = xstrdup (val);
462 val = ZOOM_options_get (c->options, "clientIP");
465 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
467 c->client_IP = xstrdup (val);
470 c->async = ZOOM_options_get_bool (c->options, "async", 0);
471 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
473 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
475 task = ZOOM_connection_add_task (c, ZOOM_TASK_CONNECT);
479 while (ZOOM_event (1, &c))
485 ZOOM_query_create(void)
487 ZOOM_query s = (ZOOM_query) xmalloc (sizeof(*s));
489 yaz_log(log_details, "%p ZOOM_query_create", s);
493 s->odr = odr_createmem (ODR_ENCODE);
500 ZOOM_query_destroy(ZOOM_query s)
506 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
507 if (s->refcount == 0)
509 odr_destroy (s->odr);
515 ZOOM_query_prefix(ZOOM_query s, const char *str)
517 s->query_string = odr_strdup(s->odr, str);
518 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
519 s->z_query->which = Z_Query_type_1;
520 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
521 if (!s->z_query->u.type_1)
523 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
527 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
532 ZOOM_query_cql(ZOOM_query s, const char *str)
536 s->query_string = odr_strdup(s->odr, str);
538 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
539 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
540 ext->indirect_reference = 0;
542 ext->which = Z_External_CQL;
543 ext->u.cql = s->query_string;
545 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
546 s->z_query->which = Z_Query_type_104;
547 s->z_query->u.type_104 = ext;
549 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
555 * Translate the CQL string client-side into RPN which is passed to
556 * the server. This is useful for server's that don't themselves
557 * support CQL, for which ZOOM_query_cql() is useless. `conn' is used
558 * only as a place to stash diagnostics if compilation fails; if this
559 * information is not needed, a null pointer may be used.
562 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
567 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
569 conn = ZOOM_connection_create(0);
571 if ((rpn = cql2pqf(conn, str)) == 0)
574 ret = ZOOM_query_prefix(s, rpn);
580 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
582 s->sort_spec = yaz_sort_spec (s->odr, criteria);
585 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
589 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
593 static zoom_ret do_write(ZOOM_connection c);
596 ZOOM_connection_destroy(ZOOM_connection c)
601 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
604 for (r = c->resultsets; r; r = r->next)
610 odr_destroy (c->odr_in);
611 odr_destroy (c->odr_out);
612 ZOOM_options_destroy (c->options);
613 ZOOM_connection_remove_tasks (c);
614 xfree (c->host_port);
619 xfree (c->cookie_out);
620 xfree (c->cookie_in);
621 xfree (c->client_IP);
625 void ZOOM_resultset_addref (ZOOM_resultset r)
630 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
635 ZOOM_resultset ZOOM_resultset_create ()
638 ZOOM_resultset r = (ZOOM_resultset) xmalloc (sizeof(*r));
642 yaz_log(log_details, "%p ZOOM_resultset_create", r);
645 r->odr = odr_createmem (ODR_ENCODE);
652 for (i = 0; i<RECORD_HASH_SIZE; i++)
653 r->record_hash[i] = 0;
661 ZOOM_API(ZOOM_resultset)
662 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
665 ZOOM_query s = ZOOM_query_create();
667 ZOOM_query_prefix (s, q);
669 r = ZOOM_connection_search (c, s);
670 ZOOM_query_destroy (s);
674 ZOOM_API(ZOOM_resultset)
675 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
677 ZOOM_resultset r = ZOOM_resultset_create ();
681 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
682 r->r_sort_spec = q->sort_spec;
685 r->options = ZOOM_options_create_with_parent(c->options);
687 r->start = ZOOM_options_get_int(r->options, "start", 0);
688 r->count = ZOOM_options_get_int(r->options, "count", 0);
690 /* If "presentChunk" is defined use that; otherwise "step" */
691 const char *cp = ZOOM_options_get (r->options, "presentChunk");
692 r->step = ZOOM_options_get_int(r->options,
693 (cp != 0 ? "presentChunk": "step"), 0);
695 r->piggyback = ZOOM_options_get_bool (r->options, "piggyback", 1);
696 cp = ZOOM_options_get (r->options, "setname");
698 r->setname = xstrdup(cp);
699 cp = ZOOM_options_get (r->options, "schema");
701 r->schema = xstrdup(cp);
705 r->next = c->resultsets;
708 if (c->host_port && c->proto == PROTO_HTTP)
712 yaz_log(log_details, "ZOOM_connection_search: no comstack");
713 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
717 yaz_log(log_details, "ZOOM_connection_search: reconnect");
722 task = ZOOM_connection_add_task (c, ZOOM_TASK_SEARCH);
723 task->u.search.resultset = r;
724 ZOOM_resultset_addref (r);
730 while (ZOOM_event (1, &c))
737 * This is the old result-set sorting API, which is maintained only
738 * for the sake of binary compatibility. There is no reason ever to
739 * use this rather than ZOOM_resultset_sort1().
742 ZOOM_resultset_sort(ZOOM_resultset r,
743 const char *sort_type, const char *sort_spec)
745 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
749 ZOOM_resultset_sort1(ZOOM_resultset r,
750 const char *sort_type, const char *sort_spec)
752 ZOOM_connection c = r->connection;
756 newq = ZOOM_query_create();
757 if (ZOOM_query_sortby(newq, sort_spec) < 0)
760 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
761 r, r, sort_type, sort_spec);
765 if (c->host_port && c->proto == PROTO_HTTP)
769 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
770 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
774 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
780 ZOOM_resultset_cache_reset(r);
781 task = ZOOM_connection_add_task (c, ZOOM_TASK_SORT);
782 task->u.sort.resultset = r;
783 task->u.sort.q = newq;
785 ZOOM_resultset_addref (r);
789 while (ZOOM_event (1, &c))
797 ZOOM_resultset_cache_reset(ZOOM_resultset r)
800 for (i = 0; i<RECORD_HASH_SIZE; i++)
802 ZOOM_record_cache rc;
803 for (rc = r->record_hash[i]; rc; rc = rc->next)
805 if (rc->rec.wrbuf_marc)
806 wrbuf_free (rc->rec.wrbuf_marc, 1);
807 if (rc->rec.wrbuf_iconv)
808 wrbuf_free (rc->rec.wrbuf_iconv, 1);
809 if (rc->rec.wrbuf_opac)
810 wrbuf_free (rc->rec.wrbuf_opac, 1);
812 r->record_hash[i] = 0;
817 ZOOM_resultset_destroy(ZOOM_resultset r)
822 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
824 if (r->refcount == 0)
826 ZOOM_resultset_cache_reset(r);
830 /* remove ourselves from the resultsets in connection */
831 ZOOM_resultset *rp = &r->connection->resultsets;
834 assert (*rp); /* we must be in this list!! */
836 { /* OK, we're here - take us out of it */
843 ZOOM_query_destroy (r->query);
844 ZOOM_options_destroy (r->options);
845 odr_destroy (r->odr);
853 ZOOM_resultset_size (ZOOM_resultset r)
858 static void do_close (ZOOM_connection c)
864 c->state = STATE_IDLE;
867 static void ZOOM_resultset_retrieve (ZOOM_resultset r,
868 int force_sync, int start, int count)
876 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
877 " count=%d", r, force_sync, start, count);
882 if (c->host_port && c->proto == PROTO_HTTP)
886 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
887 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
891 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
896 task = ZOOM_connection_add_task (c, ZOOM_TASK_RETRIEVE);
897 task->u.retrieve.resultset = r;
898 task->u.retrieve.start = start;
899 task->u.retrieve.count = count;
901 cp = ZOOM_options_get (r->options, "schema");
904 if (!r->schema || strcmp(r->schema, cp))
907 r->schema = xstrdup(cp);
911 ZOOM_resultset_addref (r);
913 if (!r->connection->async || force_sync)
914 while (r->connection && ZOOM_event (1, &r->connection))
919 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
920 size_t start, size_t count)
922 int force_present = 0;
926 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
927 r, r, (long) start, (long) count);
930 ZOOM_resultset_retrieve (r, force_present, start, count);
934 for (i = 0; i< count; i++)
935 recs[i] = ZOOM_resultset_record_immediate (r, i+start);
939 static void get_cert(ZOOM_connection c)
944 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
946 ZOOM_connection_option_setl(c, "sslPeerCert",
952 static zoom_ret do_connect (ZOOM_connection c)
955 const char *effective_host;
958 effective_host = c->proxy;
960 effective_host = c->host_port;
962 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
966 c->cs = cs_create_host (effective_host, 0, &add);
968 if (c->cs && c->cs->protocol == PROTO_HTTP)
971 const char *path = 0;
973 c->proto = PROTO_HTTP;
974 cs_get_host_args(c->host_port, &path);
976 c->path = (char*) xmalloc(strlen(path)+2);
978 strcpy (c->path+1, path);
980 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
982 return zoom_complete;
987 int ret = cs_connect (c->cs, add);
990 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
991 ZOOM_connection_put_event(c, event);
993 if (c->proto == PROTO_Z3950)
994 ZOOM_connection_send_init(c);
997 /* no init request for SRW .. */
998 assert (c->tasks->which == ZOOM_TASK_CONNECT);
999 ZOOM_connection_remove_task (c);
1001 ZOOM_connection_exec_task (c);
1003 c->state = STATE_ESTABLISHED;
1004 return zoom_pending;
1008 c->state = STATE_CONNECTING;
1009 c->mask = ZOOM_SELECT_EXCEPT;
1010 if (c->cs->io_pending & CS_WANT_WRITE)
1011 c->mask += ZOOM_SELECT_WRITE;
1012 if (c->cs->io_pending & CS_WANT_READ)
1013 c->mask += ZOOM_SELECT_READ;
1014 return zoom_pending;
1017 c->state = STATE_IDLE;
1018 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1019 return zoom_complete;
1022 int z3950_connection_socket(ZOOM_connection c)
1025 return cs_fileno(c->cs);
1029 int z3950_connection_mask(ZOOM_connection c)
1036 static void otherInfo_attach (ZOOM_connection c, Z_APDU *a, ODR out)
1039 for (i = 0; i<200; i++)
1042 Z_OtherInformation **oi;
1048 sprintf (buf, "otherInfo%d", i);
1049 val = ZOOM_options_get (c->options, buf);
1052 cp = strchr(val, ':');
1056 if (len >= sizeof(buf))
1057 len = sizeof(buf)-1;
1058 memcpy (buf, val, len);
1060 oidval = oid_getvalbyname (buf);
1061 if (oidval == VAL_NONE)
1064 yaz_oi_APDU(a, &oi);
1065 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1069 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1074 Z_OtherInformation **oi;
1075 yaz_oi_APDU(a, &oi);
1076 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1080 Z_OtherInformation **oi;
1081 yaz_oi_APDU(a, &oi);
1082 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1084 otherInfo_attach (c, a, out);
1085 if (!z_APDU(out, &a, 0, 0))
1087 FILE *outf = fopen("/tmp/apdu.txt", "a");
1090 ODR odr_pr = odr_createmem(ODR_PRINT);
1091 fprintf (outf, "a=%p\n", a);
1092 odr_setprint(odr_pr, outf);
1093 z_APDU(odr_pr, &a, 0, 0);
1094 odr_destroy(odr_pr);
1096 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1097 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1101 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1105 static zoom_ret send_APDU (ZOOM_connection c, Z_APDU *a)
1109 if (encode_APDU(c, a, c->odr_out))
1110 return zoom_complete;
1111 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1112 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1113 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1114 ZOOM_connection_put_event (c, event);
1115 odr_reset(c->odr_out);
1116 return do_write (c);
1119 /* returns 1 if PDU was sent OK (still pending )
1120 0 if PDU was not sent OK (nothing to wait for)
1123 static zoom_ret ZOOM_connection_send_init (ZOOM_connection c)
1125 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1126 Z_InitRequest *ireq = apdu->u.initRequest;
1127 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1128 odr_malloc(c->odr_out, sizeof(*auth));
1129 const char *auth_groupId = ZOOM_options_get (c->options, "group");
1130 const char *auth_userId = ZOOM_options_get (c->options, "user");
1131 const char *auth_password = ZOOM_options_get (c->options, "password");
1134 /* support the pass for backwards compatibility */
1136 auth_password = ZOOM_options_get (c->options, "pass");
1138 ODR_MASK_SET(ireq->options, Z_Options_search);
1139 ODR_MASK_SET(ireq->options, Z_Options_present);
1140 ODR_MASK_SET(ireq->options, Z_Options_scan);
1141 ODR_MASK_SET(ireq->options, Z_Options_sort);
1142 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1143 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1145 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1146 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1147 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1149 /* Index Data's Z39.50 Implementor Id is 81 */
1150 ireq->implementationId = odr_prepend(c->odr_out,
1151 ZOOM_options_get(c->options, "implementationId"),
1152 odr_prepend(c->odr_out, "81", ireq->implementationId));
1154 ireq->implementationName = odr_prepend(c->odr_out,
1155 ZOOM_options_get(c->options, "implementationName"),
1156 odr_prepend(c->odr_out, "ZOOM-C", ireq->implementationName));
1158 version = odr_strdup(c->odr_out, "$Revision: 1.73 $");
1159 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1160 version[strlen(version)-2] = '\0';
1161 ireq->implementationVersion = odr_prepend(c->odr_out,
1162 ZOOM_options_get(c->options, "implementationVersion"),
1163 odr_prepend(c->odr_out, &version[11], ireq->implementationVersion));
1165 *ireq->maximumRecordSize =
1166 ZOOM_options_get_int (c->options, "maximumRecordSize", 1024*1024);
1167 *ireq->preferredMessageSize =
1168 ZOOM_options_get_int (c->options, "preferredMessageSize", 1024*1024);
1170 if (auth_groupId || auth_password)
1172 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1175 if (auth_groupId && *auth_groupId)
1177 pass->groupId = (char *)
1178 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1179 strcpy(pass->groupId, auth_groupId);
1183 if (auth_userId && *auth_userId)
1185 pass->userId = (char *)
1186 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1187 strcpy(pass->userId, auth_userId);
1191 if (auth_password && *auth_password)
1193 pass->password = (char *)
1194 odr_malloc(c->odr_out, strlen(auth_password)+1);
1195 strcpy(pass->password, auth_password);
1200 auth->which = Z_IdAuthentication_idPass;
1201 auth->u.idPass = pass;
1202 ireq->idAuthentication = auth;
1205 else if (auth_userId)
1207 auth->which = Z_IdAuthentication_open;
1208 auth->u.open = (char *)
1209 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1210 strcpy(auth->u.open, auth_userId);
1211 ireq->idAuthentication = auth;
1214 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1215 VAL_PROXY, 1, c->host_port);
1216 if (c->charset || c->lang)
1218 Z_OtherInformation **oi;
1219 Z_OtherInformationUnit *oi_unit;
1221 yaz_oi_APDU(apdu, &oi);
1223 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1225 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1226 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1227 oi_unit->information.externallyDefinedInfo =
1228 yaz_set_proposal_charneg_list(c->odr_out, " ",
1229 c->charset, c->lang, 1);
1233 return send_APDU (c, apdu);
1237 static zoom_ret send_srw (ZOOM_connection c, Z_SRW_PDU *sr)
1239 Z_SOAP_Handler h[2] = {
1240 {"http://www.loc.gov/zing/srw/", 0, (Z_SOAP_fun) yaz_srw_codec},
1243 ODR o = odr_createmem(ODR_ENCODE);
1245 Z_SOAP *p = (Z_SOAP*) odr_malloc(o, sizeof(*p));
1249 gdu = z_get_HTTP_Request(c->odr_out);
1250 gdu->u.HTTP_Request->path = c->path;
1254 const char *cp0 = strstr(c->host_port, "://");
1255 const char *cp1 = 0;
1261 cp1 = strchr(cp0, '/');
1263 cp1 = cp0+strlen(cp0);
1267 char *h = (char*) odr_malloc(c->odr_out, cp1 - cp0 + 1);
1268 memcpy (h, cp0, cp1 - cp0);
1270 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1275 if (c->sru_mode == zoom_sru_get)
1277 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1279 else if (c->sru_mode == zoom_sru_post)
1281 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1283 else if (c->sru_mode == zoom_sru_soap)
1285 z_HTTP_header_add_content_type(c->odr_out,
1286 &gdu->u.HTTP_Request->headers,
1287 "text/xml", c->charset);
1289 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1290 "SOAPAction", "\"\"");
1291 p->which = Z_SOAP_generic;
1292 p->u.generic = (Z_SOAP_Generic *) odr_malloc(o, sizeof(*p->u.generic));
1293 p->u.generic->no = 0;
1294 p->u.generic->ns = 0;
1295 p->u.generic->p = sr;
1296 p->ns = "http://schemas.xmlsoap.org/soap/envelope/";
1298 ret = z_soap_codec_enc(o, &p,
1299 &gdu->u.HTTP_Request->content_buf,
1300 &gdu->u.HTTP_Request->content_len, h,
1304 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1305 return zoom_complete;
1306 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1309 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1310 ZOOM_connection_put_event (c, event);
1311 odr_reset(c->odr_out);
1312 return do_write (c);
1317 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1320 ZOOM_resultset resultset = 0;
1322 const char *recordPacking = 0;
1324 if (c->error) /* don't continue on error */
1325 return zoom_complete;
1327 if (c->tasks->which == ZOOM_TASK_SEARCH)
1329 resultset = c->tasks->u.search.resultset;
1330 resultset->setname = xstrdup ("default");
1331 ZOOM_options_set (resultset->options, "setname", resultset->setname);
1333 else if(c->tasks->which == ZOOM_TASK_RETRIEVE)
1335 resultset = c->tasks->u.retrieve.resultset;
1337 resultset->start = c->tasks->u.retrieve.start;
1338 resultset->count = c->tasks->u.retrieve.count;
1340 if (resultset->start >= resultset->size)
1341 return zoom_complete;
1342 if (resultset->start + resultset->count > resultset->size)
1343 resultset->count = resultset->size - resultset->start;
1345 for (i = 0; i<resultset->count; i++)
1348 record_cache_lookup (resultset, i + resultset->start);
1352 if (i == resultset->count)
1353 return zoom_complete;
1355 assert(resultset->query);
1357 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1359 if (resultset->query->z_query->which == Z_Query_type_104
1360 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1363 sr->u.request->query_type = Z_SRW_query_type_cql;
1364 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1366 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1367 resultset->query->z_query->u.type_1)
1369 sr->u.request->query_type = Z_SRW_query_type_pqf;
1370 sr->u.request->query.pqf = resultset->query->query_string;
1374 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1375 return zoom_complete;
1377 sr->u.request->startRecord = odr_intdup (c->odr_out, resultset->start + 1);
1378 sr->u.request->maximumRecords = odr_intdup (
1379 c->odr_out, resultset->step>0 ? resultset->step : resultset->count);
1380 sr->u.request->recordSchema = resultset->schema;
1382 recordPacking = ZOOM_resultset_option_get (resultset, "recordPacking");
1385 sr->u.request->recordPacking = odr_strdup(c->odr_out, recordPacking);
1387 return send_srw(c, sr);
1390 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1392 return zoom_complete;
1396 static zoom_ret ZOOM_connection_send_search (ZOOM_connection c)
1399 int lslb, ssub, mspn;
1401 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1402 Z_SearchRequest *search_req = apdu->u.searchRequest;
1403 const char *elementSetName;
1404 const char *smallSetElementSetName;
1405 const char *mediumSetElementSetName;
1408 assert (c->tasks->which == ZOOM_TASK_SEARCH);
1410 r = c->tasks->u.search.resultset;
1412 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1415 ZOOM_options_get (r->options, "elementSetName");
1416 smallSetElementSetName =
1417 ZOOM_options_get (r->options, "smallSetElementSetName");
1418 mediumSetElementSetName =
1419 ZOOM_options_get (r->options, "mediumSetElementSetName");
1421 if (!smallSetElementSetName)
1422 smallSetElementSetName = elementSetName;
1424 if (!mediumSetElementSetName)
1425 mediumSetElementSetName = elementSetName;
1430 /* prepare query for the search request */
1431 search_req->query = r->query->z_query;
1432 if (!search_req->query)
1434 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1435 return zoom_complete;
1438 search_req->databaseNames =
1439 set_DatabaseNames (c, r->options, &search_req->num_databaseNames);
1441 /* get syntax (no need to provide unless piggyback is in effect) */
1442 syntax = ZOOM_options_get (r->options, "preferredRecordSyntax");
1444 lslb = ZOOM_options_get_int (r->options, "largeSetLowerBound", -1);
1445 ssub = ZOOM_options_get_int (r->options, "smallSetUpperBound", -1);
1446 mspn = ZOOM_options_get_int (r->options, "mediumSetPresentNumber", -1);
1447 if (lslb != -1 && ssub != -1 && mspn != -1)
1449 /* So're a Z39.50 expert? Let's hope you don't do sort */
1450 *search_req->largeSetLowerBound = lslb;
1451 *search_req->smallSetUpperBound = ssub;
1452 *search_req->mediumSetPresentNumber = mspn;
1454 else if (r->start == 0 && r->count > 0
1455 && r->piggyback && !r->r_sort_spec && !r->schema)
1457 /* Regular piggyback - do it unless we're going to do sort */
1458 *search_req->largeSetLowerBound = 2000000000;
1459 *search_req->smallSetUpperBound = 1;
1460 *search_req->mediumSetPresentNumber = r->step>0 ? r->step : r->count;
1464 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1465 smallSetElementSetName = 0;
1466 mediumSetElementSetName = 0;
1469 if (smallSetElementSetName && *smallSetElementSetName)
1471 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1472 odr_malloc (c->odr_out, sizeof(*esn));
1474 esn->which = Z_ElementSetNames_generic;
1475 esn->u.generic = odr_strdup (c->odr_out, smallSetElementSetName);
1476 search_req->smallSetElementSetNames = esn;
1478 if (mediumSetElementSetName && *mediumSetElementSetName)
1480 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1481 odr_malloc (c->odr_out, sizeof(*esn));
1483 esn->which = Z_ElementSetNames_generic;
1484 esn->u.generic = odr_strdup (c->odr_out, mediumSetElementSetName);
1485 search_req->mediumSetElementSetNames = esn;
1488 search_req->preferredRecordSyntax =
1489 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1493 if (c->support_named_resultsets)
1497 /* find the lowest unused ordinal so that we re-use
1498 result sets on the server. */
1499 for (ord = 1; ; ord++)
1502 sprintf (setname, "%d", ord);
1503 for (rp = c->resultsets; rp; rp = rp->next)
1504 if (rp->setname && !strcmp (rp->setname, setname))
1509 r->setname = xstrdup (setname);
1510 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1511 "set %s", c, r->setname);
1515 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1517 r->setname = xstrdup ("default");
1519 ZOOM_options_set (r->options, "setname", r->setname);
1521 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1522 return send_APDU (c, apdu);
1525 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1532 case Z_DefaultDiagFormat_v2Addinfo:
1533 addinfo = r->u.v2Addinfo;
1535 case Z_DefaultDiagFormat_v3Addinfo:
1536 addinfo = r->u.v3Addinfo;
1541 set_dset_error(c, *r->condition,
1542 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1546 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1548 if (p->which != Z_DiagRec_defaultFormat)
1549 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1551 response_default_diag(c, p->u.defaultFormat);
1554 ZOOM_API(ZOOM_record)
1555 ZOOM_record_clone (ZOOM_record srec)
1562 odr_enc = odr_createmem(ODR_ENCODE);
1563 if (!z_NamePlusRecord (odr_enc, &srec->npr, 0, 0))
1565 buf = odr_getbuf (odr_enc, &size, 0);
1567 nrec = (ZOOM_record) xmalloc (sizeof(*nrec));
1568 nrec->odr = odr_createmem(ODR_DECODE);
1569 nrec->wrbuf_marc = 0;
1570 nrec->wrbuf_iconv = 0;
1571 nrec->wrbuf_opac = 0;
1572 odr_setbuf (nrec->odr, buf, size, 0);
1573 z_NamePlusRecord (nrec->odr, &nrec->npr, 0, 0);
1575 odr_destroy (odr_enc);
1579 ZOOM_API(ZOOM_record)
1580 ZOOM_resultset_record_immediate (ZOOM_resultset s,size_t pos)
1582 return record_cache_lookup (s, pos);
1585 ZOOM_API(ZOOM_record)
1586 ZOOM_resultset_record (ZOOM_resultset r, size_t pos)
1588 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1593 * MIKE: I think force_sync should always be zero, but I don't
1594 * want to make this change until I get the go-ahead from
1595 * Adam, in case something depends on the old synchronous
1599 if (getenv("ZOOM_RECORD_NO_FORCE_SYNC")) force_sync = 0;
1600 ZOOM_resultset_retrieve (r, force_sync, pos, 1);
1601 rec = ZOOM_resultset_record_immediate (r, pos);
1607 ZOOM_record_destroy (ZOOM_record rec)
1611 if (rec->wrbuf_marc)
1612 wrbuf_free (rec->wrbuf_marc, 1);
1613 if (rec->wrbuf_iconv)
1614 wrbuf_free (rec->wrbuf_iconv, 1);
1615 if (rec->wrbuf_opac)
1616 wrbuf_free (rec->wrbuf_opac, 1);
1617 odr_destroy (rec->odr);
1621 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1623 const char *buf, int sz,
1624 const char *record_charset)
1629 yaz_marc_t mt = yaz_marc_create();
1632 strcpy(to, "UTF-8");
1633 if (record_charset && *record_charset)
1635 /* Use "from,to" or just "from" */
1636 const char *cp = strchr(record_charset, ',');
1637 int clen = strlen(record_charset);
1640 strncpy( to, cp+1, sizeof(to)-1);
1641 to[sizeof(to)-1] = '\0';
1642 clen = cp - record_charset;
1644 if (clen > sizeof(from)-1)
1645 clen = sizeof(from)-1;
1648 strncpy(from, record_charset, clen);
1654 cd = yaz_iconv_open(to, from);
1655 yaz_marc_iconv(mt, cd);
1658 yaz_marc_xml(mt, marc_type);
1659 if (!rec->wrbuf_marc)
1660 rec->wrbuf_marc = wrbuf_alloc();
1661 wrbuf_rewind (rec->wrbuf_marc);
1662 if (yaz_marc_decode_wrbuf (mt, buf, sz, rec->wrbuf_marc) > 0)
1664 yaz_marc_destroy(mt);
1666 yaz_iconv_close(cd);
1668 *len = wrbuf_len(rec->wrbuf_marc);
1669 return wrbuf_buf(rec->wrbuf_marc);
1671 yaz_marc_destroy(mt);
1673 yaz_iconv_close(cd);
1677 static const char *record_iconv_return(ZOOM_record rec, int *len,
1678 const char *buf, int sz,
1679 const char *record_charset)
1686 strcpy(to, "UTF-8");
1687 if (record_charset && *record_charset)
1689 /* Use "from,to" or just "from" */
1690 const char *cp = strchr(record_charset, ',');
1691 int clen = strlen(record_charset);
1694 strncpy( to, cp+1, sizeof(to)-1);
1695 to[sizeof(to)-1] = '\0';
1696 clen = cp - record_charset;
1698 if (clen > sizeof(from)-1)
1699 clen = sizeof(from)-1;
1702 strncpy(from, record_charset, clen);
1706 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1709 size_t inbytesleft = sz;
1710 const char *inp = buf;
1712 if (!rec->wrbuf_iconv)
1713 rec->wrbuf_iconv = wrbuf_alloc();
1715 wrbuf_rewind(rec->wrbuf_iconv);
1719 size_t outbytesleft = sizeof(outbuf);
1720 char *outp = outbuf;
1721 size_t r = yaz_iconv (cd, (char**) &inp,
1723 &outp, &outbytesleft);
1724 if (r == (size_t) (-1))
1726 int e = yaz_iconv_error(cd);
1727 if (e != YAZ_ICONV_E2BIG)
1730 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1732 wrbuf_puts(rec->wrbuf_iconv, "");
1733 buf = wrbuf_buf(rec->wrbuf_iconv);
1734 sz = wrbuf_len(rec->wrbuf_iconv);
1735 yaz_iconv_close(cd);
1742 ZOOM_API(const char *)
1743 ZOOM_record_get (ZOOM_record rec, const char *type_spec, int *len)
1750 Z_NamePlusRecord *npr;
1753 *len = 0; /* default return */
1762 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1764 if (cp[i] == ';' || cp[i] == ' ')
1770 while (type_spec[i] == ';')
1773 while (type_spec[i] == ' ')
1775 if (!strncmp(type_spec+i, "charset=", 8))
1778 i = i + 8; /* skip charset= */
1779 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1781 if (type_spec[i] == ';' || type_spec[i] == ' ')
1787 else if (!strncmp(type_spec+i, "xpath=", 6))
1791 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1795 while (type_spec[i] == ' ')
1798 if (!strcmp (type, "database"))
1801 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1802 return npr->databaseName;
1804 else if (!strcmp (type, "syntax"))
1806 const char *desc = 0;
1807 if (npr->which == Z_NamePlusRecord_databaseRecord)
1809 Z_External *r = (Z_External *) npr->u.databaseRecord;
1810 oident *ent = oid_getentbyoid(r->direct_reference);
1817 *len = strlen(desc);
1820 if (npr->which != Z_NamePlusRecord_databaseRecord)
1823 /* from now on - we have a database record .. */
1824 if (!strcmp (type, "render"))
1826 Z_External *r = (Z_External *) npr->u.databaseRecord;
1827 oident *ent = oid_getentbyoid(r->direct_reference);
1829 /* render bibliographic record .. */
1830 if (r->which == Z_External_OPAC)
1832 r = r->u.opac->bibliographicRecord;
1835 ent = oid_getentbyoid(r->direct_reference);
1837 if (r->which == Z_External_sutrs)
1838 return record_iconv_return(rec, len,
1839 (char*) r->u.sutrs->buf,
1842 else if (r->which == Z_External_octet)
1844 const char *ret_buf;
1852 case VAL_APPLICATION_XML:
1855 ret_buf = marc_iconv_return(
1856 rec, YAZ_MARC_LINE, len,
1857 (const char *) r->u.octet_aligned->buf,
1858 r->u.octet_aligned->len,
1863 return record_iconv_return(rec, len,
1864 (const char *) r->u.octet_aligned->buf,
1865 r->u.octet_aligned->len,
1868 else if (r->which == Z_External_grs1)
1870 if (!rec->wrbuf_marc)
1871 rec->wrbuf_marc = wrbuf_alloc();
1872 wrbuf_rewind (rec->wrbuf_marc);
1873 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1874 return record_iconv_return(rec, len,
1875 wrbuf_buf(rec->wrbuf_marc),
1876 wrbuf_len(rec->wrbuf_marc),
1881 else if (!strcmp (type, "xml"))
1883 Z_External *r = (Z_External *) npr->u.databaseRecord;
1884 oident *ent = oid_getentbyoid(r->direct_reference);
1886 /* render bibliographic record .. */
1887 if (r->which == Z_External_OPAC)
1889 r = r->u.opac->bibliographicRecord;
1892 ent = oid_getentbyoid(r->direct_reference);
1895 if (r->which == Z_External_sutrs)
1896 return record_iconv_return(rec, len,
1897 (const char *) r->u.sutrs->buf,
1900 else if (r->which == Z_External_octet)
1902 const char *ret_buf;
1903 int marc_decode_type = YAZ_MARC_MARCXML;
1912 case VAL_APPLICATION_XML:
1915 ret_buf = marc_iconv_return(
1916 rec, marc_decode_type, len,
1917 (const char *) r->u.octet_aligned->buf,
1918 r->u.octet_aligned->len,
1923 return record_iconv_return(rec, len,
1924 (const char *) r->u.octet_aligned->buf,
1925 r->u.octet_aligned->len,
1928 else if (r->which == Z_External_grs1)
1935 else if (!strcmp (type, "raw"))
1937 Z_External *r = (Z_External *) npr->u.databaseRecord;
1939 if (r->which == Z_External_sutrs)
1941 if (len) *len = r->u.sutrs->len;
1942 return (const char *) r->u.sutrs->buf;
1944 else if (r->which == Z_External_octet)
1946 if (len) *len = r->u.octet_aligned->len;
1947 return (const char *) r->u.octet_aligned->buf;
1949 else /* grs-1, explain, OPAC, ... */
1952 return (const char *) npr->u.databaseRecord;
1956 else if (!strcmp (type, "ext"))
1959 return (const char *) npr->u.databaseRecord;
1961 else if (!strcmp (type, "opac"))
1964 Z_External *r = (Z_External *) npr->u.databaseRecord;
1965 if (r->which == Z_External_OPAC)
1967 if (!rec->wrbuf_opac)
1968 rec->wrbuf_opac = wrbuf_alloc();
1969 wrbuf_rewind (rec->wrbuf_opac);
1970 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
1971 return record_iconv_return(rec, len,
1972 wrbuf_buf(rec->wrbuf_opac),
1973 wrbuf_len(rec->wrbuf_opac),
1980 static int strcmp_null(const char *v1, const char *v2)
1986 return strcmp(v1, v2);
1989 static size_t record_hash(int pos)
1993 return pos % RECORD_HASH_SIZE;
1996 static void record_cache_add (ZOOM_resultset r, Z_NamePlusRecord *npr,
1999 ZOOM_record_cache rc;
2000 const char *elementSetName =
2001 ZOOM_resultset_option_get (r, "elementSetName");
2002 const char *syntax =
2003 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
2005 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2006 ZOOM_connection_put_event(r->connection, event);
2008 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2012 if (strcmp_null(r->schema, rc->schema))
2014 if (strcmp_null(elementSetName,rc->elementSetName))
2016 if (strcmp_null(syntax, rc->syntax))
2018 /* not destroying rc->npr (it's handled by nmem )*/
2020 /* keeping wrbuf_marc too */
2024 rc = (ZOOM_record_cache) odr_malloc (r->odr, sizeof(*rc));
2027 rc->rec.wrbuf_marc = 0;
2028 rc->rec.wrbuf_iconv = 0;
2029 rc->rec.wrbuf_opac = 0;
2031 rc->elementSetName = odr_strdup (r->odr, elementSetName);
2033 rc->elementSetName = 0;
2036 rc->syntax = odr_strdup (r->odr, syntax);
2041 rc->schema = odr_strdup (r->odr, r->schema);
2046 rc->next = r->record_hash[record_hash(pos)];
2047 r->record_hash[record_hash(pos)] = rc;
2050 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos)
2052 ZOOM_record_cache rc;
2053 const char *elementSetName =
2054 ZOOM_resultset_option_get (r, "elementSetName");
2055 const char *syntax =
2056 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
2058 for (rc = r->record_hash[record_hash(pos)]; rc; rc = rc->next)
2062 if (strcmp_null(r->schema, rc->schema))
2064 if (strcmp_null(elementSetName,rc->elementSetName))
2066 if (strcmp_null(syntax, rc->syntax))
2074 static void handle_records (ZOOM_connection c, Z_Records *sr,
2077 ZOOM_resultset resultset;
2081 switch (c->tasks->which)
2083 case ZOOM_TASK_SEARCH:
2084 resultset = c->tasks->u.search.resultset;
2086 case ZOOM_TASK_RETRIEVE:
2087 resultset = c->tasks->u.retrieve.resultset;
2092 if (sr && sr->which == Z_Records_NSD)
2093 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2094 else if (sr && sr->which == Z_Records_multipleNSD)
2096 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2097 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2099 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2103 if (resultset->count + resultset->start > resultset->size)
2104 resultset->count = resultset->size - resultset->start;
2105 if (resultset->count < 0)
2106 resultset->count = 0;
2107 if (sr && sr->which == Z_Records_DBOSD)
2110 NMEM nmem = odr_extract_mem (c->odr_in);
2111 Z_NamePlusRecordList *p =
2112 sr->u.databaseOrSurDiagnostics;
2113 for (i = 0; i<p->num_records; i++)
2115 record_cache_add (resultset, p->records[i],
2116 i+ resultset->start);
2118 /* transfer our response to search_nmem .. we need it later */
2119 nmem_transfer (resultset->odr->mem, nmem);
2120 nmem_destroy (nmem);
2121 if (present_phase && p->num_records == 0)
2123 /* present response and we didn't get any records! */
2124 Z_NamePlusRecord *myrec =
2125 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2126 record_cache_add(resultset, myrec, resultset->start);
2129 else if (present_phase)
2131 /* present response and we didn't get any records! */
2132 Z_NamePlusRecord *myrec =
2133 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2134 record_cache_add(resultset, myrec, resultset->start);
2139 static void handle_present_response (ZOOM_connection c, Z_PresentResponse *pr)
2141 handle_records (c, pr->records, 1);
2144 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2147 switch (term->which)
2149 case Z_Term_general:
2150 ZOOM_options_setl(opt, name,
2151 (const char *)(term->u.general->buf),
2152 term->u.general->len);
2154 case Z_Term_characterString:
2155 ZOOM_options_set(opt, name, term->u.characterString);
2157 case Z_Term_numeric:
2158 ZOOM_options_set_int(opt, name, *term->u.numeric);
2163 static void handle_queryExpression(ZOOM_options opt, const char *name,
2164 Z_QueryExpression *exp)
2170 case Z_QueryExpression_term:
2171 if (exp->u.term && exp->u.term->queryTerm)
2173 sprintf(opt_name, "%s.term", name);
2174 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2177 case Z_QueryExpression_query:
2182 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2183 Z_OtherInformation *o)
2186 for (i = 0; o && i < o->num_elements; i++)
2188 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2190 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2192 if (ext->which == Z_External_searchResult1)
2195 Z_SearchInfoReport *sr = ext->u.searchResult1;
2198 ZOOM_options_set_int(
2199 resultset->options, "searchresult.size", sr->num);
2201 for (j = 0; j < sr->num; j++)
2203 Z_SearchInfoReport_s *ent =
2204 ext->u.searchResult1->elements[j];
2207 sprintf(pref, "searchresult.%d", j);
2209 if (ent->subqueryId)
2212 sprintf(opt_name, "%s.id", pref);
2213 ZOOM_options_set(resultset->options, opt_name,
2216 if (ent->subqueryExpression)
2219 sprintf(opt_name, "%s.subquery", pref);
2220 handle_queryExpression(resultset->options, opt_name,
2221 ent->subqueryExpression);
2223 if (ent->subqueryInterpretation)
2226 sprintf(opt_name, "%s.interpretation", pref);
2227 handle_queryExpression(resultset->options, opt_name,
2228 ent->subqueryInterpretation);
2230 if (ent->subqueryRecommendation)
2233 sprintf(opt_name, "%s.recommendation", pref);
2234 handle_queryExpression(resultset->options, opt_name,
2235 ent->subqueryRecommendation);
2237 if (ent->subqueryCount)
2240 sprintf(opt_name, "%s.count", pref);
2241 ZOOM_options_set_int(resultset->options, opt_name,
2242 *ent->subqueryCount);
2250 static void handle_search_response (ZOOM_connection c, Z_SearchResponse *sr)
2252 ZOOM_resultset resultset;
2255 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2258 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2259 ZOOM_connection_put_event(c, event);
2261 resultset = c->tasks->u.search.resultset;
2263 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2265 resultset->size = *sr->resultCount;
2266 handle_records (c, sr->records, 0);
2269 static void sort_response (ZOOM_connection c, Z_SortResponse *res)
2271 if (res->diagnostics && res->num_diagnostics > 0)
2272 response_diag (c, res->diagnostics[0]);
2275 static int scan_response (ZOOM_connection c, Z_ScanResponse *res)
2277 NMEM nmem = odr_extract_mem (c->odr_in);
2280 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2282 scan = c->tasks->u.scan.scan;
2284 if (res->entries && res->entries->nonsurrogateDiagnostics)
2285 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2286 scan->scan_response = res;
2287 nmem_transfer (scan->odr->mem, nmem);
2289 ZOOM_options_set_int (scan->options, "stepSize", *res->stepSize);
2290 if (res->positionOfTerm)
2291 ZOOM_options_set_int (scan->options, "position", *res->positionOfTerm);
2292 if (res->scanStatus)
2293 ZOOM_options_set_int (scan->options, "scanStatus", *res->scanStatus);
2294 if (res->numberOfEntriesReturned)
2295 ZOOM_options_set_int (scan->options, "number",
2296 *res->numberOfEntriesReturned);
2297 nmem_destroy (nmem);
2301 static zoom_ret send_sort (ZOOM_connection c,
2302 ZOOM_resultset resultset)
2305 resultset->r_sort_spec = 0;
2306 if (resultset->r_sort_spec)
2308 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2309 Z_SortRequest *req = apdu->u.sortRequest;
2311 req->num_inputResultSetNames = 1;
2312 req->inputResultSetNames = (Z_InternationalString **)
2313 odr_malloc (c->odr_out, sizeof(*req->inputResultSetNames));
2314 req->inputResultSetNames[0] =
2315 odr_strdup (c->odr_out, resultset->setname);
2316 req->sortedResultSetName = odr_strdup (c->odr_out, resultset->setname);
2317 req->sortSequence = resultset->r_sort_spec;
2318 resultset->r_sort_spec = 0;
2319 return send_APDU (c, apdu);
2321 return zoom_complete;
2324 static zoom_ret send_present(ZOOM_connection c)
2327 Z_PresentRequest *req = 0;
2329 const char *syntax = 0;
2330 const char *elementSetName = 0;
2331 ZOOM_resultset resultset;
2335 yaz_log(log_details, "%p send_present no tasks", c);
2336 return zoom_complete;
2338 switch (c->tasks->which)
2340 case ZOOM_TASK_SEARCH:
2341 resultset = c->tasks->u.search.resultset;
2343 case ZOOM_TASK_RETRIEVE:
2344 resultset = c->tasks->u.retrieve.resultset;
2345 resultset->start = c->tasks->u.retrieve.start;
2346 resultset->count = c->tasks->u.retrieve.count;
2348 if (resultset->start >= resultset->size)
2350 yaz_log(log_details, "%p send_present start=%d >= size=%d",
2351 c, resultset->start, resultset->size);
2352 return zoom_complete;
2354 if (resultset->start + resultset->count > resultset->size)
2355 resultset->count = resultset->size - resultset->start;
2358 return zoom_complete;
2360 yaz_log(log_details, "%p send_present start=%d count=%d",
2361 c, resultset->start, resultset->count);
2363 syntax = ZOOM_resultset_option_get (resultset, "preferredRecordSyntax");
2364 elementSetName = ZOOM_resultset_option_get (resultset, "elementSetName");
2366 if (c->error) /* don't continue on error */
2367 return zoom_complete;
2368 if (resultset->start < 0)
2369 return zoom_complete;
2370 for (i = 0; i<resultset->count; i++)
2373 record_cache_lookup (resultset, i + resultset->start);
2377 if (i == resultset->count)
2379 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2380 return zoom_complete;
2383 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2384 req = apdu->u.presentRequest;
2386 resultset->start += i;
2387 resultset->count -= i;
2390 yaz_log(log_details, "%p send_present skip=%d", c, i);
2392 *req->resultSetStartPoint = resultset->start + 1;
2393 *req->numberOfRecordsRequested = resultset->step>0 ?
2394 resultset->step : resultset->count;
2395 if (*req->numberOfRecordsRequested + resultset->start > resultset->size)
2396 *req->numberOfRecordsRequested = resultset->size - resultset->start;
2397 assert (*req->numberOfRecordsRequested > 0);
2399 if (syntax && *syntax)
2400 req->preferredRecordSyntax =
2401 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
2403 if (resultset->schema && *resultset->schema)
2405 Z_RecordComposition *compo = (Z_RecordComposition *)
2406 odr_malloc (c->odr_out, sizeof(*compo));
2408 req->recordComposition = compo;
2409 compo->which = Z_RecordComp_complex;
2410 compo->u.complex = (Z_CompSpec *)
2411 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2412 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2413 odr_malloc(c->odr_out, sizeof(bool_t));
2414 *compo->u.complex->selectAlternativeSyntax = 0;
2416 compo->u.complex->generic = (Z_Specification *)
2417 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2419 compo->u.complex->generic->which = Z_Schema_oid;
2420 compo->u.complex->generic->schema.oid = (Odr_oid *)
2421 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2423 if (!compo->u.complex->generic->schema.oid)
2425 /* OID wasn't a schema! Try record syntax instead. */
2427 compo->u.complex->generic->schema.oid = (Odr_oid *)
2428 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2430 if (elementSetName && *elementSetName)
2432 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2433 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2434 compo->u.complex->generic->elementSpec->which =
2435 Z_ElementSpec_elementSetName;
2436 compo->u.complex->generic->elementSpec->u.elementSetName =
2437 odr_strdup (c->odr_out, elementSetName);
2440 compo->u.complex->generic->elementSpec = 0;
2441 compo->u.complex->num_dbSpecific = 0;
2442 compo->u.complex->dbSpecific = 0;
2443 compo->u.complex->num_recordSyntax = 0;
2444 compo->u.complex->recordSyntax = 0;
2446 else if (elementSetName && *elementSetName)
2448 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2449 odr_malloc (c->odr_out, sizeof(*esn));
2450 Z_RecordComposition *compo = (Z_RecordComposition *)
2451 odr_malloc (c->odr_out, sizeof(*compo));
2453 esn->which = Z_ElementSetNames_generic;
2454 esn->u.generic = odr_strdup (c->odr_out, elementSetName);
2455 compo->which = Z_RecordComp_simple;
2456 compo->u.simple = esn;
2457 req->recordComposition = compo;
2459 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2460 return send_APDU (c, apdu);
2463 ZOOM_API(ZOOM_scanset)
2464 ZOOM_connection_scan (ZOOM_connection c, const char *start)
2467 ZOOM_query q = ZOOM_query_create();
2469 ZOOM_query_prefix (q, start);
2471 s = ZOOM_connection_scan1(c, q);
2472 ZOOM_query_destroy (q);
2477 ZOOM_API(ZOOM_scanset)
2478 ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query q)
2480 ZOOM_scanset scan = (ZOOM_scanset) xmalloc (sizeof(*scan));
2484 scan->connection = c;
2485 scan->odr = odr_createmem (ODR_DECODE);
2486 scan->options = ZOOM_options_create_with_parent (c->options);
2488 scan->scan_response = 0;
2491 * We need to check the query-type, so we can recognise CQL and
2492 * compile it into a form that we can use here. The ZOOM_query
2493 * structure has no explicit `type' member, but inspection of the
2494 * ZOOM_query_prefix() and ZOOM_query_cql() functions shows how
2495 * the structure is set up in each case.
2498 if (q->z_query->which == Z_Query_type_1) {
2499 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2500 c, q, q->query_string);
2501 start = q->query_string;
2502 } else if (q->z_query->which == Z_Query_type_104) {
2503 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2504 c, q, q->query_string);
2505 start = freeme = cql2pqf(c, q->query_string);
2509 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2510 c, q, q->query_string);
2514 scan->termListAndStartPoint =
2515 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2517 if (scan->termListAndStartPoint != 0)
2519 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_SCAN);
2520 task->u.scan.scan = scan;
2525 while (ZOOM_event (1, &c))
2533 ZOOM_scanset_destroy (ZOOM_scanset scan)
2538 if (scan->refcount == 0)
2540 odr_destroy (scan->odr);
2542 ZOOM_options_destroy (scan->options);
2547 static zoom_ret send_package (ZOOM_connection c)
2551 yaz_log(log_details, "%p send_package", c);
2553 return zoom_complete;
2554 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2556 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
2557 ZOOM_connection_put_event (c, event);
2559 c->buf_out = c->tasks->u.package->buf_out;
2560 c->len_out = c->tasks->u.package->len_out;
2565 static zoom_ret send_scan (ZOOM_connection c)
2568 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2569 Z_ScanRequest *req = apdu->u.scanRequest;
2571 yaz_log(log_details, "%p send_scan", c);
2573 return zoom_complete;
2574 assert (c->tasks->which == ZOOM_TASK_SCAN);
2575 scan = c->tasks->u.scan.scan;
2577 req->termListAndStartPoint = scan->termListAndStartPoint;
2578 req->attributeSet = scan->attributeSet;
2580 *req->numberOfTermsRequested =
2581 ZOOM_options_get_int(scan->options, "number", 10);
2583 req->preferredPositionInResponse =
2584 odr_intdup (c->odr_out,
2585 ZOOM_options_get_int(scan->options, "position", 1));
2588 odr_intdup (c->odr_out,
2589 ZOOM_options_get_int(scan->options, "stepSize", 0));
2591 req->databaseNames = set_DatabaseNames (c, scan->options,
2592 &req->num_databaseNames);
2594 return send_APDU (c, apdu);
2598 ZOOM_scanset_size (ZOOM_scanset scan)
2600 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2602 return scan->scan_response->entries->num_entries;
2605 ZOOM_API(const char *)
2606 ZOOM_scanset_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;
2621 if (t->term->which == Z_Term_general)
2623 term = (const char *) t->term->u.general->buf;
2624 *len = t->term->u.general->len;
2626 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2631 ZOOM_API(const char *)
2632 ZOOM_scanset_display_term (ZOOM_scanset scan, size_t pos,
2635 const char *term = 0;
2636 size_t noent = ZOOM_scanset_size (scan);
2637 Z_ScanResponse *res = scan->scan_response;
2643 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2645 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2649 term = t->displayTerm;
2650 *len = strlen(term);
2652 else if (t->term->which == Z_Term_general)
2654 term = (const char *) t->term->u.general->buf;
2655 *len = t->term->u.general->len;
2657 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2662 ZOOM_API(const char *)
2663 ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key)
2665 return ZOOM_options_get (scan->options, key);
2669 ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
2672 ZOOM_options_set (scan->options, key, val);
2675 static Z_APDU *create_es_package (ZOOM_package p, int type)
2678 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2679 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2681 *req->function = Z_ExtendedServicesRequest_create;
2683 str = ZOOM_options_get(p->options, "package-name");
2685 req->packageName = nmem_strdup (p->odr_out->mem, str);
2687 str = ZOOM_options_get(p->options, "user-id");
2689 req->userId = nmem_strdup (p->odr_out->mem, str);
2691 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2694 str = ZOOM_options_get(p->options, "function");
2697 if (!strcmp (str, "create"))
2699 if (!strcmp (str, "delete"))
2701 if (!strcmp (str, "modify"))
2707 static const char *ill_array_lookup (void *clientData, const char *idx)
2709 ZOOM_package p = (ZOOM_package) clientData;
2710 return ZOOM_options_get (p->options, idx+4);
2713 static Z_External *encode_ill_request (ZOOM_package p)
2715 ODR out = p->odr_out;
2718 struct ill_get_ctl ctl;
2720 ctl.odr = p->odr_out;
2722 ctl.f = ill_array_lookup;
2724 req = ill_get_ILLRequest(&ctl, "ill", 0);
2726 if (!ill_Request (out, &req, 0, 0))
2728 int ill_request_size;
2729 char *ill_request_buf = odr_getbuf (out, &ill_request_size, 0);
2730 if (ill_request_buf)
2731 odr_setbuf (out, ill_request_buf, ill_request_size, 1);
2737 int illRequest_size = 0;
2738 char *illRequest_buf = odr_getbuf (out, &illRequest_size, 0);
2740 oid.proto = PROTO_GENERAL;
2741 oid.oclass = CLASS_GENERAL;
2742 oid.value = VAL_ISO_ILL_1;
2744 r = (Z_External *) odr_malloc (out, sizeof(*r));
2745 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2746 r->indirect_reference = 0;
2748 r->which = Z_External_single;
2750 r->u.single_ASN1_type =
2751 odr_create_Odr_oct(out,
2752 (unsigned char *)illRequest_buf,
2758 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2760 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc (p->odr_out, sizeof(*req));
2763 req->which = Z_IOItemOrder_esRequest;
2764 req->u.esRequest = (Z_IORequest *)
2765 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2767 /* to keep part ... */
2768 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2769 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2770 req->u.esRequest->toKeep->supplDescription = 0;
2771 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2772 odr_malloc (p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2774 str = ZOOM_options_get(p->options, "contact-name");
2775 req->u.esRequest->toKeep->contact->name = str ?
2776 nmem_strdup (p->odr_out->mem, str) : 0;
2778 str = ZOOM_options_get(p->options, "contact-phone");
2779 req->u.esRequest->toKeep->contact->phone = str ?
2780 nmem_strdup (p->odr_out->mem, str) : 0;
2782 str = ZOOM_options_get(p->options, "contact-email");
2783 req->u.esRequest->toKeep->contact->email = str ?
2784 nmem_strdup (p->odr_out->mem, str) : 0;
2786 req->u.esRequest->toKeep->addlBilling = 0;
2788 /* not to keep part ... */
2789 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2790 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2792 str = ZOOM_options_get(p->options, "itemorder-setname");
2797 req->u.esRequest->notToKeep->resultSetItem = 0;
2800 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2801 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2803 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2804 nmem_strdup (p->odr_out->mem, str);
2805 req->u.esRequest->notToKeep->resultSetItem->item =
2806 (int *) odr_malloc(p->odr_out, sizeof(int));
2808 str = ZOOM_options_get(p->options, "itemorder-item");
2809 *req->u.esRequest->notToKeep->resultSetItem->item =
2810 (str ? atoi(str) : 1);
2812 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2817 Z_APDU *create_admin_package(ZOOM_package p, int type,
2818 Z_ESAdminOriginPartToKeep **toKeepP,
2819 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2821 Z_APDU *apdu = create_es_package (p, VAL_ADMINSERVICE);
2824 Z_ESAdminOriginPartToKeep *toKeep;
2825 Z_ESAdminOriginPartNotToKeep *notToKeep;
2826 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2827 const char *first_db = "Default";
2829 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2833 r->direct_reference =
2834 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2837 r->indirect_reference = 0;
2838 r->which = Z_External_ESAdmin;
2840 r->u.adminService = (Z_Admin *)
2841 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2842 r->u.adminService->which = Z_Admin_esRequest;
2843 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2844 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2846 toKeep = r->u.adminService->u.esRequest->toKeep =
2847 (Z_ESAdminOriginPartToKeep *)
2848 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2849 toKeep->which = type;
2850 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2851 toKeep->u.create = odr_nullval();
2852 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2854 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2855 (Z_ESAdminOriginPartNotToKeep *)
2856 odr_malloc(p->odr_out,
2857 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2858 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
2859 notToKeep->u.recordsWillFollow = odr_nullval();
2863 *notToKeepP = notToKeep;
2868 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
2870 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
2871 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2872 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
2873 const char *doc = ZOOM_options_get(p->options, "doc");
2878 req->taskSpecificParameters = ext;
2879 ext->direct_reference = req->packageType;
2880 ext->descriptor = 0;
2881 ext->indirect_reference = 0;
2883 ext->which = Z_External_octet;
2884 ext->u.single_ASN1_type =
2885 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
2890 static Z_APDU *create_update_package(ZOOM_package p)
2893 const char *first_db = "Default";
2895 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2896 const char *action = ZOOM_options_get(p->options, "action");
2897 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
2898 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
2899 const char *record_buf = ZOOM_options_get(p->options, "record");
2900 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
2901 int syntax_oid = VAL_NONE;
2905 syntax_oid = oid_getvalbyname(syntax_str);
2908 record_buf = "void";
2909 syntax_oid = VAL_SUTRS;
2911 if (syntax_oid == VAL_NONE)
2912 syntax_oid = VAL_TEXT_XML;
2918 action = "specialUpdate";
2920 if (!strcmp(action, "recordInsert"))
2921 action_no = Z_IUOriginPartToKeep_recordInsert;
2922 else if (!strcmp(action, "recordReplace"))
2923 action_no = Z_IUOriginPartToKeep_recordReplace;
2924 else if (!strcmp(action, "recordDelete"))
2925 action_no = Z_IUOriginPartToKeep_recordDelete;
2926 else if (!strcmp(action, "elementUpdate"))
2927 action_no = Z_IUOriginPartToKeep_elementUpdate;
2928 else if (!strcmp(action, "specialUpdate"))
2929 action_no = Z_IUOriginPartToKeep_specialUpdate;
2933 apdu = create_es_package (p, VAL_DBUPDATE);
2936 Z_IUOriginPartToKeep *toKeep;
2937 Z_IUSuppliedRecords *notToKeep;
2938 Z_External *r = (Z_External *)
2939 odr_malloc (p->odr_out, sizeof(*r));
2941 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2943 r->direct_reference =
2944 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2947 r->which = Z_External_update;
2948 r->indirect_reference = 0;
2949 r->u.update = (Z_IUUpdate *)
2950 odr_malloc(p->odr_out, sizeof(*r->u.update));
2952 r->u.update->which = Z_IUUpdate_esRequest;
2953 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
2954 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
2955 toKeep = r->u.update->u.esRequest->toKeep =
2956 (Z_IUOriginPartToKeep *)
2957 odr_malloc(p->odr_out, sizeof(*toKeep));
2959 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2961 toKeep->elementSetName = 0;
2962 toKeep->actionQualifier = 0;
2963 toKeep->action = odr_intdup(p->odr_out, action_no);
2965 notToKeep = r->u.update->u.esRequest->notToKeep =
2966 (Z_IUSuppliedRecords *)
2967 odr_malloc(p->odr_out, sizeof(*notToKeep));
2969 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
2970 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
2971 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
2972 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
2973 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
2976 notToKeep->elements[0]->u.opaque =
2977 odr_create_Odr_oct(p->odr_out,
2978 (const unsigned char *) recordIdOpaque,
2979 strlen(recordIdOpaque));
2981 else if (recordIdNumber)
2983 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
2985 notToKeep->elements[0]->u.number =
2986 odr_intdup(p->odr_out, atoi(recordIdNumber));
2989 notToKeep->elements[0]->u.opaque = 0;
2990 notToKeep->elements[0]->supplementalId = 0;
2991 notToKeep->elements[0]->correlationInfo = 0;
2992 notToKeep->elements[0]->record =
2993 z_ext_record(p->odr_out, syntax_oid,
2994 record_buf, strlen(record_buf));
2998 ODR print = odr_createmem(ODR_PRINT);
3000 z_APDU(print, &apdu, 0, 0);
3007 ZOOM_package_send (ZOOM_package p, const char *type)
3014 odr_reset (p->odr_out);
3017 if (!strcmp(type, "itemorder"))
3019 apdu = create_es_package (p, VAL_ITEMORDER);
3022 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
3024 r->direct_reference =
3025 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3028 r->which = Z_External_itemOrder;
3029 r->indirect_reference = 0;
3030 r->u.itemOrder = encode_item_order (p);
3032 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3035 else if (!strcmp(type, "create")) /* create database */
3037 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3040 else if (!strcmp(type, "drop")) /* drop database */
3042 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3045 else if (!strcmp(type, "commit")) /* commit changes */
3047 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3050 else if (!strcmp(type, "update")) /* update record(s) */
3052 apdu = create_update_package(p);
3054 else if (!strcmp(type, "xmlupdate"))
3056 apdu = create_xmlupdate_package(p);
3060 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3064 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_PACKAGE);
3065 task->u.package = p;
3066 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3067 p->buf_out = (char *) xmalloc (p->len_out);
3068 memcpy (p->buf_out, buf, p->len_out);
3073 while (ZOOM_event (1, &c))
3080 ZOOM_API(ZOOM_package)
3081 ZOOM_connection_package (ZOOM_connection c, ZOOM_options options)
3083 ZOOM_package p = (ZOOM_package) xmalloc (sizeof(*p));
3086 p->odr_out = odr_createmem (ODR_ENCODE);
3087 p->options = ZOOM_options_create_with_parent2 (options, c->options);
3095 ZOOM_package_destroy(ZOOM_package p)
3100 if (p->refcount == 0)
3102 odr_destroy (p->odr_out);
3105 ZOOM_options_destroy (p->options);
3110 ZOOM_API(const char *)
3111 ZOOM_package_option_get (ZOOM_package p, const char *key)
3113 return ZOOM_options_get (p->options, key);
3118 ZOOM_package_option_set (ZOOM_package p, const char *key,
3121 ZOOM_options_set (p->options, key, val);
3124 static int ZOOM_connection_exec_task (ZOOM_connection c)
3126 ZOOM_task task = c->tasks;
3127 zoom_ret ret = zoom_complete;
3131 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3132 c, task->which, task->running);
3133 if (c->error != ZOOM_ERROR_NONE)
3135 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3136 "removing tasks because of error = %d", c, c->error);
3137 ZOOM_connection_remove_tasks (c);
3142 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3143 "task already running", c);
3147 ret = zoom_complete;
3148 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3150 switch (task->which)
3152 case ZOOM_TASK_SEARCH:
3153 if (c->proto == PROTO_HTTP)
3154 ret = ZOOM_connection_srw_send_search(c);
3156 ret = ZOOM_connection_send_search(c);
3158 case ZOOM_TASK_RETRIEVE:
3159 if (c->proto == PROTO_HTTP)
3160 ret = ZOOM_connection_srw_send_search(c);
3162 ret = send_present (c);
3164 case ZOOM_TASK_CONNECT:
3165 ret = do_connect(c);
3167 case ZOOM_TASK_SCAN:
3170 case ZOOM_TASK_PACKAGE:
3171 ret = send_package(c);
3173 case ZOOM_TASK_SORT:
3174 c->tasks->u.sort.resultset->r_sort_spec =
3175 c->tasks->u.sort.q->sort_spec;
3176 ret = send_sort(c, c->tasks->u.sort.resultset);
3182 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3183 "remove tasks because no connection exist", c);
3184 ZOOM_connection_remove_tasks (c);
3186 if (ret == zoom_complete)
3188 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3189 "task removed (complete)", c);
3190 ZOOM_connection_remove_task (c);
3193 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3198 static zoom_ret send_sort_present (ZOOM_connection c)
3200 zoom_ret r = zoom_complete;
3202 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3203 r = send_sort (c, c->tasks->u.search.resultset);
3204 if (r == zoom_complete)
3205 r = send_present (c);
3209 static int es_response (ZOOM_connection c,
3210 Z_ExtendedServicesResponse *res)
3212 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3214 if (res->diagnostics && res->num_diagnostics > 0)
3215 response_diag(c, res->diagnostics[0]);
3216 if (res->taskPackage &&
3217 res->taskPackage->which == Z_External_extendedService)
3219 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3220 Odr_oct *id = taskPackage->targetReference;
3223 ZOOM_options_setl (c->tasks->u.package->options,
3224 "targetReference", (char*) id->buf, id->len);
3226 if (res->taskPackage &&
3227 res->taskPackage->which == Z_External_octet)
3229 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3230 ZOOM_options_setl (c->tasks->u.package->options,
3231 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3236 static void interpret_init_diag(ZOOM_connection c,
3237 Z_DiagnosticFormat *diag)
3241 Z_DiagnosticFormat_s *ds = diag->elements[0];
3242 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3243 response_default_diag(c, ds->u.defaultDiagRec);
3248 static void interpret_otherinformation_field(ZOOM_connection c,
3249 Z_OtherInformation *ui)
3252 for (i = 0; i < ui->num_elements; i++)
3254 Z_OtherInformationUnit *unit = ui->list[i];
3255 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3256 unit->information.externallyDefinedInfo &&
3257 unit->information.externallyDefinedInfo->which ==
3260 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3265 static void recv_apdu (ZOOM_connection c, Z_APDU *apdu)
3267 Z_InitResponse *initrs;
3270 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3273 case Z_APDU_initResponse:
3274 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3275 initrs = apdu->u.initResponse;
3276 ZOOM_connection_option_set(c, "serverImplementationId",
3277 initrs->implementationId ?
3278 initrs->implementationId : "");
3279 ZOOM_connection_option_set(c, "serverImplementationName",
3280 initrs->implementationName ?
3281 initrs->implementationName : "");
3282 ZOOM_connection_option_set(c, "serverImplementationVersion",
3283 initrs->implementationVersion ?
3284 initrs->implementationVersion : "");
3285 /* Set the three old options too, for old applications */
3286 ZOOM_connection_option_set(c, "targetImplementationId",
3287 initrs->implementationId ?
3288 initrs->implementationId : "");
3289 ZOOM_connection_option_set(c, "targetImplementationName",
3290 initrs->implementationName ?
3291 initrs->implementationName : "");
3292 ZOOM_connection_option_set(c, "targetImplementationVersion",
3293 initrs->implementationVersion ?
3294 initrs->implementationVersion : "");
3295 if (!*initrs->result)
3297 Z_External *uif = initrs->userInformationField;
3299 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3301 if (uif && uif->which == Z_External_userInfo1)
3302 interpret_otherinformation_field(c, uif->u.userInfo1);
3307 yaz_oi_get_string_oidval (&apdu->u.initResponse->otherInfo,
3309 xfree (c->cookie_in);
3312 c->cookie_in = xstrdup(cookie);
3313 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3314 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3315 c->support_named_resultsets = 1;
3318 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3319 ZOOM_connection_remove_task (c);
3321 ZOOM_connection_exec_task (c);
3323 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3325 NMEM tmpmem = nmem_create();
3326 Z_CharSetandLanguageNegotiation *p =
3327 yaz_get_charneg_record(initrs->otherInfo);
3331 char *charset = NULL, *lang = NULL;
3334 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3335 yaz_log(log_details, "%p recv_apdu target accepted: "
3336 "charset %s, language %s, select %d",
3338 charset ? charset : "none", lang ? lang : "none", sel);
3340 ZOOM_connection_option_set (c, "negotiation-charset",
3343 ZOOM_connection_option_set (c, "negotiation-lang",
3346 ZOOM_connection_option_set (
3347 c, "negotiation-charset-in-effect-for-records",
3348 (sel != 0) ? "1" : "0");
3349 nmem_destroy(tmpmem);
3353 case Z_APDU_searchResponse:
3354 yaz_log(log_api, "%p recv_apdu Search response", c);
3355 handle_search_response (c, apdu->u.searchResponse);
3356 if (send_sort_present (c) == zoom_complete)
3357 ZOOM_connection_remove_task (c);
3359 case Z_APDU_presentResponse:
3360 yaz_log(log_api, "%p recv_apdu Present response", c);
3361 handle_present_response (c, apdu->u.presentResponse);
3362 if (send_present (c) == zoom_complete)
3363 ZOOM_connection_remove_task (c);
3365 case Z_APDU_sortResponse:
3366 yaz_log(log_api, "%p recv_apdu Sort response", c);
3367 sort_response (c, apdu->u.sortResponse);
3368 if (send_present (c) == zoom_complete)
3369 ZOOM_connection_remove_task (c);
3371 case Z_APDU_scanResponse:
3372 yaz_log(log_api, "%p recv_apdu Scan response", c);
3373 scan_response (c, apdu->u.scanResponse);
3374 ZOOM_connection_remove_task (c);
3376 case Z_APDU_extendedServicesResponse:
3377 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3378 es_response (c, apdu->u.extendedServicesResponse);
3379 ZOOM_connection_remove_task (c);
3382 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3383 if (c->reconnect_ok)
3386 c->tasks->running = 0;
3387 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3391 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3396 yaz_log(log_api, "%p Received unknown PDU", c);
3397 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3403 static void handle_srw_response(ZOOM_connection c,
3404 Z_SRW_searchRetrieveResponse *res)
3406 ZOOM_resultset resultset = 0;
3414 if (c->tasks->which == ZOOM_TASK_SEARCH)
3415 resultset = c->tasks->u.search.resultset;
3416 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
3417 resultset = c->tasks->u.retrieve.resultset;
3421 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3422 ZOOM_connection_put_event(c, event);
3424 resultset->size = 0;
3426 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3428 if (res->numberOfRecords)
3429 resultset->size = *res->numberOfRecords;
3431 for (i = 0; i<res->num_records; i++)
3435 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3436 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3438 if (res->records[i].recordPosition &&
3439 *res->records[i].recordPosition > 0)
3440 pos = *res->records[i].recordPosition - 1;
3442 pos = resultset->start + i;
3444 npr->databaseName = 0;
3445 npr->which = Z_NamePlusRecord_databaseRecord;
3446 npr->u.databaseRecord = (Z_External *)
3447 odr_malloc(c->odr_in, sizeof(Z_External));
3448 npr->u.databaseRecord->descriptor = 0;
3449 npr->u.databaseRecord->direct_reference =
3450 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3451 npr->u.databaseRecord->which = Z_External_octet;
3453 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3454 odr_malloc(c->odr_in, sizeof(Odr_oct));
3455 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3456 res->records[i].recordData_buf;
3457 npr->u.databaseRecord->u.octet_aligned->len =
3458 npr->u.databaseRecord->u.octet_aligned->size =
3459 res->records[i].recordData_len;
3460 record_cache_add (resultset, npr, pos);
3462 if (res->num_diagnostics > 0)
3464 const char *uri = res->diagnostics[0].uri;
3469 if ((cp = strrchr(uri, '/')))
3471 set_dset_error(c, code, uri,
3472 res->diagnostics[0].details, 0);
3475 nmem = odr_extract_mem(c->odr_in);
3476 nmem_transfer(resultset->odr->mem, nmem);
3482 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3485 const char *content_type = z_HTTP_header_lookup(hres->headers,
3487 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3490 yaz_log(log_details, "%p handle_http", c);
3492 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3494 Z_SOAP *soap_package = 0;
3496 Z_SOAP_Handler soap_handlers[2] = {
3497 {"http://www.loc.gov/zing/srw/", 0,
3498 (Z_SOAP_fun) yaz_srw_codec},
3501 ret = z_soap_codec(o, &soap_package,
3502 &hres->content_buf, &hres->content_len,
3504 if (!ret && soap_package->which == Z_SOAP_generic &&
3505 soap_package->u.generic->no == 0)
3507 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3508 if (sr->which == Z_SRW_searchRetrieve_response)
3509 handle_srw_response(c, sr->u.response);
3513 else if (!ret && (soap_package->which == Z_SOAP_fault
3514 || soap_package->which == Z_SOAP_error))
3516 set_HTTP_error(c, hres->code,
3517 soap_package->u.fault->fault_code,
3518 soap_package->u.fault->fault_string);
3525 if (hres->code != 200)
3526 set_HTTP_error(c, hres->code, 0, 0);
3528 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3531 ZOOM_connection_remove_task(c);
3532 if (!strcmp(hres->version, "1.0"))
3534 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3535 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3540 /* HTTP 1.1: only if no close we stay alive .. */
3541 if (connection_head && !strcmp(connection_head, "close"))
3547 static int do_read (ZOOM_connection c)
3552 event = ZOOM_Event_create (ZOOM_EVENT_RECV_DATA);
3553 ZOOM_connection_put_event (c, event);
3555 r = cs_get (c->cs, &c->buf_in, &c->len_in);
3556 more = cs_more(c->cs);
3557 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3562 if (c->reconnect_ok)
3565 c->reconnect_ok = 0;
3566 yaz_log(log_details, "%p do_read reconnect read", c);
3567 c->tasks->running = 0;
3568 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3572 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3581 odr_reset (c->odr_in);
3582 odr_setbuf (c->odr_in, c->buf_in, r, 0);
3583 event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);
3584 ZOOM_connection_put_event (c, event);
3586 if (!z_GDU (c->odr_in, &gdu, 0, 0))
3589 int err = odr_geterrorx(c->odr_in, &x);
3591 const char *element = odr_getelement(c->odr_in);
3592 sprintf (msg, "ODR code %d:%d element=%-20s",
3593 err, x, element ? element : "<unknown>");
3594 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3597 else if (gdu->which == Z_GDU_Z3950)
3598 recv_apdu (c, gdu->u.z3950);
3599 else if (gdu->which == Z_GDU_HTTP_Response)
3602 handle_http (c, gdu->u.HTTP_Response);
3604 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3608 c->reconnect_ok = 0;
3613 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out)
3618 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3619 ZOOM_connection_put_event (c, event);
3621 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3622 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3624 yaz_log(log_details, "%p do_write_ex write failed", c);
3625 if (c->reconnect_ok)
3628 c->reconnect_ok = 0;
3629 yaz_log(log_details, "%p do_write_ex reconnect write", c);
3630 c->tasks->running = 0;
3631 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3632 return zoom_pending;
3634 if (c->state == STATE_CONNECTING)
3635 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3637 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3639 return zoom_complete;
3643 c->mask = ZOOM_SELECT_EXCEPT;
3644 if (c->cs->io_pending & CS_WANT_WRITE)
3645 c->mask += ZOOM_SELECT_WRITE;
3646 if (c->cs->io_pending & CS_WANT_READ)
3647 c->mask += ZOOM_SELECT_READ;
3648 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3653 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3654 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3657 return zoom_pending;
3660 static zoom_ret do_write(ZOOM_connection c)
3662 return do_write_ex (c, c->buf_out, c->len_out);
3666 ZOOM_API(const char *)
3667 ZOOM_connection_option_get (ZOOM_connection c, const char *key)
3669 return ZOOM_options_get (c->options, key);
3672 ZOOM_API(const char *)
3673 ZOOM_connection_option_getl (ZOOM_connection c, const char *key, int *lenp)
3675 return ZOOM_options_getl (c->options, key, lenp);
3679 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
3682 ZOOM_options_set (c->options, key, val);
3686 ZOOM_connection_option_setl (ZOOM_connection c, const char *key,
3687 const char *val, int len)
3689 ZOOM_options_setl (c->options, key, val, len);
3692 ZOOM_API(const char *)
3693 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key)
3695 return ZOOM_options_get (r->options, key);
3699 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key,
3702 ZOOM_options_set (r->options, key, val);
3707 ZOOM_connection_errcode (ZOOM_connection c)
3709 return ZOOM_connection_error (c, 0, 0);
3712 ZOOM_API(const char *)
3713 ZOOM_connection_errmsg (ZOOM_connection c)
3716 ZOOM_connection_error (c, &msg, 0);
3720 ZOOM_API(const char *)
3721 ZOOM_connection_addinfo (ZOOM_connection c)
3723 const char *addinfo;
3724 ZOOM_connection_error (c, 0, &addinfo);
3728 ZOOM_API(const char *)
3729 ZOOM_connection_diagset (ZOOM_connection c)
3731 const char *diagset;
3732 ZOOM_connection_error_x (c, 0, 0, &diagset);
3736 ZOOM_API(const char *)
3737 ZOOM_diag_str (int error)
3741 case ZOOM_ERROR_NONE:
3743 case ZOOM_ERROR_CONNECT:
3744 return "Connect failed";
3745 case ZOOM_ERROR_MEMORY:
3746 return "Out of memory";
3747 case ZOOM_ERROR_ENCODE:
3748 return "Encoding failed";
3749 case ZOOM_ERROR_DECODE:
3750 return "Decoding failed";
3751 case ZOOM_ERROR_CONNECTION_LOST:
3752 return "Connection lost";
3753 case ZOOM_ERROR_INIT:
3754 return "Init rejected";
3755 case ZOOM_ERROR_INTERNAL:
3756 return "Internal failure";
3757 case ZOOM_ERROR_TIMEOUT:
3759 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3760 return "Unsupported protocol";
3761 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3762 return "Unsupported query type";
3763 case ZOOM_ERROR_INVALID_QUERY:
3764 return "Invalid query";
3765 case ZOOM_ERROR_CQL_PARSE:
3766 return "CQL parsing error";
3767 case ZOOM_ERROR_CQL_TRANSFORM:
3768 return "CQL transformation error";
3770 return diagbib1_str (error);
3775 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
3776 const char **addinfo, const char **diagset)
3778 int error = c->error;
3781 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3782 *cp = ZOOM_diag_str(error);
3783 else if (!strcmp(c->diagset, "HTTP"))
3784 *cp = z_HTTP_errmsg(c->error);
3785 else if (!strcmp(c->diagset, "Bib-1"))
3786 *cp = ZOOM_diag_str(error);
3787 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3788 *cp = yaz_diag_srw_str(c->error);
3790 *cp = "Unknown error and diagnostic set";
3793 *addinfo = c->addinfo ? c->addinfo : "";
3795 *diagset = c->diagset ? c->diagset : "";
3800 ZOOM_connection_error (ZOOM_connection c, const char **cp,
3801 const char **addinfo)
3803 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3806 static int ZOOM_connection_do_io(ZOOM_connection c, int mask)
3808 ZOOM_Event event = 0;
3809 int r = cs_look(c->cs);
3810 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
3815 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3816 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3818 ZOOM_connection_put_event (c, event);
3820 else if (r == CS_CONNECT)
3823 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3825 ret = cs_rcvconnect (c->cs);
3826 yaz_log(log_details, "%p ZOOM_connection_do_io "
3827 "cs_rcvconnect returned %d", c, ret);
3830 c->mask = ZOOM_SELECT_EXCEPT;
3831 if (c->cs->io_pending & CS_WANT_WRITE)
3832 c->mask += ZOOM_SELECT_WRITE;
3833 if (c->cs->io_pending & CS_WANT_READ)
3834 c->mask += ZOOM_SELECT_READ;
3835 ZOOM_connection_put_event (c, event);
3839 ZOOM_connection_put_event (c, event);
3841 if (c->proto == PROTO_Z3950)
3842 ZOOM_connection_send_init(c);
3845 /* no init request for SRW .. */
3846 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3847 ZOOM_connection_remove_task (c);
3849 ZOOM_connection_exec_task (c);
3851 c->state = STATE_ESTABLISHED;
3855 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3857 ZOOM_connection_put_event (c, event);
3862 if (mask & ZOOM_SELECT_READ)
3864 if (c->cs && (mask & ZOOM_SELECT_WRITE))
3871 ZOOM_connection_last_event(ZOOM_connection cs)
3874 return ZOOM_EVENT_NONE;
3875 return cs->last_event;
3879 ZOOM_event (int no, ZOOM_connection *cs)
3881 int timeout = 30; /* default timeout in seconds */
3882 int timeout_set = 0; /* whether it was overriden at all */
3884 struct pollfd pollfds[1024];
3885 ZOOM_connection poll_cs[1024];
3888 fd_set input, output, except;
3893 for (i = 0; i<no; i++)
3895 ZOOM_connection c = cs[i];
3897 if (c && (event = ZOOM_connection_get_event(c)))
3899 ZOOM_Event_destroy (event);
3903 for (i = 0; i<no; i++)
3905 ZOOM_connection c = cs[i];
3907 if (c && ZOOM_connection_exec_task (c))
3909 if ((event = ZOOM_connection_get_event(c)))
3911 ZOOM_Event_destroy (event);
3924 for (i = 0; i<no; i++)
3926 ZOOM_connection c = cs[i];
3932 fd = z3950_connection_socket(c);
3933 mask = z3950_connection_mask(c);
3940 /* -1 is used for indefinite timeout (no timeout), so -2 here. */
3941 this_timeout = ZOOM_options_get_int (c->options, "timeout", -2);
3942 if (this_timeout != -2)
3944 /* ensure the minimum timeout is used */
3946 timeout = this_timeout;
3947 else if (this_timeout != -1 && this_timeout < timeout)
3948 timeout = this_timeout;
3954 short poll_events = 0;
3956 if (mask & ZOOM_SELECT_READ)
3957 poll_events += POLLIN;
3958 if (mask & ZOOM_SELECT_WRITE)
3959 poll_events += POLLOUT;
3960 if (mask & ZOOM_SELECT_EXCEPT)
3961 poll_events += POLLERR;
3962 pollfds[nfds].fd = fd;
3963 pollfds[nfds].events = poll_events;
3964 pollfds[nfds].revents = 0;
3969 if (mask & ZOOM_SELECT_READ)
3971 FD_SET (fd, &input);
3974 if (mask & ZOOM_SELECT_WRITE)
3976 FD_SET (fd, &output);
3979 if (mask & ZOOM_SELECT_EXCEPT)
3981 FD_SET (fd, &except);
3990 r = poll (pollfds, nfds, (timeout == -1 ? -1 : timeout * 1000));
3991 for (i = 0; i<nfds; i++)
3993 ZOOM_connection c = poll_cs[i];
3997 if (pollfds[i].revents & POLLIN)
3998 mask += ZOOM_SELECT_READ;
3999 if (pollfds[i].revents & POLLOUT)
4000 mask += ZOOM_SELECT_WRITE;
4001 if (pollfds[i].revents & POLLERR)
4002 mask += ZOOM_SELECT_EXCEPT;
4004 ZOOM_connection_do_io(c, mask);
4006 else if (r == 0 && c->mask)
4008 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4009 /* timeout and this connection was waiting */
4010 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4012 ZOOM_connection_put_event(c, event);
4016 tv.tv_sec = timeout;
4018 r = select (max_fd+1, &input, &output, &except, (timeout == -1 ? 0 : &tv));
4019 for (i = 0; i<no; i++)
4021 ZOOM_connection c = cs[i];
4026 fd = z3950_connection_socket(c);
4030 /* no timeout and real socket */
4031 if (FD_ISSET(fd, &input))
4032 mask += ZOOM_SELECT_READ;
4033 if (FD_ISSET(fd, &output))
4034 mask += ZOOM_SELECT_WRITE;
4035 if (FD_ISSET(fd, &except))
4036 mask += ZOOM_SELECT_EXCEPT;
4038 ZOOM_connection_do_io(c, mask);
4040 if (r == 0 && c->mask)
4042 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4043 /* timeout and this connection was waiting */
4044 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4046 ZOOM_connection_put_event(c, event);
4050 for (i = 0; i<no; i++)
4052 ZOOM_connection c = cs[i];
4054 if (c && (event = ZOOM_connection_get_event(c)))
4056 ZOOM_Event_destroy (event);
4065 * Returns an xmalloc()d string containing RPN that corresponds to the
4066 * CQL passed in. On error, sets the Connection object's error state
4067 * and returns a null pointer.
4068 * ### We could cache CQL parser and/or transformer in Connection.
4070 static char *cql2pqf(ZOOM_connection c, const char *cql)
4074 struct cql_node *node;
4075 const char *cqlfile;
4076 static cql_transform_t trans;
4079 parser = cql_parser_create();
4080 if ((error = cql_parser_string(parser, cql)) != 0) {
4081 cql_parser_destroy(parser);
4082 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4086 node = cql_parser_result(parser);
4087 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4089 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4091 cql_parser_destroy(parser);
4092 cql_node_destroy(node);
4093 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4097 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4099 cql_parser_destroy(parser);
4100 cql_node_destroy(node);
4101 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4102 cqlfile, strerror(errno));
4103 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4107 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4108 cql_parser_destroy(parser);
4109 cql_node_destroy(node);
4112 const char *addinfo;
4113 error = cql_transform_error(trans, &addinfo);
4114 cql_transform_close(trans);
4115 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4116 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4120 cql_transform_close(trans);
4121 return xstrdup(pqfbuf);
4128 * indent-tabs-mode: nil
4130 * vim: shiftwidth=4 tabstop=8 expandtab