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))
663 /* should put proper diagnostic here */
666 if (!strcmp((*p)->srw_version, "2.0"))
668 req->recordPacking = recordXMLEscaping;
669 req->packing = recordPacking;
673 req->recordPacking = recordPacking;
675 yaz_sru_facet_request(o, &req->facetList, &facetLimit, &facetStart,
678 else if (!xmlStrcmp(method->name, BAD_CAST "searchRetrieveResponse"))
680 xmlNodePtr ptr = method->children;
681 Z_SRW_searchRetrieveResponse *res;
683 (*p)->which = Z_SRW_searchRetrieve_response;
684 res = (*p)->u.response = (Z_SRW_searchRetrieveResponse *)
685 odr_malloc(o, sizeof(*res));
687 res->numberOfRecords = 0;
688 res->resultCountPrecision = 0;
689 res->resultSetId = 0;
690 res->resultSetIdleTime = 0;
692 res->num_records = 0;
693 res->diagnostics = 0;
694 res->num_diagnostics = 0;
695 res->nextRecordPosition = 0;
697 res->suggestions = 0;
699 for (; ptr; ptr = ptr->next)
701 if (yaz_match_xsd_string(ptr, "version", o,
704 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
705 &(*p)->extraResponseData_buf,
706 &(*p)->extraResponseData_len))
708 else if (yaz_match_xsd_integer(ptr, "numberOfRecords", o,
709 &res->numberOfRecords))
711 else if (yaz_match_xsd_string(ptr, "resultCountPrecision", o,
712 &res->resultCountPrecision))
714 else if (yaz_match_xsd_string(ptr, "resultSetId", o,
717 else if (yaz_match_xsd_integer(ptr, "resultSetIdleTime", o,
718 &res->resultSetIdleTime))
720 else if (yaz_match_xsd_integer(ptr, "resultSetTTL", o,
721 &res->resultSetIdleTime))
723 else if (yaz_match_xsd_element(ptr, "records"))
724 yaz_srw_records(o, ptr, &res->records,
726 &res->num_records, client_data, 0);
727 else if (yaz_match_xsd_integer(ptr, "nextRecordPosition", o,
728 &res->nextRecordPosition))
730 else if (yaz_match_xsd_element(ptr, "diagnostics"))
731 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
732 &res->num_diagnostics,
734 else if (yaz_match_xsd_element(ptr, "facet_analysis"))
735 yaz_sru_proxy_decode_facets(o, ptr, &res->facetList);
736 else if (yaz_match_xsd_element(ptr, "facetedResults"))
737 yaz_sru_facet_response(o, &res->facetList, ptr);
740 else if (!xmlStrcmp(method->name, BAD_CAST "explainRequest"))
742 Z_SRW_explainRequest *req;
743 xmlNodePtr ptr = method->children;
745 (*p)->which = Z_SRW_explain_request;
746 req = (*p)->u.explain_request = (Z_SRW_explainRequest *)
747 odr_malloc(o, sizeof(*req));
748 req->recordPacking = 0;
752 for (; ptr; ptr = ptr->next)
754 if (yaz_match_xsd_string(ptr, "version", o,
757 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
758 &(*p)->extraResponseData_buf,
759 &(*p)->extraResponseData_len))
761 else if (yaz_match_xsd_string(ptr, "stylesheet", o,
764 else if (yaz_match_xsd_string(ptr, "recordPacking", o,
765 &req->recordPacking))
768 yaz_match_xsd_string(ptr, "database", o, &req->database);
771 else if (!xmlStrcmp(method->name, BAD_CAST "explainResponse"))
773 Z_SRW_explainResponse *res;
774 xmlNodePtr ptr = method->children;
776 (*p)->which = Z_SRW_explain_response;
777 res = (*p)->u.explain_response = (Z_SRW_explainResponse*)
778 odr_malloc(o, sizeof(*res));
779 res->diagnostics = 0;
780 res->num_diagnostics = 0;
781 res->record.recordSchema = 0;
782 res->record.recordData_buf = 0;
783 res->record.recordData_len = 0;
784 res->record.recordPosition = 0;
786 for (; ptr; ptr = ptr->next)
788 if (yaz_match_xsd_string(ptr, "version", o,
791 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
792 &(*p)->extraResponseData_buf,
793 &(*p)->extraResponseData_len))
795 else if (yaz_match_xsd_element(ptr, "record"))
796 yaz_srw_record(o, ptr, &res->record, &res->extra_record,
798 else if (yaz_match_xsd_element(ptr, "diagnostics"))
799 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
800 &res->num_diagnostics,
805 else if (!xmlStrcmp(method->name, BAD_CAST "scanRequest"))
807 Z_SRW_scanRequest *req;
808 xmlNodePtr ptr = method->children;
810 (*p)->which = Z_SRW_scan_request;
811 req = (*p)->u.scan_request = (Z_SRW_scanRequest *)
812 odr_malloc(o, sizeof(*req));
813 req->queryType = "cql";
815 req->responsePosition = 0;
816 req->maximumTerms = 0;
820 for (; ptr; ptr = ptr->next)
822 if (yaz_match_xsd_string(ptr, "version", o,
825 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
826 &(*p)->extraResponseData_buf,
827 &(*p)->extraResponseData_len))
829 else if (yaz_match_xsd_string(ptr, "scanClause", o,
832 else if (yaz_match_xsd_string(ptr, "pScanClause", o,
835 req->queryType = "pqf";
837 else if (yaz_match_xsd_integer(ptr, "responsePosition", o,
838 &req->responsePosition))
840 else if (yaz_match_xsd_integer(ptr, "maximumTerms", o,
843 else if (yaz_match_xsd_string(ptr, "stylesheet", o,
847 yaz_match_xsd_string(ptr, "database", o, &req->database);
850 else if (!xmlStrcmp(method->name, BAD_CAST "scanResponse"))
852 Z_SRW_scanResponse *res;
853 xmlNodePtr ptr = method->children;
855 (*p)->which = Z_SRW_scan_response;
856 res = (*p)->u.scan_response = (Z_SRW_scanResponse *)
857 odr_malloc(o, sizeof(*res));
860 res->diagnostics = 0;
861 res->num_diagnostics = 0;
863 for (; ptr; ptr = ptr->next)
865 if (yaz_match_xsd_string(ptr, "version", o,
868 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
869 &(*p)->extraResponseData_buf,
870 &(*p)->extraResponseData_len))
872 else if (yaz_match_xsd_element(ptr, "terms"))
873 yaz_srw_terms(o, ptr, &res->terms,
874 &res->num_terms, client_data,
876 else if (yaz_match_xsd_element(ptr, "diagnostics"))
877 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
878 &res->num_diagnostics,
887 neg_version = yaz_negotiate_sru_version((*p)->srw_version);
889 (*p)->srw_version = neg_version;
891 else if (o->direction == ODR_ENCODE)
893 Z_SRW_PDU **p = handler_data;
896 int version2 = !(*p)->srw_version ||
897 strcmp((*p)->srw_version, "2.") > 0;
898 if ((*p)->which == Z_SRW_searchRetrieve_request)
900 Z_SRW_searchRetrieveRequest *req = (*p)->u.request;
901 const char *queryType = req->queryType;
903 ns = "http://docs.oasis-open.org/ns/search-ws/sruRequest";
904 ptr = xmlNewChild(pptr, 0, BAD_CAST "searchRetrieveRequest", 0);
905 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
906 xmlSetNs(ptr, ns_srw);
909 add_xsd_string(ptr, "version", (*p)->srw_version);
912 add_xsd_string(ptr, "query", req->query);
916 if (!queryType || !strcmp(queryType, "cql"))
917 add_xsd_string(ptr, "query", req->query);
918 else if (!strcmp(queryType, "xcql"))
919 add_xsd_string(ptr, "xQuery", req->query);
920 else if (!strcmp(queryType, "pqf"))
921 add_xsd_string(ptr, "pQuery", req->query);
924 add_xsd_integer(ptr, "startRecord", req->startRecord);
925 add_xsd_integer(ptr, "maximumRecords", req->maximumRecords);
927 add_xsd_string(ptr, "recordXMLEscaping", req->recordPacking);
929 add_xsd_string(ptr, "recordPacking", req->recordPacking);
930 add_xsd_string(ptr, "recordSchema", req->recordSchema);
931 add_xsd_string(ptr, "recordXPath", req->recordXPath);
932 add_xsd_integer(ptr, "resultSetTTL", req->resultSetTTL);
933 add_xsd_string(ptr, "stylesheet", req->stylesheet);
934 add_xsd_string(ptr, "queryType", queryType);
935 switch (req->sort_type)
937 case Z_SRW_sort_type_none:
939 case Z_SRW_sort_type_sort:
940 add_xsd_string(ptr, "sortKeys", req->sort.sortKeys);
942 case Z_SRW_sort_type_xSort:
943 add_xsd_string(ptr, "xSortKeys", req->sort.xSortKeys);
946 /* still unsupported are: renderedBy, httpAccept, responseType */
947 add_xsd_string(ptr, "database", req->database);
949 add_xsd_string(ptr, "recordPacking", req->packing);
951 const char *limit = 0;
952 const char *start = 0;
953 const char *sort = 0;
954 yaz_sru_facet_request(o, &req->facetList, &limit, &start,
956 add_xsd_string(ptr, "facetLimit", limit);
957 add_xsd_string(ptr, "facetStart", start);
958 add_xsd_string(ptr, "facetSort", sort);
961 else if ((*p)->which == Z_SRW_searchRetrieve_response)
963 Z_SRW_searchRetrieveResponse *res = (*p)->u.response;
965 ns = "http://docs.oasis-open.org/ns/search-ws/sruResponse";
966 ptr = xmlNewChild(pptr, 0, BAD_CAST "searchRetrieveResponse", 0);
967 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
968 xmlSetNs(ptr, ns_srw);
971 add_xsd_string(ptr, "version", (*p)->srw_version);
972 add_xsd_integer(ptr, "numberOfRecords", res->numberOfRecords);
973 add_xsd_string(ptr, "resultSetId", res->resultSetId);
975 add_xsd_integer(ptr, "resultSetIdleTime",
976 res->resultSetIdleTime);
977 if (res->num_records)
979 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "records", 0);
980 yaz_srw_records(o, rptr, &res->records, &res->extra_records,
982 client_data, version2);
984 add_xsd_integer(ptr, "nextRecordPosition",
985 res->nextRecordPosition);
986 if (res->num_diagnostics)
988 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
990 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
991 &res->num_diagnostics, client_data, ns,
996 if (ptr && (*p)->extraResponseData_len)
997 add_XML_n(ptr, "extraResponseData",
998 (*p)->extraResponseData_buf,
999 (*p)->extraResponseData_len, ns_srw);
1000 add_xsd_integer(ptr, "resultSetTTL", res->resultSetIdleTime);
1001 add_xsd_string(ptr, "resultCountPrecision",
1002 res->resultCountPrecision);
1003 yaz_sru_facet_response(o, &res->facetList, ptr);
1004 return 0; /* so we don't make extra response data twice */
1007 else if ((*p)->which == Z_SRW_explain_request)
1009 Z_SRW_explainRequest *req = (*p)->u.explain_request;
1011 ns = "http://docs.oasis-open.org/ns/search-ws/sruRequest";
1012 ptr = xmlNewChild(pptr, 0, BAD_CAST "explainRequest", 0);
1013 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1014 xmlSetNs(ptr, ns_srw);
1017 add_xsd_string(ptr, "version", (*p)->srw_version);
1020 add_xsd_string(ptr, "recordXMLEscaping", req->recordPacking);
1021 add_xsd_string(ptr, "recordPacking", req->packing);
1024 add_xsd_string(ptr, "recordPacking", req->recordPacking);
1025 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1026 add_xsd_string(ptr, "database", req->database);
1028 else if ((*p)->which == Z_SRW_explain_response)
1030 Z_SRW_explainResponse *res = (*p)->u.explain_response;
1032 ns = "http://docs.oasis-open.org/ns/search-ws/sruResponse";
1033 ptr = xmlNewChild(pptr, 0, BAD_CAST "explainResponse", 0);
1034 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1035 xmlSetNs(ptr, ns_srw);
1037 add_xsd_string(ptr, "version", (*p)->srw_version);
1040 xmlNodePtr ptr1 = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1041 yaz_srw_record(o, ptr1, &res->record, &res->extra_record,
1042 client_data, version2);
1044 if (res->num_diagnostics)
1046 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
1048 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1049 &res->num_diagnostics, client_data, ns,
1053 else if ((*p)->which == Z_SRW_scan_request)
1055 Z_SRW_scanRequest *req = (*p)->u.scan_request;
1056 const char *queryType = req->queryType;
1058 ns = "http://docs.oasis-open.org/ns/search-ws/scan";
1059 ptr = xmlNewChild(pptr, 0, BAD_CAST "scanRequest", 0);
1060 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1061 xmlSetNs(ptr, ns_srw);
1064 add_xsd_string(ptr, "version", (*p)->srw_version);
1068 if (queryType && strcmp(queryType, "cql"))
1069 add_xsd_string(ptr, "queryType", queryType);
1070 add_xsd_string(ptr, "scanClause", req->scanClause);
1074 if (!queryType || !strcmp(queryType, "cql"))
1075 add_xsd_string(ptr, "scanClause", req->scanClause);
1076 else if (!strcmp(queryType, "pqf"))
1077 add_xsd_string(ptr, "pScanClause", req->scanClause);
1079 add_xsd_integer(ptr, "responsePosition", req->responsePosition);
1080 add_xsd_integer(ptr, "maximumTerms", req->maximumTerms);
1081 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1082 add_xsd_string(ptr, "database", req->database);
1084 else if ((*p)->which == Z_SRW_scan_response)
1086 Z_SRW_scanResponse *res = (*p)->u.scan_response;
1088 ns = "http://docs.oasis-open.org/ns/search-ws/scan";
1089 ptr = xmlNewChild(pptr, 0, BAD_CAST "scanResponse", 0);
1090 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1091 xmlSetNs(ptr, ns_srw);
1094 add_xsd_string(ptr, "version", (*p)->srw_version);
1097 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "terms", 0);
1098 yaz_srw_terms(o, rptr, &res->terms, &res->num_terms,
1101 if (res->num_diagnostics)
1103 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
1105 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1106 &res->num_diagnostics, client_data, ns,
1112 if (ptr && (*p)->extraResponseData_len)
1113 add_XML_n(ptr, "extraResponseData",
1114 (*p)->extraResponseData_buf,
1115 (*p)->extraResponseData_len, ns_srw);
1122 int yaz_ucp_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
1123 void *client_data, const char *ns_ucp_str)
1125 xmlNodePtr pptr = (xmlNodePtr) vptr;
1126 const char *ns_srw_str = YAZ_XMLNS_SRU_v1_1;
1127 if (o->direction == ODR_DECODE)
1129 Z_SRW_PDU **p = handler_data;
1130 xmlNodePtr method = pptr->children;
1132 while (method && method->type == XML_TEXT_NODE)
1133 method = method->next;
1137 if (method->type != XML_ELEMENT_NODE)
1140 *p = yaz_srw_get_core_v_2_0(o);
1142 if (!xmlStrcmp(method->name, BAD_CAST "updateRequest"))
1144 xmlNodePtr ptr = method->children;
1145 Z_SRW_updateRequest *req;
1148 (*p)->which = Z_SRW_update_request;
1149 req = (*p)->u.update_request = (Z_SRW_updateRequest *)
1150 odr_malloc(o, sizeof(*req));
1154 req->recordVersions = 0;
1155 req->num_recordVersions = 0;
1157 req->extra_record = 0;
1158 req->extraRequestData_buf = 0;
1159 req->extraRequestData_len = 0;
1160 req->stylesheet = 0;
1162 for (; ptr; ptr = ptr->next)
1164 if (yaz_match_xsd_string(ptr, "version", o,
1165 &(*p)->srw_version))
1167 else if (yaz_match_xsd_string(ptr, "action", o,
1171 if (!strcmp(oper, "info:srw/action/1/delete"))
1172 req->operation = "delete";
1173 else if (!strcmp(oper,"info:srw/action/1/replace" ))
1174 req->operation = "replace";
1175 else if (!strcmp(oper, "info:srw/action/1/create"))
1176 req->operation = "insert";
1179 else if (yaz_match_xsd_string(ptr, "recordIdentifier", o,
1182 else if (yaz_match_xsd_element(ptr, "recordVersions" ) )
1183 yaz_srw_versions( o, ptr, &req->recordVersions,
1184 &req->num_recordVersions, client_data,
1186 else if (yaz_match_xsd_element(ptr, "record"))
1188 req->record = yaz_srw_get_record(o);
1189 yaz_srw_record(o, ptr, req->record, &req->extra_record,
1192 else if (yaz_match_xsd_string(ptr, "stylesheet", o,
1196 yaz_match_xsd_string(ptr, "database", o, &req->database);
1199 else if (!xmlStrcmp(method->name, BAD_CAST "updateResponse"))
1201 xmlNodePtr ptr = method->children;
1202 Z_SRW_updateResponse *res;
1204 (*p)->which = Z_SRW_update_response;
1205 res = (*p)->u.update_response = (Z_SRW_updateResponse *)
1206 odr_malloc(o, sizeof(*res));
1208 res->operationStatus = 0;
1210 res->recordVersions = 0;
1211 res->num_recordVersions = 0;
1212 res->diagnostics = 0;
1213 res->num_diagnostics = 0;
1215 res->extra_record = 0;
1216 res->extraResponseData_buf = 0;
1217 res->extraResponseData_len = 0;
1219 for (; ptr; ptr = ptr->next)
1221 if (yaz_match_xsd_string(ptr, "version", o,
1222 &(*p)->srw_version))
1224 else if (yaz_match_xsd_string(ptr, "operationStatus", o,
1225 &res->operationStatus ))
1227 else if (yaz_match_xsd_string(ptr, "recordIdentifier", o,
1230 else if (yaz_match_xsd_element(ptr, "recordVersions" ))
1231 yaz_srw_versions(o, ptr, &res->recordVersions,
1232 &res->num_recordVersions,
1233 client_data, ns_ucp_str);
1234 else if (yaz_match_xsd_element(ptr, "record"))
1236 res->record = yaz_srw_get_record(o);
1237 yaz_srw_record(o, ptr, res->record, &res->extra_record,
1240 else if (yaz_match_xsd_element(ptr, "diagnostics"))
1241 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
1242 &res->num_diagnostics,
1243 client_data, ns_ucp_str, 0);
1246 else if (!xmlStrcmp(method->name, BAD_CAST "explainUpdateRequest"))
1249 else if (!xmlStrcmp(method->name, BAD_CAST "explainUpdateResponse"))
1258 else if (o->direction == ODR_ENCODE)
1260 Z_SRW_PDU **p = handler_data;
1261 xmlNsPtr ns_ucp, ns_srw;
1263 if ((*p)->which == Z_SRW_update_request)
1265 Z_SRW_updateRequest *req = (*p)->u.update_request;
1266 xmlNodePtr ptr = xmlNewChild(pptr, 0, BAD_CAST "updateRequest", 0);
1267 ns_ucp = xmlNewNs(ptr, BAD_CAST ns_ucp_str, BAD_CAST "zu");
1268 xmlSetNs(ptr, ns_ucp);
1269 ns_srw = xmlNewNs(ptr, BAD_CAST ns_srw_str, BAD_CAST "zs");
1271 add_xsd_string_ns(ptr, "version", (*p)->srw_version, ns_srw);
1272 add_xsd_string(ptr, "action", req->operation);
1273 add_xsd_string(ptr, "recordIdentifier", req->recordId );
1274 if (req->recordVersions)
1275 yaz_srw_versions( o, ptr, &req->recordVersions,
1276 &req->num_recordVersions,
1277 client_data, ns_ucp_str);
1278 if (req->record && req->record->recordData_len)
1280 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1281 xmlSetNs(rptr, ns_srw);
1282 yaz_srw_record(o, rptr, req->record, &req->extra_record,
1285 if (req->extraRequestData_len)
1287 add_XML_n(ptr, "extraRequestData",
1288 req->extraRequestData_buf,
1289 req->extraRequestData_len, ns_srw);
1291 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1292 add_xsd_string(ptr, "database", req->database);
1294 else if ((*p)->which == Z_SRW_update_response)
1296 Z_SRW_updateResponse *res = (*p)->u.update_response;
1297 xmlNodePtr ptr = xmlNewChild(pptr, 0, (xmlChar *)
1298 "updateResponse", 0);
1299 ns_ucp = xmlNewNs(ptr, BAD_CAST ns_ucp_str, BAD_CAST "zu");
1300 xmlSetNs(ptr, ns_ucp);
1301 ns_srw = xmlNewNs(ptr, BAD_CAST ns_srw_str, BAD_CAST "zs");
1303 add_xsd_string_ns(ptr, "version", (*p)->srw_version, ns_srw);
1304 add_xsd_string(ptr, "operationStatus", res->operationStatus );
1305 add_xsd_string(ptr, "recordIdentifier", res->recordId );
1306 if (res->recordVersions)
1307 yaz_srw_versions(o, ptr, &res->recordVersions,
1308 &res->num_recordVersions,
1309 client_data, ns_ucp_str);
1310 if (res->record && res->record->recordData_len)
1312 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1313 xmlSetNs(rptr, ns_srw);
1314 yaz_srw_record(o, rptr, res->record, &res->extra_record,
1317 if (res->num_diagnostics)
1320 xmlNewNs(pptr, BAD_CAST YAZ_XMLNS_DIAG_v1_1,
1323 xmlNodePtr rptr = xmlNewChild(ptr, ns_diag, BAD_CAST "diagnostics", 0);
1324 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1325 &res->num_diagnostics, client_data,
1328 if (res->extraResponseData_len)
1329 add_XML_n(ptr, "extraResponseData",
1330 res->extraResponseData_buf,
1331 res->extraResponseData_len, ns_srw);
1345 * c-file-style: "Stroustrup"
1346 * indent-tabs-mode: nil
1348 * vim: shiftwidth=4 tabstop=8 expandtab