2 * $Id: zoom-c.c,v 1.25 2002-05-06 07:33:50 adam Exp $
4 * ZOOM layer for C, connections, result sets, queries.
7 #include <yaz/xmalloc.h>
8 #include <yaz/otherinfo.h>
10 #include <yaz/pquery.h>
11 #include <yaz/diagbib1.h>
19 static ZOOM_Event ZOOM_Event_create (int kind)
21 ZOOM_Event event = (ZOOM_Event) xmalloc (sizeof(*event));
28 static void ZOOM_Event_destroy (ZOOM_Event event)
33 static void ZOOM_connection_put_event (ZOOM_connection c, ZOOM_Event event)
37 c->m_queue_back->prev = event;
38 assert (c->m_queue_front);
42 assert (!c->m_queue_front);
43 c->m_queue_front = event;
45 event->next = c->m_queue_back;
47 c->m_queue_back = event;
50 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
52 ZOOM_Event event = c->m_queue_front;
55 assert (c->m_queue_back);
56 c->m_queue_front = event->prev;
59 assert (c->m_queue_back);
60 c->m_queue_front->next = 0;
64 c->last_event = event->kind;
68 static void clear_error (ZOOM_connection c)
73 case ZOOM_ERROR_CONNECT:
74 case ZOOM_ERROR_MEMORY:
75 case ZOOM_ERROR_DECODE:
76 case ZOOM_ERROR_CONNECTION_LOST:
78 case ZOOM_ERROR_INTERNAL:
81 c->error = ZOOM_ERROR_NONE;
87 ZOOM_task ZOOM_connection_add_task (ZOOM_connection c, int which)
89 ZOOM_task *taskp = &c->tasks;
91 taskp = &(*taskp)->next;
92 *taskp = (ZOOM_task) xmalloc (sizeof(**taskp));
93 (*taskp)->running = 0;
94 (*taskp)->which = which;
100 void ZOOM_connection_remove_task (ZOOM_connection c)
102 ZOOM_task task = c->tasks;
106 c->tasks = task->next;
109 case ZOOM_TASK_SEARCH:
110 ZOOM_resultset_destroy (task->u.search.resultset);
112 case ZOOM_TASK_RETRIEVE:
113 ZOOM_resultset_destroy (task->u.retrieve.resultset);
115 case ZOOM_TASK_CONNECT:
118 ZOOM_scanset_destroy (task->u.scan.scan);
127 void ZOOM_connection_remove_tasks (ZOOM_connection c)
130 ZOOM_connection_remove_task(c);
133 static ZOOM_record record_cache_lookup (ZOOM_resultset r,
135 const char *elementSetName);
137 ZOOM_connection ZOOM_connection_create (ZOOM_options options)
139 ZOOM_connection c = (ZOOM_connection) xmalloc (sizeof(*c));
143 c->state = STATE_IDLE;
144 c->error = ZOOM_ERROR_NONE;
152 c->options = ZOOM_options_create_with_parent(options);
161 c->odr_in = odr_createmem (ODR_DECODE);
162 c->odr_out = odr_createmem (ODR_ENCODE);
165 c->support_named_resultsets = 0;
166 c->last_event = ZOOM_EVENT_NONE;
168 c->m_queue_front = 0;
173 /* set database names. Take local databases (if set); otherwise
174 take databases given in ZURL (if set); otherwise use Default */
175 static char **set_DatabaseNames (ZOOM_connection con, ZOOM_options options,
178 char **databaseNames;
181 const char *cp = ZOOM_options_get (options, "databaseName");
185 cp = strchr (con->host_port, '/');
192 while ((c = strchr(c, '+')))
200 databaseNames = (char**)
201 odr_malloc (con->odr_out, no * sizeof(*databaseNames));
205 c = strchr (cp, '+');
213 /* cp ptr to first char of db name, c is char
215 databaseNames[no] = (char*) odr_malloc (con->odr_out, 1+c-cp);
216 memcpy (databaseNames[no], cp, c-cp);
217 databaseNames[no++][c-cp] = '\0';
222 databaseNames[no] = NULL;
224 return databaseNames;
227 ZOOM_connection ZOOM_connection_new (const char *host, int portnum)
229 ZOOM_connection c = ZOOM_connection_create (0);
231 ZOOM_connection_connect (c, host, portnum);
235 void ZOOM_connection_connect(ZOOM_connection c,
236 const char *host, int portnum)
241 val = ZOOM_options_get (c->options, "proxy");
243 c->proxy = xstrdup (val);
250 sprintf (hostn, "%.80s:%d", host, portnum);
251 c->host_port = xstrdup(hostn);
254 c->host_port = xstrdup(host);
256 ZOOM_options_set(c->options, "host", c->host_port);
258 c->async = ZOOM_options_get_bool (c->options, "async", 0);
260 c->error = ZOOM_ERROR_NONE;
262 task = ZOOM_connection_add_task (c, ZOOM_TASK_CONNECT);
266 while (ZOOM_event (1, &c))
271 ZOOM_query ZOOM_query_create(void)
273 ZOOM_query s = (ZOOM_query) xmalloc (sizeof(*s));
278 s->odr = odr_createmem (ODR_ENCODE);
283 void ZOOM_query_destroy(ZOOM_query s)
289 yaz_log (LOG_DEBUG, "ZOOM_query_destroy count=%d", s->refcount);
290 if (s->refcount == 0)
292 odr_destroy (s->odr);
297 int ZOOM_query_prefix(ZOOM_query s, const char *str)
299 s->query = (Z_Query *) odr_malloc (s->odr, sizeof(*s->query));
300 s->query->which = Z_Query_type_1;
301 s->query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
302 if (!s->query->u.type_1)
307 int ZOOM_query_sortby(ZOOM_query s, const char *criteria)
309 s->sort_spec = yaz_sort_spec (s->odr, criteria);
315 static int do_write(ZOOM_connection c);
317 void ZOOM_connection_destroy(ZOOM_connection c)
324 for (r = c->resultsets; r; r = r->next)
329 odr_destroy (c->odr_in);
330 odr_destroy (c->odr_out);
331 ZOOM_options_destroy (c->options);
332 ZOOM_connection_remove_tasks (c);
333 xfree (c->host_port);
337 void ZOOM_resultset_addref (ZOOM_resultset r)
342 ZOOM_resultset ZOOM_resultset_create ()
344 ZOOM_resultset r = (ZOOM_resultset) xmalloc (sizeof(*r));
348 r->odr = odr_createmem (ODR_ENCODE);
362 ZOOM_resultset ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
365 ZOOM_query s = ZOOM_query_create();
367 ZOOM_query_prefix (s, q);
369 r = ZOOM_connection_search (c, s);
370 ZOOM_query_destroy (s);
374 ZOOM_resultset ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
376 ZOOM_resultset r = ZOOM_resultset_create ();
380 r->r_sort_spec = q->sort_spec;
381 r->r_query = q->query;
384 r->options = ZOOM_options_create_with_parent(c->options);
386 r->start = ZOOM_options_get_int(r->options, "start", 0);
387 r->count = ZOOM_options_get_int(r->options, "count", 0);
388 r->piggyback = ZOOM_options_get_bool (r->options, "piggyback", 1);
389 cp = ZOOM_options_get (r->options, "setname");
391 r->setname = xstrdup (cp);
395 r->next = c->resultsets;
398 task = ZOOM_connection_add_task (c, ZOOM_TASK_SEARCH);
399 task->u.search.resultset = r;
400 ZOOM_resultset_addref (r);
406 while (ZOOM_event (1, &c))
412 void ZOOM_resultset_destroy(ZOOM_resultset r)
417 yaz_log (LOG_DEBUG, "destroy r = %p count=%d", r, r->refcount);
418 if (r->refcount == 0)
420 ZOOM_record_cache rc;
422 for (rc = r->record_cache; rc; rc = rc->next)
423 if (rc->rec.wrbuf_marc)
424 wrbuf_free (rc->rec.wrbuf_marc, 1);
427 /* remove ourselves from the resultsets in connection */
428 ZOOM_resultset *rp = &r->connection->resultsets;
431 assert (*rp); /* we must be in this list!! */
433 { /* OK, we're here - take us out of it */
440 ZOOM_query_destroy (r->search);
441 ZOOM_options_destroy (r->options);
442 odr_destroy (r->odr);
448 size_t ZOOM_resultset_size (ZOOM_resultset r)
453 static void do_close (ZOOM_connection c)
459 c->state = STATE_IDLE;
462 static void ZOOM_resultset_retrieve (ZOOM_resultset r,
463 int force_sync, int start, int count)
473 task = ZOOM_connection_add_task (c, ZOOM_TASK_RETRIEVE);
474 task->u.retrieve.resultset = r;
475 task->u.retrieve.start = start;
476 task->u.retrieve.count = count;
478 ZOOM_resultset_addref (r);
480 if (!r->connection->async || force_sync)
481 while (r->connection && ZOOM_event (1, &r->connection))
485 void ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
486 size_t start, size_t count)
488 int force_present = 0;
494 ZOOM_resultset_retrieve (r, force_present, start, count);
498 for (i = 0; i< count; i++)
499 recs[i] = ZOOM_resultset_record_immediate (r, i+start);
503 static int do_connect (ZOOM_connection c)
506 const char *effective_host;
509 effective_host = c->proxy;
511 effective_host = c->host_port;
513 yaz_log (LOG_DEBUG, "do_connect host=%s", effective_host);
516 c->cs = cs_create_host (effective_host, 0, &add);
520 int ret = cs_connect (c->cs, add);
521 yaz_log (LOG_DEBUG, "cs_connect returned %d", ret);
524 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_CONNECT);
525 ZOOM_connection_put_event(c, event);
526 ZOOM_connection_send_init(c);
527 c->state = STATE_ESTABLISHED;
532 c->state = STATE_CONNECTING;
533 c->mask = ZOOM_SELECT_EXCEPT;
534 if (c->cs->io_pending & CS_WANT_WRITE)
535 c->mask += ZOOM_SELECT_WRITE;
536 if (c->cs->io_pending & CS_WANT_READ)
537 c->mask += ZOOM_SELECT_READ;
541 c->state = STATE_IDLE;
542 c->error = ZOOM_ERROR_CONNECT;
546 int z3950_connection_socket(ZOOM_connection c)
549 return cs_fileno(c->cs);
553 int z3950_connection_mask(ZOOM_connection c)
560 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
565 sprintf (str, "send_APDU t=%p type=%d", c, a->which);
568 Z_OtherInformation **oi;
570 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
572 if (!z_APDU(out, &a, 0, 0))
574 FILE *outf = fopen("/tmp/apdu.txt", "w");
577 ODR odr_pr = odr_createmem(ODR_PRINT);
578 fprintf (outf, "a=%p\n", a);
579 odr_setprint(odr_pr, outf);
580 z_APDU(odr_pr, &a, 0, 0);
584 c->error = ZOOM_ERROR_ENCODE;
592 static int send_APDU (ZOOM_connection c, Z_APDU *a)
596 if (encode_APDU(c, a, c->odr_out))
598 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
599 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
600 ZOOM_connection_put_event (c, event);
601 odr_reset(c->odr_out);
606 static int ZOOM_connection_send_init (ZOOM_connection c)
609 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
610 Z_InitRequest *ireq = apdu->u.initRequest;
611 Z_IdAuthentication *auth = (Z_IdAuthentication *)
612 odr_malloc(c->odr_out, sizeof(*auth));
613 const char *auth_groupId = ZOOM_options_get (c->options, "group");
614 const char *auth_userId = ZOOM_options_get (c->options, "user");
615 const char *auth_password = ZOOM_options_get (c->options, "pass");
617 ODR_MASK_SET(ireq->options, Z_Options_search);
618 ODR_MASK_SET(ireq->options, Z_Options_present);
619 ODR_MASK_SET(ireq->options, Z_Options_scan);
620 ODR_MASK_SET(ireq->options, Z_Options_sort);
621 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
622 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
624 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
625 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
626 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
628 impname = ZOOM_options_get (c->options, "implementationName");
629 ireq->implementationName =
630 (char *) odr_malloc (c->odr_out, 15 + (impname ? strlen(impname) : 0));
631 strcpy (ireq->implementationName, "");
634 strcat (ireq->implementationName, impname);
635 strcat (ireq->implementationName, "/");
637 strcat (ireq->implementationName, "ZOOM-C/YAZ");
639 *ireq->maximumRecordSize =
640 ZOOM_options_get_int (c->options, "maximumRecordSize", 1024*1024);
641 *ireq->preferredMessageSize =
642 ZOOM_options_get_int (c->options, "preferredMessageSize", 1024*1024);
644 if (auth_groupId || auth_password)
646 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
649 if (auth_groupId && *auth_groupId)
651 pass->groupId = (char *)
652 odr_malloc(c->odr_out, strlen(auth_groupId)+1);
653 strcpy(pass->groupId, auth_groupId);
657 if (auth_userId && *auth_userId)
659 pass->userId = (char *)
660 odr_malloc(c->odr_out, strlen(auth_userId)+1);
661 strcpy(pass->userId, auth_userId);
665 if (auth_password && *auth_password)
667 pass->password = (char *)
668 odr_malloc(c->odr_out, strlen(auth_password)+1);
669 strcpy(pass->password, auth_password);
674 auth->which = Z_IdAuthentication_idPass;
675 auth->u.idPass = pass;
676 ireq->idAuthentication = auth;
679 else if (auth_userId)
681 auth->which = Z_IdAuthentication_open;
682 auth->u.open = (char *)
683 odr_malloc(c->odr_out, strlen(auth_userId)+1);
684 strcpy(auth->u.open, auth_userId);
685 ireq->idAuthentication = auth;
688 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
689 VAL_PROXY, 1, c->host_port);
696 static int ZOOM_connection_send_search (ZOOM_connection c)
699 int lslb, ssub, mspn;
701 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
702 Z_SearchRequest *search_req = apdu->u.searchRequest;
703 const char *elementSetName;
704 const char *smallSetElementSetName;
705 const char *mediumSetElementSetName;
709 assert (c->tasks->which == ZOOM_TASK_SEARCH);
711 r = c->tasks->u.search.resultset;
714 ZOOM_options_get (r->options, "elementSetName");
715 smallSetElementSetName =
716 ZOOM_options_get (r->options, "smallSetElementSetName");
717 mediumSetElementSetName =
718 ZOOM_options_get (r->options, "mediumSetElementSetName");
720 ZOOM_options_get (r->options, "schema");
722 if (!smallSetElementSetName)
723 smallSetElementSetName = elementSetName;
725 if (!mediumSetElementSetName)
726 mediumSetElementSetName = elementSetName;
731 /* prepare query for the search request */
732 search_req->query = r->r_query;
734 search_req->databaseNames =
735 set_DatabaseNames (c, r->options, &search_req->num_databaseNames);
737 /* get syntax (no need to provide unless piggyback is in effect) */
738 syntax = ZOOM_options_get (r->options, "preferredRecordSyntax");
740 lslb = ZOOM_options_get_int (r->options, "largeSetLowerBound", -1);
741 ssub = ZOOM_options_get_int (r->options, "smallSetUpperBound", -1);
742 mspn = ZOOM_options_get_int (r->options, "mediumSetPresentNumber", -1);
743 if (lslb != -1 && ssub != -1 && mspn != -1)
745 /* So're a Z39.50 expert? Let's hope you don't do sort */
746 *search_req->largeSetLowerBound = lslb;
747 *search_req->smallSetUpperBound = ssub;
748 *search_req->mediumSetPresentNumber = mspn;
750 else if (r->start == 0 && r->count > 0
751 && r->piggyback && !r->r_sort_spec && !schema)
753 /* Regular piggyback - do it unless we're going to do sort */
754 *search_req->largeSetLowerBound = 2000000000;
755 *search_req->smallSetUpperBound = r->count;
756 *search_req->mediumSetPresentNumber = r->count;
757 smallSetElementSetName = 0; /* no need to provide this */
761 /* non-piggyback. Need not provide elementsets or syntaxes .. */
762 smallSetElementSetName = 0;
763 mediumSetElementSetName = 0;
766 if (smallSetElementSetName && *smallSetElementSetName)
768 Z_ElementSetNames *esn = (Z_ElementSetNames *)
769 odr_malloc (c->odr_out, sizeof(*esn));
771 esn->which = Z_ElementSetNames_generic;
772 esn->u.generic = odr_strdup (c->odr_out, smallSetElementSetName);
773 search_req->smallSetElementSetNames = esn;
775 if (mediumSetElementSetName && *mediumSetElementSetName)
777 Z_ElementSetNames *esn = (Z_ElementSetNames *)
778 odr_malloc (c->odr_out, sizeof(*esn));
780 esn->which = Z_ElementSetNames_generic;
781 esn->u.generic = odr_strdup (c->odr_out, mediumSetElementSetName);
782 search_req->mediumSetElementSetNames = esn;
785 search_req->preferredRecordSyntax =
786 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
790 if (c->support_named_resultsets)
794 /* find the lowest unused ordinal so that we re-use
795 result sets on the server. */
796 for (ord = 1; ; ord++)
799 sprintf (setname, "%d", ord);
800 for (rp = c->resultsets; rp; rp = rp->next)
801 if (rp->setname && !strcmp (rp->setname, setname))
806 r->setname = xstrdup (setname);
807 yaz_log (LOG_DEBUG, "allocating %s", r->setname);
810 r->setname = xstrdup ("default");
811 ZOOM_options_set (r->options, "setname", r->setname);
813 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
814 /* send search request */
820 static void response_diag (ZOOM_connection c, Z_DiagRec *p)
822 Z_DefaultDiagFormat *r;
827 if (p->which != Z_DiagRec_defaultFormat)
829 c->error = ZOOM_ERROR_DECODE;
832 r = p->u.defaultFormat;
835 case Z_DefaultDiagFormat_v2Addinfo:
836 addinfo = r->u.v2Addinfo;
838 case Z_DefaultDiagFormat_v3Addinfo:
839 addinfo = r->u.v3Addinfo;
843 c->addinfo = xstrdup (addinfo);
844 c->error = *r->condition;
847 ZOOM_record ZOOM_record_clone (ZOOM_record srec)
854 odr_enc = odr_createmem(ODR_ENCODE);
855 if (!z_NamePlusRecord (odr_enc, &srec->npr, 0, 0))
857 buf = odr_getbuf (odr_enc, &size, 0);
859 nrec = (ZOOM_record) xmalloc (sizeof(*nrec));
860 nrec->odr = odr_createmem(ODR_DECODE);
861 nrec->wrbuf_marc = 0;
862 odr_setbuf (nrec->odr, buf, size, 0);
863 z_NamePlusRecord (nrec->odr, &nrec->npr, 0, 0);
865 odr_destroy (odr_enc);
869 ZOOM_record ZOOM_resultset_record_immediate (ZOOM_resultset s,size_t pos)
871 return record_cache_lookup (s, pos, 0);
874 ZOOM_record ZOOM_resultset_record (ZOOM_resultset r, size_t pos)
876 ZOOM_resultset_retrieve (r, 1, pos, 1);
877 return ZOOM_resultset_record_immediate (r, pos);
880 void ZOOM_record_destroy (ZOOM_record rec)
885 wrbuf_free (rec->wrbuf_marc, 1);
886 odr_destroy (rec->odr);
890 const char *ZOOM_record_get (ZOOM_record rec, const char *type, int *len)
892 Z_NamePlusRecord *npr;
898 if (!strcmp (type, "database"))
900 return npr->databaseName;
902 else if (!strcmp (type, "syntax"))
904 if (npr->which == Z_NamePlusRecord_databaseRecord)
906 Z_External *r = (Z_External *) npr->u.databaseRecord;
907 oident *ent = oid_getentbyoid(r->direct_reference);
913 else if (!strcmp (type, "render") &&
914 npr->which == Z_NamePlusRecord_databaseRecord)
916 Z_External *r = (Z_External *) npr->u.databaseRecord;
917 oident *ent = oid_getentbyoid(r->direct_reference);
919 if (r->which == Z_External_sutrs)
921 *len = r->u.sutrs->len;
922 return (const char *) r->u.sutrs->buf;
924 else if (r->which == Z_External_octet)
933 case VAL_APPLICATION_XML:
936 if (!rec->wrbuf_marc)
937 rec->wrbuf_marc = wrbuf_alloc();
938 wrbuf_rewind (rec->wrbuf_marc);
939 if (yaz_marc_decode ((const char *)
940 r->u.octet_aligned->buf,
942 r->u.octet_aligned->len,
945 *len = wrbuf_len(rec->wrbuf_marc);
946 return wrbuf_buf(rec->wrbuf_marc);
949 *len = r->u.octet_aligned->len;
950 return (const char *) r->u.octet_aligned->buf;
952 else if (r->which == Z_External_grs1)
959 else if (!strcmp (type, "xml") &&
960 npr->which == Z_NamePlusRecord_databaseRecord)
962 Z_External *r = (Z_External *) npr->u.databaseRecord;
963 oident *ent = oid_getentbyoid(r->direct_reference);
965 if (r->which == Z_External_sutrs)
967 *len = r->u.sutrs->len;
968 return (const char *) r->u.sutrs->buf;
970 else if (r->which == Z_External_octet)
979 case VAL_APPLICATION_XML:
982 if (!rec->wrbuf_marc)
983 rec->wrbuf_marc = wrbuf_alloc();
984 wrbuf_rewind (rec->wrbuf_marc);
985 if (yaz_marc_decode ((const char *)
986 r->u.octet_aligned->buf,
988 r->u.octet_aligned->len,
991 *len = wrbuf_len(rec->wrbuf_marc);
992 return wrbuf_buf(rec->wrbuf_marc);
995 *len = r->u.octet_aligned->len;
996 return (const char *) r->u.octet_aligned->buf;
998 else if (r->which == Z_External_grs1)
1005 else if (!strcmp (type, "raw"))
1007 if (npr->which == Z_NamePlusRecord_databaseRecord)
1009 Z_External *r = (Z_External *) npr->u.databaseRecord;
1011 if (r->which == Z_External_sutrs)
1013 *len = r->u.sutrs->len;
1014 return (const char *) r->u.sutrs->buf;
1016 else if (r->which == Z_External_octet)
1018 *len = r->u.octet_aligned->len;
1019 return (const char *) r->u.octet_aligned->buf;
1021 else /* grs-1, explain, ... */
1024 return (const char *) npr->u.databaseRecord;
1032 static void record_cache_add (ZOOM_resultset r,
1033 Z_NamePlusRecord *npr,
1035 const char *elementSetName)
1037 ZOOM_record_cache rc;
1039 for (rc = r->record_cache; rc; rc = rc->next)
1043 if ((!elementSetName && !rc->elementSetName)
1044 || (elementSetName && rc->elementSetName &&
1045 !strcmp (elementSetName, rc->elementSetName)))
1047 /* not destroying rc->npr (it's handled by nmem )*/
1049 /* keeping wrbuf_marc too */
1054 rc = (ZOOM_record_cache) odr_malloc (r->odr, sizeof(*rc));
1057 rc->rec.wrbuf_marc = 0;
1059 rc->elementSetName = odr_strdup (r->odr, elementSetName);
1061 rc->elementSetName = 0;
1063 rc->next = r->record_cache;
1064 r->record_cache = rc;
1067 static ZOOM_record record_cache_lookup (ZOOM_resultset r,
1069 const char *elementSetName)
1071 ZOOM_record_cache rc;
1073 for (rc = r->record_cache; rc; rc = rc->next)
1077 if ((!elementSetName && !rc->elementSetName)
1078 || (elementSetName && rc->elementSetName &&
1079 !strcmp (elementSetName, rc->elementSetName)))
1086 static void handle_records (ZOOM_connection c, Z_Records *sr,
1089 ZOOM_resultset resultset;
1093 switch (c->tasks->which)
1095 case ZOOM_TASK_SEARCH:
1096 resultset = c->tasks->u.search.resultset;
1098 case ZOOM_TASK_RETRIEVE:
1099 resultset = c->tasks->u.retrieve.resultset;
1104 if (sr && sr->which == Z_Records_NSD)
1106 Z_DiagRec dr, *dr_p = &dr;
1107 dr.which = Z_DiagRec_defaultFormat;
1108 dr.u.defaultFormat = sr->u.nonSurrogateDiagnostic;
1110 response_diag (c, dr_p);
1112 else if (sr && sr->which == Z_Records_multipleNSD)
1114 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
1115 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
1117 c->error = ZOOM_ERROR_DECODE;
1121 if (resultset->count + resultset->start > resultset->size)
1122 resultset->count = resultset->size - resultset->start;
1123 if (resultset->count < 0)
1124 resultset->count = 0;
1125 if (sr && sr->which == Z_Records_DBOSD)
1128 NMEM nmem = odr_extract_mem (c->odr_in);
1129 Z_NamePlusRecordList *p =
1130 sr->u.databaseOrSurDiagnostics;
1131 for (i = 0; i<p->num_records; i++)
1133 record_cache_add (resultset, p->records[i],
1134 i+ resultset->start, 0);
1136 /* transfer our response to search_nmem .. we need it later */
1137 nmem_transfer (resultset->odr->mem, nmem);
1138 nmem_destroy (nmem);
1139 if (present_phase && p->num_records == 0)
1141 /* present response and we didn't get any records! */
1142 c->error = ZOOM_ERROR_DECODE;
1145 else if (present_phase)
1147 /* present response and we didn't get any records! */
1148 c->error = ZOOM_ERROR_DECODE;
1153 static void handle_present_response (ZOOM_connection c, Z_PresentResponse *pr)
1155 handle_records (c, pr->records, 1);
1158 static void handle_search_response (ZOOM_connection c, Z_SearchResponse *sr)
1160 ZOOM_resultset resultset;
1162 yaz_log (LOG_DEBUG, "got search response");
1164 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1167 resultset = c->tasks->u.search.resultset;
1169 resultset->size = *sr->resultCount;
1170 handle_records (c, sr->records, 0);
1173 static void sort_response (ZOOM_connection c, Z_SortResponse *res)
1175 if (res->diagnostics && res->num_diagnostics > 0)
1176 response_diag (c, res->diagnostics[0]);
1179 static int scan_response (ZOOM_connection c, Z_ScanResponse *res)
1181 NMEM nmem = odr_extract_mem (c->odr_in);
1184 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
1186 scan = c->tasks->u.scan.scan;
1188 if (res->entries && res->entries->nonsurrogateDiagnostics)
1189 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
1190 scan->scan_response = res;
1191 nmem_transfer (scan->odr->mem, nmem);
1193 ZOOM_options_set_int (scan->options, "stepSize", *res->stepSize);
1194 if (res->positionOfTerm)
1195 ZOOM_options_set_int (scan->options, "position", *res->positionOfTerm);
1196 if (res->scanStatus)
1197 ZOOM_options_set_int (scan->options, "scanStatus", *res->scanStatus);
1198 if (res->numberOfEntriesReturned)
1199 ZOOM_options_set_int (scan->options, "number",
1200 *res->numberOfEntriesReturned);
1201 nmem_destroy (nmem);
1205 static int send_sort (ZOOM_connection c)
1207 ZOOM_resultset resultset;
1209 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1212 resultset = c->tasks->u.search.resultset;
1216 resultset->r_sort_spec = 0;
1219 if (resultset->r_sort_spec)
1221 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
1222 Z_SortRequest *req = apdu->u.sortRequest;
1224 req->num_inputResultSetNames = 1;
1225 req->inputResultSetNames = (Z_InternationalString **)
1226 odr_malloc (c->odr_out, sizeof(*req->inputResultSetNames));
1227 req->inputResultSetNames[0] =
1228 odr_strdup (c->odr_out, resultset->setname);
1229 req->sortedResultSetName = odr_strdup (c->odr_out, resultset->setname);
1230 req->sortSequence = resultset->r_sort_spec;
1231 resultset->r_sort_spec = 0;
1232 send_APDU (c, apdu);
1238 static int send_present (ZOOM_connection c)
1240 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
1241 Z_PresentRequest *req = apdu->u.presentRequest;
1243 const char *syntax =
1244 ZOOM_options_get (c->options, "preferredRecordSyntax");
1245 const char *element =
1246 ZOOM_options_get (c->options, "elementSetName");
1247 const char *schema =
1248 ZOOM_options_get (c->options, "schema");
1249 ZOOM_resultset resultset;
1254 switch (c->tasks->which)
1256 case ZOOM_TASK_SEARCH:
1257 resultset = c->tasks->u.search.resultset;
1259 case ZOOM_TASK_RETRIEVE:
1260 resultset = c->tasks->u.retrieve.resultset;
1261 resultset->start = c->tasks->u.retrieve.start;
1262 resultset->count = c->tasks->u.retrieve.count;
1264 if (resultset->start >= resultset->size)
1266 if (resultset->start + resultset->count > resultset->size)
1267 resultset->count = resultset->size - resultset->start;
1273 if (c->error) /* don't continue on error */
1275 if (resultset->start < 0)
1277 for (i = 0; i<resultset->count; i++)
1280 record_cache_lookup (resultset, i + resultset->start, 0);
1284 if (i == resultset->count)
1287 resultset->start += i;
1288 resultset->count -= i;
1289 *req->resultSetStartPoint = resultset->start + 1;
1290 *req->numberOfRecordsRequested = resultset->count;
1291 assert (*req->numberOfRecordsRequested > 0);
1293 if (syntax && *syntax)
1294 req->preferredRecordSyntax =
1295 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1297 if (schema && *schema)
1299 Z_RecordComposition *compo = (Z_RecordComposition *)
1300 odr_malloc (c->odr_out, sizeof(*compo));
1302 req->recordComposition = compo;
1303 compo->which = Z_RecordComp_complex;
1304 compo->u.complex = (Z_CompSpec *)
1305 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
1306 compo->u.complex->selectAlternativeSyntax = (bool_t *)
1307 odr_malloc(c->odr_out, sizeof(bool_t));
1308 *compo->u.complex->selectAlternativeSyntax = 0;
1310 compo->u.complex->generic = (Z_Specification *)
1311 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
1313 compo->u.complex->generic->schema = (Odr_oid *)
1314 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, schema);
1316 if (!compo->u.complex->generic->schema)
1318 /* OID wasn't a schema! Try record syntax instead. */
1320 compo->u.complex->generic->schema = (Odr_oid *)
1321 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, schema);
1323 if (element && *element)
1325 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
1326 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
1327 compo->u.complex->generic->elementSpec->which =
1328 Z_ElementSpec_elementSetName;
1329 compo->u.complex->generic->elementSpec->u.elementSetName =
1330 odr_strdup (c->odr_out, element);
1333 compo->u.complex->generic->elementSpec = 0;
1334 compo->u.complex->num_dbSpecific = 0;
1335 compo->u.complex->dbSpecific = 0;
1336 compo->u.complex->num_recordSyntax = 0;
1337 compo->u.complex->recordSyntax = 0;
1339 else if (element && *element)
1341 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1342 odr_malloc (c->odr_out, sizeof(*esn));
1343 Z_RecordComposition *compo = (Z_RecordComposition *)
1344 odr_malloc (c->odr_out, sizeof(*compo));
1346 esn->which = Z_ElementSetNames_generic;
1347 esn->u.generic = odr_strdup (c->odr_out, element);
1348 compo->which = Z_RecordComp_simple;
1349 compo->u.simple = esn;
1350 req->recordComposition = compo;
1352 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
1353 send_APDU (c, apdu);
1357 ZOOM_scanset ZOOM_connection_scan (ZOOM_connection c, const char *start)
1359 ZOOM_scanset scan = (ZOOM_scanset) xmalloc (sizeof(*scan));
1361 scan->connection = c;
1362 scan->odr = odr_createmem (ODR_DECODE);
1363 scan->options = ZOOM_options_create_with_parent (c->options);
1365 scan->scan_response = 0;
1367 if ((scan->termListAndStartPoint =
1368 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet,
1371 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_SCAN);
1372 task->u.scan.scan = scan;
1377 while (ZOOM_event (1, &c))
1384 void ZOOM_scanset_destroy (ZOOM_scanset scan)
1389 if (scan->refcount == 0)
1391 odr_destroy (scan->odr);
1393 ZOOM_options_destroy (scan->options);
1398 int send_scan (ZOOM_connection c)
1401 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
1402 Z_ScanRequest *req = apdu->u.scanRequest;
1405 assert (c->tasks->which == ZOOM_TASK_SCAN);
1406 scan = c->tasks->u.scan.scan;
1408 req->termListAndStartPoint = scan->termListAndStartPoint;
1409 req->attributeSet = scan->attributeSet;
1411 *req->numberOfTermsRequested =
1412 ZOOM_options_get_int(scan->options, "number", 10);
1414 req->preferredPositionInResponse =
1415 odr_intdup (c->odr_out,
1416 ZOOM_options_get_int(scan->options, "position", 1));
1419 odr_intdup (c->odr_out,
1420 ZOOM_options_get_int(scan->options, "stepSize", 0));
1422 req->databaseNames = set_DatabaseNames (c, scan->options,
1423 &req->num_databaseNames);
1425 send_APDU (c, apdu);
1430 size_t ZOOM_scanset_size (ZOOM_scanset scan)
1432 if (!scan || !scan->scan_response || !scan->scan_response->entries)
1434 return scan->scan_response->entries->num_entries;
1437 const char *ZOOM_scanset_term (ZOOM_scanset scan, size_t pos,
1440 const char *term = 0;
1441 size_t noent = ZOOM_scanset_size (scan);
1442 Z_ScanResponse *res = scan->scan_response;
1448 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
1450 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
1452 if (t->term->which == Z_Term_general)
1454 term = (const char *) t->term->u.general->buf;
1455 *len = t->term->u.general->len;
1457 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
1462 const char *ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key)
1464 return ZOOM_options_get (scan->options, key);
1467 void ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
1470 ZOOM_options_set (scan->options, key, val);
1473 static int ZOOM_connection_exec_task (ZOOM_connection c)
1475 ZOOM_task task = c->tasks;
1477 yaz_log (LOG_DEBUG, "ZOOM_connection_exec_task");
1480 if (c->error != ZOOM_ERROR_NONE ||
1481 (!c->cs && task->which != ZOOM_TASK_CONNECT))
1483 ZOOM_connection_remove_tasks (c);
1486 yaz_log (LOG_DEBUG, "ZOOM_connection_exec_task type=%d", task->which);
1490 switch (task->which)
1492 case ZOOM_TASK_SEARCH:
1493 /* see if search hasn't been sent yet. */
1494 if (ZOOM_connection_send_search (c))
1497 case ZOOM_TASK_RETRIEVE:
1498 if (send_present (c))
1501 case ZOOM_TASK_CONNECT:
1505 case ZOOM_TASK_SCAN:
1509 ZOOM_connection_remove_task (c);
1513 static int send_sort_present (ZOOM_connection c)
1515 int r = send_sort (c);
1517 r = send_present (c);
1521 static void handle_apdu (ZOOM_connection c, Z_APDU *apdu)
1523 Z_InitResponse *initrs;
1525 yaz_log (LOG_DEBUG, "hande_apdu type=%d", apdu->which);
1529 case Z_APDU_initResponse:
1530 initrs = apdu->u.initResponse;
1531 if (!*initrs->result)
1533 c->error = ZOOM_ERROR_INIT;
1538 yaz_oi_get_string_oidval (&apdu->u.initResponse->otherInfo,
1540 xfree (c->cookie_in);
1543 c->cookie_in = xstrdup(cookie);
1544 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
1545 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
1546 c->support_named_resultsets = 1;
1549 assert (c->tasks->which == ZOOM_TASK_CONNECT);
1550 ZOOM_connection_remove_task (c);
1552 ZOOM_connection_exec_task (c);
1555 case Z_APDU_searchResponse:
1556 handle_search_response (c, apdu->u.searchResponse);
1557 if (!send_sort_present (c))
1558 ZOOM_connection_remove_task (c);
1560 case Z_APDU_presentResponse:
1561 handle_present_response (c, apdu->u.presentResponse);
1562 if (!send_present (c))
1563 ZOOM_connection_remove_task (c);
1565 case Z_APDU_sortResponse:
1566 sort_response (c, apdu->u.sortResponse);
1567 if (!send_present (c))
1568 ZOOM_connection_remove_task (c);
1570 case Z_APDU_scanResponse:
1571 scan_response (c, apdu->u.scanResponse);
1572 ZOOM_connection_remove_task (c);
1576 static int do_read (ZOOM_connection c)
1582 event = ZOOM_Event_create (ZOOM_EVENT_RECV_DATA);
1583 ZOOM_connection_put_event (c, event);
1585 r = cs_get (c->cs, &c->buf_in, &c->len_in);
1590 c->error= ZOOM_ERROR_CONNECTION_LOST;
1596 odr_reset (c->odr_in);
1597 odr_setbuf (c->odr_in, c->buf_in, r, 0);
1598 event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);
1599 ZOOM_connection_put_event (c, event);
1600 if (!z_APDU (c->odr_in, &apdu, 0, 0))
1602 c->error = ZOOM_ERROR_DECODE;
1607 handle_apdu (c, apdu);
1613 static int do_write_ex (ZOOM_connection c, char *buf_out, int len_out)
1618 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
1619 ZOOM_connection_put_event (c, event);
1621 if ((r=cs_put (c->cs, buf_out, len_out)) < 0)
1623 if (c->state == STATE_CONNECTING)
1624 c->error = ZOOM_ERROR_CONNECT;
1626 c->error = ZOOM_ERROR_CONNECTION_LOST;
1632 c->mask = ZOOM_SELECT_EXCEPT;
1633 if (c->cs->io_pending & CS_WANT_WRITE)
1634 c->mask += ZOOM_SELECT_WRITE;
1635 if (c->cs->io_pending & CS_WANT_READ)
1636 c->mask += ZOOM_SELECT_READ;
1637 yaz_log (LOG_DEBUG, "do_write_ex 1 mask=%d", c->mask);
1641 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
1642 yaz_log (LOG_DEBUG, "do_write_ex 2 mask=%d", c->mask);
1647 static int do_write(ZOOM_connection c)
1649 return do_write_ex (c, c->buf_out, c->len_out);
1653 const char *ZOOM_connection_option_get (ZOOM_connection c, const char *key)
1655 return ZOOM_options_get (c->options, key);
1658 void ZOOM_connection_option_set (ZOOM_connection c, const char *key,
1661 ZOOM_options_set (c->options, key, val);
1664 const char *ZOOM_resultset_option_get (ZOOM_resultset r, const char *key)
1666 return ZOOM_options_get (r->options, key);
1669 void ZOOM_resultset_option_set (ZOOM_resultset r, const char *key,
1672 ZOOM_options_set (r->options, key, val);
1676 int ZOOM_connection_errcode (ZOOM_connection c)
1678 return ZOOM_connection_error (c, 0, 0);
1681 const char *ZOOM_connection_errmsg (ZOOM_connection c)
1684 ZOOM_connection_error (c, &msg, 0);
1688 const char *ZOOM_connection_addinfo (ZOOM_connection c)
1690 const char *addinfo;
1691 ZOOM_connection_error (c, 0, &addinfo);
1695 int ZOOM_connection_error (ZOOM_connection c, const char **cp,
1696 const char **addinfo)
1698 int error = c->error;
1703 case ZOOM_ERROR_NONE:
1704 *cp = "No error"; break;
1705 case ZOOM_ERROR_CONNECT:
1706 *cp = "Connect failed"; break;
1707 case ZOOM_ERROR_MEMORY:
1708 *cp = "Out of memory"; break;
1709 case ZOOM_ERROR_ENCODE:
1710 *cp = "Encoding failed"; break;
1711 case ZOOM_ERROR_DECODE:
1712 *cp = "Decoding failed"; break;
1713 case ZOOM_ERROR_CONNECTION_LOST:
1714 *cp = "Connection lost"; break;
1715 case ZOOM_ERROR_INIT:
1716 *cp = "Init rejected"; break;
1717 case ZOOM_ERROR_INTERNAL:
1718 *cp = "Internal failure"; break;
1719 case ZOOM_ERROR_TIMEOUT:
1720 *cp = "Timeout"; break;
1722 *cp = diagbib1_str (error);
1728 *addinfo = c->addinfo;
1735 int ZOOM_connection_do_io(ZOOM_connection c, int mask)
1737 ZOOM_Event event = 0;
1738 int r = cs_look(c->cs);
1739 yaz_log (LOG_DEBUG, "ZOOM_connection_do_io c=%p mask=%d cs_look=%d",
1744 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
1745 c->error = ZOOM_ERROR_CONNECT;
1747 ZOOM_connection_put_event (c, event);
1749 else if (r == CS_CONNECT)
1752 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
1754 ret = cs_rcvconnect (c->cs);
1755 yaz_log (LOG_DEBUG, "cs_rcvconnect returned %d", ret);
1758 c->mask = ZOOM_SELECT_EXCEPT;
1759 if (c->cs->io_pending & CS_WANT_WRITE)
1760 c->mask += ZOOM_SELECT_WRITE;
1761 if (c->cs->io_pending & CS_WANT_READ)
1762 c->mask += ZOOM_SELECT_READ;
1763 ZOOM_connection_put_event (c, event);
1767 ZOOM_connection_put_event (c, event);
1768 ZOOM_connection_send_init (c);
1769 c->state = STATE_ESTABLISHED;
1773 c->error = ZOOM_ERROR_CONNECT;
1775 ZOOM_connection_put_event (c, event);
1780 if (mask & ZOOM_SELECT_READ)
1782 if (c->cs && (mask & ZOOM_SELECT_WRITE))
1788 int ZOOM_connection_last_event(ZOOM_connection cs)
1791 return ZOOM_EVENT_NONE;
1792 return cs->last_event;
1795 int ZOOM_event (int no, ZOOM_connection *cs)
1798 struct pollfd pollfds[1024];
1799 ZOOM_connection poll_cs[1024];
1802 fd_set input, output, except;
1807 for (i = 0; i<no; i++)
1809 ZOOM_connection c = cs[i];
1811 if (c && (event = ZOOM_connection_get_event(c)))
1813 ZOOM_Event_destroy (event);
1817 for (i = 0; i<no; i++)
1819 ZOOM_connection c = cs[i];
1821 if (c && ZOOM_connection_exec_task (c))
1823 if ((event = ZOOM_connection_get_event(c)))
1825 ZOOM_Event_destroy (event);
1841 for (i = 0; i<no; i++)
1843 ZOOM_connection c = cs[i];
1848 fd = z3950_connection_socket(c);
1849 mask = z3950_connection_mask(c);
1859 short poll_events = 0;
1861 if (mask & ZOOM_SELECT_READ)
1862 poll_events += POLLIN;
1863 if (mask & ZOOM_SELECT_WRITE)
1864 poll_events += POLLOUT;
1865 if (mask & ZOOM_SELECT_EXCEPT)
1866 poll_events += POLLERR;
1867 pollfds[nfds].fd = fd;
1868 pollfds[nfds].events = poll_events;
1869 pollfds[nfds].revents = 0;
1874 if (mask & ZOOM_SELECT_READ)
1876 FD_SET (fd, &input);
1879 if (mask & ZOOM_SELECT_WRITE)
1881 FD_SET (fd, &output);
1884 if (mask & ZOOM_SELECT_EXCEPT)
1886 FD_SET (fd, &except);
1894 r = poll (pollfds, nfds, 15000);
1895 for (i = 0; i<nfds; i++)
1897 ZOOM_connection c = poll_cs[i];
1901 if (pollfds[i].revents & POLLIN)
1902 mask += ZOOM_SELECT_READ;
1903 if (pollfds[i].revents & POLLOUT)
1904 mask += ZOOM_SELECT_WRITE;
1905 if (pollfds[i].revents & POLLERR)
1906 mask += ZOOM_SELECT_EXCEPT;
1908 ZOOM_connection_do_io(c, mask);
1910 else if (r == 0 && c->mask)
1912 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
1913 /* timeout and this connection was waiting */
1914 c->error = ZOOM_ERROR_TIMEOUT;
1916 ZOOM_connection_put_event(c, event);
1920 yaz_log (LOG_DEBUG, "select start");
1921 r = select (max_fd+1, &input, &output, &except, &tv);
1922 yaz_log (LOG_DEBUG, "select stop, returned r=%d", r);
1923 for (i = 0; i<no; i++)
1925 ZOOM_connection c = cs[i];
1930 fd = z3950_connection_socket(c);
1934 /* no timeout and real socket */
1935 if (FD_ISSET(fd, &input))
1936 mask += ZOOM_SELECT_READ;
1937 if (FD_ISSET(fd, &output))
1938 mask += ZOOM_SELECT_WRITE;
1939 if (FD_ISSET(fd, &except))
1940 mask += ZOOM_SELECT_EXCEPT;
1942 ZOOM_connection_do_io(c, mask);
1944 if (r == 0 && c->mask)
1946 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
1947 /* timeout and this connection was waiting */
1948 c->error = ZOOM_ERROR_TIMEOUT;
1950 yaz_log (LOG_DEBUG, "timeout");
1951 ZOOM_connection_put_event(c, event);
1955 for (i = 0; i<no; i++)
1957 ZOOM_connection c = cs[i];
1959 if (c && (event = ZOOM_connection_get_event(c)))
1961 ZOOM_Event_destroy (event);