postgresql/src/bin/psql/common.c

#include <config.h>
#include <c.h>
#include "common.h"

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#ifdef HAVE_TERMIOS_H
#include <termios.h>
#endif
#ifndef HAVE_STRDUP
#include <strdup.h>
#endif
#include <signal.h>
#include <assert.h>
#ifndef WIN32
#include <unistd.h>				/* for write() */
#else
#include <io.h>                 /* for _write() */
#endif

#include <libpq-fe.h>
#include <postgres_ext.h>
#include <pqsignal.h>
#include <version.h>

#include "settings.h"
#include "variables.h"
#include "copy.h"
#include "prompt.h"
#include "print.h"

#ifdef WIN32
#define popen(x,y) _popen(x,y)
#define pclose(x) _pclose(x)
#define write(a,b,c) _write(a,b,c)
#endif



/* xstrdup()
 *
 * "Safe" wrapper around strdup()
 * (Using this also avoids writing #ifdef HAVE_STRDUP in every file :)
 */
char *
xstrdup(const char *string)
{
	char	   *tmp;

	if (!string)
	{
		fprintf(stderr, "xstrdup: Cannot duplicate null pointer.\n");
		exit(EXIT_FAILURE);
	}
	tmp = strdup(string);
	if (!tmp)
	{
		perror("strdup");
		exit(EXIT_FAILURE);
	}
	return tmp;
}



/*
 * setQFout
 * -- handler for -o command line option and \o command
 *
 * Tries to open file fname (or pipe if fname starts with '|')
 * and stores the file handle in pset)
 * Upon failure, sets stdout and returns false.
 */
bool
setQFout(const char *fname, PsqlSettings *pset)
{
	bool		status = true;

#ifdef USE_ASSERT_CHECKING
	assert(pset);
#else
	if (!pset)
		return false;
#endif

	/* Close old file/pipe */
	if (pset->queryFout && pset->queryFout != stdout && pset->queryFout != stderr)
	{
		if (pset->queryFoutPipe)
			pclose(pset->queryFout);
		else
			fclose(pset->queryFout);
	}

	/* If no filename, set stdout */
	if (!fname || fname[0] == '\0')
	{
		pset->queryFout = stdout;
		pset->queryFoutPipe = false;
	}
	else if (*fname == '|')
	{
		const char *pipename = fname + 1;


#ifndef __CYGWIN32__
		pset->queryFout = popen(pipename, "w");
#else
		pset->queryFout = popen(pipename, "wb");
#endif
		pset->queryFoutPipe = true;
	}
	else
	{
#ifndef __CYGWIN32__
		pset->queryFout = fopen(fname, "w");
#else
		pset->queryFout = fopen(fname, "wb");
#endif
		pset->queryFoutPipe = false;
	}

	if (!pset->queryFout)
	{
		perror(fname);
		pset->queryFout = stdout;
		pset->queryFoutPipe = false;
		status = false;
	}

	/* Direct signals */
	if (pset->queryFoutPipe)
		pqsignal(SIGPIPE, SIG_IGN);
	else
		pqsignal(SIGPIPE, SIG_DFL);

	return status;
}



/*
 * simple_prompt
 *
 * Generalized function especially intended for reading in usernames and
 * password interactively. Reads from stdin.
 *
 * prompt:		The prompt to print
 * maxlen:		How many characters to accept
 * echo:		Set to false if you want to hide what is entered (for passwords)
 *
 * Returns a malloc()'ed string with the input (w/o trailing newline).
 */
char *
simple_prompt(const char *prompt, int maxlen, bool echo)
{
	int			length;
	char	   *destination;

#ifdef HAVE_TERMIOS_H
	struct termios t_orig,
				t;

#endif

	destination = (char *) malloc(maxlen + 2);
	if (!destination)
		return NULL;
	if (prompt)
		fputs(prompt, stdout);

#ifdef HAVE_TERMIOS_H
	if (!echo)
	{
		tcgetattr(0, &t);
		t_orig = t;
		t.c_lflag &= ~ECHO;
		tcsetattr(0, TCSADRAIN, &t);
	}
#endif

	fgets(destination, maxlen, stdin);

#ifdef HAVE_TERMIOS_H
	if (!echo)
	{
		tcsetattr(0, TCSADRAIN, &t_orig);
		puts("");
	}
#endif

	length = strlen(destination);
	if (length > 0 && destination[length - 1] != '\n')
	{
		/* eat rest of the line */
		char		buf[512];

		do
		{
			fgets(buf, 512, stdin);
		} while (buf[strlen(buf) - 1] != '\n');
	}

	if (length > 0 && destination[length - 1] == '\n')
		/* remove trailing newline */
		destination[length - 1] = '\0';

	return destination;
}



/*
 * interpolate_var()
 *
 * The idea here is that certain variables have a "magic" meaning, such as
 * LastOid. However, you can assign to those variables, but that will shadow
 * the magic meaning, until you unset it. If nothing matches, the value of
 * the environment variable is used.
 *
 * This function only returns NULL if you feed in NULL's (don't do that).
 * Otherwise, the return value is ready for immediate consumption.
 */
const char *
interpolate_var(const char *name, PsqlSettings *pset)
{
	const char *var;

#ifdef USE_ASSERT_CHECKING
	assert(name);
	assert(pset);
#else
	if (!name || !pset)
		return NULL;
#endif

    var = GetVariable(pset->vars, name);
    if (var)
        return var;

	/* otherwise return magic variable */

	/*
	 * (by convention these should be capitalized (but not all caps), to
	 * not be shadowed by regular vars or to shadow env vars)
	 */
	if (strcmp(name, "Version") == 0)
		return PG_VERSION_STR;

	if (strcmp(name, "Database") == 0)
	{
		if (PQdb(pset->db))
			return PQdb(pset->db);
		else
			return "";
	}

	if (strcmp(name, "User") == 0)
	{
		if (PQuser(pset->db))
			return PQuser(pset->db);
		else
			return "";
	}

	if (strcmp(name, "Host") == 0)
	{
		if (PQhost(pset->db))
			return PQhost(pset->db);
		else
			return "";
	}

	if (strcmp(name, "Port") == 0)
	{
		if (PQport(pset->db))
			return PQport(pset->db);
		else
			return "";
	}

    if (strcmp(name, "LastOid") == 0)
    {
        static char buf[24];
        if (pset->lastOid == InvalidOid)
            return "";
        sprintf(buf, "%u", pset->lastOid);
        return buf;
    }

	/* env vars */
	if ((var = getenv(name)))
		return var;

	return "";
}



/*
 * Code to support query cancellation
 *
 * Before we start a query, we enable a SIGINT signal catcher that sends a
 * cancel request to the backend. Note that sending the cancel directly from
 * the signal handler is safe because PQrequestCancel() is written to make it
 * so. We have to be very careful what else we do in the signal handler. This
 * includes using write() for output.
 */

static PGconn *cancelConn;

#define write_stderr(String) write(fileno(stderr), String, strlen(String))

static void
handle_sigint(SIGNAL_ARGS)
{
	if (cancelConn == NULL)
		return;
	/* Try to send cancel request */
	if (PQrequestCancel(cancelConn))
		write_stderr("\nCancel request sent\n");
	else
	{
		write_stderr("\nCould not send cancel request: ");
		write_stderr(PQerrorMessage(cancelConn));
	}
}



/*
 * PSQLexec
 *
 * This is the way to send "backdoor" queries (those not directly entered
 * by the user). It is subject to -E (echo_secret) but not -e (echo).
 */
PGresult   *
PSQLexec(PsqlSettings *pset, const char *query)
{
	PGresult   *res;
	const char *var;

	if (!pset->db)
	{
		fputs("You are currently not connected to a database.\n", stderr);
		return NULL;
	}

	var = GetVariable(pset->vars, "echo_secret");
	if (var)
	{
		printf("********* QUERY *********\n%s\n*************************\n\n", query);
		fflush(stdout);
	}

	if (var && strcmp(var, "noexec") == 0)
		return NULL;

	cancelConn = pset->db;
	pqsignal(SIGINT, handle_sigint);	/* control-C => cancel */

	res = PQexec(pset->db, query);

	pqsignal(SIGINT, SIG_DFL);	/* now control-C is back to normal */

	if (PQstatus(pset->db) == CONNECTION_OK)
	{
		if (res && (PQresultStatus(res) == PGRES_COMMAND_OK ||
					PQresultStatus(res) == PGRES_TUPLES_OK ||
					PQresultStatus(res) == PGRES_COPY_IN ||
					PQresultStatus(res) == PGRES_COPY_OUT)
			)
			return res;			/* Normal success case... */
		/* Normal failure case --- display error and return NULL */
		fputs(PQerrorMessage(pset->db), pset->queryFout);
		PQclear(res);
		return NULL;
	}

	/* Lost connection.  Report whatever libpq has to say,
	 * then consider recovery.
	 */
	fputs(PQerrorMessage(pset->db), pset->queryFout);
	PQclear(res);
	if (!pset->cur_cmd_interactive)
	{
		fprintf(stderr, "%s: connection to server was lost\n",
				pset->progname);
		exit(EXIT_BADCONN);
	}
	fputs("The connection to the server was lost. Attempting reset: ", stderr);
	fflush(stderr);
	PQreset(pset->db);
	if (PQstatus(pset->db) == CONNECTION_BAD)
	{
		fputs("Failed.\n", stderr);
		PQfinish(pset->db);
		pset->db = NULL;
	}
	else
		fputs("Succeeded.\n", stderr);
	return NULL;
}



/*
 * SendQuery: send the query string to the backend
 * (and print out results)
 *
 * Note: This is the "front door" way to send a query. That is, use it to
 * send queries actually entered by the user. These queries will be subject to
 * single step mode.
 * To send "back door" queries (generated by slash commands, etc.) in a
 * controlled way, use PSQLexec().
 *
 * Returns true if the query executed successfully, false otherwise.
 */
bool
SendQuery(PsqlSettings *pset, const char *query)
{
	bool		success = false;
	PGresult   *results;
	PGnotify   *notify;

	if (!pset->db)
	{
		fputs("You are currently not connected to a database.\n", stderr);
		return false;
	}

	if (GetVariableBool(pset->vars, "singlestep"))
	{
		char		buf[3];

		printf("***(Single step mode: Verify query)*********************************************\n"
               "%s\n"
               "***(press return to proceed or enter x and return to cancel)********************\n",
               query);
		fflush(stdout);
		fgets(buf, 3, stdin);
		if (buf[0] == 'x')
			return false;
	}

	cancelConn = pset->db;
	pqsignal(SIGINT, handle_sigint);

	results = PQexec(pset->db, query);

	pqsignal(SIGINT, SIG_DFL);

	if (results == NULL)
	{
		fputs(PQerrorMessage(pset->db), pset->queryFout);
		success = false;
	}
	else
	{
		switch (PQresultStatus(results))
		{
			case PGRES_TUPLES_OK:
				if (pset->gfname)
				{
					PsqlSettings settings_copy = *pset;

					settings_copy.queryFout = stdout;
					if (!setQFout(pset->gfname, &settings_copy))
					{
						success = false;
						break;
					}

					printQuery(results, &settings_copy.popt, settings_copy.queryFout);

					/* close file/pipe */
					setQFout(NULL, &settings_copy);

					free(pset->gfname);
					pset->gfname = NULL;

					success = true;
					break;
				}
				else
				{
					success = true;
					printQuery(results, &pset->popt, pset->queryFout);
				}
				break;
			case PGRES_EMPTY_QUERY:
				success = true;
				break;
			case PGRES_COMMAND_OK:
				success = true;
                pset->lastOid = PQoidValue(results);
                if (!GetVariableBool(pset->vars, "quiet"))
                    fprintf(pset->queryFout, "%s\n", PQcmdStatus(results));
				break;

			case PGRES_COPY_OUT:
				success = handleCopyOut(pset->db, pset->queryFout);
				break;

			case PGRES_COPY_IN:
				if (pset->cur_cmd_interactive && !GetVariable(pset->vars, "quiet"))
					puts("Enter data to be copied followed by a newline.\n"
						 "End with a backslash and a period on a line by itself.");

				success = handleCopyIn(pset->db, pset->cur_cmd_source,
									   pset->cur_cmd_interactive ? get_prompt(pset, PROMPT_COPY) : NULL);
				break;

			case PGRES_NONFATAL_ERROR:
			case PGRES_FATAL_ERROR:
			case PGRES_BAD_RESPONSE:
				success = false;
				fputs(PQerrorMessage(pset->db), stderr);
				break;
		}

        fflush(pset->queryFout);

		if (PQstatus(pset->db) == CONNECTION_BAD)
		{
            if (!pset->cur_cmd_interactive)
            {
                fprintf(stderr, "%s: connection to server was lost\n",
						pset->progname);
                exit(EXIT_BADCONN);
            }
			fputs("The connection to the server was lost. Attempting reset: ", stderr);
			fflush(stderr);
			PQreset(pset->db);
			if (PQstatus(pset->db) == CONNECTION_BAD)
			{
				fputs("Failed.\n", stderr);
				PQfinish(pset->db);
				pset->db = NULL;
				PQclear(results);
				return false;
			}
			else
				fputs("Succeeded.\n", stderr);
		}

		/* check for asynchronous notification returns */
		while ((notify = PQnotifies(pset->db)) != NULL)
		{
			fprintf(pset->queryFout, "Asynchronous NOTIFY '%s' from backend with pid '%d' received.\n",
					notify->relname, notify->be_pid);
			free(notify);
            fflush(pset->queryFout);
		}

		if (results)
			PQclear(results);
	}

	return success;
}