2 * Copyright (c) 2002-2004, Index Data.
3 * See the file LICENSE for details.
5 * $Id: srw.c,v 1.28 2004-10-31 19:23:22 adam Exp $
9 * \brief Implements SRW/SRU package encoding and decoding
15 #include <libxml/parser.h>
16 #include <libxml/tree.h>
18 static void add_XML_n(xmlNodePtr ptr, const char *elem, char *val, int len)
22 xmlDocPtr doc = xmlParseMemory(val,len);
25 xmlNodePtr c = xmlNewChild(ptr, 0, elem, 0);
26 xmlNodePtr t = xmlDocGetRootElement(doc);
27 xmlAddChild(c, xmlCopyNode(t,1));
33 xmlNodePtr add_xsd_string_n(xmlNodePtr ptr, const char *elem, const char *val,
38 xmlNodePtr c = xmlNewChild(ptr, 0, elem, 0);
39 xmlNodePtr t = xmlNewTextLen(val, len);
46 xmlNodePtr add_xsd_string(xmlNodePtr ptr, const char *elem, const char *val)
49 return xmlNewTextChild(ptr, 0, elem, val);
53 static void add_xsd_integer(xmlNodePtr ptr, const char *elem, const int *val)
58 sprintf(str, "%d", *val);
59 xmlNewTextChild(ptr, 0, elem, str);
63 static int match_element(xmlNodePtr ptr, const char *elem)
65 if (ptr->type == XML_ELEMENT_NODE && !strcmp(ptr->name, elem))
72 static int match_xsd_string_n(xmlNodePtr ptr, const char *elem, ODR o,
76 struct _xmlAttr *attr;
78 if (!match_element(ptr, elem))
81 for (attr = ptr->properties; attr; attr = attr->next)
82 if (!strcmp(attr->name, "type") &&
83 attr->children && attr->children->type == XML_TEXT_NODE)
85 const char *t = strchr(attr->children->content, ':');
89 t = attr->children->content;
90 if (!strcmp(t, "string"))
97 if (!ptr || ptr->type != XML_TEXT_NODE)
99 *val = odr_strdup(o, ptr->content);
101 *len = strlen(ptr->content);
106 static int match_xsd_string(xmlNodePtr ptr, const char *elem, ODR o,
109 return match_xsd_string_n(ptr, elem, o, val, 0);
112 static int match_xsd_XML_n(xmlNodePtr ptr, const char *elem, ODR o,
113 char **val, int *len)
117 if (!match_element(ptr, elem))
120 while (ptr && (ptr->type == XML_TEXT_NODE || ptr->type == XML_COMMENT_NODE))
124 buf = xmlBufferCreate();
126 xmlNodeDump(buf, ptr->doc, ptr, 0, 0);
128 *val = odr_malloc(o, buf->use+1);
129 memcpy (*val, buf->content, buf->use);
130 (*val)[buf->use] = '\0';
140 static int match_xsd_integer(xmlNodePtr ptr, const char *elem, ODR o, int **val)
143 struct _xmlAttr *attr;
145 if (!match_element(ptr, elem))
148 for (attr = ptr->properties; attr; attr = attr->next)
149 if (!strcmp(attr->name, "type") &&
150 attr->children && attr->children->type == XML_TEXT_NODE)
152 const char *t = strchr(attr->children->content, ':');
156 t = attr->children->content;
157 if (!strcmp(t, "integer"))
164 if (!ptr || ptr->type != XML_TEXT_NODE)
166 *val = odr_intdup(o, atoi(ptr->content));
170 static int yaz_srw_record(ODR o, xmlNodePtr pptr, Z_SRW_record *rec,
171 void *client_data, const char *ns)
173 if (o->direction == ODR_DECODE)
175 int pack = Z_SRW_recordPacking_string;
177 rec->recordSchema = 0;
178 rec->recordData_buf = 0;
179 rec->recordData_len = 0;
180 rec->recordPosition = 0;
181 for (ptr = pptr->children; ptr; ptr = ptr->next)
185 if (match_xsd_string(ptr, "recordSchema", o,
188 else if (match_xsd_string(ptr, "recordPacking", o, &spack))
190 if (spack && !strcmp(spack, "xml"))
191 pack = Z_SRW_recordPacking_XML;
192 if (spack && !strcmp(spack, "string"))
193 pack = Z_SRW_recordPacking_string;
195 else if (match_xsd_integer(ptr, "recordPosition", o,
196 &rec->recordPosition))
200 if (pack == Z_SRW_recordPacking_XML)
201 match_xsd_XML_n(ptr, "recordData", o,
202 &rec->recordData_buf,
203 &rec->recordData_len);
204 if (pack == Z_SRW_recordPacking_string)
205 match_xsd_string_n(ptr, "recordData", o,
206 &rec->recordData_buf,
207 &rec->recordData_len);
210 rec->recordPacking = pack;
212 else if (o->direction == ODR_ENCODE)
214 xmlNodePtr ptr = pptr;
215 add_xsd_string(ptr, "recordSchema", rec->recordSchema);
216 switch(rec->recordPacking)
218 case Z_SRW_recordPacking_string:
219 add_xsd_string(ptr, "recordPacking", "string");
220 add_xsd_string_n(ptr, "recordData", rec->recordData_buf,
221 rec->recordData_len);
223 case Z_SRW_recordPacking_XML:
224 add_xsd_string(ptr, "recordPacking", "xml");
225 add_XML_n(ptr, "recordData", rec->recordData_buf,
226 rec->recordData_len);
229 add_xsd_integer(ptr, "recordPosition", rec->recordPosition);
234 static int yaz_srw_records(ODR o, xmlNodePtr pptr, Z_SRW_record **recs,
235 int *num, void *client_data, const char *ns)
237 if (o->direction == ODR_DECODE)
242 for (ptr = pptr->children; ptr; ptr = ptr->next)
244 if (ptr->type == XML_ELEMENT_NODE &&
245 !strcmp(ptr->name, "record"))
250 *recs = (Z_SRW_record *) odr_malloc(o, *num * sizeof(**recs));
251 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next)
253 if (ptr->type == XML_ELEMENT_NODE &&
254 !strcmp(ptr->name, "record"))
256 yaz_srw_record(o, ptr, (*recs)+i, client_data, ns);
261 else if (o->direction == ODR_ENCODE)
264 for (i = 0; i < *num; i++)
266 xmlNodePtr rptr = xmlNewChild(pptr, 0, "record", 0);
267 yaz_srw_record(o, rptr, (*recs)+i, client_data, ns);
273 static int yaz_srw_diagnostics(ODR o, xmlNodePtr pptr, Z_SRW_diagnostic **recs,
274 int *num, void *client_data, const char *ns)
276 if (o->direction == ODR_DECODE)
281 for (ptr = pptr->children; ptr; ptr = ptr->next)
283 if (ptr->type == XML_ELEMENT_NODE &&
284 !strcmp(ptr->name, "diagnostic"))
289 *recs = (Z_SRW_diagnostic *) odr_malloc(o, *num * sizeof(**recs));
290 for (i = 0; i < *num; i++)
293 (*recs)[i].details = 0;
294 (*recs)[i].message = 0;
296 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next)
298 if (ptr->type == XML_ELEMENT_NODE &&
299 !strcmp(ptr->name, "diagnostic"))
303 (*recs)[i].details = 0;
304 (*recs)[i].message = 0;
305 for (rptr = ptr->children; rptr; rptr = rptr->next)
307 if (match_xsd_string(rptr, "uri", o,
310 else if (match_xsd_string(rptr, "details", o,
311 &(*recs)[i].details))
313 else if (match_xsd_string(rptr, "message", o,
314 &(*recs)[i].message))
321 else if (o->direction == ODR_ENCODE)
325 xmlNewNs(pptr, "info:srw/schema/1/diagnostic-v1.1", 0);
326 for (i = 0; i < *num; i++)
328 const char *std_diag = "info:srw/diagnostic/1/";
329 xmlNodePtr rptr = xmlNewChild(pptr, ns_diag, "diagnostic", 0);
330 add_xsd_string(rptr, "uri", (*recs)[i].uri);
331 if ((*recs)[i].message)
332 add_xsd_string(rptr, "message", (*recs)[i].message);
333 else if ((*recs)[i].uri &&
334 !strncmp((*recs)[i].uri, std_diag, strlen(std_diag)))
336 int no = atoi((*recs)[i].uri + strlen(std_diag));
337 const char *message = yaz_diag_srw_str(no);
339 add_xsd_string(rptr, "message", message);
341 add_xsd_string(rptr, "details", (*recs)[i].details);
347 static int yaz_srw_term(ODR o, xmlNodePtr pptr, Z_SRW_scanTerm *term,
348 void *client_data, const char *ns)
350 if (o->direction == ODR_DECODE)
354 term->numberOfRecords = 0;
355 term->displayTerm = 0;
356 for (ptr = pptr->children; ptr; ptr = ptr->next)
358 if (match_xsd_string(ptr, "value", o, &term->value))
360 else if (match_xsd_integer(ptr, "numberOfRecords", o,
361 &term->numberOfRecords))
363 else if (match_xsd_string(ptr, "displayTerm", o,
368 else if (o->direction == ODR_ENCODE)
370 xmlNodePtr ptr = pptr;
371 add_xsd_string(ptr, "value", term->value);
372 add_xsd_integer(ptr, "value", term->numberOfRecords);
373 add_xsd_string(ptr, "displayTerm", term->displayTerm);
378 static int yaz_srw_terms(ODR o, xmlNodePtr pptr, Z_SRW_scanTerm **terms,
379 int *num, void *client_data, const char *ns)
381 if (o->direction == ODR_DECODE)
386 for (ptr = pptr->children; ptr; ptr = ptr->next)
388 if (ptr->type == XML_ELEMENT_NODE &&
389 !strcmp(ptr->name, "term"))
394 *terms = (Z_SRW_scanTerm *) odr_malloc(o, *num * sizeof(**terms));
395 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next, i++)
397 if (ptr->type == XML_ELEMENT_NODE &&
398 !strcmp(ptr->name, "term"))
399 yaz_srw_term(o, ptr, (*terms)+i, client_data, ns);
402 else if (o->direction == ODR_ENCODE)
405 for (i = 0; i < *num; i++)
407 xmlNodePtr rptr = xmlNewChild(pptr, 0, "term", 0);
408 yaz_srw_term(o, rptr, (*terms)+i, client_data, ns);
414 int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
415 void *client_data, const char *ns)
417 xmlNodePtr pptr = (xmlNodePtr) vptr;
418 if (o->direction == ODR_DECODE)
420 Z_SRW_PDU **p = handler_data;
421 xmlNodePtr method = pptr->children;
423 while (method && method->type == XML_TEXT_NODE)
424 method = method->next;
428 if (method->type != XML_ELEMENT_NODE)
431 *p = (Z_SRW_PDU *) odr_malloc(o, sizeof(**p));
432 (*p)->srw_version = odr_strdup(o, "1.1");
434 if (!strcmp(method->name, "searchRetrieveRequest"))
436 xmlNodePtr ptr = method->children;
437 Z_SRW_searchRetrieveRequest *req;
439 (*p)->which = Z_SRW_searchRetrieve_request;
440 req = (*p)->u.request = (Z_SRW_searchRetrieveRequest *)
441 odr_malloc(o, sizeof(*req));
442 req->query_type = Z_SRW_query_type_cql;
444 req->sort_type = Z_SRW_sort_type_none;
446 req->startRecord = 0;
447 req->maximumRecords = 0;
448 req->recordSchema = 0;
449 req->recordPacking = 0;
450 req->recordXPath = 0;
451 req->resultSetTTL = 0;
455 for (; ptr; ptr = ptr->next)
457 if (match_xsd_string(ptr, "version", o,
460 else if (match_xsd_string(ptr, "query", o,
462 req->query_type = Z_SRW_query_type_cql;
463 else if (match_xsd_string(ptr, "pQuery", o,
465 req->query_type = Z_SRW_query_type_pqf;
466 else if (match_xsd_string(ptr, "xQuery", o,
468 req->query_type = Z_SRW_query_type_xcql;
469 else if (match_xsd_integer(ptr, "startRecord", o,
472 else if (match_xsd_integer(ptr, "maximumRecords", o,
473 &req->maximumRecords))
475 else if (match_xsd_string(ptr, "recordPacking", o,
476 &req->recordPacking))
478 else if (match_xsd_string(ptr, "recordSchema", o,
481 else if (match_xsd_string(ptr, "recordXPath", o,
484 else if (match_xsd_string(ptr, "resultSetTTL", o,
487 else if (match_xsd_string(ptr, "sortKeys", o,
488 &req->sort.sortKeys))
489 req->sort_type = Z_SRW_sort_type_sort;
490 else if (match_xsd_string(ptr, "stylesheet", o,
493 else if (match_xsd_string(ptr, "database", o,
496 /* missing is xQuery, xSortKeys .. */
499 else if (!strcmp(method->name, "searchRetrieveResponse"))
501 xmlNodePtr ptr = method->children;
502 Z_SRW_searchRetrieveResponse *res;
504 (*p)->which = Z_SRW_searchRetrieve_response;
505 res = (*p)->u.response = (Z_SRW_searchRetrieveResponse *)
506 odr_malloc(o, sizeof(*res));
508 res->numberOfRecords = 0;
509 res->resultSetId = 0;
510 res->resultSetIdleTime = 0;
512 res->num_records = 0;
513 res->diagnostics = 0;
514 res->num_diagnostics = 0;
515 res->nextRecordPosition = 0;
517 for (; ptr; ptr = ptr->next)
519 if (match_xsd_string(ptr, "version", o,
522 else if (match_xsd_integer(ptr, "numberOfRecords", o,
523 &res->numberOfRecords))
525 else if (match_xsd_string(ptr, "resultSetId", o,
528 else if (match_xsd_integer(ptr, "resultSetIdleTime", o,
529 &res->resultSetIdleTime))
531 else if (match_element(ptr, "records"))
532 yaz_srw_records(o, ptr, &res->records,
533 &res->num_records, client_data,
535 else if (match_xsd_integer(ptr, "nextRecordPosition", o,
536 &res->nextRecordPosition))
538 else if (match_element(ptr, "diagnostics"))
539 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
540 &res->num_diagnostics,
544 else if (!strcmp(method->name, "explainRequest"))
546 Z_SRW_explainRequest *req;
547 xmlNodePtr ptr = method->children;
549 (*p)->which = Z_SRW_explain_request;
550 req = (*p)->u.explain_request = (Z_SRW_explainRequest *)
551 odr_malloc(o, sizeof(*req));
552 req->recordPacking = 0;
555 for (; ptr; ptr = ptr->next)
557 if (match_xsd_string(ptr, "version", o,
560 else if (match_xsd_string(ptr, "stylesheet", o,
563 else if (match_xsd_string(ptr, "recordPacking", o,
564 &req->recordPacking))
566 else if (match_xsd_string(ptr, "database", o,
571 else if (!strcmp(method->name, "explainResponse"))
573 Z_SRW_explainResponse *res;
574 xmlNodePtr ptr = method->children;
576 (*p)->which = Z_SRW_explain_response;
577 res = (*p)->u.explain_response = (Z_SRW_explainResponse*)
578 odr_malloc(o, sizeof(*res));
579 res->diagnostics = 0;
580 res->num_diagnostics = 0;
581 res->record.recordSchema = 0;
582 res->record.recordData_buf = 0;
583 res->record.recordData_len = 0;
584 res->record.recordPosition = 0;
586 for (; ptr; ptr = ptr->next)
588 if (match_xsd_string(ptr, "version", o,
591 else if (match_element(ptr, "record"))
592 yaz_srw_record(o, ptr, &res->record, client_data, ns);
593 else if (match_element(ptr, "diagnostics"))
594 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
595 &res->num_diagnostics,
600 else if (!strcmp(method->name, "scanRequest"))
602 Z_SRW_scanRequest *req;
603 xmlNodePtr ptr = method->children;
605 (*p)->which = Z_SRW_scan_request;
606 req = (*p)->u.scan_request = (Z_SRW_scanRequest *)
607 odr_malloc(o, sizeof(*req));
611 req->responsePosition = 0;
612 req->maximumTerms = 0;
614 for (; ptr; ptr = ptr->next)
616 if (match_xsd_string(ptr, "version", o,
619 else if (match_xsd_string(ptr, "scanClause", o,
622 else if (match_xsd_integer(ptr, "responsePosition", o,
623 &req->responsePosition))
625 else if (match_xsd_integer(ptr, "maximumTerms", o,
628 else if (match_xsd_string(ptr, "stylesheet", o,
631 else if (match_xsd_string(ptr, "database", o,
636 else if (!strcmp(method->name, "scanResponse"))
638 Z_SRW_scanResponse *res;
639 xmlNodePtr ptr = method->children;
641 (*p)->which = Z_SRW_scan_response;
642 res = (*p)->u.scan_response = (Z_SRW_scanResponse *)
643 odr_malloc(o, sizeof(*res));
646 res->diagnostics = 0;
647 res->num_diagnostics = 0;
649 for (; ptr; ptr = ptr->next)
651 if (match_xsd_string(ptr, "version", o,
654 else if (match_element(ptr, "terms"))
655 yaz_srw_terms(o, ptr, &res->terms,
656 &res->num_terms, client_data,
658 else if (match_element(ptr, "diagnostics"))
659 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
660 &res->num_diagnostics,
670 else if (o->direction == ODR_ENCODE)
672 Z_SRW_PDU **p = handler_data;
675 if ((*p)->which == Z_SRW_searchRetrieve_request)
677 Z_SRW_searchRetrieveRequest *req = (*p)->u.request;
678 xmlNodePtr ptr = xmlNewChild(pptr, 0,
679 "searchRetrieveRequest", 0);
680 ns_srw = xmlNewNs(ptr, ns, "zs");
681 xmlSetNs(ptr, ns_srw);
683 if ((*p)->srw_version)
684 add_xsd_string(ptr, "version", (*p)->srw_version);
685 switch(req->query_type)
687 case Z_SRW_query_type_cql:
688 add_xsd_string(ptr, "query", req->query.cql);
690 case Z_SRW_query_type_xcql:
691 add_xsd_string(ptr, "xQuery", req->query.xcql);
693 case Z_SRW_query_type_pqf:
694 add_xsd_string(ptr, "pQuery", req->query.pqf);
697 add_xsd_integer(ptr, "startRecord", req->startRecord);
698 add_xsd_integer(ptr, "maximumRecords", req->maximumRecords);
699 add_xsd_string(ptr, "recordPacking", req->recordPacking);
700 add_xsd_string(ptr, "recordSchema", req->recordSchema);
701 add_xsd_string(ptr, "recordXPath", req->recordXPath);
702 add_xsd_integer(ptr, "resultSetTTL", req->resultSetTTL);
703 switch(req->sort_type)
705 case Z_SRW_sort_type_none:
707 case Z_SRW_sort_type_sort:
708 add_xsd_string(ptr, "sortKeys", req->sort.sortKeys);
710 case Z_SRW_sort_type_xSort:
711 add_xsd_string(ptr, "xSortKeys", req->sort.xSortKeys);
714 add_xsd_string(ptr, "stylesheet", req->stylesheet);
715 add_xsd_string(ptr, "database", req->database);
717 else if ((*p)->which == Z_SRW_searchRetrieve_response)
719 Z_SRW_searchRetrieveResponse *res = (*p)->u.response;
720 xmlNodePtr ptr = xmlNewChild(pptr, 0,
721 "searchRetrieveResponse", 0);
722 ns_srw = xmlNewNs(ptr, ns, "zs");
723 xmlSetNs(ptr, ns_srw);
725 if ((*p)->srw_version)
726 add_xsd_string(ptr, "version", (*p)->srw_version);
727 add_xsd_integer(ptr, "numberOfRecords", res->numberOfRecords);
728 add_xsd_string(ptr, "resultSetId", res->resultSetId);
729 add_xsd_integer(ptr, "resultSetIdleTime", res->resultSetIdleTime);
730 if (res->num_records)
732 xmlNodePtr rptr = xmlNewChild(ptr, 0, "records", 0);
733 yaz_srw_records(o, rptr, &res->records, &res->num_records,
736 add_xsd_integer(ptr, "nextRecordPosition",
737 res->nextRecordPosition);
738 if (res->num_diagnostics)
740 xmlNodePtr rptr = xmlNewChild(ptr, 0, "diagnostics", 0);
741 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
742 &res->num_diagnostics, client_data, ns);
745 else if ((*p)->which == Z_SRW_explain_request)
747 Z_SRW_explainRequest *req = (*p)->u.explain_request;
748 xmlNodePtr ptr = xmlNewChild(pptr, 0, "explainRequest", 0);
749 ns_srw = xmlNewNs(ptr, ns, "zs");
750 xmlSetNs(ptr, ns_srw);
752 add_xsd_string(ptr, "version", (*p)->srw_version);
753 add_xsd_string(ptr, "recordPacking", req->recordPacking);
754 add_xsd_string(ptr, "stylesheet", req->stylesheet);
755 add_xsd_string(ptr, "database", req->database);
757 else if ((*p)->which == Z_SRW_explain_response)
759 Z_SRW_explainResponse *res = (*p)->u.explain_response;
760 xmlNodePtr ptr = xmlNewChild(pptr, 0, "explainResponse", 0);
761 ns_srw = xmlNewNs(ptr, ns, "zs");
762 xmlSetNs(ptr, ns_srw);
764 add_xsd_string(ptr, "version", (*p)->srw_version);
767 xmlNodePtr ptr1 = xmlNewChild(ptr, 0, "record", 0);
768 yaz_srw_record(o, ptr1, &res->record, client_data, ns);
770 if (res->num_diagnostics)
772 xmlNodePtr rptr = xmlNewChild(ptr, 0, "diagnostics", 0);
773 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
774 &res->num_diagnostics, client_data, ns);
777 else if ((*p)->which == Z_SRW_scan_request)
779 Z_SRW_scanRequest *req = (*p)->u.scan_request;
780 xmlNodePtr ptr = xmlNewChild(pptr, 0, "scanRequest", 0);
781 ns_srw = xmlNewNs(ptr, ns, "zs");
782 xmlSetNs(ptr, ns_srw);
784 add_xsd_string(ptr, "version", (*p)->srw_version);
785 add_xsd_string(ptr, "scanClause", req->scanClause);
786 add_xsd_integer(ptr, "responsePosition", req->responsePosition);
787 add_xsd_integer(ptr, "maximumTerms", req->maximumTerms);
788 add_xsd_string(ptr, "stylesheet", req->stylesheet);
789 add_xsd_string(ptr, "database", req->database);
791 else if ((*p)->which == Z_SRW_scan_response)
793 Z_SRW_scanResponse *res = (*p)->u.scan_response;
794 xmlNodePtr ptr = xmlNewChild(pptr, 0, "scanResponse", 0);
795 ns_srw = xmlNewNs(ptr, ns, "zs");
796 xmlSetNs(ptr, ns_srw);
798 add_xsd_string(ptr, "version", (*p)->srw_version);
802 xmlNodePtr rptr = xmlNewChild(ptr, 0, "terms", 0);
803 yaz_srw_terms(o, rptr, &res->terms, &res->num_terms,
806 if (res->num_diagnostics)
808 xmlNodePtr rptr = xmlNewChild(ptr, 0, "diagnostics", 0);
809 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
810 &res->num_diagnostics, client_data, ns);