#include "libpq-fe.h"
#include "pqexpbuffer.h"

Include dependency graph for string_utils.h:

This graph shows which files directly or indirectly include this file:

Functions
const char *	fmtId (const char *rawid)

const char *	fmtIdEnc (const char *rawid, int encoding)

const char *	fmtQualifiedId (const char schema, const char id)

const char *	fmtQualifiedIdEnc (const char schema, const char id, int encoding)

void	setFmtEncoding (int encoding)

char *	formatPGVersionNumber (int version_number, bool include_minor, char *buf, size_t buflen)

void	appendStringLiteral (PQExpBuffer buf, const char *str, int encoding, bool std_strings)

void	appendStringLiteralConn (PQExpBuffer buf, const char str, PGconn conn)

void	appendStringLiteralDQ (PQExpBuffer buf, const char str, const char dqprefix)

void	appendByteaLiteral (PQExpBuffer buf, const unsigned char *str, size_t length, bool std_strings)

void	appendShellString (PQExpBuffer buf, const char *str)

bool	appendShellStringNoError (PQExpBuffer buf, const char *str)

void	appendConnStrVal (PQExpBuffer buf, const char *str)

void	appendPsqlMetaConnect (PQExpBuffer buf, const char *dbname)

bool	parsePGArray (const char atext, char *itemarray, int nitems)

void	appendPGArray (PQExpBuffer buffer, const char *value)

bool	appendReloptionsArray (PQExpBuffer buffer, const char reloptions, const char prefix, int encoding, bool std_strings)

bool	processSQLNamePattern (PGconn conn, PQExpBuffer buf, const char pattern, bool have_where, bool force_escape, const char schemavar, const char namevar, const char altnamevar, const char visibilityrule, PQExpBuffer dbnamebuf, int *dotcnt)

void	patternToSQLRegex (int encoding, PQExpBuffer dbnamebuf, PQExpBuffer schemabuf, PQExpBuffer namebuf, const char pattern, bool force_escape, bool want_literal_dbname, int dotcnt)

Variables
PGDLLIMPORT int	quote_all_identifiers

PQExpBuffer(*	getLocalPQExpBuffer )(void)

Function Documentation

◆ appendByteaLiteral()

void appendByteaLiteral	(	PQExpBuffer	buf,
		const unsigned char *	str,
		size_t	length,
		bool	std_strings
	)

extern

Definition at line 527 of file string_utils.c.

{
    const unsigned char *source = str;
    char       *target;
 
    static const char hextbl[] = "0123456789abcdef";
 
    /*
     * This implementation is hard-wired to produce hex-format output. We do
     * not know the server version the output will be loaded into, so making
     * an intelligent format choice is impossible.  It might be better to
     * always use the old escaped format.
     */
    if (!enlargePQExpBuffer(buf, 2 * length + 5))
        return;
 
    target = buf->data + buf->len;
    *target++ = '\'';
    if (!std_strings)
        *target++ = '\\';
    *target++ = '\\';
    *target++ = 'x';
 
    while (length-- > 0)
    {
        unsigned char c = *source++;
 
        *target++ = hextbl[(c >> 4) & 0xF];
        *target++ = hextbl[c & 0xF];
    }
 
    /* Write the terminating quote and NUL character. */
    *target++ = '\'';
    *target = '\0';
 
    buf->len = target - buf->data;
}

References buf, enlargePQExpBuffer(), hextbl, source, and str.

◆ appendConnStrVal()

void appendConnStrVal	(	PQExpBuffer	buf,
		const char *	str
	)

extern

Definition at line 692 of file string_utils.c.

{
    const char *s;
    bool        needquotes;
 
    /*
     * If the string is one or more plain ASCII characters, no need to quote
     * it. This is quite conservative, but better safe than sorry.
     */
    needquotes = true;
    for (s = str; *s; s++)
    {
        if (!((*s >= 'a' && *s <= 'z') || (*s >= 'A' && *s <= 'Z') ||
              (*s >= '0' && *s <= '9') || *s == '_' || *s == '.'))
        {
            needquotes = true;
            break;
        }
        needquotes = false;
    }
 
    if (needquotes)
    {
        appendPQExpBufferChar(buf, '\'');
        while (*str)
        {
            /* ' and \ must be escaped by to \' and \\ */
            if (*str == '\'' || *str == '\\')
                appendPQExpBufferChar(buf, '\\');
 
            appendPQExpBufferChar(buf, *str);
            str++;
        }
        appendPQExpBufferChar(buf, '\'');
    }
    else
        appendPQExpBufferStr(buf, str);
}

References appendPQExpBufferChar(), appendPQExpBufferStr(), buf, fb(), and str.

Referenced by appendConnStrItem(), appendPsqlMetaConnect(), constructConnStr(), generate_old_dump(), GenerateRecoveryConfig(), get_db_conn(), runPgDump(), and start_conn().

◆ appendPGArray()

void appendPGArray	(	PQExpBuffer	buffer,
		const char *	value
	)

extern

Definition at line 896 of file string_utils.c.

{
    bool        needquote;
    const char *tmp;
 
    if (buffer->data[buffer->len - 1] != '{')
        appendPQExpBufferChar(buffer, ',');
 
    /* Decide if we need quotes; this should match array_out()'s choices. */
    if (value[0] == '\0')
        needquote = true;       /* force quotes for empty string */
    else if (pg_strcasecmp(value, "NULL") == 0)
        needquote = true;       /* force quotes for literal NULL */
    else
        needquote = false;
 
    if (!needquote)
    {
        for (tmp = value; *tmp; tmp++)
        {
            char        ch = *tmp;
 
            if (ch == '"' || ch == '\\' ||
                ch == '{' || ch == '}' || ch == ',' ||
            /* these match scanner_isspace(): */
                ch == ' ' || ch == '\t' || ch == '\n' ||
                ch == '\r' || ch == '\v' || ch == '\f')
            {
                needquote = true;
                break;
            }
        }
    }
 
    if (needquote)
    {
        appendPQExpBufferChar(buffer, '"');
        for (tmp = value; *tmp; tmp++)
        {
            char        ch = *tmp;
 
            if (ch == '"' || ch == '\\')
                appendPQExpBufferChar(buffer, '\\');
            appendPQExpBufferChar(buffer, ch);
        }
        appendPQExpBufferChar(buffer, '"');
    }
    else
        appendPQExpBufferStr(buffer, value);
}

References appendPQExpBufferChar(), appendPQExpBufferStr(), PQExpBufferData::data, fb(), PQExpBufferData::len, pg_strcasecmp(), and value.

Referenced by fetchAttributeStats(), and getNamespaces().

◆ appendPsqlMetaConnect()

void appendPsqlMetaConnect	(	PQExpBuffer	buf,
		const char *	dbname
	)

extern

Definition at line 737 of file string_utils.c.

{
    const char *s;
    bool complex;
 
    /*
     * If the name is plain ASCII characters, emit a trivial "\connect "foo"".
     * For other names, even many not technically requiring it, skip to the
     * general case.  No database has a zero-length name.
     */
    complex = false;
 
    for (s = dbname; *s; s++)
    {
        if (*s == '\n' || *s == '\r')
        {
            fprintf(stderr,
                    _("database name contains a newline or carriage return: \"%s\"\n"),
                    dbname);
            exit(EXIT_FAILURE);
        }
 
        if (!((*s >= 'a' && *s <= 'z') || (*s >= 'A' && *s <= 'Z') ||
              (*s >= '0' && *s <= '9') || *s == '_' || *s == '.'))
        {
            complex = true;
        }
    }
 
    if (complex)
    {
        PQExpBufferData connstr;
 
        initPQExpBuffer(&connstr);
 
        /*
         * Force the target psql's encoding to SQL_ASCII.  We don't really
         * know the encoding of the database name, and it doesn't matter as
         * long as psql will forward it to the server unchanged.
         */
        appendPQExpBufferStr(buf, "\\encoding SQL_ASCII\n");
        appendPQExpBufferStr(buf, "\\connect -reuse-previous=on ");
 
        appendPQExpBufferStr(&connstr, "dbname=");
        appendConnStrVal(&connstr, dbname);
 
        /*
         * As long as the name does not contain a newline, SQL identifier
         * quoting satisfies the psql meta-command parser.  Prefer not to
         * involve psql-interpreted single quotes, which behaved differently
         * before PostgreSQL 9.2.
         */
        appendPQExpBufferStr(buf, fmtIdEnc(connstr.data, PG_SQL_ASCII));
 
        termPQExpBuffer(&connstr);
    }
    else
    {
        appendPQExpBufferStr(buf, "\\connect ");
        appendPQExpBufferStr(buf, fmtIdEnc(dbname, PG_SQL_ASCII));
    }
    appendPQExpBufferChar(buf, '\n');
}

References _, appendConnStrVal(), appendPQExpBufferChar(), appendPQExpBufferStr(), buf, connstr, dbname, EXIT_FAILURE, fb(), fmtIdEnc(), fprintf, initPQExpBuffer(), PG_SQL_ASCII, and termPQExpBuffer().

Referenced by _reconnectToDB(), old_9_6_invalidate_hash_indexes(), and process_extension_updates().

◆ appendReloptionsArray()

bool appendReloptionsArray	(	PQExpBuffer	buffer,
		const char *	reloptions,
		const char *	prefix,
		int	encoding,
		bool	std_strings
	)

extern

Definition at line 960 of file string_utils.c.

{
    char      **options;
    int         noptions;
    int         i;
 
    if (!parsePGArray(reloptions, &options, &noptions))
    {
        free(options);
        return false;
    }
 
    for (i = 0; i < noptions; i++)
    {
        char       *option = options[i];
        char       *name;
        char       *separator;
        char       *value;
 
        /*
         * Each array element should have the form name=value.  If the "=" is
         * missing for some reason, treat it like an empty value.
         */
        name = option;
        separator = strchr(option, '=');
        if (separator)
        {
            *separator = '\0';
            value = separator + 1;
        }
        else
            value = "";
 
        if (i > 0)
            appendPQExpBufferStr(buffer, ", ");
        appendPQExpBuffer(buffer, "%s%s=", prefix, fmtId(name));
 
        /*
         * In general we need to quote the value; but to avoid unnecessary
         * clutter, do not quote if it is an identifier that would not need
         * quoting.  (We could also allow numbers, but that is a bit trickier
         * than it looks --- for example, are leading zeroes significant?  We
         * don't want to assume very much here about what custom reloptions
         * might mean.)
         */
        if (strcmp(fmtId(value), value) == 0)
            appendPQExpBufferStr(buffer, value);
        else
            appendStringLiteral(buffer, value, encoding, std_strings);
    }
 
    free(options);
 
    return true;
}

References appendPQExpBuffer(), appendPQExpBufferStr(), appendStringLiteral(), encoding, fb(), fmtId(), free, i, name, noptions, parsePGArray(), and value.

Referenced by appendReloptionsArrayAH(), and get_create_object_cmd().

◆ appendShellString()

void appendShellString	(	PQExpBuffer	buf,
		const char *	str
	)

extern

Definition at line 576 of file string_utils.c.

{
    if (!appendShellStringNoError(buf, str))
    {
        fprintf(stderr,
                _("shell command argument contains a newline or carriage return: \"%s\"\n"),
                str);
        exit(EXIT_FAILURE);
    }
}

References _, appendShellStringNoError(), buf, EXIT_FAILURE, fb(), fprintf, and str.

Referenced by cluster_conn_opts(), ensureCleanShutdown(), generate_old_dump(), getRestoreCommand(), main(), output_completion_banner(), runPgDump(), start_standby_server(), and test_specific_config_settings().

◆ appendShellStringNoError()

bool appendShellStringNoError	(	PQExpBuffer	buf,
		const char *	str
	)

extern

Definition at line 588 of file string_utils.c.

{
#ifdef WIN32
    int         backslash_run_length = 0;
#endif
    bool        ok = true;
    const char *p;
 
    /*
     * Don't bother with adding quotes if the string is nonempty and clearly
     * contains only safe characters.
     */
    if (*str != '\0' &&
        strspn(str, "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_./:") == strlen(str))
    {
        appendPQExpBufferStr(buf, str);
        return ok;
    }
 
#ifndef WIN32
    appendPQExpBufferChar(buf, '\'');
    for (p = str; *p; p++)
    {
        if (*p == '\n' || *p == '\r')
        {
            ok = false;
            continue;
        }
 
        if (*p == '\'')
            appendPQExpBufferStr(buf, "'\"'\"'");
        else
            appendPQExpBufferChar(buf, *p);
    }
    appendPQExpBufferChar(buf, '\'');
#else                           /* WIN32 */
 
    /*
     * A Windows system() argument experiences two layers of interpretation.
     * First, cmd.exe interprets the string.  Its behavior is undocumented,
     * but a caret escapes any byte except LF or CR that would otherwise have
     * special meaning.  Handling of a caret before LF or CR differs between
     * "cmd.exe /c" and other modes, and it is unusable here.
     *
     * Second, the new process parses its command line to construct argv (see
     * https://msdn.microsoft.com/en-us/library/17w5ykft.aspx).  This treats
     * backslash-double quote sequences specially.
     */
    appendPQExpBufferStr(buf, "^\"");
    for (p = str; *p; p++)
    {
        if (*p == '\n' || *p == '\r')
        {
            ok = false;
            continue;
        }
 
        /* Change N backslashes before a double quote to 2N+1 backslashes. */
        if (*p == '"')
        {
            while (backslash_run_length)
            {
                appendPQExpBufferStr(buf, "^\\");
                backslash_run_length--;
            }
            appendPQExpBufferStr(buf, "^\\");
        }
        else if (*p == '\\')
            backslash_run_length++;
        else
            backslash_run_length = 0;
 
        /*
         * Decline to caret-escape the most mundane characters, to ease
         * debugging and lest we approach the command length limit.
         */
        if (!((*p >= 'a' && *p <= 'z') ||
              (*p >= 'A' && *p <= 'Z') ||
              (*p >= '0' && *p <= '9')))
            appendPQExpBufferChar(buf, '^');
        appendPQExpBufferChar(buf, *p);
    }
 
    /*
     * Change N backslashes at end of argument to 2N backslashes, because they
     * precede the double quote that terminates the argument.
     */
    while (backslash_run_length)
    {
        appendPQExpBufferStr(buf, "^\\");
        backslash_run_length--;
    }
    appendPQExpBufferStr(buf, "^\"");
#endif                          /* WIN32 */
 
    return ok;
}

References appendPQExpBufferChar(), appendPQExpBufferStr(), buf, fb(), and str.

Referenced by appendShellString(), and psql_get_variable().

◆ appendStringLiteral()

void appendStringLiteral	(	PQExpBuffer	buf,
		const char *	str,
		int	encoding,
		bool	std_strings
	)

extern

Definition at line 351 of file string_utils.c.

{
    size_t      length = strlen(str);
    const char *source = str;
    char       *target;
    size_t      remaining = length;
 
    if (!enlargePQExpBuffer(buf, 2 * length + 2))
        return;
 
    target = buf->data + buf->len;
    *target++ = '\'';
 
    while (remaining > 0)
    {
        char        c = *source;
        int         charlen;
        int         i;
 
        /* Fast path for plain ASCII */
        if (!IS_HIGHBIT_SET(c))
        {
            /* Apply quoting if needed */
            if (SQL_STR_DOUBLE(c, !std_strings))
                *target++ = c;
            /* Copy the character */
            *target++ = c;
            source++;
            remaining--;
            continue;
        }
 
        /* Slow path for possible multibyte characters */
        charlen = PQmblen(source, encoding);
 
        if (remaining < charlen ||
            pg_encoding_verifymbchar(encoding, source, charlen) == -1)
        {
            /*
             * Multibyte character is invalid.  It's important to verify that
             * as invalid multibyte characters could e.g. be used to "skip"
             * over quote characters, e.g. when parsing
             * character-by-character.
             *
             * Replace the character's first byte with an invalid sequence.
             * The invalid sequence ensures that the escaped string will
             * trigger an error on the server-side, even if we can't directly
             * report an error here.
             *
             * We know there's enough space for the invalid sequence because
             * the "target" buffer is 2 * length + 2 long, and at worst we're
             * replacing a single input byte with two invalid bytes.
             *
             * It would be a bit faster to verify the whole string the first
             * time we encounter a set highbit, but this way we can replace
             * just the invalid data, which probably makes it easier for users
             * to find the invalidly encoded portion of a larger string.
             */
            pg_encoding_set_invalid(encoding, target);
            target += 2;
 
            /*
             * Handle the following bytes as if this byte didn't exist. That's
             * safer in case the subsequent bytes contain important characters
             * for the caller (e.g. '>' in html).
             */
            source++;
            remaining--;
        }
        else
        {
            /* Copy the character */
            for (i = 0; i < charlen; i++)
            {
                *target++ = *source++;
                remaining--;
            }
        }
    }
 
    /* Write the terminating quote and NUL character. */
    *target++ = '\'';
    *target = '\0';
 
    buf->len = target - buf->data;
}

References buf, encoding, enlargePQExpBuffer(), fb(), i, IS_HIGHBIT_SET, pg_encoding_set_invalid(), pg_encoding_verifymbchar(), PQmblen(), remaining, source, SQL_STR_DOUBLE, and str.

Referenced by appendReloptionsArray(), appendStringLiteralConn(), and escape_append_literal().

◆ appendStringLiteralConn()

void appendStringLiteralConn	(	PQExpBuffer	buf,
		const char *	str,
		PGconn *	conn
	)

extern

Definition at line 446 of file string_utils.c.

{
    size_t      length = strlen(str);
 
    /*
     * XXX This is a kluge to silence escape_string_warning in our utility
     * programs.  It can go away once pre-v19 servers are out of support.
     */
    if (strchr(str, '\\') != NULL && PQserverVersion(conn) < 190000)
    {
        /* ensure we are not adjacent to an identifier */
        if (buf->len > 0 && buf->data[buf->len - 1] != ' ')
            appendPQExpBufferChar(buf, ' ');
        appendPQExpBufferChar(buf, ESCAPE_STRING_SYNTAX);
        appendStringLiteral(buf, str, PQclientEncoding(conn), false);
        return;
    }
    /* XXX end kluge */
 
    if (!enlargePQExpBuffer(buf, 2 * length + 2))
        return;
    appendPQExpBufferChar(buf, '\'');
    buf->len += PQescapeStringConn(conn, buf->data + buf->len,
                                   str, length, NULL);
    appendPQExpBufferChar(buf, '\'');
}

References appendPQExpBufferChar(), appendStringLiteral(), buf, conn, enlargePQExpBuffer(), ESCAPE_STRING_SYNTAX, fb(), PQclientEncoding(), PQescapeStringConn(), PQserverVersion(), and str.

Referenced by append_db_pattern_cte(), append_rel_pattern_filtered_cte(), append_rel_pattern_raw_cte(), appendQualifiedRelation(), create_logical_replication_slots(), dumpRoles(), dumpTablespaces(), dumpUserConfig(), emitShSecLabels(), get_dbnames_list_to_restore(), get_parallel_tables_list(), getTables(), lookup_object_oid(), main(), makeAlterConfigCommand(), processSQLNamePattern(), retrieve_objects(), and setup_connection().

◆ appendStringLiteralDQ()

void appendStringLiteralDQ	(	PQExpBuffer	buf,
		const char *	str,
		const char *	dqprefix
	)

extern

Definition at line 484 of file string_utils.c.

{
    static const char suffixes[] = "_XXXXXXX";
    int         nextchar = 0;
    PQExpBuffer delimBuf = createPQExpBuffer();
 
    /* start with $ + dqprefix if not NULL */
    appendPQExpBufferChar(delimBuf, '$');
    if (dqprefix)
        appendPQExpBufferStr(delimBuf, dqprefix);
 
    /*
     * Make sure we choose a delimiter which (without the trailing $) is not
     * present in the string being quoted. We don't check with the trailing $
     * because a string ending in $foo must not be quoted with $foo$.
     */
    while (strstr(str, delimBuf->data) != NULL)
    {
        appendPQExpBufferChar(delimBuf, suffixes[nextchar++]);
        nextchar %= sizeof(suffixes) - 1;
    }
 
    /* add trailing $ */
    appendPQExpBufferChar(delimBuf, '$');
 
    /* quote it and we are all done */
    appendPQExpBufferStr(buf, delimBuf->data);
    appendPQExpBufferStr(buf, str);
    appendPQExpBufferStr(buf, delimBuf->data);
 
    destroyPQExpBuffer(delimBuf);
}

References appendPQExpBufferChar(), appendPQExpBufferStr(), buf, createPQExpBuffer(), destroyPQExpBuffer(), fb(), and str.

Referenced by dumpFunc().

◆ fmtId()

const char * fmtId ( const char * rawid )

extern

Definition at line 248 of file string_utils.c.

{
    return fmtIdEnc(rawid, getFmtEncoding());
}

References fb(), fmtIdEnc(), and getFmtEncoding().

Referenced by _doSetFixedOutputState(), _getObjectDescription(), _printTableAccessMethodNoStorage(), _printTocEntry(), _selectOutputSchema(), _selectTableAccessMethod(), _selectTablespace(), append_depends_on_extension(), appendReloptionsArray(), binary_upgrade_extension_member(), buildACLCommands(), buildDefaultACLCommands(), createDummyViewAsClause(), describeOneTableDetails(), dropDBs(), dropRoles(), dropTablespaces(), dumpAccessMethod(), dumpAgg(), dumpAttrDef(), dumpBaseType(), dumpCast(), dumpCollation(), dumpCommentExtended(), dumpCompositeType(), dumpCompositeTypeColComments(), dumpConstraint(), dumpConversion(), dumpDatabase(), dumpDomain(), dumpEnumType(), dumpEventTrigger(), dumpExtension(), dumpForeignDataWrapper(), dumpForeignServer(), dumpFunc(), dumpIndex(), dumpNamespace(), dumpOpclass(), dumpOpfamily(), dumpOpr(), dumpPolicy(), dumpProcLang(), dumpPublication(), dumpPublicationNamespace(), dumpPublicationTable(), dumpRangeType(), dumpRoleGUCPrivs(), dumpRoleMembership(), dumpRoles(), dumpRule(), dumpSearchPath(), dumpSecLabel(), dumpSequence(), dumpStatisticsExt(), dumpSubscription(), dumpTable(), dumpTableComment(), dumpTableConstraintComment(), dumpTableData_insert(), dumpTableSchema(), dumpTableSecLabel(), dumpTablespaces(), dumpTransform(), dumpTrigger(), dumpTSConfig(), dumpTSDictionary(), dumpTSParser(), dumpTSTemplate(), dumpUndefinedType(), dumpUserConfig(), dumpUserMappings(), emitShSecLabels(), escape_fmt_id(), fmtCopyColumnList(), format_aggregate_signature(), format_function_arguments(), format_function_signature(), get_create_object_cmd(), get_language_name(), getFormattedOperatorName(), getPublicationTables(), main(), makeAlterConfigCommand(), and setup_connection().

◆ fmtIdEnc()

const char * fmtIdEnc	(	const char *	rawid,
		int	encoding
	)

extern

Definition at line 101 of file string_utils.c.

{
    PQExpBuffer id_return = getLocalPQExpBuffer();
 
    const char *cp;
    bool        need_quotes = false;
    size_t      remaining = strlen(rawid);
 
    /*
     * These checks need to match the identifier production in scan.l. Don't
     * use islower() etc.
     */
    if (quote_all_identifiers)
        need_quotes = true;
    /* slightly different rules for first character */
    else if (!((rawid[0] >= 'a' && rawid[0] <= 'z') || rawid[0] == '_'))
        need_quotes = true;
    else
    {
        /* otherwise check the entire string */
        cp = rawid;
        for (size_t i = 0; i < remaining; i++, cp++)
        {
            if (!((*cp >= 'a' && *cp <= 'z')
                  || (*cp >= '0' && *cp <= '9')
                  || (*cp == '_')))
            {
                need_quotes = true;
                break;
            }
        }
    }
 
    if (!need_quotes)
    {
        /*
         * Check for keyword.  We quote keywords except for unreserved ones.
         * (In some cases we could avoid quoting a col_name or type_func_name
         * keyword, but it seems much harder than it's worth to tell that.)
         *
         * Note: ScanKeywordLookup() does case-insensitive comparison, but
         * that's fine, since we already know we have all-lower-case.
         */
        int         kwnum = ScanKeywordLookup(rawid, &ScanKeywords);
 
        if (kwnum >= 0 && ScanKeywordCategories[kwnum] != UNRESERVED_KEYWORD)
            need_quotes = true;
    }
 
    if (!need_quotes)
    {
        /* no quoting needed */
        appendPQExpBufferStr(id_return, rawid);
    }
    else
    {
        appendPQExpBufferChar(id_return, '"');
 
        cp = &rawid[0];
        while (remaining > 0)
        {
            int         charlen;
 
            /* Fast path for plain ASCII */
            if (!IS_HIGHBIT_SET(*cp))
            {
                /*
                 * Did we find a double-quote in the string? Then make this a
                 * double double-quote per SQL99. Before, we put in a
                 * backslash/double-quote pair. - thomas 2000-08-05
                 */
                if (*cp == '"')
                    appendPQExpBufferChar(id_return, '"');
                appendPQExpBufferChar(id_return, *cp);
                remaining--;
                cp++;
                continue;
            }
 
            /* Slow path for possible multibyte characters */
            charlen = pg_encoding_mblen(encoding, cp);
 
            if (remaining < charlen ||
                pg_encoding_verifymbchar(encoding, cp, charlen) == -1)
            {
                /*
                 * Multibyte character is invalid.  It's important to verify
                 * that as invalid multibyte characters could e.g. be used to
                 * "skip" over quote characters, e.g. when parsing
                 * character-by-character.
                 *
                 * Replace the character's first byte with an invalid
                 * sequence. The invalid sequence ensures that the escaped
                 * string will trigger an error on the server-side, even if we
                 * can't directly report an error here.
                 *
                 * It would be a bit faster to verify the whole string the
                 * first time we encounter a set highbit, but this way we can
                 * replace just the invalid data, which probably makes it
                 * easier for users to find the invalidly encoded portion of a
                 * larger string.
                 */
                if (enlargePQExpBuffer(id_return, 2))
                {
                    pg_encoding_set_invalid(encoding,
                                            id_return->data + id_return->len);
                    id_return->len += 2;
                    id_return->data[id_return->len] = '\0';
                }
 
                /*
                 * Handle the following bytes as if this byte didn't exist.
                 * That's safer in case the subsequent bytes contain
                 * characters that are significant for the caller (e.g. '>' in
                 * html).
                 */
                remaining--;
                cp++;
            }
            else
            {
                for (int i = 0; i < charlen; i++)
                {
                    appendPQExpBufferChar(id_return, *cp);
                    remaining--;
                    cp++;
                }
            }
        }
 
        appendPQExpBufferChar(id_return, '"');
    }
 
    return id_return->data;
}

References appendPQExpBufferChar(), appendPQExpBufferStr(), encoding, enlargePQExpBuffer(), fb(), getLocalPQExpBuffer, i, IS_HIGHBIT_SET, pg_encoding_mblen(), pg_encoding_set_invalid(), pg_encoding_verifymbchar(), quote_all_identifiers, remaining, ScanKeywordCategories, ScanKeywordLookup(), ScanKeywords, and UNRESERVED_KEYWORD.

Referenced by appendPsqlMetaConnect(), fmtId(), fmtQualifiedIdEnc(), gen_reindex_command(), and main().

◆ fmtQualifiedId()

const char * fmtQualifiedId	(	const char *	schema,
		const char *	id
	)

extern

Definition at line 296 of file string_utils.c.

{
    return fmtQualifiedIdEnc(schema, id, getFmtEncoding());
}

References fmtQualifiedIdEnc(), and getFmtEncoding().

Referenced by _disableTriggersIfNecessary(), _enableTriggersIfNecessary(), _printTableAccessMethodNoStorage(), is_load_via_partition_root(), lockTableForWorker(), and restore_toc_entry().

◆ fmtQualifiedIdEnc()

const char * fmtQualifiedIdEnc	(	const char *	schema,
		const char *	id,
		int	encoding
	)

extern

Definition at line 263 of file string_utils.c.

{
    PQExpBuffer id_return;
    PQExpBuffer lcl_pqexp = createPQExpBuffer();
 
    /* Some callers might fail to provide a schema name */
    if (schema && *schema)
    {
        appendPQExpBuffer(lcl_pqexp, "%s.", fmtIdEnc(schema, encoding));
    }
    appendPQExpBufferStr(lcl_pqexp, fmtIdEnc(id, encoding));
 
    id_return = getLocalPQExpBuffer();
 
    appendPQExpBufferStr(id_return, lcl_pqexp->data);
    destroyPQExpBuffer(lcl_pqexp);
 
    return id_return->data;
}

References appendPQExpBuffer(), appendPQExpBufferStr(), createPQExpBuffer(), destroyPQExpBuffer(), encoding, fb(), fmtIdEnc(), and getLocalPQExpBuffer.

Referenced by appendQualifiedRelation(), fmtQualifiedId(), get_parallel_tabidx_list(), get_parallel_tables_list(), and retrieve_objects().

◆ formatPGVersionNumber()

char * formatPGVersionNumber	(	int	version_number,
		bool	include_minor,
		char *	buf,
		size_t	buflen
	)

extern

Definition at line 313 of file string_utils.c.

{
    if (version_number >= 100000)
    {
        /* New two-part style */
        if (include_minor)
            snprintf(buf, buflen, "%d.%d", version_number / 10000,
                     version_number % 10000);
        else
            snprintf(buf, buflen, "%d", version_number / 10000);
    }
    else
    {
        /* Old three-part style */
        if (include_minor)
            snprintf(buf, buflen, "%d.%d.%d", version_number / 10000,
                     (version_number / 100) % 100,
                     version_number % 100);
        else
            snprintf(buf, buflen, "%d.%d", version_number / 10000,
                     (version_number / 100) % 100);
    }
    return buf;
}

References buf, fb(), and snprintf.

Referenced by connection_warnings(), describeAccessMethods(), describeFunctions(), describePublications(), describeSubscriptions(), listEventTriggers(), listExtendedStats(), listPartitionedTables(), listPublications(), printVersion(), and SyncVariables().

◆ parsePGArray()

bool parsePGArray	(	const char *	atext,
		char ***	itemarray,
		int *	nitems
	)

extern

Definition at line 813 of file string_utils.c.

{
    int         inputlen;
    char      **items;
    char       *strings;
    int         curitem;
 
    /*
     * We expect input in the form of "{item,item,item}" where any item is
     * either raw data, or surrounded by double quotes (in which case embedded
     * characters including backslashes and quotes are backslashed).
     *
     * We build the result as an array of pointers followed by the actual
     * string data, all in one malloc block for convenience of deallocation.
     * The worst-case storage need is not more than one pointer and one
     * character for each input character (consider "{,,,,,,,,,,}").
     */
    *itemarray = NULL;
    *nitems = 0;
    inputlen = strlen(atext);
    if (inputlen < 2 || atext[0] != '{' || atext[inputlen - 1] != '}')
        return false;           /* bad input */
    items = (char **) malloc(inputlen * (sizeof(char *) + sizeof(char)));
    if (items == NULL)
        return false;           /* out of memory */
    *itemarray = items;
    strings = (char *) (items + inputlen);
 
    atext++;                    /* advance over initial '{' */
    curitem = 0;
    while (*atext != '}')
    {
        if (*atext == '\0')
            return false;       /* premature end of string */
        items[curitem] = strings;
        while (*atext != '}' && *atext != ',')
        {
            if (*atext == '\0')
                return false;   /* premature end of string */
            if (*atext != '"')
                *strings++ = *atext++;  /* copy unquoted data */
            else
            {
                /* process quoted substring */
                atext++;
                while (*atext != '"')
                {
                    if (*atext == '\0')
                        return false;   /* premature end of string */
                    if (*atext == '\\')
                    {
                        atext++;
                        if (*atext == '\0')
                            return false;   /* premature end of string */
                    }
                    *strings++ = *atext++;  /* copy quoted data */
                }
                atext++;
            }
        }
        *strings++ = '\0';
        if (*atext == ',')
            atext++;
        curitem++;
    }
    if (atext[1] != '\0')
        return false;           /* bogus syntax (embedded '}') */
    *nitems = curitem;
    return true;
}

References fb(), items, malloc, and nitems.

Referenced by appendReloptionsArray(), buildACLCommands(), dumpFunc(), dumpIndex(), dumpSearchPath(), dumpSubscription(), getIndexes(), getPublicationTables(), and processExtensionTables().

◆ patternToSQLRegex()

void patternToSQLRegex	(	int	encoding,
		PQExpBuffer	dbnamebuf,
		PQExpBuffer	schemabuf,
		PQExpBuffer	namebuf,
		const char *	pattern,
		bool	force_escape,
		bool	want_literal_dbname,
		int *	dotcnt
	)

extern

Definition at line 1219 of file string_utils.c.

{
    PQExpBufferData buf[3];
    PQExpBufferData left_literal;
    PQExpBuffer curbuf;
    PQExpBuffer maxbuf;
    int         i;
    bool        inquotes;
    bool        left;
    const char *cp;
 
    Assert(pattern != NULL);
    Assert(namebuf != NULL);
 
    /* callers should never expect "dbname.relname" format */
    Assert(dbnamebuf == NULL || schemabuf != NULL);
    Assert(dotcnt != NULL);
 
    *dotcnt = 0;
    inquotes = false;
    cp = pattern;
 
    if (dbnamebuf != NULL)
        maxbuf = &buf[2];
    else if (schemabuf != NULL)
        maxbuf = &buf[1];
    else
        maxbuf = &buf[0];
 
    curbuf = &buf[0];
    if (want_literal_dbname)
    {
        left = true;
        initPQExpBuffer(&left_literal);
    }
    else
        left = false;
    initPQExpBuffer(curbuf);
    appendPQExpBufferStr(curbuf, "^(");
    while (*cp)
    {
        char        ch = *cp;
 
        if (ch == '"')
        {
            if (inquotes && cp[1] == '"')
            {
                /* emit one quote, stay in inquotes mode */
                appendPQExpBufferChar(curbuf, '"');
                if (left)
                    appendPQExpBufferChar(&left_literal, '"');
                cp++;
            }
            else
                inquotes = !inquotes;
            cp++;
        }
        else if (!inquotes && isupper((unsigned char) ch))
        {
            appendPQExpBufferChar(curbuf,
                                  pg_tolower((unsigned char) ch));
            if (left)
                appendPQExpBufferChar(&left_literal,
                                      pg_tolower((unsigned char) ch));
            cp++;
        }
        else if (!inquotes && ch == '*')
        {
            appendPQExpBufferStr(curbuf, ".*");
            if (left)
                appendPQExpBufferChar(&left_literal, '*');
            cp++;
        }
        else if (!inquotes && ch == '?')
        {
            appendPQExpBufferChar(curbuf, '.');
            if (left)
                appendPQExpBufferChar(&left_literal, '?');
            cp++;
        }
        else if (!inquotes && ch == '.')
        {
            left = false;
            if (dotcnt)
                (*dotcnt)++;
            if (curbuf < maxbuf)
            {
                appendPQExpBufferStr(curbuf, ")$");
                curbuf++;
                initPQExpBuffer(curbuf);
                appendPQExpBufferStr(curbuf, "^(");
                cp++;
            }
            else
                appendPQExpBufferChar(curbuf, *cp++);
        }
        else if (ch == '$')
        {
            /*
             * Dollar is always quoted, whether inside quotes or not. The
             * reason is that it's allowed in SQL identifiers, so there's a
             * significant use-case for treating it literally, while because
             * we anchor the pattern automatically there is no use-case for
             * having it possess its regexp meaning.
             */
            appendPQExpBufferStr(curbuf, "\\$");
            if (left)
                appendPQExpBufferChar(&left_literal, '$');
            cp++;
        }
        else
        {
            /*
             * Ordinary data character, transfer to pattern
             *
             * Inside double quotes, or at all times if force_escape is true,
             * quote regexp special characters with a backslash to avoid
             * regexp errors.  Outside quotes, however, let them pass through
             * as-is; this lets knowledgeable users build regexp expressions
             * that are more powerful than shell-style patterns.
             *
             * As an exception to that, though, always quote "[]", as that's
             * much more likely to be an attempt to write an array type name
             * than it is to be the start of a regexp bracket expression.
             */
            if ((inquotes || force_escape) &&
                strchr("|*+?()[]{}.^$\\", ch))
                appendPQExpBufferChar(curbuf, '\\');
            else if (ch == '[' && cp[1] == ']')
                appendPQExpBufferChar(curbuf, '\\');
            i = PQmblenBounded(cp, encoding);
            while (i--)
            {
                if (left)
                    appendPQExpBufferChar(&left_literal, *cp);
                appendPQExpBufferChar(curbuf, *cp++);
            }
        }
    }
    appendPQExpBufferStr(curbuf, ")$");
 
    if (namebuf)
    {
        appendPQExpBufferStr(namebuf, curbuf->data);
        termPQExpBuffer(curbuf);
        curbuf--;
    }
 
    if (schemabuf && curbuf >= buf)
    {
        appendPQExpBufferStr(schemabuf, curbuf->data);
        termPQExpBuffer(curbuf);
        curbuf--;
    }
 
    if (dbnamebuf && curbuf >= buf)
    {
        if (want_literal_dbname)
            appendPQExpBufferStr(dbnamebuf, left_literal.data);
        else
            appendPQExpBufferStr(dbnamebuf, curbuf->data);
        termPQExpBuffer(curbuf);
    }
 
    if (want_literal_dbname)
        termPQExpBuffer(&left_literal);
}

References appendPQExpBufferChar(), appendPQExpBufferStr(), Assert, buf, encoding, fb(), i, initPQExpBuffer(), pg_tolower(), PQmblenBounded(), and termPQExpBuffer().

Referenced by append_database_pattern(), append_relation_pattern_helper(), append_schema_pattern(), and processSQLNamePattern().

◆ processSQLNamePattern()

bool processSQLNamePattern	(	PGconn *	conn,
		PQExpBuffer	buf,
		const char *	pattern,
		bool	have_where,
		bool	force_escape,
		const char *	schemavar,
		const char *	namevar,
		const char *	altnamevar,
		const char *	visibilityrule,
		PQExpBuffer	dbnamebuf,
		int *	dotcnt
	)

extern

Definition at line 1047 of file string_utils.c.

{
    PQExpBufferData schemabuf;
    PQExpBufferData namebuf;
    bool        added_clause = false;
    int         dcnt;
 
#define WHEREAND() \
    (appendPQExpBufferStr(buf, have_where ? "  AND " : "WHERE "), \
     have_where = true, added_clause = true)
 
    if (dotcnt == NULL)
        dotcnt = &dcnt;
    *dotcnt = 0;
    if (pattern == NULL)
    {
        /* Default: select all visible objects */
        if (visibilityrule)
        {
            WHEREAND();
            appendPQExpBuffer(buf, "%s\n", visibilityrule);
        }
        return added_clause;
    }
 
    initPQExpBuffer(&schemabuf);
    initPQExpBuffer(&namebuf);
 
    /*
     * Convert shell-style 'pattern' into the regular expression(s) we want to
     * execute.  Quoting/escaping into SQL literal format will be done below
     * using appendStringLiteralConn().
     *
     * If the caller provided a schemavar, we want to split the pattern on
     * ".", otherwise not.
     */
    patternToSQLRegex(PQclientEncoding(conn),
                      (schemavar ? dbnamebuf : NULL),
                      (schemavar ? &schemabuf : NULL),
                      &namebuf,
                      pattern, force_escape, true, dotcnt);
 
    /*
     * Now decide what we need to emit.  We may run under a hostile
     * search_path, so qualify EVERY name.  Note there will be a leading "^("
     * in the patterns in any case.
     *
     * We want the regex matches to use the database's default collation where
     * collation-sensitive behavior is required (for example, which characters
     * match '\w').  That happened by default before PG v12, but if the server
     * is >= v12 then we need to force it through explicit COLLATE clauses,
     * otherwise the "C" collation attached to "name" catalog columns wins.
     */
    if (namevar && namebuf.len > 2)
    {
        /* We have a name pattern, so constrain the namevar(s) */
 
        /* Optimize away a "*" pattern */
        if (strcmp(namebuf.data, "^(.*)$") != 0)
        {
            WHEREAND();
            if (altnamevar)
            {
                appendPQExpBuffer(buf,
                                  "(%s OPERATOR(pg_catalog.~) ", namevar);
                appendStringLiteralConn(buf, namebuf.data, conn);
                if (PQserverVersion(conn) >= 120000)
                    appendPQExpBufferStr(buf, " COLLATE pg_catalog.default");
                appendPQExpBuffer(buf,
                                  "\n        OR %s OPERATOR(pg_catalog.~) ",
                                  altnamevar);
                appendStringLiteralConn(buf, namebuf.data, conn);
                if (PQserverVersion(conn) >= 120000)
                    appendPQExpBufferStr(buf, " COLLATE pg_catalog.default");
                appendPQExpBufferStr(buf, ")\n");
            }
            else
            {
                appendPQExpBuffer(buf, "%s OPERATOR(pg_catalog.~) ", namevar);
                appendStringLiteralConn(buf, namebuf.data, conn);
                if (PQserverVersion(conn) >= 120000)
                    appendPQExpBufferStr(buf, " COLLATE pg_catalog.default");
                appendPQExpBufferChar(buf, '\n');
            }
        }
    }
 
    if (schemavar && schemabuf.len > 2)
    {
        /* We have a schema pattern, so constrain the schemavar */
 
        /* Optimize away a "*" pattern */
        if (strcmp(schemabuf.data, "^(.*)$") != 0 && schemavar)
        {
            WHEREAND();
            appendPQExpBuffer(buf, "%s OPERATOR(pg_catalog.~) ", schemavar);
            appendStringLiteralConn(buf, schemabuf.data, conn);
            if (PQserverVersion(conn) >= 120000)
                appendPQExpBufferStr(buf, " COLLATE pg_catalog.default");
            appendPQExpBufferChar(buf, '\n');
        }
    }
    else
    {
        /* No schema pattern given, so select only visible objects */
        if (visibilityrule)
        {
            WHEREAND();
            appendPQExpBuffer(buf, "%s\n", visibilityrule);
        }
    }
 
    termPQExpBuffer(&schemabuf);
    termPQExpBuffer(&namebuf);
 
    return added_clause;
#undef WHEREAND
}

References appendPQExpBuffer(), appendPQExpBufferChar(), appendPQExpBufferStr(), appendStringLiteralConn(), buf, conn, fb(), initPQExpBuffer(), patternToSQLRegex(), PQclientEncoding(), PQserverVersion(), termPQExpBuffer(), and WHEREAND.

Referenced by describeConfigurationParameters(), expand_dbname_patterns(), expand_extension_name_patterns(), expand_foreign_server_name_patterns(), expand_schema_name_patterns(), expand_table_name_patterns(), get_dbnames_list_to_restore(), and validateSQLNamePattern().

◆ setFmtEncoding()

void setFmtEncoding ( int encoding )

extern

Definition at line 69 of file string_utils.c.

{
    fmtIdEncoding = encoding;
}

References encoding, and fb().

Referenced by escape_fmt_id(), exec_command_encoding(), main(), processEncodingEntry(), setup_connection(), and SyncVariables().

Variable Documentation

◆ getLocalPQExpBuffer

PQExpBuffer(* getLocalPQExpBuffer) (void) ( void )

externdefault

Definition at line 28 of file string_utils.c.

{
    static PQExpBuffer id_return = NULL;
 
    if (id_return)              /* first time through? */
    {
        /* same buffer, just wipe contents */
        resetPQExpBuffer(id_return);
    }
    else
    {
        /* new buffer */
        id_return = createPQExpBuffer();
    }
 
    return id_return;
}

Referenced by fmtIdEnc(), fmtQualifiedIdEnc(), and ParallelBackupStart().

◆ quote_all_identifiers

PGDLLIMPORT int quote_all_identifiers

extern

Definition at line 339 of file ruleutils.c.