*
* Copyright 2000 by PostgreSQL Global Development Group
*
- * $Header: /cvsroot/pgsql/src/bin/psql/common.c,v 1.36 2001/10/18 21:57:11 tgl Exp $
+ * $Header: /cvsroot/pgsql/src/bin/psql/common.c,v 1.64 2003/06/12 08:15:28 momjian Exp $
*/
#include "postgres_fe.h"
-
#include "common.h"
#include <errno.h>
#include <stdarg.h>
-#ifdef HAVE_TERMIOS_H
-#include <termios.h>
-#endif
#ifndef HAVE_STRDUP
#include <strdup.h>
#endif
#include <signal.h>
#ifndef WIN32
+#include <sys/time.h>
#include <unistd.h> /* for write() */
#include <setjmp.h>
#else
#include <io.h> /* for _write() */
#include <win32.h>
+#include <sys/timeb.h> /* for _ftime() */
#endif
#include "libpq-fe.h"
#include "mainloop.h"
+/* Workarounds for Windows */
+/* Probably to be moved up the source tree in the future, perhaps to be replaced by
+ * more specific checks like configure-style HAVE_GETTIMEOFDAY macros.
+ */
+#ifndef WIN32
+
+typedef struct timeval TimevalStruct;
+#define GETTIMEOFDAY(T) gettimeofday(T, NULL)
+#define DIFF_MSEC(T, U) ((((T)->tv_sec - (U)->tv_sec) * 1000000.0 + (T)->tv_usec - (U)->tv_usec) / 1000.0)
+
+#else
+
+typedef struct _timeb TimevalStruct;
+#define GETTIMEOFDAY(T) _ftime(T)
+#define DIFF_MSEC(T, U) ((((T)->time - (U)->time) * 1000.0 + (T)->millitm - (U)->millitm))
+
+#endif
+
+extern bool prompt_state;
+
/*
* "Safe" wrapper around strdup()
*/
/* Direct signals */
#ifndef WIN32
- if (pset.queryFoutPipe)
- pqsignal(SIGPIPE, SIG_IGN);
- else
- pqsignal(SIGPIPE, SIG_DFL);
+ pqsignal(SIGPIPE, pset.queryFoutPipe ? SIG_IGN : SIG_DFL);
#endif
return status;
/*
- * for backend NOTICES
+ * for backend Notice messages (INFO, WARNING, etc)
*/
void
NoticeProcessor(void *arg, const char *message)
-/*
- * simple_prompt
- *
- * Generalized function especially intended for reading in usernames and
- * password interactively. Reads from /dev/tty or stdin/stderr.
- *
- * 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).
- */
-static bool prompt_state = false;
-
-char *
-simple_prompt(const char *prompt, int maxlen, bool echo)
-{
- int length;
- char *destination;
- FILE *termin, *termout;
-#ifdef HAVE_TERMIOS_H
- struct termios t_orig,
- t;
-#endif
-
- destination = (char *) malloc(maxlen + 2);
- if (!destination)
- return NULL;
-
- prompt_state = true; /* disable SIGINT */
-
- /*
- * Do not try to collapse these into one "w+" mode file.
- * Doesn't work on some platforms (eg, HPUX 10.20).
- */
- termin = fopen("/dev/tty", "r");
- termout = fopen("/dev/tty", "w");
- if (!termin || !termout)
- {
- if (termin)
- fclose(termin);
- if (termout)
- fclose(termout);
- termin = stdin;
- termout = stderr;
- }
-
-#ifdef HAVE_TERMIOS_H
- if (!echo)
- {
- tcgetattr(fileno(termin), &t);
- t_orig = t;
- t.c_lflag &= ~ECHO;
- tcsetattr(fileno(termin), TCSAFLUSH, &t);
- }
-#endif
-
- if (prompt)
- {
- fputs(gettext(prompt), termout);
- fflush(termout);
- }
-
- if (fgets(destination, maxlen, termin) == NULL)
- destination[0] = '\0';
-
- length = strlen(destination);
- if (length > 0 && destination[length - 1] != '\n')
- {
- /* eat rest of the line */
- char buf[128];
- int buflen;
-
- do
- {
- if (fgets(buf, sizeof(buf), termin) == NULL)
- break;
- buflen = strlen(buf);
- } while (buflen > 0 && buf[buflen - 1] != '\n');
- }
-
- if (length > 0 && destination[length - 1] == '\n')
- /* remove trailing newline */
- destination[length - 1] = '\0';
-
-#ifdef HAVE_TERMIOS_H
- if (!echo)
- {
- tcsetattr(fileno(termin), TCSAFLUSH, &t_orig);
- fputs("\n", termout);
- fflush(termout);
- }
-#endif
-
- if (termin != stdin)
- {
- fclose(termin);
- fclose(termout);
- }
-
- prompt_state = false; /* SIGINT okay again */
-
- return destination;
-}
-
-
-
/*
* Code to support query cancellation
*
* so. We use write() to print to stdout because it's better to use simple
* facilities in a signal handler.
*/
+static PGconn *volatile cancelConn = NULL;
+
+volatile bool cancel_pressed = false;
-PGconn *cancelConn;
-volatile bool cancel_pressed;
#ifndef WIN32
}
errno = save_errno; /* just in case the write changed it */
}
+#endif /* not WIN32 */
+
+
+
+/* ConnectionUp
+ *
+ * Returns whether our backend connection is still there.
+ */
+static bool
+ConnectionUp()
+{
+ return PQstatus(pset.db) != CONNECTION_BAD;
+}
+
+
+
+/* CheckConnection
+ *
+ * Verify that we still have a good connection to the backend, and if not,
+ * see if it can be restored.
+ *
+ * Returns true if either the connection was still there, or it could be
+ * restored successfully; false otherwise. If, however, there was no
+ * connection and the session is non-interactive, this will exit the program
+ * with a code of EXIT_BADCONN.
+ */
+static bool
+CheckConnection()
+{
+ bool OK;
+
+ OK = ConnectionUp();
+ if (!OK)
+ {
+ if (!pset.cur_cmd_interactive)
+ {
+ psql_error("connection to server was lost\n");
+ exit(EXIT_BADCONN);
+ }
+
+ fputs(gettext("The connection to the server was lost. Attempting reset: "), stderr);
+ PQreset(pset.db);
+ OK = ConnectionUp();
+ if (!OK)
+ {
+ fputs(gettext("Failed.\n"), stderr);
+ PQfinish(pset.db);
+ pset.db = NULL;
+ ResetCancelConn();
+ SetVariable(pset.vars, "DBNAME", NULL);
+ SetVariable(pset.vars, "HOST", NULL);
+ SetVariable(pset.vars, "PORT", NULL);
+ SetVariable(pset.vars, "USER", NULL);
+ SetVariable(pset.vars, "ENCODING", NULL);
+ }
+ else
+ fputs(gettext("Succeeded.\n"), stderr);
+ }
+
+ return OK;
+}
+
+
+
+/*
+ * SetCancelConn
+ *
+ * Set cancelConn to point to the current database connection.
+ */
+static void SetCancelConn(void)
+{
+ cancelConn = pset.db;
+}
+
+
+/*
+ * ResetCancelConn
+ *
+ * Set cancelConn to NULL. I don't know what this means exactly, but it saves
+ * having to export the variable.
+ */
+void ResetCancelConn(void)
+{
+ cancelConn = NULL;
+}
+
+
+/*
+ * AcceptResult
+ *
+ * Checks whether a result is valid, giving an error message if necessary;
+ * (re)sets copy_in_state and cancelConn as needed, and ensures that the
+ * connection to the backend is still up.
+ *
+ * Returns true for valid result, false for error state.
+ */
+static bool
+AcceptResult(const PGresult *result)
+{
+ bool OK = true;
+
+ ResetCancelConn();
+
+ if (!result)
+ {
+ OK = false;
+ }
+ else switch (PQresultStatus(result))
+ {
+ case PGRES_COPY_IN:
+ copy_in_state = true;
+ break;
+
+ case PGRES_COMMAND_OK:
+ case PGRES_TUPLES_OK:
+ /* Fine, do nothing */
+ break;
+
+ case PGRES_COPY_OUT:
+ /* keep cancel connection for copy out state */
+ SetCancelConn();
+ break;
+
+ default:
+ OK = false;
+ break;
+ }
+
+ if (!OK)
+ {
+ CheckConnection();
+ psql_error("%s", PQerrorMessage(pset.db));
+ }
+
+ return OK;
+}
-#endif /* not WIN32 */
/*
*
* This is the way to send "backdoor" queries (those not directly entered
* by the user). It is subject to -E but not -e.
+ *
+ * If the given querystring generates multiple PGresults, normally the last
+ * one is returned to the caller. However, if ignore_command_ok is TRUE,
+ * then PGresults with status PGRES_COMMAND_OK are ignored. This is intended
+ * mainly to allow locutions such as "begin; select ...; commit".
*/
-PGresult *
-PSQLexec(const char *query)
+PGresult *
+PSQLexec(const char *query, bool ignore_command_ok)
{
- PGresult *res;
- const char *var;
+ PGresult *res = NULL;
+ PGresult *newres;
+ int echo_hidden;
+ ExecStatusType rstatus;
if (!pset.db)
{
return NULL;
}
- var = GetVariable(pset.vars, "ECHO_HIDDEN");
- if (var)
+ echo_hidden = SwitchVariable(pset.vars, "ECHO_HIDDEN", "noexec", NULL);
+ if (echo_hidden != var_notset)
{
printf("********* QUERY **********\n"
"%s\n"
"**************************\n\n", query);
fflush(stdout);
- }
- if (var && strcmp(var, "noexec") == 0)
+ if (echo_hidden == 1)
return NULL;
+ }
- cancelConn = pset.db;
- res = PQexec(pset.db, query);
- if (PQresultStatus(res) == PGRES_COPY_IN)
- copy_in_state = true;
- /* keep cancel connection for copy out state */
- if (PQresultStatus(res) != PGRES_COPY_OUT)
- cancelConn = NULL;
-
- if (res && (PQresultStatus(res) == PGRES_COMMAND_OK ||
- PQresultStatus(res) == PGRES_TUPLES_OK ||
- PQresultStatus(res) == PGRES_COPY_IN ||
- PQresultStatus(res) == PGRES_COPY_OUT)
- )
- return res;
- else
+ /* discard any uneaten results of past queries */
+ while ((newres = PQgetResult(pset.db)) != NULL)
+ PQclear(newres);
+
+ SetCancelConn();
+ if (!PQsendQuery(pset.db, query))
{
- psql_error("%s", PQerrorMessage(pset.db));
- PQclear(res);
+ psql_error("%s", PQerrorMessage(pset.db));
+ ResetCancelConn();
+ return NULL;
+ }
- if (PQstatus(pset.db) == CONNECTION_BAD)
+ rstatus = PGRES_EMPTY_QUERY;
+
+ while (rstatus != PGRES_COPY_IN &&
+ rstatus != PGRES_COPY_OUT &&
+ (newres = PQgetResult(pset.db)))
{
- if (!pset.cur_cmd_interactive)
- {
- psql_error("connection to server was lost\n");
- exit(EXIT_BADCONN);
- }
- fputs(gettext("The connection to the server was lost. Attempting reset: "), stderr);
- PQreset(pset.db);
- if (PQstatus(pset.db) == CONNECTION_BAD)
+ rstatus = PQresultStatus(newres);
+ if (!ignore_command_ok || rstatus != PGRES_COMMAND_OK)
{
- fputs(gettext("Failed.\n"), stderr);
- PQfinish(pset.db);
- pset.db = NULL;
- SetVariable(pset.vars, "DBNAME", NULL);
- SetVariable(pset.vars, "HOST", NULL);
- SetVariable(pset.vars, "PORT", NULL);
- SetVariable(pset.vars, "USER", NULL);
- SetVariable(pset.vars, "ENCODING", NULL);
- }
- else
- fputs(gettext("Succeeded.\n"), stderr);
+ PGresult *tempRes = res;
+ res = newres;
+ newres = tempRes;
}
-
- return NULL;
+ PQclear(newres);
}
+
+ if (!AcceptResult(res) && res)
+ {
+ PQclear(res);
+ res = NULL;
+ }
+
+ return res;
}
/*
- * SendQuery: send the query string to the backend
- * (and print out results)
+ * PrintNotifications: check for asynchronous notifications, and print them out
*
- * 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(const char *query)
+static void
+PrintNotifications(void)
{
- bool success = false;
- PGresult *results;
PGnotify *notify;
- if (!pset.db)
- {
- psql_error("You are currently not connected to a database.\n");
- return false;
- }
-
- if (GetVariableBool(pset.vars, "SINGLESTEP"))
- {
- char buf[3];
-
- printf(gettext("***(Single step mode: Verify query)*********************************************\n"
- "%s\n"
- "***(press return to proceed or enter x and return to cancel)********************\n"),
- query);
- fflush(stdout);
- if (fgets(buf, sizeof(buf), stdin) != NULL)
- if (buf[0] == 'x')
- return false;
- }
- else
+ while ((notify = PQnotifies(pset.db)))
{
- const char *var = GetVariable(pset.vars, "ECHO");
-
- if (var && strncmp(var, "queries", strlen(var)) == 0)
- puts(query);
+ fprintf(pset.queryFout, gettext("Asynchronous NOTIFY '%s' from backend with pid %d received.\n"),
+ notify->relname, notify->be_pid);
+ PQfreemem(notify);
+ fflush(pset.queryFout);
}
+}
- cancelConn = pset.db;
- results = PQexec(pset.db, query);
- if (PQresultStatus(results) == PGRES_COPY_IN)
- copy_in_state = true;
- /* keep cancel connection for copy out state */
- if (PQresultStatus(results) != PGRES_COPY_OUT)
- cancelConn = NULL;
- if (results == NULL)
- {
- fputs(PQerrorMessage(pset.db), pset.queryFout);
- success = false;
- }
- else
- {
- switch (PQresultStatus(results))
- {
- case PGRES_TUPLES_OK:
+/*
+ * PrintQueryTuples: assuming query result is OK, print its tuples
+ *
+ * Returns true if successful, false otherwise.
+ */
+static bool
+PrintQueryTuples(const PGresult *results)
+{
/* write output to \g argument, if any */
if (pset.gfname)
{
{
pset.queryFout = queryFout_copy;
pset.queryFoutPipe = queryFoutPipe_copy;
- success = false;
- break;
+ return false;
}
printQuery(results, &pset.popt, pset.queryFout);
free(pset.gfname);
pset.gfname = NULL;
-
- success = true;
}
else
{
printQuery(results, &pset.popt, pset.queryFout);
- success = true;
}
+
+ return true;
+}
+
+
+
+/*
+ * PrintQueryResults: analyze query results and print them out
+ *
+ * Note: Utility function for use by SendQuery() only.
+ *
+ * Returns true if the query executed successfully, false otherwise.
+ */
+static bool
+PrintQueryResults(PGresult *results,
+ const TimevalStruct *before,
+ const TimevalStruct *after)
+{
+ bool success = false;
+
+ if (!results)
+ return false;
+
+ switch (PQresultStatus(results))
+ {
+ case PGRES_TUPLES_OK:
+ success = PrintQueryTuples(results);
break;
case PGRES_EMPTY_QUERY:
success = true;
success = true;
sprintf(buf, "%u", (unsigned int) PQoidValue(results));
if (!QUIET())
- fprintf(pset.queryFout, "%s\n", PQcmdStatus(results));
+ {
+ if (pset.popt.topt.format == PRINT_HTML)
+ {
+ fputs("<p>", pset.queryFout);
+ html_escaped_print(PQcmdStatus(results), pset.queryFout);
+ fputs("</p>\n", pset.queryFout);
+ }
+ else
+ {
+ fprintf(pset.queryFout, "%s\n", PQcmdStatus(results));
+ }
+ }
SetVariable(pset.vars, "LASTOID", buf);
break;
}
case PGRES_COPY_IN:
if (pset.cur_cmd_interactive && !QUIET())
puts(gettext("Enter data to be copied followed by a newline.\n"
- "End with a backslash and a period on a line by itself."));
+ "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(PROMPT_COPY) : NULL);
break;
- case PGRES_NONFATAL_ERROR:
- case PGRES_FATAL_ERROR:
- case PGRES_BAD_RESPONSE:
- success = false;
- psql_error("%s", PQerrorMessage(pset.db));
+ default:
break;
}
fflush(pset.queryFout);
- if (PQstatus(pset.db) == CONNECTION_BAD)
- {
- if (!pset.cur_cmd_interactive)
- {
- psql_error("connection to server was lost\n");
- exit(EXIT_BADCONN);
- }
- fputs(gettext("The connection to the server was lost. Attempting reset: "), stderr);
- PQreset(pset.db);
- if (PQstatus(pset.db) == CONNECTION_BAD)
- {
- fputs(gettext("Failed.\n"), stderr);
- PQfinish(pset.db);
- PQclear(results);
- pset.db = NULL;
- SetVariable(pset.vars, "DBNAME", NULL);
- SetVariable(pset.vars, "HOST", NULL);
- SetVariable(pset.vars, "PORT", NULL);
- SetVariable(pset.vars, "USER", NULL);
- SetVariable(pset.vars, "ENCODING", NULL);
- return false;
- }
- else
- fputs(gettext("Succeeded.\n"), stderr);
- }
+ if (!CheckConnection()) return false;
+
+ /* Possible microtiming output */
+ if (pset.timing && success)
+ printf(gettext("Time: %.2f ms\n"), DIFF_MSEC(after, before));
+
+ return success;
+}
+
- /* check for asynchronous notification returns */
- while ((notify = PQnotifies(pset.db)) != NULL)
- {
- fprintf(pset.queryFout, gettext("Asynchronous NOTIFY '%s' from backend with pid %d received.\n"),
- notify->relname, notify->be_pid);
- free(notify);
- fflush(pset.queryFout);
- }
- if (results)
- PQclear(results);
+/*
+ * 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(const char *query)
+{
+ PGresult *results;
+ TimevalStruct before, after;
+ bool OK;
+
+ if (!pset.db)
+ {
+ psql_error("You are currently not connected to a database.\n");
+ return false;
}
- return success;
+ if (GetVariableBool(pset.vars, "SINGLESTEP"))
+ {
+ char buf[3];
+
+ printf(gettext("***(Single step mode: Verify query)*********************************************\n"
+ "%s\n"
+ "***(press return to proceed or enter x and return to cancel)********************\n"),
+ query);
+ fflush(stdout);
+ if (fgets(buf, sizeof(buf), stdin) != NULL)
+ if (buf[0] == 'x')
+ return false;
+ }
+ else if (VariableEquals(pset.vars, "ECHO", "queries"))
+ puts(query);
+
+ SetCancelConn();
+
+ if (pset.timing)
+ GETTIMEOFDAY(&before);
+ results = PQexec(pset.db, query);
+ if (pset.timing)
+ GETTIMEOFDAY(&after);
+
+ OK = (AcceptResult(results) && PrintQueryResults(results, &before, &after));
+ PQclear(results);
+
+ PrintNotifications();
+ return OK;
}
+
+
+char parse_char(char **buf)
+{
+ long l;
+
+ l = strtol(*buf, buf, 0);
+ --*buf;
+ return (char)l;
+}
+
+
projects / postgresql / blobdiff