1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2012 Index Data
3 * See the file LICENSE for details.
7 * \brief Implements ZOOM Z39.50 handling
18 #include <yaz/yaz-util.h>
19 #include <yaz/xmalloc.h>
20 #include <yaz/otherinfo.h>
22 #include <yaz/pquery.h>
23 #include <yaz/marcdisp.h>
24 #include <yaz/diagbib1.h>
25 #include <yaz/charneg.h>
27 #include <yaz/query-charset.h>
28 #include <yaz/copy_types.h>
29 #include <yaz/snprintf.h>
30 #include <yaz/facet.h>
32 #include <yaz/shptr.h>
35 * This wrapper is just for logging failed lookups. It would be nicer
36 * if it could cause failure when a lookup fails, but that's hard.
38 static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
39 oid_class oid_class, const char *str) {
40 Odr_oid *res = yaz_string_to_oid_odr(yaz_oid_std(), oid_class, str,
43 yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
44 c, (int) oid_class, str);
48 static Z_APDU *create_es_package(ZOOM_package p, const Odr_oid *oid)
51 Z_APDU *apdu = zget_APDU(p->odr_out, Z_APDU_extendedServicesRequest);
52 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
54 str = ZOOM_options_get(p->options, "package-name");
56 req->packageName = odr_strdup(p->odr_out, str);
58 str = ZOOM_options_get(p->options, "user-id");
60 req->userId = odr_strdup_null(p->odr_out, str);
62 req->packageType = odr_oiddup(p->odr_out, oid);
64 str = ZOOM_options_get(p->options, "function");
67 if (!strcmp (str, "create"))
68 *req->function = Z_ExtendedServicesRequest_create;
69 if (!strcmp (str, "delete"))
70 *req->function = Z_ExtendedServicesRequest_delete;
71 if (!strcmp (str, "modify"))
72 *req->function = Z_ExtendedServicesRequest_modify;
75 str = ZOOM_options_get(p->options, "waitAction");
78 if (!strcmp (str, "wait"))
79 *req->waitAction = Z_ExtendedServicesRequest_wait;
80 if (!strcmp (str, "waitIfPossible"))
81 *req->waitAction = Z_ExtendedServicesRequest_waitIfPossible;
82 if (!strcmp (str, "dontWait"))
83 *req->waitAction = Z_ExtendedServicesRequest_dontWait;
84 if (!strcmp (str, "dontReturnPackage"))
85 *req->waitAction = Z_ExtendedServicesRequest_dontReturnPackage;
90 static const char *ill_array_lookup(void *clientData, const char *idx)
92 ZOOM_package p = (ZOOM_package) clientData;
93 return ZOOM_options_get(p->options, idx+4);
96 static Z_External *encode_ill_request(ZOOM_package p)
101 struct ill_get_ctl ctl;
103 ctl.odr = p->odr_out;
105 ctl.f = ill_array_lookup;
107 req = ill_get_ILLRequest(&ctl, "ill", 0);
109 if (!ill_Request(out, &req, 0, 0))
111 int ill_request_size;
112 char *ill_request_buf = odr_getbuf(out, &ill_request_size, 0);
114 odr_setbuf(out, ill_request_buf, ill_request_size, 1);
119 int illRequest_size = 0;
120 char *illRequest_buf = odr_getbuf(out, &illRequest_size, 0);
122 r = (Z_External *) odr_malloc(out, sizeof(*r));
123 r->direct_reference = odr_oiddup(out, yaz_oid_general_isoill_1);
124 r->indirect_reference = 0;
126 r->which = Z_External_single;
128 r->u.single_ASN1_type =
129 odr_create_Odr_oct(out,
130 (unsigned char *)illRequest_buf,
136 static Z_ItemOrder *encode_item_order(ZOOM_package p)
138 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
142 req->which = Z_IOItemOrder_esRequest;
143 req->u.esRequest = (Z_IORequest *)
144 odr_malloc(p->odr_out,sizeof(Z_IORequest));
146 /* to keep part ... */
147 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
148 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
149 req->u.esRequest->toKeep->supplDescription = 0;
150 req->u.esRequest->toKeep->contact = (Z_IOContact *)
151 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
153 str = ZOOM_options_get(p->options, "contact-name");
154 req->u.esRequest->toKeep->contact->name =
155 odr_strdup_null(p->odr_out, str);
157 str = ZOOM_options_get(p->options, "contact-phone");
158 req->u.esRequest->toKeep->contact->phone =
159 odr_strdup_null(p->odr_out, str);
161 str = ZOOM_options_get(p->options, "contact-email");
162 req->u.esRequest->toKeep->contact->email =
163 odr_strdup_null(p->odr_out, str);
165 req->u.esRequest->toKeep->addlBilling = 0;
167 /* not to keep part ... */
168 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
169 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
171 str = ZOOM_options_get(p->options, "itemorder-setname");
176 req->u.esRequest->notToKeep->resultSetItem = 0;
179 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
180 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
182 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
183 odr_strdup(p->odr_out, str);
184 req->u.esRequest->notToKeep->resultSetItem->item =
185 odr_intdup(p->odr_out, 0);
187 str = ZOOM_options_get(p->options, "itemorder-item");
188 *req->u.esRequest->notToKeep->resultSetItem->item =
189 (str ? atoi(str) : 1);
192 str = ZOOM_options_getl(p->options, "doc", &len);
195 req->u.esRequest->notToKeep->itemRequest =
196 z_ext_record_xml(p->odr_out, str, len);
199 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
204 Z_APDU *create_admin_package(ZOOM_package p, int type,
205 Z_ESAdminOriginPartToKeep **toKeepP,
206 Z_ESAdminOriginPartNotToKeep **notToKeepP)
208 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
211 Z_ESAdminOriginPartToKeep *toKeep;
212 Z_ESAdminOriginPartNotToKeep *notToKeep;
213 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
214 const char *first_db = "Default";
216 char **db = ZOOM_connection_get_databases(p->connection,
222 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
224 r->indirect_reference = 0;
225 r->which = Z_External_ESAdmin;
227 r->u.adminService = (Z_Admin *)
228 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
229 r->u.adminService->which = Z_Admin_esRequest;
230 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
231 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
233 toKeep = r->u.adminService->u.esRequest->toKeep =
234 (Z_ESAdminOriginPartToKeep *)
235 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
236 toKeep->which = type;
237 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
238 toKeep->u.create = odr_nullval();
239 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
241 r->u.adminService->u.esRequest->notToKeep = notToKeep =
242 (Z_ESAdminOriginPartNotToKeep *)
243 odr_malloc(p->odr_out,
244 sizeof(*r->u.adminService->u.esRequest->notToKeep));
245 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
246 notToKeep->u.recordsWillFollow = odr_nullval();
250 *notToKeepP = notToKeep;
255 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
257 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
258 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
259 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
261 const char *doc = ZOOM_options_getl(p->options, "doc", &len);
269 req->taskSpecificParameters = ext;
270 ext->direct_reference = req->packageType;
272 ext->indirect_reference = 0;
274 ext->which = Z_External_octet;
275 ext->u.single_ASN1_type =
276 odr_create_Odr_oct(p->odr_out, (const unsigned char *) doc, len);
280 static Z_APDU *create_update_package(ZOOM_package p)
283 const char *first_db = "Default";
285 char **db = ZOOM_connection_get_databases(p->connection, p->options,
286 &num_db, p->odr_out);
287 const char *action = ZOOM_options_get(p->options, "action");
288 int recordIdOpaque_len;
289 const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
290 &recordIdOpaque_len);
291 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
293 const char *record_buf = ZOOM_options_getl(p->options, "record",
295 int recordOpaque_len;
296 const char *recordOpaque_buf = ZOOM_options_getl(p->options, "recordOpaque",
298 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
299 const char *version = ZOOM_options_get(p->options, "updateVersion");
301 const char *correlationInfo_note =
302 ZOOM_options_get(p->options, "correlationInfo.note");
303 const char *correlationInfo_id =
304 ZOOM_options_get(p->options, "correlationInfo.id");
306 Odr_oid *syntax_oid = 0;
307 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
313 if (!record_buf && !recordOpaque_buf)
317 syntax_str = "SUTRS";
322 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
323 CLASS_RECSYN, syntax_str,
328 ZOOM_set_error(p->connection, ZOOM_ERROR_ES_INVALID_SYNTAX, syntax_str);
338 package_oid = yaz_oid_extserv_database_update_first_version;
339 /* old update does not support specialUpdate */
341 action = "recordInsert";
345 action = "specialUpdate";
346 package_oid = yaz_oid_extserv_database_update_second_version;
350 action = "specialUpdate";
351 package_oid = yaz_oid_extserv_database_update;
354 ZOOM_set_error(p->connection, ZOOM_ERROR_ES_INVALID_VERSION, version);
358 if (!strcmp(action, "recordInsert"))
359 action_no = Z_IUOriginPartToKeep_recordInsert;
360 else if (!strcmp(action, "recordReplace"))
361 action_no = Z_IUOriginPartToKeep_recordReplace;
362 else if (!strcmp(action, "recordDelete"))
363 action_no = Z_IUOriginPartToKeep_recordDelete;
364 else if (!strcmp(action, "elementUpdate"))
365 action_no = Z_IUOriginPartToKeep_elementUpdate;
366 else if (!strcmp(action, "specialUpdate"))
367 action_no = Z_IUOriginPartToKeep_specialUpdate;
370 ZOOM_set_error(p->connection, ZOOM_ERROR_ES_INVALID_ACTION, action);
374 apdu = create_es_package(p, package_oid);
377 Z_IUOriginPartToKeep *toKeep;
378 Z_IUSuppliedRecords *notToKeep;
379 Z_External *r = (Z_External *)
380 odr_malloc(p->odr_out, sizeof(*r));
381 const char *elementSetName =
382 ZOOM_options_get(p->options, "elementSetName");
384 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
386 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
388 r->which = Z_External_update;
389 r->indirect_reference = 0;
390 r->u.update = (Z_IUUpdate *)
391 odr_malloc(p->odr_out, sizeof(*r->u.update));
393 r->u.update->which = Z_IUUpdate_esRequest;
394 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
395 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
396 toKeep = r->u.update->u.esRequest->toKeep =
397 (Z_IUOriginPartToKeep *)
398 odr_malloc(p->odr_out, sizeof(*toKeep));
400 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
403 toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
405 toKeep->actionQualifier = 0;
406 toKeep->action = odr_intdup(p->odr_out, action_no);
408 notToKeep = r->u.update->u.esRequest->notToKeep =
409 (Z_IUSuppliedRecords *)
410 odr_malloc(p->odr_out, sizeof(*notToKeep));
412 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
413 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
414 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
415 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
416 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
419 notToKeep->elements[0]->u.opaque =
420 odr_create_Odr_oct(p->odr_out,
421 (const unsigned char *) recordIdOpaque,
424 else if (recordIdNumber)
426 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
428 notToKeep->elements[0]->u.number =
429 odr_intdup(p->odr_out, atoi(recordIdNumber));
432 notToKeep->elements[0]->u.opaque = 0;
433 notToKeep->elements[0]->supplementalId = 0;
434 if (correlationInfo_note || correlationInfo_id)
436 Z_IUCorrelationInfo *ci;
437 ci = notToKeep->elements[0]->correlationInfo =
438 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
439 ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
440 ci->id = correlationInfo_id ?
441 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
444 notToKeep->elements[0]->correlationInfo = 0;
445 if (recordOpaque_buf)
447 notToKeep->elements[0]->record =
448 z_ext_record_oid_any(p->odr_out, syntax_oid,
449 recordOpaque_buf, recordOpaque_len);
453 notToKeep->elements[0]->record =
454 z_ext_record_oid(p->odr_out, syntax_oid,
455 record_buf, record_len);
460 ODR print = odr_createmem(ODR_PRINT);
462 z_APDU(print, &apdu, 0, 0);
469 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
472 for (i = 0; i<200; i++)
476 Z_OtherInformation **oi;
481 sprintf(buf, "otherInfo%d", i);
482 val = ZOOM_options_get(c->options, buf);
485 cp = strchr(val, ':');
489 if (len >= sizeof(buf))
491 memcpy(buf, val, len);
494 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
500 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
506 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
511 Z_OtherInformation **oi;
513 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
518 Z_OtherInformation **oi;
520 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
523 otherInfo_attach(c, a, out);
524 if (!z_APDU(out, &a, 0, 0))
526 FILE *outf = fopen("/tmp/apdu.txt", "a");
529 ODR odr_pr = odr_createmem(ODR_PRINT);
530 fprintf(outf, "a=%p\n", a);
531 odr_setprint(odr_pr, outf);
532 z_APDU(odr_pr, &a, 0, 0);
535 yaz_log(c->log_api, "%p encoding_APDU: encoding failed", c);
536 ZOOM_set_error(c, ZOOM_ERROR_ENCODE, 0);
541 z_APDU(c->odr_print, &a, 0, 0);
543 z_APDU(c->odr_save, &a, 0, 0);
544 yaz_log(c->log_details, "%p encoding_APDU encoding OK", c);
548 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
552 if (encode_APDU(c, a, c->odr_out))
553 return zoom_complete;
554 yaz_log(c->log_details, "%p send APDU type=%d", c, a->which);
555 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
556 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
557 ZOOM_connection_put_event(c, event);
558 odr_reset(c->odr_out);
559 return ZOOM_send_buf(c);
562 zoom_ret ZOOM_connection_Z3950_send_init(ZOOM_connection c)
564 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
565 Z_InitRequest *ireq = apdu->u.initRequest;
566 Z_IdAuthentication *auth = (Z_IdAuthentication *)
567 odr_malloc(c->odr_out, sizeof(*auth));
569 ODR_MASK_SET(ireq->options, Z_Options_search);
570 ODR_MASK_SET(ireq->options, Z_Options_present);
571 ODR_MASK_SET(ireq->options, Z_Options_scan);
572 ODR_MASK_SET(ireq->options, Z_Options_sort);
573 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
574 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
576 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
577 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
578 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
580 ireq->implementationId =
581 odr_prepend(c->odr_out,
582 ZOOM_options_get(c->options, "implementationId"),
583 ireq->implementationId);
585 ireq->implementationName =
586 odr_prepend(c->odr_out,
587 ZOOM_options_get(c->options, "implementationName"),
588 odr_prepend(c->odr_out, "ZOOM-C",
589 ireq->implementationName));
591 ireq->implementationVersion =
592 odr_prepend(c->odr_out,
593 ZOOM_options_get(c->options, "implementationVersion"),
594 ireq->implementationVersion);
596 *ireq->maximumRecordSize = c->maximum_record_size;
597 *ireq->preferredMessageSize = c->preferred_message_size;
599 if (c->group || c->password)
601 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
602 pass->groupId = odr_strdup_null(c->odr_out, c->group);
603 pass->userId = odr_strdup_null(c->odr_out, c->user);
604 pass->password = odr_strdup_null(c->odr_out, c->password);
605 auth->which = Z_IdAuthentication_idPass;
606 auth->u.idPass = pass;
607 ireq->idAuthentication = auth;
611 auth->which = Z_IdAuthentication_open;
612 auth->u.open = odr_strdup(c->odr_out, c->user);
613 ireq->idAuthentication = auth;
617 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
618 yaz_oid_userinfo_proxy, 1, c->host_port);
620 if (c->charset || c->lang)
622 Z_OtherInformation **oi;
623 Z_OtherInformationUnit *oi_unit;
625 yaz_oi_APDU(apdu, &oi);
627 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
629 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
630 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
631 oi_unit->information.externallyDefinedInfo =
632 yaz_set_proposal_charneg_list(c->odr_out, " ",
633 c->charset, c->lang, 1);
637 return send_APDU(c, apdu);
640 zoom_ret ZOOM_connection_Z3950_send_search(ZOOM_connection c)
643 int lslb, ssub, mspn;
645 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
646 Z_SearchRequest *search_req = apdu->u.searchRequest;
647 const char *elementSetName;
648 const char *smallSetElementSetName;
649 const char *mediumSetElementSetName;
653 assert(c->tasks->which == ZOOM_TASK_SEARCH);
655 r = c->tasks->u.search.resultset;
657 yaz_log(c->log_details, "%p ZOOM_connection_send_search set=%p", c, r);
660 ZOOM_options_get(r->options, "elementSetName");
661 smallSetElementSetName =
662 ZOOM_options_get(r->options, "smallSetElementSetName");
663 mediumSetElementSetName =
664 ZOOM_options_get(r->options, "mediumSetElementSetName");
666 if (!smallSetElementSetName)
667 smallSetElementSetName = elementSetName;
669 if (!mediumSetElementSetName)
670 mediumSetElementSetName = elementSetName;
672 facets = ZOOM_options_get(r->options, "facets");
674 Z_FacetList *facet_list = yaz_pqf_parse_facet_list(c->odr_out, facets);
676 Z_OtherInformation **oi;
677 yaz_oi_APDU(apdu, &oi);
678 yaz_oi_set_facetlist(oi, c->odr_out, facet_list);
681 yaz_log(YLOG_WARN, "Unable to parse facets: %s", facets);
687 /* prepare query for the search request */
688 search_req->query = ZOOM_query_get_Z_Query(r->query);
689 if (!search_req->query)
691 ZOOM_set_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
692 return zoom_complete;
694 if (search_req->query->which == Z_Query_type_1 ||
695 search_req->query->which == Z_Query_type_101)
697 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
700 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
704 search_req->query = yaz_copy_Z_Query(search_req->query,
707 r = yaz_query_charset_convert_rpnquery_check(
708 search_req->query->u.type_1,
712 { /* query could not be char converted */
713 ZOOM_set_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
714 return zoom_complete;
719 search_req->databaseNames = r->databaseNames;
720 search_req->num_databaseNames = r->num_databaseNames;
722 /* get syntax (no need to provide unless piggyback is in effect) */
723 syntax = c->tasks->u.search.syntax;
725 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
726 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
727 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
728 if (lslb != -1 && ssub != -1 && mspn != -1)
730 /* So're a Z39.50 expert? Let's hope you don't do sort */
731 *search_req->largeSetLowerBound = lslb;
732 *search_req->smallSetUpperBound = ssub;
733 *search_req->mediumSetPresentNumber = mspn;
735 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
736 && r->piggyback && !r->r_sort_spec && !r->schema)
738 /* Regular piggyback - do it unless we're going to do sort */
739 *search_req->largeSetLowerBound = 2000000000;
740 *search_req->smallSetUpperBound = 1;
741 *search_req->mediumSetPresentNumber =
742 r->step>0 ? r->step : c->tasks->u.search.count;
746 /* non-piggyback. Need not provide elementsets or syntaxes .. */
747 smallSetElementSetName = 0;
748 mediumSetElementSetName = 0;
751 if (smallSetElementSetName && *smallSetElementSetName)
753 Z_ElementSetNames *esn = (Z_ElementSetNames *)
754 odr_malloc(c->odr_out, sizeof(*esn));
756 esn->which = Z_ElementSetNames_generic;
757 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
758 search_req->smallSetElementSetNames = esn;
760 if (mediumSetElementSetName && *mediumSetElementSetName)
762 Z_ElementSetNames *esn =(Z_ElementSetNames *)
763 odr_malloc(c->odr_out, sizeof(*esn));
765 esn->which = Z_ElementSetNames_generic;
766 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
767 search_req->mediumSetElementSetNames = esn;
770 search_req->preferredRecordSyntax =
771 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
775 if (c->support_named_resultsets)
779 /* find the lowest unused ordinal so that we re-use
780 result sets on the server. */
781 for (ord = 1; ; ord++)
783 #if ZOOM_RESULT_LISTS
785 sprintf(setname, "%d", ord);
786 for (rsp = c->resultsets; rsp; rsp = rsp->next)
787 if (rsp->resultset->setname && !strcmp(rsp->resultset->setname, setname))
793 sprintf(setname, "%d", ord);
794 for (rp = c->resultsets; rp; rp = rp->next)
795 if (rp->setname && !strcmp(rp->setname, setname))
802 r->setname = xstrdup(setname);
803 yaz_log(c->log_details, "%p ZOOM_connection_send_search: "
804 "allocating set %s", c, r->setname);
808 yaz_log(c->log_details, "%p ZOOM_connection_send_search: using "
810 r->setname = xstrdup("default");
812 ZOOM_options_set(r->options, "setname", r->setname);
814 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
815 return send_APDU(c, apdu);
818 zoom_ret ZOOM_connection_Z3950_send_scan(ZOOM_connection c)
821 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
822 Z_ScanRequest *req = apdu->u.scanRequest;
825 yaz_log(c->log_details, "%p send_scan", c);
827 return zoom_complete;
828 assert (c->tasks->which == ZOOM_TASK_SCAN);
829 scan = c->tasks->u.scan.scan;
831 z_query = ZOOM_query_get_Z_Query(scan->query);
833 /* Z39.50 scan can only carry RPN */
834 if (z_query->which == Z_Query_type_1 ||
835 z_query->which == Z_Query_type_101)
837 Z_RPNQuery *rpn = z_query->u.type_1;
838 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
841 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
844 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
846 yaz_query_charset_convert_rpnquery(
847 rpn, c->odr_out, cd);
851 req->attributeSet = rpn->attributeSetId;
852 if (!req->attributeSet)
853 req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
854 if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
855 rpn->RPNStructure->u.simple->which == Z_Operand_APT)
857 req->termListAndStartPoint =
858 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
862 ZOOM_set_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
863 return zoom_complete;
868 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
869 return zoom_complete;
872 *req->numberOfTermsRequested =
873 ZOOM_options_get_int(scan->options, "number", 20);
875 req->preferredPositionInResponse =
876 odr_intdup(c->odr_out,
877 ZOOM_options_get_int(scan->options, "position", 1));
880 odr_intdup(c->odr_out,
881 ZOOM_options_get_int(scan->options, "stepSize", 0));
883 req->databaseNames = scan->databaseNames;
884 req->num_databaseNames = scan->num_databaseNames;
886 return send_APDU(c, apdu);
890 ZOOM_package_send(ZOOM_package p, const char *type)
897 odr_reset(p->odr_out);
900 if (!strcmp(type, "itemorder"))
902 apdu = create_es_package(p, yaz_oid_extserv_item_order);
905 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
907 r->direct_reference =
908 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
910 r->which = Z_External_itemOrder;
911 r->indirect_reference = 0;
912 r->u.itemOrder = encode_item_order(p);
914 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
917 else if (!strcmp(type, "create")) /* create database */
919 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
922 else if (!strcmp(type, "drop")) /* drop database */
924 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
927 else if (!strcmp(type, "commit")) /* commit changes */
929 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
932 else if (!strcmp(type, "update")) /* update record(s) */
934 apdu = create_update_package(p);
936 else if (!strcmp(type, "xmlupdate"))
938 apdu = create_xmlupdate_package(p);
942 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
946 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
948 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
949 p->buf_out = (char *) xmalloc(p->len_out);
950 memcpy(p->buf_out, buf, p->len_out);
955 while (ZOOM_event(1, &c))
962 static void handle_Z3950_records(ZOOM_connection c, Z_Records *sr,
965 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
967 char oid_name_buf[OID_STR_MAX];
968 const char *oid_name;
971 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
974 case Z_DefaultDiagFormat_v2Addinfo:
975 addinfo = r->u.v2Addinfo;
977 case Z_DefaultDiagFormat_v3Addinfo:
978 addinfo = r->u.v3Addinfo;
983 ZOOM_set_dset_error(c, *r->condition, oid_name, addinfo, 0);
986 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
988 if (p->which != Z_DiagRec_defaultFormat)
989 ZOOM_set_error(c, ZOOM_ERROR_DECODE, 0);
991 response_default_diag(c, p->u.defaultFormat);
994 static int es_response_taskpackage_update(ZOOM_connection c,
995 Z_IUUpdateTaskPackage *utp)
997 if (utp && utp->targetPart)
999 Z_IUTargetPart *targetPart = utp->targetPart;
1000 switch ( *targetPart->updateStatus ) {
1001 case Z_IUTargetPart_success:
1002 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
1004 case Z_IUTargetPart_partial:
1005 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
1007 case Z_IUTargetPart_failure:
1008 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
1009 if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
1010 response_diag(c, targetPart->globalDiagnostics[0]);
1013 /* NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED. */
1018 static int es_response_taskpackage(ZOOM_connection c,
1019 Z_TaskPackage *taskPackage)
1021 Odr_oct *id = taskPackage->targetReference;
1023 ZOOM_options_setl(c->tasks->u.package->options,
1024 "targetReference", (char*) id->buf, id->len);
1026 switch ( *taskPackage->taskStatus ) {
1027 case Z_TaskPackage_pending:
1028 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
1030 case Z_TaskPackage_active:
1031 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
1033 case Z_TaskPackage_complete:
1034 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
1036 case Z_TaskPackage_aborted:
1037 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
1038 if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
1039 response_diag(c, taskPackage->packageDiagnostics[0]);
1042 /* NOTE: Only Update implemented, no others. */
1043 if ( taskPackage->taskSpecificParameters->which == Z_External_update )
1045 Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
1046 es_response_taskpackage_update(c, utp);
1052 static int handle_Z3950_es_response(ZOOM_connection c,
1053 Z_ExtendedServicesResponse *res)
1055 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
1057 switch (*res->operationStatus)
1059 case Z_ExtendedServicesResponse_done:
1060 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
1062 case Z_ExtendedServicesResponse_accepted:
1063 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
1065 case Z_ExtendedServicesResponse_failure:
1066 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
1067 if (res->diagnostics && res->num_diagnostics > 0)
1068 response_diag(c, res->diagnostics[0]);
1071 if (res->taskPackage &&
1072 res->taskPackage->which == Z_External_extendedService)
1074 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
1075 es_response_taskpackage(c, taskPackage);
1077 if (res->taskPackage &&
1078 res->taskPackage->which == Z_External_octet)
1080 Odr_oct *doc = res->taskPackage->u.octet_aligned;
1081 ZOOM_options_setl(c->tasks->u.package->options,
1082 "xmlUpdateDoc", (char*) doc->buf, doc->len);
1087 static char *get_term_cstr(ODR odr, Z_Term *term) {
1089 switch (term->which) {
1090 case Z_Term_general:
1091 return odr_strdupn(odr, (const char *) term->u.general->buf, (size_t) term->u.general->len);
1093 case Z_Term_characterString:
1094 return odr_strdup(odr, term->u.characterString);
1099 static ZOOM_facet_field get_zoom_facet_field(ODR odr, Z_FacetField *facet) {
1101 struct yaz_facet_attr attr_values;
1102 ZOOM_facet_field facet_field = odr_malloc(odr, sizeof(*facet_field));
1103 yaz_facet_attr_init(&attr_values);
1104 yaz_facet_attr_get_z_attributes(facet->attributes, &attr_values);
1105 facet_field->facet_name = odr_strdup(odr, attr_values.useattr);
1106 facet_field->num_terms = facet->num_terms;
1107 yaz_log(YLOG_DEBUG, "ZOOM_facet_field %s %d terms %d", attr_values.useattr, attr_values.limit, facet->num_terms);
1108 facet_field->facet_terms = odr_malloc(odr, facet_field->num_terms * sizeof(*facet_field->facet_terms));
1109 for (term_index = 0 ; term_index < facet->num_terms; term_index++) {
1110 Z_FacetTerm *facetTerm = facet->terms[term_index];
1111 facet_field->facet_terms[term_index].frequency = *facetTerm->count;
1112 facet_field->facet_terms[term_index].term = get_term_cstr(odr, facetTerm->term);
1113 yaz_log(YLOG_DEBUG, " term[%d] %s %d",
1114 term_index, facet_field->facet_terms[term_index].term, facet_field->facet_terms[term_index].frequency);
1119 /* Can be share with SOLR/SRU/SRW requests */
1120 void handle_facet_list(ZOOM_resultset r, Z_FacetList *fl) {
1122 r->num_facets = fl->num;
1123 yaz_log(YLOG_DEBUG, "Facets found: %d", fl->num);
1124 r->facets = odr_malloc(r->odr, r->num_facets * sizeof(*r->facets));
1125 r->facets_names = odr_malloc(r->odr, r->num_facets * sizeof(*r->facets_names));
1126 for (j = 0; j < fl->num; j++)
1128 r->facets[j] = get_zoom_facet_field(r->odr, fl->elements[j]);
1130 yaz_log(YLOG_DEBUG, "Facet field missing on index %d !", j);
1131 r->facets_names[j] = (char *) ZOOM_facet_field_name(r->facets[j]);
1135 static void handle_facet_result(ZOOM_connection c, ZOOM_resultset r,
1136 Z_OtherInformation *o)
1139 for (i = 0; o && i < o->num_elements; i++)
1141 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
1143 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
1144 if (ext->which == Z_External_userFacets)
1146 handle_facet_list(r, ext->u.facetList);
1152 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
1155 switch (term->which)
1157 case Z_Term_general:
1158 ZOOM_options_setl(opt, name,
1159 (const char *)(term->u.general->buf),
1160 term->u.general->len);
1162 case Z_Term_characterString:
1163 ZOOM_options_set(opt, name, term->u.characterString);
1165 case Z_Term_numeric:
1166 ZOOM_options_set_int(opt, name, *term->u.numeric);
1171 static void handle_queryExpression(ZOOM_options opt, const char *name,
1172 Z_QueryExpression *exp)
1178 case Z_QueryExpression_term:
1179 if (exp->u.term && exp->u.term->queryTerm)
1181 sprintf(opt_name, "%s.term", name);
1182 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
1185 case Z_QueryExpression_query:
1191 static void handle_search_result(ZOOM_connection c, ZOOM_resultset resultset,
1192 Z_OtherInformation *o)
1195 for (i = 0; o && i < o->num_elements; i++)
1197 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
1199 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
1201 if (ext->which == Z_External_searchResult1)
1204 Z_SearchInfoReport *sr = ext->u.searchResult1;
1207 ZOOM_options_set_int(
1208 resultset->options, "searchresult.size", sr->num);
1210 for (j = 0; j < sr->num; j++)
1212 Z_SearchInfoReport_s *ent =
1213 ext->u.searchResult1->elements[j];
1216 sprintf(pref, "searchresult.%d", j);
1218 if (ent->subqueryId)
1221 sprintf(opt_name, "%s.id", pref);
1222 ZOOM_options_set(resultset->options, opt_name,
1225 if (ent->subqueryExpression)
1228 sprintf(opt_name, "%s.subquery", pref);
1229 handle_queryExpression(resultset->options, opt_name,
1230 ent->subqueryExpression);
1232 if (ent->subqueryInterpretation)
1235 sprintf(opt_name, "%s.interpretation", pref);
1236 handle_queryExpression(resultset->options, opt_name,
1237 ent->subqueryInterpretation);
1239 if (ent->subqueryRecommendation)
1242 sprintf(opt_name, "%s.recommendation", pref);
1243 handle_queryExpression(resultset->options, opt_name,
1244 ent->subqueryRecommendation);
1246 if (ent->subqueryCount)
1249 sprintf(opt_name, "%s.count", pref);
1250 ZOOM_options_set_int(resultset->options, opt_name,
1251 *ent->subqueryCount);
1259 static void handle_Z3950_search_response(ZOOM_connection c,
1260 Z_SearchResponse *sr)
1262 ZOOM_resultset resultset;
1265 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1268 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
1269 ZOOM_connection_put_event(c, event);
1271 resultset = c->tasks->u.search.resultset;
1273 if (sr->resultSetStatus)
1275 ZOOM_options_set_int(resultset->options, "resultSetStatus",
1276 *sr->resultSetStatus);
1278 if (sr->presentStatus)
1280 ZOOM_options_set_int(resultset->options, "presentStatus",
1281 *sr->presentStatus);
1283 handle_search_result(c, resultset, sr->additionalSearchInfo);
1285 handle_facet_result(c, resultset, sr->additionalSearchInfo);
1287 resultset->size = *sr->resultCount;
1288 handle_Z3950_records(c, sr->records, 0);
1291 static void handle_Z3950_sort_response(ZOOM_connection c, Z_SortResponse *res)
1293 if (res->diagnostics && res->num_diagnostics > 0)
1294 response_diag(c, res->diagnostics[0]);
1297 static int handle_Z3950_scan_response(ZOOM_connection c, Z_ScanResponse *res)
1299 NMEM nmem = odr_extract_mem(c->odr_in);
1302 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
1304 scan = c->tasks->u.scan.scan;
1306 if (res->entries && res->entries->nonsurrogateDiagnostics)
1307 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
1308 scan->scan_response = res;
1309 scan->srw_scan_response = 0;
1310 nmem_transfer(odr_getmem(scan->odr), nmem);
1312 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
1313 if (res->positionOfTerm)
1314 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
1315 if (res->scanStatus)
1316 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
1317 if (res->numberOfEntriesReturned)
1318 ZOOM_options_set_int(scan->options, "number",
1319 *res->numberOfEntriesReturned);
1324 static void handle_Z3950_records(ZOOM_connection c, Z_Records *sr,
1327 ZOOM_resultset resultset;
1329 const char *syntax = 0, *elementSetName = 0;
1333 switch (c->tasks->which)
1335 case ZOOM_TASK_SEARCH:
1336 resultset = c->tasks->u.search.resultset;
1337 start = &c->tasks->u.search.start;
1338 count = &c->tasks->u.search.count;
1339 syntax = c->tasks->u.search.syntax;
1340 elementSetName = c->tasks->u.search.elementSetName;
1342 case ZOOM_TASK_RETRIEVE:
1343 resultset = c->tasks->u.retrieve.resultset;
1344 start = &c->tasks->u.retrieve.start;
1345 count = &c->tasks->u.retrieve.count;
1346 syntax = c->tasks->u.retrieve.syntax;
1347 elementSetName = c->tasks->u.retrieve.elementSetName;
1352 if (sr && sr->which == Z_Records_NSD)
1353 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
1354 else if (sr && sr->which == Z_Records_multipleNSD)
1356 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
1357 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
1359 ZOOM_set_error(c, ZOOM_ERROR_DECODE, 0);
1363 if (*count + *start > resultset->size)
1364 *count = resultset->size - *start;
1367 if (sr && sr->which == Z_Records_DBOSD)
1370 NMEM nmem = odr_extract_mem(c->odr_in);
1371 Z_NamePlusRecordList *p =
1372 sr->u.databaseOrSurDiagnostics;
1373 for (i = 0; i<p->num_records; i++)
1375 ZOOM_record_cache_add(resultset, p->records[i], i + *start,
1376 syntax, elementSetName,
1383 yaz_log(c->log_details,
1384 "handle_records resultset=%p start=%d count=%d",
1385 resultset, *start, *count);
1387 /* transfer our response to search_nmem .. we need it later */
1388 nmem_transfer(odr_getmem(resultset->odr), nmem);
1390 if (present_phase && p->num_records == 0)
1392 /* present response and we didn't get any records! */
1393 Z_NamePlusRecord *myrec =
1394 zget_surrogateDiagRec(
1396 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1397 "ZOOM C generated. Present phase and no records");
1398 ZOOM_record_cache_add(resultset, myrec, *start,
1399 syntax, elementSetName, 0, 0);
1402 else if (present_phase)
1404 /* present response and we didn't get any records! */
1405 Z_NamePlusRecord *myrec =
1406 zget_surrogateDiagRec(
1408 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1409 "ZOOM C generated: Present response and no records");
1410 ZOOM_record_cache_add(resultset, myrec, *start,
1411 syntax, elementSetName, 0, 0);
1416 static void handle_Z3950_present_response(ZOOM_connection c,
1417 Z_PresentResponse *pr)
1419 handle_Z3950_records(c, pr->records, 1);
1422 static void set_init_option(const char *name, void *clientData)
1424 ZOOM_connection c = (ZOOM_connection) clientData;
1427 sprintf(buf, "init_opt_%.70s", name);
1428 ZOOM_connection_option_set(c, buf, "1");
1432 zoom_ret send_Z3950_sort(ZOOM_connection c, ZOOM_resultset resultset)
1435 resultset->r_sort_spec = 0;
1436 if (resultset->r_sort_spec)
1438 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
1439 Z_SortRequest *req = apdu->u.sortRequest;
1441 req->num_inputResultSetNames = 1;
1442 req->inputResultSetNames = (Z_InternationalString **)
1443 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
1444 req->inputResultSetNames[0] =
1445 odr_strdup(c->odr_out, resultset->setname);
1446 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
1447 req->sortSequence = resultset->r_sort_spec;
1448 resultset->r_sort_spec = 0;
1449 return send_APDU(c, apdu);
1451 return zoom_complete;
1454 zoom_ret send_Z3950_present(ZOOM_connection c)
1457 Z_PresentRequest *req = 0;
1459 const char *syntax = 0;
1460 const char *elementSetName = 0;
1461 ZOOM_resultset resultset;
1466 yaz_log(c->log_details, "%p send_present no tasks", c);
1467 return zoom_complete;
1470 switch (c->tasks->which)
1472 case ZOOM_TASK_SEARCH:
1473 resultset = c->tasks->u.search.resultset;
1474 start = &c->tasks->u.search.start;
1475 count = &c->tasks->u.search.count;
1476 syntax = c->tasks->u.search.syntax;
1477 elementSetName = c->tasks->u.search.elementSetName;
1479 case ZOOM_TASK_RETRIEVE:
1480 resultset = c->tasks->u.retrieve.resultset;
1481 start = &c->tasks->u.retrieve.start;
1482 count = &c->tasks->u.retrieve.count;
1483 syntax = c->tasks->u.retrieve.syntax;
1484 elementSetName = c->tasks->u.retrieve.elementSetName;
1487 return zoom_complete;
1489 yaz_log(c->log_details, "%p send_present start=%d count=%d",
1492 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
1494 ZOOM_set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
1497 if (c->error) /* don't continue on error */
1498 return zoom_complete;
1499 yaz_log(c->log_details, "send_present resultset=%p start=%d count=%d",
1500 resultset, *start, *count);
1502 for (i = 0; i < *count; i++)
1505 ZOOM_record_cache_lookup(resultset, i + *start,
1506 syntax, elementSetName);
1511 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1512 ZOOM_connection_put_event(c, event);
1520 yaz_log(c->log_details, "%p send_present skip=%d no more to fetch", c, i);
1521 return zoom_complete;
1524 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
1525 req = apdu->u.presentRequest;
1528 yaz_log(c->log_details, "%p send_present skip=%d", c, i);
1530 *req->resultSetStartPoint = *start + 1;
1532 if (resultset->step > 0 && resultset->step < *count)
1533 *req->numberOfRecordsRequested = resultset->step;
1535 *req->numberOfRecordsRequested = *count;
1537 if (*req->numberOfRecordsRequested + *start > resultset->size)
1538 *req->numberOfRecordsRequested = resultset->size - *start;
1539 assert(*req->numberOfRecordsRequested > 0);
1541 if (syntax && *syntax)
1542 req->preferredRecordSyntax =
1543 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1545 if (resultset->schema && *resultset->schema)
1547 Z_RecordComposition *compo = (Z_RecordComposition *)
1548 odr_malloc(c->odr_out, sizeof(*compo));
1550 req->recordComposition = compo;
1551 compo->which = Z_RecordComp_complex;
1552 compo->u.complex = (Z_CompSpec *)
1553 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
1554 compo->u.complex->selectAlternativeSyntax = (bool_t *)
1555 odr_malloc(c->odr_out, sizeof(bool_t));
1556 *compo->u.complex->selectAlternativeSyntax = 0;
1558 compo->u.complex->generic = (Z_Specification *)
1559 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
1561 compo->u.complex->generic->which = Z_Schema_oid;
1562 compo->u.complex->generic->schema.oid = (Odr_oid *)
1563 zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
1565 if (!compo->u.complex->generic->schema.oid)
1567 /* OID wasn't a schema! Try record syntax instead. */
1569 compo->u.complex->generic->schema.oid = (Odr_oid *)
1570 zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
1572 if (elementSetName && *elementSetName)
1574 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
1575 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
1576 compo->u.complex->generic->elementSpec->which =
1577 Z_ElementSpec_elementSetName;
1578 compo->u.complex->generic->elementSpec->u.elementSetName =
1579 odr_strdup(c->odr_out, elementSetName);
1582 compo->u.complex->generic->elementSpec = 0;
1583 compo->u.complex->num_dbSpecific = 0;
1584 compo->u.complex->dbSpecific = 0;
1585 compo->u.complex->num_recordSyntax = 0;
1586 compo->u.complex->recordSyntax = 0;
1588 else if (elementSetName && *elementSetName)
1590 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1591 odr_malloc(c->odr_out, sizeof(*esn));
1592 Z_RecordComposition *compo = (Z_RecordComposition *)
1593 odr_malloc(c->odr_out, sizeof(*compo));
1595 esn->which = Z_ElementSetNames_generic;
1596 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
1597 compo->which = Z_RecordComp_simple;
1598 compo->u.simple = esn;
1599 req->recordComposition = compo;
1601 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
1602 return send_APDU(c, apdu);
1605 static zoom_ret send_Z3950_sort_present(ZOOM_connection c)
1607 zoom_ret r = zoom_complete;
1609 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
1610 r = send_Z3950_sort(c, c->tasks->u.search.resultset);
1611 if (r == zoom_complete)
1612 r = send_Z3950_present(c);
1616 void ZOOM_handle_Z3950_apdu(ZOOM_connection c, Z_APDU *apdu)
1618 Z_InitResponse *initrs;
1620 ZOOM_connection_set_mask(c, 0);
1621 yaz_log(c->log_details, "%p handle_Z3950_apdu apdu->which=%d",
1623 switch (apdu->which)
1625 case Z_APDU_initResponse:
1626 yaz_log(c->log_api, "%p handle_Z3950_apdu: Received Init response", c);
1627 initrs = apdu->u.initResponse;
1628 ZOOM_connection_option_set(c, "serverImplementationId",
1629 initrs->implementationId ?
1630 initrs->implementationId : "");
1631 ZOOM_connection_option_set(c, "serverImplementationName",
1632 initrs->implementationName ?
1633 initrs->implementationName : "");
1634 ZOOM_connection_option_set(c, "serverImplementationVersion",
1635 initrs->implementationVersion ?
1636 initrs->implementationVersion : "");
1637 /* Set the three old options too, for old applications */
1638 ZOOM_connection_option_set(c, "targetImplementationId",
1639 initrs->implementationId ?
1640 initrs->implementationId : "");
1641 ZOOM_connection_option_set(c, "targetImplementationName",
1642 initrs->implementationName ?
1643 initrs->implementationName : "");
1644 ZOOM_connection_option_set(c, "targetImplementationVersion",
1645 initrs->implementationVersion ?
1646 initrs->implementationVersion : "");
1648 /* Make initrs->options available as ZOOM-level options */
1649 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
1651 if (!*initrs->result)
1653 Z_DefaultDiagFormat *df = yaz_decode_init_diag(0, initrs);
1655 response_default_diag(c, df);
1657 ZOOM_set_error(c, ZOOM_ERROR_INIT, 0); /* default error */
1662 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
1663 yaz_oid_userinfo_cookie, 1, 0);
1664 xfree(c->cookie_in);
1667 c->cookie_in = xstrdup(cookie);
1668 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
1669 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
1670 c->support_named_resultsets = 1;
1673 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1674 ZOOM_connection_remove_task(c);
1676 ZOOM_connection_exec_task(c);
1678 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
1680 NMEM tmpmem = nmem_create();
1681 Z_CharSetandLanguageNegotiation *p =
1682 yaz_get_charneg_record(initrs->otherInfo);
1686 char *charset = NULL, *lang = NULL;
1689 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
1690 yaz_log(c->log_details, "%p handle_Z3950_apdu target accepted: "
1691 "charset %s, language %s, select %d",
1693 charset ? charset : "none", lang ? lang : "none", sel);
1695 ZOOM_connection_option_set(c, "negotiation-charset",
1698 ZOOM_connection_option_set(c, "negotiation-lang",
1701 ZOOM_connection_option_set(
1702 c, "negotiation-charset-in-effect-for-records",
1703 (sel != 0) ? "1" : "0");
1704 nmem_destroy(tmpmem);
1708 case Z_APDU_searchResponse:
1709 yaz_log(c->log_api, "%p handle_Z3950_apdu Search response", c);
1710 handle_Z3950_search_response(c, apdu->u.searchResponse);
1711 if (send_Z3950_sort_present(c) == zoom_complete)
1712 ZOOM_connection_remove_task(c);
1714 case Z_APDU_presentResponse:
1715 yaz_log(c->log_api, "%p handle_Z3950_apdu Present response", c);
1716 handle_Z3950_present_response(c, apdu->u.presentResponse);
1717 if (send_Z3950_present(c) == zoom_complete)
1718 ZOOM_connection_remove_task(c);
1720 case Z_APDU_sortResponse:
1721 yaz_log(c->log_api, "%p handle_Z3950_apdu Sort response", c);
1722 handle_Z3950_sort_response(c, apdu->u.sortResponse);
1723 if (send_Z3950_present(c) == zoom_complete)
1724 ZOOM_connection_remove_task(c);
1726 case Z_APDU_scanResponse:
1727 yaz_log(c->log_api, "%p handle_Z3950_apdu Scan response", c);
1728 handle_Z3950_scan_response(c, apdu->u.scanResponse);
1729 ZOOM_connection_remove_task(c);
1731 case Z_APDU_extendedServicesResponse:
1732 yaz_log(c->log_api, "%p handle_Z3950_apdu Extended Services response", c);
1733 handle_Z3950_es_response(c, apdu->u.extendedServicesResponse);
1734 ZOOM_connection_remove_task(c);
1737 yaz_log(c->log_api, "%p handle_Z3950_apdu Close PDU", c);
1738 if (!ZOOM_test_reconnect(c))
1740 ZOOM_set_dset_error(c, ZOOM_ERROR_CONNECTION_LOST, "ZOOM", c->host_port, apdu->u.close->diagnosticInformation);
1741 ZOOM_connection_close(c);
1745 yaz_log(c->log_api, "%p Received unknown PDU", c);
1746 ZOOM_set_error(c, ZOOM_ERROR_DECODE, 0);
1747 ZOOM_connection_close(c);
1754 * c-file-style: "Stroustrup"
1755 * indent-tabs-mode: nil
1757 * vim: shiftwidth=4 tabstop=8 expandtab