/******************************************************************************

 *

 * Project:  GDAL

 * Purpose:  CPLString implementation.

 * Author:   Frank Warmerdam, warmerdam@pobox.com

 *

 ******************************************************************************

 * Copyright (c) 2005, Frank Warmerdam <warmerdam@pobox.com>

 * Copyright (c) 2011, Even Rouault <even dot rouault at spatialys.com>

 *

 * SPDX-License-Identifier: MIT

 ****************************************************************************/

#include "cpl_port.h"

#include "cpl_string.h"

#include <cctype>

#include <cstdarg>

#include <cstddef>

#include <cstring>

#include <string>

#include "cpl_config.h"

#include "cpl_conv.h"

#if !defined(va_copy) && defined(__va_copy)

#define va_copy __va_copy

#endif

/*

 * The CPLString class is derived from std::string, so the vast majority

 * of the implementation comes from that.  This module is just the extensions

 * we add.

 */

/************************************************************************/

/*                               Printf()                               */

/************************************************************************/

/** Assign the content of the string using sprintf() */

CPLString &CPLString::Printf(CPL_FORMAT_STRING(const char *pszFormat), ...)

{

    va_list args;

    va_start(args, pszFormat);

    vPrintf(pszFormat, args);

    va_end(args);

    return *this;

}

/************************************************************************/

/*                              vPrintf()                               */

/************************************************************************/

/** Assign the content of the string using vsprintf() */

CPLString &CPLString::vPrintf(CPL_FORMAT_STRING(const char *pszFormat),

                              va_list args)

{

    /* -------------------------------------------------------------------- */

    /*      This implementation for platforms without vsnprintf() will      */

    /*      just plain fail if the formatted contents are too large.        */

    /* -------------------------------------------------------------------- */

#if !defined(HAVE_VSNPRINTF)

    char *pszBuffer = static_cast<char *>(CPLMalloc(30000));

    if (CPLvsnprintf(pszBuffer, 30000, pszFormat, args) > 29998)

    {

        CPLError(CE_Fatal, CPLE_AppDefined,

                 "CPLString::vPrintf() ... buffer overrun.");

    }

    *this = pszBuffer;

    CPLFree(pszBuffer);

/* -------------------------------------------------------------------- */

/*      This should grow a big enough buffer to hold any formatted      */

/*      result.                                                         */

/* -------------------------------------------------------------------- */

#else

    va_list wrk_args;

#ifdef va_copy

    va_copy(wrk_args, args);

#else

    wrk_args = args;

#endif

    char szModestBuffer[500] = {};

    szModestBuffer[0] = '\0';

    int nPR = CPLvsnprintf(szModestBuffer, sizeof(szModestBuffer), pszFormat,

                           wrk_args);

    if (nPR == -1 || nPR >= static_cast<int>(sizeof(szModestBuffer)) - 1)

    {

        int nWorkBufferSize = 2000;

        char *pszWorkBuffer = static_cast<char *>(CPLMalloc(nWorkBufferSize));

#ifdef va_copy

        va_end(wrk_args);

        va_copy(wrk_args, args);

#else

        wrk_args = args;

#endif

        while ((nPR = CPLvsnprintf(pszWorkBuffer, nWorkBufferSize, pszFormat,

                                   wrk_args)) >= nWorkBufferSize - 1 ||

               nPR == -1)

        {

            nWorkBufferSize *= 4;

            pszWorkBuffer =

                static_cast<char *>(CPLRealloc(pszWorkBuffer, nWorkBufferSize));

#ifdef va_copy

            va_end(wrk_args);

            va_copy(wrk_args, args);

#else

            wrk_args = args;

#endif

        }

        *this = pszWorkBuffer;

        CPLFree(pszWorkBuffer);

    }

    else

    {

        *this = szModestBuffer;

    }

#ifdef va_copy

    va_end(wrk_args);

#endif

#endif /* !defined(HAVE_VSNPRINTF) */

    return *this;

}

/************************************************************************/

/*                              FormatC()                               */

/************************************************************************/

/**

 * Format double in C locale.

 *

 * The passed value is formatted using the C locale (period as decimal

 * separator) and appended to the target CPLString.

 *

 * @param dfValue the value to format.

 * @param pszFormat the sprintf() style format to use or omit for default.

 * Note that this format string should only include one substitution argument

 * and it must be for a double (%f or %g).

 *

 * @return a reference to the CPLString.

 */

CPLString &CPLString::FormatC(double dfValue, const char *pszFormat)

{

    if (pszFormat == nullptr)

        pszFormat = "%g";

    // presumably long enough for any number.

    const size_t buf_size = 512;

    char szWork[buf_size] = {};

    CPLsnprintf(szWork, buf_size, pszFormat, dfValue);

    *this += szWork;

    return *this;

}

/************************************************************************/

/*                                Trim()                                */

/************************************************************************/

/**

 * Trim white space.

 *

 * Trims white space off the let and right of the string.  White space

 * is any of a space, a tab, a newline ('\\n') or a carriage control ('\\r').

 *

 * @return a reference to the CPLString.

 */

CPLString &CPLString::Trim()

{

    constexpr char szWhitespace[] = " \t\r\n";

    const size_t iLeft = find_first_not_of(szWhitespace);

    const size_t iRight = find_last_not_of(szWhitespace);

    if (iLeft == std::string::npos)

    {

        erase();

        return *this;

    }

    assign(substr(iLeft, iRight - iLeft + 1));

    return *this;

}

/************************************************************************/

/*                               Recode()                               */

/************************************************************************/

/** Recode the string */

CPLString &CPLString::Recode(const char *pszSrcEncoding,

                             const char *pszDstEncoding)

{

    if (pszSrcEncoding == nullptr)

        pszSrcEncoding = CPL_ENC_UTF8;

    if (pszDstEncoding == nullptr)

        pszDstEncoding = CPL_ENC_UTF8;

    if (strcmp(pszSrcEncoding, pszDstEncoding) == 0)

        return *this;

    char *pszRecoded = CPLRecode(c_str(), pszSrcEncoding, pszDstEncoding);

    if (pszRecoded == nullptr)

        return *this;

    assign(pszRecoded);

    CPLFree(pszRecoded);

    return *this;

}

/************************************************************************/

/*                               ifind()                                */

/************************************************************************/

/**

 * Case insensitive find() alternative.

 *

 * @param str substring to find.

 * @param pos offset in the string at which the search starts.

 * @return the position of substring in the string or std::string::npos if not

 * found.

 */

size_t CPLString::ifind(const std::string &str, size_t pos) const

{

    return ifind(str.c_str(), pos);

}

/**

 * Case insensitive find() alternative.

 *

 * @param s substring to find.

 * @param nPos offset in the string at which the search starts.

 * @return the position of the substring in the string or std::string::npos if

 * not found.

 */

size_t CPLString::ifind(const char *s, size_t nPos) const

{

    const char *pszHaystack = c_str();

    const char chFirst =

        static_cast<char>(CPLTolower(static_cast<unsigned char>(s[0])));

    const size_t nTargetLen = strlen(s);

    if (nPos > size())

        nPos = size();

    pszHaystack += nPos;

    while (*pszHaystack != '\0')

    {

        if (chFirst == CPLTolower(static_cast<unsigned char>(*pszHaystack)))

        {

            if (EQUALN(pszHaystack, s, nTargetLen))

                return nPos;

        }

        nPos++;

        pszHaystack++;

    }

    return std::string::npos;

}

/************************************************************************/

/*                              toupper()                               */

/************************************************************************/

/**

 * Convert to upper case in place.

 */

CPLString &CPLString::toupper()

{

    for (size_t i = 0; i < size(); i++)

        (*this)[i] = static_cast<char>(CPLToupper((*this)[i]));

    return *this;

}

/************************************************************************/

/*                              tolower()                               */

/************************************************************************/

/**

 * Convert to lower case in place.

 */

CPLString &CPLString::tolower()

{

    for (size_t i = 0; i < size(); i++)

        (*this)[i] = static_cast<char>(CPLTolower((*this)[i]));

    return *this;

}

/************************************************************************/

/*                             replaceAll()                             */

/************************************************************************/

/**

 * Replace all occurrences of osBefore with osAfter.

 */

CPLString &CPLString::replaceAll(const std::string &osBefore,

                                 const std::string &osAfter)

{

    const size_t nBeforeSize = osBefore.size();

    const size_t nAfterSize = osAfter.size();

    if (nBeforeSize)

    {

        size_t nStartPos = 0;

        while ((nStartPos = find(osBefore, nStartPos)) != std::string::npos)

        {

            replace(nStartPos, nBeforeSize, osAfter);

            nStartPos += nAfterSize;

        }

    }

    return *this;

}

/**

 * Replace all occurrences of chBefore with osAfter.

 */

CPLString &CPLString::replaceAll(char chBefore, const std::string &osAfter)

{

    return replaceAll(std::string(&chBefore, 1), osAfter);

}

/**

 * Replace all occurrences of osBefore with chAfter.

 */

CPLString &CPLString::replaceAll(const std::string &osBefore, char chAfter)

{

    return replaceAll(osBefore, std::string(&chAfter, 1));

}

/**

 * Replace all occurrences of chBefore with chAfter.

 */

CPLString &CPLString::replaceAll(char chBefore, char chAfter)

{

    return replaceAll(std::string(&chBefore, 1), std::string(&chAfter, 1));

}

/************************************************************************/

/*                              endsWith()                              */

/************************************************************************/

/**

 * Returns whether the string ends with another string

 * @param osStr other string.

 * @return true if the string ends with osStr.

 */

bool CPLString::endsWith(const std::string &osStr) const

{

    if (size() < osStr.size())

        return false;

    return substr(size() - osStr.size()) == osStr;

}

/************************************************************************/

/*                             URLEncode()                              */

/************************************************************************/

/**

 * Return a string that *can* be a valid URL.

 *

 * Said otherwise if URLEncode() != *this was not a valid URL according to

 * https://datatracker.ietf.org/doc/html/rfc3986.html.

 *

 * This replaces all characters that are not reserved (:/?#[]\@!$&'()*+,;=),

 * unreserved (a-z, A-Z, 0-9 and -.-~) or already percent-encoded by their

 * percent-encoding.

 *

 * Note that when composing a URL, and typically query-parameters, it might

 * be needed to use CPLEscape(,,CPLES_URL) to also substitute reserved

 * characters.

 *

 * @return a URL encoded string

 * @since 3.12

 */

CPLString CPLString::URLEncode() const

{

    // Helper to check if a substring is a valid percent-encoding

    auto isPercentEncoded = [](const char *str) -> bool

    {

        return str[0] == '%' &&

               std::isxdigit(static_cast<unsigned char>(str[1])) &&

               std::isxdigit(static_cast<unsigned char>(str[2]));

    };

    // Cf https://datatracker.ietf.org/doc/html/rfc3986.html

    const char *unreserved =

        "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~";

    const char *reserved = ":/?#[]@!$&'()*+,;=";

    CPLString osEncoded;

    osEncoded.reserve(size());

    for (size_t i = 0; i < size(); ++i)

    {

        char ch = (*this)[i];

        // If already percent-encoded, copy as is

        if (ch == '%' && i + 2 < size() && isPercentEncoded(c_str() + i))

        {

            osEncoded += ch;

            osEncoded += (*this)[i + 1];

            osEncoded += (*this)[i + 2];

            i += 2;

        }

        else if (strchr(unreserved, ch) || strchr(reserved, ch))

        {

            osEncoded += ch;

        }

        else

        {

            char buf[4];

            snprintf(buf, sizeof(buf), "%%%02X",

                     static_cast<unsigned char>(ch));

            osEncoded += buf;

        }

    }

    return osEncoded;

}

/************************************************************************/

/*                        SQLQuotedIdentifier()                         */

/************************************************************************/

/** Returns a string between double quotes and with all double quotes

 * inside the string are escaped by being doubled.

 *

 * Aimed at being used for SQL identifiers (table names, column names, etc.).

 *

 * @since 3.13

 */

CPLString CPLString::SQLQuotedIdentifier() const

{

    CPLString ret("\"");

    CPLString tmp(*this);

    tmp.replaceAll('"', "\"\"");

    ret += tmp;

    ret += '"';

    return ret;

}

/************************************************************************/

/*                          SQLQuotedLiteral()                          */

/************************************************************************/

/** Returns a string between single quotes and with all single quotes

 * inside the string are escaped by being doubled.

 *

 * Aimed at being used for SQL literal strings.

 *

 * @since 3.13

 */

CPLString CPLString::SQLQuotedLiteral() const

{

    CPLString ret("'");

    CPLString tmp(*this);

    tmp.replaceAll('\'', "''");

    ret += tmp;

    ret += '\'';

    return ret;

}

/************************************************************************/

/*                           CPLURLGetValue()                           */

/************************************************************************/

/**

 * Return the value matching a key from a key=value pair in a URL.

 *

 * @param pszURL the URL.

 * @param pszKey the key to find.

 * @return the value of empty string if not found.

 */

CPLString CPLURLGetValue(const char *pszURL, const char *pszKey)

{

    CPLString osKey(pszKey);

    osKey += "=";

    size_t nKeyPos = CPLString(pszURL).ifind(osKey);

    if (nKeyPos != std::string::npos && nKeyPos > 0 &&

        (pszURL[nKeyPos - 1] == '?' || pszURL[nKeyPos - 1] == '&'))

    {

        CPLString osValue(pszURL + nKeyPos + osKey.size());

        const char *pszValue = osValue.c_str();

        const char *pszSep = strchr(pszValue, '&');

        if (pszSep)

        {

            osValue.resize(pszSep - pszValue);

        }

        return osValue;

    }

    return "";

}

/************************************************************************/

/*                            CPLURLAddKVP()                            */

/************************************************************************/

/**

 * Return a new URL with a new key=value pair.

 *

 * @param pszURL the URL.

 * @param pszKey the key to find.

 * @param pszValue the value of the key (may be NULL to unset an existing KVP).

 * @return the modified URL.

 */

CPLString CPLURLAddKVP(const char *pszURL, const char *pszKey,

                       const char *pszValue)

{

    CPLString osURL(strchr(pszURL, '?') == nullptr

                        ? CPLString(pszURL).append("?")

                        : pszURL);

    CPLString osKey(pszKey);

    osKey += "=";

    size_t nKeyPos = osURL.ifind(osKey);

    if (nKeyPos != std::string::npos && nKeyPos > 0 &&

        (osURL[nKeyPos - 1] == '?' || osURL[nKeyPos - 1] == '&'))

    {

        CPLString osNewURL(osURL);

        osNewURL.resize(nKeyPos);

        if (pszValue)

        {

            osNewURL += osKey;

            osNewURL += pszValue;

        }

        const char *pszNext = strchr(osURL.c_str() + nKeyPos, '&');

        if (pszNext)

        {

            if (osNewURL.back() == '&' || osNewURL.back() == '?')

                osNewURL += pszNext + 1;

            else

                osNewURL += pszNext;

        }

        return osNewURL;

    }

    else

    {

        CPLString osNewURL(std::move(osURL));

        if (pszValue)

        {

            if (osNewURL.back() != '&' && osNewURL.back() != '?')

                osNewURL += '&';

            osNewURL += osKey;

            osNewURL += pszValue;

        }

        return osNewURL;

    }

}

/************************************************************************/

/*                             CPLOPrintf()                             */

/************************************************************************/

/** Return a CPLString with the content of sprintf() */

CPLString CPLOPrintf(CPL_FORMAT_STRING(const char *pszFormat), ...)

{

    va_list args;

    va_start(args, pszFormat);

    CPLString osTarget;

    osTarget.vPrintf(pszFormat, args);

    va_end(args);

    return osTarget;

}

/************************************************************************/

/*                            CPLOvPrintf()                             */

/************************************************************************/

/** Return a CPLString with the content of vsprintf() */

CPLString CPLOvPrintf(CPL_FORMAT_STRING(const char *pszFormat), va_list args)

{

    CPLString osTarget;

    osTarget.vPrintf(pszFormat, args);

    return osTarget;

}

/************************************************************************/

/*                       CPLQuotedSQLIdentifer()                        */

/************************************************************************/

/** Return a CPLString of the SQL quoted identifier */

CPLString CPLQuotedSQLIdentifier(const char *pszIdent)

{

    CPLString osIdent;

    if (pszIdent)

    {

        char *pszQuotedIdent = CPLEscapeString(pszIdent, -1, CPLES_SQLI);

        osIdent.Printf("\"%s\"", pszQuotedIdent);

        CPLFree(pszQuotedIdent);

    }

    return osIdent;

}