2 * Copyright (C) 2005-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: retrieval.c,v 1.21 2007-05-08 08:22:36 adam Exp $
9 * \brief Retrieval utility
17 #include <yaz/retrieval.h>
18 #include <yaz/wrbuf.h>
19 #include <yaz/xmalloc.h>
21 #include <yaz/tpath.h>
22 #include <yaz/proto.h>
23 #include <yaz/oid_db.h>
26 #include <libxml/parser.h>
27 #include <libxml/tree.h>
28 #include <libxml/xinclude.h>
30 /** \brief The internal structure for yaz_retrieval_t */
31 struct yaz_retrieval_struct {
32 /** \brief ODR memory for configuration */
35 /** \brief odr's NMEM memory (odr->mem) */
38 /** \brief string buffer for error messages */
41 /** \brief path for opening files */
44 /** \brief retrieval list */
45 struct yaz_retrieval_elem *list;
47 /** \brief last pointer in retrieval list */
48 struct yaz_retrieval_elem **list_p;
51 /** \brief information per 'retrieval' construct */
52 struct yaz_retrieval_elem {
53 /** \brief schema identifier */
54 const char *identifier;
55 /** \brief schema name , short-hand such as "dc" */
57 /** \brief record syntax */
60 /** \brief backend name */
61 const char *backend_name;
62 /** \brief backend syntax */
63 Odr_oid *backend_syntax;
65 /** \brief record conversion */
66 yaz_record_conv_t record_conv;
68 /** \brief next element in list */
69 struct yaz_retrieval_elem *next;
72 static void yaz_retrieval_reset(yaz_retrieval_t p);
74 yaz_retrieval_t yaz_retrieval_create()
76 yaz_retrieval_t p = (yaz_retrieval_t) xmalloc(sizeof(*p));
77 p->odr = odr_createmem(ODR_ENCODE);
78 p->nmem = odr_getmem(p->odr);
79 p->wr_error = wrbuf_alloc();
82 yaz_retrieval_reset(p);
86 void yaz_retrieval_destroy(yaz_retrieval_t p)
90 yaz_retrieval_reset(p);
92 wrbuf_destroy(p->wr_error);
98 void yaz_retrieval_reset(yaz_retrieval_t p)
100 struct yaz_retrieval_elem *el = p->list;
101 for(; el; el = el->next)
102 yaz_record_conv_destroy(el->record_conv);
104 wrbuf_rewind(p->wr_error);
108 p->list_p = &p->list;
111 /** \brief parse retrieval XML config */
112 static int conf_retrieval(yaz_retrieval_t p, const xmlNode *ptr)
115 struct _xmlAttr *attr;
116 struct yaz_retrieval_elem *el = (struct yaz_retrieval_elem *)
117 nmem_malloc(p->nmem, sizeof(*el));
122 el->backend_name = 0;
123 el->backend_syntax = 0;
127 for (attr = ptr->properties; attr; attr = attr->next)
129 if (!xmlStrcmp(attr->name, BAD_CAST "syntax") &&
130 attr->children && attr->children->type == XML_TEXT_NODE)
132 el->syntax = yaz_string_to_oid_odr(
135 (const char *) attr->children->content,
139 wrbuf_printf(p->wr_error, "Element <retrieval>: "
140 " unknown attribute value syntax='%s'",
141 (const char *) attr->children->content);
145 else if (!xmlStrcmp(attr->name, BAD_CAST "identifier") &&
146 attr->children && attr->children->type == XML_TEXT_NODE)
148 nmem_strdup(p->nmem, (const char *) attr->children->content);
149 else if (!xmlStrcmp(attr->name, BAD_CAST "name") &&
150 attr->children && attr->children->type == XML_TEXT_NODE)
152 nmem_strdup(p->nmem, (const char *) attr->children->content);
155 wrbuf_printf(p->wr_error, "Element <retrieval>: "
156 " expected attributes 'syntax', identifier' or "
157 "'name', got '%s'", attr->name);
164 wrbuf_printf(p->wr_error, "Missing 'syntax' attribute");
168 /* parsing backend element */
170 el->record_conv = 0; /* OK to have no 'backend' sub content */
171 for (ptr = ptr->children; ptr; ptr = ptr->next)
173 if (ptr->type != XML_ELEMENT_NODE)
175 if (strcmp((const char *) ptr->name, "backend")){
176 wrbuf_printf(p->wr_error, "Element <retrieval>: expected"
177 " zero or one element <backend>, got <%s>",
178 (const char *) ptr->name);
184 /* parsing attributees */
185 struct _xmlAttr *attr;
186 for (attr = ptr->properties; attr; attr = attr->next){
188 if (!xmlStrcmp(attr->name, BAD_CAST "name")
190 && attr->children->type == XML_TEXT_NODE)
192 = nmem_strdup(p->nmem,
193 (const char *) attr->children->content);
195 else if (!xmlStrcmp(attr->name, BAD_CAST "syntax")
197 && attr->children->type == XML_TEXT_NODE){
199 = yaz_string_to_oid_odr(
202 (const char *) attr->children->content,
204 if (!el->backend_syntax){
205 wrbuf_printf(p->wr_error,
206 "Element <backend syntax='%s'>: "
207 "attribute 'syntax' has invalid "
209 attr->children->content,
210 attr->children->content);
215 wrbuf_printf(p->wr_error, "Element <backend>: expected "
216 "attributes 'syntax' or 'name, got '%s'",
223 /* parsing internal of record conv */
224 el->record_conv = yaz_record_conv_create();
226 yaz_record_conv_set_path(el->record_conv, p->path);
229 if (yaz_record_conv_configure(el->record_conv, ptr))
231 wrbuf_printf(p->wr_error, "%s",
232 yaz_record_conv_get_error(el->record_conv));
233 yaz_record_conv_destroy(el->record_conv);
240 p->list_p = &el->next;
244 int yaz_retrieval_configure(yaz_retrieval_t p, const xmlNode *ptr)
246 yaz_retrieval_reset(p);
248 if (ptr && ptr->type == XML_ELEMENT_NODE &&
249 !strcmp((const char *) ptr->name, "retrievalinfo"))
251 for (ptr = ptr->children; ptr; ptr = ptr->next)
253 if (ptr->type != XML_ELEMENT_NODE)
255 if (!strcmp((const char *) ptr->name, "retrieval"))
257 if (conf_retrieval(p, ptr))
262 wrbuf_printf(p->wr_error, "Element <retrievalinfo>: "
263 "expected element <retrieval>, got <%s>",
271 wrbuf_printf(p->wr_error, "Expected element <retrievalinfo>");
277 int yaz_retrieval_request(yaz_retrieval_t p,
278 const char *schema, Odr_oid *syntax,
279 const char **match_schema, Odr_oid **match_syntax,
280 yaz_record_conv_t *rc,
281 const char **backend_schema,
282 Odr_oid **backend_syntax)
284 struct yaz_retrieval_elem *el = p->list;
285 int syntax_matches = 0;
286 int schema_matches = 0;
288 wrbuf_rewind(p->wr_error);
291 for(; el; el = el->next)
300 if (el->name && !strcmp(schema, el->name))
302 if (el->identifier && !strcmp(schema, el->identifier))
304 if (!el->name && !el->identifier)
308 if (syntax && el->syntax && !oid_oidcmp(syntax, el->syntax))
317 if (syntax_ok && schema_ok)
319 *match_syntax = el->syntax;
321 *match_schema = el->identifier;
326 if (el->backend_name)
327 *backend_schema = el->backend_name;
329 *backend_schema = el->name;
331 *backend_schema = schema;
335 if (el->backend_syntax)
336 *backend_syntax = el->backend_syntax;
338 *backend_syntax = el->syntax;
341 *rc = el->record_conv;
345 if (!syntax_matches && syntax)
347 char buf[OID_STR_MAX];
348 wrbuf_printf(p->wr_error, "%s", oid_oid_to_dotstring(syntax, buf));
352 wrbuf_printf(p->wr_error, "%s", schema);
358 const char *yaz_retrieval_get_error(yaz_retrieval_t p)
360 return wrbuf_cstr(p->wr_error);
363 void yaz_retrieval_set_path(yaz_retrieval_t p, const char *path)
368 p->path = xstrdup(path);
376 * indent-tabs-mode: nil
378 * vim: shiftwidth=4 tabstop=8 expandtab