Line data Source code
1 : /*
2 : * psql - the PostgreSQL interactive terminal
3 : *
4 : * Copyright (c) 2000-2020, 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 "describe.h"
21 : #include "fe_utils/print.h"
22 : #include "getopt_long.h"
23 : #include "help.h"
24 : #include "input.h"
25 : #include "mainloop.h"
26 : #include "settings.h"
27 :
28 : /*
29 : * Global psql options
30 : */
31 : PsqlSettings pset;
32 :
33 : #ifndef WIN32
34 : #define SYSPSQLRC "psqlrc"
35 : #define PSQLRC ".psqlrc"
36 : #else
37 : #define SYSPSQLRC "psqlrc"
38 : #define PSQLRC "psqlrc.conf"
39 : #endif
40 :
41 : /*
42 : * Structures to pass information between the option parsing routine
43 : * and the main function
44 : */
45 : enum _actions
46 : {
47 : ACT_SINGLE_QUERY,
48 : ACT_SINGLE_SLASH,
49 : ACT_FILE
50 : };
51 :
52 : typedef struct SimpleActionListCell
53 : {
54 : struct SimpleActionListCell *next;
55 : enum _actions action;
56 : char *val;
57 : } SimpleActionListCell;
58 :
59 : typedef struct SimpleActionList
60 : {
61 : SimpleActionListCell *head;
62 : SimpleActionListCell *tail;
63 : } SimpleActionList;
64 :
65 : struct adhoc_opts
66 : {
67 : char *dbname;
68 : char *host;
69 : char *port;
70 : char *username;
71 : char *logfilename;
72 : bool no_readline;
73 : bool no_psqlrc;
74 : bool single_txn;
75 : bool list_dbs;
76 : SimpleActionList actions;
77 : };
78 :
79 : static void parse_psql_options(int argc, char *argv[],
80 : struct adhoc_opts *options);
81 : static void simple_action_list_append(SimpleActionList *list,
82 : enum _actions action, const char *val);
83 : static void process_psqlrc(char *argv0);
84 : static void process_psqlrc_file(char *filename);
85 : static void showVersion(void);
86 : static void EstablishVariableSpace(void);
87 :
88 : #define NOPAGER 0
89 :
90 : static void
91 29548 : log_pre_callback(void)
92 : {
93 29548 : if (pset.queryFout && pset.queryFout != stdout)
94 0 : fflush(pset.queryFout);
95 29548 : }
96 :
97 : static void
98 29548 : log_locus_callback(const char **filename, uint64 *lineno)
99 : {
100 29548 : if (pset.inputfile)
101 : {
102 326 : *filename = pset.inputfile;
103 326 : *lineno = pset.lineno;
104 : }
105 : else
106 : {
107 29222 : *filename = NULL;
108 29222 : *lineno = 0;
109 : }
110 29548 : }
111 :
112 : /*
113 : *
114 : * main
115 : *
116 : */
117 : int
118 5052 : main(int argc, char *argv[])
119 : {
120 : struct adhoc_opts options;
121 : int successResult;
122 5052 : bool have_password = false;
123 : char password[100];
124 : bool new_pass;
125 :
126 5052 : pg_logging_init(argv[0]);
127 5052 : pg_logging_set_pre_callback(log_pre_callback);
128 5052 : pg_logging_set_locus_callback(log_locus_callback);
129 5052 : set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("psql"));
130 :
131 5052 : if (argc > 1)
132 : {
133 5052 : if ((strcmp(argv[1], "-?") == 0) || (argc == 2 && (strcmp(argv[1], "--help") == 0)))
134 : {
135 0 : usage(NOPAGER);
136 0 : exit(EXIT_SUCCESS);
137 : }
138 5052 : if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
139 : {
140 0 : showVersion();
141 0 : exit(EXIT_SUCCESS);
142 : }
143 : }
144 :
145 5052 : pset.progname = get_progname(argv[0]);
146 :
147 5052 : pset.db = NULL;
148 5052 : setDecimalLocale();
149 5052 : pset.encoding = PQenv2encoding();
150 5052 : pset.queryFout = stdout;
151 5052 : pset.queryFoutPipe = false;
152 5052 : pset.copyStream = NULL;
153 5052 : pset.last_error_result = NULL;
154 5052 : pset.cur_cmd_source = stdin;
155 5052 : pset.cur_cmd_interactive = false;
156 :
157 : /* We rely on unmentioned fields of pset.popt to start out 0/false/NULL */
158 5052 : pset.popt.topt.format = PRINT_ALIGNED;
159 5052 : pset.popt.topt.border = 1;
160 5052 : pset.popt.topt.pager = 1;
161 5052 : pset.popt.topt.pager_min_lines = 0;
162 5052 : pset.popt.topt.start_table = true;
163 5052 : pset.popt.topt.stop_table = true;
164 5052 : pset.popt.topt.default_footer = true;
165 :
166 5052 : pset.popt.topt.csvFieldSep[0] = DEFAULT_CSV_FIELD_SEP;
167 5052 : pset.popt.topt.csvFieldSep[1] = '\0';
168 :
169 5052 : pset.popt.topt.unicode_border_linestyle = UNICODE_LINESTYLE_SINGLE;
170 5052 : pset.popt.topt.unicode_column_linestyle = UNICODE_LINESTYLE_SINGLE;
171 5052 : pset.popt.topt.unicode_header_linestyle = UNICODE_LINESTYLE_SINGLE;
172 :
173 5052 : refresh_utf8format(&(pset.popt.topt));
174 :
175 : /* We must get COLUMNS here before readline() sets it */
176 5052 : pset.popt.topt.env_columns = getenv("COLUMNS") ? atoi(getenv("COLUMNS")) : 0;
177 :
178 5052 : pset.notty = (!isatty(fileno(stdin)) || !isatty(fileno(stdout)));
179 :
180 5052 : pset.getPassword = TRI_DEFAULT;
181 :
182 5052 : EstablishVariableSpace();
183 :
184 : /* Create variables showing psql version number */
185 5052 : SetVariable(pset.vars, "VERSION", PG_VERSION_STR);
186 5052 : SetVariable(pset.vars, "VERSION_NAME", PG_VERSION);
187 5052 : SetVariable(pset.vars, "VERSION_NUM", CppAsString2(PG_VERSION_NUM));
188 :
189 : /* Initialize variables for last error */
190 5052 : SetVariable(pset.vars, "LAST_ERROR_MESSAGE", "");
191 5052 : SetVariable(pset.vars, "LAST_ERROR_SQLSTATE", "00000");
192 :
193 : /* Default values for variables (that don't match the result of \unset) */
194 5052 : SetVariableBool(pset.vars, "AUTOCOMMIT");
195 5052 : SetVariable(pset.vars, "PROMPT1", DEFAULT_PROMPT1);
196 5052 : SetVariable(pset.vars, "PROMPT2", DEFAULT_PROMPT2);
197 5052 : SetVariable(pset.vars, "PROMPT3", DEFAULT_PROMPT3);
198 :
199 5052 : parse_psql_options(argc, argv, &options);
200 :
201 : /*
202 : * If no action was specified and we're in non-interactive mode, treat it
203 : * as if the user had specified "-f -". This lets single-transaction mode
204 : * work in this case.
205 : */
206 5052 : if (options.actions.head == NULL && pset.notty)
207 1672 : simple_action_list_append(&options.actions, ACT_FILE, NULL);
208 :
209 : /* Bail out if -1 was specified but will be ignored. */
210 5052 : if (options.single_txn && options.actions.head == NULL)
211 : {
212 0 : pg_log_fatal("-1 can only be used in non-interactive mode");
213 0 : exit(EXIT_FAILURE);
214 : }
215 :
216 5052 : if (!pset.popt.topt.fieldSep.separator &&
217 5048 : !pset.popt.topt.fieldSep.separator_zero)
218 : {
219 5048 : pset.popt.topt.fieldSep.separator = pg_strdup(DEFAULT_FIELD_SEP);
220 5048 : pset.popt.topt.fieldSep.separator_zero = false;
221 : }
222 5052 : if (!pset.popt.topt.recordSep.separator &&
223 5052 : !pset.popt.topt.recordSep.separator_zero)
224 : {
225 5052 : pset.popt.topt.recordSep.separator = pg_strdup(DEFAULT_RECORD_SEP);
226 5052 : pset.popt.topt.recordSep.separator_zero = false;
227 : }
228 :
229 5052 : if (pset.getPassword == TRI_YES)
230 : {
231 : /*
232 : * We can't be sure yet of the username that will be used, so don't
233 : * offer a potentially wrong one. Typical uses of this option are
234 : * noninteractive anyway.
235 : */
236 0 : simple_prompt("Password: ", password, sizeof(password), false);
237 0 : have_password = true;
238 : }
239 :
240 : /* loop until we have a password if requested by backend */
241 : do
242 : {
243 : #define PARAMS_ARRAY_SIZE 8
244 5052 : const char **keywords = pg_malloc(PARAMS_ARRAY_SIZE * sizeof(*keywords));
245 5052 : const char **values = pg_malloc(PARAMS_ARRAY_SIZE * sizeof(*values));
246 :
247 5052 : keywords[0] = "host";
248 5052 : values[0] = options.host;
249 5052 : keywords[1] = "port";
250 5052 : values[1] = options.port;
251 5052 : keywords[2] = "user";
252 5052 : values[2] = options.username;
253 5052 : keywords[3] = "password";
254 5052 : values[3] = have_password ? password : NULL;
255 5052 : keywords[4] = "dbname"; /* see do_connect() */
256 0 : values[4] = (options.list_dbs && options.dbname == NULL) ?
257 5052 : "postgres" : options.dbname;
258 5052 : keywords[5] = "fallback_application_name";
259 5052 : values[5] = pset.progname;
260 5052 : keywords[6] = "client_encoding";
261 5052 : values[6] = (pset.notty || getenv("PGCLIENTENCODING")) ? NULL : "auto";
262 5052 : keywords[7] = NULL;
263 5052 : values[7] = NULL;
264 :
265 5052 : new_pass = false;
266 5052 : pset.db = PQconnectdbParams(keywords, values, true);
267 5052 : free(keywords);
268 5052 : free(values);
269 :
270 5414 : if (PQstatus(pset.db) == CONNECTION_BAD &&
271 362 : PQconnectionNeedsPassword(pset.db) &&
272 0 : !have_password &&
273 0 : pset.getPassword != TRI_NO)
274 : {
275 : /*
276 : * Before closing the old PGconn, extract the user name that was
277 : * actually connected with --- it might've come out of a URI or
278 : * connstring "database name" rather than options.username.
279 : */
280 0 : const char *realusername = PQuser(pset.db);
281 : char *password_prompt;
282 :
283 0 : if (realusername && realusername[0])
284 0 : password_prompt = psprintf(_("Password for user %s: "),
285 : realusername);
286 : else
287 0 : password_prompt = pg_strdup(_("Password: "));
288 0 : PQfinish(pset.db);
289 :
290 0 : simple_prompt(password_prompt, password, sizeof(password), false);
291 0 : free(password_prompt);
292 0 : have_password = true;
293 0 : new_pass = true;
294 : }
295 5052 : } while (new_pass);
296 :
297 5052 : if (PQstatus(pset.db) == CONNECTION_BAD)
298 : {
299 362 : pg_log_error("could not connect to server: %s", PQerrorMessage(pset.db));
300 362 : PQfinish(pset.db);
301 362 : exit(EXIT_BADCONN);
302 : }
303 :
304 4690 : psql_setup_cancel_handler();
305 :
306 4690 : PQsetNoticeProcessor(pset.db, NoticeProcessor, NULL);
307 :
308 4690 : SyncVariables();
309 :
310 4690 : if (options.list_dbs)
311 : {
312 : int success;
313 :
314 0 : if (!options.no_psqlrc)
315 0 : process_psqlrc(argv[0]);
316 :
317 0 : success = listAllDbs(NULL, false);
318 0 : PQfinish(pset.db);
319 0 : exit(success ? EXIT_SUCCESS : EXIT_FAILURE);
320 : }
321 :
322 4690 : if (options.logfilename)
323 : {
324 0 : pset.logfile = fopen(options.logfilename, "a");
325 0 : if (!pset.logfile)
326 : {
327 0 : pg_log_fatal("could not open log file \"%s\": %m",
328 : options.logfilename);
329 0 : exit(EXIT_FAILURE);
330 : }
331 : }
332 :
333 4690 : if (!options.no_psqlrc)
334 0 : process_psqlrc(argv[0]);
335 :
336 : /*
337 : * If any actions were given by user, process them in the order in which
338 : * they were specified. Note single_txn is only effective in this mode.
339 : */
340 4690 : if (options.actions.head != NULL)
341 : {
342 : PGresult *res;
343 : SimpleActionListCell *cell;
344 :
345 4688 : successResult = EXIT_SUCCESS; /* silence compiler */
346 :
347 4688 : if (options.single_txn)
348 : {
349 0 : if ((res = PSQLexec("BEGIN")) == NULL)
350 : {
351 0 : if (pset.on_error_stop)
352 : {
353 0 : successResult = EXIT_USER;
354 0 : goto error;
355 : }
356 : }
357 : else
358 0 : PQclear(res);
359 : }
360 :
361 9336 : for (cell = options.actions.head; cell; cell = cell->next)
362 : {
363 4688 : if (cell->action == ACT_SINGLE_QUERY)
364 : {
365 1184 : pg_logging_config(PG_LOG_FLAG_TERSE);
366 :
367 1184 : if (pset.echo == PSQL_ECHO_ALL)
368 0 : puts(cell->val);
369 :
370 1184 : successResult = SendQuery(cell->val)
371 1182 : ? EXIT_SUCCESS : EXIT_FAILURE;
372 : }
373 3504 : else if (cell->action == ACT_SINGLE_SLASH)
374 : {
375 : PsqlScanState scan_state;
376 : ConditionalStack cond_stack;
377 :
378 0 : pg_logging_config(PG_LOG_FLAG_TERSE);
379 :
380 0 : if (pset.echo == PSQL_ECHO_ALL)
381 0 : puts(cell->val);
382 :
383 0 : scan_state = psql_scan_create(&psqlscan_callbacks);
384 0 : psql_scan_setup(scan_state,
385 0 : cell->val, strlen(cell->val),
386 0 : pset.encoding, standard_strings());
387 0 : cond_stack = conditional_stack_create();
388 0 : psql_scan_set_passthrough(scan_state, (void *) cond_stack);
389 :
390 0 : successResult = HandleSlashCmds(scan_state,
391 : cond_stack,
392 : NULL,
393 : NULL) != PSQL_CMD_ERROR
394 0 : ? EXIT_SUCCESS : EXIT_FAILURE;
395 :
396 0 : psql_scan_destroy(scan_state);
397 0 : conditional_stack_destroy(cond_stack);
398 : }
399 3504 : else if (cell->action == ACT_FILE)
400 : {
401 3504 : successResult = process_file(cell->val, false);
402 : }
403 : else
404 : {
405 : /* should never come here */
406 : Assert(false);
407 : }
408 :
409 4680 : if (successResult != EXIT_SUCCESS && pset.on_error_stop)
410 32 : break;
411 : }
412 :
413 4680 : if (options.single_txn)
414 : {
415 0 : if ((res = PSQLexec("COMMIT")) == NULL)
416 : {
417 0 : if (pset.on_error_stop)
418 : {
419 0 : successResult = EXIT_USER;
420 0 : goto error;
421 : }
422 : }
423 : else
424 0 : PQclear(res);
425 : }
426 :
427 4680 : error:
428 : ;
429 : }
430 :
431 : /*
432 : * or otherwise enter interactive main loop
433 : */
434 : else
435 : {
436 2 : pg_logging_config(PG_LOG_FLAG_TERSE);
437 2 : connection_warnings(true);
438 2 : if (!pset.quiet)
439 2 : printf(_("Type \"help\" for help.\n\n"));
440 2 : initializeInput(options.no_readline ? 0 : 1);
441 2 : successResult = MainLoop(stdin);
442 : }
443 :
444 : /* clean up */
445 4682 : if (pset.logfile)
446 0 : fclose(pset.logfile);
447 4682 : PQfinish(pset.db);
448 4682 : setQFout(NULL);
449 :
450 4682 : return successResult;
451 : }
452 :
453 :
454 : /*
455 : * Parse command line options
456 : */
457 :
458 : static void
459 5052 : parse_psql_options(int argc, char *argv[], struct adhoc_opts *options)
460 : {
461 : static struct option long_options[] =
462 : {
463 : {"echo-all", no_argument, NULL, 'a'},
464 : {"no-align", no_argument, NULL, 'A'},
465 : {"command", required_argument, NULL, 'c'},
466 : {"dbname", required_argument, NULL, 'd'},
467 : {"echo-queries", no_argument, NULL, 'e'},
468 : {"echo-errors", no_argument, NULL, 'b'},
469 : {"echo-hidden", no_argument, NULL, 'E'},
470 : {"file", required_argument, NULL, 'f'},
471 : {"field-separator", required_argument, NULL, 'F'},
472 : {"field-separator-zero", no_argument, NULL, 'z'},
473 : {"host", required_argument, NULL, 'h'},
474 : {"html", no_argument, NULL, 'H'},
475 : {"list", no_argument, NULL, 'l'},
476 : {"log-file", required_argument, NULL, 'L'},
477 : {"no-readline", no_argument, NULL, 'n'},
478 : {"single-transaction", no_argument, NULL, '1'},
479 : {"output", required_argument, NULL, 'o'},
480 : {"port", required_argument, NULL, 'p'},
481 : {"pset", required_argument, NULL, 'P'},
482 : {"quiet", no_argument, NULL, 'q'},
483 : {"record-separator", required_argument, NULL, 'R'},
484 : {"record-separator-zero", no_argument, NULL, '0'},
485 : {"single-step", no_argument, NULL, 's'},
486 : {"single-line", no_argument, NULL, 'S'},
487 : {"tuples-only", no_argument, NULL, 't'},
488 : {"table-attr", required_argument, NULL, 'T'},
489 : {"username", required_argument, NULL, 'U'},
490 : {"set", required_argument, NULL, 'v'},
491 : {"variable", required_argument, NULL, 'v'},
492 : {"version", no_argument, NULL, 'V'},
493 : {"no-password", no_argument, NULL, 'w'},
494 : {"password", no_argument, NULL, 'W'},
495 : {"expanded", no_argument, NULL, 'x'},
496 : {"no-psqlrc", no_argument, NULL, 'X'},
497 : {"help", optional_argument, NULL, 1},
498 : {"csv", no_argument, NULL, 2},
499 : {NULL, 0, NULL, 0}
500 : };
501 :
502 : int optindex;
503 : int c;
504 :
505 5052 : memset(options, 0, sizeof *options);
506 :
507 31968 : while ((c = getopt_long(argc, argv, "aAbc:d:eEf:F:h:HlL:no:p:P:qR:sStT:U:v:VwWxXz?01",
508 : long_options, &optindex)) != -1)
509 : {
510 26916 : switch (c)
511 : {
512 1274 : case 'a':
513 1274 : SetVariable(pset.vars, "ECHO", "all");
514 1274 : break;
515 2878 : case 'A':
516 2878 : pset.popt.topt.format = PRINT_UNALIGNED;
517 2878 : break;
518 0 : case 'b':
519 0 : SetVariable(pset.vars, "ECHO", "errors");
520 0 : break;
521 1246 : case 'c':
522 1246 : if (optarg[0] == '\\')
523 0 : simple_action_list_append(&options->actions,
524 : ACT_SINGLE_SLASH,
525 0 : optarg + 1);
526 : else
527 1246 : simple_action_list_append(&options->actions,
528 : ACT_SINGLE_QUERY,
529 : optarg);
530 1246 : break;
531 4348 : case 'd':
532 4348 : options->dbname = pg_strdup(optarg);
533 4348 : break;
534 2 : case 'e':
535 2 : SetVariable(pset.vars, "ECHO", "queries");
536 2 : break;
537 0 : case 'E':
538 0 : SetVariableBool(pset.vars, "ECHO_HIDDEN");
539 0 : break;
540 2132 : case 'f':
541 2132 : simple_action_list_append(&options->actions,
542 : ACT_FILE,
543 : optarg);
544 2132 : break;
545 4 : case 'F':
546 4 : pset.popt.topt.fieldSep.separator = pg_strdup(optarg);
547 4 : pset.popt.topt.fieldSep.separator_zero = false;
548 4 : break;
549 2 : case 'h':
550 2 : options->host = pg_strdup(optarg);
551 2 : break;
552 0 : case 'H':
553 0 : pset.popt.topt.format = PRINT_HTML;
554 0 : break;
555 0 : case 'l':
556 0 : options->list_dbs = true;
557 0 : break;
558 0 : case 'L':
559 0 : options->logfilename = pg_strdup(optarg);
560 0 : break;
561 0 : case 'n':
562 0 : options->no_readline = true;
563 0 : break;
564 0 : case 'o':
565 0 : if (!setQFout(optarg))
566 0 : exit(EXIT_FAILURE);
567 0 : break;
568 4 : case 'p':
569 4 : options->port = pg_strdup(optarg);
570 4 : break;
571 4 : case 'P':
572 : {
573 : char *value;
574 : char *equal_loc;
575 : bool result;
576 :
577 4 : value = pg_strdup(optarg);
578 4 : equal_loc = strchr(value, '=');
579 4 : if (!equal_loc)
580 0 : result = do_pset(value, NULL, &pset.popt, true);
581 : else
582 : {
583 4 : *equal_loc = '\0';
584 4 : result = do_pset(value, equal_loc + 1, &pset.popt, true);
585 : }
586 :
587 4 : if (!result)
588 : {
589 0 : pg_log_fatal("could not set printing parameter \"%s\"", value);
590 0 : exit(EXIT_FAILURE);
591 : }
592 :
593 4 : free(value);
594 4 : break;
595 : }
596 3602 : case 'q':
597 3602 : SetVariableBool(pset.vars, "QUIET");
598 3602 : break;
599 0 : case 'R':
600 0 : pset.popt.topt.recordSep.separator = pg_strdup(optarg);
601 0 : pset.popt.topt.recordSep.separator_zero = false;
602 0 : break;
603 0 : case 's':
604 0 : SetVariableBool(pset.vars, "SINGLESTEP");
605 0 : break;
606 0 : case 'S':
607 0 : SetVariableBool(pset.vars, "SINGLELINE");
608 0 : break;
609 2874 : case 't':
610 2874 : pset.popt.topt.tuples_only = true;
611 2874 : break;
612 0 : case 'T':
613 0 : pset.popt.topt.tableAttr = pg_strdup(optarg);
614 0 : break;
615 94 : case 'U':
616 94 : options->username = pg_strdup(optarg);
617 94 : break;
618 3400 : case 'v':
619 : {
620 : char *value;
621 : char *equal_loc;
622 :
623 3400 : value = pg_strdup(optarg);
624 3400 : equal_loc = strchr(value, '=');
625 3400 : if (!equal_loc)
626 : {
627 0 : if (!DeleteVariable(pset.vars, value))
628 0 : exit(EXIT_FAILURE); /* error already printed */
629 : }
630 : else
631 : {
632 3400 : *equal_loc = '\0';
633 3400 : if (!SetVariable(pset.vars, value, equal_loc + 1))
634 0 : exit(EXIT_FAILURE); /* error already printed */
635 : }
636 :
637 3400 : free(value);
638 3400 : break;
639 : }
640 0 : case 'V':
641 0 : showVersion();
642 0 : exit(EXIT_SUCCESS);
643 0 : case 'w':
644 0 : pset.getPassword = TRI_NO;
645 0 : break;
646 0 : case 'W':
647 0 : pset.getPassword = TRI_YES;
648 0 : break;
649 0 : case 'x':
650 0 : pset.popt.topt.expanded = true;
651 0 : break;
652 5052 : case 'X':
653 5052 : options->no_psqlrc = true;
654 5052 : break;
655 0 : case 'z':
656 0 : pset.popt.topt.fieldSep.separator_zero = true;
657 0 : break;
658 0 : case '0':
659 0 : pset.popt.topt.recordSep.separator_zero = true;
660 0 : break;
661 0 : case '1':
662 0 : options->single_txn = true;
663 0 : break;
664 0 : case '?':
665 0 : if (optind <= argc &&
666 0 : strcmp(argv[optind - 1], "-?") == 0)
667 : {
668 : /* actual help option given */
669 0 : usage(NOPAGER);
670 0 : exit(EXIT_SUCCESS);
671 : }
672 : else
673 : {
674 : /* getopt error (unknown option or missing argument) */
675 0 : goto unknown_option;
676 : }
677 : break;
678 0 : 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 0 : goto unknown_option;
688 :
689 0 : exit(EXIT_SUCCESS);
690 : }
691 : break;
692 0 : case 2:
693 0 : pset.popt.topt.format = PRINT_CSV;
694 0 : break;
695 : default:
696 0 : 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 5772 : while (argc - optind >= 1)
708 : {
709 720 : if (!options->dbname)
710 720 : 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 720 : optind++;
718 : }
719 5052 : }
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 5050 : simple_action_list_append(SimpleActionList *list,
728 : enum _actions action, const char *val)
729 : {
730 : SimpleActionListCell *cell;
731 :
732 5050 : cell = (SimpleActionListCell *) pg_malloc(sizeof(SimpleActionListCell));
733 :
734 5050 : cell->next = NULL;
735 5050 : cell->action = action;
736 5050 : if (val)
737 3378 : cell->val = pg_strdup(val);
738 : else
739 1672 : cell->val = NULL;
740 :
741 5050 : if (list->tail)
742 0 : list->tail->next = cell;
743 : else
744 5050 : list->head = cell;
745 5050 : list->tail = cell;
746 5050 : }
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 52538 : bool_substitute_hook(char *newval)
841 : {
842 52538 : if (newval == NULL)
843 : {
844 : /* "\unset FOO" becomes "\set FOO off" */
845 40420 : newval = pg_strdup("off");
846 : }
847 12118 : 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 52538 : return newval;
854 : }
855 :
856 : static bool
857 10108 : autocommit_hook(const char *newval)
858 : {
859 10108 : return ParseVariableBool(newval, "AUTOCOMMIT", &pset.autocommit);
860 : }
861 :
862 : static bool
863 7178 : on_error_stop_hook(const char *newval)
864 : {
865 7178 : return ParseVariableBool(newval, "ON_ERROR_STOP", &pset.on_error_stop);
866 : }
867 :
868 : static bool
869 8694 : quiet_hook(const char *newval)
870 : {
871 8694 : return ParseVariableBool(newval, "QUIET", &pset.quiet);
872 : }
873 :
874 : static bool
875 5052 : singleline_hook(const char *newval)
876 : {
877 5052 : return ParseVariableBool(newval, "SINGLELINE", &pset.singleline);
878 : }
879 :
880 : static bool
881 5052 : singlestep_hook(const char *newval)
882 : {
883 5052 : return ParseVariableBool(newval, "SINGLESTEP", &pset.singlestep);
884 : }
885 :
886 : static char *
887 5088 : fetch_count_substitute_hook(char *newval)
888 : {
889 5088 : if (newval == NULL)
890 5068 : newval = pg_strdup("0");
891 5088 : return newval;
892 : }
893 :
894 : static bool
895 5088 : fetch_count_hook(const char *newval)
896 : {
897 5088 : return ParseVariableNum(newval, "FETCH_COUNT", &pset.fetch_count);
898 : }
899 :
900 : static bool
901 5052 : 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 5052 : return true;
908 : }
909 :
910 : static char *
911 5052 : histsize_substitute_hook(char *newval)
912 : {
913 5052 : if (newval == NULL)
914 5052 : newval = pg_strdup("500");
915 5052 : return newval;
916 : }
917 :
918 : static bool
919 5052 : histsize_hook(const char *newval)
920 : {
921 5052 : return ParseVariableNum(newval, "HISTSIZE", &pset.histsize);
922 : }
923 :
924 : static char *
925 5052 : 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 5052 : if (newval == NULL)
939 5052 : newval = pg_strdup("0");
940 0 : else if (!ParseVariableNum(newval, NULL, &dummy))
941 0 : newval = pg_strdup("10");
942 5052 : return newval;
943 : }
944 :
945 : static bool
946 5052 : ignoreeof_hook(const char *newval)
947 : {
948 5052 : return ParseVariableNum(newval, "IGNOREEOF", &pset.ignoreeof);
949 : }
950 :
951 : static char *
952 6344 : echo_substitute_hook(char *newval)
953 : {
954 6344 : if (newval == NULL)
955 5052 : newval = pg_strdup("none");
956 6344 : return newval;
957 : }
958 :
959 : static bool
960 6344 : echo_hook(const char *newval)
961 : {
962 : Assert(newval != NULL); /* else substitute hook messed up */
963 6344 : if (pg_strcasecmp(newval, "queries") == 0)
964 2 : pset.echo = PSQL_ECHO_QUERIES;
965 6342 : else if (pg_strcasecmp(newval, "errors") == 0)
966 0 : pset.echo = PSQL_ECHO_ERRORS;
967 6342 : else if (pg_strcasecmp(newval, "all") == 0)
968 1282 : pset.echo = PSQL_ECHO_ALL;
969 5060 : else if (pg_strcasecmp(newval, "none") == 0)
970 5060 : pset.echo = PSQL_ECHO_NONE;
971 : else
972 : {
973 0 : PsqlVarEnumError("ECHO", newval, "none, errors, queries, all");
974 0 : return false;
975 : }
976 6344 : return true;
977 : }
978 :
979 : static bool
980 5052 : echo_hidden_hook(const char *newval)
981 : {
982 : Assert(newval != NULL); /* else substitute hook messed up */
983 5052 : if (pg_strcasecmp(newval, "noexec") == 0)
984 0 : pset.echo_hidden = PSQL_ECHO_HIDDEN_NOEXEC;
985 : else
986 : {
987 : bool on_off;
988 :
989 5052 : if (ParseVariableBool(newval, NULL, &on_off))
990 5052 : 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 5052 : return true;
998 : }
999 :
1000 : static bool
1001 5068 : on_error_rollback_hook(const char *newval)
1002 : {
1003 : Assert(newval != NULL); /* else substitute hook messed up */
1004 5068 : 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 5068 : if (ParseVariableBool(newval, NULL, &on_off))
1011 5064 : 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 5064 : return true;
1019 : }
1020 :
1021 : static char *
1022 5052 : comp_keyword_case_substitute_hook(char *newval)
1023 : {
1024 5052 : if (newval == NULL)
1025 5052 : newval = pg_strdup("preserve-upper");
1026 5052 : return newval;
1027 : }
1028 :
1029 : static bool
1030 5052 : comp_keyword_case_hook(const char *newval)
1031 : {
1032 : Assert(newval != NULL); /* else substitute hook messed up */
1033 5052 : if (pg_strcasecmp(newval, "preserve-upper") == 0)
1034 5052 : 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 5052 : return true;
1048 : }
1049 :
1050 : static char *
1051 5052 : histcontrol_substitute_hook(char *newval)
1052 : {
1053 5052 : if (newval == NULL)
1054 5052 : newval = pg_strdup("none");
1055 5052 : return newval;
1056 : }
1057 :
1058 : static bool
1059 5052 : histcontrol_hook(const char *newval)
1060 : {
1061 : Assert(newval != NULL); /* else substitute hook messed up */
1062 5052 : if (pg_strcasecmp(newval, "ignorespace") == 0)
1063 0 : pset.histcontrol = hctl_ignorespace;
1064 5052 : else if (pg_strcasecmp(newval, "ignoredups") == 0)
1065 0 : pset.histcontrol = hctl_ignoredups;
1066 5052 : else if (pg_strcasecmp(newval, "ignoreboth") == 0)
1067 0 : pset.histcontrol = hctl_ignoreboth;
1068 5052 : else if (pg_strcasecmp(newval, "none") == 0)
1069 5052 : pset.histcontrol = hctl_none;
1070 : else
1071 : {
1072 0 : PsqlVarEnumError("HISTCONTROL", newval,
1073 : "none, ignorespace, ignoredups, ignoreboth");
1074 0 : return false;
1075 : }
1076 5052 : return true;
1077 : }
1078 :
1079 : static bool
1080 10104 : prompt1_hook(const char *newval)
1081 : {
1082 10104 : pset.prompt1 = newval ? newval : "";
1083 10104 : return true;
1084 : }
1085 :
1086 : static bool
1087 10104 : prompt2_hook(const char *newval)
1088 : {
1089 10104 : pset.prompt2 = newval ? newval : "";
1090 10104 : return true;
1091 : }
1092 :
1093 : static bool
1094 10104 : prompt3_hook(const char *newval)
1095 : {
1096 10104 : pset.prompt3 = newval ? newval : "";
1097 10104 : return true;
1098 : }
1099 :
1100 : static char *
1101 5112 : verbosity_substitute_hook(char *newval)
1102 : {
1103 5112 : if (newval == NULL)
1104 5052 : newval = pg_strdup("default");
1105 5112 : return newval;
1106 : }
1107 :
1108 : static bool
1109 5112 : verbosity_hook(const char *newval)
1110 : {
1111 : Assert(newval != NULL); /* else substitute hook messed up */
1112 5112 : if (pg_strcasecmp(newval, "default") == 0)
1113 5072 : pset.verbosity = PQERRORS_DEFAULT;
1114 40 : else if (pg_strcasecmp(newval, "verbose") == 0)
1115 0 : pset.verbosity = PQERRORS_VERBOSE;
1116 40 : else if (pg_strcasecmp(newval, "terse") == 0)
1117 30 : pset.verbosity = PQERRORS_TERSE;
1118 10 : else if (pg_strcasecmp(newval, "sqlstate") == 0)
1119 10 : pset.verbosity = PQERRORS_SQLSTATE;
1120 : else
1121 : {
1122 0 : PsqlVarEnumError("VERBOSITY", newval, "default, verbose, terse, sqlstate");
1123 0 : return false;
1124 : }
1125 :
1126 5112 : if (pset.db)
1127 60 : PQsetErrorVerbosity(pset.db, pset.verbosity);
1128 5112 : return true;
1129 : }
1130 :
1131 : static char *
1132 5082 : show_context_substitute_hook(char *newval)
1133 : {
1134 5082 : if (newval == NULL)
1135 5054 : newval = pg_strdup("errors");
1136 5082 : return newval;
1137 : }
1138 :
1139 : static bool
1140 5082 : show_context_hook(const char *newval)
1141 : {
1142 : Assert(newval != NULL); /* else substitute hook messed up */
1143 5082 : if (pg_strcasecmp(newval, "never") == 0)
1144 12 : pset.show_context = PQSHOW_CONTEXT_NEVER;
1145 5070 : else if (pg_strcasecmp(newval, "errors") == 0)
1146 5062 : 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 5082 : if (pset.db)
1156 30 : PQsetErrorContextVisibility(pset.db, pset.show_context);
1157 5082 : return true;
1158 : }
1159 :
1160 : static bool
1161 6334 : hide_tableam_hook(const char *newval)
1162 : {
1163 6334 : return ParseVariableBool(newval, "HIDE_TABLEAM", &pset.hide_tableam);
1164 : }
1165 :
1166 : static void
1167 5052 : EstablishVariableSpace(void)
1168 : {
1169 5052 : pset.vars = CreateVariableSpace();
1170 :
1171 5052 : SetVariableHooks(pset.vars, "AUTOCOMMIT",
1172 : bool_substitute_hook,
1173 : autocommit_hook);
1174 5052 : SetVariableHooks(pset.vars, "ON_ERROR_STOP",
1175 : bool_substitute_hook,
1176 : on_error_stop_hook);
1177 5052 : SetVariableHooks(pset.vars, "QUIET",
1178 : bool_substitute_hook,
1179 : quiet_hook);
1180 5052 : SetVariableHooks(pset.vars, "SINGLELINE",
1181 : bool_substitute_hook,
1182 : singleline_hook);
1183 5052 : SetVariableHooks(pset.vars, "SINGLESTEP",
1184 : bool_substitute_hook,
1185 : singlestep_hook);
1186 5052 : SetVariableHooks(pset.vars, "FETCH_COUNT",
1187 : fetch_count_substitute_hook,
1188 : fetch_count_hook);
1189 5052 : SetVariableHooks(pset.vars, "HISTFILE",
1190 : NULL,
1191 : histfile_hook);
1192 5052 : SetVariableHooks(pset.vars, "HISTSIZE",
1193 : histsize_substitute_hook,
1194 : histsize_hook);
1195 5052 : SetVariableHooks(pset.vars, "IGNOREEOF",
1196 : ignoreeof_substitute_hook,
1197 : ignoreeof_hook);
1198 5052 : SetVariableHooks(pset.vars, "ECHO",
1199 : echo_substitute_hook,
1200 : echo_hook);
1201 5052 : SetVariableHooks(pset.vars, "ECHO_HIDDEN",
1202 : bool_substitute_hook,
1203 : echo_hidden_hook);
1204 5052 : SetVariableHooks(pset.vars, "ON_ERROR_ROLLBACK",
1205 : bool_substitute_hook,
1206 : on_error_rollback_hook);
1207 5052 : SetVariableHooks(pset.vars, "COMP_KEYWORD_CASE",
1208 : comp_keyword_case_substitute_hook,
1209 : comp_keyword_case_hook);
1210 5052 : SetVariableHooks(pset.vars, "HISTCONTROL",
1211 : histcontrol_substitute_hook,
1212 : histcontrol_hook);
1213 5052 : SetVariableHooks(pset.vars, "PROMPT1",
1214 : NULL,
1215 : prompt1_hook);
1216 5052 : SetVariableHooks(pset.vars, "PROMPT2",
1217 : NULL,
1218 : prompt2_hook);
1219 5052 : SetVariableHooks(pset.vars, "PROMPT3",
1220 : NULL,
1221 : prompt3_hook);
1222 5052 : SetVariableHooks(pset.vars, "VERBOSITY",
1223 : verbosity_substitute_hook,
1224 : verbosity_hook);
1225 5052 : SetVariableHooks(pset.vars, "SHOW_CONTEXT",
1226 : show_context_substitute_hook,
1227 : show_context_hook);
1228 5052 : SetVariableHooks(pset.vars, "HIDE_TABLEAM",
1229 : bool_substitute_hook,
1230 : hide_tableam_hook);
1231 5052 : }
|
