2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.61 2005-12-21 08:35:36 mike Exp $
9 * \brief Implements ZOOM C interface.
17 #include <yaz/yaz-util.h>
18 #include <yaz/xmalloc.h>
19 #include <yaz/otherinfo.h>
21 #include <yaz/pquery.h>
22 #include <yaz/marcdisp.h>
23 #include <yaz/diagbib1.h>
24 #include <yaz/charneg.h>
30 #include <sys/types.h>
39 #include <sys/select.h>
45 static int log_api = 0;
46 static int log_details = 0;
53 static zoom_ret ZOOM_connection_send_init (ZOOM_connection c);
54 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out);
55 static char *cql2pqf(ZOOM_connection c, const char *cql);
60 static int log_level_initialized = 0;
61 if (!log_level_initialized)
63 log_api = yaz_log_module_level("zoom");
64 log_details = yaz_log_module_level("zoomdetails");
65 log_level_initialized = 1;
69 static ZOOM_Event ZOOM_Event_create (int kind)
71 ZOOM_Event event = (ZOOM_Event) xmalloc (sizeof(*event));
78 static void ZOOM_Event_destroy (ZOOM_Event event)
83 static void ZOOM_connection_put_event (ZOOM_connection c, ZOOM_Event event)
87 c->m_queue_back->prev = event;
88 assert (c->m_queue_front);
92 assert (!c->m_queue_front);
93 c->m_queue_front = event;
95 event->next = c->m_queue_back;
97 c->m_queue_back = event;
100 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
102 ZOOM_Event event = c->m_queue_front;
105 c->last_event = ZOOM_EVENT_NONE;
108 assert (c->m_queue_back);
109 c->m_queue_front = event->prev;
110 if (c->m_queue_front)
112 assert (c->m_queue_back);
113 c->m_queue_front->next = 0;
117 c->last_event = event->kind;
122 static void set_dset_error (ZOOM_connection c, int error,
124 const char *addinfo, const char *addinfo2)
131 if (!c->diagset || strcmp(dset, c->diagset))
134 c->diagset = xstrdup(dset);
135 /* remove integer part from SRW diagset .. */
136 if ((cp = strrchr(c->diagset, '/')))
139 if (addinfo && addinfo2)
141 c->addinfo = (char*) xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
142 strcpy(c->addinfo, addinfo);
143 strcat(c->addinfo, addinfo2);
146 c->addinfo = xstrdup(addinfo);
148 yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
149 c, c->host_port ? c->host_port : "<>", dset, error,
150 addinfo ? addinfo : "",
151 addinfo2 ? addinfo2 : "");
155 static void set_HTTP_error (ZOOM_connection c, int error,
156 const char *addinfo, const char *addinfo2)
158 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
162 static void set_ZOOM_error (ZOOM_connection c, int error,
165 set_dset_error(c, error, "ZOOM", addinfo, 0);
168 static void clear_error (ZOOM_connection c)
171 * If an error is tied to an operation then it's ok to clear: for
172 * example, a diagnostic returned from a search is cleared by a
173 * subsequent search. However, problems such as Connection Lost
174 * or Init Refused are not cleared, because they are not
175 * recoverable: doing another search doesn't help.
179 case ZOOM_ERROR_CONNECT:
180 case ZOOM_ERROR_MEMORY:
181 case ZOOM_ERROR_DECODE:
182 case ZOOM_ERROR_CONNECTION_LOST:
183 case ZOOM_ERROR_INIT:
184 case ZOOM_ERROR_INTERNAL:
185 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
188 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
192 ZOOM_task ZOOM_connection_add_task (ZOOM_connection c, int which)
194 ZOOM_task *taskp = &c->tasks;
196 taskp = &(*taskp)->next;
197 *taskp = (ZOOM_task) xmalloc (sizeof(**taskp));
198 (*taskp)->running = 0;
199 (*taskp)->which = which;
205 ZOOM_task ZOOM_connection_insert_task (ZOOM_connection c, int which)
207 ZOOM_task task = (ZOOM_task) xmalloc (sizeof(*task));
209 task->next = c->tasks;
218 void ZOOM_connection_remove_task (ZOOM_connection c)
220 ZOOM_task task = c->tasks;
224 c->tasks = task->next;
227 case ZOOM_TASK_SEARCH:
228 ZOOM_resultset_destroy (task->u.search.resultset);
230 case ZOOM_TASK_RETRIEVE:
231 ZOOM_resultset_destroy (task->u.retrieve.resultset);
233 case ZOOM_TASK_CONNECT:
236 ZOOM_scanset_destroy (task->u.scan.scan);
238 case ZOOM_TASK_PACKAGE:
239 ZOOM_package_destroy (task->u.package);
242 ZOOM_resultset_destroy (task->u.sort.resultset);
243 ZOOM_query_destroy(task->u.sort.q);
252 static int ZOOM_connection_exec_task (ZOOM_connection c);
254 void ZOOM_connection_remove_tasks (ZOOM_connection c)
257 ZOOM_connection_remove_task(c);
260 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos);
262 ZOOM_API(ZOOM_connection)
263 ZOOM_connection_create (ZOOM_options options)
265 ZOOM_connection c = (ZOOM_connection) xmalloc (sizeof(*c));
269 yaz_log(log_api, "%p ZOOM_connection_create", c);
271 c->proto = PROTO_Z3950;
275 c->state = STATE_IDLE;
278 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
285 c->options = ZOOM_options_create_with_parent(options);
291 c->charset = c->lang = 0;
298 c->odr_in = odr_createmem (ODR_DECODE);
299 c->odr_out = odr_createmem (ODR_ENCODE);
302 c->support_named_resultsets = 0;
303 c->last_event = ZOOM_EVENT_NONE;
305 c->m_queue_front = 0;
310 /* set database names. Take local databases (if set); otherwise
311 take databases given in ZURL (if set); otherwise use Default */
312 static char **set_DatabaseNames (ZOOM_connection con, ZOOM_options options,
315 char **databaseNames;
316 const char *cp = ZOOM_options_get (options, "databaseName");
320 if (strncmp (con->host_port, "unix:", 5) == 0)
321 cp = strchr(con->host_port+5, ':');
323 cp = strchr(con->host_port, '/');
329 nmem_strsplit(con->odr_out->mem, "+", cp, &databaseNames, num);
330 return databaseNames;
333 ZOOM_API(ZOOM_connection)
334 ZOOM_connection_new (const char *host, int portnum)
336 ZOOM_connection c = ZOOM_connection_create (0);
338 ZOOM_connection_connect (c, host, portnum);
343 ZOOM_connection_connect(ZOOM_connection c,
344 const char *host, int portnum)
351 yaz_log(log_api, "%p ZOOM_connection_connect host=%s portnum=%d",
356 yaz_log(log_details, "%p ZOOM_connection_connect reconnect ok", c);
360 yaz_log(log_details, "%p ZOOM_connection_connect connect", c);
362 val = ZOOM_options_get (c->options, "proxy");
365 yaz_log(log_details, "%p ZOOM_connection_connect proxy=%s", c, val);
366 c->proxy = xstrdup (val);
372 val = ZOOM_options_get (c->options, "charset");
375 yaz_log(log_details, "%p ZOOM_connection_connect charset=%s", c, val);
376 c->charset = xstrdup (val);
382 val = ZOOM_options_get (c->options, "lang");
385 yaz_log(log_details, "%p ZOOM_connection_connect lang=%s", c, val);
386 c->lang = xstrdup (val);
391 xfree (c->host_port);
395 sprintf (hostn, "%.80s:%d", host, portnum);
396 c->host_port = xstrdup(hostn);
399 c->host_port = xstrdup(host);
403 * If the "<scheme>:" part of the host string is preceded by one
404 * or more comma-separated <name>=<value> pairs, these are taken
405 * to be options to be set on the connection object. Among other
406 * applications, this facility can be used to embed authentication
408 * user=admin,password=secret,tcp:localhost:9999
410 char *remainder = c->host_port;
411 char *pcolon = strchr(remainder, ':');
414 while ((pcomma = strchr(remainder, ',')) != 0 &&
415 (pcolon == 0 || pcomma < pcolon)) {
417 if ((pequals = strchr(remainder, '=')) != 0) {
419 /*printf("# setting '%s'='%s'\n", remainder, pequals+1);*/
420 ZOOM_connection_option_set(c, remainder, pequals+1);
422 remainder = pcomma+1;
425 if (remainder != c->host_port) {
427 c->host_port = xstrdup(remainder);
428 /*printf("# reset hp='%s'\n", remainder);*/
432 ZOOM_options_set(c->options, "host", c->host_port);
434 val = ZOOM_options_get (c->options, "cookie");
437 yaz_log(log_details, "%p ZOOM_connection_connect cookie=%s", c, val);
438 c->cookie_out = xstrdup (val);
441 val = ZOOM_options_get (c->options, "clientIP");
444 yaz_log(log_details, "%p ZOOM_connection_connect clientIP=%s",
446 c->client_IP = xstrdup (val);
449 c->async = ZOOM_options_get_bool (c->options, "async", 0);
450 yaz_log(log_details, "%p ZOOM_connection_connect async=%d", c, c->async);
452 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
454 task = ZOOM_connection_add_task (c, ZOOM_TASK_CONNECT);
458 while (ZOOM_event (1, &c))
464 ZOOM_query_create(void)
466 ZOOM_query s = (ZOOM_query) xmalloc (sizeof(*s));
468 yaz_log(log_details, "%p ZOOM_query_create", s);
472 s->odr = odr_createmem (ODR_ENCODE);
479 ZOOM_query_destroy(ZOOM_query s)
485 yaz_log(log_details, "%p ZOOM_query_destroy count=%d", s, s->refcount);
486 if (s->refcount == 0)
488 odr_destroy (s->odr);
494 ZOOM_query_prefix(ZOOM_query s, const char *str)
496 s->query_string = odr_strdup(s->odr, str);
497 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
498 s->z_query->which = Z_Query_type_1;
499 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
500 if (!s->z_query->u.type_1)
502 yaz_log(log_details, "%p ZOOM_query_prefix str=%s failed", s, str);
506 yaz_log(log_details, "%p ZOOM_query_prefix str=%s", s, str);
511 ZOOM_query_cql(ZOOM_query s, const char *str)
515 s->query_string = odr_strdup(s->odr, str);
517 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
518 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
519 ext->indirect_reference = 0;
521 ext->which = Z_External_CQL;
522 ext->u.cql = s->query_string;
524 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
525 s->z_query->which = Z_Query_type_104;
526 s->z_query->u.type_104 = ext;
528 yaz_log(log_details, "%p ZOOM_query_cql str=%s", s, str);
534 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
536 s->sort_spec = yaz_sort_spec (s->odr, criteria);
539 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s failed",
543 yaz_log(log_details, "%p ZOOM_query_sortby criteria=%s", s, criteria);
547 static zoom_ret do_write(ZOOM_connection c);
550 ZOOM_connection_destroy(ZOOM_connection c)
555 yaz_log(log_api, "%p ZOOM_connection_destroy", c);
558 for (r = c->resultsets; r; r = r->next)
564 odr_destroy (c->odr_in);
565 odr_destroy (c->odr_out);
566 ZOOM_options_destroy (c->options);
567 ZOOM_connection_remove_tasks (c);
568 xfree (c->host_port);
573 xfree (c->cookie_out);
574 xfree (c->cookie_in);
575 xfree (c->client_IP);
579 void ZOOM_resultset_addref (ZOOM_resultset r)
584 yaz_log(log_details, "%p ZOOM_resultset_addref count=%d",
589 ZOOM_resultset ZOOM_resultset_create ()
591 ZOOM_resultset r = (ZOOM_resultset) xmalloc (sizeof(*r));
595 yaz_log(log_details, "%p ZOOM_resultset_create", r);
598 r->odr = odr_createmem (ODR_ENCODE);
613 ZOOM_API(ZOOM_resultset)
614 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
617 ZOOM_query s = ZOOM_query_create();
619 ZOOM_query_prefix (s, q);
621 r = ZOOM_connection_search (c, s);
622 ZOOM_query_destroy (s);
626 ZOOM_API(ZOOM_resultset)
627 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
629 ZOOM_resultset r = ZOOM_resultset_create ();
633 yaz_log(log_api, "%p ZOOM_connection_search set %p query %p", c, r, q);
634 r->r_sort_spec = q->sort_spec;
637 r->options = ZOOM_options_create_with_parent(c->options);
639 r->start = ZOOM_options_get_int(r->options, "start", 0);
640 r->count = ZOOM_options_get_int(r->options, "count", 0);
642 /* If "presentChunk" is defined use that; otherwise "step" */
643 const char *cp = ZOOM_options_get (r->options, "presentChunk");
644 r->step = ZOOM_options_get_int(r->options,
645 (cp != 0 ? "presentChunk": "step"), 0);
647 r->piggyback = ZOOM_options_get_bool (r->options, "piggyback", 1);
648 cp = ZOOM_options_get (r->options, "setname");
650 r->setname = xstrdup(cp);
651 cp = ZOOM_options_get (r->options, "schema");
653 r->schema = xstrdup(cp);
657 r->next = c->resultsets;
660 if (c->host_port && c->proto == PROTO_HTTP)
664 yaz_log(log_details, "ZOOM_connection_search: no comstack");
665 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
669 yaz_log(log_details, "ZOOM_connection_search: reconnect");
674 task = ZOOM_connection_add_task (c, ZOOM_TASK_SEARCH);
675 task->u.search.resultset = r;
676 ZOOM_resultset_addref (r);
682 while (ZOOM_event (1, &c))
689 * This is the old result-set sorting API, which is maintained only
690 * for the sake of binary compatibility. There is no reason ever to
691 * use this rather than ZOOM_resultset_sort1().
694 ZOOM_resultset_sort(ZOOM_resultset r,
695 const char *sort_type, const char *sort_spec)
697 (void) ZOOM_resultset_sort1(r, sort_type, sort_spec);
701 ZOOM_resultset_sort1(ZOOM_resultset r,
702 const char *sort_type, const char *sort_spec)
704 ZOOM_connection c = r->connection;
708 newq = ZOOM_query_create();
709 if (ZOOM_query_sortby(newq, sort_spec) < 0)
712 yaz_log(log_api, "%p ZOOM_resultset_sort r=%p sort_type=%s sort_spec=%s",
713 r, r, sort_type, sort_spec);
717 if (c->host_port && c->proto == PROTO_HTTP)
721 yaz_log(log_details, "%p ZOOM_resultset_sort: no comstack", r);
722 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
726 yaz_log(log_details, "%p ZOOM_resultset_sort: prepare reconnect",
732 ZOOM_resultset_cache_reset(r);
733 task = ZOOM_connection_add_task (c, ZOOM_TASK_SORT);
734 task->u.sort.resultset = r;
735 task->u.sort.q = newq;
737 ZOOM_resultset_addref (r);
741 while (ZOOM_event (1, &c))
749 ZOOM_resultset_cache_reset(ZOOM_resultset r)
751 ZOOM_record_cache rc;
753 for (rc = r->record_cache; rc; rc = rc->next)
755 if (rc->rec.wrbuf_marc)
756 wrbuf_free (rc->rec.wrbuf_marc, 1);
757 if (rc->rec.wrbuf_iconv)
758 wrbuf_free (rc->rec.wrbuf_iconv, 1);
759 if (rc->rec.wrbuf_opac)
760 wrbuf_free (rc->rec.wrbuf_opac, 1);
766 ZOOM_resultset_destroy(ZOOM_resultset r)
771 yaz_log(log_details, "%p ZOOM_resultset_destroy r=%p count=%d",
773 if (r->refcount == 0)
775 ZOOM_resultset_cache_reset(r);
779 /* remove ourselves from the resultsets in connection */
780 ZOOM_resultset *rp = &r->connection->resultsets;
783 assert (*rp); /* we must be in this list!! */
785 { /* OK, we're here - take us out of it */
792 ZOOM_query_destroy (r->query);
793 ZOOM_options_destroy (r->options);
794 odr_destroy (r->odr);
802 ZOOM_resultset_size (ZOOM_resultset r)
807 static void do_close (ZOOM_connection c)
813 c->state = STATE_IDLE;
816 static void ZOOM_resultset_retrieve (ZOOM_resultset r,
817 int force_sync, int start, int count)
825 yaz_log(log_details, "%p ZOOM_resultset_retrieve force_sync=%d start=%d"
826 " count=%d", r, force_sync, start, count);
831 if (c->host_port && c->proto == PROTO_HTTP)
835 yaz_log(log_details, "%p ZOOM_resultset_retrieve: no comstack", r);
836 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
840 yaz_log(log_details, "%p ZOOM_resultset_retrieve: prepare "
845 task = ZOOM_connection_add_task (c, ZOOM_TASK_RETRIEVE);
846 task->u.retrieve.resultset = r;
847 task->u.retrieve.start = start;
848 task->u.retrieve.count = count;
850 cp = ZOOM_options_get (r->options, "schema");
853 if (!r->schema || strcmp(r->schema, cp))
856 r->schema = xstrdup(cp);
860 ZOOM_resultset_addref (r);
862 if (!r->connection->async || force_sync)
863 while (r->connection && ZOOM_event (1, &r->connection))
868 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
869 size_t start, size_t count)
871 int force_present = 0;
875 yaz_log(log_api, "%p ZOOM_resultset_records r=%p start=%d count=%d",
879 ZOOM_resultset_retrieve (r, force_present, start, count);
883 for (i = 0; i< count; i++)
884 recs[i] = ZOOM_resultset_record_immediate (r, i+start);
888 static void get_cert(ZOOM_connection c)
893 if (cs_get_peer_certificate_x509(c->cs, &cert_buf, &cert_len))
895 ZOOM_connection_option_setl(c, "sslPeerCert",
901 static zoom_ret do_connect (ZOOM_connection c)
904 const char *effective_host;
907 effective_host = c->proxy;
909 effective_host = c->host_port;
911 yaz_log(log_details, "%p do_connect effective_host=%s", c, effective_host);
915 c->cs = cs_create_host (effective_host, 0, &add);
917 if (c->cs && c->cs->protocol == PROTO_HTTP)
920 const char *path = 0;
922 c->proto = PROTO_HTTP;
923 cs_get_host_args(c->host_port, &path);
925 c->path = (char*) xmalloc(strlen(path)+2);
927 strcpy (c->path+1, path);
929 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
931 return zoom_complete;
936 int ret = cs_connect (c->cs, add);
939 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
940 ZOOM_connection_put_event(c, event);
942 if (c->proto == PROTO_Z3950)
943 ZOOM_connection_send_init(c);
946 /* no init request for SRW .. */
947 assert (c->tasks->which == ZOOM_TASK_CONNECT);
948 ZOOM_connection_remove_task (c);
950 ZOOM_connection_exec_task (c);
952 c->state = STATE_ESTABLISHED;
957 c->state = STATE_CONNECTING;
958 c->mask = ZOOM_SELECT_EXCEPT;
959 if (c->cs->io_pending & CS_WANT_WRITE)
960 c->mask += ZOOM_SELECT_WRITE;
961 if (c->cs->io_pending & CS_WANT_READ)
962 c->mask += ZOOM_SELECT_READ;
966 c->state = STATE_IDLE;
967 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
968 return zoom_complete;
971 int z3950_connection_socket(ZOOM_connection c)
974 return cs_fileno(c->cs);
978 int z3950_connection_mask(ZOOM_connection c)
985 static void otherInfo_attach (ZOOM_connection c, Z_APDU *a, ODR out)
988 for (i = 0; i<200; i++)
991 Z_OtherInformation **oi;
997 sprintf (buf, "otherInfo%d", i);
998 val = ZOOM_options_get (c->options, buf);
1001 cp = strchr(val, ':');
1005 if (len >= sizeof(buf))
1006 len = sizeof(buf)-1;
1007 memcpy (buf, val, len);
1009 oidval = oid_getvalbyname (buf);
1010 if (oidval == VAL_NONE)
1013 yaz_oi_APDU(a, &oi);
1014 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
1018 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
1023 Z_OtherInformation **oi;
1024 yaz_oi_APDU(a, &oi);
1025 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
1029 Z_OtherInformation **oi;
1030 yaz_oi_APDU(a, &oi);
1031 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
1033 otherInfo_attach (c, a, out);
1034 if (!z_APDU(out, &a, 0, 0))
1036 FILE *outf = fopen("/tmp/apdu.txt", "a");
1039 ODR odr_pr = odr_createmem(ODR_PRINT);
1040 fprintf (outf, "a=%p\n", a);
1041 odr_setprint(odr_pr, outf);
1042 z_APDU(odr_pr, &a, 0, 0);
1043 odr_destroy(odr_pr);
1045 yaz_log(log_api, "%p encoding_APDU: encoding failed", c);
1046 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
1050 yaz_log(log_details, "%p encoding_APDU encoding OK", c);
1054 static zoom_ret send_APDU (ZOOM_connection c, Z_APDU *a)
1058 if (encode_APDU(c, a, c->odr_out))
1059 return zoom_complete;
1060 yaz_log(log_details, "%p send APDU type=%d", c, a->which);
1061 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1062 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1063 ZOOM_connection_put_event (c, event);
1064 odr_reset(c->odr_out);
1065 return do_write (c);
1068 /* returns 1 if PDU was sent OK (still pending )
1069 0 if PDU was not sent OK (nothing to wait for)
1072 static zoom_ret ZOOM_connection_send_init (ZOOM_connection c)
1074 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
1075 Z_InitRequest *ireq = apdu->u.initRequest;
1076 Z_IdAuthentication *auth = (Z_IdAuthentication *)
1077 odr_malloc(c->odr_out, sizeof(*auth));
1078 const char *auth_groupId = ZOOM_options_get (c->options, "group");
1079 const char *auth_userId = ZOOM_options_get (c->options, "user");
1080 const char *auth_password = ZOOM_options_get (c->options, "password");
1083 /* support the pass for backwards compatibility */
1085 auth_password = ZOOM_options_get (c->options, "pass");
1087 ODR_MASK_SET(ireq->options, Z_Options_search);
1088 ODR_MASK_SET(ireq->options, Z_Options_present);
1089 ODR_MASK_SET(ireq->options, Z_Options_scan);
1090 ODR_MASK_SET(ireq->options, Z_Options_sort);
1091 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
1092 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
1094 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
1095 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
1096 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
1098 /* Index Data's Z39.50 Implementor Id is 81 */
1099 ireq->implementationId = odr_prepend(c->odr_out,
1100 ZOOM_options_get(c->options, "implementationId"),
1101 odr_prepend(c->odr_out, "81", ireq->implementationId));
1103 ireq->implementationName = odr_prepend(c->odr_out,
1104 ZOOM_options_get(c->options, "implementationName"),
1105 odr_prepend(c->odr_out, "ZOOM-C", ireq->implementationName));
1107 version = odr_strdup(c->odr_out, "$Revision: 1.61 $");
1108 if (strlen(version) > 10) /* check for unexpanded CVS strings */
1109 version[strlen(version)-2] = '\0';
1110 ireq->implementationVersion = odr_prepend(c->odr_out,
1111 ZOOM_options_get(c->options, "implementationVersion"),
1112 odr_prepend(c->odr_out, &version[11], ireq->implementationVersion));
1114 *ireq->maximumRecordSize =
1115 ZOOM_options_get_int (c->options, "maximumRecordSize", 1024*1024);
1116 *ireq->preferredMessageSize =
1117 ZOOM_options_get_int (c->options, "preferredMessageSize", 1024*1024);
1119 if (auth_groupId || auth_password)
1121 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1124 if (auth_groupId && *auth_groupId)
1126 pass->groupId = (char *)
1127 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1128 strcpy(pass->groupId, auth_groupId);
1132 if (auth_userId && *auth_userId)
1134 pass->userId = (char *)
1135 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1136 strcpy(pass->userId, auth_userId);
1140 if (auth_password && *auth_password)
1142 pass->password = (char *)
1143 odr_malloc(c->odr_out, strlen(auth_password)+1);
1144 strcpy(pass->password, auth_password);
1149 auth->which = Z_IdAuthentication_idPass;
1150 auth->u.idPass = pass;
1151 ireq->idAuthentication = auth;
1154 else if (auth_userId)
1156 auth->which = Z_IdAuthentication_open;
1157 auth->u.open = (char *)
1158 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1159 strcpy(auth->u.open, auth_userId);
1160 ireq->idAuthentication = auth;
1163 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1164 VAL_PROXY, 1, c->host_port);
1165 if (c->charset || c->lang)
1167 Z_OtherInformation **oi;
1168 Z_OtherInformationUnit *oi_unit;
1170 yaz_oi_APDU(apdu, &oi);
1172 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1174 char **charsets_addresses = 0;
1175 char **langs_addresses = 0;
1176 int charsets_count = 0;
1177 int langs_count = 0;
1180 nmem_strsplit_blank(c->odr_out->mem, c->charset,
1181 &charsets_addresses, &charsets_count);
1183 nmem_strsplit_blank(c->odr_out->mem, c->lang,
1184 &langs_addresses, &langs_count);
1185 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1186 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1187 oi_unit->information.externallyDefinedInfo =
1188 yaz_set_proposal_charneg(c->odr_out,
1189 (const char **) charsets_addresses,
1191 (const char **) langs_addresses,
1197 return send_APDU (c, apdu);
1201 static zoom_ret send_srw (ZOOM_connection c, Z_SRW_PDU *sr)
1204 Z_SOAP_Handler h[2] = {
1205 {"http://www.loc.gov/zing/srw/", 0, (Z_SOAP_fun) yaz_srw_codec},
1208 ODR o = odr_createmem(ODR_ENCODE);
1210 Z_SOAP *p = (Z_SOAP*) odr_malloc(o, sizeof(*p));
1214 gdu = z_get_HTTP_Request(c->odr_out);
1215 gdu->u.HTTP_Request->path = c->path;
1219 const char *cp0 = strstr(c->host_port, "://");
1220 const char *cp1 = 0;
1226 cp1 = strchr(cp0, '/');
1228 cp1 = cp0+strlen(cp0);
1232 char *h = (char*) odr_malloc(c->odr_out, cp1 - cp0 + 1);
1233 memcpy (h, cp0, cp1 - cp0);
1235 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1240 strcpy(ctype, "text/xml");
1241 if (c->charset && strlen(c->charset) < 20)
1243 strcat(ctype, "; charset=");
1244 strcat(ctype, c->charset);
1246 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1247 "Content-Type", ctype);
1248 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1249 "SOAPAction", "\"\"");
1250 p->which = Z_SOAP_generic;
1251 p->u.generic = (Z_SOAP_Generic *) odr_malloc(o, sizeof(*p->u.generic));
1252 p->u.generic->no = 0;
1253 p->u.generic->ns = 0;
1254 p->u.generic->p = sr;
1255 p->ns = "http://schemas.xmlsoap.org/soap/envelope/";
1257 ret = z_soap_codec_enc(o, &p,
1258 &gdu->u.HTTP_Request->content_buf,
1259 &gdu->u.HTTP_Request->content_len, h,
1262 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1263 return zoom_complete;
1264 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1268 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1269 ZOOM_connection_put_event (c, event);
1270 odr_reset(c->odr_out);
1271 return do_write (c);
1276 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1279 ZOOM_resultset resultset = 0;
1281 const char *recordPacking = 0;
1283 if (c->error) /* don't continue on error */
1284 return zoom_complete;
1286 if (c->tasks->which == ZOOM_TASK_SEARCH)
1288 resultset = c->tasks->u.search.resultset;
1289 resultset->setname = xstrdup ("default");
1290 ZOOM_options_set (resultset->options, "setname", resultset->setname);
1292 else if(c->tasks->which == ZOOM_TASK_RETRIEVE)
1294 resultset = c->tasks->u.retrieve.resultset;
1296 resultset->start = c->tasks->u.retrieve.start;
1297 resultset->count = c->tasks->u.retrieve.count;
1299 if (resultset->start >= resultset->size)
1300 return zoom_complete;
1301 if (resultset->start + resultset->count > resultset->size)
1302 resultset->count = resultset->size - resultset->start;
1304 for (i = 0; i<resultset->count; i++)
1307 record_cache_lookup (resultset, i + resultset->start);
1311 if (i == resultset->count)
1312 return zoom_complete;
1314 assert(resultset->query);
1316 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1318 if (resultset->query->z_query->which == Z_Query_type_104
1319 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1322 sr->u.request->query_type = Z_SRW_query_type_cql;
1323 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1325 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1326 resultset->query->z_query->u.type_1)
1328 sr->u.request->query_type = Z_SRW_query_type_pqf;
1329 sr->u.request->query.pqf = resultset->query->query_string;
1333 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1334 return zoom_complete;
1336 sr->u.request->startRecord = odr_intdup (c->odr_out, resultset->start + 1);
1337 sr->u.request->maximumRecords = odr_intdup (
1338 c->odr_out, resultset->step>0 ? resultset->step : resultset->count);
1339 sr->u.request->recordSchema = resultset->schema;
1341 recordPacking = ZOOM_resultset_option_get (resultset, "recordPacking");
1344 sr->u.request->recordPacking = odr_strdup(c->odr_out, recordPacking);
1346 return send_srw(c, sr);
1349 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1351 return zoom_complete;
1355 static zoom_ret ZOOM_connection_send_search (ZOOM_connection c)
1358 int lslb, ssub, mspn;
1360 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1361 Z_SearchRequest *search_req = apdu->u.searchRequest;
1362 const char *elementSetName;
1363 const char *smallSetElementSetName;
1364 const char *mediumSetElementSetName;
1367 assert (c->tasks->which == ZOOM_TASK_SEARCH);
1369 r = c->tasks->u.search.resultset;
1371 yaz_log(log_details, "%p ZOOM_connection_send_search set=%p", c, r);
1374 ZOOM_options_get (r->options, "elementSetName");
1375 smallSetElementSetName =
1376 ZOOM_options_get (r->options, "smallSetElementSetName");
1377 mediumSetElementSetName =
1378 ZOOM_options_get (r->options, "mediumSetElementSetName");
1380 if (!smallSetElementSetName)
1381 smallSetElementSetName = elementSetName;
1383 if (!mediumSetElementSetName)
1384 mediumSetElementSetName = elementSetName;
1389 /* prepare query for the search request */
1390 search_req->query = r->query->z_query;
1391 if (!search_req->query)
1393 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1394 return zoom_complete;
1397 search_req->databaseNames =
1398 set_DatabaseNames (c, r->options, &search_req->num_databaseNames);
1400 /* get syntax (no need to provide unless piggyback is in effect) */
1401 syntax = ZOOM_options_get (r->options, "preferredRecordSyntax");
1403 lslb = ZOOM_options_get_int (r->options, "largeSetLowerBound", -1);
1404 ssub = ZOOM_options_get_int (r->options, "smallSetUpperBound", -1);
1405 mspn = ZOOM_options_get_int (r->options, "mediumSetPresentNumber", -1);
1406 if (lslb != -1 && ssub != -1 && mspn != -1)
1408 /* So're a Z39.50 expert? Let's hope you don't do sort */
1409 *search_req->largeSetLowerBound = lslb;
1410 *search_req->smallSetUpperBound = ssub;
1411 *search_req->mediumSetPresentNumber = mspn;
1413 else if (r->start == 0 && r->count > 0
1414 && r->piggyback && !r->r_sort_spec && !r->schema)
1416 /* Regular piggyback - do it unless we're going to do sort */
1417 *search_req->largeSetLowerBound = 2000000000;
1418 *search_req->smallSetUpperBound = 1;
1419 *search_req->mediumSetPresentNumber = r->step>0 ? r->step : r->count;
1423 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1424 smallSetElementSetName = 0;
1425 mediumSetElementSetName = 0;
1428 if (smallSetElementSetName && *smallSetElementSetName)
1430 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1431 odr_malloc (c->odr_out, sizeof(*esn));
1433 esn->which = Z_ElementSetNames_generic;
1434 esn->u.generic = odr_strdup (c->odr_out, smallSetElementSetName);
1435 search_req->smallSetElementSetNames = esn;
1437 if (mediumSetElementSetName && *mediumSetElementSetName)
1439 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1440 odr_malloc (c->odr_out, sizeof(*esn));
1442 esn->which = Z_ElementSetNames_generic;
1443 esn->u.generic = odr_strdup (c->odr_out, mediumSetElementSetName);
1444 search_req->mediumSetElementSetNames = esn;
1447 search_req->preferredRecordSyntax =
1448 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1452 if (c->support_named_resultsets)
1456 /* find the lowest unused ordinal so that we re-use
1457 result sets on the server. */
1458 for (ord = 1; ; ord++)
1461 sprintf (setname, "%d", ord);
1462 for (rp = c->resultsets; rp; rp = rp->next)
1463 if (rp->setname && !strcmp (rp->setname, setname))
1468 r->setname = xstrdup (setname);
1469 yaz_log(log_details, "%p ZOOM_connection_send_search: allocating "
1470 "set %s", c, r->setname);
1474 yaz_log(log_details, "%p ZOOM_connection_send_search: using "
1476 r->setname = xstrdup ("default");
1478 ZOOM_options_set (r->options, "setname", r->setname);
1480 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1481 return send_APDU (c, apdu);
1484 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
1491 case Z_DefaultDiagFormat_v2Addinfo:
1492 addinfo = r->u.v2Addinfo;
1494 case Z_DefaultDiagFormat_v3Addinfo:
1495 addinfo = r->u.v3Addinfo;
1500 set_dset_error(c, *r->condition,
1501 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1505 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
1507 if (p->which != Z_DiagRec_defaultFormat)
1508 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1510 response_default_diag(c, p->u.defaultFormat);
1513 ZOOM_API(ZOOM_record)
1514 ZOOM_record_clone (ZOOM_record srec)
1521 odr_enc = odr_createmem(ODR_ENCODE);
1522 if (!z_NamePlusRecord (odr_enc, &srec->npr, 0, 0))
1524 buf = odr_getbuf (odr_enc, &size, 0);
1526 nrec = (ZOOM_record) xmalloc (sizeof(*nrec));
1527 nrec->odr = odr_createmem(ODR_DECODE);
1528 nrec->wrbuf_marc = 0;
1529 nrec->wrbuf_iconv = 0;
1530 nrec->wrbuf_opac = 0;
1531 odr_setbuf (nrec->odr, buf, size, 0);
1532 z_NamePlusRecord (nrec->odr, &nrec->npr, 0, 0);
1534 odr_destroy (odr_enc);
1538 ZOOM_API(ZOOM_record)
1539 ZOOM_resultset_record_immediate (ZOOM_resultset s,size_t pos)
1541 return record_cache_lookup (s, pos);
1544 ZOOM_API(ZOOM_record)
1545 ZOOM_resultset_record (ZOOM_resultset r, size_t pos)
1547 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1551 ZOOM_resultset_retrieve (r, 1, pos, 1);
1552 rec = ZOOM_resultset_record_immediate (r, pos);
1558 ZOOM_record_destroy (ZOOM_record rec)
1562 if (rec->wrbuf_marc)
1563 wrbuf_free (rec->wrbuf_marc, 1);
1564 if (rec->wrbuf_iconv)
1565 wrbuf_free (rec->wrbuf_iconv, 1);
1566 if (rec->wrbuf_opac)
1567 wrbuf_free (rec->wrbuf_opac, 1);
1568 odr_destroy (rec->odr);
1572 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1574 const char *buf, int sz,
1575 const char *record_charset)
1580 yaz_marc_t mt = yaz_marc_create();
1583 strcpy(to, "UTF-8");
1584 if (record_charset && *record_charset)
1586 /* Use "from,to" or just "from" */
1587 const char *cp = strchr(record_charset, ',');
1588 int clen = strlen(record_charset);
1591 strncpy( to, cp+1, sizeof(to)-1);
1592 to[sizeof(to)-1] = '\0';
1593 clen = cp - record_charset;
1595 if (clen > sizeof(from)-1)
1596 clen = sizeof(from)-1;
1599 strncpy(from, record_charset, clen);
1605 cd = yaz_iconv_open(to, from);
1606 yaz_marc_iconv(mt, cd);
1609 yaz_marc_xml(mt, marc_type);
1610 if (!rec->wrbuf_marc)
1611 rec->wrbuf_marc = wrbuf_alloc();
1612 wrbuf_rewind (rec->wrbuf_marc);
1613 if (yaz_marc_decode_wrbuf (mt, buf, sz, rec->wrbuf_marc) > 0)
1615 yaz_marc_destroy(mt);
1617 yaz_iconv_close(cd);
1619 *len = wrbuf_len(rec->wrbuf_marc);
1620 return wrbuf_buf(rec->wrbuf_marc);
1622 yaz_marc_destroy(mt);
1624 yaz_iconv_close(cd);
1628 static const char *record_iconv_return(ZOOM_record rec, int *len,
1629 const char *buf, int sz,
1630 const char *record_charset)
1637 strcpy(to, "UTF-8");
1638 if (record_charset && *record_charset)
1640 /* Use "from,to" or just "from" */
1641 const char *cp = strchr(record_charset, ',');
1642 int clen = strlen(record_charset);
1645 strncpy( to, cp+1, sizeof(to)-1);
1646 to[sizeof(to)-1] = '\0';
1647 clen = cp - record_charset;
1649 if (clen > sizeof(from)-1)
1650 clen = sizeof(from)-1;
1653 strncpy(from, record_charset, clen);
1657 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1660 size_t inbytesleft = sz;
1661 const char *inp = buf;
1663 if (!rec->wrbuf_iconv)
1664 rec->wrbuf_iconv = wrbuf_alloc();
1666 wrbuf_rewind(rec->wrbuf_iconv);
1670 size_t outbytesleft = sizeof(outbuf);
1671 char *outp = outbuf;
1672 size_t r = yaz_iconv (cd, (char**) &inp,
1674 &outp, &outbytesleft);
1675 if (r == (size_t) (-1))
1677 int e = yaz_iconv_error(cd);
1678 if (e != YAZ_ICONV_E2BIG)
1681 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1683 wrbuf_puts(rec->wrbuf_iconv, "");
1684 buf = wrbuf_buf(rec->wrbuf_iconv);
1685 sz = wrbuf_len(rec->wrbuf_iconv);
1686 yaz_iconv_close(cd);
1693 ZOOM_API(const char *)
1694 ZOOM_record_get (ZOOM_record rec, const char *type_spec, int *len)
1701 Z_NamePlusRecord *npr;
1704 *len = 0; /* default return */
1713 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1715 if (cp[i] == ';' || cp[i] == ' ')
1721 while (type_spec[i] == ';')
1724 while (type_spec[i] == ' ')
1726 if (!strncmp(type_spec+i, "charset=", 8))
1729 i = i + 8; /* skip charset= */
1730 for (j = 0; type_spec[i] && j < sizeof(charset)-1; i++, j++)
1732 if (type_spec[i] == ';' || type_spec[i] == ' ')
1738 else if (!strncmp(type_spec+i, "xpath=", 6))
1742 for (j = 0; type_spec[i] && j < sizeof(xpath)-1; i++, j++)
1746 while (type_spec[i] == ' ')
1749 if (!strcmp (type, "database"))
1752 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1753 return npr->databaseName;
1755 else if (!strcmp (type, "syntax"))
1757 const char *desc = 0;
1758 if (npr->which == Z_NamePlusRecord_databaseRecord)
1760 Z_External *r = (Z_External *) npr->u.databaseRecord;
1761 oident *ent = oid_getentbyoid(r->direct_reference);
1768 *len = strlen(desc);
1771 if (npr->which != Z_NamePlusRecord_databaseRecord)
1774 /* from now on - we have a database record .. */
1775 if (!strcmp (type, "render"))
1777 Z_External *r = (Z_External *) npr->u.databaseRecord;
1778 oident *ent = oid_getentbyoid(r->direct_reference);
1780 /* render bibliographic record .. */
1781 if (r->which == Z_External_OPAC)
1783 r = r->u.opac->bibliographicRecord;
1786 ent = oid_getentbyoid(r->direct_reference);
1788 if (r->which == Z_External_sutrs)
1789 return record_iconv_return(rec, len,
1790 (char*) r->u.sutrs->buf,
1793 else if (r->which == Z_External_octet)
1795 const char *ret_buf;
1803 case VAL_APPLICATION_XML:
1806 ret_buf = marc_iconv_return(
1807 rec, YAZ_MARC_LINE, len,
1808 (const char *) r->u.octet_aligned->buf,
1809 r->u.octet_aligned->len,
1814 return record_iconv_return(rec, len,
1815 (const char *) r->u.octet_aligned->buf,
1816 r->u.octet_aligned->len,
1819 else if (r->which == Z_External_grs1)
1821 if (!rec->wrbuf_marc)
1822 rec->wrbuf_marc = wrbuf_alloc();
1823 wrbuf_rewind (rec->wrbuf_marc);
1824 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1825 return record_iconv_return(rec, len,
1826 wrbuf_buf(rec->wrbuf_marc),
1827 wrbuf_len(rec->wrbuf_marc),
1832 else if (!strcmp (type, "xml") || !strcmp(type, "oai"))
1834 Z_External *r = (Z_External *) npr->u.databaseRecord;
1835 oident *ent = oid_getentbyoid(r->direct_reference);
1837 /* render bibliographic record .. */
1838 if (r->which == Z_External_OPAC)
1840 r = r->u.opac->bibliographicRecord;
1843 ent = oid_getentbyoid(r->direct_reference);
1846 if (r->which == Z_External_sutrs)
1847 return record_iconv_return(rec, len,
1848 (const char *) r->u.sutrs->buf,
1851 else if (r->which == Z_External_octet)
1853 const char *ret_buf;
1854 int marc_decode_type = YAZ_MARC_MARCXML;
1856 if (!strcmp(type, "oai"))
1857 marc_decode_type = YAZ_MARC_OAIMARC;
1865 case VAL_APPLICATION_XML:
1868 ret_buf = marc_iconv_return(
1869 rec, marc_decode_type, len,
1870 (const char *) r->u.octet_aligned->buf,
1871 r->u.octet_aligned->len,
1876 return record_iconv_return(rec, len,
1877 (const char *) r->u.octet_aligned->buf,
1878 r->u.octet_aligned->len,
1881 else if (r->which == Z_External_grs1)
1888 else if (!strcmp (type, "raw"))
1890 Z_External *r = (Z_External *) npr->u.databaseRecord;
1892 if (r->which == Z_External_sutrs)
1894 if (len) *len = r->u.sutrs->len;
1895 return (const char *) r->u.sutrs->buf;
1897 else if (r->which == Z_External_octet)
1899 if (len) *len = r->u.octet_aligned->len;
1900 return (const char *) r->u.octet_aligned->buf;
1902 else /* grs-1, explain, OPAC, ... */
1905 return (const char *) npr->u.databaseRecord;
1909 else if (!strcmp (type, "ext"))
1912 return (const char *) npr->u.databaseRecord;
1914 else if (!strcmp (type, "opac"))
1917 Z_External *r = (Z_External *) npr->u.databaseRecord;
1918 if (r->which == Z_External_OPAC)
1920 if (!rec->wrbuf_opac)
1921 rec->wrbuf_opac = wrbuf_alloc();
1922 wrbuf_rewind (rec->wrbuf_opac);
1923 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
1924 return record_iconv_return(rec, len,
1925 wrbuf_buf(rec->wrbuf_opac),
1926 wrbuf_len(rec->wrbuf_opac),
1933 static int strcmp_null(const char *v1, const char *v2)
1939 return strcmp(v1, v2);
1942 static void record_cache_add (ZOOM_resultset r, Z_NamePlusRecord *npr,
1945 ZOOM_record_cache rc;
1946 const char *elementSetName =
1947 ZOOM_resultset_option_get (r, "elementSetName");
1948 const char *syntax =
1949 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
1951 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1952 ZOOM_connection_put_event(r->connection, event);
1954 for (rc = r->record_cache; rc; rc = rc->next)
1958 if (strcmp_null(r->schema, rc->schema))
1960 if (strcmp_null(elementSetName,rc->elementSetName))
1962 if (strcmp_null(syntax, rc->syntax))
1964 /* not destroying rc->npr (it's handled by nmem )*/
1966 /* keeping wrbuf_marc too */
1970 rc = (ZOOM_record_cache) odr_malloc (r->odr, sizeof(*rc));
1973 rc->rec.wrbuf_marc = 0;
1974 rc->rec.wrbuf_iconv = 0;
1975 rc->rec.wrbuf_opac = 0;
1977 rc->elementSetName = odr_strdup (r->odr, elementSetName);
1979 rc->elementSetName = 0;
1982 rc->syntax = odr_strdup (r->odr, syntax);
1987 rc->schema = odr_strdup (r->odr, r->schema);
1992 rc->next = r->record_cache;
1993 r->record_cache = rc;
1996 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos)
1998 ZOOM_record_cache rc;
1999 const char *elementSetName =
2000 ZOOM_resultset_option_get (r, "elementSetName");
2001 const char *syntax =
2002 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
2004 for (rc = r->record_cache; rc; rc = rc->next)
2008 if (strcmp_null(r->schema, rc->schema))
2010 if (strcmp_null(elementSetName,rc->elementSetName))
2012 if (strcmp_null(syntax, rc->syntax))
2020 static void handle_records (ZOOM_connection c, Z_Records *sr,
2023 ZOOM_resultset resultset;
2027 switch (c->tasks->which)
2029 case ZOOM_TASK_SEARCH:
2030 resultset = c->tasks->u.search.resultset;
2032 case ZOOM_TASK_RETRIEVE:
2033 resultset = c->tasks->u.retrieve.resultset;
2038 if (sr && sr->which == Z_Records_NSD)
2039 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
2040 else if (sr && sr->which == Z_Records_multipleNSD)
2042 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
2043 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
2045 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2049 if (resultset->count + resultset->start > resultset->size)
2050 resultset->count = resultset->size - resultset->start;
2051 if (resultset->count < 0)
2052 resultset->count = 0;
2053 if (sr && sr->which == Z_Records_DBOSD)
2056 NMEM nmem = odr_extract_mem (c->odr_in);
2057 Z_NamePlusRecordList *p =
2058 sr->u.databaseOrSurDiagnostics;
2059 for (i = 0; i<p->num_records; i++)
2061 record_cache_add (resultset, p->records[i],
2062 i+ resultset->start);
2064 /* transfer our response to search_nmem .. we need it later */
2065 nmem_transfer (resultset->odr->mem, nmem);
2066 nmem_destroy (nmem);
2067 if (present_phase && p->num_records == 0)
2069 /* present response and we didn't get any records! */
2070 Z_NamePlusRecord *myrec =
2071 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2072 record_cache_add(resultset, myrec, resultset->start);
2075 else if (present_phase)
2077 /* present response and we didn't get any records! */
2078 Z_NamePlusRecord *myrec =
2079 zget_surrogateDiagRec(resultset->odr, 0, 14, 0);
2080 record_cache_add(resultset, myrec, resultset->start);
2085 static void handle_present_response (ZOOM_connection c, Z_PresentResponse *pr)
2087 handle_records (c, pr->records, 1);
2090 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
2093 switch (term->which)
2095 case Z_Term_general:
2096 ZOOM_options_setl(opt, name,
2097 (const char *)(term->u.general->buf),
2098 term->u.general->len);
2100 case Z_Term_characterString:
2101 ZOOM_options_set(opt, name, term->u.characterString);
2103 case Z_Term_numeric:
2104 ZOOM_options_set_int(opt, name, *term->u.numeric);
2109 static void handle_queryExpression(ZOOM_options opt, const char *name,
2110 Z_QueryExpression *exp)
2116 case Z_QueryExpression_term:
2117 if (exp->u.term && exp->u.term->queryTerm)
2119 sprintf(opt_name, "%s.term", name);
2120 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
2123 case Z_QueryExpression_query:
2128 static void handle_searchResult(ZOOM_connection c, ZOOM_resultset resultset,
2129 Z_OtherInformation *o)
2132 for (i = 0; o && i < o->num_elements; i++)
2134 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
2136 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
2138 if (ext->which == Z_External_searchResult1)
2141 Z_SearchInfoReport *sr = ext->u.searchResult1;
2144 ZOOM_options_set_int(
2145 resultset->options, "searchresult.size", sr->num);
2147 for (j = 0; j < sr->num; j++)
2149 Z_SearchInfoReport_s *ent =
2150 ext->u.searchResult1->elements[j];
2153 sprintf(pref, "searchresult.%d", j);
2155 if (ent->subqueryId)
2158 sprintf(opt_name, "%s.id", pref);
2159 ZOOM_options_set(resultset->options, opt_name,
2162 if (ent->subqueryExpression)
2165 sprintf(opt_name, "%s.subquery", pref);
2166 handle_queryExpression(resultset->options, opt_name,
2167 ent->subqueryExpression);
2169 if (ent->subqueryInterpretation)
2172 sprintf(opt_name, "%s.interpretation", pref);
2173 handle_queryExpression(resultset->options, opt_name,
2174 ent->subqueryInterpretation);
2176 if (ent->subqueryRecommendation)
2179 sprintf(opt_name, "%s.recommendation", pref);
2180 handle_queryExpression(resultset->options, opt_name,
2181 ent->subqueryRecommendation);
2183 if (ent->subqueryCount)
2186 sprintf(opt_name, "%s.count", pref);
2187 ZOOM_options_set_int(resultset->options, opt_name,
2188 *ent->subqueryCount);
2196 static void handle_search_response (ZOOM_connection c, Z_SearchResponse *sr)
2198 ZOOM_resultset resultset;
2201 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
2204 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2205 ZOOM_connection_put_event(c, event);
2207 resultset = c->tasks->u.search.resultset;
2209 handle_searchResult(c, resultset, sr->additionalSearchInfo);
2211 resultset->size = *sr->resultCount;
2212 handle_records (c, sr->records, 0);
2215 static void sort_response (ZOOM_connection c, Z_SortResponse *res)
2217 if (res->diagnostics && res->num_diagnostics > 0)
2218 response_diag (c, res->diagnostics[0]);
2221 static int scan_response (ZOOM_connection c, Z_ScanResponse *res)
2223 NMEM nmem = odr_extract_mem (c->odr_in);
2226 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
2228 scan = c->tasks->u.scan.scan;
2230 if (res->entries && res->entries->nonsurrogateDiagnostics)
2231 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
2232 scan->scan_response = res;
2233 nmem_transfer (scan->odr->mem, nmem);
2235 ZOOM_options_set_int (scan->options, "stepSize", *res->stepSize);
2236 if (res->positionOfTerm)
2237 ZOOM_options_set_int (scan->options, "position", *res->positionOfTerm);
2238 if (res->scanStatus)
2239 ZOOM_options_set_int (scan->options, "scanStatus", *res->scanStatus);
2240 if (res->numberOfEntriesReturned)
2241 ZOOM_options_set_int (scan->options, "number",
2242 *res->numberOfEntriesReturned);
2243 nmem_destroy (nmem);
2247 static zoom_ret send_sort (ZOOM_connection c,
2248 ZOOM_resultset resultset)
2251 resultset->r_sort_spec = 0;
2252 if (resultset->r_sort_spec)
2254 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2255 Z_SortRequest *req = apdu->u.sortRequest;
2257 req->num_inputResultSetNames = 1;
2258 req->inputResultSetNames = (Z_InternationalString **)
2259 odr_malloc (c->odr_out, sizeof(*req->inputResultSetNames));
2260 req->inputResultSetNames[0] =
2261 odr_strdup (c->odr_out, resultset->setname);
2262 req->sortedResultSetName = odr_strdup (c->odr_out, resultset->setname);
2263 req->sortSequence = resultset->r_sort_spec;
2264 resultset->r_sort_spec = 0;
2265 return send_APDU (c, apdu);
2267 return zoom_complete;
2270 static zoom_ret send_present(ZOOM_connection c)
2273 Z_PresentRequest *req = 0;
2275 const char *syntax = 0;
2276 const char *elementSetName = 0;
2277 ZOOM_resultset resultset;
2281 yaz_log(log_details, "%p send_present no tasks", c);
2282 return zoom_complete;
2284 switch (c->tasks->which)
2286 case ZOOM_TASK_SEARCH:
2287 resultset = c->tasks->u.search.resultset;
2289 case ZOOM_TASK_RETRIEVE:
2290 resultset = c->tasks->u.retrieve.resultset;
2291 resultset->start = c->tasks->u.retrieve.start;
2292 resultset->count = c->tasks->u.retrieve.count;
2294 if (resultset->start >= resultset->size)
2296 yaz_log(log_details, "%p send_present start=%d >= size=%d",
2297 c, resultset->start, resultset->size);
2298 return zoom_complete;
2300 if (resultset->start + resultset->count > resultset->size)
2301 resultset->count = resultset->size - resultset->start;
2304 return zoom_complete;
2306 yaz_log(log_details, "%p send_present start=%d count=%d",
2307 c, resultset->start, resultset->count);
2309 syntax = ZOOM_resultset_option_get (resultset, "preferredRecordSyntax");
2310 elementSetName = ZOOM_resultset_option_get (resultset, "elementSetName");
2312 if (c->error) /* don't continue on error */
2313 return zoom_complete;
2314 if (resultset->start < 0)
2315 return zoom_complete;
2316 for (i = 0; i<resultset->count; i++)
2319 record_cache_lookup (resultset, i + resultset->start);
2323 if (i == resultset->count)
2325 yaz_log(log_details, "%p send_present skip=%d no more to fetch", c, i);
2326 return zoom_complete;
2329 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2330 req = apdu->u.presentRequest;
2332 resultset->start += i;
2333 resultset->count -= i;
2336 yaz_log(log_details, "%p send_present skip=%d", c, i);
2338 *req->resultSetStartPoint = resultset->start + 1;
2339 *req->numberOfRecordsRequested = resultset->step>0 ?
2340 resultset->step : resultset->count;
2341 assert (*req->numberOfRecordsRequested > 0);
2344 if (syntax && *syntax)
2345 req->preferredRecordSyntax =
2346 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
2348 if (resultset->schema && *resultset->schema)
2350 Z_RecordComposition *compo = (Z_RecordComposition *)
2351 odr_malloc (c->odr_out, sizeof(*compo));
2353 req->recordComposition = compo;
2354 compo->which = Z_RecordComp_complex;
2355 compo->u.complex = (Z_CompSpec *)
2356 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2357 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2358 odr_malloc(c->odr_out, sizeof(bool_t));
2359 *compo->u.complex->selectAlternativeSyntax = 0;
2361 compo->u.complex->generic = (Z_Specification *)
2362 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2364 compo->u.complex->generic->which = Z_Schema_oid;
2365 compo->u.complex->generic->schema.oid = (Odr_oid *)
2366 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2368 if (!compo->u.complex->generic->schema.oid)
2370 /* OID wasn't a schema! Try record syntax instead. */
2372 compo->u.complex->generic->schema.oid = (Odr_oid *)
2373 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2375 if (elementSetName && *elementSetName)
2377 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2378 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2379 compo->u.complex->generic->elementSpec->which =
2380 Z_ElementSpec_elementSetName;
2381 compo->u.complex->generic->elementSpec->u.elementSetName =
2382 odr_strdup (c->odr_out, elementSetName);
2385 compo->u.complex->generic->elementSpec = 0;
2386 compo->u.complex->num_dbSpecific = 0;
2387 compo->u.complex->dbSpecific = 0;
2388 compo->u.complex->num_recordSyntax = 0;
2389 compo->u.complex->recordSyntax = 0;
2391 else if (elementSetName && *elementSetName)
2393 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2394 odr_malloc (c->odr_out, sizeof(*esn));
2395 Z_RecordComposition *compo = (Z_RecordComposition *)
2396 odr_malloc (c->odr_out, sizeof(*compo));
2398 esn->which = Z_ElementSetNames_generic;
2399 esn->u.generic = odr_strdup (c->odr_out, elementSetName);
2400 compo->which = Z_RecordComp_simple;
2401 compo->u.simple = esn;
2402 req->recordComposition = compo;
2404 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2405 return send_APDU (c, apdu);
2408 ZOOM_API(ZOOM_scanset)
2409 ZOOM_connection_scan (ZOOM_connection c, const char *start)
2412 ZOOM_query q = ZOOM_query_create();
2414 ZOOM_query_prefix (q, start);
2416 s = ZOOM_connection_scan1(c, q);
2417 ZOOM_query_destroy (q);
2422 ZOOM_API(ZOOM_scanset)
2423 ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query q)
2425 ZOOM_scanset scan = (ZOOM_scanset) xmalloc (sizeof(*scan));
2429 scan->connection = c;
2430 scan->odr = odr_createmem (ODR_DECODE);
2431 scan->options = ZOOM_options_create_with_parent (c->options);
2433 scan->scan_response = 0;
2436 * We need to check the query-type, so we can recognise CQL and
2437 * compile it into a form that we can use here. The ZOOM_query
2438 * structure has no explicit `type' member, but inspection of the
2439 * ZOOM_query_prefix() and ZOOM_query_cql() functions shows how
2440 * the structure is set up in each case.
2443 if (q->z_query->which == Z_Query_type_1) {
2444 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p PQF '%s'",
2445 c, q, q->query_string);
2446 start = q->query_string;
2447 } else if (q->z_query->which == Z_Query_type_104) {
2448 yaz_log(log_api, "%p ZOOM_connection_scan1 q=%p CQL '%s'",
2449 c, q, q->query_string);
2450 start = freeme = cql2pqf(c, q->query_string);
2454 yaz_log(YLOG_FATAL, "%p ZOOM_connection_scan1 q=%p unknown type '%s'",
2455 c, q, q->query_string);
2459 scan->termListAndStartPoint =
2460 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet, start);
2462 if (scan->termListAndStartPoint != 0)
2464 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_SCAN);
2465 task->u.scan.scan = scan;
2470 while (ZOOM_event (1, &c))
2478 ZOOM_scanset_destroy (ZOOM_scanset scan)
2483 if (scan->refcount == 0)
2485 odr_destroy (scan->odr);
2487 ZOOM_options_destroy (scan->options);
2492 static zoom_ret send_package (ZOOM_connection c)
2496 yaz_log(log_details, "%p send_package", c);
2498 return zoom_complete;
2499 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2501 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
2502 ZOOM_connection_put_event (c, event);
2504 return do_write_ex (c, c->tasks->u.package->buf_out,
2505 c->tasks->u.package->len_out);
2508 static zoom_ret send_scan (ZOOM_connection c)
2511 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2512 Z_ScanRequest *req = apdu->u.scanRequest;
2514 yaz_log(log_details, "%p send_scan", c);
2516 return zoom_complete;
2517 assert (c->tasks->which == ZOOM_TASK_SCAN);
2518 scan = c->tasks->u.scan.scan;
2520 req->termListAndStartPoint = scan->termListAndStartPoint;
2521 req->attributeSet = scan->attributeSet;
2523 *req->numberOfTermsRequested =
2524 ZOOM_options_get_int(scan->options, "number", 10);
2526 req->preferredPositionInResponse =
2527 odr_intdup (c->odr_out,
2528 ZOOM_options_get_int(scan->options, "position", 1));
2531 odr_intdup (c->odr_out,
2532 ZOOM_options_get_int(scan->options, "stepSize", 0));
2534 req->databaseNames = set_DatabaseNames (c, scan->options,
2535 &req->num_databaseNames);
2537 return send_APDU (c, apdu);
2541 ZOOM_scanset_size (ZOOM_scanset scan)
2543 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2545 return scan->scan_response->entries->num_entries;
2548 ZOOM_API(const char *)
2549 ZOOM_scanset_term (ZOOM_scanset scan, size_t pos,
2552 const char *term = 0;
2553 size_t noent = ZOOM_scanset_size (scan);
2554 Z_ScanResponse *res = scan->scan_response;
2560 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2562 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2564 if (t->term->which == Z_Term_general)
2566 term = (const char *) t->term->u.general->buf;
2567 *len = t->term->u.general->len;
2569 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2574 ZOOM_API(const char *)
2575 ZOOM_scanset_display_term (ZOOM_scanset scan, size_t pos,
2578 const char *term = 0;
2579 size_t noent = ZOOM_scanset_size (scan);
2580 Z_ScanResponse *res = scan->scan_response;
2586 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2588 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2592 term = t->displayTerm;
2593 *len = strlen(term);
2595 else if (t->term->which == Z_Term_general)
2597 term = (const char *) t->term->u.general->buf;
2598 *len = t->term->u.general->len;
2600 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2605 ZOOM_API(const char *)
2606 ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key)
2608 return ZOOM_options_get (scan->options, key);
2612 ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
2615 ZOOM_options_set (scan->options, key, val);
2618 static Z_APDU *create_es_package (ZOOM_package p, int type)
2621 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2622 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2624 *req->function = Z_ExtendedServicesRequest_create;
2626 str = ZOOM_options_get(p->options, "package-name");
2628 req->packageName = nmem_strdup (p->odr_out->mem, str);
2630 str = ZOOM_options_get(p->options, "user-id");
2632 req->userId = nmem_strdup (p->odr_out->mem, str);
2634 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2637 str = ZOOM_options_get(p->options, "function");
2640 if (!strcmp (str, "create"))
2642 if (!strcmp (str, "delete"))
2644 if (!strcmp (str, "modify"))
2650 static const char *ill_array_lookup (void *clientData, const char *idx)
2652 ZOOM_package p = (ZOOM_package) clientData;
2653 return ZOOM_options_get (p->options, idx+4);
2656 static Z_External *encode_ill_request (ZOOM_package p)
2658 ODR out = p->odr_out;
2661 struct ill_get_ctl ctl;
2663 ctl.odr = p->odr_out;
2665 ctl.f = ill_array_lookup;
2667 req = ill_get_ILLRequest(&ctl, "ill", 0);
2669 if (!ill_Request (out, &req, 0, 0))
2671 int ill_request_size;
2672 char *ill_request_buf = odr_getbuf (out, &ill_request_size, 0);
2673 if (ill_request_buf)
2674 odr_setbuf (out, ill_request_buf, ill_request_size, 1);
2680 int illRequest_size = 0;
2681 char *illRequest_buf = odr_getbuf (out, &illRequest_size, 0);
2683 oid.proto = PROTO_GENERAL;
2684 oid.oclass = CLASS_GENERAL;
2685 oid.value = VAL_ISO_ILL_1;
2687 r = (Z_External *) odr_malloc (out, sizeof(*r));
2688 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2689 r->indirect_reference = 0;
2691 r->which = Z_External_single;
2693 r->u.single_ASN1_type = (Odr_oct *)
2694 odr_malloc (out, sizeof(*r->u.single_ASN1_type));
2695 r->u.single_ASN1_type->buf = (unsigned char*)
2696 odr_malloc (out, illRequest_size);
2697 r->u.single_ASN1_type->len = illRequest_size;
2698 r->u.single_ASN1_type->size = illRequest_size;
2699 memcpy (r->u.single_ASN1_type->buf, illRequest_buf, illRequest_size);
2704 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2706 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc (p->odr_out, sizeof(*req));
2709 req->which = Z_IOItemOrder_esRequest;
2710 req->u.esRequest = (Z_IORequest *)
2711 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2713 /* to keep part ... */
2714 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2715 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2716 req->u.esRequest->toKeep->supplDescription = 0;
2717 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2718 odr_malloc (p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2720 str = ZOOM_options_get(p->options, "contact-name");
2721 req->u.esRequest->toKeep->contact->name = str ?
2722 nmem_strdup (p->odr_out->mem, str) : 0;
2724 str = ZOOM_options_get(p->options, "contact-phone");
2725 req->u.esRequest->toKeep->contact->phone = str ?
2726 nmem_strdup (p->odr_out->mem, str) : 0;
2728 str = ZOOM_options_get(p->options, "contact-email");
2729 req->u.esRequest->toKeep->contact->email = str ?
2730 nmem_strdup (p->odr_out->mem, str) : 0;
2732 req->u.esRequest->toKeep->addlBilling = 0;
2734 /* not to keep part ... */
2735 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2736 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2738 str = ZOOM_options_get(p->options, "itemorder-setname");
2743 req->u.esRequest->notToKeep->resultSetItem = 0;
2746 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2747 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2749 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2750 nmem_strdup (p->odr_out->mem, str);
2751 req->u.esRequest->notToKeep->resultSetItem->item =
2752 (int *) odr_malloc(p->odr_out, sizeof(int));
2754 str = ZOOM_options_get(p->options, "itemorder-item");
2755 *req->u.esRequest->notToKeep->resultSetItem->item =
2756 (str ? atoi(str) : 1);
2758 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2763 Z_APDU *create_admin_package(ZOOM_package p, int type,
2764 Z_ESAdminOriginPartToKeep **toKeepP,
2765 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2767 Z_APDU *apdu = create_es_package (p, VAL_ADMINSERVICE);
2770 Z_ESAdminOriginPartToKeep *toKeep;
2771 Z_ESAdminOriginPartNotToKeep *notToKeep;
2772 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2773 const char *first_db = "Default";
2775 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2779 r->direct_reference =
2780 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2783 r->indirect_reference = 0;
2784 r->which = Z_External_ESAdmin;
2786 r->u.adminService = (Z_Admin *)
2787 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2788 r->u.adminService->which = Z_Admin_esRequest;
2789 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2790 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2792 toKeep = r->u.adminService->u.esRequest->toKeep =
2793 (Z_ESAdminOriginPartToKeep *)
2794 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2795 toKeep->which = type;
2796 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2797 toKeep->u.create = odr_nullval();
2798 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2800 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2801 (Z_ESAdminOriginPartNotToKeep *)
2802 odr_malloc(p->odr_out,
2803 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2804 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
2805 notToKeep->u.recordsWillFollow = odr_nullval();
2809 *notToKeepP = notToKeep;
2814 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
2816 Z_APDU *apdu = create_es_package(p, VAL_XMLES);
2817 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2818 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
2819 const char *doc = ZOOM_options_get(p->options, "doc");
2821 req->taskSpecificParameters = ext;
2822 ext->direct_reference = req->packageType;
2823 ext->descriptor = 0;
2824 ext->indirect_reference = 0;
2826 ext->which = Z_External_octet;
2827 ext->u.single_ASN1_type = (Odr_oct *)
2828 odr_malloc (p->odr_out, sizeof(Odr_oct));
2832 ext->u.single_ASN1_type->buf = (unsigned char*)
2833 odr_strdup(p->odr_out, doc);
2834 ext->u.single_ASN1_type->size = ext->u.single_ASN1_type->len = strlen(doc);
2838 static Z_APDU *create_update_package(ZOOM_package p)
2841 const char *first_db = "Default";
2843 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2844 const char *action = ZOOM_options_get(p->options, "action");
2845 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
2846 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
2847 const char *record_buf = ZOOM_options_get(p->options, "record");
2848 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
2849 int syntax_oid = VAL_NONE;
2853 syntax_oid = oid_getvalbyname(syntax_str);
2856 record_buf = "void";
2857 syntax_oid = VAL_SUTRS;
2859 if (syntax_oid == VAL_NONE)
2860 syntax_oid = VAL_TEXT_XML;
2866 action = "specialUpdate";
2868 if (!strcmp(action, "recordInsert"))
2869 action_no = Z_IUOriginPartToKeep_recordInsert;
2870 else if (!strcmp(action, "recordReplace"))
2871 action_no = Z_IUOriginPartToKeep_recordReplace;
2872 else if (!strcmp(action, "recordDelete"))
2873 action_no = Z_IUOriginPartToKeep_recordDelete;
2874 else if (!strcmp(action, "elementUpdate"))
2875 action_no = Z_IUOriginPartToKeep_elementUpdate;
2876 else if (!strcmp(action, "specialUpdate"))
2877 action_no = Z_IUOriginPartToKeep_specialUpdate;
2881 apdu = create_es_package (p, VAL_DBUPDATE);
2884 Z_IUOriginPartToKeep *toKeep;
2885 Z_IUSuppliedRecords *notToKeep;
2886 Z_External *r = (Z_External *)
2887 odr_malloc (p->odr_out, sizeof(*r));
2889 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2891 r->direct_reference =
2892 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2895 r->which = Z_External_update;
2896 r->indirect_reference = 0;
2897 r->u.update = (Z_IUUpdate *)
2898 odr_malloc(p->odr_out, sizeof(*r->u.update));
2900 r->u.update->which = Z_IUUpdate_esRequest;
2901 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
2902 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
2903 toKeep = r->u.update->u.esRequest->toKeep =
2904 (Z_IUOriginPartToKeep *)
2905 odr_malloc(p->odr_out, sizeof(*toKeep));
2907 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2909 toKeep->elementSetName = 0;
2910 toKeep->actionQualifier = 0;
2911 toKeep->action = odr_intdup(p->odr_out, action_no);
2913 notToKeep = r->u.update->u.esRequest->notToKeep =
2914 (Z_IUSuppliedRecords *)
2915 odr_malloc(p->odr_out, sizeof(*notToKeep));
2917 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
2918 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
2919 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
2920 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
2921 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
2924 notToKeep->elements[0]->u.opaque = (Odr_oct *)
2925 odr_malloc (p->odr_out, sizeof(Odr_oct));
2926 notToKeep->elements[0]->u.opaque->size =
2927 notToKeep->elements[0]->u.opaque->len = strlen(recordIdOpaque);
2928 notToKeep->elements[0]->u.opaque->buf = (unsigned char*)
2929 odr_strdup(p->odr_out, recordIdOpaque);
2931 else if (recordIdNumber)
2933 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
2935 notToKeep->elements[0]->u.number =
2936 odr_intdup(p->odr_out, atoi(recordIdNumber));
2939 notToKeep->elements[0]->u.opaque = 0;
2940 notToKeep->elements[0]->supplementalId = 0;
2941 notToKeep->elements[0]->correlationInfo = 0;
2942 notToKeep->elements[0]->record =
2943 z_ext_record(p->odr_out, syntax_oid,
2944 record_buf, strlen(record_buf));
2948 ODR print = odr_createmem(ODR_PRINT);
2950 z_APDU(print, &apdu, 0, 0);
2957 ZOOM_package_send (ZOOM_package p, const char *type)
2964 odr_reset (p->odr_out);
2967 if (!strcmp(type, "itemorder"))
2969 apdu = create_es_package (p, VAL_ITEMORDER);
2972 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2974 r->direct_reference =
2975 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2978 r->which = Z_External_itemOrder;
2979 r->indirect_reference = 0;
2980 r->u.itemOrder = encode_item_order (p);
2982 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2985 else if (!strcmp(type, "create")) /* create database */
2987 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
2990 else if (!strcmp(type, "drop")) /* drop database */
2992 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
2995 else if (!strcmp(type, "commit")) /* commit changes */
2997 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
3000 else if (!strcmp(type, "update")) /* update record(s) */
3002 apdu = create_update_package(p);
3004 else if (!strcmp(type, "xmlupdate"))
3006 apdu = create_xmlupdate_package(p);
3010 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
3014 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_PACKAGE);
3015 task->u.package = p;
3016 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
3017 p->buf_out = (char *) xmalloc (p->len_out);
3018 memcpy (p->buf_out, buf, p->len_out);
3023 while (ZOOM_event (1, &c))
3030 ZOOM_API(ZOOM_package)
3031 ZOOM_connection_package (ZOOM_connection c, ZOOM_options options)
3033 ZOOM_package p = (ZOOM_package) xmalloc (sizeof(*p));
3036 p->odr_out = odr_createmem (ODR_ENCODE);
3037 p->options = ZOOM_options_create_with_parent2 (options, c->options);
3045 ZOOM_package_destroy(ZOOM_package p)
3050 if (p->refcount == 0)
3052 odr_destroy (p->odr_out);
3055 ZOOM_options_destroy (p->options);
3060 ZOOM_API(const char *)
3061 ZOOM_package_option_get (ZOOM_package p, const char *key)
3063 return ZOOM_options_get (p->options, key);
3068 ZOOM_package_option_set (ZOOM_package p, const char *key,
3071 ZOOM_options_set (p->options, key, val);
3074 static int ZOOM_connection_exec_task (ZOOM_connection c)
3076 ZOOM_task task = c->tasks;
3077 zoom_ret ret = zoom_complete;
3081 yaz_log(log_details, "%p ZOOM_connection_exec_task type=%d run=%d",
3082 c, task->which, task->running);
3083 if (c->error != ZOOM_ERROR_NONE)
3085 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3086 "removing tasks because of error = %d", c, c->error);
3087 ZOOM_connection_remove_tasks (c);
3092 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3093 "task already running", c);
3097 ret = zoom_complete;
3098 if (c->cs || task->which == ZOOM_TASK_CONNECT)
3100 switch (task->which)
3102 case ZOOM_TASK_SEARCH:
3103 if (c->proto == PROTO_HTTP)
3104 ret = ZOOM_connection_srw_send_search(c);
3106 ret = ZOOM_connection_send_search(c);
3108 case ZOOM_TASK_RETRIEVE:
3109 if (c->proto == PROTO_HTTP)
3110 ret = ZOOM_connection_srw_send_search(c);
3112 ret = send_present (c);
3114 case ZOOM_TASK_CONNECT:
3115 ret = do_connect(c);
3117 case ZOOM_TASK_SCAN:
3120 case ZOOM_TASK_PACKAGE:
3121 ret = send_package(c);
3123 case ZOOM_TASK_SORT:
3124 c->tasks->u.sort.resultset->r_sort_spec =
3125 c->tasks->u.sort.q->sort_spec;
3126 ret = send_sort(c, c->tasks->u.sort.resultset);
3132 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3133 "remove tasks because no connection exist", c);
3134 ZOOM_connection_remove_tasks (c);
3136 if (ret == zoom_complete)
3138 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3139 "task removed (complete)", c);
3140 ZOOM_connection_remove_task (c);
3143 yaz_log(log_details, "%p ZOOM_connection_exec_task "
3148 static zoom_ret send_sort_present (ZOOM_connection c)
3150 zoom_ret r = zoom_complete;
3152 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
3153 r = send_sort (c, c->tasks->u.search.resultset);
3154 if (r == zoom_complete)
3155 r = send_present (c);
3159 static int es_response (ZOOM_connection c,
3160 Z_ExtendedServicesResponse *res)
3162 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
3164 if (res->diagnostics && res->num_diagnostics > 0)
3165 response_diag(c, res->diagnostics[0]);
3166 if (res->taskPackage &&
3167 res->taskPackage->which == Z_External_extendedService)
3169 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
3170 Odr_oct *id = taskPackage->targetReference;
3173 ZOOM_options_setl (c->tasks->u.package->options,
3174 "targetReference", (char*) id->buf, id->len);
3176 if (res->taskPackage &&
3177 res->taskPackage->which == Z_External_octet)
3179 Odr_oct *doc = res->taskPackage->u.octet_aligned;
3180 ZOOM_options_setl (c->tasks->u.package->options,
3181 "xmlUpdateDoc", (char*) doc->buf, doc->len);
3186 static void interpret_init_diag(ZOOM_connection c,
3187 Z_DiagnosticFormat *diag)
3191 Z_DiagnosticFormat_s *ds = diag->elements[0];
3192 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
3193 response_default_diag(c, ds->u.defaultDiagRec);
3198 static void interpret_otherinformation_field(ZOOM_connection c,
3199 Z_OtherInformation *ui)
3202 for (i = 0; i < ui->num_elements; i++)
3204 Z_OtherInformationUnit *unit = ui->list[i];
3205 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
3206 unit->information.externallyDefinedInfo &&
3207 unit->information.externallyDefinedInfo->which ==
3210 interpret_init_diag(c, unit->information.externallyDefinedInfo->u.diag1);
3215 static void recv_apdu (ZOOM_connection c, Z_APDU *apdu)
3217 Z_InitResponse *initrs;
3220 yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
3223 case Z_APDU_initResponse:
3224 yaz_log(log_api, "%p recv_apd: Received Init response", c);
3225 initrs = apdu->u.initResponse;
3226 ZOOM_connection_option_set(c, "serverImplementationId",
3227 initrs->implementationId ?
3228 initrs->implementationId : "");
3229 ZOOM_connection_option_set(c, "serverImplementationName",
3230 initrs->implementationName ?
3231 initrs->implementationName : "");
3232 ZOOM_connection_option_set(c, "serverImplementationVersion",
3233 initrs->implementationVersion ?
3234 initrs->implementationVersion : "");
3235 /* Set the three old options too, for old applications */
3236 ZOOM_connection_option_set(c, "targetImplementationId",
3237 initrs->implementationId ?
3238 initrs->implementationId : "");
3239 ZOOM_connection_option_set(c, "targetImplementationName",
3240 initrs->implementationName ?
3241 initrs->implementationName : "");
3242 ZOOM_connection_option_set(c, "targetImplementationVersion",
3243 initrs->implementationVersion ?
3244 initrs->implementationVersion : "");
3245 if (!*initrs->result)
3247 Z_External *uif = initrs->userInformationField;
3249 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0); /* default error */
3251 if (uif && uif->which == Z_External_userInfo1)
3252 interpret_otherinformation_field(c, uif->u.userInfo1);
3257 yaz_oi_get_string_oidval (&apdu->u.initResponse->otherInfo,
3259 xfree (c->cookie_in);
3262 c->cookie_in = xstrdup(cookie);
3263 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
3264 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
3265 c->support_named_resultsets = 1;
3268 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3269 ZOOM_connection_remove_task (c);
3271 ZOOM_connection_exec_task (c);
3273 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
3275 NMEM tmpmem = nmem_create();
3276 Z_CharSetandLanguageNegotiation *p =
3277 yaz_get_charneg_record(initrs->otherInfo);
3281 char *charset = NULL, *lang = NULL;
3284 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
3285 yaz_log(log_details, "%p recv_apdu target accepted: "
3286 "charset %s, language %s, select %d",
3288 charset ? charset : "none", lang ? lang : "none", sel);
3290 ZOOM_connection_option_set (c, "negotiation-charset",
3293 ZOOM_connection_option_set (c, "negotiation-lang",
3296 ZOOM_connection_option_set (
3297 c, "negotiation-charset-in-effect-for-records",
3298 (sel != 0) ? "1" : "0");
3299 nmem_destroy(tmpmem);
3303 case Z_APDU_searchResponse:
3304 yaz_log(log_api, "%p recv_apdu Search response", c);
3305 handle_search_response (c, apdu->u.searchResponse);
3306 if (send_sort_present (c) == zoom_complete)
3307 ZOOM_connection_remove_task (c);
3309 case Z_APDU_presentResponse:
3310 yaz_log(log_api, "%p recv_apdu Present response", c);
3311 handle_present_response (c, apdu->u.presentResponse);
3312 if (send_present (c) == zoom_complete)
3313 ZOOM_connection_remove_task (c);
3315 case Z_APDU_sortResponse:
3316 yaz_log(log_api, "%p recv_apdu Sort response", c);
3317 sort_response (c, apdu->u.sortResponse);
3318 if (send_present (c) == zoom_complete)
3319 ZOOM_connection_remove_task (c);
3321 case Z_APDU_scanResponse:
3322 yaz_log(log_api, "%p recv_apdu Scan response", c);
3323 scan_response (c, apdu->u.scanResponse);
3324 ZOOM_connection_remove_task (c);
3326 case Z_APDU_extendedServicesResponse:
3327 yaz_log(log_api, "%p recv_apdu Extended Services response", c);
3328 es_response (c, apdu->u.extendedServicesResponse);
3329 ZOOM_connection_remove_task (c);
3332 yaz_log(log_api, "%p recv_apdu Close PDU", c);
3333 if (c->reconnect_ok)
3336 c->tasks->running = 0;
3337 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3341 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3346 yaz_log(log_api, "%p Received unknown PDU", c);
3347 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3353 static void handle_srw_response(ZOOM_connection c,
3354 Z_SRW_searchRetrieveResponse *res)
3356 ZOOM_resultset resultset = 0;
3364 if (c->tasks->which == ZOOM_TASK_SEARCH)
3365 resultset = c->tasks->u.search.resultset;
3366 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
3367 resultset = c->tasks->u.retrieve.resultset;
3371 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
3372 ZOOM_connection_put_event(c, event);
3374 resultset->size = 0;
3376 yaz_log(log_details, "%p handle_srw_response got SRW response OK", c);
3378 if (res->numberOfRecords)
3379 resultset->size = *res->numberOfRecords;
3381 for (i = 0; i<res->num_records; i++)
3385 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
3386 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
3388 if (res->records[i].recordPosition &&
3389 *res->records[i].recordPosition > 0)
3390 pos = *res->records[i].recordPosition - 1;
3392 pos = resultset->start + i;
3394 npr->databaseName = 0;
3395 npr->which = Z_NamePlusRecord_databaseRecord;
3396 npr->u.databaseRecord = (Z_External *)
3397 odr_malloc(c->odr_in, sizeof(Z_External));
3398 npr->u.databaseRecord->descriptor = 0;
3399 npr->u.databaseRecord->direct_reference =
3400 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3401 npr->u.databaseRecord->which = Z_External_octet;
3402 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3403 odr_malloc(c->odr_in, sizeof(Odr_oct));
3404 npr->u.databaseRecord->u.octet_aligned->buf = (unsigned char*)
3405 res->records[i].recordData_buf;
3406 npr->u.databaseRecord->u.octet_aligned->len =
3407 npr->u.databaseRecord->u.octet_aligned->size =
3408 res->records[i].recordData_len;
3409 record_cache_add (resultset, npr, pos);
3411 if (res->num_diagnostics > 0)
3413 const char *uri = res->diagnostics[0].uri;
3418 if ((cp = strrchr(uri, '/')))
3420 set_dset_error(c, code, uri,
3421 res->diagnostics[0].details, 0);
3424 nmem = odr_extract_mem(c->odr_in);
3425 nmem_transfer(resultset->odr->mem, nmem);
3431 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3434 const char *content_type = z_HTTP_header_lookup(hres->headers,
3436 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3439 yaz_log(log_details, "%p handle_http", c);
3441 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3443 Z_SOAP *soap_package = 0;
3445 Z_SOAP_Handler soap_handlers[2] = {
3446 {"http://www.loc.gov/zing/srw/", 0,
3447 (Z_SOAP_fun) yaz_srw_codec},
3450 ret = z_soap_codec(o, &soap_package,
3451 &hres->content_buf, &hres->content_len,
3453 if (!ret && soap_package->which == Z_SOAP_generic &&
3454 soap_package->u.generic->no == 0)
3456 Z_SRW_PDU *sr = (Z_SRW_PDU*) soap_package->u.generic->p;
3457 if (sr->which == Z_SRW_searchRetrieve_response)
3458 handle_srw_response(c, sr->u.response);
3462 else if (!ret && (soap_package->which == Z_SOAP_fault
3463 || soap_package->which == Z_SOAP_error))
3465 set_HTTP_error(c, hres->code,
3466 soap_package->u.fault->fault_code,
3467 soap_package->u.fault->fault_string);
3474 if (hres->code != 200)
3475 set_HTTP_error(c, hres->code, 0, 0);
3477 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3480 ZOOM_connection_remove_task(c);
3481 if (!strcmp(hres->version, "1.0"))
3483 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3484 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3489 /* HTTP 1.1: only if no close we stay alive .. */
3490 if (connection_head && !strcmp(connection_head, "close"))
3496 static int do_read (ZOOM_connection c)
3501 event = ZOOM_Event_create (ZOOM_EVENT_RECV_DATA);
3502 ZOOM_connection_put_event (c, event);
3504 r = cs_get (c->cs, &c->buf_in, &c->len_in);
3505 more = cs_more(c->cs);
3506 yaz_log(log_details, "%p do_read len=%d more=%d", c, r, more);
3511 if (c->reconnect_ok)
3514 c->reconnect_ok = 0;
3515 yaz_log(log_details, "%p do_read reconnect read", c);
3516 c->tasks->running = 0;
3517 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3521 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3530 odr_reset (c->odr_in);
3531 odr_setbuf (c->odr_in, c->buf_in, r, 0);
3532 event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);
3533 ZOOM_connection_put_event (c, event);
3535 if (!z_GDU (c->odr_in, &gdu, 0, 0))
3538 int err = odr_geterrorx(c->odr_in, &x);
3540 const char *element = odr_getelement(c->odr_in);
3541 sprintf (msg, "ODR code %d:%d element=%-20s",
3542 err, x, element ? element : "<unknown>");
3543 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3546 else if (gdu->which == Z_GDU_Z3950)
3547 recv_apdu (c, gdu->u.z3950);
3548 else if (gdu->which == Z_GDU_HTTP_Response)
3551 handle_http (c, gdu->u.HTTP_Response);
3553 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3557 c->reconnect_ok = 0;
3562 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out)
3567 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3568 ZOOM_connection_put_event (c, event);
3570 yaz_log(log_details, "%p do_write_ex len=%d", c, len_out);
3571 if ((r = cs_put(c->cs, buf_out, len_out)) < 0)
3573 yaz_log(log_details, "%p do_write_ex write failed", c);
3574 if (c->reconnect_ok)
3577 c->reconnect_ok = 0;
3578 yaz_log(log_details, "%p do_write_ex reconnect write", c);
3579 c->tasks->running = 0;
3580 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3581 return zoom_pending;
3583 if (c->state == STATE_CONNECTING)
3584 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3586 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, c->host_port);
3588 return zoom_complete;
3592 c->mask = ZOOM_SELECT_EXCEPT;
3593 if (c->cs->io_pending & CS_WANT_WRITE)
3594 c->mask += ZOOM_SELECT_WRITE;
3595 if (c->cs->io_pending & CS_WANT_READ)
3596 c->mask += ZOOM_SELECT_READ;
3597 yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
3602 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3603 yaz_log(log_details, "%p do_write_ex write complete mask=%d",
3606 return zoom_pending;
3609 static zoom_ret do_write(ZOOM_connection c)
3611 return do_write_ex (c, c->buf_out, c->len_out);
3615 ZOOM_API(const char *)
3616 ZOOM_connection_option_get (ZOOM_connection c, const char *key)
3618 return ZOOM_options_get (c->options, key);
3621 ZOOM_API(const char *)
3622 ZOOM_connection_option_getl (ZOOM_connection c, const char *key, int *lenp)
3624 return ZOOM_options_getl (c->options, key, lenp);
3628 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
3631 ZOOM_options_set (c->options, key, val);
3635 ZOOM_connection_option_setl (ZOOM_connection c, const char *key,
3636 const char *val, int len)
3638 ZOOM_options_setl (c->options, key, val, len);
3641 ZOOM_API(const char *)
3642 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key)
3644 return ZOOM_options_get (r->options, key);
3648 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key,
3651 ZOOM_options_set (r->options, key, val);
3656 ZOOM_connection_errcode (ZOOM_connection c)
3658 return ZOOM_connection_error (c, 0, 0);
3661 ZOOM_API(const char *)
3662 ZOOM_connection_errmsg (ZOOM_connection c)
3665 ZOOM_connection_error (c, &msg, 0);
3669 ZOOM_API(const char *)
3670 ZOOM_connection_addinfo (ZOOM_connection c)
3672 const char *addinfo;
3673 ZOOM_connection_error (c, 0, &addinfo);
3677 ZOOM_API(const char *)
3678 ZOOM_connection_diagset (ZOOM_connection c)
3680 const char *diagset;
3681 ZOOM_connection_error_x (c, 0, 0, &diagset);
3685 ZOOM_API(const char *)
3686 ZOOM_diag_str (int error)
3690 case ZOOM_ERROR_NONE:
3692 case ZOOM_ERROR_CONNECT:
3693 return "Connect failed";
3694 case ZOOM_ERROR_MEMORY:
3695 return "Out of memory";
3696 case ZOOM_ERROR_ENCODE:
3697 return "Encoding failed";
3698 case ZOOM_ERROR_DECODE:
3699 return "Decoding failed";
3700 case ZOOM_ERROR_CONNECTION_LOST:
3701 return "Connection lost";
3702 case ZOOM_ERROR_INIT:
3703 return "Init rejected";
3704 case ZOOM_ERROR_INTERNAL:
3705 return "Internal failure";
3706 case ZOOM_ERROR_TIMEOUT:
3708 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3709 return "Unsupported protocol";
3710 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3711 return "Unsupported query type";
3712 case ZOOM_ERROR_INVALID_QUERY:
3713 return "Invalid query";
3714 case ZOOM_ERROR_CQL_PARSE:
3715 return "CQL parsing error";
3716 case ZOOM_ERROR_CQL_TRANSFORM:
3717 return "CQL transformation error";
3719 return diagbib1_str (error);
3724 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
3725 const char **addinfo, const char **diagset)
3727 int error = c->error;
3730 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3731 *cp = ZOOM_diag_str(error);
3732 else if (!strcmp(c->diagset, "HTTP"))
3733 *cp = z_HTTP_errmsg(c->error);
3734 else if (!strcmp(c->diagset, "Bib-1"))
3735 *cp = ZOOM_diag_str(error);
3736 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3737 *cp = yaz_diag_srw_str(c->error);
3739 *cp = "Unknown error and diagnostic set";
3742 *addinfo = c->addinfo ? c->addinfo : "";
3744 *diagset = c->diagset ? c->diagset : "";
3749 ZOOM_connection_error (ZOOM_connection c, const char **cp,
3750 const char **addinfo)
3752 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3755 static int ZOOM_connection_do_io(ZOOM_connection c, int mask)
3757 ZOOM_Event event = 0;
3758 int r = cs_look(c->cs);
3759 yaz_log(log_details, "%p ZOOM_connection_do_io mask=%d cs_look=%d",
3764 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3765 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3767 ZOOM_connection_put_event (c, event);
3769 else if (r == CS_CONNECT)
3772 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3774 ret = cs_rcvconnect (c->cs);
3775 yaz_log(log_details, "%p ZOOM_connection_do_io "
3776 "cs_rcvconnect returned %d", c, ret);
3779 c->mask = ZOOM_SELECT_EXCEPT;
3780 if (c->cs->io_pending & CS_WANT_WRITE)
3781 c->mask += ZOOM_SELECT_WRITE;
3782 if (c->cs->io_pending & CS_WANT_READ)
3783 c->mask += ZOOM_SELECT_READ;
3784 ZOOM_connection_put_event (c, event);
3788 ZOOM_connection_put_event (c, event);
3790 if (c->proto == PROTO_Z3950)
3791 ZOOM_connection_send_init(c);
3794 /* no init request for SRW .. */
3795 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3796 ZOOM_connection_remove_task (c);
3798 ZOOM_connection_exec_task (c);
3800 c->state = STATE_ESTABLISHED;
3804 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, c->host_port);
3806 ZOOM_connection_put_event (c, event);
3811 if (mask & ZOOM_SELECT_READ)
3813 if (c->cs && (mask & ZOOM_SELECT_WRITE))
3820 ZOOM_connection_last_event(ZOOM_connection cs)
3823 return ZOOM_EVENT_NONE;
3824 return cs->last_event;
3828 ZOOM_event (int no, ZOOM_connection *cs)
3830 int timeout = 30; /* default timeout in seconds */
3831 int timeout_set = 0; /* whether it was overriden at all */
3833 struct pollfd pollfds[1024];
3834 ZOOM_connection poll_cs[1024];
3837 fd_set input, output, except;
3842 for (i = 0; i<no; i++)
3844 ZOOM_connection c = cs[i];
3846 if (c && (event = ZOOM_connection_get_event(c)))
3848 ZOOM_Event_destroy (event);
3852 for (i = 0; i<no; i++)
3854 ZOOM_connection c = cs[i];
3856 if (c && ZOOM_connection_exec_task (c))
3858 if ((event = ZOOM_connection_get_event(c)))
3860 ZOOM_Event_destroy (event);
3873 for (i = 0; i<no; i++)
3875 ZOOM_connection c = cs[i];
3881 fd = z3950_connection_socket(c);
3882 mask = z3950_connection_mask(c);
3889 /* -1 is used for indefinite timeout (no timeout), so -2 here. */
3890 this_timeout = ZOOM_options_get_int (c->options, "timeout", -2);
3891 if (this_timeout != -2)
3893 /* ensure the minimum timeout is used */
3895 timeout = this_timeout;
3896 else if (this_timeout != -1 && this_timeout < timeout)
3897 timeout = this_timeout;
3903 short poll_events = 0;
3905 if (mask & ZOOM_SELECT_READ)
3906 poll_events += POLLIN;
3907 if (mask & ZOOM_SELECT_WRITE)
3908 poll_events += POLLOUT;
3909 if (mask & ZOOM_SELECT_EXCEPT)
3910 poll_events += POLLERR;
3911 pollfds[nfds].fd = fd;
3912 pollfds[nfds].events = poll_events;
3913 pollfds[nfds].revents = 0;
3918 if (mask & ZOOM_SELECT_READ)
3920 FD_SET (fd, &input);
3923 if (mask & ZOOM_SELECT_WRITE)
3925 FD_SET (fd, &output);
3928 if (mask & ZOOM_SELECT_EXCEPT)
3930 FD_SET (fd, &except);
3939 r = poll (pollfds, nfds, (timeout == -1 ? -1 : timeout * 1000));
3940 for (i = 0; i<nfds; i++)
3942 ZOOM_connection c = poll_cs[i];
3946 if (pollfds[i].revents & POLLIN)
3947 mask += ZOOM_SELECT_READ;
3948 if (pollfds[i].revents & POLLOUT)
3949 mask += ZOOM_SELECT_WRITE;
3950 if (pollfds[i].revents & POLLERR)
3951 mask += ZOOM_SELECT_EXCEPT;
3953 ZOOM_connection_do_io(c, mask);
3955 else if (r == 0 && c->mask)
3957 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3958 /* timeout and this connection was waiting */
3959 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3961 ZOOM_connection_put_event(c, event);
3965 tv.tv_sec = timeout;
3967 r = select (max_fd+1, &input, &output, &except, (timeout == -1 ? 0 : &tv));
3968 for (i = 0; i<no; i++)
3970 ZOOM_connection c = cs[i];
3975 fd = z3950_connection_socket(c);
3979 /* no timeout and real socket */
3980 if (FD_ISSET(fd, &input))
3981 mask += ZOOM_SELECT_READ;
3982 if (FD_ISSET(fd, &output))
3983 mask += ZOOM_SELECT_WRITE;
3984 if (FD_ISSET(fd, &except))
3985 mask += ZOOM_SELECT_EXCEPT;
3987 ZOOM_connection_do_io(c, mask);
3989 if (r == 0 && c->mask)
3991 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3992 /* timeout and this connection was waiting */
3993 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3995 ZOOM_connection_put_event(c, event);
3999 for (i = 0; i<no; i++)
4001 ZOOM_connection c = cs[i];
4003 if (c && (event = ZOOM_connection_get_event(c)))
4005 ZOOM_Event_destroy (event);
4014 * Returns an xmalloc()d string containing RPN that corresponds to the
4015 * CQL passed in. On error, sets the Connection object's error state
4016 * and returns a null pointer.
4017 * ### We could cache CQL parser and/or transformer in Connection.
4019 static char *cql2pqf(ZOOM_connection c, const char *cql)
4023 struct cql_node *node;
4024 const char *cqlfile;
4025 static cql_transform_t trans;
4028 parser = cql_parser_create();
4029 if ((error = cql_parser_string(parser, cql)) != 0) {
4030 cql_parser_destroy(parser);
4031 set_ZOOM_error(c, ZOOM_ERROR_CQL_PARSE, cql);
4035 node = cql_parser_result(parser);
4036 /* ### Do not call cql_parser_destroy() yet: it destroys `node'! */
4038 cqlfile = ZOOM_connection_option_get(c, "cqlfile");
4040 cql_parser_destroy(parser);
4041 cql_node_destroy(node);
4042 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, "no CQL transform file");
4046 if ((trans = cql_transform_open_fname(cqlfile)) == 0) {
4048 cql_parser_destroy(parser);
4049 cql_node_destroy(node);
4050 sprintf(buf, "can't open CQL transform file '%.200s': %.200s",
4051 cqlfile, strerror(errno));
4052 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4056 error = cql_transform_buf(trans, node, pqfbuf, sizeof pqfbuf);
4057 cql_parser_destroy(parser);
4058 cql_node_destroy(node);
4061 const char *addinfo;
4062 error = cql_transform_error(trans, &addinfo);
4063 cql_transform_close(trans);
4064 sprintf(buf, "%.200s (addinfo=%.200s)", cql_strerror(error), addinfo);
4065 set_ZOOM_error(c, ZOOM_ERROR_CQL_TRANSFORM, buf);
4069 cql_transform_close(trans);
4070 return xstrdup(pqfbuf);
4077 * indent-tabs-mode: nil
4079 * vim: shiftwidth=4 tabstop=8 expandtab