pacemaker  2.0.2-debe490
Scalable High-Availability cluster resource manager
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Macros | Typedefs | Functions
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 <libxml/parser.h>
#include <libxml/tree.h>
#include <crm/crm.h>
#include <crm/msg_xml.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 CHUNK_SIZE   1024
 
#define buffer_print(buffer, max, offset, fmt, args...)
 
#define XML_PRIVATE_MAGIC   (long) 0x81726354
 
#define XPATH_MAX   512
 

Typedefs

typedef struct xml_deleted_obj_s xml_deleted_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)
 
int pcmk__element_xpath (const char *prefix, xmlNode *xml, char *buffer, int offset, size_t buffer_size)
 
char * xml_get_path (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...
 

Macro Definition Documentation

#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);
#define CHUNK_SIZE
Definition: xml.c:61
#define crm_perror(level, fmt, args...)
Log a system error message.
Definition: logging.h:218
#define CRM_ASSERT(expr)
Definition: results.h:42

Definition at line 77 of file xml.c.

#define CHUNK_SIZE   1024

Definition at line 61 of file xml.c.

#define XML_BUFFER_SIZE   4096

Definition at line 33 of file xml.c.

#define XML_PARSER_DEBUG   0

Definition at line 34 of file xml.c.

#define XML_PRIVATE_MAGIC   (long) 0x81726354

Definition at line 204 of file xml.c.

#define XPATH_MAX   512

Definition at line 4224 of file xml.c.

Typedef Documentation

typedef struct xml_deleted_obj_s xml_deleted_obj_t

Function Documentation

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

Definition at line 2512 of file xml.c.

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

Definition at line 1868 of file xml.c.

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

Definition at line 1882 of file xml.c.

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

Definition at line 3267 of file xml.c.

gboolean can_prune_leaf ( xmlNode *  xml_node)

Definition at line 3575 of file xml.c.

void copy_in_properties ( xmlNode *  target,
xmlNode *  src 
)

Definition at line 1750 of file xml.c.

xmlNode* copy_xml ( xmlNode *  src)

Definition at line 2020 of file xml.c.

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

Definition at line 1890 of file xml.c.

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

Definition at line 3170 of file xml.c.

void crm_destroy_xml ( gpointer  data)

xmlNode destructor which can be used in glib collections

Definition at line 4260 of file xml.c.

xmlNode* crm_next_same_xml ( const xmlNode *  sibling)

Get next instance of same XML tag.

Parameters
[in]siblingXML tag to start from
Returns
Next sibling XML tag with same name

Definition at line 4180 of file xml.c.

const char* crm_xml_add_last_written ( xmlNode *  xml_node)

Definition at line 2310 of file xml.c.

void crm_xml_cleanup ( void  )

Definition at line 4217 of file xml.c.

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

Definition at line 3065 of file xml.c.

char* crm_xml_escape ( const char *  text)

Definition at line 2538 of file xml.c.

void crm_xml_init ( void  )

Definition at line 4195 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]idString to sanitize

Definition at line 2325 of file xml.c.

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

Set the ID of an XML element using a format.

Parameters
[in,out]xmlXML element
[in]fmtprintf-style format
[in]...any arguments required by format

Definition at line 2347 of file xml.c.

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

Definition at line 3547 of file xml.c.

char* dump_xml_formatted ( xmlNode *  an_xml_node)

Definition at line 3186 of file xml.c.

char* dump_xml_formatted_with_text ( xmlNode *  an_xml_node)

Definition at line 3176 of file xml.c.

char* dump_xml_unformatted ( xmlNode *  an_xml_node)

Definition at line 3196 of file xml.c.

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

Definition at line 4227 of file xml.c.

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

Definition at line 1791 of file xml.c.

xmlNode* filename2xml ( const char *  filename)

Definition at line 2237 of file xml.c.

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

Definition at line 1743 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 4008 of file xml.c.

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

Definition at line 1678 of file xml.c.

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

Definition at line 4155 of file xml.c.

void fix_plus_plus_recursive ( xmlNode *  target)

Definition at line 1773 of file xml.c.

void free_xml ( xmlNode *  child)

Definition at line 2014 of file xml.c.

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 
)
xmlNode* get_message_xml ( xmlNode *  msg,
const char *  field 
)

Definition at line 2504 of file xml.c.

int get_tag_name ( const char *  input,
size_t  offset,
size_t  max 
)
xmlDoc* getDocPtr ( xmlNode *  node)

Definition at line 1852 of file xml.c.

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

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

Definition at line 781 of file xml.c.

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

Definition at line 1915 of file xml.c.

void pcmk__mark_xml_attr_dirty ( xmlAttr *  a)

Definition at line 183 of file xml.c.

void pcmk__set_xml_flag ( xmlNode *  xml,
enum xml_private_flags  flag 
)

Definition at line 130 of file xml.c.

bool pcmk__tracking_xml_changes ( xmlNode *  xml,
bool  lazy 
)

Definition at line 64 of file xml.c.

void purge_diff_markers ( xmlNode *  a_node)

Definition at line 3236 of file xml.c.

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

Definition at line 4040 of file xml.c.

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

Definition at line 3249 of file xml.c.

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

Definition at line 4123 of file xml.c.

xmlNode* stdin2xml ( void  )

Definition at line 2123 of file xml.c.

xmlNode* string2xml ( const char *  input)

Definition at line 2058 of file xml.c.

void strip_text_nodes ( xmlNode *  xml)

Definition at line 2208 of file xml.c.

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

Definition at line 3670 of file xml.c.

gboolean update_xml_child ( xmlNode *  child,
xmlNode *  to_update 
)

Definition at line 3974 of file xml.c.

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

Write XML to a file descriptor.

Parameters
[in]xml_nodeXML to write
[in]filenameName of file being written (for logging only)
[in]fdOpen file descriptor corresponding to filename
[in]compressWhether to compress XML before writing
Returns
Number of bytes written on success, -errno otherwise

Definition at line 2469 of file xml.c.

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

Write XML to a file.

Parameters
[in]xml_nodeXML to write
[in]filenameName of file to write
[in]compressWhether to compress XML before writing
Returns
Number of bytes written on success, -errno otherwise

Definition at line 2491 of file xml.c.

void xml_accept_changes ( xmlNode *  xml)

Definition at line 1000 of file xml.c.

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

Definition at line 1601 of file xml.c.

void xml_calculate_changes ( xmlNode *  old_xml,
xmlNode *  new_xml 
)

Definition at line 3532 of file xml.c.

void xml_calculate_significant_changes ( xmlNode *  old_xml,
xmlNode *  new_xml 
)

Definition at line 3525 of file xml.c.

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

Definition at line 724 of file xml.c.

bool xml_document_dirty ( xmlNode *  xml)

Definition at line 325 of file xml.c.

char* xml_get_path ( xmlNode *  xml)

Definition at line 1937 of file xml.c.

gboolean xml_has_children ( const xmlNode *  xml_root)

Definition at line 3206 of file xml.c.

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

Definition at line 969 of file xml.c.

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

Definition at line 814 of file xml.c.

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

Definition at line 1192 of file xml.c.

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

Definition at line 3215 of file xml.c.

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

Definition at line 299 of file xml.c.

bool xml_tracking_changes ( xmlNode *  xml)

Definition at line 314 of file xml.c.