Age Owner Branch data TLA Line data Source code
1 : : /*
2 : : * psql - the PostgreSQL interactive terminal
3 : : *
4 : : * Copyright (c) 2000-2026, PostgreSQL Global Development Group
5 : : *
6 : : * src/bin/psql/startup.c
7 : : */
8 : : #include "postgres_fe.h"
9 : :
10 : : #ifndef WIN32
11 : : #include <unistd.h>
12 : : #else /* WIN32 */
13 : : #include <io.h>
14 : : #include <win32.h>
15 : : #endif /* WIN32 */
16 : :
17 : : #include "command.h"
18 : : #include "common.h"
19 : : #include "common/logging.h"
20 : : #include "common/string.h"
21 : : #include "describe.h"
22 : : #include "fe_utils/print.h"
23 : : #include "getopt_long.h"
24 : : #include "help.h"
25 : : #include "input.h"
26 : : #include "mainloop.h"
27 : : #include "portability/instr_time.h"
28 : : #include "settings.h"
29 : :
30 : : /*
31 : : * Global psql options
32 : : */
33 : : PsqlSettings pset;
34 : :
35 : : #ifndef WIN32
36 : : #define SYSPSQLRC "psqlrc"
37 : : #define PSQLRC ".psqlrc"
38 : : #else
39 : : #define SYSPSQLRC "psqlrc"
40 : : #define PSQLRC "psqlrc.conf"
41 : : #endif
42 : :
43 : : /*
44 : : * Structures to pass information between the option parsing routine
45 : : * and the main function
46 : : */
47 : : enum _actions
48 : : {
49 : : ACT_SINGLE_QUERY,
50 : : ACT_SINGLE_SLASH,
51 : : ACT_FILE,
52 : : };
53 : :
54 : : typedef struct SimpleActionListCell
55 : : {
56 : : struct SimpleActionListCell *next;
57 : : enum _actions action;
58 : : char *val;
59 : : } SimpleActionListCell;
60 : :
61 : : typedef struct SimpleActionList
62 : : {
63 : : SimpleActionListCell *head;
64 : : SimpleActionListCell *tail;
65 : : } SimpleActionList;
66 : :
67 : : struct adhoc_opts
68 : : {
69 : : char *dbname;
70 : : char *host;
71 : : char *port;
72 : : char *username;
73 : : char *logfilename;
74 : : bool no_readline;
75 : : bool no_psqlrc;
76 : : bool single_txn;
77 : : bool list_dbs;
78 : : SimpleActionList actions;
79 : : };
80 : :
81 : : static void parse_psql_options(int argc, char *argv[],
82 : : struct adhoc_opts *options);
83 : : static void simple_action_list_append(SimpleActionList *list,
84 : : enum _actions action, const char *val);
85 : : static void process_psqlrc(char *argv0);
86 : : static void process_psqlrc_file(char *filename);
87 : : static void showVersion(void);
88 : : static void EstablishVariableSpace(void);
89 : :
90 : : #define NOPAGER 0
91 : :
92 : : static void
2673 peter@eisentraut.org 93 :CBC 48379 : log_pre_callback(void)
94 : : {
95 [ + - - + ]: 48379 : if (pset.queryFout && pset.queryFout != stdout)
2673 peter@eisentraut.org 96 :UBC 0 : fflush(pset.queryFout);
2673 peter@eisentraut.org 97 :CBC 48379 : }
98 : :
99 : : static void
100 : 48379 : log_locus_callback(const char **filename, uint64 *lineno)
101 : : {
102 [ + + ]: 48379 : if (pset.inputfile)
103 : : {
104 : 736 : *filename = pset.inputfile;
2622 tgl@sss.pgh.pa.us 105 : 736 : *lineno = pset.lineno;
106 : : }
107 : : else
108 : : {
2673 peter@eisentraut.org 109 : 47643 : *filename = NULL;
110 : 47643 : *lineno = 0;
111 : : }
112 : 48379 : }
113 : :
114 : : #ifndef WIN32
115 : : static void
1839 tmunro@postgresql.or 116 : 8 : empty_signal_handler(SIGNAL_ARGS)
117 : : {
118 : 8 : }
119 : : #endif
120 : :
121 : : /*
122 : : *
123 : : * main
124 : : *
125 : : */
126 : : int
9666 peter_e@gmx.net 127 : 10585 : main(int argc, char *argv[])
128 : : {
129 : : struct adhoc_opts options;
130 : : int successResult;
2152 tgl@sss.pgh.pa.us 131 : 10585 : char *password = NULL;
132 : : bool new_pass;
133 : :
2673 peter@eisentraut.org 134 : 10585 : pg_logging_init(argv[0]);
135 : 10585 : pg_logging_set_pre_callback(log_pre_callback);
136 : 10585 : pg_logging_set_locus_callback(log_locus_callback);
6436 peter_e@gmx.net 137 : 10585 : set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("psql"));
138 : :
9374 139 [ + - ]: 10585 : if (argc > 1)
140 : : {
4338 andres@anarazel.de 141 [ + - + + : 10585 : if ((strcmp(argv[1], "-?") == 0) || (argc == 2 && (strcmp(argv[1], "--help") == 0)))
+ + ]
142 : : {
143 : 1 : usage(NOPAGER);
9374 peter_e@gmx.net 144 : 1 : exit(EXIT_SUCCESS);
145 : : }
9257 bruce@momjian.us 146 [ + + + + ]: 10584 : if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
147 : : {
9374 peter_e@gmx.net 148 : 20 : showVersion();
149 : 20 : exit(EXIT_SUCCESS);
150 : : }
151 : : }
152 : :
7340 tgl@sss.pgh.pa.us 153 : 10564 : pset.progname = get_progname(argv[0]);
154 : :
7271 155 : 10564 : pset.db = NULL;
2102 156 : 10564 : pset.dead_conn = NULL;
7682 bruce@momjian.us 157 : 10564 : setDecimalLocale();
7271 tgl@sss.pgh.pa.us 158 : 10564 : pset.encoding = PQenv2encoding();
159 : 10564 : pset.queryFout = stdout;
160 : 10564 : pset.queryFoutPipe = false;
4521 161 : 10564 : pset.copyStream = NULL;
3766 162 : 10564 : pset.last_error_result = NULL;
9690 peter_e@gmx.net 163 : 10564 : pset.cur_cmd_source = stdin;
164 : 10564 : pset.cur_cmd_interactive = false;
165 : :
166 : : /* We rely on unmentioned fields of pset.popt to start out 0/false/NULL */
167 : 10564 : pset.popt.topt.format = PRINT_ALIGNED;
168 : 10564 : pset.popt.topt.border = 1;
8661 bruce@momjian.us 169 : 10564 : pset.popt.topt.pager = 1;
4138 andrew@dunslane.net 170 : 10564 : pset.popt.topt.pager_min_lines = 0;
7271 tgl@sss.pgh.pa.us 171 : 10564 : pset.popt.topt.start_table = true;
172 : 10564 : pset.popt.topt.stop_table = true;
5199 rhaas@postgresql.org 173 : 10564 : pset.popt.topt.default_footer = true;
174 : :
2799 tgl@sss.pgh.pa.us 175 : 10564 : pset.popt.topt.csvFieldSep[0] = DEFAULT_CSV_FIELD_SEP;
176 : 10564 : pset.popt.topt.csvFieldSep[1] = '\0';
177 : :
4335 sfrost@snowman.net 178 : 10564 : pset.popt.topt.unicode_border_linestyle = UNICODE_LINESTYLE_SINGLE;
179 : 10564 : pset.popt.topt.unicode_column_linestyle = UNICODE_LINESTYLE_SINGLE;
180 : 10564 : pset.popt.topt.unicode_header_linestyle = UNICODE_LINESTYLE_SINGLE;
181 : :
182 : 10564 : refresh_utf8format(&(pset.popt.topt));
183 : :
184 : : /* We must get COLUMNS here before readline() sets it */
6653 bruce@momjian.us 185 [ - + ]: 10564 : pset.popt.topt.env_columns = getenv("COLUMNS") ? atoi(getenv("COLUMNS")) : 0;
186 : :
9690 peter_e@gmx.net 187 [ + + - + ]: 10564 : pset.notty = (!isatty(fileno(stdin)) || !isatty(fileno(stdout)));
188 : :
6359 189 : 10564 : pset.getPassword = TRI_DEFAULT;
190 : :
7271 tgl@sss.pgh.pa.us 191 : 10564 : EstablishVariableSpace();
192 : :
193 : : /* Create variables showing psql version number */
194 : 10564 : SetVariable(pset.vars, "VERSION", PG_VERSION_STR);
3246 195 : 10564 : SetVariable(pset.vars, "VERSION_NAME", PG_VERSION);
196 : 10564 : SetVariable(pset.vars, "VERSION_NUM", CppAsString2(PG_VERSION_NUM));
197 : :
198 : : /* Initialize variables for last error */
3239 199 : 10564 : SetVariable(pset.vars, "LAST_ERROR_MESSAGE", "");
200 : 10564 : SetVariable(pset.vars, "LAST_ERROR_SQLSTATE", "00000");
201 : :
202 : : /* Default values for variables (that don't match the result of \unset) */
7271 203 : 10564 : SetVariableBool(pset.vars, "AUTOCOMMIT");
204 : 10564 : SetVariable(pset.vars, "PROMPT1", DEFAULT_PROMPT1);
205 : 10564 : SetVariable(pset.vars, "PROMPT2", DEFAULT_PROMPT2);
206 : 10564 : SetVariable(pset.vars, "PROMPT3", DEFAULT_PROMPT3);
1574 peter@eisentraut.org 207 : 10564 : SetVariableBool(pset.vars, "SHOW_ALL_RESULTS");
208 : :
209 : : /* Initialize pipeline variables */
516 michael@paquier.xyz 210 : 10564 : SetVariable(pset.vars, "PIPELINE_SYNC_COUNT", "0");
211 : 10564 : SetVariable(pset.vars, "PIPELINE_COMMAND_COUNT", "0");
212 : 10564 : SetVariable(pset.vars, "PIPELINE_RESULT_COUNT", "0");
213 : :
9653 peter_e@gmx.net 214 : 10564 : parse_psql_options(argc, argv, &options);
215 : :
216 : : /*
217 : : * If no action was specified and we're in non-interactive mode, treat it
218 : : * as if the user had specified "-f -". This lets single-transaction mode
219 : : * work in this case.
220 : : */
3883 rhaas@postgresql.org 221 [ + + + + ]: 10561 : if (options.actions.head == NULL && pset.notty)
222 : 2750 : simple_action_list_append(&options.actions, ACT_FILE, NULL);
223 : :
224 : : /* Bail out if -1 was specified but will be ignored. */
225 [ + + - + ]: 10561 : if (options.single_txn && options.actions.head == NULL)
1570 tgl@sss.pgh.pa.us 226 :UBC 0 : pg_fatal("-1 can only be used in non-interactive mode");
227 : :
5281 peter_e@gmx.net 228 [ + + ]:CBC 10561 : if (!pset.popt.topt.fieldSep.separator &&
229 [ + - ]: 10559 : !pset.popt.topt.fieldSep.separator_zero)
230 : : {
231 : 10559 : pset.popt.topt.fieldSep.separator = pg_strdup(DEFAULT_FIELD_SEP);
232 : 10559 : pset.popt.topt.fieldSep.separator_zero = false;
233 : : }
234 [ + - ]: 10561 : if (!pset.popt.topt.recordSep.separator &&
235 [ + - ]: 10561 : !pset.popt.topt.recordSep.separator_zero)
236 : : {
237 : 10561 : pset.popt.topt.recordSep.separator = pg_strdup(DEFAULT_RECORD_SEP);
238 : 10561 : pset.popt.topt.recordSep.separator_zero = false;
239 : : }
240 : :
6359 241 [ - + ]: 10561 : if (pset.getPassword == TRI_YES)
242 : : {
243 : : /*
244 : : * We can't be sure yet of the username that will be used, so don't
245 : : * offer a potentially wrong one. Typical uses of this option are
246 : : * noninteractive anyway. (Note: since we've not yet set up our
247 : : * cancel handler, there's no need to use simple_prompt_extended.)
248 : : */
2152 tgl@sss.pgh.pa.us 249 :UBC 0 : password = simple_prompt("Password: ", false);
250 : : }
251 : :
252 : : /* loop until we have a password if requested by backend */
253 : : do
254 : : {
255 : : #define PARAMS_ARRAY_SIZE 8
1413 peter@eisentraut.org 256 :CBC 10561 : const char **keywords = pg_malloc_array(const char *, PARAMS_ARRAY_SIZE);
257 : 10561 : const char **values = pg_malloc_array(const char *, PARAMS_ARRAY_SIZE);
258 : :
5994 bruce@momjian.us 259 : 10561 : keywords[0] = "host";
260 : 10561 : values[0] = options.host;
261 : 10561 : keywords[1] = "port";
262 : 10561 : values[1] = options.port;
263 : 10561 : keywords[2] = "user";
264 : 10561 : values[2] = options.username;
265 : 10561 : keywords[3] = "password";
2152 tgl@sss.pgh.pa.us 266 : 10561 : values[3] = password;
3639 noah@leadboat.com 267 : 10561 : keywords[4] = "dbname"; /* see do_connect() */
3883 rhaas@postgresql.org 268 [ # # ]:UBC 0 : values[4] = (options.list_dbs && options.dbname == NULL) ?
5994 bruce@momjian.us 269 [ - + ]:CBC 10561 : "postgres" : options.dbname;
270 : 10561 : keywords[5] = "fallback_application_name";
271 : 10561 : values[5] = pset.progname;
5636 peter_e@gmx.net 272 : 10561 : keywords[6] = "client_encoding";
273 [ + + + - ]: 10561 : values[6] = (pset.notty || getenv("PGCLIENTENCODING")) ? NULL : "auto";
274 : 10561 : keywords[7] = NULL;
275 : 10561 : values[7] = NULL;
276 : :
6015 mail@joeconway.com 277 : 10561 : new_pass = false;
278 : 10561 : pset.db = PQconnectdbParams(keywords, values, true);
25 peter@eisentraut.org 279 :GNC 10561 : pg_free(keywords);
280 : 10561 : pg_free(values);
281 : :
9690 peter_e@gmx.net 282 [ + + + + ]:CBC 10710 : if (PQstatus(pset.db) == CONNECTION_BAD &&
6804 tgl@sss.pgh.pa.us 283 [ + - ]: 150 : PQconnectionNeedsPassword(pset.db) &&
2152 284 : 1 : !password &&
6359 peter_e@gmx.net 285 [ - + ]: 1 : pset.getPassword != TRI_NO)
286 : : {
287 : : /*
288 : : * Before closing the old PGconn, extract the user name that was
289 : : * actually connected with --- it might've come out of a URI or
290 : : * connstring "database name" rather than options.username.
291 : : */
3100 tgl@sss.pgh.pa.us 292 :UBC 0 : const char *realusername = PQuser(pset.db);
293 : : char *password_prompt;
294 : :
295 [ # # # # ]: 0 : if (realusername && realusername[0])
296 : 0 : password_prompt = psprintf(_("Password for user %s: "),
297 : : realusername);
298 : : else
299 : 0 : password_prompt = pg_strdup(_("Password: "));
9443 peter_e@gmx.net 300 : 0 : PQfinish(pset.db);
301 : :
2152 tgl@sss.pgh.pa.us 302 : 0 : password = simple_prompt(password_prompt, false);
25 peter@eisentraut.org 303 :UNC 0 : pfree(password_prompt);
6958 tgl@sss.pgh.pa.us 304 :UBC 0 : new_pass = true;
305 : : }
6958 tgl@sss.pgh.pa.us 306 [ - + ]:CBC 10561 : } while (new_pass);
307 : :
9690 peter_e@gmx.net 308 [ + + ]: 10561 : if (PQstatus(pset.db) == CONNECTION_BAD)
309 : : {
2087 peter@eisentraut.org 310 : 149 : pg_log_error("%s", PQerrorMessage(pset.db));
9690 peter_e@gmx.net 311 : 149 : PQfinish(pset.db);
9761 bruce@momjian.us 312 : 149 : exit(EXIT_BADCONN);
313 : : }
314 : :
2428 michael@paquier.xyz 315 : 10412 : psql_setup_cancel_handler();
316 : :
317 : : #ifndef WIN32
318 : :
319 : : /*
320 : : * do_watch() needs signal handlers installed (otherwise sigwait() will
321 : : * filter them out on some platforms), but doesn't need them to do
322 : : * anything, and they shouldn't ever run (unless perhaps a stray SIGALRM
323 : : * arrives due to a race when do_watch() cancels an itimer).
324 : : */
1839 tmunro@postgresql.or 325 : 10412 : pqsignal(SIGCHLD, empty_signal_handler);
326 : 10412 : pqsignal(SIGALRM, empty_signal_handler);
327 : : #endif
328 : :
9601 bruce@momjian.us 329 : 10412 : PQsetNoticeProcessor(pset.db, NoticeProcessor, NULL);
330 : :
331 : : /* initialize timing infrastructure (required for INSTR_* calls) */
110 andres@anarazel.de 332 : 10412 : pg_initialize_timing();
333 : :
8429 tgl@sss.pgh.pa.us 334 : 10412 : SyncVariables();
335 : :
3883 rhaas@postgresql.org 336 [ - + ]: 10412 : if (options.list_dbs)
337 : : {
338 : : int success;
339 : :
5639 peter_e@gmx.net 340 [ # # ]:UBC 0 : if (!options.no_psqlrc)
341 : 0 : process_psqlrc(argv[0]);
342 : :
4893 343 : 0 : success = listAllDbs(NULL, false);
9690 344 : 0 : PQfinish(pset.db);
9643 345 : 0 : exit(success ? EXIT_SUCCESS : EXIT_FAILURE);
346 : : }
347 : :
7712 bruce@momjian.us 348 [ - + ]:CBC 10412 : if (options.logfilename)
349 : : {
7712 bruce@momjian.us 350 :UBC 0 : pset.logfile = fopen(options.logfilename, "a");
351 [ # # ]: 0 : if (!pset.logfile)
1570 tgl@sss.pgh.pa.us 352 : 0 : pg_fatal("could not open log file \"%s\": %m",
353 : : options.logfilename);
354 : : }
355 : :
3883 rhaas@postgresql.org 356 [ - + ]:CBC 10412 : if (!options.no_psqlrc)
3883 rhaas@postgresql.org 357 :UBC 0 : process_psqlrc(argv[0]);
358 : :
359 : : /*
360 : : * If any actions were given by user, process them in the order in which
361 : : * they were specified. Note single_txn is only effective in this mode.
362 : : */
3883 rhaas@postgresql.org 363 [ + + ]:CBC 10412 : if (options.actions.head != NULL)
364 : : {
365 : : PGresult *res;
366 : : SimpleActionListCell *cell;
367 : :
368 : 10409 : successResult = EXIT_SUCCESS; /* silence compiler */
369 : :
370 [ + + ]: 10409 : if (options.single_txn)
371 : : {
372 [ - + ]: 7 : if ((res = PSQLexec("BEGIN")) == NULL)
373 : : {
3883 rhaas@postgresql.org 374 [ # # ]:UBC 0 : if (pset.on_error_stop)
375 : : {
376 : 0 : successResult = EXIT_USER;
377 : 0 : goto error;
378 : : }
379 : : }
380 : : else
3883 rhaas@postgresql.org 381 :CBC 7 : PQclear(res);
382 : : }
383 : :
384 [ + + ]: 20790 : for (cell = options.actions.head; cell; cell = cell->next)
385 : : {
386 [ + + ]: 10552 : if (cell->action == ACT_SINGLE_QUERY)
387 : : {
2673 peter@eisentraut.org 388 : 411 : pg_logging_config(PG_LOG_FLAG_TERSE);
389 : :
3883 rhaas@postgresql.org 390 [ - + ]: 411 : if (pset.echo == PSQL_ECHO_ALL)
3883 rhaas@postgresql.org 391 :UBC 0 : puts(cell->val);
392 : :
3883 rhaas@postgresql.org 393 :CBC 411 : successResult = SendQuery(cell->val)
394 : 410 : ? EXIT_SUCCESS : EXIT_FAILURE;
395 : : }
396 [ + + ]: 10141 : else if (cell->action == ACT_SINGLE_SLASH)
397 : : {
398 : : PsqlScanState scan_state;
399 : : ConditionalStack cond_stack;
400 : :
2673 peter@eisentraut.org 401 : 2 : pg_logging_config(PG_LOG_FLAG_TERSE);
402 : :
3883 rhaas@postgresql.org 403 [ - + ]: 2 : if (pset.echo == PSQL_ECHO_ALL)
3883 rhaas@postgresql.org 404 :UBC 0 : puts(cell->val);
405 : :
3782 tgl@sss.pgh.pa.us 406 :CBC 2 : scan_state = psql_scan_create(&psqlscan_callbacks);
3883 rhaas@postgresql.org 407 : 2 : psql_scan_setup(scan_state,
3782 tgl@sss.pgh.pa.us 408 : 2 : cell->val, strlen(cell->val),
409 : 2 : pset.encoding, standard_strings());
3405 410 : 2 : cond_stack = conditional_stack_create();
605 peter@eisentraut.org 411 : 2 : psql_scan_set_passthrough(scan_state, cond_stack);
412 : :
3405 tgl@sss.pgh.pa.us 413 : 2 : successResult = HandleSlashCmds(scan_state,
414 : : cond_stack,
415 : : NULL,
416 : : NULL) != PSQL_CMD_ERROR
3883 rhaas@postgresql.org 417 : 2 : ? EXIT_SUCCESS : EXIT_FAILURE;
418 : :
419 : 2 : psql_scan_destroy(scan_state);
3405 tgl@sss.pgh.pa.us 420 : 2 : conditional_stack_destroy(cond_stack);
421 : : }
3883 rhaas@postgresql.org 422 [ + - ]: 10139 : else if (cell->action == ACT_FILE)
423 : : {
424 : 10139 : successResult = process_file(cell->val, false);
425 : : }
426 : : else
427 : : {
428 : : /* should never come here */
3878 tgl@sss.pgh.pa.us 429 :UBC 0 : Assert(false);
430 : : }
431 : :
3883 rhaas@postgresql.org 432 [ + + + + ]:CBC 10535 : if (successResult != EXIT_SUCCESS && pset.on_error_stop)
433 : 154 : break;
434 : : }
435 : :
436 [ + + ]: 10392 : if (options.single_txn)
437 : : {
438 : : /*
439 : : * Rollback the contents of the single transaction if the caller
440 : : * has set ON_ERROR_STOP and one of the steps has failed. This
441 : : * check needs to match the one done a couple of lines above.
442 : : */
1502 michael@paquier.xyz 443 [ + + + + ]: 7 : res = PSQLexec((successResult != EXIT_SUCCESS && pset.on_error_stop) ?
444 : : "ROLLBACK" : "COMMIT");
1511 445 [ - + ]: 7 : if (res == NULL)
446 : : {
3883 rhaas@postgresql.org 447 [ # # ]:UBC 0 : if (pset.on_error_stop)
448 : : {
449 : 0 : successResult = EXIT_USER;
450 : 0 : goto error;
451 : : }
452 : : }
453 : : else
3883 rhaas@postgresql.org 454 :CBC 7 : PQclear(res);
455 : : }
456 : :
457 : 10392 : error:
458 : : ;
459 : : }
460 : :
461 : : /*
462 : : * or otherwise enter interactive main loop
463 : : */
464 : : else
465 : : {
2577 peter@eisentraut.org 466 : 3 : pg_logging_config(PG_LOG_FLAG_TERSE);
6004 bruce@momjian.us 467 : 3 : connection_warnings(true);
5099 rhaas@postgresql.org 468 [ + - ]: 3 : if (!pset.quiet)
6580 bruce@momjian.us 469 : 3 : printf(_("Type \"help\" for help.\n\n"));
5099 rhaas@postgresql.org 470 : 3 : initializeInput(options.no_readline ? 0 : 1);
9686 peter_e@gmx.net 471 : 3 : successResult = MainLoop(stdin);
472 : : }
473 : :
474 : : /* clean up */
7712 bruce@momjian.us 475 [ - + ]: 10395 : if (pset.logfile)
7712 bruce@momjian.us 476 :UBC 0 : fclose(pset.logfile);
2102 tgl@sss.pgh.pa.us 477 [ + - ]:CBC 10395 : if (pset.db)
478 : 10395 : PQfinish(pset.db);
479 [ - + ]: 10395 : if (pset.dead_conn)
2102 tgl@sss.pgh.pa.us 480 :UBC 0 : PQfinish(pset.dead_conn);
9690 peter_e@gmx.net 481 :CBC 10395 : setQFout(NULL);
482 : :
9761 bruce@momjian.us 483 : 10395 : return successResult;
484 : : }
485 : :
486 : :
487 : : /*
488 : : * Parse command line options
489 : : */
490 : :
491 : : static void
3322 tgl@sss.pgh.pa.us 492 : 10564 : parse_psql_options(int argc, char *argv[], struct adhoc_opts *options)
493 : : {
494 : : static struct option long_options[] =
495 : : {
496 : : {"echo-all", no_argument, NULL, 'a'},
497 : : {"no-align", no_argument, NULL, 'A'},
498 : : {"command", required_argument, NULL, 'c'},
499 : : {"dbname", required_argument, NULL, 'd'},
500 : : {"echo-queries", no_argument, NULL, 'e'},
501 : : {"echo-errors", no_argument, NULL, 'b'},
502 : : {"echo-hidden", no_argument, NULL, 'E'},
503 : : {"file", required_argument, NULL, 'f'},
504 : : {"field-separator", required_argument, NULL, 'F'},
505 : : {"field-separator-zero", no_argument, NULL, 'z'},
506 : : {"host", required_argument, NULL, 'h'},
507 : : {"html", no_argument, NULL, 'H'},
508 : : {"list", no_argument, NULL, 'l'},
509 : : {"log-file", required_argument, NULL, 'L'},
510 : : {"no-readline", no_argument, NULL, 'n'},
511 : : {"single-transaction", no_argument, NULL, '1'},
512 : : {"output", required_argument, NULL, 'o'},
513 : : {"port", required_argument, NULL, 'p'},
514 : : {"pset", required_argument, NULL, 'P'},
515 : : {"quiet", no_argument, NULL, 'q'},
516 : : {"record-separator", required_argument, NULL, 'R'},
517 : : {"record-separator-zero", no_argument, NULL, '0'},
518 : : {"single-step", no_argument, NULL, 's'},
519 : : {"single-line", no_argument, NULL, 'S'},
520 : : {"tuples-only", no_argument, NULL, 't'},
521 : : {"table-attr", required_argument, NULL, 'T'},
522 : : {"username", required_argument, NULL, 'U'},
523 : : {"set", required_argument, NULL, 'v'},
524 : : {"variable", required_argument, NULL, 'v'},
525 : : {"version", no_argument, NULL, 'V'},
526 : : {"no-password", no_argument, NULL, 'w'},
527 : : {"password", no_argument, NULL, 'W'},
528 : : {"expanded", no_argument, NULL, 'x'},
529 : : {"no-psqlrc", no_argument, NULL, 'X'},
530 : : {"help", optional_argument, NULL, 1},
531 : : {"csv", no_argument, NULL, 2},
532 : : {NULL, 0, NULL, 0}
533 : : };
534 : :
535 : : int optindex;
536 : : int c;
537 : :
9739 bruce@momjian.us 538 : 10564 : memset(options, 0, sizeof *options);
539 : :
4399 fujii@postgresql.org 540 : 78123 : while ((c = getopt_long(argc, argv, "aAbc:d:eEf:F:h:HlL:no:p:P:qR:sStT:U:v:VwWxXz?01",
8602 peter_e@gmx.net 541 [ + + ]: 78123 : long_options, &optindex)) != -1)
542 : : {
9761 bruce@momjian.us 543 [ + + - + : 67562 : switch (c)
+ + - + +
+ - - - -
- + + + -
- - + - +
+ - + - -
+ - - + +
+ - - ]
544 : : {
9660 peter_e@gmx.net 545 : 1310 : case 'a':
546 : 1310 : SetVariable(pset.vars, "ECHO", "all");
547 : 1310 : break;
9761 bruce@momjian.us 548 : 8982 : case 'A':
9690 peter_e@gmx.net 549 : 8982 : pset.popt.topt.format = PRINT_UNALIGNED;
9761 bruce@momjian.us 550 : 8982 : break;
4399 fujii@postgresql.org 551 :UBC 0 : case 'b':
552 : 0 : SetVariable(pset.vars, "ECHO", "errors");
553 : 0 : break;
9761 bruce@momjian.us 554 :CBC 417 : case 'c':
555 [ + + ]: 417 : if (optarg[0] == '\\')
3883 rhaas@postgresql.org 556 : 2 : simple_action_list_append(&options->actions,
557 : : ACT_SINGLE_SLASH,
3878 tgl@sss.pgh.pa.us 558 : 2 : optarg + 1);
559 : : else
3883 rhaas@postgresql.org 560 : 415 : simple_action_list_append(&options->actions,
561 : : ACT_SINGLE_QUERY,
562 : : optarg);
9761 bruce@momjian.us 563 : 417 : break;
564 : 10457 : case 'd':
5035 565 : 10457 : options->dbname = pg_strdup(optarg);
9761 566 : 10457 : break;
567 : 10 : case 'e':
9660 peter_e@gmx.net 568 : 10 : SetVariable(pset.vars, "ECHO", "queries");
9761 bruce@momjian.us 569 : 10 : break;
9761 bruce@momjian.us 570 :UBC 0 : case 'E':
9660 peter_e@gmx.net 571 : 0 : SetVariableBool(pset.vars, "ECHO_HIDDEN");
9761 bruce@momjian.us 572 : 0 : break;
9761 bruce@momjian.us 573 :CBC 7538 : case 'f':
3883 rhaas@postgresql.org 574 : 7538 : simple_action_list_append(&options->actions,
575 : : ACT_FILE,
576 : : optarg);
9761 bruce@momjian.us 577 : 7538 : break;
578 : 2 : case 'F':
5281 peter_e@gmx.net 579 : 2 : pset.popt.topt.fieldSep.separator = pg_strdup(optarg);
580 : 2 : pset.popt.topt.fieldSep.separator_zero = false;
9761 bruce@momjian.us 581 : 2 : break;
582 : 10 : case 'h':
5035 583 : 10 : options->host = pg_strdup(optarg);
9761 584 : 10 : break;
9761 bruce@momjian.us 585 :UBC 0 : case 'H':
9690 peter_e@gmx.net 586 : 0 : pset.popt.topt.format = PRINT_HTML;
9761 bruce@momjian.us 587 : 0 : break;
588 : 0 : case 'l':
3883 rhaas@postgresql.org 589 : 0 : options->list_dbs = true;
9761 bruce@momjian.us 590 : 0 : break;
7712 591 : 0 : case 'L':
5035 592 : 0 : options->logfilename = pg_strdup(optarg);
7712 593 : 0 : break;
9761 594 : 0 : case 'n':
595 : 0 : options->no_readline = true;
596 : 0 : break;
597 : 0 : case 'o':
3888 tgl@sss.pgh.pa.us 598 [ # # ]: 0 : if (!setQFout(optarg))
599 : 0 : exit(EXIT_FAILURE);
9761 bruce@momjian.us 600 : 0 : break;
9761 bruce@momjian.us 601 :CBC 11 : case 'p':
5035 602 : 11 : options->port = pg_strdup(optarg);
9761 603 : 11 : break;
604 : 2 : case 'P':
605 : : {
606 : : char *value;
607 : : char *equal_loc;
608 : : bool result;
609 : :
8218 neilc@samurai.com 610 : 2 : value = pg_strdup(optarg);
9761 bruce@momjian.us 611 : 2 : equal_loc = strchr(value, '=');
612 [ - + ]: 2 : if (!equal_loc)
9690 peter_e@gmx.net 613 :UBC 0 : result = do_pset(value, NULL, &pset.popt, true);
614 : : else
615 : : {
9761 bruce@momjian.us 616 :CBC 2 : *equal_loc = '\0';
9690 peter_e@gmx.net 617 : 2 : result = do_pset(value, equal_loc + 1, &pset.popt, true);
618 : : }
619 : :
9761 bruce@momjian.us 620 [ - + ]: 2 : if (!result)
1570 tgl@sss.pgh.pa.us 621 :UBC 0 : pg_fatal("could not set printing parameter \"%s\"", value);
622 : :
25 peter@eisentraut.org 623 :GNC 2 : pg_free(value);
9761 bruce@momjian.us 624 :CBC 2 : break;
625 : : }
626 : 9090 : case 'q':
9660 peter_e@gmx.net 627 : 9090 : SetVariableBool(pset.vars, "QUIET");
9761 bruce@momjian.us 628 : 9090 : break;
9601 bruce@momjian.us 629 :UBC 0 : case 'R':
5281 peter_e@gmx.net 630 : 0 : pset.popt.topt.recordSep.separator = pg_strdup(optarg);
631 : 0 : pset.popt.topt.recordSep.separator_zero = false;
9601 bruce@momjian.us 632 : 0 : break;
9761 633 : 0 : case 's':
9660 peter_e@gmx.net 634 : 0 : SetVariableBool(pset.vars, "SINGLESTEP");
9761 bruce@momjian.us 635 : 0 : break;
636 : 0 : case 'S':
9660 peter_e@gmx.net 637 : 0 : SetVariableBool(pset.vars, "SINGLELINE");
9761 bruce@momjian.us 638 : 0 : break;
9761 bruce@momjian.us 639 :CBC 8975 : case 't':
9690 peter_e@gmx.net 640 : 8975 : pset.popt.topt.tuples_only = true;
9761 bruce@momjian.us 641 : 8975 : break;
9761 bruce@momjian.us 642 :UBC 0 : case 'T':
8218 neilc@samurai.com 643 : 0 : pset.popt.topt.tableAttr = pg_strdup(optarg);
9761 bruce@momjian.us 644 : 0 : break;
9761 bruce@momjian.us 645 :CBC 22 : case 'U':
5035 646 : 22 : options->username = pg_strdup(optarg);
9761 647 : 22 : break;
648 : 9813 : case 'v':
649 : : {
650 : : char *value;
651 : : char *equal_loc;
652 : :
8218 neilc@samurai.com 653 : 9813 : value = pg_strdup(optarg);
9761 bruce@momjian.us 654 : 9813 : equal_loc = strchr(value, '=');
655 [ - + ]: 9813 : if (!equal_loc)
656 : : {
9690 peter_e@gmx.net 657 [ # # ]:UBC 0 : if (!DeleteVariable(pset.vars, value))
3462 tgl@sss.pgh.pa.us 658 : 0 : exit(EXIT_FAILURE); /* error already printed */
659 : : }
660 : : else
661 : : {
9761 bruce@momjian.us 662 :CBC 9813 : *equal_loc = '\0';
9690 peter_e@gmx.net 663 [ - + ]: 9813 : if (!SetVariable(pset.vars, value, equal_loc + 1))
3462 tgl@sss.pgh.pa.us 664 :UBC 0 : exit(EXIT_FAILURE); /* error already printed */
665 : : }
666 : :
25 peter@eisentraut.org 667 :GNC 9813 : pg_free(value);
9761 bruce@momjian.us 668 :CBC 9813 : break;
669 : : }
9761 bruce@momjian.us 670 :UBC 0 : case 'V':
9692 peter_e@gmx.net 671 : 0 : showVersion();
672 : 0 : exit(EXIT_SUCCESS);
6359 peter_e@gmx.net 673 :CBC 352 : case 'w':
674 : 352 : pset.getPassword = TRI_NO;
675 : 352 : break;
9761 bruce@momjian.us 676 :UBC 0 : case 'W':
6359 peter_e@gmx.net 677 : 0 : pset.getPassword = TRI_YES;
9761 bruce@momjian.us 678 : 0 : break;
9643 peter_e@gmx.net 679 : 0 : case 'x':
680 : 0 : pset.popt.topt.expanded = true;
681 : 0 : break;
9601 bruce@momjian.us 682 :CBC 10561 : case 'X':
683 : 10561 : options->no_psqlrc = true;
684 : 10561 : break;
5281 peter_e@gmx.net 685 :UBC 0 : case 'z':
686 : 0 : pset.popt.topt.fieldSep.separator_zero = true;
687 : 0 : break;
688 : 0 : case '0':
689 : 0 : pset.popt.topt.recordSep.separator_zero = true;
690 : 0 : break;
7469 bruce@momjian.us 691 :CBC 7 : case '1':
692 : 7 : options->single_txn = true;
693 : 7 : break;
9761 694 : 1 : case '?':
2527 tgl@sss.pgh.pa.us 695 [ + - ]: 1 : if (optind <= argc &&
696 [ - + ]: 1 : strcmp(argv[optind - 1], "-?") == 0)
697 : : {
698 : : /* actual help option given */
4338 andres@anarazel.de 699 :UBC 0 : usage(NOPAGER);
9601 bruce@momjian.us 700 : 0 : exit(EXIT_SUCCESS);
701 : : }
702 : : else
703 : : {
704 : : /* getopt error (unknown option or missing argument) */
4338 andres@anarazel.de 705 :CBC 1 : goto unknown_option;
706 : : }
707 : : break;
708 : 2 : case 1:
709 : : {
710 [ + - - + ]: 2 : if (!optarg || strcmp(optarg, "options") == 0)
4338 andres@anarazel.de 711 :UBC 0 : usage(NOPAGER);
4338 andres@anarazel.de 712 [ + - + + ]:CBC 2 : else if (optarg && strcmp(optarg, "commands") == 0)
713 : 1 : slashUsage(NOPAGER);
714 [ + - + - ]: 1 : else if (optarg && strcmp(optarg, "variables") == 0)
715 : 1 : helpVariables(NOPAGER);
716 : : else
4338 andres@anarazel.de 717 :UBC 0 : goto unknown_option;
718 : :
4338 andres@anarazel.de 719 :CBC 2 : exit(EXIT_SUCCESS);
720 : : }
721 : : break;
2799 tgl@sss.pgh.pa.us 722 :UBC 0 : case 2:
723 : 0 : pset.popt.topt.format = PRINT_CSV;
724 : 0 : break;
725 : : default:
4082 bruce@momjian.us 726 :CBC 1 : unknown_option:
727 : : /* getopt_long already emitted a complaint */
1570 tgl@sss.pgh.pa.us 728 : 1 : pg_log_error_hint("Try \"%s --help\" for more information.",
729 : : pset.progname);
9571 bruce@momjian.us 730 : 1 : exit(EXIT_FAILURE);
731 : : }
732 : : }
733 : :
734 : : /*
735 : : * if we still have arguments, use it as the database name and username
736 : : */
9761 737 [ + + ]: 10683 : while (argc - optind >= 1)
738 : : {
739 [ + - ]: 122 : if (!options->dbname)
740 : 122 : options->dbname = argv[optind];
9761 bruce@momjian.us 741 [ # # ]:UBC 0 : else if (!options->username)
742 : 0 : options->username = argv[optind];
7271 tgl@sss.pgh.pa.us 743 [ # # ]: 0 : else if (!pset.quiet)
2673 peter@eisentraut.org 744 : 0 : pg_log_warning("extra command-line argument \"%s\" ignored",
745 : : argv[optind]);
746 : :
9761 bruce@momjian.us 747 :CBC 122 : optind++;
748 : : }
749 : 10561 : }
750 : :
751 : :
752 : : /*
753 : : * Append a new item to the end of the SimpleActionList.
754 : : * Note that "val" is copied if it's not NULL.
755 : : */
756 : : static void
3878 tgl@sss.pgh.pa.us 757 : 10705 : simple_action_list_append(SimpleActionList *list,
758 : : enum _actions action, const char *val)
759 : : {
760 : : SimpleActionListCell *cell;
761 : :
1413 peter@eisentraut.org 762 : 10705 : cell = pg_malloc_object(SimpleActionListCell);
763 : :
3878 tgl@sss.pgh.pa.us 764 : 10705 : cell->next = NULL;
765 : 10705 : cell->action = action;
766 [ + + ]: 10705 : if (val)
767 : 7955 : cell->val = pg_strdup(val);
768 : : else
769 : 2750 : cell->val = NULL;
770 : :
771 [ + + ]: 10705 : if (list->tail)
772 : 147 : list->tail->next = cell;
773 : : else
774 : 10558 : list->head = cell;
775 : 10705 : list->tail = cell;
776 : 10705 : }
777 : :
778 : :
779 : : /*
780 : : * Load .psqlrc file, if found.
781 : : */
782 : : static void
5985 magnus@hagander.net 783 :UBC 0 : process_psqlrc(char *argv0)
784 : : {
785 : : char home[MAXPGPATH];
786 : : char rc_file[MAXPGPATH];
787 : : char my_exec_path[MAXPGPATH];
788 : : char etc_path[MAXPGPATH];
4861 bruce@momjian.us 789 : 0 : char *envrc = getenv("PSQLRC");
790 : :
4530 sfrost@snowman.net 791 [ # # ]: 0 : if (find_my_exec(argv0, my_exec_path) < 0)
1570 tgl@sss.pgh.pa.us 792 : 0 : pg_fatal("could not find own program executable");
793 : :
8105 bruce@momjian.us 794 : 0 : get_etc_path(my_exec_path, etc_path);
795 : :
7871 tgl@sss.pgh.pa.us 796 : 0 : snprintf(rc_file, MAXPGPATH, "%s/%s", etc_path, SYSPSQLRC);
797 : 0 : process_psqlrc_file(rc_file);
798 : :
5258 andrew@dunslane.net 799 [ # # # # ]: 0 : if (envrc != NULL && strlen(envrc) > 0)
800 : 0 : {
801 : : /* might need to free() this */
4806 bruce@momjian.us 802 : 0 : char *envrc_alloc = pstrdup(envrc);
803 : :
4861 804 : 0 : expand_tilde(&envrc_alloc);
805 : 0 : process_psqlrc_file(envrc_alloc);
806 : : }
5258 andrew@dunslane.net 807 [ # # ]: 0 : else if (get_home_path(home))
808 : : {
7871 tgl@sss.pgh.pa.us 809 : 0 : snprintf(rc_file, MAXPGPATH, "%s/%s", home, PSQLRC);
810 : 0 : process_psqlrc_file(rc_file);
811 : : }
8130 bruce@momjian.us 812 : 0 : }
813 : :
814 : :
815 : :
816 : : static void
817 : 0 : process_psqlrc_file(char *filename)
818 : : {
819 : : char *psqlrc_minor,
820 : : *psqlrc_major;
821 : :
822 : : #if defined(WIN32) && (!defined(__MINGW32__))
823 : : #define R_OK 4
824 : : #endif
825 : :
4660 tgl@sss.pgh.pa.us 826 : 0 : psqlrc_minor = psprintf("%s-%s", filename, PG_VERSION);
827 : 0 : psqlrc_major = psprintf("%s-%s", filename, PG_MAJORVERSION);
828 : :
829 : : /* check for minor version first, then major, then no version */
5399 bruce@momjian.us 830 [ # # ]: 0 : if (access(psqlrc_minor, R_OK) == 0)
3883 rhaas@postgresql.org 831 : 0 : (void) process_file(psqlrc_minor, false);
5399 bruce@momjian.us 832 [ # # ]: 0 : else if (access(psqlrc_major, R_OK) == 0)
3883 rhaas@postgresql.org 833 : 0 : (void) process_file(psqlrc_major, false);
8130 bruce@momjian.us 834 [ # # ]: 0 : else if (access(filename, R_OK) == 0)
3883 rhaas@postgresql.org 835 : 0 : (void) process_file(filename, false);
836 : :
25 peter@eisentraut.org 837 :UNC 0 : pfree(psqlrc_minor);
838 : 0 : pfree(psqlrc_major);
9761 bruce@momjian.us 839 :UBC 0 : }
840 : :
841 : :
842 : :
843 : : /*
844 : : * showVersion
845 : : *
846 : : * This output format is intended to match GNU standards.
847 : : */
848 : : static void
9692 peter_e@gmx.net 849 :CBC 20 : showVersion(void)
850 : : {
9520 851 : 20 : puts("psql (PostgreSQL) " PG_VERSION);
9761 bruce@momjian.us 852 : 20 : }
853 : :
854 : :
855 : :
856 : : /*
857 : : * Substitute hooks and assign hooks for psql variables.
858 : : *
859 : : * This isn't an amazingly good place for them, but neither is anywhere else.
860 : : *
861 : : * By policy, every special variable that controls any psql behavior should
862 : : * have one or both hooks, even if they're just no-ops. This ensures that
863 : : * the variable will remain present in variables.c's list even when unset,
864 : : * which ensures that it's known to tab completion.
865 : : */
866 : :
867 : : static char *
3462 tgl@sss.pgh.pa.us 868 : 145844 : bool_substitute_hook(char *newval)
869 : : {
870 [ + + ]: 145844 : if (newval == NULL)
871 : : {
872 : : /* "\unset FOO" becomes "\set FOO off" */
873 : 105644 : newval = pg_strdup("off");
874 : : }
875 [ + + ]: 40200 : else if (newval[0] == '\0')
876 : : {
877 : : /* "\set FOO" becomes "\set FOO on" */
878 : 4 : pg_free(newval);
879 : 4 : newval = pg_strdup("on");
880 : : }
881 : 145844 : return newval;
882 : : }
883 : :
884 : : static bool
7271 885 : 21156 : autocommit_hook(const char *newval)
886 : : {
3464 887 : 21156 : return ParseVariableBool(newval, "AUTOCOMMIT", &pset.autocommit);
888 : : }
889 : :
890 : : static bool
7271 891 : 17757 : on_error_stop_hook(const char *newval)
892 : : {
3464 893 : 17757 : return ParseVariableBool(newval, "ON_ERROR_STOP", &pset.on_error_stop);
894 : : }
895 : :
896 : : static bool
7271 897 : 19726 : quiet_hook(const char *newval)
898 : : {
3464 899 : 19726 : return ParseVariableBool(newval, "QUIET", &pset.quiet);
900 : : }
901 : :
902 : : static bool
7271 903 : 10564 : singleline_hook(const char *newval)
904 : : {
3464 905 : 10564 : return ParseVariableBool(newval, "SINGLELINE", &pset.singleline);
906 : : }
907 : :
908 : : static bool
7271 909 : 10564 : singlestep_hook(const char *newval)
910 : : {
3464 911 : 10564 : return ParseVariableBool(newval, "SINGLESTEP", &pset.singlestep);
912 : : }
913 : :
914 : : static char *
3461 915 : 10617 : fetch_count_substitute_hook(char *newval)
916 : : {
917 [ + + ]: 10617 : if (newval == NULL)
918 : 10588 : newval = pg_strdup("0");
919 : 10617 : return newval;
920 : : }
921 : :
922 : : static bool
7271 923 : 10617 : fetch_count_hook(const char *newval)
924 : : {
3461 925 : 10617 : return ParseVariableNum(newval, "FETCH_COUNT", &pset.fetch_count);
926 : : }
927 : :
928 : : static bool
929 : 10564 : histfile_hook(const char *newval)
930 : : {
931 : : /*
932 : : * Someday we might try to validate the filename, but for now, this is
933 : : * just a placeholder to ensure HISTFILE is known to tab completion.
934 : : */
3464 935 : 10564 : return true;
936 : : }
937 : :
938 : : static char *
3461 939 : 10564 : histsize_substitute_hook(char *newval)
940 : : {
941 [ + - ]: 10564 : if (newval == NULL)
942 : 10564 : newval = pg_strdup("500");
943 : 10564 : return newval;
944 : : }
945 : :
946 : : static bool
947 : 10564 : histsize_hook(const char *newval)
948 : : {
949 : 10564 : return ParseVariableNum(newval, "HISTSIZE", &pset.histsize);
950 : : }
951 : :
952 : : static char *
488 dgustafsson@postgres 953 : 10568 : watch_interval_substitute_hook(char *newval)
954 : : {
955 [ + + ]: 10568 : if (newval == NULL)
956 : 10565 : newval = pg_strdup(DEFAULT_WATCH_INTERVAL);
957 : 10568 : return newval;
958 : : }
959 : :
960 : : static bool
961 : 10568 : watch_interval_hook(const char *newval)
962 : : {
963 : 10568 : return ParseVariableDouble(newval, "WATCH_INTERVAL", &pset.watch_interval,
964 : : 0, DEFAULT_WATCH_INTERVAL_MAX);
965 : : }
966 : :
967 : : static char *
3461 tgl@sss.pgh.pa.us 968 : 10564 : ignoreeof_substitute_hook(char *newval)
969 : : {
970 : : int dummy;
971 : :
972 : : /*
973 : : * This tries to mimic the behavior of bash, to wit "If set, the value is
974 : : * the number of consecutive EOF characters which must be typed as the
975 : : * first characters on an input line before bash exits. If the variable
976 : : * exists but does not have a numeric value, or has no value, the default
977 : : * value is 10. If it does not exist, EOF signifies the end of input to
978 : : * the shell." Unlike bash, however, we insist on the stored value
979 : : * actually being a valid integer.
980 : : */
981 [ + - ]: 10564 : if (newval == NULL)
982 : 10564 : newval = pg_strdup("0");
3461 tgl@sss.pgh.pa.us 983 [ # # ]:UBC 0 : else if (!ParseVariableNum(newval, NULL, &dummy))
984 : 0 : newval = pg_strdup("10");
3461 tgl@sss.pgh.pa.us 985 :CBC 10564 : return newval;
986 : : }
987 : :
988 : : static bool
989 : 10564 : ignoreeof_hook(const char *newval)
990 : : {
991 : 10564 : return ParseVariableNum(newval, "IGNOREEOF", &pset.ignoreeof);
992 : : }
993 : :
994 : : static char *
3462 995 : 11910 : echo_substitute_hook(char *newval)
996 : : {
997 [ + + ]: 11910 : if (newval == NULL)
998 : 10564 : newval = pg_strdup("none");
999 : 11910 : return newval;
1000 : : }
1001 : :
1002 : : static bool
7271 1003 : 11910 : echo_hook(const char *newval)
1004 : : {
3462 1005 [ - + ]: 11910 : Assert(newval != NULL); /* else substitute hook messed up */
1006 [ + + ]: 11910 : if (pg_strcasecmp(newval, "queries") == 0)
7271 1007 : 10 : pset.echo = PSQL_ECHO_QUERIES;
4225 1008 [ + + ]: 11900 : else if (pg_strcasecmp(newval, "errors") == 0)
4399 fujii@postgresql.org 1009 : 4 : pset.echo = PSQL_ECHO_ERRORS;
4225 tgl@sss.pgh.pa.us 1010 [ + + ]: 11896 : else if (pg_strcasecmp(newval, "all") == 0)
7271 1011 : 1323 : pset.echo = PSQL_ECHO_ALL;
4225 1012 [ + - ]: 10573 : else if (pg_strcasecmp(newval, "none") == 0)
1013 : 10573 : pset.echo = PSQL_ECHO_NONE;
1014 : : else
1015 : : {
3464 tgl@sss.pgh.pa.us 1016 :UBC 0 : PsqlVarEnumError("ECHO", newval, "none, errors, queries, all");
1017 : 0 : return false;
1018 : : }
3464 tgl@sss.pgh.pa.us 1019 :CBC 11910 : return true;
1020 : : }
1021 : :
1022 : : static bool
7271 1023 : 10564 : echo_hidden_hook(const char *newval)
1024 : : {
3462 1025 [ - + ]: 10564 : Assert(newval != NULL); /* else substitute hook messed up */
1026 [ - + ]: 10564 : if (pg_strcasecmp(newval, "noexec") == 0)
7271 tgl@sss.pgh.pa.us 1027 :UBC 0 : pset.echo_hidden = PSQL_ECHO_HIDDEN_NOEXEC;
1028 : : else
1029 : : {
1030 : : bool on_off;
1031 : :
3464 tgl@sss.pgh.pa.us 1032 [ + - ]:CBC 10564 : if (ParseVariableBool(newval, NULL, &on_off))
1033 : 10564 : pset.echo_hidden = on_off ? PSQL_ECHO_HIDDEN_ON : PSQL_ECHO_HIDDEN_OFF;
1034 : : else
1035 : : {
3464 tgl@sss.pgh.pa.us 1036 :UBC 0 : PsqlVarEnumError("ECHO_HIDDEN", newval, "on, off, noexec");
1037 : 0 : return false;
1038 : : }
1039 : : }
3464 tgl@sss.pgh.pa.us 1040 :CBC 10564 : return true;
1041 : : }
1042 : :
1043 : : static bool
7271 1044 : 10596 : on_error_rollback_hook(const char *newval)
1045 : : {
3462 1046 [ - + ]: 10596 : Assert(newval != NULL); /* else substitute hook messed up */
1047 [ - + ]: 10596 : if (pg_strcasecmp(newval, "interactive") == 0)
7271 tgl@sss.pgh.pa.us 1048 :UBC 0 : pset.on_error_rollback = PSQL_ERROR_ROLLBACK_INTERACTIVE;
1049 : : else
1050 : : {
1051 : : bool on_off;
1052 : :
3464 tgl@sss.pgh.pa.us 1053 [ + + ]:CBC 10596 : if (ParseVariableBool(newval, NULL, &on_off))
1054 [ + + ]: 10592 : pset.on_error_rollback = on_off ? PSQL_ERROR_ROLLBACK_ON : PSQL_ERROR_ROLLBACK_OFF;
1055 : : else
1056 : : {
1057 : 4 : PsqlVarEnumError("ON_ERROR_ROLLBACK", newval, "on, off, interactive");
1058 : 4 : return false;
1059 : : }
1060 : : }
1061 : 10592 : return true;
1062 : : }
1063 : :
1064 : : static char *
3462 1065 : 10568 : comp_keyword_case_substitute_hook(char *newval)
1066 : : {
1067 [ + + ]: 10568 : if (newval == NULL)
1068 : 10564 : newval = pg_strdup("preserve-upper");
1069 : 10568 : return newval;
1070 : : }
1071 : :
1072 : : static bool
4225 1073 : 10568 : comp_keyword_case_hook(const char *newval)
1074 : : {
3462 1075 [ - + ]: 10568 : Assert(newval != NULL); /* else substitute hook messed up */
1076 [ + + ]: 10568 : if (pg_strcasecmp(newval, "preserve-upper") == 0)
4225 1077 : 10565 : pset.comp_case = PSQL_COMP_CASE_PRESERVE_UPPER;
1078 [ + + ]: 3 : else if (pg_strcasecmp(newval, "preserve-lower") == 0)
1079 : 1 : pset.comp_case = PSQL_COMP_CASE_PRESERVE_LOWER;
1080 [ + + ]: 2 : else if (pg_strcasecmp(newval, "upper") == 0)
1081 : 1 : pset.comp_case = PSQL_COMP_CASE_UPPER;
1082 [ + - ]: 1 : else if (pg_strcasecmp(newval, "lower") == 0)
1083 : 1 : pset.comp_case = PSQL_COMP_CASE_LOWER;
1084 : : else
1085 : : {
3464 tgl@sss.pgh.pa.us 1086 :UBC 0 : PsqlVarEnumError("COMP_KEYWORD_CASE", newval,
1087 : : "lower, upper, preserve-lower, preserve-upper");
1088 : 0 : return false;
1089 : : }
3464 tgl@sss.pgh.pa.us 1090 :CBC 10568 : return true;
1091 : : }
1092 : :
1093 : : static char *
3462 1094 : 10564 : histcontrol_substitute_hook(char *newval)
1095 : : {
1096 [ + - ]: 10564 : if (newval == NULL)
1097 : 10564 : newval = pg_strdup("none");
1098 : 10564 : return newval;
1099 : : }
1100 : :
1101 : : static bool
7271 1102 : 10564 : histcontrol_hook(const char *newval)
1103 : : {
3462 1104 [ - + ]: 10564 : Assert(newval != NULL); /* else substitute hook messed up */
1105 [ - + ]: 10564 : if (pg_strcasecmp(newval, "ignorespace") == 0)
7271 tgl@sss.pgh.pa.us 1106 :UBC 0 : pset.histcontrol = hctl_ignorespace;
4225 tgl@sss.pgh.pa.us 1107 [ - + ]:CBC 10564 : else if (pg_strcasecmp(newval, "ignoredups") == 0)
7271 tgl@sss.pgh.pa.us 1108 :UBC 0 : pset.histcontrol = hctl_ignoredups;
4225 tgl@sss.pgh.pa.us 1109 [ - + ]:CBC 10564 : else if (pg_strcasecmp(newval, "ignoreboth") == 0)
7271 tgl@sss.pgh.pa.us 1110 :UBC 0 : pset.histcontrol = hctl_ignoreboth;
4225 tgl@sss.pgh.pa.us 1111 [ + - ]:CBC 10564 : else if (pg_strcasecmp(newval, "none") == 0)
1112 : 10564 : pset.histcontrol = hctl_none;
1113 : : else
1114 : : {
3464 tgl@sss.pgh.pa.us 1115 :UBC 0 : PsqlVarEnumError("HISTCONTROL", newval,
1116 : : "none, ignorespace, ignoredups, ignoreboth");
1117 : 0 : return false;
1118 : : }
3464 tgl@sss.pgh.pa.us 1119 :CBC 10564 : return true;
1120 : : }
1121 : :
1122 : : static bool
7271 1123 : 21128 : prompt1_hook(const char *newval)
1124 : : {
1125 [ + + ]: 21128 : pset.prompt1 = newval ? newval : "";
3464 1126 : 21128 : return true;
1127 : : }
1128 : :
1129 : : static bool
7271 1130 : 21128 : prompt2_hook(const char *newval)
1131 : : {
1132 [ + + ]: 21128 : pset.prompt2 = newval ? newval : "";
3464 1133 : 21128 : return true;
1134 : : }
1135 : :
1136 : : static bool
7271 1137 : 21128 : prompt3_hook(const char *newval)
1138 : : {
1139 [ + + ]: 21128 : pset.prompt3 = newval ? newval : "";
3464 1140 : 21128 : return true;
1141 : : }
1142 : :
1143 : : static char *
3462 1144 : 10701 : verbosity_substitute_hook(char *newval)
1145 : : {
1146 [ + + ]: 10701 : if (newval == NULL)
1147 : 10564 : newval = pg_strdup("default");
1148 : 10701 : return newval;
1149 : : }
1150 : :
1151 : : static bool
7271 1152 : 10701 : verbosity_hook(const char *newval)
1153 : : {
3462 1154 [ - + ]: 10701 : Assert(newval != NULL); /* else substitute hook messed up */
1155 [ + + ]: 10701 : if (pg_strcasecmp(newval, "default") == 0)
7271 1156 : 10624 : pset.verbosity = PQERRORS_DEFAULT;
4225 1157 [ - + ]: 77 : else if (pg_strcasecmp(newval, "verbose") == 0)
7271 tgl@sss.pgh.pa.us 1158 :UBC 0 : pset.verbosity = PQERRORS_VERBOSE;
2670 tgl@sss.pgh.pa.us 1159 [ + + ]:CBC 77 : else if (pg_strcasecmp(newval, "terse") == 0)
1160 : 42 : pset.verbosity = PQERRORS_TERSE;
1161 [ + - ]: 35 : else if (pg_strcasecmp(newval, "sqlstate") == 0)
1162 : 35 : pset.verbosity = PQERRORS_SQLSTATE;
1163 : : else
1164 : : {
2670 tgl@sss.pgh.pa.us 1165 :UBC 0 : PsqlVarEnumError("VERBOSITY", newval, "default, verbose, terse, sqlstate");
3464 1166 : 0 : return false;
1167 : : }
1168 : :
7271 tgl@sss.pgh.pa.us 1169 [ + + ]:CBC 10701 : if (pset.db)
1170 : 137 : PQsetErrorVerbosity(pset.db, pset.verbosity);
3464 1171 : 10701 : return true;
1172 : : }
1173 : :
1174 : : static bool
1574 peter@eisentraut.org 1175 : 21137 : show_all_results_hook(const char *newval)
1176 : : {
1177 : 21137 : return ParseVariableBool(newval, "SHOW_ALL_RESULTS", &pset.show_all_results);
1178 : : }
1179 : :
1180 : : static char *
3462 tgl@sss.pgh.pa.us 1181 : 10596 : show_context_substitute_hook(char *newval)
1182 : : {
1183 [ + + ]: 10596 : if (newval == NULL)
1184 : 10565 : newval = pg_strdup("errors");
1185 : 10596 : return newval;
1186 : : }
1187 : :
1188 : : static bool
3977 1189 : 10596 : show_context_hook(const char *newval)
1190 : : {
3462 1191 [ - + ]: 10596 : Assert(newval != NULL); /* else substitute hook messed up */
1192 [ + + ]: 10596 : if (pg_strcasecmp(newval, "never") == 0)
3977 1193 : 9 : pset.show_context = PQSHOW_CONTEXT_NEVER;
1194 [ + + ]: 10587 : else if (pg_strcasecmp(newval, "errors") == 0)
1195 : 10577 : pset.show_context = PQSHOW_CONTEXT_ERRORS;
1196 [ + - ]: 10 : else if (pg_strcasecmp(newval, "always") == 0)
1197 : 10 : pset.show_context = PQSHOW_CONTEXT_ALWAYS;
1198 : : else
1199 : : {
3464 tgl@sss.pgh.pa.us 1200 :UBC 0 : PsqlVarEnumError("SHOW_CONTEXT", newval, "never, errors, always");
1201 : 0 : return false;
1202 : : }
1203 : :
3977 tgl@sss.pgh.pa.us 1204 [ + + ]:CBC 10596 : if (pset.db)
1205 : 32 : PQsetErrorContextVisibility(pset.db, pset.show_context);
3464 1206 : 10596 : return true;
1207 : : }
1208 : :
1209 : : static bool
1955 rhaas@postgresql.org 1210 : 11898 : hide_compression_hook(const char *newval)
1211 : : {
1212 : 11898 : return ParseVariableBool(newval, "HIDE_TOAST_COMPRESSION",
1213 : : &pset.hide_compression);
1214 : : }
1215 : :
1216 : : static bool
2699 andres@anarazel.de 1217 : 11882 : hide_tableam_hook(const char *newval)
1218 : : {
1219 : 11882 : return ParseVariableBool(newval, "HIDE_TABLEAM", &pset.hide_tableam);
1220 : : }
1221 : :
1222 : : static void
7271 tgl@sss.pgh.pa.us 1223 : 10564 : EstablishVariableSpace(void)
1224 : : {
1225 : 10564 : pset.vars = CreateVariableSpace();
1226 : :
3462 1227 : 10564 : SetVariableHooks(pset.vars, "AUTOCOMMIT",
1228 : : bool_substitute_hook,
1229 : : autocommit_hook);
1230 : 10564 : SetVariableHooks(pset.vars, "ON_ERROR_STOP",
1231 : : bool_substitute_hook,
1232 : : on_error_stop_hook);
1233 : 10564 : SetVariableHooks(pset.vars, "QUIET",
1234 : : bool_substitute_hook,
1235 : : quiet_hook);
1236 : 10564 : SetVariableHooks(pset.vars, "SINGLELINE",
1237 : : bool_substitute_hook,
1238 : : singleline_hook);
1239 : 10564 : SetVariableHooks(pset.vars, "SINGLESTEP",
1240 : : bool_substitute_hook,
1241 : : singlestep_hook);
1242 : 10564 : SetVariableHooks(pset.vars, "FETCH_COUNT",
1243 : : fetch_count_substitute_hook,
1244 : : fetch_count_hook);
3461 1245 : 10564 : SetVariableHooks(pset.vars, "HISTFILE",
1246 : : NULL,
1247 : : histfile_hook);
1248 : 10564 : SetVariableHooks(pset.vars, "HISTSIZE",
1249 : : histsize_substitute_hook,
1250 : : histsize_hook);
1251 : 10564 : SetVariableHooks(pset.vars, "IGNOREEOF",
1252 : : ignoreeof_substitute_hook,
1253 : : ignoreeof_hook);
3462 1254 : 10564 : SetVariableHooks(pset.vars, "ECHO",
1255 : : echo_substitute_hook,
1256 : : echo_hook);
1257 : 10564 : SetVariableHooks(pset.vars, "ECHO_HIDDEN",
1258 : : bool_substitute_hook,
1259 : : echo_hidden_hook);
1260 : 10564 : SetVariableHooks(pset.vars, "ON_ERROR_ROLLBACK",
1261 : : bool_substitute_hook,
1262 : : on_error_rollback_hook);
1263 : 10564 : SetVariableHooks(pset.vars, "COMP_KEYWORD_CASE",
1264 : : comp_keyword_case_substitute_hook,
1265 : : comp_keyword_case_hook);
1266 : 10564 : SetVariableHooks(pset.vars, "HISTCONTROL",
1267 : : histcontrol_substitute_hook,
1268 : : histcontrol_hook);
1269 : 10564 : SetVariableHooks(pset.vars, "PROMPT1",
1270 : : NULL,
1271 : : prompt1_hook);
1272 : 10564 : SetVariableHooks(pset.vars, "PROMPT2",
1273 : : NULL,
1274 : : prompt2_hook);
1275 : 10564 : SetVariableHooks(pset.vars, "PROMPT3",
1276 : : NULL,
1277 : : prompt3_hook);
1278 : 10564 : SetVariableHooks(pset.vars, "VERBOSITY",
1279 : : verbosity_substitute_hook,
1280 : : verbosity_hook);
1574 peter@eisentraut.org 1281 : 10564 : SetVariableHooks(pset.vars, "SHOW_ALL_RESULTS",
1282 : : bool_substitute_hook,
1283 : : show_all_results_hook);
3462 tgl@sss.pgh.pa.us 1284 : 10564 : SetVariableHooks(pset.vars, "SHOW_CONTEXT",
1285 : : show_context_substitute_hook,
1286 : : show_context_hook);
1955 rhaas@postgresql.org 1287 : 10564 : SetVariableHooks(pset.vars, "HIDE_TOAST_COMPRESSION",
1288 : : bool_substitute_hook,
1289 : : hide_compression_hook);
2699 andres@anarazel.de 1290 : 10564 : SetVariableHooks(pset.vars, "HIDE_TABLEAM",
1291 : : bool_substitute_hook,
1292 : : hide_tableam_hook);
488 dgustafsson@postgres 1293 : 10564 : SetVariableHooks(pset.vars, "WATCH_INTERVAL",
1294 : : watch_interval_substitute_hook,
1295 : : watch_interval_hook);
7271 tgl@sss.pgh.pa.us 1296 : 10564 : }
|