2 * $Id: zoom-c.c,v 1.20 2002-01-09 12:44:31 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 = 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)
35 // put in back of queue
38 c->m_queue_back->prev = event;
39 assert (c->m_queue_front);
43 assert (!c->m_queue_front);
44 c->m_queue_front = event;
46 event->next = c->m_queue_back;
48 c->m_queue_back = event;
51 static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
53 // get from front of queue
54 ZOOM_Event event = c->m_queue_front;
57 assert (c->m_queue_back);
58 c->m_queue_front = event->prev;
61 assert (c->m_queue_back);
62 c->m_queue_front->next = 0;
66 c->last_event = event->kind;
70 static void clear_error (ZOOM_connection c)
75 case ZOOM_ERROR_CONNECT:
76 case ZOOM_ERROR_MEMORY:
77 case ZOOM_ERROR_DECODE:
78 case ZOOM_ERROR_CONNECTION_LOST:
80 case ZOOM_ERROR_INTERNAL:
83 c->error = ZOOM_ERROR_NONE;
89 ZOOM_task ZOOM_connection_add_task (ZOOM_connection c, int which)
91 ZOOM_task *taskp = &c->tasks;
93 taskp = &(*taskp)->next;
94 *taskp = xmalloc (sizeof(**taskp));
95 (*taskp)->running = 0;
96 (*taskp)->which = which;
102 void ZOOM_connection_remove_task (ZOOM_connection c)
104 ZOOM_task task = c->tasks;
108 c->tasks = task->next;
111 case ZOOM_TASK_SEARCH:
112 ZOOM_resultset_destroy (task->u.search.resultset);
114 case ZOOM_TASK_RETRIEVE:
115 ZOOM_resultset_destroy (task->u.retrieve.resultset);
117 case ZOOM_TASK_CONNECT:
120 ZOOM_scanset_destroy (task->u.scan.scan);
129 void ZOOM_connection_remove_tasks (ZOOM_connection c)
132 ZOOM_connection_remove_task(c);
135 static ZOOM_record record_cache_lookup (ZOOM_resultset r,
137 const char *elementSetName);
139 ZOOM_connection ZOOM_connection_create (ZOOM_options options)
141 ZOOM_connection c = xmalloc (sizeof(*c));
145 c->state = STATE_IDLE;
146 c->error = ZOOM_ERROR_NONE;
154 c->options = ZOOM_options_create_with_parent(options);
163 c->odr_in = odr_createmem (ODR_DECODE);
164 c->odr_out = odr_createmem (ODR_ENCODE);
167 c->support_named_resultsets = 0;
168 c->last_event = ZOOM_EVENT_NONE;
170 c->m_queue_front = 0;
175 /* set database names. Take local databases (if set); otherwise
176 take databases given in ZURL (if set); otherwise use Default */
177 static char **set_DatabaseNames (ZOOM_connection con, ZOOM_options options,
180 char **databaseNames;
183 const char *cp = ZOOM_options_get (options, "databaseName");
187 cp = strchr (con->host_port, '/');
194 while ((c = strchr(c, '+')))
202 databaseNames = odr_malloc (con->odr_out, no * sizeof(*databaseNames));
206 c = strchr (cp, '+');
214 /* cp ptr to first char of db name, c is char
216 databaseNames[no] = odr_malloc (con->odr_out, 1+c-cp);
217 memcpy (databaseNames[no], cp, c-cp);
218 databaseNames[no++][c-cp] = '\0';
223 databaseNames[no] = NULL;
225 return databaseNames;
228 ZOOM_connection ZOOM_connection_new (const char *host, int portnum)
230 ZOOM_connection c = ZOOM_connection_create (0);
232 ZOOM_connection_connect (c, host, portnum);
236 void ZOOM_connection_connect(ZOOM_connection c,
237 const char *host, int portnum)
242 val = ZOOM_options_get (c->options, "proxy");
244 c->proxy = xstrdup (val);
251 sprintf (hostn, "%.80s:%d", host, portnum);
252 c->host_port = xstrdup(hostn);
255 c->host_port = xstrdup(host);
257 ZOOM_options_set(c->options, "host", c->host_port);
259 c->async = ZOOM_options_get_bool (c->options, "async", 0);
261 c->error = ZOOM_ERROR_NONE;
263 task = ZOOM_connection_add_task (c, ZOOM_TASK_CONNECT);
267 while (ZOOM_event (1, &c))
272 ZOOM_query ZOOM_query_create(void)
274 ZOOM_query s = xmalloc (sizeof(*s));
279 s->odr = odr_createmem (ODR_ENCODE);
284 void ZOOM_query_destroy(ZOOM_query s)
290 yaz_log (LOG_DEBUG, "ZOOM_query_destroy count=%d", s->refcount);
291 if (s->refcount == 0)
293 odr_destroy (s->odr);
298 int ZOOM_query_prefix(ZOOM_query s, const char *str)
300 s->query = odr_malloc (s->odr, sizeof(*s->query));
301 s->query->which = Z_Query_type_1;
302 s->query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
303 if (!s->query->u.type_1)
308 int ZOOM_query_sortby(ZOOM_query s, const char *criteria)
310 s->sort_spec = yaz_sort_spec (s->odr, criteria);
316 static int do_write(ZOOM_connection c);
318 void ZOOM_connection_destroy(ZOOM_connection c)
325 for (r = c->resultsets; r; r = r->next)
330 odr_destroy (c->odr_in);
331 odr_destroy (c->odr_out);
332 ZOOM_options_destroy (c->options);
333 ZOOM_connection_remove_tasks (c);
334 xfree (c->host_port);
338 void ZOOM_resultset_addref (ZOOM_resultset r)
343 ZOOM_resultset ZOOM_resultset_create ()
345 ZOOM_resultset r = xmalloc (sizeof(*r));
349 r->odr = odr_createmem (ODR_ENCODE);
363 ZOOM_resultset ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
366 ZOOM_query s = ZOOM_query_create();
368 ZOOM_query_prefix (s, q);
370 r = ZOOM_connection_search (c, s);
371 ZOOM_query_destroy (s);
375 ZOOM_resultset ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
377 ZOOM_resultset r = ZOOM_resultset_create ();
381 r->r_sort_spec = q->sort_spec;
382 r->r_query = q->query;
385 r->options = ZOOM_options_create_with_parent(c->options);
387 r->start = ZOOM_options_get_int(r->options, "start", 0);
388 r->count = ZOOM_options_get_int(r->options, "count", 0);
389 r->piggyback = ZOOM_options_get_bool (r->options, "piggyback", 1);
390 cp = ZOOM_options_get (r->options, "setname");
392 r->setname = xstrdup (cp);
396 r->next = c->resultsets;
399 task = ZOOM_connection_add_task (c, ZOOM_TASK_SEARCH);
400 task->u.search.resultset = r;
401 ZOOM_resultset_addref (r);
407 while (ZOOM_event (1, &c))
413 void ZOOM_resultset_destroy(ZOOM_resultset r)
418 yaz_log (LOG_DEBUG, "destroy r = %p count=%d", r, r->refcount);
419 if (r->refcount == 0)
423 /* remove ourselves from the resultsets in connection */
424 ZOOM_resultset *rp = &r->connection->resultsets;
427 assert (*rp); /* we must be in this list!! */
429 { /* OK, we're here - take us out of it */
436 ZOOM_query_destroy (r->search);
437 ZOOM_options_destroy (r->options);
438 odr_destroy (r->odr);
444 size_t ZOOM_resultset_size (ZOOM_resultset r)
449 static void do_close (ZOOM_connection c)
455 c->state = STATE_IDLE;
458 static void ZOOM_resultset_retrieve (ZOOM_resultset r,
459 int force_sync, int start, int count)
469 task = ZOOM_connection_add_task (c, ZOOM_TASK_RETRIEVE);
470 task->u.retrieve.resultset = r;
471 task->u.retrieve.start = start;
472 task->u.retrieve.count = count;
474 ZOOM_resultset_addref (r);
476 if (!r->connection->async || force_sync)
477 while (r->connection && ZOOM_event (1, &r->connection))
481 void ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
482 size_t start, size_t count)
484 int force_present = 0;
490 ZOOM_resultset_retrieve (r, force_present, start, count);
494 for (i = 0; i< count; i++)
495 recs[i] = ZOOM_resultset_record_immediate (r, i+start);
499 static int do_connect (ZOOM_connection c)
502 const char *effective_host;
505 effective_host = c->proxy;
507 effective_host = c->host_port;
509 yaz_log (LOG_DEBUG, "do_connect host=%s", effective_host);
512 c->cs = cs_create_host (effective_host, 0, &add);
516 int ret = cs_connect (c->cs, add);
517 yaz_log (LOG_DEBUG, "cs_connect returned %d", ret);
520 c->state = STATE_CONNECTING;
521 c->mask = ZOOM_SELECT_READ | ZOOM_SELECT_WRITE |
526 c->state = STATE_IDLE;
527 c->error = ZOOM_ERROR_CONNECT;
531 int z3950_connection_socket(ZOOM_connection c)
534 return cs_fileno(c->cs);
538 int z3950_connection_mask(ZOOM_connection c)
545 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
550 sprintf (str, "send_APDU t=%p type=%d", c, a->which);
553 Z_OtherInformation **oi;
555 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
557 if (!z_APDU(out, &a, 0, 0))
559 FILE *outf = fopen("/tmp/apdu.txt", "w");
562 ODR odr_pr = odr_createmem(ODR_PRINT);
563 fprintf (outf, "a=%p\n", a);
564 odr_setprint(odr_pr, outf);
565 z_APDU(odr_pr, &a, 0, 0);
569 c->error = ZOOM_ERROR_ENCODE;
577 static int send_APDU (ZOOM_connection c, Z_APDU *a)
581 if (encode_APDU(c, a, c->odr_out))
583 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
584 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
585 ZOOM_connection_put_event (c, event);
586 odr_reset(c->odr_out);
591 static int ZOOM_connection_send_init (ZOOM_connection c)
594 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
595 Z_InitRequest *ireq = apdu->u.initRequest;
596 Z_IdAuthentication *auth = odr_malloc(c->odr_out, sizeof(*auth));
597 const char *auth_groupId = ZOOM_options_get (c->options, "group");
598 const char *auth_userId = ZOOM_options_get (c->options, "user");
599 const char *auth_password = ZOOM_options_get (c->options, "pass");
601 ODR_MASK_SET(ireq->options, Z_Options_search);
602 ODR_MASK_SET(ireq->options, Z_Options_present);
603 ODR_MASK_SET(ireq->options, Z_Options_scan);
604 ODR_MASK_SET(ireq->options, Z_Options_sort);
605 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
606 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
608 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
609 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
610 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
612 impname = ZOOM_options_get (c->options, "implementationName");
613 ireq->implementationName =
614 odr_malloc (c->odr_out, 15 + (impname ? strlen(impname) : 0));
615 strcpy (ireq->implementationName, "");
618 strcat (ireq->implementationName, impname);
619 strcat (ireq->implementationName, "/");
621 strcat (ireq->implementationName, "ZOOM-C/YAZ");
623 *ireq->maximumRecordSize =
624 ZOOM_options_get_int (c->options, "maximumRecordSize", 1024*1024);
625 *ireq->preferredMessageSize =
626 ZOOM_options_get_int (c->options, "preferredMessageSize", 1024*1024);
628 if (auth_groupId || auth_password)
630 Z_IdPass *pass = odr_malloc(c->odr_out, sizeof(*pass));
633 if (auth_groupId && *auth_groupId)
635 pass->groupId = odr_malloc(c->odr_out, strlen(auth_groupId)+1);
636 strcpy(pass->groupId, auth_groupId);
640 if (auth_userId && *auth_userId)
642 pass->userId = odr_malloc(c->odr_out, strlen(auth_userId)+1);
643 strcpy(pass->userId, auth_userId);
647 if (auth_password && *auth_password)
649 pass->password = odr_malloc(c->odr_out, strlen(auth_password)+1);
650 strcpy(pass->password, auth_password);
655 auth->which = Z_IdAuthentication_idPass;
656 auth->u.idPass = pass;
657 ireq->idAuthentication = auth;
660 else if (auth_userId)
662 auth->which = Z_IdAuthentication_open;
663 auth->u.open = odr_malloc(c->odr_out, strlen(auth_userId)+1);
664 strcpy(auth->u.open, auth_userId);
665 ireq->idAuthentication = auth;
668 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
669 VAL_PROXY, 1, c->host_port);
676 static int ZOOM_connection_send_search (ZOOM_connection c)
679 int lslb, ssub, mspn;
681 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
682 Z_SearchRequest *search_req = apdu->u.searchRequest;
683 const char *elementSetName;
684 const char *smallSetElementSetName;
685 const char *mediumSetElementSetName;
689 assert (c->tasks->which == ZOOM_TASK_SEARCH);
691 r = c->tasks->u.search.resultset;
694 ZOOM_options_get (r->options, "elementSetName");
695 smallSetElementSetName =
696 ZOOM_options_get (r->options, "smallSetElementSetName");
697 mediumSetElementSetName =
698 ZOOM_options_get (r->options, "mediumSetElementSetName");
700 ZOOM_options_get (r->options, "schema");
702 if (!smallSetElementSetName)
703 smallSetElementSetName = elementSetName;
705 if (!mediumSetElementSetName)
706 mediumSetElementSetName = elementSetName;
711 /* prepare query for the search request */
712 search_req->query = r->r_query;
714 search_req->databaseNames =
715 set_DatabaseNames (c, r->options, &search_req->num_databaseNames);
717 /* get syntax (no need to provide unless piggyback is in effect) */
718 syntax = ZOOM_options_get (r->options, "preferredRecordSyntax");
720 lslb = ZOOM_options_get_int (r->options, "largeSetLowerBound", -1);
721 ssub = ZOOM_options_get_int (r->options, "smallSetUpperBound", -1);
722 mspn = ZOOM_options_get_int (r->options, "mediumSetPresentNumber", -1);
723 if (lslb != -1 && ssub != -1 && mspn != -1)
725 /* So're a Z39.50 expert? Let's hope you don't do sort */
726 *search_req->largeSetLowerBound = lslb;
727 *search_req->smallSetUpperBound = ssub;
728 *search_req->mediumSetPresentNumber = mspn;
730 else if (r->start == 0 && r->count > 0
731 && r->piggyback && !r->r_sort_spec && !schema)
733 /* Regular piggyback - do it unless we're going to do sort */
734 *search_req->largeSetLowerBound = 2000000000;
735 *search_req->smallSetUpperBound = r->count;
736 *search_req->mediumSetPresentNumber = r->count;
737 smallSetElementSetName = 0; /* no need to provide this */
741 /* non-piggyback. Need not provide elementsets or syntaxes .. */
742 smallSetElementSetName = 0;
743 mediumSetElementSetName = 0;
746 if (smallSetElementSetName && *smallSetElementSetName)
748 Z_ElementSetNames *esn = odr_malloc (c->odr_out, sizeof(*esn));
750 esn->which = Z_ElementSetNames_generic;
751 esn->u.generic = odr_strdup (c->odr_out, smallSetElementSetName);
752 search_req->smallSetElementSetNames = esn;
754 if (mediumSetElementSetName && *mediumSetElementSetName)
756 Z_ElementSetNames *esn = odr_malloc (c->odr_out, sizeof(*esn));
758 esn->which = Z_ElementSetNames_generic;
759 esn->u.generic = odr_strdup (c->odr_out, mediumSetElementSetName);
760 search_req->mediumSetElementSetNames = esn;
763 search_req->preferredRecordSyntax =
764 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
768 if (c->support_named_resultsets)
772 /* find the lowest unused ordinal so that we re-use
773 result sets on the server. */
774 for (ord = 1; ; ord++)
777 sprintf (setname, "%d", ord);
778 for (rp = c->resultsets; rp; rp = rp->next)
779 if (rp->setname && !strcmp (rp->setname, setname))
784 r->setname = xstrdup (setname);
785 yaz_log (LOG_DEBUG, "allocating %s", r->setname);
788 r->setname = xstrdup ("default");
789 ZOOM_options_set (r->options, "setname", r->setname);
791 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
792 /* send search request */
798 static void response_diag (ZOOM_connection c, Z_DiagRec *p)
800 Z_DefaultDiagFormat *r;
805 if (p->which != Z_DiagRec_defaultFormat)
807 c->error = ZOOM_ERROR_DECODE;
810 r = p->u.defaultFormat;
813 case Z_DefaultDiagFormat_v2Addinfo:
814 addinfo = r->u.v2Addinfo;
816 case Z_DefaultDiagFormat_v3Addinfo:
817 addinfo = r->u.v3Addinfo;
821 c->addinfo = xstrdup (addinfo);
822 c->error = *r->condition;
825 ZOOM_record ZOOM_record_clone (ZOOM_record srec)
832 odr_enc = odr_createmem(ODR_ENCODE);
833 if (!z_NamePlusRecord (odr_enc, &srec->npr, 0, 0))
835 buf = odr_getbuf (odr_enc, &size, 0);
837 nrec = xmalloc (sizeof(*nrec));
838 nrec->odr = odr_createmem(ODR_DECODE);
839 nrec->wrbuf_marc = 0;
840 odr_setbuf (nrec->odr, buf, size, 0);
841 z_NamePlusRecord (nrec->odr, &nrec->npr, 0, 0);
843 odr_destroy (odr_enc);
847 ZOOM_record ZOOM_resultset_record_immediate (ZOOM_resultset s,size_t pos)
849 return record_cache_lookup (s, pos, 0);
852 ZOOM_record ZOOM_resultset_record (ZOOM_resultset r, size_t pos)
854 ZOOM_resultset_retrieve (r, 1, pos, 1);
855 return ZOOM_resultset_record_immediate (r, pos);
858 void ZOOM_record_destroy (ZOOM_record rec)
863 wrbuf_free (rec->wrbuf_marc, 1);
864 odr_destroy (rec->odr);
868 void *ZOOM_record_get (ZOOM_record rec, const char *type, size_t *len)
870 Z_NamePlusRecord *npr;
876 if (!strcmp (type, "database"))
878 return npr->databaseName;
880 else if (!strcmp (type, "syntax"))
882 if (npr->which == Z_NamePlusRecord_databaseRecord)
884 Z_External *r = (Z_External *) npr->u.databaseRecord;
885 oident *ent = oid_getentbyoid(r->direct_reference);
891 else if (!strcmp (type, "render"))
893 if (npr->which == Z_NamePlusRecord_databaseRecord)
895 Z_External *r = (Z_External *) npr->u.databaseRecord;
896 oident *ent = oid_getentbyoid(r->direct_reference);
898 if (r->which == Z_External_sutrs)
900 *len = r->u.sutrs->len;
901 return r->u.sutrs->buf;
903 else if (r->which == Z_External_octet)
912 case VAL_APPLICATION_XML:
915 if (!rec->wrbuf_marc)
916 rec->wrbuf_marc = wrbuf_alloc();
917 if (marc_display_wrbuf (r->u.octet_aligned->buf,
919 r->u.octet_aligned->len) > 0)
921 *len = wrbuf_len(rec->wrbuf_marc);
922 return wrbuf_buf(rec->wrbuf_marc);
925 *len = r->u.octet_aligned->len;
926 return r->u.octet_aligned->buf;
928 else if (r->which == Z_External_grs1)
936 else if (!strcmp (type, "raw"))
938 if (npr->which == Z_NamePlusRecord_databaseRecord)
940 Z_External *r = (Z_External *) npr->u.databaseRecord;
942 if (r->which == Z_External_sutrs)
944 *len = r->u.sutrs->len;
945 return r->u.sutrs->buf;
947 else if (r->which == Z_External_octet)
949 *len = r->u.octet_aligned->len;
950 return r->u.octet_aligned->buf;
952 else /* grs-1, explain, ... */
955 return (Z_External *) npr->u.databaseRecord;
963 static void record_cache_add (ZOOM_resultset r,
964 Z_NamePlusRecord *npr,
966 const char *elementSetName)
968 ZOOM_record_cache rc;
970 for (rc = r->record_cache; rc; rc = rc->next)
974 if ((!elementSetName && !rc->elementSetName)
975 || (elementSetName && rc->elementSetName &&
976 !strcmp (elementSetName, rc->elementSetName)))
978 /* not destroying rc->npr (it's handled by nmem )*/
980 /* keeping wrbuf_marc too */
986 rc = odr_malloc (r->odr, sizeof(*rc));
989 rc->rec.wrbuf_marc = 0;
991 rc->elementSetName = odr_strdup (r->odr, elementSetName);
993 rc->elementSetName = 0;
995 rc->next = r->record_cache;
996 r->record_cache = rc;
999 static ZOOM_record record_cache_lookup (ZOOM_resultset r,
1001 const char *elementSetName)
1003 ZOOM_record_cache rc;
1005 for (rc = r->record_cache; rc; rc = rc->next)
1009 if ((!elementSetName && !rc->elementSetName)
1010 || (elementSetName && rc->elementSetName &&
1011 !strcmp (elementSetName, rc->elementSetName)))
1018 static void handle_records (ZOOM_connection c, Z_Records *sr,
1021 ZOOM_resultset resultset;
1025 switch (c->tasks->which)
1027 case ZOOM_TASK_SEARCH:
1028 resultset = c->tasks->u.search.resultset;
1030 case ZOOM_TASK_RETRIEVE:
1031 resultset = c->tasks->u.retrieve.resultset;
1036 if (sr && sr->which == Z_Records_NSD)
1038 Z_DiagRec dr, *dr_p = &dr;
1039 dr.which = Z_DiagRec_defaultFormat;
1040 dr.u.defaultFormat = sr->u.nonSurrogateDiagnostic;
1042 response_diag (c, dr_p);
1044 else if (sr && sr->which == Z_Records_multipleNSD)
1046 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
1047 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
1049 c->error = ZOOM_ERROR_DECODE;
1053 if (resultset->count + resultset->start > resultset->size)
1054 resultset->count = resultset->size - resultset->start;
1055 if (resultset->count < 0)
1056 resultset->count = 0;
1057 if (sr && sr->which == Z_Records_DBOSD)
1060 NMEM nmem = odr_extract_mem (c->odr_in);
1061 Z_NamePlusRecordList *p =
1062 sr->u.databaseOrSurDiagnostics;
1063 for (i = 0; i<p->num_records; i++)
1065 record_cache_add (resultset, p->records[i],
1066 i+ resultset->start, 0);
1068 /* transfer our response to search_nmem .. we need it later */
1069 nmem_transfer (resultset->odr->mem, nmem);
1070 nmem_destroy (nmem);
1071 if (present_phase && p->num_records == 0)
1073 /* present response and we didn't get any records! */
1074 c->error = ZOOM_ERROR_DECODE;
1077 else if (present_phase)
1079 /* present response and we didn't get any records! */
1080 c->error = ZOOM_ERROR_DECODE;
1085 static void handle_present_response (ZOOM_connection c, Z_PresentResponse *pr)
1087 handle_records (c, pr->records, 1);
1090 static void handle_search_response (ZOOM_connection c, Z_SearchResponse *sr)
1092 ZOOM_resultset resultset;
1094 yaz_log (LOG_DEBUG, "got search response");
1096 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1099 resultset = c->tasks->u.search.resultset;
1101 resultset->size = *sr->resultCount;
1102 handle_records (c, sr->records, 0);
1105 static void sort_response (ZOOM_connection c, Z_SortResponse *res)
1107 if (res->diagnostics && res->num_diagnostics > 0)
1108 response_diag (c, res->diagnostics[0]);
1111 static int scan_response (ZOOM_connection c, Z_ScanResponse *res)
1113 NMEM nmem = odr_extract_mem (c->odr_in);
1116 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
1118 scan = c->tasks->u.scan.scan;
1120 if (res->entries && res->entries->nonsurrogateDiagnostics)
1121 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
1122 scan->scan_response = res;
1123 nmem_transfer (scan->odr->mem, nmem);
1125 ZOOM_options_set_int (scan->options, "stepSize", *res->stepSize);
1126 if (res->positionOfTerm)
1127 ZOOM_options_set_int (scan->options, "position", *res->positionOfTerm);
1128 if (res->scanStatus)
1129 ZOOM_options_set_int (scan->options, "scanStatus", *res->scanStatus);
1130 if (res->numberOfEntriesReturned)
1131 ZOOM_options_set_int (scan->options, "number",
1132 *res->numberOfEntriesReturned);
1133 nmem_destroy (nmem);
1137 static int send_sort (ZOOM_connection c)
1139 ZOOM_resultset resultset;
1141 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1144 resultset = c->tasks->u.search.resultset;
1148 resultset->r_sort_spec = 0;
1151 if (resultset->r_sort_spec)
1153 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
1154 Z_SortRequest *req = apdu->u.sortRequest;
1156 req->num_inputResultSetNames = 1;
1157 req->inputResultSetNames = (Z_InternationalString **)
1158 odr_malloc (c->odr_out, sizeof(*req->inputResultSetNames));
1159 req->inputResultSetNames[0] =
1160 odr_strdup (c->odr_out, resultset->setname);
1161 req->sortedResultSetName = odr_strdup (c->odr_out, resultset->setname);
1162 req->sortSequence = resultset->r_sort_spec;
1163 resultset->r_sort_spec = 0;
1164 send_APDU (c, apdu);
1170 static int send_present (ZOOM_connection c)
1172 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
1173 Z_PresentRequest *req = apdu->u.presentRequest;
1175 const char *syntax =
1176 ZOOM_options_get (c->options, "preferredRecordSyntax");
1177 const char *element =
1178 ZOOM_options_get (c->options, "elementSetName");
1179 const char *schema =
1180 ZOOM_options_get (c->options, "schema");
1181 ZOOM_resultset resultset;
1186 switch (c->tasks->which)
1188 case ZOOM_TASK_SEARCH:
1189 resultset = c->tasks->u.search.resultset;
1191 case ZOOM_TASK_RETRIEVE:
1192 resultset = c->tasks->u.retrieve.resultset;
1193 resultset->start = c->tasks->u.retrieve.start;
1194 resultset->count = c->tasks->u.retrieve.count;
1196 if (resultset->start >= resultset->size)
1198 if (resultset->start + resultset->count > resultset->size)
1199 resultset->count = resultset->size - resultset->start;
1205 if (c->error) /* don't continue on error */
1207 if (resultset->start < 0)
1209 for (i = 0; i<resultset->count; i++)
1212 record_cache_lookup (resultset, i + resultset->start, 0);
1216 if (i == resultset->count)
1219 resultset->start += i;
1220 resultset->count -= i;
1221 *req->resultSetStartPoint = resultset->start + 1;
1222 *req->numberOfRecordsRequested = resultset->count;
1223 assert (*req->numberOfRecordsRequested > 0);
1225 if (syntax && *syntax)
1226 req->preferredRecordSyntax =
1227 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1229 if (schema && *schema)
1231 Z_RecordComposition *compo = odr_malloc (c->odr_out, sizeof(*compo));
1233 req->recordComposition = compo;
1234 compo->which = Z_RecordComp_complex;
1235 compo->u.complex = (Z_CompSpec *)
1236 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
1237 compo->u.complex->selectAlternativeSyntax = (bool_t *)
1238 odr_malloc(c->odr_out, sizeof(bool_t));
1239 *compo->u.complex->selectAlternativeSyntax = 0;
1241 compo->u.complex->generic = (Z_Specification *)
1242 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
1244 compo->u.complex->generic->schema = (Odr_oid *)
1245 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, schema);
1247 if (!compo->u.complex->generic->schema)
1249 /* OID wasn't a schema! Try record syntax instead. */
1251 compo->u.complex->generic->schema = (Odr_oid *)
1252 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, schema);
1254 if (element && *element)
1256 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
1257 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
1258 compo->u.complex->generic->elementSpec->which =
1259 Z_ElementSpec_elementSetName;
1260 compo->u.complex->generic->elementSpec->u.elementSetName =
1261 odr_strdup (c->odr_out, element);
1264 compo->u.complex->generic->elementSpec = 0;
1265 compo->u.complex->num_dbSpecific = 0;
1266 compo->u.complex->dbSpecific = 0;
1267 compo->u.complex->num_recordSyntax = 0;
1268 compo->u.complex->recordSyntax = 0;
1270 else if (element && *element)
1272 Z_ElementSetNames *esn = odr_malloc (c->odr_out, sizeof(*esn));
1273 Z_RecordComposition *compo = odr_malloc (c->odr_out, sizeof(*compo));
1275 esn->which = Z_ElementSetNames_generic;
1276 esn->u.generic = odr_strdup (c->odr_out, element);
1277 compo->which = Z_RecordComp_simple;
1278 compo->u.simple = esn;
1279 req->recordComposition = compo;
1281 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
1282 send_APDU (c, apdu);
1286 ZOOM_scanset ZOOM_connection_scan (ZOOM_connection c, const char *start)
1288 ZOOM_scanset scan = xmalloc (sizeof(*scan));
1290 scan->connection = c;
1291 scan->odr = odr_createmem (ODR_DECODE);
1292 scan->options = ZOOM_options_create_with_parent (c->options);
1294 scan->scan_response = 0;
1296 if ((scan->termListAndStartPoint =
1297 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet,
1300 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_SCAN);
1301 task->u.scan.scan = scan;
1306 while (ZOOM_event (1, &c))
1313 void ZOOM_scanset_destroy (ZOOM_scanset scan)
1318 if (scan->refcount == 0)
1320 odr_destroy (scan->odr);
1322 ZOOM_options_destroy (scan->options);
1327 int send_scan (ZOOM_connection c)
1330 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
1331 Z_ScanRequest *req = apdu->u.scanRequest;
1334 assert (c->tasks->which == ZOOM_TASK_SCAN);
1335 scan = c->tasks->u.scan.scan;
1337 req->termListAndStartPoint = scan->termListAndStartPoint;
1338 req->attributeSet = scan->attributeSet;
1340 *req->numberOfTermsRequested =
1341 ZOOM_options_get_int(scan->options, "number", 10);
1343 req->preferredPositionInResponse =
1344 odr_intdup (c->odr_out,
1345 ZOOM_options_get_int(scan->options, "position", 1));
1348 odr_intdup (c->odr_out,
1349 ZOOM_options_get_int(scan->options, "stepSize", 0));
1351 req->databaseNames = set_DatabaseNames (c, scan->options,
1352 &req->num_databaseNames);
1354 send_APDU (c, apdu);
1359 size_t ZOOM_scanset_size (ZOOM_scanset scan)
1361 if (!scan || !scan->scan_response || !scan->scan_response->entries)
1363 return scan->scan_response->entries->num_entries;
1366 const char *ZOOM_scanset_term (ZOOM_scanset scan, size_t pos,
1367 int *occ, size_t *len)
1369 const char *term = 0;
1370 size_t noent = ZOOM_scanset_size (scan);
1371 Z_ScanResponse *res = scan->scan_response;
1377 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
1379 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
1381 if (t->term->which == Z_Term_general)
1383 term = t->term->u.general->buf;
1384 *len = t->term->u.general->len;
1386 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
1391 const char *ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key)
1393 return ZOOM_options_get (scan->options, key);
1396 void ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
1399 ZOOM_options_set (scan->options, key, val);
1402 static int ZOOM_connection_exec_task (ZOOM_connection c)
1404 ZOOM_task task = c->tasks;
1406 yaz_log (LOG_DEBUG, "ZOOM_connection_exec_task");
1409 if (c->error != ZOOM_ERROR_NONE ||
1410 (!c->cs && task->which != ZOOM_TASK_CONNECT))
1412 ZOOM_connection_remove_tasks (c);
1415 yaz_log (LOG_DEBUG, "ZOOM_connection_exec_task type=%d", task->which);
1419 switch (task->which)
1421 case ZOOM_TASK_SEARCH:
1422 /* see if search hasn't been sent yet. */
1423 if (ZOOM_connection_send_search (c))
1426 case ZOOM_TASK_RETRIEVE:
1427 if (send_present (c))
1430 case ZOOM_TASK_CONNECT:
1434 case ZOOM_TASK_SCAN:
1438 ZOOM_connection_remove_task (c);
1442 static int send_sort_present (ZOOM_connection c)
1444 int r = send_sort (c);
1446 r = send_present (c);
1450 static void handle_apdu (ZOOM_connection c, Z_APDU *apdu)
1452 Z_InitResponse *initrs;
1454 yaz_log (LOG_DEBUG, "hande_apdu type=%d", apdu->which);
1458 case Z_APDU_initResponse:
1459 initrs = apdu->u.initResponse;
1460 if (!*initrs->result)
1462 c->error = ZOOM_ERROR_INIT;
1467 yaz_oi_get_string_oidval (&apdu->u.initResponse->otherInfo,
1469 xfree (c->cookie_in);
1472 c->cookie_in = xstrdup(cookie);
1473 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
1474 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
1475 c->support_named_resultsets = 1;
1478 assert (c->tasks->which == ZOOM_TASK_CONNECT);
1479 ZOOM_connection_remove_task (c);
1481 ZOOM_connection_exec_task (c);
1484 case Z_APDU_searchResponse:
1485 handle_search_response (c, apdu->u.searchResponse);
1486 if (!send_sort_present (c))
1487 ZOOM_connection_remove_task (c);
1489 case Z_APDU_presentResponse:
1490 handle_present_response (c, apdu->u.presentResponse);
1491 if (!send_present (c))
1492 ZOOM_connection_remove_task (c);
1494 case Z_APDU_sortResponse:
1495 sort_response (c, apdu->u.sortResponse);
1496 if (!send_present (c))
1497 ZOOM_connection_remove_task (c);
1499 case Z_APDU_scanResponse:
1500 scan_response (c, apdu->u.scanResponse);
1501 ZOOM_connection_remove_task (c);
1505 static int do_read (ZOOM_connection c)
1511 event = ZOOM_Event_create (ZOOM_EVENT_RECV_DATA);
1512 ZOOM_connection_put_event (c, event);
1514 r = cs_get (c->cs, &c->buf_in, &c->len_in);
1519 c->error= ZOOM_ERROR_CONNECTION_LOST;
1525 odr_reset (c->odr_in);
1526 odr_setbuf (c->odr_in, c->buf_in, r, 0);
1527 event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);
1528 ZOOM_connection_put_event (c, event);
1529 if (!z_APDU (c->odr_in, &apdu, 0, 0))
1531 c->error = ZOOM_ERROR_DECODE;
1536 handle_apdu (c, apdu);
1542 static int do_write_ex (ZOOM_connection c, char *buf_out, int len_out)
1547 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
1548 ZOOM_connection_put_event (c, event);
1550 if ((r=cs_put (c->cs, buf_out, len_out)) < 0)
1552 if (c->state == STATE_CONNECTING)
1553 c->error = ZOOM_ERROR_CONNECT;
1555 c->error = ZOOM_ERROR_CONNECTION_LOST;
1561 c->state = STATE_ESTABLISHED;
1562 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_WRITE|ZOOM_SELECT_EXCEPT;
1566 c->state = STATE_ESTABLISHED;
1567 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
1572 static int do_write(ZOOM_connection c)
1574 return do_write_ex (c, c->buf_out, c->len_out);
1578 const char *ZOOM_connection_option_get (ZOOM_connection c, const char *key)
1580 return ZOOM_options_get (c->options, key);
1583 void ZOOM_connection_option_set (ZOOM_connection c, const char *key,
1586 ZOOM_options_set (c->options, key, val);
1589 const char *ZOOM_resultset_option_get (ZOOM_resultset r, const char *key)
1591 return ZOOM_options_get (r->options, key);
1594 void ZOOM_resultset_option_set (ZOOM_resultset r, const char *key,
1597 ZOOM_options_set (r->options, key, val);
1601 int ZOOM_connection_errcode (ZOOM_connection c)
1603 return ZOOM_connection_error (c, 0, 0);
1606 const char *ZOOM_connection_errmsg (ZOOM_connection c)
1609 ZOOM_connection_error (c, &msg, 0);
1613 const char *ZOOM_connection_addinfo (ZOOM_connection c)
1615 const char *addinfo;
1616 ZOOM_connection_error (c, 0, &addinfo);
1620 int ZOOM_connection_error (ZOOM_connection c, const char **cp,
1621 const char **addinfo)
1623 int error = c->error;
1628 case ZOOM_ERROR_NONE:
1629 *cp = "No error"; break;
1630 case ZOOM_ERROR_CONNECT:
1631 *cp = "Connect failed"; break;
1632 case ZOOM_ERROR_MEMORY:
1633 *cp = "Out of memory"; break;
1634 case ZOOM_ERROR_ENCODE:
1635 *cp = "Encoding failed"; break;
1636 case ZOOM_ERROR_DECODE:
1637 *cp = "Decoding failed"; break;
1638 case ZOOM_ERROR_CONNECTION_LOST:
1639 *cp = "Connection lost"; break;
1640 case ZOOM_ERROR_INIT:
1641 *cp = "Init rejected"; break;
1642 case ZOOM_ERROR_INTERNAL:
1643 *cp = "Internal failure"; break;
1644 case ZOOM_ERROR_TIMEOUT:
1645 *cp = "Timeout"; break;
1647 *cp = diagbib1_str (error);
1653 *addinfo = c->addinfo;
1660 int ZOOM_connection_do_io(ZOOM_connection c, int mask)
1662 ZOOM_Event event = 0;
1664 int r = cs_look(c->cs);
1665 yaz_log (LOG_LOG, "ZOOM_connection_do_io c=%p mask=%d cs_look=%d",
1670 event = ZOOM_Event_create (ZOOM_EVENT_IO_CONNECT);
1671 c->error = ZOOM_ERROR_CONNECT;
1673 ZOOM_connection_put_event (c, event);
1675 else if (r == CS_CONNECT)
1677 event = ZOOM_Event_create (ZOOM_EVENT_IO_CONNECT);
1678 yaz_log (LOG_LOG, "calling rcvconnect");
1679 if (cs_rcvconnect (c->cs) < 0)
1681 c->error = ZOOM_ERROR_CONNECT;
1683 ZOOM_connection_put_event (c, event);
1687 ZOOM_connection_put_event (c, event);
1688 ZOOM_connection_send_init (c);
1693 if (mask & ZOOM_SELECT_READ)
1695 if (c->cs && (mask & ZOOM_SELECT_WRITE))
1699 yaz_log (LOG_DEBUG, "ZOOM_connection_do_io c=%p mask=%d", c, mask);
1700 if (c->state == STATE_CONNECTING)
1702 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
1703 if (mask & ZOOM_SELECT_WRITE)
1705 ZOOM_connection_put_event (c, event);
1706 ZOOM_connection_send_init (c);
1710 c->error = ZOOM_ERROR_CONNECT;
1712 ZOOM_connection_put_event (c, event);
1715 else if (c->state == STATE_ESTABLISHED)
1717 if (mask & ZOOM_SELECT_READ)
1719 if (c->cs && (mask & ZOOM_SELECT_WRITE))
1724 event = ZOOM_Event_create (ZOOM_EVENT_UNKNOWN);
1725 ZOOM_connection_put_event (c, event);
1726 c->error = ZOOM_ERROR_INTERNAL;
1733 int ZOOM_connection_last_event(ZOOM_connection cs)
1736 return ZOOM_EVENT_NONE;
1737 return cs->last_event;
1740 int ZOOM_event (int no, ZOOM_connection *cs)
1743 struct pollfd pollfds[1024];
1744 ZOOM_connection poll_cs[1024];
1747 fd_set input, output, except;
1752 for (i = 0; i<no; i++)
1754 ZOOM_connection c = cs[i];
1756 if (c && (event = ZOOM_connection_get_event(c)))
1758 ZOOM_Event_destroy (event);
1762 for (i = 0; i<no; i++)
1764 ZOOM_connection c = cs[i];
1766 if (c && ZOOM_connection_exec_task (c))
1768 if ((event = ZOOM_connection_get_event(c)))
1770 ZOOM_Event_destroy (event);
1786 for (i = 0; i<no; i++)
1788 ZOOM_connection c = cs[i];
1793 fd = z3950_connection_socket(c);
1794 mask = z3950_connection_mask(c);
1804 short poll_events = 0;
1806 if (mask & ZOOM_SELECT_READ)
1807 poll_events += POLLIN;
1808 if (mask & ZOOM_SELECT_WRITE)
1809 poll_events += POLLOUT;
1810 if (mask & ZOOM_SELECT_EXCEPT)
1811 poll_events += POLLERR;
1812 pollfds[nfds].fd = fd;
1813 pollfds[nfds].events = poll_events;
1814 pollfds[nfds].revents = 0;
1819 if (mask & ZOOM_SELECT_READ)
1821 FD_SET (fd, &input);
1824 if (mask & ZOOM_SELECT_WRITE)
1826 FD_SET (fd, &output);
1829 if (mask & ZOOM_SELECT_EXCEPT)
1831 FD_SET (fd, &except);
1839 yaz_log (LOG_DEBUG, "poll start");
1840 r = poll (pollfds, nfds, 15000);
1841 yaz_log (LOG_DEBUG, "poll stop, returned r=%d", r);
1842 for (i = 0; i<nfds; i++)
1844 ZOOM_connection c = poll_cs[i];
1848 if (pollfds[i].revents & POLLIN)
1849 mask += ZOOM_SELECT_READ;
1850 if (pollfds[i].revents & POLLOUT)
1851 mask += ZOOM_SELECT_WRITE;
1852 if (pollfds[i].revents & POLLERR)
1853 mask += ZOOM_SELECT_EXCEPT;
1855 ZOOM_connection_do_io(c, mask);
1857 else if (r == 0 && c->mask)
1859 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
1860 /* timeout and this connection was waiting */
1861 c->error = ZOOM_ERROR_TIMEOUT;
1863 ZOOM_connection_put_event(c, event);
1867 yaz_log (LOG_DEBUG, "select start");
1868 r = select (max_fd+1, &input, &output, &except, &tv);
1869 yaz_log (LOG_DEBUG, "select stop, returned r=%d", r);
1870 for (i = 0; i<no; i++)
1872 ZOOM_connection c = cs[i];
1877 fd = z3950_connection_socket(c);
1881 /* no timeout and real socket */
1882 if (FD_ISSET(fd, &input))
1883 mask += ZOOM_SELECT_READ;
1884 if (FD_ISSET(fd, &output))
1885 mask += ZOOM_SELECT_WRITE;
1886 if (FD_ISSET(fd, &except))
1887 mask += ZOOM_SELECT_EXCEPT;
1889 ZOOM_connection_do_io(c, mask);
1891 if (r == 0 && c->mask)
1893 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
1894 /* timeout and this connection was waiting */
1895 c->error = ZOOM_ERROR_TIMEOUT;
1897 yaz_log (LOG_DEBUG, "timeout");
1898 ZOOM_connection_put_event(c, event);
1902 for (i = 0; i<no; i++)
1904 ZOOM_connection c = cs[i];
1906 if (c && (event = ZOOM_connection_get_event(c)))
1908 ZOOM_Event_destroy (event);