/src/pacemaker/lib/common/strings.c

Source
/*
 * Copyright 2004-2026 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.
 */

#include <crm_internal.h>

#include <regex.h>
#include <stdarg.h>     // va_list, etc.
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <ctype.h>
#include <float.h>  // DBL_MIN
#include <limits.h>
#include <bzlib.h>
#include <sys/types.h>

/*!
 * \internal
 * \brief Scan a long long integer from a string
 *
 * \param[in]  text           String to scan
 * \param[out] result         If not NULL, where to store scanned value
 * \param[in]  default_value  Value to use if text is NULL or invalid
 * \param[out] end_text       If not NULL, where to store pointer to first
 *                            non-integer character
 *
 * \return Standard Pacemaker return code (\c pcmk_rc_ok on success,
 *         \c pcmk_rc_bad_input on failed string conversion due to invalid
 *         input, or \c ERANGE if outside long long range)
 * \note Sets \c errno on error
 */
static int
scan_ll(const char *text, long long *result, long long default_value,
        char **end_text)
{
    long long local_result = default_value;
    char *local_end_text = NULL;
    int rc = pcmk_rc_ok;

    errno = 0;
    if (text != NULL) {
        local_result = strtoll(text, &local_end_text, 10);
        if (errno == ERANGE) {
            rc = errno;
            pcmk__debug("Integer parsed from '%s' was clipped to %lld", text,
                        local_result);

        } else if (local_end_text == text) {
            rc = pcmk_rc_bad_input;
            local_result = default_value;
            pcmk__debug("Could not parse integer from '%s' (using %lld "
                        "instead): No digits found",
                        text, default_value);

        } else if (errno != 0) {
            rc = errno;
            local_result = default_value;
            pcmk__debug("Could not parse integer from '%s' (using %lld "
                        "instead): %s",
                        text, default_value, pcmk_rc_str(rc));
        }

        if ((end_text == NULL) && !pcmk__str_empty(local_end_text)) {
            pcmk__debug("Characters left over after parsing '%s': '%s'",
                        text, local_end_text);
        }
        errno = rc;
    }
    if (end_text != NULL) {
        *end_text = local_end_text;
    }
    if (result != NULL) {
        *result = local_result;
    }
    return rc;
}

/*!
 * \internal
 * \brief Scan a long long integer value from a string
 *
 * \param[in]  text           The string to scan (may be NULL)
 * \param[out] result         Where to store result (or NULL to ignore)
 * \param[in]  default_value  Value to use if text is NULL or invalid
 *
 * \return Standard Pacemaker return code
 */
int
pcmk__scan_ll(const char *text, long long *result, long long default_value)
{
    long long local_result = default_value;
    int rc = scan_ll(text, &local_result, default_value, NULL);

    if (result != NULL) {
        *result = local_result;
    }
    return rc;
}

/*!
 * \internal
 * \brief Scan an integer value from a string, constrained to a minimum
 *
 * \param[in]  text           The string to scan (may be NULL)
 * \param[out] result         Where to store result (or NULL to ignore)
 * \param[in]  minimum        Value to use as default and minimum
 *
 * \return Standard Pacemaker return code
 * \note If the value is larger than the maximum integer, EOVERFLOW will be
 *       returned and \p result will be set to the maximum integer.
 */
int
pcmk__scan_min_int(const char *text, int *result, int minimum)
{
    int rc;
    long long result_ll;

    rc = pcmk__scan_ll(text, &result_ll, (long long) minimum);

    if (result_ll < (long long) minimum) {
        pcmk__warn("Clipped '%s' to minimum acceptable value %d", text,
                   minimum);
        result_ll = (long long) minimum;

    } else if (result_ll > INT_MAX) {
        pcmk__warn("Clipped '%s' to maximum integer %d", text, INT_MAX);
        result_ll = (long long) INT_MAX;
        rc = EOVERFLOW;
    }

    if (result != NULL) {
        *result = (int) result_ll;
    }
    return rc;
}

/*!
 * \internal
 * \brief Scan a TCP port number from a string
 *
 * \param[in]  text  The string to scan
 * \param[out] port  Where to store result (or NULL to ignore)
 *
 * \return Standard Pacemaker return code
 * \note \p port will be -1 if \p text is NULL or invalid
 */
int
pcmk__scan_port(const char *text, int *port)
{
    long long port_ll;
    int rc = pcmk__scan_ll(text, &port_ll, -1LL);

    if (rc != pcmk_rc_ok) {
        pcmk__warn("'%s' is not a valid port: %s", text, pcmk_rc_str(rc));

    } else if ((text != NULL) // wasn't default or invalid
        && ((port_ll < 0LL) || (port_ll > 65535LL))) {
        pcmk__warn("Ignoring port specification '%s' not in valid range "
                   "(0-65535)",
                   text);
        rc = (port_ll < 0LL)? pcmk_rc_before_range : pcmk_rc_after_range;
        port_ll = -1LL;
    }
    if (port != NULL) {
        *port = (int) port_ll;
    }
    return rc;
}

/*!
 * \internal
 * \brief Scan a double-precision floating-point value from a string
 *
 * \param[in]      text         The string to parse
 * \param[out]     result       Parsed value on success, or
 *                              \c PCMK__PARSE_DBL_DEFAULT on error
 * \param[in]      default_text Default string to parse if \p text is
 *                              \c NULL
 * \param[out]     end_text     If not \c NULL, where to store a pointer
 *                              to the position immediately after the
 *                              value
 *
 * \return Standard Pacemaker return code (\c pcmk_rc_ok on success,
 *         \c EINVAL on failed string conversion due to invalid input,
 *         \c EOVERFLOW on arithmetic overflow, \c pcmk_rc_underflow
 *         on arithmetic underflow, or \c errno from \c strtod() on
 *         other parse errors)
 */
int
pcmk__scan_double(const char *text, double *result, const char *default_text,
                  char **end_text)
{
    int rc = pcmk_rc_ok;
    char *local_end_text = NULL;

    pcmk__assert(result != NULL);
    *result = PCMK__PARSE_DBL_DEFAULT;

    text = (text != NULL) ? text : default_text;

    if (text == NULL) {
        rc = EINVAL;
        pcmk__debug("No text and no default conversion value supplied");

    } else {
        errno = 0;
        *result = strtod(text, &local_end_text);

        if (errno == ERANGE) {
            /*
             * Overflow: strtod() returns +/- HUGE_VAL and sets errno to
             *           ERANGE
             *
             * Underflow: strtod() returns "a value whose magnitude is
             *            no greater than the smallest normalized
             *            positive" double. Whether ERANGE is set is
             *            implementation-defined.
             */
            const char *over_under;

            if (QB_ABS(*result) > DBL_MIN) {
                rc = EOVERFLOW;
                over_under = "over";
            } else {
                rc = pcmk_rc_underflow;
                over_under = "under";
            }

            pcmk__debug("Floating-point value parsed from '%s' would %sflow "
                        "(using %g instead)",
                        text, over_under, *result);

        } else if (errno != 0) {
            rc = errno;
            // strtod() set *result = 0 on parse failure
            *result = PCMK__PARSE_DBL_DEFAULT;

            pcmk__debug("Could not parse floating-point value from '%s' (using "
                        "%.1f instead): %s",
                        text, PCMK__PARSE_DBL_DEFAULT, pcmk_rc_str(rc));

        } else if (local_end_text == text) {
            // errno == 0, but nothing was parsed
            rc = EINVAL;
            *result = PCMK__PARSE_DBL_DEFAULT;

            pcmk__debug("Could not parse floating-point value from '%s' (using "
                        "%.1f instead): No digits found",
                        text, PCMK__PARSE_DBL_DEFAULT);

        } else if (QB_ABS(*result) <= DBL_MIN) {
            /*
             * errno == 0 and text was parsed, but value might have
             * underflowed.
             *
             * ERANGE might not be set for underflow. Check magnitude
             * of *result, but also make sure the input number is not
             * actually zero (0 <= DBL_MIN is not underflow).
             *
             * This check must come last. A parse failure in strtod()
             * also sets *result == 0, so a parse failure would match
             * this test condition prematurely.
             */
            for (const char *p = text; p != local_end_text; p++) {
                if (strchr("0.eE", *p) == NULL) {
                    rc = pcmk_rc_underflow;
                    pcmk__debug("Floating-point value parsed from '%s' would "
                                "underflow (using %g instead)", text, *result);
                    break;
                }
            }

        } else {
            pcmk__trace("Floating-point value parsed successfully from '%s': "
                        "%g",
                        text, *result);
        }

        if ((end_text == NULL) && !pcmk__str_empty(local_end_text)) {
            pcmk__debug("Characters left over after parsing '%s': '%s'", text,
                        local_end_text);
        }
    }

    if (end_text != NULL) {
        *end_text = local_end_text;
    }

    return rc;
}

/*!
 * \internal
 * \brief Parse an <tt>unsigned int</tt> from a string stored in a hash table
 *
 * \param[in]     table        Hash table to search
 * \param[in]     key          Hash table key to use to retrieve string
 * \param[in]     default_val  What to use if key has no entry in table
 * \param[out]    result       If not NULL, where to store parsed integer
 *
 * \return Standard Pacemaker return code
 */
int
pcmk__uint_from_hash(GHashTable *table, const char *key,
                     unsigned int default_val, unsigned int *result)
{
    const char *value;
    long long value_ll;
    int rc = pcmk_rc_ok;

    CRM_CHECK((table != NULL) && (key != NULL), return EINVAL);

    if (result != NULL) {
        *result = default_val;
    }

    value = g_hash_table_lookup(table, key);
    if (value == NULL) {
        return pcmk_rc_ok;
    }

    rc = pcmk__scan_ll(value, &value_ll, 0LL);
    if (rc != pcmk_rc_ok) {
        pcmk__warn("Using default (%u) for %s because '%s' is not a valid "
                   "integer: %s",
                   default_val, key, value, pcmk_rc_str(rc));
        return rc;
    }

    if ((value_ll < 0) || (value_ll > UINT_MAX)) {
        pcmk__warn("Using default (%u) for %s because '%s' is not in valid "
                   "range",
                   default_val, key, value);
        return ERANGE;
    }

    if (result != NULL) {
        *result = (unsigned int) value_ll;
    }
    return pcmk_rc_ok;
}

/*!
 * \brief Parse milliseconds from a Pacemaker interval specification
 *
 * \param[in]  input      Pacemaker time interval specification (a bare number
 *                        of seconds; a number with a unit, optionally with
 *                        whitespace before and/or after the number; or an ISO
 *                        8601 duration) (can be \c NULL)
 * \param[out] result_ms  Where to store milliseconds equivalent of \p input on
 *                        success (limited to the range of an unsigned integer),
 *                        or 0 if \p input is \c NULL or invalid
 *
 * \return Standard Pacemaker return code
 */
int
pcmk_parse_interval_spec(const char *input, unsigned int *result_ms)
{
    long long msec = PCMK__PARSE_INT_DEFAULT;
    int rc = pcmk_rc_ok;

    if (input == NULL) {
        msec = 0;
        goto done;
    }

    if (input[0] == 'P') {
        crm_time_t *period_s = pcmk__time_parse_duration(input);

        if (period_s != NULL) {
            msec = pcmk__time_get_seconds(period_s);
            msec = QB_MIN(msec, UINT_MAX / 1000) * 1000;
            free(period_s);
        }

    } else {
        rc = pcmk__parse_ms(input, &msec);
    }

    if (msec < 0) {
        pcmk__warn("Using 0 instead of invalid interval specification '%s'",
                   input);
        msec = 0;

        if (rc == pcmk_rc_ok) {
            // Preserve any error from pcmk__parse_ms()
            rc = EINVAL;
        }
    }

done:
    if (result_ms != NULL) {
        *result_ms = (msec >= UINT_MAX)? UINT_MAX : (unsigned int) msec;
    }
    return rc;
}

/*!
 * \internal
 * \brief Create a hash of a string suitable for use with GHashTable
 *
 * \param[in] v  String to hash
 *
 * \return A hash of \p v compatible with g_str_hash() before glib 2.28
 * \note glib changed their hash implementation:
 *
 * https://gitlab.gnome.org/GNOME/glib/commit/354d655ba8a54b754cb5a3efb42767327775696c
 *
 * Note that the new g_str_hash is presumably a *better* hash (it's actually
 * a correct implementation of DJB's hash), but we need to preserve existing
 * behaviour, because the hash key ultimately determines the "sort" order
 * when iterating through GHashTables, which affects allocation of scores to
 * clone instances when iterating through allowed nodes. It (somehow) also
 * appears to have some minor impact on the ordering of a few pseudo_event IDs
 * in the transition graph.
 */
static unsigned int
pcmk__str_hash(const void *v)
{
    const signed char *p;
    guint32 h = 0;

    for (p = v; *p != '\0'; p++)
        h = (h << 5) - h + *p;

    return h;
}

/*!
 * \internal
 * \brief Create a hash table with case-sensitive strings as keys
 *
 * \param[in] key_destroy_func    Function to free a key
 * \param[in] value_destroy_func  Function to free a value
 *
 * \return Newly allocated hash table
 * \note It is the caller's responsibility to free the result, using
 *       g_hash_table_destroy().
 */
GHashTable *
pcmk__strkey_table(GDestroyNotify key_destroy_func,
                   GDestroyNotify value_destroy_func)
{
    return g_hash_table_new_full(pcmk__str_hash, g_str_equal,
                                 key_destroy_func, value_destroy_func);
}

/*!
 * \internal
 * \brief Insert string copies into a hash table as key and value
 *
 * \param[in,out] table  Hash table to add to
 * \param[in]     name   String to add a copy of as key
 * \param[in]     value  String to add a copy of as value
 *
 * \note This asserts on invalid arguments or memory allocation failure.
 */
void
pcmk__insert_dup(GHashTable *table, const char *name, const char *value)
{
    pcmk__assert((table != NULL) && (name != NULL));

    g_hash_table_insert(table, pcmk__str_copy(name), pcmk__str_copy(value));
}

/* used with hash tables where case does not matter */
static gboolean
pcmk__strcase_equal(const void *a, const void *b)
{
    return pcmk__str_eq((const char *)a, (const char *)b, pcmk__str_casei);
}

static unsigned int
pcmk__strcase_hash(const void *v)
{
    const signed char *p;
    guint32 h = 0;

    for (p = v; *p != '\0'; p++)
        h = (h << 5) - h + g_ascii_tolower(*p);

    return h;
}

/*!
 * \internal
 * \brief Create a hash table with case-insensitive strings as keys
 *
 * \param[in] key_destroy_func    Function to free a key
 * \param[in] value_destroy_func  Function to free a value
 *
 * \return Newly allocated hash table
 * \note It is the caller's responsibility to free the result, using
 *       g_hash_table_destroy().
 */
GHashTable *
pcmk__strikey_table(GDestroyNotify key_destroy_func,
                    GDestroyNotify value_destroy_func)
{
    return g_hash_table_new_full(pcmk__strcase_hash, pcmk__strcase_equal,
                                 key_destroy_func, value_destroy_func);
}

static void
copy_str_table_entry(void *key, void *value, void *user_data)
{
    if (key && value && user_data) {
        pcmk__insert_dup((GHashTable *) user_data,
                         (const char *) key, (const char *) value);
    }
}

/*!
 * \internal
 * \brief Copy a hash table that uses dynamically allocated strings
 *
 * \param[in,out] old_table  Hash table to duplicate
 *
 * \return New hash table with copies of everything in \p old_table
 * \note This assumes the hash table uses dynamically allocated strings -- that
 *       is, both the key and value free functions are free().
 */
GHashTable *
pcmk__str_table_dup(GHashTable *old_table)
{
    GHashTable *new_table = NULL;

    if (old_table) {
        new_table = pcmk__strkey_table(free, free);
        g_hash_table_foreach(old_table, copy_str_table_entry, new_table);
    }
    return new_table;
}

/*!
 * \internal
 * \brief Add a word to a string list of words
 *
 * \param[in,out] list       Pointer to current string list (may not be \p NULL)
 * \param[in]     init_size  \p list will be initialized to at least this size,
 *                           if it needs initialization (if 0, use GLib's default
 *                           initial string size)
 * \param[in]     word       String to add to \p list (\p list will be
 *                           unchanged if this is \p NULL or the empty string)
 * \param[in]     separator  String to separate words in \p list
 *
 * \note \p word may contain \p separator, though that would be a bad idea if
 *       the string needs to be parsed later.
 */
void
pcmk__add_separated_word(GString **list, size_t init_size, const char *word,
                         const char *separator)
{
    pcmk__assert((list != NULL) && (separator != NULL));

    if (pcmk__str_empty(word)) {
        return;
    }

    if (*list == NULL) {
        if (init_size > 0) {
            *list = g_string_sized_new(init_size);
        } else {
            *list = g_string_new(NULL);
        }
    }

    if ((*list)->len > 0) {
        // Don't add a separator before the first word in the list
        g_string_append(*list, separator);
    }
    g_string_append(*list, word);
}

/*!
 * \internal
 * \brief Compress data
 *
 * \param[in]  data        Data to compress
 * \param[in]  length      Number of characters of data to compress
 * \param[out] result      Where to store newly allocated compressed result
 * \param[out] result_len  Where to store actual compressed length of result
 *
 * \return Standard Pacemaker return code
 */
int
pcmk__compress(const char *data, size_t length, char **result, size_t *result_len)
{
    size_t max = (length * 1.01) + 601;     // Max size of the compressed result
    unsigned int dest_len = 0;              // Where bz2 should store the actual size
    int rc = pcmk_rc_ok;
    char *compressed = NULL;
    char *uncompressed = NULL;

    /* Did the max calculation overflow? */
    if (max < length) {
        return EINVAL;
    }

    /* BZ2_bzBuffToBuffCompress wants unsigned ints, not size_t.  This function
     * takes size_t arguments to simplify checking in its callers.  Make sure
     * we're not passing BZ2_bzBuffToBuffCompress something that's too large.
     */
#if (SIZE_MAX > UINT_MAX)
    if (max > UINT_MAX) {
        return EINVAL;
    }
#endif

    compressed = pcmk__assert_alloc(max, sizeof(char));
    uncompressed = pcmk__str_copy(data);

    dest_len = max;
    rc = BZ2_bzBuffToBuffCompress(compressed, &dest_len, uncompressed, length,
                                  PCMK__BZ2_BLOCKS, 0, PCMK__BZ2_WORK);
    *result_len = dest_len;

    rc = pcmk__bzlib2rc(rc);

    free(uncompressed);

    if (rc != pcmk_rc_ok) {
        pcmk__err("Compression of %zu bytes failed: %s " QB_XS " rc=%d", length,
                  pcmk_rc_str(rc), rc);
        free(compressed);
        return rc;
    }

    pcmk__trace("Compressed %zu bytes into %zu", length, *result_len);

    *result = compressed;
    return pcmk_rc_ok;
}

/*!
 * \internal
 * \brief Parse a boolean value from a string
 *
 * Valid input strings (case-insensitive) are as follows:
 * * \c PCMK_VALUE_TRUE, \c "on", \c "yes", \c "y", or \c "1" for \c true
 * * \c PCMK_VALUE_FALSE, \c PCMK_VALUE_OFF, \c "no", \c "n", or \c "0" for
 *   \c false
 *
 * \param[in]  input   Input string
 * \param[out] result  Where to store result (can be \c NULL; unchanged on
 *                     error)
 *
 * \retval Standard Pacemaker return code
 */
int
pcmk__parse_bool(const char *input, bool *result)
{
    bool local_result = false;

    CRM_CHECK(input != NULL, return EINVAL);

    if (pcmk__strcase_any_of(input, PCMK_VALUE_TRUE, "on", "yes", "y", "1",
                             NULL)) {
        local_result = true;

    } else if (pcmk__strcase_any_of(input, PCMK_VALUE_FALSE, PCMK_VALUE_OFF,
                                    "no", "n", "0", NULL)) {
        local_result = false;

    } else {
        return pcmk_rc_bad_input;
    }

    if (result != NULL) {
        *result = local_result;
    }
    return pcmk_rc_ok;
}

/*!
 * \internal
 * \brief Parse a range specification string
 *
 * A valid range specification string can be in any of the following forms,
 * where \c "X", \c "Y", and \c "Z" are nonnegative integers that fit into a
 * <tt>long long</tt> variable:
 * * "X-Y"
 * * "X-"
 * * "-Y"
 * * "Z"
 *
 * In the list above, \c "X" is the start value and \c "Y" is the end value of
 * the range. Either the start value or the end value, but not both, can be
 * empty. \c "Z", a single integer with no \c '-' character, is both the start
 * value and the end value of its range.
 *
 * If the start value or end value is empty, then the parsed result stored in
 * \p *start or \p *end (respectively) is \c PCMK__PARSE_INT_DEFAULT after a
 * successful parse.
 *
 * If the specification string consists of only a single number, then the same
 * value is stored in both \p *start and \p *end on a successful parse.
 *
 * \param[in]  text   String to parse
 * \param[out] start  Where to store start value (can be \c NULL)
 * \param[out] end    Where to store end value (can be \c NULL)
 *
 * \return Standard Pacemaker return code
 *
 * \note The values stored in \p *start and \p *end are undefined if the return
 *       value is not \c pcmk_rc_ok.
 */
int
pcmk__parse_ll_range(const char *text, long long *start, long long *end)
{
    int rc = pcmk_rc_ok;
    long long local_start = 0;
    long long local_end = 0;
    gchar **split = NULL;
    unsigned int length = 0;
    const char *start_s = NULL;
    const char *end_s = NULL;

    // Do not free
    char *remainder = NULL;

    if (start == NULL) {
        start = &local_start;
    }
    if (end == NULL) {
        end = &local_end;
    }
    *start = PCMK__PARSE_INT_DEFAULT;
    *end = PCMK__PARSE_INT_DEFAULT;

    if (pcmk__str_empty(text)) {
        rc = ENODATA;
        goto done;
    }

    split = g_strsplit(text, "-", 2);
    length = g_strv_length(split);
    start_s = split[0];
    if (length == 2) {
        end_s = split[1];
    }

    if (pcmk__str_empty(start_s) && pcmk__str_empty(end_s)) {
        rc = pcmk_rc_bad_input;
        goto done;
    }

    if (!pcmk__str_empty(start_s)) {
        rc = scan_ll(start_s, start, PCMK__PARSE_INT_DEFAULT, &remainder);
        if (rc != pcmk_rc_ok) {
            goto done;
        }
        if (!pcmk__str_empty(remainder)) {
            rc = pcmk_rc_bad_input;
            goto done;
        }
    }

    if (length == 1) {
        // String contains only a single number, which is both start and end
        *end = *start;
        goto done;
    }

    if (!pcmk__str_empty(end_s)) {
        rc = scan_ll(end_s, end, PCMK__PARSE_INT_DEFAULT, &remainder);

        if ((rc == pcmk_rc_ok) && !pcmk__str_empty(remainder)) {
            rc = pcmk_rc_bad_input;
        }
    }

done:
    g_strfreev(split);
    return rc;
}

/*!
 * \internal
 * \brief Get multiplier and divisor corresponding to given units string
 *
 * Multiplier and divisor convert from a number of seconds to an equivalent
 * number of the unit described by the units string.
 *
 * \param[in]  units       String describing a unit of time (may be empty,
 *                         \c "s", \c "sec", \c "ms", \c "msec", \c "us",
 *                         \c "usec", \c "m", \c "min", \c "h", or \c "hr")
 * \param[out] multiplier  Number of units in one second, if unit is smaller
 *                         than one second, or 1 otherwise (unchanged on error)
 * \param[out] divisor     Number of seconds in one unit, if unit is larger
 *                         than one second, or 1 otherwise (unchanged on error)
 *
 * \return Standard Pacemaker return code
 */
static int
get_multiplier_divisor(const char *units, long long *multiplier,
                       long long *divisor)
{
    /* @COMPAT Use exact comparisons. Currently, we match too liberally, and the
     * second strncasecmp() in each case is redundant.
     */
    if ((*units == '\0')
        || (strncasecmp(units, "s", 1) == 0)
        || (strncasecmp(units, "sec", 3) == 0)) {
        *multiplier = 1000;
        *divisor = 1;

    } else if ((strncasecmp(units, "ms", 2) == 0)
               || (strncasecmp(units, "msec", 4) == 0)) {
        *multiplier = 1;
        *divisor = 1;

    } else if ((strncasecmp(units, "us", 2) == 0)
               || (strncasecmp(units, "usec", 4) == 0)) {
        *multiplier = 1;
        *divisor = 1000;

    } else if ((strncasecmp(units, "m", 1) == 0)
               || (strncasecmp(units, "min", 3) == 0)) {
        *multiplier = 60 * 1000;
        *divisor = 1;

    } else if ((strncasecmp(units, "h", 1) == 0)
               || (strncasecmp(units, "hr", 2) == 0)) {
        *multiplier = 60 * 60 * 1000;
        *divisor = 1;

    } else {
        // Invalid units
        return pcmk_rc_bad_input;
    }

    return pcmk_rc_ok;
}

/*!
 * \internal
 * \brief Parse a time and units string into a milliseconds value
 *
 * \param[in]  input   String with a nonnegative number and optional unit
 *                     (optionally with whitespace before and/or after the
 *                     number). If absent, the unit defaults to seconds.
 * \param[out] result  Where to store result in milliseconds (unchanged on error
 *                     except \c ERANGE)
 *
 * \return Standard Pacemaker return code
 */
int
pcmk__parse_ms(const char *input, long long *result)
{
    long long local_result = 0;
    char *units = NULL; // Do not free; will point to part of input
    long long multiplier = 1000;
    long long divisor = 1;
    int rc = pcmk_rc_ok;

    CRM_CHECK(input != NULL, return EINVAL);

    rc = scan_ll(input, &local_result, 0, &units);
    if ((rc == pcmk_rc_ok) || (rc == ERANGE)) {
        int units_rc = pcmk_rc_ok;

        /* If the number is a decimal, scan_ll() reads only the integer part.
         * Skip any remaining digits or decimal characters.
         *
         * @COMPAT Well-formed and malformed decimals are both accepted inputs.
         * For example, "3.14 ms" and "3.1.4 ms" are treated the same as "3ms"
         * and parsed successfully. At a compatibility break, decide if this is
         * still desired.
         */
        for (; isdigit(*units) || (*units == '.'); units++);

        // Skip any additional whitespace after the number
        for (; isspace(*units); units++);

        // Validate units and get conversion constants
        units_rc = get_multiplier_divisor(units, &multiplier, &divisor);
        if (units_rc != pcmk_rc_ok) {
            rc = units_rc;
        }
    }

    if (rc == ERANGE) {
        pcmk__warn("'%s' will be clipped to %lld", input, local_result);

        /* Continue through rest of body before returning ERANGE
         *
         * @COMPAT Improve handling of overflow. Units won't necessarily be
         * respected right now, for one thing.
         */

    } else if (rc != pcmk_rc_ok) {
        pcmk__warn("'%s' is not a valid time duration: %s", input,
                   pcmk_rc_str(rc));
        return rc;
    }

    if (result == NULL) {
        return rc;
    }

    // Apply units, capping at LLONG_MAX
    if (local_result > (LLONG_MAX / multiplier)) {
        *result = LLONG_MAX;
    } else if (local_result < (LLONG_MIN / multiplier)) {
        *result = LLONG_MIN;
    } else {
        *result = (local_result * multiplier) / divisor;
    }

    return rc;
}

/*!
 * \internal
 * \brief Data for \c cmp_str_in_list()
 */
struct str_in_list_data {
    const char *str;
    uint32_t flags;
};

/*!
 * \internal
 * \brief Call \c pcmk__strcmp() against an element of a \c GList
 *
 * \param[in] a  List element (a string)
 * \param[in] b  String to compare against \p and the flags for comparison (a
 *               (<tt>struct str_in_list_data</tt>)
 *
 * \return A negative integer if \p a comes before \p b->str, a positive integer
 *         if \p a comes after \p b->str, or 0 if \p a is equal to \p b->str
 *         (according to \p b->flags)
 */
static int
cmp_str_in_list(const void *a, const void *b)
{
    const char *element = a;
    const struct str_in_list_data *data = b;

    return pcmk__strcmp(element, data->str, data->flags);
}

/*!
 * \internal
 * \brief Find a string in a list of strings
 *
 * \param[in] str    String to search for
 * \param[in] list   List to search
 * \param[in] flags  Group of <tt>enum pcmk__str_flags</tt> to pass to
 *                   \c pcmk__str_eq()
 *
 * \return \c true if \p str is in \p list, or \c false otherwise
 */
bool
pcmk__str_in_list(const char *str, const GList *list, uint32_t flags)
{
    const struct str_in_list_data data = {
        .str = str,
        .flags = flags,
    };

    return (g_list_find_custom((GList *) list, &data, cmp_str_in_list) != NULL);
}

/*!
 * \internal
 * \brief Check whether a string is in an array of <tt>gchar *</tt>
 *
 * \param[in] strv  <tt>NULL</tt>-terminated array of strings to search
 * \param[in] str   String to search for
 *
 * \return \c true if \p str is an element of \p strv, or \c false otherwise
 */
bool
pcmk__g_strv_contains(char **strv, const char *str)
{
    // @COMPAT Replace with calls to g_strv_contains() when we require glib 2.44
    CRM_CHECK((strv != NULL) && (str != NULL), return false);

    for (; *strv != NULL; strv++) {
        if (pcmk__str_eq(*strv, str, pcmk__str_none)) {
            return true;
        }
    }

    return false;
}

static bool
str_any_of(const char *s, va_list args, uint32_t flags)
{
    if (s == NULL) {
        return false;
    }

    while (1) {
        const char *ele = va_arg(args, const char *);

        if (ele == NULL) {
            break;
        } else if (pcmk__str_eq(s, ele, flags)) {
            return true;
        }
    }

    return false;
}

/*!
 * \internal
 * \brief Is a string a member of a list of strings?
 *
 * \param[in]  s    String to search for in \p ...
 * \param[in]  ...  Strings to compare \p s against.  The final string
 *                  must be NULL.
 *
 * \note The comparison is done case-insensitively.  The function name is
 *       meant to be reminiscent of strcasecmp.
 *
 * \return \c true if \p s is in \p ..., or \c false otherwise
 */
bool
pcmk__strcase_any_of(const char *s, ...)
{
    va_list ap;
    bool rc;

    va_start(ap, s);
    rc = str_any_of(s, ap, pcmk__str_casei);
    va_end(ap);
    return rc;
}

/*!
 * \internal
 * \brief Is a string a member of a list of strings?
 *
 * \param[in]  s    String to search for in \p ...
 * \param[in]  ...  Strings to compare \p s against.  The final string
 *                  must be NULL.
 *
 * \note The comparison is done taking case into account.
 *
 * \return \c true if \p s is in \p ..., or \c false otherwise
 */
bool
pcmk__str_any_of(const char *s, ...)
{
    va_list ap;
    bool rc;

    va_start(ap, s);
    rc = str_any_of(s, ap, pcmk__str_none);
    va_end(ap);
    return rc;
}

/*!
 * \internal
 * \brief Sort strings, with numeric portions sorted numerically
 *
 * Sort two strings case-insensitively like strcasecmp(), but with any numeric
 * portions of the string sorted numerically. This is particularly useful for
 * node names (for example, "node10" will sort higher than "node9" but lower
 * than "remotenode9").
 *
 * \param[in] s1  First string to compare (must not be NULL)
 * \param[in] s2  Second string to compare (must not be NULL)
 *
 * \retval -1 \p s1 comes before \p s2
 * \retval  0 \p s1 and \p s2 are equal
 * \retval  1 \p s1 comes after \p s2
 */
int
pcmk__numeric_strcasecmp(const char *s1, const char *s2)
{
    pcmk__assert((s1 != NULL) && (s2 != NULL));

    while (*s1 && *s2) {
        if (isdigit(*s1) && isdigit(*s2)) {
            // If node names contain a number, sort numerically

            char *end1 = NULL;
            char *end2 = NULL;
            long num1 = strtol(s1, &end1, 10);
            long num2 = strtol(s2, &end2, 10);

            // allow ordering e.g. 007 > 7
            size_t len1 = end1 - s1;
            size_t len2 = end2 - s2;

            if (num1 < num2) {
                return -1;
            } else if (num1 > num2) {
                return 1;
            } else if (len1 < len2) {
                return -1;
            } else if (len1 > len2) {
                return 1;
            }
            s1 = end1;
            s2 = end2;
        } else {
            // Compare non-digits case-insensitively
            int lower1 = tolower(*s1);
            int lower2 = tolower(*s2);

            if (lower1 < lower2) {
                return -1;
            } else if (lower1 > lower2) {
                return 1;
            }
            ++s1;
            ++s2;
        }
    }
    if (!*s1 && *s2) {
        return -1;
    } else if (*s1 && !*s2) {
        return 1;
    }
    return 0;
}

/*!
 * \internal
 * \brief Sort strings.
 *
 * This is your one-stop function for string comparison. By default, this
 * function works like \p g_strcmp0. That is, like \p strcmp but a \p NULL
 * string sorts before a non-<tt>NULL</tt> string.
 *
 * The \p pcmk__str_none flag produces the default behavior. Behavior can be
 * changed with various flags:
 *
 * - \p pcmk__str_regex - The second string is a regular expression that the
 *                        first string will be matched against.
 * - \p pcmk__str_casei - By default, comparisons are done taking case into
 *                        account. This flag makes comparisons case-
 *                        insensitive. This can be combined with
 *                        \p pcmk__str_regex.
 * - \p pcmk__str_null_matches - If one string is \p NULL and the other is not,
 *                               still return \p 0.
 * - \p pcmk__str_star_matches - If one string is \p "*" and the other is not,
 *                               still return \p 0.
 *
 * \param[in] s1     First string to compare
 * \param[in] s2     Second string to compare, or a regular expression to
 *                   match if \p pcmk__str_regex is set
 * \param[in] flags  A bitfield of \p pcmk__str_flags to modify operation
 *
 * \retval  negative \p s1 is \p NULL or comes before \p s2
 * \retval  0        \p s1 and \p s2 are equal, or \p s1 is found in \p s2 if
 *                   \c pcmk__str_regex is set
 * \retval  positive \p s2 is \p NULL or \p s1 comes after \p s2, or \p s2
 *                   is an invalid regular expression, or \p s1 was not found
 *                   in \p s2 if \p pcmk__str_regex is set.
 */
int
pcmk__strcmp(const char *s1, const char *s2, uint32_t flags)
{
    /* If this flag is set, the second string is a regex. */
    if (pcmk__is_set(flags, pcmk__str_regex)) {
        regex_t r_patt;
        int reg_flags = REG_EXTENDED | REG_NOSUB;
        int regcomp_rc = 0;
        int rc = 0;

        if (s1 == NULL || s2 == NULL) {
            return 1;
        }

        if (pcmk__is_set(flags, pcmk__str_casei)) {
            reg_flags |= REG_ICASE;
        }
        regcomp_rc = regcomp(&r_patt, s2, reg_flags);
        if (regcomp_rc != 0) {
            rc = 1;
            pcmk__err("Bad regex '%s' for update: %s", s2,
                      strerror(regcomp_rc));
        } else {
            rc = regexec(&r_patt, s1, 0, NULL, 0);
            regfree(&r_patt);
            if (rc != 0) {
                rc = 1;
            }
        }
        return rc;
    }

    /* If the strings are the same pointer, return 0 immediately. */
    if (s1 == s2) {
        return 0;
    }

    /* If this flag is set, return 0 if either (or both) of the input strings
     * are NULL.  If neither one is NULL, we need to continue and compare
     * them normally.
     */
    if (pcmk__is_set(flags, pcmk__str_null_matches)) {
        if (s1 == NULL || s2 == NULL) {
            return 0;
        }
    }

    /* Handle the cases where one is NULL and the str_null_matches flag is not set.
     * A NULL string always sorts to the beginning.
     */
    if (s1 == NULL) {
        return -1;
    } else if (s2 == NULL) {
        return 1;
    }

    /* If this flag is set, return 0 if either (or both) of the input strings
     * are "*".  If neither one is, we need to continue and compare them
     * normally.
     */
    if (pcmk__is_set(flags, pcmk__str_star_matches)) {
        if (strcmp(s1, "*") == 0 || strcmp(s2, "*") == 0) {
            return 0;
        }
    }

    if (pcmk__is_set(flags, pcmk__str_casei)) {
        return strcasecmp(s1, s2);
    } else {
        return strcmp(s1, s2);
    }
}

/*!
 * \internal
 * \brief Copy a string, asserting on failure
 *
 * \param[in] file      File where \p function is located
 * \param[in] function  Calling function
 * \param[in] line      Line within \p file
 * \param[in] str       String to copy (can be \c NULL)
 *
 * \return Newly allocated copy of \p str, or \c NULL if \p str is \c NULL
 *
 * \note The caller is responsible for freeing the return value using \c free().
 */
char *
pcmk__str_copy_as(const char *file, const char *function, uint32_t line,
                  const char *str)
{
    if (str != NULL) {
        char *result = strdup(str);

        if (result == NULL) {
            crm_abort(file, function, line, "Out of memory", FALSE, TRUE);
            crm_exit(CRM_EX_OSERR);
        }
        return result;
    }
    return NULL;
}

/*!
 * \internal
 * \brief Update a dynamically allocated string with a new value
 *
 * Given a dynamically allocated string and a new value for it, if the string
 * is different from the new value, free the string and replace it with either a
 * newly allocated duplicate of the value or NULL as appropriate.
 *
 * \param[in,out] str    Pointer to dynamically allocated string
 * \param[in]     value  New value to duplicate (or NULL)
 *
 * \note The caller remains responsibile for freeing \p *str.
 */
void
pcmk__str_update(char **str, const char *value)
{
    if ((str != NULL) && !pcmk__str_eq(*str, value, pcmk__str_none)) {
        free(*str);
        *str = pcmk__str_copy(value);
    }
}

/*!
 * \internal
 * \brief Print to an allocated string using \c printf()-style formatting
 *
 * This is like \c asprintf() but asserts on any error. The return value cannot
 * be \c NULL, but it may be an empty string, depending on the format string and
 * variadic arguments.
 *
 * \param[in] format  \c printf() format string
 * \param[in] ...     \c printf() format arguments
 *
 * \return Newly allocated string (guaranteed not to be \c NULL).
 *
 * \note The caller is responsible for freeing the return value using \c free().
 */
char *
pcmk__assert_asprintf(const char *format, ...)
{
    char *result = NULL;
    va_list ap;

    va_start(ap, format);
    pcmk__assert(vasprintf(&result, format, ap) >= 0);
    va_end(ap);

    return result;
}

/*!
 * \internal
 * \brief Append a list of strings to a destination \p GString
 *
 * \param[in,out] buffer  Where to append the strings (must not be \p NULL)
 * \param[in]     ...     A <tt>NULL</tt>-terminated list of strings
 *
 * \note This tends to be more efficient than a single call to
 *       \p g_string_append_printf().
 */
void
pcmk__g_strcat(GString *buffer, ...)
{
    va_list ap;

    pcmk__assert(buffer != NULL);
    va_start(ap, buffer);

    while (true) {
        const char *ele = va_arg(ap, const char *);

        if (ele == NULL) {
            break;
        }
        g_string_append(buffer, ele);
    }
    va_end(ap);
}

// Deprecated functions kept only for backward API compatibility
// LCOV_EXCL_START

#include <crm/common/strings_compat.h>

long long
crm_get_msec(const char *input)
{
    char *units = NULL; // Do not free; will point to part of input
    long long multiplier = 1000;
    long long divisor = 1;
    long long msec = PCMK__PARSE_INT_DEFAULT;
    int rc = pcmk_rc_ok;

    if (input == NULL) {
        return PCMK__PARSE_INT_DEFAULT;
    }

    // Skip initial whitespace
    while (isspace(*input)) {
        input++;
    }

    rc = scan_ll(input, &msec, PCMK__PARSE_INT_DEFAULT, &units);

    if ((rc == ERANGE) && (msec > 0)) {
        pcmk__warn("'%s' will be clipped to %lld", input, msec);

    } else if ((rc != pcmk_rc_ok) || (msec < 0)) {
        pcmk__warn("'%s' is not a valid time duration: %s", input,
                   ((rc == pcmk_rc_ok)? "Negative" : pcmk_rc_str(rc)));
        return PCMK__PARSE_INT_DEFAULT;
    }

    /* If the number is a decimal, scan_ll() reads only the integer part. Skip
     * any remaining digits or decimal characters.
     *
     * @COMPAT Well-formed and malformed decimals are both accepted inputs. For
     * example, "3.14 ms" and "3.1.4 ms" are treated the same as "3ms" and
     * parsed successfully. At a compatibility break, decide if this is still
     * desired.
     */
    while (isdigit(*units) || (*units == '.')) {
        units++;
    }

    // Skip any additional whitespace after the number
    while (isspace(*units)) {
        units++;
    }

    /* @COMPAT Use exact comparisons. Currently, we match too liberally, and the
     * second strncasecmp() in each case is redundant.
     */
    if ((*units == '\0')
        || (strncasecmp(units, "s", 1) == 0)
        || (strncasecmp(units, "sec", 3) == 0)) {
        multiplier = 1000;
        divisor = 1;

    } else if ((strncasecmp(units, "ms", 2) == 0)
               || (strncasecmp(units, "msec", 4) == 0)) {
        multiplier = 1;
        divisor = 1;

    } else if ((strncasecmp(units, "us", 2) == 0)
               || (strncasecmp(units, "usec", 4) == 0)) {
        multiplier = 1;
        divisor = 1000;

    } else if ((strncasecmp(units, "m", 1) == 0)
               || (strncasecmp(units, "min", 3) == 0)) {
        multiplier = 60 * 1000;
        divisor = 1;

    } else if ((strncasecmp(units, "h", 1) == 0)
               || (strncasecmp(units, "hr", 2) == 0)) {
        multiplier = 60 * 60 * 1000;
        divisor = 1;

    } else {
        // Invalid units
        return PCMK__PARSE_INT_DEFAULT;
    }

    // Apply units, capping at LLONG_MAX
    if (msec > (LLONG_MAX / multiplier)) {
        return LLONG_MAX;
    }
    return (msec * multiplier) / divisor;
}

gboolean
crm_is_true(const char *s)
{
    gboolean ret = FALSE;

    return (crm_str_to_boolean(s, &ret) < 0)? FALSE : ret;
}

int
crm_str_to_boolean(const char *s, int *ret)
{
    if (s == NULL) {
        return -1;
    }

    if (pcmk__strcase_any_of(s, PCMK_VALUE_TRUE, "on", "yes", "y", "1", NULL)) {
        if (ret != NULL) {
            *ret = TRUE;
        }
        return 1;
    }

    if (pcmk__strcase_any_of(s, PCMK_VALUE_FALSE, PCMK_VALUE_OFF, "no", "n",
                             "0", NULL)) {
        if (ret != NULL) {
            *ret = FALSE;
        }
        return 1;
    }
    return -1;
}

char *
crm_strdup_printf(char const *format, ...)
{
    va_list ap;
    int len = 0;
    char *string = NULL;

    va_start(ap, format);
    len = vasprintf(&string, format, ap);
    pcmk__assert(len > 0);
    va_end(ap);
    return string;
}

// LCOV_EXCL_STOP
// End deprecated API

Coverage Report

Created: 2026-08-14 06:23