include/yaz/xml_include.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /** \file
  29     \brief XML Include (not to be confused with W3C XInclude)
  30 */
  31
  32 #ifndef YAZ_XML_INCLUDE_H
  33 #define YAZ_XML_INCLUDE_H
  34
  35 #include <yaz/yconfig.h>
  36 #include <yaz/xmltypes.h>
  37 #include <yaz/file_glob.h>
  38
  39 YAZ_BEGIN_CDECL
  40
  41 #if YAZ_HAVE_XML2
  42
  43 /** \brief substitute include nodes in a tree
  44     \param n node where include is performed
  45     \param base_path base_path - for relative file specs
  46     \retval 0 OK
  47     \retval -1 FAILURE
  48
  49     Nodes of the form <include src="glob-pattern"/> are substituted with
  50     contents of files matching glob-pattern. Do not use this function
  51     on XML from untrusted sources -- from the net for example -- local
  52     trusted XML configuration ONLY.
  53 */
  54 YAZ_EXPORT
  55 int yaz_xml_include_simple(xmlNode *n, const char *base_path);
  56
  57 /** \brief substitute include nodes in a tree
  58     \param n node where include is performed
  59     \param base_path base_path - for relative file specs
  60     \param flags for yaz_file_glob2 (YAZ_FILE_GLOB_...)
  61     \retval 0 OK
  62     \retval -1 FAILURE
  63
  64     Nodes of the form <include src="glob-pattern"/> are substituted with
  65     contents of files matching glob-pattern. Do not use this function
  66     on XML from untrusted sources -- from the net for example -- local
  67     trusted XML configuration ONLY.
  68 */
  69 YAZ_EXPORT
  70 int yaz_xml_include_glob(xmlNode *n, const char *base_path, unsigned flags);
  71
  72 #endif
  73 YAZ_END_CDECL
  74
  75 #endif
  76
  77 /*
  78  * Local variables:
  79  * c-basic-offset: 4
  80  * c-file-style: "Stroustrup"
  81  * indent-tabs-mode: nil
  82  * End:
  83  * vim: shiftwidth=4 tabstop=8 expandtab
  84  */
  85