2 * $Id: zoom-c.c,v 1.18 2002-01-03 12:18:38 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)
72 c->error = ZOOM_ERROR_NONE;
77 ZOOM_task ZOOM_connection_add_task (ZOOM_connection c, int which)
79 ZOOM_task *taskp = &c->tasks;
81 taskp = &(*taskp)->next;
82 *taskp = xmalloc (sizeof(**taskp));
83 (*taskp)->running = 0;
84 (*taskp)->which = which;
90 void ZOOM_connection_remove_task (ZOOM_connection c)
92 ZOOM_task task = c->tasks;
96 c->tasks = task->next;
99 case ZOOM_TASK_SEARCH:
100 ZOOM_resultset_destroy (task->u.search.resultset);
102 case ZOOM_TASK_RETRIEVE:
103 ZOOM_resultset_destroy (task->u.retrieve.resultset);
105 case ZOOM_TASK_CONNECT:
108 ZOOM_scanset_destroy (task->u.scan.scan);
117 void ZOOM_connection_remove_tasks (ZOOM_connection c)
120 ZOOM_connection_remove_task(c);
123 static ZOOM_record record_cache_lookup (ZOOM_resultset r,
125 const char *elementSetName);
127 ZOOM_connection ZOOM_connection_create (ZOOM_options options)
129 ZOOM_connection c = xmalloc (sizeof(*c));
133 c->state = STATE_IDLE;
134 c->error = ZOOM_ERROR_NONE;
142 c->options = ZOOM_options_create_with_parent(options);
151 c->odr_in = odr_createmem (ODR_DECODE);
152 c->odr_out = odr_createmem (ODR_ENCODE);
155 c->support_named_resultsets = 0;
156 c->last_event = ZOOM_EVENT_NONE;
158 c->m_queue_front = 0;
163 /* set database names. Take local databases (if set); otherwise
164 take databases given in ZURL (if set); otherwise use Default */
165 static char **set_DatabaseNames (ZOOM_connection con, ZOOM_options options,
168 char **databaseNames;
171 const char *cp = ZOOM_options_get (options, "databaseName");
175 cp = strchr (con->host_port, '/');
182 while ((c = strchr(c, '+')))
190 databaseNames = odr_malloc (con->odr_out, no * sizeof(*databaseNames));
194 c = strchr (cp, '+');
202 /* cp ptr to first char of db name, c is char
204 databaseNames[no] = odr_malloc (con->odr_out, 1+c-cp);
205 memcpy (databaseNames[no], cp, c-cp);
206 databaseNames[no++][c-cp] = '\0';
211 databaseNames[no] = NULL;
213 return databaseNames;
216 ZOOM_connection ZOOM_connection_new (const char *host, int portnum)
218 ZOOM_connection c = ZOOM_connection_create (0);
220 ZOOM_connection_connect (c, host, portnum);
224 void ZOOM_connection_connect(ZOOM_connection c,
225 const char *host, int portnum)
230 val = ZOOM_options_get (c->options, "proxy");
232 c->proxy = xstrdup (val);
239 sprintf (hostn, "%.80s:%d", host, portnum);
240 c->host_port = xstrdup(hostn);
243 c->host_port = xstrdup(host);
245 ZOOM_options_set(c->options, "host", c->host_port);
247 c->async = ZOOM_options_get_bool (c->options, "async", 0);
249 task = ZOOM_connection_add_task (c, ZOOM_TASK_CONNECT);
253 while (ZOOM_event (1, &c))
258 ZOOM_query ZOOM_query_create(void)
260 ZOOM_query s = xmalloc (sizeof(*s));
265 s->odr = odr_createmem (ODR_ENCODE);
270 void ZOOM_query_destroy(ZOOM_query s)
276 yaz_log (LOG_DEBUG, "ZOOM_query_destroy count=%d", s->refcount);
277 if (s->refcount == 0)
279 odr_destroy (s->odr);
284 int ZOOM_query_prefix(ZOOM_query s, const char *str)
286 s->query = odr_malloc (s->odr, sizeof(*s->query));
287 s->query->which = Z_Query_type_1;
288 s->query->u.type_1 = p_query_rpn(s->odr, PROTO_Z3950, str);
289 if (!s->query->u.type_1)
294 int ZOOM_query_sortby(ZOOM_query s, const char *criteria)
296 s->sort_spec = yaz_sort_spec (s->odr, criteria);
302 static int do_write(ZOOM_connection c);
304 void ZOOM_connection_destroy(ZOOM_connection c)
311 for (r = c->resultsets; r; r = r->next)
316 odr_destroy (c->odr_in);
317 odr_destroy (c->odr_out);
318 ZOOM_options_destroy (c->options);
319 ZOOM_connection_remove_tasks (c);
320 xfree (c->host_port);
324 void ZOOM_resultset_addref (ZOOM_resultset r)
329 ZOOM_resultset ZOOM_resultset_create ()
331 ZOOM_resultset r = xmalloc (sizeof(*r));
335 r->odr = odr_createmem (ODR_ENCODE);
349 ZOOM_resultset ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
352 ZOOM_query s = ZOOM_query_create();
354 ZOOM_query_prefix (s, q);
356 r = ZOOM_connection_search (c, s);
357 ZOOM_query_destroy (s);
361 ZOOM_resultset ZOOM_connection_search(ZOOM_connection c, ZOOM_query q)
363 ZOOM_resultset r = ZOOM_resultset_create ();
367 r->r_sort_spec = q->sort_spec;
368 r->r_query = q->query;
371 r->options = ZOOM_options_create_with_parent(c->options);
373 r->start = ZOOM_options_get_int(r->options, "start", 0);
374 r->count = ZOOM_options_get_int(r->options, "count", 0);
375 r->piggyback = ZOOM_options_get_bool (r->options, "piggyback", 1);
376 cp = ZOOM_options_get (r->options, "setname");
378 r->setname = xstrdup (cp);
382 r->next = c->resultsets;
385 task = ZOOM_connection_add_task (c, ZOOM_TASK_SEARCH);
386 task->u.search.resultset = r;
387 ZOOM_resultset_addref (r);
393 while (ZOOM_event (1, &c))
399 void ZOOM_resultset_destroy(ZOOM_resultset r)
404 yaz_log (LOG_DEBUG, "destroy r = %p count=%d", r, r->refcount);
405 if (r->refcount == 0)
409 /* remove ourselves from the resultsets in connection */
410 ZOOM_resultset *rp = &r->connection->resultsets;
413 assert (*rp); /* we must be in this list!! */
415 { /* OK, we're here - take us out of it */
422 ZOOM_query_destroy (r->search);
423 ZOOM_options_destroy (r->options);
424 odr_destroy (r->odr);
430 size_t ZOOM_resultset_size (ZOOM_resultset r)
435 static void do_close (ZOOM_connection c)
441 c->state = STATE_IDLE;
444 static void ZOOM_resultset_retrieve (ZOOM_resultset r,
445 int force_sync, int start, int count)
455 task = ZOOM_connection_add_task (c, ZOOM_TASK_RETRIEVE);
456 task->u.retrieve.resultset = r;
457 task->u.retrieve.start = start;
458 task->u.retrieve.count = count;
460 ZOOM_resultset_addref (r);
462 if (!r->connection->async || force_sync)
463 while (r->connection && ZOOM_event (1, &r->connection))
467 void ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
468 size_t start, size_t count)
470 int force_present = 0;
476 ZOOM_resultset_retrieve (r, force_present, start, count);
480 for (i = 0; i< count; i++)
481 recs[i] = ZOOM_resultset_record_immediate (r, i+start);
485 static int do_connect (ZOOM_connection c)
488 const char *effective_host;
491 effective_host = c->proxy;
493 effective_host = c->host_port;
495 yaz_log (LOG_DEBUG, "do_connect host=%s", effective_host);
498 c->cs = cs_create_host (effective_host, 0, &add);
502 int ret = cs_connect (c->cs, add);
503 yaz_log (LOG_DEBUG, "cs_connect returned %d", ret);
506 c->state = STATE_CONNECTING;
507 c->mask = ZOOM_SELECT_READ | ZOOM_SELECT_WRITE |
512 c->state = STATE_IDLE;
513 c->error = ZOOM_ERROR_CONNECT;
517 int z3950_connection_socket(ZOOM_connection c)
520 return cs_fileno(c->cs);
524 int z3950_connection_mask(ZOOM_connection c)
531 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
536 sprintf (str, "send_APDU t=%p type=%d", c, a->which);
539 Z_OtherInformation **oi;
541 yaz_oi_set_string_oidval(oi, out, VAL_COOKIE, 1, c->cookie_out);
543 if (!z_APDU(out, &a, 0, 0))
545 FILE *outf = fopen("/tmp/apdu.txt", "w");
548 ODR odr_pr = odr_createmem(ODR_PRINT);
549 fprintf (outf, "a=%p\n", a);
550 odr_setprint(odr_pr, outf);
551 z_APDU(odr_pr, &a, 0, 0);
555 c->error = ZOOM_ERROR_ENCODE;
563 static int send_APDU (ZOOM_connection c, Z_APDU *a)
567 if (encode_APDU(c, a, c->odr_out))
569 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
570 event = ZOOM_Event_create (ZOOM_EVENT_SEND_APDU);
571 ZOOM_connection_put_event (c, event);
572 odr_reset(c->odr_out);
577 static int ZOOM_connection_send_init (ZOOM_connection c)
580 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
581 Z_InitRequest *ireq = apdu->u.initRequest;
582 Z_IdAuthentication *auth = odr_malloc(c->odr_out, sizeof(*auth));
583 const char *auth_groupId = ZOOM_options_get (c->options, "group");
584 const char *auth_userId = ZOOM_options_get (c->options, "user");
585 const char *auth_password = ZOOM_options_get (c->options, "pass");
587 ODR_MASK_SET(ireq->options, Z_Options_search);
588 ODR_MASK_SET(ireq->options, Z_Options_present);
589 ODR_MASK_SET(ireq->options, Z_Options_scan);
590 ODR_MASK_SET(ireq->options, Z_Options_sort);
591 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
592 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
594 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
595 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
596 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
598 impname = ZOOM_options_get (c->options, "implementationName");
599 ireq->implementationName =
600 odr_malloc (c->odr_out, 15 + (impname ? strlen(impname) : 0));
601 strcpy (ireq->implementationName, "");
604 strcat (ireq->implementationName, impname);
605 strcat (ireq->implementationName, "/");
607 strcat (ireq->implementationName, "ZOOM-C/YAZ");
609 *ireq->maximumRecordSize =
610 ZOOM_options_get_int (c->options, "maximumRecordSize", 1024*1024);
611 *ireq->preferredMessageSize =
612 ZOOM_options_get_int (c->options, "preferredMessageSize", 1024*1024);
614 if (auth_groupId || auth_password)
616 Z_IdPass *pass = odr_malloc(c->odr_out, sizeof(*pass));
619 if (auth_groupId && *auth_groupId)
621 pass->groupId = odr_malloc(c->odr_out, strlen(auth_groupId)+1);
622 strcpy(pass->groupId, auth_groupId);
626 if (auth_userId && *auth_userId)
628 pass->userId = odr_malloc(c->odr_out, strlen(auth_userId)+1);
629 strcpy(pass->userId, auth_userId);
633 if (auth_password && *auth_password)
635 pass->password = odr_malloc(c->odr_out, strlen(auth_password)+1);
636 strcpy(pass->password, auth_password);
641 auth->which = Z_IdAuthentication_idPass;
642 auth->u.idPass = pass;
643 ireq->idAuthentication = auth;
646 else if (auth_userId)
648 auth->which = Z_IdAuthentication_open;
649 auth->u.open = odr_malloc(c->odr_out, strlen(auth_userId)+1);
650 strcpy(auth->u.open, auth_userId);
651 ireq->idAuthentication = auth;
654 yaz_oi_set_string_oidval(&ireq->otherInfo, c->odr_out,
655 VAL_PROXY, 1, c->host_port);
662 static int ZOOM_connection_send_search (ZOOM_connection c)
665 int lslb, ssub, mspn;
667 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
668 Z_SearchRequest *search_req = apdu->u.searchRequest;
669 const char *elementSetName;
670 const char *smallSetElementSetName;
671 const char *mediumSetElementSetName;
675 assert (c->tasks->which == ZOOM_TASK_SEARCH);
677 r = c->tasks->u.search.resultset;
680 ZOOM_options_get (r->options, "elementSetName");
681 smallSetElementSetName =
682 ZOOM_options_get (r->options, "smallSetElementSetName");
683 mediumSetElementSetName =
684 ZOOM_options_get (r->options, "mediumSetElementSetName");
686 ZOOM_options_get (r->options, "schema");
688 if (!smallSetElementSetName)
689 smallSetElementSetName = elementSetName;
691 if (!mediumSetElementSetName)
692 mediumSetElementSetName = elementSetName;
697 /* prepare query for the search request */
698 search_req->query = r->r_query;
700 search_req->databaseNames =
701 set_DatabaseNames (c, r->options, &search_req->num_databaseNames);
703 /* get syntax (no need to provide unless piggyback is in effect) */
704 syntax = ZOOM_options_get (r->options, "preferredRecordSyntax");
706 lslb = ZOOM_options_get_int (r->options, "largeSetLowerBound", -1);
707 ssub = ZOOM_options_get_int (r->options, "smallSetUpperBound", -1);
708 mspn = ZOOM_options_get_int (r->options, "mediumSetPresentNumber", -1);
709 if (lslb != -1 && ssub != -1 && mspn != -1)
711 /* So're a Z39.50 expert? Let's hope you don't do sort */
712 *search_req->largeSetLowerBound = lslb;
713 *search_req->smallSetUpperBound = ssub;
714 *search_req->mediumSetPresentNumber = mspn;
716 else if (r->start == 0 && r->count > 0
717 && r->piggyback && !r->r_sort_spec && !schema)
719 /* Regular piggyback - do it unless we're going to do sort */
720 *search_req->largeSetLowerBound = 2000000000;
721 *search_req->smallSetUpperBound = r->count;
722 *search_req->mediumSetPresentNumber = r->count;
723 smallSetElementSetName = 0; /* no need to provide this */
727 /* non-piggyback. Need not provide elementsets or syntaxes .. */
728 smallSetElementSetName = 0;
729 mediumSetElementSetName = 0;
732 if (smallSetElementSetName && *smallSetElementSetName)
734 Z_ElementSetNames *esn = odr_malloc (c->odr_out, sizeof(*esn));
736 esn->which = Z_ElementSetNames_generic;
737 esn->u.generic = odr_strdup (c->odr_out, smallSetElementSetName);
738 search_req->smallSetElementSetNames = esn;
740 if (mediumSetElementSetName && *mediumSetElementSetName)
742 Z_ElementSetNames *esn = odr_malloc (c->odr_out, sizeof(*esn));
744 esn->which = Z_ElementSetNames_generic;
745 esn->u.generic = odr_strdup (c->odr_out, mediumSetElementSetName);
746 search_req->mediumSetElementSetNames = esn;
749 search_req->preferredRecordSyntax =
750 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
754 if (c->support_named_resultsets)
758 /* find the lowest unused ordinal so that we re-use
759 result sets on the server. */
760 for (ord = 1; ; ord++)
763 sprintf (setname, "%d", ord);
764 for (rp = c->resultsets; rp; rp = rp->next)
765 if (rp->setname && !strcmp (rp->setname, setname))
770 r->setname = xstrdup (setname);
771 yaz_log (LOG_DEBUG, "allocating %s", r->setname);
774 r->setname = xstrdup ("default");
775 ZOOM_options_set (r->options, "setname", r->setname);
777 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
778 /* send search request */
784 static void response_diag (ZOOM_connection c, Z_DiagRec *p)
786 Z_DefaultDiagFormat *r;
791 if (p->which != Z_DiagRec_defaultFormat)
793 c->error = ZOOM_ERROR_DECODE;
796 r = p->u.defaultFormat;
799 case Z_DefaultDiagFormat_v2Addinfo:
800 addinfo = r->u.v2Addinfo;
802 case Z_DefaultDiagFormat_v3Addinfo:
803 addinfo = r->u.v3Addinfo;
807 c->addinfo = xstrdup (addinfo);
808 c->error = *r->condition;
811 ZOOM_record ZOOM_record_clone (ZOOM_record srec)
818 odr_enc = odr_createmem(ODR_ENCODE);
819 if (!z_NamePlusRecord (odr_enc, &srec->npr, 0, 0))
821 buf = odr_getbuf (odr_enc, &size, 0);
823 nrec = xmalloc (sizeof(*nrec));
824 nrec->odr = odr_createmem(ODR_DECODE);
825 nrec->wrbuf_marc = 0;
826 odr_setbuf (nrec->odr, buf, size, 0);
827 z_NamePlusRecord (nrec->odr, &nrec->npr, 0, 0);
829 odr_destroy (odr_enc);
833 ZOOM_record ZOOM_resultset_record_immediate (ZOOM_resultset s,size_t pos)
835 return record_cache_lookup (s, pos, 0);
838 ZOOM_record ZOOM_resultset_record (ZOOM_resultset r, size_t pos)
840 ZOOM_resultset_retrieve (r, 1, pos, 1);
841 return ZOOM_resultset_record_immediate (r, pos);
844 void ZOOM_record_destroy (ZOOM_record rec)
849 wrbuf_free (rec->wrbuf_marc, 1);
850 odr_destroy (rec->odr);
854 void *ZOOM_record_get (ZOOM_record rec, const char *type, size_t *len)
856 Z_NamePlusRecord *npr;
862 if (!strcmp (type, "database"))
864 return npr->databaseName;
866 else if (!strcmp (type, "syntax"))
868 if (npr->which == Z_NamePlusRecord_databaseRecord)
870 Z_External *r = (Z_External *) npr->u.databaseRecord;
871 oident *ent = oid_getentbyoid(r->direct_reference);
877 else if (!strcmp (type, "render"))
879 if (npr->which == Z_NamePlusRecord_databaseRecord)
881 Z_External *r = (Z_External *) npr->u.databaseRecord;
882 oident *ent = oid_getentbyoid(r->direct_reference);
884 if (r->which == Z_External_sutrs)
886 *len = r->u.sutrs->len;
887 return r->u.sutrs->buf;
889 else if (r->which == Z_External_octet)
898 case VAL_APPLICATION_XML:
901 if (!rec->wrbuf_marc)
902 rec->wrbuf_marc = wrbuf_alloc();
903 if (marc_display_wrbuf (r->u.octet_aligned->buf,
905 r->u.octet_aligned->len) > 0)
907 *len = wrbuf_len(rec->wrbuf_marc);
908 return wrbuf_buf(rec->wrbuf_marc);
911 *len = r->u.octet_aligned->len;
912 return r->u.octet_aligned->buf;
914 else if (r->which == Z_External_grs1)
922 else if (!strcmp (type, "raw"))
924 if (npr->which == Z_NamePlusRecord_databaseRecord)
927 return (Z_External *) npr->u.databaseRecord;
934 static void record_cache_add (ZOOM_resultset r,
935 Z_NamePlusRecord *npr,
937 const char *elementSetName)
939 ZOOM_record_cache rc;
941 for (rc = r->record_cache; rc; rc = rc->next)
945 if ((!elementSetName && !rc->elementSetName)
946 || (elementSetName && rc->elementSetName &&
947 !strcmp (elementSetName, rc->elementSetName)))
949 /* not destroying rc->npr (it's handled by nmem )*/
951 /* keeping wrbuf_marc too */
957 rc = odr_malloc (r->odr, sizeof(*rc));
960 rc->rec.wrbuf_marc = 0;
962 rc->elementSetName = odr_strdup (r->odr, elementSetName);
964 rc->elementSetName = 0;
966 rc->next = r->record_cache;
967 r->record_cache = rc;
970 static ZOOM_record record_cache_lookup (ZOOM_resultset r,
972 const char *elementSetName)
974 ZOOM_record_cache rc;
976 for (rc = r->record_cache; rc; rc = rc->next)
980 if ((!elementSetName && !rc->elementSetName)
981 || (elementSetName && rc->elementSetName &&
982 !strcmp (elementSetName, rc->elementSetName)))
989 static void handle_records (ZOOM_connection c, Z_Records *sr,
992 ZOOM_resultset resultset;
996 switch (c->tasks->which)
998 case ZOOM_TASK_SEARCH:
999 resultset = c->tasks->u.search.resultset;
1001 case ZOOM_TASK_RETRIEVE:
1002 resultset = c->tasks->u.retrieve.resultset;
1007 if (sr && sr->which == Z_Records_NSD)
1009 Z_DiagRec dr, *dr_p = &dr;
1010 dr.which = Z_DiagRec_defaultFormat;
1011 dr.u.defaultFormat = sr->u.nonSurrogateDiagnostic;
1013 response_diag (c, dr_p);
1015 else if (sr && sr->which == Z_Records_multipleNSD)
1017 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
1018 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
1020 c->error = ZOOM_ERROR_DECODE;
1024 if (resultset->count + resultset->start > resultset->size)
1025 resultset->count = resultset->size - resultset->start;
1026 if (resultset->count < 0)
1027 resultset->count = 0;
1028 if (sr && sr->which == Z_Records_DBOSD)
1031 NMEM nmem = odr_extract_mem (c->odr_in);
1032 Z_NamePlusRecordList *p =
1033 sr->u.databaseOrSurDiagnostics;
1034 for (i = 0; i<p->num_records; i++)
1036 record_cache_add (resultset, p->records[i],
1037 i+ resultset->start, 0);
1039 /* transfer our response to search_nmem .. we need it later */
1040 nmem_transfer (resultset->odr->mem, nmem);
1041 nmem_destroy (nmem);
1042 if (present_phase && p->num_records == 0)
1044 /* present response and we didn't get any records! */
1045 c->error = ZOOM_ERROR_DECODE;
1048 else if (present_phase)
1050 /* present response and we didn't get any records! */
1051 c->error = ZOOM_ERROR_DECODE;
1056 static void handle_present_response (ZOOM_connection c, Z_PresentResponse *pr)
1058 handle_records (c, pr->records, 1);
1061 static void handle_search_response (ZOOM_connection c, Z_SearchResponse *sr)
1063 ZOOM_resultset resultset;
1065 yaz_log (LOG_DEBUG, "got search response");
1067 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1070 resultset = c->tasks->u.search.resultset;
1072 resultset->size = *sr->resultCount;
1073 handle_records (c, sr->records, 0);
1076 static void sort_response (ZOOM_connection c, Z_SortResponse *res)
1078 if (res->diagnostics && res->num_diagnostics > 0)
1079 response_diag (c, res->diagnostics[0]);
1082 static int scan_response (ZOOM_connection c, Z_ScanResponse *res)
1084 NMEM nmem = odr_extract_mem (c->odr_in);
1087 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
1089 scan = c->tasks->u.scan.scan;
1091 if (res->entries && res->entries->nonsurrogateDiagnostics)
1092 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
1093 scan->scan_response = res;
1094 nmem_transfer (scan->odr->mem, nmem);
1096 ZOOM_options_set_int (scan->options, "stepSize", *res->stepSize);
1097 if (res->positionOfTerm)
1098 ZOOM_options_set_int (scan->options, "position", *res->positionOfTerm);
1099 if (res->scanStatus)
1100 ZOOM_options_set_int (scan->options, "scanStatus", *res->scanStatus);
1101 if (res->numberOfEntriesReturned)
1102 ZOOM_options_set_int (scan->options, "number",
1103 *res->numberOfEntriesReturned);
1104 nmem_destroy (nmem);
1108 static int send_sort (ZOOM_connection c)
1110 ZOOM_resultset resultset;
1112 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1115 resultset = c->tasks->u.search.resultset;
1119 resultset->r_sort_spec = 0;
1122 if (resultset->r_sort_spec)
1124 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
1125 Z_SortRequest *req = apdu->u.sortRequest;
1127 req->num_inputResultSetNames = 1;
1128 req->inputResultSetNames = (Z_InternationalString **)
1129 odr_malloc (c->odr_out, sizeof(*req->inputResultSetNames));
1130 req->inputResultSetNames[0] =
1131 odr_strdup (c->odr_out, resultset->setname);
1132 req->sortedResultSetName = odr_strdup (c->odr_out, resultset->setname);
1133 req->sortSequence = resultset->r_sort_spec;
1134 resultset->r_sort_spec = 0;
1135 send_APDU (c, apdu);
1141 static int send_present (ZOOM_connection c)
1143 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
1144 Z_PresentRequest *req = apdu->u.presentRequest;
1146 const char *syntax =
1147 ZOOM_options_get (c->options, "preferredRecordSyntax");
1148 const char *element =
1149 ZOOM_options_get (c->options, "elementSetName");
1150 const char *schema =
1151 ZOOM_options_get (c->options, "schema");
1152 ZOOM_resultset resultset;
1157 switch (c->tasks->which)
1159 case ZOOM_TASK_SEARCH:
1160 resultset = c->tasks->u.search.resultset;
1162 case ZOOM_TASK_RETRIEVE:
1163 resultset = c->tasks->u.retrieve.resultset;
1164 resultset->start = c->tasks->u.retrieve.start;
1165 resultset->count = c->tasks->u.retrieve.count;
1167 if (resultset->start >= resultset->size)
1169 if (resultset->start + resultset->count > resultset->size)
1170 resultset->count = resultset->size - resultset->start;
1176 if (c->error) /* don't continue on error */
1178 if (resultset->start < 0)
1180 for (i = 0; i<resultset->count; i++)
1183 record_cache_lookup (resultset, i + resultset->start, 0);
1187 if (i == resultset->count)
1190 resultset->start += i;
1191 resultset->count -= i;
1192 *req->resultSetStartPoint = resultset->start + 1;
1193 *req->numberOfRecordsRequested = resultset->count;
1194 assert (*req->numberOfRecordsRequested > 0);
1196 if (syntax && *syntax)
1197 req->preferredRecordSyntax =
1198 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, syntax);
1200 if (schema && *schema)
1202 Z_RecordComposition *compo = odr_malloc (c->odr_out, sizeof(*compo));
1204 req->recordComposition = compo;
1205 compo->which = Z_RecordComp_complex;
1206 compo->u.complex = (Z_CompSpec *)
1207 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
1208 compo->u.complex->selectAlternativeSyntax = (bool_t *)
1209 odr_malloc(c->odr_out, sizeof(bool_t));
1210 *compo->u.complex->selectAlternativeSyntax = 0;
1212 compo->u.complex->generic = (Z_Specification *)
1213 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
1215 compo->u.complex->generic->schema = (Odr_oid *)
1216 yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, schema);
1218 if (!compo->u.complex->generic->schema)
1220 /* OID wasn't a schema! Try record syntax instead. */
1222 compo->u.complex->generic->schema = (Odr_oid *)
1223 yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, schema);
1225 if (element && *element)
1227 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
1228 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
1229 compo->u.complex->generic->elementSpec->which =
1230 Z_ElementSpec_elementSetName;
1231 compo->u.complex->generic->elementSpec->u.elementSetName =
1232 odr_strdup (c->odr_out, element);
1235 compo->u.complex->generic->elementSpec = 0;
1236 compo->u.complex->num_dbSpecific = 0;
1237 compo->u.complex->dbSpecific = 0;
1238 compo->u.complex->num_recordSyntax = 0;
1239 compo->u.complex->recordSyntax = 0;
1241 else if (element && *element)
1243 Z_ElementSetNames *esn = odr_malloc (c->odr_out, sizeof(*esn));
1244 Z_RecordComposition *compo = odr_malloc (c->odr_out, sizeof(*compo));
1246 esn->which = Z_ElementSetNames_generic;
1247 esn->u.generic = odr_strdup (c->odr_out, element);
1248 compo->which = Z_RecordComp_simple;
1249 compo->u.simple = esn;
1250 req->recordComposition = compo;
1252 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
1253 send_APDU (c, apdu);
1257 ZOOM_scanset ZOOM_connection_scan (ZOOM_connection c, const char *start)
1259 ZOOM_scanset scan = xmalloc (sizeof(*scan));
1261 scan->connection = c;
1262 scan->odr = odr_createmem (ODR_DECODE);
1263 scan->options = ZOOM_options_create_with_parent (c->options);
1265 scan->scan_response = 0;
1267 if ((scan->termListAndStartPoint =
1268 p_query_scan(scan->odr, PROTO_Z3950, &scan->attributeSet,
1271 ZOOM_task task = ZOOM_connection_add_task (c, ZOOM_TASK_SCAN);
1272 task->u.scan.scan = scan;
1277 while (ZOOM_event (1, &c))
1284 void ZOOM_scanset_destroy (ZOOM_scanset scan)
1289 if (scan->refcount == 0)
1291 odr_destroy (scan->odr);
1293 ZOOM_options_destroy (scan->options);
1298 int send_scan (ZOOM_connection c)
1301 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
1302 Z_ScanRequest *req = apdu->u.scanRequest;
1305 assert (c->tasks->which == ZOOM_TASK_SCAN);
1306 scan = c->tasks->u.scan.scan;
1308 req->termListAndStartPoint = scan->termListAndStartPoint;
1309 req->attributeSet = scan->attributeSet;
1311 *req->numberOfTermsRequested =
1312 ZOOM_options_get_int(scan->options, "number", 10);
1314 req->preferredPositionInResponse =
1315 odr_intdup (c->odr_out,
1316 ZOOM_options_get_int(scan->options, "position", 1));
1319 odr_intdup (c->odr_out,
1320 ZOOM_options_get_int(scan->options, "stepSize", 0));
1322 req->databaseNames = set_DatabaseNames (c, scan->options,
1323 &req->num_databaseNames);
1325 send_APDU (c, apdu);
1330 size_t ZOOM_scanset_size (ZOOM_scanset scan)
1332 if (!scan || !scan->scan_response || !scan->scan_response->entries)
1334 return scan->scan_response->entries->num_entries;
1337 const char *ZOOM_scanset_term (ZOOM_scanset scan, size_t pos,
1338 int *occ, size_t *len)
1340 const char *term = 0;
1341 size_t noent = ZOOM_scanset_size (scan);
1342 Z_ScanResponse *res = scan->scan_response;
1348 if (res->entries->entries[pos]->which == Z_Entry_termInfo)
1350 Z_TermInfo *t = res->entries->entries[pos]->u.termInfo;
1352 if (t->term->which == Z_Term_general)
1354 term = t->term->u.general->buf;
1355 *len = t->term->u.general->len;
1357 *occ = t->globalOccurrences ? *t->globalOccurrences : 0;
1362 const char *ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key)
1364 return ZOOM_options_get (scan->options, key);
1367 void ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
1370 ZOOM_options_set (scan->options, key, val);
1373 static int ZOOM_connection_exec_task (ZOOM_connection c)
1375 ZOOM_task task = c->tasks;
1377 yaz_log (LOG_DEBUG, "ZOOM_connection_exec_task");
1380 if (c->error != ZOOM_ERROR_NONE ||
1381 (!c->cs && task->which != ZOOM_TASK_CONNECT))
1383 ZOOM_connection_remove_tasks (c);
1386 yaz_log (LOG_DEBUG, "ZOOM_connection_exec_task type=%d", task->which);
1390 switch (task->which)
1392 case ZOOM_TASK_SEARCH:
1393 /* see if search hasn't been sent yet. */
1394 if (ZOOM_connection_send_search (c))
1397 case ZOOM_TASK_RETRIEVE:
1398 if (send_present (c))
1401 case ZOOM_TASK_CONNECT:
1405 case ZOOM_TASK_SCAN:
1409 ZOOM_connection_remove_task (c);
1413 static int send_sort_present (ZOOM_connection c)
1415 int r = send_sort (c);
1417 r = send_present (c);
1421 static void handle_apdu (ZOOM_connection c, Z_APDU *apdu)
1423 Z_InitResponse *initrs;
1425 yaz_log (LOG_DEBUG, "hande_apdu type=%d", apdu->which);
1429 case Z_APDU_initResponse:
1430 initrs = apdu->u.initResponse;
1431 if (!*initrs->result)
1433 c->error = ZOOM_ERROR_INIT;
1438 yaz_oi_get_string_oidval (&apdu->u.initResponse->otherInfo,
1440 xfree (c->cookie_in);
1443 c->cookie_in = xstrdup(cookie);
1444 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
1445 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
1446 c->support_named_resultsets = 1;
1449 assert (c->tasks->which == ZOOM_TASK_CONNECT);
1450 ZOOM_connection_remove_task (c);
1452 ZOOM_connection_exec_task (c);
1455 case Z_APDU_searchResponse:
1456 handle_search_response (c, apdu->u.searchResponse);
1457 if (!send_sort_present (c))
1458 ZOOM_connection_remove_task (c);
1460 case Z_APDU_presentResponse:
1461 handle_present_response (c, apdu->u.presentResponse);
1462 if (!send_present (c))
1463 ZOOM_connection_remove_task (c);
1465 case Z_APDU_sortResponse:
1466 sort_response (c, apdu->u.sortResponse);
1467 if (!send_present (c))
1468 ZOOM_connection_remove_task (c);
1470 case Z_APDU_scanResponse:
1471 scan_response (c, apdu->u.scanResponse);
1472 ZOOM_connection_remove_task (c);
1476 static int do_read (ZOOM_connection c)
1482 event = ZOOM_Event_create (ZOOM_EVENT_RECV_DATA);
1483 ZOOM_connection_put_event (c, event);
1485 r = cs_get (c->cs, &c->buf_in, &c->len_in);
1490 c->error= ZOOM_ERROR_CONNECTION_LOST;
1496 odr_reset (c->odr_in);
1497 odr_setbuf (c->odr_in, c->buf_in, r, 0);
1498 event = ZOOM_Event_create (ZOOM_EVENT_RECV_APDU);
1499 ZOOM_connection_put_event (c, event);
1500 if (!z_APDU (c->odr_in, &apdu, 0, 0))
1502 c->error = ZOOM_ERROR_DECODE;
1507 handle_apdu (c, apdu);
1513 static int do_write_ex (ZOOM_connection c, char *buf_out, int len_out)
1518 event = ZOOM_Event_create(ZOOM_EVENT_SEND_DATA);
1519 ZOOM_connection_put_event (c, event);
1521 if ((r=cs_put (c->cs, buf_out, len_out)) < 0)
1523 if (c->state == STATE_CONNECTING)
1524 c->error = ZOOM_ERROR_CONNECT;
1526 c->error = ZOOM_ERROR_CONNECTION_LOST;
1532 c->state = STATE_ESTABLISHED;
1533 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_WRITE|ZOOM_SELECT_EXCEPT;
1537 c->state = STATE_ESTABLISHED;
1538 c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
1543 static int do_write(ZOOM_connection c)
1545 return do_write_ex (c, c->buf_out, c->len_out);
1549 const char *ZOOM_connection_option_get (ZOOM_connection c, const char *key)
1551 return ZOOM_options_get (c->options, key);
1554 void ZOOM_connection_option_set (ZOOM_connection c, const char *key,
1557 ZOOM_options_set (c->options, key, val);
1560 const char *ZOOM_resultset_option_get (ZOOM_resultset r, const char *key)
1562 return ZOOM_options_get (r->options, key);
1565 void ZOOM_resultset_option_set (ZOOM_resultset r, const char *key,
1568 ZOOM_options_set (r->options, key, val);
1572 int ZOOM_connection_errcode (ZOOM_connection c)
1574 return ZOOM_connection_error (c, 0, 0);
1577 const char *ZOOM_connection_errmsg (ZOOM_connection c)
1580 ZOOM_connection_error (c, &msg, 0);
1584 const char *ZOOM_connection_addinfo (ZOOM_connection c)
1586 const char *addinfo;
1587 ZOOM_connection_error (c, 0, &addinfo);
1591 int ZOOM_connection_error (ZOOM_connection c, const char **cp,
1592 const char **addinfo)
1594 int error = c->error;
1599 case ZOOM_ERROR_NONE:
1600 *cp = "No error"; break;
1601 case ZOOM_ERROR_CONNECT:
1602 *cp = "Connect failed"; break;
1603 case ZOOM_ERROR_MEMORY:
1604 *cp = "Out of memory"; break;
1605 case ZOOM_ERROR_ENCODE:
1606 *cp = "Encoding failed"; break;
1607 case ZOOM_ERROR_DECODE:
1608 *cp = "Decoding failed"; break;
1609 case ZOOM_ERROR_CONNECTION_LOST:
1610 *cp = "Connection lost"; break;
1611 case ZOOM_ERROR_INIT:
1612 *cp = "Init rejected"; break;
1613 case ZOOM_ERROR_INTERNAL:
1614 *cp = "Internal failure"; break;
1615 case ZOOM_ERROR_TIMEOUT:
1616 *cp = "Timeout"; break;
1618 *cp = diagbib1_str (error);
1624 *addinfo = c->addinfo;
1631 int ZOOM_connection_do_io(ZOOM_connection c, int mask)
1633 ZOOM_Event event = 0;
1635 int r = cs_look(c->cs);
1636 yaz_log (LOG_LOG, "ZOOM_connection_do_io c=%p mask=%d cs_look=%d",
1641 event = ZOOM_Event_create (ZOOM_EVENT_IO_CONNECT);
1642 c->error = ZOOM_ERROR_CONNECT;
1644 ZOOM_connection_put_event (c, event);
1646 else if (r == CS_CONNECT)
1648 event = ZOOM_Event_create (ZOOM_EVENT_IO_CONNECT);
1649 yaz_log (LOG_LOG, "calling rcvconnect");
1650 if (cs_rcvconnect (c->cs) < 0)
1652 c->error = ZOOM_ERROR_CONNECT;
1654 ZOOM_connection_put_event (c, event);
1658 ZOOM_connection_put_event (c, event);
1659 ZOOM_connection_send_init (c);
1664 if (mask & ZOOM_SELECT_READ)
1666 if (c->cs && (mask & ZOOM_SELECT_WRITE))
1670 yaz_log (LOG_DEBUG, "ZOOM_connection_do_io c=%p mask=%d", c, mask);
1671 if (c->state == STATE_CONNECTING)
1673 event = ZOOM_Event_create (ZOOM_EVENT_CONNECT);
1674 if (mask & ZOOM_SELECT_WRITE)
1676 ZOOM_connection_put_event (c, event);
1677 ZOOM_connection_send_init (c);
1681 c->error = ZOOM_ERROR_CONNECT;
1683 ZOOM_connection_put_event (c, event);
1686 else if (c->state == STATE_ESTABLISHED)
1688 if (mask & ZOOM_SELECT_READ)
1690 if (c->cs && (mask & ZOOM_SELECT_WRITE))
1695 event = ZOOM_Event_create (ZOOM_EVENT_UNKNOWN);
1696 ZOOM_connection_put_event (c, event);
1697 c->error = ZOOM_ERROR_INTERNAL;
1704 int ZOOM_connection_last_event(ZOOM_connection cs)
1707 return ZOOM_EVENT_NONE;
1708 return cs->last_event;
1711 int ZOOM_event (int no, ZOOM_connection *cs)
1714 struct pollfd pollfds[1024];
1715 ZOOM_connection poll_cs[1024];
1718 fd_set input, output, except;
1723 for (i = 0; i<no; i++)
1725 ZOOM_connection c = cs[i];
1727 if (c && (event = ZOOM_connection_get_event(c)))
1729 ZOOM_Event_destroy (event);
1733 for (i = 0; i<no; i++)
1735 ZOOM_connection c = cs[i];
1737 if (c && ZOOM_connection_exec_task (c))
1739 if ((event = ZOOM_connection_get_event(c)))
1741 ZOOM_Event_destroy (event);
1757 for (i = 0; i<no; i++)
1759 ZOOM_connection c = cs[i];
1764 fd = z3950_connection_socket(c);
1765 mask = z3950_connection_mask(c);
1775 short poll_events = 0;
1777 if (mask & ZOOM_SELECT_READ)
1778 poll_events += POLLIN;
1779 if (mask & ZOOM_SELECT_WRITE)
1780 poll_events += POLLOUT;
1781 if (mask & ZOOM_SELECT_EXCEPT)
1782 poll_events += POLLERR;
1783 pollfds[nfds].fd = fd;
1784 pollfds[nfds].events = poll_events;
1785 pollfds[nfds].revents = 0;
1790 if (mask & ZOOM_SELECT_READ)
1792 FD_SET (fd, &input);
1795 if (mask & ZOOM_SELECT_WRITE)
1797 FD_SET (fd, &output);
1800 if (mask & ZOOM_SELECT_EXCEPT)
1802 FD_SET (fd, &except);
1810 yaz_log (LOG_DEBUG, "poll start");
1811 r = poll (pollfds, nfds, 15000);
1812 yaz_log (LOG_DEBUG, "poll stop, returned r=%d", r);
1813 for (i = 0; i<nfds; i++)
1815 ZOOM_connection c = poll_cs[i];
1819 if (pollfds[i].revents & POLLIN)
1820 mask += ZOOM_SELECT_READ;
1821 if (pollfds[i].revents & POLLOUT)
1822 mask += ZOOM_SELECT_WRITE;
1823 if (pollfds[i].revents & POLLERR)
1824 mask += ZOOM_SELECT_EXCEPT;
1826 ZOOM_connection_do_io(c, mask);
1828 else if (r == 0 && c->mask)
1830 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
1831 /* timeout and this connection was waiting */
1832 c->error = ZOOM_ERROR_TIMEOUT;
1834 ZOOM_connection_put_event(c, event);
1838 yaz_log (LOG_DEBUG, "select start");
1839 r = select (max_fd+1, &input, &output, &except, &tv);
1840 yaz_log (LOG_DEBUG, "select stop, returned r=%d", r);
1841 for (i = 0; i<no; i++)
1843 ZOOM_connection c = cs[i];
1848 fd = z3950_connection_socket(c);
1852 /* no timeout and real socket */
1853 if (FD_ISSET(fd, &input))
1854 mask += ZOOM_SELECT_READ;
1855 if (FD_ISSET(fd, &output))
1856 mask += ZOOM_SELECT_WRITE;
1857 if (FD_ISSET(fd, &except))
1858 mask += ZOOM_SELECT_EXCEPT;
1860 ZOOM_connection_do_io(c, mask);
1862 if (r == 0 && c->mask)
1864 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
1865 /* timeout and this connection was waiting */
1866 c->error = ZOOM_ERROR_TIMEOUT;
1868 yaz_log (LOG_DEBUG, "timeout");
1869 ZOOM_connection_put_event(c, event);
1873 for (i = 0; i<no; i++)
1875 ZOOM_connection c = cs[i];
1877 if (c && (event = ZOOM_connection_get_event(c)))
1879 ZOOM_Event_destroy (event);