1 /* $Id: alvis.c,v 1.11 2007-01-15 15:10:16 adam Exp $
2 Copyright (C) 1995-2007
5 This file is part of the Zebra server.
7 Zebra is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
27 #include <yaz/diagbib1.h>
28 #include <yaz/tpath.h>
30 #include <libxml/xmlversion.h>
31 #include <libxml/parser.h>
32 #include <libxml/tree.h>
33 #include <libxml/xmlIO.h>
34 #include <libxml/xmlreader.h>
35 #include <libxslt/transform.h>
36 #include <libxslt/xsltutils.h>
39 #include <libexslt/exslt.h>
42 #include <idzebra/util.h>
43 #include <idzebra/recctrl.h>
45 struct filter_schema {
47 const char *identifier;
48 const char *stylesheet;
49 struct filter_schema *next;
50 const char *default_schema;
51 /* char default_schema; */
52 const char *include_snippet;
53 xsltStylesheetPtr stylesheet_xsp;
60 const char *profile_path;
62 const char *split_path;
64 struct filter_schema *schemas;
65 xmlTextReaderPtr reader;
68 #define ZEBRA_SCHEMA_XSLT_NS "http://indexdata.dk/zebra/xslt/1"
70 #define XML_STRCMP(a,b) strcmp((char*)a, b)
71 #define XML_STRLEN(a) strlen((char*)a)
73 static const char *zebra_xslt_ns = ZEBRA_SCHEMA_XSLT_NS;
75 static void set_param_xml(const char **params, const char *name,
76 const char *value, ODR odr)
85 static void set_param_str(const char **params, const char *name,
86 const char *value, ODR odr)
88 char *quoted = odr_malloc(odr, 3 + strlen(value));
89 sprintf(quoted, "'%s'", value);
97 static void set_param_int(const char **params, const char *name,
100 char *quoted = odr_malloc(odr, 30); /* 25 digits enough for 2^64 */
103 sprintf(quoted, "'" ZINT_FORMAT "'", value);
109 #define ENABLE_INPUT_CALLBACK 0
111 #if ENABLE_INPUT_CALLBACK
112 static int zebra_xmlInputMatchCallback (char const *filename)
114 yaz_log(YLOG_LOG, "match %s", filename);
118 static void * zebra_xmlInputOpenCallback (char const *filename)
123 static int zebra_xmlInputReadCallback (void * context, char * buffer, int len)
128 static int zebra_xmlInputCloseCallback (void * context)
134 static void *filter_init(Res res, RecType recType)
136 struct filter_info *tinfo = (struct filter_info *) xmalloc(sizeof(*tinfo));
139 tinfo->full_name = 0;
140 tinfo->profile_path = 0;
141 tinfo->split_level = 0;
142 tinfo->split_path = 0;
143 tinfo->odr = odr_createmem(ODR_ENCODE);
151 #if ENABLE_INPUT_CALLBACK
152 xmlRegisterDefaultInputCallbacks();
153 xmlRegisterInputCallbacks(zebra_xmlInputMatchCallback,
154 zebra_xmlInputOpenCallback,
155 zebra_xmlInputReadCallback,
156 zebra_xmlInputCloseCallback);
161 static int attr_content(struct _xmlAttr *attr, const char *name,
162 const char **dst_content)
164 if (!XML_STRCMP(attr->name, name) && attr->children
165 && attr->children->type == XML_TEXT_NODE)
167 *dst_content = (const char *)(attr->children->content);
173 static void destroy_schemas(struct filter_info *tinfo)
175 struct filter_schema *schema = tinfo->schemas;
178 struct filter_schema *schema_next = schema->next;
179 if (schema->stylesheet_xsp)
180 xsltFreeStylesheet(schema->stylesheet_xsp);
182 schema = schema_next;
187 xmlFreeDoc(tinfo->doc);
191 static ZEBRA_RES create_schemas(struct filter_info *tinfo, const char *fname)
193 char tmp_full_name[1024];
195 tinfo->fname = xstrdup(fname);
197 if (yaz_filepath_resolve(tinfo->fname, tinfo->profile_path,
198 NULL, tmp_full_name))
199 tinfo->full_name = xstrdup(tmp_full_name);
201 tinfo->full_name = xstrdup(tinfo->fname);
203 yaz_log(YLOG_LOG, "alvis filter: loading config file %s", tinfo->full_name);
205 tinfo->doc = xmlParseFile(tinfo->full_name);
209 yaz_log(YLOG_WARN, "alvis filter: could not parse config file %s",
215 ptr = xmlDocGetRootElement(tinfo->doc);
216 if (!ptr || ptr->type != XML_ELEMENT_NODE
217 || XML_STRCMP(ptr->name, "schemaInfo"))
220 "alvis filter: config file %s :"
221 " expected root element <schemaInfo>",
226 for (ptr = ptr->children; ptr; ptr = ptr->next)
228 if (ptr->type != XML_ELEMENT_NODE)
230 if (!XML_STRCMP(ptr->name, "schema"))
232 struct _xmlAttr *attr;
233 struct filter_schema *schema = xmalloc(sizeof(*schema));
235 schema->identifier = 0;
236 schema->stylesheet = 0;
237 schema->default_schema = 0;
238 schema->next = tinfo->schemas;
239 schema->stylesheet_xsp = 0;
240 schema->include_snippet = 0;
241 tinfo->schemas = schema;
242 for (attr = ptr->properties; attr; attr = attr->next)
244 attr_content(attr, "identifier", &schema->identifier);
245 attr_content(attr, "name", &schema->name);
246 attr_content(attr, "stylesheet", &schema->stylesheet);
247 attr_content(attr, "default", &schema->default_schema);
248 attr_content(attr, "snippet", &schema->include_snippet);
250 /*yaz_log(YLOG_LOG, "XSLT add %s %s %s",
251 schema->name, schema->identifier, schema->stylesheet); */
253 /* find requested schema */
255 if (schema->stylesheet)
257 char tmp_xslt_full_name[1024];
258 if (!yaz_filepath_resolve(schema->stylesheet, tinfo->profile_path,
259 NULL, tmp_xslt_full_name))
262 "alvis filter: stylesheet %s not found in path %s",
263 schema->stylesheet, tinfo->profile_path);
266 schema->stylesheet_xsp
267 = xsltParseStylesheetFile((const xmlChar*) tmp_xslt_full_name);
268 if (!schema->stylesheet_xsp)
271 "alvis filter: could not parse xslt stylesheet %s",
277 else if (!XML_STRCMP(ptr->name, "split"))
279 struct _xmlAttr *attr;
280 for (attr = ptr->properties; attr; attr = attr->next)
282 const char *split_level_str = 0;
283 attr_content(attr, "level", &split_level_str);
285 split_level_str ? atoi(split_level_str) : 0;
290 yaz_log(YLOG_WARN, "Bad element %s in %s", ptr->name, fname);
297 static struct filter_schema *lookup_schema(struct filter_info *tinfo,
300 struct filter_schema *schema;
302 for (schema = tinfo->schemas; schema; schema = schema->next)
304 /* find requested schema */
307 if (schema->identifier && !strcmp(schema->identifier, est))
310 if (schema->name && !strcmp(schema->name, est))
313 /* or return default schema if defined */
314 else if (schema->default_schema)
318 /* return first schema if no default schema defined */
320 return tinfo->schemas;
325 static ZEBRA_RES filter_config(void *clientData, Res res, const char *args)
327 struct filter_info *tinfo = clientData;
330 yaz_log(YLOG_WARN, "alvis filter: need config file");
334 if (tinfo->fname && !strcmp(args, tinfo->fname))
337 tinfo->profile_path = res_get(res, "profilePath");
338 yaz_log(YLOG_LOG, "alvis filter: profilePath %s", tinfo->profile_path);
340 destroy_schemas(tinfo);
341 return create_schemas(tinfo, args);
344 static void filter_destroy(void *clientData)
346 struct filter_info *tinfo = clientData;
347 destroy_schemas(tinfo);
349 xmlFreeTextReader(tinfo->reader);
350 odr_destroy(tinfo->odr);
354 static int ioread_ex(void *context, char *buffer, int len)
356 struct recExtractCtrl *p = context;
357 return p->stream->readf(p->stream, buffer, len);
360 static int ioclose_ex(void *context)
365 static void index_cdata(struct filter_info *tinfo, struct recExtractCtrl *ctrl,
366 xmlNodePtr ptr, RecWord *recWord)
368 for(; ptr; ptr = ptr->next)
370 index_cdata(tinfo, ctrl, ptr->children, recWord);
371 if (ptr->type != XML_TEXT_NODE)
373 recWord->term_buf = (const char *)ptr->content;
374 recWord->term_len = XML_STRLEN(ptr->content);
375 (*ctrl->tokenAdd)(recWord);
379 static void index_node(struct filter_info *tinfo, struct recExtractCtrl *ctrl,
380 xmlNodePtr ptr, RecWord *recWord)
382 for(; ptr; ptr = ptr->next)
384 index_node(tinfo, ctrl, ptr->children, recWord);
385 if (ptr->type != XML_ELEMENT_NODE || !ptr->ns ||
386 XML_STRCMP(ptr->ns->href, zebra_xslt_ns))
388 if (!XML_STRCMP(ptr->name, "index"))
390 const char *name_str = 0;
391 const char *type_str = 0;
392 const char *xpath_str = 0;
393 struct _xmlAttr *attr;
394 for (attr = ptr->properties; attr; attr = attr->next)
396 attr_content(attr, "name", &name_str);
397 attr_content(attr, "xpath", &xpath_str);
398 attr_content(attr, "type", &type_str);
402 int prev_type = recWord->index_type; /* save default type */
404 if (type_str && *type_str)
405 recWord->index_type = *type_str; /* type was given */
406 recWord->index_name = name_str;
407 index_cdata(tinfo, ctrl, ptr->children, recWord);
409 recWord->index_type = prev_type; /* restore it again */
415 static void index_record(struct filter_info *tinfo,struct recExtractCtrl *ctrl,
416 xmlNodePtr ptr, RecWord *recWord)
418 const char *type_str = "update";
420 if (ptr && ptr->type == XML_ELEMENT_NODE && ptr->ns &&
421 !XML_STRCMP(ptr->ns->href, zebra_xslt_ns)
422 && !XML_STRCMP(ptr->name, "record"))
424 const char *id_str = 0;
425 const char *rank_str = 0;
426 struct _xmlAttr *attr;
427 for (attr = ptr->properties; attr; attr = attr->next)
429 attr_content(attr, "type", &type_str);
430 attr_content(attr, "id", &id_str);
431 attr_content(attr, "rank", &rank_str);
434 sscanf(id_str, "%255s", ctrl->match_criteria);
437 ctrl->staticrank = atozint(rank_str);
441 if (!strcmp("update", type_str))
442 index_node(tinfo, ctrl, ptr, recWord);
443 else if (!strcmp("delete", type_str))
444 yaz_log(YLOG_WARN, "alvis filter delete: to be implemented");
446 yaz_log(YLOG_WARN, "alvis filter: unknown record type '%s'",
450 static int extract_doc(struct filter_info *tinfo, struct recExtractCtrl *p,
454 const char *params[10];
458 struct filter_schema *schema = lookup_schema(tinfo, zebra_xslt_ns);
461 set_param_str(params, "schema", zebra_xslt_ns, tinfo->odr);
463 (*p->init)(p, &recWord);
465 if (schema && schema->stylesheet_xsp)
469 xsltApplyStylesheet(schema->stylesheet_xsp,
471 if (p->flagShowRecords)
473 xmlDocDumpMemory(resDoc, &buf_out, &len_out);
474 fwrite(buf_out, len_out, 1, stdout);
477 root_ptr = xmlDocGetRootElement(resDoc);
479 index_record(tinfo, p, root_ptr, &recWord);
482 yaz_log(YLOG_WARN, "No root for index XML record."
483 " split_level=%d stylesheet=%s",
484 tinfo->split_level, schema->stylesheet);
488 xmlDocDumpMemory(doc, &buf_out, &len_out);
489 if (p->flagShowRecords)
490 fwrite(buf_out, len_out, 1, stdout);
491 (*p->setStoreData)(p, buf_out, len_out);
495 return RECCTRL_EXTRACT_OK;
498 static int extract_split(struct filter_info *tinfo, struct recExtractCtrl *p)
505 xmlFreeTextReader(tinfo->reader);
506 tinfo->reader = xmlReaderForIO(ioread_ex, ioclose_ex,
513 return RECCTRL_EXTRACT_ERROR_GENERIC;
515 ret = xmlTextReaderRead(tinfo->reader);
518 int type = xmlTextReaderNodeType(tinfo->reader);
519 int depth = xmlTextReaderDepth(tinfo->reader);
520 if (type == XML_READER_TYPE_ELEMENT && tinfo->split_level == depth)
522 xmlNodePtr ptr = xmlTextReaderExpand(tinfo->reader);
525 xmlNodePtr ptr2 = xmlCopyNode(ptr, 1);
526 xmlDocPtr doc = xmlNewDoc((const xmlChar*) "1.0");
528 xmlDocSetRootElement(doc, ptr2);
530 return extract_doc(tinfo, p, doc);
534 xmlFreeTextReader(tinfo->reader);
536 return RECCTRL_EXTRACT_ERROR_GENERIC;
539 ret = xmlTextReaderRead(tinfo->reader);
541 xmlFreeTextReader(tinfo->reader);
543 return RECCTRL_EXTRACT_EOF;
546 static int extract_full(struct filter_info *tinfo, struct recExtractCtrl *p)
548 if (p->first_record) /* only one record per stream */
550 xmlDocPtr doc = xmlReadIO(ioread_ex, ioclose_ex, p /* I/O handler */,
556 return RECCTRL_EXTRACT_ERROR_GENERIC;
558 return extract_doc(tinfo, p, doc);
561 return RECCTRL_EXTRACT_EOF;
564 static int filter_extract(void *clientData, struct recExtractCtrl *p)
566 struct filter_info *tinfo = clientData;
568 odr_reset(tinfo->odr);
569 if (tinfo->split_level == 0)
570 return extract_full(tinfo, p);
572 return extract_split(tinfo, p);
575 static int ioread_ret(void *context, char *buffer, int len)
577 struct recRetrieveCtrl *p = context;
578 return p->stream->readf(p->stream, buffer, len);
581 static int ioclose_ret(void *context)
586 static const char *snippet_doc(struct recRetrieveCtrl *p, int text_mode,
589 const char *xml_doc_str;
591 WRBUF wrbuf = wrbuf_alloc();
592 zebra_snippets *res =
593 zebra_snippets_window(p->doc_snippet, p->hit_snippet, window_size);
594 zebra_snippet_word *w = zebra_snippets_list(res);
597 wrbuf_printf(wrbuf, "\'");
599 wrbuf_printf(wrbuf, "<snippet xmlns='%s'>\n", zebra_xslt_ns);
600 for (; w; w = w->next)
604 else if (ord != w->ord)
608 wrbuf_printf(wrbuf, "%s%s%s ",
611 w->match ? "*" : "");
614 wrbuf_printf(wrbuf, " <term ord='%d' seqno='" ZINT_FORMAT "' %s>",
616 (w->match ? "match='1'" : ""));
617 wrbuf_xmlputs(wrbuf, w->term);
618 wrbuf_printf(wrbuf, "</term>\n");
622 wrbuf_printf(wrbuf, "\'");
624 wrbuf_printf(wrbuf, "</snippet>\n");
626 xml_doc_str = odr_strdup(p->odr, wrbuf_buf(wrbuf));
628 zebra_snippets_destroy(res);
629 wrbuf_free(wrbuf, 1);
633 static int filter_retrieve (void *clientData, struct recRetrieveCtrl *p)
635 /* const char *esn = zebra_xslt_ns; */
637 const char *params[32];
638 struct filter_info *tinfo = clientData;
641 struct filter_schema *schema;
642 int window_size = -1;
646 if (p->comp->which == Z_RecordComp_simple
647 && p->comp->u.simple->which == Z_ElementSetNames_generic)
649 esn = p->comp->u.simple->u.generic;
651 else if (p->comp->which == Z_RecordComp_complex
652 && p->comp->u.complex->generic->elementSpec
653 && p->comp->u.complex->generic->elementSpec->which ==
654 Z_ElementSpec_elementSetName)
656 esn = p->comp->u.complex->generic->elementSpec->u.elementSetName;
659 schema = lookup_schema(tinfo, esn);
663 YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
667 if (schema->include_snippet)
668 window_size = atoi(schema->include_snippet);
671 set_param_int(params, "id", p->localno, p->odr);
673 set_param_str(params, "filename", p->fname, p->odr);
674 if (p->staticrank >= 0)
675 set_param_int(params, "rank", p->staticrank, p->odr);
678 set_param_str(params, "schema", esn, p->odr);
681 set_param_str(params, "schema", schema->name, p->odr);
682 else if (schema->identifier)
683 set_param_str(params, "schema", schema->identifier, p->odr);
685 set_param_str(params, "schema", "", p->odr);
688 set_param_int(params, "score", p->score, p->odr);
689 set_param_int(params, "size", p->recordSize, p->odr);
691 if (window_size >= 0)
692 set_param_xml(params, "snippet", snippet_doc(p, 1, window_size),
694 doc = xmlReadIO(ioread_ret, ioclose_ret, p /* I/O handler */,
700 p->diagnostic = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
704 if (window_size >= 0)
706 xmlNodePtr node = xmlDocGetRootElement(doc);
707 const char *snippet_str = snippet_doc(p, 0, window_size);
708 xmlDocPtr snippet_doc = xmlParseMemory(snippet_str, strlen(snippet_str));
709 xmlAddChild(node, xmlDocGetRootElement(snippet_doc));
711 if (!schema->stylesheet_xsp)
715 resDoc = xsltApplyStylesheet(schema->stylesheet_xsp,
721 p->diagnostic = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
723 else if (p->input_format == VAL_NONE || p->input_format == VAL_TEXT_XML)
728 if (schema->stylesheet_xsp)
729 xsltSaveResultToString(&buf_out, &len_out, resDoc,
730 schema->stylesheet_xsp);
732 xmlDocDumpMemory(resDoc, &buf_out, &len_out);
734 p->output_format = VAL_TEXT_XML;
735 p->rec_len = len_out;
736 p->rec_buf = odr_malloc(p->odr, p->rec_len);
737 memcpy(p->rec_buf, buf_out, p->rec_len);
740 else if (p->output_format == VAL_SUTRS)
745 if (schema->stylesheet_xsp)
746 xsltSaveResultToString(&buf_out, &len_out, resDoc,
747 schema->stylesheet_xsp);
749 xmlDocDumpMemory(resDoc, &buf_out, &len_out);
751 p->output_format = VAL_SUTRS;
752 p->rec_len = len_out;
753 p->rec_buf = odr_malloc(p->odr, p->rec_len);
754 memcpy(p->rec_buf, buf_out, p->rec_len);
760 p->diagnostic = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
766 static struct recType filter_type = {
777 #ifdef IDZEBRA_STATIC_ALVIS
790 * indent-tabs-mode: nil
792 * vim: shiftwidth=4 tabstop=8 expandtab