2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.81 2006-07-06 10:17:54 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>
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);
60 static int log_level_initialized = 0;
61 if (!log_level_initialized)
63 log_api = yaz_log_module_level("zoom");
64 log_details = yaz_log_module_level("zoomdetails");
65 log_level_initialized = 1;
69 static ZOOM_Event ZOOM_Event_create (int kind)
71 ZOOM_Event event = (ZOOM_Event) xmalloc (sizeof(*event));
75 yaz_log(log_details, "ZOOM_event_create(%d)", kind);
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)
568 ZOOM_connection freeme = 0;
570 yaz_log(log_details, "%p ZOOM_query_cql2rpn str=%s conn=%p", s, str, conn);
572 conn = freeme = ZOOM_connection_create(0);
574 rpn = cql2pqf(conn, str);
576 ZOOM_connection_destroy(freeme);
580 ret = ZOOM_query_prefix(s, rpn);
586 * Analogous in every way to ZOOM_query_cql2rpn(), except that there
587 * is no analogous ZOOM_query_ccl() that just sends uninterpreted CCL
588 * to the server, as the YAZ GFS doesn't know how to handle this.
591 ZOOM_query_ccl2rpn(ZOOM_query s, const char *str, const char *config,
592 int *ccl_error, const char **error_string,
596 struct ccl_rpn_node *rpn;
597 CCL_bibset bibset = ccl_qual_mk();
600 ccl_qual_buf(bibset, config);
602 rpn = ccl_find_str(bibset, str, ccl_error, error_pos);
605 *error_string = ccl_err_msg(*ccl_error);
610 WRBUF wr = wrbuf_alloc();
613 ret = ZOOM_query_prefix(s, wrbuf_buf(wr));
616 ccl_qual_rm(&bibset);
621 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
623 s->sort_spec = yaz_sort_spec (s->odr, criteria);
626 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
630 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
634 static zoom_ret do_write(ZOOM_connection c);
637 ZOOM_connection_destroy(ZOOM_connection c)
642 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
645 for (r = c->resultsets; r; r = r->next)
651 odr_destroy (c->odr_in);
652 odr_destroy (c->odr_out);
653 ZOOM_options_destroy (c->options);
654 ZOOM_connection_remove_tasks (c);
655 xfree (c->host_port);
660 xfree (c->cookie_out);
661 xfree (c->cookie_in);
662 xfree (c->client_IP);
666 void ZOOM_resultset_addref (ZOOM_resultset r)
671 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
676 ZOOM_resultset ZOOM_resultset_create ()
679 ZOOM_resultset r = (ZOOM_resultset) xmalloc (sizeof(*r));
683 yaz_log(log_details, "%p ZOOM_resultset_create", r);
686 r->odr = odr_createmem (ODR_ENCODE);
693 for (i = 0; i<RECORD_HASH_SIZE; i++)
694 r->record_hash[i] = 0;
702 ZOOM_API(ZOOM_resultset)
703 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
706 ZOOM_query s = ZOOM_query_create();
708 ZOOM_query_prefix (s, q);
710 r = ZOOM_connection_search (c, s);
711 ZOOM_query_destroy (s);
715 ZOOM_API(ZOOM_resultset)
716 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
718 ZOOM_resultset r = ZOOM_resultset_create ();
722 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
723 r->r_sort_spec = q->sort_spec;
726 r->options = ZOOM_options_create_with_parent(c->options);
728 r->start = ZOOM_options_get_int(r->options, "start", 0);
729 r->count = ZOOM_options_get_int(r->options, "count", 0);
731 /* If "presentChunk" is defined use that; otherwise "step" */
732 const char *cp = ZOOM_options_get (r->options, "presentChunk");
733 r->step = ZOOM_options_get_int(r->options,
734 (cp != 0 ? "presentChunk": "step"), 0);
736 r->piggyback = ZOOM_options_get_bool (r->options, "piggyback", 1);
737 cp = ZOOM_options_get (r->options, "setname");
739 r->setname = xstrdup(cp);
740 cp = ZOOM_options_get (r->options, "schema");
742 r->schema = xstrdup(cp);
746 r->next = c->resultsets;
749 if (c->host_port && c->proto == PROTO_HTTP)
753 yaz_log(log_details, "ZOOM_connection_search: no comstack");
754 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
758 yaz_log(log_details, "ZOOM_connection_search: reconnect");
763 task = ZOOM_connection_add_task (c, ZOOM_TASK_SEARCH);
764 task->u.search.resultset = r;
765 ZOOM_resultset_addref (r);
771 while (ZOOM_event (1, &c))
778 * This is the old result-set sorting API, which is maintained only
779 * for the sake of binary compatibility. There is no reason ever to
780 * use this rather than ZOOM_resultset_sort1().
783 ZOOM_resultset_sort(ZOOM_resultset r,
784 const char *sort_type, const char *sort_spec)
786 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
790 ZOOM_resultset_sort1(ZOOM_resultset r,
791 const char *sort_type, const char *sort_spec)
793 ZOOM_connection c = r->connection;
797 newq = ZOOM_query_create();
798 if (ZOOM_query_sortby(newq, sort_spec) < 0)
801 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
802 r, r, sort_type, sort_spec);
806 if (c->host_port && c->proto == PROTO_HTTP)
810 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
811 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
815 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
821 ZOOM_resultset_cache_reset(r);
822 task = ZOOM_connection_add_task (c, ZOOM_TASK_SORT);
823 task->u.sort.resultset = r;
824 task->u.sort.q = newq;
826 ZOOM_resultset_addref (r);
830 while (ZOOM_event (1, &c))
838 ZOOM_resultset_cache_reset(ZOOM_resultset r)
841 for (i = 0; i<RECORD_HASH_SIZE; i++)
843 ZOOM_record_cache rc;
844 for (rc = r->record_hash[i]; rc; rc = rc->next)
846 if (rc->rec.wrbuf_marc)
847 wrbuf_free (rc->rec.wrbuf_marc, 1);
848 if (rc->rec.wrbuf_iconv)
849 wrbuf_free (rc->rec.wrbuf_iconv, 1);
850 if (rc->rec.wrbuf_opac)
851 wrbuf_free (rc->rec.wrbuf_opac, 1);
853 r->record_hash[i] = 0;
858 ZOOM_resultset_destroy(ZOOM_resultset r)
863 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
865 if (r->refcount == 0)
867 ZOOM_resultset_cache_reset(r);
871 /* remove ourselves from the resultsets in connection */
872 ZOOM_resultset *rp = &r->connection->resultsets;
875 assert (*rp); /* we must be in this list!! */
877 { /* OK, we're here - take us out of it */
884 ZOOM_query_destroy (r->query);
885 ZOOM_options_destroy (r->options);
886 odr_destroy (r->odr);
894 ZOOM_resultset_size (ZOOM_resultset r)
899 static void do_close (ZOOM_connection c)
905 c->state = STATE_IDLE;
908 static void ZOOM_resultset_retrieve (ZOOM_resultset r,
909 int force_sync, int start, int count)
917 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
918 " count=%d", r, force_sync, start, count);
923 if (c->host_port && c->proto == PROTO_HTTP)
927 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
928 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
932 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
937 task = ZOOM_connection_add_task (c, ZOOM_TASK_RETRIEVE);
938 task->u.retrieve.resultset = r;
939 task->u.retrieve.start = start;
940 task->u.retrieve.count = count;
942 cp = ZOOM_options_get (r->options, "schema");
945 if (!r->schema || strcmp(r->schema, cp))
948 r->schema = xstrdup(cp);
952 ZOOM_resultset_addref (r);
954 if (!r->connection->async || force_sync)
955 while (r->connection && ZOOM_event (1, &r->connection))
960 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
961 size_t start, size_t count)
963 int force_present = 0;
967 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%ld count=%ld",
968 r, r, (long) start, (long) count);
971 ZOOM_resultset_retrieve (r, force_present, start, count);
975 for (i = 0; i< count; i++)
976 recs[i] = ZOOM_resultset_record_immediate (r, i+start);
980 static void get_cert(ZOOM_connection c)
985 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
987 ZOOM_connection_option_setl(c, "sslPeerCert",
993 static zoom_ret do_connect (ZOOM_connection c)
996 const char *effective_host;
999 effective_host = c->proxy;
1001 effective_host = c->host_port;
1003 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
1007 c->cs = cs_create_host (effective_host, 0, &add);
1009 if (c->cs && c->cs->protocol == PROTO_HTTP)
1012 const char *path = 0;
1014 c->proto = PROTO_HTTP;
1015 cs_get_host_args(c->host_port, &path);
1017 c->path = (char*) xmalloc(strlen(path)+2);
1019 strcpy (c->path+1, path);
1021 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
1023 return zoom_complete;
1028 int ret = cs_connect (c->cs, add);
1031 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
1032 ZOOM_connection_put_event(c, event);
1034 if (c->proto == PROTO_Z3950)
1035 ZOOM_connection_send_init(c);
1038 /* no init request for SRW .. */
1039 assert (c->tasks->which == ZOOM_TASK_CONNECT);
1040 ZOOM_connection_remove_task (c);
1042 ZOOM_connection_exec_task (c);
1044 c->state = STATE_ESTABLISHED;
1045 return zoom_pending;
1049 c->state = STATE_CONNECTING;
1050 c->mask = ZOOM_SELECT_EXCEPT;
1051 if (c->cs->io_pending & CS_WANT_WRITE)
1052 c->mask += ZOOM_SELECT_WRITE;
1053 if (c->cs->io_pending & CS_WANT_READ)
1054 c->mask += ZOOM_SELECT_READ;
1055 return zoom_pending;
1058 c->state = STATE_IDLE;
1059 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
1060 return zoom_complete;
1063 int z3950_connection_socket(ZOOM_connection c)
1066 return cs_fileno(c->cs);
1070 int z3950_connection_mask(ZOOM_connection c)
1077 static void otherInfo_attach (ZOOM_connection c, Z_APDU *a, ODR out)
1080 for (i = 0; i<200; i++)
1083 Z_OtherInformation **oi;
1089 sprintf (buf, "otherInfo%d", i);
1090 val = ZOOM_options_get (c->options, buf);
1093 cp = strchr(val, ':');
1097 if (len >= sizeof(buf))
1098 len = sizeof(buf)-1;
1099 memcpy (buf, val, len);
1101 oidval = oid_getvalbyname (buf);
1102 if (oidval == VAL_NONE)
1105 yaz_oi_APDU(a, &oi);
1106 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1110 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1115 Z_OtherInformation **oi;
1116 yaz_oi_APDU(a, &oi);
1117 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1121 Z_OtherInformation **oi;
1122 yaz_oi_APDU(a, &oi);
1123 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1125 otherInfo_attach (c, a, out);
1126 if (!z_APDU(out, &a, 0, 0))
1128 FILE *outf = fopen("/tmp/apdu.txt", "a");
1131 ODR odr_pr = odr_createmem(ODR_PRINT);
1132 fprintf (outf, "a=%p\n", a);
1133 odr_setprint(odr_pr, outf);
1134 z_APDU(odr_pr, &a, 0, 0);
1135 odr_destroy(odr_pr);
1137 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1138 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1142 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1146 static zoom_ret send_APDU (ZOOM_connection c, Z_APDU *a)
1150 if (encode_APDU(c, a, c->odr_out))
1151 return zoom_complete;
1152 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1153 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1154 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1155 ZOOM_connection_put_event (c, event);
1156 odr_reset(c->odr_out);
1157 return do_write (c);
1160 /* returns 1 if PDU was sent OK (still pending )
1161 0 if PDU was not sent OK (nothing to wait for)
1164 static zoom_ret ZOOM_connection_send_init (ZOOM_connection c)
1166 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1167 Z_InitRequest *ireq = apdu->u.initRequest;
1168 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1169 odr_malloc(c->odr_out, sizeof(*auth));
1170 const char *auth_groupId = ZOOM_options_get (c->options, "group");
1171 const char *auth_userId = ZOOM_options_get (c->options, "user");
1172 const char *auth_password = ZOOM_options_get (c->options, "password");
1175 /* support the pass for backwards compatibility */
1177 auth_password = ZOOM_options_get (c->options, "pass");
1179 ODR_MASK_SET(ireq->options, Z_Options_search);
1180 ODR_MASK_SET(ireq->options, Z_Options_present);
1181 ODR_MASK_SET(ireq->options, Z_Options_scan);
1182 ODR_MASK_SET(ireq->options, Z_Options_sort);
1183 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1184 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1186 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1187 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1188 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1190 /* Index Data's Z39.50 Implementor Id is 81 */
1191 ireq->implementationId = odr_prepend(c->odr_out,
1192 ZOOM_options_get(c->options, "implementationId"),
1193 odr_prepend(c->odr_out, "81", ireq->implementationId));
1195 ireq->implementationName = odr_prepend(c->odr_out,
1196 ZOOM_options_get(c->options, "implementationName"),
1197 odr_prepend(c->odr_out, "ZOOM-C", ireq->implementationName));
1199 version = odr_strdup(c->odr_out, "$Revision: 1.81 $");
1200 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1201 version[strlen(version)-2] = '\0';
1202 ireq->implementationVersion = odr_prepend(c->odr_out,
1203 ZOOM_options_get(c->options, "implementationVersion"),
1204 odr_prepend(c->odr_out, &version[11], ireq->implementationVersion));
1206 *ireq->maximumRecordSize =
1207 ZOOM_options_get_int (c->options, "maximumRecordSize", 1024*1024);
1208 *ireq->preferredMessageSize =
1209 ZOOM_options_get_int (c->options, "preferredMessageSize", 1024*1024);
1211 if (auth_groupId || auth_password)
1213 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1216 if (auth_groupId && *auth_groupId)
1218 pass->groupId = (char *)
1219 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1220 strcpy(pass->groupId, auth_groupId);
1224 if (auth_userId && *auth_userId)
1226 pass->userId = (char *)
1227 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1228 strcpy(pass->userId, auth_userId);
1232 if (auth_password && *auth_password)
1234 pass->password = (char *)
1235 odr_malloc(c->odr_out, strlen(auth_password)+1);
1236 strcpy(pass->password, auth_password);
1241 auth->which = Z_IdAuthentication_idPass;
1242 auth->u.idPass = pass;
1243 ireq->idAuthentication = auth;
1246 else if (auth_userId)
1248 auth->which = Z_IdAuthentication_open;
1249 auth->u.open = (char *)
1250 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1251 strcpy(auth->u.open, auth_userId);
1252 ireq->idAuthentication = auth;
1255 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1256 VAL_PROXY, 1, c->host_port);
1257 if (c->charset || c->lang)
1259 Z_OtherInformation **oi;
1260 Z_OtherInformationUnit *oi_unit;
1262 yaz_oi_APDU(apdu, &oi);
1264 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1266 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1267 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1268 oi_unit->information.externallyDefinedInfo =
1269 yaz_set_proposal_charneg_list(c->odr_out, " ",
1270 c->charset, c->lang, 1);
1274 return send_APDU (c, apdu);
1278 static zoom_ret send_srw (ZOOM_connection c, Z_SRW_PDU *sr)
1283 gdu = z_get_HTTP_Request_host_path(c->odr_out, c->host_port, c->path);
1285 if (c->sru_mode == zoom_sru_get)
1287 yaz_sru_get_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1289 else if (c->sru_mode == zoom_sru_post)
1291 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1293 else if (c->sru_mode == zoom_sru_soap)
1295 yaz_sru_post_encode(gdu->u.HTTP_Request, sr, c->odr_out, c->charset);
1297 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1298 return zoom_complete;
1299 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1301 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1302 ZOOM_connection_put_event (c, event);
1303 odr_reset(c->odr_out);
1304 return do_write (c);
1309 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1312 ZOOM_resultset resultset = 0;
1314 const char *recordPacking = 0;
1316 if (c->error) /* don't continue on error */
1317 return zoom_complete;
1319 if (c->tasks->which == ZOOM_TASK_SEARCH)
1321 resultset = c->tasks->u.search.resultset;
1322 resultset->setname = xstrdup ("default");
1323 ZOOM_options_set (resultset->options, "setname", resultset->setname);
1325 else if(c->tasks->which == ZOOM_TASK_RETRIEVE)
1327 resultset = c->tasks->u.retrieve.resultset;
1329 resultset->start = c->tasks->u.retrieve.start;
1330 resultset->count = c->tasks->u.retrieve.count;
1332 if (resultset->start >= resultset->size)
1333 return zoom_complete;
1334 if (resultset->start + resultset->count > resultset->size)
1335 resultset->count = resultset->size - resultset->start;
1337 for (i = 0; i<resultset->count; i++)
1340 record_cache_lookup (resultset, i + resultset->start);
1345 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1346 ZOOM_connection_put_event(c, event);
1349 resultset->start += i;
1350 resultset->count -= i;
1352 if (resultset->count == 0)
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 resultset->count -= i;
2119 resultset->start += i;
2120 /* transfer our response to search_nmem .. we need it later */
2121 nmem_transfer (resultset->odr->mem, nmem);
2122 nmem_destroy (nmem);
2123 if (present_phase && p->num_records == 0)
2125 /* present response and we didn't get any records! */
2126 Z_NamePlusRecord *myrec =
2127 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2128 record_cache_add(resultset, myrec, resultset->start);
2131 else if (present_phase)
2133 /* present response and we didn't get any records! */
2134 Z_NamePlusRecord *myrec =
2135 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2136 record_cache_add(resultset, myrec, resultset->start);
2141 static void handle_present_response (ZOOM_connection c, Z_PresentResponse *pr)
2143 handle_records (c, pr->records, 1);
2146 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2149 switch (term->which)
2151 case Z_Term_general:
2152 ZOOM_options_setl(opt, name,
2153 (const char *)(term->u.general->buf),
2154 term->u.general->len);
2156 case Z_Term_characterString:
2157 ZOOM_options_set(opt, name, term->u.characterString);
2159 case Z_Term_numeric:
2160 ZOOM_options_set_int(opt, name, *term->u.numeric);
2165 static void handle_queryExpression(ZOOM_options opt, const char *name,
2166 Z_QueryExpression *exp)
2172 case Z_QueryExpression_term:
2173 if (exp->u.term && exp->u.term->queryTerm)
2175 sprintf(opt_name, "%s.term", name);
2176 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2179 case Z_QueryExpression_query:
2184 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2185 Z_OtherInformation *o)
2188 for (i = 0; o && i < o->num_elements; i++)
2190 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2192 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2194 if (ext->which == Z_External_searchResult1)
2197 Z_SearchInfoReport *sr = ext->u.searchResult1;
2200 ZOOM_options_set_int(
2201 resultset->options, "searchresult.size", sr->num);
2203 for (j = 0; j < sr->num; j++)
2205 Z_SearchInfoReport_s *ent =
2206 ext->u.searchResult1->elements[j];
2209 sprintf(pref, "searchresult.%d", j);
2211 if (ent->subqueryId)
2214 sprintf(opt_name, "%s.id", pref);
2215 ZOOM_options_set(resultset->options, opt_name,
2218 if (ent->subqueryExpression)
2221 sprintf(opt_name, "%s.subquery", pref);
2222 handle_queryExpression(resultset->options, opt_name,
2223 ent->subqueryExpression);
2225 if (ent->subqueryInterpretation)
2228 sprintf(opt_name, "%s.interpretation", pref);
2229 handle_queryExpression(resultset->options, opt_name,
2230 ent->subqueryInterpretation);
2232 if (ent->subqueryRecommendation)
2235 sprintf(opt_name, "%s.recommendation", pref);
2236 handle_queryExpression(resultset->options, opt_name,
2237 ent->subqueryRecommendation);
2239 if (ent->subqueryCount)
2242 sprintf(opt_name, "%s.count", pref);
2243 ZOOM_options_set_int(resultset->options, opt_name,
2244 *ent->subqueryCount);
2252 static void handle_search_response (ZOOM_connection c, Z_SearchResponse *sr)
2254 ZOOM_resultset resultset;
2257 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2260 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2261 ZOOM_connection_put_event(c, event);
2263 resultset = c->tasks->u.search.resultset;
2265 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2267 resultset->size = *sr->resultCount;
2268 handle_records (c, sr->records, 0);
2271 static void sort_response (ZOOM_connection c, Z_SortResponse *res)
2273 if (res->diagnostics && res->num_diagnostics > 0)
2274 response_diag (c, res->diagnostics[0]);
2277 static int scan_response (ZOOM_connection c, Z_ScanResponse *res)
2279 NMEM nmem = odr_extract_mem (c->odr_in);
2282 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2284 scan = c->tasks->u.scan.scan;
2286 if (res->entries && res->entries->nonsurrogateDiagnostics)
2287 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2288 scan->scan_response = res;
2289 nmem_transfer (scan->odr->mem, nmem);
2291 ZOOM_options_set_int (scan->options, "stepSize", *res->stepSize);
2292 if (res->positionOfTerm)
2293 ZOOM_options_set_int (scan->options, "position", *res->positionOfTerm);
2294 if (res->scanStatus)
2295 ZOOM_options_set_int (scan->options, "scanStatus", *res->scanStatus);
2296 if (res->numberOfEntriesReturned)
2297 ZOOM_options_set_int (scan->options, "number",
2298 *res->numberOfEntriesReturned);
2299 nmem_destroy (nmem);
2303 static zoom_ret send_sort (ZOOM_connection c,
2304 ZOOM_resultset resultset)
2307 resultset->r_sort_spec = 0;
2308 if (resultset->r_sort_spec)
2310 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2311 Z_SortRequest *req = apdu->u.sortRequest;
2313 req->num_inputResultSetNames = 1;
2314 req->inputResultSetNames = (Z_InternationalString **)
2315 odr_malloc (c->odr_out, sizeof(*req->inputResultSetNames));
2316 req->inputResultSetNames[0] =
2317 odr_strdup (c->odr_out, resultset->setname);
2318 req->sortedResultSetName = odr_strdup (c->odr_out, resultset->setname);
2319 req->sortSequence = resultset->r_sort_spec;
2320 resultset->r_sort_spec = 0;
2321 return send_APDU (c, apdu);
2323 return zoom_complete;
2326 static zoom_ret send_present(ZOOM_connection c)
2329 Z_PresentRequest *req = 0;
2331 const char *syntax = 0;
2332 const char *elementSetName = 0;
2333 ZOOM_resultset resultset;
2337 yaz_log(log_details, "%p send_present no tasks", c);
2338 return zoom_complete;
2341 switch (c->tasks->which)
2343 case ZOOM_TASK_SEARCH:
2344 resultset = c->tasks->u.search.resultset;
2346 case ZOOM_TASK_RETRIEVE:
2347 resultset = c->tasks->u.retrieve.resultset;
2348 resultset->start = c->tasks->u.retrieve.start;
2349 resultset->count = c->tasks->u.retrieve.count;
2351 if (resultset->start >= resultset->size)
2353 yaz_log(log_details, "%p send_present start=%d >= size=%d",
2354 c, resultset->start, resultset->size);
2355 return zoom_complete;
2357 if (resultset->start + resultset->count > resultset->size)
2358 resultset->count = resultset->size - resultset->start;
2361 return zoom_complete;
2363 yaz_log(log_details, "%p send_present start=%d count=%d",
2364 c, resultset->start, resultset->count);
2366 syntax = ZOOM_resultset_option_get (resultset, "preferredRecordSyntax");
2367 elementSetName = ZOOM_resultset_option_get (resultset, "elementSetName");
2369 if (c->error) /* don't continue on error */
2370 return zoom_complete;
2371 if (resultset->start < 0)
2372 return zoom_complete;
2373 for (i = 0; i<resultset->count; i++)
2376 record_cache_lookup (resultset, i + resultset->start);
2381 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
2382 ZOOM_connection_put_event(c, event);
2385 resultset->start += i;
2386 resultset->count -= i;
2388 if (resultset->count == 0)
2390 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2391 return zoom_complete;
2394 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2395 req = apdu->u.presentRequest;
2398 yaz_log(log_details, "%p send_present skip=%d", c, i);
2400 *req->resultSetStartPoint = resultset->start + 1;
2401 *req->numberOfRecordsRequested = resultset->step>0 ?
2402 resultset->step : resultset->count;
2403 if (*req->numberOfRecordsRequested + resultset->start > resultset->size)
2404 *req->numberOfRecordsRequested = resultset->size - resultset->start;
2405 assert (*req->numberOfRecordsRequested > 0);
2407 if (syntax && *syntax)
2408 req->preferredRecordSyntax =
2409 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
2411 if (resultset->schema && *resultset->schema)
2413 Z_RecordComposition *compo = (Z_RecordComposition *)
2414 odr_malloc (c->odr_out, sizeof(*compo));
2416 req->recordComposition = compo;
2417 compo->which = Z_RecordComp_complex;
2418 compo->u.complex = (Z_CompSpec *)
2419 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2420 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2421 odr_malloc(c->odr_out, sizeof(bool_t));
2422 *compo->u.complex->selectAlternativeSyntax = 0;
2424 compo->u.complex->generic = (Z_Specification *)
2425 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2427 compo->u.complex->generic->which = Z_Schema_oid;
2428 compo->u.complex->generic->schema.oid = (Odr_oid *)
2429 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2431 if (!compo->u.complex->generic->schema.oid)
2433 /* OID wasn't a schema! Try record syntax instead. */
2435 compo->u.complex->generic->schema.oid = (Odr_oid *)
2436 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2438 if (elementSetName && *elementSetName)
2440 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2441 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2442 compo->u.complex->generic->elementSpec->which =
2443 Z_ElementSpec_elementSetName;
2444 compo->u.complex->generic->elementSpec->u.elementSetName =
2445 odr_strdup (c->odr_out, elementSetName);
2448 compo->u.complex->generic->elementSpec = 0;
2449 compo->u.complex->num_dbSpecific = 0;
2450 compo->u.complex->dbSpecific = 0;
2451 compo->u.complex->num_recordSyntax = 0;
2452 compo->u.complex->recordSyntax = 0;
2454 else if (elementSetName && *elementSetName)
2456 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2457 odr_malloc (c->odr_out, sizeof(*esn));
2458 Z_RecordComposition *compo = (Z_RecordComposition *)
2459 odr_malloc (c->odr_out, sizeof(*compo));
2461 esn->which = Z_ElementSetNames_generic;
2462 esn->u.generic = odr_strdup (c->odr_out, elementSetName);
2463 compo->which = Z_RecordComp_simple;
2464 compo->u.simple = esn;
2465 req->recordComposition = compo;
2467 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2468 return send_APDU (c, apdu);
2471 ZOOM_API(ZOOM_scanset)
2472 ZOOM_connection_scan (ZOOM_connection c, const char *start)
2475 ZOOM_query q = ZOOM_query_create();
2477 ZOOM_query_prefix (q, start);
2479 s = ZOOM_connection_scan1(c, q);
2480 ZOOM_query_destroy (q);
2485 ZOOM_API(ZOOM_scanset)
2486 ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query q)
2488 ZOOM_scanset scan = (ZOOM_scanset) xmalloc (sizeof(*scan));
2492 scan->connection = c;
2493 scan->odr = odr_createmem (ODR_DECODE);
2494 scan->options = ZOOM_options_create_with_parent (c->options);
2496 scan->scan_response = 0;
2499 * We need to check the query-type, so we can recognise CQL and
2500 * CCL and compile them into a form that we can use here. The
2501 * ZOOM_query structure has no explicit `type' member, but
2502 * inspection of the ZOOM_query_prefix() and ZOOM_query_cql()
2503 * functions shows how the structure is set up in each case.
2505 if (q->z_query->which == Z_Query_type_1) {
2506 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2507 c, q, q->query_string);
2508 start = q->query_string;
2509 } else if (q->z_query->which == Z_Query_type_104) {
2510 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2511 c, q, q->query_string);
2512 start = freeme = cql2pqf(c, q->query_string);
2516 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2517 c, q, q->query_string);
2521 scan->termListAndStartPoint =
2522 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2524 if (scan->termListAndStartPoint != 0)
2526 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_SCAN);
2527 task->u.scan.scan = scan;
2532 while (ZOOM_event (1, &c))
2540 ZOOM_scanset_destroy (ZOOM_scanset scan)
2545 if (scan->refcount == 0)
2547 odr_destroy (scan->odr);
2549 ZOOM_options_destroy (scan->options);
2554 static zoom_ret send_package (ZOOM_connection c)
2558 yaz_log(log_details, "%p send_package", c);
2560 return zoom_complete;
2561 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2563 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
2564 ZOOM_connection_put_event (c, event);
2566 c->buf_out = c->tasks->u.package->buf_out;
2567 c->len_out = c->tasks->u.package->len_out;
2572 static zoom_ret send_scan (ZOOM_connection c)
2575 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2576 Z_ScanRequest *req = apdu->u.scanRequest;
2578 yaz_log(log_details, "%p send_scan", c);
2580 return zoom_complete;
2581 assert (c->tasks->which == ZOOM_TASK_SCAN);
2582 scan = c->tasks->u.scan.scan;
2584 req->termListAndStartPoint = scan->termListAndStartPoint;
2585 req->attributeSet = scan->attributeSet;
2587 *req->numberOfTermsRequested =
2588 ZOOM_options_get_int(scan->options, "number", 10);
2590 req->preferredPositionInResponse =
2591 odr_intdup (c->odr_out,
2592 ZOOM_options_get_int(scan->options, "position", 1));
2595 odr_intdup (c->odr_out,
2596 ZOOM_options_get_int(scan->options, "stepSize", 0));
2598 req->databaseNames = set_DatabaseNames (c, scan->options,
2599 &req->num_databaseNames);
2601 return send_APDU (c, apdu);
2605 ZOOM_scanset_size (ZOOM_scanset scan)
2607 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2609 return scan->scan_response->entries->num_entries;
2612 ZOOM_API(const char *)
2613 ZOOM_scanset_term (ZOOM_scanset scan, size_t pos,
2616 const char *term = 0;
2617 size_t noent = ZOOM_scanset_size (scan);
2618 Z_ScanResponse *res = scan->scan_response;
2624 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2626 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2628 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_display_term (ZOOM_scanset scan, size_t pos,
2642 const char *term = 0;
2643 size_t noent = ZOOM_scanset_size (scan);
2644 Z_ScanResponse *res = scan->scan_response;
2650 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2652 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2656 term = t->displayTerm;
2657 *len = strlen(term);
2659 else if (t->term->which == Z_Term_general)
2661 term = (const char *) t->term->u.general->buf;
2662 *len = t->term->u.general->len;
2664 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2669 ZOOM_API(const char *)
2670 ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key)
2672 return ZOOM_options_get (scan->options, key);
2676 ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
2679 ZOOM_options_set (scan->options, key, val);
2682 static Z_APDU *create_es_package (ZOOM_package p, int type)
2685 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2686 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2688 *req->function = Z_ExtendedServicesRequest_create;
2690 str = ZOOM_options_get(p->options, "package-name");
2692 req->packageName = nmem_strdup (p->odr_out->mem, str);
2694 str = ZOOM_options_get(p->options, "user-id");
2696 req->userId = nmem_strdup (p->odr_out->mem, str);
2698 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2701 str = ZOOM_options_get(p->options, "function");
2704 if (!strcmp (str, "create"))
2706 if (!strcmp (str, "delete"))
2708 if (!strcmp (str, "modify"))
2714 static const char *ill_array_lookup (void *clientData, const char *idx)
2716 ZOOM_package p = (ZOOM_package) clientData;
2717 return ZOOM_options_get (p->options, idx+4);
2720 static Z_External *encode_ill_request (ZOOM_package p)
2722 ODR out = p->odr_out;
2725 struct ill_get_ctl ctl;
2727 ctl.odr = p->odr_out;
2729 ctl.f = ill_array_lookup;
2731 req = ill_get_ILLRequest(&ctl, "ill", 0);
2733 if (!ill_Request (out, &req, 0, 0))
2735 int ill_request_size;
2736 char *ill_request_buf = odr_getbuf (out, &ill_request_size, 0);
2737 if (ill_request_buf)
2738 odr_setbuf (out, ill_request_buf, ill_request_size, 1);
2744 int illRequest_size = 0;
2745 char *illRequest_buf = odr_getbuf (out, &illRequest_size, 0);
2747 oid.proto = PROTO_GENERAL;
2748 oid.oclass = CLASS_GENERAL;
2749 oid.value = VAL_ISO_ILL_1;
2751 r = (Z_External *) odr_malloc (out, sizeof(*r));
2752 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2753 r->indirect_reference = 0;
2755 r->which = Z_External_single;
2757 r->u.single_ASN1_type =
2758 odr_create_Odr_oct(out,
2759 (unsigned char *)illRequest_buf,
2765 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2767 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc (p->odr_out, sizeof(*req));
2770 req->which = Z_IOItemOrder_esRequest;
2771 req->u.esRequest = (Z_IORequest *)
2772 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2774 /* to keep part ... */
2775 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2776 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2777 req->u.esRequest->toKeep->supplDescription = 0;
2778 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2779 odr_malloc (p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2781 str = ZOOM_options_get(p->options, "contact-name");
2782 req->u.esRequest->toKeep->contact->name = str ?
2783 nmem_strdup (p->odr_out->mem, str) : 0;
2785 str = ZOOM_options_get(p->options, "contact-phone");
2786 req->u.esRequest->toKeep->contact->phone = str ?
2787 nmem_strdup (p->odr_out->mem, str) : 0;
2789 str = ZOOM_options_get(p->options, "contact-email");
2790 req->u.esRequest->toKeep->contact->email = str ?
2791 nmem_strdup (p->odr_out->mem, str) : 0;
2793 req->u.esRequest->toKeep->addlBilling = 0;
2795 /* not to keep part ... */
2796 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2797 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2799 str = ZOOM_options_get(p->options, "itemorder-setname");
2804 req->u.esRequest->notToKeep->resultSetItem = 0;
2807 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2808 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2810 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2811 nmem_strdup (p->odr_out->mem, str);
2812 req->u.esRequest->notToKeep->resultSetItem->item =
2813 (int *) odr_malloc(p->odr_out, sizeof(int));
2815 str = ZOOM_options_get(p->options, "itemorder-item");
2816 *req->u.esRequest->notToKeep->resultSetItem->item =
2817 (str ? atoi(str) : 1);
2819 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2824 Z_APDU *create_admin_package(ZOOM_package p, int type,
2825 Z_ESAdminOriginPartToKeep **toKeepP,
2826 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2828 Z_APDU *apdu = create_es_package (p, VAL_ADMINSERVICE);
2831 Z_ESAdminOriginPartToKeep *toKeep;
2832 Z_ESAdminOriginPartNotToKeep *notToKeep;
2833 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2834 const char *first_db = "Default";
2836 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2840 r->direct_reference =
2841 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2844 r->indirect_reference = 0;
2845 r->which = Z_External_ESAdmin;
2847 r->u.adminService = (Z_Admin *)
2848 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2849 r->u.adminService->which = Z_Admin_esRequest;
2850 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2851 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2853 toKeep = r->u.adminService->u.esRequest->toKeep =
2854 (Z_ESAdminOriginPartToKeep *)
2855 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2856 toKeep->which = type;
2857 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2858 toKeep->u.create = odr_nullval();
2859 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2861 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2862 (Z_ESAdminOriginPartNotToKeep *)
2863 odr_malloc(p->odr_out,
2864 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2865 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
2866 notToKeep->u.recordsWillFollow = odr_nullval();
2870 *notToKeepP = notToKeep;
2875 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
2877 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
2878 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2879 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
2880 const char *doc = ZOOM_options_get(p->options, "doc");
2885 req->taskSpecificParameters = ext;
2886 ext->direct_reference = req->packageType;
2887 ext->descriptor = 0;
2888 ext->indirect_reference = 0;
2890 ext->which = Z_External_octet;
2891 ext->u.single_ASN1_type =
2892 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc,
2897 static Z_APDU *create_update_package(ZOOM_package p)
2900 const char *first_db = "Default";
2902 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2903 const char *action = ZOOM_options_get(p->options, "action");
2904 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
2905 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
2906 const char *record_buf = ZOOM_options_get(p->options, "record");
2907 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
2908 int syntax_oid = VAL_NONE;
2912 syntax_oid = oid_getvalbyname(syntax_str);
2915 record_buf = "void";
2916 syntax_oid = VAL_SUTRS;
2918 if (syntax_oid == VAL_NONE)
2919 syntax_oid = VAL_TEXT_XML;
2925 action = "specialUpdate";
2927 if (!strcmp(action, "recordInsert"))
2928 action_no = Z_IUOriginPartToKeep_recordInsert;
2929 else if (!strcmp(action, "recordReplace"))
2930 action_no = Z_IUOriginPartToKeep_recordReplace;
2931 else if (!strcmp(action, "recordDelete"))
2932 action_no = Z_IUOriginPartToKeep_recordDelete;
2933 else if (!strcmp(action, "elementUpdate"))
2934 action_no = Z_IUOriginPartToKeep_elementUpdate;
2935 else if (!strcmp(action, "specialUpdate"))
2936 action_no = Z_IUOriginPartToKeep_specialUpdate;
2940 apdu = create_es_package (p, VAL_DBUPDATE);
2943 Z_IUOriginPartToKeep *toKeep;
2944 Z_IUSuppliedRecords *notToKeep;
2945 Z_External *r = (Z_External *)
2946 odr_malloc (p->odr_out, sizeof(*r));
2948 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2950 r->direct_reference =
2951 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2954 r->which = Z_External_update;
2955 r->indirect_reference = 0;
2956 r->u.update = (Z_IUUpdate *)
2957 odr_malloc(p->odr_out, sizeof(*r->u.update));
2959 r->u.update->which = Z_IUUpdate_esRequest;
2960 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
2961 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
2962 toKeep = r->u.update->u.esRequest->toKeep =
2963 (Z_IUOriginPartToKeep *)
2964 odr_malloc(p->odr_out, sizeof(*toKeep));
2966 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2968 toKeep->elementSetName = 0;
2969 toKeep->actionQualifier = 0;
2970 toKeep->action = odr_intdup(p->odr_out, action_no);
2972 notToKeep = r->u.update->u.esRequest->notToKeep =
2973 (Z_IUSuppliedRecords *)
2974 odr_malloc(p->odr_out, sizeof(*notToKeep));
2976 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
2977 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
2978 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
2979 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
2980 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
2983 notToKeep->elements[0]->u.opaque =
2984 odr_create_Odr_oct(p->odr_out,
2985 (const unsigned char *) recordIdOpaque,
2986 strlen(recordIdOpaque));
2988 else if (recordIdNumber)
2990 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
2992 notToKeep->elements[0]->u.number =
2993 odr_intdup(p->odr_out, atoi(recordIdNumber));
2996 notToKeep->elements[0]->u.opaque = 0;
2997 notToKeep->elements[0]->supplementalId = 0;
2998 notToKeep->elements[0]->correlationInfo = 0;
2999 notToKeep->elements[0]->record =
3000 z_ext_record(p->odr_out, syntax_oid,
3001 record_buf, strlen(record_buf));
3005 ODR print = odr_createmem(ODR_PRINT);
3007 z_APDU(print, &apdu, 0, 0);
3014 ZOOM_package_send (ZOOM_package p, const char *type)
3021 odr_reset (p->odr_out);
3024 if (!strcmp(type, "itemorder"))
3026 apdu = create_es_package (p, VAL_ITEMORDER);
3029 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
3031 r->direct_reference =
3032 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
3035 r->which = Z_External_itemOrder;
3036 r->indirect_reference = 0;
3037 r->u.itemOrder = encode_item_order (p);
3039 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
3042 else if (!strcmp(type, "create")) /* create database */
3044 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
3047 else if (!strcmp(type, "drop")) /* drop database */
3049 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
3052 else if (!strcmp(type, "commit")) /* commit changes */
3054 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3057 else if (!strcmp(type, "update")) /* update record(s) */
3059 apdu = create_update_package(p);
3061 else if (!strcmp(type, "xmlupdate"))
3063 apdu = create_xmlupdate_package(p);
3067 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3071 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_PACKAGE);
3072 task->u.package = p;
3073 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3074 p->buf_out = (char *) xmalloc (p->len_out);
3075 memcpy (p->buf_out, buf, p->len_out);
3080 while (ZOOM_event (1, &c))
3087 ZOOM_API(ZOOM_package)
3088 ZOOM_connection_package (ZOOM_connection c, ZOOM_options options)
3090 ZOOM_package p = (ZOOM_package) xmalloc (sizeof(*p));
3093 p->odr_out = odr_createmem (ODR_ENCODE);
3094 p->options = ZOOM_options_create_with_parent2 (options, c->options);
3102 ZOOM_package_destroy(ZOOM_package p)
3107 if (p->refcount == 0)
3109 odr_destroy (p->odr_out);
3112 ZOOM_options_destroy (p->options);
3117 ZOOM_API(const char *)
3118 ZOOM_package_option_get (ZOOM_package p, const char *key)
3120 return ZOOM_options_get (p->options, key);
3125 ZOOM_package_option_set (ZOOM_package p, const char *key,
3128 ZOOM_options_set (p->options, key, val);
3131 static int ZOOM_connection_exec_task (ZOOM_connection c)
3133 ZOOM_task task = c->tasks;
3134 zoom_ret ret = zoom_complete;
3138 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3139 c, task->which, task->running);
3140 if (c->error != ZOOM_ERROR_NONE)
3142 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3143 "removing tasks because of error = %d", c, c->error);
3144 ZOOM_connection_remove_tasks (c);
3149 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3150 "task already running", c);
3154 ret = zoom_complete;
3155 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3157 switch (task->which)
3159 case ZOOM_TASK_SEARCH:
3160 if (c->proto == PROTO_HTTP)
3161 ret = ZOOM_connection_srw_send_search(c);
3163 ret = ZOOM_connection_send_search(c);
3165 case ZOOM_TASK_RETRIEVE:
3166 if (c->proto == PROTO_HTTP)
3167 ret = ZOOM_connection_srw_send_search(c);
3169 ret = send_present (c);
3171 case ZOOM_TASK_CONNECT:
3172 ret = do_connect(c);
3174 case ZOOM_TASK_SCAN:
3177 case ZOOM_TASK_PACKAGE:
3178 ret = send_package(c);
3180 case ZOOM_TASK_SORT:
3181 c->tasks->u.sort.resultset->r_sort_spec =
3182 c->tasks->u.sort.q->sort_spec;
3183 ret = send_sort(c, c->tasks->u.sort.resultset);
3189 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3190 "remove tasks because no connection exist", c);
3191 ZOOM_connection_remove_tasks (c);
3193 if (ret == zoom_complete)
3195 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3196 "task removed (complete)", c);
3197 ZOOM_connection_remove_task (c);
3200 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3205 static zoom_ret send_sort_present (ZOOM_connection c)
3207 zoom_ret r = zoom_complete;
3209 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3210 r = send_sort (c, c->tasks->u.search.resultset);
3211 if (r == zoom_complete)
3212 r = send_present (c);
3216 static int es_response (ZOOM_connection c,
3217 Z_ExtendedServicesResponse *res)
3219 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3221 if (res->diagnostics && res->num_diagnostics > 0)
3222 response_diag(c, res->diagnostics[0]);
3223 if (res->taskPackage &&
3224 res->taskPackage->which == Z_External_extendedService)
3226 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3227 Odr_oct *id = taskPackage->targetReference;
3230 ZOOM_options_setl (c->tasks->u.package->options,
3231 "targetReference", (char*) id->buf, id->len);
3233 if (res->taskPackage &&
3234 res->taskPackage->which == Z_External_octet)
3236 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3237 ZOOM_options_setl (c->tasks->u.package->options,
3238 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3243 static void interpret_init_diag(ZOOM_connection c,
3244 Z_DiagnosticFormat *diag)
3248 Z_DiagnosticFormat_s *ds = diag->elements[0];
3249 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3250 response_default_diag(c, ds->u.defaultDiagRec);
3255 static void interpret_otherinformation_field(ZOOM_connection c,
3256 Z_OtherInformation *ui)
3259 for (i = 0; i < ui->num_elements; i++)
3261 Z_OtherInformationUnit *unit = ui->list[i];
3262 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3263 unit->information.externallyDefinedInfo &&
3264 unit->information.externallyDefinedInfo->which ==
3267 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3272 static void recv_apdu (ZOOM_connection c, Z_APDU *apdu)
3274 Z_InitResponse *initrs;
3277 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3280 case Z_APDU_initResponse:
3281 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3282 initrs = apdu->u.initResponse;
3283 ZOOM_connection_option_set(c, "serverImplementationId",
3284 initrs->implementationId ?
3285 initrs->implementationId : "");
3286 ZOOM_connection_option_set(c, "serverImplementationName",
3287 initrs->implementationName ?
3288 initrs->implementationName : "");
3289 ZOOM_connection_option_set(c, "serverImplementationVersion",
3290 initrs->implementationVersion ?
3291 initrs->implementationVersion : "");
3292 /* Set the three old options too, for old applications */
3293 ZOOM_connection_option_set(c, "targetImplementationId",
3294 initrs->implementationId ?
3295 initrs->implementationId : "");
3296 ZOOM_connection_option_set(c, "targetImplementationName",
3297 initrs->implementationName ?
3298 initrs->implementationName : "");
3299 ZOOM_connection_option_set(c, "targetImplementationVersion",
3300 initrs->implementationVersion ?
3301 initrs->implementationVersion : "");
3302 if (!*initrs->result)
3304 Z_External *uif = initrs->userInformationField;
3306 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3308 if (uif && uif->which == Z_External_userInfo1)
3309 interpret_otherinformation_field(c, uif->u.userInfo1);
3314 yaz_oi_get_string_oidval (&apdu->u.initResponse->otherInfo,
3316 xfree (c->cookie_in);
3319 c->cookie_in = xstrdup(cookie);
3320 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3321 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3322 c->support_named_resultsets = 1;
3325 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3326 ZOOM_connection_remove_task (c);
3328 ZOOM_connection_exec_task (c);
3330 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3332 NMEM tmpmem = nmem_create();
3333 Z_CharSetandLanguageNegotiation *p =
3334 yaz_get_charneg_record(initrs->otherInfo);
3338 char *charset = NULL, *lang = NULL;
3341 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3342 yaz_log(log_details, "%p recv_apdu target accepted: "
3343 "charset %s, language %s, select %d",
3345 charset ? charset : "none", lang ? lang : "none", sel);
3347 ZOOM_connection_option_set (c, "negotiation-charset",
3350 ZOOM_connection_option_set (c, "negotiation-lang",
3353 ZOOM_connection_option_set (
3354 c, "negotiation-charset-in-effect-for-records",
3355 (sel != 0) ? "1" : "0");
3356 nmem_destroy(tmpmem);
3360 case Z_APDU_searchResponse:
3361 yaz_log(log_api, "%p recv_apdu Search response", c);
3362 handle_search_response (c, apdu->u.searchResponse);
3363 if (send_sort_present (c) == zoom_complete)
3364 ZOOM_connection_remove_task (c);
3366 case Z_APDU_presentResponse:
3367 yaz_log(log_api, "%p recv_apdu Present response", c);
3368 handle_present_response (c, apdu->u.presentResponse);
3369 if (send_present (c) == zoom_complete)
3370 ZOOM_connection_remove_task (c);
3372 case Z_APDU_sortResponse:
3373 yaz_log(log_api, "%p recv_apdu Sort response", c);
3374 sort_response (c, apdu->u.sortResponse);
3375 if (send_present (c) == zoom_complete)
3376 ZOOM_connection_remove_task (c);
3378 case Z_APDU_scanResponse:
3379 yaz_log(log_api, "%p recv_apdu Scan response", c);
3380 scan_response (c, apdu->u.scanResponse);
3381 ZOOM_connection_remove_task (c);
3383 case Z_APDU_extendedServicesResponse:
3384 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3385 es_response (c, apdu->u.extendedServicesResponse);
3386 ZOOM_connection_remove_task (c);
3389 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3390 if (c->reconnect_ok)
3393 c->tasks->running = 0;
3394 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3398 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3403 yaz_log(log_api, "%p Received unknown PDU", c);
3404 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3410 static void handle_srw_response(ZOOM_connection c,
3411 Z_SRW_searchRetrieveResponse *res)
3413 ZOOM_resultset resultset = 0;
3421 if (c->tasks->which == ZOOM_TASK_SEARCH)
3422 resultset = c->tasks->u.search.resultset;
3423 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
3424 resultset = c->tasks->u.retrieve.resultset;
3428 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3429 ZOOM_connection_put_event(c, event);
3431 resultset->size = 0;
3433 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3435 if (res->numberOfRecords)
3436 resultset->size = *res->numberOfRecords;
3438 for (i = 0; i<res->num_records; i++)
3442 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3443 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3445 if (res->records[i].recordPosition &&
3446 *res->records[i].recordPosition > 0)
3447 pos = *res->records[i].recordPosition - 1;
3449 pos = resultset->start + i;
3451 npr->databaseName = 0;
3452 npr->which = Z_NamePlusRecord_databaseRecord;
3453 npr->u.databaseRecord = (Z_External *)
3454 odr_malloc(c->odr_in, sizeof(Z_External));
3455 npr->u.databaseRecord->descriptor = 0;
3456 npr->u.databaseRecord->direct_reference =
3457 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3458 npr->u.databaseRecord->which = Z_External_octet;
3460 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3461 odr_malloc(c->odr_in, sizeof(Odr_oct));
3462 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3463 res->records[i].recordData_buf;
3464 npr->u.databaseRecord->u.octet_aligned->len =
3465 npr->u.databaseRecord->u.octet_aligned->size =
3466 res->records[i].recordData_len;
3467 record_cache_add (resultset, npr, pos);
3469 if (res->num_diagnostics > 0)
3471 const char *uri = res->diagnostics[0].uri;
3476 if ((cp = strrchr(uri, '/')))
3478 set_dset_error(c, code, uri,
3479 res->diagnostics[0].details, 0);
3482 nmem = odr_extract_mem(c->odr_in);
3483 nmem_transfer(resultset->odr->mem, nmem);
3489 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3492 const char *content_type = z_HTTP_header_lookup(hres->headers,
3494 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3497 yaz_log(log_details, "%p handle_http", c);
3499 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3501 Z_SOAP *soap_package = 0;
3503 Z_SOAP_Handler soap_handlers[2] = {
3504 {"http://www.loc.gov/zing/srw/", 0,
3505 (Z_SOAP_fun) yaz_srw_codec},
3508 ret = z_soap_codec(o, &soap_package,
3509 &hres->content_buf, &hres->content_len,
3511 if (!ret && soap_package->which == Z_SOAP_generic &&
3512 soap_package->u.generic->no == 0)
3514 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3515 if (sr->which == Z_SRW_searchRetrieve_response)
3516 handle_srw_response(c, sr->u.response);
3520 else if (!ret && (soap_package->which == Z_SOAP_fault
3521 || soap_package->which == Z_SOAP_error))
3523 set_HTTP_error(c, hres->code,
3524 soap_package->u.fault->fault_code,
3525 soap_package->u.fault->fault_string);
3532 if (hres->code != 200)
3533 set_HTTP_error(c, hres->code, 0, 0);
3535 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3538 ZOOM_connection_remove_task(c);
3539 if (!strcmp(hres->version, "1.0"))
3541 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3542 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3547 /* HTTP 1.1: only if no close we stay alive .. */
3548 if (connection_head && !strcmp(connection_head, "close"))
3554 static int do_read (ZOOM_connection c)
3559 event = ZOOM_Event_create (ZOOM_EVENT_RECV_DATA);
3560 ZOOM_connection_put_event (c, event);
3562 r = cs_get (c->cs, &c->buf_in, &c->len_in);
3563 more = cs_more(c->cs);
3564 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3569 if (c->reconnect_ok)
3572 c->reconnect_ok = 0;
3573 yaz_log(log_details, "%p do_read reconnect read", c);
3574 c->tasks->running = 0;
3575 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3579 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3588 odr_reset (c->odr_in);
3589 odr_setbuf (c->odr_in, c->buf_in, r, 0);
3590 event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);
3591 ZOOM_connection_put_event (c, event);
3593 if (!z_GDU (c->odr_in, &gdu, 0, 0))
3596 int err = odr_geterrorx(c->odr_in, &x);
3598 const char *element = odr_getelement(c->odr_in);
3599 sprintf (msg, "ODR code %d:%d element=%-20s",
3600 err, x, element ? element : "<unknown>");
3601 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3604 else if (gdu->which == Z_GDU_Z3950)
3605 recv_apdu (c, gdu->u.z3950);
3606 else if (gdu->which == Z_GDU_HTTP_Response)
3609 handle_http (c, gdu->u.HTTP_Response);
3611 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3615 c->reconnect_ok = 0;
3620 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out)
3625 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3626 ZOOM_connection_put_event (c, event);
3628 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3629 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3631 yaz_log(log_details, "%p do_write_ex write failed", c);
3632 if (c->reconnect_ok)
3635 c->reconnect_ok = 0;
3636 yaz_log(log_details, "%p do_write_ex reconnect write", c);
3637 c->tasks->running = 0;
3638 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3639 return zoom_pending;
3641 if (c->state == STATE_CONNECTING)
3642 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3644 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3646 return zoom_complete;
3650 c->mask = ZOOM_SELECT_EXCEPT;
3651 if (c->cs->io_pending & CS_WANT_WRITE)
3652 c->mask += ZOOM_SELECT_WRITE;
3653 if (c->cs->io_pending & CS_WANT_READ)
3654 c->mask += ZOOM_SELECT_READ;
3655 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3660 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3661 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3664 return zoom_pending;
3667 static zoom_ret do_write(ZOOM_connection c)
3669 return do_write_ex (c, c->buf_out, c->len_out);
3673 ZOOM_API(const char *)
3674 ZOOM_connection_option_get (ZOOM_connection c, const char *key)
3676 return ZOOM_options_get (c->options, key);
3679 ZOOM_API(const char *)
3680 ZOOM_connection_option_getl (ZOOM_connection c, const char *key, int *lenp)
3682 return ZOOM_options_getl (c->options, key, lenp);
3686 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
3689 ZOOM_options_set (c->options, key, val);
3693 ZOOM_connection_option_setl (ZOOM_connection c, const char *key,
3694 const char *val, int len)
3696 ZOOM_options_setl (c->options, key, val, len);
3699 ZOOM_API(const char *)
3700 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key)
3702 return ZOOM_options_get (r->options, key);
3706 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key,
3709 ZOOM_options_set (r->options, key, val);
3714 ZOOM_connection_errcode (ZOOM_connection c)
3716 return ZOOM_connection_error (c, 0, 0);
3719 ZOOM_API(const char *)
3720 ZOOM_connection_errmsg (ZOOM_connection c)
3723 ZOOM_connection_error (c, &msg, 0);
3727 ZOOM_API(const char *)
3728 ZOOM_connection_addinfo (ZOOM_connection c)
3730 const char *addinfo;
3731 ZOOM_connection_error (c, 0, &addinfo);
3735 ZOOM_API(const char *)
3736 ZOOM_connection_diagset (ZOOM_connection c)
3738 const char *diagset;
3739 ZOOM_connection_error_x (c, 0, 0, &diagset);
3743 ZOOM_API(const char *)
3744 ZOOM_diag_str (int error)
3748 case ZOOM_ERROR_NONE:
3750 case ZOOM_ERROR_CONNECT:
3751 return "Connect failed";
3752 case ZOOM_ERROR_MEMORY:
3753 return "Out of memory";
3754 case ZOOM_ERROR_ENCODE:
3755 return "Encoding failed";
3756 case ZOOM_ERROR_DECODE:
3757 return "Decoding failed";
3758 case ZOOM_ERROR_CONNECTION_LOST:
3759 return "Connection lost";
3760 case ZOOM_ERROR_INIT:
3761 return "Init rejected";
3762 case ZOOM_ERROR_INTERNAL:
3763 return "Internal failure";
3764 case ZOOM_ERROR_TIMEOUT:
3766 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3767 return "Unsupported protocol";
3768 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3769 return "Unsupported query type";
3770 case ZOOM_ERROR_INVALID_QUERY:
3771 return "Invalid query";
3772 case ZOOM_ERROR_CQL_PARSE:
3773 return "CQL parsing error";
3774 case ZOOM_ERROR_CQL_TRANSFORM:
3775 return "CQL transformation error";
3776 case ZOOM_ERROR_CCL_CONFIG:
3777 return "CCL configuration error";
3778 case ZOOM_ERROR_CCL_PARSE:
3779 return "CCL parsing error";
3781 return diagbib1_str (error);
3786 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
3787 const char **addinfo, const char **diagset)
3789 int error = c->error;
3792 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3793 *cp = ZOOM_diag_str(error);
3794 else if (!strcmp(c->diagset, "HTTP"))
3795 *cp = z_HTTP_errmsg(c->error);
3796 else if (!strcmp(c->diagset, "Bib-1"))
3797 *cp = ZOOM_diag_str(error);
3798 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3799 *cp = yaz_diag_srw_str(c->error);
3801 *cp = "Unknown error and diagnostic set";
3804 *addinfo = c->addinfo ? c->addinfo : "";
3806 *diagset = c->diagset ? c->diagset : "";
3811 ZOOM_connection_error (ZOOM_connection c, const char **cp,
3812 const char **addinfo)
3814 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3817 static int ZOOM_connection_do_io(ZOOM_connection c, int mask)
3819 ZOOM_Event event = 0;
3820 int r = cs_look(c->cs);
3821 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
3826 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3827 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3829 ZOOM_connection_put_event (c, event);
3831 else if (r == CS_CONNECT)
3834 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3836 ret = cs_rcvconnect (c->cs);
3837 yaz_log(log_details, "%p ZOOM_connection_do_io "
3838 "cs_rcvconnect returned %d", c, ret);
3841 c->mask = ZOOM_SELECT_EXCEPT;
3842 if (c->cs->io_pending & CS_WANT_WRITE)
3843 c->mask += ZOOM_SELECT_WRITE;
3844 if (c->cs->io_pending & CS_WANT_READ)
3845 c->mask += ZOOM_SELECT_READ;
3846 ZOOM_connection_put_event (c, event);
3850 ZOOM_connection_put_event (c, event);
3852 if (c->proto == PROTO_Z3950)
3853 ZOOM_connection_send_init(c);
3856 /* no init request for SRW .. */
3857 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3858 ZOOM_connection_remove_task (c);
3860 ZOOM_connection_exec_task (c);
3862 c->state = STATE_ESTABLISHED;
3866 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3868 ZOOM_connection_put_event (c, event);
3873 if (mask & ZOOM_SELECT_READ)
3875 if (c->cs && (mask & ZOOM_SELECT_WRITE))
3882 ZOOM_connection_last_event(ZOOM_connection cs)
3885 return ZOOM_EVENT_NONE;
3886 return cs->last_event;
3890 ZOOM_event (int no, ZOOM_connection *cs)
3892 int timeout = 30; /* default timeout in seconds */
3893 int timeout_set = 0; /* whether it was overriden at all */
3895 struct pollfd pollfds[1024];
3896 ZOOM_connection poll_cs[1024];
3899 fd_set input, output, except;
3904 yaz_log(log_details, "ZOOM_event no=%d", no);
3905 for (i = 0; i<no; i++)
3907 ZOOM_connection c = cs[i];
3909 if (c && (event = ZOOM_connection_get_event(c)))
3911 ZOOM_Event_destroy (event);
3915 for (i = 0; i<no; i++)
3917 ZOOM_connection c = cs[i];
3921 ZOOM_connection_exec_task (c);
3922 if ((event = ZOOM_connection_get_event(c)))
3924 ZOOM_Event_destroy (event);
3937 for (i = 0; i<no; i++)
3939 ZOOM_connection c = cs[i];
3945 fd = z3950_connection_socket(c);
3946 mask = z3950_connection_mask(c);
3953 /* -1 is used for indefinite timeout (no timeout), so -2 here. */
3954 this_timeout = ZOOM_options_get_int (c->options, "timeout", -2);
3955 if (this_timeout != -2)
3957 /* ensure the minimum timeout is used */
3959 timeout = this_timeout;
3960 else if (this_timeout != -1 && this_timeout < timeout)
3961 timeout = this_timeout;
3967 short poll_events = 0;
3969 if (mask & ZOOM_SELECT_READ)
3970 poll_events += POLLIN;
3971 if (mask & ZOOM_SELECT_WRITE)
3972 poll_events += POLLOUT;
3973 if (mask & ZOOM_SELECT_EXCEPT)
3974 poll_events += POLLERR;
3975 pollfds[nfds].fd = fd;
3976 pollfds[nfds].events = poll_events;
3977 pollfds[nfds].revents = 0;
3982 if (mask & ZOOM_SELECT_READ)
3984 FD_SET (fd, &input);
3987 if (mask & ZOOM_SELECT_WRITE)
3989 FD_SET (fd, &output);
3992 if (mask & ZOOM_SELECT_EXCEPT)
3994 FD_SET (fd, &except);
4003 r = poll (pollfds, nfds, (timeout == -1 ? -1 : timeout * 1000));
4004 for (i = 0; i<nfds; i++)
4006 ZOOM_connection c = poll_cs[i];
4010 if (pollfds[i].revents & POLLIN)
4011 mask += ZOOM_SELECT_READ;
4012 if (pollfds[i].revents & POLLOUT)
4013 mask += ZOOM_SELECT_WRITE;
4014 if (pollfds[i].revents & POLLERR)
4015 mask += ZOOM_SELECT_EXCEPT;
4017 ZOOM_connection_do_io(c, mask);
4019 else if (r == 0 && c->mask)
4021 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4022 /* timeout and this connection was waiting */
4023 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4025 ZOOM_connection_put_event(c, event);
4029 tv.tv_sec = timeout;
4031 r = select (max_fd+1, &input, &output, &except, (timeout == -1 ? 0 : &tv));
4032 for (i = 0; i<no; i++)
4034 ZOOM_connection c = cs[i];
4039 fd = z3950_connection_socket(c);
4043 /* no timeout and real socket */
4044 if (FD_ISSET(fd, &input))
4045 mask += ZOOM_SELECT_READ;
4046 if (FD_ISSET(fd, &output))
4047 mask += ZOOM_SELECT_WRITE;
4048 if (FD_ISSET(fd, &except))
4049 mask += ZOOM_SELECT_EXCEPT;
4051 ZOOM_connection_do_io(c, mask);
4053 if (r == 0 && c->mask)
4055 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
4056 /* timeout and this connection was waiting */
4057 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
4059 ZOOM_connection_put_event(c, event);
4063 for (i = 0; i<no; i++)
4065 ZOOM_connection c = cs[i];
4067 if (c && (event = ZOOM_connection_get_event(c)))
4069 ZOOM_Event_destroy (event);
4078 * Returns an xmalloc()d string containing RPN that corresponds to the
4079 * CQL passed in. On error, sets the Connection object's error state
4080 * and returns a null pointer.
4081 * ### We could cache CQL parser and/or transformer in Connection.
4083 static char *cql2pqf(ZOOM_connection c, const char *cql)
4087 struct cql_node *node;
4088 const char *cqlfile;
4089 static cql_transform_t trans;
4092 parser = cql_parser_create();
4093 if ((error = cql_parser_string(parser, cql)) != 0) {
4094 cql_parser_destroy(parser);
4095 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4099 node = cql_parser_result(parser);
4100 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4102 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4104 cql_parser_destroy(parser);
4105 cql_node_destroy(node);
4106 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4110 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4112 cql_parser_destroy(parser);
4113 cql_node_destroy(node);
4114 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4115 cqlfile, strerror(errno));
4116 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4120 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4121 cql_parser_destroy(parser);
4122 cql_node_destroy(node);
4125 const char *addinfo;
4126 error = cql_transform_error(trans, &addinfo);
4127 cql_transform_close(trans);
4128 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4129 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4133 cql_transform_close(trans);
4134 return xstrdup(pqfbuf);
4140 * indent-tabs-mode: nil
4142 * vim: shiftwidth=4 tabstop=8 expandtab