2 * Copyright (c) 2002-2003, Index Data.
3 * See the file LICENSE for details.
5 * $Id: srw.c,v 1.6 2003-12-22 22:47:20 adam Exp $
11 #include <libxml/parser.h>
12 #include <libxml/tree.h>
14 static void add_XML_n(xmlNodePtr ptr, const char *elem, char *val, int len)
18 xmlDocPtr doc = xmlParseMemory(val,len);
21 xmlNodePtr c = xmlNewChild(ptr, 0, elem, 0);
22 xmlNodePtr t = xmlDocGetRootElement(doc);
23 xmlAddChild(c, xmlCopyNode(t,1));
29 xmlNodePtr add_xsd_string_n(xmlNodePtr ptr, const char *elem, char *val,
34 xmlNodePtr c = xmlNewChild(ptr, 0, elem, 0);
35 xmlNodePtr t = xmlNewTextLen(val, len);
42 xmlNodePtr add_xsd_string(xmlNodePtr ptr, const char *elem, char *val)
45 return xmlNewChild(ptr, 0, elem, val);
49 static void add_xsd_integer(xmlNodePtr ptr, const char *elem, int *val)
54 sprintf(str, "%d", *val);
55 xmlNewChild(ptr, 0, elem, str);
59 static int match_element(xmlNodePtr ptr, const char *elem)
61 if (ptr->type == XML_ELEMENT_NODE && !strcmp(ptr->name, elem))
68 static int match_xsd_string_n(xmlNodePtr ptr, const char *elem, ODR o,
72 struct _xmlAttr *attr;
74 if (!match_element(ptr, elem))
77 for (attr = ptr->properties; attr; attr = attr->next)
78 if (!strcmp(attr->name, "type") &&
79 attr->children && attr->children->type == XML_TEXT_NODE)
81 const char *t = strchr(attr->children->content, ':');
85 t = attr->children->content;
86 if (!strcmp(t, "string"))
93 if (!ptr || ptr->type != XML_TEXT_NODE)
95 *val = odr_strdup(o, ptr->content);
97 *len = strlen(ptr->content);
102 static int match_xsd_string(xmlNodePtr ptr, const char *elem, ODR o,
105 return match_xsd_string_n(ptr, elem, o, val, 0);
108 static int match_xsd_XML_n(xmlNodePtr ptr, const char *elem, ODR o,
109 char **val, int *len)
113 if (!match_element(ptr, elem))
118 buf = xmlBufferCreate();
120 xmlNodeDump(buf, ptr->doc, ptr, 0, 0);
122 *val = odr_malloc(o, buf->use+1);
123 memcpy (*val, buf->content, buf->use);
124 (*val)[buf->use] = '\0';
135 static int match_xsd_integer(xmlNodePtr ptr, const char *elem, ODR o, int **val)
138 struct _xmlAttr *attr;
140 if (!match_element(ptr, elem))
143 for (attr = ptr->properties; attr; attr = attr->next)
144 if (!strcmp(attr->name, "type") &&
145 attr->children && attr->children->type == XML_TEXT_NODE)
147 const char *t = strchr(attr->children->content, ':');
151 t = attr->children->content;
152 if (!strcmp(t, "integer"))
159 if (!ptr || ptr->type != XML_TEXT_NODE)
161 *val = odr_intdup(o, atoi(ptr->content));
165 static int yaz_srw_record(ODR o, xmlNodePtr pptr, Z_SRW_record *rec,
166 void *client_data, const char *ns)
168 if (o->direction == ODR_DECODE)
170 int pack = Z_SRW_recordPacking_string;
172 rec->recordSchema = 0;
173 rec->recordData_buf = 0;
174 rec->recordData_len = 0;
175 rec->recordPosition = 0;
176 for (ptr = pptr->children; ptr; ptr = ptr->next)
180 if (match_xsd_string(ptr, "recordSchema", o,
183 else if (match_xsd_string(ptr, "recordPacking", o, &spack))
185 if (pack && !strcmp(spack, "xml"))
186 pack = Z_SRW_recordPacking_XML;
187 if (pack && !strcmp(spack, "string"))
188 pack = Z_SRW_recordPacking_string;
190 else if (match_xsd_integer(ptr, "recordPosition", o,
191 &rec->recordPosition))
195 if (pack == Z_SRW_recordPacking_XML)
196 match_xsd_XML_n(ptr, "recordData", o,
197 &rec->recordData_buf,
198 &rec->recordData_len);
199 if (pack == Z_SRW_recordPacking_string)
200 match_xsd_string_n(ptr, "recordData", o,
201 &rec->recordData_buf,
202 &rec->recordData_len);
205 rec->recordPacking = pack;
207 else if (o->direction == ODR_ENCODE)
209 xmlNodePtr ptr = pptr;
210 add_xsd_string(ptr, "recordSchema", rec->recordSchema);
211 switch(rec->recordPacking)
213 case Z_SRW_recordPacking_string:
214 add_xsd_string(ptr, "recordPacking", "string");
215 add_xsd_string_n(ptr, "recordData", rec->recordData_buf,
216 rec->recordData_len);
218 case Z_SRW_recordPacking_XML:
219 add_xsd_string(ptr, "recordPacking", "xml");
220 add_XML_n(ptr, "recordData", rec->recordData_buf,
221 rec->recordData_len);
224 add_xsd_integer(ptr, "recordPosition", rec->recordPosition);
228 static int yaz_srw_records(ODR o, xmlNodePtr pptr, Z_SRW_record **recs,
229 int *num, void *client_data, const char *ns)
231 if (o->direction == ODR_DECODE)
236 for (ptr = pptr->children; ptr; ptr = ptr->next)
238 if (ptr->type == XML_ELEMENT_NODE &&
239 !strcmp(ptr->name, "record"))
244 *recs = odr_malloc(o, *num * sizeof(**recs));
245 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next, i++)
247 if (ptr->type == XML_ELEMENT_NODE &&
248 !strcmp(ptr->name, "record"))
249 yaz_srw_record(o, ptr, (*recs)+i, client_data, ns);
252 else if (o->direction == ODR_ENCODE)
255 for (i = 0; i < *num; i++)
257 xmlNodePtr rptr = xmlNewChild(pptr, 0, "record", 0);
258 yaz_srw_record(o, rptr, (*recs)+i, client_data, ns);
264 static int yaz_srw_diagnostics(ODR o, xmlNodePtr pptr, Z_SRW_diagnostic **recs,
265 int *num, void *client_data, const char *ns)
267 if (o->direction == ODR_DECODE)
272 for (ptr = pptr->children; ptr; ptr = ptr->next)
274 if (ptr->type == XML_ELEMENT_NODE &&
275 !strcmp(ptr->name, "diagnostic"))
280 *recs = odr_malloc(o, *num * sizeof(**recs));
281 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next, i++)
283 if (ptr->type == XML_ELEMENT_NODE &&
284 !strcmp(ptr->name, "diagnostic"))
288 (*recs)[i].details = 0;
289 for (rptr = ptr->children; rptr; rptr = rptr->next)
291 if (match_xsd_integer(rptr, "code", o,
294 else if (match_xsd_string(rptr, "details", o,
295 &(*recs)[i].details))
302 else if (o->direction == ODR_ENCODE)
306 xmlNewNs(pptr, "http://www.loc.gov/zing/srw/diagnostics/", "diag");
307 for (i = 0; i < *num; i++)
309 xmlNodePtr rptr = xmlNewChild(pptr, ns_diag, "diagnostic", 0);
310 add_xsd_integer(rptr, "code", (*recs)[i].code);
311 add_xsd_string(rptr, "details", (*recs)[i].details);
318 int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
319 void *client_data, const char *ns)
321 xmlNodePtr pptr = vptr;
322 if (o->direction == ODR_DECODE)
324 Z_SRW_PDU **p = handler_data;
325 xmlNodePtr method = pptr->children;
327 while (method && method->type == XML_TEXT_NODE)
328 method = method->next;
332 if (method->type != XML_ELEMENT_NODE)
335 *p = odr_malloc(o, sizeof(**p));
336 (*p)->srw_version = odr_strdup(o, "1.1");
338 if (!strcmp(method->name, "searchRetrieveRequest"))
340 xmlNodePtr ptr = method->children;
341 Z_SRW_searchRetrieveRequest *req;
343 (*p)->which = Z_SRW_searchRetrieve_request;
344 req = (*p)->u.request = odr_malloc(o, sizeof(*req));
345 req->query_type = Z_SRW_query_type_cql;
347 req->sort_type = Z_SRW_sort_type_none;
349 req->startRecord = 0;
350 req->maximumRecords = 0;
351 req->recordSchema = 0;
352 req->recordPacking = 0;
355 for (; ptr; ptr = ptr->next)
357 if (match_xsd_string(ptr, "query", o,
359 req->query_type = Z_SRW_query_type_cql;
360 else if (match_xsd_string(ptr, "pQuery", o,
362 req->query_type = Z_SRW_query_type_pqf;
363 else if (match_xsd_string(ptr, "xQuery", o,
365 req->query_type = Z_SRW_query_type_xcql;
366 else if (match_xsd_string(ptr, "sortKeys", o,
367 &req->sort.sortKeys))
368 req->sort_type = Z_SRW_sort_type_sort;
369 else if (match_xsd_string(ptr, "recordSchema", o,
372 else if (match_xsd_string(ptr, "recordPacking", o,
373 &req->recordPacking))
375 else if (match_xsd_integer(ptr, "startRecord", o,
378 else if (match_xsd_integer(ptr, "maximumRecords", o,
379 &req->maximumRecords))
381 else if (match_xsd_string(ptr, "database", o,
384 else if (match_xsd_string(ptr, "version", o,
387 /* missing is xQuery, xSortKeys .. */
390 else if (!strcmp(method->name, "searchRetrieveResponse"))
392 xmlNodePtr ptr = method->children;
393 Z_SRW_searchRetrieveResponse *res;
395 (*p)->which = Z_SRW_searchRetrieve_response;
396 res = (*p)->u.response = odr_malloc(o, sizeof(*res));
398 res->numberOfRecords = 0;
399 res->resultSetId = 0;
400 res->resultSetIdleTime = 0;
402 res->num_records = 0;
403 res->diagnostics = 0;
404 res->num_diagnostics = 0;
405 res->nextRecordPosition = 0;
407 for (; ptr; ptr = ptr->next)
409 if (match_xsd_integer(ptr, "numberOfRecords", o,
410 &res->numberOfRecords))
412 else if (match_xsd_string(ptr, "resultSetId", o,
415 else if (match_xsd_integer(ptr, "resultSetIdleTime", o,
416 &res->resultSetIdleTime))
418 else if (match_element(ptr, "records"))
419 yaz_srw_records(o, ptr, &res->records,
420 &res->num_records, client_data,
422 else if (match_element(ptr, "diagnostics"))
423 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
424 &res->num_diagnostics,
426 else if (match_xsd_integer(ptr, "nextRecordPosition", o,
427 &res->nextRecordPosition))
429 else if (match_xsd_string(ptr, "version", o,
434 else if (!strcmp(method->name, "explainRequest"))
436 Z_SRW_explainRequest *req;
437 xmlNodePtr ptr = method->children;
439 (*p)->which = Z_SRW_explain_request;
440 req = (*p)->u.explain_request = odr_malloc(o, sizeof(*req));
441 req->recordPacking = 0;
443 for (; ptr; ptr = ptr->next)
445 if (match_xsd_string(ptr, "recordPacking", o,
446 &req->recordPacking))
448 else if (match_xsd_string(ptr, "version", o,
453 else if (!strcmp(method->name, "explainResponse"))
455 Z_SRW_explainResponse *res;
456 xmlNodePtr ptr = method->children;
458 (*p)->which = Z_SRW_explain_response;
459 res = (*p)->u.explain_response = odr_malloc(o, sizeof(*res));
461 for (; ptr; ptr = ptr->next)
463 if (match_element(ptr, "record"))
464 yaz_srw_record(o, ptr, &res->record, client_data, ns);
465 else if (match_xsd_string(ptr, "version", o,
476 else if (o->direction == ODR_ENCODE)
478 Z_SRW_PDU **p = handler_data;
481 if ((*p)->which == Z_SRW_searchRetrieve_request)
483 Z_SRW_searchRetrieveRequest *req = (*p)->u.request;
484 xmlNodePtr ptr = xmlNewChild(pptr, 0,
485 "searchRetrieveRequest", 0);
486 ns_srw = xmlNewNs(ptr, ns, "zs");
487 xmlSetNs(ptr, ns_srw);
489 if ((*p)->srw_version)
490 add_xsd_string(ptr, "version", (*p)->srw_version);
491 switch(req->query_type)
493 case Z_SRW_query_type_cql:
494 add_xsd_string(ptr, "query", req->query.cql);
496 case Z_SRW_query_type_xcql:
497 add_xsd_string(ptr, "xQuery", req->query.xcql);
499 case Z_SRW_query_type_pqf:
500 add_xsd_string(ptr, "pQuery", req->query.pqf);
503 switch(req->sort_type)
505 case Z_SRW_sort_type_none:
507 case Z_SRW_sort_type_sort:
508 add_xsd_string(ptr, "sortKeys", req->sort.sortKeys);
510 case Z_SRW_sort_type_xSort:
511 add_xsd_string(ptr, "xSortKeys", req->sort.xSortKeys);
514 add_xsd_integer(ptr, "startRecord", req->startRecord);
515 add_xsd_integer(ptr, "maximumRecords", req->maximumRecords);
516 add_xsd_string(ptr, "recordSchema", req->recordSchema);
517 add_xsd_string(ptr, "recordPacking", req->recordPacking);
518 add_xsd_string(ptr, "database", req->database);
520 else if ((*p)->which == Z_SRW_searchRetrieve_response)
522 Z_SRW_searchRetrieveResponse *res = (*p)->u.response;
523 xmlNodePtr ptr = xmlNewChild(pptr, 0,
524 "searchRetrieveResponse", 0);
525 ns_srw = xmlNewNs(ptr, ns, "zs");
526 xmlSetNs(ptr, ns_srw);
528 if ((*p)->srw_version)
529 add_xsd_string(ptr, "version", (*p)->srw_version);
530 add_xsd_integer(ptr, "numberOfRecords", res->numberOfRecords);
531 add_xsd_string(ptr, "resultSetId", res->resultSetId);
532 add_xsd_integer(ptr, "resultSetIdleTime", res->resultSetIdleTime);
533 if (res->num_records)
535 xmlNodePtr rptr = xmlNewChild(ptr, 0, "records", 0);
536 yaz_srw_records(o, rptr, &res->records, &res->num_records,
539 if (res->num_diagnostics)
541 xmlNodePtr rptr = xmlNewChild(ptr, 0, "diagnostics", 0);
542 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
543 &res->num_diagnostics, client_data, ns);
545 add_xsd_integer(ptr, "nextRecordPosition", res->nextRecordPosition);
547 else if ((*p)->which == Z_SRW_explain_request)
549 xmlNodePtr ptr = xmlNewChild(pptr, 0, "explainRequest", 0);
550 ns_srw = xmlNewNs(ptr, ns, "zs");
551 xmlSetNs(ptr, ns_srw);
553 if ((*p)->srw_version)
554 add_xsd_string(ptr, "version", (*p)->srw_version);
556 else if ((*p)->which == Z_SRW_explain_response)
558 Z_SRW_explainResponse *res = (*p)->u.explain_response;
559 xmlNodePtr ptr = xmlNewChild(pptr, 0, "explainResponse", 0);
560 ns_srw = xmlNewNs(ptr, ns, "zs");
561 xmlSetNs(ptr, ns_srw);
563 if ((*p)->srw_version)
564 add_xsd_string(ptr, "version", (*p)->srw_version);
565 ptr = xmlNewChild(ptr, 0, "record", 0);
566 yaz_srw_record(o, ptr, &res->record, client_data, ns);
575 Z_SRW_PDU *yaz_srw_get(ODR o, int which)
577 Z_SRW_PDU *sr = odr_malloc(o, sizeof(*o));
579 sr->srw_version = odr_strdup(o, "1.1");
583 case Z_SRW_searchRetrieve_request:
584 sr->u.request = (Z_SRW_searchRetrieveRequest *)
585 odr_malloc(o, sizeof(*sr->u.request));
586 sr->u.request->query_type = Z_SRW_query_type_cql;
587 sr->u.request->query.cql = 0;
588 sr->u.request->sort_type = Z_SRW_sort_type_none;
589 sr->u.request->sort.none = 0;
590 sr->u.request->startRecord = 0;
591 sr->u.request->maximumRecords = 0;
592 sr->u.request->recordSchema = 0;
593 sr->u.request->recordPacking = 0;
594 sr->u.request->database = 0;
596 case Z_SRW_searchRetrieve_response:
597 sr->u.response = (Z_SRW_searchRetrieveResponse *)
598 odr_malloc(o, sizeof(*sr->u.response));
599 sr->u.response->numberOfRecords = 0;
600 sr->u.response->resultSetId = 0;
601 sr->u.response->resultSetIdleTime = 0;
602 sr->u.response->records = 0;
603 sr->u.response->num_records = 0;
604 sr->u.response->diagnostics = 0;
605 sr->u.response->num_diagnostics = 0;
606 sr->u.response->nextRecordPosition = 0;
608 case Z_SRW_explain_request:
609 sr->u.explain_request = (Z_SRW_explainRequest *)
610 odr_malloc(o, sizeof(*sr->u.explain_request));
611 sr->u.explain_request->recordPacking = 0;
612 sr->u.explain_request->database = 0;
614 case Z_SRW_explain_response:
615 sr->u.explain_response = (Z_SRW_explainResponse *)
616 odr_malloc(o, sizeof(*sr->u.explain_response));
617 sr->u.explain_response->record.recordData_buf = 0;
618 sr->u.explain_response->record.recordData_len = 0;
619 sr->u.explain_response->record.recordSchema = 0;
620 sr->u.explain_response->record.recordPosition = 0;
621 sr->u.explain_response->record.recordPacking = Z_SRW_recordPacking_string;
632 } yaz_srw_codes [] = {
633 {1, "Permanent system error"},
634 {2, "System temporarily unavailable"},
635 {3, "Authentication error"},
636 /* Diagnostics Relating to CQL */
637 {10, "Illegal query"},
638 {11, "Unsupported query type (XCQL vs CQL)"},
639 {12, "Too many characters in query"},
640 {13, "Unbalanced or illegal use of parentheses"},
641 {14, "Unbalanced or illegal use of quotes"},
642 {15, "Illegal or unsupported context set"},
643 {16, "Illegal or unsupported index"},
644 {17, "Illegal or unsupported combination of index and context set"},
645 {18, "Illegal or unsupported combination of indexes"},
646 {19, "Illegal or unsupported relation"},
647 {20, "Illegal or unsupported relation modifier"},
648 {21, "Illegal or unsupported combination of relation modifers"},
649 {22, "Illegal or unsupported combination of relation and index"},
650 {23, "Too many characters in term"},
651 {24, "Illegal combination of relation and term"},
652 {25, "Special characters not quoted in term"},
653 {26, "Non special character escaped in term"},
654 {27, "Empty term unsupported"},
655 {28, "Masking character not supported"},
656 {29, "Masked words too short"},
657 {30, "Too many masking characters in term"},
658 {31, "Anchoring character not supported"},
659 {32, "Anchoring character in illegal or unsupported position"},
660 {33, "Combination of proximity/adjacency and masking characters not supported"},
661 {34, "Combination of proximity/adjacency and anchoring characters not supported"},
662 {35, "Terms only exclusion (stop) words"},
663 {36, "Term in invalid format for index or relation"},
664 {37, "Illegal or unsupported boolean operator"},
665 {38, "Too many boolean operators in query"},
666 {39, "Proximity not supported"},
667 {40, "Illegal or unsupported proximity relation"},
668 {41, "Illegal or unsupported proximity distance"},
669 {42, "Illegal or unsupported proximity unit"},
670 {43, "Illegal or unsupported proximity ordering"},
671 {44, "Illegal or unsupported combination of proximity modifiers"},
672 {45, "context set name (prefix) assigned to multiple identifiers"},
673 /* Diagnostics Relating to Result Sets */
674 {50, "Result sets not supported"},
675 {51, "Result set does not exist"},
676 {52, "Result set temporarily unavailable"},
677 {53, "Result sets only supported for retrieval"},
678 {54, "Retrieval may only occur from an existing result set"},
679 {55, "Combination of result sets with search terms not supported"},
680 {56, "Only combination of single result set with search terms supported"},
681 {57, "Result set created but no records available"},
682 {58, "Result set created with unpredictable partial results available"},
683 {59, "Result set created with valid partial results available"},
684 /* Diagnostics Relating to Records */
685 {60, "Too many records retrieved"},
686 {61, "First record position out of range"},
687 {62, "Negative number of records requested"},
688 {63, "System error in retrieving records"},
689 {64, "Record temporarily unavailable"},
690 {65, "Record does not exist"},
691 {66, "Unknown schema for retrieval"},
692 {67, "Record not available in this schema"},
693 {68, "Not authorised to send record"},
694 {69, "Not authorised to send record in this schema"},
695 {70, "Record too large to send"},
696 /* Diagnostics Relating to Sorting */
697 {80, "Sort not supported"},
698 {81, "Unsupported sort type (sortKeys vs xSortKeys)"},
699 {82, "Illegal or unsupported sort sequence"},
700 {83, "Too many records"},
701 {84, "Too many sort keys"},
702 {85, "Duplicate sort keys"},
703 {86, "Incompatible record formats"},
704 {87, "Unsupported schema for sort"},
705 {88, "Unsupported tag path for sort"},
706 {89, "Tag path illegal or unsupported for schema"},
707 {90, "Illegal or unsupported direction value"},
708 {91, "Illegal or unsupported case value"},
709 {92, "Illegal or unsupported missing value action"},
710 /* Diagnostics Relating to Explain */
711 {100, "Explain not supported"},
712 {101, "Explain request type not supported (SOAP vs GET)"},
713 {102, "Explain record temporarily unavailable"},
717 const char *yaz_diag_srw_str (int code)
720 for (i = 0; yaz_srw_codes[i].code; i++)
721 if (yaz_srw_codes[i].code == code)
722 return yaz_srw_codes[i].msg;
728 static int srw_bib1_map[] = {
757 24, 63, /* bad map */
758 25, 63, /* bad map */
759 26, 63, /* bad map */
767 100, 1, /* bad map */
815 205, 1, /* bad map */
816 206, 1, /* bad map */
818 208, 1, /* bad map */
829 218, 1, /* bad map */
830 219, 1, /* bad map */
831 220, 1, /* bad map */
832 221, 1, /* bad map */
833 222, 1, /* bad map */
834 223, 1, /* bad map */
835 224, 1, /* bad map */
836 225, 1, /* bad map */
837 226, 1, /* bad map */
839 228, 1, /* bad map */
844 233, 1, /* bad map */
845 234, 1, /* bad map */
851 240, 1, /* bad map */
852 241, 1, /* bad map */
854 243, 1, /* bad map */
859 1001, 1, /* bad map */
860 1002, 1, /* bad map */
861 1003, 1, /* bad map */
862 1004, 1, /* bad map */
863 1005, 1, /* bad map */
864 1006, 1, /* bad map */
896 int yaz_diag_bib1_to_srw (int code)
898 const int *p = srw_bib1_map;
908 int yaz_diag_srw_to_bib1(int code)
910 const int *p = srw_bib1_map;