2 * Copyright (c) 2000-2004, Index Data
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.22 2004-01-27 21:22:44 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 (c->diagset && strcmp(dset, c->diagset))
100 c->diagset = xstrdup(dset);
101 /* remove integer part from SRW diagset .. */
102 if ((cp = strrchr(c->diagset, '/')))
105 if (addinfo && addinfo2)
107 c->addinfo = xmalloc(strlen(addinfo) + strlen(addinfo2) + 2);
108 strcpy(c->addinfo, addinfo);
109 strcat(c->addinfo, addinfo2);
112 c->addinfo = xstrdup(addinfo);
114 yaz_log(LOG_DEBUG, "Error %s %s:%d %s %s",
115 c->host_port ? c->host_port : "<>", dset, error,
116 addinfo ? addinfo : "",
117 addinfo2 ? addinfo2 : "");
121 static void set_HTTP_error (ZOOM_connection c, int error,
122 const char *addinfo, const char *addinfo2)
124 set_dset_error(c, error, "HTTP", addinfo, addinfo2);
128 static void set_ZOOM_error (ZOOM_connection c, int error,
131 set_dset_error(c, error, "ZOOM", addinfo, 0);
134 static void clear_error (ZOOM_connection c)
139 case ZOOM_ERROR_CONNECT:
140 case ZOOM_ERROR_MEMORY:
141 case ZOOM_ERROR_DECODE:
142 case ZOOM_ERROR_CONNECTION_LOST:
143 case ZOOM_ERROR_INIT:
144 case ZOOM_ERROR_INTERNAL:
145 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
148 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
152 ZOOM_task ZOOM_connection_add_task (ZOOM_connection c, int which)
154 ZOOM_task *taskp = &c->tasks;
156 taskp = &(*taskp)->next;
157 *taskp = (ZOOM_task) xmalloc (sizeof(**taskp));
158 (*taskp)->running = 0;
159 (*taskp)->which = which;
165 ZOOM_task ZOOM_connection_insert_task (ZOOM_connection c, int which)
167 ZOOM_task task = (ZOOM_task) xmalloc (sizeof(*task));
169 task->next = c->tasks;
178 void ZOOM_connection_remove_task (ZOOM_connection c)
180 ZOOM_task task = c->tasks;
184 c->tasks = task->next;
187 case ZOOM_TASK_SEARCH:
189 ZOOM_resultset_destroy (task->u.search.resultset);
191 case ZOOM_TASK_RETRIEVE:
192 ZOOM_resultset_destroy (task->u.retrieve.resultset);
194 case ZOOM_TASK_CONNECT:
197 ZOOM_scanset_destroy (task->u.scan.scan);
199 case ZOOM_TASK_PACKAGE:
200 ZOOM_package_destroy (task->u.package);
209 static int ZOOM_connection_exec_task (ZOOM_connection c);
211 void ZOOM_connection_remove_tasks (ZOOM_connection c)
214 ZOOM_connection_remove_task(c);
217 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos);
219 ZOOM_API(ZOOM_connection)
220 ZOOM_connection_create (ZOOM_options options)
222 ZOOM_connection c = (ZOOM_connection) xmalloc (sizeof(*c));
224 c->proto = PROTO_Z3950;
228 c->state = STATE_IDLE;
231 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
238 c->options = ZOOM_options_create_with_parent(options);
244 c->charset = c->lang = 0;
251 c->odr_in = odr_createmem (ODR_DECODE);
252 c->odr_out = odr_createmem (ODR_ENCODE);
255 c->support_named_resultsets = 0;
256 c->last_event = ZOOM_EVENT_NONE;
258 c->m_queue_front = 0;
263 /* set database names. Take local databases (if set); otherwise
264 take databases given in ZURL (if set); otherwise use Default */
265 static char **set_DatabaseNames (ZOOM_connection con, ZOOM_options options,
268 char **databaseNames;
271 const char *cp = ZOOM_options_get (options, "databaseName");
275 if (strncmp (con->host_port, "unix:", 5) == 0)
276 cp = strchr (con->host_port+5, ':');
278 cp = strchr (con->host_port, '/');
285 while ((c = strchr(c, '+')))
293 databaseNames = (char**)
294 odr_malloc (con->odr_out, no * sizeof(*databaseNames));
298 c = strchr (cp, '+');
306 /* cp ptr to first char of db name, c is char
308 databaseNames[no] = (char*) odr_malloc (con->odr_out, 1+c-cp);
309 memcpy (databaseNames[no], cp, c-cp);
310 databaseNames[no++][c-cp] = '\0';
315 databaseNames[no] = NULL;
317 return databaseNames;
320 ZOOM_API(ZOOM_connection)
321 ZOOM_connection_new (const char *host, int portnum)
323 ZOOM_connection c = ZOOM_connection_create (0);
325 ZOOM_connection_connect (c, host, portnum);
330 ZOOM_connection_connect(ZOOM_connection c,
331 const char *host, int portnum)
338 yaz_log (LOG_DEBUG, "reconnect");
342 yaz_log(LOG_DEBUG, "connect");
344 val = ZOOM_options_get (c->options, "proxy");
346 c->proxy = xstrdup (val);
351 val = ZOOM_options_get (c->options, "charset");
353 c->charset = xstrdup (val);
358 val = ZOOM_options_get (c->options, "lang");
360 c->lang = xstrdup (val);
364 xfree (c->host_port);
368 sprintf (hostn, "%.80s:%d", host, portnum);
369 c->host_port = xstrdup(hostn);
372 c->host_port = xstrdup(host);
374 ZOOM_options_set(c->options, "host", c->host_port);
376 val = ZOOM_options_get (c->options, "cookie");
378 c->cookie_out = xstrdup (val);
380 val = ZOOM_options_get (c->options, "clientIP");
382 c->client_IP = xstrdup (val);
384 c->async = ZOOM_options_get_bool (c->options, "async", 0);
386 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
388 task = ZOOM_connection_add_task (c, ZOOM_TASK_CONNECT);
392 while (ZOOM_event (1, &c))
398 ZOOM_query_create(void)
400 ZOOM_query s = (ZOOM_query) xmalloc (sizeof(*s));
405 s->odr = odr_createmem (ODR_ENCODE);
412 ZOOM_query_destroy(ZOOM_query s)
418 yaz_log (LOG_DEBUG, "ZOOM_query_destroy count=%d", s->refcount);
419 if (s->refcount == 0)
421 odr_destroy (s->odr);
427 ZOOM_query_prefix(ZOOM_query s, const char *str)
429 s->query_string = odr_strdup(s->odr, str);
430 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
431 s->z_query->which = Z_Query_type_1;
432 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
433 if (!s->z_query->u.type_1)
439 ZOOM_query_cql(ZOOM_query s, const char *str)
443 s->query_string = odr_strdup(s->odr, str);
445 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
446 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
447 ext->indirect_reference = 0;
449 ext->which = Z_External_CQL;
450 ext->u.cql = s->query_string;
452 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
453 s->z_query->which = Z_Query_type_104;
454 s->z_query->u.type_104 = ext;
460 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
462 s->sort_spec = yaz_sort_spec (s->odr, criteria);
468 static zoom_ret do_write(ZOOM_connection c);
471 ZOOM_connection_destroy(ZOOM_connection c)
478 for (r = c->resultsets; r; r = r->next)
484 odr_destroy (c->odr_in);
485 odr_destroy (c->odr_out);
486 ZOOM_options_destroy (c->options);
487 ZOOM_connection_remove_tasks (c);
488 xfree (c->host_port);
493 xfree (c->cookie_out);
494 xfree (c->cookie_in);
495 xfree (c->client_IP);
499 void ZOOM_resultset_addref (ZOOM_resultset r)
504 yaz_log (LOG_DEBUG, "ZOOM_resultset_addref r=%p count=%d",
508 ZOOM_resultset ZOOM_resultset_create ()
510 ZOOM_resultset r = (ZOOM_resultset) xmalloc (sizeof(*r));
512 yaz_log (LOG_DEBUG, "ZOOM_resultset_create r = %p", r);
515 r->odr = odr_createmem (ODR_ENCODE);
530 ZOOM_API(ZOOM_resultset)
531 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
534 ZOOM_query s = ZOOM_query_create();
536 ZOOM_query_prefix (s, q);
538 r = ZOOM_connection_search (c, s);
539 ZOOM_query_destroy (s);
543 ZOOM_API(ZOOM_resultset)
544 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
546 ZOOM_resultset r = ZOOM_resultset_create ();
550 r->r_sort_spec = q->sort_spec;
553 r->options = ZOOM_options_create_with_parent(c->options);
555 r->start = ZOOM_options_get_int(r->options, "start", 0);
556 r->count = ZOOM_options_get_int(r->options, "count", 0);
558 /* If "presentChunk" is defined use that; otherwise "step" */
559 const char *cp = ZOOM_options_get (r->options, "presentChunk");
560 r->step = ZOOM_options_get_int(r->options,
561 (cp != 0 ? "presentChunk": "step"), 0);
563 r->piggyback = ZOOM_options_get_bool (r->options, "piggyback", 1);
564 cp = ZOOM_options_get (r->options, "setname");
566 r->setname = xstrdup(cp);
567 cp = ZOOM_options_get (r->options, "schema");
569 r->schema = xstrdup(cp);
573 r->next = c->resultsets;
576 if (c->host_port && c->proto == PROTO_HTTP)
580 yaz_log(LOG_DEBUG, "NO COMSTACK");
581 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
585 yaz_log(LOG_DEBUG, "PREPARE FOR RECONNECT");
590 task = ZOOM_connection_add_task (c, ZOOM_TASK_SEARCH);
591 task->u.search.resultset = r;
592 ZOOM_resultset_addref (r);
598 while (ZOOM_event (1, &c))
605 ZOOM_resultset_destroy(ZOOM_resultset r)
610 yaz_log (LOG_DEBUG, "ZOOM_resultset_destroy r = %p count=%d",
612 if (r->refcount == 0)
614 ZOOM_record_cache rc;
616 for (rc = r->record_cache; rc; rc = rc->next)
618 if (rc->rec.wrbuf_marc)
619 wrbuf_free (rc->rec.wrbuf_marc, 1);
620 if (rc->rec.wrbuf_iconv)
621 wrbuf_free (rc->rec.wrbuf_iconv, 1);
622 if (rc->rec.wrbuf_opac)
623 wrbuf_free (rc->rec.wrbuf_opac, 1);
627 /* remove ourselves from the resultsets in connection */
628 ZOOM_resultset *rp = &r->connection->resultsets;
631 assert (*rp); /* we must be in this list!! */
633 { /* OK, we're here - take us out of it */
640 ZOOM_query_destroy (r->query);
641 ZOOM_options_destroy (r->options);
642 odr_destroy (r->odr);
650 ZOOM_resultset_size (ZOOM_resultset r)
655 static void do_close (ZOOM_connection c)
661 c->state = STATE_IDLE;
664 static void ZOOM_resultset_retrieve (ZOOM_resultset r,
665 int force_sync, int start, int count)
677 if (c->host_port && c->proto == PROTO_HTTP)
681 yaz_log(LOG_DEBUG, "NO COMSTACK");
682 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
686 yaz_log(LOG_DEBUG, "PREPARE FOR RECONNECT");
690 task = ZOOM_connection_add_task (c, ZOOM_TASK_RETRIEVE);
691 task->u.retrieve.resultset = r;
692 task->u.retrieve.start = start;
693 task->u.retrieve.count = count;
695 cp = ZOOM_options_get (r->options, "schema");
698 if (!r->schema || strcmp(r->schema, cp))
701 r->schema = xstrdup(cp);
705 ZOOM_resultset_addref (r);
707 if (!r->connection->async || force_sync)
708 while (r->connection && ZOOM_event (1, &r->connection))
713 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
714 size_t start, size_t count)
716 int force_present = 0;
722 ZOOM_resultset_retrieve (r, force_present, start, count);
726 for (i = 0; i< count; i++)
727 recs[i] = ZOOM_resultset_record_immediate (r, i+start);
731 static zoom_ret do_connect (ZOOM_connection c)
734 const char *effective_host;
737 effective_host = c->proxy;
739 effective_host = c->host_port;
741 yaz_log (LOG_DEBUG, "do_connect host=%s", effective_host);
744 c->cs = cs_create_host (effective_host, 0, &add);
746 if (c->cs && c->cs->protocol == PROTO_HTTP)
749 const char *path = 0;
751 c->proto = PROTO_HTTP;
752 cs_get_host_args(c->host_port, &path);
754 c->path = xmalloc(strlen(path)+2);
756 strcpy (c->path+1, path);
758 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
760 return zoom_complete;
765 int ret = cs_connect (c->cs, add);
768 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
769 ZOOM_connection_put_event(c, event);
770 if (c->proto == PROTO_Z3950)
771 ZOOM_connection_send_init(c);
774 /* no init request for SRW .. */
775 assert (c->tasks->which == ZOOM_TASK_CONNECT);
776 ZOOM_connection_remove_task (c);
778 ZOOM_connection_exec_task (c);
780 c->state = STATE_ESTABLISHED;
785 c->state = STATE_CONNECTING;
786 c->mask = ZOOM_SELECT_EXCEPT;
787 if (c->cs->io_pending & CS_WANT_WRITE)
788 c->mask += ZOOM_SELECT_WRITE;
789 if (c->cs->io_pending & CS_WANT_READ)
790 c->mask += ZOOM_SELECT_READ;
794 c->state = STATE_IDLE;
795 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, effective_host);
796 return zoom_complete;
799 int z3950_connection_socket(ZOOM_connection c)
802 return cs_fileno(c->cs);
806 int z3950_connection_mask(ZOOM_connection c)
813 static void otherInfo_attach (ZOOM_connection c, Z_APDU *a, ODR out)
816 for (i = 0; i<200; i++)
819 Z_OtherInformation **oi;
825 sprintf (buf, "otherInfo%d", i);
826 val = ZOOM_options_get (c->options, buf);
829 cp = strchr (val, ':');
833 if (len >= sizeof(buf))
835 memcpy (buf, val, len);
837 oidval = oid_getvalbyname (buf);
838 if (oidval == VAL_NONE)
842 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
846 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
851 Z_OtherInformation **oi;
853 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
857 Z_OtherInformation **oi;
859 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
861 otherInfo_attach (c, a, out);
862 if (!z_APDU(out, &a, 0, 0))
864 FILE *outf = fopen("/tmp/apdu.txt", "a");
867 ODR odr_pr = odr_createmem(ODR_PRINT);
868 fprintf (outf, "a=%p\n", a);
869 odr_setprint(odr_pr, outf);
870 z_APDU(odr_pr, &a, 0, 0);
873 yaz_log (LOG_DEBUG, "encoding failed");
874 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
882 static zoom_ret send_APDU (ZOOM_connection c, Z_APDU *a)
886 if (encode_APDU(c, a, c->odr_out))
887 return zoom_complete;
888 yaz_log(LOG_DEBUG, "send APDU type=%d", a->which);
889 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
890 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
891 ZOOM_connection_put_event (c, event);
892 odr_reset(c->odr_out);
896 /* returns 1 if PDU was sent OK (still pending )
897 0 if PDU was not sent OK (nothing to wait for)
900 static zoom_ret ZOOM_connection_send_init (ZOOM_connection c)
902 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
903 Z_InitRequest *ireq = apdu->u.initRequest;
904 Z_IdAuthentication *auth = (Z_IdAuthentication *)
905 odr_malloc(c->odr_out, sizeof(*auth));
906 const char *auth_groupId = ZOOM_options_get (c->options, "group");
907 const char *auth_userId = ZOOM_options_get (c->options, "user");
908 const char *auth_password = ZOOM_options_get (c->options, "password");
911 /* support the pass for backwards compatibility */
913 auth_password = ZOOM_options_get (c->options, "pass");
915 ODR_MASK_SET(ireq->options, Z_Options_search);
916 ODR_MASK_SET(ireq->options, Z_Options_present);
917 ODR_MASK_SET(ireq->options, Z_Options_scan);
918 ODR_MASK_SET(ireq->options, Z_Options_sort);
919 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
920 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
922 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
923 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
924 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
926 /* Index Data's Z39.50 Implementor Id is 81 */
927 ireq->implementationId = odr_prepend(c->odr_out,
928 ZOOM_options_get(c->options, "implementationId"),
929 odr_prepend(c->odr_out, "81", ireq->implementationId));
931 ireq->implementationName = odr_prepend(c->odr_out,
932 ZOOM_options_get(c->options, "implementationName"),
933 odr_prepend(c->odr_out, "ZOOM-C", ireq->implementationName));
935 version = odr_strdup(c->odr_out, "$Revision: 1.22 $");
936 if (strlen(version) > 10) /* check for unexpanded CVS strings */
937 version[strlen(version)-2] = '\0';
938 ireq->implementationVersion = odr_prepend(c->odr_out,
939 ZOOM_options_get(c->options, "implementationVersion"),
940 odr_prepend(c->odr_out, &version[11], ireq->implementationVersion));
942 *ireq->maximumRecordSize =
943 ZOOM_options_get_int (c->options, "maximumRecordSize", 1024*1024);
944 *ireq->preferredMessageSize =
945 ZOOM_options_get_int (c->options, "preferredMessageSize", 1024*1024);
947 if (auth_groupId || auth_password)
949 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
952 if (auth_groupId && *auth_groupId)
954 pass->groupId = (char *)
955 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
956 strcpy(pass->groupId, auth_groupId);
960 if (auth_userId && *auth_userId)
962 pass->userId = (char *)
963 odr_malloc(c->odr_out, strlen(auth_userId)+1);
964 strcpy(pass->userId, auth_userId);
968 if (auth_password && *auth_password)
970 pass->password = (char *)
971 odr_malloc(c->odr_out, strlen(auth_password)+1);
972 strcpy(pass->password, auth_password);
977 auth->which = Z_IdAuthentication_idPass;
978 auth->u.idPass = pass;
979 ireq->idAuthentication = auth;
982 else if (auth_userId)
984 auth->which = Z_IdAuthentication_open;
985 auth->u.open = (char *)
986 odr_malloc(c->odr_out, strlen(auth_userId)+1);
987 strcpy(auth->u.open, auth_userId);
988 ireq->idAuthentication = auth;
991 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
992 VAL_PROXY, 1, c->host_port);
993 if (c->charset||c->lang)
995 Z_OtherInformation **oi;
996 Z_OtherInformationUnit *oi_unit;
998 yaz_oi_APDU(apdu, &oi);
1000 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1002 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1004 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1005 oi_unit->information.externallyDefinedInfo =
1006 yaz_set_proposal_charneg
1008 (const char **)&c->charset, (c->charset) ? 1:0,
1009 (const char **)&c->lang, (c->lang) ? 1:0, 1);
1013 return send_APDU (c, apdu);
1017 static zoom_ret send_srw (ZOOM_connection c, Z_SRW_PDU *sr)
1020 Z_SOAP_Handler h[2] = {
1021 {"http://www.loc.gov/zing/srw/", 0, (Z_SOAP_fun) yaz_srw_codec},
1024 ODR o = odr_createmem(ODR_ENCODE);
1026 Z_SOAP *p = odr_malloc(o, sizeof(*p));
1030 gdu = z_get_HTTP_Request(c->odr_out);
1031 gdu->u.HTTP_Request->path = c->path;
1035 const char *cp0 = strstr(c->host_port, "://");
1036 const char *cp1 = 0;
1042 cp1 = strchr(cp0, '/');
1044 cp1 = cp0+strlen(cp0);
1048 char *h = odr_malloc(c->odr_out, cp1 - cp0 + 1);
1049 memcpy (h, cp0, cp1 - cp0);
1051 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1056 strcpy(ctype, "text/xml");
1057 if (c->charset && strlen(c->charset) < 20)
1059 strcat(ctype, "; charset=");
1060 strcat(ctype, c->charset);
1062 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1063 "Content-Type", ctype);
1064 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1065 "SOAPAction", "\"\"");
1066 p->which = Z_SOAP_generic;
1067 p->u.generic = odr_malloc(o, sizeof(*p->u.generic));
1068 p->u.generic->no = 0;
1069 p->u.generic->ns = 0;
1070 p->u.generic->p = sr;
1071 p->ns = "http://schemas.xmlsoap.org/soap/envelope/";
1073 ret = z_soap_codec_enc(o, &p,
1074 &gdu->u.HTTP_Request->content_buf,
1075 &gdu->u.HTTP_Request->content_len, h,
1078 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1079 return zoom_complete;
1080 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1084 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1085 ZOOM_connection_put_event (c, event);
1086 odr_reset(c->odr_out);
1087 return do_write (c);
1092 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1095 ZOOM_resultset resultset = 0;
1097 const char *recordPacking = 0;
1099 if (c->error) /* don't continue on error */
1100 return zoom_complete;
1102 if (c->tasks->which == ZOOM_TASK_SEARCH)
1104 resultset = c->tasks->u.search.resultset;
1105 resultset->setname = xstrdup ("default");
1106 ZOOM_options_set (resultset->options, "setname", resultset->setname);
1108 else if(c->tasks->which == ZOOM_TASK_RETRIEVE)
1110 resultset = c->tasks->u.retrieve.resultset;
1112 resultset->start = c->tasks->u.retrieve.start;
1113 resultset->count = c->tasks->u.retrieve.count;
1115 if (resultset->start >= resultset->size)
1116 return zoom_complete;
1117 if (resultset->start + resultset->count > resultset->size)
1118 resultset->count = resultset->size - resultset->start;
1120 for (i = 0; i<resultset->count; i++)
1123 record_cache_lookup (resultset, i + resultset->start);
1127 if (i == resultset->count)
1128 return zoom_complete;
1130 assert(resultset->query);
1132 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1134 if (resultset->query->z_query->which == Z_Query_type_104
1135 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1138 sr->u.request->query_type = Z_SRW_query_type_cql;
1139 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1141 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1142 resultset->query->z_query->u.type_1)
1144 sr->u.request->query_type = Z_SRW_query_type_pqf;
1145 sr->u.request->query.pqf = resultset->query->query_string;
1149 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1150 return zoom_complete;
1152 sr->u.request->startRecord = odr_intdup (c->odr_out, resultset->start + 1);
1153 sr->u.request->maximumRecords = odr_intdup (
1154 c->odr_out, resultset->step>0 ? resultset->step : resultset->count);
1155 sr->u.request->recordSchema = resultset->schema;
1157 recordPacking = ZOOM_resultset_option_get (resultset, "recordPacking");
1160 sr->u.request->recordPacking = odr_strdup(c->odr_out, recordPacking);
1162 return send_srw(c, sr);
1165 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1167 return zoom_complete;
1171 static zoom_ret ZOOM_connection_send_search (ZOOM_connection c)
1174 int lslb, ssub, mspn;
1176 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1177 Z_SearchRequest *search_req = apdu->u.searchRequest;
1178 const char *elementSetName;
1179 const char *smallSetElementSetName;
1180 const char *mediumSetElementSetName;
1183 assert (c->tasks->which == ZOOM_TASK_SEARCH);
1185 r = c->tasks->u.search.resultset;
1188 ZOOM_options_get (r->options, "elementSetName");
1189 smallSetElementSetName =
1190 ZOOM_options_get (r->options, "smallSetElementSetName");
1191 mediumSetElementSetName =
1192 ZOOM_options_get (r->options, "mediumSetElementSetName");
1194 if (!smallSetElementSetName)
1195 smallSetElementSetName = elementSetName;
1197 if (!mediumSetElementSetName)
1198 mediumSetElementSetName = elementSetName;
1203 /* prepare query for the search request */
1204 search_req->query = r->query->z_query;
1206 search_req->databaseNames =
1207 set_DatabaseNames (c, r->options, &search_req->num_databaseNames);
1209 /* get syntax (no need to provide unless piggyback is in effect) */
1210 syntax = ZOOM_options_get (r->options, "preferredRecordSyntax");
1212 lslb = ZOOM_options_get_int (r->options, "largeSetLowerBound", -1);
1213 ssub = ZOOM_options_get_int (r->options, "smallSetUpperBound", -1);
1214 mspn = ZOOM_options_get_int (r->options, "mediumSetPresentNumber", -1);
1215 if (lslb != -1 && ssub != -1 && mspn != -1)
1217 /* So're a Z39.50 expert? Let's hope you don't do sort */
1218 *search_req->largeSetLowerBound = lslb;
1219 *search_req->smallSetUpperBound = ssub;
1220 *search_req->mediumSetPresentNumber = mspn;
1222 else if (r->start == 0 && r->count > 0
1223 && r->piggyback && !r->r_sort_spec && !r->schema)
1225 /* Regular piggyback - do it unless we're going to do sort */
1226 *search_req->largeSetLowerBound = 2000000000;
1227 *search_req->smallSetUpperBound = 1;
1228 *search_req->mediumSetPresentNumber = r->step>0 ? r->step : r->count;
1232 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1233 smallSetElementSetName = 0;
1234 mediumSetElementSetName = 0;
1237 if (smallSetElementSetName && *smallSetElementSetName)
1239 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1240 odr_malloc (c->odr_out, sizeof(*esn));
1242 esn->which = Z_ElementSetNames_generic;
1243 esn->u.generic = odr_strdup (c->odr_out, smallSetElementSetName);
1244 search_req->smallSetElementSetNames = esn;
1246 if (mediumSetElementSetName && *mediumSetElementSetName)
1248 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1249 odr_malloc (c->odr_out, sizeof(*esn));
1251 esn->which = Z_ElementSetNames_generic;
1252 esn->u.generic = odr_strdup (c->odr_out, mediumSetElementSetName);
1253 search_req->mediumSetElementSetNames = esn;
1256 search_req->preferredRecordSyntax =
1257 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1261 if (c->support_named_resultsets)
1265 /* find the lowest unused ordinal so that we re-use
1266 result sets on the server. */
1267 for (ord = 1; ; ord++)
1270 sprintf (setname, "%d", ord);
1271 for (rp = c->resultsets; rp; rp = rp->next)
1272 if (rp->setname && !strcmp (rp->setname, setname))
1277 r->setname = xstrdup (setname);
1278 yaz_log (LOG_DEBUG, "allocating set %s", r->setname);
1281 r->setname = xstrdup ("default");
1282 ZOOM_options_set (r->options, "setname", r->setname);
1284 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1285 /* send search request */
1286 return send_APDU (c, apdu);
1289 static void response_diag (ZOOM_connection c, Z_DiagRec *p)
1292 Z_DefaultDiagFormat *r;
1297 if (p->which != Z_DiagRec_defaultFormat)
1299 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1302 r = p->u.defaultFormat;
1305 case Z_DefaultDiagFormat_v2Addinfo:
1306 addinfo = r->u.v2Addinfo;
1308 case Z_DefaultDiagFormat_v3Addinfo:
1309 addinfo = r->u.v3Addinfo;
1312 set_dset_error(c, *r->condition,
1313 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1317 ZOOM_API(ZOOM_record)
1318 ZOOM_record_clone (ZOOM_record srec)
1325 odr_enc = odr_createmem(ODR_ENCODE);
1326 if (!z_NamePlusRecord (odr_enc, &srec->npr, 0, 0))
1328 buf = odr_getbuf (odr_enc, &size, 0);
1330 nrec = (ZOOM_record) xmalloc (sizeof(*nrec));
1331 nrec->odr = odr_createmem(ODR_DECODE);
1332 nrec->wrbuf_marc = 0;
1333 nrec->wrbuf_iconv = 0;
1334 nrec->wrbuf_opac = 0;
1335 odr_setbuf (nrec->odr, buf, size, 0);
1336 z_NamePlusRecord (nrec->odr, &nrec->npr, 0, 0);
1338 odr_destroy (odr_enc);
1342 ZOOM_API(ZOOM_record)
1343 ZOOM_resultset_record_immediate (ZOOM_resultset s,size_t pos)
1345 return record_cache_lookup (s, pos);
1348 ZOOM_API(ZOOM_record)
1349 ZOOM_resultset_record (ZOOM_resultset r, size_t pos)
1351 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1355 ZOOM_resultset_retrieve (r, 1, pos, 1);
1356 rec = ZOOM_resultset_record_immediate (r, pos);
1362 ZOOM_record_destroy (ZOOM_record rec)
1366 if (rec->wrbuf_marc)
1367 wrbuf_free (rec->wrbuf_marc, 1);
1368 if (rec->wrbuf_iconv)
1369 wrbuf_free (rec->wrbuf_iconv, 1);
1370 if (rec->wrbuf_opac)
1371 wrbuf_free (rec->wrbuf_opac, 1);
1372 odr_destroy (rec->odr);
1376 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1378 const char *buf, int sz,
1379 const char *record_charset)
1384 yaz_marc_t mt = yaz_marc_create();
1387 strcpy(to, "UTF-8");
1388 if (record_charset && *record_charset)
1390 /* Use "from,to" or just "from" */
1391 const char *cp =strchr(record_charset, ',');
1392 int clen = strlen(record_charset);
1395 strncpy( to, cp+1, sizeof(to)-1);
1396 to[sizeof(to)-1] = '\0';
1397 clen = cp - record_charset;
1399 if (clen > sizeof(from)-1)
1400 clen = sizeof(from)-1;
1403 strncpy(from, record_charset, clen);
1409 cd = yaz_iconv_open(to, from);
1410 yaz_marc_iconv(mt, cd);
1413 yaz_marc_xml(mt, marc_type);
1414 if (!rec->wrbuf_marc)
1415 rec->wrbuf_marc = wrbuf_alloc();
1416 wrbuf_rewind (rec->wrbuf_marc);
1417 if (yaz_marc_decode_wrbuf (mt, buf, sz, rec->wrbuf_marc) > 0)
1419 yaz_marc_destroy(mt);
1421 yaz_iconv_close(cd);
1423 *len = wrbuf_len(rec->wrbuf_marc);
1424 return wrbuf_buf(rec->wrbuf_marc);
1426 yaz_marc_destroy(mt);
1428 yaz_iconv_close(cd);
1432 static const char *record_iconv_return(ZOOM_record rec, int *len,
1433 const char *buf, int sz,
1434 const char *record_charset)
1441 strcpy(to, "UTF-8");
1442 if (record_charset && *record_charset)
1444 /* Use "from,to" or just "from" */
1445 const char *cp =strchr(record_charset, ',');
1446 int clen = strlen(record_charset);
1449 strncpy( to, cp+1, sizeof(to)-1);
1450 to[sizeof(to)-1] = '\0';
1451 clen = cp - record_charset;
1453 if (clen > sizeof(from)-1)
1454 clen = sizeof(from)-1;
1457 strncpy(from, record_charset, clen);
1461 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1464 size_t inbytesleft = sz;
1465 const char *inp = buf;
1467 if (!rec->wrbuf_iconv)
1468 rec->wrbuf_iconv = wrbuf_alloc();
1470 wrbuf_rewind(rec->wrbuf_iconv);
1474 size_t outbytesleft = sizeof(outbuf);
1475 char *outp = outbuf;
1476 size_t r = yaz_iconv (cd, (char**) &inp,
1478 &outp, &outbytesleft);
1479 if (r == (size_t) (-1))
1481 int e = yaz_iconv_error(cd);
1482 if (e != YAZ_ICONV_E2BIG)
1485 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1487 wrbuf_puts(rec->wrbuf_iconv, "");
1488 buf = wrbuf_buf(rec->wrbuf_iconv);
1489 sz = wrbuf_len(rec->wrbuf_iconv);
1490 yaz_iconv_close(cd);
1497 ZOOM_API(const char *)
1498 ZOOM_record_get (ZOOM_record rec, const char *type_spec, int *len)
1505 Z_NamePlusRecord *npr;
1508 *len = 0; /* default return */
1517 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1519 if (cp[i] == ';' || cp[i] == ' ')
1525 while (type_spec[i] == ';')
1528 while (type_spec[i] == ' ')
1530 if (!strncmp(type_spec+i, "charset=", 8))
1533 for (i = 0; cp[i] && i < sizeof(charset)-1; i++)
1535 if (cp[i] == ';' || cp[i] == ' ')
1541 else if (!strncmp(type_spec+i, "xpath=", 6))
1544 for (i = 0; cp[i] && i < sizeof(xpath)-1; i++)
1548 while (type_spec[i] == ' ')
1551 if (!strcmp (type, "database"))
1554 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1555 return npr->databaseName;
1557 else if (!strcmp (type, "syntax"))
1559 const char *desc = 0;
1560 if (npr->which == Z_NamePlusRecord_databaseRecord)
1562 Z_External *r = (Z_External *) npr->u.databaseRecord;
1563 oident *ent = oid_getentbyoid(r->direct_reference);
1570 *len = strlen(desc);
1573 if (npr->which != Z_NamePlusRecord_databaseRecord)
1576 /* from now on - we have a database record .. */
1577 if (!strcmp (type, "render"))
1579 Z_External *r = (Z_External *) npr->u.databaseRecord;
1580 oident *ent = oid_getentbyoid(r->direct_reference);
1582 /* render bibliographic record .. */
1583 if (r->which == Z_External_OPAC)
1585 r = r->u.opac->bibliographicRecord;
1588 ent = oid_getentbyoid(r->direct_reference);
1590 if (r->which == Z_External_sutrs)
1591 return record_iconv_return(rec, len,
1592 r->u.sutrs->buf, r->u.sutrs->len,
1594 else if (r->which == Z_External_octet)
1596 const char *ret_buf;
1604 case VAL_APPLICATION_XML:
1607 ret_buf = marc_iconv_return(
1608 rec, YAZ_MARC_LINE, len,
1609 (const char *) r->u.octet_aligned->buf,
1610 r->u.octet_aligned->len,
1615 return record_iconv_return(rec, len,
1616 (const char *) r->u.octet_aligned->buf,
1617 r->u.octet_aligned->len,
1620 else if (r->which == Z_External_grs1)
1622 if (!rec->wrbuf_marc)
1623 rec->wrbuf_marc = wrbuf_alloc();
1624 wrbuf_rewind (rec->wrbuf_marc);
1625 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1626 return record_iconv_return(rec, len,
1627 wrbuf_buf(rec->wrbuf_marc),
1628 wrbuf_len(rec->wrbuf_marc),
1633 else if (!strcmp (type, "xml") || !strcmp(type, "oai"))
1635 Z_External *r = (Z_External *) npr->u.databaseRecord;
1636 oident *ent = oid_getentbyoid(r->direct_reference);
1638 /* render bibliographic record .. */
1639 if (r->which == Z_External_OPAC)
1641 r = r->u.opac->bibliographicRecord;
1644 ent = oid_getentbyoid(r->direct_reference);
1647 if (r->which == Z_External_sutrs)
1648 return record_iconv_return(rec, len,
1649 (const char *) r->u.sutrs->buf,
1652 else if (r->which == Z_External_octet)
1654 const char *ret_buf;
1655 int marc_decode_type = YAZ_MARC_MARCXML;
1657 if (!strcmp(type, "oai"))
1658 marc_decode_type = YAZ_MARC_OAIMARC;
1666 case VAL_APPLICATION_XML:
1669 ret_buf = marc_iconv_return(
1670 rec, marc_decode_type, len,
1671 (const char *) r->u.octet_aligned->buf,
1672 r->u.octet_aligned->len,
1677 return record_iconv_return(rec, len,
1678 (const char *) r->u.octet_aligned->buf,
1679 r->u.octet_aligned->len,
1682 else if (r->which == Z_External_grs1)
1689 else if (!strcmp (type, "raw"))
1691 Z_External *r = (Z_External *) npr->u.databaseRecord;
1693 if (r->which == Z_External_sutrs)
1695 if (len) *len = r->u.sutrs->len;
1696 return (const char *) r->u.sutrs->buf;
1698 else if (r->which == Z_External_octet)
1700 if (len) *len = r->u.octet_aligned->len;
1701 return (const char *) r->u.octet_aligned->buf;
1703 else /* grs-1, explain, OPAC, ... */
1706 return (const char *) npr->u.databaseRecord;
1710 else if (!strcmp (type, "ext"))
1713 return (const char *) npr->u.databaseRecord;
1715 else if (!strcmp (type, "opac"))
1718 Z_External *r = (Z_External *) npr->u.databaseRecord;
1719 if (r->which == Z_External_OPAC)
1721 if (!rec->wrbuf_opac)
1722 rec->wrbuf_opac = wrbuf_alloc();
1723 wrbuf_rewind (rec->wrbuf_opac);
1724 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
1725 return record_iconv_return(rec, len,
1726 wrbuf_buf(rec->wrbuf_opac),
1727 wrbuf_len(rec->wrbuf_opac),
1734 static int strcmp_null(const char *v1, const char *v2)
1740 return strcmp(v1, v2);
1743 static void record_cache_add (ZOOM_resultset r, Z_NamePlusRecord *npr,
1746 ZOOM_record_cache rc;
1747 const char *elementSetName =
1748 ZOOM_resultset_option_get (r, "elementSetName");
1749 const char *syntax =
1750 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
1752 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1753 ZOOM_connection_put_event(r->connection, event);
1755 for (rc = r->record_cache; rc; rc = rc->next)
1759 if (strcmp_null(r->schema, rc->schema))
1761 if (strcmp_null(elementSetName,rc->elementSetName))
1763 if (strcmp_null(syntax, rc->syntax))
1765 /* not destroying rc->npr (it's handled by nmem )*/
1767 /* keeping wrbuf_marc too */
1771 rc = (ZOOM_record_cache) odr_malloc (r->odr, sizeof(*rc));
1774 rc->rec.wrbuf_marc = 0;
1775 rc->rec.wrbuf_iconv = 0;
1776 rc->rec.wrbuf_opac = 0;
1778 rc->elementSetName = odr_strdup (r->odr, elementSetName);
1780 rc->elementSetName = 0;
1783 rc->syntax = odr_strdup (r->odr, syntax);
1788 rc->schema = odr_strdup (r->odr, r->schema);
1793 rc->next = r->record_cache;
1794 r->record_cache = rc;
1797 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos)
1799 ZOOM_record_cache rc;
1800 const char *elementSetName =
1801 ZOOM_resultset_option_get (r, "elementSetName");
1802 const char *syntax =
1803 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
1805 for (rc = r->record_cache; rc; rc = rc->next)
1809 if (strcmp_null(r->schema, rc->schema))
1811 if (strcmp_null(elementSetName,rc->elementSetName))
1813 if (strcmp_null(syntax, rc->syntax))
1821 static void handle_records (ZOOM_connection c, Z_Records *sr,
1824 ZOOM_resultset resultset;
1828 switch (c->tasks->which)
1830 case ZOOM_TASK_SEARCH:
1831 resultset = c->tasks->u.search.resultset;
1833 case ZOOM_TASK_RETRIEVE:
1834 resultset = c->tasks->u.retrieve.resultset;
1839 if (sr && sr->which == Z_Records_NSD)
1841 Z_DiagRec dr, *dr_p = &dr;
1842 dr.which = Z_DiagRec_defaultFormat;
1843 dr.u.defaultFormat = sr->u.nonSurrogateDiagnostic;
1845 response_diag (c, dr_p);
1847 else if (sr && sr->which == Z_Records_multipleNSD)
1849 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
1850 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
1852 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1856 if (resultset->count + resultset->start > resultset->size)
1857 resultset->count = resultset->size - resultset->start;
1858 if (resultset->count < 0)
1859 resultset->count = 0;
1860 if (sr && sr->which == Z_Records_DBOSD)
1863 NMEM nmem = odr_extract_mem (c->odr_in);
1864 Z_NamePlusRecordList *p =
1865 sr->u.databaseOrSurDiagnostics;
1866 for (i = 0; i<p->num_records; i++)
1868 record_cache_add (resultset, p->records[i],
1869 i+ resultset->start);
1871 /* transfer our response to search_nmem .. we need it later */
1872 nmem_transfer (resultset->odr->mem, nmem);
1873 nmem_destroy (nmem);
1874 if (present_phase && p->num_records == 0)
1876 /* present response and we didn't get any records! */
1877 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1880 else if (present_phase)
1882 /* present response and we didn't get any records! */
1883 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1888 static void handle_present_response (ZOOM_connection c, Z_PresentResponse *pr)
1890 handle_records (c, pr->records, 1);
1893 static void handle_search_response (ZOOM_connection c, Z_SearchResponse *sr)
1895 ZOOM_resultset resultset;
1898 yaz_log (LOG_DEBUG, "got search response");
1900 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1903 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
1904 ZOOM_connection_put_event(c, event);
1906 resultset = c->tasks->u.search.resultset;
1908 resultset->size = *sr->resultCount;
1909 handle_records (c, sr->records, 0);
1912 static void sort_response (ZOOM_connection c, Z_SortResponse *res)
1914 if (res->diagnostics && res->num_diagnostics > 0)
1915 response_diag (c, res->diagnostics[0]);
1918 static int scan_response (ZOOM_connection c, Z_ScanResponse *res)
1920 NMEM nmem = odr_extract_mem (c->odr_in);
1923 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
1925 scan = c->tasks->u.scan.scan;
1927 if (res->entries && res->entries->nonsurrogateDiagnostics)
1928 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
1929 scan->scan_response = res;
1930 nmem_transfer (scan->odr->mem, nmem);
1932 ZOOM_options_set_int (scan->options, "stepSize", *res->stepSize);
1933 if (res->positionOfTerm)
1934 ZOOM_options_set_int (scan->options, "position", *res->positionOfTerm);
1935 if (res->scanStatus)
1936 ZOOM_options_set_int (scan->options, "scanStatus", *res->scanStatus);
1937 if (res->numberOfEntriesReturned)
1938 ZOOM_options_set_int (scan->options, "number",
1939 *res->numberOfEntriesReturned);
1940 nmem_destroy (nmem);
1944 static zoom_ret send_sort (ZOOM_connection c)
1946 ZOOM_resultset resultset;
1948 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1949 return zoom_complete;
1951 resultset = c->tasks->u.search.resultset;
1955 resultset->r_sort_spec = 0;
1956 return zoom_complete;
1958 if (resultset->r_sort_spec)
1960 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
1961 Z_SortRequest *req = apdu->u.sortRequest;
1963 req->num_inputResultSetNames = 1;
1964 req->inputResultSetNames = (Z_InternationalString **)
1965 odr_malloc (c->odr_out, sizeof(*req->inputResultSetNames));
1966 req->inputResultSetNames[0] =
1967 odr_strdup (c->odr_out, resultset->setname);
1968 req->sortedResultSetName = odr_strdup (c->odr_out, resultset->setname);
1969 req->sortSequence = resultset->r_sort_spec;
1970 resultset->r_sort_spec = 0;
1971 return send_APDU (c, apdu);
1973 return zoom_complete;
1976 static zoom_ret send_present (ZOOM_connection c)
1979 Z_PresentRequest *req = 0;
1981 const char *syntax = 0;
1982 const char *elementSetName = 0;
1983 ZOOM_resultset resultset;
1986 return zoom_complete;
1988 switch (c->tasks->which)
1990 case ZOOM_TASK_SEARCH:
1991 resultset = c->tasks->u.search.resultset;
1993 case ZOOM_TASK_RETRIEVE:
1994 resultset = c->tasks->u.retrieve.resultset;
1995 resultset->start = c->tasks->u.retrieve.start;
1996 resultset->count = c->tasks->u.retrieve.count;
1998 if (resultset->start >= resultset->size)
1999 return zoom_complete;
2000 if (resultset->start + resultset->count > resultset->size)
2001 resultset->count = resultset->size - resultset->start;
2004 return zoom_complete;
2007 syntax = ZOOM_resultset_option_get (resultset, "preferredRecordSyntax");
2008 elementSetName = ZOOM_resultset_option_get (resultset, "elementSetName");
2010 if (c->error) /* don't continue on error */
2011 return zoom_complete;
2012 if (resultset->start < 0)
2013 return zoom_complete;
2014 for (i = 0; i<resultset->count; i++)
2017 record_cache_lookup (resultset, i + resultset->start);
2021 if (i == resultset->count)
2022 return zoom_complete;
2024 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2025 req = apdu->u.presentRequest;
2027 resultset->start += i;
2028 resultset->count -= i;
2029 *req->resultSetStartPoint = resultset->start + 1;
2030 *req->numberOfRecordsRequested = resultset->step>0 ?
2031 resultset->step : resultset->count;
2032 assert (*req->numberOfRecordsRequested > 0);
2034 if (syntax && *syntax)
2035 req->preferredRecordSyntax =
2036 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
2038 if (resultset->schema && *resultset->schema)
2040 Z_RecordComposition *compo = (Z_RecordComposition *)
2041 odr_malloc (c->odr_out, sizeof(*compo));
2043 req->recordComposition = compo;
2044 compo->which = Z_RecordComp_complex;
2045 compo->u.complex = (Z_CompSpec *)
2046 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2047 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2048 odr_malloc(c->odr_out, sizeof(bool_t));
2049 *compo->u.complex->selectAlternativeSyntax = 0;
2051 compo->u.complex->generic = (Z_Specification *)
2052 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2054 compo->u.complex->generic->which = Z_Schema_oid;
2055 compo->u.complex->generic->schema.oid = (Odr_oid *)
2056 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2058 if (!compo->u.complex->generic->schema.oid)
2060 /* OID wasn't a schema! Try record syntax instead. */
2062 compo->u.complex->generic->schema.oid = (Odr_oid *)
2063 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2065 if (elementSetName && *elementSetName)
2067 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2068 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2069 compo->u.complex->generic->elementSpec->which =
2070 Z_ElementSpec_elementSetName;
2071 compo->u.complex->generic->elementSpec->u.elementSetName =
2072 odr_strdup (c->odr_out, elementSetName);
2075 compo->u.complex->generic->elementSpec = 0;
2076 compo->u.complex->num_dbSpecific = 0;
2077 compo->u.complex->dbSpecific = 0;
2078 compo->u.complex->num_recordSyntax = 0;
2079 compo->u.complex->recordSyntax = 0;
2081 else if (elementSetName && *elementSetName)
2083 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2084 odr_malloc (c->odr_out, sizeof(*esn));
2085 Z_RecordComposition *compo = (Z_RecordComposition *)
2086 odr_malloc (c->odr_out, sizeof(*compo));
2088 esn->which = Z_ElementSetNames_generic;
2089 esn->u.generic = odr_strdup (c->odr_out, elementSetName);
2090 compo->which = Z_RecordComp_simple;
2091 compo->u.simple = esn;
2092 req->recordComposition = compo;
2094 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2095 return send_APDU (c, apdu);
2098 ZOOM_API(ZOOM_scanset)
2099 ZOOM_connection_scan (ZOOM_connection c, const char *start)
2101 ZOOM_scanset scan = (ZOOM_scanset) xmalloc (sizeof(*scan));
2103 scan->connection = c;
2104 scan->odr = odr_createmem (ODR_DECODE);
2105 scan->options = ZOOM_options_create_with_parent (c->options);
2107 scan->scan_response = 0;
2109 if ((scan->termListAndStartPoint =
2110 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet,
2113 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_SCAN);
2114 task->u.scan.scan = scan;
2119 while (ZOOM_event (1, &c))
2127 ZOOM_scanset_destroy (ZOOM_scanset scan)
2132 if (scan->refcount == 0)
2134 odr_destroy (scan->odr);
2136 ZOOM_options_destroy (scan->options);
2141 static zoom_ret send_package (ZOOM_connection c)
2145 return zoom_complete;
2146 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2148 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
2149 ZOOM_connection_put_event (c, event);
2151 return do_write_ex (c, c->tasks->u.package->buf_out,
2152 c->tasks->u.package->len_out);
2155 static zoom_ret send_scan (ZOOM_connection c)
2158 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2159 Z_ScanRequest *req = apdu->u.scanRequest;
2161 return zoom_complete;
2162 assert (c->tasks->which == ZOOM_TASK_SCAN);
2163 scan = c->tasks->u.scan.scan;
2165 req->termListAndStartPoint = scan->termListAndStartPoint;
2166 req->attributeSet = scan->attributeSet;
2168 *req->numberOfTermsRequested =
2169 ZOOM_options_get_int(scan->options, "number", 10);
2171 req->preferredPositionInResponse =
2172 odr_intdup (c->odr_out,
2173 ZOOM_options_get_int(scan->options, "position", 1));
2176 odr_intdup (c->odr_out,
2177 ZOOM_options_get_int(scan->options, "stepSize", 0));
2179 req->databaseNames = set_DatabaseNames (c, scan->options,
2180 &req->num_databaseNames);
2182 return send_APDU (c, apdu);
2186 ZOOM_scanset_size (ZOOM_scanset scan)
2188 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2190 return scan->scan_response->entries->num_entries;
2193 ZOOM_API(const char *)
2194 ZOOM_scanset_term (ZOOM_scanset scan, size_t pos,
2197 const char *term = 0;
2198 size_t noent = ZOOM_scanset_size (scan);
2199 Z_ScanResponse *res = scan->scan_response;
2205 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2207 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2209 if (t->term->which == Z_Term_general)
2211 term = (const char *) t->term->u.general->buf;
2212 *len = t->term->u.general->len;
2214 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2219 ZOOM_API(const char *)
2220 ZOOM_scanset_display_term (ZOOM_scanset scan, size_t pos,
2223 const char *term = 0;
2224 size_t noent = ZOOM_scanset_size (scan);
2225 Z_ScanResponse *res = scan->scan_response;
2231 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2233 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2237 term = t->displayTerm;
2238 *len = strlen(term);
2240 else if (t->term->which == Z_Term_general)
2242 term = (const char *) t->term->u.general->buf;
2243 *len = t->term->u.general->len;
2245 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2250 ZOOM_API(const char *)
2251 ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key)
2253 return ZOOM_options_get (scan->options, key);
2257 ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
2260 ZOOM_options_set (scan->options, key, val);
2263 static Z_APDU *create_es_package (ZOOM_package p, int type)
2266 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2267 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2269 *req->function = Z_ExtendedServicesRequest_create;
2271 str = ZOOM_options_get(p->options, "package-name");
2273 req->packageName = nmem_strdup (p->odr_out->mem, str);
2275 str = ZOOM_options_get(p->options, "user-id");
2277 req->userId = nmem_strdup (p->odr_out->mem, str);
2279 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2282 str = ZOOM_options_get(p->options, "function");
2285 if (!strcmp (str, "create"))
2287 if (!strcmp (str, "delete"))
2289 if (!strcmp (str, "modify"))
2295 static const char *ill_array_lookup (void *clientData, const char *idx)
2297 ZOOM_package p = (ZOOM_package) clientData;
2298 return ZOOM_options_get (p->options, idx+4);
2301 static Z_External *encode_ill_request (ZOOM_package p)
2303 ODR out = p->odr_out;
2306 struct ill_get_ctl ctl;
2308 ctl.odr = p->odr_out;
2310 ctl.f = ill_array_lookup;
2312 req = ill_get_ILLRequest(&ctl, "ill", 0);
2314 if (!ill_Request (out, &req, 0, 0))
2316 int ill_request_size;
2317 char *ill_request_buf = odr_getbuf (out, &ill_request_size, 0);
2318 if (ill_request_buf)
2319 odr_setbuf (out, ill_request_buf, ill_request_size, 1);
2325 int illRequest_size = 0;
2326 char *illRequest_buf = odr_getbuf (out, &illRequest_size, 0);
2328 oid.proto = PROTO_GENERAL;
2329 oid.oclass = CLASS_GENERAL;
2330 oid.value = VAL_ISO_ILL_1;
2332 r = (Z_External *) odr_malloc (out, sizeof(*r));
2333 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2334 r->indirect_reference = 0;
2336 r->which = Z_External_single;
2338 r->u.single_ASN1_type = (Odr_oct *)
2339 odr_malloc (out, sizeof(*r->u.single_ASN1_type));
2340 r->u.single_ASN1_type->buf = (unsigned char*)
2341 odr_malloc (out, illRequest_size);
2342 r->u.single_ASN1_type->len = illRequest_size;
2343 r->u.single_ASN1_type->size = illRequest_size;
2344 memcpy (r->u.single_ASN1_type->buf, illRequest_buf, illRequest_size);
2349 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2351 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc (p->odr_out, sizeof(*req));
2354 req->which=Z_IOItemOrder_esRequest;
2355 req->u.esRequest = (Z_IORequest *)
2356 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2358 /* to keep part ... */
2359 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2360 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2361 req->u.esRequest->toKeep->supplDescription = 0;
2362 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2363 odr_malloc (p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2365 str = ZOOM_options_get(p->options, "contact-name");
2366 req->u.esRequest->toKeep->contact->name = str ?
2367 nmem_strdup (p->odr_out->mem, str) : 0;
2369 str = ZOOM_options_get(p->options, "contact-phone");
2370 req->u.esRequest->toKeep->contact->phone = str ?
2371 nmem_strdup (p->odr_out->mem, str) : 0;
2373 str = ZOOM_options_get(p->options, "contact-email");
2374 req->u.esRequest->toKeep->contact->email = str ?
2375 nmem_strdup (p->odr_out->mem, str) : 0;
2377 req->u.esRequest->toKeep->addlBilling = 0;
2379 /* not to keep part ... */
2380 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2381 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2383 str = ZOOM_options_get(p->options, "itemorder-setname");
2388 req->u.esRequest->notToKeep->resultSetItem = 0;
2391 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2392 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2394 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2395 nmem_strdup (p->odr_out->mem, str);
2396 req->u.esRequest->notToKeep->resultSetItem->item =
2397 (int *) odr_malloc(p->odr_out, sizeof(int));
2399 str = ZOOM_options_get(p->options, "itemorder-item");
2400 *req->u.esRequest->notToKeep->resultSetItem->item =
2401 (str ? atoi(str) : 1);
2403 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2408 Z_APDU *create_admin_package(ZOOM_package p, int type,
2409 Z_ESAdminOriginPartToKeep **toKeepP,
2410 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2412 Z_APDU *apdu = create_es_package (p, VAL_ADMINSERVICE);
2415 Z_ESAdminOriginPartToKeep *toKeep;
2416 Z_ESAdminOriginPartNotToKeep *notToKeep;
2417 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2418 const char *first_db = "Default";
2420 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2424 r->direct_reference =
2425 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2428 r->indirect_reference = 0;
2429 r->which = Z_External_ESAdmin;
2431 r->u.adminService = (Z_Admin *)
2432 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2433 r->u.adminService->which = Z_Admin_esRequest;
2434 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2435 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2437 toKeep = r->u.adminService->u.esRequest->toKeep =
2438 (Z_ESAdminOriginPartToKeep *)
2439 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2441 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2442 toKeep->u.create=odr_nullval();
2443 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2445 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2446 (Z_ESAdminOriginPartNotToKeep *)
2447 odr_malloc(p->odr_out,
2448 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2449 notToKeep->which=Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
2450 notToKeep->u.recordsWillFollow=odr_nullval();
2454 *notToKeepP = notToKeep;
2459 static Z_APDU *create_update_package(ZOOM_package p)
2462 const char *first_db = "Default";
2464 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2465 const char *action = ZOOM_options_get(p->options, "action");
2466 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
2467 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
2468 const char *record_buf = ZOOM_options_get(p->options, "record");
2469 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
2470 int syntax_oid = VAL_NONE;
2474 syntax_oid = oid_getvalbyname(syntax_str);
2477 record_buf = "void";
2478 syntax_oid = VAL_SUTRS;
2480 if (syntax_oid != VAL_NONE)
2481 syntax_oid = VAL_TEXT_XML;
2487 action = "specialUpdate";
2489 if (!strcmp(action, "recordInsert"))
2490 action_no = Z_IUOriginPartToKeep_recordInsert;
2491 else if (!strcmp(action, "recordReplace"))
2492 action_no = Z_IUOriginPartToKeep_recordReplace;
2493 else if (!strcmp(action, "recordDelete"))
2494 action_no = Z_IUOriginPartToKeep_recordDelete;
2495 else if (!strcmp(action, "elementUpdate"))
2496 action_no = Z_IUOriginPartToKeep_elementUpdate;
2497 else if (!strcmp(action, "specialUpdate"))
2498 action_no = Z_IUOriginPartToKeep_specialUpdate;
2502 apdu = create_es_package (p, VAL_DBUPDATE);
2505 Z_IUOriginPartToKeep *toKeep;
2506 Z_IUSuppliedRecords *notToKeep;
2507 Z_External *r = (Z_External *)
2508 odr_malloc (p->odr_out, sizeof(*r));
2510 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2512 r->direct_reference =
2513 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2516 r->which = Z_External_update;
2517 r->indirect_reference = 0;
2518 r->u.update = (Z_IUUpdate *)
2519 odr_malloc(p->odr_out, sizeof(*r->u.update));
2521 r->u.update->which = Z_IUUpdate_esRequest;
2522 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
2523 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
2524 toKeep = r->u.update->u.esRequest->toKeep =
2525 (Z_IUOriginPartToKeep *)
2526 odr_malloc(p->odr_out, sizeof(*toKeep));
2528 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2530 toKeep->elementSetName = 0;
2531 toKeep->actionQualifier = 0;
2532 toKeep->action = odr_intdup(p->odr_out, action_no);
2534 notToKeep = r->u.update->u.esRequest->notToKeep =
2535 (Z_IUSuppliedRecords *)
2536 odr_malloc(p->odr_out, sizeof(*notToKeep));
2538 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
2539 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
2540 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
2541 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
2542 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
2545 notToKeep->elements[0]->u.opaque = (Odr_oct *)
2546 odr_malloc (p->odr_out, sizeof(Odr_oct));
2547 notToKeep->elements[0]->u.opaque->size =
2548 notToKeep->elements[0]->u.opaque->len = strlen(recordIdOpaque);
2549 notToKeep->elements[0]->u.opaque->buf =
2550 odr_strdup(p->odr_out, recordIdOpaque);
2552 else if (recordIdNumber)
2554 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
2556 notToKeep->elements[0]->u.number =
2557 odr_intdup(p->odr_out, atoi(recordIdNumber));
2560 notToKeep->elements[0]->u.opaque = 0;
2561 notToKeep->elements[0]->supplementalId = 0;
2562 notToKeep->elements[0]->correlationInfo = 0;
2563 notToKeep->elements[0]->record =
2564 z_ext_record(p->odr_out, syntax_oid,
2565 record_buf, strlen(record_buf));
2569 ODR print = odr_createmem(ODR_PRINT);
2571 z_APDU(print, &apdu, 0, 0);
2578 ZOOM_package_send (ZOOM_package p, const char *type)
2585 odr_reset (p->odr_out);
2588 if (!strcmp(type, "itemorder"))
2590 apdu = create_es_package (p, VAL_ITEMORDER);
2593 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2595 r->direct_reference =
2596 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2599 r->which = Z_External_itemOrder;
2600 r->indirect_reference = 0;
2601 r->u.itemOrder = encode_item_order (p);
2603 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2606 if (!strcmp(type, "create")) /* create database */
2608 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
2611 if (!strcmp(type, "drop")) /* drop database */
2613 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
2616 if (!strcmp(type, "update")) /* update record(s) */
2618 apdu = create_update_package(p);
2622 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
2626 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_PACKAGE);
2627 task->u.package = p;
2628 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
2629 p->buf_out = (char *) xmalloc (p->len_out);
2630 memcpy (p->buf_out, buf, p->len_out);
2635 while (ZOOM_event (1, &c))
2642 ZOOM_API(ZOOM_package)
2643 ZOOM_connection_package (ZOOM_connection c, ZOOM_options options)
2645 ZOOM_package p = (ZOOM_package) xmalloc (sizeof(*p));
2648 p->odr_out = odr_createmem (ODR_ENCODE);
2649 p->options = ZOOM_options_create_with_parent2 (options, c->options);
2657 ZOOM_package_destroy(ZOOM_package p)
2662 if (p->refcount == 0)
2664 odr_destroy (p->odr_out);
2667 ZOOM_options_destroy (p->options);
2672 ZOOM_API(const char *)
2673 ZOOM_package_option_get (ZOOM_package p, const char *key)
2675 return ZOOM_options_get (p->options, key);
2680 ZOOM_package_option_set (ZOOM_package p, const char *key,
2683 ZOOM_options_set (p->options, key, val);
2686 static int ZOOM_connection_exec_task (ZOOM_connection c)
2688 ZOOM_task task = c->tasks;
2689 zoom_ret ret = zoom_complete;
2693 yaz_log (LOG_DEBUG, "ZOOM_connection_exec_task task=<null>");
2696 yaz_log (LOG_DEBUG, "ZOOM_connection_exec_task type=%d run=%d",
2697 task->which, task->running);
2698 if (c->error != ZOOM_ERROR_NONE)
2700 yaz_log (LOG_DEBUG, "remove tasks because of error = %d", c->error);
2701 ZOOM_connection_remove_tasks (c);
2706 yaz_log (LOG_DEBUG, "task already running");
2710 ret = zoom_complete;
2711 if (c->cs || task->which == ZOOM_TASK_CONNECT)
2713 switch (task->which)
2715 case ZOOM_TASK_SEARCH:
2716 if (c->proto == PROTO_HTTP)
2717 ret = ZOOM_connection_srw_send_search(c);
2719 ret = ZOOM_connection_send_search(c);
2721 case ZOOM_TASK_RETRIEVE:
2722 if (c->proto == PROTO_HTTP)
2723 ret = ZOOM_connection_srw_send_search(c);
2725 ret = send_present (c);
2727 case ZOOM_TASK_CONNECT:
2728 ret = do_connect(c);
2730 case ZOOM_TASK_SCAN:
2733 case ZOOM_TASK_PACKAGE:
2734 ret = send_package(c);
2740 yaz_log (LOG_DEBUG, "remove tasks because no connection exist");
2741 ZOOM_connection_remove_tasks (c);
2743 if (ret == zoom_complete)
2745 yaz_log (LOG_DEBUG, "task removed (complete)");
2746 ZOOM_connection_remove_task (c);
2749 yaz_log (LOG_DEBUG, "task pending");
2753 static zoom_ret send_sort_present (ZOOM_connection c)
2755 zoom_ret r = send_sort (c);
2756 if (r == zoom_complete)
2757 r = send_present (c);
2761 static int es_response (ZOOM_connection c,
2762 Z_ExtendedServicesResponse *res)
2764 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
2766 if (res->diagnostics && res->num_diagnostics > 0)
2767 response_diag(c, res->diagnostics[0]);
2768 if (res->taskPackage &&
2769 res->taskPackage->which == Z_External_extendedService)
2771 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
2772 Odr_oct *id = taskPackage->targetReference;
2775 ZOOM_options_setl (c->tasks->u.package->options,
2776 "targetReference", (char*) id->buf, id->len);
2782 static void handle_apdu (ZOOM_connection c, Z_APDU *apdu)
2784 Z_InitResponse *initrs;
2787 yaz_log (LOG_DEBUG, "recv APDU type=%d", apdu->which);
2790 case Z_APDU_initResponse:
2791 initrs = apdu->u.initResponse;
2792 ZOOM_connection_option_set(c, "serverImplementationId",
2793 initrs->implementationId ?
2794 initrs->implementationId : "");
2795 ZOOM_connection_option_set(c, "serverImplementationName",
2796 initrs->implementationName ?
2797 initrs->implementationName : "");
2798 ZOOM_connection_option_set(c, "serverImplementationVersion",
2799 initrs->implementationVersion ?
2800 initrs->implementationVersion : "");
2801 /* Set the three old options too, for old applications */
2802 ZOOM_connection_option_set(c, "targetImplementationId",
2803 initrs->implementationId ?
2804 initrs->implementationId : "");
2805 ZOOM_connection_option_set(c, "targetImplementationName",
2806 initrs->implementationName ?
2807 initrs->implementationName : "");
2808 ZOOM_connection_option_set(c, "targetImplementationVersion",
2809 initrs->implementationVersion ?
2810 initrs->implementationVersion : "");
2811 if (!*initrs->result)
2813 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0);
2818 yaz_oi_get_string_oidval (&apdu->u.initResponse->otherInfo,
2820 xfree (c->cookie_in);
2823 c->cookie_in = xstrdup(cookie);
2824 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
2825 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
2826 c->support_named_resultsets = 1;
2829 assert (c->tasks->which == ZOOM_TASK_CONNECT);
2830 ZOOM_connection_remove_task (c);
2832 ZOOM_connection_exec_task (c);
2834 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
2836 NMEM tmpmem = nmem_create();
2837 Z_CharSetandLanguageNegotiation *p =
2838 yaz_get_charneg_record(initrs->otherInfo);
2842 char *charset=NULL, *lang=NULL;
2845 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
2846 yaz_log(LOG_DEBUG, "Target accepted: charset %s, "
2847 "language %s, select %d",
2848 charset ? charset : "none", lang ? lang : "none", sel);
2850 ZOOM_connection_option_set (c, "negotiation-charset",
2853 ZOOM_connection_option_set (c, "negotiation-lang",
2855 nmem_destroy(tmpmem);
2859 case Z_APDU_searchResponse:
2860 handle_search_response (c, apdu->u.searchResponse);
2861 if (send_sort_present (c) == zoom_complete)
2862 ZOOM_connection_remove_task (c);
2864 case Z_APDU_presentResponse:
2865 handle_present_response (c, apdu->u.presentResponse);
2866 if (send_present (c) == zoom_complete)
2867 ZOOM_connection_remove_task (c);
2869 case Z_APDU_sortResponse:
2870 sort_response (c, apdu->u.sortResponse);
2871 if (send_present (c) == zoom_complete)
2872 ZOOM_connection_remove_task (c);
2874 case Z_APDU_scanResponse:
2875 scan_response (c, apdu->u.scanResponse);
2876 ZOOM_connection_remove_task (c);
2878 case Z_APDU_extendedServicesResponse:
2879 es_response (c, apdu->u.extendedServicesResponse);
2880 ZOOM_connection_remove_task (c);
2883 if (c->reconnect_ok)
2886 c->tasks->running = 0;
2887 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
2891 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, 0);
2896 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2902 static void handle_srw_response(ZOOM_connection c,
2903 Z_SRW_searchRetrieveResponse *res)
2905 ZOOM_resultset resultset = 0;
2913 if (c->tasks->which == ZOOM_TASK_SEARCH)
2914 resultset = c->tasks->u.search.resultset;
2915 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
2916 resultset = c->tasks->u.retrieve.resultset;
2920 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2921 ZOOM_connection_put_event(c, event);
2923 resultset->size = 0;
2925 yaz_log(LOG_DEBUG, "got SRW response OK");
2927 if (res->numberOfRecords)
2928 resultset->size = *res->numberOfRecords;
2930 for (i = 0; i<res->num_records; i++)
2934 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
2935 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
2937 if (res->records[i].recordPosition &&
2938 *res->records[i].recordPosition > 0)
2939 pos = *res->records[i].recordPosition - 1;
2941 pos = resultset->start + i;
2943 npr->databaseName = 0;
2944 npr->which = Z_NamePlusRecord_databaseRecord;
2945 npr->u.databaseRecord = (Z_External *)
2946 odr_malloc(c->odr_in, sizeof(Z_External));
2947 npr->u.databaseRecord->descriptor = 0;
2948 npr->u.databaseRecord->direct_reference =
2949 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
2950 npr->u.databaseRecord->which = Z_External_octet;
2951 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
2952 odr_malloc(c->odr_in, sizeof(Odr_oct));
2953 npr->u.databaseRecord->u.octet_aligned->buf =
2954 res->records[i].recordData_buf;
2955 npr->u.databaseRecord->u.octet_aligned->len =
2956 npr->u.databaseRecord->u.octet_aligned->size =
2957 res->records[i].recordData_len;
2958 record_cache_add (resultset, npr, pos);
2960 if (res->num_diagnostics > 0)
2962 const char *code = res->diagnostics[0].code;
2967 if ((cp = strrchr(code, '/')))
2968 code_int = atoi(cp+1);
2969 set_dset_error(c, code_int, code,
2970 res->diagnostics[0].details, 0);
2973 nmem = odr_extract_mem(c->odr_in);
2974 nmem_transfer(resultset->odr->mem, nmem);
2980 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
2983 const char *content_type = z_HTTP_header_lookup(hres->headers,
2985 const char *connection_head = z_HTTP_header_lookup(hres->headers,
2988 yaz_log (LOG_DEBUG, "handle_http");
2990 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
2992 Z_SOAP *soap_package = 0;
2994 Z_SOAP_Handler soap_handlers[2] = {
2995 {"http://www.loc.gov/zing/srw/", 0,
2996 (Z_SOAP_fun) yaz_srw_codec},
2999 ret = z_soap_codec(o, &soap_package,
3000 &hres->content_buf, &hres->content_len,
3002 if (!ret && soap_package->which == Z_SOAP_generic &&
3003 soap_package->u.generic->no == 0)
3005 Z_SRW_PDU *sr = soap_package->u.generic->p;
3006 if (sr->which == Z_SRW_searchRetrieve_response)
3007 handle_srw_response(c, sr->u.response);
3011 else if (!ret && (soap_package->which == Z_SOAP_fault
3012 || soap_package->which == Z_SOAP_error))
3014 set_HTTP_error(c, hres->code,
3015 soap_package->u.fault->fault_code,
3016 soap_package->u.fault->fault_string);
3023 if (hres->code != 200)
3024 set_HTTP_error(c, hres->code, 0, 0);
3026 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3029 ZOOM_connection_remove_task(c);
3030 if (!strcmp(hres->version, "1.0"))
3032 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3033 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3038 /* HTTP 1.1: only if no close we stay alive .. */
3039 if (connection_head && !strcmp(connection_head, "close"))
3045 static int do_read (ZOOM_connection c)
3050 event = ZOOM_Event_create (ZOOM_EVENT_RECV_DATA);
3051 ZOOM_connection_put_event (c, event);
3053 r = cs_get (c->cs, &c->buf_in, &c->len_in);
3054 more = cs_more(c->cs);
3055 yaz_log (LOG_DEBUG, "do_read len=%d more=%d", r, more);
3060 if (c->reconnect_ok)
3063 c->reconnect_ok = 0;
3064 yaz_log (LOG_DEBUG, "reconnect read");
3065 c->tasks->running = 0;
3066 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3070 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, 0);
3079 odr_reset (c->odr_in);
3080 odr_setbuf (c->odr_in, c->buf_in, r, 0);
3081 event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);
3082 ZOOM_connection_put_event (c, event);
3084 if (!z_GDU (c->odr_in, &gdu, 0, 0))
3087 int err = odr_geterrorx(c->odr_in, &x);
3089 const char *element = odr_getelement(c->odr_in);
3090 sprintf (msg, "ODR code %d:%d element=%-20s",
3091 err, x, element ? element : "<unknown>");
3092 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3095 else if (gdu->which == Z_GDU_Z3950)
3096 handle_apdu (c, gdu->u.z3950);
3097 else if (gdu->which == Z_GDU_HTTP_Response)
3100 handle_http (c, gdu->u.HTTP_Response);
3102 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3106 c->reconnect_ok = 0;
3111 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out)
3116 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3117 ZOOM_connection_put_event (c, event);
3119 yaz_log (LOG_DEBUG, "do_write_ex len=%d", len_out);
3120 if ((r=cs_put (c->cs, buf_out, len_out)) < 0)
3122 if (c->reconnect_ok)
3125 c->reconnect_ok = 0;
3126 yaz_log (LOG_DEBUG, "reconnect write");
3127 c->tasks->running = 0;
3128 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3129 return zoom_pending;
3131 if (c->state == STATE_CONNECTING)
3132 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, 0);
3134 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, 0);
3136 return zoom_complete;
3140 c->mask = ZOOM_SELECT_EXCEPT;
3141 if (c->cs->io_pending & CS_WANT_WRITE)
3142 c->mask += ZOOM_SELECT_WRITE;
3143 if (c->cs->io_pending & CS_WANT_READ)
3144 c->mask += ZOOM_SELECT_READ;
3145 yaz_log (LOG_DEBUG, "do_write_ex 1 mask=%d", c->mask);
3149 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3150 yaz_log (LOG_DEBUG, "do_write_ex 2 mask=%d", c->mask);
3152 return zoom_pending;
3155 static zoom_ret do_write(ZOOM_connection c)
3157 return do_write_ex (c, c->buf_out, c->len_out);
3161 ZOOM_API(const char *)
3162 ZOOM_connection_option_get (ZOOM_connection c, const char *key)
3164 return ZOOM_options_get (c->options, key);
3168 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
3171 ZOOM_options_set (c->options, key, val);
3174 ZOOM_API(const char *)
3175 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key)
3177 return ZOOM_options_get (r->options, key);
3181 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key,
3184 ZOOM_options_set (r->options, key, val);
3189 ZOOM_connection_errcode (ZOOM_connection c)
3191 return ZOOM_connection_error (c, 0, 0);
3194 ZOOM_API(const char *)
3195 ZOOM_connection_errmsg (ZOOM_connection c)
3198 ZOOM_connection_error (c, &msg, 0);
3202 ZOOM_API(const char *)
3203 ZOOM_connection_addinfo (ZOOM_connection c)
3205 const char *addinfo;
3206 ZOOM_connection_error (c, 0, &addinfo);
3210 ZOOM_API(const char *)
3211 ZOOM_diag_str (int error)
3215 case ZOOM_ERROR_NONE:
3217 case ZOOM_ERROR_CONNECT:
3218 return "Connect failed";
3219 case ZOOM_ERROR_MEMORY:
3220 return "Out of memory";
3221 case ZOOM_ERROR_ENCODE:
3222 return "Encoding failed";
3223 case ZOOM_ERROR_DECODE:
3224 return "Decoding failed";
3225 case ZOOM_ERROR_CONNECTION_LOST:
3226 return "Connection lost";
3227 case ZOOM_ERROR_INIT:
3228 return "Init rejected";
3229 case ZOOM_ERROR_INTERNAL:
3230 return "Internal failure";
3231 case ZOOM_ERROR_TIMEOUT:
3233 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3234 return "Unsupported protocol";
3235 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3236 return "Unsupported query type";
3238 return diagbib1_str (error);
3243 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
3244 const char **addinfo, const char **diagset)
3246 int error = c->error;
3249 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3250 *cp = ZOOM_diag_str(error);
3251 else if (!strcmp(c->diagset, "HTTP"))
3252 *cp = z_HTTP_errmsg(c->error);
3253 else if (!strcmp(c->diagset, "Bib-1"))
3254 *cp = ZOOM_diag_str(error);
3255 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3256 *cp = yaz_diag_srw_str(c->error);
3258 *cp = "Unknown error and diagnostic set";
3261 *addinfo = c->addinfo ? c->addinfo : "";
3263 *diagset = c->diagset ? c->diagset : "";
3268 ZOOM_connection_error (ZOOM_connection c, const char **cp,
3269 const char **addinfo)
3271 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3274 static int ZOOM_connection_do_io(ZOOM_connection c, int mask)
3276 ZOOM_Event event = 0;
3277 int r = cs_look(c->cs);
3278 yaz_log (LOG_DEBUG, "ZOOM_connection_do_io c=%p mask=%d cs_look=%d",
3283 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3284 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, 0);
3286 ZOOM_connection_put_event (c, event);
3288 else if (r == CS_CONNECT)
3291 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3293 ret = cs_rcvconnect (c->cs);
3294 yaz_log (LOG_DEBUG, "cs_rcvconnect returned %d", ret);
3297 c->mask = ZOOM_SELECT_EXCEPT;
3298 if (c->cs->io_pending & CS_WANT_WRITE)
3299 c->mask += ZOOM_SELECT_WRITE;
3300 if (c->cs->io_pending & CS_WANT_READ)
3301 c->mask += ZOOM_SELECT_READ;
3302 ZOOM_connection_put_event (c, event);
3306 ZOOM_connection_put_event (c, event);
3307 if (c->proto == PROTO_Z3950)
3308 ZOOM_connection_send_init(c);
3311 /* no init request for SRW .. */
3312 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3313 ZOOM_connection_remove_task (c);
3315 ZOOM_connection_exec_task (c);
3317 c->state = STATE_ESTABLISHED;
3321 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, 0);
3323 ZOOM_connection_put_event (c, event);
3328 if (mask & ZOOM_SELECT_READ)
3330 if (c->cs && (mask & ZOOM_SELECT_WRITE))
3337 ZOOM_connection_last_event(ZOOM_connection cs)
3340 return ZOOM_EVENT_NONE;
3341 return cs->last_event;
3345 ZOOM_event (int no, ZOOM_connection *cs)
3349 struct pollfd pollfds[1024];
3350 ZOOM_connection poll_cs[1024];
3353 fd_set input, output, except;
3358 for (i = 0; i<no; i++)
3360 ZOOM_connection c = cs[i];
3362 if (c && (event = ZOOM_connection_get_event(c)))
3364 ZOOM_Event_destroy (event);
3368 for (i = 0; i<no; i++)
3370 ZOOM_connection c = cs[i];
3372 if (c && ZOOM_connection_exec_task (c))
3374 if ((event = ZOOM_connection_get_event(c)))
3376 ZOOM_Event_destroy (event);
3389 for (i = 0; i<no; i++)
3391 ZOOM_connection c = cs[i];
3397 fd = z3950_connection_socket(c);
3398 mask = z3950_connection_mask(c);
3405 this_timeout = ZOOM_options_get_int (c->options, "timeout", -1);
3406 if (this_timeout != -1 && this_timeout < timeout)
3407 timeout = this_timeout;
3411 short poll_events = 0;
3413 if (mask & ZOOM_SELECT_READ)
3414 poll_events += POLLIN;
3415 if (mask & ZOOM_SELECT_WRITE)
3416 poll_events += POLLOUT;
3417 if (mask & ZOOM_SELECT_EXCEPT)
3418 poll_events += POLLERR;
3419 pollfds[nfds].fd = fd;
3420 pollfds[nfds].events = poll_events;
3421 pollfds[nfds].revents = 0;
3426 if (mask & ZOOM_SELECT_READ)
3428 FD_SET (fd, &input);
3431 if (mask & ZOOM_SELECT_WRITE)
3433 FD_SET (fd, &output);
3436 if (mask & ZOOM_SELECT_EXCEPT)
3438 FD_SET (fd, &except);
3443 if (timeout >= 5000)
3450 r = poll (pollfds, nfds, timeout * 1000);
3451 for (i = 0; i<nfds; i++)
3453 ZOOM_connection c = poll_cs[i];
3457 if (pollfds[i].revents & POLLIN)
3458 mask += ZOOM_SELECT_READ;
3459 if (pollfds[i].revents & POLLOUT)
3460 mask += ZOOM_SELECT_WRITE;
3461 if (pollfds[i].revents & POLLERR)
3462 mask += ZOOM_SELECT_EXCEPT;
3464 ZOOM_connection_do_io(c, mask);
3466 else if (r == 0 && c->mask)
3468 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3469 /* timeout and this connection was waiting */
3470 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3472 ZOOM_connection_put_event(c, event);
3476 tv.tv_sec = timeout;
3478 yaz_log (LOG_DEBUG, "select start");
3479 r = select (max_fd+1, &input, &output, &except, &tv);
3480 yaz_log (LOG_DEBUG, "select stop, returned r=%d", r);
3481 for (i = 0; i<no; i++)
3483 ZOOM_connection c = cs[i];
3488 fd = z3950_connection_socket(c);
3492 /* no timeout and real socket */
3493 if (FD_ISSET(fd, &input))
3494 mask += ZOOM_SELECT_READ;
3495 if (FD_ISSET(fd, &output))
3496 mask += ZOOM_SELECT_WRITE;
3497 if (FD_ISSET(fd, &except))
3498 mask += ZOOM_SELECT_EXCEPT;
3500 ZOOM_connection_do_io(c, mask);
3502 if (r == 0 && c->mask)
3504 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3505 /* timeout and this connection was waiting */
3506 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3508 yaz_log (LOG_DEBUG, "timeout");
3509 ZOOM_connection_put_event(c, event);
3513 for (i = 0; i<no; i++)
3515 ZOOM_connection c = cs[i];
3517 if (c && (event = ZOOM_connection_get_event(c)))
3519 ZOOM_Event_destroy (event);