PostgreSQL Source Code  git master
common.h File Reference
#include <setjmp.h>
#include <signal.h>
#include "fe_utils/print.h"
#include "fe_utils/psqlscan.h"
#include "libpq-fe.h"
Include dependency graph for common.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

bool openQueryOutputFile (const char *fname, FILE **fout, bool *is_pipe)
 
bool setQFout (const char *fname)
 
char * psql_get_variable (const char *varname, PsqlScanQuoteType quote, void *passthrough)
 
void NoticeProcessor (void *arg, const char *message)
 
void psql_setup_cancel_handler (void)
 
void SetShellResultVariables (int wait_result)
 
PGresultPSQLexec (const char *query)
 
int PSQLexecWatch (const char *query, const printQueryOpt *opt, FILE *printQueryFout, int min_rows)
 
bool SendQuery (const char *query)
 
bool is_superuser (void)
 
bool standard_strings (void)
 
const char * session_username (void)
 
void expand_tilde (char **filename)
 
bool recognized_connection_string (const char *connstr)
 

Variables

volatile sig_atomic_t sigint_interrupt_enabled
 
sigjmp_buf sigint_interrupt_jmp
 

Function Documentation

◆ expand_tilde()

void expand_tilde ( char **  filename)

Definition at line 2348 of file common.c.

2349 {
2350  if (!filename || !(*filename))
2351  return;
2352 
2353  /*
2354  * WIN32 doesn't use tilde expansion for file names. Also, it uses tilde
2355  * for short versions of long file names, though the tilde is usually
2356  * toward the end, not at the beginning.
2357  */
2358 #ifndef WIN32
2359 
2360  /* try tilde expansion */
2361  if (**filename == '~')
2362  {
2363  char *fn;
2364  char oldp,
2365  *p;
2366  struct passwd *pw;
2367  char home[MAXPGPATH];
2368 
2369  fn = *filename;
2370  *home = '\0';
2371 
2372  p = fn + 1;
2373  while (*p != '/' && *p != '\0')
2374  p++;
2375 
2376  oldp = *p;
2377  *p = '\0';
2378 
2379  if (*(fn + 1) == '\0')
2380  get_home_path(home); /* ~ or ~/ only */
2381  else if ((pw = getpwnam(fn + 1)) != NULL)
2382  strlcpy(home, pw->pw_dir, sizeof(home)); /* ~user */
2383 
2384  *p = oldp;
2385  if (strlen(home) != 0)
2386  {
2387  char *newfn;
2388 
2389  newfn = psprintf("%s%s", home, p);
2390  free(fn);
2391  *filename = newfn;
2392  }
2393  }
2394 #endif
2395 }
#define free(a)
Definition: header.h:65
#define MAXPGPATH
static char * filename
Definition: pg_dumpall.c:119
bool get_home_path(char *ret_path)
Definition: path.c:928
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: strlcpy.c:45
char * psprintf(const char *fmt,...)
Definition: psprintf.c:46
static void * fn(void *arg)
Definition: thread-alloc.c:119

References filename, fn(), free, get_home_path(), MAXPGPATH, psprintf(), and strlcpy().

Referenced by exec_command_edit(), exec_command_g(), exec_command_include(), exec_command_lo(), exec_command_out(), exec_command_s(), exec_command_write(), initializeInput(), parse_slash_copy(), and process_psqlrc().

◆ is_superuser()

bool is_superuser ( void  )

Definition at line 2287 of file common.c.

2288 {
2289  const char *val;
2290 
2291  if (!pset.db)
2292  return false;
2293 
2294  val = PQparameterStatus(pset.db, "is_superuser");
2295 
2296  if (val && strcmp(val, "on") == 0)
2297  return true;
2298 
2299  return false;
2300 }
const char * PQparameterStatus(const PGconn *conn, const char *paramName)
Definition: fe-connect.c:7213
long val
Definition: informix.c:664
PsqlSettings pset
Definition: startup.c:32
PGconn * db
Definition: settings.h:82

References _psqlSettings::db, PQparameterStatus(), pset, and val.

◆ NoticeProcessor()

void NoticeProcessor ( void *  arg,
const char *  message 
)

Definition at line 229 of file common.c.

230 {
231  (void) arg; /* not used */
232  pg_log_info("%s", message);
233 }
#define pg_log_info(...)
Definition: logging.h:124
void * arg

References arg, and pg_log_info.

Referenced by do_connect(), and main().

◆ openQueryOutputFile()

bool openQueryOutputFile ( const char *  fname,
FILE **  fout,
bool is_pipe 
)

Definition at line 58 of file common.c.

59 {
60  if (!fname || fname[0] == '\0')
61  {
62  *fout = stdout;
63  *is_pipe = false;
64  }
65  else if (*fname == '|')
66  {
67  fflush(NULL);
68  *fout = popen(fname + 1, "w");
69  *is_pipe = true;
70  }
71  else
72  {
73  *fout = fopen(fname, "w");
74  *is_pipe = false;
75  }
76 
77  if (*fout == NULL)
78  {
79  pg_log_error("%s: %m", fname);
80  return false;
81  }
82 
83  return true;
84 }
static void const char fflush(stdout)
#define pg_log_error(...)
Definition: logging.h:106

References fflush(), pg_log_error, and generate_unaccent_rules::stdout.

Referenced by ExecQueryAndProcessResults(), ExecQueryUsingCursor(), and setQFout().

◆ psql_get_variable()

char* psql_get_variable ( const char *  varname,
PsqlScanQuoteType  quote,
void *  passthrough 
)

Definition at line 138 of file common.c.

140 {
141  char *result = NULL;
142  const char *value;
143 
144  /* In an inactive \if branch, suppress all variable substitutions */
145  if (passthrough && !conditional_active((ConditionalStack) passthrough))
146  return NULL;
147 
148  value = GetVariable(pset.vars, varname);
149  if (!value)
150  return NULL;
151 
152  switch (quote)
153  {
154  case PQUOTE_PLAIN:
155  result = pg_strdup(value);
156  break;
157  case PQUOTE_SQL_LITERAL:
158  case PQUOTE_SQL_IDENT:
159  {
160  /*
161  * For these cases, we use libpq's quoting functions, which
162  * assume the string is in the connection's client encoding.
163  */
164  char *escaped_value;
165 
166  if (!pset.db)
167  {
168  pg_log_error("cannot escape without active connection");
169  return NULL;
170  }
171 
172  if (quote == PQUOTE_SQL_LITERAL)
173  escaped_value =
174  PQescapeLiteral(pset.db, value, strlen(value));
175  else
176  escaped_value =
177  PQescapeIdentifier(pset.db, value, strlen(value));
178 
179  if (escaped_value == NULL)
180  {
181  const char *error = PQerrorMessage(pset.db);
182 
183  pg_log_info("%s", error);
184  return NULL;
185  }
186 
187  /*
188  * Rather than complicate the lexer's API with a notion of
189  * which free() routine to use, just pay the price of an extra
190  * strdup().
191  */
192  result = pg_strdup(escaped_value);
193  PQfreemem(escaped_value);
194  break;
195  }
196  case PQUOTE_SHELL_ARG:
197  {
198  /*
199  * For this we use appendShellStringNoError, which is
200  * encoding-agnostic, which is fine since the shell probably
201  * is too. In any case, the only special character is "'",
202  * which is not known to appear in valid multibyte characters.
203  */
205 
208  {
209  pg_log_error("shell command argument contains a newline or carriage return: \"%s\"",
210  value);
211  free(buf.data);
212  return NULL;
213  }
214  result = buf.data;
215  break;
216  }
217 
218  /* No default: we want a compiler warning for missing cases */
219  }
220 
221  return result;
222 }
bool conditional_active(ConditionalStack cstack)
Definition: conditional.c:140
char * PQerrorMessage(const PGconn *conn)
Definition: fe-connect.c:7248
void PQfreemem(void *ptr)
Definition: fe-exec.c:3946
char * PQescapeIdentifier(PGconn *conn, const char *str, size_t len)
Definition: fe-exec.c:4224
char * PQescapeLiteral(PGconn *conn, const char *str, size_t len)
Definition: fe-exec.c:4218
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
static struct @148 value
static char * buf
Definition: pg_test_fsync.c:67
void initPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:90
@ PQUOTE_SQL_LITERAL
Definition: psqlscan.h:55
@ PQUOTE_PLAIN
Definition: psqlscan.h:54
@ PQUOTE_SHELL_ARG
Definition: psqlscan.h:57
@ PQUOTE_SQL_IDENT
Definition: psqlscan.h:56
static void error(void)
Definition: sql-dyntest.c:147
bool appendShellStringNoError(PQExpBuffer buf, const char *str)
Definition: string_utils.c:441
VariableSpace vars
Definition: settings.h:122
const char * GetVariable(VariableSpace space, const char *name)
Definition: variables.c:71

References appendShellStringNoError(), buf, conditional_active(), _psqlSettings::db, error(), free, GetVariable(), initPQExpBuffer(), pg_log_error, pg_log_info, pg_strdup(), PQerrorMessage(), PQescapeIdentifier(), PQescapeLiteral(), PQfreemem(), PQUOTE_PLAIN, PQUOTE_SHELL_ARG, PQUOTE_SQL_IDENT, PQUOTE_SQL_LITERAL, pset, value, and _psqlSettings::vars.

◆ psql_setup_cancel_handler()

void psql_setup_cancel_handler ( void  )

Definition at line 275 of file common.c.

276 {
278 }
static void setup_cancel_handler(void)
Definition: parallel.c:608
static void psql_cancel_callback(void)
Definition: common.c:259

References psql_cancel_callback(), and setup_cancel_handler().

Referenced by main().

◆ PSQLexec()

PGresult* PSQLexec ( const char *  query)

Definition at line 581 of file common.c.

582 {
583  PGresult *res;
584 
585  if (!pset.db)
586  {
587  pg_log_error("You are currently not connected to a database.");
588  return NULL;
589  }
590 
592  {
593  printf(_("/******** QUERY *********/\n"
594  "%s\n"
595  "/************************/\n\n"), query);
596  fflush(stdout);
597  if (pset.logfile)
598  {
600  _("/******** QUERY *********/\n"
601  "%s\n"
602  "/************************/\n\n"), query);
604  }
605 
607  return NULL;
608  }
609 
611 
612  res = PQexec(pset.db, query);
613 
614  ResetCancelConn();
615 
616  if (!AcceptResult(res, true))
617  {
619  res = NULL;
620  }
621 
622  return res;
623 }
static void ClearOrSaveResult(PGresult *result)
Definition: common.c:484
static bool AcceptResult(const PGresult *result, bool show_error)
Definition: common.c:365
void ResetCancelConn(void)
Definition: cancel.c:107
void SetCancelConn(PGconn *conn)
Definition: cancel.c:77
#define _(x)
Definition: elog.c:91
PGresult * PQexec(PGconn *conn, const char *query)
Definition: fe-exec.c:2228
#define fprintf
Definition: port.h:242
#define printf(...)
Definition: port.h:244
@ PSQL_ECHO_HIDDEN_NOEXEC
Definition: settings.h:47
@ PSQL_ECHO_HIDDEN_OFF
Definition: settings.h:45
FILE * logfile
Definition: settings.h:120
PSQL_ECHO_HIDDEN echo_hidden
Definition: settings.h:147

References _, AcceptResult(), ClearOrSaveResult(), _psqlSettings::db, _psqlSettings::echo_hidden, fflush(), fprintf, _psqlSettings::logfile, pg_log_error, PQexec(), printf, pset, PSQL_ECHO_HIDDEN_NOEXEC, PSQL_ECHO_HIDDEN_OFF, res, ResetCancelConn(), SetCancelConn(), and generate_unaccent_rules::stdout.

Referenced by add_tablespace_footer(), addFooterToPublicationDesc(), describeAccessMethods(), describeAggregates(), describeConfigurationParameters(), describeFunctions(), describeOneTableDetails(), describeOneTSConfig(), describeOneTSParser(), describeOperators(), describePublications(), describeRoleGrants(), describeRoles(), describeSubscriptions(), describeTableDetails(), describeTablespaces(), describeTypes(), do_lo_import(), exec_command_password(), fail_lo_xact(), finish_lo_xact(), listAllDbs(), listCasts(), listCollations(), listConversions(), listDbRoleSettings(), listDefaultACLs(), listDomains(), listEventTriggers(), listExtendedStats(), listExtensionContents(), listExtensions(), listForeignDataWrappers(), listForeignServers(), listForeignTables(), listLanguages(), listLargeObjects(), listOneExtensionContents(), listOperatorClasses(), listOperatorFamilies(), listOpFamilyFunctions(), listOpFamilyOperators(), listPartitionedTables(), listPublications(), listSchemas(), listTables(), listTSConfigs(), listTSConfigsVerbose(), listTSDictionaries(), listTSParsers(), listTSParsersVerbose(), listTSTemplates(), listUserMappings(), main(), objectDescription(), permissionsList(), and start_lo_xact().

◆ PSQLexecWatch()

int PSQLexecWatch ( const char *  query,
const printQueryOpt opt,
FILE *  printQueryFout,
int  min_rows 
)

Definition at line 636 of file common.c.

637 {
638  bool timing = pset.timing;
639  double elapsed_msec = 0;
640  int res;
641 
642  if (!pset.db)
643  {
644  pg_log_error("You are currently not connected to a database.");
645  return 0;
646  }
647 
649 
650  res = ExecQueryAndProcessResults(query, &elapsed_msec, NULL, true, min_rows, opt, printQueryFout);
651 
652  ResetCancelConn();
653 
654  /* Possible microtiming output */
655  if (timing)
656  PrintTiming(elapsed_msec);
657 
658  return res;
659 }
static int ExecQueryAndProcessResults(const char *query, double *elapsed_msec, bool *svpt_gone_p, bool is_watch, int min_rows, const printQueryOpt *opt, FILE *printQueryFout)
Definition: common.c:1417
static void PrintTiming(double elapsed_msec)
Definition: common.c:522

References _psqlSettings::db, ExecQueryAndProcessResults(), pg_log_error, PrintTiming(), pset, res, ResetCancelConn(), SetCancelConn(), and _psqlSettings::timing.

Referenced by do_watch().

◆ recognized_connection_string()

bool recognized_connection_string ( const char *  connstr)

Definition at line 2433 of file common.c.

2434 {
2435  return uri_prefix_length(connstr) != 0 || strchr(connstr, '=') != NULL;
2436 }
static int uri_prefix_length(const char *connstr)
Definition: common.c:2406
static char * connstr
Definition: pg_dumpall.c:88

References connstr, and uri_prefix_length().

Referenced by do_connect().

◆ SendQuery()

bool SendQuery ( const char *  query)

Definition at line 1043 of file common.c.

1044 {
1045  bool timing = pset.timing;
1046  PGTransactionStatusType transaction_status;
1047  double elapsed_msec = 0;
1048  bool OK = false;
1049  int i;
1050  bool on_error_rollback_savepoint = false;
1051  bool svpt_gone = false;
1052 
1053  if (!pset.db)
1054  {
1055  pg_log_error("You are currently not connected to a database.");
1056  goto sendquery_cleanup;
1057  }
1058 
1059  if (pset.singlestep)
1060  {
1061  char buf[3];
1062 
1063  fflush(stderr);
1064  printf(_("/**(Single step mode: verify command)******************************************/\n"
1065  "%s\n"
1066  "/**(press return to proceed or enter x and return to cancel)*******************/\n"),
1067  query);
1068  fflush(stdout);
1069  if (fgets(buf, sizeof(buf), stdin) != NULL)
1070  if (buf[0] == 'x')
1071  goto sendquery_cleanup;
1072  if (cancel_pressed)
1073  goto sendquery_cleanup;
1074  }
1075  else if (pset.echo == PSQL_ECHO_QUERIES)
1076  {
1077  puts(query);
1078  fflush(stdout);
1079  }
1080 
1081  if (pset.logfile)
1082  {
1084  _("/******** QUERY *********/\n"
1085  "%s\n"
1086  "/************************/\n\n"), query);
1087  fflush(pset.logfile);
1088  }
1089 
1091 
1092  transaction_status = PQtransactionStatus(pset.db);
1093 
1094  if (transaction_status == PQTRANS_IDLE &&
1095  !pset.autocommit &&
1096  !command_no_begin(query))
1097  {
1098  PGresult *result;
1099 
1100  result = PQexec(pset.db, "BEGIN");
1101  if (PQresultStatus(result) != PGRES_COMMAND_OK)
1102  {
1104  ClearOrSaveResult(result);
1105  goto sendquery_cleanup;
1106  }
1107  ClearOrSaveResult(result);
1108  transaction_status = PQtransactionStatus(pset.db);
1109  }
1110 
1111  if (transaction_status == PQTRANS_INTRANS &&
1115  {
1116  PGresult *result;
1117 
1118  result = PQexec(pset.db, "SAVEPOINT pg_psql_temporary_savepoint");
1119  if (PQresultStatus(result) != PGRES_COMMAND_OK)
1120  {
1122  ClearOrSaveResult(result);
1123  goto sendquery_cleanup;
1124  }
1125  ClearOrSaveResult(result);
1126  on_error_rollback_savepoint = true;
1127  }
1128 
1129  if (pset.gdesc_flag)
1130  {
1131  /* Describe query's result columns, without executing it */
1132  OK = DescribeQuery(query, &elapsed_msec);
1133  }
1134  else if (pset.fetch_count <= 0 || pset.gexec_flag ||
1136  {
1137  /* Default fetch-it-all-and-print mode */
1138  OK = (ExecQueryAndProcessResults(query, &elapsed_msec, &svpt_gone, false, 0, NULL, NULL) > 0);
1139  }
1140  else
1141  {
1142  /* Fetch-in-segments mode */
1143  OK = ExecQueryUsingCursor(query, &elapsed_msec);
1144  }
1145 
1146  if (!OK && pset.echo == PSQL_ECHO_ERRORS)
1147  pg_log_info("STATEMENT: %s", query);
1148 
1149  /* If we made a temporary savepoint, possibly release/rollback */
1150  if (on_error_rollback_savepoint)
1151  {
1152  const char *svptcmd = NULL;
1153 
1154  transaction_status = PQtransactionStatus(pset.db);
1155 
1156  switch (transaction_status)
1157  {
1158  case PQTRANS_INERROR:
1159  /* We always rollback on an error */
1160  svptcmd = "ROLLBACK TO pg_psql_temporary_savepoint";
1161  break;
1162 
1163  case PQTRANS_IDLE:
1164  /* If they are no longer in a transaction, then do nothing */
1165  break;
1166 
1167  case PQTRANS_INTRANS:
1168 
1169  /*
1170  * Release our savepoint, but do nothing if they are messing
1171  * with savepoints themselves
1172  */
1173  if (!svpt_gone)
1174  svptcmd = "RELEASE pg_psql_temporary_savepoint";
1175  break;
1176 
1177  case PQTRANS_ACTIVE:
1178  case PQTRANS_UNKNOWN:
1179  default:
1180  OK = false;
1181  /* PQTRANS_UNKNOWN is expected given a broken connection. */
1182  if (transaction_status != PQTRANS_UNKNOWN || ConnectionUp())
1183  pg_log_error("unexpected transaction status (%d)",
1184  transaction_status);
1185  break;
1186  }
1187 
1188  if (svptcmd)
1189  {
1190  PGresult *svptres;
1191 
1192  svptres = PQexec(pset.db, svptcmd);
1193  if (PQresultStatus(svptres) != PGRES_COMMAND_OK)
1194  {
1196  ClearOrSaveResult(svptres);
1197  OK = false;
1198 
1199  goto sendquery_cleanup;
1200  }
1201  PQclear(svptres);
1202  }
1203  }
1204 
1205  /* Possible microtiming output */
1206  if (timing)
1207  PrintTiming(elapsed_msec);
1208 
1209  /* check for events that may occur during query execution */
1210 
1211  if (pset.encoding != PQclientEncoding(pset.db) &&
1212  PQclientEncoding(pset.db) >= 0)
1213  {
1214  /* track effects of SET CLIENT_ENCODING */
1217  SetVariable(pset.vars, "ENCODING",
1219  }
1220 
1222 
1223  /* perform cleanup that should occur after any attempted query */
1224 
1225 sendquery_cleanup:
1226 
1227  /* global cancellation reset */
1228  ResetCancelConn();
1229 
1230  /* reset \g's output-to-filename trigger */
1231  if (pset.gfname)
1232  {
1233  free(pset.gfname);
1234  pset.gfname = NULL;
1235  }
1236 
1237  /* restore print settings if \g changed them */
1238  if (pset.gsavepopt)
1239  {
1241  pset.gsavepopt = NULL;
1242  }
1243 
1244  /* clean up after \bind */
1245  if (pset.bind_flag)
1246  {
1247  for (i = 0; i < pset.bind_nparams; i++)
1248  free(pset.bind_params[i]);
1250  pset.bind_params = NULL;
1251  pset.bind_flag = false;
1252  }
1253 
1254  /* reset \gset trigger */
1255  if (pset.gset_prefix)
1256  {
1258  pset.gset_prefix = NULL;
1259  }
1260 
1261  /* reset \gdesc trigger */
1262  pset.gdesc_flag = false;
1263 
1264  /* reset \gexec trigger */
1265  pset.gexec_flag = false;
1266 
1267  /* reset \crosstabview trigger */
1268  pset.crosstab_flag = false;
1269  for (i = 0; i < lengthof(pset.ctv_args); i++)
1270  {
1271  pg_free(pset.ctv_args[i]);
1272  pset.ctv_args[i] = NULL;
1273  }
1274 
1275  return OK;
1276 }
static bool DescribeQuery(const char *query, double *elapsed_msec)
Definition: common.c:1288
static bool ExecQueryUsingCursor(const char *query, double *elapsed_msec)
Definition: common.c:1710
static void PrintNotifications(void)
Definition: common.c:666
static bool is_select_command(const char *query)
Definition: common.c:2250
static bool ConnectionUp(void)
Definition: common.c:286
static bool command_no_begin(const char *query)
Definition: common.c:2035
#define lengthof(array)
Definition: c.h:777
void restorePsetInfo(printQueryOpt *popt, printQueryOpt *save)
Definition: command.c:4977
const char * pg_encoding_to_char(int encoding)
Definition: encnames.c:588
PGTransactionStatusType PQtransactionStatus(const PGconn *conn)
Definition: fe-connect.c:7203
int PQclientEncoding(const PGconn *conn)
Definition: fe-connect.c:7336
ExecStatusType PQresultStatus(const PGresult *res)
Definition: fe-exec.c:3325
void pg_free(void *ptr)
Definition: fe_memutils.c:105
volatile sig_atomic_t cancel_pressed
Definition: print.c:43
int i
Definition: isn.c:73
@ PGRES_COMMAND_OK
Definition: libpq-fe.h:97
PGTransactionStatusType
Definition: libpq-fe.h:117
@ PQTRANS_INTRANS
Definition: libpq-fe.h:120
@ PQTRANS_IDLE
Definition: libpq-fe.h:118
@ PQTRANS_ACTIVE
Definition: libpq-fe.h:119
@ PQTRANS_UNKNOWN
Definition: libpq-fe.h:122
@ PQTRANS_INERROR
Definition: libpq-fe.h:121
@ PSQL_ERROR_ROLLBACK_ON
Definition: settings.h:54
@ PSQL_ERROR_ROLLBACK_OFF
Definition: settings.h:52
@ PSQL_ECHO_ERRORS
Definition: settings.h:39
@ PSQL_ECHO_QUERIES
Definition: settings.h:38
printQueryOpt popt
Definition: settings.h:91
bool bind_flag
Definition: settings.h:99
char * gset_prefix
Definition: settings.h:96
PSQL_ERROR_ROLLBACK on_error_rollback
Definition: settings.h:148
int encoding
Definition: settings.h:83
bool autocommit
Definition: settings.h:136
char * ctv_args[4]
Definition: settings.h:104
char ** bind_params
Definition: settings.h:102
PSQL_ECHO echo
Definition: settings.h:146
bool singlestep
Definition: settings.h:140
printQueryOpt * gsavepopt
Definition: settings.h:94
char * gfname
Definition: settings.h:93
int fetch_count
Definition: settings.h:143
bool cur_cmd_interactive
Definition: settings.h:111
bool gexec_flag
Definition: settings.h:98
bool crosstab_flag
Definition: settings.h:103
bool gdesc_flag
Definition: settings.h:97
int bind_nparams
Definition: settings.h:101
printTableOpt topt
Definition: print.h:185
int encoding
Definition: print.h:138
bool SetVariable(VariableSpace space, const char *name, const char *value)
Definition: variables.c:211

References _, _psqlSettings::autocommit, _psqlSettings::bind_flag, _psqlSettings::bind_nparams, _psqlSettings::bind_params, buf, cancel_pressed, ClearOrSaveResult(), command_no_begin(), ConnectionUp(), _psqlSettings::crosstab_flag, _psqlSettings::ctv_args, _psqlSettings::cur_cmd_interactive, _psqlSettings::db, DescribeQuery(), _psqlSettings::echo, _psqlSettings::encoding, printTableOpt::encoding, ExecQueryAndProcessResults(), ExecQueryUsingCursor(), _psqlSettings::fetch_count, fflush(), fprintf, free, _psqlSettings::gdesc_flag, _psqlSettings::gexec_flag, _psqlSettings::gfname, _psqlSettings::gsavepopt, _psqlSettings::gset_prefix, i, is_select_command(), lengthof, _psqlSettings::logfile, _psqlSettings::on_error_rollback, pg_encoding_to_char(), pg_free(), pg_log_error, pg_log_info, PGRES_COMMAND_OK, _psqlSettings::popt, PQclear(), PQclientEncoding(), PQerrorMessage(), PQexec(), PQresultStatus(), PQTRANS_ACTIVE, PQTRANS_IDLE, PQTRANS_INERROR, PQTRANS_INTRANS, PQTRANS_UNKNOWN, PQtransactionStatus(), printf, PrintNotifications(), PrintTiming(), pset, PSQL_ECHO_ERRORS, PSQL_ECHO_QUERIES, PSQL_ERROR_ROLLBACK_OFF, PSQL_ERROR_ROLLBACK_ON, ResetCancelConn(), restorePsetInfo(), SetCancelConn(), SetVariable(), _psqlSettings::singlestep, generate_unaccent_rules::stdout, _psqlSettings::timing, printQueryOpt::topt, and _psqlSettings::vars.

Referenced by do_copy(), ExecQueryTuples(), main(), and MainLoop().

◆ session_username()

const char* session_username ( void  )

Definition at line 2327 of file common.c.

2328 {
2329  const char *val;
2330 
2331  if (!pset.db)
2332  return NULL;
2333 
2334  val = PQparameterStatus(pset.db, "session_authorization");
2335  if (val)
2336  return val;
2337  else
2338  return PQuser(pset.db);
2339 }
char * PQuser(const PGconn *conn)
Definition: fe-connect.c:7102

References _psqlSettings::db, PQparameterStatus(), PQuser(), pset, and val.

Referenced by get_prompt().

◆ setQFout()

bool setQFout ( const char *  fname)

Definition at line 94 of file common.c.

95 {
96  FILE *fout;
97  bool is_pipe;
98 
99  /* First make sure we can open the new output file/pipe */
100  if (!openQueryOutputFile(fname, &fout, &is_pipe))
101  return false;
102 
103  /* Close old file/pipe */
104  if (pset.queryFout && pset.queryFout != stdout && pset.queryFout != stderr)
105  {
106  if (pset.queryFoutPipe)
108  else
109  fclose(pset.queryFout);
110  }
111 
112  pset.queryFout = fout;
113  pset.queryFoutPipe = is_pipe;
114 
115  /* Adjust SIGPIPE handling appropriately: ignore signal if is_pipe */
116  set_sigpipe_trap_state(is_pipe);
118 
119  return true;
120 }
void SetShellResultVariables(int wait_result)
Definition: common.c:462
bool openQueryOutputFile(const char *fname, FILE **fout, bool *is_pipe)
Definition: common.c:58
void restore_sigpipe_trap(void)
Definition: print.c:3062
void set_sigpipe_trap_state(bool ignore)
Definition: print.c:3075
FILE * queryFout
Definition: settings.h:84
bool queryFoutPipe
Definition: settings.h:85

References openQueryOutputFile(), pset, _psqlSettings::queryFout, _psqlSettings::queryFoutPipe, restore_sigpipe_trap(), set_sigpipe_trap_state(), SetShellResultVariables(), and generate_unaccent_rules::stdout.

Referenced by exec_command_out(), main(), and parse_psql_options().

◆ SetShellResultVariables()

void SetShellResultVariables ( int  wait_result)

Definition at line 462 of file common.c.

463 {
464  char buf[32];
465 
466  SetVariable(pset.vars, "SHELL_ERROR",
467  (wait_result == 0) ? "false" : "true");
468  snprintf(buf, sizeof(buf), "%d", wait_result_to_exit_code(wait_result));
469  SetVariable(pset.vars, "SHELL_EXIT_CODE", buf);
470 }
#define snprintf
Definition: port.h:238
int wait_result_to_exit_code(int exit_status)
Definition: wait_error.c:138

References buf, pset, SetVariable(), snprintf, _psqlSettings::vars, and wait_result_to_exit_code().

Referenced by do_copy(), do_shell(), exec_command_write(), ExecQueryAndProcessResults(), ExecQueryUsingCursor(), and setQFout().

◆ standard_strings()

bool standard_strings ( void  )

Definition at line 2307 of file common.c.

2308 {
2309  const char *val;
2310 
2311  if (!pset.db)
2312  return false;
2313 
2314  val = PQparameterStatus(pset.db, "standard_conforming_strings");
2315 
2316  if (val && strcmp(val, "on") == 0)
2317  return true;
2318 
2319  return false;
2320 }

References _psqlSettings::db, PQparameterStatus(), pset, and val.

Referenced by get_create_object_cmd(), main(), MainLoop(), and parse_slash_copy().

Variable Documentation

◆ sigint_interrupt_enabled

volatile sig_atomic_t sigint_interrupt_enabled
extern

◆ sigint_interrupt_jmp

sigjmp_buf sigint_interrupt_jmp
extern