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