1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2013 Index Data
3 * See the file LICENSE for details.
7 * \brief Implements 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>
24 char *yaz_negotiate_sru_version(char *input_ver)
28 if (!strcmp(input_ver, "1.1"))
30 if (!strncmp(input_ver, "1.", 2))
32 if (!strncmp(input_ver, "2.", 2))
37 static int yaz_srw_record(ODR o, xmlNodePtr pptr, Z_SRW_record *rec,
38 Z_SRW_extra_record **extra,
39 void *client_data, int version2)
41 if (o->direction == ODR_DECODE)
43 Z_SRW_extra_record ex;
50 rec->recordSchema = 0;
51 rec->recordData_buf = 0;
52 rec->recordData_len = 0;
53 rec->recordPosition = 0;
56 ex.extraRecordData_buf = 0;
57 ex.extraRecordData_len = 0;
58 ex.recordIdentifier = 0;
60 for (ptr = pptr->children; ptr; ptr = ptr->next)
63 if (yaz_match_xsd_string(ptr, "recordSchema", o,
66 else if (yaz_match_xsd_string(ptr, "recordPacking", o, &spack))
67 ; /* can't rely on it: in SRU 2.0 it's different semantics */
68 else if (yaz_match_xsd_integer(ptr, "recordPosition", o,
69 &rec->recordPosition))
71 else if (yaz_match_xsd_element(ptr, "recordData"))
73 /* we assume XML packing, if any element nodes exist below
74 recordData. Unfortunately, in SRU 2.0 recordPacking
75 means something different */
76 xmlNode *p = ptr->children;
77 for (; p; p = p->next)
78 if (p->type == XML_ELEMENT_NODE)
84 &rec->recordData_buf, &rec->recordData_len, 1);
85 rec->recordPacking = Z_SRW_recordPacking_XML;
89 yaz_match_xsd_string_n(
91 &rec->recordData_buf, &rec->recordData_len);
92 rec->recordPacking = Z_SRW_recordPacking_string;
95 else if (yaz_match_xsd_XML_n(ptr, "extraRecordData", o,
96 &ex.extraRecordData_buf,
97 &ex.extraRecordData_len) )
100 yaz_match_xsd_string(ptr, "recordIdentifier", o,
101 &ex.recordIdentifier);
103 if (ex.extraRecordData_buf || ex.recordIdentifier)
105 *extra = (Z_SRW_extra_record *)
106 odr_malloc(o, sizeof(Z_SRW_extra_record));
107 memcpy(*extra, &ex, sizeof(Z_SRW_extra_record));
110 else if (o->direction == ODR_ENCODE)
112 xmlNodePtr ptr = pptr;
113 int pack = rec->recordPacking;
114 const char *spack = yaz_srw_pack_to_str(pack);
116 /* recordSchema and recordData are required */
117 if (!rec->recordSchema)
118 xmlNewChild(ptr, 0, BAD_CAST "recordSchema", 0);
120 add_xsd_string(ptr, "recordSchema", rec->recordSchema);
124 add_xsd_string(ptr, "recordXMLEscaping", spack);
126 add_xsd_string(ptr, "recordPacking", spack);
128 if (!rec->recordData_buf)
129 xmlNewChild(ptr, 0, BAD_CAST "recordData", 0);
134 case Z_SRW_recordPacking_string:
135 add_xsd_string_n(ptr, "recordData", rec->recordData_buf,
136 rec->recordData_len);
138 case Z_SRW_recordPacking_XML:
139 add_XML_n(ptr, "recordData", rec->recordData_buf,
140 rec->recordData_len, 0);
142 case Z_SRW_recordPacking_URL:
143 add_xsd_string_n(ptr, "recordData", rec->recordData_buf,
144 rec->recordData_len);
148 if (rec->recordPosition)
149 add_xsd_integer(ptr, "recordPosition", rec->recordPosition );
152 if ((*extra)->recordIdentifier)
153 add_xsd_string(ptr, "recordIdentifier",
154 (*extra)->recordIdentifier);
155 if ((*extra)->extraRecordData_buf)
156 add_XML_n(ptr, "extraRecordData",
157 (*extra)->extraRecordData_buf,
158 (*extra)->extraRecordData_len, 0);
164 static int yaz_srw_records(ODR o, xmlNodePtr pptr, Z_SRW_record **recs,
165 Z_SRW_extra_record ***extra,
166 int *num, void *client_data, int version2)
168 if (o->direction == ODR_DECODE)
173 for (ptr = pptr->children; ptr; ptr = ptr->next)
175 if (ptr->type == XML_ELEMENT_NODE &&
176 !xmlStrcmp(ptr->name, BAD_CAST "record"))
181 *recs = (Z_SRW_record *) odr_malloc(o, *num * sizeof(**recs));
182 *extra = (Z_SRW_extra_record **) odr_malloc(o, *num * sizeof(**extra));
183 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next)
185 if (ptr->type == XML_ELEMENT_NODE &&
186 !xmlStrcmp(ptr->name, BAD_CAST "record"))
188 yaz_srw_record(o, ptr, *recs + i, *extra + i, client_data, 0);
193 else if (o->direction == ODR_ENCODE)
196 for (i = 0; i < *num; i++)
198 xmlNodePtr rptr = xmlNewChild(pptr, 0, BAD_CAST "record",
200 yaz_srw_record(o, rptr, (*recs)+i, (*extra ? *extra + i : 0),
201 client_data, version2);
207 static int yaz_srw_version(ODR o, xmlNodePtr pptr, Z_SRW_recordVersion *rec,
208 void *client_data, const char *ns)
210 if (o->direction == ODR_DECODE)
213 rec->versionType = 0;
214 rec->versionValue = 0;
215 for (ptr = pptr->children; ptr; ptr = ptr->next)
218 if (yaz_match_xsd_string(ptr, "versionType", o,
222 yaz_match_xsd_string(ptr, "versionValue", o,
226 else if (o->direction == ODR_ENCODE)
228 xmlNodePtr ptr = pptr;
229 add_xsd_string(ptr, "versionType", rec->versionType);
230 add_xsd_string(ptr, "versionValue", rec->versionValue);
235 static int yaz_srw_versions(ODR o, xmlNodePtr pptr,
236 Z_SRW_recordVersion **vers,
237 int *num, void *client_data, const char *ns)
239 if (o->direction == ODR_DECODE)
244 for (ptr = pptr->children; ptr; ptr = ptr->next)
246 if (ptr->type == XML_ELEMENT_NODE &&
247 !xmlStrcmp(ptr->name, BAD_CAST "recordVersion"))
252 *vers = (Z_SRW_recordVersion *) odr_malloc(o, *num * sizeof(**vers));
253 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next)
255 if (ptr->type == XML_ELEMENT_NODE &&
256 !xmlStrcmp(ptr->name, BAD_CAST "recordVersion"))
258 yaz_srw_version(o, ptr, *vers + i, client_data, ns);
263 else if (o->direction == ODR_ENCODE)
266 for (i = 0; i < *num; i++)
268 xmlNodePtr rptr = xmlNewChild(pptr, 0, BAD_CAST "version",
270 yaz_srw_version(o, rptr, (*vers)+i, client_data, ns);
276 Z_FacetTerm *yaz_sru_proxy_get_facet_term_count(ODR odr, xmlNodePtr node)
280 WRBUF wrbuf = wrbuf_alloc();
281 Z_FacetTerm *facet_term;
282 const char *freq_string = yaz_element_attribute_value_get(
283 node, "facetvalue", "est_representation");
285 freq = odr_atoi(freq_string);
289 for (child = node->children; child ; child = child->next)
291 if (child->type == XML_TEXT_NODE)
292 wrbuf_puts(wrbuf, (const char *) child->content);
294 facet_term = facet_term_create_cstr(odr, wrbuf_cstr(wrbuf), freq);
295 wrbuf_destroy(wrbuf);
299 static Z_FacetField *yaz_sru_proxy_decode_facet_field(ODR odr, xmlNodePtr ptr)
301 Z_AttributeList *list;
302 Z_FacetField *facet_field;
307 const char* name = yaz_element_attribute_value_get(ptr, "facet", "code");
308 yaz_log(YLOG_DEBUG, "sru-proxy facet type: %s", name);
310 list = yaz_use_attribute_create(odr, name);
311 for (node = ptr->children; node; node = node->next) {
312 if (yaz_match_xsd_element(node, "facetvalue"))
315 facet_field = facet_field_create(odr, list, num_terms);
317 for (node = ptr->children; node; node = node->next)
319 if (yaz_match_xsd_element(node, "facetvalue"))
321 facet_field_term_set(odr, facet_field,
322 yaz_sru_proxy_get_facet_term_count(odr, node),
330 static int yaz_sru_proxy_decode_facets(ODR o, xmlNodePtr root,
331 Z_FacetList **facetList)
335 for (ptr = root->children; ptr; ptr = ptr->next)
337 if (yaz_match_xsd_element(ptr, "facets"))
340 Z_FacetList *facet_list;
342 for (node = ptr->children; node; node= node->next)
344 if (node->type == XML_ELEMENT_NODE)
347 facet_list = facet_list_create(o, num_facets);
349 for (node = ptr->children; node; node= node->next)
351 if (yaz_match_xsd_element(node, "facet"))
353 facet_list_field_set(
355 yaz_sru_proxy_decode_facet_field(o, node), num_facets);
359 *facetList = facet_list;
368 static int yaz_srw_decode_diagnostics(ODR o, xmlNodePtr pptr,
369 Z_SRW_diagnostic **recs, int *num,
370 void *client_data, const char *ns)
375 for (ptr = pptr; ptr; ptr = ptr->next)
377 if (ptr->type == XML_ELEMENT_NODE &&
378 !xmlStrcmp(ptr->name, BAD_CAST "diagnostic"))
383 *recs = (Z_SRW_diagnostic *) odr_malloc(o, *num * sizeof(**recs));
384 for (i = 0; i < *num; i++)
387 (*recs)[i].details = 0;
388 (*recs)[i].message = 0;
390 for (i = 0, ptr = pptr; ptr; ptr = ptr->next)
392 if (ptr->type == XML_ELEMENT_NODE &&
393 !xmlStrcmp(ptr->name, BAD_CAST "diagnostic"))
397 (*recs)[i].details = 0;
398 (*recs)[i].message = 0;
399 for (rptr = ptr->children; rptr; rptr = rptr->next)
401 if (yaz_match_xsd_string(rptr, "uri", o, &(*recs)[i].uri))
403 else if (yaz_match_xsd_string(rptr, "details", o,
404 &(*recs)[i].details))
407 yaz_match_xsd_string(rptr, "message", o,
408 &(*recs)[i].message);
416 int sru_decode_surrogate_diagnostics(const char *buf, size_t len,
417 Z_SRW_diagnostic **diag,
421 xmlDocPtr doc = xmlParseMemory(buf, len);
424 xmlNodePtr ptr = xmlDocGetRootElement(doc);
425 while (ptr && ptr->type != XML_ELEMENT_NODE)
428 && !xmlStrcmp(ptr->ns->href,
429 BAD_CAST "http://www.loc.gov/zing/srw/diagnostic/"))
431 ret = yaz_srw_decode_diagnostics(odr, ptr, diag, num, 0, 0);
438 static int yaz_srw_diagnostics(ODR o, xmlNodePtr pptr, Z_SRW_diagnostic **recs,
439 int *num, void *client_data, const char *ns)
441 if (o->direction == ODR_DECODE)
443 return yaz_srw_decode_diagnostics(o, pptr->children, recs, num, client_data, ns);
445 else if (o->direction == ODR_ENCODE)
449 xmlNewNs(pptr, BAD_CAST YAZ_XMLNS_DIAG_v1_1, BAD_CAST "diag" );
450 for (i = 0; i < *num; i++)
452 const char *std_diag = "info:srw/diagnostic/1/";
453 const char *ucp_diag = "info:srw/diagnostic/12/";
454 xmlNodePtr rptr = xmlNewChild(pptr, ns_diag,
455 BAD_CAST "diagnostic", 0);
456 add_xsd_string(rptr, "uri", (*recs)[i].uri);
457 if ((*recs)[i].message)
458 add_xsd_string(rptr, "message", (*recs)[i].message);
459 else if ((*recs)[i].uri )
461 if (!strncmp((*recs)[i].uri, std_diag, strlen(std_diag)))
463 int no = atoi((*recs)[i].uri + strlen(std_diag));
464 const char *message = yaz_diag_srw_str(no);
466 add_xsd_string(rptr, "message", message);
468 else if (!strncmp((*recs)[i].uri, ucp_diag, strlen(ucp_diag)))
470 int no = atoi((*recs)[i].uri + strlen(ucp_diag));
471 const char *message = yaz_diag_sru_update_str(no);
473 add_xsd_string(rptr, "message", message);
476 add_xsd_string(rptr, "details", (*recs)[i].details);
482 static int yaz_srw_term(ODR o, xmlNodePtr pptr, Z_SRW_scanTerm *term,
483 void *client_data, const char *ns)
485 if (o->direction == ODR_DECODE)
489 term->numberOfRecords = 0;
490 term->displayTerm = 0;
491 term->whereInList = 0;
492 for (ptr = pptr->children; ptr; ptr = ptr->next)
494 if (yaz_match_xsd_string(ptr, "value", o, &term->value))
496 else if (yaz_match_xsd_integer(ptr, "numberOfRecords", o,
497 &term->numberOfRecords))
499 else if (yaz_match_xsd_string(ptr, "displayTerm", o,
503 yaz_match_xsd_string(ptr, "whereInList", o, &term->whereInList);
506 else if (o->direction == ODR_ENCODE)
508 xmlNodePtr ptr = pptr;
509 add_xsd_string(ptr, "value", term->value);
510 add_xsd_integer(ptr, "numberOfRecords", term->numberOfRecords);
511 add_xsd_string(ptr, "displayTerm", term->displayTerm);
512 add_xsd_string(ptr, "whereInList", term->whereInList);
517 static int yaz_srw_terms(ODR o, xmlNodePtr pptr, Z_SRW_scanTerm **terms,
518 int *num, void *client_data, const char *ns)
520 if (o->direction == ODR_DECODE)
525 for (ptr = pptr->children; ptr; ptr = ptr->next)
527 if (ptr->type == XML_ELEMENT_NODE &&
528 !xmlStrcmp(ptr->name, BAD_CAST "term"))
533 *terms = (Z_SRW_scanTerm *) odr_malloc(o, *num * sizeof(**terms));
534 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next, i++)
536 if (ptr->type == XML_ELEMENT_NODE &&
537 !xmlStrcmp(ptr->name, BAD_CAST "term"))
538 yaz_srw_term(o, ptr, (*terms)+i, client_data, ns);
541 else if (o->direction == ODR_ENCODE)
544 for (i = 0; i < *num; i++)
546 xmlNodePtr rptr = xmlNewChild(pptr, 0, BAD_CAST "term", 0);
547 yaz_srw_term(o, rptr, (*terms)+i, client_data, ns);
553 int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
554 void *client_data, const char *ns)
556 xmlNodePtr pptr = (xmlNodePtr) vptr;
557 if (o->direction == ODR_DECODE)
559 Z_SRW_PDU **p = handler_data;
560 xmlNodePtr method = pptr->children;
563 while (method && method->type == XML_TEXT_NODE)
564 method = method->next;
568 if (method->type != XML_ELEMENT_NODE)
571 *p = yaz_srw_get_core_v_2_0(o);
573 if (!xmlStrcmp(method->name, BAD_CAST "searchRetrieveRequest"))
575 xmlNodePtr ptr = method->children;
576 Z_SRW_searchRetrieveRequest *req;
577 char *recordPacking = 0;
578 char *recordXMLEscaping = 0;
579 const char *facetLimit = 0;
580 const char *facetStart = 0;
581 const char *facetSort = 0;
583 (*p)->which = Z_SRW_searchRetrieve_request;
584 req = (*p)->u.request = (Z_SRW_searchRetrieveRequest *)
585 odr_malloc(o, sizeof(*req));
586 req->queryType = "cql";
588 req->sort_type = Z_SRW_sort_type_none;
590 req->startRecord = 0;
591 req->maximumRecords = 0;
592 req->recordSchema = 0;
593 req->recordPacking = 0;
595 req->recordXPath = 0;
596 req->resultSetTTL = 0;
600 for (; ptr; ptr = ptr->next)
602 if (yaz_match_xsd_string(ptr, "version", o,
605 else if (yaz_match_xsd_string(ptr, "queryType", o,
608 else if (yaz_match_xsd_string(ptr, "query", o,
611 else if (yaz_match_xsd_string(ptr, "pQuery", o,
613 req->queryType = "pqf";
614 else if (yaz_match_xsd_string(ptr, "xQuery", o,
616 req->queryType = "xcql";
617 else if (yaz_match_xsd_integer(ptr, "startRecord", o,
620 else if (yaz_match_xsd_integer(ptr, "maximumRecords", o,
621 &req->maximumRecords))
623 else if (yaz_match_xsd_string(ptr, "recordPacking", o,
626 else if (yaz_match_xsd_string(ptr, "recordXMLEscaping", o,
629 else if (yaz_match_xsd_string(ptr, "recordSchema", o,
632 else if (yaz_match_xsd_string(ptr, "recordXPath", o,
635 else if (yaz_match_xsd_integer(ptr, "resultSetTTL", o,
638 else if (yaz_match_xsd_string(ptr, "sortKeys", o,
639 &req->sort.sortKeys))
640 req->sort_type = Z_SRW_sort_type_sort;
641 else if (yaz_match_xsd_string(ptr, "stylesheet", o,
644 else if (yaz_match_xsd_string(ptr, "database", o,
647 else if (yaz_match_xsd_string(ptr, "facetLimit", o,
648 (char**) &facetLimit))
650 else if (yaz_match_xsd_string(ptr, "facetStart", o,
651 (char**) &facetStart))
653 else if (yaz_match_xsd_string(ptr, "facetSort", o,
654 (char**) &facetSort))
659 /* should put proper diagnostic here */
662 if (!strcmp((*p)->srw_version, "2.0"))
664 req->recordPacking = recordXMLEscaping;
665 req->packing = recordPacking;
669 req->recordPacking = recordPacking;
671 yaz_sru_facet_request(o, &req->facetList, &facetLimit, &facetStart,
674 else if (!xmlStrcmp(method->name, BAD_CAST "searchRetrieveResponse"))
676 xmlNodePtr ptr = method->children;
677 Z_SRW_searchRetrieveResponse *res;
679 (*p)->which = Z_SRW_searchRetrieve_response;
680 res = (*p)->u.response = (Z_SRW_searchRetrieveResponse *)
681 odr_malloc(o, sizeof(*res));
683 res->numberOfRecords = 0;
684 res->resultCountPrecision = 0;
685 res->resultSetId = 0;
686 res->resultSetIdleTime = 0;
688 res->num_records = 0;
689 res->diagnostics = 0;
690 res->num_diagnostics = 0;
691 res->nextRecordPosition = 0;
693 res->suggestions = 0;
695 for (; ptr; ptr = ptr->next)
697 if (yaz_match_xsd_string(ptr, "version", o,
700 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
701 &(*p)->extraResponseData_buf,
702 &(*p)->extraResponseData_len))
704 else if (yaz_match_xsd_integer(ptr, "numberOfRecords", o,
705 &res->numberOfRecords))
707 else if (yaz_match_xsd_string(ptr, "resultCountPrecision", o,
708 &res->resultCountPrecision))
710 else if (yaz_match_xsd_string(ptr, "resultSetId", o,
713 else if (yaz_match_xsd_integer(ptr, "resultSetIdleTime", o,
714 &res->resultSetIdleTime))
716 else if (yaz_match_xsd_integer(ptr, "resultSetTTL", o,
717 &res->resultSetIdleTime))
719 else if (yaz_match_xsd_element(ptr, "records"))
720 yaz_srw_records(o, ptr, &res->records,
722 &res->num_records, client_data, 0);
723 else if (yaz_match_xsd_integer(ptr, "nextRecordPosition", o,
724 &res->nextRecordPosition))
726 else if (yaz_match_xsd_element(ptr, "diagnostics"))
727 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
728 &res->num_diagnostics,
730 else if (yaz_match_xsd_element(ptr, "facet_analysis"))
731 yaz_sru_proxy_decode_facets(o, ptr, &res->facetList);
732 else if (yaz_match_xsd_element(ptr, "facetedResults"))
733 yaz_sru_facet_response(o, &res->facetList, ptr);
736 else if (!xmlStrcmp(method->name, BAD_CAST "explainRequest"))
738 Z_SRW_explainRequest *req;
739 xmlNodePtr ptr = method->children;
741 (*p)->which = Z_SRW_explain_request;
742 req = (*p)->u.explain_request = (Z_SRW_explainRequest *)
743 odr_malloc(o, sizeof(*req));
744 req->recordPacking = 0;
748 for (; ptr; ptr = ptr->next)
750 if (yaz_match_xsd_string(ptr, "version", o,
753 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
754 &(*p)->extraResponseData_buf,
755 &(*p)->extraResponseData_len))
757 else if (yaz_match_xsd_string(ptr, "stylesheet", o,
760 else if (yaz_match_xsd_string(ptr, "recordPacking", o,
761 &req->recordPacking))
764 yaz_match_xsd_string(ptr, "database", o, &req->database);
767 else if (!xmlStrcmp(method->name, BAD_CAST "explainResponse"))
769 Z_SRW_explainResponse *res;
770 xmlNodePtr ptr = method->children;
772 (*p)->which = Z_SRW_explain_response;
773 res = (*p)->u.explain_response = (Z_SRW_explainResponse*)
774 odr_malloc(o, sizeof(*res));
775 res->diagnostics = 0;
776 res->num_diagnostics = 0;
777 res->record.recordSchema = 0;
778 res->record.recordData_buf = 0;
779 res->record.recordData_len = 0;
780 res->record.recordPosition = 0;
782 for (; ptr; ptr = ptr->next)
784 if (yaz_match_xsd_string(ptr, "version", o,
787 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
788 &(*p)->extraResponseData_buf,
789 &(*p)->extraResponseData_len))
791 else if (yaz_match_xsd_element(ptr, "record"))
792 yaz_srw_record(o, ptr, &res->record, &res->extra_record,
794 else if (yaz_match_xsd_element(ptr, "diagnostics"))
795 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
796 &res->num_diagnostics,
801 else if (!xmlStrcmp(method->name, BAD_CAST "scanRequest"))
803 Z_SRW_scanRequest *req;
804 xmlNodePtr ptr = method->children;
806 (*p)->which = Z_SRW_scan_request;
807 req = (*p)->u.scan_request = (Z_SRW_scanRequest *)
808 odr_malloc(o, sizeof(*req));
809 req->queryType = "cql";
811 req->responsePosition = 0;
812 req->maximumTerms = 0;
816 for (; ptr; ptr = ptr->next)
818 if (yaz_match_xsd_string(ptr, "version", o,
821 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
822 &(*p)->extraResponseData_buf,
823 &(*p)->extraResponseData_len))
825 else if (yaz_match_xsd_string(ptr, "scanClause", o,
828 else if (yaz_match_xsd_string(ptr, "pScanClause", o,
831 req->queryType = "pqf";
833 else if (yaz_match_xsd_integer(ptr, "responsePosition", o,
834 &req->responsePosition))
836 else if (yaz_match_xsd_integer(ptr, "maximumTerms", o,
839 else if (yaz_match_xsd_string(ptr, "stylesheet", o,
843 yaz_match_xsd_string(ptr, "database", o, &req->database);
846 else if (!xmlStrcmp(method->name, BAD_CAST "scanResponse"))
848 Z_SRW_scanResponse *res;
849 xmlNodePtr ptr = method->children;
851 (*p)->which = Z_SRW_scan_response;
852 res = (*p)->u.scan_response = (Z_SRW_scanResponse *)
853 odr_malloc(o, sizeof(*res));
856 res->diagnostics = 0;
857 res->num_diagnostics = 0;
859 for (; ptr; ptr = ptr->next)
861 if (yaz_match_xsd_string(ptr, "version", o,
864 else if (yaz_match_xsd_XML_n(ptr, "extraResponseData", o,
865 &(*p)->extraResponseData_buf,
866 &(*p)->extraResponseData_len))
868 else if (yaz_match_xsd_element(ptr, "terms"))
869 yaz_srw_terms(o, ptr, &res->terms,
870 &res->num_terms, client_data,
872 else if (yaz_match_xsd_element(ptr, "diagnostics"))
873 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
874 &res->num_diagnostics,
883 neg_version = yaz_negotiate_sru_version((*p)->srw_version);
885 (*p)->srw_version = neg_version;
887 else if (o->direction == ODR_ENCODE)
889 Z_SRW_PDU **p = handler_data;
892 int version2 = !(*p)->srw_version ||
893 strcmp((*p)->srw_version, "2.") > 0;
894 if ((*p)->which == Z_SRW_searchRetrieve_request)
896 Z_SRW_searchRetrieveRequest *req = (*p)->u.request;
897 const char *queryType = req->queryType;
899 ns = "http://docs.oasis-open.org/ns/search-ws/sruRequest";
900 ptr = xmlNewChild(pptr, 0, BAD_CAST "searchRetrieveRequest", 0);
901 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
902 xmlSetNs(ptr, ns_srw);
904 add_xsd_string(ptr, "version", (*p)->srw_version);
908 add_xsd_string(ptr, "queryType", queryType);
909 add_xsd_string(ptr, "query", req->query);
913 if (!queryType || !strcmp(queryType, "cql"))
914 add_xsd_string(ptr, "query", req->query);
915 else if (!strcmp(queryType, "xcql"))
916 add_xsd_string(ptr, "xQuery", req->query);
917 else if (!strcmp(queryType, "pqf"))
918 add_xsd_string(ptr, "pQuery", req->query);
920 add_xsd_integer(ptr, "startRecord", req->startRecord);
921 add_xsd_integer(ptr, "maximumRecords", req->maximumRecords);
924 add_xsd_string(ptr, "recordXMLEscaping", req->recordPacking);
925 add_xsd_string(ptr, "recordPacking", req->packing);
928 add_xsd_string(ptr, "recordPacking", req->recordPacking);
929 add_xsd_string(ptr, "recordSchema", req->recordSchema);
930 add_xsd_string(ptr, "recordXPath", req->recordXPath);
931 add_xsd_integer(ptr, "resultSetTTL", req->resultSetTTL);
932 switch (req->sort_type)
934 case Z_SRW_sort_type_none:
936 case Z_SRW_sort_type_sort:
937 add_xsd_string(ptr, "sortKeys", req->sort.sortKeys);
939 case Z_SRW_sort_type_xSort:
940 add_xsd_string(ptr, "xSortKeys", req->sort.xSortKeys);
943 add_xsd_string(ptr, "stylesheet", req->stylesheet);
944 add_xsd_string(ptr, "database", req->database);
946 const char *limit = 0;
947 const char *start = 0;
948 const char *sort = 0;
949 yaz_sru_facet_request(o, &req->facetList, &limit, &start,
951 add_xsd_string(ptr, "facetLimit", limit);
952 add_xsd_string(ptr, "facetStart", start);
953 add_xsd_string(ptr, "facetSort", sort);
956 else if ((*p)->which == Z_SRW_searchRetrieve_response)
958 Z_SRW_searchRetrieveResponse *res = (*p)->u.response;
960 ns = "http://docs.oasis-open.org/ns/search-ws/sruResponse";
961 ptr = xmlNewChild(pptr, 0, BAD_CAST "searchRetrieveResponse", 0);
962 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
963 xmlSetNs(ptr, ns_srw);
965 add_xsd_string(ptr, "version", (*p)->srw_version);
966 add_xsd_integer(ptr, "numberOfRecords", res->numberOfRecords);
967 add_xsd_string(ptr, "resultSetId", res->resultSetId);
969 version2 ? "resultSetTTL" : "resultSetIdleTime" ,
970 res->resultSetIdleTime);
971 if (res->num_records)
973 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "records", 0);
974 yaz_srw_records(o, rptr, &res->records, &res->extra_records,
976 client_data, version2);
978 add_xsd_integer(ptr, "nextRecordPosition",
979 res->nextRecordPosition);
980 if (res->num_diagnostics)
982 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
984 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
985 &res->num_diagnostics, client_data, ns);
987 if (res->resultCountPrecision)
988 add_xsd_string(ptr, "resultCountPrecision",
989 res->resultCountPrecision);
990 yaz_sru_facet_response(o, &res->facetList, ptr);
992 else if ((*p)->which == Z_SRW_explain_request)
994 Z_SRW_explainRequest *req = (*p)->u.explain_request;
996 ns = "http://docs.oasis-open.org/ns/search-ws/sruRequest";
997 ptr = xmlNewChild(pptr, 0, BAD_CAST "explainRequest", 0);
998 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
999 xmlSetNs(ptr, ns_srw);
1001 add_xsd_string(ptr, "version", (*p)->srw_version);
1004 add_xsd_string(ptr, "recordXMLEscaping", req->recordPacking);
1005 add_xsd_string(ptr, "recordPacking", req->packing);
1008 add_xsd_string(ptr, "recordPacking", req->recordPacking);
1009 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1010 add_xsd_string(ptr, "database", req->database);
1012 else if ((*p)->which == Z_SRW_explain_response)
1014 Z_SRW_explainResponse *res = (*p)->u.explain_response;
1016 ns = "http://docs.oasis-open.org/ns/search-ws/sruResponse";
1017 ptr = xmlNewChild(pptr, 0, BAD_CAST "explainResponse", 0);
1018 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1019 xmlSetNs(ptr, ns_srw);
1021 add_xsd_string(ptr, "version", (*p)->srw_version);
1024 xmlNodePtr ptr1 = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1025 yaz_srw_record(o, ptr1, &res->record, &res->extra_record,
1026 client_data, version2);
1028 if (res->num_diagnostics)
1030 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
1032 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1033 &res->num_diagnostics, client_data, ns);
1036 else if ((*p)->which == Z_SRW_scan_request)
1038 Z_SRW_scanRequest *req = (*p)->u.scan_request;
1039 const char *queryType = req->queryType;
1041 ns = "http://docs.oasis-open.org/ns/search-ws/scan";
1042 ptr = xmlNewChild(pptr, 0, BAD_CAST "scanRequest", 0);
1043 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1044 xmlSetNs(ptr, ns_srw);
1046 add_xsd_string(ptr, "version", (*p)->srw_version);
1050 if (queryType && strcmp(queryType, "cql"))
1051 add_xsd_string(ptr, "queryType", queryType);
1052 add_xsd_string(ptr, "scanClause", req->scanClause);
1056 if (!queryType || !strcmp(queryType, "cql"))
1057 add_xsd_string(ptr, "scanClause", req->scanClause);
1058 else if (!strcmp(queryType, "pqf"))
1059 add_xsd_string(ptr, "pScanClause", req->scanClause);
1061 add_xsd_integer(ptr, "responsePosition", req->responsePosition);
1062 add_xsd_integer(ptr, "maximumTerms", req->maximumTerms);
1063 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1064 add_xsd_string(ptr, "database", req->database);
1066 else if ((*p)->which == Z_SRW_scan_response)
1068 Z_SRW_scanResponse *res = (*p)->u.scan_response;
1070 ns = "http://docs.oasis-open.org/ns/search-ws/scan";
1071 ptr = xmlNewChild(pptr, 0, BAD_CAST "scanResponse", 0);
1072 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1073 xmlSetNs(ptr, ns_srw);
1075 add_xsd_string(ptr, "version", (*p)->srw_version);
1078 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "terms", 0);
1079 yaz_srw_terms(o, rptr, &res->terms, &res->num_terms,
1082 if (res->num_diagnostics)
1084 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
1086 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1087 &res->num_diagnostics, client_data, ns);
1092 if (ptr && (*p)->extraResponseData_len)
1093 add_XML_n(ptr, "extraResponseData",
1094 (*p)->extraResponseData_buf,
1095 (*p)->extraResponseData_len, ns_srw);
1102 int yaz_ucp_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
1103 void *client_data, const char *ns_ucp_str)
1105 xmlNodePtr pptr = (xmlNodePtr) vptr;
1106 const char *ns_srw_str = YAZ_XMLNS_SRU_v1_1;
1107 if (o->direction == ODR_DECODE)
1109 Z_SRW_PDU **p = handler_data;
1110 xmlNodePtr method = pptr->children;
1112 while (method && method->type == XML_TEXT_NODE)
1113 method = method->next;
1117 if (method->type != XML_ELEMENT_NODE)
1120 *p = yaz_srw_get_core_v_2_0(o);
1122 if (!xmlStrcmp(method->name, BAD_CAST "updateRequest"))
1124 xmlNodePtr ptr = method->children;
1125 Z_SRW_updateRequest *req;
1128 (*p)->which = Z_SRW_update_request;
1129 req = (*p)->u.update_request = (Z_SRW_updateRequest *)
1130 odr_malloc(o, sizeof(*req));
1134 req->recordVersions = 0;
1135 req->num_recordVersions = 0;
1137 req->extra_record = 0;
1138 req->extraRequestData_buf = 0;
1139 req->extraRequestData_len = 0;
1140 req->stylesheet = 0;
1142 for (; ptr; ptr = ptr->next)
1144 if (yaz_match_xsd_string(ptr, "version", o,
1145 &(*p)->srw_version))
1147 else if (yaz_match_xsd_string(ptr, "action", o,
1151 if (!strcmp(oper, "info:srw/action/1/delete"))
1152 req->operation = "delete";
1153 else if (!strcmp(oper,"info:srw/action/1/replace" ))
1154 req->operation = "replace";
1155 else if (!strcmp(oper, "info:srw/action/1/create"))
1156 req->operation = "insert";
1159 else if (yaz_match_xsd_string(ptr, "recordIdentifier", o,
1162 else if (yaz_match_xsd_element(ptr, "recordVersions" ) )
1163 yaz_srw_versions( o, ptr, &req->recordVersions,
1164 &req->num_recordVersions, client_data,
1166 else if (yaz_match_xsd_element(ptr, "record"))
1168 req->record = yaz_srw_get_record(o);
1169 yaz_srw_record(o, ptr, req->record, &req->extra_record,
1172 else if (yaz_match_xsd_string(ptr, "stylesheet", o,
1176 yaz_match_xsd_string(ptr, "database", o, &req->database);
1179 else if (!xmlStrcmp(method->name, BAD_CAST "updateResponse"))
1181 xmlNodePtr ptr = method->children;
1182 Z_SRW_updateResponse *res;
1184 (*p)->which = Z_SRW_update_response;
1185 res = (*p)->u.update_response = (Z_SRW_updateResponse *)
1186 odr_malloc(o, sizeof(*res));
1188 res->operationStatus = 0;
1190 res->recordVersions = 0;
1191 res->num_recordVersions = 0;
1192 res->diagnostics = 0;
1193 res->num_diagnostics = 0;
1195 res->extra_record = 0;
1196 res->extraResponseData_buf = 0;
1197 res->extraResponseData_len = 0;
1199 for (; ptr; ptr = ptr->next)
1201 if (yaz_match_xsd_string(ptr, "version", o,
1202 &(*p)->srw_version))
1204 else if (yaz_match_xsd_string(ptr, "operationStatus", o,
1205 &res->operationStatus ))
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, &res->recordVersions,
1212 &res->num_recordVersions,
1213 client_data, ns_ucp_str);
1214 else if (yaz_match_xsd_element(ptr, "record"))
1216 res->record = yaz_srw_get_record(o);
1217 yaz_srw_record(o, ptr, res->record, &res->extra_record,
1220 else if (yaz_match_xsd_element(ptr, "diagnostics"))
1221 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
1222 &res->num_diagnostics,
1223 client_data, ns_ucp_str);
1226 else if (!xmlStrcmp(method->name, BAD_CAST "explainUpdateRequest"))
1229 else if (!xmlStrcmp(method->name, BAD_CAST "explainUpdateResponse"))
1238 else if (o->direction == ODR_ENCODE)
1240 Z_SRW_PDU **p = handler_data;
1241 xmlNsPtr ns_ucp, ns_srw;
1243 if ((*p)->which == Z_SRW_update_request)
1245 Z_SRW_updateRequest *req = (*p)->u.update_request;
1246 xmlNodePtr ptr = xmlNewChild(pptr, 0, BAD_CAST "updateRequest", 0);
1247 ns_ucp = xmlNewNs(ptr, BAD_CAST ns_ucp_str, BAD_CAST "zu");
1248 xmlSetNs(ptr, ns_ucp);
1249 ns_srw = xmlNewNs(ptr, BAD_CAST ns_srw_str, BAD_CAST "zs");
1251 add_xsd_string_ns(ptr, "version", (*p)->srw_version, ns_srw);
1252 add_xsd_string(ptr, "action", req->operation);
1253 add_xsd_string(ptr, "recordIdentifier", req->recordId );
1254 if (req->recordVersions)
1255 yaz_srw_versions( o, ptr, &req->recordVersions,
1256 &req->num_recordVersions,
1257 client_data, ns_ucp_str);
1258 if (req->record && req->record->recordData_len)
1260 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1261 xmlSetNs(rptr, ns_srw);
1262 yaz_srw_record(o, rptr, req->record, &req->extra_record,
1265 if (req->extraRequestData_len)
1267 add_XML_n(ptr, "extraRequestData",
1268 req->extraRequestData_buf,
1269 req->extraRequestData_len, ns_srw);
1271 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1272 add_xsd_string(ptr, "database", req->database);
1274 else if ((*p)->which == Z_SRW_update_response)
1276 Z_SRW_updateResponse *res = (*p)->u.update_response;
1277 xmlNodePtr ptr = xmlNewChild(pptr, 0, (xmlChar *)
1278 "updateResponse", 0);
1279 ns_ucp = xmlNewNs(ptr, BAD_CAST ns_ucp_str, BAD_CAST "zu");
1280 xmlSetNs(ptr, ns_ucp);
1281 ns_srw = xmlNewNs(ptr, BAD_CAST ns_srw_str, BAD_CAST "zs");
1283 add_xsd_string_ns(ptr, "version", (*p)->srw_version, ns_srw);
1284 add_xsd_string(ptr, "operationStatus", res->operationStatus );
1285 add_xsd_string(ptr, "recordIdentifier", res->recordId );
1286 if (res->recordVersions)
1287 yaz_srw_versions(o, ptr, &res->recordVersions,
1288 &res->num_recordVersions,
1289 client_data, ns_ucp_str);
1290 if (res->record && res->record->recordData_len)
1292 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1293 xmlSetNs(rptr, ns_srw);
1294 yaz_srw_record(o, rptr, res->record, &res->extra_record,
1297 if (res->num_diagnostics)
1300 xmlNewNs(pptr, BAD_CAST YAZ_XMLNS_DIAG_v1_1,
1303 xmlNodePtr rptr = xmlNewChild(ptr, ns_diag, BAD_CAST "diagnostics", 0);
1304 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1305 &res->num_diagnostics, client_data,
1308 if (res->extraResponseData_len)
1309 add_XML_n(ptr, "extraResponseData",
1310 res->extraResponseData_buf,
1311 res->extraResponseData_len, ns_srw);
1325 * c-file-style: "Stroustrup"
1326 * indent-tabs-mode: nil
1328 * vim: shiftwidth=4 tabstop=8 expandtab