1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2013 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, illRequest_buf, illRequest_size);
134 static Z_ItemOrder *encode_item_order(ZOOM_package p)
136 Z_ItemOrder *req = (Z_ItemOrder *) odr_malloc(p->odr_out, sizeof(*req));
140 req->which = Z_IOItemOrder_esRequest;
141 req->u.esRequest = (Z_IORequest *)
142 odr_malloc(p->odr_out,sizeof(Z_IORequest));
144 /* to keep part ... */
145 req->u.esRequest->toKeep = (Z_IOOriginPartToKeep *)
146 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartToKeep));
147 req->u.esRequest->toKeep->supplDescription = 0;
148 req->u.esRequest->toKeep->contact = (Z_IOContact *)
149 odr_malloc(p->odr_out, sizeof(*req->u.esRequest->toKeep->contact));
151 str = ZOOM_options_get(p->options, "contact-name");
152 req->u.esRequest->toKeep->contact->name =
153 odr_strdup_null(p->odr_out, str);
155 str = ZOOM_options_get(p->options, "contact-phone");
156 req->u.esRequest->toKeep->contact->phone =
157 odr_strdup_null(p->odr_out, str);
159 str = ZOOM_options_get(p->options, "contact-email");
160 req->u.esRequest->toKeep->contact->email =
161 odr_strdup_null(p->odr_out, str);
163 req->u.esRequest->toKeep->addlBilling = 0;
165 /* not to keep part ... */
166 req->u.esRequest->notToKeep = (Z_IOOriginPartNotToKeep *)
167 odr_malloc(p->odr_out,sizeof(Z_IOOriginPartNotToKeep));
169 str = ZOOM_options_get(p->options, "itemorder-setname");
174 req->u.esRequest->notToKeep->resultSetItem = 0;
177 req->u.esRequest->notToKeep->resultSetItem = (Z_IOResultSetItem *)
178 odr_malloc(p->odr_out, sizeof(Z_IOResultSetItem));
180 req->u.esRequest->notToKeep->resultSetItem->resultSetId =
181 odr_strdup(p->odr_out, str);
182 req->u.esRequest->notToKeep->resultSetItem->item =
183 odr_intdup(p->odr_out, 0);
185 str = ZOOM_options_get(p->options, "itemorder-item");
186 *req->u.esRequest->notToKeep->resultSetItem->item =
187 (str ? atoi(str) : 1);
190 str = ZOOM_options_getl(p->options, "doc", &len);
193 req->u.esRequest->notToKeep->itemRequest =
194 z_ext_record_xml(p->odr_out, str, len);
197 req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
202 Z_APDU *create_admin_package(ZOOM_package p, int type,
203 Z_ESAdminOriginPartToKeep **toKeepP,
204 Z_ESAdminOriginPartNotToKeep **notToKeepP)
206 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_admin);
209 Z_ESAdminOriginPartToKeep *toKeep;
210 Z_ESAdminOriginPartNotToKeep *notToKeep;
211 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
212 const char *first_db = "Default";
214 char **db = ZOOM_connection_get_databases(p->connection,
220 r->direct_reference = odr_oiddup(p->odr_out, yaz_oid_extserv_admin);
222 r->indirect_reference = 0;
223 r->which = Z_External_ESAdmin;
225 r->u.adminService = (Z_Admin *)
226 odr_malloc(p->odr_out, sizeof(*r->u.adminService));
227 r->u.adminService->which = Z_Admin_esRequest;
228 r->u.adminService->u.esRequest = (Z_AdminEsRequest *)
229 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest));
231 toKeep = r->u.adminService->u.esRequest->toKeep =
232 (Z_ESAdminOriginPartToKeep *)
233 odr_malloc(p->odr_out, sizeof(*r->u.adminService->u.esRequest->toKeep));
234 toKeep->which = type;
235 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
236 toKeep->u.create = odr_nullval();
237 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
239 r->u.adminService->u.esRequest->notToKeep = notToKeep =
240 (Z_ESAdminOriginPartNotToKeep *)
241 odr_malloc(p->odr_out,
242 sizeof(*r->u.adminService->u.esRequest->notToKeep));
243 notToKeep->which = Z_ESAdminOriginPartNotToKeep_recordsWillFollow;
244 notToKeep->u.recordsWillFollow = odr_nullval();
248 *notToKeepP = notToKeep;
253 static Z_APDU *create_xmlupdate_package(ZOOM_package p)
255 Z_APDU *apdu = create_es_package(p, yaz_oid_extserv_xml_es);
256 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
257 Z_External *ext = (Z_External *) odr_malloc(p->odr_out, sizeof(*ext));
259 const char *doc = ZOOM_options_getl(p->options, "doc", &len);
267 req->taskSpecificParameters = ext;
268 ext->direct_reference = req->packageType;
270 ext->indirect_reference = 0;
272 ext->which = Z_External_octet;
273 ext->u.single_ASN1_type = odr_create_Odr_oct(p->odr_out, doc, len);
277 static Z_APDU *create_update_package(ZOOM_package p)
280 const char *first_db = "Default";
282 char **db = ZOOM_connection_get_databases(p->connection, p->options,
283 &num_db, p->odr_out);
284 const char *action = ZOOM_options_get(p->options, "action");
285 int recordIdOpaque_len;
286 const char *recordIdOpaque = ZOOM_options_getl(p->options, "recordIdOpaque",
287 &recordIdOpaque_len);
288 const char *recordIdNumber = ZOOM_options_get(p->options, "recordIdNumber");
290 const char *record_buf = ZOOM_options_getl(p->options, "record",
292 int recordOpaque_len;
293 const char *recordOpaque_buf = ZOOM_options_getl(p->options, "recordOpaque",
295 const char *syntax_str = ZOOM_options_get(p->options, "syntax");
296 const char *version = ZOOM_options_get(p->options, "updateVersion");
298 const char *correlationInfo_note =
299 ZOOM_options_get(p->options, "correlationInfo.note");
300 const char *correlationInfo_id =
301 ZOOM_options_get(p->options, "correlationInfo.id");
303 Odr_oid *syntax_oid = 0;
304 const Odr_oid *package_oid = yaz_oid_extserv_database_update;
310 if (!record_buf && !recordOpaque_buf)
314 syntax_str = "SUTRS";
319 syntax_oid = yaz_string_to_oid_odr(yaz_oid_std(),
320 CLASS_RECSYN, syntax_str,
325 ZOOM_set_error(p->connection, ZOOM_ERROR_ES_INVALID_SYNTAX, syntax_str);
335 package_oid = yaz_oid_extserv_database_update_first_version;
336 /* old update does not support specialUpdate */
338 action = "recordInsert";
342 action = "specialUpdate";
343 package_oid = yaz_oid_extserv_database_update_second_version;
347 action = "specialUpdate";
348 package_oid = yaz_oid_extserv_database_update;
351 ZOOM_set_error(p->connection, ZOOM_ERROR_ES_INVALID_VERSION, version);
355 if (!strcmp(action, "recordInsert"))
356 action_no = Z_IUOriginPartToKeep_recordInsert;
357 else if (!strcmp(action, "recordReplace"))
358 action_no = Z_IUOriginPartToKeep_recordReplace;
359 else if (!strcmp(action, "recordDelete"))
360 action_no = Z_IUOriginPartToKeep_recordDelete;
361 else if (!strcmp(action, "elementUpdate"))
362 action_no = Z_IUOriginPartToKeep_elementUpdate;
363 else if (!strcmp(action, "specialUpdate"))
364 action_no = Z_IUOriginPartToKeep_specialUpdate;
367 ZOOM_set_error(p->connection, ZOOM_ERROR_ES_INVALID_ACTION, action);
371 apdu = create_es_package(p, package_oid);
374 Z_IUOriginPartToKeep *toKeep;
375 Z_IUSuppliedRecords *notToKeep;
376 Z_External *r = (Z_External *)
377 odr_malloc(p->odr_out, sizeof(*r));
378 const char *elementSetName =
379 ZOOM_options_get(p->options, "elementSetName");
381 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
383 r->direct_reference = odr_oiddup(p->odr_out, package_oid);
385 r->which = Z_External_update;
386 r->indirect_reference = 0;
387 r->u.update = (Z_IUUpdate *)
388 odr_malloc(p->odr_out, sizeof(*r->u.update));
390 r->u.update->which = Z_IUUpdate_esRequest;
391 r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
392 odr_malloc(p->odr_out, sizeof(*r->u.update->u.esRequest));
393 toKeep = r->u.update->u.esRequest->toKeep =
394 (Z_IUOriginPartToKeep *)
395 odr_malloc(p->odr_out, sizeof(*toKeep));
397 toKeep->databaseName = odr_strdup(p->odr_out, first_db);
400 toKeep->elementSetName = odr_strdup_null(p->odr_out, elementSetName);
402 toKeep->actionQualifier = 0;
403 toKeep->action = odr_intdup(p->odr_out, action_no);
405 notToKeep = r->u.update->u.esRequest->notToKeep =
406 (Z_IUSuppliedRecords *)
407 odr_malloc(p->odr_out, sizeof(*notToKeep));
409 notToKeep->elements = (Z_IUSuppliedRecords_elem **)
410 odr_malloc(p->odr_out, sizeof(*notToKeep->elements));
411 notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
412 odr_malloc(p->odr_out, sizeof(**notToKeep->elements));
413 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_opaque;
416 notToKeep->elements[0]->u.opaque =
417 odr_create_Odr_oct(p->odr_out, recordIdOpaque,
420 else if (recordIdNumber)
422 notToKeep->elements[0]->which = Z_IUSuppliedRecords_elem_number;
424 notToKeep->elements[0]->u.number =
425 odr_intdup(p->odr_out, atoi(recordIdNumber));
428 notToKeep->elements[0]->u.opaque = 0;
429 notToKeep->elements[0]->supplementalId = 0;
430 if (correlationInfo_note || correlationInfo_id)
432 Z_IUCorrelationInfo *ci;
433 ci = notToKeep->elements[0]->correlationInfo =
434 (Z_IUCorrelationInfo *) odr_malloc(p->odr_out, sizeof(*ci));
435 ci->note = odr_strdup_null(p->odr_out, correlationInfo_note);
436 ci->id = correlationInfo_id ?
437 odr_intdup(p->odr_out, atoi(correlationInfo_id)) : 0;
440 notToKeep->elements[0]->correlationInfo = 0;
441 if (recordOpaque_buf)
443 notToKeep->elements[0]->record =
444 z_ext_record_oid_any(p->odr_out, syntax_oid,
445 recordOpaque_buf, recordOpaque_len);
449 notToKeep->elements[0]->record =
450 z_ext_record_oid(p->odr_out, syntax_oid,
451 record_buf, record_len);
456 ODR print = odr_createmem(ODR_PRINT);
458 z_APDU(print, &apdu, 0, 0);
465 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
468 for (i = 0; i<200; i++)
472 Z_OtherInformation **oi;
477 sprintf(buf, "otherInfo%d", i);
478 val = ZOOM_options_get(c->options, buf);
481 cp = strchr(val, ':');
485 if (len >= sizeof(buf))
487 memcpy(buf, val, len);
490 oid = yaz_string_to_oid_odr(yaz_oid_std(), CLASS_USERINFO,
496 yaz_oi_set_string_oid(oi, out, oid, 1, cp+1);
502 static int encode_APDU(ZOOM_connection c, Z_APDU *a, ODR out)
507 Z_OtherInformation **oi;
509 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_cookie,
514 Z_OtherInformation **oi;
516 yaz_oi_set_string_oid(oi, out, yaz_oid_userinfo_client_ip,
519 otherInfo_attach(c, a, out);
520 if (!z_APDU(out, &a, 0, 0))
522 FILE *outf = fopen("/tmp/apdu.txt", "a");
525 ODR odr_pr = odr_createmem(ODR_PRINT);
526 fprintf(outf, "a=%p\n", a);
527 odr_setprint(odr_pr, outf);
528 z_APDU(odr_pr, &a, 0, 0);
531 yaz_log(c->log_api, "%p encoding_APDU: encoding failed", c);
532 ZOOM_set_error(c, ZOOM_ERROR_ENCODE, 0);
537 z_APDU(c->odr_print, &a, 0, 0);
539 z_APDU(c->odr_save, &a, 0, 0);
540 yaz_log(c->log_details, "%p encoding_APDU encoding OK", c);
544 static zoom_ret send_APDU(ZOOM_connection c, Z_APDU *a)
548 if (encode_APDU(c, a, c->odr_out))
549 return zoom_complete;
550 yaz_log(c->log_details, "%p send APDU type=%d", c, a->which);
551 c->buf_out = odr_getbuf(c->odr_out, &c->len_out, 0);
552 event = ZOOM_Event_create(ZOOM_EVENT_SEND_APDU);
553 ZOOM_connection_put_event(c, event);
554 odr_reset(c->odr_out);
555 return ZOOM_send_buf(c);
558 zoom_ret ZOOM_connection_Z3950_send_init(ZOOM_connection c)
560 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_initRequest);
561 Z_InitRequest *ireq = apdu->u.initRequest;
562 Z_IdAuthentication *auth = (Z_IdAuthentication *)
563 odr_malloc(c->odr_out, sizeof(*auth));
565 ODR_MASK_SET(ireq->options, Z_Options_search);
566 ODR_MASK_SET(ireq->options, Z_Options_present);
567 ODR_MASK_SET(ireq->options, Z_Options_scan);
568 ODR_MASK_SET(ireq->options, Z_Options_sort);
569 ODR_MASK_SET(ireq->options, Z_Options_extendedServices);
570 ODR_MASK_SET(ireq->options, Z_Options_namedResultSets);
572 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_1);
573 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_2);
574 ODR_MASK_SET(ireq->protocolVersion, Z_ProtocolVersion_3);
576 ireq->implementationId =
577 odr_prepend(c->odr_out,
578 ZOOM_options_get(c->options, "implementationId"),
579 ireq->implementationId);
581 ireq->implementationName =
582 odr_prepend(c->odr_out,
583 ZOOM_options_get(c->options, "implementationName"),
584 odr_prepend(c->odr_out, "ZOOM-C",
585 ireq->implementationName));
587 ireq->implementationVersion =
588 odr_prepend(c->odr_out,
589 ZOOM_options_get(c->options, "implementationVersion"),
590 ireq->implementationVersion);
592 *ireq->maximumRecordSize = c->maximum_record_size;
593 *ireq->preferredMessageSize = c->preferred_message_size;
595 if (c->group || c->password)
597 Z_IdPass *pass = (Z_IdPass *) odr_malloc(c->odr_out, sizeof(*pass));
598 pass->groupId = odr_strdup_null(c->odr_out, c->group);
599 pass->userId = odr_strdup_null(c->odr_out, c->user);
600 pass->password = odr_strdup_null(c->odr_out, c->password);
601 auth->which = Z_IdAuthentication_idPass;
602 auth->u.idPass = pass;
603 ireq->idAuthentication = auth;
607 auth->which = Z_IdAuthentication_open;
608 auth->u.open = odr_strdup(c->odr_out, c->user);
609 ireq->idAuthentication = auth;
613 yaz_oi_set_string_oid(&ireq->otherInfo, c->odr_out,
614 yaz_oid_userinfo_proxy, 1, c->host_port);
616 if (c->charset || c->lang)
618 Z_OtherInformation **oi;
619 Z_OtherInformationUnit *oi_unit;
621 yaz_oi_APDU(apdu, &oi);
623 if ((oi_unit = yaz_oi_update(oi, c->odr_out, NULL, 0, 0)))
625 ODR_MASK_SET(ireq->options, Z_Options_negotiationModel);
626 oi_unit->which = Z_OtherInfo_externallyDefinedInfo;
627 oi_unit->information.externallyDefinedInfo =
628 yaz_set_proposal_charneg_list(c->odr_out, " ",
629 c->charset, c->lang, 1);
633 return send_APDU(c, apdu);
636 zoom_ret ZOOM_connection_Z3950_send_search(ZOOM_connection c)
639 int lslb, ssub, mspn;
642 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_searchRequest);
643 Z_SearchRequest *search_req = apdu->u.searchRequest;
644 const char *elementSetName;
645 const char *smallSetElementSetName;
646 const char *mediumSetElementSetName;
650 assert(c->tasks->which == ZOOM_TASK_SEARCH);
652 r = c->tasks->u.search.resultset;
654 yaz_log(c->log_details, "%p ZOOM_connection_send_search set=%p", c, r);
657 ZOOM_options_get(r->options, "elementSetName");
658 smallSetElementSetName =
659 ZOOM_options_get(r->options, "smallSetElementSetName");
660 mediumSetElementSetName =
661 ZOOM_options_get(r->options, "mediumSetElementSetName");
663 if (!smallSetElementSetName)
664 smallSetElementSetName = elementSetName;
666 if (!mediumSetElementSetName)
667 mediumSetElementSetName = elementSetName;
669 facets = ZOOM_options_get(r->options, "facets");
671 Z_FacetList *facet_list = yaz_pqf_parse_facet_list(c->odr_out, facets);
673 Z_OtherInformation **oi = &search_req->additionalSearchInfo;
674 yaz_oi_set_facetlist(oi, c->odr_out, facet_list);
677 yaz_log(YLOG_WARN, "Unable to parse facets: %s", facets);
683 /* prepare query for the search request */
684 search_req->query = ZOOM_query_get_Z_Query(r->query);
685 if (!search_req->query)
687 ZOOM_set_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
688 return zoom_complete;
690 if (search_req->query->which == Z_Query_type_1 ||
691 search_req->query->which == Z_Query_type_101)
693 const char *cp = ZOOM_options_get(r->options, "rpnCharset");
696 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
700 search_req->query = yaz_copy_Z_Query(search_req->query,
703 r = yaz_query_charset_convert_rpnquery_check(
704 search_req->query->u.type_1,
708 { /* query could not be char converted */
709 ZOOM_set_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
710 return zoom_complete;
715 search_req->databaseNames = r->databaseNames;
716 search_req->num_databaseNames = r->num_databaseNames;
718 /* get syntax (no need to provide unless piggyback is in effect) */
719 syntax = c->tasks->u.search.syntax;
721 schema = c->tasks->u.search.schema;
723 lslb = ZOOM_options_get_int(r->options, "largeSetLowerBound", -1);
724 ssub = ZOOM_options_get_int(r->options, "smallSetUpperBound", -1);
725 mspn = ZOOM_options_get_int(r->options, "mediumSetPresentNumber", -1);
726 if (lslb != -1 && ssub != -1 && mspn != -1)
728 /* So're a Z39.50 expert? Let's hope you don't do sort */
729 *search_req->largeSetLowerBound = lslb;
730 *search_req->smallSetUpperBound = ssub;
731 *search_req->mediumSetPresentNumber = mspn;
733 else if (c->tasks->u.search.start == 0 && c->tasks->u.search.count > 0
734 && r->piggyback && !r->r_sort_spec && !schema)
736 /* Regular piggyback - do it unless we're going to do sort */
737 *search_req->largeSetLowerBound = 2000000000;
738 *search_req->smallSetUpperBound = 1;
739 *search_req->mediumSetPresentNumber =
740 r->step>0 ? r->step : c->tasks->u.search.count;
744 /* non-piggyback. Need not provide elementsets or syntaxes .. */
745 smallSetElementSetName = 0;
746 mediumSetElementSetName = 0;
749 if (smallSetElementSetName && *smallSetElementSetName)
751 Z_ElementSetNames *esn = (Z_ElementSetNames *)
752 odr_malloc(c->odr_out, sizeof(*esn));
754 esn->which = Z_ElementSetNames_generic;
755 esn->u.generic = odr_strdup(c->odr_out, smallSetElementSetName);
756 search_req->smallSetElementSetNames = esn;
758 if (mediumSetElementSetName && *mediumSetElementSetName)
760 Z_ElementSetNames *esn =(Z_ElementSetNames *)
761 odr_malloc(c->odr_out, sizeof(*esn));
763 esn->which = Z_ElementSetNames_generic;
764 esn->u.generic = odr_strdup(c->odr_out, mediumSetElementSetName);
765 search_req->mediumSetElementSetNames = esn;
768 search_req->preferredRecordSyntax =
769 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
773 if (c->support_named_resultsets)
777 /* find the lowest unused ordinal so that we re-use
778 result sets on the server. */
779 for (ord = 1; ; ord++)
782 sprintf(setname, "%d", ord);
783 for (rp = c->resultsets; rp; rp = rp->next)
784 if (rp->setname && !strcmp(rp->setname, setname))
789 r->setname = xstrdup(setname);
790 yaz_log(c->log_details, "%p ZOOM_connection_send_search: "
791 "allocating set %s", c, r->setname);
795 yaz_log(c->log_details, "%p ZOOM_connection_send_search: using "
797 r->setname = xstrdup("default");
799 ZOOM_options_set(r->options, "setname", r->setname);
801 search_req->resultSetName = odr_strdup(c->odr_out, r->setname);
802 return send_APDU(c, apdu);
805 zoom_ret ZOOM_connection_Z3950_send_scan(ZOOM_connection c)
808 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_scanRequest);
809 Z_ScanRequest *req = apdu->u.scanRequest;
812 yaz_log(c->log_details, "%p send_scan", c);
814 return zoom_complete;
815 assert (c->tasks->which == ZOOM_TASK_SCAN);
816 scan = c->tasks->u.scan.scan;
818 z_query = ZOOM_query_get_Z_Query(scan->query);
820 /* Z39.50 scan can only carry RPN */
821 if (z_query->which == Z_Query_type_1 ||
822 z_query->which == Z_Query_type_101)
824 Z_RPNQuery *rpn = z_query->u.type_1;
825 const char *cp = ZOOM_options_get(scan->options, "rpnCharset");
828 yaz_iconv_t cd = yaz_iconv_open(cp, "UTF-8");
831 rpn = yaz_copy_z_RPNQuery(rpn, c->odr_out);
833 yaz_query_charset_convert_rpnquery(
834 rpn, c->odr_out, cd);
838 req->attributeSet = rpn->attributeSetId;
839 if (!req->attributeSet)
840 req->attributeSet = odr_oiddup(c->odr_out, yaz_oid_attset_bib_1);
841 if (rpn->RPNStructure->which == Z_RPNStructure_simple &&
842 rpn->RPNStructure->u.simple->which == Z_Operand_APT)
844 req->termListAndStartPoint =
845 rpn->RPNStructure->u.simple->u.attributesPlusTerm;
849 ZOOM_set_error(c, ZOOM_ERROR_INVALID_QUERY, 0);
850 return zoom_complete;
855 ZOOM_set_error(c, ZOOM_ERROR_UNSUPPORTED_QUERY, 0);
856 return zoom_complete;
859 *req->numberOfTermsRequested =
860 ZOOM_options_get_int(scan->options, "number", 20);
862 req->preferredPositionInResponse =
863 odr_intdup(c->odr_out,
864 ZOOM_options_get_int(scan->options, "position", 1));
867 odr_intdup(c->odr_out,
868 ZOOM_options_get_int(scan->options, "stepSize", 0));
870 req->databaseNames = scan->databaseNames;
871 req->num_databaseNames = scan->num_databaseNames;
873 return send_APDU(c, apdu);
877 ZOOM_package_send(ZOOM_package p, const char *type)
884 odr_reset(p->odr_out);
887 if (!strcmp(type, "itemorder"))
889 apdu = create_es_package(p, yaz_oid_extserv_item_order);
892 Z_External *r = (Z_External *) odr_malloc(p->odr_out, sizeof(*r));
894 r->direct_reference =
895 odr_oiddup(p->odr_out, yaz_oid_extserv_item_order);
897 r->which = Z_External_itemOrder;
898 r->indirect_reference = 0;
899 r->u.itemOrder = encode_item_order(p);
901 apdu->u.extendedServicesRequest->taskSpecificParameters = r;
904 else if (!strcmp(type, "create")) /* create database */
906 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_create,
909 else if (!strcmp(type, "drop")) /* drop database */
911 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_drop,
914 else if (!strcmp(type, "commit")) /* commit changes */
916 apdu = create_admin_package(p, Z_ESAdminOriginPartToKeep_commit,
919 else if (!strcmp(type, "update")) /* update record(s) */
921 apdu = create_update_package(p);
923 else if (!strcmp(type, "xmlupdate"))
925 apdu = create_xmlupdate_package(p);
929 if (encode_APDU(p->connection, apdu, p->odr_out) == 0)
933 ZOOM_task task = ZOOM_connection_add_task(c, ZOOM_TASK_PACKAGE);
935 buf = odr_getbuf(p->odr_out, &p->len_out, 0);
936 p->buf_out = (char *) xmalloc(p->len_out);
937 memcpy(p->buf_out, buf, p->len_out);
942 while (ZOOM_event(1, &c))
949 static void handle_Z3950_records(ZOOM_connection c, Z_Records *sr,
952 static void response_default_diag(ZOOM_connection c, Z_DefaultDiagFormat *r)
954 char oid_name_buf[OID_STR_MAX];
955 const char *oid_name;
958 oid_name = yaz_oid_to_string_buf(r->diagnosticSetId, 0, oid_name_buf);
961 case Z_DefaultDiagFormat_v2Addinfo:
962 addinfo = r->u.v2Addinfo;
964 case Z_DefaultDiagFormat_v3Addinfo:
965 addinfo = r->u.v3Addinfo;
970 ZOOM_set_dset_error(c, *r->condition, oid_name, addinfo, 0);
973 static void response_diag(ZOOM_connection c, Z_DiagRec *p)
975 if (p->which != Z_DiagRec_defaultFormat)
976 ZOOM_set_error(c, ZOOM_ERROR_DECODE, 0);
978 response_default_diag(c, p->u.defaultFormat);
981 static int es_response_taskpackage_update(ZOOM_connection c,
982 Z_IUUpdateTaskPackage *utp)
984 if (utp && utp->targetPart)
986 Z_IUTargetPart *targetPart = utp->targetPart;
987 switch ( *targetPart->updateStatus ) {
988 case Z_IUTargetPart_success:
989 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "success");
991 case Z_IUTargetPart_partial:
992 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "partial");
994 case Z_IUTargetPart_failure:
995 ZOOM_options_set(c->tasks->u.package->options,"updateStatus", "failure");
996 if (targetPart->globalDiagnostics && targetPart->num_globalDiagnostics > 0)
997 response_diag(c, targetPart->globalDiagnostics[0]);
1000 /* NOTE: Individual record status, surrogate diagnostics, and supplemental diagnostics ARE NOT REPORTED. */
1005 static int es_response_taskpackage(ZOOM_connection c,
1006 Z_TaskPackage *taskPackage)
1008 Odr_oct *id = taskPackage->targetReference;
1010 ZOOM_options_setl(c->tasks->u.package->options,
1011 "targetReference", (char*) id->buf, id->len);
1013 switch ( *taskPackage->taskStatus ) {
1014 case Z_TaskPackage_pending:
1015 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "pending");
1017 case Z_TaskPackage_active:
1018 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "active");
1020 case Z_TaskPackage_complete:
1021 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "complete");
1023 case Z_TaskPackage_aborted:
1024 ZOOM_options_set(c->tasks->u.package->options,"taskStatus", "aborted");
1025 if ( taskPackage->num_packageDiagnostics && taskPackage->packageDiagnostics )
1026 response_diag(c, taskPackage->packageDiagnostics[0]);
1029 /* NOTE: Only Update implemented, no others. */
1030 if ( taskPackage->taskSpecificParameters->which == Z_External_update )
1032 Z_IUUpdateTaskPackage *utp = taskPackage->taskSpecificParameters->u.update->u.taskPackage;
1033 es_response_taskpackage_update(c, utp);
1039 static int handle_Z3950_es_response(ZOOM_connection c,
1040 Z_ExtendedServicesResponse *res)
1042 if (!c->tasks || c->tasks->which != ZOOM_TASK_PACKAGE)
1044 switch (*res->operationStatus)
1046 case Z_ExtendedServicesResponse_done:
1047 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "done");
1049 case Z_ExtendedServicesResponse_accepted:
1050 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "accepted");
1052 case Z_ExtendedServicesResponse_failure:
1053 ZOOM_options_set(c->tasks->u.package->options,"operationStatus", "failure");
1054 if (res->diagnostics && res->num_diagnostics > 0)
1055 response_diag(c, res->diagnostics[0]);
1058 if (res->taskPackage &&
1059 res->taskPackage->which == Z_External_extendedService)
1061 Z_TaskPackage *taskPackage = res->taskPackage->u.extendedService;
1062 es_response_taskpackage(c, taskPackage);
1064 if (res->taskPackage &&
1065 res->taskPackage->which == Z_External_octet)
1067 Odr_oct *doc = res->taskPackage->u.octet_aligned;
1068 ZOOM_options_setl(c->tasks->u.package->options,
1069 "xmlUpdateDoc", (char*) doc->buf, doc->len);
1074 static char *get_term_cstr(ODR odr, Z_Term *term) {
1076 switch (term->which) {
1077 case Z_Term_general:
1078 return odr_strdupn(odr, (const char *) term->u.general->buf, (size_t) term->u.general->len);
1080 case Z_Term_characterString:
1081 return odr_strdup(odr, term->u.characterString);
1086 static ZOOM_facet_field get_zoom_facet_field(ODR odr, Z_FacetField *facet) {
1088 struct yaz_facet_attr attr_values;
1089 ZOOM_facet_field facet_field = odr_malloc(odr, sizeof(*facet_field));
1090 yaz_facet_attr_init(&attr_values);
1091 yaz_facet_attr_get_z_attributes(facet->attributes, &attr_values);
1092 facet_field->facet_name = odr_strdup(odr, attr_values.useattr);
1093 facet_field->num_terms = facet->num_terms;
1094 yaz_log(YLOG_DEBUG, "ZOOM_facet_field %s %d terms %d", attr_values.useattr, attr_values.limit, facet->num_terms);
1095 facet_field->facet_terms = odr_malloc(odr, facet_field->num_terms * sizeof(*facet_field->facet_terms));
1096 for (term_index = 0 ; term_index < facet->num_terms; term_index++) {
1097 Z_FacetTerm *facetTerm = facet->terms[term_index];
1098 facet_field->facet_terms[term_index].frequency = *facetTerm->count;
1099 facet_field->facet_terms[term_index].term = get_term_cstr(odr, facetTerm->term);
1100 yaz_log(YLOG_DEBUG, " term[%d] %s %d",
1101 term_index, facet_field->facet_terms[term_index].term, facet_field->facet_terms[term_index].frequency);
1106 /* Can be share with SOLR/SRU/SRW requests */
1107 void ZOOM_handle_facet_list(ZOOM_resultset r, Z_FacetList *fl)
1110 r->num_facets = fl->num;
1111 yaz_log(YLOG_DEBUG, "Facets found: %d", fl->num);
1112 r->facets = odr_malloc(r->odr, r->num_facets * sizeof(*r->facets));
1113 r->facets_names = odr_malloc(r->odr, r->num_facets * sizeof(*r->facets_names));
1114 for (j = 0; j < fl->num; j++)
1116 r->facets[j] = get_zoom_facet_field(r->odr, fl->elements[j]);
1118 yaz_log(YLOG_DEBUG, "Facet field missing on index %d !", j);
1119 r->facets_names[j] = (char *) ZOOM_facet_field_name(r->facets[j]);
1123 static void handle_facet_result(ZOOM_connection c, ZOOM_resultset r,
1124 Z_OtherInformation *o)
1127 for (i = 0; o && i < o->num_elements; i++)
1129 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
1131 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
1132 if (ext->which == Z_External_userFacets)
1134 ZOOM_handle_facet_list(r, ext->u.facetList);
1140 static void handle_queryExpressionTerm(ZOOM_options opt, const char *name,
1143 switch (term->which)
1145 case Z_Term_general:
1146 ZOOM_options_setl(opt, name,
1147 (const char *)(term->u.general->buf),
1148 term->u.general->len);
1150 case Z_Term_characterString:
1151 ZOOM_options_set(opt, name, term->u.characterString);
1153 case Z_Term_numeric:
1154 ZOOM_options_set_int(opt, name, *term->u.numeric);
1159 static void handle_queryExpression(ZOOM_options opt, const char *name,
1160 Z_QueryExpression *exp)
1166 case Z_QueryExpression_term:
1167 if (exp->u.term && exp->u.term->queryTerm)
1169 sprintf(opt_name, "%s.term", name);
1170 handle_queryExpressionTerm(opt, opt_name, exp->u.term->queryTerm);
1173 case Z_QueryExpression_query:
1179 static void handle_search_result(ZOOM_connection c, ZOOM_resultset resultset,
1180 Z_OtherInformation *o)
1183 for (i = 0; o && i < o->num_elements; i++)
1185 if (o->list[i]->which == Z_OtherInfo_externallyDefinedInfo)
1187 Z_External *ext = o->list[i]->information.externallyDefinedInfo;
1189 if (ext->which == Z_External_searchResult1)
1192 Z_SearchInfoReport *sr = ext->u.searchResult1;
1195 ZOOM_options_set_int(
1196 resultset->options, "searchresult.size", sr->num);
1198 for (j = 0; j < sr->num; j++)
1200 Z_SearchInfoReport_s *ent =
1201 ext->u.searchResult1->elements[j];
1204 sprintf(pref, "searchresult.%d", j);
1206 if (ent->subqueryId)
1209 sprintf(opt_name, "%s.id", pref);
1210 ZOOM_options_set(resultset->options, opt_name,
1213 if (ent->subqueryExpression)
1216 sprintf(opt_name, "%s.subquery", pref);
1217 handle_queryExpression(resultset->options, opt_name,
1218 ent->subqueryExpression);
1220 if (ent->subqueryInterpretation)
1223 sprintf(opt_name, "%s.interpretation", pref);
1224 handle_queryExpression(resultset->options, opt_name,
1225 ent->subqueryInterpretation);
1227 if (ent->subqueryRecommendation)
1230 sprintf(opt_name, "%s.recommendation", pref);
1231 handle_queryExpression(resultset->options, opt_name,
1232 ent->subqueryRecommendation);
1234 if (ent->subqueryCount)
1237 sprintf(opt_name, "%s.count", pref);
1238 ZOOM_options_set_int(resultset->options, opt_name,
1239 *ent->subqueryCount);
1247 static void handle_Z3950_search_response(ZOOM_connection c,
1248 Z_SearchResponse *sr)
1250 ZOOM_resultset resultset;
1253 if (!c->tasks || c->tasks->which != ZOOM_TASK_SEARCH)
1256 event = ZOOM_Event_create(ZOOM_EVENT_RECV_SEARCH);
1257 ZOOM_connection_put_event(c, event);
1259 resultset = c->tasks->u.search.resultset;
1261 if (sr->resultSetStatus)
1263 ZOOM_options_set_int(resultset->options, "resultSetStatus",
1264 *sr->resultSetStatus);
1266 if (sr->presentStatus)
1268 ZOOM_options_set_int(resultset->options, "presentStatus",
1269 *sr->presentStatus);
1271 handle_search_result(c, resultset, sr->additionalSearchInfo);
1273 handle_facet_result(c, resultset, sr->additionalSearchInfo);
1275 resultset->size = *sr->resultCount;
1276 handle_Z3950_records(c, sr->records, 0);
1279 static void handle_Z3950_sort_response(ZOOM_connection c, Z_SortResponse *res)
1281 if (res->diagnostics && res->num_diagnostics > 0)
1282 response_diag(c, res->diagnostics[0]);
1285 static int handle_Z3950_scan_response(ZOOM_connection c, Z_ScanResponse *res)
1287 NMEM nmem = odr_extract_mem(c->odr_in);
1290 if (!c->tasks || c->tasks->which != ZOOM_TASK_SCAN)
1292 scan = c->tasks->u.scan.scan;
1294 if (res->entries && res->entries->nonsurrogateDiagnostics)
1295 response_diag(c, res->entries->nonsurrogateDiagnostics[0]);
1296 scan->scan_response = res;
1297 scan->srw_scan_response = 0;
1298 nmem_transfer(odr_getmem(scan->odr), nmem);
1300 ZOOM_options_set_int(scan->options, "stepSize", *res->stepSize);
1301 if (res->positionOfTerm)
1302 ZOOM_options_set_int(scan->options, "position", *res->positionOfTerm);
1303 if (res->scanStatus)
1304 ZOOM_options_set_int(scan->options, "scanStatus", *res->scanStatus);
1305 if (res->numberOfEntriesReturned)
1306 ZOOM_options_set_int(scan->options, "number",
1307 *res->numberOfEntriesReturned);
1312 static void handle_Z3950_records(ZOOM_connection c, Z_Records *sr,
1315 ZOOM_resultset resultset;
1317 const char *syntax = 0, *elementSetName = 0, *schema = 0;
1321 switch (c->tasks->which)
1323 case ZOOM_TASK_SEARCH:
1324 resultset = c->tasks->u.search.resultset;
1325 start = &c->tasks->u.search.start;
1326 count = &c->tasks->u.search.count;
1327 syntax = c->tasks->u.search.syntax;
1328 elementSetName = c->tasks->u.search.elementSetName;
1329 schema = c->tasks->u.search.schema;
1331 case ZOOM_TASK_RETRIEVE:
1332 resultset = c->tasks->u.retrieve.resultset;
1333 start = &c->tasks->u.retrieve.start;
1334 count = &c->tasks->u.retrieve.count;
1335 syntax = c->tasks->u.retrieve.syntax;
1336 elementSetName = c->tasks->u.retrieve.elementSetName;
1337 schema = c->tasks->u.retrieve.schema;
1342 if (sr && sr->which == Z_Records_NSD)
1343 response_default_diag(c, sr->u.nonSurrogateDiagnostic);
1344 else if (sr && sr->which == Z_Records_multipleNSD)
1346 if (sr->u.multipleNonSurDiagnostics->num_diagRecs >= 1)
1347 response_diag(c, sr->u.multipleNonSurDiagnostics->diagRecs[0]);
1349 ZOOM_set_error(c, ZOOM_ERROR_DECODE, 0);
1353 if (*count + *start > resultset->size)
1354 *count = resultset->size - *start;
1357 if (sr && sr->which == Z_Records_DBOSD)
1360 NMEM nmem = odr_extract_mem(c->odr_in);
1361 Z_NamePlusRecordList *p =
1362 sr->u.databaseOrSurDiagnostics;
1363 for (i = 0; i<p->num_records; i++)
1365 ZOOM_record_cache_add(resultset, p->records[i], i + *start,
1366 syntax, elementSetName, schema, 0);
1372 yaz_log(c->log_details,
1373 "handle_records resultset=%p start=%d count=%d",
1374 resultset, *start, *count);
1376 /* transfer our response to search_nmem .. we need it later */
1377 nmem_transfer(odr_getmem(resultset->odr), nmem);
1379 if (present_phase && p->num_records == 0)
1381 /* present response and we didn't get any records! */
1382 Z_NamePlusRecord *myrec =
1383 zget_surrogateDiagRec(
1385 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1386 "ZOOM C generated. Present phase and no records");
1387 ZOOM_record_cache_add(resultset, myrec, *start,
1388 syntax, elementSetName, schema, 0);
1391 else if (present_phase)
1393 /* present response and we didn't get any records! */
1394 Z_NamePlusRecord *myrec =
1395 zget_surrogateDiagRec(
1397 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1398 "ZOOM C generated: Present response and no records");
1399 ZOOM_record_cache_add(resultset, myrec, *start,
1400 syntax, elementSetName, schema, 0);
1405 static void handle_Z3950_present_response(ZOOM_connection c,
1406 Z_PresentResponse *pr)
1408 handle_Z3950_records(c, pr->records, 1);
1411 static void set_init_option(const char *name, void *clientData)
1413 ZOOM_connection c = (ZOOM_connection) clientData;
1416 sprintf(buf, "init_opt_%.70s", name);
1417 ZOOM_connection_option_set(c, buf, "1");
1421 zoom_ret send_Z3950_sort(ZOOM_connection c, ZOOM_resultset resultset)
1424 resultset->r_sort_spec = 0;
1425 if (resultset->r_sort_spec)
1427 Z_APDU *apdu = zget_APDU(c->odr_out, Z_APDU_sortRequest);
1428 Z_SortRequest *req = apdu->u.sortRequest;
1430 req->num_inputResultSetNames = 1;
1431 req->inputResultSetNames = (Z_InternationalString **)
1432 odr_malloc(c->odr_out, sizeof(*req->inputResultSetNames));
1433 req->inputResultSetNames[0] =
1434 odr_strdup(c->odr_out, resultset->setname);
1435 req->sortedResultSetName = odr_strdup(c->odr_out, resultset->setname);
1436 req->sortSequence = resultset->r_sort_spec;
1437 resultset->r_sort_spec = 0;
1438 return send_APDU(c, apdu);
1440 return zoom_complete;
1443 zoom_ret send_Z3950_present(ZOOM_connection c)
1446 Z_PresentRequest *req = 0;
1448 const char *syntax = 0;
1449 const char *elementSetName = 0;
1450 const char *schema = 0;
1451 ZOOM_resultset resultset;
1456 yaz_log(c->log_details, "%p send_present no tasks", c);
1457 return zoom_complete;
1460 switch (c->tasks->which)
1462 case ZOOM_TASK_SEARCH:
1463 resultset = c->tasks->u.search.resultset;
1464 start = &c->tasks->u.search.start;
1465 count = &c->tasks->u.search.count;
1466 syntax = c->tasks->u.search.syntax;
1467 elementSetName = c->tasks->u.search.elementSetName;
1468 schema = c->tasks->u.search.schema;
1470 case ZOOM_TASK_RETRIEVE:
1471 resultset = c->tasks->u.retrieve.resultset;
1472 start = &c->tasks->u.retrieve.start;
1473 count = &c->tasks->u.retrieve.count;
1474 syntax = c->tasks->u.retrieve.syntax;
1475 elementSetName = c->tasks->u.retrieve.elementSetName;
1476 schema = c->tasks->u.retrieve.schema;
1479 return zoom_complete;
1481 yaz_log(c->log_details, "%p send_present start=%d count=%d",
1484 if (*start < 0 || *count < 0 || *start + *count > resultset->size)
1486 ZOOM_set_dset_error(c, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, "Bib-1",
1489 if (c->error) /* don't continue on error */
1490 return zoom_complete;
1491 yaz_log(c->log_details, "send_present resultset=%p start=%d count=%d",
1492 resultset, *start, *count);
1494 for (i = 0; i < *count; i++)
1497 ZOOM_record_cache_lookup(resultset, i + *start,
1498 syntax, elementSetName, schema);
1503 ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_RECV_RECORD);
1504 ZOOM_connection_put_event(c, event);
1512 yaz_log(c->log_details, "%p send_present skip=%d no more to fetch", c, i);
1513 return zoom_complete;
1516 apdu = zget_APDU(c->odr_out, Z_APDU_presentRequest);
1517 req = apdu->u.presentRequest;
1520 yaz_log(c->log_details, "%p send_present skip=%d", c, i);
1522 *req->resultSetStartPoint = *start + 1;
1524 if (resultset->step > 0 && resultset->step < *count)
1525 *req->numberOfRecordsRequested = resultset->step;
1527 *req->numberOfRecordsRequested = *count;
1529 if (*req->numberOfRecordsRequested + *start > resultset->size)
1530 *req->numberOfRecordsRequested = resultset->size - *start;
1531 assert(*req->numberOfRecordsRequested > 0);
1533 if (syntax && *syntax)
1534 req->preferredRecordSyntax =
1535 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
1537 if (schema && *schema)
1539 Z_RecordComposition *compo = (Z_RecordComposition *)
1540 odr_malloc(c->odr_out, sizeof(*compo));
1542 req->recordComposition = compo;
1543 compo->which = Z_RecordComp_complex;
1544 compo->u.complex = (Z_CompSpec *)
1545 odr_malloc(c->odr_out, sizeof(*compo->u.complex));
1546 compo->u.complex->selectAlternativeSyntax = (bool_t *)
1547 odr_malloc(c->odr_out, sizeof(bool_t));
1548 *compo->u.complex->selectAlternativeSyntax = 0;
1550 compo->u.complex->generic = (Z_Specification *)
1551 odr_malloc(c->odr_out, sizeof(*compo->u.complex->generic));
1553 compo->u.complex->generic->which = Z_Schema_oid;
1554 compo->u.complex->generic->schema.oid = (Odr_oid *)
1555 zoom_yaz_str_to_z3950oid(c, CLASS_SCHEMA, schema);
1557 if (!compo->u.complex->generic->schema.oid)
1559 /* OID wasn't a schema! Try record syntax instead. */
1561 compo->u.complex->generic->schema.oid = (Odr_oid *)
1562 zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, schema);
1564 if (elementSetName && *elementSetName)
1566 compo->u.complex->generic->elementSpec = (Z_ElementSpec *)
1567 odr_malloc(c->odr_out, sizeof(Z_ElementSpec));
1568 compo->u.complex->generic->elementSpec->which =
1569 Z_ElementSpec_elementSetName;
1570 compo->u.complex->generic->elementSpec->u.elementSetName =
1571 odr_strdup(c->odr_out, elementSetName);
1574 compo->u.complex->generic->elementSpec = 0;
1575 compo->u.complex->num_dbSpecific = 0;
1576 compo->u.complex->dbSpecific = 0;
1577 compo->u.complex->num_recordSyntax = 0;
1578 compo->u.complex->recordSyntax = 0;
1580 else if (elementSetName && *elementSetName)
1582 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1583 odr_malloc(c->odr_out, sizeof(*esn));
1584 Z_RecordComposition *compo = (Z_RecordComposition *)
1585 odr_malloc(c->odr_out, sizeof(*compo));
1587 esn->which = Z_ElementSetNames_generic;
1588 esn->u.generic = odr_strdup(c->odr_out, elementSetName);
1589 compo->which = Z_RecordComp_simple;
1590 compo->u.simple = esn;
1591 req->recordComposition = compo;
1593 req->resultSetId = odr_strdup(c->odr_out, resultset->setname);
1594 return send_APDU(c, apdu);
1597 static zoom_ret send_Z3950_sort_present(ZOOM_connection c)
1599 zoom_ret r = zoom_complete;
1601 if (c->tasks && c->tasks->which == ZOOM_TASK_SEARCH)
1602 r = send_Z3950_sort(c, c->tasks->u.search.resultset);
1603 if (r == zoom_complete)
1604 r = send_Z3950_present(c);
1608 void ZOOM_handle_Z3950_apdu(ZOOM_connection c, Z_APDU *apdu)
1610 Z_InitResponse *initrs;
1612 ZOOM_connection_set_mask(c, 0);
1613 yaz_log(c->log_details, "%p handle_Z3950_apdu apdu->which=%d",
1615 switch (apdu->which)
1617 case Z_APDU_initResponse:
1618 yaz_log(c->log_api, "%p handle_Z3950_apdu: Received Init response", c);
1619 initrs = apdu->u.initResponse;
1620 ZOOM_connection_option_set(c, "serverImplementationId",
1621 initrs->implementationId ?
1622 initrs->implementationId : "");
1623 ZOOM_connection_option_set(c, "serverImplementationName",
1624 initrs->implementationName ?
1625 initrs->implementationName : "");
1626 ZOOM_connection_option_set(c, "serverImplementationVersion",
1627 initrs->implementationVersion ?
1628 initrs->implementationVersion : "");
1629 /* Set the three old options too, for old applications */
1630 ZOOM_connection_option_set(c, "targetImplementationId",
1631 initrs->implementationId ?
1632 initrs->implementationId : "");
1633 ZOOM_connection_option_set(c, "targetImplementationName",
1634 initrs->implementationName ?
1635 initrs->implementationName : "");
1636 ZOOM_connection_option_set(c, "targetImplementationVersion",
1637 initrs->implementationVersion ?
1638 initrs->implementationVersion : "");
1640 /* Make initrs->options available as ZOOM-level options */
1641 yaz_init_opt_decode(initrs->options, set_init_option, (void*) c);
1643 if (!*initrs->result)
1645 Z_DefaultDiagFormat *df = yaz_decode_init_diag(0, initrs);
1647 response_default_diag(c, df);
1649 ZOOM_set_error(c, ZOOM_ERROR_INIT, 0); /* default error */
1654 yaz_oi_get_string_oid(&apdu->u.initResponse->otherInfo,
1655 yaz_oid_userinfo_cookie, 1, 0);
1656 xfree(c->cookie_in);
1659 c->cookie_in = xstrdup(cookie);
1660 if (ODR_MASK_GET(initrs->options, Z_Options_namedResultSets) &&
1661 ODR_MASK_GET(initrs->protocolVersion, Z_ProtocolVersion_3))
1662 c->support_named_resultsets = 1;
1665 assert(c->tasks->which == ZOOM_TASK_CONNECT);
1666 ZOOM_connection_remove_task(c);
1668 ZOOM_connection_exec_task(c);
1670 if (ODR_MASK_GET(initrs->options, Z_Options_negotiationModel))
1672 NMEM tmpmem = nmem_create();
1673 Z_CharSetandLanguageNegotiation *p =
1674 yaz_get_charneg_record(initrs->otherInfo);
1678 char *charset = NULL, *lang = NULL;
1681 yaz_get_response_charneg(tmpmem, p, &charset, &lang, &sel);
1682 yaz_log(c->log_details, "%p handle_Z3950_apdu target accepted: "
1683 "charset %s, language %s, select %d",
1685 charset ? charset : "none", lang ? lang : "none", sel);
1687 ZOOM_connection_option_set(c, "negotiation-charset",
1690 ZOOM_connection_option_set(c, "negotiation-lang",
1693 ZOOM_connection_option_set(
1694 c, "negotiation-charset-in-effect-for-records",
1695 (sel != 0) ? "1" : "0");
1696 nmem_destroy(tmpmem);
1700 case Z_APDU_searchResponse:
1701 yaz_log(c->log_api, "%p handle_Z3950_apdu Search response", c);
1702 handle_Z3950_search_response(c, apdu->u.searchResponse);
1703 if (send_Z3950_sort_present(c) == zoom_complete)
1704 ZOOM_connection_remove_task(c);
1706 case Z_APDU_presentResponse:
1707 yaz_log(c->log_api, "%p handle_Z3950_apdu Present response", c);
1708 handle_Z3950_present_response(c, apdu->u.presentResponse);
1709 if (send_Z3950_present(c) == zoom_complete)
1710 ZOOM_connection_remove_task(c);
1712 case Z_APDU_sortResponse:
1713 yaz_log(c->log_api, "%p handle_Z3950_apdu Sort response", c);
1714 handle_Z3950_sort_response(c, apdu->u.sortResponse);
1715 if (send_Z3950_present(c) == zoom_complete)
1716 ZOOM_connection_remove_task(c);
1718 case Z_APDU_scanResponse:
1719 yaz_log(c->log_api, "%p handle_Z3950_apdu Scan response", c);
1720 handle_Z3950_scan_response(c, apdu->u.scanResponse);
1721 ZOOM_connection_remove_task(c);
1723 case Z_APDU_extendedServicesResponse:
1724 yaz_log(c->log_api, "%p handle_Z3950_apdu Extended Services response", c);
1725 handle_Z3950_es_response(c, apdu->u.extendedServicesResponse);
1726 ZOOM_connection_remove_task(c);
1729 yaz_log(c->log_api, "%p handle_Z3950_apdu Close PDU", c);
1730 if (!ZOOM_test_reconnect(c))
1732 ZOOM_set_dset_error(c, ZOOM_ERROR_CONNECTION_LOST, "ZOOM", c->host_port, apdu->u.close->diagnosticInformation);
1733 ZOOM_connection_close(c);
1737 yaz_log(c->log_api, "%p Received unknown PDU", c);
1738 ZOOM_set_error(c, ZOOM_ERROR_DECODE, 0);
1739 ZOOM_connection_close(c);
1746 * c-file-style: "Stroustrup"
1747 * indent-tabs-mode: nil
1749 * vim: shiftwidth=4 tabstop=8 expandtab