xml_internal.h

Go to the documentation of this file.

/*
 * Copyright 2017-2025 the Pacemaker project contributors
 *
 * The version control history for this file may have further details.
 *
 * This source code is licensed under the GNU Lesser General Public License
 * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
 */
 
#ifndef PCMK__CRM_COMMON_XML_INTERNAL__H
#define PCMK__CRM_COMMON_XML_INTERNAL__H
 
/*
 * Internal-only wrappers for and extensions to libxml2 (libxslt)
 */
 
#include <stdlib.h>
#include <stdint.h>   // uint32_t
#include <stdio.h>
 
#include <crm/crm.h>  /* transitively imports qblog.h */
#include <crm/common/output_internal.h>
#include <crm/common/xml_names.h>             // PCMK_XA_ID, PCMK_XE_CLONE
 
// This file is a wrapper for other {xml_*,xpath}_internal.h headers
#include <crm/common/xml_comment_internal.h>
#include <crm/common/xml_element_internal.h>
#include <crm/common/xml_idref_internal.h>
#include <crm/common/xml_io_internal.h>
#include <crm/common/xml_names_internal.h>
#include <crm/common/xpath_internal.h>
 
#include <libxml/relaxng.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define PCMK__XML_LOG_BASE(priority, dechunk, postemit, prefix, fmt, ap)        \
do {                                                                            \
    if (!(dechunk) && (prefix) == NULL) {  /* quick pass */                     \
        qb_log_from_external_source_va(__func__, __FILE__, (fmt),               \
                                       (priority), __LINE__, 0, (ap));          \
        (void) (postemit);                                                      \
    } else {                                                                    \
        int CXLB_len = 0;                                                       \
        char *CXLB_buf = NULL;                                                  \
        static int CXLB_buffer_len = 0;                                         \
        static char *CXLB_buffer = NULL;                                        \
        static uint8_t CXLB_priority = 0;                                       \
                                                                                \
        CXLB_len = vasprintf(&CXLB_buf, (fmt), (ap));                           \
                                                                                \
        if (CXLB_len <= 0 || CXLB_buf[CXLB_len - 1] == '\n' || !(dechunk)) {    \
            if (CXLB_len < 0) {                                                 \
                CXLB_buf = (char *) "LOG CORRUPTION HAZARD"; /*we don't modify*/\
                CXLB_priority = QB_MIN(CXLB_priority, LOG_ERR);                 \
            } else if (CXLB_len > 0 /* && (dechunk) */                          \
                       && CXLB_buf[CXLB_len - 1] == '\n') {                     \
                CXLB_buf[CXLB_len - 1] = '\0';                                  \
            }                                                                   \
            if (CXLB_buffer) {                                                  \
                qb_log_from_external_source(__func__, __FILE__, "%s%s%s",       \
                                            CXLB_priority, __LINE__, 0,         \
                                            (prefix) != NULL ? (prefix) : "",   \
                                            CXLB_buffer, CXLB_buf);             \
                free(CXLB_buffer);                                              \
            } else {                                                            \
                qb_log_from_external_source(__func__, __FILE__, "%s%s",         \
                                            (priority), __LINE__, 0,            \
                                            (prefix) != NULL ? (prefix) : "",   \
                                            CXLB_buf);                          \
            }                                                                   \
            if (CXLB_len < 0) {                                                 \
                CXLB_buf = NULL;  /* restore temporary override */              \
            }                                                                   \
            CXLB_buffer = NULL;                                                 \
            CXLB_buffer_len = 0;                                                \
            (void) (postemit);                                                  \
                                                                                \
        } else if (CXLB_buffer == NULL) {                                       \
            CXLB_buffer_len = CXLB_len;                                         \
            CXLB_buffer = CXLB_buf;                                             \
            CXLB_buf = NULL;                                                    \
            CXLB_priority = (priority);  /* remember as a running severest */   \
                                                                                \
        } else {                                                                \
            CXLB_buffer = realloc(CXLB_buffer, 1 + CXLB_buffer_len + CXLB_len); \
            memcpy(CXLB_buffer + CXLB_buffer_len, CXLB_buf, CXLB_len);          \
            CXLB_buffer_len += CXLB_len;                                        \
            CXLB_buffer[CXLB_buffer_len] = '\0';                                \
            CXLB_priority = QB_MIN(CXLB_priority, (priority));  /* severest? */ \
        }                                                                       \
        free(CXLB_buf);                                                         \
    }                                                                           \
} while (0)
 
enum pcmk__xml_fmt_options {
    pcmk__xml_fmt_filtered   = (1 << 0),
 
    pcmk__xml_fmt_pretty     = (1 << 1),
 
    pcmk__xml_fmt_open       = (1 << 3),
 
    pcmk__xml_fmt_children   = (1 << 4),
 
    pcmk__xml_fmt_close      = (1 << 5),
 
    // @COMPAT Can we start including text nodes unconditionally?
    pcmk__xml_fmt_text       = (1 << 6),
};
 
int pcmk__xml_show(pcmk__output_t *out, const char *prefix, const xmlNode *data,
                   int depth, uint32_t options);
int pcmk__xml_show_changes(pcmk__output_t *out, const xmlNode *xml);
 
enum pcmk__xml_artefact_ns {
    pcmk__xml_artefact_ns_legacy_rng = 1,
    pcmk__xml_artefact_ns_legacy_xslt,
    pcmk__xml_artefact_ns_base_rng,
    pcmk__xml_artefact_ns_base_xslt,
};
 
void pcmk__strip_xml_text(xmlNode *xml);
 
enum pcmk__xml_escape_type {
    pcmk__xml_escape_text,
 
    pcmk__xml_escape_attr,
 
    /* @COMPAT Drop escaping of at least '\n' and '\t' for
     * pcmk__xml_escape_attr_pretty when openstack-info, openstack-floating-ip,
     * and openstack-virtual-ip resource agents no longer depend on it.
     *
     * At time of writing, openstack-info may set a multiline value for the
     * openstack_ports node attribute. The other two agents query the value and
     * require it to be on one line with no spaces.
     */
    pcmk__xml_escape_attr_pretty,
};
 
bool pcmk__xml_needs_escape(const char *text, enum pcmk__xml_escape_type type);
char *pcmk__xml_escape(const char *text, enum pcmk__xml_escape_type type);
 
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);
 
static inline xmlNode *
pcmk__xml_first_child(const xmlNode *parent)
{
    xmlNode *child = (parent? parent->children : NULL);
 
    while (child && (child->type == XML_TEXT_NODE)) {
        child = child->next;
    }
    return child;
}
 
static inline xmlNode *
pcmk__xml_next(const xmlNode *child)
{
    xmlNode *next = (child? child->next : NULL);
 
    while (next && (next->type == XML_TEXT_NODE)) {
        next = next->next;
    }
    return next;
}
 
void pcmk__xml_free(xmlNode *xml);
void pcmk__xml_free_doc(xmlDoc *doc);
xmlNode *pcmk__xml_copy(xmlNode *parent, xmlNode *src);
 
enum pcmk__xa_flags {
    pcmk__xaf_none          = 0U,
 
    pcmk__xaf_no_overwrite  = (1U << 0),
 
    pcmk__xaf_score_update  = (1U << 1),
};
 
void pcmk__xml_sanitize_id(char *id);
 
/* internal XML-related utilities */
 
enum pcmk__xml_flags {
    pcmk__xf_none            = UINT32_C(0),
 
    pcmk__xf_dirty           = (UINT32_C(1) << 0),
 
    pcmk__xf_deleted         = (UINT32_C(1) << 1),
 
    pcmk__xf_created         = (UINT32_C(1) << 2),
 
    pcmk__xf_modified        = (UINT32_C(1) << 3),
 
    pcmk__xf_tracking        = (UINT32_C(1) << 4),
 
    pcmk__xf_skip            = (UINT32_C(1) << 6),
 
    pcmk__xf_moved           = (UINT32_C(1) << 7),
 
    pcmk__xf_acl_enabled     = (UINT32_C(1) << 8),
 
    /* @TODO Consider splitting the ACL permission flags (pcmk__xf_acl_read,
     * pcmk__xf_acl_write, pcmk__xf_acl_write, and pcmk__xf_acl_create) into a
     * separate enum and reserving this enum for tracking-related flags.
     *
     * The ACL permission flags have various meanings in different contexts (for
     * example, what permission an ACL grants or denies; what permissions the
     * current ACL user has for a given XML node; and possibly others). And
     * for xml_acl_t objects, they're used in exclusive mode (exactly one is
     * set), rather than as flags.
     */
 
    pcmk__xf_acl_read        = (UINT32_C(1) << 9),
 
    pcmk__xf_acl_write       = (UINT32_C(1) << 10),
 
    pcmk__xf_acl_deny        = (UINT32_C(1) << 11),
 
    pcmk__xf_acl_create      = (UINT32_C(1) << 12),
 
    pcmk__xf_acl_denied      = (UINT32_C(1) << 13),
 
    pcmk__xf_ignore_attr_pos = (UINT32_C(1) << 14),
};
 
void pcmk__xml_doc_set_flags(xmlDoc *doc, uint32_t flags);
bool pcmk__xml_doc_all_flags_set(const xmlDoc *xml, uint32_t flags);
 
void pcmk__xml_commit_changes(xmlDoc *doc);
void pcmk__xml_mark_changes(xmlNode *old_xml, xmlNode *new_xml);
 
bool pcmk__xml_tree_foreach(xmlNode *xml, bool (*fn)(xmlNode *, void *),
                            void *user_data);
 
static inline const char *
pcmk__xml_attr_value(const xmlAttr *attr)
{
    return ((attr == NULL) || (attr->children == NULL))? NULL
           : (const char *) attr->children->content;
}
 
bool pcmk__cib_element_in_patchset(const xmlNode *patchset,
                                   const char *element);
 
#ifdef __cplusplus
}
#endif
 
#endif // PCMK__CRM_COMMON_XML_INTERNAL__H