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 int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
558 void *client_data, const char *ns)
560 xmlNodePtr pptr = (xmlNodePtr) vptr;
561 if (o->direction == ODR_DECODE)
563 Z_SRW_PDU **p = handler_data;
564 xmlNodePtr method = pptr->children;
567 while (method && method->type == XML_TEXT_NODE)
568 method = method->next;
572 if (method->type != XML_ELEMENT_NODE)
575 *p = yaz_srw_get_core_v_2_0(o);
577 if (!xmlStrcmp(method->name, BAD_CAST "searchRetrieveRequest"))
579 xmlNodePtr ptr = method->children;
580 Z_SRW_searchRetrieveRequest *req;
581 char *recordPacking = 0;
582 char *recordXMLEscaping = 0;
583 const char *facetLimit = 0;
584 const char *facetStart = 0;
585 const char *facetSort = 0;
587 (*p)->which = Z_SRW_searchRetrieve_request;
588 req = (*p)->u.request = (Z_SRW_searchRetrieveRequest *)
589 odr_malloc(o, sizeof(*req));
590 req->queryType = "cql";
592 req->sort_type = Z_SRW_sort_type_none;
594 req->startRecord = 0;
595 req->maximumRecords = 0;
596 req->recordSchema = 0;
597 req->recordPacking = 0;
599 req->recordXPath = 0;
600 req->resultSetTTL = 0;
604 for (; ptr; ptr = ptr->next)
606 if (yaz_match_xsd_string(ptr, "version", o,
609 else if (yaz_match_xsd_string(ptr, "queryType", o,
612 else if (yaz_match_xsd_string(ptr, "query", o,
615 else if (yaz_match_xsd_string(ptr, "pQuery", o,
617 req->queryType = "pqf";
618 else if (yaz_match_xsd_string(ptr, "xQuery", o,
620 req->queryType = "xcql";
621 else if (yaz_match_xsd_integer(ptr, "startRecord", o,
624 else if (yaz_match_xsd_integer(ptr, "maximumRecords", o,
625 &req->maximumRecords))
627 else if (yaz_match_xsd_string(ptr, "recordPacking", o,
630 else if (yaz_match_xsd_string(ptr, "recordXMLEscaping", o,
633 else if (yaz_match_xsd_string(ptr, "recordSchema", o,
636 else if (yaz_match_xsd_string(ptr, "recordXPath", o,
639 else if (yaz_match_xsd_integer(ptr, "resultSetTTL", o,
642 else if (yaz_match_xsd_string(ptr, "sortKeys", o,
643 &req->sort.sortKeys))
644 req->sort_type = Z_SRW_sort_type_sort;
645 else if (yaz_match_xsd_string(ptr, "stylesheet", o,
648 else if (yaz_match_xsd_string(ptr, "database", o,
651 else if (yaz_match_xsd_string(ptr, "facetLimit", o,
652 (char**) &facetLimit))
654 else if (yaz_match_xsd_string(ptr, "facetStart", o,
655 (char**) &facetStart))
657 else if (yaz_match_xsd_string(ptr, "facetSort", o,
658 (char**) &facetSort))
665 /* should put proper diagnostic here */
668 if (!strcmp((*p)->srw_version, "2.0"))
670 req->recordPacking = recordXMLEscaping;
671 req->packing = recordPacking;
675 req->recordPacking = recordPacking;
677 yaz_sru_facet_request(o, &req->facetList, &facetLimit, &facetStart,
680 else if (!xmlStrcmp(method->name, BAD_CAST "searchRetrieveResponse"))
682 xmlNodePtr ptr = method->children;
683 Z_SRW_searchRetrieveResponse *res;
685 (*p)->which = Z_SRW_searchRetrieve_response;
686 res = (*p)->u.response = (Z_SRW_searchRetrieveResponse *)
687 odr_malloc(o, sizeof(*res));
689 res->numberOfRecords = 0;
690 res->resultCountPrecision = 0;
691 res->resultSetId = 0;
692 res->resultSetIdleTime = 0;
694 res->num_records = 0;
695 res->diagnostics = 0;
696 res->num_diagnostics = 0;
697 res->nextRecordPosition = 0;
699 res->suggestions = 0;
701 for (; ptr; ptr = ptr->next)
703 if (yaz_match_xsd_string(ptr, "version", o,
706 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
707 &(*p)->extraResponseData_buf,
708 &(*p)->extraResponseData_len))
710 else if (yaz_match_xsd_integer(ptr, "numberOfRecords", o,
711 &res->numberOfRecords))
713 else if (yaz_match_xsd_string(ptr, "resultCountPrecision", o,
714 &res->resultCountPrecision))
716 else if (yaz_match_xsd_string(ptr, "resultSetId", o,
719 else if (yaz_match_xsd_integer(ptr, "resultSetIdleTime", o,
720 &res->resultSetIdleTime))
722 else if (yaz_match_xsd_integer(ptr, "resultSetTTL", o,
723 &res->resultSetIdleTime))
725 else if (yaz_match_xsd_element(ptr, "records"))
726 yaz_srw_records(o, ptr, &res->records,
728 &res->num_records, client_data, 0);
729 else if (yaz_match_xsd_integer(ptr, "nextRecordPosition", o,
730 &res->nextRecordPosition))
732 else if (yaz_match_xsd_element(ptr, "diagnostics"))
733 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
734 &res->num_diagnostics,
736 else if (yaz_match_xsd_element(ptr, "facet_analysis"))
737 yaz_sru_proxy_decode_facets(o, ptr, &res->facetList);
738 else if (yaz_match_xsd_element(ptr, "facetedResults"))
739 yaz_sru_facet_response(o, &res->facetList, ptr);
742 else if (!xmlStrcmp(method->name, BAD_CAST "explainRequest"))
744 Z_SRW_explainRequest *req;
745 xmlNodePtr ptr = method->children;
747 (*p)->which = Z_SRW_explain_request;
748 req = (*p)->u.explain_request = (Z_SRW_explainRequest *)
749 odr_malloc(o, sizeof(*req));
750 req->recordPacking = 0;
754 for (; ptr; ptr = ptr->next)
756 if (yaz_match_xsd_string(ptr, "version", o,
759 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
760 &(*p)->extraResponseData_buf,
761 &(*p)->extraResponseData_len))
763 else if (yaz_match_xsd_string(ptr, "stylesheet", o,
766 else if (yaz_match_xsd_string(ptr, "recordPacking", o,
767 &req->recordPacking))
770 yaz_match_xsd_string(ptr, "database", o, &req->database);
773 else if (!xmlStrcmp(method->name, BAD_CAST "explainResponse"))
775 Z_SRW_explainResponse *res;
776 xmlNodePtr ptr = method->children;
778 (*p)->which = Z_SRW_explain_response;
779 res = (*p)->u.explain_response = (Z_SRW_explainResponse*)
780 odr_malloc(o, sizeof(*res));
781 res->diagnostics = 0;
782 res->num_diagnostics = 0;
783 res->record.recordSchema = 0;
784 res->record.recordData_buf = 0;
785 res->record.recordData_len = 0;
786 res->record.recordPosition = 0;
788 for (; ptr; ptr = ptr->next)
790 if (yaz_match_xsd_string(ptr, "version", o,
793 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
794 &(*p)->extraResponseData_buf,
795 &(*p)->extraResponseData_len))
797 else if (yaz_match_xsd_element(ptr, "record"))
798 yaz_srw_record(o, ptr, &res->record, &res->extra_record,
800 else if (yaz_match_xsd_element(ptr, "diagnostics"))
801 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
802 &res->num_diagnostics,
807 else if (!xmlStrcmp(method->name, BAD_CAST "scanRequest"))
809 Z_SRW_scanRequest *req;
810 xmlNodePtr ptr = method->children;
812 (*p)->which = Z_SRW_scan_request;
813 req = (*p)->u.scan_request = (Z_SRW_scanRequest *)
814 odr_malloc(o, sizeof(*req));
815 req->queryType = "cql";
817 req->responsePosition = 0;
818 req->maximumTerms = 0;
822 for (; ptr; ptr = ptr->next)
824 if (yaz_match_xsd_string(ptr, "version", o,
827 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
828 &(*p)->extraResponseData_buf,
829 &(*p)->extraResponseData_len))
831 else if (yaz_match_xsd_string(ptr, "scanClause", o,
834 else if (yaz_match_xsd_string(ptr, "pScanClause", o,
837 req->queryType = "pqf";
839 else if (yaz_match_xsd_integer(ptr, "responsePosition", o,
840 &req->responsePosition))
842 else if (yaz_match_xsd_integer(ptr, "maximumTerms", o,
845 else if (yaz_match_xsd_string(ptr, "stylesheet", o,
849 yaz_match_xsd_string(ptr, "database", o, &req->database);
852 else if (!xmlStrcmp(method->name, BAD_CAST "scanResponse"))
854 Z_SRW_scanResponse *res;
855 xmlNodePtr ptr = method->children;
857 (*p)->which = Z_SRW_scan_response;
858 res = (*p)->u.scan_response = (Z_SRW_scanResponse *)
859 odr_malloc(o, sizeof(*res));
862 res->diagnostics = 0;
863 res->num_diagnostics = 0;
865 for (; ptr; ptr = ptr->next)
867 if (yaz_match_xsd_string(ptr, "version", o,
870 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
871 &(*p)->extraResponseData_buf,
872 &(*p)->extraResponseData_len))
874 else if (yaz_match_xsd_element(ptr, "terms"))
875 yaz_srw_terms(o, ptr, &res->terms,
876 &res->num_terms, client_data,
878 else if (yaz_match_xsd_element(ptr, "diagnostics"))
879 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
880 &res->num_diagnostics,
889 neg_version = yaz_negotiate_sru_version((*p)->srw_version);
891 (*p)->srw_version = neg_version;
893 else if (o->direction == ODR_ENCODE)
895 Z_SRW_PDU **p = handler_data;
898 int version2 = !(*p)->srw_version ||
899 strcmp((*p)->srw_version, "2.") > 0;
900 if ((*p)->which == Z_SRW_searchRetrieve_request)
902 Z_SRW_searchRetrieveRequest *req = (*p)->u.request;
903 const char *queryType = req->queryType;
905 ns = "http://docs.oasis-open.org/ns/search-ws/sruRequest";
906 ptr = xmlNewChild(pptr, 0, BAD_CAST "searchRetrieveRequest", 0);
907 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
908 xmlSetNs(ptr, ns_srw);
911 add_xsd_string(ptr, "version", (*p)->srw_version);
914 add_xsd_string(ptr, "query", req->query);
918 if (!queryType || !strcmp(queryType, "cql"))
919 add_xsd_string(ptr, "query", req->query);
920 else if (!strcmp(queryType, "xcql"))
921 add_xsd_string(ptr, "xQuery", req->query);
922 else if (!strcmp(queryType, "pqf"))
923 add_xsd_string(ptr, "pQuery", req->query);
926 add_xsd_integer(ptr, "startRecord", req->startRecord);
927 add_xsd_integer(ptr, "maximumRecords", req->maximumRecords);
929 add_xsd_string(ptr, "recordXMLEscaping", req->recordPacking);
931 add_xsd_string(ptr, "recordPacking", req->recordPacking);
932 add_xsd_string(ptr, "recordSchema", req->recordSchema);
933 add_xsd_string(ptr, "recordXPath", req->recordXPath);
934 add_xsd_integer(ptr, "resultSetTTL", req->resultSetTTL);
935 add_xsd_string(ptr, "stylesheet", req->stylesheet);
936 add_xsd_string(ptr, "queryType", queryType);
937 switch (req->sort_type)
939 case Z_SRW_sort_type_none:
941 case Z_SRW_sort_type_sort:
942 add_xsd_string(ptr, "sortKeys", req->sort.sortKeys);
944 case Z_SRW_sort_type_xSort:
945 add_xsd_string(ptr, "xSortKeys", req->sort.xSortKeys);
948 /* still unsupported are: renderedBy, httpAccept, responseType */
949 add_xsd_string(ptr, "database", req->database);
951 add_xsd_string(ptr, "recordPacking", req->packing);
953 const char *limit = 0;
954 const char *start = 0;
955 const char *sort = 0;
956 yaz_sru_facet_request(o, &req->facetList, &limit, &start,
958 add_xsd_string(ptr, "facetLimit", limit);
959 add_xsd_string(ptr, "facetStart", start);
960 add_xsd_string(ptr, "facetSort", sort);
963 else if ((*p)->which == Z_SRW_searchRetrieve_response)
965 Z_SRW_searchRetrieveResponse *res = (*p)->u.response;
967 ns = "http://docs.oasis-open.org/ns/search-ws/sruResponse";
968 ptr = xmlNewChild(pptr, 0, BAD_CAST "searchRetrieveResponse", 0);
969 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
970 xmlSetNs(ptr, ns_srw);
973 add_xsd_string(ptr, "version", (*p)->srw_version);
974 add_xsd_integer(ptr, "numberOfRecords", res->numberOfRecords);
975 add_xsd_string(ptr, "resultSetId", res->resultSetId);
977 add_xsd_integer(ptr, "resultSetIdleTime",
978 res->resultSetIdleTime);
979 if (res->num_records)
981 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "records", 0);
982 yaz_srw_records(o, rptr, &res->records, &res->extra_records,
984 client_data, version2);
986 add_xsd_integer(ptr, "nextRecordPosition",
987 res->nextRecordPosition);
988 if ((*p)->extra_args)
991 xmlNewChild(ptr, 0, BAD_CAST "echoedSearchRetrieveRequest",
993 Z_SRW_extra_arg *ea = (*p)->extra_args;
994 for (; ea; ea = ea->next)
995 add_xsd_string(p1, ea->name, ea->value);
998 if (res->num_diagnostics)
1000 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
1002 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1003 &res->num_diagnostics, client_data, ns,
1008 if (ptr && (*p)->extraResponseData_len)
1009 add_XML_n(ptr, "extraResponseData",
1010 (*p)->extraResponseData_buf,
1011 (*p)->extraResponseData_len, ns_srw);
1012 add_xsd_integer(ptr, "resultSetTTL", res->resultSetIdleTime);
1013 add_xsd_string(ptr, "resultCountPrecision",
1014 res->resultCountPrecision);
1015 yaz_sru_facet_response(o, &res->facetList, ptr);
1016 return 0; /* so we don't make extra response data twice */
1019 else if ((*p)->which == Z_SRW_explain_request)
1021 Z_SRW_explainRequest *req = (*p)->u.explain_request;
1023 ns = "http://docs.oasis-open.org/ns/search-ws/sruRequest";
1024 ptr = xmlNewChild(pptr, 0, BAD_CAST "explainRequest", 0);
1025 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1026 xmlSetNs(ptr, ns_srw);
1029 add_xsd_string(ptr, "version", (*p)->srw_version);
1032 add_xsd_string(ptr, "recordXMLEscaping", req->recordPacking);
1033 add_xsd_string(ptr, "recordPacking", req->packing);
1036 add_xsd_string(ptr, "recordPacking", req->recordPacking);
1037 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1038 add_xsd_string(ptr, "database", req->database);
1040 else if ((*p)->which == Z_SRW_explain_response)
1042 Z_SRW_explainResponse *res = (*p)->u.explain_response;
1044 ns = "http://docs.oasis-open.org/ns/search-ws/sruResponse";
1045 ptr = xmlNewChild(pptr, 0, BAD_CAST "explainResponse", 0);
1046 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1047 xmlSetNs(ptr, ns_srw);
1049 add_xsd_string(ptr, "version", (*p)->srw_version);
1052 xmlNodePtr ptr1 = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1053 yaz_srw_record(o, ptr1, &res->record, &res->extra_record,
1054 client_data, version2);
1056 if ((*p)->extra_args)
1059 xmlNewChild(ptr, 0, BAD_CAST "echoedExplainRequest", 0);
1060 Z_SRW_extra_arg *ea = (*p)->extra_args;
1061 for (; ea; ea = ea->next)
1062 add_xsd_string(p1, ea->name, ea->value);
1064 if (res->num_diagnostics)
1066 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
1068 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1069 &res->num_diagnostics, client_data, ns,
1073 else if ((*p)->which == Z_SRW_scan_request)
1075 Z_SRW_scanRequest *req = (*p)->u.scan_request;
1076 const char *queryType = req->queryType;
1078 ns = "http://docs.oasis-open.org/ns/search-ws/scan";
1079 ptr = xmlNewChild(pptr, 0, BAD_CAST "scanRequest", 0);
1080 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1081 xmlSetNs(ptr, ns_srw);
1084 add_xsd_string(ptr, "version", (*p)->srw_version);
1088 if (queryType && strcmp(queryType, "cql"))
1089 add_xsd_string(ptr, "queryType", queryType);
1090 add_xsd_string(ptr, "scanClause", req->scanClause);
1094 if (!queryType || !strcmp(queryType, "cql"))
1095 add_xsd_string(ptr, "scanClause", req->scanClause);
1096 else if (!strcmp(queryType, "pqf"))
1097 add_xsd_string(ptr, "pScanClause", req->scanClause);
1099 add_xsd_integer(ptr, "responsePosition", req->responsePosition);
1100 add_xsd_integer(ptr, "maximumTerms", req->maximumTerms);
1101 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1102 add_xsd_string(ptr, "database", req->database);
1104 else if ((*p)->which == Z_SRW_scan_response)
1106 Z_SRW_scanResponse *res = (*p)->u.scan_response;
1108 ns = "http://docs.oasis-open.org/ns/search-ws/scan";
1109 ptr = xmlNewChild(pptr, 0, BAD_CAST "scanResponse", 0);
1110 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1111 xmlSetNs(ptr, ns_srw);
1114 add_xsd_string(ptr, "version", (*p)->srw_version);
1117 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "terms", 0);
1118 yaz_srw_terms(o, rptr, &res->terms, &res->num_terms,
1121 if (res->num_diagnostics)
1123 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
1125 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1126 &res->num_diagnostics, client_data, ns,
1132 if (ptr && (*p)->extraResponseData_len)
1133 add_XML_n(ptr, "extraResponseData",
1134 (*p)->extraResponseData_buf,
1135 (*p)->extraResponseData_len, ns_srw);
1142 int yaz_ucp_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
1143 void *client_data, const char *ns_ucp_str)
1145 xmlNodePtr pptr = (xmlNodePtr) vptr;
1146 const char *ns_srw_str = YAZ_XMLNS_SRU_v1_1;
1147 if (o->direction == ODR_DECODE)
1149 Z_SRW_PDU **p = handler_data;
1150 xmlNodePtr method = pptr->children;
1152 while (method && method->type == XML_TEXT_NODE)
1153 method = method->next;
1157 if (method->type != XML_ELEMENT_NODE)
1160 *p = yaz_srw_get_core_v_2_0(o);
1162 if (!xmlStrcmp(method->name, BAD_CAST "updateRequest"))
1164 xmlNodePtr ptr = method->children;
1165 Z_SRW_updateRequest *req;
1168 (*p)->which = Z_SRW_update_request;
1169 req = (*p)->u.update_request = (Z_SRW_updateRequest *)
1170 odr_malloc(o, sizeof(*req));
1174 req->recordVersions = 0;
1175 req->num_recordVersions = 0;
1177 req->extra_record = 0;
1178 req->extraRequestData_buf = 0;
1179 req->extraRequestData_len = 0;
1180 req->stylesheet = 0;
1182 for (; ptr; ptr = ptr->next)
1184 if (yaz_match_xsd_string(ptr, "version", o,
1185 &(*p)->srw_version))
1187 else if (yaz_match_xsd_string(ptr, "action", o,
1191 if (!strcmp(oper, "info:srw/action/1/delete"))
1192 req->operation = "delete";
1193 else if (!strcmp(oper,"info:srw/action/1/replace" ))
1194 req->operation = "replace";
1195 else if (!strcmp(oper, "info:srw/action/1/create"))
1196 req->operation = "insert";
1199 else if (yaz_match_xsd_string(ptr, "recordIdentifier", o,
1202 else if (yaz_match_xsd_element(ptr, "recordVersions" ) )
1203 yaz_srw_versions( o, ptr, &req->recordVersions,
1204 &req->num_recordVersions, client_data,
1206 else if (yaz_match_xsd_element(ptr, "record"))
1208 req->record = yaz_srw_get_record(o);
1209 yaz_srw_record(o, ptr, req->record, &req->extra_record,
1212 else if (yaz_match_xsd_string(ptr, "stylesheet", o,
1216 yaz_match_xsd_string(ptr, "database", o, &req->database);
1219 else if (!xmlStrcmp(method->name, BAD_CAST "updateResponse"))
1221 xmlNodePtr ptr = method->children;
1222 Z_SRW_updateResponse *res;
1224 (*p)->which = Z_SRW_update_response;
1225 res = (*p)->u.update_response = (Z_SRW_updateResponse *)
1226 odr_malloc(o, sizeof(*res));
1228 res->operationStatus = 0;
1230 res->recordVersions = 0;
1231 res->num_recordVersions = 0;
1232 res->diagnostics = 0;
1233 res->num_diagnostics = 0;
1235 res->extra_record = 0;
1236 res->extraResponseData_buf = 0;
1237 res->extraResponseData_len = 0;
1239 for (; ptr; ptr = ptr->next)
1241 if (yaz_match_xsd_string(ptr, "version", o,
1242 &(*p)->srw_version))
1244 else if (yaz_match_xsd_string(ptr, "operationStatus", o,
1245 &res->operationStatus ))
1247 else if (yaz_match_xsd_string(ptr, "recordIdentifier", o,
1250 else if (yaz_match_xsd_element(ptr, "recordVersions" ))
1251 yaz_srw_versions(o, ptr, &res->recordVersions,
1252 &res->num_recordVersions,
1253 client_data, ns_ucp_str);
1254 else if (yaz_match_xsd_element(ptr, "record"))
1256 res->record = yaz_srw_get_record(o);
1257 yaz_srw_record(o, ptr, res->record, &res->extra_record,
1260 else if (yaz_match_xsd_element(ptr, "diagnostics"))
1261 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
1262 &res->num_diagnostics,
1263 client_data, ns_ucp_str, 0);
1266 else if (!xmlStrcmp(method->name, BAD_CAST "explainUpdateRequest"))
1269 else if (!xmlStrcmp(method->name, BAD_CAST "explainUpdateResponse"))
1278 else if (o->direction == ODR_ENCODE)
1280 Z_SRW_PDU **p = handler_data;
1281 xmlNsPtr ns_ucp, ns_srw;
1283 if ((*p)->which == Z_SRW_update_request)
1285 Z_SRW_updateRequest *req = (*p)->u.update_request;
1286 xmlNodePtr ptr = xmlNewChild(pptr, 0, BAD_CAST "updateRequest", 0);
1287 ns_ucp = xmlNewNs(ptr, BAD_CAST ns_ucp_str, BAD_CAST "zu");
1288 xmlSetNs(ptr, ns_ucp);
1289 ns_srw = xmlNewNs(ptr, BAD_CAST ns_srw_str, BAD_CAST "zs");
1291 add_xsd_string_ns(ptr, "version", (*p)->srw_version, ns_srw);
1292 add_xsd_string(ptr, "action", req->operation);
1293 add_xsd_string(ptr, "recordIdentifier", req->recordId );
1294 if (req->recordVersions)
1295 yaz_srw_versions( o, ptr, &req->recordVersions,
1296 &req->num_recordVersions,
1297 client_data, ns_ucp_str);
1298 if (req->record && req->record->recordData_len)
1300 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1301 xmlSetNs(rptr, ns_srw);
1302 yaz_srw_record(o, rptr, req->record, &req->extra_record,
1305 if (req->extraRequestData_len)
1307 add_XML_n(ptr, "extraRequestData",
1308 req->extraRequestData_buf,
1309 req->extraRequestData_len, ns_srw);
1311 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1312 add_xsd_string(ptr, "database", req->database);
1314 else if ((*p)->which == Z_SRW_update_response)
1316 Z_SRW_updateResponse *res = (*p)->u.update_response;
1317 xmlNodePtr ptr = xmlNewChild(pptr, 0, (xmlChar *)
1318 "updateResponse", 0);
1319 ns_ucp = xmlNewNs(ptr, BAD_CAST ns_ucp_str, BAD_CAST "zu");
1320 xmlSetNs(ptr, ns_ucp);
1321 ns_srw = xmlNewNs(ptr, BAD_CAST ns_srw_str, BAD_CAST "zs");
1323 add_xsd_string_ns(ptr, "version", (*p)->srw_version, ns_srw);
1324 add_xsd_string(ptr, "operationStatus", res->operationStatus );
1325 add_xsd_string(ptr, "recordIdentifier", res->recordId );
1326 if (res->recordVersions)
1327 yaz_srw_versions(o, ptr, &res->recordVersions,
1328 &res->num_recordVersions,
1329 client_data, ns_ucp_str);
1330 if (res->record && res->record->recordData_len)
1332 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1333 xmlSetNs(rptr, ns_srw);
1334 yaz_srw_record(o, rptr, res->record, &res->extra_record,
1337 if (res->num_diagnostics)
1340 xmlNewNs(pptr, BAD_CAST YAZ_XMLNS_DIAG_v1_1,
1343 xmlNodePtr rptr = xmlNewChild(ptr, ns_diag, BAD_CAST "diagnostics", 0);
1344 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1345 &res->num_diagnostics, client_data,
1348 if (res->extraResponseData_len)
1349 add_XML_n(ptr, "extraResponseData",
1350 res->extraResponseData_buf,
1351 res->extraResponseData_len, ns_srw);
1365 * c-file-style: "Stroustrup"
1366 * indent-tabs-mode: nil
1368 * vim: shiftwidth=4 tabstop=8 expandtab