util.c File Reference

#include "postgres_fe.h"
#include <signal.h>
#include "common/username.h"
#include "pg_upgrade.h"

Include dependency graph for util.c:

Go to the source code of this file.

Functions
static void	pg_log_v (eLogType type, const char *fmt, va_list ap) pg_attribute_printf(2
static void void	report_status (eLogType type, const char *fmt,...)
void	end_progress_output (void)
void	prep_status (const char *fmt,...)
void	pg_log (eLogType type, const char *fmt,...)
void	pg_fatal (const char *fmt,...)
void	check_ok (void)
char *	quote_identifier (const char *s)
int	get_user_info (char **user_name_p)
unsigned int	str2uint (const char *str)
void	pg_putenv (const char *var, const char *val)

Variables
LogOpts	log_opts

Function Documentation

check_ok()

void check_ok

(

void

)

Definition at line 171 of file util.c.

References PG_REPORT, report_status(), and generate_unaccent_rules::stdout.

{
    /* all seems well */
    report_status(PG_REPORT, "ok");
    fflush(stdout);
}

end_progress_output()

void end_progress_output

(

void

)

Definition at line 43 of file util.c.

References prep_status().

Referenced by create_new_objects(), generate_old_dump(), and transfer_all_new_tablespaces().

{
    /*
     * In case nothing printed; pass a space so gcc doesn't complain about
     * empty format string.
     */
    prep_status(" ");
}

get_user_info()

int get_user_info

(

char **

user_name_p

)

Definition at line 211 of file util.c.

References get_user_name(), pg_fatal(), and pg_strdup().

Referenced by parseCommandLine().

{
    int         user_id;
    const char *user_name;
    char       *errstr;

#ifndef WIN32
    user_id = geteuid();
#else
    user_id = 1;
#endif

    user_name = get_user_name(&errstr);
    if (!user_name)
        pg_fatal("%s\n", errstr);

    /* make a copy */
    *user_name_p = pg_strdup(user_name);

    return user_id;
}

pg_fatal()

void pg_fatal	(	const char *	fmt,
			...
	)

Definition at line 158 of file util.c.

References _, generate_unaccent_rules::args, PG_FATAL, pg_log_v(), and printf.

Referenced by get_user_info().

{
    va_list     args;

    va_start(args, fmt);
    pg_log_v(PG_FATAL, fmt, args);
    va_end(args);
    printf(_("Failure, exiting\n"));
    exit(1);
}

pg_log()

void pg_log	(	eLogType	type,
		const char *	fmt,
			...
	)

Definition at line 147 of file util.c.

References generate_unaccent_rules::args, and pg_log_v().

Referenced by prep_status(), and report_status().

{
    va_list     args;

    va_start(args, fmt);
    pg_log_v(type, fmt, args);
    va_end(args);
}

pg_log_v()

static void pg_log_v ( eLogType  type, const char *  fmt, va_list  ap  )

static

Definition at line 87 of file util.c.

References _, fprintf, LogOpts::internal, MESSAGE_WIDTH, PG_FATAL, PG_REPORT, PG_STATUS, PG_VERBOSE, PG_WARNING, printf, QUERY_ALLOC, generate_unaccent_rules::stdout, LogOpts::verbose, and vsnprintf.

Referenced by pg_fatal(), and pg_log().

{
    char        message[QUERY_ALLOC];

    vsnprintf(message, sizeof(message), _(fmt), ap);

    /* PG_VERBOSE and PG_STATUS are only output in verbose mode */
    /* fopen() on log_opts.internal might have failed, so check it */
    if (((type != PG_VERBOSE && type != PG_STATUS) || log_opts.verbose) &&
        log_opts.internal != NULL)
    {
        if (type == PG_STATUS)
            /* status messages need two leading spaces and a newline */
            fprintf(log_opts.internal, "  %s\n", message);
        else
            fprintf(log_opts.internal, "%s", message);
        fflush(log_opts.internal);
    }

    switch (type)
    {
        case PG_VERBOSE:
            if (log_opts.verbose)
                printf("%s", message);
            break;

        case PG_STATUS:
            /* for output to a display, do leading truncation and append \r */
            if (isatty(fileno(stdout)))
                /* -2 because we use a 2-space indent */
                printf("  %s%-*.*s\r",
                /* prefix with "..." if we do leading truncation */
                       strlen(message) <= MESSAGE_WIDTH - 2 ? "" : "...",
                       MESSAGE_WIDTH - 2, MESSAGE_WIDTH - 2,
                /* optional leading truncation */
                       strlen(message) <= MESSAGE_WIDTH - 2 ? message :
                       message + strlen(message) - MESSAGE_WIDTH + 3 + 2);
            else
                printf("  %s\n", message);
            break;

        case PG_REPORT:
        case PG_WARNING:
            printf("%s", message);
            break;

        case PG_FATAL:
            printf("\n%s", message);
            printf(_("Failure, exiting\n"));
            exit(1);
            break;

        default:
            break;
    }
    fflush(stdout);
}

pg_putenv()

void pg_putenv	(	const char *	var,
		const char *	val
	)

Definition at line 253 of file util.c.

References psprintf(), putenv, and unsetenv.

Referenced by get_control_data(), and parseCommandLine().

{
    if (val)
    {
#ifndef WIN32
        char       *envstr;

        envstr = psprintf("%s=%s", var, val);
        putenv(envstr);

        /*
         * Do not free envstr because it becomes part of the environment on
         * some operating systems.  See port/unsetenv.c::unsetenv.
         */
#else
        SetEnvironmentVariableA(var, val);
#endif
    }
    else
    {
#ifndef WIN32
        unsetenv(var);
#else
        SetEnvironmentVariableA(var, "");
#endif
    }
}

prep_status()

void prep_status	(	const char *	fmt,
			...
	)

Definition at line 69 of file util.c.

References generate_unaccent_rules::args, MAX_STRING, MESSAGE_WIDTH, pg_log(), PG_REPORT, and vsnprintf.

Referenced by end_progress_output().

{
    va_list     args;
    char        message[MAX_STRING];

    va_start(args, fmt);
    vsnprintf(message, sizeof(message), fmt, args);
    va_end(args);

    if (strlen(message) > 0 && message[strlen(message) - 1] == '\n')
        pg_log(PG_REPORT, "%s", message);
    else
        /* trim strings that don't end in a newline */
        pg_log(PG_REPORT, "%-*s", MESSAGE_WIDTH, message);
}

quote_identifier()

char* quote_identifier

(

const char *

s

)

Definition at line 187 of file util.c.

References palloc(), pg_malloc(), quote_all_identifiers, ScanKeywordCategories, ScanKeywordLookup(), ScanKeywords, and UNRESERVED_KEYWORD.

{
    char       *result = pg_malloc(strlen(s) * 2 + 3);
    char       *r = result;

    *r++ = '"';
    while (*s)
    {
        if (*s == '"')
            *r++ = *s;
        *r++ = *s;
        s++;
    }
    *r++ = '"';
    *r++ = '\0';

    return result;
}

report_status()

static void void report_status	(	eLogType	type,
		const char *	fmt,
			...
	)

Definition at line 28 of file util.c.

References generate_unaccent_rules::args, MAX_STRING, pg_log(), and vsnprintf.

Referenced by check_ok().

{
    va_list     args;
    char        message[MAX_STRING];

    va_start(args, fmt);
    vsnprintf(message, sizeof(message), fmt, args);
    va_end(args);

    pg_log(type, "%s\n", message);
}

str2uint()

unsigned int str2uint

(

const char *

str

)

Definition at line 240 of file util.c.

Referenced by get_control_data().

{
    return strtoul(str, NULL, 10);
}

Variable Documentation

log_opts

LogOpts log_opts

Definition at line 17 of file util.c.

Referenced by cleanup(), generate_old_dump(), get_db_and_rel_infos(), parseCommandLine(), prepare_new_cluster(), and print_maps().