External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-07-11 12:25:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

virXMLParseHelper: Add root XML node name validation capability

Browse Source 
Some callers want to validate the root XML node name. Add the capability
to the parser helper to prevent open-coding.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
This commit is contained in:
Peter Krempa 2021-04-14 13:12:12 +02:00
parent b660a043e0
commit 3362ab5e02
2 changed files with 23 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/util/virxml.c
View File

@ -1020,11 +1020,15 @@ catchXMLError(void *ctx, const char *msg G_GNUC_UNUSED, ...)
* @filename: file to be parsed or NULL if string parsing is requested
* @xmlStr: XML string to be parsed in case filename is NULL
* @url: URL of XML document for string parser
* @rootelement: Optional name of the expected root element
* @ctxt: optional pointer to populate with new context pointer
*
* Parse XML document provided either as a file or a string. The function
* guarantees that the XML document contains a root element.
*
* If @rootelement is not NULL, the name of the root element of the parsed XML
* is vaidated against
*
* Returns parsed XML document.
*/
xmlDocPtr
@ -1032,11 +1036,13 @@ virXMLParseHelper(int domcode,
const char *filename,
const char *xmlStr,
const char *url,
const char *rootelement,
xmlXPathContextPtr *ctxt)
{
struct virParserData private;
g_autoptr(xmlParserCtxt) pctxt = NULL;
g_autoptr(xmlDoc) xml = NULL;
xmlNodePtr rootnode;
const char *docname;
if (filename)
@ -1075,18 +1081,26 @@ virXMLParseHelper(int domcode,
return NULL;
}
if (xmlDocGetRootElement(xml) == NULL) {
if (!(rootnode = xmlDocGetRootElement(xml))) {
virGenericReportError(domcode, VIR_ERR_INTERNAL_ERROR,
"%s", _("missing root element"));
return NULL;
}
if (rootelement &&
!virXMLNodeNameEqual(rootnode, rootelement)) {
virReportError(VIR_ERR_XML_ERROR,
_("expecting root element of '%s', not '%s'"),
rootelement, rootnode->name);
return NULL;
}
if (ctxt) {
if (!(*ctxt = virXMLXPathContextNew(xml)))
return NULL;
(*ctxt)->node = xmlDocGetRootElement(xml);
(*ctxt)->node = rootnode;
}
return g_steal_pointer(&xml);

13
src/util/virxml.h
View File

@ -150,6 +150,7 @@ virXMLParseHelper(int domcode,
const char *filename,
const char *xmlStr,
const char *url,
const char *rootelement,
xmlXPathContextPtr *ctxt);
const char *
@ -166,7 +167,7 @@ virXMLPickShellSafeComment(const char *str1,
* Return the parsed document object, or NULL on failure.
*/
#define virXMLParse(filename, xmlStr, url) \
virXMLParseHelper(VIR_FROM_THIS, filename, xmlStr, url, NULL)
virXMLParseHelper(VIR_FROM_THIS, filename, xmlStr, url, NULL, NULL)
/**
* virXMLParseString:
@ -178,7 +179,7 @@ virXMLPickShellSafeComment(const char *str1,
* Return the parsed document object, or NULL on failure.
*/
#define virXMLParseString(xmlStr, url) \
virXMLParseHelper(VIR_FROM_THIS, NULL, xmlStr, url, NULL)
virXMLParseHelper(VIR_FROM_THIS, NULL, xmlStr, url, NULL, NULL)
/**
* virXMLParseFile:
@ -189,7 +190,7 @@ virXMLPickShellSafeComment(const char *str1,
* Return the parsed document object, or NULL on failure.
*/
#define virXMLParseFile(filename) \
virXMLParseHelper(VIR_FROM_THIS, filename, NULL, NULL, NULL)
virXMLParseHelper(VIR_FROM_THIS, filename, NULL, NULL, NULL, NULL)
/**
* virXMLParseCtxt:
@ -204,7 +205,7 @@ virXMLPickShellSafeComment(const char *str1,
* Return the parsed document object, or NULL on failure.
*/
#define virXMLParseCtxt(filename, xmlStr, url, pctxt) \
virXMLParseHelper(VIR_FROM_THIS, filename, xmlStr, url, pctxt)
virXMLParseHelper(VIR_FROM_THIS, filename, xmlStr, url, NULL, pctxt)
/**
* virXMLParseStringCtxt:
@ -218,7 +219,7 @@ virXMLPickShellSafeComment(const char *str1,
* Return the parsed document object, or NULL on failure.
*/
#define virXMLParseStringCtxt(xmlStr, url, pctxt) \
virXMLParseHelper(VIR_FROM_THIS, NULL, xmlStr, url, pctxt)
virXMLParseHelper(VIR_FROM_THIS, NULL, xmlStr, url, NULL, pctxt)
/**
* virXMLParseFileCtxt:
@ -231,7 +232,7 @@ virXMLPickShellSafeComment(const char *str1,
* Return the parsed document object, or NULL on failure.
*/
#define virXMLParseFileCtxt(filename, pctxt) \
virXMLParseHelper(VIR_FROM_THIS, filename, NULL, NULL, pctxt)
virXMLParseHelper(VIR_FROM_THIS, filename, NULL, NULL, NULL, pctxt)
int
virXMLSaveFile(const char *path,