xml.c File Reference

#include <crm_internal.h>
#include <stdio.h>
#include <sys/types.h>
#include <unistd.h>
#include <time.h>
#include <string.h>
#include <stdlib.h>
#include <stdarg.h>
#include <bzlib.h>
#include <libxml/parser.h>
#include <libxml/tree.h>
#include <libxml/xmlIO.h>
#include <crm/crm.h>
#include <crm/msg_xml.h>
#include <crm/common/iso8601_internal.h>
#include <crm/common/xml.h>
#include <crm/common/xml_internal.h>
#include "crmcommon_private.h"

Include dependency graph for xml.c:

Go to the source code of this file.

Macros
#define	XML_BUFFER_SIZE   4096
#define	XML_PARSER_DEBUG   0
#define	PCMK__XML_PARSE_OPTS   (XML_PARSE_NOBLANKS | XML_PARSE_RECOVER)
#define	CHUNK_SIZE   1024
#define	buffer_print(buffer, max, offset, fmt, args...)
#define	XML_PRIVATE_MAGIC   (long) 0x81726354
#define	PCMK__XMLDUMP_STATS   0
#define	XPATH_MAX   512

Typedefs
typedef struct xml_deleted_obj_s	xml_deleted_obj_t
typedef struct xml_change_obj_s	xml_change_obj_t

Functions
bool	pcmk__tracking_xml_changes (xmlNode *xml, bool lazy)
void	pcmk__set_xml_flag (xmlNode *xml, enum xml_private_flags flag)
void	pcmk__mark_xml_attr_dirty (xmlAttr *a)
int	get_tag_name (const char *input, size_t offset, size_t max)
int	get_attr_name (const char *input, size_t offset, size_t max)
int	get_attr_value (const char *input, size_t offset, size_t max)
gboolean	can_prune_leaf (xmlNode *xml_node)
void	xml_track_changes (xmlNode *xml, const char *user, xmlNode *acl_source, bool enforce_acls)
bool	xml_tracking_changes (xmlNode *xml)
bool	xml_document_dirty (xmlNode *xml)
xmlNode *	xml_create_patchset (int format, xmlNode *source, xmlNode *target, bool *config_changed, bool manage_version)
void	patchset_process_digest (xmlNode *patch, xmlNode *source, xmlNode *target, bool with_digest)
void	xml_log_patchset (uint8_t log_level, const char *function, xmlNode *patchset)
void	xml_log_changes (uint8_t log_level, const char *function, xmlNode *xml)
void	xml_accept_changes (xmlNode *xml)
bool	xml_patch_versions (xmlNode *patchset, int add[3], int del[3])
int	xml_apply_patchset (xmlNode *xml, xmlNode *patchset, bool check_version)
xmlNode *	find_xml_node (xmlNode *root, const char *search_path, gboolean must_find)
xmlNode *	find_entity (xmlNode *parent, const char *node_name, const char *id)
void	copy_in_properties (xmlNode *target, xmlNode *src)
void	fix_plus_plus_recursive (xmlNode *target)
void	expand_plus_plus (xmlNode *target, const char *name, const char *value)
xmlDoc *	getDocPtr (xmlNode *node)
xmlNode *	add_node_copy (xmlNode *parent, xmlNode *src_node)
int	add_node_nocopy (xmlNode *parent, const char *name, xmlNode *child)
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)
int	pcmk__element_xpath (const char *prefix, xmlNode *xml, char *buffer, int offset, size_t buffer_size)
char *	xml_get_path (xmlNode *xml)
void	pcmk_free_xml_subtree (xmlNode *xml)
void	free_xml (xmlNode *child)
xmlNode *	copy_xml (xmlNode *src)
xmlNode *	string2xml (const char *input)
xmlNode *	stdin2xml (void)
void	strip_text_nodes (xmlNode *xml)
xmlNode *	filename2xml (const char *filename)
const char *	crm_xml_add_last_written (xmlNode *xml_node)
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,...)
	Set the ID of an XML element using a format. More...
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...
xmlNode *	get_message_xml (xmlNode *msg, const char *field)
gboolean	add_message_xml (xmlNode *msg, const char *field, xmlNode *xml)
char *	crm_xml_escape (const char *text)
void	log_data_element (int log_level, const char *file, const char *function, int line, const char *prefix, xmlNode *data, int depth, int options)
void	crm_xml_dump (xmlNode *data, int options, char **buffer, int *offset, int *max, int depth)
void	crm_buffer_add_char (char **buffer, int *offset, int *max, char c)
char *	dump_xml_formatted_with_text (xmlNode *an_xml_node)
char *	dump_xml_formatted (xmlNode *an_xml_node)
char *	dump_xml_unformatted (xmlNode *an_xml_node)
gboolean	xml_has_children (const xmlNode *xml_root)
void	xml_remove_prop (xmlNode *obj, const char *name)
void	purge_diff_markers (xmlNode *a_node)
void	save_xml_to_file (xmlNode *xml, const char *desc, const char *filename)
gboolean	apply_xml_diff (xmlNode *old_xml, xmlNode *diff, xmlNode **new_xml)
void	xml_calculate_significant_changes (xmlNode *old_xml, xmlNode *new_xml)
void	xml_calculate_changes (xmlNode *old_xml, xmlNode *new_xml)
xmlNode *	diff_xml_object (xmlNode *old, xmlNode *new, gboolean suppress)
xmlNode *	subtract_xml_object (xmlNode *parent, xmlNode *left, xmlNode *right, gboolean full, gboolean *changed, const char *marker)
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)
gboolean	replace_xml_child (xmlNode *parent, xmlNode *child, xmlNode *update, gboolean delete_only)
xmlNode *	sorted_xml (xmlNode *input, xmlNode *parent, gboolean recursive)
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...
void	crm_xml_init (void)
void	crm_xml_cleanup (void)
xmlNode *	expand_idref (xmlNode *input, xmlNode *top)
void	crm_destroy_xml (gpointer data)
	xmlNode destructor which can be used in glib collections More...
char *	pcmk__xml_artefact_root (enum pcmk__xml_artefact_ns ns)
char *	pcmk__xml_artefact_path (enum pcmk__xml_artefact_ns ns, const char *filespec)

Macro Definition Documentation

buffer_print

#define buffer_print	(		buffer,
			max,
			offset,
			fmt,
			args...
	)

Value:

        do {            \
        int rc = (max);                                                 \
        if(buffer) {                                                    \
            rc = snprintf((buffer) + (offset), (max) - (offset), fmt, ##args); \
        }                                                               \
        if(buffer && rc < 0) {                                          \
            crm_perror(LOG_ERR, "snprintf failed at offset %d", offset); \
            (buffer)[(offset)] = 0;                                     \
            break;                                                      \
        } else if(rc >= ((max) - (offset))) {                           \
            char *tmp = NULL;                                           \
            (max) = QB_MAX(CHUNK_SIZE, (max) * 2);                      \
            tmp = realloc_safe((buffer), (max));                        \
            CRM_ASSERT(tmp);                                            \
            (buffer) = tmp;                                             \
        } else {                                                        \
            offset += rc;                                               \
            break;                                                      \
        }                                                               \
    } while(1);

Definition at line 87 of file xml.c.

CHUNK_SIZE

#define CHUNK_SIZE   1024

Definition at line 71 of file xml.c.

PCMK__XML_PARSE_OPTS

#define PCMK__XML_PARSE_OPTS   (XML_PARSE_NOBLANKS | XML_PARSE_RECOVER)

Definition at line 44 of file xml.c.

PCMK__XMLDUMP_STATS

#define PCMK__XMLDUMP_STATS   0

Definition at line 3170 of file xml.c.

XML_BUFFER_SIZE

#define XML_BUFFER_SIZE   4096

Definition at line 32 of file xml.c.

XML_PARSER_DEBUG

#define XML_PARSER_DEBUG   0

Definition at line 33 of file xml.c.

XML_PRIVATE_MAGIC

#define XML_PRIVATE_MAGIC   (long) 0x81726354

Definition at line 214 of file xml.c.

XPATH_MAX

#define XPATH_MAX   512

Definition at line 4454 of file xml.c.

Typedef Documentation

xml_change_obj_t

typedef struct xml_change_obj_s xml_change_obj_t

xml_deleted_obj_t

typedef struct xml_deleted_obj_s xml_deleted_obj_t

Function Documentation

add_message_xml()

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

Definition at line 2618 of file xml.c.

add_node_copy()

xmlNode* add_node_copy	(	xmlNode *	parent,
		xmlNode *	src_node
	)

Definition at line 1948 of file xml.c.

add_node_nocopy()

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

Definition at line 1962 of file xml.c.

apply_xml_diff()

gboolean apply_xml_diff	(	xmlNode *	old_xml,
		xmlNode *	diff,
		xmlNode **	new_xml
	)

Definition at line 3377 of file xml.c.

can_prune_leaf()

gboolean can_prune_leaf

(

xmlNode *

xml_node

)

Definition at line 3804 of file xml.c.

copy_in_properties()

void copy_in_properties	(	xmlNode *	target,
		xmlNode *	src
	)

Definition at line 1830 of file xml.c.

copy_xml()

xmlNode* copy_xml

(

xmlNode *

src

)

Definition at line 2136 of file xml.c.

create_xml_node()

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

Definition at line 1970 of file xml.c.

crm_buffer_add_char()

void crm_buffer_add_char	(	char **	buffer,
		int *	offset,
		int *	max,
		char	c
	)

Definition at line 3278 of file xml.c.

crm_destroy_xml()

void crm_destroy_xml

(

gpointer

data

)

xmlNode destructor which can be used in glib collections

Definition at line 4490 of file xml.c.

crm_next_same_xml()

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 4410 of file xml.c.

crm_xml_add_last_written()

const char* crm_xml_add_last_written

(

xmlNode *

xml_node

)

Definition at line 2418 of file xml.c.

crm_xml_cleanup()

void crm_xml_cleanup

(

void

)

Definition at line 4447 of file xml.c.

crm_xml_dump()

void crm_xml_dump	(	xmlNode *	data,
		int	options,
		char **	buffer,
		int *	offset,
		int *	max,
		int	depth
	)

Definition at line 3173 of file xml.c.

crm_xml_escape()

char* crm_xml_escape

(

const char *

text

)

Definition at line 2644 of file xml.c.

crm_xml_init()

void crm_xml_init

(

void

)

Definition at line 4425 of file xml.c.

crm_xml_sanitize_id()

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 2431 of file xml.c.

crm_xml_set_id()

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

Set the ID of an XML element using a format.

Parameters

[in,out]	xml	XML element
[in]	fmt	printf-style format
[in]	...	any arguments required by format

Definition at line 2453 of file xml.c.

diff_xml_object()

xmlNode* diff_xml_object	(	xmlNode *	old,
		xmlNode *	new,
		gboolean	suppress
	)

Definition at line 3776 of file xml.c.

dump_xml_formatted()

char* dump_xml_formatted

(

xmlNode *

an_xml_node

)

Definition at line 3296 of file xml.c.

dump_xml_formatted_with_text()

char* dump_xml_formatted_with_text

(

xmlNode *

an_xml_node

)

Definition at line 3284 of file xml.c.

dump_xml_unformatted()

char* dump_xml_unformatted

(

xmlNode *

an_xml_node

)

Definition at line 3306 of file xml.c.

expand_idref()

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

Definition at line 4457 of file xml.c.

expand_plus_plus()

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

Definition at line 1871 of file xml.c.

filename2xml()

xmlNode* filename2xml

(

const char *

filename

)

Definition at line 2348 of file xml.c.

find_entity()

xmlNode* find_entity	(	xmlNode *	parent,
		const char *	node_name,
		const char *	id
	)

Definition at line 1823 of file xml.c.

find_xml_children()

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

Definition at line 4237 of file xml.c.

find_xml_node()

xmlNode* find_xml_node	(	xmlNode *	root,
		const char *	search_path,
		gboolean	must_find
	)

Definition at line 1758 of file xml.c.

first_named_child()

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

Definition at line 4384 of file xml.c.

fix_plus_plus_recursive()

void fix_plus_plus_recursive

(

xmlNode *

target

)

Definition at line 1853 of file xml.c.

free_xml()

void free_xml

(

xmlNode *

child

)

Definition at line 2130 of file xml.c.

get_attr_name()

int get_attr_name	(	const char *	input,
		size_t	offset,
		size_t	max
	)

get_attr_value()

int get_attr_value	(	const char *	input,
		size_t	offset,
		size_t	max
	)

get_message_xml()

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

Definition at line 2610 of file xml.c.

get_tag_name()

int get_tag_name	(	const char *	input,
		size_t	offset,
		size_t	max
	)

getDocPtr()

xmlDoc* getDocPtr

(

xmlNode *

node

)

Definition at line 1932 of file xml.c.

log_data_element()

void log_data_element	(	int	log_level,
		const char *	file,
		const char *	function,
		int	line,
		const char *	prefix,
		xmlNode *	data,
		int	depth,
		int	options
	)

Definition at line 2943 of file xml.c.

patchset_process_digest()

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

Definition at line 791 of file xml.c.

pcmk__element_xpath()

int pcmk__element_xpath	(	const char *	prefix,
		xmlNode *	xml,
		char *	buffer,
		int	offset,
		size_t	buffer_size
	)

Definition at line 2024 of file xml.c.

pcmk__mark_xml_attr_dirty()

void pcmk__mark_xml_attr_dirty

(

xmlAttr *

a

)

Definition at line 193 of file xml.c.

pcmk__set_xml_flag()

void pcmk__set_xml_flag	(	xmlNode *	xml,
		enum xml_private_flags	flag
	)

Definition at line 140 of file xml.c.

pcmk__tracking_xml_changes()

bool pcmk__tracking_xml_changes	(	xmlNode *	xml,
		bool	lazy
	)

Definition at line 74 of file xml.c.

pcmk__xml_artefact_path()

char* pcmk__xml_artefact_path	(	enum pcmk__xml_artefact_ns	ns,
		const char *	filespec
	)

Definition at line 4524 of file xml.c.

pcmk__xml_artefact_root()

char* pcmk__xml_artefact_root

(

enum pcmk__xml_artefact_ns

ns

)

Definition at line 4496 of file xml.c.

pcmk_create_html_node()

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

Definition at line 2007 of file xml.c.

pcmk_create_xml_text_node()

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

Definition at line 1995 of file xml.c.

pcmk_free_xml_subtree()

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 2063 of file xml.c.

purge_diff_markers()

void purge_diff_markers

(

xmlNode *

a_node

)

Definition at line 3346 of file xml.c.

replace_xml_child()

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

Definition at line 4269 of file xml.c.

save_xml_to_file()

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

Definition at line 3359 of file xml.c.

sorted_xml()

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

Definition at line 4352 of file xml.c.

stdin2xml()

xmlNode* stdin2xml

(

void

)

Definition at line 2235 of file xml.c.

string2xml()

xmlNode* string2xml

(

const char *

input

)

Definition at line 2174 of file xml.c.

strip_text_nodes()

void strip_text_nodes

(

xmlNode *

xml

)

Definition at line 2320 of file xml.c.

subtract_xml_object()

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

Definition at line 3899 of file xml.c.

update_xml_child()

gboolean update_xml_child	(	xmlNode *	child,
		xmlNode *	to_update
	)

Definition at line 4203 of file xml.c.

write_xml_fd()

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 2575 of file xml.c.

write_xml_file()

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 2597 of file xml.c.

xml_accept_changes()

void xml_accept_changes

(

xmlNode *

xml

)

Definition at line 1010 of file xml.c.

xml_apply_patchset()

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

Definition at line 1681 of file xml.c.

xml_calculate_changes()

void xml_calculate_changes	(	xmlNode *	old_xml,
		xmlNode *	new_xml
	)

Definition at line 3761 of file xml.c.

xml_calculate_significant_changes()

void xml_calculate_significant_changes	(	xmlNode *	old_xml,
		xmlNode *	new_xml
	)

Definition at line 3754 of file xml.c.

xml_create_patchset()

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

Definition at line 734 of file xml.c.

xml_document_dirty()

bool xml_document_dirty

(

xmlNode *

xml

)

Definition at line 335 of file xml.c.

xml_get_path()

char* xml_get_path

(

xmlNode *

xml

)

Definition at line 2046 of file xml.c.

xml_has_children()

gboolean xml_has_children

(

const xmlNode *

xml_root

)

Definition at line 3316 of file xml.c.

xml_log_changes()

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

Definition at line 979 of file xml.c.

xml_log_patchset()

void xml_log_patchset	(	uint8_t	log_level,
		const char *	function,
		xmlNode *	patchset
	)

Definition at line 824 of file xml.c.

xml_patch_versions()

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

Definition at line 1202 of file xml.c.

xml_remove_prop()

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

Definition at line 3325 of file xml.c.

xml_track_changes()

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

Definition at line 309 of file xml.c.

xml_tracking_changes()

bool xml_tracking_changes

(

xmlNode *

xml

)

Definition at line 324 of file xml.c.