2 * Copyright (c) 2002-2003, Index Data.
3 * See the file LICENSE for details.
5 * $Id: srw.c,v 1.10 2003-03-20 21:15:00 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 static void 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);
40 static void add_xsd_string(xmlNodePtr ptr, const char *elem, char *val)
43 xmlNewChild(ptr, 0, elem, val);
46 static void add_xsd_integer(xmlNodePtr ptr, const char *elem, int *val)
51 sprintf(str, "%d", *val);
52 xmlNewChild(ptr, 0, elem, str);
56 static int match_element(xmlNodePtr ptr, const char *elem)
58 if (ptr->type == XML_ELEMENT_NODE && !strcmp(ptr->name, elem))
65 static int match_xsd_string_n(xmlNodePtr ptr, const char *elem, ODR o,
69 struct _xmlAttr *attr;
71 if (!match_element(ptr, elem))
74 for (attr = ptr->properties; attr; attr = attr->next)
75 if (!strcmp(attr->name, "type") &&
76 attr->children && attr->children->type == XML_TEXT_NODE)
78 const char *t = strchr(attr->children->content, ':');
82 t = attr->children->content;
83 if (!strcmp(t, "string"))
90 if (!ptr || ptr->type != XML_TEXT_NODE)
92 *val = odr_strdup(o, ptr->content);
94 *len = strlen(ptr->content);
99 static int match_xsd_string(xmlNodePtr ptr, const char *elem, ODR o,
102 return match_xsd_string_n(ptr, elem, o, val, 0);
105 static int match_xsd_integer(xmlNodePtr ptr, const char *elem, ODR o, int **val)
108 struct _xmlAttr *attr;
110 if (!match_element(ptr, elem))
113 for (attr = ptr->properties; attr; attr = attr->next)
114 if (!strcmp(attr->name, "type") &&
115 attr->children && attr->children->type == XML_TEXT_NODE)
117 const char *t = strchr(attr->children->content, ':');
121 t = attr->children->content;
122 if (!strcmp(t, "integer"))
129 if (!ptr || ptr->type != XML_TEXT_NODE)
131 *val = odr_intdup(o, atoi(ptr->content));
135 static int yaz_srw_records(ODR o, xmlNodePtr pptr, Z_SRW_record **recs,
136 int *num, void *client_data, const char *ns)
138 if (o->direction == ODR_DECODE)
143 for (ptr = pptr->children; ptr; ptr = ptr->next)
145 if (ptr->type == XML_ELEMENT_NODE &&
146 !strcmp(ptr->name, "record"))
151 *recs = odr_malloc(o, *num * sizeof(**recs));
152 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next, i++)
154 if (ptr->type == XML_ELEMENT_NODE &&
155 !strcmp(ptr->name, "record"))
158 (*recs)[i].recordSchema = 0;
159 (*recs)[i].recordPacking = Z_SRW_recordPacking_string;
160 (*recs)[i].recordData_buf = 0;
161 (*recs)[i].recordData_len = 0;
162 (*recs)[i].recordPosition = 0;
163 for (rptr = ptr->children; rptr; rptr = rptr->next)
165 if (match_xsd_string(rptr, "recordSchema", o,
166 &(*recs)[i].recordSchema))
168 else if (match_xsd_string_n(rptr, "recordData", o,
169 &(*recs)[i].recordData_buf,
170 &(*recs)[i].recordData_len))
172 else if (match_xsd_integer(rptr, "recordPosition", o,
173 &(*recs)[i].recordPosition))
179 else if (o->direction == ODR_ENCODE)
182 for (i = 0; i < *num; i++)
184 xmlNodePtr rptr = xmlNewChild(pptr, 0, "record", 0);
185 add_xsd_string(rptr, "recordSchema", (*recs)[i].recordSchema);
186 switch((*recs)[i].recordPacking)
188 case Z_SRW_recordPacking_string:
189 add_xsd_string_n(rptr, "recordData", (*recs)[i].recordData_buf,
190 (*recs)[i].recordData_len);
192 case Z_SRW_recordPacking_XML:
193 add_XML_n(rptr, "recordXML", (*recs)[i].recordData_buf,
194 (*recs)[i].recordData_len);
197 add_xsd_integer(rptr, "recordPosition", (*recs)[i].recordPosition);
203 static int yaz_srw_diagnostics(ODR o, xmlNodePtr pptr, Z_SRW_diagnostic **recs,
204 int *num, void *client_data, const char *ns)
206 if (o->direction == ODR_DECODE)
211 for (ptr = pptr->children; ptr; ptr = ptr->next)
213 if (ptr->type == XML_ELEMENT_NODE &&
214 !strcmp(ptr->name, "diagnostic"))
219 *recs = odr_malloc(o, *num * sizeof(**recs));
220 for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next, i++)
222 if (ptr->type == XML_ELEMENT_NODE &&
223 !strcmp(ptr->name, "diagnostic"))
227 (*recs)[i].details = 0;
228 for (rptr = ptr->children; rptr; rptr = rptr->next)
230 if (match_xsd_integer(rptr, "code", o,
233 else if (match_xsd_string(rptr, "details", o,
234 &(*recs)[i].details))
241 else if (o->direction == ODR_ENCODE)
244 for (i = 0; i < *num; i++)
246 xmlNodePtr rptr = xmlNewChild(pptr, 0, "diagnostic", 0);
247 add_xsd_integer(rptr, "code", (*recs)[i].code);
248 add_xsd_string(rptr, "details", (*recs)[i].details);
255 int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
256 void *client_data, const char *ns)
258 xmlNodePtr pptr = vptr;
259 if (o->direction == ODR_DECODE)
261 xmlNodePtr method = pptr->children;
263 while (method && method->type == XML_TEXT_NODE)
264 method = method->next;
266 if (method->type != XML_ELEMENT_NODE)
268 if (method && !strcmp(method->name, "searchRetrieveRequest"))
270 Z_SRW_PDU **p = handler_data;
271 xmlNodePtr ptr = method->children;
272 Z_SRW_searchRetrieveRequest *req;
274 *p = odr_malloc(o, sizeof(**p));
275 (*p)->which = Z_SRW_searchRetrieve_request;
276 req = (*p)->u.request = odr_malloc(o, sizeof(*req));
277 req->query_type = Z_SRW_query_type_cql;
279 req->sort_type = Z_SRW_sort_type_none;
281 req->startRecord = 0;
282 req->maximumRecords = 0;
283 req->recordSchema = 0;
284 req->recordPacking = 0;
287 for (; ptr; ptr = ptr->next)
289 if (match_xsd_string(ptr, "query", o,
291 req->query_type = Z_SRW_query_type_cql;
292 else if (match_xsd_string(ptr, "pQuery", o,
294 req->query_type = Z_SRW_query_type_pqf;
295 else if (match_xsd_string(ptr, "xQuery", o,
297 req->query_type = Z_SRW_query_type_xcql;
298 else if (match_xsd_string(ptr, "sortKeys", o,
299 &req->sort.sortKeys))
300 req->sort_type = Z_SRW_sort_type_sort;
301 else if (match_xsd_string(ptr, "recordSchema", o,
304 else if (match_xsd_string(ptr, "recordPacking", o,
305 &req->recordPacking))
307 else if (match_xsd_integer(ptr, "startRecord", o,
310 else if (match_xsd_integer(ptr, "maximumRecords", o,
311 &req->maximumRecords))
313 else if (match_xsd_string(ptr, "database", o,
316 /* missing is xQuery, xSortKeys .. */
319 else if (method && !strcmp(method->name, "searchRetrieveResponse"))
321 Z_SRW_PDU **p = handler_data;
322 xmlNodePtr ptr = method->children;
323 Z_SRW_searchRetrieveResponse *res;
325 *p = odr_malloc(o, sizeof(**p));
326 (*p)->which = Z_SRW_searchRetrieve_response;
327 res = (*p)->u.response = odr_malloc(o, sizeof(*res));
329 res->numberOfRecords = 0;
330 res->resultSetId = 0;
331 res->resultSetIdleTime = 0;
333 res->num_records = 0;
334 res->diagnostics = 0;
335 res->num_diagnostics = 0;
336 res->nextRecordPosition = 0;
338 for (; ptr; ptr = ptr->next)
340 if (match_xsd_integer(ptr, "numberOfRecords", o,
341 &res->numberOfRecords))
343 else if (match_xsd_string(ptr, "resultSetId", o,
346 else if (match_xsd_integer(ptr, "resultSetIdleTime", o,
347 &res->resultSetIdleTime))
349 else if (match_element(ptr, "records"))
350 yaz_srw_records(o, ptr, &res->records,
351 &res->num_records, client_data,
353 else if (match_element(ptr, "diagnostics"))
354 yaz_srw_diagnostics(o, ptr, &res->diagnostics,
355 &res->num_diagnostics,
357 else if (match_xsd_integer(ptr, "nextRecordPosition", o,
358 &res->nextRecordPosition))
366 else if (o->direction == ODR_ENCODE)
368 Z_SRW_PDU **p = handler_data;
369 if ((*p)->which == Z_SRW_searchRetrieve_request)
371 Z_SRW_searchRetrieveRequest *req = (*p)->u.request;
372 xmlNodePtr ptr = xmlNewChild(pptr, 0,
373 "searchRetrieveRequest", 0);
374 xmlNsPtr ns_srw = xmlNewNs(ptr, ns, "zs");
376 xmlSetNs(ptr, ns_srw);
378 switch(req->query_type)
380 case Z_SRW_query_type_cql:
381 add_xsd_string(ptr, "query", req->query.cql);
383 case Z_SRW_query_type_xcql:
384 add_xsd_string(ptr, "xQuery", req->query.xcql);
386 case Z_SRW_query_type_pqf:
387 add_xsd_string(ptr, "pQuery", req->query.pqf);
390 switch(req->sort_type)
392 case Z_SRW_sort_type_none:
394 case Z_SRW_sort_type_sort:
395 add_xsd_string(ptr, "sortKeys", req->sort.sortKeys);
397 case Z_SRW_sort_type_xSort:
398 add_xsd_string(ptr, "xSortKeys", req->sort.xSortKeys);
401 add_xsd_integer(ptr, "startRecord", req->startRecord);
402 add_xsd_integer(ptr, "maximumRecords", req->maximumRecords);
403 add_xsd_string(ptr, "recordSchema", req->recordSchema);
404 add_xsd_string(ptr, "recordPacking", req->recordPacking);
405 add_xsd_string(ptr, "database", req->database);
407 else if ((*p)->which == Z_SRW_searchRetrieve_response)
409 Z_SRW_searchRetrieveResponse *res = (*p)->u.response;
410 xmlNodePtr ptr = xmlNewChild(pptr, 0,
411 "searchRetrieveResponse", 0);
412 xmlNsPtr ns_srw = xmlNewNs(ptr, ns, "zs");
414 xmlSetNs(ptr, ns_srw);
415 add_xsd_integer(ptr, "numberOfRecords", res->numberOfRecords);
416 add_xsd_string(ptr, "resultSetId", res->resultSetId);
417 add_xsd_integer(ptr, "resultSetIdleTime", res->resultSetIdleTime);
418 if (res->num_records)
420 xmlNodePtr rptr = xmlNewChild(ptr, 0, "records", 0);
421 yaz_srw_records(o, rptr, &res->records, &res->num_records,
424 if (res->num_diagnostics)
426 xmlNodePtr rptr = xmlNewChild(ptr, 0, "diagnostics", 0);
427 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
428 &res->num_diagnostics, client_data, ns);
430 add_xsd_integer(ptr, "nextRecordPosition", res->nextRecordPosition);
439 Z_SRW_PDU *yaz_srw_get(ODR o, int which)
441 Z_SRW_PDU *sr = odr_malloc(o, sizeof(*o));
445 case Z_SRW_searchRetrieve_request:
446 sr->u.request = odr_malloc(o, sizeof(*sr->u.request));
447 sr->u.request->query_type = Z_SRW_query_type_cql;
448 sr->u.request->query.cql = 0;
449 sr->u.request->sort_type = Z_SRW_sort_type_none;
450 sr->u.request->sort.none = 0;
451 sr->u.request->startRecord = 0;
452 sr->u.request->maximumRecords = 0;
453 sr->u.request->recordSchema = 0;
454 sr->u.request->recordPacking = 0;
455 sr->u.request->database = 0;
457 case Z_SRW_searchRetrieve_response:
458 sr->u.response = odr_malloc(o, sizeof(*sr->u.response));
459 sr->u.response->numberOfRecords = 0;
460 sr->u.response->resultSetId = 0;
461 sr->u.response->resultSetIdleTime = 0;
462 sr->u.response->records = 0;
463 sr->u.response->num_records = 0;
464 sr->u.response->diagnostics = 0;
465 sr->u.response->num_diagnostics = 0;
466 sr->u.response->nextRecordPosition = 0;
477 } yaz_srw_codes [] = {
478 {1, "Permanent system error"},
479 {2, "System temporarily unavailable"},
480 {3, "Authentication error"},
481 /* Diagnostics Relating to CQL */
482 {10, "Illegal query"},
483 {11, "Unsupported query type (XCQL vs CQL)"},
484 {12, "Too many characters in query"},
485 {13, "Unbalanced or illegal use of parentheses"},
486 {14, "Unbalanced or illegal use of quotes"},
487 {15, "Illegal or unsupported index set"},
488 {16, "Illegal or unsupported index"},
489 {17, "Illegal or unsupported combination of index and index set"},
490 {18, "Illegal or unsupported combination of indexes"},
491 {19, "Illegal or unsupported relation"},
492 {20, "Illegal or unsupported relation modifier"},
493 {21, "Illegal or unsupported combination of relation modifers"},
494 {22, "Illegal or unsupported combination of relation and index"},
495 {23, "Too many characters in term"},
496 {24, "Illegal combination of relation and term"},
497 {25, "Special characters not quoted in term"},
498 {26, "Non special character escaped in term"},
499 {27, "Empty term unsupported"},
500 {28, "Masking character not supported"},
501 {29, "Masked words too short"},
502 {30, "Too many masking characters in term"},
503 {31, "Anchoring character not supported"},
504 {32, "Anchoring character in illegal or unsupported position"},
505 {33, "Combination of proximity/adjacency and masking characters not supported"},
506 {34, "Combination of proximity/adjacency and anchoring characters not supported"},
507 {35, "Terms only exclusion (stop) words"},
508 {36, "Term in invalid format for index or relation"},
509 {37, "Illegal or unsupported boolean operator"},
510 {38, "Too many boolean operators in query"},
511 {39, "Proximity not supported"},
512 {40, "Illegal or unsupported proximity relation"},
513 {41, "Illegal or unsupported proximity distance"},
514 {42, "Illegal or unsupported proximity unit"},
515 {43, "Illegal or unsupported proximity ordering"},
516 {44, "Illegal or unsupported combination of proximity modifiers"},
517 {45, "Index set name (prefix) assigned to multiple identifiers"},
518 /* Diagnostics Relating to Result Sets */
519 {50, "Result sets not supported"},
520 {51, "Result set does not exist"},
521 {52, "Result set temporarily unavailable"},
522 {53, "Result sets only supported for retrieval"},
523 {54, "Retrieval may only occur from an existing result set"},
524 {55, "Combination of result sets with search terms not supported"},
525 {56, "Only combination of single result set with search terms supported"},
526 {57, "Result set created but no records available"},
527 {58, "Result set created with unpredictable partial results available"},
528 {59, "Result set created with valid partial results available"},
529 /* Diagnostics Relating to Records */
530 {60, "Too many records retrieved"},
531 {61, "First record position out of range"},
532 {62, "Negative number of records requested"},
533 {63, "System error in retrieving records"},
534 {64, "Record temporarily unavailable"},
535 {65, "Record does not exist"},
536 {66, "Unknown schema for retrieval"},
537 {67, "Record not available in this schema"},
538 {68, "Not authorised to send record"},
539 {69, "Not authorised to send record in this schema"},
540 {70, "Record too large to send"},
541 /* Diagnostics Relating to Sorting */
542 {80, "Sort not supported"},
543 {81, "Unsupported sort type (sortKeys vs xSortKeys)"},
544 {82, "Illegal or unsupported sort sequence"},
545 {83, "Too many records"},
546 {84, "Too many sort keys"},
547 {85, "Duplicate sort keys"},
548 {86, "Incompatible record formats"},
549 {87, "Unsupported schema for sort"},
550 {88, "Unsupported tag path for sort"},
551 {89, "Tag path illegal or unsupported for schema"},
552 {90, "Illegal or unsupported direction value"},
553 {91, "Illegal or unsupported case value"},
554 {92, "Illegal or unsupported missing value action"},
555 /* Diagnostics Relating to Explain */
556 {100, "Explain not supported"},
557 {101, "Explain request type not supported (SOAP vs GET)"},
558 {102, "Explain record temporarily unavailable"},
562 const char *yaz_diag_srw_str (int code)
565 for (i = 0; yaz_srw_codes[i].code; i++)
566 if (yaz_srw_codes[i].code == code)
567 return yaz_srw_codes[i].msg;
573 static int srw_bib1_map[] = {
602 24, 63, /* bad map */
603 25, 63, /* bad map */
604 26, 63, /* bad map */
612 100, 1, /* bad map */
660 205, 1, /* bad map */
661 206, 1, /* bad map */
663 208, 1, /* bad map */
674 218, 1, /* bad map */
675 219, 1, /* bad map */
676 220, 1, /* bad map */
677 221, 1, /* bad map */
678 222, 1, /* bad map */
679 223, 1, /* bad map */
680 224, 1, /* bad map */
681 225, 1, /* bad map */
682 226, 1, /* bad map */
684 228, 1, /* bad map */
689 233, 1, /* bad map */
690 234, 1, /* bad map */
696 240, 1, /* bad map */
697 241, 1, /* bad map */
699 243, 1, /* bad map */
704 1001, 1, /* bad map */
705 1002, 1, /* bad map */
706 1003, 1, /* bad map */
707 1004, 1, /* bad map */
708 1005, 1, /* bad map */
709 1006, 1, /* bad map */
741 int yaz_diag_bib1_to_srw (int code)
743 const int *p = srw_bib1_map;
753 int yaz_diag_srw_to_bib1(int code)
755 const int *p = srw_bib1_map;