2 * Copyright (c) 2000-2003, Index Data
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.10 2003-12-04 12:57:30 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, "pass");
901 ODR_MASK_SET(ireq->options, Z_Options_search);
902 ODR_MASK_SET(ireq->options, Z_Options_present);
903 ODR_MASK_SET(ireq->options, Z_Options_scan);
904 ODR_MASK_SET(ireq->options, Z_Options_sort);
905 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
906 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
908 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
909 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
910 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
912 /* Index Data's Z39.50 Implementor Id is 81 */
913 ireq->implementationId = odr_prepend(c->odr_out,
914 ZOOM_options_get(c->options, "implementationId"),
915 odr_prepend(c->odr_out, "81", ireq->implementationId));
917 ireq->implementationName = odr_prepend(c->odr_out,
918 ZOOM_options_get(c->options, "implementationName"),
919 odr_prepend(c->odr_out, "ZOOM-C", ireq->implementationName));
921 version = odr_strdup(c->odr_out, "$Revision: 1.10 $");
922 if (strlen(version) > 10) /* check for unexpanded CVS strings */
923 version[strlen(version)-2] = '\0';
924 ireq->implementationVersion = odr_prepend(c->odr_out,
925 ZOOM_options_get(c->options, "implementationVersion"),
926 odr_prepend(c->odr_out, &version[11], ireq->implementationVersion));
928 *ireq->maximumRecordSize =
929 ZOOM_options_get_int (c->options, "maximumRecordSize", 1024*1024);
930 *ireq->preferredMessageSize =
931 ZOOM_options_get_int (c->options, "preferredMessageSize", 1024*1024);
933 if (auth_groupId || auth_password)
935 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
938 if (auth_groupId && *auth_groupId)
940 pass->groupId = (char *)
941 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
942 strcpy(pass->groupId, auth_groupId);
946 if (auth_userId && *auth_userId)
948 pass->userId = (char *)
949 odr_malloc(c->odr_out, strlen(auth_userId)+1);
950 strcpy(pass->userId, auth_userId);
954 if (auth_password && *auth_password)
956 pass->password = (char *)
957 odr_malloc(c->odr_out, strlen(auth_password)+1);
958 strcpy(pass->password, auth_password);
963 auth->which = Z_IdAuthentication_idPass;
964 auth->u.idPass = pass;
965 ireq->idAuthentication = auth;
968 else if (auth_userId)
970 auth->which = Z_IdAuthentication_open;
971 auth->u.open = (char *)
972 odr_malloc(c->odr_out, strlen(auth_userId)+1);
973 strcpy(auth->u.open, auth_userId);
974 ireq->idAuthentication = auth;
977 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
978 VAL_PROXY, 1, c->host_port);
979 if (c->charset||c->lang)
981 Z_OtherInformation **oi;
982 Z_OtherInformationUnit *oi_unit;
984 yaz_oi_APDU(apdu, &oi);
986 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
988 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
990 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
991 oi_unit->information.externallyDefinedInfo =
992 yaz_set_proposal_charneg
994 (const char **)&c->charset, (c->charset) ? 1:0,
995 (const char **)&c->lang, (c->lang) ? 1:0, 1);
999 return send_APDU (c, apdu);
1003 static zoom_ret send_srw (ZOOM_connection c, Z_SRW_PDU *sr)
1006 Z_SOAP_Handler h[2] = {
1007 {"http://www.loc.gov/zing/srw/v1.0/", 0, (Z_SOAP_fun) yaz_srw_codec},
1010 ODR o = odr_createmem(ODR_ENCODE);
1012 Z_SOAP *p = odr_malloc(o, sizeof(*p));
1016 gdu = z_get_HTTP_Request(c->odr_out);
1017 gdu->u.HTTP_Request->path = c->path;
1021 const char *cp0 = strstr(c->host_port, "://");
1022 const char *cp1 = 0;
1028 cp1 = strchr(cp0, '/');
1030 cp1 = cp0+strlen(cp0);
1034 char *h = odr_malloc(c->odr_out, cp1 - cp0 + 1);
1035 memcpy (h, cp0, cp1 - cp0);
1037 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1042 strcpy(ctype, "text/xml");
1043 if (c->charset && strlen(c->charset) < 20)
1045 strcat(ctype, "; charset=");
1046 strcat(ctype, c->charset);
1048 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1049 "Content-Type", ctype);
1050 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1051 "SOAPAction", "\"\"");
1052 p->which = Z_SOAP_generic;
1053 p->u.generic = odr_malloc(o, sizeof(*p->u.generic));
1054 p->u.generic->no = 0;
1055 p->u.generic->ns = 0;
1056 p->u.generic->p = sr;
1057 p->ns = "http://schemas.xmlsoap.org/soap/envelope/";
1059 ret = z_soap_codec_enc(o, &p,
1060 &gdu->u.HTTP_Request->content_buf,
1061 &gdu->u.HTTP_Request->content_len, h,
1064 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1065 return zoom_complete;
1066 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1070 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1071 ZOOM_connection_put_event (c, event);
1072 odr_reset(c->odr_out);
1073 return do_write (c);
1078 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1081 ZOOM_resultset resultset = 0;
1083 const char *recordPacking = 0;
1085 if (c->error) /* don't continue on error */
1086 return zoom_complete;
1088 if (c->tasks->which == ZOOM_TASK_SEARCH)
1090 resultset = c->tasks->u.search.resultset;
1091 resultset->setname = xstrdup ("default");
1092 ZOOM_options_set (resultset->options, "setname", resultset->setname);
1094 else if(c->tasks->which == ZOOM_TASK_RETRIEVE)
1096 resultset = c->tasks->u.retrieve.resultset;
1098 resultset->start = c->tasks->u.retrieve.start;
1099 resultset->count = c->tasks->u.retrieve.count;
1101 if (resultset->start >= resultset->size)
1102 return zoom_complete;
1103 if (resultset->start + resultset->count > resultset->size)
1104 resultset->count = resultset->size - resultset->start;
1106 for (i = 0; i<resultset->count; i++)
1109 record_cache_lookup (resultset, i + resultset->start);
1113 if (i == resultset->count)
1114 return zoom_complete;
1116 assert(resultset->query);
1118 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1120 if (resultset->query->z_query->which == Z_Query_type_104
1121 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1124 sr->u.request->query_type = Z_SRW_query_type_cql;
1125 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1127 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1128 resultset->query->z_query->u.type_1)
1130 sr->u.request->query_type = Z_SRW_query_type_pqf;
1131 sr->u.request->query.pqf = resultset->query->query_string;
1135 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1136 return zoom_complete;
1138 sr->u.request->startRecord = odr_intdup (c->odr_out, resultset->start + 1);
1139 sr->u.request->maximumRecords = odr_intdup (
1140 c->odr_out, resultset->step>0 ? resultset->step : resultset->count);
1141 sr->u.request->recordSchema = resultset->schema;
1143 recordPacking = ZOOM_resultset_option_get (resultset, "recordPacking");
1146 sr->u.request->recordPacking = odr_strdup(c->odr_out, recordPacking);
1148 return send_srw(c, sr);
1151 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1153 return zoom_complete;
1157 static zoom_ret ZOOM_connection_send_search (ZOOM_connection c)
1160 int lslb, ssub, mspn;
1162 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1163 Z_SearchRequest *search_req = apdu->u.searchRequest;
1164 const char *elementSetName;
1165 const char *smallSetElementSetName;
1166 const char *mediumSetElementSetName;
1169 assert (c->tasks->which == ZOOM_TASK_SEARCH);
1171 r = c->tasks->u.search.resultset;
1174 ZOOM_options_get (r->options, "elementSetName");
1175 smallSetElementSetName =
1176 ZOOM_options_get (r->options, "smallSetElementSetName");
1177 mediumSetElementSetName =
1178 ZOOM_options_get (r->options, "mediumSetElementSetName");
1180 if (!smallSetElementSetName)
1181 smallSetElementSetName = elementSetName;
1183 if (!mediumSetElementSetName)
1184 mediumSetElementSetName = elementSetName;
1189 /* prepare query for the search request */
1190 search_req->query = r->query->z_query;
1192 search_req->databaseNames =
1193 set_DatabaseNames (c, r->options, &search_req->num_databaseNames);
1195 /* get syntax (no need to provide unless piggyback is in effect) */
1196 syntax = ZOOM_options_get (r->options, "preferredRecordSyntax");
1198 lslb = ZOOM_options_get_int (r->options, "largeSetLowerBound", -1);
1199 ssub = ZOOM_options_get_int (r->options, "smallSetUpperBound", -1);
1200 mspn = ZOOM_options_get_int (r->options, "mediumSetPresentNumber", -1);
1201 if (lslb != -1 && ssub != -1 && mspn != -1)
1203 /* So're a Z39.50 expert? Let's hope you don't do sort */
1204 *search_req->largeSetLowerBound = lslb;
1205 *search_req->smallSetUpperBound = ssub;
1206 *search_req->mediumSetPresentNumber = mspn;
1208 else if (r->start == 0 && r->count > 0
1209 && r->piggyback && !r->r_sort_spec && !r->schema)
1211 /* Regular piggyback - do it unless we're going to do sort */
1212 *search_req->largeSetLowerBound = 2000000000;
1213 *search_req->smallSetUpperBound = 1;
1214 *search_req->mediumSetPresentNumber = r->step>0 ? r->step : r->count;
1218 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1219 smallSetElementSetName = 0;
1220 mediumSetElementSetName = 0;
1223 if (smallSetElementSetName && *smallSetElementSetName)
1225 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1226 odr_malloc (c->odr_out, sizeof(*esn));
1228 esn->which = Z_ElementSetNames_generic;
1229 esn->u.generic = odr_strdup (c->odr_out, smallSetElementSetName);
1230 search_req->smallSetElementSetNames = esn;
1232 if (mediumSetElementSetName && *mediumSetElementSetName)
1234 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1235 odr_malloc (c->odr_out, sizeof(*esn));
1237 esn->which = Z_ElementSetNames_generic;
1238 esn->u.generic = odr_strdup (c->odr_out, mediumSetElementSetName);
1239 search_req->mediumSetElementSetNames = esn;
1242 search_req->preferredRecordSyntax =
1243 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1247 if (c->support_named_resultsets)
1251 /* find the lowest unused ordinal so that we re-use
1252 result sets on the server. */
1253 for (ord = 1; ; ord++)
1256 sprintf (setname, "%d", ord);
1257 for (rp = c->resultsets; rp; rp = rp->next)
1258 if (rp->setname && !strcmp (rp->setname, setname))
1263 r->setname = xstrdup (setname);
1264 yaz_log (LOG_DEBUG, "allocating set %s", r->setname);
1267 r->setname = xstrdup ("default");
1268 ZOOM_options_set (r->options, "setname", r->setname);
1270 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1271 /* send search request */
1272 return send_APDU (c, apdu);
1275 static void response_diag (ZOOM_connection c, Z_DiagRec *p)
1278 Z_DefaultDiagFormat *r;
1283 if (p->which != Z_DiagRec_defaultFormat)
1285 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1288 r = p->u.defaultFormat;
1291 case Z_DefaultDiagFormat_v2Addinfo:
1292 addinfo = r->u.v2Addinfo;
1294 case Z_DefaultDiagFormat_v3Addinfo:
1295 addinfo = r->u.v3Addinfo;
1298 set_dset_error(c, *r->condition,
1299 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1303 ZOOM_API(ZOOM_record)
1304 ZOOM_record_clone (ZOOM_record srec)
1311 odr_enc = odr_createmem(ODR_ENCODE);
1312 if (!z_NamePlusRecord (odr_enc, &srec->npr, 0, 0))
1314 buf = odr_getbuf (odr_enc, &size, 0);
1316 nrec = (ZOOM_record) xmalloc (sizeof(*nrec));
1317 nrec->odr = odr_createmem(ODR_DECODE);
1318 nrec->wrbuf_marc = 0;
1319 nrec->wrbuf_iconv = 0;
1320 nrec->wrbuf_opac = 0;
1321 odr_setbuf (nrec->odr, buf, size, 0);
1322 z_NamePlusRecord (nrec->odr, &nrec->npr, 0, 0);
1324 odr_destroy (odr_enc);
1328 ZOOM_API(ZOOM_record)
1329 ZOOM_resultset_record_immediate (ZOOM_resultset s,size_t pos)
1331 return record_cache_lookup (s, pos);
1334 ZOOM_API(ZOOM_record)
1335 ZOOM_resultset_record (ZOOM_resultset r, size_t pos)
1337 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1341 ZOOM_resultset_retrieve (r, 1, pos, 1);
1342 rec = ZOOM_resultset_record_immediate (r, pos);
1348 ZOOM_record_destroy (ZOOM_record rec)
1352 if (rec->wrbuf_marc)
1353 wrbuf_free (rec->wrbuf_marc, 1);
1354 if (rec->wrbuf_iconv)
1355 wrbuf_free (rec->wrbuf_iconv, 1);
1356 if (rec->wrbuf_opac)
1357 wrbuf_free (rec->wrbuf_opac, 1);
1358 odr_destroy (rec->odr);
1362 static const char *record_iconv_return(ZOOM_record rec, int *len,
1363 const char *buf, int sz,
1364 const char *record_charset)
1371 strcpy(to, "UTF-8");
1372 if (record_charset && *record_charset)
1374 /* Use "from,to" or just "from" */
1375 const char *cp =strchr(record_charset, ',');
1376 int clen = strlen(record_charset);
1379 strncpy( to, cp+1, sizeof(to)-1);
1380 to[sizeof(to)-1] = '\0';
1381 clen = cp - record_charset;
1383 if (clen > sizeof(from)-1)
1384 clen = sizeof(from)-1;
1387 strncpy(from, record_charset, clen);
1391 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1394 size_t inbytesleft = sz;
1395 const char *inp = buf;
1397 if (!rec->wrbuf_iconv)
1398 rec->wrbuf_iconv = wrbuf_alloc();
1400 wrbuf_rewind(rec->wrbuf_iconv);
1404 size_t outbytesleft = sizeof(outbuf);
1405 char *outp = outbuf;
1406 size_t r = yaz_iconv (cd, (char**) &inp,
1408 &outp, &outbytesleft);
1409 if (r == (size_t) (-1))
1411 int e = yaz_iconv_error(cd);
1412 if (e != YAZ_ICONV_E2BIG)
1415 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1417 wrbuf_puts(rec->wrbuf_iconv, "");
1418 buf = wrbuf_buf(rec->wrbuf_iconv);
1419 sz = wrbuf_len(rec->wrbuf_iconv);
1420 yaz_iconv_close(cd);
1427 ZOOM_API(const char *)
1428 ZOOM_record_get (ZOOM_record rec, const char *type_spec, int *len)
1434 Z_NamePlusRecord *npr;
1437 *len = 0; /* default return */
1446 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1448 if (cp[i] == ';' || cp[i] == ' ')
1454 if (type_spec[i] == ';')
1457 while (type_spec[i] == ' ')
1459 if (!strncmp(type_spec+i, "charset=", 8))
1462 for (i = 0; cp[i] && i < sizeof(charset)-1; i++)
1464 if (cp[i] == ';' || cp[i] == ' ')
1472 if (!strcmp (type, "database"))
1475 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1476 return npr->databaseName;
1478 else if (!strcmp (type, "syntax"))
1480 const char *desc = 0;
1481 if (npr->which == Z_NamePlusRecord_databaseRecord)
1483 Z_External *r = (Z_External *) npr->u.databaseRecord;
1484 oident *ent = oid_getentbyoid(r->direct_reference);
1491 *len = strlen(desc);
1494 if (npr->which != Z_NamePlusRecord_databaseRecord)
1497 /* from now on - we have a database record .. */
1498 if (!strcmp (type, "render"))
1500 Z_External *r = (Z_External *) npr->u.databaseRecord;
1501 oident *ent = oid_getentbyoid(r->direct_reference);
1503 /* render bibliographic record .. */
1504 if (r->which == Z_External_OPAC)
1506 r = r->u.opac->bibliographicRecord;
1509 ent = oid_getentbyoid(r->direct_reference);
1511 if (r->which == Z_External_sutrs)
1512 return record_iconv_return(rec, len,
1513 r->u.sutrs->buf, r->u.sutrs->len,
1515 else if (r->which == Z_External_octet)
1525 case VAL_APPLICATION_XML:
1528 if (!rec->wrbuf_marc)
1529 rec->wrbuf_marc = wrbuf_alloc();
1531 mt = yaz_marc_create();
1532 wrbuf_rewind (rec->wrbuf_marc);
1533 if (yaz_marc_decode_wrbuf (
1534 mt, (const char *) r->u.octet_aligned->buf,
1535 r->u.octet_aligned->len,
1536 rec->wrbuf_marc) > 0)
1538 yaz_marc_destroy(mt);
1539 return record_iconv_return(rec, len,
1540 wrbuf_buf(rec->wrbuf_marc),
1541 wrbuf_len(rec->wrbuf_marc),
1544 yaz_marc_destroy(mt);
1546 return record_iconv_return(rec, len,
1547 (const char *) r->u.octet_aligned->buf,
1548 r->u.octet_aligned->len,
1551 else if (r->which == Z_External_grs1)
1553 if (!rec->wrbuf_marc)
1554 rec->wrbuf_marc = wrbuf_alloc();
1555 wrbuf_rewind (rec->wrbuf_marc);
1556 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1557 return record_iconv_return(rec, len,
1558 wrbuf_buf(rec->wrbuf_marc),
1559 wrbuf_len(rec->wrbuf_marc),
1564 else if (!strcmp (type, "xml") || !strcmp(type, "oai"))
1566 Z_External *r = (Z_External *) npr->u.databaseRecord;
1567 oident *ent = oid_getentbyoid(r->direct_reference);
1569 /* render bibliographic record .. */
1570 if (r->which == Z_External_OPAC)
1572 r = r->u.opac->bibliographicRecord;
1575 ent = oid_getentbyoid(r->direct_reference);
1578 if (r->which == Z_External_sutrs)
1579 return record_iconv_return(rec, len,
1580 (const char *) r->u.sutrs->buf,
1583 else if (r->which == Z_External_octet)
1586 int marc_decode_type = YAZ_MARC_MARCXML;
1588 if (!strcmp(type, "oai"))
1589 marc_decode_type = YAZ_MARC_OAIMARC;
1597 case VAL_APPLICATION_XML:
1600 if (!rec->wrbuf_marc)
1601 rec->wrbuf_marc = wrbuf_alloc();
1602 wrbuf_rewind (rec->wrbuf_marc);
1603 mt = yaz_marc_create();
1605 yaz_marc_xml(mt, YAZ_MARC_MARCXML);
1606 if (yaz_marc_decode_wrbuf (
1607 mt, (const char *) r->u.octet_aligned->buf,
1608 r->u.octet_aligned->len,
1609 rec->wrbuf_marc) > 0)
1611 yaz_marc_destroy(mt);
1612 return record_iconv_return(rec, len,
1613 wrbuf_buf(rec->wrbuf_marc),
1614 wrbuf_len(rec->wrbuf_marc),
1617 yaz_marc_destroy(mt);
1619 return record_iconv_return(rec, len,
1620 (const char *) r->u.octet_aligned->buf,
1621 r->u.octet_aligned->len,
1624 else if (r->which == Z_External_grs1)
1631 else if (!strcmp (type, "raw"))
1633 Z_External *r = (Z_External *) npr->u.databaseRecord;
1635 if (r->which == Z_External_sutrs)
1637 if (len) *len = r->u.sutrs->len;
1638 return (const char *) r->u.sutrs->buf;
1640 else if (r->which == Z_External_octet)
1642 if (len) *len = r->u.octet_aligned->len;
1643 return (const char *) r->u.octet_aligned->buf;
1645 else /* grs-1, explain, OPAC, ... */
1648 return (const char *) npr->u.databaseRecord;
1652 else if (!strcmp (type, "ext"))
1655 return (const char *) npr->u.databaseRecord;
1657 else if (!strcmp (type, "opac"))
1660 Z_External *r = (Z_External *) npr->u.databaseRecord;
1661 if (r->which == Z_External_OPAC)
1663 if (!rec->wrbuf_opac)
1664 rec->wrbuf_opac = wrbuf_alloc();
1665 wrbuf_rewind (rec->wrbuf_opac);
1666 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
1667 return record_iconv_return(rec, len,
1668 wrbuf_buf(rec->wrbuf_opac),
1669 wrbuf_len(rec->wrbuf_opac),
1676 static int strcmp_null(const char *v1, const char *v2)
1682 return strcmp(v1, v2);
1685 static void record_cache_add (ZOOM_resultset r, Z_NamePlusRecord *npr,
1688 ZOOM_record_cache rc;
1689 const char *elementSetName =
1690 ZOOM_resultset_option_get (r, "elementSetName");
1691 const char *syntax =
1692 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
1694 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1695 ZOOM_connection_put_event(r->connection, event);
1697 for (rc = r->record_cache; rc; rc = rc->next)
1701 if (strcmp_null(r->schema, rc->schema))
1703 if (strcmp_null(elementSetName,rc->elementSetName))
1705 if (strcmp_null(syntax, rc->syntax))
1707 /* not destroying rc->npr (it's handled by nmem )*/
1709 /* keeping wrbuf_marc too */
1713 rc = (ZOOM_record_cache) odr_malloc (r->odr, sizeof(*rc));
1716 rc->rec.wrbuf_marc = 0;
1717 rc->rec.wrbuf_iconv = 0;
1718 rc->rec.wrbuf_opac = 0;
1720 rc->elementSetName = odr_strdup (r->odr, elementSetName);
1722 rc->elementSetName = 0;
1725 rc->syntax = odr_strdup (r->odr, syntax);
1730 rc->schema = odr_strdup (r->odr, r->schema);
1735 rc->next = r->record_cache;
1736 r->record_cache = rc;
1739 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos)
1741 ZOOM_record_cache rc;
1742 const char *elementSetName =
1743 ZOOM_resultset_option_get (r, "elementSetName");
1744 const char *syntax =
1745 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
1747 for (rc = r->record_cache; rc; rc = rc->next)
1751 if (strcmp_null(r->schema, rc->schema))
1753 if (strcmp_null(elementSetName,rc->elementSetName))
1755 if (strcmp_null(syntax, rc->syntax))
1763 static void handle_records (ZOOM_connection c, Z_Records *sr,
1766 ZOOM_resultset resultset;
1770 switch (c->tasks->which)
1772 case ZOOM_TASK_SEARCH:
1773 resultset = c->tasks->u.search.resultset;
1775 case ZOOM_TASK_RETRIEVE:
1776 resultset = c->tasks->u.retrieve.resultset;
1781 if (sr && sr->which == Z_Records_NSD)
1783 Z_DiagRec dr, *dr_p = &dr;
1784 dr.which = Z_DiagRec_defaultFormat;
1785 dr.u.defaultFormat = sr->u.nonSurrogateDiagnostic;
1787 response_diag (c, dr_p);
1789 else if (sr && sr->which == Z_Records_multipleNSD)
1791 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
1792 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
1794 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1798 if (resultset->count + resultset->start > resultset->size)
1799 resultset->count = resultset->size - resultset->start;
1800 if (resultset->count < 0)
1801 resultset->count = 0;
1802 if (sr && sr->which == Z_Records_DBOSD)
1805 NMEM nmem = odr_extract_mem (c->odr_in);
1806 Z_NamePlusRecordList *p =
1807 sr->u.databaseOrSurDiagnostics;
1808 for (i = 0; i<p->num_records; i++)
1810 record_cache_add (resultset, p->records[i],
1811 i+ resultset->start);
1813 /* transfer our response to search_nmem .. we need it later */
1814 nmem_transfer (resultset->odr->mem, nmem);
1815 nmem_destroy (nmem);
1816 if (present_phase && p->num_records == 0)
1818 /* present response and we didn't get any records! */
1819 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1822 else if (present_phase)
1824 /* present response and we didn't get any records! */
1825 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1830 static void handle_present_response (ZOOM_connection c, Z_PresentResponse *pr)
1832 handle_records (c, pr->records, 1);
1835 static void handle_search_response (ZOOM_connection c, Z_SearchResponse *sr)
1837 ZOOM_resultset resultset;
1840 yaz_log (LOG_DEBUG, "got search response");
1842 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1845 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
1846 ZOOM_connection_put_event(c, event);
1848 resultset = c->tasks->u.search.resultset;
1850 resultset->size = *sr->resultCount;
1851 handle_records (c, sr->records, 0);
1854 static void sort_response (ZOOM_connection c, Z_SortResponse *res)
1856 if (res->diagnostics && res->num_diagnostics > 0)
1857 response_diag (c, res->diagnostics[0]);
1860 static int scan_response (ZOOM_connection c, Z_ScanResponse *res)
1862 NMEM nmem = odr_extract_mem (c->odr_in);
1865 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
1867 scan = c->tasks->u.scan.scan;
1869 if (res->entries && res->entries->nonsurrogateDiagnostics)
1870 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
1871 scan->scan_response = res;
1872 nmem_transfer (scan->odr->mem, nmem);
1874 ZOOM_options_set_int (scan->options, "stepSize", *res->stepSize);
1875 if (res->positionOfTerm)
1876 ZOOM_options_set_int (scan->options, "position", *res->positionOfTerm);
1877 if (res->scanStatus)
1878 ZOOM_options_set_int (scan->options, "scanStatus", *res->scanStatus);
1879 if (res->numberOfEntriesReturned)
1880 ZOOM_options_set_int (scan->options, "number",
1881 *res->numberOfEntriesReturned);
1882 nmem_destroy (nmem);
1886 static zoom_ret send_sort (ZOOM_connection c)
1888 ZOOM_resultset resultset;
1890 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1891 return zoom_complete;
1893 resultset = c->tasks->u.search.resultset;
1897 resultset->r_sort_spec = 0;
1898 return zoom_complete;
1900 if (resultset->r_sort_spec)
1902 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
1903 Z_SortRequest *req = apdu->u.sortRequest;
1905 req->num_inputResultSetNames = 1;
1906 req->inputResultSetNames = (Z_InternationalString **)
1907 odr_malloc (c->odr_out, sizeof(*req->inputResultSetNames));
1908 req->inputResultSetNames[0] =
1909 odr_strdup (c->odr_out, resultset->setname);
1910 req->sortedResultSetName = odr_strdup (c->odr_out, resultset->setname);
1911 req->sortSequence = resultset->r_sort_spec;
1912 resultset->r_sort_spec = 0;
1913 return send_APDU (c, apdu);
1915 return zoom_complete;
1918 static zoom_ret send_present (ZOOM_connection c)
1921 Z_PresentRequest *req = 0;
1923 const char *syntax = 0;
1924 const char *elementSetName = 0;
1925 ZOOM_resultset resultset;
1928 return zoom_complete;
1930 switch (c->tasks->which)
1932 case ZOOM_TASK_SEARCH:
1933 resultset = c->tasks->u.search.resultset;
1935 case ZOOM_TASK_RETRIEVE:
1936 resultset = c->tasks->u.retrieve.resultset;
1937 resultset->start = c->tasks->u.retrieve.start;
1938 resultset->count = c->tasks->u.retrieve.count;
1940 if (resultset->start >= resultset->size)
1941 return zoom_complete;
1942 if (resultset->start + resultset->count > resultset->size)
1943 resultset->count = resultset->size - resultset->start;
1946 return zoom_complete;
1949 syntax = ZOOM_resultset_option_get (resultset, "preferredRecordSyntax");
1950 elementSetName = ZOOM_resultset_option_get (resultset, "elementSetName");
1952 if (c->error) /* don't continue on error */
1953 return zoom_complete;
1954 if (resultset->start < 0)
1955 return zoom_complete;
1956 for (i = 0; i<resultset->count; i++)
1959 record_cache_lookup (resultset, i + resultset->start);
1963 if (i == resultset->count)
1964 return zoom_complete;
1966 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
1967 req = apdu->u.presentRequest;
1969 resultset->start += i;
1970 resultset->count -= i;
1971 *req->resultSetStartPoint = resultset->start + 1;
1972 *req->numberOfRecordsRequested = resultset->step>0 ?
1973 resultset->step : resultset->count;
1974 assert (*req->numberOfRecordsRequested > 0);
1976 if (syntax && *syntax)
1977 req->preferredRecordSyntax =
1978 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1980 if (resultset->schema && *resultset->schema)
1982 Z_RecordComposition *compo = (Z_RecordComposition *)
1983 odr_malloc (c->odr_out, sizeof(*compo));
1985 req->recordComposition = compo;
1986 compo->which = Z_RecordComp_complex;
1987 compo->u.complex = (Z_CompSpec *)
1988 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
1989 compo->u.complex->selectAlternativeSyntax = (bool_t *)
1990 odr_malloc(c->odr_out, sizeof(bool_t));
1991 *compo->u.complex->selectAlternativeSyntax = 0;
1993 compo->u.complex->generic = (Z_Specification *)
1994 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
1996 compo->u.complex->generic->which = Z_Schema_oid;
1997 compo->u.complex->generic->schema.oid = (Odr_oid *)
1998 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2000 if (!compo->u.complex->generic->schema.oid)
2002 /* OID wasn't a schema! Try record syntax instead. */
2004 compo->u.complex->generic->schema.oid = (Odr_oid *)
2005 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2007 if (elementSetName && *elementSetName)
2009 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2010 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2011 compo->u.complex->generic->elementSpec->which =
2012 Z_ElementSpec_elementSetName;
2013 compo->u.complex->generic->elementSpec->u.elementSetName =
2014 odr_strdup (c->odr_out, elementSetName);
2017 compo->u.complex->generic->elementSpec = 0;
2018 compo->u.complex->num_dbSpecific = 0;
2019 compo->u.complex->dbSpecific = 0;
2020 compo->u.complex->num_recordSyntax = 0;
2021 compo->u.complex->recordSyntax = 0;
2023 else if (elementSetName && *elementSetName)
2025 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2026 odr_malloc (c->odr_out, sizeof(*esn));
2027 Z_RecordComposition *compo = (Z_RecordComposition *)
2028 odr_malloc (c->odr_out, sizeof(*compo));
2030 esn->which = Z_ElementSetNames_generic;
2031 esn->u.generic = odr_strdup (c->odr_out, elementSetName);
2032 compo->which = Z_RecordComp_simple;
2033 compo->u.simple = esn;
2034 req->recordComposition = compo;
2036 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2037 return send_APDU (c, apdu);
2040 ZOOM_API(ZOOM_scanset)
2041 ZOOM_connection_scan (ZOOM_connection c, const char *start)
2043 ZOOM_scanset scan = (ZOOM_scanset) xmalloc (sizeof(*scan));
2045 scan->connection = c;
2046 scan->odr = odr_createmem (ODR_DECODE);
2047 scan->options = ZOOM_options_create_with_parent (c->options);
2049 scan->scan_response = 0;
2051 if ((scan->termListAndStartPoint =
2052 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet,
2055 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_SCAN);
2056 task->u.scan.scan = scan;
2061 while (ZOOM_event (1, &c))
2069 ZOOM_scanset_destroy (ZOOM_scanset scan)
2074 if (scan->refcount == 0)
2076 odr_destroy (scan->odr);
2078 ZOOM_options_destroy (scan->options);
2083 static zoom_ret send_package (ZOOM_connection c)
2087 return zoom_complete;
2088 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2090 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
2091 ZOOM_connection_put_event (c, event);
2093 return do_write_ex (c, c->tasks->u.package->buf_out,
2094 c->tasks->u.package->len_out);
2097 static zoom_ret send_scan (ZOOM_connection c)
2100 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2101 Z_ScanRequest *req = apdu->u.scanRequest;
2103 return zoom_complete;
2104 assert (c->tasks->which == ZOOM_TASK_SCAN);
2105 scan = c->tasks->u.scan.scan;
2107 req->termListAndStartPoint = scan->termListAndStartPoint;
2108 req->attributeSet = scan->attributeSet;
2110 *req->numberOfTermsRequested =
2111 ZOOM_options_get_int(scan->options, "number", 10);
2113 req->preferredPositionInResponse =
2114 odr_intdup (c->odr_out,
2115 ZOOM_options_get_int(scan->options, "position", 1));
2118 odr_intdup (c->odr_out,
2119 ZOOM_options_get_int(scan->options, "stepSize", 0));
2121 req->databaseNames = set_DatabaseNames (c, scan->options,
2122 &req->num_databaseNames);
2124 return send_APDU (c, apdu);
2128 ZOOM_scanset_size (ZOOM_scanset scan)
2130 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2132 return scan->scan_response->entries->num_entries;
2135 ZOOM_API(const char *)
2136 ZOOM_scanset_term (ZOOM_scanset scan, size_t pos,
2139 const char *term = 0;
2140 size_t noent = ZOOM_scanset_size (scan);
2141 Z_ScanResponse *res = scan->scan_response;
2147 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2149 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2151 if (t->term->which == Z_Term_general)
2153 term = (const char *) t->term->u.general->buf;
2154 *len = t->term->u.general->len;
2156 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2161 ZOOM_API(const char *)
2162 ZOOM_scanset_display_term (ZOOM_scanset scan, size_t pos,
2165 const char *term = 0;
2166 size_t noent = ZOOM_scanset_size (scan);
2167 Z_ScanResponse *res = scan->scan_response;
2173 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2175 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2179 term = (const char *) t->term->u.general->buf;
2180 *len = strlen(term);
2182 else if (t->term->which == Z_Term_general)
2184 term = (const char *) t->term->u.general->buf;
2185 *len = t->term->u.general->len;
2187 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2192 ZOOM_API(const char *)
2193 ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key)
2195 return ZOOM_options_get (scan->options, key);
2199 ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
2202 ZOOM_options_set (scan->options, key, val);
2205 static Z_APDU *create_es_package (ZOOM_package p, int type)
2208 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2209 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2211 *req->function = Z_ExtendedServicesRequest_create;
2213 str = ZOOM_options_get(p->options, "package-name");
2215 req->packageName = nmem_strdup (p->odr_out->mem, str);
2217 str = ZOOM_options_get(p->options, "user-id");
2219 req->userId = nmem_strdup (p->odr_out->mem, str);
2221 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2224 str = ZOOM_options_get(p->options, "function");
2227 if (!strcmp (str, "create"))
2229 if (!strcmp (str, "delete"))
2231 if (!strcmp (str, "modify"))
2237 static const char *ill_array_lookup (void *clientData, const char *idx)
2239 ZOOM_package p = (ZOOM_package) clientData;
2240 return ZOOM_options_get (p->options, idx+4);
2243 static Z_External *encode_ill_request (ZOOM_package p)
2245 ODR out = p->odr_out;
2248 struct ill_get_ctl ctl;
2250 ctl.odr = p->odr_out;
2252 ctl.f = ill_array_lookup;
2254 req = ill_get_ILLRequest(&ctl, "ill", 0);
2256 if (!ill_Request (out, &req, 0, 0))
2258 int ill_request_size;
2259 char *ill_request_buf = odr_getbuf (out, &ill_request_size, 0);
2260 if (ill_request_buf)
2261 odr_setbuf (out, ill_request_buf, ill_request_size, 1);
2267 int illRequest_size = 0;
2268 char *illRequest_buf = odr_getbuf (out, &illRequest_size, 0);
2270 oid.proto = PROTO_GENERAL;
2271 oid.oclass = CLASS_GENERAL;
2272 oid.value = VAL_ISO_ILL_1;
2274 r = (Z_External *) odr_malloc (out, sizeof(*r));
2275 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2276 r->indirect_reference = 0;
2278 r->which = Z_External_single;
2280 r->u.single_ASN1_type = (Odr_oct *)
2281 odr_malloc (out, sizeof(*r->u.single_ASN1_type));
2282 r->u.single_ASN1_type->buf = (unsigned char*)
2283 odr_malloc (out, illRequest_size);
2284 r->u.single_ASN1_type->len = illRequest_size;
2285 r->u.single_ASN1_type->size = illRequest_size;
2286 memcpy (r->u.single_ASN1_type->buf, illRequest_buf, illRequest_size);
2291 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2293 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc (p->odr_out, sizeof(*req));
2296 req->which=Z_IOItemOrder_esRequest;
2297 req->u.esRequest = (Z_IORequest *)
2298 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2300 /* to keep part ... */
2301 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2302 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2303 req->u.esRequest->toKeep->supplDescription = 0;
2304 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2305 odr_malloc (p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2307 str = ZOOM_options_get(p->options, "contact-name");
2308 req->u.esRequest->toKeep->contact->name = str ?
2309 nmem_strdup (p->odr_out->mem, str) : 0;
2311 str = ZOOM_options_get(p->options, "contact-phone");
2312 req->u.esRequest->toKeep->contact->phone = str ?
2313 nmem_strdup (p->odr_out->mem, str) : 0;
2315 str = ZOOM_options_get(p->options, "contact-email");
2316 req->u.esRequest->toKeep->contact->email = str ?
2317 nmem_strdup (p->odr_out->mem, str) : 0;
2319 req->u.esRequest->toKeep->addlBilling = 0;
2321 /* not to keep part ... */
2322 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2323 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2325 str = ZOOM_options_get(p->options, "itemorder-setname");
2330 req->u.esRequest->notToKeep->resultSetItem = 0;
2333 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2334 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2336 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2337 nmem_strdup (p->odr_out->mem, str);
2338 req->u.esRequest->notToKeep->resultSetItem->item =
2339 (int *) odr_malloc(p->odr_out, sizeof(int));
2341 str = ZOOM_options_get(p->options, "itemorder-item");
2342 *req->u.esRequest->notToKeep->resultSetItem->item =
2343 (str ? atoi(str) : 1);
2345 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2350 Z_APDU *create_admin_package(ZOOM_package p, int type,
2351 Z_ESAdminOriginPartToKeep **toKeepP,
2352 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2354 Z_APDU *apdu = create_es_package (p, VAL_ADMINSERVICE);
2357 Z_ESAdminOriginPartToKeep *toKeep;
2358 Z_ESAdminOriginPartNotToKeep *notToKeep;
2359 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2360 const char *first_db = "Default";
2362 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2366 r->direct_reference =
2367 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2370 r->indirect_reference = 0;
2371 r->which = Z_External_ESAdmin;
2373 r->u.adminService = (Z_Admin *)
2374 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2375 r->u.adminService->which = Z_Admin_esRequest;
2376 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2377 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2379 toKeep = r->u.adminService->u.esRequest->toKeep =
2380 (Z_ESAdminOriginPartToKeep *)
2381 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2383 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2384 toKeep->u.create=odr_nullval();
2385 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2387 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2388 (Z_ESAdminOriginPartNotToKeep *)
2389 odr_malloc(p->odr_out,
2390 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2391 notToKeep->which=Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
2392 notToKeep->u.recordsWillFollow=odr_nullval();
2396 *notToKeepP = notToKeep;
2401 static Z_APDU *create_update_package(ZOOM_package p)
2404 const char *first_db = "Default";
2406 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2407 const char *action = ZOOM_options_get(p->options, "action");
2408 const char *recordId = ZOOM_options_get(p->options, "recordId");
2409 const char *record_buf = ZOOM_options_get(p->options, "record");
2410 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
2411 int syntax_oid = VAL_NONE;
2415 syntax_oid = oid_getvalbyname(syntax_str);
2418 record_buf = "void";
2419 syntax_oid = VAL_SUTRS;
2421 if (syntax_oid != VAL_NONE)
2422 syntax_oid = VAL_TEXT_XML;
2428 action = "specialUpdate";
2430 if (!strcmp(action, "recordInsert"))
2431 action_no = Z_IUOriginPartToKeep_recordInsert;
2432 else if (!strcmp(action, "recordReplace"))
2433 action_no = Z_IUOriginPartToKeep_recordReplace;
2434 else if (!strcmp(action, "recordDelete"))
2435 action_no = Z_IUOriginPartToKeep_recordDelete;
2436 else if (!strcmp(action, "elementUpdate"))
2437 action_no = Z_IUOriginPartToKeep_elementUpdate;
2438 else if (!strcmp(action, "specialUpdate"))
2439 action_no = Z_IUOriginPartToKeep_specialUpdate;
2443 apdu = create_es_package (p, VAL_DBUPDATE);
2446 Z_IUOriginPartToKeep *toKeep;
2447 Z_IUSuppliedRecords *notToKeep;
2448 Z_External *r = (Z_External *)
2449 odr_malloc (p->odr_out, sizeof(*r));
2451 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2453 r->direct_reference =
2454 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2457 r->which = Z_External_update;
2458 r->indirect_reference = 0;
2459 r->u.update = (Z_IUUpdate *)
2460 odr_malloc(p->odr_out, sizeof(*r->u.update));
2462 r->u.update->which = Z_IUUpdate_esRequest;
2463 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
2464 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
2465 toKeep = r->u.update->u.esRequest->toKeep =
2466 (Z_IUOriginPartToKeep *)
2467 odr_malloc(p->odr_out, sizeof(*toKeep));
2469 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2471 toKeep->elementSetName = 0;
2472 toKeep->actionQualifier = 0;
2473 toKeep->action = odr_intdup(p->odr_out, action_no);
2475 notToKeep = r->u.update->u.esRequest->notToKeep =
2476 (Z_IUSuppliedRecords *)
2477 odr_malloc(p->odr_out, sizeof(*notToKeep));
2479 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
2480 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
2481 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
2482 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
2483 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
2486 notToKeep->elements[0]->u.opaque = (Odr_oct *)
2487 odr_malloc (p->odr_out, sizeof(Odr_oct));
2488 notToKeep->elements[0]->u.opaque->size = strlen(recordId);
2489 notToKeep->elements[0]->u.opaque->len = strlen(recordId);
2490 notToKeep->elements[0]->u.opaque->buf =
2491 odr_strdup(p->odr_out, recordId);
2494 notToKeep->elements[0]->u.opaque = 0;
2495 notToKeep->elements[0]->supplementalId = 0;
2496 notToKeep->elements[0]->correlationInfo = 0;
2497 notToKeep->elements[0]->record =
2498 z_ext_record(p->odr_out, syntax_oid,
2499 record_buf, strlen(record_buf));
2503 ODR print = odr_createmem(ODR_PRINT);
2505 z_APDU(print, &apdu, 0, 0);
2512 ZOOM_package_send (ZOOM_package p, const char *type)
2519 odr_reset (p->odr_out);
2522 if (!strcmp(type, "itemorder"))
2524 apdu = create_es_package (p, VAL_ITEMORDER);
2527 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2529 r->direct_reference =
2530 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2533 r->which = Z_External_itemOrder;
2534 r->indirect_reference = 0;
2535 r->u.itemOrder = encode_item_order (p);
2537 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2540 if (!strcmp(type, "create")) /* create database */
2542 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
2545 if (!strcmp(type, "drop")) /* drop database */
2547 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
2550 if (!strcmp(type, "update")) /* update record(s) */
2552 apdu = create_update_package(p);
2556 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
2560 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_PACKAGE);
2561 task->u.package = p;
2562 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
2563 p->buf_out = (char *) xmalloc (p->len_out);
2564 memcpy (p->buf_out, buf, p->len_out);
2569 while (ZOOM_event (1, &c))
2576 ZOOM_API(ZOOM_package)
2577 ZOOM_connection_package (ZOOM_connection c, ZOOM_options options)
2579 ZOOM_package p = (ZOOM_package) xmalloc (sizeof(*p));
2582 p->odr_out = odr_createmem (ODR_ENCODE);
2583 p->options = ZOOM_options_create_with_parent2 (options, c->options);
2591 ZOOM_package_destroy(ZOOM_package p)
2596 if (p->refcount == 0)
2598 odr_destroy (p->odr_out);
2601 ZOOM_options_destroy (p->options);
2606 ZOOM_API(const char *)
2607 ZOOM_package_option_get (ZOOM_package p, const char *key)
2609 return ZOOM_options_get (p->options, key);
2614 ZOOM_package_option_set (ZOOM_package p, const char *key,
2617 ZOOM_options_set (p->options, key, val);
2620 static int ZOOM_connection_exec_task (ZOOM_connection c)
2622 ZOOM_task task = c->tasks;
2623 zoom_ret ret = zoom_complete;
2627 yaz_log (LOG_DEBUG, "ZOOM_connection_exec_task task=<null>");
2630 yaz_log (LOG_DEBUG, "ZOOM_connection_exec_task type=%d run=%d",
2631 task->which, task->running);
2632 if (c->error != ZOOM_ERROR_NONE)
2634 yaz_log (LOG_DEBUG, "remove tasks because of error = %d", c->error);
2635 ZOOM_connection_remove_tasks (c);
2640 yaz_log (LOG_DEBUG, "task already running");
2644 ret = zoom_complete;
2645 if (c->cs || task->which == ZOOM_TASK_CONNECT)
2647 switch (task->which)
2649 case ZOOM_TASK_SEARCH:
2650 if (c->proto == PROTO_HTTP)
2651 ret = ZOOM_connection_srw_send_search(c);
2653 ret = ZOOM_connection_send_search(c);
2655 case ZOOM_TASK_RETRIEVE:
2656 if (c->proto == PROTO_HTTP)
2657 ret = ZOOM_connection_srw_send_search(c);
2659 ret = send_present (c);
2661 case ZOOM_TASK_CONNECT:
2662 ret = do_connect(c);
2664 case ZOOM_TASK_SCAN:
2667 case ZOOM_TASK_PACKAGE:
2668 ret = send_package(c);
2674 yaz_log (LOG_DEBUG, "remove tasks because no connection exist");
2675 ZOOM_connection_remove_tasks (c);
2677 if (ret == zoom_complete)
2679 yaz_log (LOG_DEBUG, "task removed (complete)");
2680 ZOOM_connection_remove_task (c);
2683 yaz_log (LOG_DEBUG, "task pending");
2687 static zoom_ret send_sort_present (ZOOM_connection c)
2689 zoom_ret r = send_sort (c);
2690 if (r == zoom_complete)
2691 r = send_present (c);
2695 static int es_response (ZOOM_connection c,
2696 Z_ExtendedServicesResponse *res)
2698 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
2700 if (res->diagnostics && res->num_diagnostics > 0)
2701 response_diag(c, res->diagnostics[0]);
2702 if (res->taskPackage &&
2703 res->taskPackage->which == Z_External_extendedService)
2705 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
2706 Odr_oct *id = taskPackage->targetReference;
2709 ZOOM_options_setl (c->tasks->u.package->options,
2710 "targetReference", (char*) id->buf, id->len);
2716 static void handle_apdu (ZOOM_connection c, Z_APDU *apdu)
2718 Z_InitResponse *initrs;
2721 yaz_log (LOG_DEBUG, "recv APDU type=%d", apdu->which);
2724 case Z_APDU_initResponse:
2725 initrs = apdu->u.initResponse;
2726 ZOOM_connection_option_set(c, "serverImplementationId",
2727 initrs->implementationId ?
2728 initrs->implementationId : "");
2729 ZOOM_connection_option_set(c, "serverImplementationName",
2730 initrs->implementationName ?
2731 initrs->implementationName : "");
2732 ZOOM_connection_option_set(c, "serverImplementationVersion",
2733 initrs->implementationVersion ?
2734 initrs->implementationVersion : "");
2735 /* Set the three old options too, for old applications */
2736 ZOOM_connection_option_set(c, "targetImplementationId",
2737 initrs->implementationId ?
2738 initrs->implementationId : "");
2739 ZOOM_connection_option_set(c, "targetImplementationName",
2740 initrs->implementationName ?
2741 initrs->implementationName : "");
2742 ZOOM_connection_option_set(c, "targetImplementationVersion",
2743 initrs->implementationVersion ?
2744 initrs->implementationVersion : "");
2745 if (!*initrs->result)
2747 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0);
2752 yaz_oi_get_string_oidval (&apdu->u.initResponse->otherInfo,
2754 xfree (c->cookie_in);
2757 c->cookie_in = xstrdup(cookie);
2758 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
2759 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
2760 c->support_named_resultsets = 1;
2763 assert (c->tasks->which == ZOOM_TASK_CONNECT);
2764 ZOOM_connection_remove_task (c);
2766 ZOOM_connection_exec_task (c);
2768 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
2770 NMEM tmpmem = nmem_create();
2771 Z_CharSetandLanguageNegotiation *p =
2772 yaz_get_charneg_record(initrs->otherInfo);
2776 char *charset=NULL, *lang=NULL;
2779 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
2780 yaz_log(LOG_DEBUG, "Target accepted: charset %s, "
2781 "language %s, select %d",
2782 charset ? charset : "none", lang ? lang : "none", sel);
2784 ZOOM_connection_option_set (c, "negotiation-charset",
2787 ZOOM_connection_option_set (c, "negotiation-lang",
2789 nmem_destroy(tmpmem);
2793 case Z_APDU_searchResponse:
2794 handle_search_response (c, apdu->u.searchResponse);
2795 if (send_sort_present (c) == zoom_complete)
2796 ZOOM_connection_remove_task (c);
2798 case Z_APDU_presentResponse:
2799 handle_present_response (c, apdu->u.presentResponse);
2800 if (send_present (c) == zoom_complete)
2801 ZOOM_connection_remove_task (c);
2803 case Z_APDU_sortResponse:
2804 sort_response (c, apdu->u.sortResponse);
2805 if (send_present (c) == zoom_complete)
2806 ZOOM_connection_remove_task (c);
2808 case Z_APDU_scanResponse:
2809 scan_response (c, apdu->u.scanResponse);
2810 ZOOM_connection_remove_task (c);
2812 case Z_APDU_extendedServicesResponse:
2813 es_response (c, apdu->u.extendedServicesResponse);
2814 ZOOM_connection_remove_task (c);
2817 if (c->reconnect_ok)
2820 c->tasks->running = 0;
2821 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
2825 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, 0);
2830 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2836 static void handle_srw_response(ZOOM_connection c,
2837 Z_SRW_searchRetrieveResponse *res)
2839 ZOOM_resultset resultset = 0;
2847 if (c->tasks->which == ZOOM_TASK_SEARCH)
2848 resultset = c->tasks->u.search.resultset;
2849 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
2850 resultset = c->tasks->u.retrieve.resultset;
2854 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2855 ZOOM_connection_put_event(c, event);
2857 resultset->size = 0;
2859 yaz_log(LOG_DEBUG, "got SRW response OK");
2861 if (res->numberOfRecords)
2862 resultset->size = *res->numberOfRecords;
2864 for (i = 0; i<res->num_records; i++)
2868 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
2869 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
2871 if (res->records[i].recordPosition &&
2872 *res->records[i].recordPosition > 0)
2873 pos = *res->records[i].recordPosition - 1;
2875 pos = resultset->start + i;
2877 npr->databaseName = 0;
2878 npr->which = Z_NamePlusRecord_databaseRecord;
2879 npr->u.databaseRecord = (Z_External *)
2880 odr_malloc(c->odr_in, sizeof(Z_External));
2881 npr->u.databaseRecord->descriptor = 0;
2882 npr->u.databaseRecord->direct_reference =
2883 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
2884 npr->u.databaseRecord->which = Z_External_octet;
2885 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
2886 odr_malloc(c->odr_in, sizeof(Odr_oct));
2887 npr->u.databaseRecord->u.octet_aligned->buf =
2888 res->records[i].recordData_buf;
2889 npr->u.databaseRecord->u.octet_aligned->len =
2890 npr->u.databaseRecord->u.octet_aligned->size =
2891 res->records[i].recordData_len;
2892 record_cache_add (resultset, npr, pos);
2894 if (res->num_diagnostics > 0)
2896 set_dset_error(c, *res->diagnostics[0].code, "SRW",
2897 res->diagnostics[0].details, 0);
2899 nmem = odr_extract_mem(c->odr_in);
2900 nmem_transfer(resultset->odr->mem, nmem);
2906 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
2909 const char *content_type = z_HTTP_header_lookup(hres->headers,
2911 const char *connection_head = z_HTTP_header_lookup(hres->headers,
2914 yaz_log (LOG_DEBUG, "handle_http");
2916 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
2918 Z_SOAP *soap_package = 0;
2919 ODR o = odr_createmem(ODR_DECODE);
2920 Z_SOAP_Handler soap_handlers[2] = {
2921 {"http://www.loc.gov/zing/srw/v1.0/", 0,
2922 (Z_SOAP_fun) yaz_srw_codec},
2925 ret = z_soap_codec(o, &soap_package,
2926 &hres->content_buf, &hres->content_len,
2928 if (!ret && soap_package->which == Z_SOAP_generic &&
2929 soap_package->u.generic->no == 0)
2931 Z_SRW_PDU *sr = soap_package->u.generic->p;
2932 if (sr->which == Z_SRW_searchRetrieve_response)
2933 handle_srw_response(c, sr->u.response);
2937 else if (!ret && (soap_package->which == Z_SOAP_fault
2938 || soap_package->which == Z_SOAP_error))
2940 set_HTTP_error(c, hres->code,
2941 soap_package->u.fault->fault_code,
2942 soap_package->u.fault->fault_string);
2950 if (hres->code != 200)
2951 set_HTTP_error(c, hres->code, 0, 0);
2953 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2956 ZOOM_connection_remove_task(c);
2957 if (!strcmp(hres->version, "1.0"))
2959 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
2960 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
2965 /* HTTP 1.1: only if no close we stay alive .. */
2966 if (connection_head && !strcmp(connection_head, "close"))
2972 static int do_read (ZOOM_connection c)
2977 event = ZOOM_Event_create (ZOOM_EVENT_RECV_DATA);
2978 ZOOM_connection_put_event (c, event);
2980 r = cs_get (c->cs, &c->buf_in, &c->len_in);
2981 more = cs_more(c->cs);
2982 yaz_log (LOG_DEBUG, "do_read len=%d more=%d", r, more);
2987 if (c->reconnect_ok)
2990 c->reconnect_ok = 0;
2991 yaz_log (LOG_DEBUG, "reconnect read");
2992 c->tasks->running = 0;
2993 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
2997 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, 0);
3006 odr_reset (c->odr_in);
3007 odr_setbuf (c->odr_in, c->buf_in, r, 0);
3008 event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);
3009 ZOOM_connection_put_event (c, event);
3011 if (!z_GDU (c->odr_in, &gdu, 0, 0))
3014 int err = odr_geterrorx(c->odr_in, &x);
3016 const char *element = odr_getelement(c->odr_in);
3017 sprintf (msg, "ODR code %d:%d element=%-20s",
3018 err, x, element ? element : "<unknown>");
3019 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3022 else if (gdu->which == Z_GDU_Z3950)
3023 handle_apdu (c, gdu->u.z3950);
3024 else if (gdu->which == Z_GDU_HTTP_Response)
3027 handle_http (c, gdu->u.HTTP_Response);
3029 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3033 c->reconnect_ok = 0;
3038 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out)
3043 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3044 ZOOM_connection_put_event (c, event);
3046 yaz_log (LOG_DEBUG, "do_write_ex len=%d", len_out);
3047 if ((r=cs_put (c->cs, buf_out, len_out)) < 0)
3049 if (c->reconnect_ok)
3052 c->reconnect_ok = 0;
3053 yaz_log (LOG_DEBUG, "reconnect write");
3054 c->tasks->running = 0;
3055 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3056 return zoom_pending;
3058 if (c->state == STATE_CONNECTING)
3059 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, 0);
3061 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, 0);
3063 return zoom_complete;
3067 c->mask = ZOOM_SELECT_EXCEPT;
3068 if (c->cs->io_pending & CS_WANT_WRITE)
3069 c->mask += ZOOM_SELECT_WRITE;
3070 if (c->cs->io_pending & CS_WANT_READ)
3071 c->mask += ZOOM_SELECT_READ;
3072 yaz_log (LOG_DEBUG, "do_write_ex 1 mask=%d", c->mask);
3076 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3077 yaz_log (LOG_DEBUG, "do_write_ex 2 mask=%d", c->mask);
3079 return zoom_pending;
3082 static zoom_ret do_write(ZOOM_connection c)
3084 return do_write_ex (c, c->buf_out, c->len_out);
3088 ZOOM_API(const char *)
3089 ZOOM_connection_option_get (ZOOM_connection c, const char *key)
3091 return ZOOM_options_get (c->options, key);
3095 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
3098 ZOOM_options_set (c->options, key, val);
3101 ZOOM_API(const char *)
3102 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key)
3104 return ZOOM_options_get (r->options, key);
3108 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key,
3111 ZOOM_options_set (r->options, key, val);
3116 ZOOM_connection_errcode (ZOOM_connection c)
3118 return ZOOM_connection_error (c, 0, 0);
3121 ZOOM_API(const char *)
3122 ZOOM_connection_errmsg (ZOOM_connection c)
3125 ZOOM_connection_error (c, &msg, 0);
3129 ZOOM_API(const char *)
3130 ZOOM_connection_addinfo (ZOOM_connection c)
3132 const char *addinfo;
3133 ZOOM_connection_error (c, 0, &addinfo);
3137 ZOOM_API(const char *)
3138 ZOOM_diag_str (int error)
3142 case ZOOM_ERROR_NONE:
3144 case ZOOM_ERROR_CONNECT:
3145 return "Connect failed";
3146 case ZOOM_ERROR_MEMORY:
3147 return "Out of memory";
3148 case ZOOM_ERROR_ENCODE:
3149 return "Encoding failed";
3150 case ZOOM_ERROR_DECODE:
3151 return "Decoding failed";
3152 case ZOOM_ERROR_CONNECTION_LOST:
3153 return "Connection lost";
3154 case ZOOM_ERROR_INIT:
3155 return "Init rejected";
3156 case ZOOM_ERROR_INTERNAL:
3157 return "Internal failure";
3158 case ZOOM_ERROR_TIMEOUT:
3160 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3161 return "Unsupported protocol";
3162 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3163 return "Unsupported query type";
3165 return diagbib1_str (error);
3170 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
3171 const char **addinfo, const char **diagset)
3173 int error = c->error;
3176 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3177 *cp = ZOOM_diag_str(error);
3178 else if (!strcmp(c->diagset, "HTTP"))
3179 *cp = z_HTTP_errmsg(c->error);
3180 else if (!strcmp(c->diagset, "Bib-1"))
3181 *cp = ZOOM_diag_str(error);
3182 else if (!strcmp(c->diagset, "SRW"))
3183 *cp = yaz_diag_srw_str(c->error);
3185 *cp = "Unknown error and diagnostic set";
3188 *addinfo = c->addinfo ? c->addinfo : "";
3190 *diagset = c->diagset ? c->diagset : "";
3195 ZOOM_connection_error (ZOOM_connection c, const char **cp,
3196 const char **addinfo)
3198 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3201 static int ZOOM_connection_do_io(ZOOM_connection c, int mask)
3203 ZOOM_Event event = 0;
3204 int r = cs_look(c->cs);
3205 yaz_log (LOG_DEBUG, "ZOOM_connection_do_io c=%p mask=%d cs_look=%d",
3210 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3211 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, 0);
3213 ZOOM_connection_put_event (c, event);
3215 else if (r == CS_CONNECT)
3218 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3220 ret = cs_rcvconnect (c->cs);
3221 yaz_log (LOG_DEBUG, "cs_rcvconnect returned %d", ret);
3224 c->mask = ZOOM_SELECT_EXCEPT;
3225 if (c->cs->io_pending & CS_WANT_WRITE)
3226 c->mask += ZOOM_SELECT_WRITE;
3227 if (c->cs->io_pending & CS_WANT_READ)
3228 c->mask += ZOOM_SELECT_READ;
3229 ZOOM_connection_put_event (c, event);
3233 ZOOM_connection_put_event (c, event);
3234 if (c->proto == PROTO_Z3950)
3235 ZOOM_connection_send_init(c);
3238 /* no init request for SRW .. */
3239 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3240 ZOOM_connection_remove_task (c);
3242 ZOOM_connection_exec_task (c);
3244 c->state = STATE_ESTABLISHED;
3248 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, 0);
3250 ZOOM_connection_put_event (c, event);
3255 if (mask & ZOOM_SELECT_READ)
3257 if (c->cs && (mask & ZOOM_SELECT_WRITE))
3264 ZOOM_connection_last_event(ZOOM_connection cs)
3267 return ZOOM_EVENT_NONE;
3268 return cs->last_event;
3272 ZOOM_event (int no, ZOOM_connection *cs)
3276 struct pollfd pollfds[1024];
3277 ZOOM_connection poll_cs[1024];
3280 fd_set input, output, except;
3285 for (i = 0; i<no; i++)
3287 ZOOM_connection c = cs[i];
3289 if (c && (event = ZOOM_connection_get_event(c)))
3291 ZOOM_Event_destroy (event);
3295 for (i = 0; i<no; i++)
3297 ZOOM_connection c = cs[i];
3299 if (c && ZOOM_connection_exec_task (c))
3301 if ((event = ZOOM_connection_get_event(c)))
3303 ZOOM_Event_destroy (event);
3316 for (i = 0; i<no; i++)
3318 ZOOM_connection c = cs[i];
3324 fd = z3950_connection_socket(c);
3325 mask = z3950_connection_mask(c);
3332 this_timeout = ZOOM_options_get_int (c->options, "timeout", -1);
3333 if (this_timeout != -1 && this_timeout < timeout)
3334 timeout = this_timeout;
3338 short poll_events = 0;
3340 if (mask & ZOOM_SELECT_READ)
3341 poll_events += POLLIN;
3342 if (mask & ZOOM_SELECT_WRITE)
3343 poll_events += POLLOUT;
3344 if (mask & ZOOM_SELECT_EXCEPT)
3345 poll_events += POLLERR;
3346 pollfds[nfds].fd = fd;
3347 pollfds[nfds].events = poll_events;
3348 pollfds[nfds].revents = 0;
3353 if (mask & ZOOM_SELECT_READ)
3355 FD_SET (fd, &input);
3358 if (mask & ZOOM_SELECT_WRITE)
3360 FD_SET (fd, &output);
3363 if (mask & ZOOM_SELECT_EXCEPT)
3365 FD_SET (fd, &except);
3370 if (timeout >= 5000)
3377 r = poll (pollfds, nfds, timeout * 1000);
3378 for (i = 0; i<nfds; i++)
3380 ZOOM_connection c = poll_cs[i];
3384 if (pollfds[i].revents & POLLIN)
3385 mask += ZOOM_SELECT_READ;
3386 if (pollfds[i].revents & POLLOUT)
3387 mask += ZOOM_SELECT_WRITE;
3388 if (pollfds[i].revents & POLLERR)
3389 mask += ZOOM_SELECT_EXCEPT;
3391 ZOOM_connection_do_io(c, mask);
3393 else if (r == 0 && c->mask)
3395 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3396 /* timeout and this connection was waiting */
3397 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3399 ZOOM_connection_put_event(c, event);
3403 tv.tv_sec = timeout;
3405 yaz_log (LOG_DEBUG, "select start");
3406 r = select (max_fd+1, &input, &output, &except, &tv);
3407 yaz_log (LOG_DEBUG, "select stop, returned r=%d", r);
3408 for (i = 0; i<no; i++)
3410 ZOOM_connection c = cs[i];
3415 fd = z3950_connection_socket(c);
3419 /* no timeout and real socket */
3420 if (FD_ISSET(fd, &input))
3421 mask += ZOOM_SELECT_READ;
3422 if (FD_ISSET(fd, &output))
3423 mask += ZOOM_SELECT_WRITE;
3424 if (FD_ISSET(fd, &except))
3425 mask += ZOOM_SELECT_EXCEPT;
3427 ZOOM_connection_do_io(c, mask);
3429 if (r == 0 && c->mask)
3431 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3432 /* timeout and this connection was waiting */
3433 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3435 yaz_log (LOG_DEBUG, "timeout");
3436 ZOOM_connection_put_event(c, event);
3440 for (i = 0; i<no; i++)
3442 ZOOM_connection c = cs[i];
3444 if (c && (event = ZOOM_connection_get_event(c)))
3446 ZOOM_Event_destroy (event);