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>
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 static 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 static int match_element(xmlNodePtr ptr, const char *elem)
84 if (ptr->type == XML_ELEMENT_NODE && !xmlStrcmp(ptr->name, BAD_CAST elem))
93 static 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 static int match_xsd_string(xmlNodePtr ptr, const char *elem, ODR o,
133 return match_xsd_string_n(ptr, elem, o, val, 0);
136 static int match_xsd_XML_n2(xmlNodePtr ptr, const char *elem, ODR o,
137 char **val, int *len, int fixup_root)
140 int no_root_nodes = 0;
142 if (!match_element(ptr, elem))
145 buf = xmlBufferCreate();
147 /* Copy each element nodes at top.
148 In most cases there is only one root node.. At least one server
149 http://www.theeuropeanlibrary.org/sru/sru.pl
150 has multiple root nodes in recordData.
152 for (ptr = ptr->children; ptr; ptr = ptr->next)
154 if (ptr->type == XML_ELEMENT_NODE)
156 /* copy node to get NS right (bug #740). */
157 xmlNode *tmp = xmlCopyNode(ptr, 1);
159 xmlNodeDump(buf, tmp->doc, tmp, 0, 0);
165 if (no_root_nodes != 1 && fixup_root)
167 /* does not appear to be an XML document. Make it so */
168 xmlBufferAddHead(buf, (const xmlChar *) "<yaz_record>", -1);
169 xmlBufferAdd(buf, (const xmlChar *) "</yaz_record>", -1);
171 *val = (char *) odr_malloc(o, buf->use + 1);
172 memcpy(*val, buf->content, buf->use);
173 (*val)[buf->use] = '\0';
183 static int match_xsd_XML_n(xmlNodePtr ptr, const char *elem, ODR o,
184 char **val, int *len)
186 return match_xsd_XML_n2(ptr, elem, o, val, len, 0);
189 static int match_xsd_integer(xmlNodePtr ptr, const char *elem, ODR o,
193 struct _xmlAttr *attr;
195 if (!match_element(ptr, elem))
198 for (attr = ptr->properties; attr; attr = attr->next)
199 if (!strcmp(attr->name, "type") &&
200 attr->children && attr->children->type == XML_TEXT_NODE)
202 const char *t = strchr(attr->children->content, ':');
206 t = attr->children->content;
207 if (!strcmp(t, "integer"))
214 if (!ptr || ptr->type != XML_TEXT_NODE)
216 *val = odr_intdup(o, odr_atoi((const char *) ptr->content));
220 char *yaz_negotiate_sru_version(char *input_ver)
224 if (!strcmp(input_ver, "1.1"))
226 if (!strncmp(input_ver, "1.", 2))
228 if (!strncmp(input_ver, "2.", 2))
233 static int yaz_srw_record(ODR o, xmlNodePtr pptr, Z_SRW_record *rec,
234 Z_SRW_extra_record **extra,
235 void *client_data, int version2)
237 if (o->direction == ODR_DECODE)
239 Z_SRW_extra_record ex;
246 rec->recordSchema = 0;
247 rec->recordData_buf = 0;
248 rec->recordData_len = 0;
249 rec->recordPosition = 0;
252 ex.extraRecordData_buf = 0;
253 ex.extraRecordData_len = 0;
254 ex.recordIdentifier = 0;
256 for (ptr = pptr->children; ptr; ptr = ptr->next)
259 if (match_xsd_string(ptr, "recordSchema", o,
262 else if (match_xsd_string(ptr, "recordPacking", o, &spack))
263 ; /* can't rely on it: in SRU 2.0 it's different semantics */
264 else if (match_xsd_integer(ptr, "recordPosition", o,
265 &rec->recordPosition))
267 else if (match_element(ptr, "recordData"))
269 /* we assume XML packing, if any element nodes exist below
270 recordData. Unfortunately, in SRU 2.0 recordPacking
271 means something different */
272 xmlNode *p = ptr->children;
273 for (; p; p = p->next)
274 if (p->type == XML_ELEMENT_NODE)
279 ptr, "recordData", o,
280 &rec->recordData_buf, &rec->recordData_len, 1);
281 rec->recordPacking = Z_SRW_recordPacking_XML;
286 ptr, "recordData", o,
287 &rec->recordData_buf, &rec->recordData_len);
288 rec->recordPacking = Z_SRW_recordPacking_string;
291 else if (match_xsd_XML_n(ptr, "extraRecordData", o,
292 &ex.extraRecordData_buf,
293 &ex.extraRecordData_len) )
296 match_xsd_string(ptr, "recordIdentifier", o,
297 &ex.recordIdentifier);
299 if (ex.extraRecordData_buf || ex.recordIdentifier)
301 *extra = (Z_SRW_extra_record *)
302 odr_malloc(o, sizeof(Z_SRW_extra_record));
303 memcpy(*extra, &ex, sizeof(Z_SRW_extra_record));
306 else if (o->direction == ODR_ENCODE)
308 xmlNodePtr ptr = pptr;
309 int pack = rec->recordPacking;
310 const char *spack = yaz_srw_pack_to_str(pack);
312 add_xsd_string(ptr, "recordSchema", rec->recordSchema);
316 add_xsd_string(ptr, "recordXMLEscaping", spack);
318 add_xsd_string(ptr, "recordPacking", spack);
322 case Z_SRW_recordPacking_string:
323 add_xsd_string_n(ptr, "recordData", rec->recordData_buf,
324 rec->recordData_len);
326 case Z_SRW_recordPacking_XML:
327 add_XML_n(ptr, "recordData", rec->recordData_buf,
328 rec->recordData_len, 0);
330 case Z_SRW_recordPacking_URL:
331 add_xsd_string_n(ptr, "recordData", rec->recordData_buf,
332 rec->recordData_len);
335 if (rec->recordPosition)
336 add_xsd_integer(ptr, "recordPosition", rec->recordPosition );
339 if ((*extra)->recordIdentifier)
340 add_xsd_string(ptr, "recordIdentifier",
341 (*extra)->recordIdentifier);
342 if ((*extra)->extraRecordData_buf)
343 add_XML_n(ptr, "extraRecordData",
344 (*extra)->extraRecordData_buf,
345 (*extra)->extraRecordData_len, 0);
351 static int yaz_srw_records(ODR o, xmlNodePtr pptr, Z_SRW_record **recs,
352 Z_SRW_extra_record ***extra,
353 int *num, void *client_data, int version2)
355 if (o->direction == ODR_DECODE)
360 for (ptr = pptr->children; ptr; ptr = ptr->next)
362 if (ptr->type == XML_ELEMENT_NODE &&
363 !xmlStrcmp(ptr->name, BAD_CAST "record"))
368 *recs = (Z_SRW_record *) odr_malloc(o, *num * sizeof(**recs));
369 *extra = (Z_SRW_extra_record **) odr_malloc(o, *num * sizeof(**extra));
370 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next)
372 if (ptr->type == XML_ELEMENT_NODE &&
373 !xmlStrcmp(ptr->name, BAD_CAST "record"))
375 yaz_srw_record(o, ptr, *recs + i, *extra + i, client_data, 0);
380 else if (o->direction == ODR_ENCODE)
383 for (i = 0; i < *num; i++)
385 xmlNodePtr rptr = xmlNewChild(pptr, 0, BAD_CAST "record",
387 yaz_srw_record(o, rptr, (*recs)+i, (*extra ? *extra + i : 0),
388 client_data, version2);
394 static int yaz_srw_version(ODR o, xmlNodePtr pptr, Z_SRW_recordVersion *rec,
395 void *client_data, const char *ns)
397 if (o->direction == ODR_DECODE)
400 rec->versionType = 0;
401 rec->versionValue = 0;
402 for (ptr = pptr->children; ptr; ptr = ptr->next)
405 if (match_xsd_string(ptr, "versionType", o,
409 match_xsd_string(ptr, "versionValue", o, &rec->versionValue);
412 else if (o->direction == ODR_ENCODE)
414 xmlNodePtr ptr = pptr;
415 add_xsd_string(ptr, "versionType", rec->versionType);
416 add_xsd_string(ptr, "versionValue", rec->versionValue);
421 static int yaz_srw_versions(ODR o, xmlNodePtr pptr,
422 Z_SRW_recordVersion **vers,
423 int *num, void *client_data, const char *ns)
425 if (o->direction == ODR_DECODE)
430 for (ptr = pptr->children; ptr; ptr = ptr->next)
432 if (ptr->type == XML_ELEMENT_NODE &&
433 !xmlStrcmp(ptr->name, BAD_CAST "recordVersion"))
438 *vers = (Z_SRW_recordVersion *) odr_malloc(o, *num * sizeof(**vers));
439 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next)
441 if (ptr->type == XML_ELEMENT_NODE &&
442 !xmlStrcmp(ptr->name, BAD_CAST "recordVersion"))
444 yaz_srw_version(o, ptr, *vers + i, client_data, ns);
449 else if (o->direction == ODR_ENCODE)
452 for (i = 0; i < *num; i++)
454 xmlNodePtr rptr = xmlNewChild(pptr, 0, BAD_CAST "version",
456 yaz_srw_version(o, rptr, (*vers)+i, client_data, ns);
462 Z_FacetTerm *yaz_sru_proxy_get_facet_term_count(ODR odr, xmlNodePtr node)
466 WRBUF wrbuf = wrbuf_alloc();
467 Z_FacetTerm *facet_term;
468 const char *freq_string = yaz_element_attribute_value_get(
469 node, "facetvalue", "est_representation");
471 freq = odr_atoi(freq_string);
475 for (child = node->children; child ; child = child->next)
477 if (child->type == XML_TEXT_NODE)
478 wrbuf_puts(wrbuf, (const char *) child->content);
480 facet_term = facet_term_create_cstr(odr, wrbuf_cstr(wrbuf), freq);
481 wrbuf_destroy(wrbuf);
485 static Z_FacetField *yaz_sru_proxy_decode_facet_field(ODR odr, xmlNodePtr ptr)
487 Z_AttributeList *list;
488 Z_FacetField *facet_field;
493 const char* name = yaz_element_attribute_value_get(ptr, "facet", "code");
494 yaz_log(YLOG_DEBUG, "sru-proxy facet type: %s", name);
496 list = yaz_use_attribute_create(odr, name);
497 for (node = ptr->children; node; node = node->next) {
498 if (match_element(node, "facetvalue"))
501 facet_field = facet_field_create(odr, list, num_terms);
503 for (node = ptr->children; node; node = node->next)
505 if (match_element(node, "facetvalue"))
507 facet_field_term_set(odr, facet_field,
508 yaz_sru_proxy_get_facet_term_count(odr, node),
516 static int yaz_sru_proxy_decode_facets(ODR o, xmlNodePtr root,
517 Z_FacetList **facetList)
521 for (ptr = root->children; ptr; ptr = ptr->next)
523 if (match_element(ptr, "facets"))
526 Z_FacetList *facet_list;
528 for (node = ptr->children; node; node= node->next)
530 if (node->type == XML_ELEMENT_NODE)
533 facet_list = facet_list_create(o, num_facets);
535 for (node = ptr->children; node; node= node->next)
537 if (match_element(node, "facet"))
539 facet_list_field_set(
541 yaz_sru_proxy_decode_facet_field(o, node), num_facets);
545 *facetList = facet_list;
554 static int yaz_srw_decode_diagnostics(ODR o, xmlNodePtr pptr,
555 Z_SRW_diagnostic **recs, int *num,
556 void *client_data, const char *ns)
561 for (ptr = pptr; ptr; ptr = ptr->next)
563 if (ptr->type == XML_ELEMENT_NODE &&
564 !xmlStrcmp(ptr->name, BAD_CAST "diagnostic"))
569 *recs = (Z_SRW_diagnostic *) odr_malloc(o, *num * sizeof(**recs));
570 for (i = 0; i < *num; i++)
573 (*recs)[i].details = 0;
574 (*recs)[i].message = 0;
576 for (i = 0, ptr = pptr; ptr; ptr = ptr->next)
578 if (ptr->type == XML_ELEMENT_NODE &&
579 !xmlStrcmp(ptr->name, BAD_CAST "diagnostic"))
583 (*recs)[i].details = 0;
584 (*recs)[i].message = 0;
585 for (rptr = ptr->children; rptr; rptr = rptr->next)
587 if (match_xsd_string(rptr, "uri", o,
590 else if (match_xsd_string(rptr, "details", o,
591 &(*recs)[i].details))
594 match_xsd_string(rptr, "message", o, &(*recs)[i].message);
602 int sru_decode_surrogate_diagnostics(const char *buf, size_t len,
603 Z_SRW_diagnostic **diag,
607 xmlDocPtr doc = xmlParseMemory(buf, len);
610 xmlNodePtr ptr = xmlDocGetRootElement(doc);
611 while (ptr && ptr->type != XML_ELEMENT_NODE)
614 && !xmlStrcmp(ptr->ns->href,
615 BAD_CAST "http://www.loc.gov/zing/srw/diagnostic/"))
617 ret = yaz_srw_decode_diagnostics(odr, ptr, diag, num, 0, 0);
624 static int yaz_srw_diagnostics(ODR o, xmlNodePtr pptr, Z_SRW_diagnostic **recs,
625 int *num, void *client_data, const char *ns)
627 if (o->direction == ODR_DECODE)
629 return yaz_srw_decode_diagnostics(o, pptr->children, recs, num, client_data, ns);
631 else if (o->direction == ODR_ENCODE)
635 xmlNewNs(pptr, BAD_CAST YAZ_XMLNS_DIAG_v1_1, BAD_CAST "diag" );
636 for (i = 0; i < *num; i++)
638 const char *std_diag = "info:srw/diagnostic/1/";
639 const char *ucp_diag = "info:srw/diagnostic/12/";
640 xmlNodePtr rptr = xmlNewChild(pptr, ns_diag,
641 BAD_CAST "diagnostic", 0);
642 add_xsd_string(rptr, "uri", (*recs)[i].uri);
643 if ((*recs)[i].message)
644 add_xsd_string(rptr, "message", (*recs)[i].message);
645 else if ((*recs)[i].uri )
647 if (!strncmp((*recs)[i].uri, std_diag, strlen(std_diag)))
649 int no = atoi((*recs)[i].uri + strlen(std_diag));
650 const char *message = yaz_diag_srw_str(no);
652 add_xsd_string(rptr, "message", message);
654 else if (!strncmp((*recs)[i].uri, ucp_diag, strlen(ucp_diag)))
656 int no = atoi((*recs)[i].uri + strlen(ucp_diag));
657 const char *message = yaz_diag_sru_update_str(no);
659 add_xsd_string(rptr, "message", message);
662 add_xsd_string(rptr, "details", (*recs)[i].details);
668 static int yaz_srw_term(ODR o, xmlNodePtr pptr, Z_SRW_scanTerm *term,
669 void *client_data, const char *ns)
671 if (o->direction == ODR_DECODE)
675 term->numberOfRecords = 0;
676 term->displayTerm = 0;
677 term->whereInList = 0;
678 for (ptr = pptr->children; ptr; ptr = ptr->next)
680 if (match_xsd_string(ptr, "value", o, &term->value))
682 else if (match_xsd_integer(ptr, "numberOfRecords", o,
683 &term->numberOfRecords))
685 else if (match_xsd_string(ptr, "displayTerm", o,
689 match_xsd_string(ptr, "whereInList", o, &term->whereInList);
692 else if (o->direction == ODR_ENCODE)
694 xmlNodePtr ptr = pptr;
695 add_xsd_string(ptr, "value", term->value);
696 add_xsd_integer(ptr, "numberOfRecords", term->numberOfRecords);
697 add_xsd_string(ptr, "displayTerm", term->displayTerm);
698 add_xsd_string(ptr, "whereInList", term->whereInList);
703 static int yaz_srw_terms(ODR o, xmlNodePtr pptr, Z_SRW_scanTerm **terms,
704 int *num, void *client_data, const char *ns)
706 if (o->direction == ODR_DECODE)
711 for (ptr = pptr->children; ptr; ptr = ptr->next)
713 if (ptr->type == XML_ELEMENT_NODE &&
714 !xmlStrcmp(ptr->name, BAD_CAST "term"))
719 *terms = (Z_SRW_scanTerm *) odr_malloc(o, *num * sizeof(**terms));
720 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next, i++)
722 if (ptr->type == XML_ELEMENT_NODE &&
723 !xmlStrcmp(ptr->name, BAD_CAST "term"))
724 yaz_srw_term(o, ptr, (*terms)+i, client_data, ns);
727 else if (o->direction == ODR_ENCODE)
730 for (i = 0; i < *num; i++)
732 xmlNodePtr rptr = xmlNewChild(pptr, 0, BAD_CAST "term", 0);
733 yaz_srw_term(o, rptr, (*terms)+i, client_data, ns);
739 int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
740 void *client_data, const char *ns)
742 xmlNodePtr pptr = (xmlNodePtr) vptr;
743 if (o->direction == ODR_DECODE)
745 Z_SRW_PDU **p = handler_data;
746 xmlNodePtr method = pptr->children;
749 while (method && method->type == XML_TEXT_NODE)
750 method = method->next;
754 if (method->type != XML_ELEMENT_NODE)
757 *p = yaz_srw_get_core_v_2_0(o);
759 if (!xmlStrcmp(method->name, BAD_CAST "searchRetrieveRequest"))
761 xmlNodePtr ptr = method->children;
762 Z_SRW_searchRetrieveRequest *req;
763 char *recordPacking = 0;
764 char *recordXMLEscaping = 0;
766 (*p)->which = Z_SRW_searchRetrieve_request;
767 req = (*p)->u.request = (Z_SRW_searchRetrieveRequest *)
768 odr_malloc(o, sizeof(*req));
769 req->queryType = "cql";
771 req->sort_type = Z_SRW_sort_type_none;
773 req->startRecord = 0;
774 req->maximumRecords = 0;
775 req->recordSchema = 0;
776 req->recordPacking = 0;
778 req->recordXPath = 0;
779 req->resultSetTTL = 0;
783 for (; ptr; ptr = ptr->next)
785 if (match_xsd_string(ptr, "version", o,
788 else if (match_xsd_string(ptr, "queryType", o,
791 else if (match_xsd_string(ptr, "query", o,
794 else if (match_xsd_string(ptr, "pQuery", o,
796 req->queryType = "pqf";
797 else if (match_xsd_string(ptr, "xQuery", o,
799 req->queryType = "xcql";
800 else if (match_xsd_integer(ptr, "startRecord", o,
803 else if (match_xsd_integer(ptr, "maximumRecords", o,
804 &req->maximumRecords))
806 else if (match_xsd_string(ptr, "recordPacking", o,
809 else if (match_xsd_string(ptr, "recordXMLEscaping", o,
812 else if (match_xsd_string(ptr, "recordSchema", o,
815 else if (match_xsd_string(ptr, "recordXPath", o,
818 else if (match_xsd_integer(ptr, "resultSetTTL", o,
821 else if (match_xsd_string(ptr, "sortKeys", o,
822 &req->sort.sortKeys))
823 req->sort_type = Z_SRW_sort_type_sort;
824 else if (match_xsd_string(ptr, "stylesheet", o,
828 match_xsd_string(ptr, "database", o, &req->database);
832 /* should put proper diagnostic here */
835 if (!strcmp((*p)->srw_version, "2.0"))
837 req->recordPacking = recordXMLEscaping;
838 req->packing = recordPacking;
842 req->recordPacking = recordPacking;
845 else if (!xmlStrcmp(method->name, BAD_CAST "searchRetrieveResponse"))
847 xmlNodePtr ptr = method->children;
848 Z_SRW_searchRetrieveResponse *res;
850 (*p)->which = Z_SRW_searchRetrieve_response;
851 res = (*p)->u.response = (Z_SRW_searchRetrieveResponse *)
852 odr_malloc(o, sizeof(*res));
854 res->numberOfRecords = 0;
855 res->resultCountPrecision = 0;
856 res->resultSetId = 0;
857 res->resultSetIdleTime = 0;
859 res->num_records = 0;
860 res->diagnostics = 0;
861 res->num_diagnostics = 0;
862 res->nextRecordPosition = 0;
864 res->suggestions = 0;
866 for (; ptr; ptr = ptr->next)
868 if (match_xsd_string(ptr, "version", o,
871 else if (match_xsd_XML_n(ptr, "extraResponseData", o,
872 &(*p)->extraResponseData_buf,
873 &(*p)->extraResponseData_len))
875 else if (match_xsd_integer(ptr, "numberOfRecords", o,
876 &res->numberOfRecords))
878 else if (match_xsd_string(ptr, "resultCountPrecision", o,
879 &res->resultCountPrecision))
881 else if (match_xsd_string(ptr, "resultSetId", o,
884 else if (match_xsd_integer(ptr, "resultSetIdleTime", o,
885 &res->resultSetIdleTime))
887 else if (match_xsd_integer(ptr, "resultSetTTL", o,
888 &res->resultSetIdleTime))
890 else if (match_element(ptr, "records"))
891 yaz_srw_records(o, ptr, &res->records,
893 &res->num_records, client_data, 0);
894 else if (match_xsd_integer(ptr, "nextRecordPosition", o,
895 &res->nextRecordPosition))
897 else if (match_element(ptr, "diagnostics"))
898 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
899 &res->num_diagnostics,
901 else if (match_element(ptr, "facet_analysis"))
902 yaz_sru_proxy_decode_facets(o, ptr, &res->facetList);
905 else if (!xmlStrcmp(method->name, BAD_CAST "explainRequest"))
907 Z_SRW_explainRequest *req;
908 xmlNodePtr ptr = method->children;
910 (*p)->which = Z_SRW_explain_request;
911 req = (*p)->u.explain_request = (Z_SRW_explainRequest *)
912 odr_malloc(o, sizeof(*req));
913 req->recordPacking = 0;
917 for (; ptr; ptr = ptr->next)
919 if (match_xsd_string(ptr, "version", o,
922 else if (match_xsd_XML_n(ptr, "extraResponseData", o,
923 &(*p)->extraResponseData_buf,
924 &(*p)->extraResponseData_len))
926 else if (match_xsd_string(ptr, "stylesheet", o,
929 else if (match_xsd_string(ptr, "recordPacking", o,
930 &req->recordPacking))
933 match_xsd_string(ptr, "database", o, &req->database);
936 else if (!xmlStrcmp(method->name, BAD_CAST "explainResponse"))
938 Z_SRW_explainResponse *res;
939 xmlNodePtr ptr = method->children;
941 (*p)->which = Z_SRW_explain_response;
942 res = (*p)->u.explain_response = (Z_SRW_explainResponse*)
943 odr_malloc(o, sizeof(*res));
944 res->diagnostics = 0;
945 res->num_diagnostics = 0;
946 res->record.recordSchema = 0;
947 res->record.recordData_buf = 0;
948 res->record.recordData_len = 0;
949 res->record.recordPosition = 0;
951 for (; ptr; ptr = ptr->next)
953 if (match_xsd_string(ptr, "version", o,
956 else if (match_xsd_XML_n(ptr, "extraResponseData", o,
957 &(*p)->extraResponseData_buf,
958 &(*p)->extraResponseData_len))
960 else if (match_element(ptr, "record"))
961 yaz_srw_record(o, ptr, &res->record, &res->extra_record,
963 else if (match_element(ptr, "diagnostics"))
964 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
965 &res->num_diagnostics,
970 else if (!xmlStrcmp(method->name, BAD_CAST "scanRequest"))
972 Z_SRW_scanRequest *req;
973 xmlNodePtr ptr = method->children;
975 (*p)->which = Z_SRW_scan_request;
976 req = (*p)->u.scan_request = (Z_SRW_scanRequest *)
977 odr_malloc(o, sizeof(*req));
978 req->queryType = "cql";
980 req->responsePosition = 0;
981 req->maximumTerms = 0;
985 for (; ptr; ptr = ptr->next)
987 if (match_xsd_string(ptr, "version", o,
990 else if (match_xsd_XML_n(ptr, "extraResponseData", o,
991 &(*p)->extraResponseData_buf,
992 &(*p)->extraResponseData_len))
994 else if (match_xsd_string(ptr, "scanClause", o,
997 else if (match_xsd_string(ptr, "pScanClause", o,
1000 req->queryType = "pqf";
1002 else if (match_xsd_integer(ptr, "responsePosition", o,
1003 &req->responsePosition))
1005 else if (match_xsd_integer(ptr, "maximumTerms", o,
1006 &req->maximumTerms))
1008 else if (match_xsd_string(ptr, "stylesheet", o,
1012 match_xsd_string(ptr, "database", o, &req->database);
1015 else if (!xmlStrcmp(method->name, BAD_CAST "scanResponse"))
1017 Z_SRW_scanResponse *res;
1018 xmlNodePtr ptr = method->children;
1020 (*p)->which = Z_SRW_scan_response;
1021 res = (*p)->u.scan_response = (Z_SRW_scanResponse *)
1022 odr_malloc(o, sizeof(*res));
1025 res->diagnostics = 0;
1026 res->num_diagnostics = 0;
1028 for (; ptr; ptr = ptr->next)
1030 if (match_xsd_string(ptr, "version", o,
1031 &(*p)->srw_version))
1033 else if (match_xsd_XML_n(ptr, "extraResponseData", o,
1034 &(*p)->extraResponseData_buf,
1035 &(*p)->extraResponseData_len))
1037 else if (match_element(ptr, "terms"))
1038 yaz_srw_terms(o, ptr, &res->terms,
1039 &res->num_terms, client_data,
1041 else if (match_element(ptr, "diagnostics"))
1042 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
1043 &res->num_diagnostics,
1052 neg_version = yaz_negotiate_sru_version((*p)->srw_version);
1054 (*p)->srw_version = neg_version;
1056 else if (o->direction == ODR_ENCODE)
1058 Z_SRW_PDU **p = handler_data;
1061 int version2 = !(*p)->srw_version ||
1062 strcmp((*p)->srw_version, "2.") > 0;
1063 if ((*p)->which == Z_SRW_searchRetrieve_request)
1065 Z_SRW_searchRetrieveRequest *req = (*p)->u.request;
1066 const char *queryType = req->queryType;
1068 ns = "http://docs.oasis-open.org/ns/search-ws/sruRequest";
1069 ptr = xmlNewChild(pptr, 0, BAD_CAST "searchRetrieveRequest", 0);
1070 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1071 xmlSetNs(ptr, ns_srw);
1074 add_xsd_string(ptr, "version", (*p)->srw_version);
1079 add_xsd_string(ptr, "queryType", queryType);
1080 add_xsd_string(ptr, "query", req->query);
1084 if (!queryType || !strcmp(queryType, "cql"))
1085 add_xsd_string(ptr, "query", req->query);
1086 else if (!strcmp(queryType, "xcql"))
1087 add_xsd_string(ptr, "xQuery", req->query);
1088 else if (!strcmp(queryType, "pqf"))
1089 add_xsd_string(ptr, "pQuery", req->query);
1091 add_xsd_integer(ptr, "startRecord", req->startRecord);
1092 add_xsd_integer(ptr, "maximumRecords", req->maximumRecords);
1095 add_xsd_string(ptr, "recordXMLEscaping", req->recordPacking);
1096 add_xsd_string(ptr, "recordPacking", req->packing);
1099 add_xsd_string(ptr, "recordPacking", req->recordPacking);
1100 add_xsd_string(ptr, "recordSchema", req->recordSchema);
1101 add_xsd_string(ptr, "recordXPath", req->recordXPath);
1102 add_xsd_integer(ptr, "resultSetTTL", req->resultSetTTL);
1103 switch (req->sort_type)
1105 case Z_SRW_sort_type_none:
1107 case Z_SRW_sort_type_sort:
1108 add_xsd_string(ptr, "sortKeys", req->sort.sortKeys);
1110 case Z_SRW_sort_type_xSort:
1111 add_xsd_string(ptr, "xSortKeys", req->sort.xSortKeys);
1114 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1115 add_xsd_string(ptr, "database", req->database);
1117 else if ((*p)->which == Z_SRW_searchRetrieve_response)
1119 Z_SRW_searchRetrieveResponse *res = (*p)->u.response;
1121 ns = "http://docs.oasis-open.org/ns/search-ws/sruResponse";
1122 ptr = xmlNewChild(pptr, 0, BAD_CAST "searchRetrieveResponse", 0);
1123 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1124 xmlSetNs(ptr, ns_srw);
1127 add_xsd_string(ptr, "version", (*p)->srw_version);
1128 add_xsd_integer(ptr, "numberOfRecords", res->numberOfRecords);
1129 add_xsd_string(ptr, "resultSetId", res->resultSetId);
1130 add_xsd_integer(ptr,
1131 version2 ? "resultSetTTL" : "resultSetIdleTime" ,
1132 res->resultSetIdleTime);
1133 if (res->num_records)
1135 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "records", 0);
1136 yaz_srw_records(o, rptr, &res->records, &res->extra_records,
1138 client_data, version2);
1140 add_xsd_integer(ptr, "nextRecordPosition",
1141 res->nextRecordPosition);
1142 if (res->num_diagnostics)
1144 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
1146 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1147 &res->num_diagnostics, client_data, ns);
1149 if (res->resultCountPrecision)
1150 add_xsd_string(ptr, "resultCountPrecision",
1151 res->resultCountPrecision);
1153 else if ((*p)->which == Z_SRW_explain_request)
1155 Z_SRW_explainRequest *req = (*p)->u.explain_request;
1156 ptr = xmlNewChild(pptr, 0, BAD_CAST "explainRequest", 0);
1157 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1158 xmlSetNs(ptr, ns_srw);
1161 add_xsd_string(ptr, "version", (*p)->srw_version);
1164 add_xsd_string(ptr, "recordXMLEscaping", req->recordPacking);
1165 add_xsd_string(ptr, "recordPacking", req->packing);
1168 add_xsd_string(ptr, "recordPacking", req->recordPacking);
1169 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1170 add_xsd_string(ptr, "database", req->database);
1172 else if ((*p)->which == Z_SRW_explain_response)
1174 Z_SRW_explainResponse *res = (*p)->u.explain_response;
1175 ptr = xmlNewChild(pptr, 0, BAD_CAST "explainResponse", 0);
1176 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1177 xmlSetNs(ptr, ns_srw);
1179 add_xsd_string(ptr, "version", (*p)->srw_version);
1182 xmlNodePtr ptr1 = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1183 yaz_srw_record(o, ptr1, &res->record, &res->extra_record,
1184 client_data, version2);
1186 if (res->num_diagnostics)
1188 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
1190 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1191 &res->num_diagnostics, client_data, ns);
1194 else if ((*p)->which == Z_SRW_scan_request)
1196 Z_SRW_scanRequest *req = (*p)->u.scan_request;
1197 const char *queryType = req->queryType;
1199 ns = "http://docs.oasis-open.org/ns/search-ws/scan";
1200 ptr = xmlNewChild(pptr, 0, BAD_CAST "scanRequest", 0);
1201 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1202 xmlSetNs(ptr, ns_srw);
1205 add_xsd_string(ptr, "version", (*p)->srw_version);
1209 if (queryType && strcmp(queryType, "cql"))
1210 add_xsd_string(ptr, "queryType", queryType);
1211 add_xsd_string(ptr, "scanClause", req->scanClause);
1215 if (!queryType || !strcmp(queryType, "cql"))
1216 add_xsd_string(ptr, "scanClause", req->scanClause);
1217 else if (!strcmp(queryType, "pqf"))
1218 add_xsd_string(ptr, "pScanClause", req->scanClause);
1220 add_xsd_integer(ptr, "responsePosition", req->responsePosition);
1221 add_xsd_integer(ptr, "maximumTerms", req->maximumTerms);
1222 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1223 add_xsd_string(ptr, "database", req->database);
1225 else if ((*p)->which == Z_SRW_scan_response)
1227 Z_SRW_scanResponse *res = (*p)->u.scan_response;
1229 ns = "http://docs.oasis-open.org/ns/search-ws/scan";
1230 ptr = xmlNewChild(pptr, 0, BAD_CAST "scanResponse", 0);
1231 ns_srw = xmlNewNs(ptr, BAD_CAST ns, BAD_CAST "zs");
1232 xmlSetNs(ptr, ns_srw);
1235 add_xsd_string(ptr, "version", (*p)->srw_version);
1239 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "terms", 0);
1240 yaz_srw_terms(o, rptr, &res->terms, &res->num_terms,
1243 if (res->num_diagnostics)
1245 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "diagnostics",
1247 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1248 &res->num_diagnostics, client_data, ns);
1253 if (ptr && (*p)->extraResponseData_len)
1254 add_XML_n(ptr, "extraResponseData",
1255 (*p)->extraResponseData_buf,
1256 (*p)->extraResponseData_len, ns_srw);
1263 int yaz_ucp_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
1264 void *client_data, const char *ns_ucp_str)
1266 xmlNodePtr pptr = (xmlNodePtr) vptr;
1267 const char *ns_srw_str = YAZ_XMLNS_SRU_v1_1;
1268 if (o->direction == ODR_DECODE)
1270 Z_SRW_PDU **p = handler_data;
1271 xmlNodePtr method = pptr->children;
1273 while (method && method->type == XML_TEXT_NODE)
1274 method = method->next;
1278 if (method->type != XML_ELEMENT_NODE)
1281 *p = yaz_srw_get_core_v_2_0(o);
1283 if (!xmlStrcmp(method->name, BAD_CAST "updateRequest"))
1285 xmlNodePtr ptr = method->children;
1286 Z_SRW_updateRequest *req;
1289 (*p)->which = Z_SRW_update_request;
1290 req = (*p)->u.update_request = (Z_SRW_updateRequest *)
1291 odr_malloc(o, sizeof(*req));
1295 req->recordVersions = 0;
1296 req->num_recordVersions = 0;
1298 req->extra_record = 0;
1299 req->extraRequestData_buf = 0;
1300 req->extraRequestData_len = 0;
1301 req->stylesheet = 0;
1303 for (; ptr; ptr = ptr->next)
1305 if (match_xsd_string(ptr, "version", o,
1306 &(*p)->srw_version))
1308 else if (match_xsd_string(ptr, "action", o,
1312 if (!strcmp(oper, "info:srw/action/1/delete"))
1313 req->operation = "delete";
1314 else if (!strcmp(oper,"info:srw/action/1/replace" ))
1315 req->operation = "replace";
1316 else if (!strcmp(oper, "info:srw/action/1/create"))
1317 req->operation = "insert";
1320 else if (match_xsd_string(ptr, "recordIdentifier", o,
1323 else if (match_element(ptr, "recordVersions" ) )
1324 yaz_srw_versions( o, ptr, &req->recordVersions,
1325 &req->num_recordVersions, client_data,
1327 else if (match_element(ptr, "record"))
1329 req->record = yaz_srw_get_record(o);
1330 yaz_srw_record(o, ptr, req->record, &req->extra_record,
1333 else if (match_xsd_string(ptr, "stylesheet", o,
1337 match_xsd_string(ptr, "database", o, &req->database);
1340 else if (!xmlStrcmp(method->name, BAD_CAST "updateResponse"))
1342 xmlNodePtr ptr = method->children;
1343 Z_SRW_updateResponse *res;
1345 (*p)->which = Z_SRW_update_response;
1346 res = (*p)->u.update_response = (Z_SRW_updateResponse *)
1347 odr_malloc(o, sizeof(*res));
1349 res->operationStatus = 0;
1351 res->recordVersions = 0;
1352 res->num_recordVersions = 0;
1353 res->diagnostics = 0;
1354 res->num_diagnostics = 0;
1356 res->extra_record = 0;
1357 res->extraResponseData_buf = 0;
1358 res->extraResponseData_len = 0;
1360 for (; ptr; ptr = ptr->next)
1362 if (match_xsd_string(ptr, "version", o,
1363 &(*p)->srw_version))
1365 else if (match_xsd_string(ptr, "operationStatus", o,
1366 &res->operationStatus ))
1368 else if (match_xsd_string(ptr, "recordIdentifier", o,
1371 else if (match_element(ptr, "recordVersions" ))
1372 yaz_srw_versions(o, ptr, &res->recordVersions,
1373 &res->num_recordVersions,
1374 client_data, ns_ucp_str);
1375 else if (match_element(ptr, "record"))
1377 res->record = yaz_srw_get_record(o);
1378 yaz_srw_record(o, ptr, res->record, &res->extra_record,
1381 else if (match_element(ptr, "diagnostics"))
1382 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
1383 &res->num_diagnostics,
1384 client_data, ns_ucp_str);
1387 else if (!xmlStrcmp(method->name, BAD_CAST "explainUpdateRequest"))
1390 else if (!xmlStrcmp(method->name, BAD_CAST "explainUpdateResponse"))
1399 else if (o->direction == ODR_ENCODE)
1401 Z_SRW_PDU **p = handler_data;
1402 xmlNsPtr ns_ucp, ns_srw;
1404 if ((*p)->which == Z_SRW_update_request)
1406 Z_SRW_updateRequest *req = (*p)->u.update_request;
1407 xmlNodePtr ptr = xmlNewChild(pptr, 0, BAD_CAST "updateRequest", 0);
1408 ns_ucp = xmlNewNs(ptr, BAD_CAST ns_ucp_str, BAD_CAST "zu");
1409 xmlSetNs(ptr, ns_ucp);
1410 ns_srw = xmlNewNs(ptr, BAD_CAST ns_srw_str, BAD_CAST "zs");
1412 add_xsd_string_ns(ptr, "version", (*p)->srw_version, ns_srw);
1413 add_xsd_string(ptr, "action", req->operation);
1414 add_xsd_string(ptr, "recordIdentifier", req->recordId );
1415 if (req->recordVersions)
1416 yaz_srw_versions( o, ptr, &req->recordVersions,
1417 &req->num_recordVersions,
1418 client_data, ns_ucp_str);
1419 if (req->record && req->record->recordData_len)
1421 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1422 xmlSetNs(rptr, ns_srw);
1423 yaz_srw_record(o, rptr, req->record, &req->extra_record,
1426 if (req->extraRequestData_len)
1428 add_XML_n(ptr, "extraRequestData",
1429 req->extraRequestData_buf,
1430 req->extraRequestData_len, ns_srw);
1432 add_xsd_string(ptr, "stylesheet", req->stylesheet);
1433 add_xsd_string(ptr, "database", req->database);
1435 else if ((*p)->which == Z_SRW_update_response)
1437 Z_SRW_updateResponse *res = (*p)->u.update_response;
1438 xmlNodePtr ptr = xmlNewChild(pptr, 0, (xmlChar *)
1439 "updateResponse", 0);
1440 ns_ucp = xmlNewNs(ptr, BAD_CAST ns_ucp_str, BAD_CAST "zu");
1441 xmlSetNs(ptr, ns_ucp);
1442 ns_srw = xmlNewNs(ptr, BAD_CAST ns_srw_str, BAD_CAST "zs");
1444 add_xsd_string_ns(ptr, "version", (*p)->srw_version, ns_srw);
1445 add_xsd_string(ptr, "operationStatus", res->operationStatus );
1446 add_xsd_string(ptr, "recordIdentifier", res->recordId );
1447 if (res->recordVersions)
1448 yaz_srw_versions(o, ptr, &res->recordVersions,
1449 &res->num_recordVersions,
1450 client_data, ns_ucp_str);
1451 if (res->record && res->record->recordData_len)
1453 xmlNodePtr rptr = xmlNewChild(ptr, 0, BAD_CAST "record", 0);
1454 xmlSetNs(rptr, ns_srw);
1455 yaz_srw_record(o, rptr, res->record, &res->extra_record,
1458 if (res->num_diagnostics)
1461 xmlNewNs(pptr, BAD_CAST YAZ_XMLNS_DIAG_v1_1,
1464 xmlNodePtr rptr = xmlNewChild(ptr, ns_diag, BAD_CAST "diagnostics", 0);
1465 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
1466 &res->num_diagnostics, client_data,
1469 if (res->extraResponseData_len)
1470 add_XML_n(ptr, "extraResponseData",
1471 res->extraResponseData_buf,
1472 res->extraResponseData_len, ns_srw);
1486 * c-file-style: "Stroustrup"
1487 * indent-tabs-mode: nil
1489 * vim: shiftwidth=4 tabstop=8 expandtab