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 static void add_XML_n(xmlNodePtr ptr, const char *elem, char *val, int len,
29 xmlDocPtr doc = xmlParseMemory(val,len);
32 xmlNodePtr c = xmlNewChild(ptr, ns_ptr, BAD_CAST elem, 0);
33 xmlNodePtr t = xmlDocGetRootElement(doc);
34 xmlAddChild(c, xmlCopyNode(t,1));
40 xmlNodePtr add_xsd_string_n(xmlNodePtr ptr, const char *elem, const char *val,
45 xmlNodePtr c = xmlNewChild(ptr, 0, BAD_CAST elem, 0);
46 xmlNodePtr t = xmlNewTextLen(BAD_CAST val, len);
53 xmlNodePtr add_xsd_string_ns(xmlNodePtr ptr, const char *elem, const char *val,
58 xmlNodePtr c = xmlNewChild(ptr, ns_ptr, BAD_CAST elem, 0);
59 xmlNodePtr t = xmlNewText(BAD_CAST val);
66 xmlNodePtr add_xsd_string(xmlNodePtr ptr, const char *elem, const char *val)
68 return add_xsd_string_ns(ptr, elem, val, 0);
71 void add_xsd_integer(xmlNodePtr ptr, const char *elem,
77 sprintf(str, ODR_INT_PRINTF, *val);
78 xmlNewTextChild(ptr, 0, BAD_CAST elem, BAD_CAST str);
82 int match_element(xmlNodePtr ptr, const char *elem)
84 if (ptr->type == XML_ELEMENT_NODE && !xmlStrcmp(ptr->name, BAD_CAST elem))
93 int match_xsd_string_n(xmlNodePtr ptr, const char *elem, ODR o,
97 struct _xmlAttr *attr;
99 if (!match_element(ptr, elem))
102 for (attr = ptr->properties; attr; attr = attr->next)
103 if (!strcmp(attr->name, "type") &&
104 attr->children && attr->children->type == XML_TEXT_NODE)
106 const char *t = strchr(attr->children->content, ':');
110 t = attr->children->content;
111 if (!strcmp(t, "string"))
118 if (!ptr || ptr->type != XML_TEXT_NODE)
123 *val = odr_strdup(o, (const char *) ptr->content);
125 *len = xmlStrlen(ptr->content);
130 int match_xsd_string(xmlNodePtr ptr, const char *elem, ODR o, char **val)
132 return match_xsd_string_n(ptr, elem, o, val, 0);
135 static int match_xsd_XML_n2(xmlNodePtr ptr, const char *elem, ODR o,
136 char **val, int *len, int fixup_root)
139 int no_root_nodes = 0;
141 if (!match_element(ptr, elem))
144 buf = xmlBufferCreate();
146 /* Copy each element nodes at top.
147 In most cases there is only one root node.. At least one server
148 http://www.theeuropeanlibrary.org/sru/sru.pl
149 has multiple root nodes in recordData.
151 for (ptr = ptr->children; ptr; ptr = ptr->next)
153 if (ptr->type == XML_ELEMENT_NODE)
155 /* copy node to get NS right (bug #740). */
156 xmlNode *tmp = xmlCopyNode(ptr, 1);
158 xmlNodeDump(buf, tmp->doc, tmp, 0, 0);
164 if (no_root_nodes != 1 && fixup_root)
166 /* does not appear to be an XML document. Make it so */
167 xmlBufferAddHead(buf, (const xmlChar *) "<yaz_record>", -1);
168 xmlBufferAdd(buf, (const xmlChar *) "</yaz_record>", -1);
170 *val = (char *) odr_malloc(o, buf->use + 1);
171 memcpy(*val, buf->content, buf->use);
172 (*val)[buf->use] = '\0';
182 static int match_xsd_XML_n(xmlNodePtr ptr, const char *elem, ODR o,
183 char **val, int *len)
185 return match_xsd_XML_n2(ptr, elem, o, val, len, 0);
188 int match_xsd_integer(xmlNodePtr ptr, const char *elem, ODR o, Odr_int **val)
191 struct _xmlAttr *attr;
193 if (!match_element(ptr, elem))
196 for (attr = ptr->properties; attr; attr = attr->next)
197 if (!strcmp(attr->name, "type") &&
198 attr->children && attr->children->type == XML_TEXT_NODE)
200 const char *t = strchr(attr->children->content, ':');
204 t = attr->children->content;
205 if (!strcmp(t, "integer"))
212 if (!ptr || ptr->type != XML_TEXT_NODE)
214 *val = odr_intdup(o, odr_atoi((const char *) ptr->content));
218 char *yaz_negotiate_sru_version(char *input_ver)
222 if (!strcmp(input_ver, "1.1"))
224 if (!strncmp(input_ver, "1.", 2))
226 if (!strncmp(input_ver, "2.", 2))
231 static int yaz_srw_record(ODR o, xmlNodePtr pptr, Z_SRW_record *rec,
232 Z_SRW_extra_record **extra,
233 void *client_data, int version2)
235 if (o->direction == ODR_DECODE)
237 Z_SRW_extra_record ex;
244 rec->recordSchema = 0;
245 rec->recordData_buf = 0;
246 rec->recordData_len = 0;
247 rec->recordPosition = 0;
250 ex.extraRecordData_buf = 0;
251 ex.extraRecordData_len = 0;
252 ex.recordIdentifier = 0;
254 for (ptr = pptr->children; ptr; ptr = ptr->next)
257 if (match_xsd_string(ptr, "recordSchema", o,
260 else if (match_xsd_string(ptr, "recordPacking", o, &spack))
261 ; /* can't rely on it: in SRU 2.0 it's different semantics */
262 else if (match_xsd_integer(ptr, "recordPosition", o,
263 &rec->recordPosition))
265 else if (match_element(ptr, "recordData"))
267 /* we assume XML packing, if any element nodes exist below
268 recordData. Unfortunately, in SRU 2.0 recordPacking
269 means something different */
270 xmlNode *p = ptr->children;
271 for (; p; p = p->next)
272 if (p->type == XML_ELEMENT_NODE)
277 ptr, "recordData", o,
278 &rec->recordData_buf, &rec->recordData_len, 1);
279 rec->recordPacking = Z_SRW_recordPacking_XML;
284 ptr, "recordData", o,
285 &rec->recordData_buf, &rec->recordData_len);
286 rec->recordPacking = Z_SRW_recordPacking_string;
289 else if (match_xsd_XML_n(ptr, "extraRecordData", o,
290 &ex.extraRecordData_buf,
291 &ex.extraRecordData_len) )
294 match_xsd_string(ptr, "recordIdentifier", o,
295 &ex.recordIdentifier);
297 if (ex.extraRecordData_buf || ex.recordIdentifier)
299 *extra = (Z_SRW_extra_record *)
300 odr_malloc(o, sizeof(Z_SRW_extra_record));
301 memcpy(*extra, &ex, sizeof(Z_SRW_extra_record));
304 else if (o->direction == ODR_ENCODE)
306 xmlNodePtr ptr = pptr;
307 int pack = rec->recordPacking;
308 const char *spack = yaz_srw_pack_to_str(pack);
310 add_xsd_string(ptr, "recordSchema", rec->recordSchema);
314 add_xsd_string(ptr, "recordXMLEscaping", spack);
316 add_xsd_string(ptr, "recordPacking", spack);
320 case Z_SRW_recordPacking_string:
321 add_xsd_string_n(ptr, "recordData", rec->recordData_buf,
322 rec->recordData_len);
324 case Z_SRW_recordPacking_XML:
325 add_XML_n(ptr, "recordData", rec->recordData_buf,
326 rec->recordData_len, 0);
328 case Z_SRW_recordPacking_URL:
329 add_xsd_string_n(ptr, "recordData", rec->recordData_buf,
330 rec->recordData_len);
333 if (rec->recordPosition)
334 add_xsd_integer(ptr, "recordPosition", rec->recordPosition );
337 if ((*extra)->recordIdentifier)
338 add_xsd_string(ptr, "recordIdentifier",
339 (*extra)->recordIdentifier);
340 if ((*extra)->extraRecordData_buf)
341 add_XML_n(ptr, "extraRecordData",
342 (*extra)->extraRecordData_buf,
343 (*extra)->extraRecordData_len, 0);
349 static int yaz_srw_records(ODR o, xmlNodePtr pptr, Z_SRW_record **recs,
350 Z_SRW_extra_record ***extra,
351 int *num, void *client_data, int version2)
353 if (o->direction == ODR_DECODE)
358 for (ptr = pptr->children; ptr; ptr = ptr->next)
360 if (ptr->type == XML_ELEMENT_NODE &&
361 !xmlStrcmp(ptr->name, BAD_CAST "record"))
366 *recs = (Z_SRW_record *) odr_malloc(o, *num * sizeof(**recs));
367 *extra = (Z_SRW_extra_record **) odr_malloc(o, *num * sizeof(**extra));
368 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next)
370 if (ptr->type == XML_ELEMENT_NODE &&
371 !xmlStrcmp(ptr->name, BAD_CAST "record"))
373 yaz_srw_record(o, ptr, *recs + i, *extra + i, client_data, 0);
378 else if (o->direction == ODR_ENCODE)
381 for (i = 0; i < *num; i++)
383 xmlNodePtr rptr = xmlNewChild(pptr, 0, BAD_CAST "record",
385 yaz_srw_record(o, rptr, (*recs)+i, (*extra ? *extra + i : 0),
386 client_data, version2);
392 static int yaz_srw_version(ODR o, xmlNodePtr pptr, Z_SRW_recordVersion *rec,
393 void *client_data, const char *ns)
395 if (o->direction == ODR_DECODE)
398 rec->versionType = 0;
399 rec->versionValue = 0;
400 for (ptr = pptr->children; ptr; ptr = ptr->next)
403 if (match_xsd_string(ptr, "versionType", o,
407 match_xsd_string(ptr, "versionValue", o, &rec->versionValue);
410 else if (o->direction == ODR_ENCODE)
412 xmlNodePtr ptr = pptr;
413 add_xsd_string(ptr, "versionType", rec->versionType);
414 add_xsd_string(ptr, "versionValue", rec->versionValue);
419 static int yaz_srw_versions(ODR o, xmlNodePtr pptr,
420 Z_SRW_recordVersion **vers,
421 int *num, void *client_data, const char *ns)
423 if (o->direction == ODR_DECODE)
428 for (ptr = pptr->children; ptr; ptr = ptr->next)
430 if (ptr->type == XML_ELEMENT_NODE &&
431 !xmlStrcmp(ptr->name, BAD_CAST "recordVersion"))
436 *vers = (Z_SRW_recordVersion *) odr_malloc(o, *num * sizeof(**vers));
437 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next)
439 if (ptr->type == XML_ELEMENT_NODE &&
440 !xmlStrcmp(ptr->name, BAD_CAST "recordVersion"))
442 yaz_srw_version(o, ptr, *vers + i, client_data, ns);
447 else if (o->direction == ODR_ENCODE)
450 for (i = 0; i < *num; i++)
452 xmlNodePtr rptr = xmlNewChild(pptr, 0, BAD_CAST "version",
454 yaz_srw_version(o, rptr, (*vers)+i, client_data, ns);
460 Z_FacetTerm *yaz_sru_proxy_get_facet_term_count(ODR odr, xmlNodePtr node)
464 WRBUF wrbuf = wrbuf_alloc();
465 Z_FacetTerm *facet_term;
466 const char *freq_string = yaz_element_attribute_value_get(
467 node, "facetvalue", "est_representation");
469 freq = odr_atoi(freq_string);
473 for (child = node->children; child ; child = child->next)
475 if (child->type == XML_TEXT_NODE)
476 wrbuf_puts(wrbuf, (const char *) child->content);
478 facet_term = facet_term_create_cstr(odr, wrbuf_cstr(wrbuf), freq);
479 wrbuf_destroy(wrbuf);
483 static Z_FacetField *yaz_sru_proxy_decode_facet_field(ODR odr, xmlNodePtr ptr)
485 Z_AttributeList *list;
486 Z_FacetField *facet_field;
491 const char* name = yaz_element_attribute_value_get(ptr, "facet", "code");
492 yaz_log(YLOG_DEBUG, "sru-proxy facet type: %s", name);
494 list = yaz_use_attribute_create(odr, name);
495 for (node = ptr->children; node; node = node->next) {
496 if (match_element(node, "facetvalue"))
499 facet_field = facet_field_create(odr, list, num_terms);
501 for (node = ptr->children; node; node = node->next)
503 if (match_element(node, "facetvalue"))
505 facet_field_term_set(odr, facet_field,
506 yaz_sru_proxy_get_facet_term_count(odr, node),
514 static int yaz_sru_proxy_decode_facets(ODR o, xmlNodePtr root,
515 Z_FacetList **facetList)
519 for (ptr = root->children; ptr; ptr = ptr->next)
521 if (match_element(ptr, "facets"))
524 Z_FacetList *facet_list;
526 for (node = ptr->children; node; node= node->next)
528 if (node->type == XML_ELEMENT_NODE)
531 facet_list = facet_list_create(o, num_facets);
533 for (node = ptr->children; node; node= node->next)
535 if (match_element(node, "facet"))
537 facet_list_field_set(
539 yaz_sru_proxy_decode_facet_field(o, node), num_facets);
543 *facetList = facet_list;
552 static int yaz_srw_decode_diagnostics(ODR o, xmlNodePtr pptr,
553 Z_SRW_diagnostic **recs, int *num,
554 void *client_data, const char *ns)
559 for (ptr = pptr; ptr; ptr = ptr->next)
561 if (ptr->type == XML_ELEMENT_NODE &&
562 !xmlStrcmp(ptr->name, BAD_CAST "diagnostic"))
567 *recs = (Z_SRW_diagnostic *) odr_malloc(o, *num * sizeof(**recs));
568 for (i = 0; i < *num; i++)
571 (*recs)[i].details = 0;
572 (*recs)[i].message = 0;
574 for (i = 0, ptr = pptr; ptr; ptr = ptr->next)
576 if (ptr->type == XML_ELEMENT_NODE &&
577 !xmlStrcmp(ptr->name, BAD_CAST "diagnostic"))
581 (*recs)[i].details = 0;
582 (*recs)[i].message = 0;
583 for (rptr = ptr->children; rptr; rptr = rptr->next)
585 if (match_xsd_string(rptr, "uri", o,
588 else if (match_xsd_string(rptr, "details", o,
589 &(*recs)[i].details))
592 match_xsd_string(rptr, "message", o, &(*recs)[i].message);
600 int sru_decode_surrogate_diagnostics(const char *buf, size_t len,
601 Z_SRW_diagnostic **diag,
605 xmlDocPtr doc = xmlParseMemory(buf, len);
608 xmlNodePtr ptr = xmlDocGetRootElement(doc);
609 while (ptr && ptr->type != XML_ELEMENT_NODE)
612 && !xmlStrcmp(ptr->ns->href,
613 BAD_CAST "http://www.loc.gov/zing/srw/diagnostic/"))
615 ret = yaz_srw_decode_diagnostics(odr, ptr, diag, num, 0, 0);
622 static int yaz_srw_diagnostics(ODR o, xmlNodePtr pptr, Z_SRW_diagnostic **recs,
623 int *num, void *client_data, const char *ns)
625 if (o->direction == ODR_DECODE)
627 return yaz_srw_decode_diagnostics(o, pptr->children, recs, num, client_data, ns);
629 else if (o->direction == ODR_ENCODE)
633 xmlNewNs(pptr, BAD_CAST YAZ_XMLNS_DIAG_v1_1, BAD_CAST "diag" );
634 for (i = 0; i < *num; i++)
636 const char *std_diag = "info:srw/diagnostic/1/";
637 const char *ucp_diag = "info:srw/diagnostic/12/";
638 xmlNodePtr rptr = xmlNewChild(pptr, ns_diag,
639 BAD_CAST "diagnostic", 0);
640 add_xsd_string(rptr, "uri", (*recs)[i].uri);
641 if ((*recs)[i].message)
642 add_xsd_string(rptr, "message", (*recs)[i].message);
643 else if ((*recs)[i].uri )
645 if (!strncmp((*recs)[i].uri, std_diag, strlen(std_diag)))
647 int no = atoi((*recs)[i].uri + strlen(std_diag));
648 const char *message = yaz_diag_srw_str(no);
650 add_xsd_string(rptr, "message", message);
652 else if (!strncmp((*recs)[i].uri, ucp_diag, strlen(ucp_diag)))
654 int no = atoi((*recs)[i].uri + strlen(ucp_diag));
655 const char *message = yaz_diag_sru_update_str(no);
657 add_xsd_string(rptr, "message", message);
660 add_xsd_string(rptr, "details", (*recs)[i].details);
666 static int yaz_srw_term(ODR o, xmlNodePtr pptr, Z_SRW_scanTerm *term,
667 void *client_data, const char *ns)
669 if (o->direction == ODR_DECODE)
673 term->numberOfRecords = 0;
674 term->displayTerm = 0;
675 term->whereInList = 0;
676 for (ptr = pptr->children; ptr; ptr = ptr->next)
678 if (match_xsd_string(ptr, "value", o, &term->value))
680 else if (match_xsd_integer(ptr, "numberOfRecords", o,
681 &term->numberOfRecords))
683 else if (match_xsd_string(ptr, "displayTerm", o,
687 match_xsd_string(ptr, "whereInList", o, &term->whereInList);
690 else if (o->direction == ODR_ENCODE)
692 xmlNodePtr ptr = pptr;
693 add_xsd_string(ptr, "value", term->value);
694 add_xsd_integer(ptr, "numberOfRecords", term->numberOfRecords);
695 add_xsd_string(ptr, "displayTerm", term->displayTerm);
696 add_xsd_string(ptr, "whereInList", term->whereInList);
701 static int yaz_srw_terms(ODR o, xmlNodePtr pptr, Z_SRW_scanTerm **terms,
702 int *num, void *client_data, const char *ns)
704 if (o->direction == ODR_DECODE)
709 for (ptr = pptr->children; ptr; ptr = ptr->next)
711 if (ptr->type == XML_ELEMENT_NODE &&
712 !xmlStrcmp(ptr->name, BAD_CAST "term"))
717 *terms = (Z_SRW_scanTerm *) odr_malloc(o, *num * sizeof(**terms));
718 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next, i++)
720 if (ptr->type == XML_ELEMENT_NODE &&
721 !xmlStrcmp(ptr->name, BAD_CAST "term"))
722 yaz_srw_term(o, ptr, (*terms)+i, client_data, ns);
725 else if (o->direction == ODR_ENCODE)
728 for (i = 0; i < *num; i++)
730 xmlNodePtr rptr = xmlNewChild(pptr, 0, BAD_CAST "term", 0);
731 yaz_srw_term(o, rptr, (*terms)+i, client_data, ns);
737 int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
738 void *client_data, const char *ns)
740 xmlNodePtr pptr = (xmlNodePtr) vptr;
741 if (o->direction == ODR_DECODE)
743 Z_SRW_PDU **p = handler_data;
744 xmlNodePtr method = pptr->children;
747 while (method && method->type == XML_TEXT_NODE)
748 method = method->next;
752 if (method->type != XML_ELEMENT_NODE)
755 *p = yaz_srw_get_core_v_2_0(o);
757 if (!xmlStrcmp(method->name, BAD_CAST "searchRetrieveRequest"))
759 xmlNodePtr ptr = method->children;
760 Z_SRW_searchRetrieveRequest *req;
761 char *recordPacking = 0;
762 char *recordXMLEscaping = 0;
763 const char *facetLimit = 0;
765 (*p)->which = Z_SRW_searchRetrieve_request;
766 req = (*p)->u.request = (Z_SRW_searchRetrieveRequest *)
767 odr_malloc(o, sizeof(*req));
768 req->queryType = "cql";
770 req->sort_type = Z_SRW_sort_type_none;
772 req->startRecord = 0;
773 req->maximumRecords = 0;
774 req->recordSchema = 0;
775 req->recordPacking = 0;
777 req->recordXPath = 0;
778 req->resultSetTTL = 0;
782 for (; ptr; ptr = ptr->next)
784 if (match_xsd_string(ptr, "version", o,
787 else if (match_xsd_string(ptr, "queryType", o,
790 else if (match_xsd_string(ptr, "query", o,
793 else if (match_xsd_string(ptr, "pQuery", o,
795 req->queryType = "pqf";
796 else if (match_xsd_string(ptr, "xQuery", o,
798 req->queryType = "xcql";
799 else if (match_xsd_integer(ptr, "startRecord", o,
802 else if (match_xsd_integer(ptr, "maximumRecords", o,
803 &req->maximumRecords))
805 else if (match_xsd_string(ptr, "recordPacking", o,
808 else if (match_xsd_string(ptr, "recordXMLEscaping", o,
811 else if (match_xsd_string(ptr, "recordSchema", o,
814 else if (match_xsd_string(ptr, "recordXPath", o,
817 else if (match_xsd_integer(ptr, "resultSetTTL", o,
820 else if (match_xsd_string(ptr, "sortKeys", o,
821 &req->sort.sortKeys))
822 req->sort_type = Z_SRW_sort_type_sort;
823 else if (match_xsd_string(ptr, "stylesheet", o,
826 else if (match_xsd_string(ptr, "database", o, &req->database))
828 else if (match_xsd_string(ptr, "facetLimit", o,
829 (char**) &facetLimit))
834 /* should put proper diagnostic here */
837 if (!strcmp((*p)->srw_version, "2.0"))
839 req->recordPacking = recordXMLEscaping;
840 req->packing = recordPacking;
844 req->recordPacking = recordPacking;
846 yaz_sru_facet_request(o, &req->facetList, &facetLimit);
848 else if (!xmlStrcmp(method->name, BAD_CAST "searchRetrieveResponse"))
850 xmlNodePtr ptr = method->children;
851 Z_SRW_searchRetrieveResponse *res;
853 (*p)->which = Z_SRW_searchRetrieve_response;
854 res = (*p)->u.response = (Z_SRW_searchRetrieveResponse *)
855 odr_malloc(o, sizeof(*res));
857 res->numberOfRecords = 0;
858 res->resultCountPrecision = 0;
859 res->resultSetId = 0;
860 res->resultSetIdleTime = 0;
862 res->num_records = 0;
863 res->diagnostics = 0;
864 res->num_diagnostics = 0;
865 res->nextRecordPosition = 0;
867 res->suggestions = 0;
869 for (; ptr; ptr = ptr->next)
871 if (match_xsd_string(ptr, "version", o,
874 else if (match_xsd_XML_n(ptr, "extraResponseData", o,
875 &(*p)->extraResponseData_buf,
876 &(*p)->extraResponseData_len))
878 else if (match_xsd_integer(ptr, "numberOfRecords", o,
879 &res->numberOfRecords))
881 else if (match_xsd_string(ptr, "resultCountPrecision", o,
882 &res->resultCountPrecision))
884 else if (match_xsd_string(ptr, "resultSetId", o,
887 else if (match_xsd_integer(ptr, "resultSetIdleTime", o,
888 &res->resultSetIdleTime))
890 else if (match_xsd_integer(ptr, "resultSetTTL", o,
891 &res->resultSetIdleTime))
893 else if (match_element(ptr, "records"))
894 yaz_srw_records(o, ptr, &res->records,
896 &res->num_records, client_data, 0);
897 else if (match_xsd_integer(ptr, "nextRecordPosition", o,
898 &res->nextRecordPosition))
900 else if (match_element(ptr, "diagnostics"))
901 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
902 &res->num_diagnostics,
904 else if (match_element(ptr, "facet_analysis"))
905 yaz_sru_proxy_decode_facets(o, ptr, &res->facetList);
906 else if (match_element(ptr, "facetedResults"))
907 yaz_sru_facet_response(o, &res->facetList, ptr);
910 else if (!xmlStrcmp(method->name, BAD_CAST "explainRequest"))
912 Z_SRW_explainRequest *req;
913 xmlNodePtr ptr = method->children;
915 (*p)->which = Z_SRW_explain_request;
916 req = (*p)->u.explain_request = (Z_SRW_explainRequest *)
917 odr_malloc(o, sizeof(*req));
918 req->recordPacking = 0;
922 for (; ptr; ptr = ptr->next)
924 if (match_xsd_string(ptr, "version", o,
927 else if (match_xsd_XML_n(ptr, "extraResponseData", o,
928 &(*p)->extraResponseData_buf,
929 &(*p)->extraResponseData_len))
931 else if (match_xsd_string(ptr, "stylesheet", o,
934 else if (match_xsd_string(ptr, "recordPacking", o,
935 &req->recordPacking))
938 match_xsd_string(ptr, "database", o, &req->database);
941 else if (!xmlStrcmp(method->name, BAD_CAST "explainResponse"))
943 Z_SRW_explainResponse *res;
944 xmlNodePtr ptr = method->children;
946 (*p)->which = Z_SRW_explain_response;
947 res = (*p)->u.explain_response = (Z_SRW_explainResponse*)
948 odr_malloc(o, sizeof(*res));
949 res->diagnostics = 0;
950 res->num_diagnostics = 0;
951 res->record.recordSchema = 0;
952 res->record.recordData_buf = 0;
953 res->record.recordData_len = 0;
954 res->record.recordPosition = 0;
956 for (; ptr; ptr = ptr->next)
958 if (match_xsd_string(ptr, "version", o,
961 else if (match_xsd_XML_n(ptr, "extraResponseData", o,
962 &(*p)->extraResponseData_buf,
963 &(*p)->extraResponseData_len))
965 else if (match_element(ptr, "record"))
966 yaz_srw_record(o, ptr, &res->record, &res->extra_record,
968 else if (match_element(ptr, "diagnostics"))
969 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
970 &res->num_diagnostics,
975 else if (!xmlStrcmp(method->name, BAD_CAST "scanRequest"))
977 Z_SRW_scanRequest *req;
978 xmlNodePtr ptr = method->children;
980 (*p)->which = Z_SRW_scan_request;
981 req = (*p)->u.scan_request = (Z_SRW_scanRequest *)
982 odr_malloc(o, sizeof(*req));
983 req->queryType = "cql";
985 req->responsePosition = 0;
986 req->maximumTerms = 0;
990 for (; ptr; ptr = ptr->next)
992 if (match_xsd_string(ptr, "version", o,
995 else if (match_xsd_XML_n(ptr, "extraResponseData", o,
996 &(*p)->extraResponseData_buf,
997 &(*p)->extraResponseData_len))
999 else if (match_xsd_string(ptr, "scanClause", o,
1002 else if (match_xsd_string(ptr, "pScanClause", o,
1005 req->queryType = "pqf";
1007 else if (match_xsd_integer(ptr, "responsePosition", o,
1008 &req->responsePosition))
1010 else if (match_xsd_integer(ptr, "maximumTerms", o,
1011 &req->maximumTerms))
1013 else if (match_xsd_string(ptr, "stylesheet", o,
1017 match_xsd_string(ptr, "database", o, &req->database);
1020 else if (!xmlStrcmp(method->name, BAD_CAST "scanResponse"))
1022 Z_SRW_scanResponse *res;
1023 xmlNodePtr ptr = method->children;
1025 (*p)->which = Z_SRW_scan_response;
1026 res = (*p)->u.scan_response = (Z_SRW_scanResponse *)
1027 odr_malloc(o, sizeof(*res));
1030 res->diagnostics = 0;
1031 res->num_diagnostics = 0;
1033 for (; ptr; ptr = ptr->next)
1035 if (match_xsd_string(ptr, "version", o,
1036 &(*p)->srw_version))
1038 else if (match_xsd_XML_n(ptr, "extraResponseData", o,
1039 &(*p)->extraResponseData_buf,
1040 &(*p)->extraResponseData_len))
1042 else if (match_element(ptr, "terms"))
1043 yaz_srw_terms(o, ptr, &res->terms,
1044 &res->num_terms, client_data,
1046 else if (match_element(ptr, "diagnostics"))
1047 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
1048 &res->num_diagnostics,
1057 neg_version = yaz_negotiate_sru_version((*p)->srw_version);
1059 (*p)->srw_version = neg_version;
1061 else if (o->direction == ODR_ENCODE)
1063 Z_SRW_PDU **p = handler_data;
1066 int version2 = !(*p)->srw_version ||
1067 strcmp((*p)->srw_version, "2.") > 0;
1068 if ((*p)->which == Z_SRW_searchRetrieve_request)
1070 Z_SRW_searchRetrieveRequest *req = (*p)->u.request;
1071 const char *queryType = req->queryType;
1073 ns = "http://docs.oasis-open.org/ns/search-ws/sruRequest";
1074 ptr = xmlNewChild(pptr, 0, BAD_CAST "searchRetrieveRequest", 0);
1075 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1076 xmlSetNs(ptr, ns_srw);
1078 add_xsd_string(ptr, "version", (*p)->srw_version);
1082 add_xsd_string(ptr, "queryType", queryType);
1083 add_xsd_string(ptr, "query", req->query);
1087 if (!queryType || !strcmp(queryType, "cql"))
1088 add_xsd_string(ptr, "query", req->query);
1089 else if (!strcmp(queryType, "xcql"))
1090 add_xsd_string(ptr, "xQuery", req->query);
1091 else if (!strcmp(queryType, "pqf"))
1092 add_xsd_string(ptr, "pQuery", req->query);
1094 add_xsd_integer(ptr, "startRecord", req->startRecord);
1095 add_xsd_integer(ptr, "maximumRecords", req->maximumRecords);
1098 add_xsd_string(ptr, "recordXMLEscaping", req->recordPacking);
1099 add_xsd_string(ptr, "recordPacking", req->packing);
1102 add_xsd_string(ptr, "recordPacking", req->recordPacking);
1103 add_xsd_string(ptr, "recordSchema", req->recordSchema);
1104 add_xsd_string(ptr, "recordXPath", req->recordXPath);
1105 add_xsd_integer(ptr, "resultSetTTL", req->resultSetTTL);
1106 switch (req->sort_type)
1108 case Z_SRW_sort_type_none:
1110 case Z_SRW_sort_type_sort:
1111 add_xsd_string(ptr, "sortKeys", req->sort.sortKeys);
1113 case Z_SRW_sort_type_xSort:
1114 add_xsd_string(ptr, "xSortKeys", req->sort.xSortKeys);
1117 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1118 add_xsd_string(ptr, "database", req->database);
1120 const char *limit = 0;
1121 yaz_sru_facet_request(o, &req->facetList, &limit);
1122 add_xsd_string(ptr, "facetLimit", limit);
1125 else if ((*p)->which == Z_SRW_searchRetrieve_response)
1127 Z_SRW_searchRetrieveResponse *res = (*p)->u.response;
1129 ns = "http://docs.oasis-open.org/ns/search-ws/sruResponse";
1130 ptr = xmlNewChild(pptr, 0, BAD_CAST "searchRetrieveResponse", 0);
1131 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1132 xmlSetNs(ptr, ns_srw);
1134 add_xsd_string(ptr, "version", (*p)->srw_version);
1135 add_xsd_integer(ptr, "numberOfRecords", res->numberOfRecords);
1136 add_xsd_string(ptr, "resultSetId", res->resultSetId);
1137 add_xsd_integer(ptr,
1138 version2 ? "resultSetTTL" : "resultSetIdleTime" ,
1139 res->resultSetIdleTime);
1140 if (res->num_records)
1142 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "records", 0);
1143 yaz_srw_records(o, rptr, &res->records, &res->extra_records,
1145 client_data, version2);
1147 add_xsd_integer(ptr, "nextRecordPosition",
1148 res->nextRecordPosition);
1149 if (res->num_diagnostics)
1151 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
1153 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1154 &res->num_diagnostics, client_data, ns);
1156 if (res->resultCountPrecision)
1157 add_xsd_string(ptr, "resultCountPrecision",
1158 res->resultCountPrecision);
1159 yaz_sru_facet_response(o, &res->facetList, ptr);
1161 else if ((*p)->which == Z_SRW_explain_request)
1163 Z_SRW_explainRequest *req = (*p)->u.explain_request;
1164 ptr = xmlNewChild(pptr, 0, BAD_CAST "explainRequest", 0);
1165 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1166 xmlSetNs(ptr, ns_srw);
1168 add_xsd_string(ptr, "version", (*p)->srw_version);
1171 add_xsd_string(ptr, "recordXMLEscaping", req->recordPacking);
1172 add_xsd_string(ptr, "recordPacking", req->packing);
1175 add_xsd_string(ptr, "recordPacking", req->recordPacking);
1176 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1177 add_xsd_string(ptr, "database", req->database);
1179 else if ((*p)->which == Z_SRW_explain_response)
1181 Z_SRW_explainResponse *res = (*p)->u.explain_response;
1182 ptr = xmlNewChild(pptr, 0, BAD_CAST "explainResponse", 0);
1183 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1184 xmlSetNs(ptr, ns_srw);
1186 add_xsd_string(ptr, "version", (*p)->srw_version);
1189 xmlNodePtr ptr1 = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1190 yaz_srw_record(o, ptr1, &res->record, &res->extra_record,
1191 client_data, version2);
1193 if (res->num_diagnostics)
1195 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
1197 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1198 &res->num_diagnostics, client_data, ns);
1201 else if ((*p)->which == Z_SRW_scan_request)
1203 Z_SRW_scanRequest *req = (*p)->u.scan_request;
1204 const char *queryType = req->queryType;
1206 ns = "http://docs.oasis-open.org/ns/search-ws/scan";
1207 ptr = xmlNewChild(pptr, 0, BAD_CAST "scanRequest", 0);
1208 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1209 xmlSetNs(ptr, ns_srw);
1211 add_xsd_string(ptr, "version", (*p)->srw_version);
1215 if (queryType && strcmp(queryType, "cql"))
1216 add_xsd_string(ptr, "queryType", queryType);
1217 add_xsd_string(ptr, "scanClause", req->scanClause);
1221 if (!queryType || !strcmp(queryType, "cql"))
1222 add_xsd_string(ptr, "scanClause", req->scanClause);
1223 else if (!strcmp(queryType, "pqf"))
1224 add_xsd_string(ptr, "pScanClause", req->scanClause);
1226 add_xsd_integer(ptr, "responsePosition", req->responsePosition);
1227 add_xsd_integer(ptr, "maximumTerms", req->maximumTerms);
1228 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1229 add_xsd_string(ptr, "database", req->database);
1231 else if ((*p)->which == Z_SRW_scan_response)
1233 Z_SRW_scanResponse *res = (*p)->u.scan_response;
1235 ns = "http://docs.oasis-open.org/ns/search-ws/scan";
1236 ptr = xmlNewChild(pptr, 0, BAD_CAST "scanResponse", 0);
1237 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1238 xmlSetNs(ptr, ns_srw);
1240 add_xsd_string(ptr, "version", (*p)->srw_version);
1243 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "terms", 0);
1244 yaz_srw_terms(o, rptr, &res->terms, &res->num_terms,
1247 if (res->num_diagnostics)
1249 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
1251 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1252 &res->num_diagnostics, client_data, ns);
1257 if (ptr && (*p)->extraResponseData_len)
1258 add_XML_n(ptr, "extraResponseData",
1259 (*p)->extraResponseData_buf,
1260 (*p)->extraResponseData_len, ns_srw);
1267 int yaz_ucp_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
1268 void *client_data, const char *ns_ucp_str)
1270 xmlNodePtr pptr = (xmlNodePtr) vptr;
1271 const char *ns_srw_str = YAZ_XMLNS_SRU_v1_1;
1272 if (o->direction == ODR_DECODE)
1274 Z_SRW_PDU **p = handler_data;
1275 xmlNodePtr method = pptr->children;
1277 while (method && method->type == XML_TEXT_NODE)
1278 method = method->next;
1282 if (method->type != XML_ELEMENT_NODE)
1285 *p = yaz_srw_get_core_v_2_0(o);
1287 if (!xmlStrcmp(method->name, BAD_CAST "updateRequest"))
1289 xmlNodePtr ptr = method->children;
1290 Z_SRW_updateRequest *req;
1293 (*p)->which = Z_SRW_update_request;
1294 req = (*p)->u.update_request = (Z_SRW_updateRequest *)
1295 odr_malloc(o, sizeof(*req));
1299 req->recordVersions = 0;
1300 req->num_recordVersions = 0;
1302 req->extra_record = 0;
1303 req->extraRequestData_buf = 0;
1304 req->extraRequestData_len = 0;
1305 req->stylesheet = 0;
1307 for (; ptr; ptr = ptr->next)
1309 if (match_xsd_string(ptr, "version", o,
1310 &(*p)->srw_version))
1312 else if (match_xsd_string(ptr, "action", o,
1316 if (!strcmp(oper, "info:srw/action/1/delete"))
1317 req->operation = "delete";
1318 else if (!strcmp(oper,"info:srw/action/1/replace" ))
1319 req->operation = "replace";
1320 else if (!strcmp(oper, "info:srw/action/1/create"))
1321 req->operation = "insert";
1324 else if (match_xsd_string(ptr, "recordIdentifier", o,
1327 else if (match_element(ptr, "recordVersions" ) )
1328 yaz_srw_versions( o, ptr, &req->recordVersions,
1329 &req->num_recordVersions, client_data,
1331 else if (match_element(ptr, "record"))
1333 req->record = yaz_srw_get_record(o);
1334 yaz_srw_record(o, ptr, req->record, &req->extra_record,
1337 else if (match_xsd_string(ptr, "stylesheet", o,
1341 match_xsd_string(ptr, "database", o, &req->database);
1344 else if (!xmlStrcmp(method->name, BAD_CAST "updateResponse"))
1346 xmlNodePtr ptr = method->children;
1347 Z_SRW_updateResponse *res;
1349 (*p)->which = Z_SRW_update_response;
1350 res = (*p)->u.update_response = (Z_SRW_updateResponse *)
1351 odr_malloc(o, sizeof(*res));
1353 res->operationStatus = 0;
1355 res->recordVersions = 0;
1356 res->num_recordVersions = 0;
1357 res->diagnostics = 0;
1358 res->num_diagnostics = 0;
1360 res->extra_record = 0;
1361 res->extraResponseData_buf = 0;
1362 res->extraResponseData_len = 0;
1364 for (; ptr; ptr = ptr->next)
1366 if (match_xsd_string(ptr, "version", o,
1367 &(*p)->srw_version))
1369 else if (match_xsd_string(ptr, "operationStatus", o,
1370 &res->operationStatus ))
1372 else if (match_xsd_string(ptr, "recordIdentifier", o,
1375 else if (match_element(ptr, "recordVersions" ))
1376 yaz_srw_versions(o, ptr, &res->recordVersions,
1377 &res->num_recordVersions,
1378 client_data, ns_ucp_str);
1379 else if (match_element(ptr, "record"))
1381 res->record = yaz_srw_get_record(o);
1382 yaz_srw_record(o, ptr, res->record, &res->extra_record,
1385 else if (match_element(ptr, "diagnostics"))
1386 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
1387 &res->num_diagnostics,
1388 client_data, ns_ucp_str);
1391 else if (!xmlStrcmp(method->name, BAD_CAST "explainUpdateRequest"))
1394 else if (!xmlStrcmp(method->name, BAD_CAST "explainUpdateResponse"))
1403 else if (o->direction == ODR_ENCODE)
1405 Z_SRW_PDU **p = handler_data;
1406 xmlNsPtr ns_ucp, ns_srw;
1408 if ((*p)->which == Z_SRW_update_request)
1410 Z_SRW_updateRequest *req = (*p)->u.update_request;
1411 xmlNodePtr ptr = xmlNewChild(pptr, 0, BAD_CAST "updateRequest", 0);
1412 ns_ucp = xmlNewNs(ptr, BAD_CAST ns_ucp_str, BAD_CAST "zu");
1413 xmlSetNs(ptr, ns_ucp);
1414 ns_srw = xmlNewNs(ptr, BAD_CAST ns_srw_str, BAD_CAST "zs");
1416 add_xsd_string_ns(ptr, "version", (*p)->srw_version, ns_srw);
1417 add_xsd_string(ptr, "action", req->operation);
1418 add_xsd_string(ptr, "recordIdentifier", req->recordId );
1419 if (req->recordVersions)
1420 yaz_srw_versions( o, ptr, &req->recordVersions,
1421 &req->num_recordVersions,
1422 client_data, ns_ucp_str);
1423 if (req->record && req->record->recordData_len)
1425 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1426 xmlSetNs(rptr, ns_srw);
1427 yaz_srw_record(o, rptr, req->record, &req->extra_record,
1430 if (req->extraRequestData_len)
1432 add_XML_n(ptr, "extraRequestData",
1433 req->extraRequestData_buf,
1434 req->extraRequestData_len, ns_srw);
1436 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1437 add_xsd_string(ptr, "database", req->database);
1439 else if ((*p)->which == Z_SRW_update_response)
1441 Z_SRW_updateResponse *res = (*p)->u.update_response;
1442 xmlNodePtr ptr = xmlNewChild(pptr, 0, (xmlChar *)
1443 "updateResponse", 0);
1444 ns_ucp = xmlNewNs(ptr, BAD_CAST ns_ucp_str, BAD_CAST "zu");
1445 xmlSetNs(ptr, ns_ucp);
1446 ns_srw = xmlNewNs(ptr, BAD_CAST ns_srw_str, BAD_CAST "zs");
1448 add_xsd_string_ns(ptr, "version", (*p)->srw_version, ns_srw);
1449 add_xsd_string(ptr, "operationStatus", res->operationStatus );
1450 add_xsd_string(ptr, "recordIdentifier", res->recordId );
1451 if (res->recordVersions)
1452 yaz_srw_versions(o, ptr, &res->recordVersions,
1453 &res->num_recordVersions,
1454 client_data, ns_ucp_str);
1455 if (res->record && res->record->recordData_len)
1457 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1458 xmlSetNs(rptr, ns_srw);
1459 yaz_srw_record(o, rptr, res->record, &res->extra_record,
1462 if (res->num_diagnostics)
1465 xmlNewNs(pptr, BAD_CAST YAZ_XMLNS_DIAG_v1_1,
1468 xmlNodePtr rptr = xmlNewChild(ptr, ns_diag, BAD_CAST "diagnostics", 0);
1469 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1470 &res->num_diagnostics, client_data,
1473 if (res->extraResponseData_len)
1474 add_XML_n(ptr, "extraResponseData",
1475 res->extraResponseData_buf,
1476 res->extraResponseData_len, ns_srw);
1490 * c-file-style: "Stroustrup"
1491 * indent-tabs-mode: nil
1493 * vim: shiftwidth=4 tabstop=8 expandtab