1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) Index Data
3 * See the file LICENSE for details.
7 * \brief Implements SRW/SRU package encoding and decoding
16 #include <yaz/wrbuf.h>
18 #include <libxml/parser.h>
19 #include <libxml/tree.h>
21 #include <yaz/facet.h>
22 #include <yaz/proto.h>
25 char *yaz_negotiate_sru_version(char *input_ver)
29 if (!strcmp(input_ver, "1.1"))
31 if (!strncmp(input_ver, "1.", 2))
33 if (!strncmp(input_ver, "2.", 2))
38 static int yaz_srw_record(ODR o, xmlNodePtr pptr, Z_SRW_record *rec,
39 Z_SRW_extra_record **extra,
40 void *client_data, int version2)
42 if (o->direction == ODR_DECODE)
44 Z_SRW_extra_record ex;
51 rec->recordSchema = 0;
52 rec->recordData_buf = 0;
53 rec->recordData_len = 0;
54 rec->recordPosition = 0;
57 ex.extraRecordData_buf = 0;
58 ex.extraRecordData_len = 0;
59 ex.recordIdentifier = 0;
61 for (ptr = pptr->children; ptr; ptr = ptr->next)
64 if (yaz_match_xsd_string(ptr, "recordSchema", o,
67 else if (yaz_match_xsd_string(ptr, "recordPacking", o, &spack))
68 ; /* can't rely on it: in SRU 2.0 it's different semantics */
69 else if (yaz_match_xsd_integer(ptr, "recordPosition", o,
70 &rec->recordPosition))
72 else if (yaz_match_xsd_element(ptr, "recordData"))
74 /* we assume XML packing, if any element nodes exist below
75 recordData. Unfortunately, in SRU 2.0 recordPacking
76 means something different */
77 xmlNode *p = ptr->children;
78 for (; p; p = p->next)
79 if (p->type == XML_ELEMENT_NODE)
85 &rec->recordData_buf, &rec->recordData_len, 1);
86 rec->recordPacking = Z_SRW_recordPacking_XML;
90 yaz_match_xsd_string_n(
92 &rec->recordData_buf, &rec->recordData_len);
93 rec->recordPacking = Z_SRW_recordPacking_string;
96 else if (yaz_match_xsd_XML_n(ptr, "extraRecordData", o,
97 &ex.extraRecordData_buf,
98 &ex.extraRecordData_len) )
101 yaz_match_xsd_string(ptr, "recordIdentifier", o,
102 &ex.recordIdentifier);
104 if (ex.extraRecordData_buf || ex.recordIdentifier)
106 *extra = (Z_SRW_extra_record *)
107 odr_malloc(o, sizeof(Z_SRW_extra_record));
108 memcpy(*extra, &ex, sizeof(Z_SRW_extra_record));
111 else if (o->direction == ODR_ENCODE)
113 xmlNodePtr ptr = pptr;
114 int pack = rec->recordPacking;
115 const char *spack = yaz_srw_pack_to_str(pack);
117 /* recordSchema and recordData are required */
118 if (!rec->recordSchema)
119 xmlNewChild(ptr, 0, BAD_CAST "recordSchema", 0);
121 add_xsd_string(ptr, "recordSchema", rec->recordSchema);
125 add_xsd_string(ptr, "recordXMLEscaping", spack);
127 add_xsd_string(ptr, "recordPacking", spack);
129 if (!rec->recordData_buf)
130 xmlNewChild(ptr, 0, BAD_CAST "recordData", 0);
135 case Z_SRW_recordPacking_string:
136 add_xsd_string_n(ptr, "recordData", rec->recordData_buf,
137 rec->recordData_len);
139 case Z_SRW_recordPacking_XML:
140 add_XML_n(ptr, "recordData", rec->recordData_buf,
141 rec->recordData_len, 0);
143 case Z_SRW_recordPacking_URL:
144 add_xsd_string_n(ptr, "recordData", rec->recordData_buf,
145 rec->recordData_len);
149 if (rec->recordPosition)
150 add_xsd_integer(ptr, "recordPosition", rec->recordPosition );
153 if ((*extra)->recordIdentifier)
154 add_xsd_string(ptr, "recordIdentifier",
155 (*extra)->recordIdentifier);
156 if ((*extra)->extraRecordData_buf)
157 add_XML_n(ptr, "extraRecordData",
158 (*extra)->extraRecordData_buf,
159 (*extra)->extraRecordData_len, 0);
165 static int yaz_srw_records(ODR o, xmlNodePtr pptr, Z_SRW_record **recs,
166 Z_SRW_extra_record ***extra,
167 int *num, void *client_data, int version2)
169 if (o->direction == ODR_DECODE)
174 for (ptr = pptr->children; ptr; ptr = ptr->next)
176 if (ptr->type == XML_ELEMENT_NODE &&
177 !xmlStrcmp(ptr->name, BAD_CAST "record"))
182 *recs = (Z_SRW_record *) odr_malloc(o, *num * sizeof(**recs));
183 *extra = (Z_SRW_extra_record **) odr_malloc(o, *num * sizeof(**extra));
184 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next)
186 if (ptr->type == XML_ELEMENT_NODE &&
187 !xmlStrcmp(ptr->name, BAD_CAST "record"))
189 yaz_srw_record(o, ptr, *recs + i, *extra + i, client_data, 0);
194 else if (o->direction == ODR_ENCODE)
197 for (i = 0; i < *num; i++)
199 xmlNodePtr rptr = xmlNewChild(pptr, 0, BAD_CAST "record",
201 yaz_srw_record(o, rptr, (*recs)+i, (*extra ? *extra + i : 0),
202 client_data, version2);
208 static int yaz_srw_version(ODR o, xmlNodePtr pptr, Z_SRW_recordVersion *rec,
209 void *client_data, const char *ns)
211 if (o->direction == ODR_DECODE)
214 rec->versionType = 0;
215 rec->versionValue = 0;
216 for (ptr = pptr->children; ptr; ptr = ptr->next)
219 if (yaz_match_xsd_string(ptr, "versionType", o,
223 yaz_match_xsd_string(ptr, "versionValue", o,
227 else if (o->direction == ODR_ENCODE)
229 xmlNodePtr ptr = pptr;
230 add_xsd_string(ptr, "versionType", rec->versionType);
231 add_xsd_string(ptr, "versionValue", rec->versionValue);
236 static int yaz_srw_versions(ODR o, xmlNodePtr pptr,
237 Z_SRW_recordVersion **vers,
238 int *num, void *client_data, const char *ns)
240 if (o->direction == ODR_DECODE)
245 for (ptr = pptr->children; ptr; ptr = ptr->next)
247 if (ptr->type == XML_ELEMENT_NODE &&
248 !xmlStrcmp(ptr->name, BAD_CAST "recordVersion"))
253 *vers = (Z_SRW_recordVersion *) odr_malloc(o, *num * sizeof(**vers));
254 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next)
256 if (ptr->type == XML_ELEMENT_NODE &&
257 !xmlStrcmp(ptr->name, BAD_CAST "recordVersion"))
259 yaz_srw_version(o, ptr, *vers + i, client_data, ns);
264 else if (o->direction == ODR_ENCODE)
267 for (i = 0; i < *num; i++)
269 xmlNodePtr rptr = xmlNewChild(pptr, 0, BAD_CAST "version",
271 yaz_srw_version(o, rptr, (*vers)+i, client_data, ns);
277 Z_FacetTerm *yaz_sru_proxy_get_facet_term_count(ODR odr, xmlNodePtr node)
281 WRBUF wrbuf = wrbuf_alloc();
282 Z_FacetTerm *facet_term;
283 const char *freq_string = yaz_element_attribute_value_get(
284 node, "facetvalue", "est_representation");
286 freq = odr_atoi(freq_string);
290 for (child = node->children; child ; child = child->next)
292 if (child->type == XML_TEXT_NODE)
293 wrbuf_puts(wrbuf, (const char *) child->content);
295 facet_term = facet_term_create_cstr(odr, wrbuf_cstr(wrbuf), freq);
296 wrbuf_destroy(wrbuf);
300 static Z_FacetField *yaz_sru_proxy_decode_facet_field(ODR odr, xmlNodePtr ptr)
302 Z_AttributeList *list;
303 Z_FacetField *facet_field;
308 const char* name = yaz_element_attribute_value_get(ptr, "facet", "code");
309 yaz_log(YLOG_DEBUG, "sru-proxy facet type: %s", name);
311 list = zget_AttributeList_use_string(odr, name);
312 for (node = ptr->children; node; node = node->next) {
313 if (yaz_match_xsd_element(node, "facetvalue"))
316 facet_field = facet_field_create(odr, list, num_terms);
318 for (node = ptr->children; node; node = node->next)
320 if (yaz_match_xsd_element(node, "facetvalue"))
322 facet_field_term_set(odr, facet_field,
323 yaz_sru_proxy_get_facet_term_count(odr, node),
331 static int yaz_sru_proxy_decode_facets(ODR o, xmlNodePtr root,
332 Z_FacetList **facetList)
336 for (ptr = root->children; ptr; ptr = ptr->next)
338 if (yaz_match_xsd_element(ptr, "facets"))
341 Z_FacetList *facet_list;
343 for (node = ptr->children; node; node= node->next)
345 if (node->type == XML_ELEMENT_NODE)
348 facet_list = facet_list_create(o, num_facets);
350 for (node = ptr->children; node; node= node->next)
352 if (yaz_match_xsd_element(node, "facet"))
354 facet_list_field_set(
356 yaz_sru_proxy_decode_facet_field(o, node), num_facets);
360 *facetList = facet_list;
369 static int yaz_srw_decode_diagnostics(ODR o, xmlNodePtr pptr,
370 Z_SRW_diagnostic **recs, int *num,
371 void *client_data, const char *ns)
376 for (ptr = pptr; ptr; ptr = ptr->next)
378 if (ptr->type == XML_ELEMENT_NODE &&
379 !xmlStrcmp(ptr->name, BAD_CAST "diagnostic"))
384 *recs = (Z_SRW_diagnostic *) odr_malloc(o, *num * sizeof(**recs));
385 for (i = 0; i < *num; i++)
388 (*recs)[i].details = 0;
389 (*recs)[i].message = 0;
391 for (i = 0, ptr = pptr; ptr; ptr = ptr->next)
393 if (ptr->type == XML_ELEMENT_NODE &&
394 !xmlStrcmp(ptr->name, BAD_CAST "diagnostic"))
398 (*recs)[i].details = 0;
399 (*recs)[i].message = 0;
400 for (rptr = ptr->children; rptr; rptr = rptr->next)
402 if (yaz_match_xsd_string(rptr, "uri", o, &(*recs)[i].uri))
404 else if (yaz_match_xsd_string(rptr, "details", o,
405 &(*recs)[i].details))
408 yaz_match_xsd_string(rptr, "message", o,
409 &(*recs)[i].message);
417 int sru_decode_surrogate_diagnostics(const char *buf, size_t len,
418 Z_SRW_diagnostic **diag,
422 xmlDocPtr doc = xmlParseMemory(buf, len);
425 xmlNodePtr ptr = xmlDocGetRootElement(doc);
426 while (ptr && ptr->type != XML_ELEMENT_NODE)
429 && !xmlStrcmp(ptr->ns->href,
430 BAD_CAST "http://www.loc.gov/zing/srw/diagnostic/"))
432 ret = yaz_srw_decode_diagnostics(odr, ptr, diag, num, 0, 0);
439 static int yaz_srw_diagnostics(ODR o, xmlNodePtr pptr, Z_SRW_diagnostic **recs,
440 int *num, void *client_data, const char *ns,
443 if (o->direction == ODR_DECODE)
445 return yaz_srw_decode_diagnostics(o, pptr->children, recs, num, client_data, ns);
447 else if (o->direction == ODR_ENCODE)
451 xmlNewNs(pptr, BAD_CAST (version2 ?
452 YAZ_XMLNS_DIAG_v2 : YAZ_XMLNS_DIAG_v1_1),
454 for (i = 0; i < *num; i++)
456 const char *std_diag = "info:srw/diagnostic/1/";
457 const char *ucp_diag = "info:srw/diagnostic/12/";
458 xmlNodePtr rptr = xmlNewChild(pptr, ns_diag,
459 BAD_CAST "diagnostic", 0);
460 add_xsd_string(rptr, "uri", (*recs)[i].uri);
461 add_xsd_string(rptr, "details", (*recs)[i].details);
462 if ((*recs)[i].message)
463 add_xsd_string(rptr, "message", (*recs)[i].message);
464 else if ((*recs)[i].uri )
466 if (!strncmp((*recs)[i].uri, std_diag, strlen(std_diag)))
468 int no = atoi((*recs)[i].uri + strlen(std_diag));
469 const char *message = yaz_diag_srw_str(no);
471 add_xsd_string(rptr, "message", message);
473 else if (!strncmp((*recs)[i].uri, ucp_diag, strlen(ucp_diag)))
475 int no = atoi((*recs)[i].uri + strlen(ucp_diag));
476 const char *message = yaz_diag_sru_update_str(no);
478 add_xsd_string(rptr, "message", message);
486 static int yaz_srw_term(ODR o, xmlNodePtr pptr, Z_SRW_scanTerm *term,
487 void *client_data, const char *ns)
489 if (o->direction == ODR_DECODE)
493 term->numberOfRecords = 0;
494 term->displayTerm = 0;
495 term->whereInList = 0;
496 for (ptr = pptr->children; ptr; ptr = ptr->next)
498 if (yaz_match_xsd_string(ptr, "value", o, &term->value))
500 else if (yaz_match_xsd_integer(ptr, "numberOfRecords", o,
501 &term->numberOfRecords))
503 else if (yaz_match_xsd_string(ptr, "displayTerm", o,
507 yaz_match_xsd_string(ptr, "whereInList", o, &term->whereInList);
510 else if (o->direction == ODR_ENCODE)
512 xmlNodePtr ptr = pptr;
513 add_xsd_string(ptr, "value", term->value);
514 add_xsd_integer(ptr, "numberOfRecords", term->numberOfRecords);
515 add_xsd_string(ptr, "displayTerm", term->displayTerm);
516 add_xsd_string(ptr, "whereInList", term->whereInList);
521 static int yaz_srw_terms(ODR o, xmlNodePtr pptr, Z_SRW_scanTerm **terms,
522 int *num, void *client_data, const char *ns)
524 if (o->direction == ODR_DECODE)
529 for (ptr = pptr->children; ptr; ptr = ptr->next)
531 if (ptr->type == XML_ELEMENT_NODE &&
532 !xmlStrcmp(ptr->name, BAD_CAST "term"))
537 *terms = (Z_SRW_scanTerm *) odr_malloc(o, *num * sizeof(**terms));
538 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next, i++)
540 if (ptr->type == XML_ELEMENT_NODE &&
541 !xmlStrcmp(ptr->name, BAD_CAST "term"))
542 yaz_srw_term(o, ptr, (*terms)+i, client_data, ns);
545 else if (o->direction == ODR_ENCODE)
548 for (i = 0; i < *num; i++)
550 xmlNodePtr rptr = xmlNewChild(pptr, 0, BAD_CAST "term", 0);
551 yaz_srw_term(o, rptr, (*terms)+i, client_data, ns);
557 static void encode_echoed_args(xmlNodePtr ptr, Z_SRW_PDU *p, const char *name)
559 Z_SRW_extra_arg *ea = p->extra_args;
562 xmlNode *p1 = xmlNewChild(ptr, 0, BAD_CAST name, 0);
564 for (; ea; ea = ea->next)
566 if (ea->name && ea->name[0] == 'x' && ea->name[1] == '-')
568 /* not really according to XSD as of July 2014 */
570 p2 = xmlNewChild(p1, 0,
571 BAD_CAST "extraRequestData", 0);
572 /* skip +2: "x-" in element */
573 add_xsd_string(p2, ea->name + 2, ea->value);
576 add_xsd_string(p1, ea->name, ea->value);
581 int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
582 void *client_data, const char *ns)
584 xmlNodePtr pptr = (xmlNodePtr) vptr;
585 if (o->direction == ODR_DECODE)
587 Z_SRW_PDU **p = handler_data;
588 xmlNodePtr method = pptr->children;
591 while (method && method->type == XML_TEXT_NODE)
592 method = method->next;
596 if (method->type != XML_ELEMENT_NODE)
599 *p = yaz_srw_get_core_v_2_0(o);
601 if (!xmlStrcmp(method->name, BAD_CAST "searchRetrieveRequest"))
603 xmlNodePtr ptr = method->children;
604 Z_SRW_searchRetrieveRequest *req;
605 char *recordPacking = 0;
606 char *recordXMLEscaping = 0;
607 const char *facetLimit = 0;
608 const char *facetStart = 0;
609 const char *facetSort = 0;
611 (*p)->which = Z_SRW_searchRetrieve_request;
612 req = (*p)->u.request = (Z_SRW_searchRetrieveRequest *)
613 odr_malloc(o, sizeof(*req));
614 req->queryType = "cql";
616 req->sort_type = Z_SRW_sort_type_none;
618 req->startRecord = 0;
619 req->maximumRecords = 0;
620 req->recordSchema = 0;
621 req->recordPacking = 0;
623 req->recordXPath = 0;
624 req->resultSetTTL = 0;
628 for (; ptr; ptr = ptr->next)
630 if (yaz_match_xsd_string(ptr, "version", o,
633 else if (yaz_match_xsd_string(ptr, "queryType", o,
636 else if (yaz_match_xsd_string(ptr, "query", o,
639 else if (yaz_match_xsd_string(ptr, "pQuery", o,
641 req->queryType = "pqf";
642 else if (yaz_match_xsd_string(ptr, "xQuery", o,
644 req->queryType = "xcql";
645 else if (yaz_match_xsd_integer(ptr, "startRecord", o,
648 else if (yaz_match_xsd_integer(ptr, "maximumRecords", o,
649 &req->maximumRecords))
651 else if (yaz_match_xsd_string(ptr, "recordPacking", o,
654 else if (yaz_match_xsd_string(ptr, "recordXMLEscaping", o,
657 else if (yaz_match_xsd_string(ptr, "recordSchema", o,
660 else if (yaz_match_xsd_string(ptr, "recordXPath", o,
663 else if (yaz_match_xsd_integer(ptr, "resultSetTTL", o,
666 else if (yaz_match_xsd_string(ptr, "sortKeys", o,
667 &req->sort.sortKeys))
668 req->sort_type = Z_SRW_sort_type_sort;
669 else if (yaz_match_xsd_string(ptr, "stylesheet", o,
672 else if (yaz_match_xsd_string(ptr, "database", o,
675 else if (yaz_match_xsd_string(ptr, "facetLimit", o,
676 (char**) &facetLimit))
678 else if (yaz_match_xsd_string(ptr, "facetStart", o,
679 (char**) &facetStart))
681 else if (yaz_match_xsd_string(ptr, "facetSort", o,
682 (char**) &facetSort))
689 /* should put proper diagnostic here */
692 if (!strcmp((*p)->srw_version, "2.0"))
694 req->recordPacking = recordXMLEscaping;
695 req->packing = recordPacking;
699 req->recordPacking = recordPacking;
701 yaz_sru_facet_request(o, &req->facetList, &facetLimit, &facetStart,
704 else if (!xmlStrcmp(method->name, BAD_CAST "searchRetrieveResponse"))
706 xmlNodePtr ptr = method->children;
707 Z_SRW_searchRetrieveResponse *res;
709 (*p)->which = Z_SRW_searchRetrieve_response;
710 res = (*p)->u.response = (Z_SRW_searchRetrieveResponse *)
711 odr_malloc(o, sizeof(*res));
713 res->numberOfRecords = 0;
714 res->resultCountPrecision = 0;
715 res->resultSetId = 0;
716 res->resultSetIdleTime = 0;
718 res->num_records = 0;
719 res->diagnostics = 0;
720 res->num_diagnostics = 0;
721 res->nextRecordPosition = 0;
723 res->suggestions = 0;
725 for (; ptr; ptr = ptr->next)
727 if (yaz_match_xsd_string(ptr, "version", o,
730 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
731 &(*p)->extraResponseData_buf,
732 &(*p)->extraResponseData_len))
734 else if (yaz_match_xsd_integer(ptr, "numberOfRecords", o,
735 &res->numberOfRecords))
737 else if (yaz_match_xsd_string(ptr, "resultCountPrecision", o,
738 &res->resultCountPrecision))
740 else if (yaz_match_xsd_string(ptr, "resultSetId", o,
743 else if (yaz_match_xsd_integer(ptr, "resultSetIdleTime", o,
744 &res->resultSetIdleTime))
746 else if (yaz_match_xsd_integer(ptr, "resultSetTTL", o,
747 &res->resultSetIdleTime))
749 else if (yaz_match_xsd_element(ptr, "records"))
750 yaz_srw_records(o, ptr, &res->records,
752 &res->num_records, client_data, 0);
753 else if (yaz_match_xsd_integer(ptr, "nextRecordPosition", o,
754 &res->nextRecordPosition))
756 else if (yaz_match_xsd_element(ptr, "diagnostics"))
757 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
758 &res->num_diagnostics,
760 else if (yaz_match_xsd_element(ptr, "facet_analysis"))
761 yaz_sru_proxy_decode_facets(o, ptr, &res->facetList);
762 else if (yaz_match_xsd_element(ptr, "facetedResults"))
763 yaz_sru_facet_response(o, &res->facetList, ptr);
766 else if (!xmlStrcmp(method->name, BAD_CAST "explainRequest"))
768 Z_SRW_explainRequest *req;
769 xmlNodePtr ptr = method->children;
771 (*p)->which = Z_SRW_explain_request;
772 req = (*p)->u.explain_request = (Z_SRW_explainRequest *)
773 odr_malloc(o, sizeof(*req));
774 req->recordPacking = 0;
778 for (; ptr; ptr = ptr->next)
780 if (yaz_match_xsd_string(ptr, "version", o,
783 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
784 &(*p)->extraResponseData_buf,
785 &(*p)->extraResponseData_len))
787 else if (yaz_match_xsd_string(ptr, "stylesheet", o,
790 else if (yaz_match_xsd_string(ptr, "recordPacking", o,
791 &req->recordPacking))
794 yaz_match_xsd_string(ptr, "database", o, &req->database);
797 else if (!xmlStrcmp(method->name, BAD_CAST "explainResponse"))
799 Z_SRW_explainResponse *res;
800 xmlNodePtr ptr = method->children;
802 (*p)->which = Z_SRW_explain_response;
803 res = (*p)->u.explain_response = (Z_SRW_explainResponse*)
804 odr_malloc(o, sizeof(*res));
805 res->diagnostics = 0;
806 res->num_diagnostics = 0;
807 res->record.recordSchema = 0;
808 res->record.recordData_buf = 0;
809 res->record.recordData_len = 0;
810 res->record.recordPosition = 0;
812 for (; ptr; ptr = ptr->next)
814 if (yaz_match_xsd_string(ptr, "version", o,
817 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
818 &(*p)->extraResponseData_buf,
819 &(*p)->extraResponseData_len))
821 else if (yaz_match_xsd_element(ptr, "record"))
822 yaz_srw_record(o, ptr, &res->record, &res->extra_record,
824 else if (yaz_match_xsd_element(ptr, "diagnostics"))
825 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
826 &res->num_diagnostics,
831 else if (!xmlStrcmp(method->name, BAD_CAST "scanRequest"))
833 Z_SRW_scanRequest *req;
834 xmlNodePtr ptr = method->children;
836 (*p)->which = Z_SRW_scan_request;
837 req = (*p)->u.scan_request = (Z_SRW_scanRequest *)
838 odr_malloc(o, sizeof(*req));
839 req->queryType = "cql";
841 req->responsePosition = 0;
842 req->maximumTerms = 0;
846 for (; ptr; ptr = ptr->next)
848 if (yaz_match_xsd_string(ptr, "version", o,
851 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
852 &(*p)->extraResponseData_buf,
853 &(*p)->extraResponseData_len))
855 else if (yaz_match_xsd_string(ptr, "scanClause", o,
858 else if (yaz_match_xsd_string(ptr, "pScanClause", o,
861 req->queryType = "pqf";
863 else if (yaz_match_xsd_integer(ptr, "responsePosition", o,
864 &req->responsePosition))
866 else if (yaz_match_xsd_integer(ptr, "maximumTerms", o,
869 else if (yaz_match_xsd_string(ptr, "stylesheet", o,
873 yaz_match_xsd_string(ptr, "database", o, &req->database);
876 else if (!xmlStrcmp(method->name, BAD_CAST "scanResponse"))
878 Z_SRW_scanResponse *res;
879 xmlNodePtr ptr = method->children;
881 (*p)->which = Z_SRW_scan_response;
882 res = (*p)->u.scan_response = (Z_SRW_scanResponse *)
883 odr_malloc(o, sizeof(*res));
886 res->diagnostics = 0;
887 res->num_diagnostics = 0;
889 for (; ptr; ptr = ptr->next)
891 if (yaz_match_xsd_string(ptr, "version", o,
894 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
895 &(*p)->extraResponseData_buf,
896 &(*p)->extraResponseData_len))
898 else if (yaz_match_xsd_element(ptr, "terms"))
899 yaz_srw_terms(o, ptr, &res->terms,
900 &res->num_terms, client_data,
902 else if (yaz_match_xsd_element(ptr, "diagnostics"))
903 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
904 &res->num_diagnostics,
913 neg_version = yaz_negotiate_sru_version((*p)->srw_version);
915 (*p)->srw_version = neg_version;
917 else if (o->direction == ODR_ENCODE)
919 Z_SRW_PDU **p = handler_data;
922 int version2 = !(*p)->srw_version ||
923 strcmp((*p)->srw_version, "2.") > 0;
924 if ((*p)->which == Z_SRW_searchRetrieve_request)
926 Z_SRW_searchRetrieveRequest *req = (*p)->u.request;
927 const char *queryType = req->queryType;
929 ns = "http://docs.oasis-open.org/ns/search-ws/sruRequest";
930 ptr = xmlNewChild(pptr, 0, BAD_CAST "searchRetrieveRequest", 0);
931 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
932 xmlSetNs(ptr, ns_srw);
935 add_xsd_string(ptr, "version", (*p)->srw_version);
938 add_xsd_string(ptr, "query", req->query);
942 if (!queryType || !strcmp(queryType, "cql"))
943 add_xsd_string(ptr, "query", req->query);
944 else if (!strcmp(queryType, "xcql"))
945 add_xsd_string(ptr, "xQuery", req->query);
946 else if (!strcmp(queryType, "pqf"))
947 add_xsd_string(ptr, "pQuery", req->query);
950 add_xsd_integer(ptr, "startRecord", req->startRecord);
951 add_xsd_integer(ptr, "maximumRecords", req->maximumRecords);
953 add_xsd_string(ptr, "recordXMLEscaping", req->recordPacking);
955 add_xsd_string(ptr, "recordPacking", req->recordPacking);
956 add_xsd_string(ptr, "recordSchema", req->recordSchema);
957 add_xsd_string(ptr, "recordXPath", req->recordXPath);
958 add_xsd_integer(ptr, "resultSetTTL", req->resultSetTTL);
959 add_xsd_string(ptr, "stylesheet", req->stylesheet);
960 add_xsd_string(ptr, "queryType", queryType);
961 switch (req->sort_type)
963 case Z_SRW_sort_type_none:
965 case Z_SRW_sort_type_sort:
966 add_xsd_string(ptr, "sortKeys", req->sort.sortKeys);
968 case Z_SRW_sort_type_xSort:
969 add_xsd_string(ptr, "xSortKeys", req->sort.xSortKeys);
972 /* still unsupported are: renderedBy, httpAccept, responseType */
973 add_xsd_string(ptr, "database", req->database);
975 add_xsd_string(ptr, "recordPacking", req->packing);
977 const char *limit = 0;
978 const char *start = 0;
979 const char *sort = 0;
980 yaz_sru_facet_request(o, &req->facetList, &limit, &start,
982 add_xsd_string(ptr, "facetLimit", limit);
983 add_xsd_string(ptr, "facetStart", start);
984 add_xsd_string(ptr, "facetSort", sort);
987 else if ((*p)->which == Z_SRW_searchRetrieve_response)
989 Z_SRW_searchRetrieveResponse *res = (*p)->u.response;
991 ns = "http://docs.oasis-open.org/ns/search-ws/sruResponse";
992 ptr = xmlNewChild(pptr, 0, BAD_CAST "searchRetrieveResponse", 0);
993 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
994 xmlSetNs(ptr, ns_srw);
997 add_xsd_string(ptr, "version", (*p)->srw_version);
998 add_xsd_integer(ptr, "numberOfRecords", res->numberOfRecords);
999 add_xsd_string(ptr, "resultSetId", res->resultSetId);
1001 add_xsd_integer(ptr, "resultSetIdleTime",
1002 res->resultSetIdleTime);
1003 if (res->num_records)
1005 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "records", 0);
1006 yaz_srw_records(o, rptr, &res->records, &res->extra_records,
1008 client_data, version2);
1010 add_xsd_integer(ptr, "nextRecordPosition",
1011 res->nextRecordPosition);
1012 encode_echoed_args(ptr, *p, "echoedSearchRetrieveRequest");
1013 if (res->num_diagnostics)
1015 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
1017 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1018 &res->num_diagnostics, client_data, ns,
1023 if (ptr && (*p)->extraResponseData_len)
1024 add_XML_n(ptr, "extraResponseData",
1025 (*p)->extraResponseData_buf,
1026 (*p)->extraResponseData_len, ns_srw);
1027 add_xsd_integer(ptr, "resultSetTTL", res->resultSetIdleTime);
1028 add_xsd_string(ptr, "resultCountPrecision",
1029 res->resultCountPrecision);
1030 yaz_sru_facet_response(o, &res->facetList, ptr);
1031 return 0; /* so we don't make extra response data twice */
1034 else if ((*p)->which == Z_SRW_explain_request)
1036 Z_SRW_explainRequest *req = (*p)->u.explain_request;
1038 ns = "http://docs.oasis-open.org/ns/search-ws/sruRequest";
1039 ptr = xmlNewChild(pptr, 0, BAD_CAST "explainRequest", 0);
1040 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1041 xmlSetNs(ptr, ns_srw);
1044 add_xsd_string(ptr, "version", (*p)->srw_version);
1047 add_xsd_string(ptr, "recordXMLEscaping", req->recordPacking);
1048 add_xsd_string(ptr, "recordPacking", req->packing);
1051 add_xsd_string(ptr, "recordPacking", req->recordPacking);
1052 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1053 add_xsd_string(ptr, "database", req->database);
1055 else if ((*p)->which == Z_SRW_explain_response)
1057 Z_SRW_explainResponse *res = (*p)->u.explain_response;
1059 ns = "http://docs.oasis-open.org/ns/search-ws/sruResponse";
1060 ptr = xmlNewChild(pptr, 0, BAD_CAST "explainResponse", 0);
1061 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1062 xmlSetNs(ptr, ns_srw);
1064 add_xsd_string(ptr, "version", (*p)->srw_version);
1067 xmlNodePtr ptr1 = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1068 yaz_srw_record(o, ptr1, &res->record, &res->extra_record,
1069 client_data, version2);
1071 encode_echoed_args(ptr, *p, "echoedExplainRequest");
1072 if (res->num_diagnostics)
1074 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
1076 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1077 &res->num_diagnostics, client_data, ns,
1081 else if ((*p)->which == Z_SRW_scan_request)
1083 Z_SRW_scanRequest *req = (*p)->u.scan_request;
1084 const char *queryType = req->queryType;
1086 ns = "http://docs.oasis-open.org/ns/search-ws/scan";
1087 ptr = xmlNewChild(pptr, 0, BAD_CAST "scanRequest", 0);
1088 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1089 xmlSetNs(ptr, ns_srw);
1092 add_xsd_string(ptr, "version", (*p)->srw_version);
1096 if (queryType && strcmp(queryType, "cql"))
1097 add_xsd_string(ptr, "queryType", queryType);
1098 add_xsd_string(ptr, "scanClause", req->scanClause);
1102 if (!queryType || !strcmp(queryType, "cql"))
1103 add_xsd_string(ptr, "scanClause", req->scanClause);
1104 else if (!strcmp(queryType, "pqf"))
1105 add_xsd_string(ptr, "pScanClause", req->scanClause);
1107 add_xsd_integer(ptr, "responsePosition", req->responsePosition);
1108 add_xsd_integer(ptr, "maximumTerms", req->maximumTerms);
1109 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1110 add_xsd_string(ptr, "database", req->database);
1112 else if ((*p)->which == Z_SRW_scan_response)
1114 Z_SRW_scanResponse *res = (*p)->u.scan_response;
1116 ns = "http://docs.oasis-open.org/ns/search-ws/scan";
1117 ptr = xmlNewChild(pptr, 0, BAD_CAST "scanResponse", 0);
1118 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1119 xmlSetNs(ptr, ns_srw);
1122 add_xsd_string(ptr, "version", (*p)->srw_version);
1125 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "terms", 0);
1126 yaz_srw_terms(o, rptr, &res->terms, &res->num_terms,
1129 if (res->num_diagnostics)
1131 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
1133 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1134 &res->num_diagnostics, client_data, ns,
1140 if (ptr && (*p)->extraResponseData_len)
1141 add_XML_n(ptr, "extraResponseData",
1142 (*p)->extraResponseData_buf,
1143 (*p)->extraResponseData_len, ns_srw);
1150 int yaz_ucp_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
1151 void *client_data, const char *ns_ucp_str)
1153 xmlNodePtr pptr = (xmlNodePtr) vptr;
1154 const char *ns_srw_str = YAZ_XMLNS_SRU_v1_1;
1155 if (o->direction == ODR_DECODE)
1157 Z_SRW_PDU **p = handler_data;
1158 xmlNodePtr method = pptr->children;
1160 while (method && method->type == XML_TEXT_NODE)
1161 method = method->next;
1165 if (method->type != XML_ELEMENT_NODE)
1168 *p = yaz_srw_get_core_v_2_0(o);
1170 if (!xmlStrcmp(method->name, BAD_CAST "updateRequest"))
1172 xmlNodePtr ptr = method->children;
1173 Z_SRW_updateRequest *req;
1176 (*p)->which = Z_SRW_update_request;
1177 req = (*p)->u.update_request = (Z_SRW_updateRequest *)
1178 odr_malloc(o, sizeof(*req));
1182 req->recordVersions = 0;
1183 req->num_recordVersions = 0;
1185 req->extra_record = 0;
1186 req->extraRequestData_buf = 0;
1187 req->extraRequestData_len = 0;
1188 req->stylesheet = 0;
1190 for (; ptr; ptr = ptr->next)
1192 if (yaz_match_xsd_string(ptr, "version", o,
1193 &(*p)->srw_version))
1195 else if (yaz_match_xsd_string(ptr, "action", o,
1199 if (!strcmp(oper, "info:srw/action/1/delete"))
1200 req->operation = "delete";
1201 else if (!strcmp(oper,"info:srw/action/1/replace" ))
1202 req->operation = "replace";
1203 else if (!strcmp(oper, "info:srw/action/1/create"))
1204 req->operation = "insert";
1207 else if (yaz_match_xsd_string(ptr, "recordIdentifier", o,
1210 else if (yaz_match_xsd_element(ptr, "recordVersions" ) )
1211 yaz_srw_versions( o, ptr, &req->recordVersions,
1212 &req->num_recordVersions, client_data,
1214 else if (yaz_match_xsd_element(ptr, "record"))
1216 req->record = yaz_srw_get_record(o);
1217 yaz_srw_record(o, ptr, req->record, &req->extra_record,
1220 else if (yaz_match_xsd_string(ptr, "stylesheet", o,
1224 yaz_match_xsd_string(ptr, "database", o, &req->database);
1227 else if (!xmlStrcmp(method->name, BAD_CAST "updateResponse"))
1229 xmlNodePtr ptr = method->children;
1230 Z_SRW_updateResponse *res;
1232 (*p)->which = Z_SRW_update_response;
1233 res = (*p)->u.update_response = (Z_SRW_updateResponse *)
1234 odr_malloc(o, sizeof(*res));
1236 res->operationStatus = 0;
1238 res->recordVersions = 0;
1239 res->num_recordVersions = 0;
1240 res->diagnostics = 0;
1241 res->num_diagnostics = 0;
1243 res->extra_record = 0;
1244 res->extraResponseData_buf = 0;
1245 res->extraResponseData_len = 0;
1247 for (; ptr; ptr = ptr->next)
1249 if (yaz_match_xsd_string(ptr, "version", o,
1250 &(*p)->srw_version))
1252 else if (yaz_match_xsd_string(ptr, "operationStatus", o,
1253 &res->operationStatus ))
1255 else if (yaz_match_xsd_string(ptr, "recordIdentifier", o,
1258 else if (yaz_match_xsd_element(ptr, "recordVersions" ))
1259 yaz_srw_versions(o, ptr, &res->recordVersions,
1260 &res->num_recordVersions,
1261 client_data, ns_ucp_str);
1262 else if (yaz_match_xsd_element(ptr, "record"))
1264 res->record = yaz_srw_get_record(o);
1265 yaz_srw_record(o, ptr, res->record, &res->extra_record,
1268 else if (yaz_match_xsd_element(ptr, "diagnostics"))
1269 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
1270 &res->num_diagnostics,
1271 client_data, ns_ucp_str, 0);
1274 else if (!xmlStrcmp(method->name, BAD_CAST "explainUpdateRequest"))
1277 else if (!xmlStrcmp(method->name, BAD_CAST "explainUpdateResponse"))
1286 else if (o->direction == ODR_ENCODE)
1288 Z_SRW_PDU **p = handler_data;
1289 xmlNsPtr ns_ucp, ns_srw;
1291 if ((*p)->which == Z_SRW_update_request)
1293 Z_SRW_updateRequest *req = (*p)->u.update_request;
1294 xmlNodePtr ptr = xmlNewChild(pptr, 0, BAD_CAST "updateRequest", 0);
1295 ns_ucp = xmlNewNs(ptr, BAD_CAST ns_ucp_str, BAD_CAST "zu");
1296 xmlSetNs(ptr, ns_ucp);
1297 ns_srw = xmlNewNs(ptr, BAD_CAST ns_srw_str, BAD_CAST "zs");
1299 add_xsd_string_ns(ptr, "version", (*p)->srw_version, ns_srw);
1300 add_xsd_string(ptr, "action", req->operation);
1301 add_xsd_string(ptr, "recordIdentifier", req->recordId );
1302 if (req->recordVersions)
1303 yaz_srw_versions( o, ptr, &req->recordVersions,
1304 &req->num_recordVersions,
1305 client_data, ns_ucp_str);
1306 if (req->record && req->record->recordData_len)
1308 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1309 xmlSetNs(rptr, ns_srw);
1310 yaz_srw_record(o, rptr, req->record, &req->extra_record,
1313 if (req->extraRequestData_len)
1315 add_XML_n(ptr, "extraRequestData",
1316 req->extraRequestData_buf,
1317 req->extraRequestData_len, ns_srw);
1319 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1320 add_xsd_string(ptr, "database", req->database);
1322 else if ((*p)->which == Z_SRW_update_response)
1324 Z_SRW_updateResponse *res = (*p)->u.update_response;
1325 xmlNodePtr ptr = xmlNewChild(pptr, 0, (xmlChar *)
1326 "updateResponse", 0);
1327 ns_ucp = xmlNewNs(ptr, BAD_CAST ns_ucp_str, BAD_CAST "zu");
1328 xmlSetNs(ptr, ns_ucp);
1329 ns_srw = xmlNewNs(ptr, BAD_CAST ns_srw_str, BAD_CAST "zs");
1331 add_xsd_string_ns(ptr, "version", (*p)->srw_version, ns_srw);
1332 add_xsd_string(ptr, "operationStatus", res->operationStatus );
1333 add_xsd_string(ptr, "recordIdentifier", res->recordId );
1334 if (res->recordVersions)
1335 yaz_srw_versions(o, ptr, &res->recordVersions,
1336 &res->num_recordVersions,
1337 client_data, ns_ucp_str);
1338 if (res->record && res->record->recordData_len)
1340 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1341 xmlSetNs(rptr, ns_srw);
1342 yaz_srw_record(o, rptr, res->record, &res->extra_record,
1345 if (res->num_diagnostics)
1348 xmlNewNs(pptr, BAD_CAST YAZ_XMLNS_DIAG_v1_1,
1351 xmlNodePtr rptr = xmlNewChild(ptr, ns_diag, BAD_CAST "diagnostics", 0);
1352 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1353 &res->num_diagnostics, client_data,
1356 if (res->extraResponseData_len)
1357 add_XML_n(ptr, "extraResponseData",
1358 res->extraResponseData_buf,
1359 res->extraResponseData_len, ns_srw);
1373 * c-file-style: "Stroustrup"
1374 * indent-tabs-mode: nil
1376 * vim: shiftwidth=4 tabstop=8 expandtab