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