pacemaker  1.1.18-7fdfbbe
Scalable High-Availability cluster resource manager
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Macros | Functions
xml.h File Reference
Core API

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 <crm/crm.h>
#include <libxml/tree.h>
#include <libxml/xpath.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
 

Functions

gboolean add_message_xml (xmlNode *msg, const char *field, xmlNode *xml)
 
xmlNode * get_message_xml (xmlNode *msg, const char *field)
 
GHashTable * xml2list (xmlNode *parent)
 
xmlNode * crm_create_nvpair_xml (xmlNode *parent, const char *id, const char *name, const char *value)
 Create an XML name/value pair. More...
 
void hash2nvpair (gpointer key, gpointer value, gpointer user_data)
 
void hash2field (gpointer key, gpointer value, gpointer user_data)
 
void hash2metafield (gpointer key, gpointer value, gpointer user_data)
 
void hash2smartfield (gpointer key, gpointer value, gpointer user_data)
 
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)
 
const char * crm_xml_add (xmlNode *node, const char *name, const char *value)
 
const char * crm_xml_replace (xmlNode *node, const char *name, const char *value)
 
const char * crm_xml_add_int (xmlNode *node, const char *name, int value)
 
void unlink_xml_node (xmlNode *node)
 
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)
 
int write_xml_file (xmlNode *xml_node, const char *filename, gboolean compress)
 
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)
 
void print_xml_diff (FILE *where, xmlNode *diff)
 
gboolean apply_xml_diff (xmlNode *old, xmlNode *diff, xmlNode **new)
 
xmlNode * find_xml_node (xmlNode *cib, const char *node_path, gboolean must_find)
 
xmlNode * find_entity (xmlNode *parent, const char *node_name, const char *id)
 
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)
 
int crm_element_value_int (xmlNode *data, const char *name, int *dest)
 
char * crm_element_value_copy (xmlNode *data, const char *name)
 
int crm_element_value_const_int (const xmlNode *data, const char *name, int *dest)
 
const char * crm_element_value_const (const xmlNode *data, const char *name)
 
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)
 
const char * crm_element_value (xmlNode *data, const char *name)
 
void xml_validate (const xmlNode *root)
 
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 free_xml (xmlNode *child)
 
xmlNode * first_named_child (xmlNode *parent, const char *name)
 
xmlNode * crm_next_same_xml (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_acl_enabled (xmlNode *xml)
 
void xml_acl_disable (xmlNode *xml)
 
bool xml_acl_denied (xmlNode *xml)
 
bool xml_acl_filtered_copy (const char *user, xmlNode *acl_source, xmlNode *xml, xmlNode **result)
 
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, xmlNode *new)
 
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,...) __attribute__((__format__(__printf__
 
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 48 of file xml.h.

#define CRM_BZ2_THRESHOLD   128 * 1024

Definition at line 50 of file xml.h.

#define CRM_BZ2_WORK   20

Definition at line 49 of file xml.h.

#define XML_PARANOIA_CHECKS   0

Definition at line 52 of file xml.h.

Function Documentation

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

Definition at line 3171 of file xml.c.

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

Definition at line 2405 of file xml.c.

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

Definition at line 2419 of file xml.c.

gboolean apply_xml_diff ( xmlNode *  old,
xmlNode *  diff,
xmlNode **  new 
)

Definition at line 3933 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]inputRoot of XML to digest
Returns
Newly allocated string containing digest

Definition at line 156 of file digest.c.

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

Calculate and return digest of XML operation.

Parameters
[in]inputRoot of XML to digest
[in]versionNot used
Returns
Newly allocated string containing digest

Definition at line 175 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]inputRoot of XML to digest
[in]sortWhether to sort XML before calculating digest
[in]do_filterWhether to filter certain XML attributes
[in]versionCRM feature set version (used to select v1/v2 digest)
Returns
Newly allocated string containing digest

Definition at line 192 of file digest.c.

gboolean can_prune_leaf ( xmlNode *  xml_node)

Definition at line 4228 of file xml.c.

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

Definition at line 926 of file schemas.c.

void copy_in_properties ( xmlNode *  target,
xmlNode *  src 
)

Definition at line 2287 of file xml.c.

xmlNode* copy_xml ( xmlNode *  src_node)

Definition at line 2712 of file xml.c.

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

Definition at line 2588 of file xml.c.

xmlNode* crm_create_nvpair_xml ( xmlNode *  parent,
const char *  id,
const char *  name,
const char *  value 
)

Create an XML name/value pair.

Parameters
[in]parentIf not NULL, make new XML node a child of this one
[in]idIf not NULL, use this as ID (otherwise auto-generate)
[in]nameName to use
[in]valueValue to use
Returns
New XML object on success, NULL otherwise

Definition at line 4831 of file xml.c.

void void crm_destroy_xml ( gpointer  data)

xmlNode destructor which can be used in glib collections

Definition at line 5187 of file xml.c.

const char* crm_element_value ( xmlNode *  data,
const char *  name 
)

Definition at line 5165 of file xml.c.

const char* crm_element_value_const ( const xmlNode *  data,
const char *  name 
)

Definition at line 3863 of file xml.c.

int crm_element_value_const_int ( const xmlNode *  data,
const char *  name,
int *  dest 
)

Definition at line 3857 of file xml.c.

char* crm_element_value_copy ( xmlNode *  data,
const char *  name 
)

Definition at line 3869 of file xml.c.

int crm_element_value_int ( xmlNode *  data,
const char *  name,
int *  dest 
)

Definition at line 3844 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]xmlXML to search
[in]xpathXPath search string
[in]helperFunction to call for each result
[in,out]user_dataData 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 179 of file xpath.c.

xmlNode* crm_next_same_xml ( 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 5078 of file xml.c.

const char* crm_xml_add ( xmlNode *  node,
const char *  name,
const char *  value 
)

Definition at line 2490 of file xml.c.

const char* crm_xml_add_int ( xmlNode *  node,
const char *  name,
int  value 
)

Definition at line 2578 of file xml.c.

void crm_xml_cleanup ( void  )

Definition at line 5115 of file xml.c.

char* crm_xml_escape ( const char *  text)

Definition at line 3197 of file xml.c.

void crm_xml_init ( void  )

Definition at line 5093 of file xml.c.

const char* crm_xml_replace ( xmlNode *  node,
const char *  name,
const char *  value 
)

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

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

Definition at line 107 of file xpath.c.

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

Definition at line 4200 of file xml.c.

char* dump_xml_formatted ( xmlNode *  msg)

Definition at line 3815 of file xml.c.

char* dump_xml_formatted_with_text ( xmlNode *  msg)

Definition at line 3805 of file xml.c.

char* dump_xml_unformatted ( xmlNode *  msg)

Definition at line 3825 of file xml.c.

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

Definition at line 5125 of file xml.c.

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

Definition at line 2328 of file xml.c.

xmlNode* filename2xml ( const char *  filename)

Definition at line 2934 of file xml.c.

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

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

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

Definition at line 2235 of file xml.c.

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

Definition at line 5053 of file xml.c.

void fix_plus_plus_recursive ( xmlNode *  target)

Definition at line 2310 of file xml.c.

void free_xml ( xmlNode *  child)

Definition at line 2706 of file xml.c.

void freeXpathObject ( xmlXPathObjectPtr  xpathObj)

Definition at line 45 of file xpath.c.

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

Definition at line 3163 of file xml.c.

const char* get_schema_name ( int  version)

Definition at line 757 of file schemas.c.

int get_schema_version ( const char *  name)

Definition at line 766 of file schemas.c.

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

Definition at line 224 of file xpath.c.

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

Definition at line 198 of file xpath.c.

xmlDoc* getDocPtr ( xmlNode *  node)

Definition at line 2389 of file xml.c.

xmlNode* getXpathResult ( xmlXPathObjectPtr  xpathObj,
int  index 
)

Definition at line 64 of file xpath.c.

void hash2field ( gpointer  key,
gpointer  value,
gpointer  user_data 
)

Definition at line 4892 of file xml.c.

void hash2metafield ( gpointer  key,
gpointer  value,
gpointer  user_data 
)

Definition at line 4908 of file xml.c.

void hash2nvpair ( gpointer  key,
gpointer  value,
gpointer  user_data 
)

Definition at line 4858 of file xml.c.

void hash2smartfield ( gpointer  key,
gpointer  value,
gpointer  user_data 
)

Definition at line 4869 of file xml.c.

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

Definition at line 1354 of file xml.c.

void print_xml_diff ( FILE *  where,
xmlNode *  diff 
)
void purge_diff_markers ( xmlNode *  a_node)

Definition at line 3902 of file xml.c.

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

Definition at line 4738 of file xml.c.

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

Definition at line 3915 of file xml.c.

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

Definition at line 5009 of file xml.c.

xmlNode* stdin2xml ( void  )

Definition at line 2815 of file xml.c.

xmlNode* string2xml ( const char *  input)

Definition at line 2750 of file xml.c.

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

Definition at line 4386 of file xml.c.

void unlink_xml_node ( xmlNode *  node)
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_blobXML tree representing CIB, may be swapped with an "updated" one
[out]bestThe 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]maxWhen transform is positive, this allows to set upper boundary schema (per its index in the global schemas table) beyond which its forbidden to update by the means of XSLT transformation
[in]transformWhether to employ XSLT-based transformation so as allow overcoming possible incompatibilities between major schema versions (see above)
[in]to_logsIf 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 783 of file schemas.c.

gboolean update_xml_child ( xmlNode *  child,
xmlNode *  to_update 
)

Definition at line 4672 of file xml.c.

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

Definition at line 650 of file schemas.c.

gboolean validate_xml_verbose ( xmlNode *  xml_blob)

Definition at line 622 of file schemas.c.

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

Definition at line 3143 of file xml.c.

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

Definition at line 3153 of file xml.c.

GHashTable* xml2list ( xmlNode *  parent)

Definition at line 4931 of file xml.c.

void xml_accept_changes ( xmlNode *  xml)

Definition at line 1573 of file xml.c.

bool xml_acl_denied ( xmlNode *  xml)

Definition at line 822 of file xml.c.

void xml_acl_disable ( xmlNode *  xml)

Definition at line 833 of file xml.c.

bool xml_acl_enabled ( xmlNode *  xml)

Definition at line 846 of file xml.c.

bool xml_acl_filtered_copy ( const char *  user,
xmlNode *  acl_source,
xmlNode *  xml,
xmlNode **  result 
)

Definition at line 701 of file xml.c.

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

Definition at line 2158 of file xml.c.

void xml_calculate_changes ( xmlNode *  old,
xmlNode *  new 
)

Definition at line 4187 of file xml.c.

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

Definition at line 1294 of file xml.c.

bool xml_document_dirty ( xmlNode *  xml)

Definition at line 883 of file xml.c.

char* xml_get_path ( xmlNode *  xml)

Definition at line 2631 of file xml.c.

gboolean xml_has_children ( const xmlNode *  root)

Definition at line 3835 of file xml.c.

const char* xml_latest_schema ( void  )

Definition at line 122 of file schemas.c.

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

Definition at line 1542 of file xml.c.

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

Definition at line 1387 of file xml.c.

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

Definition at line 1765 of file xml.c.

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

Definition at line 3881 of file xml.c.

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

Definition at line 857 of file xml.c.

bool xml_tracking_changes ( xmlNode *  xml)

Definition at line 872 of file xml.c.

void xml_validate ( const xmlNode *  root)
xmlXPathObjectPtr xpath_search ( xmlNode *  xml_top,
const char *  path 
)

Definition at line 145 of file xpath.c.

Generated on Tue Nov 14 2017 16:40:16 for pacemaker by   doxygen 1.8.5