2 * Copyright (c) 2000-2003, Index Data
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.9 2003-11-26 16:56:00 mike 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 const char *impid, *impname, *impver;
893 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
894 Z_InitRequest *ireq = apdu->u.initRequest;
895 Z_IdAuthentication *auth = (Z_IdAuthentication *)
896 odr_malloc(c->odr_out, sizeof(*auth));
897 const char *auth_groupId = ZOOM_options_get (c->options, "group");
898 const char *auth_userId = ZOOM_options_get (c->options, "user");
899 const char *auth_password = ZOOM_options_get (c->options, "pass");
902 ODR_MASK_SET(ireq->options, Z_Options_search);
903 ODR_MASK_SET(ireq->options, Z_Options_present);
904 ODR_MASK_SET(ireq->options, Z_Options_scan);
905 ODR_MASK_SET(ireq->options, Z_Options_sort);
906 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
907 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
909 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
910 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
911 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
913 /* Index Data's Z39.50 Implementor Id is 81 */
914 ireq->implementationId = odr_prepend(c->odr_out,
915 ZOOM_options_get(c->options, "implementationId"),
916 odr_prepend(c->odr_out, "81", ireq->implementationId));
918 ireq->implementationName = odr_prepend(c->odr_out,
919 ZOOM_options_get(c->options, "implementationName"),
920 odr_prepend(c->odr_out, "ZOOM-C", ireq->implementationName));
922 version = odr_strdup(c->odr_out, "$Revision: 1.9 $");
923 if (strlen(version) > 10) /* check for unexpanded CVS strings */
924 version[strlen(version)-2] = '\0';
925 ireq->implementationVersion = odr_prepend(c->odr_out,
926 ZOOM_options_get(c->options, "implementationVersion"),
927 odr_prepend(c->odr_out, &version[11], ireq->implementationVersion));
929 *ireq->maximumRecordSize =
930 ZOOM_options_get_int (c->options, "maximumRecordSize", 1024*1024);
931 *ireq->preferredMessageSize =
932 ZOOM_options_get_int (c->options, "preferredMessageSize", 1024*1024);
934 if (auth_groupId || auth_password)
936 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
939 if (auth_groupId && *auth_groupId)
941 pass->groupId = (char *)
942 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
943 strcpy(pass->groupId, auth_groupId);
947 if (auth_userId && *auth_userId)
949 pass->userId = (char *)
950 odr_malloc(c->odr_out, strlen(auth_userId)+1);
951 strcpy(pass->userId, auth_userId);
955 if (auth_password && *auth_password)
957 pass->password = (char *)
958 odr_malloc(c->odr_out, strlen(auth_password)+1);
959 strcpy(pass->password, auth_password);
964 auth->which = Z_IdAuthentication_idPass;
965 auth->u.idPass = pass;
966 ireq->idAuthentication = auth;
969 else if (auth_userId)
971 auth->which = Z_IdAuthentication_open;
972 auth->u.open = (char *)
973 odr_malloc(c->odr_out, strlen(auth_userId)+1);
974 strcpy(auth->u.open, auth_userId);
975 ireq->idAuthentication = auth;
978 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
979 VAL_PROXY, 1, c->host_port);
980 if (c->charset||c->lang)
982 Z_OtherInformation **oi;
983 Z_OtherInformationUnit *oi_unit;
985 yaz_oi_APDU(apdu, &oi);
987 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
989 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
991 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
992 oi_unit->information.externallyDefinedInfo =
993 yaz_set_proposal_charneg
995 (const char **)&c->charset, (c->charset) ? 1:0,
996 (const char **)&c->lang, (c->lang) ? 1:0, 1);
1000 return send_APDU (c, apdu);
1004 static zoom_ret send_srw (ZOOM_connection c, Z_SRW_PDU *sr)
1007 Z_SOAP_Handler h[2] = {
1008 {"http://www.loc.gov/zing/srw/v1.0/", 0, (Z_SOAP_fun) yaz_srw_codec},
1011 ODR o = odr_createmem(ODR_ENCODE);
1013 Z_SOAP *p = odr_malloc(o, sizeof(*p));
1017 gdu = z_get_HTTP_Request(c->odr_out);
1018 gdu->u.HTTP_Request->path = c->path;
1022 const char *cp0 = strstr(c->host_port, "://");
1023 const char *cp1 = 0;
1029 cp1 = strchr(cp0, '/');
1031 cp1 = cp0+strlen(cp0);
1035 char *h = odr_malloc(c->odr_out, cp1 - cp0 + 1);
1036 memcpy (h, cp0, cp1 - cp0);
1038 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1043 strcpy(ctype, "text/xml");
1044 if (c->charset && strlen(c->charset) < 20)
1046 strcat(ctype, "; charset=");
1047 strcat(ctype, c->charset);
1049 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1050 "Content-Type", ctype);
1051 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1052 "SOAPAction", "\"\"");
1053 p->which = Z_SOAP_generic;
1054 p->u.generic = odr_malloc(o, sizeof(*p->u.generic));
1055 p->u.generic->no = 0;
1056 p->u.generic->ns = 0;
1057 p->u.generic->p = sr;
1058 p->ns = "http://schemas.xmlsoap.org/soap/envelope/";
1060 ret = z_soap_codec_enc(o, &p,
1061 &gdu->u.HTTP_Request->content_buf,
1062 &gdu->u.HTTP_Request->content_len, h,
1065 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1066 return zoom_complete;
1067 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1071 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1072 ZOOM_connection_put_event (c, event);
1073 odr_reset(c->odr_out);
1074 return do_write (c);
1079 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1082 ZOOM_resultset resultset = 0;
1084 const char *recordPacking = 0;
1086 if (c->error) /* don't continue on error */
1087 return zoom_complete;
1089 if (c->tasks->which == ZOOM_TASK_SEARCH)
1091 resultset = c->tasks->u.search.resultset;
1092 resultset->setname = xstrdup ("default");
1093 ZOOM_options_set (resultset->options, "setname", resultset->setname);
1095 else if(c->tasks->which == ZOOM_TASK_RETRIEVE)
1097 resultset = c->tasks->u.retrieve.resultset;
1099 resultset->start = c->tasks->u.retrieve.start;
1100 resultset->count = c->tasks->u.retrieve.count;
1102 if (resultset->start >= resultset->size)
1103 return zoom_complete;
1104 if (resultset->start + resultset->count > resultset->size)
1105 resultset->count = resultset->size - resultset->start;
1107 for (i = 0; i<resultset->count; i++)
1110 record_cache_lookup (resultset, i + resultset->start);
1114 if (i == resultset->count)
1115 return zoom_complete;
1117 assert(resultset->query);
1119 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1121 if (resultset->query->z_query->which == Z_Query_type_104
1122 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1125 sr->u.request->query_type = Z_SRW_query_type_cql;
1126 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1128 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1129 resultset->query->z_query->u.type_1)
1131 sr->u.request->query_type = Z_SRW_query_type_pqf;
1132 sr->u.request->query.pqf = resultset->query->query_string;
1136 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1137 return zoom_complete;
1139 sr->u.request->startRecord = odr_intdup (c->odr_out, resultset->start + 1);
1140 sr->u.request->maximumRecords = odr_intdup (
1141 c->odr_out, resultset->step>0 ? resultset->step : resultset->count);
1142 sr->u.request->recordSchema = resultset->schema;
1144 recordPacking = ZOOM_resultset_option_get (resultset, "recordPacking");
1147 sr->u.request->recordPacking = odr_strdup(c->odr_out, recordPacking);
1149 return send_srw(c, sr);
1152 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1154 return zoom_complete;
1158 static zoom_ret ZOOM_connection_send_search (ZOOM_connection c)
1161 int lslb, ssub, mspn;
1163 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1164 Z_SearchRequest *search_req = apdu->u.searchRequest;
1165 const char *elementSetName;
1166 const char *smallSetElementSetName;
1167 const char *mediumSetElementSetName;
1170 assert (c->tasks->which == ZOOM_TASK_SEARCH);
1172 r = c->tasks->u.search.resultset;
1175 ZOOM_options_get (r->options, "elementSetName");
1176 smallSetElementSetName =
1177 ZOOM_options_get (r->options, "smallSetElementSetName");
1178 mediumSetElementSetName =
1179 ZOOM_options_get (r->options, "mediumSetElementSetName");
1181 if (!smallSetElementSetName)
1182 smallSetElementSetName = elementSetName;
1184 if (!mediumSetElementSetName)
1185 mediumSetElementSetName = elementSetName;
1190 /* prepare query for the search request */
1191 search_req->query = r->query->z_query;
1193 search_req->databaseNames =
1194 set_DatabaseNames (c, r->options, &search_req->num_databaseNames);
1196 /* get syntax (no need to provide unless piggyback is in effect) */
1197 syntax = ZOOM_options_get (r->options, "preferredRecordSyntax");
1199 lslb = ZOOM_options_get_int (r->options, "largeSetLowerBound", -1);
1200 ssub = ZOOM_options_get_int (r->options, "smallSetUpperBound", -1);
1201 mspn = ZOOM_options_get_int (r->options, "mediumSetPresentNumber", -1);
1202 if (lslb != -1 && ssub != -1 && mspn != -1)
1204 /* So're a Z39.50 expert? Let's hope you don't do sort */
1205 *search_req->largeSetLowerBound = lslb;
1206 *search_req->smallSetUpperBound = ssub;
1207 *search_req->mediumSetPresentNumber = mspn;
1209 else if (r->start == 0 && r->count > 0
1210 && r->piggyback && !r->r_sort_spec && !r->schema)
1212 /* Regular piggyback - do it unless we're going to do sort */
1213 *search_req->largeSetLowerBound = 2000000000;
1214 *search_req->smallSetUpperBound = 1;
1215 *search_req->mediumSetPresentNumber = r->step>0 ? r->step : r->count;
1219 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1220 smallSetElementSetName = 0;
1221 mediumSetElementSetName = 0;
1224 if (smallSetElementSetName && *smallSetElementSetName)
1226 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1227 odr_malloc (c->odr_out, sizeof(*esn));
1229 esn->which = Z_ElementSetNames_generic;
1230 esn->u.generic = odr_strdup (c->odr_out, smallSetElementSetName);
1231 search_req->smallSetElementSetNames = esn;
1233 if (mediumSetElementSetName && *mediumSetElementSetName)
1235 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1236 odr_malloc (c->odr_out, sizeof(*esn));
1238 esn->which = Z_ElementSetNames_generic;
1239 esn->u.generic = odr_strdup (c->odr_out, mediumSetElementSetName);
1240 search_req->mediumSetElementSetNames = esn;
1243 search_req->preferredRecordSyntax =
1244 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1248 if (c->support_named_resultsets)
1252 /* find the lowest unused ordinal so that we re-use
1253 result sets on the server. */
1254 for (ord = 1; ; ord++)
1257 sprintf (setname, "%d", ord);
1258 for (rp = c->resultsets; rp; rp = rp->next)
1259 if (rp->setname && !strcmp (rp->setname, setname))
1264 r->setname = xstrdup (setname);
1265 yaz_log (LOG_DEBUG, "allocating set %s", r->setname);
1268 r->setname = xstrdup ("default");
1269 ZOOM_options_set (r->options, "setname", r->setname);
1271 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1272 /* send search request */
1273 return send_APDU (c, apdu);
1276 static void response_diag (ZOOM_connection c, Z_DiagRec *p)
1279 Z_DefaultDiagFormat *r;
1284 if (p->which != Z_DiagRec_defaultFormat)
1286 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1289 r = p->u.defaultFormat;
1292 case Z_DefaultDiagFormat_v2Addinfo:
1293 addinfo = r->u.v2Addinfo;
1295 case Z_DefaultDiagFormat_v3Addinfo:
1296 addinfo = r->u.v3Addinfo;
1299 set_dset_error(c, *r->condition,
1300 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1304 ZOOM_API(ZOOM_record)
1305 ZOOM_record_clone (ZOOM_record srec)
1312 odr_enc = odr_createmem(ODR_ENCODE);
1313 if (!z_NamePlusRecord (odr_enc, &srec->npr, 0, 0))
1315 buf = odr_getbuf (odr_enc, &size, 0);
1317 nrec = (ZOOM_record) xmalloc (sizeof(*nrec));
1318 nrec->odr = odr_createmem(ODR_DECODE);
1319 nrec->wrbuf_marc = 0;
1320 nrec->wrbuf_iconv = 0;
1321 nrec->wrbuf_opac = 0;
1322 odr_setbuf (nrec->odr, buf, size, 0);
1323 z_NamePlusRecord (nrec->odr, &nrec->npr, 0, 0);
1325 odr_destroy (odr_enc);
1329 ZOOM_API(ZOOM_record)
1330 ZOOM_resultset_record_immediate (ZOOM_resultset s,size_t pos)
1332 return record_cache_lookup (s, pos);
1335 ZOOM_API(ZOOM_record)
1336 ZOOM_resultset_record (ZOOM_resultset r, size_t pos)
1338 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1342 ZOOM_resultset_retrieve (r, 1, pos, 1);
1343 rec = ZOOM_resultset_record_immediate (r, pos);
1349 ZOOM_record_destroy (ZOOM_record rec)
1353 if (rec->wrbuf_marc)
1354 wrbuf_free (rec->wrbuf_marc, 1);
1355 if (rec->wrbuf_iconv)
1356 wrbuf_free (rec->wrbuf_iconv, 1);
1357 if (rec->wrbuf_opac)
1358 wrbuf_free (rec->wrbuf_opac, 1);
1359 odr_destroy (rec->odr);
1363 static const char *record_iconv_return(ZOOM_record rec, int *len,
1364 const char *buf, int sz,
1365 const char *record_charset)
1372 strcpy(to, "UTF-8");
1373 if (record_charset && *record_charset)
1375 /* Use "from,to" or just "from" */
1376 const char *cp =strchr(record_charset, ',');
1377 int clen = strlen(record_charset);
1380 strncpy( to, cp+1, sizeof(to)-1);
1381 to[sizeof(to)-1] = '\0';
1382 clen = cp - record_charset;
1384 if (clen > sizeof(from)-1)
1385 clen = sizeof(from)-1;
1388 strncpy(from, record_charset, clen);
1392 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1395 size_t inbytesleft = sz;
1396 const char *inp = buf;
1398 if (!rec->wrbuf_iconv)
1399 rec->wrbuf_iconv = wrbuf_alloc();
1401 wrbuf_rewind(rec->wrbuf_iconv);
1405 size_t outbytesleft = sizeof(outbuf);
1406 char *outp = outbuf;
1407 size_t r = yaz_iconv (cd, (char**) &inp,
1409 &outp, &outbytesleft);
1410 if (r == (size_t) (-1))
1412 int e = yaz_iconv_error(cd);
1413 if (e != YAZ_ICONV_E2BIG)
1416 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1418 wrbuf_puts(rec->wrbuf_iconv, "");
1419 buf = wrbuf_buf(rec->wrbuf_iconv);
1420 sz = wrbuf_len(rec->wrbuf_iconv);
1421 yaz_iconv_close(cd);
1428 ZOOM_API(const char *)
1429 ZOOM_record_get (ZOOM_record rec, const char *type_spec, int *len)
1435 Z_NamePlusRecord *npr;
1438 *len = 0; /* default return */
1447 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1449 if (cp[i] == ';' || cp[i] == ' ')
1455 if (type_spec[i] == ';')
1458 while (type_spec[i] == ' ')
1460 if (!strncmp(type_spec+i, "charset=", 8))
1463 for (i = 0; cp[i] && i < sizeof(charset)-1; i++)
1465 if (cp[i] == ';' || cp[i] == ' ')
1473 if (!strcmp (type, "database"))
1476 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1477 return npr->databaseName;
1479 else if (!strcmp (type, "syntax"))
1481 const char *desc = 0;
1482 if (npr->which == Z_NamePlusRecord_databaseRecord)
1484 Z_External *r = (Z_External *) npr->u.databaseRecord;
1485 oident *ent = oid_getentbyoid(r->direct_reference);
1492 *len = strlen(desc);
1495 if (npr->which != Z_NamePlusRecord_databaseRecord)
1498 /* from now on - we have a database record .. */
1499 if (!strcmp (type, "render"))
1501 Z_External *r = (Z_External *) npr->u.databaseRecord;
1502 oident *ent = oid_getentbyoid(r->direct_reference);
1504 /* render bibliographic record .. */
1505 if (r->which == Z_External_OPAC)
1507 r = r->u.opac->bibliographicRecord;
1510 ent = oid_getentbyoid(r->direct_reference);
1512 if (r->which == Z_External_sutrs)
1513 return record_iconv_return(rec, len,
1514 r->u.sutrs->buf, r->u.sutrs->len,
1516 else if (r->which == Z_External_octet)
1526 case VAL_APPLICATION_XML:
1529 if (!rec->wrbuf_marc)
1530 rec->wrbuf_marc = wrbuf_alloc();
1532 mt = yaz_marc_create();
1533 wrbuf_rewind (rec->wrbuf_marc);
1534 if (yaz_marc_decode_wrbuf (
1535 mt, (const char *) r->u.octet_aligned->buf,
1536 r->u.octet_aligned->len,
1537 rec->wrbuf_marc) > 0)
1539 yaz_marc_destroy(mt);
1540 return record_iconv_return(rec, len,
1541 wrbuf_buf(rec->wrbuf_marc),
1542 wrbuf_len(rec->wrbuf_marc),
1545 yaz_marc_destroy(mt);
1547 return record_iconv_return(rec, len,
1548 (const char *) r->u.octet_aligned->buf,
1549 r->u.octet_aligned->len,
1552 else if (r->which == Z_External_grs1)
1554 if (!rec->wrbuf_marc)
1555 rec->wrbuf_marc = wrbuf_alloc();
1556 wrbuf_rewind (rec->wrbuf_marc);
1557 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1558 return record_iconv_return(rec, len,
1559 wrbuf_buf(rec->wrbuf_marc),
1560 wrbuf_len(rec->wrbuf_marc),
1565 else if (!strcmp (type, "xml") || !strcmp(type, "oai"))
1567 Z_External *r = (Z_External *) npr->u.databaseRecord;
1568 oident *ent = oid_getentbyoid(r->direct_reference);
1570 /* render bibliographic record .. */
1571 if (r->which == Z_External_OPAC)
1573 r = r->u.opac->bibliographicRecord;
1576 ent = oid_getentbyoid(r->direct_reference);
1579 if (r->which == Z_External_sutrs)
1580 return record_iconv_return(rec, len,
1581 (const char *) r->u.sutrs->buf,
1584 else if (r->which == Z_External_octet)
1587 int marc_decode_type = YAZ_MARC_MARCXML;
1589 if (!strcmp(type, "oai"))
1590 marc_decode_type = YAZ_MARC_OAIMARC;
1598 case VAL_APPLICATION_XML:
1601 if (!rec->wrbuf_marc)
1602 rec->wrbuf_marc = wrbuf_alloc();
1603 wrbuf_rewind (rec->wrbuf_marc);
1604 mt = yaz_marc_create();
1606 yaz_marc_xml(mt, YAZ_MARC_MARCXML);
1607 if (yaz_marc_decode_wrbuf (
1608 mt, (const char *) r->u.octet_aligned->buf,
1609 r->u.octet_aligned->len,
1610 rec->wrbuf_marc) > 0)
1612 yaz_marc_destroy(mt);
1613 return record_iconv_return(rec, len,
1614 wrbuf_buf(rec->wrbuf_marc),
1615 wrbuf_len(rec->wrbuf_marc),
1618 yaz_marc_destroy(mt);
1620 return record_iconv_return(rec, len,
1621 (const char *) r->u.octet_aligned->buf,
1622 r->u.octet_aligned->len,
1625 else if (r->which == Z_External_grs1)
1632 else if (!strcmp (type, "raw"))
1634 Z_External *r = (Z_External *) npr->u.databaseRecord;
1636 if (r->which == Z_External_sutrs)
1638 if (len) *len = r->u.sutrs->len;
1639 return (const char *) r->u.sutrs->buf;
1641 else if (r->which == Z_External_octet)
1643 if (len) *len = r->u.octet_aligned->len;
1644 return (const char *) r->u.octet_aligned->buf;
1646 else /* grs-1, explain, OPAC, ... */
1649 return (const char *) npr->u.databaseRecord;
1653 else if (!strcmp (type, "ext"))
1656 return (const char *) npr->u.databaseRecord;
1658 else if (!strcmp (type, "opac"))
1661 Z_External *r = (Z_External *) npr->u.databaseRecord;
1662 if (r->which == Z_External_OPAC)
1664 if (!rec->wrbuf_opac)
1665 rec->wrbuf_opac = wrbuf_alloc();
1666 wrbuf_rewind (rec->wrbuf_opac);
1667 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
1668 return record_iconv_return(rec, len,
1669 wrbuf_buf(rec->wrbuf_opac),
1670 wrbuf_len(rec->wrbuf_opac),
1677 static int strcmp_null(const char *v1, const char *v2)
1683 return strcmp(v1, v2);
1686 static void record_cache_add (ZOOM_resultset r, Z_NamePlusRecord *npr,
1689 ZOOM_record_cache rc;
1690 const char *elementSetName =
1691 ZOOM_resultset_option_get (r, "elementSetName");
1692 const char *syntax =
1693 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
1695 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1696 ZOOM_connection_put_event(r->connection, event);
1698 for (rc = r->record_cache; rc; rc = rc->next)
1702 if (strcmp_null(r->schema, rc->schema))
1704 if (strcmp_null(elementSetName,rc->elementSetName))
1706 if (strcmp_null(syntax, rc->syntax))
1708 /* not destroying rc->npr (it's handled by nmem )*/
1710 /* keeping wrbuf_marc too */
1714 rc = (ZOOM_record_cache) odr_malloc (r->odr, sizeof(*rc));
1717 rc->rec.wrbuf_marc = 0;
1718 rc->rec.wrbuf_iconv = 0;
1719 rc->rec.wrbuf_opac = 0;
1721 rc->elementSetName = odr_strdup (r->odr, elementSetName);
1723 rc->elementSetName = 0;
1726 rc->syntax = odr_strdup (r->odr, syntax);
1731 rc->schema = odr_strdup (r->odr, r->schema);
1736 rc->next = r->record_cache;
1737 r->record_cache = rc;
1740 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos)
1742 ZOOM_record_cache rc;
1743 const char *elementSetName =
1744 ZOOM_resultset_option_get (r, "elementSetName");
1745 const char *syntax =
1746 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
1748 for (rc = r->record_cache; rc; rc = rc->next)
1752 if (strcmp_null(r->schema, rc->schema))
1754 if (strcmp_null(elementSetName,rc->elementSetName))
1756 if (strcmp_null(syntax, rc->syntax))
1764 static void handle_records (ZOOM_connection c, Z_Records *sr,
1767 ZOOM_resultset resultset;
1771 switch (c->tasks->which)
1773 case ZOOM_TASK_SEARCH:
1774 resultset = c->tasks->u.search.resultset;
1776 case ZOOM_TASK_RETRIEVE:
1777 resultset = c->tasks->u.retrieve.resultset;
1782 if (sr && sr->which == Z_Records_NSD)
1784 Z_DiagRec dr, *dr_p = &dr;
1785 dr.which = Z_DiagRec_defaultFormat;
1786 dr.u.defaultFormat = sr->u.nonSurrogateDiagnostic;
1788 response_diag (c, dr_p);
1790 else if (sr && sr->which == Z_Records_multipleNSD)
1792 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
1793 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
1795 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1799 if (resultset->count + resultset->start > resultset->size)
1800 resultset->count = resultset->size - resultset->start;
1801 if (resultset->count < 0)
1802 resultset->count = 0;
1803 if (sr && sr->which == Z_Records_DBOSD)
1806 NMEM nmem = odr_extract_mem (c->odr_in);
1807 Z_NamePlusRecordList *p =
1808 sr->u.databaseOrSurDiagnostics;
1809 for (i = 0; i<p->num_records; i++)
1811 record_cache_add (resultset, p->records[i],
1812 i+ resultset->start);
1814 /* transfer our response to search_nmem .. we need it later */
1815 nmem_transfer (resultset->odr->mem, nmem);
1816 nmem_destroy (nmem);
1817 if (present_phase && p->num_records == 0)
1819 /* present response and we didn't get any records! */
1820 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1823 else if (present_phase)
1825 /* present response and we didn't get any records! */
1826 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1831 static void handle_present_response (ZOOM_connection c, Z_PresentResponse *pr)
1833 handle_records (c, pr->records, 1);
1836 static void handle_search_response (ZOOM_connection c, Z_SearchResponse *sr)
1838 ZOOM_resultset resultset;
1841 yaz_log (LOG_DEBUG, "got search response");
1843 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1846 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
1847 ZOOM_connection_put_event(c, event);
1849 resultset = c->tasks->u.search.resultset;
1851 resultset->size = *sr->resultCount;
1852 handle_records (c, sr->records, 0);
1855 static void sort_response (ZOOM_connection c, Z_SortResponse *res)
1857 if (res->diagnostics && res->num_diagnostics > 0)
1858 response_diag (c, res->diagnostics[0]);
1861 static int scan_response (ZOOM_connection c, Z_ScanResponse *res)
1863 NMEM nmem = odr_extract_mem (c->odr_in);
1866 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
1868 scan = c->tasks->u.scan.scan;
1870 if (res->entries && res->entries->nonsurrogateDiagnostics)
1871 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
1872 scan->scan_response = res;
1873 nmem_transfer (scan->odr->mem, nmem);
1875 ZOOM_options_set_int (scan->options, "stepSize", *res->stepSize);
1876 if (res->positionOfTerm)
1877 ZOOM_options_set_int (scan->options, "position", *res->positionOfTerm);
1878 if (res->scanStatus)
1879 ZOOM_options_set_int (scan->options, "scanStatus", *res->scanStatus);
1880 if (res->numberOfEntriesReturned)
1881 ZOOM_options_set_int (scan->options, "number",
1882 *res->numberOfEntriesReturned);
1883 nmem_destroy (nmem);
1887 static zoom_ret send_sort (ZOOM_connection c)
1889 ZOOM_resultset resultset;
1891 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1892 return zoom_complete;
1894 resultset = c->tasks->u.search.resultset;
1898 resultset->r_sort_spec = 0;
1899 return zoom_complete;
1901 if (resultset->r_sort_spec)
1903 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
1904 Z_SortRequest *req = apdu->u.sortRequest;
1906 req->num_inputResultSetNames = 1;
1907 req->inputResultSetNames = (Z_InternationalString **)
1908 odr_malloc (c->odr_out, sizeof(*req->inputResultSetNames));
1909 req->inputResultSetNames[0] =
1910 odr_strdup (c->odr_out, resultset->setname);
1911 req->sortedResultSetName = odr_strdup (c->odr_out, resultset->setname);
1912 req->sortSequence = resultset->r_sort_spec;
1913 resultset->r_sort_spec = 0;
1914 return send_APDU (c, apdu);
1916 return zoom_complete;
1919 static zoom_ret send_present (ZOOM_connection c)
1922 Z_PresentRequest *req = 0;
1924 const char *syntax = 0;
1925 const char *elementSetName = 0;
1926 ZOOM_resultset resultset;
1929 return zoom_complete;
1931 switch (c->tasks->which)
1933 case ZOOM_TASK_SEARCH:
1934 resultset = c->tasks->u.search.resultset;
1936 case ZOOM_TASK_RETRIEVE:
1937 resultset = c->tasks->u.retrieve.resultset;
1938 resultset->start = c->tasks->u.retrieve.start;
1939 resultset->count = c->tasks->u.retrieve.count;
1941 if (resultset->start >= resultset->size)
1942 return zoom_complete;
1943 if (resultset->start + resultset->count > resultset->size)
1944 resultset->count = resultset->size - resultset->start;
1947 return zoom_complete;
1950 syntax = ZOOM_resultset_option_get (resultset, "preferredRecordSyntax");
1951 elementSetName = ZOOM_resultset_option_get (resultset, "elementSetName");
1953 if (c->error) /* don't continue on error */
1954 return zoom_complete;
1955 if (resultset->start < 0)
1956 return zoom_complete;
1957 for (i = 0; i<resultset->count; i++)
1960 record_cache_lookup (resultset, i + resultset->start);
1964 if (i == resultset->count)
1965 return zoom_complete;
1967 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
1968 req = apdu->u.presentRequest;
1970 resultset->start += i;
1971 resultset->count -= i;
1972 *req->resultSetStartPoint = resultset->start + 1;
1973 *req->numberOfRecordsRequested = resultset->step>0 ?
1974 resultset->step : resultset->count;
1975 assert (*req->numberOfRecordsRequested > 0);
1977 if (syntax && *syntax)
1978 req->preferredRecordSyntax =
1979 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1981 if (resultset->schema && *resultset->schema)
1983 Z_RecordComposition *compo = (Z_RecordComposition *)
1984 odr_malloc (c->odr_out, sizeof(*compo));
1986 req->recordComposition = compo;
1987 compo->which = Z_RecordComp_complex;
1988 compo->u.complex = (Z_CompSpec *)
1989 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
1990 compo->u.complex->selectAlternativeSyntax = (bool_t *)
1991 odr_malloc(c->odr_out, sizeof(bool_t));
1992 *compo->u.complex->selectAlternativeSyntax = 0;
1994 compo->u.complex->generic = (Z_Specification *)
1995 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
1997 compo->u.complex->generic->which = Z_Schema_oid;
1998 compo->u.complex->generic->schema.oid = (Odr_oid *)
1999 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2001 if (!compo->u.complex->generic->schema.oid)
2003 /* OID wasn't a schema! Try record syntax instead. */
2005 compo->u.complex->generic->schema.oid = (Odr_oid *)
2006 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2008 if (elementSetName && *elementSetName)
2010 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2011 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2012 compo->u.complex->generic->elementSpec->which =
2013 Z_ElementSpec_elementSetName;
2014 compo->u.complex->generic->elementSpec->u.elementSetName =
2015 odr_strdup (c->odr_out, elementSetName);
2018 compo->u.complex->generic->elementSpec = 0;
2019 compo->u.complex->num_dbSpecific = 0;
2020 compo->u.complex->dbSpecific = 0;
2021 compo->u.complex->num_recordSyntax = 0;
2022 compo->u.complex->recordSyntax = 0;
2024 else if (elementSetName && *elementSetName)
2026 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2027 odr_malloc (c->odr_out, sizeof(*esn));
2028 Z_RecordComposition *compo = (Z_RecordComposition *)
2029 odr_malloc (c->odr_out, sizeof(*compo));
2031 esn->which = Z_ElementSetNames_generic;
2032 esn->u.generic = odr_strdup (c->odr_out, elementSetName);
2033 compo->which = Z_RecordComp_simple;
2034 compo->u.simple = esn;
2035 req->recordComposition = compo;
2037 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2038 return send_APDU (c, apdu);
2041 ZOOM_API(ZOOM_scanset)
2042 ZOOM_connection_scan (ZOOM_connection c, const char *start)
2044 ZOOM_scanset scan = (ZOOM_scanset) xmalloc (sizeof(*scan));
2046 scan->connection = c;
2047 scan->odr = odr_createmem (ODR_DECODE);
2048 scan->options = ZOOM_options_create_with_parent (c->options);
2050 scan->scan_response = 0;
2052 if ((scan->termListAndStartPoint =
2053 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet,
2056 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_SCAN);
2057 task->u.scan.scan = scan;
2062 while (ZOOM_event (1, &c))
2070 ZOOM_scanset_destroy (ZOOM_scanset scan)
2075 if (scan->refcount == 0)
2077 odr_destroy (scan->odr);
2079 ZOOM_options_destroy (scan->options);
2084 static zoom_ret send_package (ZOOM_connection c)
2088 return zoom_complete;
2089 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2091 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
2092 ZOOM_connection_put_event (c, event);
2094 return do_write_ex (c, c->tasks->u.package->buf_out,
2095 c->tasks->u.package->len_out);
2098 static zoom_ret send_scan (ZOOM_connection c)
2101 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2102 Z_ScanRequest *req = apdu->u.scanRequest;
2104 return zoom_complete;
2105 assert (c->tasks->which == ZOOM_TASK_SCAN);
2106 scan = c->tasks->u.scan.scan;
2108 req->termListAndStartPoint = scan->termListAndStartPoint;
2109 req->attributeSet = scan->attributeSet;
2111 *req->numberOfTermsRequested =
2112 ZOOM_options_get_int(scan->options, "number", 10);
2114 req->preferredPositionInResponse =
2115 odr_intdup (c->odr_out,
2116 ZOOM_options_get_int(scan->options, "position", 1));
2119 odr_intdup (c->odr_out,
2120 ZOOM_options_get_int(scan->options, "stepSize", 0));
2122 req->databaseNames = set_DatabaseNames (c, scan->options,
2123 &req->num_databaseNames);
2125 return send_APDU (c, apdu);
2129 ZOOM_scanset_size (ZOOM_scanset scan)
2131 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2133 return scan->scan_response->entries->num_entries;
2136 ZOOM_API(const char *)
2137 ZOOM_scanset_term (ZOOM_scanset scan, size_t pos,
2140 const char *term = 0;
2141 size_t noent = ZOOM_scanset_size (scan);
2142 Z_ScanResponse *res = scan->scan_response;
2148 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2150 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2152 if (t->term->which == Z_Term_general)
2154 term = (const char *) t->term->u.general->buf;
2155 *len = t->term->u.general->len;
2157 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2162 ZOOM_API(const char *)
2163 ZOOM_scanset_display_term (ZOOM_scanset scan, size_t pos,
2166 const char *term = 0;
2167 size_t noent = ZOOM_scanset_size (scan);
2168 Z_ScanResponse *res = scan->scan_response;
2174 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2176 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2180 term = (const char *) t->term->u.general->buf;
2181 *len = strlen(term);
2183 else if (t->term->which == Z_Term_general)
2185 term = (const char *) t->term->u.general->buf;
2186 *len = t->term->u.general->len;
2188 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2193 ZOOM_API(const char *)
2194 ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key)
2196 return ZOOM_options_get (scan->options, key);
2200 ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
2203 ZOOM_options_set (scan->options, key, val);
2206 static Z_APDU *create_es_package (ZOOM_package p, int type)
2209 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2210 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2212 *req->function = Z_ExtendedServicesRequest_create;
2214 str = ZOOM_options_get(p->options, "package-name");
2216 req->packageName = nmem_strdup (p->odr_out->mem, str);
2218 str = ZOOM_options_get(p->options, "user-id");
2220 req->userId = nmem_strdup (p->odr_out->mem, str);
2222 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2225 str = ZOOM_options_get(p->options, "function");
2228 if (!strcmp (str, "create"))
2230 if (!strcmp (str, "delete"))
2232 if (!strcmp (str, "modify"))
2238 static const char *ill_array_lookup (void *clientData, const char *idx)
2240 ZOOM_package p = (ZOOM_package) clientData;
2241 return ZOOM_options_get (p->options, idx+4);
2244 static Z_External *encode_ill_request (ZOOM_package p)
2246 ODR out = p->odr_out;
2249 struct ill_get_ctl ctl;
2251 ctl.odr = p->odr_out;
2253 ctl.f = ill_array_lookup;
2255 req = ill_get_ILLRequest(&ctl, "ill", 0);
2257 if (!ill_Request (out, &req, 0, 0))
2259 int ill_request_size;
2260 char *ill_request_buf = odr_getbuf (out, &ill_request_size, 0);
2261 if (ill_request_buf)
2262 odr_setbuf (out, ill_request_buf, ill_request_size, 1);
2268 int illRequest_size = 0;
2269 char *illRequest_buf = odr_getbuf (out, &illRequest_size, 0);
2271 oid.proto = PROTO_GENERAL;
2272 oid.oclass = CLASS_GENERAL;
2273 oid.value = VAL_ISO_ILL_1;
2275 r = (Z_External *) odr_malloc (out, sizeof(*r));
2276 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2277 r->indirect_reference = 0;
2279 r->which = Z_External_single;
2281 r->u.single_ASN1_type = (Odr_oct *)
2282 odr_malloc (out, sizeof(*r->u.single_ASN1_type));
2283 r->u.single_ASN1_type->buf = (unsigned char*)
2284 odr_malloc (out, illRequest_size);
2285 r->u.single_ASN1_type->len = illRequest_size;
2286 r->u.single_ASN1_type->size = illRequest_size;
2287 memcpy (r->u.single_ASN1_type->buf, illRequest_buf, illRequest_size);
2292 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2294 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc (p->odr_out, sizeof(*req));
2297 req->which=Z_IOItemOrder_esRequest;
2298 req->u.esRequest = (Z_IORequest *)
2299 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2301 /* to keep part ... */
2302 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2303 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2304 req->u.esRequest->toKeep->supplDescription = 0;
2305 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2306 odr_malloc (p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2308 str = ZOOM_options_get(p->options, "contact-name");
2309 req->u.esRequest->toKeep->contact->name = str ?
2310 nmem_strdup (p->odr_out->mem, str) : 0;
2312 str = ZOOM_options_get(p->options, "contact-phone");
2313 req->u.esRequest->toKeep->contact->phone = str ?
2314 nmem_strdup (p->odr_out->mem, str) : 0;
2316 str = ZOOM_options_get(p->options, "contact-email");
2317 req->u.esRequest->toKeep->contact->email = str ?
2318 nmem_strdup (p->odr_out->mem, str) : 0;
2320 req->u.esRequest->toKeep->addlBilling = 0;
2322 /* not to keep part ... */
2323 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2324 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2326 str = ZOOM_options_get(p->options, "itemorder-setname");
2331 req->u.esRequest->notToKeep->resultSetItem = 0;
2334 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2335 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2337 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2338 nmem_strdup (p->odr_out->mem, str);
2339 req->u.esRequest->notToKeep->resultSetItem->item =
2340 (int *) odr_malloc(p->odr_out, sizeof(int));
2342 str = ZOOM_options_get(p->options, "itemorder-item");
2343 *req->u.esRequest->notToKeep->resultSetItem->item =
2344 (str ? atoi(str) : 1);
2346 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2351 Z_APDU *create_admin_package(ZOOM_package p, int type,
2352 Z_ESAdminOriginPartToKeep **toKeepP,
2353 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2355 Z_APDU *apdu = create_es_package (p, VAL_ADMINSERVICE);
2358 Z_ESAdminOriginPartToKeep *toKeep;
2359 Z_ESAdminOriginPartNotToKeep *notToKeep;
2360 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2361 const char *first_db = "Default";
2363 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2367 r->direct_reference =
2368 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2371 r->indirect_reference = 0;
2372 r->which = Z_External_ESAdmin;
2374 r->u.adminService = (Z_Admin *)
2375 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2376 r->u.adminService->which = Z_Admin_esRequest;
2377 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2378 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2380 toKeep = r->u.adminService->u.esRequest->toKeep =
2381 (Z_ESAdminOriginPartToKeep *)
2382 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2384 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2385 toKeep->u.create=odr_nullval();
2386 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2388 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2389 (Z_ESAdminOriginPartNotToKeep *)
2390 odr_malloc(p->odr_out,
2391 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2392 notToKeep->which=Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
2393 notToKeep->u.recordsWillFollow=odr_nullval();
2397 *notToKeepP = notToKeep;
2402 static Z_APDU *create_update_package(ZOOM_package p)
2405 const char *first_db = "Default";
2407 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2408 const char *action = ZOOM_options_get(p->options, "action");
2409 const char *recordId = ZOOM_options_get(p->options, "recordId");
2410 const char *record_buf = ZOOM_options_get(p->options, "record");
2411 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
2412 int syntax_oid = VAL_NONE;
2416 syntax_oid = oid_getvalbyname(syntax_str);
2419 record_buf = "void";
2420 syntax_oid = VAL_SUTRS;
2422 if (syntax_oid != VAL_NONE)
2423 syntax_oid = VAL_TEXT_XML;
2429 action = "specialUpdate";
2431 if (!strcmp(action, "recordInsert"))
2432 action_no = Z_IUOriginPartToKeep_recordInsert;
2433 else if (!strcmp(action, "recordReplace"))
2434 action_no = Z_IUOriginPartToKeep_recordReplace;
2435 else if (!strcmp(action, "recordDelete"))
2436 action_no = Z_IUOriginPartToKeep_recordDelete;
2437 else if (!strcmp(action, "elementUpdate"))
2438 action_no = Z_IUOriginPartToKeep_elementUpdate;
2439 else if (!strcmp(action, "specialUpdate"))
2440 action_no = Z_IUOriginPartToKeep_specialUpdate;
2444 apdu = create_es_package (p, VAL_DBUPDATE);
2447 Z_IUOriginPartToKeep *toKeep;
2448 Z_IUSuppliedRecords *notToKeep;
2449 Z_External *r = (Z_External *)
2450 odr_malloc (p->odr_out, sizeof(*r));
2452 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2454 r->direct_reference =
2455 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2458 r->which = Z_External_update;
2459 r->indirect_reference = 0;
2460 r->u.update = (Z_IUUpdate *)
2461 odr_malloc(p->odr_out, sizeof(*r->u.update));
2463 r->u.update->which = Z_IUUpdate_esRequest;
2464 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
2465 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
2466 toKeep = r->u.update->u.esRequest->toKeep =
2467 (Z_IUOriginPartToKeep *)
2468 odr_malloc(p->odr_out, sizeof(*toKeep));
2470 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2472 toKeep->elementSetName = 0;
2473 toKeep->actionQualifier = 0;
2474 toKeep->action = odr_intdup(p->odr_out, action_no);
2476 notToKeep = r->u.update->u.esRequest->notToKeep =
2477 (Z_IUSuppliedRecords *)
2478 odr_malloc(p->odr_out, sizeof(*notToKeep));
2480 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
2481 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
2482 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
2483 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
2484 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
2487 notToKeep->elements[0]->u.opaque = (Odr_oct *)
2488 odr_malloc (p->odr_out, sizeof(Odr_oct));
2489 notToKeep->elements[0]->u.opaque->size = strlen(recordId);
2490 notToKeep->elements[0]->u.opaque->len = strlen(recordId);
2491 notToKeep->elements[0]->u.opaque->buf =
2492 odr_strdup(p->odr_out, recordId);
2495 notToKeep->elements[0]->u.opaque = 0;
2496 notToKeep->elements[0]->supplementalId = 0;
2497 notToKeep->elements[0]->correlationInfo = 0;
2498 notToKeep->elements[0]->record =
2499 z_ext_record(p->odr_out, syntax_oid,
2500 record_buf, strlen(record_buf));
2504 ODR print = odr_createmem(ODR_PRINT);
2506 z_APDU(print, &apdu, 0, 0);
2513 ZOOM_package_send (ZOOM_package p, const char *type)
2520 odr_reset (p->odr_out);
2523 if (!strcmp(type, "itemorder"))
2525 apdu = create_es_package (p, VAL_ITEMORDER);
2528 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2530 r->direct_reference =
2531 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2534 r->which = Z_External_itemOrder;
2535 r->indirect_reference = 0;
2536 r->u.itemOrder = encode_item_order (p);
2538 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2541 if (!strcmp(type, "create")) /* create database */
2543 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
2546 if (!strcmp(type, "drop")) /* drop database */
2548 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
2551 if (!strcmp(type, "update")) /* update record(s) */
2553 apdu = create_update_package(p);
2557 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
2561 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_PACKAGE);
2562 task->u.package = p;
2563 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
2564 p->buf_out = (char *) xmalloc (p->len_out);
2565 memcpy (p->buf_out, buf, p->len_out);
2570 while (ZOOM_event (1, &c))
2577 ZOOM_API(ZOOM_package)
2578 ZOOM_connection_package (ZOOM_connection c, ZOOM_options options)
2580 ZOOM_package p = (ZOOM_package) xmalloc (sizeof(*p));
2583 p->odr_out = odr_createmem (ODR_ENCODE);
2584 p->options = ZOOM_options_create_with_parent2 (options, c->options);
2592 ZOOM_package_destroy(ZOOM_package p)
2597 if (p->refcount == 0)
2599 odr_destroy (p->odr_out);
2602 ZOOM_options_destroy (p->options);
2607 ZOOM_API(const char *)
2608 ZOOM_package_option_get (ZOOM_package p, const char *key)
2610 return ZOOM_options_get (p->options, key);
2615 ZOOM_package_option_set (ZOOM_package p, const char *key,
2618 ZOOM_options_set (p->options, key, val);
2621 static int ZOOM_connection_exec_task (ZOOM_connection c)
2623 ZOOM_task task = c->tasks;
2624 zoom_ret ret = zoom_complete;
2628 yaz_log (LOG_DEBUG, "ZOOM_connection_exec_task task=<null>");
2631 yaz_log (LOG_DEBUG, "ZOOM_connection_exec_task type=%d run=%d",
2632 task->which, task->running);
2633 if (c->error != ZOOM_ERROR_NONE)
2635 yaz_log (LOG_DEBUG, "remove tasks because of error = %d", c->error);
2636 ZOOM_connection_remove_tasks (c);
2641 yaz_log (LOG_DEBUG, "task already running");
2645 ret = zoom_complete;
2646 if (c->cs || task->which == ZOOM_TASK_CONNECT)
2648 switch (task->which)
2650 case ZOOM_TASK_SEARCH:
2651 if (c->proto == PROTO_HTTP)
2652 ret = ZOOM_connection_srw_send_search(c);
2654 ret = ZOOM_connection_send_search(c);
2656 case ZOOM_TASK_RETRIEVE:
2657 if (c->proto == PROTO_HTTP)
2658 ret = ZOOM_connection_srw_send_search(c);
2660 ret = send_present (c);
2662 case ZOOM_TASK_CONNECT:
2663 ret = do_connect(c);
2665 case ZOOM_TASK_SCAN:
2668 case ZOOM_TASK_PACKAGE:
2669 ret = send_package(c);
2675 yaz_log (LOG_DEBUG, "remove tasks because no connection exist");
2676 ZOOM_connection_remove_tasks (c);
2678 if (ret == zoom_complete)
2680 yaz_log (LOG_DEBUG, "task removed (complete)");
2681 ZOOM_connection_remove_task (c);
2684 yaz_log (LOG_DEBUG, "task pending");
2688 static zoom_ret send_sort_present (ZOOM_connection c)
2690 zoom_ret r = send_sort (c);
2691 if (r == zoom_complete)
2692 r = send_present (c);
2696 static int es_response (ZOOM_connection c,
2697 Z_ExtendedServicesResponse *res)
2699 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
2701 if (res->diagnostics && res->num_diagnostics > 0)
2702 response_diag(c, res->diagnostics[0]);
2703 if (res->taskPackage &&
2704 res->taskPackage->which == Z_External_extendedService)
2706 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
2707 Odr_oct *id = taskPackage->targetReference;
2710 ZOOM_options_setl (c->tasks->u.package->options,
2711 "targetReference", (char*) id->buf, id->len);
2717 static void handle_apdu (ZOOM_connection c, Z_APDU *apdu)
2719 Z_InitResponse *initrs;
2722 yaz_log (LOG_DEBUG, "recv APDU type=%d", apdu->which);
2725 case Z_APDU_initResponse:
2726 initrs = apdu->u.initResponse;
2727 ZOOM_connection_option_set(c, "serverImplementationId",
2728 initrs->implementationId ?
2729 initrs->implementationId : "");
2730 ZOOM_connection_option_set(c, "serverImplementationName",
2731 initrs->implementationName ?
2732 initrs->implementationName : "");
2733 ZOOM_connection_option_set(c, "serverImplementationVersion",
2734 initrs->implementationVersion ?
2735 initrs->implementationVersion : "");
2736 /* Set the three old options too, for old applications */
2737 ZOOM_connection_option_set(c, "targetImplementationId",
2738 initrs->implementationId ?
2739 initrs->implementationId : "");
2740 ZOOM_connection_option_set(c, "targetImplementationName",
2741 initrs->implementationName ?
2742 initrs->implementationName : "");
2743 ZOOM_connection_option_set(c, "targetImplementationVersion",
2744 initrs->implementationVersion ?
2745 initrs->implementationVersion : "");
2746 if (!*initrs->result)
2748 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0);
2753 yaz_oi_get_string_oidval (&apdu->u.initResponse->otherInfo,
2755 xfree (c->cookie_in);
2758 c->cookie_in = xstrdup(cookie);
2759 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
2760 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
2761 c->support_named_resultsets = 1;
2764 assert (c->tasks->which == ZOOM_TASK_CONNECT);
2765 ZOOM_connection_remove_task (c);
2767 ZOOM_connection_exec_task (c);
2769 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
2771 NMEM tmpmem = nmem_create();
2772 Z_CharSetandLanguageNegotiation *p =
2773 yaz_get_charneg_record(initrs->otherInfo);
2777 char *charset=NULL, *lang=NULL;
2780 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
2781 yaz_log(LOG_DEBUG, "Target accepted: charset %s, "
2782 "language %s, select %d",
2783 charset ? charset : "none", lang ? lang : "none", sel);
2785 ZOOM_connection_option_set (c, "negotiation-charset",
2788 ZOOM_connection_option_set (c, "negotiation-lang",
2790 nmem_destroy(tmpmem);
2794 case Z_APDU_searchResponse:
2795 handle_search_response (c, apdu->u.searchResponse);
2796 if (send_sort_present (c) == zoom_complete)
2797 ZOOM_connection_remove_task (c);
2799 case Z_APDU_presentResponse:
2800 handle_present_response (c, apdu->u.presentResponse);
2801 if (send_present (c) == zoom_complete)
2802 ZOOM_connection_remove_task (c);
2804 case Z_APDU_sortResponse:
2805 sort_response (c, apdu->u.sortResponse);
2806 if (send_present (c) == zoom_complete)
2807 ZOOM_connection_remove_task (c);
2809 case Z_APDU_scanResponse:
2810 scan_response (c, apdu->u.scanResponse);
2811 ZOOM_connection_remove_task (c);
2813 case Z_APDU_extendedServicesResponse:
2814 es_response (c, apdu->u.extendedServicesResponse);
2815 ZOOM_connection_remove_task (c);
2818 if (c->reconnect_ok)
2821 c->tasks->running = 0;
2822 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
2826 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, 0);
2831 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2837 static void handle_srw_response(ZOOM_connection c,
2838 Z_SRW_searchRetrieveResponse *res)
2840 ZOOM_resultset resultset = 0;
2848 if (c->tasks->which == ZOOM_TASK_SEARCH)
2849 resultset = c->tasks->u.search.resultset;
2850 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
2851 resultset = c->tasks->u.retrieve.resultset;
2855 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2856 ZOOM_connection_put_event(c, event);
2858 resultset->size = 0;
2860 yaz_log(LOG_DEBUG, "got SRW response OK");
2862 if (res->numberOfRecords)
2863 resultset->size = *res->numberOfRecords;
2865 for (i = 0; i<res->num_records; i++)
2869 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
2870 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
2872 if (res->records[i].recordPosition &&
2873 *res->records[i].recordPosition > 0)
2874 pos = *res->records[i].recordPosition - 1;
2876 pos = resultset->start + i;
2878 npr->databaseName = 0;
2879 npr->which = Z_NamePlusRecord_databaseRecord;
2880 npr->u.databaseRecord = (Z_External *)
2881 odr_malloc(c->odr_in, sizeof(Z_External));
2882 npr->u.databaseRecord->descriptor = 0;
2883 npr->u.databaseRecord->direct_reference =
2884 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
2885 npr->u.databaseRecord->which = Z_External_octet;
2886 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
2887 odr_malloc(c->odr_in, sizeof(Odr_oct));
2888 npr->u.databaseRecord->u.octet_aligned->buf =
2889 res->records[i].recordData_buf;
2890 npr->u.databaseRecord->u.octet_aligned->len =
2891 npr->u.databaseRecord->u.octet_aligned->size =
2892 res->records[i].recordData_len;
2893 record_cache_add (resultset, npr, pos);
2895 if (res->num_diagnostics > 0)
2897 set_dset_error(c, *res->diagnostics[0].code, "SRW",
2898 res->diagnostics[0].details, 0);
2900 nmem = odr_extract_mem(c->odr_in);
2901 nmem_transfer(resultset->odr->mem, nmem);
2907 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
2910 const char *content_type = z_HTTP_header_lookup(hres->headers,
2912 const char *connection_head = z_HTTP_header_lookup(hres->headers,
2915 yaz_log (LOG_DEBUG, "handle_http");
2917 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
2919 Z_SOAP *soap_package = 0;
2920 ODR o = odr_createmem(ODR_DECODE);
2921 Z_SOAP_Handler soap_handlers[2] = {
2922 {"http://www.loc.gov/zing/srw/v1.0/", 0,
2923 (Z_SOAP_fun) yaz_srw_codec},
2926 ret = z_soap_codec(o, &soap_package,
2927 &hres->content_buf, &hres->content_len,
2929 if (!ret && soap_package->which == Z_SOAP_generic &&
2930 soap_package->u.generic->no == 0)
2932 Z_SRW_PDU *sr = soap_package->u.generic->p;
2933 if (sr->which == Z_SRW_searchRetrieve_response)
2934 handle_srw_response(c, sr->u.response);
2938 else if (!ret && (soap_package->which == Z_SOAP_fault
2939 || soap_package->which == Z_SOAP_error))
2941 set_HTTP_error(c, hres->code,
2942 soap_package->u.fault->fault_code,
2943 soap_package->u.fault->fault_string);
2951 if (hres->code != 200)
2952 set_HTTP_error(c, hres->code, 0, 0);
2954 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2957 ZOOM_connection_remove_task(c);
2958 if (!strcmp(hres->version, "1.0"))
2960 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
2961 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
2966 /* HTTP 1.1: only if no close we stay alive .. */
2967 if (connection_head && !strcmp(connection_head, "close"))
2973 static int do_read (ZOOM_connection c)
2978 event = ZOOM_Event_create (ZOOM_EVENT_RECV_DATA);
2979 ZOOM_connection_put_event (c, event);
2981 r = cs_get (c->cs, &c->buf_in, &c->len_in);
2982 more = cs_more(c->cs);
2983 yaz_log (LOG_DEBUG, "do_read len=%d more=%d", r, more);
2988 if (c->reconnect_ok)
2991 c->reconnect_ok = 0;
2992 yaz_log (LOG_DEBUG, "reconnect read");
2993 c->tasks->running = 0;
2994 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
2998 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, 0);
3007 odr_reset (c->odr_in);
3008 odr_setbuf (c->odr_in, c->buf_in, r, 0);
3009 event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);
3010 ZOOM_connection_put_event (c, event);
3012 if (!z_GDU (c->odr_in, &gdu, 0, 0))
3015 int err = odr_geterrorx(c->odr_in, &x);
3017 const char *element = odr_getelement(c->odr_in);
3018 sprintf (msg, "ODR code %d:%d element=%-20s",
3019 err, x, element ? element : "<unknown>");
3020 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3023 else if (gdu->which == Z_GDU_Z3950)
3024 handle_apdu (c, gdu->u.z3950);
3025 else if (gdu->which == Z_GDU_HTTP_Response)
3028 handle_http (c, gdu->u.HTTP_Response);
3030 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3034 c->reconnect_ok = 0;
3039 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out)
3044 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3045 ZOOM_connection_put_event (c, event);
3047 yaz_log (LOG_DEBUG, "do_write_ex len=%d", len_out);
3048 if ((r=cs_put (c->cs, buf_out, len_out)) < 0)
3050 if (c->reconnect_ok)
3053 c->reconnect_ok = 0;
3054 yaz_log (LOG_DEBUG, "reconnect write");
3055 c->tasks->running = 0;
3056 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3057 return zoom_pending;
3059 if (c->state == STATE_CONNECTING)
3060 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, 0);
3062 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, 0);
3064 return zoom_complete;
3068 c->mask = ZOOM_SELECT_EXCEPT;
3069 if (c->cs->io_pending & CS_WANT_WRITE)
3070 c->mask += ZOOM_SELECT_WRITE;
3071 if (c->cs->io_pending & CS_WANT_READ)
3072 c->mask += ZOOM_SELECT_READ;
3073 yaz_log (LOG_DEBUG, "do_write_ex 1 mask=%d", c->mask);
3077 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3078 yaz_log (LOG_DEBUG, "do_write_ex 2 mask=%d", c->mask);
3080 return zoom_pending;
3083 static zoom_ret do_write(ZOOM_connection c)
3085 return do_write_ex (c, c->buf_out, c->len_out);
3089 ZOOM_API(const char *)
3090 ZOOM_connection_option_get (ZOOM_connection c, const char *key)
3092 return ZOOM_options_get (c->options, key);
3096 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
3099 ZOOM_options_set (c->options, key, val);
3102 ZOOM_API(const char *)
3103 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key)
3105 return ZOOM_options_get (r->options, key);
3109 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key,
3112 ZOOM_options_set (r->options, key, val);
3117 ZOOM_connection_errcode (ZOOM_connection c)
3119 return ZOOM_connection_error (c, 0, 0);
3122 ZOOM_API(const char *)
3123 ZOOM_connection_errmsg (ZOOM_connection c)
3126 ZOOM_connection_error (c, &msg, 0);
3130 ZOOM_API(const char *)
3131 ZOOM_connection_addinfo (ZOOM_connection c)
3133 const char *addinfo;
3134 ZOOM_connection_error (c, 0, &addinfo);
3138 ZOOM_API(const char *)
3139 ZOOM_diag_str (int error)
3143 case ZOOM_ERROR_NONE:
3145 case ZOOM_ERROR_CONNECT:
3146 return "Connect failed";
3147 case ZOOM_ERROR_MEMORY:
3148 return "Out of memory";
3149 case ZOOM_ERROR_ENCODE:
3150 return "Encoding failed";
3151 case ZOOM_ERROR_DECODE:
3152 return "Decoding failed";
3153 case ZOOM_ERROR_CONNECTION_LOST:
3154 return "Connection lost";
3155 case ZOOM_ERROR_INIT:
3156 return "Init rejected";
3157 case ZOOM_ERROR_INTERNAL:
3158 return "Internal failure";
3159 case ZOOM_ERROR_TIMEOUT:
3161 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3162 return "Unsupported protocol";
3163 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3164 return "Unsupported query type";
3166 return diagbib1_str (error);
3171 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
3172 const char **addinfo, const char **diagset)
3174 int error = c->error;
3177 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3178 *cp = ZOOM_diag_str(error);
3179 else if (!strcmp(c->diagset, "HTTP"))
3180 *cp = z_HTTP_errmsg(c->error);
3181 else if (!strcmp(c->diagset, "Bib-1"))
3182 *cp = ZOOM_diag_str(error);
3183 else if (!strcmp(c->diagset, "SRW"))
3184 *cp = yaz_diag_srw_str(c->error);
3186 *cp = "Unknown error and diagnostic set";
3189 *addinfo = c->addinfo ? c->addinfo : "";
3191 *diagset = c->diagset ? c->diagset : "";
3196 ZOOM_connection_error (ZOOM_connection c, const char **cp,
3197 const char **addinfo)
3199 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3202 static int ZOOM_connection_do_io(ZOOM_connection c, int mask)
3204 ZOOM_Event event = 0;
3205 int r = cs_look(c->cs);
3206 yaz_log (LOG_DEBUG, "ZOOM_connection_do_io c=%p mask=%d cs_look=%d",
3211 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3212 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, 0);
3214 ZOOM_connection_put_event (c, event);
3216 else if (r == CS_CONNECT)
3219 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3221 ret = cs_rcvconnect (c->cs);
3222 yaz_log (LOG_DEBUG, "cs_rcvconnect returned %d", ret);
3225 c->mask = ZOOM_SELECT_EXCEPT;
3226 if (c->cs->io_pending & CS_WANT_WRITE)
3227 c->mask += ZOOM_SELECT_WRITE;
3228 if (c->cs->io_pending & CS_WANT_READ)
3229 c->mask += ZOOM_SELECT_READ;
3230 ZOOM_connection_put_event (c, event);
3234 ZOOM_connection_put_event (c, event);
3235 if (c->proto == PROTO_Z3950)
3236 ZOOM_connection_send_init(c);
3239 /* no init request for SRW .. */
3240 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3241 ZOOM_connection_remove_task (c);
3243 ZOOM_connection_exec_task (c);
3245 c->state = STATE_ESTABLISHED;
3249 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, 0);
3251 ZOOM_connection_put_event (c, event);
3256 if (mask & ZOOM_SELECT_READ)
3258 if (c->cs && (mask & ZOOM_SELECT_WRITE))
3265 ZOOM_connection_last_event(ZOOM_connection cs)
3268 return ZOOM_EVENT_NONE;
3269 return cs->last_event;
3273 ZOOM_event (int no, ZOOM_connection *cs)
3277 struct pollfd pollfds[1024];
3278 ZOOM_connection poll_cs[1024];
3281 fd_set input, output, except;
3286 for (i = 0; i<no; i++)
3288 ZOOM_connection c = cs[i];
3290 if (c && (event = ZOOM_connection_get_event(c)))
3292 ZOOM_Event_destroy (event);
3296 for (i = 0; i<no; i++)
3298 ZOOM_connection c = cs[i];
3300 if (c && ZOOM_connection_exec_task (c))
3302 if ((event = ZOOM_connection_get_event(c)))
3304 ZOOM_Event_destroy (event);
3317 for (i = 0; i<no; i++)
3319 ZOOM_connection c = cs[i];
3325 fd = z3950_connection_socket(c);
3326 mask = z3950_connection_mask(c);
3333 this_timeout = ZOOM_options_get_int (c->options, "timeout", -1);
3334 if (this_timeout != -1 && this_timeout < timeout)
3335 timeout = this_timeout;
3339 short poll_events = 0;
3341 if (mask & ZOOM_SELECT_READ)
3342 poll_events += POLLIN;
3343 if (mask & ZOOM_SELECT_WRITE)
3344 poll_events += POLLOUT;
3345 if (mask & ZOOM_SELECT_EXCEPT)
3346 poll_events += POLLERR;
3347 pollfds[nfds].fd = fd;
3348 pollfds[nfds].events = poll_events;
3349 pollfds[nfds].revents = 0;
3354 if (mask & ZOOM_SELECT_READ)
3356 FD_SET (fd, &input);
3359 if (mask & ZOOM_SELECT_WRITE)
3361 FD_SET (fd, &output);
3364 if (mask & ZOOM_SELECT_EXCEPT)
3366 FD_SET (fd, &except);
3371 if (timeout >= 5000)
3378 r = poll (pollfds, nfds, timeout * 1000);
3379 for (i = 0; i<nfds; i++)
3381 ZOOM_connection c = poll_cs[i];
3385 if (pollfds[i].revents & POLLIN)
3386 mask += ZOOM_SELECT_READ;
3387 if (pollfds[i].revents & POLLOUT)
3388 mask += ZOOM_SELECT_WRITE;
3389 if (pollfds[i].revents & POLLERR)
3390 mask += ZOOM_SELECT_EXCEPT;
3392 ZOOM_connection_do_io(c, mask);
3394 else if (r == 0 && c->mask)
3396 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3397 /* timeout and this connection was waiting */
3398 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3400 ZOOM_connection_put_event(c, event);
3404 tv.tv_sec = timeout;
3406 yaz_log (LOG_DEBUG, "select start");
3407 r = select (max_fd+1, &input, &output, &except, &tv);
3408 yaz_log (LOG_DEBUG, "select stop, returned r=%d", r);
3409 for (i = 0; i<no; i++)
3411 ZOOM_connection c = cs[i];
3416 fd = z3950_connection_socket(c);
3420 /* no timeout and real socket */
3421 if (FD_ISSET(fd, &input))
3422 mask += ZOOM_SELECT_READ;
3423 if (FD_ISSET(fd, &output))
3424 mask += ZOOM_SELECT_WRITE;
3425 if (FD_ISSET(fd, &except))
3426 mask += ZOOM_SELECT_EXCEPT;
3428 ZOOM_connection_do_io(c, mask);
3430 if (r == 0 && c->mask)
3432 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3433 /* timeout and this connection was waiting */
3434 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3436 yaz_log (LOG_DEBUG, "timeout");
3437 ZOOM_connection_put_event(c, event);
3441 for (i = 0; i<no; i++)
3443 ZOOM_connection c = cs[i];
3445 if (c && (event = ZOOM_connection_get_event(c)))
3447 ZOOM_Event_destroy (event);