Wrappers for and extensions to libxml2. More...

#include <stdio.h>
#include <sys/types.h>
#include <unistd.h>
#include <stdlib.h>
#include <errno.h>
#include <fcntl.h>
#include <libxml/tree.h>
#include <libxml/xpath.h>
#include <crm/crm.h>
#include <crm/common/nvpair.h>
#include <crm/common/xml_compat.h>

Include dependency graph for xml.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	CRM_BZ2_BLOCKS 4

#define	CRM_BZ2_WORK 20

#define	CRM_BZ2_THRESHOLD 128 * 1024

#define	XML_PARANOIA_CHECKS 0

Typedefs
typedef const xmlChar *	pcmkXmlStr

Functions
gboolean	add_message_xml (xmlNode msg, const char field, xmlNode *xml)

xmlNode *	get_message_xml (xmlNode msg, const char field)

xmlDoc *	getDocPtr (xmlNode *node)

void	copy_in_properties (xmlNode target, xmlNode src)

void	expand_plus_plus (xmlNode target, const char name, const char *value)

void	fix_plus_plus_recursive (xmlNode *target)

xmlNode *	create_xml_node (xmlNode parent, const char name)

xmlNode *	pcmk_create_xml_text_node (xmlNode parent, const char name, const char *content)

xmlNode *	pcmk_create_html_node (xmlNode parent, const char element_name, const char id, const char class_name, const char *text)

void	purge_diff_markers (xmlNode *a_node)

xmlNode *	copy_xml (xmlNode *src_node)

xmlNode *	add_node_copy (xmlNode new_parent, xmlNode xml_node)

int	add_node_nocopy (xmlNode parent, const char name, xmlNode *child)

xmlNode *	filename2xml (const char *filename)

xmlNode *	stdin2xml (void)

xmlNode *	string2xml (const char *input)

int	write_xml_fd (xmlNode xml_node, const char filename, int fd, gboolean compress)
	Write XML to a file descriptor. More...

int	write_xml_file (xmlNode xml_node, const char filename, gboolean compress)
	Write XML to a file. More...

char *	dump_xml_formatted (xmlNode *msg)

char *	dump_xml_formatted_with_text (xmlNode *msg)

char *	dump_xml_unformatted (xmlNode *msg)

xmlNode *	diff_xml_object (xmlNode left, xmlNode right, gboolean suppress)

xmlNode *	subtract_xml_object (xmlNode parent, xmlNode left, xmlNode right, gboolean full, gboolean changed, const char *marker)

gboolean	can_prune_leaf (xmlNode *xml_node)

xmlNode *	find_xml_node (xmlNode cib, const char node_path, gboolean must_find)

void	xml_remove_prop (xmlNode obj, const char name)

gboolean	replace_xml_child (xmlNode parent, xmlNode child, xmlNode *update, gboolean delete_only)

gboolean	update_xml_child (xmlNode child, xmlNode to_update)

int	find_xml_children (xmlNode *children, xmlNode root, const char tag, const char field, const char *value, gboolean search_matches)

xmlNode *	get_xpath_object (const char xpath, xmlNode xml_obj, int error_level)

xmlNode *	get_xpath_object_relative (const char xpath, xmlNode xml_obj, int error_level)

gboolean	xml_has_children (const xmlNode *root)

char *	calculate_on_disk_digest (xmlNode *local_cib)
	Calculate and return digest of XML tree, suitable for storing on disk. More...

char *	calculate_operation_digest (xmlNode local_cib, const char version)
	Calculate and return digest of XML operation. More...

char *	calculate_xml_versioned_digest (xmlNode input, gboolean sort, gboolean do_filter, const char version)
	Calculate and return digest of XML tree. More...

gboolean	validate_xml (xmlNode xml_blob, const char validation, gboolean to_logs)

gboolean	validate_xml_verbose (xmlNode *xml_blob)

int	update_validation (xmlNode *xml_blob, int best, int max, gboolean transform, gboolean to_logs)
	Update CIB XML to most recent schema version. More...

int	get_schema_version (const char *name)

const char *	get_schema_name (int version)

const char *	xml_latest_schema (void)

gboolean	cli_config_update (xmlNode *xml, int best_version, gboolean to_logs)

void	crm_xml_init (void)

void	crm_xml_cleanup (void)

void	pcmk_free_xml_subtree (xmlNode *xml)

void	free_xml (xmlNode *child)

xmlNode *	first_named_child (const xmlNode parent, const char name)

xmlNode *	crm_next_same_xml (const xmlNode *sibling)
	Get next instance of same XML tag. More...

xmlNode *	sorted_xml (xmlNode input, xmlNode parent, gboolean recursive)

xmlXPathObjectPtr	xpath_search (xmlNode xml_top, const char path)

void	crm_foreach_xpath_result (xmlNode xml, const char xpath, void(helper)(xmlNode , void ), void user_data)
	Run a supplied function for each result of an xpath search. More...

xmlNode *	expand_idref (xmlNode input, xmlNode top)

void	freeXpathObject (xmlXPathObjectPtr xpathObj)

xmlNode *	getXpathResult (xmlXPathObjectPtr xpathObj, int index)

void	dedupXpathResults (xmlXPathObjectPtr xpathObj)

bool	xml_tracking_changes (xmlNode *xml)

bool	xml_document_dirty (xmlNode *xml)

void	xml_track_changes (xmlNode xml, const char user, xmlNode *acl_source, bool enforce_acls)

void	xml_calculate_changes (xmlNode old_xml, xmlNode new_xml)

void	xml_calculate_significant_changes (xmlNode old_xml, xmlNode new_xml)

void	xml_accept_changes (xmlNode *xml)

void	xml_log_changes (uint8_t level, const char function, xmlNode xml)

void	xml_log_patchset (uint8_t level, const char function, xmlNode xml)

bool	xml_patch_versions (xmlNode *patchset, int add[3], int del[3])

xmlNode *	xml_create_patchset (int format, xmlNode source, xmlNode target, bool *config, bool manage_version)

int	xml_apply_patchset (xmlNode xml, xmlNode patchset, bool check_version)

void	patchset_process_digest (xmlNode patch, xmlNode source, xmlNode *target, bool with_digest)

void	save_xml_to_file (xmlNode xml, const char desc, const char *filename)

char *	xml_get_path (xmlNode *xml)

char *	crm_xml_escape (const char *text)

void	crm_xml_sanitize_id (char *id)
	Sanitize a string so it is usable as an XML ID. More...

void	crm_xml_set_id (xmlNode xml, const char format,...) G_GNUC_PRINTF(2

void void	crm_destroy_xml (gpointer data)
	xmlNode destructor which can be used in glib collections More...

Detailed Description

Wrappers for and extensions to libxml2.

Definition in file xml.h.

Macro Definition Documentation

#define CRM_BZ2_BLOCKS 4

Definition at line 45 of file xml.h.

#define CRM_BZ2_THRESHOLD 128 * 1024

Definition at line 47 of file xml.h.

#define CRM_BZ2_WORK 20

Definition at line 46 of file xml.h.

#define XML_PARANOIA_CHECKS 0

Definition at line 49 of file xml.h.

Typedef Documentation

typedef const xmlChar* pcmkXmlStr

Definition at line 51 of file xml.h.

Function Documentation

gboolean add_message_xml	(	xmlNode *	msg,
		const char *	field,
		xmlNode *	xml
	)

Definition at line 162 of file messages.c.

xmlNode* add_node_copy	(	xmlNode *	new_parent,
		xmlNode *	xml_node
	)

Definition at line 674 of file xml.c.

int add_node_nocopy	(	xmlNode *	parent,
		const char *	name,
		xmlNode *	child
	)

Definition at line 688 of file xml.c.

char* calculate_on_disk_digest ( xmlNode * input )

Calculate and return digest of XML tree, suitable for storing on disk.

Parameters

[in] input Root of XML to digest

Returns: Newly allocated string containing digest

Definition at line 151 of file digest.c.

char* calculate_operation_digest	(	xmlNode *	input,
		const char *	version
	)

Calculate and return digest of XML operation.

Parameters

[in]	input	Root of XML to digest
[in]	version	Not used

Returns: Newly allocated string containing digest

Definition at line 170 of file digest.c.

char* calculate_xml_versioned_digest	(	xmlNode *	input,
		gboolean	sort,
		gboolean	do_filter,
		const char *	version
	)

Calculate and return digest of XML tree.

Parameters

[in]	input	Root of XML to digest
[in]	sort	Whether to sort XML before calculating digest
[in]	do_filter	Whether to filter certain XML attributes
[in]	version	CRM feature set version (used to select v1/v2 digest)

Returns: Newly allocated string containing digest

Definition at line 187 of file digest.c.

gboolean can_prune_leaf ( xmlNode * xml_node )

Definition at line 2388 of file xml.c.

gboolean cli_config_update	(	xmlNode **	xml,
		int *	best_version,
		gboolean	to_logs
	)

Definition at line 1196 of file schemas.c.

void copy_in_properties	(	xmlNode *	target,
		xmlNode *	src
	)

Definition at line 521 of file xml.c.

xmlNode* copy_xml ( xmlNode * src_node )

Definition at line 829 of file xml.c.

xmlNode* create_xml_node	(	xmlNode *	parent,
		const char *	name
	)

Definition at line 696 of file xml.c.

void void crm_destroy_xml ( gpointer data )

xmlNode destructor which can be used in glib collections

Definition at line 2896 of file xml.c.

void crm_foreach_xpath_result	(	xmlNode *	xml,
		const char *	xpath,
		void()(xmlNode , void *)	helper,
		void *	user_data
	)

Run a supplied function for each result of an xpath search.

Parameters

[in]	xml	XML to search
[in]	xpath	XPath search string
[in]	helper	Function to call for each result
[in,out]	user_data	Data to pass to supplied function

Note: The helper function will be passed the XML node of the result, and the supplied user_data. This function does not otherwise use user_data.

Definition at line 173 of file xpath.c.

xmlNode* crm_next_same_xml ( const xmlNode * sibling )

Get next instance of same XML tag.

Parameters

[in] sibling XML tag to start from

Returns: Next sibling XML tag with same name

Definition at line 2816 of file xml.c.

void crm_xml_cleanup ( void )

Definition at line 2853 of file xml.c.

char* crm_xml_escape ( const char * text )

Definition at line 1335 of file xml.c.

void crm_xml_init ( void )

Definition at line 2831 of file xml.c.

void crm_xml_sanitize_id ( char * id )

Sanitize a string so it is usable as an XML ID.

Parameters

[in,out] id String to sanitize

Definition at line 1127 of file xml.c.

void crm_xml_set_id	(	xmlNode *	xml,
		const char *	format,
			...
	)

void dedupXpathResults ( xmlXPathObjectPtr xpathObj )

Definition at line 101 of file xpath.c.

xmlNode* diff_xml_object	(	xmlNode *	left,
		xmlNode *	right,
		gboolean	suppress
	)

Definition at line 1420 of file patchset.c.

char* dump_xml_formatted ( xmlNode * msg )

Definition at line 2006 of file xml.c.

char* dump_xml_formatted_with_text ( xmlNode * msg )

Definition at line 1994 of file xml.c.

char* dump_xml_unformatted ( xmlNode * msg )

Definition at line 2017 of file xml.c.

xmlNode* expand_idref	(	xmlNode *	input,
		xmlNode *	top
	)

Definition at line 2863 of file xml.c.

void expand_plus_plus	(	xmlNode *	target,
		const char *	name,
		const char *	value
	)

Definition at line 560 of file xml.c.

xmlNode* filename2xml ( const char * filename )

Definition at line 1043 of file xml.c.

int find_xml_children	(	xmlNode **	children,
		xmlNode *	root,
		const char *	tag,
		const char *	field,
		const char *	value,
		gboolean	search_matches
	)

Definition at line 2643 of file xml.c.

xmlNode* find_xml_node	(	xmlNode *	cib,
		const char *	node_path,
		gboolean	must_find
	)

Definition at line 446 of file xml.c.

xmlNode* first_named_child	(	const xmlNode *	parent,
		const char *	name
	)

Definition at line 2790 of file xml.c.

void fix_plus_plus_recursive ( xmlNode * target )

Definition at line 542 of file xml.c.

void free_xml ( xmlNode * child )

Definition at line 823 of file xml.c.

void freeXpathObject ( xmlXPathObjectPtr xpathObj )

Definition at line 39 of file xpath.c.

xmlNode* get_message_xml	(	xmlNode *	msg,
		const char *	field
	)

Definition at line 154 of file messages.c.

const char* get_schema_name ( int version )

Definition at line 1021 of file schemas.c.

int get_schema_version ( const char * name )

Definition at line 1030 of file schemas.c.

xmlNode* get_xpath_object	(	const char *	xpath,
		xmlNode *	xml_obj,
		int	error_level
	)

Definition at line 214 of file xpath.c.

xmlNode* get_xpath_object_relative	(	const char *	xpath,
		xmlNode *	xml_obj,
		int	error_level
	)

Definition at line 192 of file xpath.c.

xmlDoc* getDocPtr ( xmlNode * node )

Definition at line 658 of file xml.c.

xmlNode* getXpathResult	(	xmlXPathObjectPtr	xpathObj,
		int	index
	)

Definition at line 58 of file xpath.c.

void patchset_process_digest	(	xmlNode *	patch,
		xmlNode *	source,
		xmlNode *	target,
		bool	with_digest
	)

Definition at line 427 of file patchset.c.

xmlNode* pcmk_create_html_node	(	xmlNode *	parent,
		const char *	element_name,
		const char *	id,
		const char *	class_name,
		const char *	text
	)

Definition at line 733 of file xml.c.

xmlNode* pcmk_create_xml_text_node	(	xmlNode *	parent,
		const char *	name,
		const char *	content
	)

Definition at line 721 of file xml.c.

void pcmk_free_xml_subtree ( xmlNode * xml )

Free an XML element and all of its children, removing it from its parent

Parameters

[in] xml XML element to free

Definition at line 755 of file xml.c.

void purge_diff_markers ( xmlNode * a_node )

Definition at line 1406 of file patchset.c.

gboolean replace_xml_child	(	xmlNode *	parent,
		xmlNode *	child,
		xmlNode *	update,
		gboolean	delete_only
	)

Definition at line 2676 of file xml.c.

void save_xml_to_file	(	xmlNode *	xml,
		const char *	desc,
		const char *	filename
	)

Definition at line 2055 of file xml.c.

xmlNode* sorted_xml	(	xmlNode *	input,
		xmlNode *	parent,
		gboolean	recursive
	)

Definition at line 2758 of file xml.c.

xmlNode* stdin2xml ( void )

Definition at line 929 of file xml.c.

xmlNode* string2xml ( const char * input )

Definition at line 868 of file xml.c.

xmlNode* subtract_xml_object	(	xmlNode *	parent,
		xmlNode *	left,
		xmlNode *	right,
		gboolean	full,
		gboolean *	changed,
		const char *	marker
	)

Definition at line 1469 of file patchset.c.

int update_validation	(	xmlNode **	xml_blob,
		int *	best,
		int	max,
		gboolean	transform,
		gboolean	to_logs
	)

Update CIB XML to most recent schema version.

"Update" means either actively employ XSLT-based transformation(s) (if intermediate product to transform valid per its declared schema version, transformation available, proceeded successfully with a result valid per expectated newer schema version), or just try to bump the marked validating schema until all gradually rising schema versions attested or the first such attempt subsequently fails to validate. Which of the two styles will be used depends on transform parameter (positive/negative, respectively).

Parameters

[in,out]	xml_blob	XML tree representing CIB, may be swapped with an "updated" one
[out]	best	The highest configuration version (per its index in the global schemas table) it was possible to reach during the update steps while ensuring the validity of the result; if no validation success was observed against possibly multiple schemas, the value is less or equal the result of `get_schema_version` applied on the input `xml_blob` value (unless that function maps it to -1, then 0 would be used instead)
[in]	max	When `transform` is positive, this allows to set upper boundary schema (per its index in the global schemas table) beyond which it's forbidden to update by the means of XSLT transformation
[in]	transform	Whether to employ XSLT-based transformation so as to allow overcoming possible incompatibilities between major schema versions (see above)
[in]	to_logs	If true, output notable progress info to internal log streams; if false, to stderr

Returns: pcmk_ok if no non-recoverable error encountered (up to caller to evaluate if the update satisfies the requirements per returned best value), negative value carrying the reason otherwise

Definition at line 1047 of file schemas.c.

gboolean update_xml_child	(	xmlNode *	child,
		xmlNode *	to_update
	)

Definition at line 2609 of file xml.c.

gboolean validate_xml	(	xmlNode *	xml_blob,
		const char *	validation,
		gboolean	to_logs
	)

Definition at line 700 of file schemas.c.

gboolean validate_xml_verbose ( xmlNode * xml_blob )

Definition at line 672 of file schemas.c.

int write_xml_fd	(	xmlNode *	xml_node,
		const char *	filename,
		int	fd,
		gboolean	compress
	)

Write XML to a file descriptor.

Parameters

[in]	xml_node	XML to write
[in]	filename	Name of file being written (for logging only)
[in]	fd	Open file descriptor corresponding to filename
[in]	compress	Whether to compress XML before writing

Returns: Number of bytes written on success, -errno otherwise

Definition at line 1270 of file xml.c.

int write_xml_file	(	xmlNode *	xml_node,
		const char *	filename,
		gboolean	compress
	)

Write XML to a file.

Parameters

[in]	xml_node	XML to write
[in]	filename	Name of file to write
[in]	compress	Whether to compress XML before writing

Returns: Number of bytes written on success, -errno otherwise

Definition at line 1298 of file xml.c.

void xml_accept_changes ( xmlNode * xml )

Definition at line 421 of file xml.c.

int xml_apply_patchset	(	xmlNode *	xml,
		xmlNode *	patchset,
		bool	check_version
	)

Definition at line 1326 of file patchset.c.

void xml_calculate_changes	(	xmlNode *	old_xml,
		xmlNode *	new_xml
	)

Definition at line 2374 of file xml.c.

void xml_calculate_significant_changes	(	xmlNode *	old_xml,
		xmlNode *	new_xml
	)

Definition at line 2367 of file xml.c.

xmlNode* xml_create_patchset	(	int	format,
		xmlNode *	source,
		xmlNode *	target,
		bool *	config,
		bool	manage_version
	)

Definition at line 370 of file patchset.c.

bool xml_document_dirty ( xmlNode * xml )

Definition at line 298 of file xml.c.

char* xml_get_path ( xmlNode * xml )

Definition at line 291 of file xpath.c.

gboolean xml_has_children ( const xmlNode * root )

Definition at line 2027 of file xml.c.

const char* xml_latest_schema ( void )

Definition at line 115 of file schemas.c.

void xml_log_changes	(	uint8_t	level,
		const char *	function,
		xmlNode *	xml
	)

Definition at line 386 of file xml.c.

void xml_log_patchset	(	uint8_t	level,
		const char *	function,
		xmlNode *	xml
	)

Definition at line 458 of file patchset.c.

bool xml_patch_versions	(	xmlNode *	patchset,
		int	add[3],
		int	del[3]
	)

Definition at line 802 of file patchset.c.

void xml_remove_prop	(	xmlNode *	obj,
		const char *	name
	)

Definition at line 2036 of file xml.c.

void xml_track_changes	(	xmlNode *	xml,
		const char *	user,
		xmlNode *	acl_source,
		bool	enforce_acls
	)

Definition at line 276 of file xml.c.

bool xml_tracking_changes ( xmlNode * xml )

Definition at line 291 of file xml.c.

xmlXPathObjectPtr xpath_search	(	xmlNode *	xml_top,
		const char *	path
	)

Definition at line 139 of file xpath.c.

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Function Documentation