2 * Copyright (c) 2000-2004, Index Data
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.21 2004-01-27 12:15:12 adam Exp $
7 * ZOOM layer for C, connections, result sets, queries.
13 #include <yaz/yaz-util.h>
14 #include <yaz/xmalloc.h>
15 #include <yaz/otherinfo.h>
17 #include <yaz/pquery.h>
18 #include <yaz/marcdisp.h>
19 #include <yaz/diagbib1.h>
20 #include <yaz/charneg.h>
33 static zoom_ret ZOOM_connection_send_init (ZOOM_connection c);
34 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out);
36 static ZOOM_Event ZOOM_Event_create (int kind)
38 ZOOM_Event event = (ZOOM_Event) xmalloc (sizeof(*event));
45 static void ZOOM_Event_destroy (ZOOM_Event event)
50 static void ZOOM_connection_put_event (ZOOM_connection c, ZOOM_Event event)
54 c->m_queue_back->prev = event;
55 assert (c->m_queue_front);
59 assert (!c->m_queue_front);
60 c->m_queue_front = event;
62 event->next = c->m_queue_back;
64 c->m_queue_back = event;
67 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
69 ZOOM_Event event = c->m_queue_front;
72 c->last_event = ZOOM_EVENT_NONE;
75 assert (c->m_queue_back);
76 c->m_queue_front = event->prev;
79 assert (c->m_queue_back);
80 c->m_queue_front->next = 0;
84 c->last_event = event->kind;
89 static void set_dset_error (ZOOM_connection c, int error,
91 const char *addinfo, const char *addinfo2)
97 if (addinfo && addinfo2)
99 c->addinfo = xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
100 strcpy(c->addinfo, addinfo);
101 strcat(c->addinfo, addinfo2);
104 c->addinfo = xstrdup(addinfo);
106 yaz_log(LOG_DEBUG, "Error %s %s:%d %s %s",
107 c->host_port ? c->host_port : "<>", dset, error,
108 addinfo ? addinfo : "",
109 addinfo2 ? addinfo2 : "");
113 static void set_HTTP_error (ZOOM_connection c, int error,
114 const char *addinfo, const char *addinfo2)
116 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
120 static void set_ZOOM_error (ZOOM_connection c, int error,
123 set_dset_error(c, error, "ZOOM", addinfo, 0);
126 static void clear_error (ZOOM_connection c)
131 case ZOOM_ERROR_CONNECT:
132 case ZOOM_ERROR_MEMORY:
133 case ZOOM_ERROR_DECODE:
134 case ZOOM_ERROR_CONNECTION_LOST:
135 case ZOOM_ERROR_INIT:
136 case ZOOM_ERROR_INTERNAL:
137 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
140 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
144 ZOOM_task ZOOM_connection_add_task (ZOOM_connection c, int which)
146 ZOOM_task *taskp = &c->tasks;
148 taskp = &(*taskp)->next;
149 *taskp = (ZOOM_task) xmalloc (sizeof(**taskp));
150 (*taskp)->running = 0;
151 (*taskp)->which = which;
157 ZOOM_task ZOOM_connection_insert_task (ZOOM_connection c, int which)
159 ZOOM_task task = (ZOOM_task) xmalloc (sizeof(*task));
161 task->next = c->tasks;
170 void ZOOM_connection_remove_task (ZOOM_connection c)
172 ZOOM_task task = c->tasks;
176 c->tasks = task->next;
179 case ZOOM_TASK_SEARCH:
181 ZOOM_resultset_destroy (task->u.search.resultset);
183 case ZOOM_TASK_RETRIEVE:
184 ZOOM_resultset_destroy (task->u.retrieve.resultset);
186 case ZOOM_TASK_CONNECT:
189 ZOOM_scanset_destroy (task->u.scan.scan);
191 case ZOOM_TASK_PACKAGE:
192 ZOOM_package_destroy (task->u.package);
201 static int ZOOM_connection_exec_task (ZOOM_connection c);
203 void ZOOM_connection_remove_tasks (ZOOM_connection c)
206 ZOOM_connection_remove_task(c);
209 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos);
211 ZOOM_API(ZOOM_connection)
212 ZOOM_connection_create (ZOOM_options options)
214 ZOOM_connection c = (ZOOM_connection) xmalloc (sizeof(*c));
216 c->proto = PROTO_Z3950;
220 c->state = STATE_IDLE;
222 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
229 c->options = ZOOM_options_create_with_parent(options);
235 c->charset = c->lang = 0;
242 c->odr_in = odr_createmem (ODR_DECODE);
243 c->odr_out = odr_createmem (ODR_ENCODE);
246 c->support_named_resultsets = 0;
247 c->last_event = ZOOM_EVENT_NONE;
249 c->m_queue_front = 0;
254 /* set database names. Take local databases (if set); otherwise
255 take databases given in ZURL (if set); otherwise use Default */
256 static char **set_DatabaseNames (ZOOM_connection con, ZOOM_options options,
259 char **databaseNames;
262 const char *cp = ZOOM_options_get (options, "databaseName");
266 if (strncmp (con->host_port, "unix:", 5) == 0)
267 cp = strchr (con->host_port+5, ':');
269 cp = strchr (con->host_port, '/');
276 while ((c = strchr(c, '+')))
284 databaseNames = (char**)
285 odr_malloc (con->odr_out, no * sizeof(*databaseNames));
289 c = strchr (cp, '+');
297 /* cp ptr to first char of db name, c is char
299 databaseNames[no] = (char*) odr_malloc (con->odr_out, 1+c-cp);
300 memcpy (databaseNames[no], cp, c-cp);
301 databaseNames[no++][c-cp] = '\0';
306 databaseNames[no] = NULL;
308 return databaseNames;
311 ZOOM_API(ZOOM_connection)
312 ZOOM_connection_new (const char *host, int portnum)
314 ZOOM_connection c = ZOOM_connection_create (0);
316 ZOOM_connection_connect (c, host, portnum);
321 ZOOM_connection_connect(ZOOM_connection c,
322 const char *host, int portnum)
329 yaz_log (LOG_DEBUG, "reconnect");
333 yaz_log(LOG_DEBUG, "connect");
335 val = ZOOM_options_get (c->options, "proxy");
337 c->proxy = xstrdup (val);
342 val = ZOOM_options_get (c->options, "charset");
344 c->charset = xstrdup (val);
349 val = ZOOM_options_get (c->options, "lang");
351 c->lang = xstrdup (val);
355 xfree (c->host_port);
359 sprintf (hostn, "%.80s:%d", host, portnum);
360 c->host_port = xstrdup(hostn);
363 c->host_port = xstrdup(host);
365 ZOOM_options_set(c->options, "host", c->host_port);
367 val = ZOOM_options_get (c->options, "cookie");
369 c->cookie_out = xstrdup (val);
371 val = ZOOM_options_get (c->options, "clientIP");
373 c->client_IP = xstrdup (val);
375 c->async = ZOOM_options_get_bool (c->options, "async", 0);
377 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
379 task = ZOOM_connection_add_task (c, ZOOM_TASK_CONNECT);
383 while (ZOOM_event (1, &c))
389 ZOOM_query_create(void)
391 ZOOM_query s = (ZOOM_query) xmalloc (sizeof(*s));
396 s->odr = odr_createmem (ODR_ENCODE);
403 ZOOM_query_destroy(ZOOM_query s)
409 yaz_log (LOG_DEBUG, "ZOOM_query_destroy count=%d", s->refcount);
410 if (s->refcount == 0)
412 odr_destroy (s->odr);
418 ZOOM_query_prefix(ZOOM_query s, const char *str)
420 s->query_string = odr_strdup(s->odr, str);
421 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
422 s->z_query->which = Z_Query_type_1;
423 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
424 if (!s->z_query->u.type_1)
430 ZOOM_query_cql(ZOOM_query s, const char *str)
434 s->query_string = odr_strdup(s->odr, str);
436 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
437 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
438 ext->indirect_reference = 0;
440 ext->which = Z_External_CQL;
441 ext->u.cql = s->query_string;
443 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
444 s->z_query->which = Z_Query_type_104;
445 s->z_query->u.type_104 = ext;
451 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
453 s->sort_spec = yaz_sort_spec (s->odr, criteria);
459 static zoom_ret do_write(ZOOM_connection c);
462 ZOOM_connection_destroy(ZOOM_connection c)
469 for (r = c->resultsets; r; r = r->next)
474 odr_destroy (c->odr_in);
475 odr_destroy (c->odr_out);
476 ZOOM_options_destroy (c->options);
477 ZOOM_connection_remove_tasks (c);
478 xfree (c->host_port);
483 xfree (c->cookie_out);
484 xfree (c->cookie_in);
485 xfree (c->client_IP);
489 void ZOOM_resultset_addref (ZOOM_resultset r)
494 yaz_log (LOG_DEBUG, "ZOOM_resultset_addref r=%p count=%d",
498 ZOOM_resultset ZOOM_resultset_create ()
500 ZOOM_resultset r = (ZOOM_resultset) xmalloc (sizeof(*r));
502 yaz_log (LOG_DEBUG, "ZOOM_resultset_create r = %p", r);
505 r->odr = odr_createmem (ODR_ENCODE);
520 ZOOM_API(ZOOM_resultset)
521 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
524 ZOOM_query s = ZOOM_query_create();
526 ZOOM_query_prefix (s, q);
528 r = ZOOM_connection_search (c, s);
529 ZOOM_query_destroy (s);
533 ZOOM_API(ZOOM_resultset)
534 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
536 ZOOM_resultset r = ZOOM_resultset_create ();
540 r->r_sort_spec = q->sort_spec;
543 r->options = ZOOM_options_create_with_parent(c->options);
545 r->start = ZOOM_options_get_int(r->options, "start", 0);
546 r->count = ZOOM_options_get_int(r->options, "count", 0);
548 /* If "presentChunk" is defined use that; otherwise "step" */
549 const char *cp = ZOOM_options_get (r->options, "presentChunk");
550 r->step = ZOOM_options_get_int(r->options,
551 (cp != 0 ? "presentChunk": "step"), 0);
553 r->piggyback = ZOOM_options_get_bool (r->options, "piggyback", 1);
554 cp = ZOOM_options_get (r->options, "setname");
556 r->setname = xstrdup(cp);
557 cp = ZOOM_options_get (r->options, "schema");
559 r->schema = xstrdup(cp);
563 r->next = c->resultsets;
566 if (c->host_port && c->proto == PROTO_HTTP)
570 yaz_log(LOG_DEBUG, "NO COMSTACK");
571 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
575 yaz_log(LOG_DEBUG, "PREPARE FOR RECONNECT");
580 task = ZOOM_connection_add_task (c, ZOOM_TASK_SEARCH);
581 task->u.search.resultset = r;
582 ZOOM_resultset_addref (r);
588 while (ZOOM_event (1, &c))
595 ZOOM_resultset_destroy(ZOOM_resultset r)
600 yaz_log (LOG_DEBUG, "ZOOM_resultset_destroy r = %p count=%d",
602 if (r->refcount == 0)
604 ZOOM_record_cache rc;
606 for (rc = r->record_cache; rc; rc = rc->next)
608 if (rc->rec.wrbuf_marc)
609 wrbuf_free (rc->rec.wrbuf_marc, 1);
610 if (rc->rec.wrbuf_iconv)
611 wrbuf_free (rc->rec.wrbuf_iconv, 1);
612 if (rc->rec.wrbuf_opac)
613 wrbuf_free (rc->rec.wrbuf_opac, 1);
617 /* remove ourselves from the resultsets in connection */
618 ZOOM_resultset *rp = &r->connection->resultsets;
621 assert (*rp); /* we must be in this list!! */
623 { /* OK, we're here - take us out of it */
630 ZOOM_query_destroy (r->query);
631 ZOOM_options_destroy (r->options);
632 odr_destroy (r->odr);
640 ZOOM_resultset_size (ZOOM_resultset r)
645 static void do_close (ZOOM_connection c)
651 c->state = STATE_IDLE;
654 static void ZOOM_resultset_retrieve (ZOOM_resultset r,
655 int force_sync, int start, int count)
667 if (c->host_port && c->proto == PROTO_HTTP)
671 yaz_log(LOG_DEBUG, "NO COMSTACK");
672 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
676 yaz_log(LOG_DEBUG, "PREPARE FOR RECONNECT");
680 task = ZOOM_connection_add_task (c, ZOOM_TASK_RETRIEVE);
681 task->u.retrieve.resultset = r;
682 task->u.retrieve.start = start;
683 task->u.retrieve.count = count;
685 cp = ZOOM_options_get (r->options, "schema");
688 if (!r->schema || strcmp(r->schema, cp))
691 r->schema = xstrdup(cp);
695 ZOOM_resultset_addref (r);
697 if (!r->connection->async || force_sync)
698 while (r->connection && ZOOM_event (1, &r->connection))
703 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
704 size_t start, size_t count)
706 int force_present = 0;
712 ZOOM_resultset_retrieve (r, force_present, start, count);
716 for (i = 0; i< count; i++)
717 recs[i] = ZOOM_resultset_record_immediate (r, i+start);
721 static zoom_ret do_connect (ZOOM_connection c)
724 const char *effective_host;
727 effective_host = c->proxy;
729 effective_host = c->host_port;
731 yaz_log (LOG_DEBUG, "do_connect host=%s", effective_host);
734 c->cs = cs_create_host (effective_host, 0, &add);
736 if (c->cs && c->cs->protocol == PROTO_HTTP)
739 const char *path = 0;
741 c->proto = PROTO_HTTP;
742 cs_get_host_args(c->host_port, &path);
744 c->path = xmalloc(strlen(path)+2);
746 strcpy (c->path+1, path);
748 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
750 return zoom_complete;
755 int ret = cs_connect (c->cs, add);
758 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
759 ZOOM_connection_put_event(c, event);
760 if (c->proto == PROTO_Z3950)
761 ZOOM_connection_send_init(c);
764 /* no init request for SRW .. */
765 assert (c->tasks->which == ZOOM_TASK_CONNECT);
766 ZOOM_connection_remove_task (c);
768 ZOOM_connection_exec_task (c);
770 c->state = STATE_ESTABLISHED;
775 c->state = STATE_CONNECTING;
776 c->mask = ZOOM_SELECT_EXCEPT;
777 if (c->cs->io_pending & CS_WANT_WRITE)
778 c->mask += ZOOM_SELECT_WRITE;
779 if (c->cs->io_pending & CS_WANT_READ)
780 c->mask += ZOOM_SELECT_READ;
784 c->state = STATE_IDLE;
785 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, effective_host);
786 return zoom_complete;
789 int z3950_connection_socket(ZOOM_connection c)
792 return cs_fileno(c->cs);
796 int z3950_connection_mask(ZOOM_connection c)
803 static void otherInfo_attach (ZOOM_connection c, Z_APDU *a, ODR out)
806 for (i = 0; i<200; i++)
809 Z_OtherInformation **oi;
815 sprintf (buf, "otherInfo%d", i);
816 val = ZOOM_options_get (c->options, buf);
819 cp = strchr (val, ':');
823 if (len >= sizeof(buf))
825 memcpy (buf, val, len);
827 oidval = oid_getvalbyname (buf);
828 if (oidval == VAL_NONE)
832 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
836 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
841 Z_OtherInformation **oi;
843 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
847 Z_OtherInformation **oi;
849 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
851 otherInfo_attach (c, a, out);
852 if (!z_APDU(out, &a, 0, 0))
854 FILE *outf = fopen("/tmp/apdu.txt", "a");
857 ODR odr_pr = odr_createmem(ODR_PRINT);
858 fprintf (outf, "a=%p\n", a);
859 odr_setprint(odr_pr, outf);
860 z_APDU(odr_pr, &a, 0, 0);
863 yaz_log (LOG_DEBUG, "encoding failed");
864 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
872 static zoom_ret send_APDU (ZOOM_connection c, Z_APDU *a)
876 if (encode_APDU(c, a, c->odr_out))
877 return zoom_complete;
878 yaz_log(LOG_DEBUG, "send APDU type=%d", a->which);
879 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
880 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
881 ZOOM_connection_put_event (c, event);
882 odr_reset(c->odr_out);
886 /* returns 1 if PDU was sent OK (still pending )
887 0 if PDU was not sent OK (nothing to wait for)
890 static zoom_ret ZOOM_connection_send_init (ZOOM_connection c)
892 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
893 Z_InitRequest *ireq = apdu->u.initRequest;
894 Z_IdAuthentication *auth = (Z_IdAuthentication *)
895 odr_malloc(c->odr_out, sizeof(*auth));
896 const char *auth_groupId = ZOOM_options_get (c->options, "group");
897 const char *auth_userId = ZOOM_options_get (c->options, "user");
898 const char *auth_password = ZOOM_options_get (c->options, "password");
901 /* support the pass for backwards compatibility */
903 auth_password = ZOOM_options_get (c->options, "pass");
905 ODR_MASK_SET(ireq->options, Z_Options_search);
906 ODR_MASK_SET(ireq->options, Z_Options_present);
907 ODR_MASK_SET(ireq->options, Z_Options_scan);
908 ODR_MASK_SET(ireq->options, Z_Options_sort);
909 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
910 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
912 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
913 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
914 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
916 /* Index Data's Z39.50 Implementor Id is 81 */
917 ireq->implementationId = odr_prepend(c->odr_out,
918 ZOOM_options_get(c->options, "implementationId"),
919 odr_prepend(c->odr_out, "81", ireq->implementationId));
921 ireq->implementationName = odr_prepend(c->odr_out,
922 ZOOM_options_get(c->options, "implementationName"),
923 odr_prepend(c->odr_out, "ZOOM-C", ireq->implementationName));
925 version = odr_strdup(c->odr_out, "$Revision: 1.21 $");
926 if (strlen(version) > 10) /* check for unexpanded CVS strings */
927 version[strlen(version)-2] = '\0';
928 ireq->implementationVersion = odr_prepend(c->odr_out,
929 ZOOM_options_get(c->options, "implementationVersion"),
930 odr_prepend(c->odr_out, &version[11], ireq->implementationVersion));
932 *ireq->maximumRecordSize =
933 ZOOM_options_get_int (c->options, "maximumRecordSize", 1024*1024);
934 *ireq->preferredMessageSize =
935 ZOOM_options_get_int (c->options, "preferredMessageSize", 1024*1024);
937 if (auth_groupId || auth_password)
939 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
942 if (auth_groupId && *auth_groupId)
944 pass->groupId = (char *)
945 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
946 strcpy(pass->groupId, auth_groupId);
950 if (auth_userId && *auth_userId)
952 pass->userId = (char *)
953 odr_malloc(c->odr_out, strlen(auth_userId)+1);
954 strcpy(pass->userId, auth_userId);
958 if (auth_password && *auth_password)
960 pass->password = (char *)
961 odr_malloc(c->odr_out, strlen(auth_password)+1);
962 strcpy(pass->password, auth_password);
967 auth->which = Z_IdAuthentication_idPass;
968 auth->u.idPass = pass;
969 ireq->idAuthentication = auth;
972 else if (auth_userId)
974 auth->which = Z_IdAuthentication_open;
975 auth->u.open = (char *)
976 odr_malloc(c->odr_out, strlen(auth_userId)+1);
977 strcpy(auth->u.open, auth_userId);
978 ireq->idAuthentication = auth;
981 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
982 VAL_PROXY, 1, c->host_port);
983 if (c->charset||c->lang)
985 Z_OtherInformation **oi;
986 Z_OtherInformationUnit *oi_unit;
988 yaz_oi_APDU(apdu, &oi);
990 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
992 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
994 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
995 oi_unit->information.externallyDefinedInfo =
996 yaz_set_proposal_charneg
998 (const char **)&c->charset, (c->charset) ? 1:0,
999 (const char **)&c->lang, (c->lang) ? 1:0, 1);
1003 return send_APDU (c, apdu);
1007 static zoom_ret send_srw (ZOOM_connection c, Z_SRW_PDU *sr)
1010 Z_SOAP_Handler h[2] = {
1011 {"http://www.loc.gov/zing/srw/", 0, (Z_SOAP_fun) yaz_srw_codec},
1014 ODR o = odr_createmem(ODR_ENCODE);
1016 Z_SOAP *p = odr_malloc(o, sizeof(*p));
1020 gdu = z_get_HTTP_Request(c->odr_out);
1021 gdu->u.HTTP_Request->path = c->path;
1025 const char *cp0 = strstr(c->host_port, "://");
1026 const char *cp1 = 0;
1032 cp1 = strchr(cp0, '/');
1034 cp1 = cp0+strlen(cp0);
1038 char *h = odr_malloc(c->odr_out, cp1 - cp0 + 1);
1039 memcpy (h, cp0, cp1 - cp0);
1041 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1046 strcpy(ctype, "text/xml");
1047 if (c->charset && strlen(c->charset) < 20)
1049 strcat(ctype, "; charset=");
1050 strcat(ctype, c->charset);
1052 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1053 "Content-Type", ctype);
1054 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1055 "SOAPAction", "\"\"");
1056 p->which = Z_SOAP_generic;
1057 p->u.generic = odr_malloc(o, sizeof(*p->u.generic));
1058 p->u.generic->no = 0;
1059 p->u.generic->ns = 0;
1060 p->u.generic->p = sr;
1061 p->ns = "http://schemas.xmlsoap.org/soap/envelope/";
1063 ret = z_soap_codec_enc(o, &p,
1064 &gdu->u.HTTP_Request->content_buf,
1065 &gdu->u.HTTP_Request->content_len, h,
1068 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1069 return zoom_complete;
1070 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1074 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1075 ZOOM_connection_put_event (c, event);
1076 odr_reset(c->odr_out);
1077 return do_write (c);
1082 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1085 ZOOM_resultset resultset = 0;
1087 const char *recordPacking = 0;
1089 if (c->error) /* don't continue on error */
1090 return zoom_complete;
1092 if (c->tasks->which == ZOOM_TASK_SEARCH)
1094 resultset = c->tasks->u.search.resultset;
1095 resultset->setname = xstrdup ("default");
1096 ZOOM_options_set (resultset->options, "setname", resultset->setname);
1098 else if(c->tasks->which == ZOOM_TASK_RETRIEVE)
1100 resultset = c->tasks->u.retrieve.resultset;
1102 resultset->start = c->tasks->u.retrieve.start;
1103 resultset->count = c->tasks->u.retrieve.count;
1105 if (resultset->start >= resultset->size)
1106 return zoom_complete;
1107 if (resultset->start + resultset->count > resultset->size)
1108 resultset->count = resultset->size - resultset->start;
1110 for (i = 0; i<resultset->count; i++)
1113 record_cache_lookup (resultset, i + resultset->start);
1117 if (i == resultset->count)
1118 return zoom_complete;
1120 assert(resultset->query);
1122 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1124 if (resultset->query->z_query->which == Z_Query_type_104
1125 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1128 sr->u.request->query_type = Z_SRW_query_type_cql;
1129 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1131 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1132 resultset->query->z_query->u.type_1)
1134 sr->u.request->query_type = Z_SRW_query_type_pqf;
1135 sr->u.request->query.pqf = resultset->query->query_string;
1139 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1140 return zoom_complete;
1142 sr->u.request->startRecord = odr_intdup (c->odr_out, resultset->start + 1);
1143 sr->u.request->maximumRecords = odr_intdup (
1144 c->odr_out, resultset->step>0 ? resultset->step : resultset->count);
1145 sr->u.request->recordSchema = resultset->schema;
1147 recordPacking = ZOOM_resultset_option_get (resultset, "recordPacking");
1150 sr->u.request->recordPacking = odr_strdup(c->odr_out, recordPacking);
1152 return send_srw(c, sr);
1155 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1157 return zoom_complete;
1161 static zoom_ret ZOOM_connection_send_search (ZOOM_connection c)
1164 int lslb, ssub, mspn;
1166 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1167 Z_SearchRequest *search_req = apdu->u.searchRequest;
1168 const char *elementSetName;
1169 const char *smallSetElementSetName;
1170 const char *mediumSetElementSetName;
1173 assert (c->tasks->which == ZOOM_TASK_SEARCH);
1175 r = c->tasks->u.search.resultset;
1178 ZOOM_options_get (r->options, "elementSetName");
1179 smallSetElementSetName =
1180 ZOOM_options_get (r->options, "smallSetElementSetName");
1181 mediumSetElementSetName =
1182 ZOOM_options_get (r->options, "mediumSetElementSetName");
1184 if (!smallSetElementSetName)
1185 smallSetElementSetName = elementSetName;
1187 if (!mediumSetElementSetName)
1188 mediumSetElementSetName = elementSetName;
1193 /* prepare query for the search request */
1194 search_req->query = r->query->z_query;
1196 search_req->databaseNames =
1197 set_DatabaseNames (c, r->options, &search_req->num_databaseNames);
1199 /* get syntax (no need to provide unless piggyback is in effect) */
1200 syntax = ZOOM_options_get (r->options, "preferredRecordSyntax");
1202 lslb = ZOOM_options_get_int (r->options, "largeSetLowerBound", -1);
1203 ssub = ZOOM_options_get_int (r->options, "smallSetUpperBound", -1);
1204 mspn = ZOOM_options_get_int (r->options, "mediumSetPresentNumber", -1);
1205 if (lslb != -1 && ssub != -1 && mspn != -1)
1207 /* So're a Z39.50 expert? Let's hope you don't do sort */
1208 *search_req->largeSetLowerBound = lslb;
1209 *search_req->smallSetUpperBound = ssub;
1210 *search_req->mediumSetPresentNumber = mspn;
1212 else if (r->start == 0 && r->count > 0
1213 && r->piggyback && !r->r_sort_spec && !r->schema)
1215 /* Regular piggyback - do it unless we're going to do sort */
1216 *search_req->largeSetLowerBound = 2000000000;
1217 *search_req->smallSetUpperBound = 1;
1218 *search_req->mediumSetPresentNumber = r->step>0 ? r->step : r->count;
1222 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1223 smallSetElementSetName = 0;
1224 mediumSetElementSetName = 0;
1227 if (smallSetElementSetName && *smallSetElementSetName)
1229 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1230 odr_malloc (c->odr_out, sizeof(*esn));
1232 esn->which = Z_ElementSetNames_generic;
1233 esn->u.generic = odr_strdup (c->odr_out, smallSetElementSetName);
1234 search_req->smallSetElementSetNames = esn;
1236 if (mediumSetElementSetName && *mediumSetElementSetName)
1238 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1239 odr_malloc (c->odr_out, sizeof(*esn));
1241 esn->which = Z_ElementSetNames_generic;
1242 esn->u.generic = odr_strdup (c->odr_out, mediumSetElementSetName);
1243 search_req->mediumSetElementSetNames = esn;
1246 search_req->preferredRecordSyntax =
1247 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1251 if (c->support_named_resultsets)
1255 /* find the lowest unused ordinal so that we re-use
1256 result sets on the server. */
1257 for (ord = 1; ; ord++)
1260 sprintf (setname, "%d", ord);
1261 for (rp = c->resultsets; rp; rp = rp->next)
1262 if (rp->setname && !strcmp (rp->setname, setname))
1267 r->setname = xstrdup (setname);
1268 yaz_log (LOG_DEBUG, "allocating set %s", r->setname);
1271 r->setname = xstrdup ("default");
1272 ZOOM_options_set (r->options, "setname", r->setname);
1274 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1275 /* send search request */
1276 return send_APDU (c, apdu);
1279 static void response_diag (ZOOM_connection c, Z_DiagRec *p)
1282 Z_DefaultDiagFormat *r;
1287 if (p->which != Z_DiagRec_defaultFormat)
1289 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1292 r = p->u.defaultFormat;
1295 case Z_DefaultDiagFormat_v2Addinfo:
1296 addinfo = r->u.v2Addinfo;
1298 case Z_DefaultDiagFormat_v3Addinfo:
1299 addinfo = r->u.v3Addinfo;
1302 set_dset_error(c, *r->condition,
1303 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1307 ZOOM_API(ZOOM_record)
1308 ZOOM_record_clone (ZOOM_record srec)
1315 odr_enc = odr_createmem(ODR_ENCODE);
1316 if (!z_NamePlusRecord (odr_enc, &srec->npr, 0, 0))
1318 buf = odr_getbuf (odr_enc, &size, 0);
1320 nrec = (ZOOM_record) xmalloc (sizeof(*nrec));
1321 nrec->odr = odr_createmem(ODR_DECODE);
1322 nrec->wrbuf_marc = 0;
1323 nrec->wrbuf_iconv = 0;
1324 nrec->wrbuf_opac = 0;
1325 odr_setbuf (nrec->odr, buf, size, 0);
1326 z_NamePlusRecord (nrec->odr, &nrec->npr, 0, 0);
1328 odr_destroy (odr_enc);
1332 ZOOM_API(ZOOM_record)
1333 ZOOM_resultset_record_immediate (ZOOM_resultset s,size_t pos)
1335 return record_cache_lookup (s, pos);
1338 ZOOM_API(ZOOM_record)
1339 ZOOM_resultset_record (ZOOM_resultset r, size_t pos)
1341 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1345 ZOOM_resultset_retrieve (r, 1, pos, 1);
1346 rec = ZOOM_resultset_record_immediate (r, pos);
1352 ZOOM_record_destroy (ZOOM_record rec)
1356 if (rec->wrbuf_marc)
1357 wrbuf_free (rec->wrbuf_marc, 1);
1358 if (rec->wrbuf_iconv)
1359 wrbuf_free (rec->wrbuf_iconv, 1);
1360 if (rec->wrbuf_opac)
1361 wrbuf_free (rec->wrbuf_opac, 1);
1362 odr_destroy (rec->odr);
1366 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1368 const char *buf, int sz,
1369 const char *record_charset)
1374 yaz_marc_t mt = yaz_marc_create();
1377 strcpy(to, "UTF-8");
1378 if (record_charset && *record_charset)
1380 /* Use "from,to" or just "from" */
1381 const char *cp =strchr(record_charset, ',');
1382 int clen = strlen(record_charset);
1385 strncpy( to, cp+1, sizeof(to)-1);
1386 to[sizeof(to)-1] = '\0';
1387 clen = cp - record_charset;
1389 if (clen > sizeof(from)-1)
1390 clen = sizeof(from)-1;
1393 strncpy(from, record_charset, clen);
1399 cd = yaz_iconv_open(to, from);
1400 yaz_marc_iconv(mt, cd);
1403 yaz_marc_xml(mt, marc_type);
1404 if (!rec->wrbuf_marc)
1405 rec->wrbuf_marc = wrbuf_alloc();
1406 wrbuf_rewind (rec->wrbuf_marc);
1407 if (yaz_marc_decode_wrbuf (mt, buf, sz, rec->wrbuf_marc) > 0)
1409 yaz_marc_destroy(mt);
1411 yaz_iconv_close(cd);
1413 *len = wrbuf_len(rec->wrbuf_marc);
1414 return wrbuf_buf(rec->wrbuf_marc);
1416 yaz_marc_destroy(mt);
1418 yaz_iconv_close(cd);
1422 static const char *record_iconv_return(ZOOM_record rec, int *len,
1423 const char *buf, int sz,
1424 const char *record_charset)
1431 strcpy(to, "UTF-8");
1432 if (record_charset && *record_charset)
1434 /* Use "from,to" or just "from" */
1435 const char *cp =strchr(record_charset, ',');
1436 int clen = strlen(record_charset);
1439 strncpy( to, cp+1, sizeof(to)-1);
1440 to[sizeof(to)-1] = '\0';
1441 clen = cp - record_charset;
1443 if (clen > sizeof(from)-1)
1444 clen = sizeof(from)-1;
1447 strncpy(from, record_charset, clen);
1451 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1454 size_t inbytesleft = sz;
1455 const char *inp = buf;
1457 if (!rec->wrbuf_iconv)
1458 rec->wrbuf_iconv = wrbuf_alloc();
1460 wrbuf_rewind(rec->wrbuf_iconv);
1464 size_t outbytesleft = sizeof(outbuf);
1465 char *outp = outbuf;
1466 size_t r = yaz_iconv (cd, (char**) &inp,
1468 &outp, &outbytesleft);
1469 if (r == (size_t) (-1))
1471 int e = yaz_iconv_error(cd);
1472 if (e != YAZ_ICONV_E2BIG)
1475 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1477 wrbuf_puts(rec->wrbuf_iconv, "");
1478 buf = wrbuf_buf(rec->wrbuf_iconv);
1479 sz = wrbuf_len(rec->wrbuf_iconv);
1480 yaz_iconv_close(cd);
1487 ZOOM_API(const char *)
1488 ZOOM_record_get (ZOOM_record rec, const char *type_spec, int *len)
1495 Z_NamePlusRecord *npr;
1498 *len = 0; /* default return */
1507 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1509 if (cp[i] == ';' || cp[i] == ' ')
1515 while (type_spec[i] == ';')
1518 while (type_spec[i] == ' ')
1520 if (!strncmp(type_spec+i, "charset=", 8))
1523 for (i = 0; cp[i] && i < sizeof(charset)-1; i++)
1525 if (cp[i] == ';' || cp[i] == ' ')
1531 else if (!strncmp(type_spec+i, "xpath=", 6))
1534 for (i = 0; cp[i] && i < sizeof(xpath)-1; i++)
1538 while (type_spec[i] == ' ')
1541 if (!strcmp (type, "database"))
1544 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1545 return npr->databaseName;
1547 else if (!strcmp (type, "syntax"))
1549 const char *desc = 0;
1550 if (npr->which == Z_NamePlusRecord_databaseRecord)
1552 Z_External *r = (Z_External *) npr->u.databaseRecord;
1553 oident *ent = oid_getentbyoid(r->direct_reference);
1560 *len = strlen(desc);
1563 if (npr->which != Z_NamePlusRecord_databaseRecord)
1566 /* from now on - we have a database record .. */
1567 if (!strcmp (type, "render"))
1569 Z_External *r = (Z_External *) npr->u.databaseRecord;
1570 oident *ent = oid_getentbyoid(r->direct_reference);
1572 /* render bibliographic record .. */
1573 if (r->which == Z_External_OPAC)
1575 r = r->u.opac->bibliographicRecord;
1578 ent = oid_getentbyoid(r->direct_reference);
1580 if (r->which == Z_External_sutrs)
1581 return record_iconv_return(rec, len,
1582 r->u.sutrs->buf, r->u.sutrs->len,
1584 else if (r->which == Z_External_octet)
1586 const char *ret_buf;
1594 case VAL_APPLICATION_XML:
1597 ret_buf = marc_iconv_return(
1598 rec, YAZ_MARC_LINE, len,
1599 (const char *) r->u.octet_aligned->buf,
1600 r->u.octet_aligned->len,
1605 return record_iconv_return(rec, len,
1606 (const char *) r->u.octet_aligned->buf,
1607 r->u.octet_aligned->len,
1610 else if (r->which == Z_External_grs1)
1612 if (!rec->wrbuf_marc)
1613 rec->wrbuf_marc = wrbuf_alloc();
1614 wrbuf_rewind (rec->wrbuf_marc);
1615 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1616 return record_iconv_return(rec, len,
1617 wrbuf_buf(rec->wrbuf_marc),
1618 wrbuf_len(rec->wrbuf_marc),
1623 else if (!strcmp (type, "xml") || !strcmp(type, "oai"))
1625 Z_External *r = (Z_External *) npr->u.databaseRecord;
1626 oident *ent = oid_getentbyoid(r->direct_reference);
1628 /* render bibliographic record .. */
1629 if (r->which == Z_External_OPAC)
1631 r = r->u.opac->bibliographicRecord;
1634 ent = oid_getentbyoid(r->direct_reference);
1637 if (r->which == Z_External_sutrs)
1638 return record_iconv_return(rec, len,
1639 (const char *) r->u.sutrs->buf,
1642 else if (r->which == Z_External_octet)
1644 const char *ret_buf;
1645 int marc_decode_type = YAZ_MARC_MARCXML;
1647 if (!strcmp(type, "oai"))
1648 marc_decode_type = YAZ_MARC_OAIMARC;
1656 case VAL_APPLICATION_XML:
1659 ret_buf = marc_iconv_return(
1660 rec, marc_decode_type, len,
1661 (const char *) r->u.octet_aligned->buf,
1662 r->u.octet_aligned->len,
1667 return record_iconv_return(rec, len,
1668 (const char *) r->u.octet_aligned->buf,
1669 r->u.octet_aligned->len,
1672 else if (r->which == Z_External_grs1)
1679 else if (!strcmp (type, "raw"))
1681 Z_External *r = (Z_External *) npr->u.databaseRecord;
1683 if (r->which == Z_External_sutrs)
1685 if (len) *len = r->u.sutrs->len;
1686 return (const char *) r->u.sutrs->buf;
1688 else if (r->which == Z_External_octet)
1690 if (len) *len = r->u.octet_aligned->len;
1691 return (const char *) r->u.octet_aligned->buf;
1693 else /* grs-1, explain, OPAC, ... */
1696 return (const char *) npr->u.databaseRecord;
1700 else if (!strcmp (type, "ext"))
1703 return (const char *) npr->u.databaseRecord;
1705 else if (!strcmp (type, "opac"))
1708 Z_External *r = (Z_External *) npr->u.databaseRecord;
1709 if (r->which == Z_External_OPAC)
1711 if (!rec->wrbuf_opac)
1712 rec->wrbuf_opac = wrbuf_alloc();
1713 wrbuf_rewind (rec->wrbuf_opac);
1714 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
1715 return record_iconv_return(rec, len,
1716 wrbuf_buf(rec->wrbuf_opac),
1717 wrbuf_len(rec->wrbuf_opac),
1724 static int strcmp_null(const char *v1, const char *v2)
1730 return strcmp(v1, v2);
1733 static void record_cache_add (ZOOM_resultset r, Z_NamePlusRecord *npr,
1736 ZOOM_record_cache rc;
1737 const char *elementSetName =
1738 ZOOM_resultset_option_get (r, "elementSetName");
1739 const char *syntax =
1740 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
1742 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1743 ZOOM_connection_put_event(r->connection, event);
1745 for (rc = r->record_cache; rc; rc = rc->next)
1749 if (strcmp_null(r->schema, rc->schema))
1751 if (strcmp_null(elementSetName,rc->elementSetName))
1753 if (strcmp_null(syntax, rc->syntax))
1755 /* not destroying rc->npr (it's handled by nmem )*/
1757 /* keeping wrbuf_marc too */
1761 rc = (ZOOM_record_cache) odr_malloc (r->odr, sizeof(*rc));
1764 rc->rec.wrbuf_marc = 0;
1765 rc->rec.wrbuf_iconv = 0;
1766 rc->rec.wrbuf_opac = 0;
1768 rc->elementSetName = odr_strdup (r->odr, elementSetName);
1770 rc->elementSetName = 0;
1773 rc->syntax = odr_strdup (r->odr, syntax);
1778 rc->schema = odr_strdup (r->odr, r->schema);
1783 rc->next = r->record_cache;
1784 r->record_cache = rc;
1787 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos)
1789 ZOOM_record_cache rc;
1790 const char *elementSetName =
1791 ZOOM_resultset_option_get (r, "elementSetName");
1792 const char *syntax =
1793 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
1795 for (rc = r->record_cache; rc; rc = rc->next)
1799 if (strcmp_null(r->schema, rc->schema))
1801 if (strcmp_null(elementSetName,rc->elementSetName))
1803 if (strcmp_null(syntax, rc->syntax))
1811 static void handle_records (ZOOM_connection c, Z_Records *sr,
1814 ZOOM_resultset resultset;
1818 switch (c->tasks->which)
1820 case ZOOM_TASK_SEARCH:
1821 resultset = c->tasks->u.search.resultset;
1823 case ZOOM_TASK_RETRIEVE:
1824 resultset = c->tasks->u.retrieve.resultset;
1829 if (sr && sr->which == Z_Records_NSD)
1831 Z_DiagRec dr, *dr_p = &dr;
1832 dr.which = Z_DiagRec_defaultFormat;
1833 dr.u.defaultFormat = sr->u.nonSurrogateDiagnostic;
1835 response_diag (c, dr_p);
1837 else if (sr && sr->which == Z_Records_multipleNSD)
1839 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
1840 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
1842 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1846 if (resultset->count + resultset->start > resultset->size)
1847 resultset->count = resultset->size - resultset->start;
1848 if (resultset->count < 0)
1849 resultset->count = 0;
1850 if (sr && sr->which == Z_Records_DBOSD)
1853 NMEM nmem = odr_extract_mem (c->odr_in);
1854 Z_NamePlusRecordList *p =
1855 sr->u.databaseOrSurDiagnostics;
1856 for (i = 0; i<p->num_records; i++)
1858 record_cache_add (resultset, p->records[i],
1859 i+ resultset->start);
1861 /* transfer our response to search_nmem .. we need it later */
1862 nmem_transfer (resultset->odr->mem, nmem);
1863 nmem_destroy (nmem);
1864 if (present_phase && p->num_records == 0)
1866 /* present response and we didn't get any records! */
1867 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1870 else if (present_phase)
1872 /* present response and we didn't get any records! */
1873 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1878 static void handle_present_response (ZOOM_connection c, Z_PresentResponse *pr)
1880 handle_records (c, pr->records, 1);
1883 static void handle_search_response (ZOOM_connection c, Z_SearchResponse *sr)
1885 ZOOM_resultset resultset;
1888 yaz_log (LOG_DEBUG, "got search response");
1890 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1893 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
1894 ZOOM_connection_put_event(c, event);
1896 resultset = c->tasks->u.search.resultset;
1898 resultset->size = *sr->resultCount;
1899 handle_records (c, sr->records, 0);
1902 static void sort_response (ZOOM_connection c, Z_SortResponse *res)
1904 if (res->diagnostics && res->num_diagnostics > 0)
1905 response_diag (c, res->diagnostics[0]);
1908 static int scan_response (ZOOM_connection c, Z_ScanResponse *res)
1910 NMEM nmem = odr_extract_mem (c->odr_in);
1913 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
1915 scan = c->tasks->u.scan.scan;
1917 if (res->entries && res->entries->nonsurrogateDiagnostics)
1918 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
1919 scan->scan_response = res;
1920 nmem_transfer (scan->odr->mem, nmem);
1922 ZOOM_options_set_int (scan->options, "stepSize", *res->stepSize);
1923 if (res->positionOfTerm)
1924 ZOOM_options_set_int (scan->options, "position", *res->positionOfTerm);
1925 if (res->scanStatus)
1926 ZOOM_options_set_int (scan->options, "scanStatus", *res->scanStatus);
1927 if (res->numberOfEntriesReturned)
1928 ZOOM_options_set_int (scan->options, "number",
1929 *res->numberOfEntriesReturned);
1930 nmem_destroy (nmem);
1934 static zoom_ret send_sort (ZOOM_connection c)
1936 ZOOM_resultset resultset;
1938 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1939 return zoom_complete;
1941 resultset = c->tasks->u.search.resultset;
1945 resultset->r_sort_spec = 0;
1946 return zoom_complete;
1948 if (resultset->r_sort_spec)
1950 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
1951 Z_SortRequest *req = apdu->u.sortRequest;
1953 req->num_inputResultSetNames = 1;
1954 req->inputResultSetNames = (Z_InternationalString **)
1955 odr_malloc (c->odr_out, sizeof(*req->inputResultSetNames));
1956 req->inputResultSetNames[0] =
1957 odr_strdup (c->odr_out, resultset->setname);
1958 req->sortedResultSetName = odr_strdup (c->odr_out, resultset->setname);
1959 req->sortSequence = resultset->r_sort_spec;
1960 resultset->r_sort_spec = 0;
1961 return send_APDU (c, apdu);
1963 return zoom_complete;
1966 static zoom_ret send_present (ZOOM_connection c)
1969 Z_PresentRequest *req = 0;
1971 const char *syntax = 0;
1972 const char *elementSetName = 0;
1973 ZOOM_resultset resultset;
1976 return zoom_complete;
1978 switch (c->tasks->which)
1980 case ZOOM_TASK_SEARCH:
1981 resultset = c->tasks->u.search.resultset;
1983 case ZOOM_TASK_RETRIEVE:
1984 resultset = c->tasks->u.retrieve.resultset;
1985 resultset->start = c->tasks->u.retrieve.start;
1986 resultset->count = c->tasks->u.retrieve.count;
1988 if (resultset->start >= resultset->size)
1989 return zoom_complete;
1990 if (resultset->start + resultset->count > resultset->size)
1991 resultset->count = resultset->size - resultset->start;
1994 return zoom_complete;
1997 syntax = ZOOM_resultset_option_get (resultset, "preferredRecordSyntax");
1998 elementSetName = ZOOM_resultset_option_get (resultset, "elementSetName");
2000 if (c->error) /* don't continue on error */
2001 return zoom_complete;
2002 if (resultset->start < 0)
2003 return zoom_complete;
2004 for (i = 0; i<resultset->count; i++)
2007 record_cache_lookup (resultset, i + resultset->start);
2011 if (i == resultset->count)
2012 return zoom_complete;
2014 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2015 req = apdu->u.presentRequest;
2017 resultset->start += i;
2018 resultset->count -= i;
2019 *req->resultSetStartPoint = resultset->start + 1;
2020 *req->numberOfRecordsRequested = resultset->step>0 ?
2021 resultset->step : resultset->count;
2022 assert (*req->numberOfRecordsRequested > 0);
2024 if (syntax && *syntax)
2025 req->preferredRecordSyntax =
2026 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
2028 if (resultset->schema && *resultset->schema)
2030 Z_RecordComposition *compo = (Z_RecordComposition *)
2031 odr_malloc (c->odr_out, sizeof(*compo));
2033 req->recordComposition = compo;
2034 compo->which = Z_RecordComp_complex;
2035 compo->u.complex = (Z_CompSpec *)
2036 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2037 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2038 odr_malloc(c->odr_out, sizeof(bool_t));
2039 *compo->u.complex->selectAlternativeSyntax = 0;
2041 compo->u.complex->generic = (Z_Specification *)
2042 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2044 compo->u.complex->generic->which = Z_Schema_oid;
2045 compo->u.complex->generic->schema.oid = (Odr_oid *)
2046 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2048 if (!compo->u.complex->generic->schema.oid)
2050 /* OID wasn't a schema! Try record syntax instead. */
2052 compo->u.complex->generic->schema.oid = (Odr_oid *)
2053 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2055 if (elementSetName && *elementSetName)
2057 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2058 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2059 compo->u.complex->generic->elementSpec->which =
2060 Z_ElementSpec_elementSetName;
2061 compo->u.complex->generic->elementSpec->u.elementSetName =
2062 odr_strdup (c->odr_out, elementSetName);
2065 compo->u.complex->generic->elementSpec = 0;
2066 compo->u.complex->num_dbSpecific = 0;
2067 compo->u.complex->dbSpecific = 0;
2068 compo->u.complex->num_recordSyntax = 0;
2069 compo->u.complex->recordSyntax = 0;
2071 else if (elementSetName && *elementSetName)
2073 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2074 odr_malloc (c->odr_out, sizeof(*esn));
2075 Z_RecordComposition *compo = (Z_RecordComposition *)
2076 odr_malloc (c->odr_out, sizeof(*compo));
2078 esn->which = Z_ElementSetNames_generic;
2079 esn->u.generic = odr_strdup (c->odr_out, elementSetName);
2080 compo->which = Z_RecordComp_simple;
2081 compo->u.simple = esn;
2082 req->recordComposition = compo;
2084 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2085 return send_APDU (c, apdu);
2088 ZOOM_API(ZOOM_scanset)
2089 ZOOM_connection_scan (ZOOM_connection c, const char *start)
2091 ZOOM_scanset scan = (ZOOM_scanset) xmalloc (sizeof(*scan));
2093 scan->connection = c;
2094 scan->odr = odr_createmem (ODR_DECODE);
2095 scan->options = ZOOM_options_create_with_parent (c->options);
2097 scan->scan_response = 0;
2099 if ((scan->termListAndStartPoint =
2100 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet,
2103 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_SCAN);
2104 task->u.scan.scan = scan;
2109 while (ZOOM_event (1, &c))
2117 ZOOM_scanset_destroy (ZOOM_scanset scan)
2122 if (scan->refcount == 0)
2124 odr_destroy (scan->odr);
2126 ZOOM_options_destroy (scan->options);
2131 static zoom_ret send_package (ZOOM_connection c)
2135 return zoom_complete;
2136 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2138 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
2139 ZOOM_connection_put_event (c, event);
2141 return do_write_ex (c, c->tasks->u.package->buf_out,
2142 c->tasks->u.package->len_out);
2145 static zoom_ret send_scan (ZOOM_connection c)
2148 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2149 Z_ScanRequest *req = apdu->u.scanRequest;
2151 return zoom_complete;
2152 assert (c->tasks->which == ZOOM_TASK_SCAN);
2153 scan = c->tasks->u.scan.scan;
2155 req->termListAndStartPoint = scan->termListAndStartPoint;
2156 req->attributeSet = scan->attributeSet;
2158 *req->numberOfTermsRequested =
2159 ZOOM_options_get_int(scan->options, "number", 10);
2161 req->preferredPositionInResponse =
2162 odr_intdup (c->odr_out,
2163 ZOOM_options_get_int(scan->options, "position", 1));
2166 odr_intdup (c->odr_out,
2167 ZOOM_options_get_int(scan->options, "stepSize", 0));
2169 req->databaseNames = set_DatabaseNames (c, scan->options,
2170 &req->num_databaseNames);
2172 return send_APDU (c, apdu);
2176 ZOOM_scanset_size (ZOOM_scanset scan)
2178 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2180 return scan->scan_response->entries->num_entries;
2183 ZOOM_API(const char *)
2184 ZOOM_scanset_term (ZOOM_scanset scan, size_t pos,
2187 const char *term = 0;
2188 size_t noent = ZOOM_scanset_size (scan);
2189 Z_ScanResponse *res = scan->scan_response;
2195 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2197 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2199 if (t->term->which == Z_Term_general)
2201 term = (const char *) t->term->u.general->buf;
2202 *len = t->term->u.general->len;
2204 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2209 ZOOM_API(const char *)
2210 ZOOM_scanset_display_term (ZOOM_scanset scan, size_t pos,
2213 const char *term = 0;
2214 size_t noent = ZOOM_scanset_size (scan);
2215 Z_ScanResponse *res = scan->scan_response;
2221 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2223 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2227 term = t->displayTerm;
2228 *len = strlen(term);
2230 else if (t->term->which == Z_Term_general)
2232 term = (const char *) t->term->u.general->buf;
2233 *len = t->term->u.general->len;
2235 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2240 ZOOM_API(const char *)
2241 ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key)
2243 return ZOOM_options_get (scan->options, key);
2247 ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
2250 ZOOM_options_set (scan->options, key, val);
2253 static Z_APDU *create_es_package (ZOOM_package p, int type)
2256 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2257 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2259 *req->function = Z_ExtendedServicesRequest_create;
2261 str = ZOOM_options_get(p->options, "package-name");
2263 req->packageName = nmem_strdup (p->odr_out->mem, str);
2265 str = ZOOM_options_get(p->options, "user-id");
2267 req->userId = nmem_strdup (p->odr_out->mem, str);
2269 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2272 str = ZOOM_options_get(p->options, "function");
2275 if (!strcmp (str, "create"))
2277 if (!strcmp (str, "delete"))
2279 if (!strcmp (str, "modify"))
2285 static const char *ill_array_lookup (void *clientData, const char *idx)
2287 ZOOM_package p = (ZOOM_package) clientData;
2288 return ZOOM_options_get (p->options, idx+4);
2291 static Z_External *encode_ill_request (ZOOM_package p)
2293 ODR out = p->odr_out;
2296 struct ill_get_ctl ctl;
2298 ctl.odr = p->odr_out;
2300 ctl.f = ill_array_lookup;
2302 req = ill_get_ILLRequest(&ctl, "ill", 0);
2304 if (!ill_Request (out, &req, 0, 0))
2306 int ill_request_size;
2307 char *ill_request_buf = odr_getbuf (out, &ill_request_size, 0);
2308 if (ill_request_buf)
2309 odr_setbuf (out, ill_request_buf, ill_request_size, 1);
2315 int illRequest_size = 0;
2316 char *illRequest_buf = odr_getbuf (out, &illRequest_size, 0);
2318 oid.proto = PROTO_GENERAL;
2319 oid.oclass = CLASS_GENERAL;
2320 oid.value = VAL_ISO_ILL_1;
2322 r = (Z_External *) odr_malloc (out, sizeof(*r));
2323 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2324 r->indirect_reference = 0;
2326 r->which = Z_External_single;
2328 r->u.single_ASN1_type = (Odr_oct *)
2329 odr_malloc (out, sizeof(*r->u.single_ASN1_type));
2330 r->u.single_ASN1_type->buf = (unsigned char*)
2331 odr_malloc (out, illRequest_size);
2332 r->u.single_ASN1_type->len = illRequest_size;
2333 r->u.single_ASN1_type->size = illRequest_size;
2334 memcpy (r->u.single_ASN1_type->buf, illRequest_buf, illRequest_size);
2339 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2341 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc (p->odr_out, sizeof(*req));
2344 req->which=Z_IOItemOrder_esRequest;
2345 req->u.esRequest = (Z_IORequest *)
2346 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2348 /* to keep part ... */
2349 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2350 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2351 req->u.esRequest->toKeep->supplDescription = 0;
2352 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2353 odr_malloc (p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2355 str = ZOOM_options_get(p->options, "contact-name");
2356 req->u.esRequest->toKeep->contact->name = str ?
2357 nmem_strdup (p->odr_out->mem, str) : 0;
2359 str = ZOOM_options_get(p->options, "contact-phone");
2360 req->u.esRequest->toKeep->contact->phone = str ?
2361 nmem_strdup (p->odr_out->mem, str) : 0;
2363 str = ZOOM_options_get(p->options, "contact-email");
2364 req->u.esRequest->toKeep->contact->email = str ?
2365 nmem_strdup (p->odr_out->mem, str) : 0;
2367 req->u.esRequest->toKeep->addlBilling = 0;
2369 /* not to keep part ... */
2370 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2371 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2373 str = ZOOM_options_get(p->options, "itemorder-setname");
2378 req->u.esRequest->notToKeep->resultSetItem = 0;
2381 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2382 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2384 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2385 nmem_strdup (p->odr_out->mem, str);
2386 req->u.esRequest->notToKeep->resultSetItem->item =
2387 (int *) odr_malloc(p->odr_out, sizeof(int));
2389 str = ZOOM_options_get(p->options, "itemorder-item");
2390 *req->u.esRequest->notToKeep->resultSetItem->item =
2391 (str ? atoi(str) : 1);
2393 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2398 Z_APDU *create_admin_package(ZOOM_package p, int type,
2399 Z_ESAdminOriginPartToKeep **toKeepP,
2400 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2402 Z_APDU *apdu = create_es_package (p, VAL_ADMINSERVICE);
2405 Z_ESAdminOriginPartToKeep *toKeep;
2406 Z_ESAdminOriginPartNotToKeep *notToKeep;
2407 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2408 const char *first_db = "Default";
2410 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2414 r->direct_reference =
2415 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2418 r->indirect_reference = 0;
2419 r->which = Z_External_ESAdmin;
2421 r->u.adminService = (Z_Admin *)
2422 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2423 r->u.adminService->which = Z_Admin_esRequest;
2424 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2425 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2427 toKeep = r->u.adminService->u.esRequest->toKeep =
2428 (Z_ESAdminOriginPartToKeep *)
2429 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2431 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2432 toKeep->u.create=odr_nullval();
2433 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2435 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2436 (Z_ESAdminOriginPartNotToKeep *)
2437 odr_malloc(p->odr_out,
2438 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2439 notToKeep->which=Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
2440 notToKeep->u.recordsWillFollow=odr_nullval();
2444 *notToKeepP = notToKeep;
2449 static Z_APDU *create_update_package(ZOOM_package p)
2452 const char *first_db = "Default";
2454 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2455 const char *action = ZOOM_options_get(p->options, "action");
2456 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
2457 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
2458 const char *record_buf = ZOOM_options_get(p->options, "record");
2459 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
2460 int syntax_oid = VAL_NONE;
2464 syntax_oid = oid_getvalbyname(syntax_str);
2467 record_buf = "void";
2468 syntax_oid = VAL_SUTRS;
2470 if (syntax_oid != VAL_NONE)
2471 syntax_oid = VAL_TEXT_XML;
2477 action = "specialUpdate";
2479 if (!strcmp(action, "recordInsert"))
2480 action_no = Z_IUOriginPartToKeep_recordInsert;
2481 else if (!strcmp(action, "recordReplace"))
2482 action_no = Z_IUOriginPartToKeep_recordReplace;
2483 else if (!strcmp(action, "recordDelete"))
2484 action_no = Z_IUOriginPartToKeep_recordDelete;
2485 else if (!strcmp(action, "elementUpdate"))
2486 action_no = Z_IUOriginPartToKeep_elementUpdate;
2487 else if (!strcmp(action, "specialUpdate"))
2488 action_no = Z_IUOriginPartToKeep_specialUpdate;
2492 apdu = create_es_package (p, VAL_DBUPDATE);
2495 Z_IUOriginPartToKeep *toKeep;
2496 Z_IUSuppliedRecords *notToKeep;
2497 Z_External *r = (Z_External *)
2498 odr_malloc (p->odr_out, sizeof(*r));
2500 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2502 r->direct_reference =
2503 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2506 r->which = Z_External_update;
2507 r->indirect_reference = 0;
2508 r->u.update = (Z_IUUpdate *)
2509 odr_malloc(p->odr_out, sizeof(*r->u.update));
2511 r->u.update->which = Z_IUUpdate_esRequest;
2512 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
2513 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
2514 toKeep = r->u.update->u.esRequest->toKeep =
2515 (Z_IUOriginPartToKeep *)
2516 odr_malloc(p->odr_out, sizeof(*toKeep));
2518 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2520 toKeep->elementSetName = 0;
2521 toKeep->actionQualifier = 0;
2522 toKeep->action = odr_intdup(p->odr_out, action_no);
2524 notToKeep = r->u.update->u.esRequest->notToKeep =
2525 (Z_IUSuppliedRecords *)
2526 odr_malloc(p->odr_out, sizeof(*notToKeep));
2528 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
2529 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
2530 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
2531 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
2532 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
2535 notToKeep->elements[0]->u.opaque = (Odr_oct *)
2536 odr_malloc (p->odr_out, sizeof(Odr_oct));
2537 notToKeep->elements[0]->u.opaque->size =
2538 notToKeep->elements[0]->u.opaque->len = strlen(recordIdOpaque);
2539 notToKeep->elements[0]->u.opaque->buf =
2540 odr_strdup(p->odr_out, recordIdOpaque);
2542 else if (recordIdNumber)
2544 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
2546 notToKeep->elements[0]->u.number =
2547 odr_intdup(p->odr_out, atoi(recordIdNumber));
2550 notToKeep->elements[0]->u.opaque = 0;
2551 notToKeep->elements[0]->supplementalId = 0;
2552 notToKeep->elements[0]->correlationInfo = 0;
2553 notToKeep->elements[0]->record =
2554 z_ext_record(p->odr_out, syntax_oid,
2555 record_buf, strlen(record_buf));
2559 ODR print = odr_createmem(ODR_PRINT);
2561 z_APDU(print, &apdu, 0, 0);
2568 ZOOM_package_send (ZOOM_package p, const char *type)
2575 odr_reset (p->odr_out);
2578 if (!strcmp(type, "itemorder"))
2580 apdu = create_es_package (p, VAL_ITEMORDER);
2583 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2585 r->direct_reference =
2586 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2589 r->which = Z_External_itemOrder;
2590 r->indirect_reference = 0;
2591 r->u.itemOrder = encode_item_order (p);
2593 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2596 if (!strcmp(type, "create")) /* create database */
2598 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
2601 if (!strcmp(type, "drop")) /* drop database */
2603 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
2606 if (!strcmp(type, "update")) /* update record(s) */
2608 apdu = create_update_package(p);
2612 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
2616 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_PACKAGE);
2617 task->u.package = p;
2618 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
2619 p->buf_out = (char *) xmalloc (p->len_out);
2620 memcpy (p->buf_out, buf, p->len_out);
2625 while (ZOOM_event (1, &c))
2632 ZOOM_API(ZOOM_package)
2633 ZOOM_connection_package (ZOOM_connection c, ZOOM_options options)
2635 ZOOM_package p = (ZOOM_package) xmalloc (sizeof(*p));
2638 p->odr_out = odr_createmem (ODR_ENCODE);
2639 p->options = ZOOM_options_create_with_parent2 (options, c->options);
2647 ZOOM_package_destroy(ZOOM_package p)
2652 if (p->refcount == 0)
2654 odr_destroy (p->odr_out);
2657 ZOOM_options_destroy (p->options);
2662 ZOOM_API(const char *)
2663 ZOOM_package_option_get (ZOOM_package p, const char *key)
2665 return ZOOM_options_get (p->options, key);
2670 ZOOM_package_option_set (ZOOM_package p, const char *key,
2673 ZOOM_options_set (p->options, key, val);
2676 static int ZOOM_connection_exec_task (ZOOM_connection c)
2678 ZOOM_task task = c->tasks;
2679 zoom_ret ret = zoom_complete;
2683 yaz_log (LOG_DEBUG, "ZOOM_connection_exec_task task=<null>");
2686 yaz_log (LOG_DEBUG, "ZOOM_connection_exec_task type=%d run=%d",
2687 task->which, task->running);
2688 if (c->error != ZOOM_ERROR_NONE)
2690 yaz_log (LOG_DEBUG, "remove tasks because of error = %d", c->error);
2691 ZOOM_connection_remove_tasks (c);
2696 yaz_log (LOG_DEBUG, "task already running");
2700 ret = zoom_complete;
2701 if (c->cs || task->which == ZOOM_TASK_CONNECT)
2703 switch (task->which)
2705 case ZOOM_TASK_SEARCH:
2706 if (c->proto == PROTO_HTTP)
2707 ret = ZOOM_connection_srw_send_search(c);
2709 ret = ZOOM_connection_send_search(c);
2711 case ZOOM_TASK_RETRIEVE:
2712 if (c->proto == PROTO_HTTP)
2713 ret = ZOOM_connection_srw_send_search(c);
2715 ret = send_present (c);
2717 case ZOOM_TASK_CONNECT:
2718 ret = do_connect(c);
2720 case ZOOM_TASK_SCAN:
2723 case ZOOM_TASK_PACKAGE:
2724 ret = send_package(c);
2730 yaz_log (LOG_DEBUG, "remove tasks because no connection exist");
2731 ZOOM_connection_remove_tasks (c);
2733 if (ret == zoom_complete)
2735 yaz_log (LOG_DEBUG, "task removed (complete)");
2736 ZOOM_connection_remove_task (c);
2739 yaz_log (LOG_DEBUG, "task pending");
2743 static zoom_ret send_sort_present (ZOOM_connection c)
2745 zoom_ret r = send_sort (c);
2746 if (r == zoom_complete)
2747 r = send_present (c);
2751 static int es_response (ZOOM_connection c,
2752 Z_ExtendedServicesResponse *res)
2754 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
2756 if (res->diagnostics && res->num_diagnostics > 0)
2757 response_diag(c, res->diagnostics[0]);
2758 if (res->taskPackage &&
2759 res->taskPackage->which == Z_External_extendedService)
2761 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
2762 Odr_oct *id = taskPackage->targetReference;
2765 ZOOM_options_setl (c->tasks->u.package->options,
2766 "targetReference", (char*) id->buf, id->len);
2772 static void handle_apdu (ZOOM_connection c, Z_APDU *apdu)
2774 Z_InitResponse *initrs;
2777 yaz_log (LOG_DEBUG, "recv APDU type=%d", apdu->which);
2780 case Z_APDU_initResponse:
2781 initrs = apdu->u.initResponse;
2782 ZOOM_connection_option_set(c, "serverImplementationId",
2783 initrs->implementationId ?
2784 initrs->implementationId : "");
2785 ZOOM_connection_option_set(c, "serverImplementationName",
2786 initrs->implementationName ?
2787 initrs->implementationName : "");
2788 ZOOM_connection_option_set(c, "serverImplementationVersion",
2789 initrs->implementationVersion ?
2790 initrs->implementationVersion : "");
2791 /* Set the three old options too, for old applications */
2792 ZOOM_connection_option_set(c, "targetImplementationId",
2793 initrs->implementationId ?
2794 initrs->implementationId : "");
2795 ZOOM_connection_option_set(c, "targetImplementationName",
2796 initrs->implementationName ?
2797 initrs->implementationName : "");
2798 ZOOM_connection_option_set(c, "targetImplementationVersion",
2799 initrs->implementationVersion ?
2800 initrs->implementationVersion : "");
2801 if (!*initrs->result)
2803 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0);
2808 yaz_oi_get_string_oidval (&apdu->u.initResponse->otherInfo,
2810 xfree (c->cookie_in);
2813 c->cookie_in = xstrdup(cookie);
2814 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
2815 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
2816 c->support_named_resultsets = 1;
2819 assert (c->tasks->which == ZOOM_TASK_CONNECT);
2820 ZOOM_connection_remove_task (c);
2822 ZOOM_connection_exec_task (c);
2824 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
2826 NMEM tmpmem = nmem_create();
2827 Z_CharSetandLanguageNegotiation *p =
2828 yaz_get_charneg_record(initrs->otherInfo);
2832 char *charset=NULL, *lang=NULL;
2835 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
2836 yaz_log(LOG_DEBUG, "Target accepted: charset %s, "
2837 "language %s, select %d",
2838 charset ? charset : "none", lang ? lang : "none", sel);
2840 ZOOM_connection_option_set (c, "negotiation-charset",
2843 ZOOM_connection_option_set (c, "negotiation-lang",
2845 nmem_destroy(tmpmem);
2849 case Z_APDU_searchResponse:
2850 handle_search_response (c, apdu->u.searchResponse);
2851 if (send_sort_present (c) == zoom_complete)
2852 ZOOM_connection_remove_task (c);
2854 case Z_APDU_presentResponse:
2855 handle_present_response (c, apdu->u.presentResponse);
2856 if (send_present (c) == zoom_complete)
2857 ZOOM_connection_remove_task (c);
2859 case Z_APDU_sortResponse:
2860 sort_response (c, apdu->u.sortResponse);
2861 if (send_present (c) == zoom_complete)
2862 ZOOM_connection_remove_task (c);
2864 case Z_APDU_scanResponse:
2865 scan_response (c, apdu->u.scanResponse);
2866 ZOOM_connection_remove_task (c);
2868 case Z_APDU_extendedServicesResponse:
2869 es_response (c, apdu->u.extendedServicesResponse);
2870 ZOOM_connection_remove_task (c);
2873 if (c->reconnect_ok)
2876 c->tasks->running = 0;
2877 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
2881 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, 0);
2886 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2892 static void handle_srw_response(ZOOM_connection c,
2893 Z_SRW_searchRetrieveResponse *res)
2895 ZOOM_resultset resultset = 0;
2903 if (c->tasks->which == ZOOM_TASK_SEARCH)
2904 resultset = c->tasks->u.search.resultset;
2905 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
2906 resultset = c->tasks->u.retrieve.resultset;
2910 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2911 ZOOM_connection_put_event(c, event);
2913 resultset->size = 0;
2915 yaz_log(LOG_DEBUG, "got SRW response OK");
2917 if (res->numberOfRecords)
2918 resultset->size = *res->numberOfRecords;
2920 for (i = 0; i<res->num_records; i++)
2924 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
2925 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
2927 if (res->records[i].recordPosition &&
2928 *res->records[i].recordPosition > 0)
2929 pos = *res->records[i].recordPosition - 1;
2931 pos = resultset->start + i;
2933 npr->databaseName = 0;
2934 npr->which = Z_NamePlusRecord_databaseRecord;
2935 npr->u.databaseRecord = (Z_External *)
2936 odr_malloc(c->odr_in, sizeof(Z_External));
2937 npr->u.databaseRecord->descriptor = 0;
2938 npr->u.databaseRecord->direct_reference =
2939 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
2940 npr->u.databaseRecord->which = Z_External_octet;
2941 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
2942 odr_malloc(c->odr_in, sizeof(Odr_oct));
2943 npr->u.databaseRecord->u.octet_aligned->buf =
2944 res->records[i].recordData_buf;
2945 npr->u.databaseRecord->u.octet_aligned->len =
2946 npr->u.databaseRecord->u.octet_aligned->size =
2947 res->records[i].recordData_len;
2948 record_cache_add (resultset, npr, pos);
2950 if (res->num_diagnostics > 0)
2952 const char *std_diag = "info:srw/diagnostic/1/1/";
2953 const char *code = res->diagnostics[0].code;
2955 const char *category = code;
2958 if (code && (cp = strrchr(code, '/')))
2959 code_int = atoi(cp+1);
2960 if (code && !strncmp(code, std_diag, strlen(std_diag)))
2964 set_dset_error(c, code_int, category,
2965 res->diagnostics[0].details, 0);
2967 nmem = odr_extract_mem(c->odr_in);
2968 nmem_transfer(resultset->odr->mem, nmem);
2974 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
2977 const char *content_type = z_HTTP_header_lookup(hres->headers,
2979 const char *connection_head = z_HTTP_header_lookup(hres->headers,
2982 yaz_log (LOG_DEBUG, "handle_http");
2984 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
2986 Z_SOAP *soap_package = 0;
2988 Z_SOAP_Handler soap_handlers[2] = {
2989 {"http://www.loc.gov/zing/srw/", 0,
2990 (Z_SOAP_fun) yaz_srw_codec},
2993 ret = z_soap_codec(o, &soap_package,
2994 &hres->content_buf, &hres->content_len,
2996 if (!ret && soap_package->which == Z_SOAP_generic &&
2997 soap_package->u.generic->no == 0)
2999 Z_SRW_PDU *sr = soap_package->u.generic->p;
3000 if (sr->which == Z_SRW_searchRetrieve_response)
3001 handle_srw_response(c, sr->u.response);
3005 else if (!ret && (soap_package->which == Z_SOAP_fault
3006 || soap_package->which == Z_SOAP_error))
3008 set_HTTP_error(c, hres->code,
3009 soap_package->u.fault->fault_code,
3010 soap_package->u.fault->fault_string);
3017 if (hres->code != 200)
3018 set_HTTP_error(c, hres->code, 0, 0);
3020 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3023 ZOOM_connection_remove_task(c);
3024 if (!strcmp(hres->version, "1.0"))
3026 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3027 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3032 /* HTTP 1.1: only if no close we stay alive .. */
3033 if (connection_head && !strcmp(connection_head, "close"))
3039 static int do_read (ZOOM_connection c)
3044 event = ZOOM_Event_create (ZOOM_EVENT_RECV_DATA);
3045 ZOOM_connection_put_event (c, event);
3047 r = cs_get (c->cs, &c->buf_in, &c->len_in);
3048 more = cs_more(c->cs);
3049 yaz_log (LOG_DEBUG, "do_read len=%d more=%d", r, more);
3054 if (c->reconnect_ok)
3057 c->reconnect_ok = 0;
3058 yaz_log (LOG_DEBUG, "reconnect read");
3059 c->tasks->running = 0;
3060 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3064 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, 0);
3073 odr_reset (c->odr_in);
3074 odr_setbuf (c->odr_in, c->buf_in, r, 0);
3075 event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);
3076 ZOOM_connection_put_event (c, event);
3078 if (!z_GDU (c->odr_in, &gdu, 0, 0))
3081 int err = odr_geterrorx(c->odr_in, &x);
3083 const char *element = odr_getelement(c->odr_in);
3084 sprintf (msg, "ODR code %d:%d element=%-20s",
3085 err, x, element ? element : "<unknown>");
3086 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3089 else if (gdu->which == Z_GDU_Z3950)
3090 handle_apdu (c, gdu->u.z3950);
3091 else if (gdu->which == Z_GDU_HTTP_Response)
3094 handle_http (c, gdu->u.HTTP_Response);
3096 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3100 c->reconnect_ok = 0;
3105 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out)
3110 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3111 ZOOM_connection_put_event (c, event);
3113 yaz_log (LOG_DEBUG, "do_write_ex len=%d", len_out);
3114 if ((r=cs_put (c->cs, buf_out, len_out)) < 0)
3116 if (c->reconnect_ok)
3119 c->reconnect_ok = 0;
3120 yaz_log (LOG_DEBUG, "reconnect write");
3121 c->tasks->running = 0;
3122 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3123 return zoom_pending;
3125 if (c->state == STATE_CONNECTING)
3126 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, 0);
3128 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, 0);
3130 return zoom_complete;
3134 c->mask = ZOOM_SELECT_EXCEPT;
3135 if (c->cs->io_pending & CS_WANT_WRITE)
3136 c->mask += ZOOM_SELECT_WRITE;
3137 if (c->cs->io_pending & CS_WANT_READ)
3138 c->mask += ZOOM_SELECT_READ;
3139 yaz_log (LOG_DEBUG, "do_write_ex 1 mask=%d", c->mask);
3143 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3144 yaz_log (LOG_DEBUG, "do_write_ex 2 mask=%d", c->mask);
3146 return zoom_pending;
3149 static zoom_ret do_write(ZOOM_connection c)
3151 return do_write_ex (c, c->buf_out, c->len_out);
3155 ZOOM_API(const char *)
3156 ZOOM_connection_option_get (ZOOM_connection c, const char *key)
3158 return ZOOM_options_get (c->options, key);
3162 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
3165 ZOOM_options_set (c->options, key, val);
3168 ZOOM_API(const char *)
3169 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key)
3171 return ZOOM_options_get (r->options, key);
3175 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key,
3178 ZOOM_options_set (r->options, key, val);
3183 ZOOM_connection_errcode (ZOOM_connection c)
3185 return ZOOM_connection_error (c, 0, 0);
3188 ZOOM_API(const char *)
3189 ZOOM_connection_errmsg (ZOOM_connection c)
3192 ZOOM_connection_error (c, &msg, 0);
3196 ZOOM_API(const char *)
3197 ZOOM_connection_addinfo (ZOOM_connection c)
3199 const char *addinfo;
3200 ZOOM_connection_error (c, 0, &addinfo);
3204 ZOOM_API(const char *)
3205 ZOOM_diag_str (int error)
3209 case ZOOM_ERROR_NONE:
3211 case ZOOM_ERROR_CONNECT:
3212 return "Connect failed";
3213 case ZOOM_ERROR_MEMORY:
3214 return "Out of memory";
3215 case ZOOM_ERROR_ENCODE:
3216 return "Encoding failed";
3217 case ZOOM_ERROR_DECODE:
3218 return "Decoding failed";
3219 case ZOOM_ERROR_CONNECTION_LOST:
3220 return "Connection lost";
3221 case ZOOM_ERROR_INIT:
3222 return "Init rejected";
3223 case ZOOM_ERROR_INTERNAL:
3224 return "Internal failure";
3225 case ZOOM_ERROR_TIMEOUT:
3227 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3228 return "Unsupported protocol";
3229 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3230 return "Unsupported query type";
3232 return diagbib1_str (error);
3237 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
3238 const char **addinfo, const char **diagset)
3240 int error = c->error;
3243 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3244 *cp = ZOOM_diag_str(error);
3245 else if (!strcmp(c->diagset, "HTTP"))
3246 *cp = z_HTTP_errmsg(c->error);
3247 else if (!strcmp(c->diagset, "Bib-1"))
3248 *cp = ZOOM_diag_str(error);
3249 else if (!strcmp(c->diagset, "SRW"))
3250 *cp = yaz_diag_srw_str(c->error);
3252 *cp = "Unknown error and diagnostic set";
3255 *addinfo = c->addinfo ? c->addinfo : "";
3257 *diagset = c->diagset ? c->diagset : "";
3262 ZOOM_connection_error (ZOOM_connection c, const char **cp,
3263 const char **addinfo)
3265 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3268 static int ZOOM_connection_do_io(ZOOM_connection c, int mask)
3270 ZOOM_Event event = 0;
3271 int r = cs_look(c->cs);
3272 yaz_log (LOG_DEBUG, "ZOOM_connection_do_io c=%p mask=%d cs_look=%d",
3277 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3278 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, 0);
3280 ZOOM_connection_put_event (c, event);
3282 else if (r == CS_CONNECT)
3285 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3287 ret = cs_rcvconnect (c->cs);
3288 yaz_log (LOG_DEBUG, "cs_rcvconnect returned %d", ret);
3291 c->mask = ZOOM_SELECT_EXCEPT;
3292 if (c->cs->io_pending & CS_WANT_WRITE)
3293 c->mask += ZOOM_SELECT_WRITE;
3294 if (c->cs->io_pending & CS_WANT_READ)
3295 c->mask += ZOOM_SELECT_READ;
3296 ZOOM_connection_put_event (c, event);
3300 ZOOM_connection_put_event (c, event);
3301 if (c->proto == PROTO_Z3950)
3302 ZOOM_connection_send_init(c);
3305 /* no init request for SRW .. */
3306 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3307 ZOOM_connection_remove_task (c);
3309 ZOOM_connection_exec_task (c);
3311 c->state = STATE_ESTABLISHED;
3315 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, 0);
3317 ZOOM_connection_put_event (c, event);
3322 if (mask & ZOOM_SELECT_READ)
3324 if (c->cs && (mask & ZOOM_SELECT_WRITE))
3331 ZOOM_connection_last_event(ZOOM_connection cs)
3334 return ZOOM_EVENT_NONE;
3335 return cs->last_event;
3339 ZOOM_event (int no, ZOOM_connection *cs)
3343 struct pollfd pollfds[1024];
3344 ZOOM_connection poll_cs[1024];
3347 fd_set input, output, except;
3352 for (i = 0; i<no; i++)
3354 ZOOM_connection c = cs[i];
3356 if (c && (event = ZOOM_connection_get_event(c)))
3358 ZOOM_Event_destroy (event);
3362 for (i = 0; i<no; i++)
3364 ZOOM_connection c = cs[i];
3366 if (c && ZOOM_connection_exec_task (c))
3368 if ((event = ZOOM_connection_get_event(c)))
3370 ZOOM_Event_destroy (event);
3383 for (i = 0; i<no; i++)
3385 ZOOM_connection c = cs[i];
3391 fd = z3950_connection_socket(c);
3392 mask = z3950_connection_mask(c);
3399 this_timeout = ZOOM_options_get_int (c->options, "timeout", -1);
3400 if (this_timeout != -1 && this_timeout < timeout)
3401 timeout = this_timeout;
3405 short poll_events = 0;
3407 if (mask & ZOOM_SELECT_READ)
3408 poll_events += POLLIN;
3409 if (mask & ZOOM_SELECT_WRITE)
3410 poll_events += POLLOUT;
3411 if (mask & ZOOM_SELECT_EXCEPT)
3412 poll_events += POLLERR;
3413 pollfds[nfds].fd = fd;
3414 pollfds[nfds].events = poll_events;
3415 pollfds[nfds].revents = 0;
3420 if (mask & ZOOM_SELECT_READ)
3422 FD_SET (fd, &input);
3425 if (mask & ZOOM_SELECT_WRITE)
3427 FD_SET (fd, &output);
3430 if (mask & ZOOM_SELECT_EXCEPT)
3432 FD_SET (fd, &except);
3437 if (timeout >= 5000)
3444 r = poll (pollfds, nfds, timeout * 1000);
3445 for (i = 0; i<nfds; i++)
3447 ZOOM_connection c = poll_cs[i];
3451 if (pollfds[i].revents & POLLIN)
3452 mask += ZOOM_SELECT_READ;
3453 if (pollfds[i].revents & POLLOUT)
3454 mask += ZOOM_SELECT_WRITE;
3455 if (pollfds[i].revents & POLLERR)
3456 mask += ZOOM_SELECT_EXCEPT;
3458 ZOOM_connection_do_io(c, mask);
3460 else if (r == 0 && c->mask)
3462 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3463 /* timeout and this connection was waiting */
3464 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3466 ZOOM_connection_put_event(c, event);
3470 tv.tv_sec = timeout;
3472 yaz_log (LOG_DEBUG, "select start");
3473 r = select (max_fd+1, &input, &output, &except, &tv);
3474 yaz_log (LOG_DEBUG, "select stop, returned r=%d", r);
3475 for (i = 0; i<no; i++)
3477 ZOOM_connection c = cs[i];
3482 fd = z3950_connection_socket(c);
3486 /* no timeout and real socket */
3487 if (FD_ISSET(fd, &input))
3488 mask += ZOOM_SELECT_READ;
3489 if (FD_ISSET(fd, &output))
3490 mask += ZOOM_SELECT_WRITE;
3491 if (FD_ISSET(fd, &except))
3492 mask += ZOOM_SELECT_EXCEPT;
3494 ZOOM_connection_do_io(c, mask);
3496 if (r == 0 && c->mask)
3498 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3499 /* timeout and this connection was waiting */
3500 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3502 yaz_log (LOG_DEBUG, "timeout");
3503 ZOOM_connection_put_event(c, event);
3507 for (i = 0; i<no; i++)
3509 ZOOM_connection c = cs[i];
3511 if (c && (event = ZOOM_connection_get_event(c)))
3513 ZOOM_Event_destroy (event);