2 * Copyright (c) 2000-2004, Index Data
3 * See the file LICENSE for details.
5 * $Id: zoom-c.c,v 1.25 2004-02-23 09:26:11 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);
203 ZOOM_resultset_destroy (task->u.sort.resultset);
204 ZOOM_query_destroy(task->u.sort.q);
213 static int ZOOM_connection_exec_task (ZOOM_connection c);
215 void ZOOM_connection_remove_tasks (ZOOM_connection c)
218 ZOOM_connection_remove_task(c);
221 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos);
223 ZOOM_API(ZOOM_connection)
224 ZOOM_connection_create (ZOOM_options options)
226 ZOOM_connection c = (ZOOM_connection) xmalloc (sizeof(*c));
228 c->proto = PROTO_Z3950;
232 c->state = STATE_IDLE;
235 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
242 c->options = ZOOM_options_create_with_parent(options);
248 c->charset = c->lang = 0;
255 c->odr_in = odr_createmem (ODR_DECODE);
256 c->odr_out = odr_createmem (ODR_ENCODE);
259 c->support_named_resultsets = 0;
260 c->last_event = ZOOM_EVENT_NONE;
262 c->m_queue_front = 0;
267 /* set database names. Take local databases (if set); otherwise
268 take databases given in ZURL (if set); otherwise use Default */
269 static char **set_DatabaseNames (ZOOM_connection con, ZOOM_options options,
272 char **databaseNames;
275 const char *cp = ZOOM_options_get (options, "databaseName");
279 if (strncmp (con->host_port, "unix:", 5) == 0)
280 cp = strchr (con->host_port+5, ':');
282 cp = strchr (con->host_port, '/');
289 while ((c = strchr(c, '+')))
297 databaseNames = (char**)
298 odr_malloc (con->odr_out, no * sizeof(*databaseNames));
302 c = strchr (cp, '+');
310 /* cp ptr to first char of db name, c is char
312 databaseNames[no] = (char*) odr_malloc (con->odr_out, 1+c-cp);
313 memcpy (databaseNames[no], cp, c-cp);
314 databaseNames[no++][c-cp] = '\0';
319 databaseNames[no] = NULL;
321 return databaseNames;
324 ZOOM_API(ZOOM_connection)
325 ZOOM_connection_new (const char *host, int portnum)
327 ZOOM_connection c = ZOOM_connection_create (0);
329 ZOOM_connection_connect (c, host, portnum);
334 ZOOM_connection_connect(ZOOM_connection c,
335 const char *host, int portnum)
342 yaz_log (LOG_DEBUG, "reconnect");
346 yaz_log(LOG_DEBUG, "connect");
348 val = ZOOM_options_get (c->options, "proxy");
350 c->proxy = xstrdup (val);
355 val = ZOOM_options_get (c->options, "charset");
357 c->charset = xstrdup (val);
362 val = ZOOM_options_get (c->options, "lang");
364 c->lang = xstrdup (val);
368 xfree (c->host_port);
372 sprintf (hostn, "%.80s:%d", host, portnum);
373 c->host_port = xstrdup(hostn);
376 c->host_port = xstrdup(host);
378 ZOOM_options_set(c->options, "host", c->host_port);
380 val = ZOOM_options_get (c->options, "cookie");
382 c->cookie_out = xstrdup (val);
384 val = ZOOM_options_get (c->options, "clientIP");
386 c->client_IP = xstrdup (val);
388 c->async = ZOOM_options_get_bool (c->options, "async", 0);
390 set_ZOOM_error(c, ZOOM_ERROR_NONE, 0);
392 task = ZOOM_connection_add_task (c, ZOOM_TASK_CONNECT);
396 while (ZOOM_event (1, &c))
402 ZOOM_query_create(void)
404 ZOOM_query s = (ZOOM_query) xmalloc (sizeof(*s));
409 s->odr = odr_createmem (ODR_ENCODE);
416 ZOOM_query_destroy(ZOOM_query s)
422 yaz_log (LOG_DEBUG, "ZOOM_query_destroy count=%d", s->refcount);
423 if (s->refcount == 0)
425 odr_destroy (s->odr);
431 ZOOM_query_prefix(ZOOM_query s, const char *str)
433 s->query_string = odr_strdup(s->odr, str);
434 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
435 s->z_query->which = Z_Query_type_1;
436 s->z_query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
437 if (!s->z_query->u.type_1)
446 ZOOM_query_cql(ZOOM_query s, const char *str)
450 s->query_string = odr_strdup(s->odr, str);
452 ext = (Z_External *) odr_malloc(s->odr, sizeof(*ext));
453 ext->direct_reference = odr_getoidbystr(s->odr, "1.2.840.10003.16.2");
454 ext->indirect_reference = 0;
456 ext->which = Z_External_CQL;
457 ext->u.cql = s->query_string;
459 s->z_query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->z_query));
460 s->z_query->which = Z_Query_type_104;
461 s->z_query->u.type_104 = ext;
467 ZOOM_query_sortby(ZOOM_query s, const char *criteria)
469 s->sort_spec = yaz_sort_spec (s->odr, criteria);
475 static zoom_ret do_write(ZOOM_connection c);
478 ZOOM_connection_destroy(ZOOM_connection c)
485 for (r = c->resultsets; r; r = r->next)
491 odr_destroy (c->odr_in);
492 odr_destroy (c->odr_out);
493 ZOOM_options_destroy (c->options);
494 ZOOM_connection_remove_tasks (c);
495 xfree (c->host_port);
500 xfree (c->cookie_out);
501 xfree (c->cookie_in);
502 xfree (c->client_IP);
506 void ZOOM_resultset_addref (ZOOM_resultset r)
511 yaz_log (LOG_DEBUG, "ZOOM_resultset_addref r=%p count=%d",
516 ZOOM_resultset ZOOM_resultset_create ()
518 ZOOM_resultset r = (ZOOM_resultset) xmalloc (sizeof(*r));
520 yaz_log (LOG_DEBUG, "ZOOM_resultset_create r = %p", r);
523 r->odr = odr_createmem (ODR_ENCODE);
538 ZOOM_API(ZOOM_resultset)
539 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
542 ZOOM_query s = ZOOM_query_create();
544 ZOOM_query_prefix (s, q);
546 r = ZOOM_connection_search (c, s);
547 ZOOM_query_destroy (s);
551 ZOOM_API(ZOOM_resultset)
552 ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
554 ZOOM_resultset r = ZOOM_resultset_create ();
558 r->r_sort_spec = q->sort_spec;
561 r->options = ZOOM_options_create_with_parent(c->options);
563 r->start = ZOOM_options_get_int(r->options, "start", 0);
564 r->count = ZOOM_options_get_int(r->options, "count", 0);
566 /* If "presentChunk" is defined use that; otherwise "step" */
567 const char *cp = ZOOM_options_get (r->options, "presentChunk");
568 r->step = ZOOM_options_get_int(r->options,
569 (cp != 0 ? "presentChunk": "step"), 0);
571 r->piggyback = ZOOM_options_get_bool (r->options, "piggyback", 1);
572 cp = ZOOM_options_get (r->options, "setname");
574 r->setname = xstrdup(cp);
575 cp = ZOOM_options_get (r->options, "schema");
577 r->schema = xstrdup(cp);
581 r->next = c->resultsets;
584 if (c->host_port && c->proto == PROTO_HTTP)
588 yaz_log(LOG_DEBUG, "NO COMSTACK");
589 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
593 yaz_log(LOG_DEBUG, "PREPARE FOR RECONNECT");
598 task = ZOOM_connection_add_task (c, ZOOM_TASK_SEARCH);
599 task->u.search.resultset = r;
600 ZOOM_resultset_addref (r);
606 while (ZOOM_event (1, &c))
613 ZOOM_resultset_sort(ZOOM_resultset r,
614 const char *sort_type, const char *sort_spec)
616 ZOOM_connection c = r->connection;
622 if (c->host_port && c->proto == PROTO_HTTP)
626 yaz_log(LOG_DEBUG, "NO COMSTACK");
627 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
631 yaz_log(LOG_DEBUG, "PREPARE FOR RECONNECT");
636 ZOOM_resultset_cache_reset(r);
637 task = ZOOM_connection_add_task (c, ZOOM_TASK_SORT);
638 task->u.sort.resultset = r;
639 task->u.sort.q = ZOOM_query_create();
640 ZOOM_query_sortby(task->u.sort.q, sort_spec);
642 ZOOM_resultset_addref (r);
646 while (ZOOM_event (1, &c))
652 ZOOM_resultset_cache_reset(ZOOM_resultset r)
654 ZOOM_record_cache rc;
656 for (rc = r->record_cache; rc; rc = rc->next)
658 if (rc->rec.wrbuf_marc)
659 wrbuf_free (rc->rec.wrbuf_marc, 1);
660 if (rc->rec.wrbuf_iconv)
661 wrbuf_free (rc->rec.wrbuf_iconv, 1);
662 if (rc->rec.wrbuf_opac)
663 wrbuf_free (rc->rec.wrbuf_opac, 1);
669 ZOOM_resultset_destroy(ZOOM_resultset r)
674 yaz_log (LOG_DEBUG, "ZOOM_resultset_destroy r = %p count=%d",
676 if (r->refcount == 0)
678 ZOOM_resultset_cache_reset(r);
682 /* remove ourselves from the resultsets in connection */
683 ZOOM_resultset *rp = &r->connection->resultsets;
686 assert (*rp); /* we must be in this list!! */
688 { /* OK, we're here - take us out of it */
695 ZOOM_query_destroy (r->query);
696 ZOOM_options_destroy (r->options);
697 odr_destroy (r->odr);
705 ZOOM_resultset_size (ZOOM_resultset r)
710 static void do_close (ZOOM_connection c)
716 c->state = STATE_IDLE;
719 static void ZOOM_resultset_retrieve (ZOOM_resultset r,
720 int force_sync, int start, int count)
732 if (c->host_port && c->proto == PROTO_HTTP)
736 yaz_log(LOG_DEBUG, "NO COMSTACK");
737 ZOOM_connection_add_task(c, ZOOM_TASK_CONNECT);
741 yaz_log(LOG_DEBUG, "PREPARE FOR RECONNECT");
745 task = ZOOM_connection_add_task (c, ZOOM_TASK_RETRIEVE);
746 task->u.retrieve.resultset = r;
747 task->u.retrieve.start = start;
748 task->u.retrieve.count = count;
750 cp = ZOOM_options_get (r->options, "schema");
753 if (!r->schema || strcmp(r->schema, cp))
756 r->schema = xstrdup(cp);
760 ZOOM_resultset_addref (r);
762 if (!r->connection->async || force_sync)
763 while (r->connection && ZOOM_event (1, &r->connection))
768 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
769 size_t start, size_t count)
771 int force_present = 0;
777 ZOOM_resultset_retrieve (r, force_present, start, count);
781 for (i = 0; i< count; i++)
782 recs[i] = ZOOM_resultset_record_immediate (r, i+start);
786 static zoom_ret do_connect (ZOOM_connection c)
789 const char *effective_host;
792 effective_host = c->proxy;
794 effective_host = c->host_port;
796 yaz_log (LOG_DEBUG, "do_connect host=%s", effective_host);
799 c->cs = cs_create_host (effective_host, 0, &add);
801 if (c->cs && c->cs->protocol == PROTO_HTTP)
804 const char *path = 0;
806 c->proto = PROTO_HTTP;
807 cs_get_host_args(c->host_port, &path);
809 c->path = xmalloc(strlen(path)+2);
811 strcpy (c->path+1, path);
813 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_PROTOCOL, "SRW");
815 return zoom_complete;
820 int ret = cs_connect (c->cs, add);
823 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
824 ZOOM_connection_put_event(c, event);
825 if (c->proto == PROTO_Z3950)
826 ZOOM_connection_send_init(c);
829 /* no init request for SRW .. */
830 assert (c->tasks->which == ZOOM_TASK_CONNECT);
831 ZOOM_connection_remove_task (c);
833 ZOOM_connection_exec_task (c);
835 c->state = STATE_ESTABLISHED;
840 c->state = STATE_CONNECTING;
841 c->mask = ZOOM_SELECT_EXCEPT;
842 if (c->cs->io_pending & CS_WANT_WRITE)
843 c->mask += ZOOM_SELECT_WRITE;
844 if (c->cs->io_pending & CS_WANT_READ)
845 c->mask += ZOOM_SELECT_READ;
849 c->state = STATE_IDLE;
850 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, effective_host);
851 return zoom_complete;
854 int z3950_connection_socket(ZOOM_connection c)
857 return cs_fileno(c->cs);
861 int z3950_connection_mask(ZOOM_connection c)
868 static void otherInfo_attach (ZOOM_connection c, Z_APDU *a, ODR out)
871 for (i = 0; i<200; i++)
874 Z_OtherInformation **oi;
880 sprintf (buf, "otherInfo%d", i);
881 val = ZOOM_options_get (c->options, buf);
884 cp = strchr (val, ':');
888 if (len >= sizeof(buf))
890 memcpy (buf, val, len);
892 oidval = oid_getvalbyname (buf);
893 if (oidval == VAL_NONE)
897 yaz_oi_set_string_oidval(oi, out, oidval, 1, cp+1);
901 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
906 Z_OtherInformation **oi;
908 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
912 Z_OtherInformation **oi;
914 yaz_oi_set_string_oidval(oi, out, VAL_CLIENT_IP, 1, c->client_IP);
916 otherInfo_attach (c, a, out);
917 if (!z_APDU(out, &a, 0, 0))
919 FILE *outf = fopen("/tmp/apdu.txt", "a");
922 ODR odr_pr = odr_createmem(ODR_PRINT);
923 fprintf (outf, "a=%p\n", a);
924 odr_setprint(odr_pr, outf);
925 z_APDU(odr_pr, &a, 0, 0);
928 yaz_log (LOG_DEBUG, "encoding failed");
929 set_ZOOM_error(c, ZOOM_ERROR_ENCODE, 0);
937 static zoom_ret send_APDU (ZOOM_connection c, Z_APDU *a)
941 if (encode_APDU(c, a, c->odr_out))
942 return zoom_complete;
943 yaz_log(LOG_DEBUG, "send APDU type=%d", a->which);
944 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
945 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
946 ZOOM_connection_put_event (c, event);
947 odr_reset(c->odr_out);
951 /* returns 1 if PDU was sent OK (still pending )
952 0 if PDU was not sent OK (nothing to wait for)
955 static zoom_ret ZOOM_connection_send_init (ZOOM_connection c)
957 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
958 Z_InitRequest *ireq = apdu->u.initRequest;
959 Z_IdAuthentication *auth = (Z_IdAuthentication *)
960 odr_malloc(c->odr_out, sizeof(*auth));
961 const char *auth_groupId = ZOOM_options_get (c->options, "group");
962 const char *auth_userId = ZOOM_options_get (c->options, "user");
963 const char *auth_password = ZOOM_options_get (c->options, "password");
966 /* support the pass for backwards compatibility */
968 auth_password = ZOOM_options_get (c->options, "pass");
970 ODR_MASK_SET(ireq->options, Z_Options_search);
971 ODR_MASK_SET(ireq->options, Z_Options_present);
972 ODR_MASK_SET(ireq->options, Z_Options_scan);
973 ODR_MASK_SET(ireq->options, Z_Options_sort);
974 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
975 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
977 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
978 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
979 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
981 /* Index Data's Z39.50 Implementor Id is 81 */
982 ireq->implementationId = odr_prepend(c->odr_out,
983 ZOOM_options_get(c->options, "implementationId"),
984 odr_prepend(c->odr_out, "81", ireq->implementationId));
986 ireq->implementationName = odr_prepend(c->odr_out,
987 ZOOM_options_get(c->options, "implementationName"),
988 odr_prepend(c->odr_out, "ZOOM-C", ireq->implementationName));
990 version = odr_strdup(c->odr_out, "$Revision: 1.25 $");
991 if (strlen(version) > 10) /* check for unexpanded CVS strings */
992 version[strlen(version)-2] = '\0';
993 ireq->implementationVersion = odr_prepend(c->odr_out,
994 ZOOM_options_get(c->options, "implementationVersion"),
995 odr_prepend(c->odr_out, &version[11], ireq->implementationVersion));
997 *ireq->maximumRecordSize =
998 ZOOM_options_get_int (c->options, "maximumRecordSize", 1024*1024);
999 *ireq->preferredMessageSize =
1000 ZOOM_options_get_int (c->options, "preferredMessageSize", 1024*1024);
1002 if (auth_groupId || auth_password)
1004 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
1007 if (auth_groupId && *auth_groupId)
1009 pass->groupId = (char *)
1010 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
1011 strcpy(pass->groupId, auth_groupId);
1015 if (auth_userId && *auth_userId)
1017 pass->userId = (char *)
1018 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1019 strcpy(pass->userId, auth_userId);
1023 if (auth_password && *auth_password)
1025 pass->password = (char *)
1026 odr_malloc(c->odr_out, strlen(auth_password)+1);
1027 strcpy(pass->password, auth_password);
1032 auth->which = Z_IdAuthentication_idPass;
1033 auth->u.idPass = pass;
1034 ireq->idAuthentication = auth;
1037 else if (auth_userId)
1039 auth->which = Z_IdAuthentication_open;
1040 auth->u.open = (char *)
1041 odr_malloc(c->odr_out, strlen(auth_userId)+1);
1042 strcpy(auth->u.open, auth_userId);
1043 ireq->idAuthentication = auth;
1046 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
1047 VAL_PROXY, 1, c->host_port);
1048 if (c->charset||c->lang)
1050 Z_OtherInformation **oi;
1051 Z_OtherInformationUnit *oi_unit;
1053 yaz_oi_APDU(apdu, &oi);
1055 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
1057 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
1059 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
1060 oi_unit->information.externallyDefinedInfo =
1061 yaz_set_proposal_charneg
1063 (const char **)&c->charset, (c->charset) ? 1:0,
1064 (const char **)&c->lang, (c->lang) ? 1:0, 1);
1068 return send_APDU (c, apdu);
1072 static zoom_ret send_srw (ZOOM_connection c, Z_SRW_PDU *sr)
1075 Z_SOAP_Handler h[2] = {
1076 {"http://www.loc.gov/zing/srw/", 0, (Z_SOAP_fun) yaz_srw_codec},
1079 ODR o = odr_createmem(ODR_ENCODE);
1081 Z_SOAP *p = odr_malloc(o, sizeof(*p));
1085 gdu = z_get_HTTP_Request(c->odr_out);
1086 gdu->u.HTTP_Request->path = c->path;
1090 const char *cp0 = strstr(c->host_port, "://");
1091 const char *cp1 = 0;
1097 cp1 = strchr(cp0, '/');
1099 cp1 = cp0+strlen(cp0);
1103 char *h = odr_malloc(c->odr_out, cp1 - cp0 + 1);
1104 memcpy (h, cp0, cp1 - cp0);
1106 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1111 strcpy(ctype, "text/xml");
1112 if (c->charset && strlen(c->charset) < 20)
1114 strcat(ctype, "; charset=");
1115 strcat(ctype, c->charset);
1117 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1118 "Content-Type", ctype);
1119 z_HTTP_header_add(c->odr_out, &gdu->u.HTTP_Request->headers,
1120 "SOAPAction", "\"\"");
1121 p->which = Z_SOAP_generic;
1122 p->u.generic = odr_malloc(o, sizeof(*p->u.generic));
1123 p->u.generic->no = 0;
1124 p->u.generic->ns = 0;
1125 p->u.generic->p = sr;
1126 p->ns = "http://schemas.xmlsoap.org/soap/envelope/";
1128 ret = z_soap_codec_enc(o, &p,
1129 &gdu->u.HTTP_Request->content_buf,
1130 &gdu->u.HTTP_Request->content_len, h,
1133 if (!z_GDU(c->odr_out, &gdu, 0, 0))
1134 return zoom_complete;
1135 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
1139 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
1140 ZOOM_connection_put_event (c, event);
1141 odr_reset(c->odr_out);
1142 return do_write (c);
1147 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1150 ZOOM_resultset resultset = 0;
1152 const char *recordPacking = 0;
1154 if (c->error) /* don't continue on error */
1155 return zoom_complete;
1157 if (c->tasks->which == ZOOM_TASK_SEARCH)
1159 resultset = c->tasks->u.search.resultset;
1160 resultset->setname = xstrdup ("default");
1161 ZOOM_options_set (resultset->options, "setname", resultset->setname);
1163 else if(c->tasks->which == ZOOM_TASK_RETRIEVE)
1165 resultset = c->tasks->u.retrieve.resultset;
1167 resultset->start = c->tasks->u.retrieve.start;
1168 resultset->count = c->tasks->u.retrieve.count;
1170 if (resultset->start >= resultset->size)
1171 return zoom_complete;
1172 if (resultset->start + resultset->count > resultset->size)
1173 resultset->count = resultset->size - resultset->start;
1175 for (i = 0; i<resultset->count; i++)
1178 record_cache_lookup (resultset, i + resultset->start);
1182 if (i == resultset->count)
1183 return zoom_complete;
1185 assert(resultset->query);
1187 sr = yaz_srw_get(c->odr_out, Z_SRW_searchRetrieve_request);
1189 if (resultset->query->z_query->which == Z_Query_type_104
1190 && resultset->query->z_query->u.type_104->which == Z_External_CQL)
1193 sr->u.request->query_type = Z_SRW_query_type_cql;
1194 sr->u.request->query.cql =resultset->query->z_query->u.type_104->u.cql;
1196 else if (resultset->query->z_query->which == Z_Query_type_1 &&
1197 resultset->query->z_query->u.type_1)
1199 sr->u.request->query_type = Z_SRW_query_type_pqf;
1200 sr->u.request->query.pqf = resultset->query->query_string;
1204 set_ZOOM_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
1205 return zoom_complete;
1207 sr->u.request->startRecord = odr_intdup (c->odr_out, resultset->start + 1);
1208 sr->u.request->maximumRecords = odr_intdup (
1209 c->odr_out, resultset->step>0 ? resultset->step : resultset->count);
1210 sr->u.request->recordSchema = resultset->schema;
1212 recordPacking = ZOOM_resultset_option_get (resultset, "recordPacking");
1215 sr->u.request->recordPacking = odr_strdup(c->odr_out, recordPacking);
1217 return send_srw(c, sr);
1220 static zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c)
1222 return zoom_complete;
1226 static zoom_ret ZOOM_connection_send_search (ZOOM_connection c)
1229 int lslb, ssub, mspn;
1231 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
1232 Z_SearchRequest *search_req = apdu->u.searchRequest;
1233 const char *elementSetName;
1234 const char *smallSetElementSetName;
1235 const char *mediumSetElementSetName;
1238 assert (c->tasks->which == ZOOM_TASK_SEARCH);
1240 r = c->tasks->u.search.resultset;
1243 ZOOM_options_get (r->options, "elementSetName");
1244 smallSetElementSetName =
1245 ZOOM_options_get (r->options, "smallSetElementSetName");
1246 mediumSetElementSetName =
1247 ZOOM_options_get (r->options, "mediumSetElementSetName");
1249 if (!smallSetElementSetName)
1250 smallSetElementSetName = elementSetName;
1252 if (!mediumSetElementSetName)
1253 mediumSetElementSetName = elementSetName;
1258 /* prepare query for the search request */
1259 search_req->query = r->query->z_query;
1260 if (!search_req->query)
1262 set_ZOOM_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
1263 return zoom_complete;
1266 search_req->databaseNames =
1267 set_DatabaseNames (c, r->options, &search_req->num_databaseNames);
1269 /* get syntax (no need to provide unless piggyback is in effect) */
1270 syntax = ZOOM_options_get (r->options, "preferredRecordSyntax");
1272 lslb = ZOOM_options_get_int (r->options, "largeSetLowerBound", -1);
1273 ssub = ZOOM_options_get_int (r->options, "smallSetUpperBound", -1);
1274 mspn = ZOOM_options_get_int (r->options, "mediumSetPresentNumber", -1);
1275 if (lslb != -1 && ssub != -1 && mspn != -1)
1277 /* So're a Z39.50 expert? Let's hope you don't do sort */
1278 *search_req->largeSetLowerBound = lslb;
1279 *search_req->smallSetUpperBound = ssub;
1280 *search_req->mediumSetPresentNumber = mspn;
1282 else if (r->start == 0 && r->count > 0
1283 && r->piggyback && !r->r_sort_spec && !r->schema)
1285 /* Regular piggyback - do it unless we're going to do sort */
1286 *search_req->largeSetLowerBound = 2000000000;
1287 *search_req->smallSetUpperBound = 1;
1288 *search_req->mediumSetPresentNumber = r->step>0 ? r->step : r->count;
1292 /* non-piggyback. Need not provide elementsets or syntaxes .. */
1293 smallSetElementSetName = 0;
1294 mediumSetElementSetName = 0;
1297 if (smallSetElementSetName && *smallSetElementSetName)
1299 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1300 odr_malloc (c->odr_out, sizeof(*esn));
1302 esn->which = Z_ElementSetNames_generic;
1303 esn->u.generic = odr_strdup (c->odr_out, smallSetElementSetName);
1304 search_req->smallSetElementSetNames = esn;
1306 if (mediumSetElementSetName && *mediumSetElementSetName)
1308 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1309 odr_malloc (c->odr_out, sizeof(*esn));
1311 esn->which = Z_ElementSetNames_generic;
1312 esn->u.generic = odr_strdup (c->odr_out, mediumSetElementSetName);
1313 search_req->mediumSetElementSetNames = esn;
1316 search_req->preferredRecordSyntax =
1317 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1321 if (c->support_named_resultsets)
1325 /* find the lowest unused ordinal so that we re-use
1326 result sets on the server. */
1327 for (ord = 1; ; ord++)
1330 sprintf (setname, "%d", ord);
1331 for (rp = c->resultsets; rp; rp = rp->next)
1332 if (rp->setname && !strcmp (rp->setname, setname))
1337 r->setname = xstrdup (setname);
1338 yaz_log (LOG_DEBUG, "allocating set %s", r->setname);
1341 r->setname = xstrdup ("default");
1342 ZOOM_options_set (r->options, "setname", r->setname);
1344 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
1345 /* send search request */
1346 return send_APDU (c, apdu);
1349 static void response_diag (ZOOM_connection c, Z_DiagRec *p)
1352 Z_DefaultDiagFormat *r;
1357 if (p->which != Z_DiagRec_defaultFormat)
1359 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1362 r = p->u.defaultFormat;
1365 case Z_DefaultDiagFormat_v2Addinfo:
1366 addinfo = r->u.v2Addinfo;
1368 case Z_DefaultDiagFormat_v3Addinfo:
1369 addinfo = r->u.v3Addinfo;
1372 set_dset_error(c, *r->condition,
1373 yaz_z3950oid_to_str(r->diagnosticSetId, &oclass),
1377 ZOOM_API(ZOOM_record)
1378 ZOOM_record_clone (ZOOM_record srec)
1385 odr_enc = odr_createmem(ODR_ENCODE);
1386 if (!z_NamePlusRecord (odr_enc, &srec->npr, 0, 0))
1388 buf = odr_getbuf (odr_enc, &size, 0);
1390 nrec = (ZOOM_record) xmalloc (sizeof(*nrec));
1391 nrec->odr = odr_createmem(ODR_DECODE);
1392 nrec->wrbuf_marc = 0;
1393 nrec->wrbuf_iconv = 0;
1394 nrec->wrbuf_opac = 0;
1395 odr_setbuf (nrec->odr, buf, size, 0);
1396 z_NamePlusRecord (nrec->odr, &nrec->npr, 0, 0);
1398 odr_destroy (odr_enc);
1402 ZOOM_API(ZOOM_record)
1403 ZOOM_resultset_record_immediate (ZOOM_resultset s,size_t pos)
1405 return record_cache_lookup (s, pos);
1408 ZOOM_API(ZOOM_record)
1409 ZOOM_resultset_record (ZOOM_resultset r, size_t pos)
1411 ZOOM_record rec = ZOOM_resultset_record_immediate(r, pos);
1415 ZOOM_resultset_retrieve (r, 1, pos, 1);
1416 rec = ZOOM_resultset_record_immediate (r, pos);
1422 ZOOM_record_destroy (ZOOM_record rec)
1426 if (rec->wrbuf_marc)
1427 wrbuf_free (rec->wrbuf_marc, 1);
1428 if (rec->wrbuf_iconv)
1429 wrbuf_free (rec->wrbuf_iconv, 1);
1430 if (rec->wrbuf_opac)
1431 wrbuf_free (rec->wrbuf_opac, 1);
1432 odr_destroy (rec->odr);
1436 static const char *marc_iconv_return(ZOOM_record rec, int marc_type,
1438 const char *buf, int sz,
1439 const char *record_charset)
1444 yaz_marc_t mt = yaz_marc_create();
1447 strcpy(to, "UTF-8");
1448 if (record_charset && *record_charset)
1450 /* Use "from,to" or just "from" */
1451 const char *cp =strchr(record_charset, ',');
1452 int clen = strlen(record_charset);
1455 strncpy( to, cp+1, sizeof(to)-1);
1456 to[sizeof(to)-1] = '\0';
1457 clen = cp - record_charset;
1459 if (clen > sizeof(from)-1)
1460 clen = sizeof(from)-1;
1463 strncpy(from, record_charset, clen);
1469 cd = yaz_iconv_open(to, from);
1470 yaz_marc_iconv(mt, cd);
1473 yaz_marc_xml(mt, marc_type);
1474 if (!rec->wrbuf_marc)
1475 rec->wrbuf_marc = wrbuf_alloc();
1476 wrbuf_rewind (rec->wrbuf_marc);
1477 if (yaz_marc_decode_wrbuf (mt, buf, sz, rec->wrbuf_marc) > 0)
1479 yaz_marc_destroy(mt);
1481 yaz_iconv_close(cd);
1483 *len = wrbuf_len(rec->wrbuf_marc);
1484 return wrbuf_buf(rec->wrbuf_marc);
1486 yaz_marc_destroy(mt);
1488 yaz_iconv_close(cd);
1492 static const char *record_iconv_return(ZOOM_record rec, int *len,
1493 const char *buf, int sz,
1494 const char *record_charset)
1501 strcpy(to, "UTF-8");
1502 if (record_charset && *record_charset)
1504 /* Use "from,to" or just "from" */
1505 const char *cp =strchr(record_charset, ',');
1506 int clen = strlen(record_charset);
1509 strncpy( to, cp+1, sizeof(to)-1);
1510 to[sizeof(to)-1] = '\0';
1511 clen = cp - record_charset;
1513 if (clen > sizeof(from)-1)
1514 clen = sizeof(from)-1;
1517 strncpy(from, record_charset, clen);
1521 if (*from && *to && (cd = yaz_iconv_open(to, from)))
1524 size_t inbytesleft = sz;
1525 const char *inp = buf;
1527 if (!rec->wrbuf_iconv)
1528 rec->wrbuf_iconv = wrbuf_alloc();
1530 wrbuf_rewind(rec->wrbuf_iconv);
1534 size_t outbytesleft = sizeof(outbuf);
1535 char *outp = outbuf;
1536 size_t r = yaz_iconv (cd, (char**) &inp,
1538 &outp, &outbytesleft);
1539 if (r == (size_t) (-1))
1541 int e = yaz_iconv_error(cd);
1542 if (e != YAZ_ICONV_E2BIG)
1545 wrbuf_write(rec->wrbuf_iconv, outbuf, outp - outbuf);
1547 wrbuf_puts(rec->wrbuf_iconv, "");
1548 buf = wrbuf_buf(rec->wrbuf_iconv);
1549 sz = wrbuf_len(rec->wrbuf_iconv);
1550 yaz_iconv_close(cd);
1557 ZOOM_API(const char *)
1558 ZOOM_record_get (ZOOM_record rec, const char *type_spec, int *len)
1565 Z_NamePlusRecord *npr;
1568 *len = 0; /* default return */
1577 for (i = 0; cp[i] && i < sizeof(type)-1; i++)
1579 if (cp[i] == ';' || cp[i] == ' ')
1585 while (type_spec[i] == ';')
1588 while (type_spec[i] == ' ')
1590 if (!strncmp(type_spec+i, "charset=", 8))
1593 for (i = 0; cp[i] && i < sizeof(charset)-1; i++)
1595 if (cp[i] == ';' || cp[i] == ' ')
1601 else if (!strncmp(type_spec+i, "xpath=", 6))
1604 for (i = 0; cp[i] && i < sizeof(xpath)-1; i++)
1608 while (type_spec[i] == ' ')
1611 if (!strcmp (type, "database"))
1614 *len = (npr->databaseName ? strlen(npr->databaseName) : 0);
1615 return npr->databaseName;
1617 else if (!strcmp (type, "syntax"))
1619 const char *desc = 0;
1620 if (npr->which == Z_NamePlusRecord_databaseRecord)
1622 Z_External *r = (Z_External *) npr->u.databaseRecord;
1623 oident *ent = oid_getentbyoid(r->direct_reference);
1630 *len = strlen(desc);
1633 if (npr->which != Z_NamePlusRecord_databaseRecord)
1636 /* from now on - we have a database record .. */
1637 if (!strcmp (type, "render"))
1639 Z_External *r = (Z_External *) npr->u.databaseRecord;
1640 oident *ent = oid_getentbyoid(r->direct_reference);
1642 /* render bibliographic record .. */
1643 if (r->which == Z_External_OPAC)
1645 r = r->u.opac->bibliographicRecord;
1648 ent = oid_getentbyoid(r->direct_reference);
1650 if (r->which == Z_External_sutrs)
1651 return record_iconv_return(rec, len,
1652 r->u.sutrs->buf, r->u.sutrs->len,
1654 else if (r->which == Z_External_octet)
1656 const char *ret_buf;
1664 case VAL_APPLICATION_XML:
1667 ret_buf = marc_iconv_return(
1668 rec, YAZ_MARC_LINE, len,
1669 (const char *) r->u.octet_aligned->buf,
1670 r->u.octet_aligned->len,
1675 return record_iconv_return(rec, len,
1676 (const char *) r->u.octet_aligned->buf,
1677 r->u.octet_aligned->len,
1680 else if (r->which == Z_External_grs1)
1682 if (!rec->wrbuf_marc)
1683 rec->wrbuf_marc = wrbuf_alloc();
1684 wrbuf_rewind (rec->wrbuf_marc);
1685 yaz_display_grs1(rec->wrbuf_marc, r->u.grs1, 0);
1686 return record_iconv_return(rec, len,
1687 wrbuf_buf(rec->wrbuf_marc),
1688 wrbuf_len(rec->wrbuf_marc),
1693 else if (!strcmp (type, "xml") || !strcmp(type, "oai"))
1695 Z_External *r = (Z_External *) npr->u.databaseRecord;
1696 oident *ent = oid_getentbyoid(r->direct_reference);
1698 /* render bibliographic record .. */
1699 if (r->which == Z_External_OPAC)
1701 r = r->u.opac->bibliographicRecord;
1704 ent = oid_getentbyoid(r->direct_reference);
1707 if (r->which == Z_External_sutrs)
1708 return record_iconv_return(rec, len,
1709 (const char *) r->u.sutrs->buf,
1712 else if (r->which == Z_External_octet)
1714 const char *ret_buf;
1715 int marc_decode_type = YAZ_MARC_MARCXML;
1717 if (!strcmp(type, "oai"))
1718 marc_decode_type = YAZ_MARC_OAIMARC;
1726 case VAL_APPLICATION_XML:
1729 ret_buf = marc_iconv_return(
1730 rec, marc_decode_type, len,
1731 (const char *) r->u.octet_aligned->buf,
1732 r->u.octet_aligned->len,
1737 return record_iconv_return(rec, len,
1738 (const char *) r->u.octet_aligned->buf,
1739 r->u.octet_aligned->len,
1742 else if (r->which == Z_External_grs1)
1749 else if (!strcmp (type, "raw"))
1751 Z_External *r = (Z_External *) npr->u.databaseRecord;
1753 if (r->which == Z_External_sutrs)
1755 if (len) *len = r->u.sutrs->len;
1756 return (const char *) r->u.sutrs->buf;
1758 else if (r->which == Z_External_octet)
1760 if (len) *len = r->u.octet_aligned->len;
1761 return (const char *) r->u.octet_aligned->buf;
1763 else /* grs-1, explain, OPAC, ... */
1766 return (const char *) npr->u.databaseRecord;
1770 else if (!strcmp (type, "ext"))
1773 return (const char *) npr->u.databaseRecord;
1775 else if (!strcmp (type, "opac"))
1778 Z_External *r = (Z_External *) npr->u.databaseRecord;
1779 if (r->which == Z_External_OPAC)
1781 if (!rec->wrbuf_opac)
1782 rec->wrbuf_opac = wrbuf_alloc();
1783 wrbuf_rewind (rec->wrbuf_opac);
1784 yaz_display_OPAC(rec->wrbuf_opac, r->u.opac, 0);
1785 return record_iconv_return(rec, len,
1786 wrbuf_buf(rec->wrbuf_opac),
1787 wrbuf_len(rec->wrbuf_opac),
1794 static int strcmp_null(const char *v1, const char *v2)
1800 return strcmp(v1, v2);
1803 static void record_cache_add (ZOOM_resultset r, Z_NamePlusRecord *npr,
1806 ZOOM_record_cache rc;
1807 const char *elementSetName =
1808 ZOOM_resultset_option_get (r, "elementSetName");
1809 const char *syntax =
1810 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
1812 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1813 ZOOM_connection_put_event(r->connection, event);
1815 for (rc = r->record_cache; rc; rc = rc->next)
1819 if (strcmp_null(r->schema, rc->schema))
1821 if (strcmp_null(elementSetName,rc->elementSetName))
1823 if (strcmp_null(syntax, rc->syntax))
1825 /* not destroying rc->npr (it's handled by nmem )*/
1827 /* keeping wrbuf_marc too */
1831 rc = (ZOOM_record_cache) odr_malloc (r->odr, sizeof(*rc));
1834 rc->rec.wrbuf_marc = 0;
1835 rc->rec.wrbuf_iconv = 0;
1836 rc->rec.wrbuf_opac = 0;
1838 rc->elementSetName = odr_strdup (r->odr, elementSetName);
1840 rc->elementSetName = 0;
1843 rc->syntax = odr_strdup (r->odr, syntax);
1848 rc->schema = odr_strdup (r->odr, r->schema);
1853 rc->next = r->record_cache;
1854 r->record_cache = rc;
1857 static ZOOM_record record_cache_lookup (ZOOM_resultset r, int pos)
1859 ZOOM_record_cache rc;
1860 const char *elementSetName =
1861 ZOOM_resultset_option_get (r, "elementSetName");
1862 const char *syntax =
1863 ZOOM_resultset_option_get (r, "preferredRecordSyntax");
1865 for (rc = r->record_cache; rc; rc = rc->next)
1869 if (strcmp_null(r->schema, rc->schema))
1871 if (strcmp_null(elementSetName,rc->elementSetName))
1873 if (strcmp_null(syntax, rc->syntax))
1881 static void handle_records (ZOOM_connection c, Z_Records *sr,
1884 ZOOM_resultset resultset;
1888 switch (c->tasks->which)
1890 case ZOOM_TASK_SEARCH:
1891 resultset = c->tasks->u.search.resultset;
1893 case ZOOM_TASK_RETRIEVE:
1894 resultset = c->tasks->u.retrieve.resultset;
1899 if (sr && sr->which == Z_Records_NSD)
1901 Z_DiagRec dr, *dr_p = &dr;
1902 dr.which = Z_DiagRec_defaultFormat;
1903 dr.u.defaultFormat = sr->u.nonSurrogateDiagnostic;
1905 response_diag (c, dr_p);
1907 else if (sr && sr->which == Z_Records_multipleNSD)
1909 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
1910 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
1912 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1916 if (resultset->count + resultset->start > resultset->size)
1917 resultset->count = resultset->size - resultset->start;
1918 if (resultset->count < 0)
1919 resultset->count = 0;
1920 if (sr && sr->which == Z_Records_DBOSD)
1923 NMEM nmem = odr_extract_mem (c->odr_in);
1924 Z_NamePlusRecordList *p =
1925 sr->u.databaseOrSurDiagnostics;
1926 for (i = 0; i<p->num_records; i++)
1928 record_cache_add (resultset, p->records[i],
1929 i+ resultset->start);
1931 /* transfer our response to search_nmem .. we need it later */
1932 nmem_transfer (resultset->odr->mem, nmem);
1933 nmem_destroy (nmem);
1934 if (present_phase && p->num_records == 0)
1936 /* present response and we didn't get any records! */
1937 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1940 else if (present_phase)
1942 /* present response and we didn't get any records! */
1943 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
1948 static void handle_present_response (ZOOM_connection c, Z_PresentResponse *pr)
1950 handle_records (c, pr->records, 1);
1953 static void handle_search_response (ZOOM_connection c, Z_SearchResponse *sr)
1955 ZOOM_resultset resultset;
1958 yaz_log (LOG_DEBUG, "got search response");
1960 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1963 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
1964 ZOOM_connection_put_event(c, event);
1966 resultset = c->tasks->u.search.resultset;
1968 resultset->size = *sr->resultCount;
1969 handle_records (c, sr->records, 0);
1972 static void sort_response (ZOOM_connection c, Z_SortResponse *res)
1974 if (res->diagnostics && res->num_diagnostics > 0)
1975 response_diag (c, res->diagnostics[0]);
1978 static int scan_response (ZOOM_connection c, Z_ScanResponse *res)
1980 NMEM nmem = odr_extract_mem (c->odr_in);
1983 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
1985 scan = c->tasks->u.scan.scan;
1987 if (res->entries && res->entries->nonsurrogateDiagnostics)
1988 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
1989 scan->scan_response = res;
1990 nmem_transfer (scan->odr->mem, nmem);
1992 ZOOM_options_set_int (scan->options, "stepSize", *res->stepSize);
1993 if (res->positionOfTerm)
1994 ZOOM_options_set_int (scan->options, "position", *res->positionOfTerm);
1995 if (res->scanStatus)
1996 ZOOM_options_set_int (scan->options, "scanStatus", *res->scanStatus);
1997 if (res->numberOfEntriesReturned)
1998 ZOOM_options_set_int (scan->options, "number",
1999 *res->numberOfEntriesReturned);
2000 nmem_destroy (nmem);
2004 static zoom_ret send_sort (ZOOM_connection c,
2005 ZOOM_resultset resultset)
2008 resultset->r_sort_spec = 0;
2009 if (resultset->r_sort_spec)
2011 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
2012 Z_SortRequest *req = apdu->u.sortRequest;
2014 req->num_inputResultSetNames = 1;
2015 req->inputResultSetNames = (Z_InternationalString **)
2016 odr_malloc (c->odr_out, sizeof(*req->inputResultSetNames));
2017 req->inputResultSetNames[0] =
2018 odr_strdup (c->odr_out, resultset->setname);
2019 req->sortedResultSetName = odr_strdup (c->odr_out, resultset->setname);
2020 req->sortSequence = resultset->r_sort_spec;
2021 resultset->r_sort_spec = 0;
2022 return send_APDU (c, apdu);
2024 return zoom_complete;
2027 static zoom_ret send_present (ZOOM_connection c)
2030 Z_PresentRequest *req = 0;
2032 const char *syntax = 0;
2033 const char *elementSetName = 0;
2034 ZOOM_resultset resultset;
2037 return zoom_complete;
2039 switch (c->tasks->which)
2041 case ZOOM_TASK_SEARCH:
2042 resultset = c->tasks->u.search.resultset;
2044 case ZOOM_TASK_RETRIEVE:
2045 resultset = c->tasks->u.retrieve.resultset;
2046 resultset->start = c->tasks->u.retrieve.start;
2047 resultset->count = c->tasks->u.retrieve.count;
2049 if (resultset->start >= resultset->size)
2050 return zoom_complete;
2051 if (resultset->start + resultset->count > resultset->size)
2052 resultset->count = resultset->size - resultset->start;
2055 return zoom_complete;
2058 syntax = ZOOM_resultset_option_get (resultset, "preferredRecordSyntax");
2059 elementSetName = ZOOM_resultset_option_get (resultset, "elementSetName");
2061 if (c->error) /* don't continue on error */
2062 return zoom_complete;
2063 if (resultset->start < 0)
2064 return zoom_complete;
2065 for (i = 0; i<resultset->count; i++)
2068 record_cache_lookup (resultset, i + resultset->start);
2072 if (i == resultset->count)
2073 return zoom_complete;
2075 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
2076 req = apdu->u.presentRequest;
2078 resultset->start += i;
2079 resultset->count -= i;
2080 *req->resultSetStartPoint = resultset->start + 1;
2081 *req->numberOfRecordsRequested = resultset->step>0 ?
2082 resultset->step : resultset->count;
2083 assert (*req->numberOfRecordsRequested > 0);
2085 if (syntax && *syntax)
2086 req->preferredRecordSyntax =
2087 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
2089 if (resultset->schema && *resultset->schema)
2091 Z_RecordComposition *compo = (Z_RecordComposition *)
2092 odr_malloc (c->odr_out, sizeof(*compo));
2094 req->recordComposition = compo;
2095 compo->which = Z_RecordComp_complex;
2096 compo->u.complex = (Z_CompSpec *)
2097 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
2098 compo->u.complex->selectAlternativeSyntax = (bool_t *)
2099 odr_malloc(c->odr_out, sizeof(bool_t));
2100 *compo->u.complex->selectAlternativeSyntax = 0;
2102 compo->u.complex->generic = (Z_Specification *)
2103 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
2105 compo->u.complex->generic->which = Z_Schema_oid;
2106 compo->u.complex->generic->schema.oid = (Odr_oid *)
2107 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
2109 if (!compo->u.complex->generic->schema.oid)
2111 /* OID wasn't a schema! Try record syntax instead. */
2113 compo->u.complex->generic->schema.oid = (Odr_oid *)
2114 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
2116 if (elementSetName && *elementSetName)
2118 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
2119 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
2120 compo->u.complex->generic->elementSpec->which =
2121 Z_ElementSpec_elementSetName;
2122 compo->u.complex->generic->elementSpec->u.elementSetName =
2123 odr_strdup (c->odr_out, elementSetName);
2126 compo->u.complex->generic->elementSpec = 0;
2127 compo->u.complex->num_dbSpecific = 0;
2128 compo->u.complex->dbSpecific = 0;
2129 compo->u.complex->num_recordSyntax = 0;
2130 compo->u.complex->recordSyntax = 0;
2132 else if (elementSetName && *elementSetName)
2134 Z_ElementSetNames *esn = (Z_ElementSetNames *)
2135 odr_malloc (c->odr_out, sizeof(*esn));
2136 Z_RecordComposition *compo = (Z_RecordComposition *)
2137 odr_malloc (c->odr_out, sizeof(*compo));
2139 esn->which = Z_ElementSetNames_generic;
2140 esn->u.generic = odr_strdup (c->odr_out, elementSetName);
2141 compo->which = Z_RecordComp_simple;
2142 compo->u.simple = esn;
2143 req->recordComposition = compo;
2145 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
2146 return send_APDU (c, apdu);
2149 ZOOM_API(ZOOM_scanset)
2150 ZOOM_connection_scan (ZOOM_connection c, const char *start)
2152 ZOOM_scanset scan = (ZOOM_scanset) xmalloc (sizeof(*scan));
2154 scan->connection = c;
2155 scan->odr = odr_createmem (ODR_DECODE);
2156 scan->options = ZOOM_options_create_with_parent (c->options);
2158 scan->scan_response = 0;
2160 if ((scan->termListAndStartPoint =
2161 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet,
2164 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_SCAN);
2165 task->u.scan.scan = scan;
2170 while (ZOOM_event (1, &c))
2178 ZOOM_scanset_destroy (ZOOM_scanset scan)
2183 if (scan->refcount == 0)
2185 odr_destroy (scan->odr);
2187 ZOOM_options_destroy (scan->options);
2192 static zoom_ret send_package (ZOOM_connection c)
2196 return zoom_complete;
2197 assert (c->tasks->which == ZOOM_TASK_PACKAGE);
2199 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
2200 ZOOM_connection_put_event (c, event);
2202 return do_write_ex (c, c->tasks->u.package->buf_out,
2203 c->tasks->u.package->len_out);
2206 static zoom_ret send_scan (ZOOM_connection c)
2209 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
2210 Z_ScanRequest *req = apdu->u.scanRequest;
2212 return zoom_complete;
2213 assert (c->tasks->which == ZOOM_TASK_SCAN);
2214 scan = c->tasks->u.scan.scan;
2216 req->termListAndStartPoint = scan->termListAndStartPoint;
2217 req->attributeSet = scan->attributeSet;
2219 *req->numberOfTermsRequested =
2220 ZOOM_options_get_int(scan->options, "number", 10);
2222 req->preferredPositionInResponse =
2223 odr_intdup (c->odr_out,
2224 ZOOM_options_get_int(scan->options, "position", 1));
2227 odr_intdup (c->odr_out,
2228 ZOOM_options_get_int(scan->options, "stepSize", 0));
2230 req->databaseNames = set_DatabaseNames (c, scan->options,
2231 &req->num_databaseNames);
2233 return send_APDU (c, apdu);
2237 ZOOM_scanset_size (ZOOM_scanset scan)
2239 if (!scan || !scan->scan_response || !scan->scan_response->entries)
2241 return scan->scan_response->entries->num_entries;
2244 ZOOM_API(const char *)
2245 ZOOM_scanset_term (ZOOM_scanset scan, size_t pos,
2248 const char *term = 0;
2249 size_t noent = ZOOM_scanset_size (scan);
2250 Z_ScanResponse *res = scan->scan_response;
2256 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2258 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2260 if (t->term->which == Z_Term_general)
2262 term = (const char *) t->term->u.general->buf;
2263 *len = t->term->u.general->len;
2265 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2270 ZOOM_API(const char *)
2271 ZOOM_scanset_display_term (ZOOM_scanset scan, size_t pos,
2274 const char *term = 0;
2275 size_t noent = ZOOM_scanset_size (scan);
2276 Z_ScanResponse *res = scan->scan_response;
2282 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
2284 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
2288 term = t->displayTerm;
2289 *len = strlen(term);
2291 else if (t->term->which == Z_Term_general)
2293 term = (const char *) t->term->u.general->buf;
2294 *len = t->term->u.general->len;
2296 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
2301 ZOOM_API(const char *)
2302 ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key)
2304 return ZOOM_options_get (scan->options, key);
2308 ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
2311 ZOOM_options_set (scan->options, key, val);
2314 static Z_APDU *create_es_package (ZOOM_package p, int type)
2317 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
2318 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
2320 *req->function = Z_ExtendedServicesRequest_create;
2322 str = ZOOM_options_get(p->options, "package-name");
2324 req->packageName = nmem_strdup (p->odr_out->mem, str);
2326 str = ZOOM_options_get(p->options, "user-id");
2328 req->userId = nmem_strdup (p->odr_out->mem, str);
2330 req->packageType = yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2333 str = ZOOM_options_get(p->options, "function");
2336 if (!strcmp (str, "create"))
2338 if (!strcmp (str, "delete"))
2340 if (!strcmp (str, "modify"))
2346 static const char *ill_array_lookup (void *clientData, const char *idx)
2348 ZOOM_package p = (ZOOM_package) clientData;
2349 return ZOOM_options_get (p->options, idx+4);
2352 static Z_External *encode_ill_request (ZOOM_package p)
2354 ODR out = p->odr_out;
2357 struct ill_get_ctl ctl;
2359 ctl.odr = p->odr_out;
2361 ctl.f = ill_array_lookup;
2363 req = ill_get_ILLRequest(&ctl, "ill", 0);
2365 if (!ill_Request (out, &req, 0, 0))
2367 int ill_request_size;
2368 char *ill_request_buf = odr_getbuf (out, &ill_request_size, 0);
2369 if (ill_request_buf)
2370 odr_setbuf (out, ill_request_buf, ill_request_size, 1);
2376 int illRequest_size = 0;
2377 char *illRequest_buf = odr_getbuf (out, &illRequest_size, 0);
2379 oid.proto = PROTO_GENERAL;
2380 oid.oclass = CLASS_GENERAL;
2381 oid.value = VAL_ISO_ILL_1;
2383 r = (Z_External *) odr_malloc (out, sizeof(*r));
2384 r->direct_reference = odr_oiddup(out,oid_getoidbyent(&oid));
2385 r->indirect_reference = 0;
2387 r->which = Z_External_single;
2389 r->u.single_ASN1_type = (Odr_oct *)
2390 odr_malloc (out, sizeof(*r->u.single_ASN1_type));
2391 r->u.single_ASN1_type->buf = (unsigned char*)
2392 odr_malloc (out, illRequest_size);
2393 r->u.single_ASN1_type->len = illRequest_size;
2394 r->u.single_ASN1_type->size = illRequest_size;
2395 memcpy (r->u.single_ASN1_type->buf, illRequest_buf, illRequest_size);
2400 static Z_ItemOrder *encode_item_order(ZOOM_package p)
2402 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc (p->odr_out, sizeof(*req));
2405 req->which=Z_IOItemOrder_esRequest;
2406 req->u.esRequest = (Z_IORequest *)
2407 odr_malloc(p->odr_out,sizeof(Z_IORequest));
2409 /* to keep part ... */
2410 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
2411 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
2412 req->u.esRequest->toKeep->supplDescription = 0;
2413 req->u.esRequest->toKeep->contact = (Z_IOContact *)
2414 odr_malloc (p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
2416 str = ZOOM_options_get(p->options, "contact-name");
2417 req->u.esRequest->toKeep->contact->name = str ?
2418 nmem_strdup (p->odr_out->mem, str) : 0;
2420 str = ZOOM_options_get(p->options, "contact-phone");
2421 req->u.esRequest->toKeep->contact->phone = str ?
2422 nmem_strdup (p->odr_out->mem, str) : 0;
2424 str = ZOOM_options_get(p->options, "contact-email");
2425 req->u.esRequest->toKeep->contact->email = str ?
2426 nmem_strdup (p->odr_out->mem, str) : 0;
2428 req->u.esRequest->toKeep->addlBilling = 0;
2430 /* not to keep part ... */
2431 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
2432 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
2434 str = ZOOM_options_get(p->options, "itemorder-setname");
2439 req->u.esRequest->notToKeep->resultSetItem = 0;
2442 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
2443 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
2445 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
2446 nmem_strdup (p->odr_out->mem, str);
2447 req->u.esRequest->notToKeep->resultSetItem->item =
2448 (int *) odr_malloc(p->odr_out, sizeof(int));
2450 str = ZOOM_options_get(p->options, "itemorder-item");
2451 *req->u.esRequest->notToKeep->resultSetItem->item =
2452 (str ? atoi(str) : 1);
2454 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
2459 Z_APDU *create_admin_package(ZOOM_package p, int type,
2460 Z_ESAdminOriginPartToKeep **toKeepP,
2461 Z_ESAdminOriginPartNotToKeep **notToKeepP)
2463 Z_APDU *apdu = create_es_package (p, VAL_ADMINSERVICE);
2466 Z_ESAdminOriginPartToKeep *toKeep;
2467 Z_ESAdminOriginPartNotToKeep *notToKeep;
2468 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2469 const char *first_db = "Default";
2471 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2475 r->direct_reference =
2476 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2479 r->indirect_reference = 0;
2480 r->which = Z_External_ESAdmin;
2482 r->u.adminService = (Z_Admin *)
2483 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
2484 r->u.adminService->which = Z_Admin_esRequest;
2485 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
2486 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
2488 toKeep = r->u.adminService->u.esRequest->toKeep =
2489 (Z_ESAdminOriginPartToKeep *)
2490 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
2492 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2493 toKeep->u.create=odr_nullval();
2494 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2496 r->u.adminService->u.esRequest->notToKeep = notToKeep =
2497 (Z_ESAdminOriginPartNotToKeep *)
2498 odr_malloc(p->odr_out,
2499 sizeof(*r->u.adminService->u.esRequest->notToKeep));
2500 notToKeep->which=Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
2501 notToKeep->u.recordsWillFollow=odr_nullval();
2505 *notToKeepP = notToKeep;
2510 static Z_APDU *create_update_package(ZOOM_package p)
2513 const char *first_db = "Default";
2515 char **db = set_DatabaseNames(p->connection, p->options, &num_db);
2516 const char *action = ZOOM_options_get(p->options, "action");
2517 const char *recordIdOpaque = ZOOM_options_get(p->options, "recordIdOpaque");
2518 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
2519 const char *record_buf = ZOOM_options_get(p->options, "record");
2520 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
2521 int syntax_oid = VAL_NONE;
2525 syntax_oid = oid_getvalbyname(syntax_str);
2528 record_buf = "void";
2529 syntax_oid = VAL_SUTRS;
2531 if (syntax_oid != VAL_NONE)
2532 syntax_oid = VAL_TEXT_XML;
2538 action = "specialUpdate";
2540 if (!strcmp(action, "recordInsert"))
2541 action_no = Z_IUOriginPartToKeep_recordInsert;
2542 else if (!strcmp(action, "recordReplace"))
2543 action_no = Z_IUOriginPartToKeep_recordReplace;
2544 else if (!strcmp(action, "recordDelete"))
2545 action_no = Z_IUOriginPartToKeep_recordDelete;
2546 else if (!strcmp(action, "elementUpdate"))
2547 action_no = Z_IUOriginPartToKeep_elementUpdate;
2548 else if (!strcmp(action, "specialUpdate"))
2549 action_no = Z_IUOriginPartToKeep_specialUpdate;
2553 apdu = create_es_package (p, VAL_DBUPDATE);
2556 Z_IUOriginPartToKeep *toKeep;
2557 Z_IUSuppliedRecords *notToKeep;
2558 Z_External *r = (Z_External *)
2559 odr_malloc (p->odr_out, sizeof(*r));
2561 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2563 r->direct_reference =
2564 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2567 r->which = Z_External_update;
2568 r->indirect_reference = 0;
2569 r->u.update = (Z_IUUpdate *)
2570 odr_malloc(p->odr_out, sizeof(*r->u.update));
2572 r->u.update->which = Z_IUUpdate_esRequest;
2573 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
2574 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
2575 toKeep = r->u.update->u.esRequest->toKeep =
2576 (Z_IUOriginPartToKeep *)
2577 odr_malloc(p->odr_out, sizeof(*toKeep));
2579 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
2581 toKeep->elementSetName = 0;
2582 toKeep->actionQualifier = 0;
2583 toKeep->action = odr_intdup(p->odr_out, action_no);
2585 notToKeep = r->u.update->u.esRequest->notToKeep =
2586 (Z_IUSuppliedRecords *)
2587 odr_malloc(p->odr_out, sizeof(*notToKeep));
2589 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
2590 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
2591 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
2592 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
2593 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
2596 notToKeep->elements[0]->u.opaque = (Odr_oct *)
2597 odr_malloc (p->odr_out, sizeof(Odr_oct));
2598 notToKeep->elements[0]->u.opaque->size =
2599 notToKeep->elements[0]->u.opaque->len = strlen(recordIdOpaque);
2600 notToKeep->elements[0]->u.opaque->buf =
2601 odr_strdup(p->odr_out, recordIdOpaque);
2603 else if (recordIdNumber)
2605 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
2607 notToKeep->elements[0]->u.number =
2608 odr_intdup(p->odr_out, atoi(recordIdNumber));
2611 notToKeep->elements[0]->u.opaque = 0;
2612 notToKeep->elements[0]->supplementalId = 0;
2613 notToKeep->elements[0]->correlationInfo = 0;
2614 notToKeep->elements[0]->record =
2615 z_ext_record(p->odr_out, syntax_oid,
2616 record_buf, strlen(record_buf));
2620 ODR print = odr_createmem(ODR_PRINT);
2622 z_APDU(print, &apdu, 0, 0);
2629 ZOOM_package_send (ZOOM_package p, const char *type)
2636 odr_reset (p->odr_out);
2639 if (!strcmp(type, "itemorder"))
2641 apdu = create_es_package (p, VAL_ITEMORDER);
2644 Z_External *r = (Z_External *) odr_malloc (p->odr_out, sizeof(*r));
2646 r->direct_reference =
2647 yaz_oidval_to_z3950oid(p->odr_out, CLASS_EXTSERV,
2650 r->which = Z_External_itemOrder;
2651 r->indirect_reference = 0;
2652 r->u.itemOrder = encode_item_order (p);
2654 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
2657 if (!strcmp(type, "create")) /* create database */
2659 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
2662 if (!strcmp(type, "drop")) /* drop database */
2664 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
2667 if (!strcmp(type, "update")) /* update record(s) */
2669 apdu = create_update_package(p);
2673 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
2677 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_PACKAGE);
2678 task->u.package = p;
2679 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
2680 p->buf_out = (char *) xmalloc (p->len_out);
2681 memcpy (p->buf_out, buf, p->len_out);
2686 while (ZOOM_event (1, &c))
2693 ZOOM_API(ZOOM_package)
2694 ZOOM_connection_package (ZOOM_connection c, ZOOM_options options)
2696 ZOOM_package p = (ZOOM_package) xmalloc (sizeof(*p));
2699 p->odr_out = odr_createmem (ODR_ENCODE);
2700 p->options = ZOOM_options_create_with_parent2 (options, c->options);
2708 ZOOM_package_destroy(ZOOM_package p)
2713 if (p->refcount == 0)
2715 odr_destroy (p->odr_out);
2718 ZOOM_options_destroy (p->options);
2723 ZOOM_API(const char *)
2724 ZOOM_package_option_get (ZOOM_package p, const char *key)
2726 return ZOOM_options_get (p->options, key);
2731 ZOOM_package_option_set (ZOOM_package p, const char *key,
2734 ZOOM_options_set (p->options, key, val);
2737 static int ZOOM_connection_exec_task (ZOOM_connection c)
2739 ZOOM_task task = c->tasks;
2740 zoom_ret ret = zoom_complete;
2744 yaz_log (LOG_DEBUG, "ZOOM_connection_exec_task task=<null>");
2747 yaz_log (LOG_DEBUG, "ZOOM_connection_exec_task type=%d run=%d",
2748 task->which, task->running);
2749 if (c->error != ZOOM_ERROR_NONE)
2751 yaz_log (LOG_DEBUG, "remove tasks because of error = %d", c->error);
2752 ZOOM_connection_remove_tasks (c);
2757 yaz_log (LOG_DEBUG, "task already running");
2761 ret = zoom_complete;
2762 if (c->cs || task->which == ZOOM_TASK_CONNECT)
2764 switch (task->which)
2766 case ZOOM_TASK_SEARCH:
2767 if (c->proto == PROTO_HTTP)
2768 ret = ZOOM_connection_srw_send_search(c);
2770 ret = ZOOM_connection_send_search(c);
2772 case ZOOM_TASK_RETRIEVE:
2773 if (c->proto == PROTO_HTTP)
2774 ret = ZOOM_connection_srw_send_search(c);
2776 ret = send_present (c);
2778 case ZOOM_TASK_CONNECT:
2779 ret = do_connect(c);
2781 case ZOOM_TASK_SCAN:
2784 case ZOOM_TASK_PACKAGE:
2785 ret = send_package(c);
2787 case ZOOM_TASK_SORT:
2788 c->tasks->u.sort.resultset->r_sort_spec =
2789 c->tasks->u.sort.q->sort_spec;
2790 ret = send_sort(c, c->tasks->u.sort.resultset);
2796 yaz_log (LOG_DEBUG, "remove tasks because no connection exist");
2797 ZOOM_connection_remove_tasks (c);
2799 if (ret == zoom_complete)
2801 yaz_log (LOG_DEBUG, "task removed (complete)");
2802 ZOOM_connection_remove_task (c);
2805 yaz_log (LOG_DEBUG, "task pending");
2809 static zoom_ret send_sort_present (ZOOM_connection c)
2811 zoom_ret r = zoom_complete;
2813 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
2814 r = send_sort (c, c->tasks->u.search.resultset);
2815 if (r == zoom_complete)
2816 r = send_present (c);
2820 static int es_response (ZOOM_connection c,
2821 Z_ExtendedServicesResponse *res)
2823 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
2825 if (res->diagnostics && res->num_diagnostics > 0)
2826 response_diag(c, res->diagnostics[0]);
2827 if (res->taskPackage &&
2828 res->taskPackage->which == Z_External_extendedService)
2830 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
2831 Odr_oct *id = taskPackage->targetReference;
2834 ZOOM_options_setl (c->tasks->u.package->options,
2835 "targetReference", (char*) id->buf, id->len);
2841 static void handle_apdu (ZOOM_connection c, Z_APDU *apdu)
2843 Z_InitResponse *initrs;
2846 yaz_log (LOG_DEBUG, "recv APDU type=%d", apdu->which);
2849 case Z_APDU_initResponse:
2850 initrs = apdu->u.initResponse;
2851 ZOOM_connection_option_set(c, "serverImplementationId",
2852 initrs->implementationId ?
2853 initrs->implementationId : "");
2854 ZOOM_connection_option_set(c, "serverImplementationName",
2855 initrs->implementationName ?
2856 initrs->implementationName : "");
2857 ZOOM_connection_option_set(c, "serverImplementationVersion",
2858 initrs->implementationVersion ?
2859 initrs->implementationVersion : "");
2860 /* Set the three old options too, for old applications */
2861 ZOOM_connection_option_set(c, "targetImplementationId",
2862 initrs->implementationId ?
2863 initrs->implementationId : "");
2864 ZOOM_connection_option_set(c, "targetImplementationName",
2865 initrs->implementationName ?
2866 initrs->implementationName : "");
2867 ZOOM_connection_option_set(c, "targetImplementationVersion",
2868 initrs->implementationVersion ?
2869 initrs->implementationVersion : "");
2870 if (!*initrs->result)
2872 set_ZOOM_error(c, ZOOM_ERROR_INIT, 0);
2877 yaz_oi_get_string_oidval (&apdu->u.initResponse->otherInfo,
2879 xfree (c->cookie_in);
2882 c->cookie_in = xstrdup(cookie);
2883 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
2884 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
2885 c->support_named_resultsets = 1;
2888 assert (c->tasks->which == ZOOM_TASK_CONNECT);
2889 ZOOM_connection_remove_task (c);
2891 ZOOM_connection_exec_task (c);
2893 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
2895 NMEM tmpmem = nmem_create();
2896 Z_CharSetandLanguageNegotiation *p =
2897 yaz_get_charneg_record(initrs->otherInfo);
2901 char *charset=NULL, *lang=NULL;
2904 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
2905 yaz_log(LOG_DEBUG, "Target accepted: charset %s, "
2906 "language %s, select %d",
2907 charset ? charset : "none", lang ? lang : "none", sel);
2909 ZOOM_connection_option_set (c, "negotiation-charset",
2912 ZOOM_connection_option_set (c, "negotiation-lang",
2914 nmem_destroy(tmpmem);
2918 case Z_APDU_searchResponse:
2919 handle_search_response (c, apdu->u.searchResponse);
2920 if (send_sort_present (c) == zoom_complete)
2921 ZOOM_connection_remove_task (c);
2923 case Z_APDU_presentResponse:
2924 handle_present_response (c, apdu->u.presentResponse);
2925 if (send_present (c) == zoom_complete)
2926 ZOOM_connection_remove_task (c);
2928 case Z_APDU_sortResponse:
2929 sort_response (c, apdu->u.sortResponse);
2930 if (send_present (c) == zoom_complete)
2931 ZOOM_connection_remove_task (c);
2933 case Z_APDU_scanResponse:
2934 scan_response (c, apdu->u.scanResponse);
2935 ZOOM_connection_remove_task (c);
2937 case Z_APDU_extendedServicesResponse:
2938 es_response (c, apdu->u.extendedServicesResponse);
2939 ZOOM_connection_remove_task (c);
2942 if (c->reconnect_ok)
2945 c->tasks->running = 0;
2946 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
2950 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, 0);
2955 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
2961 static void handle_srw_response(ZOOM_connection c,
2962 Z_SRW_searchRetrieveResponse *res)
2964 ZOOM_resultset resultset = 0;
2972 if (c->tasks->which == ZOOM_TASK_SEARCH)
2973 resultset = c->tasks->u.search.resultset;
2974 else if (c->tasks->which == ZOOM_TASK_RETRIEVE)
2975 resultset = c->tasks->u.retrieve.resultset;
2979 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
2980 ZOOM_connection_put_event(c, event);
2982 resultset->size = 0;
2984 yaz_log(LOG_DEBUG, "got SRW response OK");
2986 if (res->numberOfRecords)
2987 resultset->size = *res->numberOfRecords;
2989 for (i = 0; i<res->num_records; i++)
2993 Z_NamePlusRecord *npr = (Z_NamePlusRecord *)
2994 odr_malloc(c->odr_in, sizeof(Z_NamePlusRecord));
2996 if (res->records[i].recordPosition &&
2997 *res->records[i].recordPosition > 0)
2998 pos = *res->records[i].recordPosition - 1;
3000 pos = resultset->start + i;
3002 npr->databaseName = 0;
3003 npr->which = Z_NamePlusRecord_databaseRecord;
3004 npr->u.databaseRecord = (Z_External *)
3005 odr_malloc(c->odr_in, sizeof(Z_External));
3006 npr->u.databaseRecord->descriptor = 0;
3007 npr->u.databaseRecord->direct_reference =
3008 yaz_oidval_to_z3950oid(c->odr_in, CLASS_RECSYN, VAL_TEXT_XML);
3009 npr->u.databaseRecord->which = Z_External_octet;
3010 npr->u.databaseRecord->u.octet_aligned = (Odr_oct *)
3011 odr_malloc(c->odr_in, sizeof(Odr_oct));
3012 npr->u.databaseRecord->u.octet_aligned->buf =
3013 res->records[i].recordData_buf;
3014 npr->u.databaseRecord->u.octet_aligned->len =
3015 npr->u.databaseRecord->u.octet_aligned->size =
3016 res->records[i].recordData_len;
3017 record_cache_add (resultset, npr, pos);
3019 if (res->num_diagnostics > 0)
3021 const char *uri = res->diagnostics[0].uri;
3026 if ((cp = strrchr(uri, '/')))
3028 set_dset_error(c, code, uri,
3029 res->diagnostics[0].details, 0);
3032 nmem = odr_extract_mem(c->odr_in);
3033 nmem_transfer(resultset->odr->mem, nmem);
3039 static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
3042 const char *content_type = z_HTTP_header_lookup(hres->headers,
3044 const char *connection_head = z_HTTP_header_lookup(hres->headers,
3047 yaz_log (LOG_DEBUG, "handle_http");
3049 if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
3051 Z_SOAP *soap_package = 0;
3053 Z_SOAP_Handler soap_handlers[2] = {
3054 {"http://www.loc.gov/zing/srw/", 0,
3055 (Z_SOAP_fun) yaz_srw_codec},
3058 ret = z_soap_codec(o, &soap_package,
3059 &hres->content_buf, &hres->content_len,
3061 if (!ret && soap_package->which == Z_SOAP_generic &&
3062 soap_package->u.generic->no == 0)
3064 Z_SRW_PDU *sr = soap_package->u.generic->p;
3065 if (sr->which == Z_SRW_searchRetrieve_response)
3066 handle_srw_response(c, sr->u.response);
3070 else if (!ret && (soap_package->which == Z_SOAP_fault
3071 || soap_package->which == Z_SOAP_error))
3073 set_HTTP_error(c, hres->code,
3074 soap_package->u.fault->fault_code,
3075 soap_package->u.fault->fault_string);
3082 if (hres->code != 200)
3083 set_HTTP_error(c, hres->code, 0, 0);
3085 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3088 ZOOM_connection_remove_task(c);
3089 if (!strcmp(hres->version, "1.0"))
3091 /* HTTP 1.0: only if Keep-Alive we stay alive.. */
3092 if (!connection_head || strcmp(connection_head, "Keep-Alive"))
3097 /* HTTP 1.1: only if no close we stay alive .. */
3098 if (connection_head && !strcmp(connection_head, "close"))
3104 static int do_read (ZOOM_connection c)
3109 event = ZOOM_Event_create (ZOOM_EVENT_RECV_DATA);
3110 ZOOM_connection_put_event (c, event);
3112 r = cs_get (c->cs, &c->buf_in, &c->len_in);
3113 more = cs_more(c->cs);
3114 yaz_log (LOG_DEBUG, "do_read len=%d more=%d", r, more);
3119 if (c->reconnect_ok)
3122 c->reconnect_ok = 0;
3123 yaz_log (LOG_DEBUG, "reconnect read");
3124 c->tasks->running = 0;
3125 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3129 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, 0);
3138 odr_reset (c->odr_in);
3139 odr_setbuf (c->odr_in, c->buf_in, r, 0);
3140 event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);
3141 ZOOM_connection_put_event (c, event);
3143 if (!z_GDU (c->odr_in, &gdu, 0, 0))
3146 int err = odr_geterrorx(c->odr_in, &x);
3148 const char *element = odr_getelement(c->odr_in);
3149 sprintf (msg, "ODR code %d:%d element=%-20s",
3150 err, x, element ? element : "<unknown>");
3151 set_ZOOM_error(c, ZOOM_ERROR_DECODE, msg);
3154 else if (gdu->which == Z_GDU_Z3950)
3155 handle_apdu (c, gdu->u.z3950);
3156 else if (gdu->which == Z_GDU_HTTP_Response)
3159 handle_http (c, gdu->u.HTTP_Response);
3161 set_ZOOM_error(c, ZOOM_ERROR_DECODE, 0);
3165 c->reconnect_ok = 0;
3170 static zoom_ret do_write_ex (ZOOM_connection c, char *buf_out, int len_out)
3175 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
3176 ZOOM_connection_put_event (c, event);
3178 yaz_log (LOG_DEBUG, "do_write_ex len=%d", len_out);
3179 if ((r=cs_put (c->cs, buf_out, len_out)) < 0)
3181 if (c->reconnect_ok)
3184 c->reconnect_ok = 0;
3185 yaz_log (LOG_DEBUG, "reconnect write");
3186 c->tasks->running = 0;
3187 ZOOM_connection_insert_task (c, ZOOM_TASK_CONNECT);
3188 return zoom_pending;
3190 if (c->state == STATE_CONNECTING)
3191 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, 0);
3193 set_ZOOM_error(c, ZOOM_ERROR_CONNECTION_LOST, 0);
3195 return zoom_complete;
3199 c->mask = ZOOM_SELECT_EXCEPT;
3200 if (c->cs->io_pending & CS_WANT_WRITE)
3201 c->mask += ZOOM_SELECT_WRITE;
3202 if (c->cs->io_pending & CS_WANT_READ)
3203 c->mask += ZOOM_SELECT_READ;
3204 yaz_log (LOG_DEBUG, "do_write_ex 1 mask=%d", c->mask);
3208 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
3209 yaz_log (LOG_DEBUG, "do_write_ex 2 mask=%d", c->mask);
3211 return zoom_pending;
3214 static zoom_ret do_write(ZOOM_connection c)
3216 return do_write_ex (c, c->buf_out, c->len_out);
3220 ZOOM_API(const char *)
3221 ZOOM_connection_option_get (ZOOM_connection c, const char *key)
3223 return ZOOM_options_get (c->options, key);
3227 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
3230 ZOOM_options_set (c->options, key, val);
3233 ZOOM_API(const char *)
3234 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key)
3236 return ZOOM_options_get (r->options, key);
3240 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key,
3243 ZOOM_options_set (r->options, key, val);
3248 ZOOM_connection_errcode (ZOOM_connection c)
3250 return ZOOM_connection_error (c, 0, 0);
3253 ZOOM_API(const char *)
3254 ZOOM_connection_errmsg (ZOOM_connection c)
3257 ZOOM_connection_error (c, &msg, 0);
3261 ZOOM_API(const char *)
3262 ZOOM_connection_addinfo (ZOOM_connection c)
3264 const char *addinfo;
3265 ZOOM_connection_error (c, 0, &addinfo);
3269 ZOOM_API(const char *)
3270 ZOOM_diag_str (int error)
3274 case ZOOM_ERROR_NONE:
3276 case ZOOM_ERROR_CONNECT:
3277 return "Connect failed";
3278 case ZOOM_ERROR_MEMORY:
3279 return "Out of memory";
3280 case ZOOM_ERROR_ENCODE:
3281 return "Encoding failed";
3282 case ZOOM_ERROR_DECODE:
3283 return "Decoding failed";
3284 case ZOOM_ERROR_CONNECTION_LOST:
3285 return "Connection lost";
3286 case ZOOM_ERROR_INIT:
3287 return "Init rejected";
3288 case ZOOM_ERROR_INTERNAL:
3289 return "Internal failure";
3290 case ZOOM_ERROR_TIMEOUT:
3292 case ZOOM_ERROR_UNSUPPORTED_PROTOCOL:
3293 return "Unsupported protocol";
3294 case ZOOM_ERROR_UNSUPPORTED_QUERY:
3295 return "Unsupported query type";
3296 case ZOOM_ERROR_INVALID_QUERY:
3297 return "Invalid query";
3299 return diagbib1_str (error);
3304 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
3305 const char **addinfo, const char **diagset)
3307 int error = c->error;
3310 if (!c->diagset || !strcmp(c->diagset, "ZOOM"))
3311 *cp = ZOOM_diag_str(error);
3312 else if (!strcmp(c->diagset, "HTTP"))
3313 *cp = z_HTTP_errmsg(c->error);
3314 else if (!strcmp(c->diagset, "Bib-1"))
3315 *cp = ZOOM_diag_str(error);
3316 else if (!strcmp(c->diagset, "info:srw/diagnostic/1"))
3317 *cp = yaz_diag_srw_str(c->error);
3319 *cp = "Unknown error and diagnostic set";
3322 *addinfo = c->addinfo ? c->addinfo : "";
3324 *diagset = c->diagset ? c->diagset : "";
3329 ZOOM_connection_error (ZOOM_connection c, const char **cp,
3330 const char **addinfo)
3332 return ZOOM_connection_error_x(c, cp, addinfo, 0);
3335 static int ZOOM_connection_do_io(ZOOM_connection c, int mask)
3337 ZOOM_Event event = 0;
3338 int r = cs_look(c->cs);
3339 yaz_log (LOG_DEBUG, "ZOOM_connection_do_io c=%p mask=%d cs_look=%d",
3344 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3345 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, 0);
3347 ZOOM_connection_put_event (c, event);
3349 else if (r == CS_CONNECT)
3352 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
3354 ret = cs_rcvconnect (c->cs);
3355 yaz_log (LOG_DEBUG, "cs_rcvconnect returned %d", ret);
3358 c->mask = ZOOM_SELECT_EXCEPT;
3359 if (c->cs->io_pending & CS_WANT_WRITE)
3360 c->mask += ZOOM_SELECT_WRITE;
3361 if (c->cs->io_pending & CS_WANT_READ)
3362 c->mask += ZOOM_SELECT_READ;
3363 ZOOM_connection_put_event (c, event);
3367 ZOOM_connection_put_event (c, event);
3368 if (c->proto == PROTO_Z3950)
3369 ZOOM_connection_send_init(c);
3372 /* no init request for SRW .. */
3373 assert (c->tasks->which == ZOOM_TASK_CONNECT);
3374 ZOOM_connection_remove_task (c);
3376 ZOOM_connection_exec_task (c);
3378 c->state = STATE_ESTABLISHED;
3382 set_ZOOM_error(c, ZOOM_ERROR_CONNECT, 0);
3384 ZOOM_connection_put_event (c, event);
3389 if (mask & ZOOM_SELECT_READ)
3391 if (c->cs && (mask & ZOOM_SELECT_WRITE))
3398 ZOOM_connection_last_event(ZOOM_connection cs)
3401 return ZOOM_EVENT_NONE;
3402 return cs->last_event;
3406 ZOOM_event (int no, ZOOM_connection *cs)
3410 struct pollfd pollfds[1024];
3411 ZOOM_connection poll_cs[1024];
3414 fd_set input, output, except;
3419 for (i = 0; i<no; i++)
3421 ZOOM_connection c = cs[i];
3423 if (c && (event = ZOOM_connection_get_event(c)))
3425 ZOOM_Event_destroy (event);
3429 for (i = 0; i<no; i++)
3431 ZOOM_connection c = cs[i];
3433 if (c && ZOOM_connection_exec_task (c))
3435 if ((event = ZOOM_connection_get_event(c)))
3437 ZOOM_Event_destroy (event);
3450 for (i = 0; i<no; i++)
3452 ZOOM_connection c = cs[i];
3458 fd = z3950_connection_socket(c);
3459 mask = z3950_connection_mask(c);
3466 this_timeout = ZOOM_options_get_int (c->options, "timeout", -1);
3467 if (this_timeout != -1 && this_timeout < timeout)
3468 timeout = this_timeout;
3472 short poll_events = 0;
3474 if (mask & ZOOM_SELECT_READ)
3475 poll_events += POLLIN;
3476 if (mask & ZOOM_SELECT_WRITE)
3477 poll_events += POLLOUT;
3478 if (mask & ZOOM_SELECT_EXCEPT)
3479 poll_events += POLLERR;
3480 pollfds[nfds].fd = fd;
3481 pollfds[nfds].events = poll_events;
3482 pollfds[nfds].revents = 0;
3487 if (mask & ZOOM_SELECT_READ)
3489 FD_SET (fd, &input);
3492 if (mask & ZOOM_SELECT_WRITE)
3494 FD_SET (fd, &output);
3497 if (mask & ZOOM_SELECT_EXCEPT)
3499 FD_SET (fd, &except);
3504 if (timeout >= 5000)
3511 r = poll (pollfds, nfds, timeout * 1000);
3512 for (i = 0; i<nfds; i++)
3514 ZOOM_connection c = poll_cs[i];
3518 if (pollfds[i].revents & POLLIN)
3519 mask += ZOOM_SELECT_READ;
3520 if (pollfds[i].revents & POLLOUT)
3521 mask += ZOOM_SELECT_WRITE;
3522 if (pollfds[i].revents & POLLERR)
3523 mask += ZOOM_SELECT_EXCEPT;
3525 ZOOM_connection_do_io(c, mask);
3527 else if (r == 0 && c->mask)
3529 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3530 /* timeout and this connection was waiting */
3531 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3533 ZOOM_connection_put_event(c, event);
3537 tv.tv_sec = timeout;
3539 yaz_log (LOG_DEBUG, "select start");
3540 r = select (max_fd+1, &input, &output, &except, &tv);
3541 yaz_log (LOG_DEBUG, "select stop, returned r=%d", r);
3542 for (i = 0; i<no; i++)
3544 ZOOM_connection c = cs[i];
3549 fd = z3950_connection_socket(c);
3553 /* no timeout and real socket */
3554 if (FD_ISSET(fd, &input))
3555 mask += ZOOM_SELECT_READ;
3556 if (FD_ISSET(fd, &output))
3557 mask += ZOOM_SELECT_WRITE;
3558 if (FD_ISSET(fd, &except))
3559 mask += ZOOM_SELECT_EXCEPT;
3561 ZOOM_connection_do_io(c, mask);
3563 if (r == 0 && c->mask)
3565 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
3566 /* timeout and this connection was waiting */
3567 set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
3569 yaz_log (LOG_DEBUG, "timeout");
3570 ZOOM_connection_put_event(c, event);
3574 for (i = 0; i<no; i++)
3576 ZOOM_connection c = cs[i];
3578 if (c && (event = ZOOM_connection_get_event(c)))
3580 ZOOM_Event_destroy (event);