chomp PQerrorMessage() in backend uses

PQerrorMessage() returns an error message with a trailing newline, but
in backend use (dblink, postgres_fdw, libpqwalreceiver), we want to have
the error message without that for emitting via ereport().  To simplify
that, add a function pchomp() that returns a pstrdup'ed string with the
trailing newline characters removed.
This commit is contained in:
Peter Eisentraut 2017-02-27 08:30:06 -05:00
parent 9fab40ad32
commit 2ed193c904
6 changed files with 40 additions and 36 deletions

View file

@ -166,7 +166,7 @@ typedef struct remoteConnHashEnt
#define DBLINK_RES_INTERNALERROR(p2) \ #define DBLINK_RES_INTERNALERROR(p2) \
do { \ do { \
msg = pstrdup(PQerrorMessage(conn)); \ msg = pchomp(PQerrorMessage(conn)); \
if (res) \ if (res) \
PQclear(res); \ PQclear(res); \
elog(ERROR, "%s: %s", p2, msg); \ elog(ERROR, "%s: %s", p2, msg); \
@ -204,7 +204,7 @@ typedef struct remoteConnHashEnt
conn = PQconnectdb(connstr); \ conn = PQconnectdb(connstr); \
if (PQstatus(conn) == CONNECTION_BAD) \ if (PQstatus(conn) == CONNECTION_BAD) \
{ \ { \
msg = pstrdup(PQerrorMessage(conn)); \ msg = pchomp(PQerrorMessage(conn)); \
PQfinish(conn); \ PQfinish(conn); \
ereport(ERROR, \ ereport(ERROR, \
(errcode(ERRCODE_SQLCLIENT_UNABLE_TO_ESTABLISH_SQLCONNECTION), \ (errcode(ERRCODE_SQLCLIENT_UNABLE_TO_ESTABLISH_SQLCONNECTION), \
@ -278,7 +278,7 @@ dblink_connect(PG_FUNCTION_ARGS)
if (PQstatus(conn) == CONNECTION_BAD) if (PQstatus(conn) == CONNECTION_BAD)
{ {
msg = pstrdup(PQerrorMessage(conn)); msg = pchomp(PQerrorMessage(conn));
PQfinish(conn); PQfinish(conn);
if (rconn) if (rconn)
pfree(rconn); pfree(rconn);
@ -651,7 +651,7 @@ dblink_send_query(PG_FUNCTION_ARGS)
/* async query send */ /* async query send */
retval = PQsendQuery(conn, sql); retval = PQsendQuery(conn, sql);
if (retval != 1) if (retval != 1)
elog(NOTICE, "could not send query: %s", PQerrorMessage(conn)); elog(NOTICE, "could not send query: %s", pchomp(PQerrorMessage(conn)));
PG_RETURN_INT32(retval); PG_RETURN_INT32(retval);
} }
@ -1087,7 +1087,7 @@ storeQueryResult(volatile storeInfo *sinfo, PGconn *conn, const char *sql)
PGresult *res; PGresult *res;
if (!PQsendQuery(conn, sql)) if (!PQsendQuery(conn, sql))
elog(ERROR, "could not send query: %s", PQerrorMessage(conn)); elog(ERROR, "could not send query: %s", pchomp(PQerrorMessage(conn)));
if (!PQsetSingleRowMode(conn)) /* shouldn't fail */ if (!PQsetSingleRowMode(conn)) /* shouldn't fail */
elog(ERROR, "failed to set single-row mode for dblink query"); elog(ERROR, "failed to set single-row mode for dblink query");
@ -1370,7 +1370,7 @@ dblink_error_message(PG_FUNCTION_ARGS)
if (msg == NULL || msg[0] == '\0') if (msg == NULL || msg[0] == '\0')
PG_RETURN_TEXT_P(cstring_to_text("OK")); PG_RETURN_TEXT_P(cstring_to_text("OK"));
else else
PG_RETURN_TEXT_P(cstring_to_text(msg)); PG_RETURN_TEXT_P(cstring_to_text(pchomp(msg)));
} }
/* /*
@ -2709,7 +2709,7 @@ dblink_res_error(PGconn *conn, const char *conname, PGresult *res,
* return NULL, not a PGresult at all. * return NULL, not a PGresult at all.
*/ */
if (message_primary == NULL) if (message_primary == NULL)
message_primary = PQerrorMessage(conn); message_primary = pchomp(PQerrorMessage(conn));
if (res) if (res)
PQclear(res); PQclear(res);

View file

@ -377,7 +377,6 @@ FROM dblink('myconn','SELECT * FROM foo') AS t(a int, b text, c text[])
WHERE t.a > 7; WHERE t.a > 7;
ERROR: could not establish connection ERROR: could not establish connection
DETAIL: missing "=" after "myconn" in connection info string DETAIL: missing "=" after "myconn" in connection info string
-- create a named persistent connection -- create a named persistent connection
SELECT dblink_connect('myconn',connection_parameters()); SELECT dblink_connect('myconn',connection_parameters());
dblink_connect dblink_connect
@ -604,7 +603,6 @@ FROM dblink('myconn','SELECT * FROM foo') AS t(a int, b text, c text[])
WHERE t.a > 7; WHERE t.a > 7;
ERROR: could not establish connection ERROR: could not establish connection
DETAIL: missing "=" after "myconn" in connection info string DETAIL: missing "=" after "myconn" in connection info string
-- create a named persistent connection -- create a named persistent connection
SELECT dblink_connect('myconn',connection_parameters()); SELECT dblink_connect('myconn',connection_parameters());
dblink_connect dblink_connect

View file

@ -226,21 +226,11 @@ connect_pg_server(ForeignServer *server, UserMapping *user)
conn = PQconnectdbParams(keywords, values, false); conn = PQconnectdbParams(keywords, values, false);
if (!conn || PQstatus(conn) != CONNECTION_OK) if (!conn || PQstatus(conn) != CONNECTION_OK)
{
char *connmessage;
int msglen;
/* libpq typically appends a newline, strip that */
connmessage = pstrdup(PQerrorMessage(conn));
msglen = strlen(connmessage);
if (msglen > 0 && connmessage[msglen - 1] == '\n')
connmessage[msglen - 1] = '\0';
ereport(ERROR, ereport(ERROR,
(errcode(ERRCODE_SQLCLIENT_UNABLE_TO_ESTABLISH_SQLCONNECTION), (errcode(ERRCODE_SQLCLIENT_UNABLE_TO_ESTABLISH_SQLCONNECTION),
errmsg("could not connect to server \"%s\"", errmsg("could not connect to server \"%s\"",
server->servername), server->servername),
errdetail_internal("%s", connmessage))); errdetail_internal("%s", pchomp(PQerrorMessage(conn)))));
}
/* /*
* Check that non-superuser has used password to establish connection; * Check that non-superuser has used password to establish connection;
@ -563,7 +553,7 @@ pgfdw_report_error(int elevel, PGresult *res, PGconn *conn,
* return NULL, not a PGresult at all. * return NULL, not a PGresult at all.
*/ */
if (message_primary == NULL) if (message_primary == NULL)
message_primary = PQerrorMessage(conn); message_primary = pchomp(PQerrorMessage(conn));
ereport(elevel, ereport(elevel,
(errcode(sqlstate), (errcode(sqlstate),

View file

@ -149,7 +149,7 @@ libpqrcv_connect(const char *conninfo, bool logical, const char *appname,
conn->streamConn = PQconnectdbParams(keys, vals, /* expand_dbname = */ true); conn->streamConn = PQconnectdbParams(keys, vals, /* expand_dbname = */ true);
if (PQstatus(conn->streamConn) != CONNECTION_OK) if (PQstatus(conn->streamConn) != CONNECTION_OK)
{ {
*err = pstrdup(PQerrorMessage(conn->streamConn)); *err = pchomp(PQerrorMessage(conn->streamConn));
return NULL; return NULL;
} }
@ -247,7 +247,7 @@ libpqrcv_identify_system(WalReceiverConn *conn, TimeLineID *primary_tli,
ereport(ERROR, ereport(ERROR,
(errmsg("could not receive database system identifier and timeline ID from " (errmsg("could not receive database system identifier and timeline ID from "
"the primary server: %s", "the primary server: %s",
PQerrorMessage(conn->streamConn)))); pchomp(PQerrorMessage(conn->streamConn)))));
} }
if (PQnfields(res) < 3 || PQntuples(res) != 1) if (PQnfields(res) < 3 || PQntuples(res) != 1)
{ {
@ -324,13 +324,13 @@ libpqrcv_startstreaming(WalReceiverConn *conn,
if (!pubnames_str) if (!pubnames_str)
ereport(ERROR, ereport(ERROR,
(errmsg("could not start WAL streaming: %s", (errmsg("could not start WAL streaming: %s",
PQerrorMessage(conn->streamConn)))); pchomp(PQerrorMessage(conn->streamConn)))));
pubnames_literal = PQescapeLiteral(conn->streamConn, pubnames_str, pubnames_literal = PQescapeLiteral(conn->streamConn, pubnames_str,
strlen(pubnames_str)); strlen(pubnames_str));
if (!pubnames_literal) if (!pubnames_literal)
ereport(ERROR, ereport(ERROR,
(errmsg("could not start WAL streaming: %s", (errmsg("could not start WAL streaming: %s",
PQerrorMessage(conn->streamConn)))); pchomp(PQerrorMessage(conn->streamConn)))));
appendStringInfo(&cmd, ", publication_names %s", pubnames_literal); appendStringInfo(&cmd, ", publication_names %s", pubnames_literal);
PQfreemem(pubnames_literal); PQfreemem(pubnames_literal);
pfree(pubnames_str); pfree(pubnames_str);
@ -355,7 +355,7 @@ libpqrcv_startstreaming(WalReceiverConn *conn,
PQclear(res); PQclear(res);
ereport(ERROR, ereport(ERROR,
(errmsg("could not start WAL streaming: %s", (errmsg("could not start WAL streaming: %s",
PQerrorMessage(conn->streamConn)))); pchomp(PQerrorMessage(conn->streamConn)))));
} }
PQclear(res); PQclear(res);
return true; return true;
@ -374,7 +374,7 @@ libpqrcv_endstreaming(WalReceiverConn *conn, TimeLineID *next_tli)
PQflush(conn->streamConn)) PQflush(conn->streamConn))
ereport(ERROR, ereport(ERROR,
(errmsg("could not send end-of-streaming message to primary: %s", (errmsg("could not send end-of-streaming message to primary: %s",
PQerrorMessage(conn->streamConn)))); pchomp(PQerrorMessage(conn->streamConn)))));
*next_tli = 0; *next_tli = 0;
@ -418,7 +418,7 @@ libpqrcv_endstreaming(WalReceiverConn *conn, TimeLineID *next_tli)
if (PQresultStatus(res) != PGRES_COMMAND_OK) if (PQresultStatus(res) != PGRES_COMMAND_OK)
ereport(ERROR, ereport(ERROR,
(errmsg("error reading result of streaming command: %s", (errmsg("error reading result of streaming command: %s",
PQerrorMessage(conn->streamConn)))); pchomp(PQerrorMessage(conn->streamConn)))));
PQclear(res); PQclear(res);
/* Verify that there are no more results */ /* Verify that there are no more results */
@ -426,7 +426,7 @@ libpqrcv_endstreaming(WalReceiverConn *conn, TimeLineID *next_tli)
if (res != NULL) if (res != NULL)
ereport(ERROR, ereport(ERROR,
(errmsg("unexpected result after CommandComplete: %s", (errmsg("unexpected result after CommandComplete: %s",
PQerrorMessage(conn->streamConn)))); pchomp(PQerrorMessage(conn->streamConn)))));
} }
/* /*
@ -453,7 +453,7 @@ libpqrcv_readtimelinehistoryfile(WalReceiverConn *conn,
ereport(ERROR, ereport(ERROR,
(errmsg("could not receive timeline history file from " (errmsg("could not receive timeline history file from "
"the primary server: %s", "the primary server: %s",
PQerrorMessage(conn->streamConn)))); pchomp(PQerrorMessage(conn->streamConn)))));
} }
if (PQnfields(res) != 2 || PQntuples(res) != 1) if (PQnfields(res) != 2 || PQntuples(res) != 1)
{ {
@ -611,7 +611,7 @@ libpqrcv_receive(WalReceiverConn *conn, char **buffer,
if (PQconsumeInput(conn->streamConn) == 0) if (PQconsumeInput(conn->streamConn) == 0)
ereport(ERROR, ereport(ERROR,
(errmsg("could not receive data from WAL stream: %s", (errmsg("could not receive data from WAL stream: %s",
PQerrorMessage(conn->streamConn)))); pchomp(PQerrorMessage(conn->streamConn)))));
/* Now that we've consumed some input, try again */ /* Now that we've consumed some input, try again */
rawlen = PQgetCopyData(conn->streamConn, &conn->recvBuf, 1); rawlen = PQgetCopyData(conn->streamConn, &conn->recvBuf, 1);
@ -638,13 +638,13 @@ libpqrcv_receive(WalReceiverConn *conn, char **buffer,
PQclear(res); PQclear(res);
ereport(ERROR, ereport(ERROR,
(errmsg("could not receive data from WAL stream: %s", (errmsg("could not receive data from WAL stream: %s",
PQerrorMessage(conn->streamConn)))); pchomp(PQerrorMessage(conn->streamConn)))));
} }
} }
if (rawlen < -1) if (rawlen < -1)
ereport(ERROR, ereport(ERROR,
(errmsg("could not receive data from WAL stream: %s", (errmsg("could not receive data from WAL stream: %s",
PQerrorMessage(conn->streamConn)))); pchomp(PQerrorMessage(conn->streamConn)))));
/* Return received messages to caller */ /* Return received messages to caller */
*buffer = conn->recvBuf; *buffer = conn->recvBuf;
@ -663,7 +663,7 @@ libpqrcv_send(WalReceiverConn *conn, const char *buffer, int nbytes)
PQflush(conn->streamConn)) PQflush(conn->streamConn))
ereport(ERROR, ereport(ERROR,
(errmsg("could not send data to WAL stream: %s", (errmsg("could not send data to WAL stream: %s",
PQerrorMessage(conn->streamConn)))); pchomp(PQerrorMessage(conn->streamConn)))));
} }
/* /*
@ -697,7 +697,7 @@ libpqrcv_create_slot(WalReceiverConn *conn, const char *slotname,
PQclear(res); PQclear(res);
ereport(ERROR, ereport(ERROR,
(errmsg("could not create replication slot \"%s\": %s", (errmsg("could not create replication slot \"%s\": %s",
slotname, PQerrorMessage(conn->streamConn)))); slotname, pchomp(PQerrorMessage(conn->streamConn)))));
} }
*lsn = DatumGetLSN(DirectFunctionCall1Coll(pg_lsn_in, InvalidOid, *lsn = DatumGetLSN(DirectFunctionCall1Coll(pg_lsn_in, InvalidOid,
@ -728,7 +728,7 @@ libpqrcv_command(WalReceiverConn *conn, const char *cmd, char **err)
if (PQresultStatus(res) != PGRES_COMMAND_OK) if (PQresultStatus(res) != PGRES_COMMAND_OK)
{ {
PQclear(res); PQclear(res);
*err = pstrdup(PQerrorMessage(conn->streamConn)); *err = pchomp(PQerrorMessage(conn->streamConn));
return false; return false;
} }

View file

@ -1181,3 +1181,17 @@ pnstrdup(const char *in, Size len)
out[len] = '\0'; out[len] = '\0';
return out; return out;
} }
/*
* Make copy of string with all trailing newline characters removed.
*/
char *
pchomp(const char *in)
{
size_t n;
n = strlen(in);
while (n > 0 && in[n - 1] == '\n')
n--;
return pnstrdup(in, n);
}

View file

@ -127,6 +127,8 @@ extern char *MemoryContextStrdup(MemoryContext context, const char *string);
extern char *pstrdup(const char *in); extern char *pstrdup(const char *in);
extern char *pnstrdup(const char *in, Size len); extern char *pnstrdup(const char *in, Size len);
extern char *pchomp(const char *in);
/* sprintf into a palloc'd buffer --- these are in psprintf.c */ /* sprintf into a palloc'd buffer --- these are in psprintf.c */
extern char *psprintf(const char *fmt,...) pg_attribute_printf(1, 2); extern char *psprintf(const char *fmt,...) pg_attribute_printf(1, 2);
extern size_t pvsnprintf(char *buf, size_t len, const char *fmt, va_list args) pg_attribute_printf(3, 0); extern size_t pvsnprintf(char *buf, size_t len, const char *fmt, va_list args) pg_attribute_printf(3, 0);