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/common.c
7 : */
8 : #include "postgres_fe.h"
9 :
10 : #include <ctype.h>
11 : #include <limits.h>
12 : #include <math.h>
13 : #include <pwd.h>
14 : #include <signal.h>
15 : #ifndef WIN32
16 : #include <unistd.h> /* for write() */
17 : #else
18 : #include <io.h> /* for _write() */
19 : #include <win32.h>
20 : #endif
21 :
22 : #include "command.h"
23 : #include "common.h"
24 : #include "common/logging.h"
25 : #include "copy.h"
26 : #include "crosstabview.h"
27 : #include "fe_utils/cancel.h"
28 : #include "fe_utils/mbprint.h"
29 : #include "fe_utils/string_utils.h"
30 : #include "portability/instr_time.h"
31 : #include "settings.h"
32 :
33 : static bool DescribeQuery(const char *query, double *elapsed_msec);
34 : static int ExecQueryAndProcessResults(const char *query,
35 : double *elapsed_msec,
36 : bool *svpt_gone_p,
37 : bool is_watch,
38 : int min_rows,
39 : const printQueryOpt *opt,
40 : FILE *printQueryFout);
41 : static bool command_no_begin(const char *query);
42 :
43 :
44 : /*
45 : * openQueryOutputFile --- attempt to open a query output file
46 : *
47 : * fname == NULL selects stdout, else an initial '|' selects a pipe,
48 : * else plain file.
49 : *
50 : * Returns output file pointer into *fout, and is-a-pipe flag into *is_pipe.
51 : * Caller is responsible for adjusting SIGPIPE state if it's a pipe.
52 : *
53 : * On error, reports suitable error message and returns false.
54 : */
55 : bool
56 17486 : openQueryOutputFile(const char *fname, FILE **fout, bool *is_pipe)
57 : {
58 17486 : if (!fname || fname[0] == '\0')
59 : {
60 17436 : *fout = stdout;
61 17436 : *is_pipe = false;
62 : }
63 50 : else if (*fname == '|')
64 : {
65 8 : fflush(NULL);
66 8 : *fout = popen(fname + 1, "w");
67 8 : *is_pipe = true;
68 : }
69 : else
70 : {
71 42 : *fout = fopen(fname, "w");
72 42 : *is_pipe = false;
73 : }
74 :
75 17486 : if (*fout == NULL)
76 : {
77 0 : pg_log_error("%s: %m", fname);
78 0 : return false;
79 : }
80 :
81 17486 : return true;
82 : }
83 :
84 : /*
85 : * Check if an output stream for \g needs to be opened, and if yes,
86 : * open it and update the caller's gfile_fout and is_pipe state variables.
87 : * Return true if OK, false if an error occurred.
88 : */
89 : static bool
90 132508 : SetupGOutput(FILE **gfile_fout, bool *is_pipe)
91 : {
92 : /* If there is a \g file or program, and it's not already open, open it */
93 132508 : if (pset.gfname != NULL && *gfile_fout == NULL)
94 : {
95 32 : if (openQueryOutputFile(pset.gfname, gfile_fout, is_pipe))
96 : {
97 32 : if (*is_pipe)
98 8 : disable_sigpipe_trap();
99 : }
100 : else
101 0 : return false;
102 : }
103 132508 : return true;
104 : }
105 :
106 : /*
107 : * Close the output stream for \g, if we opened it.
108 : */
109 : static void
110 342126 : CloseGOutput(FILE *gfile_fout, bool is_pipe)
111 : {
112 342126 : if (gfile_fout)
113 : {
114 32 : if (is_pipe)
115 : {
116 8 : SetShellResultVariables(pclose(gfile_fout));
117 8 : restore_sigpipe_trap();
118 : }
119 : else
120 24 : fclose(gfile_fout);
121 : }
122 342126 : }
123 :
124 : /*
125 : * Reset pset pipeline state
126 : */
127 : static void
128 0 : pipelineReset(void)
129 : {
130 0 : pset.piped_syncs = 0;
131 0 : pset.piped_commands = 0;
132 0 : pset.available_results = 0;
133 0 : pset.requested_results = 0;
134 0 : }
135 :
136 : /*
137 : * setQFout
138 : * -- handler for -o command line option and \o command
139 : *
140 : * On success, updates pset with the new output file and returns true.
141 : * On failure, returns false without changing pset state.
142 : */
143 : bool
144 17454 : setQFout(const char *fname)
145 : {
146 : FILE *fout;
147 : bool is_pipe;
148 :
149 : /* First make sure we can open the new output file/pipe */
150 17454 : if (!openQueryOutputFile(fname, &fout, &is_pipe))
151 0 : return false;
152 :
153 : /* Close old file/pipe */
154 17454 : if (pset.queryFout && pset.queryFout != stdout && pset.queryFout != stderr)
155 : {
156 18 : if (pset.queryFoutPipe)
157 0 : SetShellResultVariables(pclose(pset.queryFout));
158 : else
159 18 : fclose(pset.queryFout);
160 : }
161 :
162 17454 : pset.queryFout = fout;
163 17454 : pset.queryFoutPipe = is_pipe;
164 :
165 : /* Adjust SIGPIPE handling appropriately: ignore signal if is_pipe */
166 17454 : set_sigpipe_trap_state(is_pipe);
167 17454 : restore_sigpipe_trap();
168 :
169 17454 : return true;
170 : }
171 :
172 :
173 : /*
174 : * Variable-fetching callback for flex lexer
175 : *
176 : * If the specified variable exists, return its value as a string (malloc'd
177 : * and expected to be freed by the caller); else return NULL.
178 : *
179 : * If "quote" isn't PQUOTE_PLAIN, then return the value suitably quoted and
180 : * escaped for the specified quoting requirement. (Failure in escaping
181 : * should lead to printing an error and returning NULL.)
182 : *
183 : * "passthrough" is the pointer previously given to psql_scan_set_passthrough.
184 : * In psql, passthrough points to a ConditionalStack, which we check to
185 : * determine whether variable expansion is allowed.
186 : */
187 : char *
188 3890 : psql_get_variable(const char *varname, PsqlScanQuoteType quote,
189 : void *passthrough)
190 : {
191 3890 : char *result = NULL;
192 : const char *value;
193 :
194 : /* In an inactive \if branch, suppress all variable substitutions */
195 3890 : if (passthrough && !conditional_active((ConditionalStack) passthrough))
196 72 : return NULL;
197 :
198 3818 : value = GetVariable(pset.vars, varname);
199 3818 : if (!value)
200 482 : return NULL;
201 :
202 3336 : switch (quote)
203 : {
204 2486 : case PQUOTE_PLAIN:
205 2486 : result = pg_strdup(value);
206 2486 : break;
207 850 : case PQUOTE_SQL_LITERAL:
208 : case PQUOTE_SQL_IDENT:
209 : {
210 : /*
211 : * For these cases, we use libpq's quoting functions, which
212 : * assume the string is in the connection's client encoding.
213 : */
214 : char *escaped_value;
215 :
216 850 : if (!pset.db)
217 : {
218 0 : pg_log_error("cannot escape without active connection");
219 0 : return NULL;
220 : }
221 :
222 850 : if (quote == PQUOTE_SQL_LITERAL)
223 : escaped_value =
224 824 : PQescapeLiteral(pset.db, value, strlen(value));
225 : else
226 : escaped_value =
227 26 : PQescapeIdentifier(pset.db, value, strlen(value));
228 :
229 850 : if (escaped_value == NULL)
230 : {
231 0 : const char *error = PQerrorMessage(pset.db);
232 :
233 0 : pg_log_info("%s", error);
234 0 : return NULL;
235 : }
236 :
237 : /*
238 : * Rather than complicate the lexer's API with a notion of
239 : * which free() routine to use, just pay the price of an extra
240 : * strdup().
241 : */
242 850 : result = pg_strdup(escaped_value);
243 850 : PQfreemem(escaped_value);
244 850 : break;
245 : }
246 0 : case PQUOTE_SHELL_ARG:
247 : {
248 : /*
249 : * For this we use appendShellStringNoError, which is
250 : * encoding-agnostic, which is fine since the shell probably
251 : * is too. In any case, the only special character is "'",
252 : * which is not known to appear in valid multibyte characters.
253 : */
254 : PQExpBufferData buf;
255 :
256 0 : initPQExpBuffer(&buf);
257 0 : if (!appendShellStringNoError(&buf, value))
258 : {
259 0 : pg_log_error("shell command argument contains a newline or carriage return: \"%s\"",
260 : value);
261 0 : free(buf.data);
262 0 : return NULL;
263 : }
264 0 : result = buf.data;
265 0 : break;
266 : }
267 :
268 : /* No default: we want a compiler warning for missing cases */
269 : }
270 :
271 3336 : return result;
272 : }
273 :
274 :
275 : /*
276 : * for backend Notice messages (INFO, WARNING, etc)
277 : */
278 : void
279 154190 : NoticeProcessor(void *arg, const char *message)
280 : {
281 : (void) arg; /* not used */
282 154190 : pg_log_info("%s", message);
283 154190 : }
284 :
285 :
286 :
287 : /*
288 : * Code to support query cancellation
289 : *
290 : * Before we start a query, we enable the SIGINT signal catcher to send a
291 : * cancel request to the backend.
292 : *
293 : * SIGINT is supposed to abort all long-running psql operations, not only
294 : * database queries. In most places, this is accomplished by checking
295 : * cancel_pressed during long-running loops. However, that won't work when
296 : * blocked on user input (in readline() or fgets()). In those places, we
297 : * set sigint_interrupt_enabled true while blocked, instructing the signal
298 : * catcher to longjmp through sigint_interrupt_jmp. We assume readline and
299 : * fgets are coded to handle possible interruption.
300 : *
301 : * On Windows, currently this does not work, so control-C is less useful
302 : * there.
303 : */
304 : volatile sig_atomic_t sigint_interrupt_enabled = false;
305 :
306 : sigjmp_buf sigint_interrupt_jmp;
307 :
308 : static void
309 2 : psql_cancel_callback(void)
310 : {
311 : #ifndef WIN32
312 : /* if we are waiting for input, longjmp out of it */
313 2 : if (sigint_interrupt_enabled)
314 : {
315 0 : sigint_interrupt_enabled = false;
316 0 : siglongjmp(sigint_interrupt_jmp, 1);
317 : }
318 : #endif
319 :
320 : /* else, set cancel flag to stop any long-running loops */
321 2 : cancel_pressed = true;
322 2 : }
323 :
324 : void
325 17446 : psql_setup_cancel_handler(void)
326 : {
327 17446 : setup_cancel_handler(psql_cancel_callback);
328 17446 : }
329 :
330 :
331 : /* ConnectionUp
332 : *
333 : * Returns whether our backend connection is still there.
334 : */
335 : static bool
336 383870 : ConnectionUp(void)
337 : {
338 383870 : return PQstatus(pset.db) != CONNECTION_BAD;
339 : }
340 :
341 :
342 :
343 : /* CheckConnection
344 : *
345 : * Verify that we still have a good connection to the backend, and if not,
346 : * see if it can be restored.
347 : *
348 : * Returns true if either the connection was still there, or it could be
349 : * restored successfully; false otherwise. If, however, there was no
350 : * connection and the session is non-interactive, this will exit the program
351 : * with a code of EXIT_BADCONN.
352 : */
353 : static bool
354 383870 : CheckConnection(void)
355 : {
356 : bool OK;
357 :
358 383870 : OK = ConnectionUp();
359 383870 : if (!OK)
360 : {
361 20 : if (!pset.cur_cmd_interactive)
362 : {
363 20 : pg_log_error("connection to server was lost");
364 20 : exit(EXIT_BADCONN);
365 : }
366 :
367 0 : fprintf(stderr, _("The connection to the server was lost. Attempting reset: "));
368 0 : PQreset(pset.db);
369 0 : pipelineReset();
370 0 : OK = ConnectionUp();
371 0 : if (!OK)
372 : {
373 0 : fprintf(stderr, _("Failed.\n"));
374 :
375 : /*
376 : * Transition to having no connection; but stash away the failed
377 : * connection so that we can still refer to its parameters in a
378 : * later \connect attempt. Keep the state cleanup here in sync
379 : * with do_connect().
380 : */
381 0 : if (pset.dead_conn)
382 0 : PQfinish(pset.dead_conn);
383 0 : pset.dead_conn = pset.db;
384 0 : pset.db = NULL;
385 0 : ResetCancelConn();
386 0 : UnsyncVariables();
387 : }
388 : else
389 : {
390 0 : fprintf(stderr, _("Succeeded.\n"));
391 :
392 : /*
393 : * Re-sync, just in case anything changed. Keep this in sync with
394 : * do_connect().
395 : */
396 0 : SyncVariables();
397 0 : connection_warnings(false); /* Must be after SyncVariables */
398 : }
399 : }
400 :
401 383850 : return OK;
402 : }
403 :
404 :
405 :
406 :
407 : /*
408 : * AcceptResult
409 : *
410 : * Checks whether a result is valid, giving an error message if necessary;
411 : * and ensures that the connection to the backend is still up.
412 : *
413 : * Returns true for valid result, false for error state.
414 : */
415 : static bool
416 386620 : AcceptResult(const PGresult *result, bool show_error)
417 : {
418 : bool OK;
419 :
420 386620 : if (!result)
421 0 : OK = false;
422 : else
423 386620 : switch (PQresultStatus(result))
424 : {
425 344924 : case PGRES_COMMAND_OK:
426 : case PGRES_TUPLES_OK:
427 : case PGRES_TUPLES_CHUNK:
428 : case PGRES_EMPTY_QUERY:
429 : case PGRES_COPY_IN:
430 : case PGRES_COPY_OUT:
431 : case PGRES_PIPELINE_SYNC:
432 : /* Fine, do nothing */
433 344924 : OK = true;
434 344924 : break;
435 :
436 41694 : case PGRES_PIPELINE_ABORTED:
437 : case PGRES_BAD_RESPONSE:
438 : case PGRES_NONFATAL_ERROR:
439 : case PGRES_FATAL_ERROR:
440 41694 : OK = false;
441 41694 : break;
442 :
443 2 : default:
444 2 : OK = false;
445 2 : pg_log_error("unexpected PQresultStatus: %d",
446 : PQresultStatus(result));
447 2 : break;
448 : }
449 :
450 386620 : if (!OK && show_error)
451 : {
452 6 : const char *error = PQerrorMessage(pset.db);
453 :
454 6 : if (strlen(error))
455 6 : pg_log_info("%s", error);
456 :
457 6 : CheckConnection();
458 : }
459 :
460 386620 : return OK;
461 : }
462 :
463 :
464 : /*
465 : * Set special variables from a query result
466 : * - ERROR: true/false, whether an error occurred on this query
467 : * - SQLSTATE: code of error, or "00000" if no error, or "" if unknown
468 : * - ROW_COUNT: how many rows were returned or affected, or "0"
469 : * - LAST_ERROR_SQLSTATE: same for last error
470 : * - LAST_ERROR_MESSAGE: message of last error
471 : *
472 : * Note: current policy is to apply this only to the results of queries
473 : * entered by the user, not queries generated by slash commands.
474 : */
475 : static void
476 342188 : SetResultVariables(PGresult *result, bool success)
477 : {
478 342188 : if (success)
479 : {
480 300180 : const char *ntuples = PQcmdTuples(result);
481 :
482 300180 : SetVariable(pset.vars, "ERROR", "false");
483 300180 : SetVariable(pset.vars, "SQLSTATE", "00000");
484 300180 : SetVariable(pset.vars, "ROW_COUNT", *ntuples ? ntuples : "0");
485 : }
486 : else
487 : {
488 42008 : const char *code = PQresultErrorField(result, PG_DIAG_SQLSTATE);
489 42008 : const char *mesg = PQresultErrorField(result, PG_DIAG_MESSAGE_PRIMARY);
490 :
491 42008 : SetVariable(pset.vars, "ERROR", "true");
492 :
493 : /*
494 : * If there is no SQLSTATE code, use an empty string. This can happen
495 : * for libpq-detected errors (e.g., lost connection, ENOMEM).
496 : */
497 42008 : if (code == NULL)
498 154 : code = "";
499 42008 : SetVariable(pset.vars, "SQLSTATE", code);
500 42008 : SetVariable(pset.vars, "ROW_COUNT", "0");
501 42008 : SetVariable(pset.vars, "LAST_ERROR_SQLSTATE", code);
502 42008 : SetVariable(pset.vars, "LAST_ERROR_MESSAGE", mesg ? mesg : "");
503 : }
504 342188 : }
505 :
506 :
507 : /*
508 : * Set special variables from a shell command result
509 : * - SHELL_ERROR: true/false, whether command returned exit code 0
510 : * - SHELL_EXIT_CODE: exit code according to shell conventions
511 : *
512 : * The argument is a wait status as returned by wait(2) or waitpid(2),
513 : * which also applies to pclose(3) and system(3).
514 : */
515 : void
516 8 : SetShellResultVariables(int wait_result)
517 : {
518 : char buf[32];
519 :
520 8 : SetVariable(pset.vars, "SHELL_ERROR",
521 : (wait_result == 0) ? "false" : "true");
522 8 : snprintf(buf, sizeof(buf), "%d", wait_result_to_exit_code(wait_result));
523 8 : SetVariable(pset.vars, "SHELL_EXIT_CODE", buf);
524 8 : }
525 :
526 :
527 : /*
528 : * Set special pipeline variables
529 : * - PIPELINE_SYNC_COUNT: The number of piped syncs
530 : * - PIPELINE_COMMAND_COUNT: The number of piped commands
531 : * - PIPELINE_RESULT_COUNT: The number of results available to read
532 : */
533 : static void
534 343378 : SetPipelineVariables(void)
535 : {
536 : char buf[32];
537 :
538 343378 : snprintf(buf, sizeof(buf), "%d", pset.piped_syncs);
539 343378 : SetVariable(pset.vars, "PIPELINE_SYNC_COUNT", buf);
540 343378 : snprintf(buf, sizeof(buf), "%d", pset.piped_commands);
541 343378 : SetVariable(pset.vars, "PIPELINE_COMMAND_COUNT", buf);
542 343378 : snprintf(buf, sizeof(buf), "%d", pset.available_results);
543 343378 : SetVariable(pset.vars, "PIPELINE_RESULT_COUNT", buf);
544 343378 : }
545 :
546 :
547 : /*
548 : * ClearOrSaveResult
549 : *
550 : * If the result represents an error, remember it for possible display by
551 : * \errverbose. Otherwise, just PQclear() it.
552 : *
553 : * Note: current policy is to apply this to the results of all queries,
554 : * including "back door" queries, for debugging's sake. It's OK to use
555 : * PQclear() directly on results known to not be error results, however.
556 : */
557 : static void
558 344856 : ClearOrSaveResult(PGresult *result)
559 : {
560 344856 : if (result)
561 : {
562 344264 : switch (PQresultStatus(result))
563 : {
564 41862 : case PGRES_NONFATAL_ERROR:
565 : case PGRES_FATAL_ERROR:
566 41862 : PQclear(pset.last_error_result);
567 41862 : pset.last_error_result = result;
568 41862 : break;
569 :
570 302402 : default:
571 302402 : PQclear(result);
572 302402 : break;
573 : }
574 : }
575 344856 : }
576 :
577 :
578 : /*
579 : * Consume all results
580 : */
581 : static void
582 0 : ClearOrSaveAllResults(void)
583 : {
584 : PGresult *result;
585 :
586 0 : while ((result = PQgetResult(pset.db)) != NULL)
587 0 : ClearOrSaveResult(result);
588 0 : }
589 :
590 :
591 : /*
592 : * Print microtiming output. Always print raw milliseconds; if the interval
593 : * is >= 1 second, also break it down into days/hours/minutes/seconds.
594 : */
595 : static void
596 4 : PrintTiming(double elapsed_msec)
597 : {
598 : double seconds;
599 : double minutes;
600 : double hours;
601 : double days;
602 :
603 4 : if (elapsed_msec < 1000.0)
604 : {
605 : /* This is the traditional (pre-v10) output format */
606 4 : printf(_("Time: %.3f ms\n"), elapsed_msec);
607 4 : return;
608 : }
609 :
610 : /*
611 : * Note: we could print just seconds, in a format like %06.3f, when the
612 : * total is less than 1min. But that's hard to interpret unless we tack
613 : * on "s" or otherwise annotate it. Forcing the display to include
614 : * minutes seems like a better solution.
615 : */
616 0 : seconds = elapsed_msec / 1000.0;
617 0 : minutes = floor(seconds / 60.0);
618 0 : seconds -= 60.0 * minutes;
619 0 : if (minutes < 60.0)
620 : {
621 0 : printf(_("Time: %.3f ms (%02d:%06.3f)\n"),
622 : elapsed_msec, (int) minutes, seconds);
623 0 : return;
624 : }
625 :
626 0 : hours = floor(minutes / 60.0);
627 0 : minutes -= 60.0 * hours;
628 0 : if (hours < 24.0)
629 : {
630 0 : printf(_("Time: %.3f ms (%02d:%02d:%06.3f)\n"),
631 : elapsed_msec, (int) hours, (int) minutes, seconds);
632 0 : return;
633 : }
634 :
635 0 : days = floor(hours / 24.0);
636 0 : hours -= 24.0 * days;
637 0 : printf(_("Time: %.3f ms (%.0f d %02d:%02d:%06.3f)\n"),
638 : elapsed_msec, days, (int) hours, (int) minutes, seconds);
639 : }
640 :
641 :
642 : /*
643 : * PSQLexec
644 : *
645 : * This is the way to send "backdoor" queries (those not directly entered
646 : * by the user). It is subject to -E but not -e.
647 : *
648 : * Caller is responsible for handling the ensuing processing if a COPY
649 : * command is sent.
650 : *
651 : * Note: we don't bother to check PQclientEncoding; it is assumed that no
652 : * caller uses this path to issue "SET CLIENT_ENCODING".
653 : */
654 : PGresult *
655 42104 : PSQLexec(const char *query)
656 : {
657 : PGresult *res;
658 :
659 42104 : if (!pset.db)
660 : {
661 0 : pg_log_error("You are currently not connected to a database.");
662 0 : return NULL;
663 : }
664 :
665 42104 : if (pset.echo_hidden != PSQL_ECHO_HIDDEN_OFF)
666 : {
667 0 : printf(_("/******** QUERY *********/\n"
668 : "%s\n"
669 : "/************************/\n\n"), query);
670 0 : fflush(stdout);
671 0 : if (pset.logfile)
672 : {
673 0 : fprintf(pset.logfile,
674 0 : _("/******** QUERY *********/\n"
675 : "%s\n"
676 : "/************************/\n\n"), query);
677 0 : fflush(pset.logfile);
678 : }
679 :
680 0 : if (pset.echo_hidden == PSQL_ECHO_HIDDEN_NOEXEC)
681 0 : return NULL;
682 : }
683 :
684 42104 : SetCancelConn(pset.db);
685 :
686 42104 : res = PQexec(pset.db, query);
687 :
688 42104 : ResetCancelConn();
689 :
690 42104 : if (!AcceptResult(res, true))
691 : {
692 0 : ClearOrSaveResult(res);
693 0 : res = NULL;
694 : }
695 :
696 42104 : return res;
697 : }
698 :
699 :
700 : /*
701 : * PSQLexecWatch
702 : *
703 : * This function is used for \watch command to send the query to
704 : * the server and print out the result.
705 : *
706 : * Returns 1 if the query executed successfully, 0 if it cannot be repeated,
707 : * e.g., because of the interrupt, -1 on error.
708 : */
709 : int
710 42 : PSQLexecWatch(const char *query, const printQueryOpt *opt, FILE *printQueryFout, int min_rows)
711 : {
712 42 : bool timing = pset.timing;
713 42 : double elapsed_msec = 0;
714 : int res;
715 :
716 42 : if (!pset.db)
717 : {
718 0 : pg_log_error("You are currently not connected to a database.");
719 0 : return 0;
720 : }
721 :
722 42 : SetCancelConn(pset.db);
723 :
724 42 : res = ExecQueryAndProcessResults(query, &elapsed_msec, NULL, true, min_rows, opt, printQueryFout);
725 :
726 40 : ResetCancelConn();
727 :
728 : /* Possible microtiming output */
729 40 : if (timing)
730 0 : PrintTiming(elapsed_msec);
731 :
732 40 : return res;
733 : }
734 :
735 :
736 : /*
737 : * PrintNotifications: check for asynchronous notifications, and print them out
738 : */
739 : static void
740 343424 : PrintNotifications(void)
741 : {
742 : PGnotify *notify;
743 :
744 343424 : PQconsumeInput(pset.db);
745 343428 : while ((notify = PQnotifies(pset.db)) != NULL)
746 : {
747 : /* for backward compatibility, only show payload if nonempty */
748 4 : if (notify->extra[0])
749 2 : fprintf(pset.queryFout, _("Asynchronous notification \"%s\" with payload \"%s\" received from server process with PID %d.\n"),
750 : notify->relname, notify->extra, notify->be_pid);
751 : else
752 2 : fprintf(pset.queryFout, _("Asynchronous notification \"%s\" received from server process with PID %d.\n"),
753 : notify->relname, notify->be_pid);
754 4 : fflush(pset.queryFout);
755 4 : PQfreemem(notify);
756 4 : PQconsumeInput(pset.db);
757 : }
758 343424 : }
759 :
760 :
761 : /*
762 : * PrintQueryTuples: assuming query result is OK, print its tuples
763 : *
764 : * We use the options given by opt unless that's NULL, in which case
765 : * we use pset.popt.
766 : *
767 : * Output is to printQueryFout unless that's NULL, in which case
768 : * we use pset.queryFout.
769 : *
770 : * Returns true if successful, false otherwise.
771 : */
772 : static bool
773 131506 : PrintQueryTuples(const PGresult *result, const printQueryOpt *opt,
774 : FILE *printQueryFout)
775 : {
776 131506 : bool ok = true;
777 131506 : FILE *fout = printQueryFout ? printQueryFout : pset.queryFout;
778 :
779 131506 : printQuery(result, opt ? opt : &pset.popt, fout, false, pset.logfile);
780 131506 : fflush(fout);
781 131506 : if (ferror(fout))
782 : {
783 0 : pg_log_error("could not print result table: %m");
784 0 : ok = false;
785 : }
786 :
787 131506 : return ok;
788 : }
789 :
790 :
791 : /*
792 : * StoreQueryTuple: assuming query result is OK, save data into variables
793 : *
794 : * Returns true if successful, false otherwise.
795 : */
796 : static bool
797 754 : StoreQueryTuple(const PGresult *result)
798 : {
799 754 : bool success = true;
800 :
801 754 : if (PQntuples(result) < 1)
802 : {
803 18 : pg_log_error("no rows returned for \\gset");
804 18 : success = false;
805 : }
806 736 : else if (PQntuples(result) > 1)
807 : {
808 12 : pg_log_error("more than one row returned for \\gset");
809 12 : success = false;
810 : }
811 : else
812 : {
813 : int i;
814 :
815 1622 : for (i = 0; i < PQnfields(result); i++)
816 : {
817 904 : char *colname = PQfname(result, i);
818 : char *varname;
819 : char *value;
820 :
821 : /* concatenate prefix and column name */
822 904 : varname = psprintf("%s%s", pset.gset_prefix, colname);
823 :
824 904 : if (VariableHasHook(pset.vars, varname))
825 : {
826 6 : pg_log_warning("attempt to \\gset into specially treated variable \"%s\" ignored",
827 : varname);
828 6 : continue;
829 : }
830 :
831 898 : if (!PQgetisnull(result, 0, i))
832 886 : value = PQgetvalue(result, 0, i);
833 : else
834 : {
835 : /* for NULL value, unset rather than set the variable */
836 12 : value = NULL;
837 : }
838 :
839 898 : if (!SetVariable(pset.vars, varname, value))
840 : {
841 6 : free(varname);
842 6 : success = false;
843 6 : break;
844 : }
845 :
846 892 : free(varname);
847 : }
848 : }
849 :
850 754 : return success;
851 : }
852 :
853 :
854 : /*
855 : * ExecQueryTuples: assuming query result is OK, execute each query
856 : * result field as a SQL statement
857 : *
858 : * Returns true if successful, false otherwise.
859 : */
860 : static bool
861 46 : ExecQueryTuples(const PGresult *result)
862 : {
863 46 : bool success = true;
864 46 : int nrows = PQntuples(result);
865 46 : int ncolumns = PQnfields(result);
866 : int r,
867 : c;
868 :
869 : /*
870 : * We must turn off gexec_flag to avoid infinite recursion.
871 : */
872 46 : pset.gexec_flag = false;
873 :
874 472 : for (r = 0; r < nrows; r++)
875 : {
876 870 : for (c = 0; c < ncolumns; c++)
877 : {
878 444 : if (!PQgetisnull(result, r, c))
879 : {
880 438 : const char *query = PQgetvalue(result, r, c);
881 :
882 : /* Abandon execution if cancel_pressed */
883 438 : if (cancel_pressed)
884 0 : goto loop_exit;
885 :
886 : /*
887 : * ECHO_ALL mode should echo these queries, but SendQuery
888 : * assumes that MainLoop did that, so we have to do it here.
889 : */
890 438 : if (pset.echo == PSQL_ECHO_ALL && !pset.singlestep)
891 : {
892 430 : puts(query);
893 430 : fflush(stdout);
894 : }
895 :
896 438 : if (!SendQuery(query))
897 : {
898 : /* Error - abandon execution if ON_ERROR_STOP */
899 6 : success = false;
900 6 : if (pset.on_error_stop)
901 0 : goto loop_exit;
902 : }
903 : }
904 : }
905 : }
906 :
907 46 : loop_exit:
908 :
909 : /*
910 : * Restore state. We know gexec_flag was on, else we'd not be here. (We
911 : * also know it'll get turned off at end of command, but that's not ours
912 : * to do here.)
913 : */
914 46 : pset.gexec_flag = true;
915 :
916 : /* Return true if all queries were successful */
917 46 : return success;
918 : }
919 :
920 :
921 : /*
922 : * Marshal the COPY data. Either path will get the
923 : * connection out of its COPY state, then call PQresultStatus()
924 : * once and report any error. Return whether all was ok.
925 : *
926 : * For COPY OUT, direct the output to copystream, or discard if that's NULL.
927 : * For COPY IN, use pset.copyStream as data source if it's set,
928 : * otherwise cur_cmd_source.
929 : *
930 : * Update *resultp if further processing is necessary; set to NULL otherwise.
931 : * Return a result when queryFout can safely output a result status: on COPY
932 : * IN, or on COPY OUT if written to something other than pset.queryFout.
933 : * Returning NULL prevents the command status from being printed, which we
934 : * want if the status line doesn't get taken as part of the COPY data.
935 : */
936 : static bool
937 1454 : HandleCopyResult(PGresult **resultp, FILE *copystream)
938 : {
939 : bool success;
940 : PGresult *copy_result;
941 1454 : ExecStatusType result_status = PQresultStatus(*resultp);
942 :
943 : Assert(result_status == PGRES_COPY_OUT ||
944 : result_status == PGRES_COPY_IN);
945 :
946 1454 : SetCancelConn(pset.db);
947 :
948 1454 : if (result_status == PGRES_COPY_OUT)
949 : {
950 540 : success = handleCopyOut(pset.db,
951 : copystream,
952 : ©_result)
953 540 : && (copystream != NULL);
954 :
955 : /*
956 : * Suppress status printing if the report would go to the same place
957 : * as the COPY data just went. Note this doesn't prevent error
958 : * reporting, since handleCopyOut did that.
959 : */
960 540 : if (copystream == pset.queryFout)
961 : {
962 514 : PQclear(copy_result);
963 514 : copy_result = NULL;
964 : }
965 : }
966 : else
967 : {
968 : /* COPY IN */
969 : /* Ignore the copystream argument passed to the function */
970 914 : copystream = pset.copyStream ? pset.copyStream : pset.cur_cmd_source;
971 914 : success = handleCopyIn(pset.db,
972 : copystream,
973 914 : PQbinaryTuples(*resultp),
974 : ©_result);
975 : }
976 1454 : ResetCancelConn();
977 :
978 : /*
979 : * Replace the PGRES_COPY_OUT/IN result with COPY command's exit status,
980 : * or with NULL if we want to suppress printing anything.
981 : */
982 1454 : PQclear(*resultp);
983 1454 : *resultp = copy_result;
984 :
985 1454 : return success;
986 : }
987 :
988 : /*
989 : * PrintQueryStatus: report command status as required
990 : */
991 : static void
992 301038 : PrintQueryStatus(PGresult *result, FILE *printQueryFout)
993 : {
994 : char buf[16];
995 301038 : const char *cmdstatus = PQcmdStatus(result);
996 301038 : FILE *fout = printQueryFout ? printQueryFout : pset.queryFout;
997 :
998 : /* Do nothing if it's a TUPLES_OK result that isn't from RETURNING */
999 301038 : if (PQresultStatus(result) == PGRES_TUPLES_OK)
1000 : {
1001 132498 : if (!(strncmp(cmdstatus, "INSERT", 6) == 0 ||
1002 132032 : strncmp(cmdstatus, "UPDATE", 6) == 0 ||
1003 131508 : strncmp(cmdstatus, "DELETE", 6) == 0 ||
1004 131294 : strncmp(cmdstatus, "MERGE", 5) == 0))
1005 131150 : return;
1006 : }
1007 :
1008 169888 : if (!pset.quiet)
1009 : {
1010 874 : if (pset.popt.topt.format == PRINT_HTML)
1011 : {
1012 0 : fputs("<p>", fout);
1013 0 : html_escaped_print(cmdstatus, fout);
1014 0 : fputs("</p>\n", fout);
1015 : }
1016 : else
1017 874 : fprintf(fout, "%s\n", cmdstatus);
1018 874 : fflush(fout);
1019 : }
1020 :
1021 169888 : if (pset.logfile)
1022 0 : fprintf(pset.logfile, "%s\n", cmdstatus);
1023 :
1024 169888 : snprintf(buf, sizeof(buf), "%u", (unsigned int) PQoidValue(result));
1025 169888 : SetVariable(pset.vars, "LASTOID", buf);
1026 : }
1027 :
1028 :
1029 : /*
1030 : * PrintQueryResult: print out (or store or execute) query result as required
1031 : *
1032 : * last is true if this is the last result of a command string.
1033 : * opt and printQueryFout are defined as for PrintQueryTuples.
1034 : * printStatusFout is where to send command status; NULL means pset.queryFout.
1035 : *
1036 : * Returns true if the query executed successfully, false otherwise.
1037 : */
1038 : static bool
1039 301596 : PrintQueryResult(PGresult *result, bool last,
1040 : const printQueryOpt *opt, FILE *printQueryFout,
1041 : FILE *printStatusFout)
1042 : {
1043 : bool success;
1044 :
1045 301596 : if (!result)
1046 0 : return false;
1047 :
1048 301596 : switch (PQresultStatus(result))
1049 : {
1050 132452 : case PGRES_TUPLES_OK:
1051 : /* store or execute or print the data ... */
1052 132452 : if (last && pset.gset_prefix)
1053 754 : success = StoreQueryTuple(result);
1054 131698 : else if (last && pset.gexec_flag)
1055 46 : success = ExecQueryTuples(result);
1056 131652 : else if (last && pset.crosstab_flag)
1057 132 : success = PrintResultInCrosstab(result);
1058 131520 : else if (last || pset.show_all_results)
1059 131506 : success = PrintQueryTuples(result, opt, printQueryFout);
1060 : else
1061 14 : success = true;
1062 :
1063 : /*
1064 : * If it's INSERT/UPDATE/DELETE/MERGE RETURNING, also print
1065 : * status.
1066 : */
1067 132452 : if (last || pset.show_all_results)
1068 132438 : PrintQueryStatus(result, printStatusFout);
1069 :
1070 132452 : break;
1071 :
1072 168540 : case PGRES_COMMAND_OK:
1073 168540 : if (last || pset.show_all_results)
1074 168540 : PrintQueryStatus(result, printStatusFout);
1075 168540 : success = true;
1076 168540 : break;
1077 :
1078 604 : case PGRES_EMPTY_QUERY:
1079 604 : success = true;
1080 604 : break;
1081 :
1082 0 : case PGRES_COPY_OUT:
1083 : case PGRES_COPY_IN:
1084 : /* nothing to do here: already processed */
1085 0 : success = true;
1086 0 : break;
1087 :
1088 0 : case PGRES_PIPELINE_ABORTED:
1089 : case PGRES_BAD_RESPONSE:
1090 : case PGRES_NONFATAL_ERROR:
1091 : case PGRES_FATAL_ERROR:
1092 0 : success = false;
1093 0 : break;
1094 :
1095 0 : default:
1096 0 : success = false;
1097 0 : pg_log_error("unexpected PQresultStatus: %d",
1098 : PQresultStatus(result));
1099 0 : break;
1100 : }
1101 :
1102 301596 : return success;
1103 : }
1104 :
1105 : /*
1106 : * SendQuery: send the query string to the backend
1107 : * (and print out result)
1108 : *
1109 : * Note: This is the "front door" way to send a query. That is, use it to
1110 : * send queries actually entered by the user. These queries will be subject to
1111 : * single step mode.
1112 : * To send "back door" queries (generated by slash commands, etc.) in a
1113 : * controlled way, use PSQLexec().
1114 : *
1115 : * Returns true if the query executed successfully, false otherwise.
1116 : */
1117 : bool
1118 343450 : SendQuery(const char *query)
1119 : {
1120 343450 : bool timing = pset.timing;
1121 : PGTransactionStatusType transaction_status;
1122 343450 : double elapsed_msec = 0;
1123 343450 : bool OK = false;
1124 : int i;
1125 343450 : bool on_error_rollback_savepoint = false;
1126 343450 : bool svpt_gone = false;
1127 :
1128 343450 : if (!pset.db)
1129 : {
1130 0 : pg_log_error("You are currently not connected to a database.");
1131 0 : goto sendquery_cleanup;
1132 : }
1133 :
1134 343450 : if (pset.singlestep)
1135 : {
1136 : char buf[3];
1137 :
1138 0 : fflush(stderr);
1139 0 : printf(_("/**(Single step mode: verify command)******************************************/\n"
1140 : "%s\n"
1141 : "/**(press return to proceed or enter x and return to cancel)*******************/\n"),
1142 : query);
1143 0 : fflush(stdout);
1144 0 : if (fgets(buf, sizeof(buf), stdin) != NULL)
1145 0 : if (buf[0] == 'x')
1146 0 : goto sendquery_cleanup;
1147 0 : if (cancel_pressed)
1148 0 : goto sendquery_cleanup;
1149 : }
1150 343450 : else if (pset.echo == PSQL_ECHO_QUERIES)
1151 : {
1152 80 : puts(query);
1153 80 : fflush(stdout);
1154 : }
1155 :
1156 343450 : if (pset.logfile)
1157 : {
1158 0 : fprintf(pset.logfile,
1159 0 : _("/******** QUERY *********/\n"
1160 : "%s\n"
1161 : "/************************/\n\n"), query);
1162 0 : fflush(pset.logfile);
1163 : }
1164 :
1165 343450 : SetCancelConn(pset.db);
1166 :
1167 343450 : transaction_status = PQtransactionStatus(pset.db);
1168 :
1169 343450 : if (transaction_status == PQTRANS_IDLE &&
1170 313366 : !pset.autocommit &&
1171 84 : !command_no_begin(query))
1172 : {
1173 : PGresult *result;
1174 :
1175 72 : result = PQexec(pset.db, "BEGIN");
1176 72 : if (PQresultStatus(result) != PGRES_COMMAND_OK)
1177 : {
1178 0 : pg_log_info("%s", PQerrorMessage(pset.db));
1179 0 : ClearOrSaveResult(result);
1180 0 : goto sendquery_cleanup;
1181 : }
1182 72 : ClearOrSaveResult(result);
1183 72 : transaction_status = PQtransactionStatus(pset.db);
1184 : }
1185 :
1186 343450 : if (transaction_status == PQTRANS_INTRANS &&
1187 28010 : pset.on_error_rollback != PSQL_ERROR_ROLLBACK_OFF &&
1188 156 : (pset.cur_cmd_interactive ||
1189 156 : pset.on_error_rollback == PSQL_ERROR_ROLLBACK_ON))
1190 : {
1191 : PGresult *result;
1192 :
1193 156 : result = PQexec(pset.db, "SAVEPOINT pg_psql_temporary_savepoint");
1194 156 : if (PQresultStatus(result) != PGRES_COMMAND_OK)
1195 : {
1196 0 : pg_log_info("%s", PQerrorMessage(pset.db));
1197 0 : ClearOrSaveResult(result);
1198 0 : goto sendquery_cleanup;
1199 : }
1200 156 : ClearOrSaveResult(result);
1201 156 : on_error_rollback_savepoint = true;
1202 : }
1203 :
1204 343450 : if (pset.gdesc_flag)
1205 : {
1206 : /* Describe query's result columns, without executing it */
1207 86 : OK = DescribeQuery(query, &elapsed_msec);
1208 : }
1209 : else
1210 : {
1211 : /* Default fetch-and-print mode */
1212 343364 : OK = (ExecQueryAndProcessResults(query, &elapsed_msec, &svpt_gone, false, 0, NULL, NULL) > 0);
1213 : }
1214 :
1215 343424 : if (!OK && pset.echo == PSQL_ECHO_ERRORS)
1216 6 : pg_log_info("STATEMENT: %s", query);
1217 :
1218 : /* If we made a temporary savepoint, possibly release/rollback */
1219 343424 : if (on_error_rollback_savepoint)
1220 : {
1221 156 : const char *svptcmd = NULL;
1222 :
1223 156 : transaction_status = PQtransactionStatus(pset.db);
1224 :
1225 156 : switch (transaction_status)
1226 : {
1227 42 : case PQTRANS_INERROR:
1228 : /* We always rollback on an error */
1229 42 : svptcmd = "ROLLBACK TO pg_psql_temporary_savepoint";
1230 42 : break;
1231 :
1232 42 : case PQTRANS_IDLE:
1233 : /* If they are no longer in a transaction, then do nothing */
1234 42 : break;
1235 :
1236 72 : case PQTRANS_INTRANS:
1237 :
1238 : /*
1239 : * Release our savepoint, but do nothing if they are messing
1240 : * with savepoints themselves
1241 : */
1242 72 : if (!svpt_gone)
1243 66 : svptcmd = "RELEASE pg_psql_temporary_savepoint";
1244 72 : break;
1245 :
1246 0 : case PQTRANS_ACTIVE:
1247 : case PQTRANS_UNKNOWN:
1248 : default:
1249 0 : OK = false;
1250 : /* PQTRANS_UNKNOWN is expected given a broken connection. */
1251 0 : if (transaction_status != PQTRANS_UNKNOWN || ConnectionUp())
1252 0 : pg_log_error("unexpected transaction status (%d)",
1253 : transaction_status);
1254 0 : break;
1255 : }
1256 :
1257 156 : if (svptcmd)
1258 : {
1259 : PGresult *svptres;
1260 :
1261 108 : svptres = PQexec(pset.db, svptcmd);
1262 108 : if (PQresultStatus(svptres) != PGRES_COMMAND_OK)
1263 : {
1264 0 : pg_log_info("%s", PQerrorMessage(pset.db));
1265 0 : ClearOrSaveResult(svptres);
1266 0 : OK = false;
1267 :
1268 0 : goto sendquery_cleanup;
1269 : }
1270 108 : PQclear(svptres);
1271 : }
1272 : }
1273 :
1274 : /* Possible microtiming output */
1275 343424 : if (timing)
1276 4 : PrintTiming(elapsed_msec);
1277 :
1278 : /* check for events that may occur during query execution */
1279 :
1280 343452 : if (pset.encoding != PQclientEncoding(pset.db) &&
1281 28 : PQclientEncoding(pset.db) >= 0)
1282 : {
1283 : /* track effects of SET CLIENT_ENCODING */
1284 28 : pset.encoding = PQclientEncoding(pset.db);
1285 28 : pset.popt.topt.encoding = pset.encoding;
1286 28 : SetVariable(pset.vars, "ENCODING",
1287 : pg_encoding_to_char(pset.encoding));
1288 : }
1289 :
1290 343424 : PrintNotifications();
1291 :
1292 : /* perform cleanup that should occur after any attempted query */
1293 :
1294 343424 : sendquery_cleanup:
1295 :
1296 : /* global cancellation reset */
1297 343424 : ResetCancelConn();
1298 :
1299 : /* reset \g's output-to-filename trigger */
1300 343424 : if (pset.gfname)
1301 : {
1302 32 : free(pset.gfname);
1303 32 : pset.gfname = NULL;
1304 : }
1305 :
1306 : /* restore print settings if \g changed them */
1307 343424 : if (pset.gsavepopt)
1308 : {
1309 42 : restorePsetInfo(&pset.popt, pset.gsavepopt);
1310 42 : pset.gsavepopt = NULL;
1311 : }
1312 :
1313 : /* clean up after extended protocol queries */
1314 343424 : clean_extended_state();
1315 :
1316 : /* reset \gset trigger */
1317 343424 : if (pset.gset_prefix)
1318 : {
1319 754 : free(pset.gset_prefix);
1320 754 : pset.gset_prefix = NULL;
1321 : }
1322 :
1323 : /* reset \gdesc trigger */
1324 343424 : pset.gdesc_flag = false;
1325 :
1326 : /* reset \gexec trigger */
1327 343424 : pset.gexec_flag = false;
1328 :
1329 : /* reset \crosstabview trigger */
1330 343424 : pset.crosstab_flag = false;
1331 1717120 : for (i = 0; i < lengthof(pset.ctv_args); i++)
1332 : {
1333 1373696 : pg_free(pset.ctv_args[i]);
1334 1373696 : pset.ctv_args[i] = NULL;
1335 : }
1336 :
1337 343424 : return OK;
1338 : }
1339 :
1340 :
1341 : /*
1342 : * DescribeQuery: describe the result columns of a query, without executing it
1343 : *
1344 : * Returns true if the operation executed successfully, false otherwise.
1345 : *
1346 : * If pset.timing is on, total query time (exclusive of result-printing) is
1347 : * stored into *elapsed_msec.
1348 : */
1349 : static bool
1350 86 : DescribeQuery(const char *query, double *elapsed_msec)
1351 : {
1352 86 : bool timing = pset.timing;
1353 : PGresult *result;
1354 : bool OK;
1355 : instr_time before,
1356 : after;
1357 :
1358 86 : *elapsed_msec = 0;
1359 :
1360 86 : if (timing)
1361 0 : INSTR_TIME_SET_CURRENT(before);
1362 : else
1363 86 : INSTR_TIME_SET_ZERO(before);
1364 :
1365 : /*
1366 : * To parse the query but not execute it, we prepare it, using the unnamed
1367 : * prepared statement. This is invisible to psql users, since there's no
1368 : * way to access the unnamed prepared statement from psql user space. The
1369 : * next Parse or Query protocol message would overwrite the statement
1370 : * anyway. (So there's no great need to clear it when done, which is a
1371 : * good thing because libpq provides no easy way to do that.)
1372 : */
1373 86 : result = PQprepare(pset.db, "", query, 0, NULL);
1374 86 : if (PQresultStatus(result) != PGRES_COMMAND_OK)
1375 : {
1376 32 : pg_log_info("%s", PQerrorMessage(pset.db));
1377 32 : SetResultVariables(result, false);
1378 32 : ClearOrSaveResult(result);
1379 32 : return false;
1380 : }
1381 54 : PQclear(result);
1382 :
1383 54 : result = PQdescribePrepared(pset.db, "");
1384 108 : OK = AcceptResult(result, true) &&
1385 54 : (PQresultStatus(result) == PGRES_COMMAND_OK);
1386 54 : if (OK && result)
1387 : {
1388 54 : if (PQnfields(result) > 0)
1389 : {
1390 : PQExpBufferData buf;
1391 : int i;
1392 :
1393 36 : initPQExpBuffer(&buf);
1394 :
1395 36 : printfPQExpBuffer(&buf,
1396 : "SELECT name AS \"%s\", pg_catalog.format_type(tp, tpm) AS \"%s\"\n"
1397 : "FROM (VALUES ",
1398 : gettext_noop("Column"),
1399 : gettext_noop("Type"));
1400 :
1401 162 : for (i = 0; i < PQnfields(result); i++)
1402 : {
1403 : const char *name;
1404 : char *escname;
1405 :
1406 126 : if (i > 0)
1407 90 : appendPQExpBufferChar(&buf, ',');
1408 :
1409 126 : name = PQfname(result, i);
1410 126 : escname = PQescapeLiteral(pset.db, name, strlen(name));
1411 :
1412 126 : if (escname == NULL)
1413 : {
1414 0 : pg_log_info("%s", PQerrorMessage(pset.db));
1415 0 : PQclear(result);
1416 0 : termPQExpBuffer(&buf);
1417 0 : return false;
1418 : }
1419 :
1420 126 : appendPQExpBuffer(&buf, "(%s, '%u'::pg_catalog.oid, %d)",
1421 : escname,
1422 : PQftype(result, i),
1423 : PQfmod(result, i));
1424 :
1425 126 : PQfreemem(escname);
1426 : }
1427 :
1428 36 : appendPQExpBufferStr(&buf, ") s(name, tp, tpm)");
1429 36 : PQclear(result);
1430 :
1431 36 : result = PQexec(pset.db, buf.data);
1432 36 : OK = AcceptResult(result, true);
1433 :
1434 36 : if (timing)
1435 : {
1436 0 : INSTR_TIME_SET_CURRENT(after);
1437 0 : INSTR_TIME_SUBTRACT(after, before);
1438 0 : *elapsed_msec += INSTR_TIME_GET_MILLISEC(after);
1439 : }
1440 :
1441 36 : if (OK && result)
1442 36 : OK = PrintQueryResult(result, true, NULL, NULL, NULL);
1443 :
1444 36 : termPQExpBuffer(&buf);
1445 : }
1446 : else
1447 18 : fprintf(pset.queryFout,
1448 18 : _("The command has no result, or the result has no columns.\n"));
1449 : }
1450 :
1451 54 : SetResultVariables(result, OK);
1452 54 : ClearOrSaveResult(result);
1453 :
1454 54 : return OK;
1455 : }
1456 :
1457 : /*
1458 : * Read and discard all results in an aborted pipeline.
1459 : *
1460 : * If a synchronisation point is found, we can stop discarding results as
1461 : * the pipeline will switch back to a clean state. If no synchronisation
1462 : * point is available, we need to stop when there are no more pending
1463 : * results, otherwise, calling PQgetResult() would block.
1464 : */
1465 : static PGresult *
1466 108 : discardAbortedPipelineResults(void)
1467 : {
1468 : for (;;)
1469 270 : {
1470 378 : PGresult *res = PQgetResult(pset.db);
1471 378 : ExecStatusType result_status = PQresultStatus(res);
1472 :
1473 378 : if (result_status == PGRES_PIPELINE_SYNC)
1474 : {
1475 : /*
1476 : * Found a synchronisation point. The sync counter is decremented
1477 : * by the caller.
1478 : */
1479 66 : return res;
1480 : }
1481 312 : else if (res != NULL && result_status == PGRES_FATAL_ERROR)
1482 : {
1483 : /*
1484 : * Found a FATAL error sent by the backend, and we cannot recover
1485 : * from this state. Instead, return the last result and let the
1486 : * outer loop handle it.
1487 : */
1488 : PGresult *fatal_res PG_USED_FOR_ASSERTS_ONLY;
1489 :
1490 : /*
1491 : * Fetch result to consume the end of the current query being
1492 : * processed.
1493 : */
1494 0 : fatal_res = PQgetResult(pset.db);
1495 : Assert(fatal_res == NULL);
1496 0 : return res;
1497 : }
1498 312 : else if (res == NULL)
1499 : {
1500 : /* A query was processed, decrement the counters */
1501 : Assert(pset.available_results > 0);
1502 : Assert(pset.requested_results > 0);
1503 210 : pset.available_results--;
1504 210 : pset.requested_results--;
1505 : }
1506 :
1507 312 : if (pset.requested_results == 0)
1508 : {
1509 : /* We have read all the requested results, leave */
1510 42 : return res;
1511 : }
1512 :
1513 270 : if (pset.available_results == 0 && pset.piped_syncs == 0)
1514 : {
1515 : /*
1516 : * There are no more results to get and there is no
1517 : * synchronisation point to stop at. This will leave the pipeline
1518 : * in an aborted state.
1519 : */
1520 0 : return res;
1521 : }
1522 :
1523 : /*
1524 : * An aborted pipeline will have either NULL results or results in an
1525 : * PGRES_PIPELINE_ABORTED status.
1526 : */
1527 : Assert(res == NULL || result_status == PGRES_PIPELINE_ABORTED);
1528 270 : PQclear(res);
1529 : }
1530 : }
1531 :
1532 : /*
1533 : * ExecQueryAndProcessResults: utility function for use by SendQuery()
1534 : * and PSQLexecWatch().
1535 : *
1536 : * Sends query and cycles through PGresult objects.
1537 : *
1538 : * If our command string contained a COPY FROM STDIN or COPY TO STDOUT, the
1539 : * PGresult associated with these commands must be processed by providing an
1540 : * input or output stream. In that event, we'll marshal data for the COPY.
1541 : *
1542 : * For other commands, the results are processed normally, depending on their
1543 : * status and the status of a pipeline.
1544 : *
1545 : * When invoked from \watch, is_watch is true and min_rows is the value
1546 : * of that option, or 0 if it wasn't set.
1547 : *
1548 : * Returns 1 on complete success, 0 on interrupt and -1 or errors. Possible
1549 : * failure modes include purely client-side problems; check the transaction
1550 : * status for the server-side opinion.
1551 : *
1552 : * Note that on a combined query, failure does not mean that nothing was
1553 : * committed.
1554 : */
1555 : static int
1556 343406 : ExecQueryAndProcessResults(const char *query,
1557 : double *elapsed_msec, bool *svpt_gone_p,
1558 : bool is_watch, int min_rows,
1559 : const printQueryOpt *opt, FILE *printQueryFout)
1560 : {
1561 343406 : bool timing = pset.timing;
1562 343406 : bool success = false;
1563 343406 : bool return_early = false;
1564 343406 : bool end_pipeline = false;
1565 : instr_time before,
1566 : after;
1567 : PGresult *result;
1568 343406 : FILE *gfile_fout = NULL;
1569 343406 : bool gfile_is_pipe = false;
1570 :
1571 343406 : if (timing)
1572 4 : INSTR_TIME_SET_CURRENT(before);
1573 : else
1574 343402 : INSTR_TIME_SET_ZERO(before);
1575 :
1576 343406 : switch (pset.send_mode)
1577 : {
1578 36 : case PSQL_SEND_EXTENDED_CLOSE:
1579 36 : success = PQsendClosePrepared(pset.db, pset.stmtName);
1580 36 : if (success && PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF)
1581 18 : pset.piped_commands++;
1582 36 : break;
1583 96 : case PSQL_SEND_EXTENDED_PARSE:
1584 96 : success = PQsendPrepare(pset.db, pset.stmtName, query, 0, NULL);
1585 96 : if (success && PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF)
1586 66 : pset.piped_commands++;
1587 96 : break;
1588 600 : case PSQL_SEND_EXTENDED_QUERY_PARAMS:
1589 : Assert(pset.stmtName == NULL);
1590 1200 : success = PQsendQueryParams(pset.db, query,
1591 : pset.bind_nparams, NULL,
1592 600 : (const char *const *) pset.bind_params,
1593 : NULL, NULL, 0);
1594 600 : if (success && PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF)
1595 516 : pset.piped_commands++;
1596 600 : break;
1597 114 : case PSQL_SEND_EXTENDED_QUERY_PREPARED:
1598 : Assert(pset.stmtName != NULL);
1599 228 : success = PQsendQueryPrepared(pset.db, pset.stmtName,
1600 : pset.bind_nparams,
1601 114 : (const char *const *) pset.bind_params,
1602 : NULL, NULL, 0);
1603 114 : if (success && PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF)
1604 48 : pset.piped_commands++;
1605 114 : break;
1606 290 : case PSQL_SEND_START_PIPELINE_MODE:
1607 290 : success = PQenterPipelineMode(pset.db);
1608 290 : break;
1609 290 : case PSQL_SEND_END_PIPELINE_MODE:
1610 290 : success = PQpipelineSync(pset.db);
1611 290 : if (success && PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF)
1612 : {
1613 : /*
1614 : * End of the pipeline, all queued commands need to be
1615 : * processed.
1616 : */
1617 284 : end_pipeline = true;
1618 284 : pset.piped_syncs++;
1619 :
1620 : /*
1621 : * The server will send a ReadyForQuery after a Sync is
1622 : * processed, flushing all the results back to the client.
1623 : */
1624 284 : pset.available_results += pset.piped_commands;
1625 284 : pset.piped_commands = 0;
1626 :
1627 : /* We want to read all results */
1628 284 : pset.requested_results = pset.available_results + pset.piped_syncs;
1629 : }
1630 290 : break;
1631 108 : case PSQL_SEND_PIPELINE_SYNC:
1632 108 : success = PQsendPipelineSync(pset.db);
1633 108 : if (success && PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF)
1634 : {
1635 108 : pset.piped_syncs++;
1636 :
1637 : /*
1638 : * The server will send a ReadyForQuery after a Sync is
1639 : * processed, flushing all the results back to the client.
1640 : */
1641 108 : pset.available_results += pset.piped_commands;
1642 108 : pset.piped_commands = 0;
1643 : }
1644 108 : break;
1645 18 : case PSQL_SEND_FLUSH:
1646 18 : success = PQflush(pset.db);
1647 18 : break;
1648 54 : case PSQL_SEND_FLUSH_REQUEST:
1649 54 : success = PQsendFlushRequest(pset.db);
1650 54 : if (success && PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF)
1651 : {
1652 : /*
1653 : * With the flush request, all commands in the pipeline are
1654 : * pushed and the server will flush the results back to the
1655 : * client, making them available.
1656 : */
1657 54 : pset.available_results += pset.piped_commands;
1658 54 : pset.piped_commands = 0;
1659 : }
1660 54 : break;
1661 144 : case PSQL_SEND_GET_RESULTS:
1662 144 : if (pset.available_results == 0 && pset.piped_syncs == 0)
1663 : {
1664 : /*
1665 : * If no sync or flush request were sent, PQgetResult() would
1666 : * block as there are no results available. Forbid any
1667 : * attempt to get pending results should we try to reach this
1668 : * state.
1669 : */
1670 24 : pg_log_info("No pending results to get");
1671 24 : success = false;
1672 24 : pset.requested_results = 0;
1673 : }
1674 : else
1675 : {
1676 120 : success = true;
1677 :
1678 : /*
1679 : * Cap requested_results to the maximum number of known
1680 : * results.
1681 : */
1682 120 : if (pset.requested_results == 0 ||
1683 54 : pset.requested_results > (pset.available_results + pset.piped_syncs))
1684 66 : pset.requested_results = pset.available_results + pset.piped_syncs;
1685 : }
1686 144 : break;
1687 341656 : case PSQL_SEND_QUERY:
1688 341656 : if (PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF)
1689 : {
1690 104 : success = PQsendQueryParams(pset.db, query,
1691 : 0, NULL, NULL, NULL, NULL, 0);
1692 104 : if (success)
1693 104 : pset.piped_commands++;
1694 : }
1695 : else
1696 341552 : success = PQsendQuery(pset.db, query);
1697 341656 : break;
1698 : }
1699 :
1700 343406 : if (!success)
1701 : {
1702 48 : const char *error = PQerrorMessage(pset.db);
1703 :
1704 48 : if (strlen(error))
1705 6 : pg_log_info("%s", error);
1706 :
1707 48 : CheckConnection();
1708 :
1709 48 : SetPipelineVariables();
1710 :
1711 48 : return -1;
1712 : }
1713 :
1714 686312 : if (pset.requested_results == 0 && !end_pipeline &&
1715 342954 : PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF)
1716 : {
1717 : /*
1718 : * We are in a pipeline and have not reached the pipeline end, or
1719 : * there was no request to read pipeline results. Update the psql
1720 : * variables tracking the pipeline activity and exit.
1721 : */
1722 1204 : SetPipelineVariables();
1723 1204 : return 1;
1724 : }
1725 :
1726 : /*
1727 : * Fetch the result in chunks if FETCH_COUNT is set, except when:
1728 : *
1729 : * * SHOW_ALL_RESULTS is false, since that requires us to complete the
1730 : * query before we can tell if its results should be displayed.
1731 : *
1732 : * * We're doing \crosstab, which likewise needs to see all the rows at
1733 : * once.
1734 : *
1735 : * * We're doing \gexec: we must complete the data fetch to make the
1736 : * connection free for issuing the resulting commands.
1737 : *
1738 : * * We're doing \gset: only one result row is allowed anyway.
1739 : *
1740 : * * We're doing \watch: users probably don't want us to force use of the
1741 : * pager for that, plus chunking could break the min_rows check.
1742 : */
1743 342154 : if (pset.fetch_count > 0 && pset.show_all_results &&
1744 134 : !pset.crosstab_flag && !pset.gexec_flag &&
1745 128 : !pset.gset_prefix && !is_watch)
1746 : {
1747 104 : if (!PQsetChunkedRowsMode(pset.db, pset.fetch_count))
1748 6 : pg_log_warning("fetching results in chunked mode failed");
1749 : }
1750 :
1751 : /*
1752 : * If SIGINT is sent while the query is processing, the interrupt will be
1753 : * consumed. The user's intention, though, is to cancel the entire watch
1754 : * process, so detect a sent cancellation request and exit in this case.
1755 : */
1756 342154 : if (is_watch && cancel_pressed)
1757 : {
1758 0 : ClearOrSaveAllResults();
1759 0 : return 0;
1760 : }
1761 :
1762 : /* first result */
1763 342154 : result = PQgetResult(pset.db);
1764 342154 : if (min_rows > 0 && PQntuples(result) < min_rows)
1765 : {
1766 2 : return_early = true;
1767 : }
1768 :
1769 686546 : while (result != NULL)
1770 : {
1771 : ExecStatusType result_status;
1772 344420 : bool is_chunked_result = false;
1773 344420 : PGresult *next_result = NULL;
1774 : bool last;
1775 :
1776 344420 : if (!AcceptResult(result, false))
1777 41670 : {
1778 : /*
1779 : * Some error occurred, either a server-side failure or a failure
1780 : * to submit the command string. Record that.
1781 : */
1782 41690 : const char *error = PQresultErrorMessage(result);
1783 :
1784 41690 : if (strlen(error))
1785 41658 : pg_log_info("%s", error);
1786 :
1787 41690 : CheckConnection();
1788 41670 : if (!is_watch)
1789 41668 : SetResultVariables(result, false);
1790 :
1791 : /* keep the result status before clearing it */
1792 41670 : result_status = PQresultStatus(result);
1793 41670 : ClearOrSaveResult(result);
1794 41670 : success = false;
1795 :
1796 41670 : if (result_status == PGRES_PIPELINE_ABORTED)
1797 30 : pg_log_info("Pipeline aborted, command did not run");
1798 :
1799 : /*
1800 : * switch to next result
1801 : */
1802 41670 : if (result_status == PGRES_COPY_BOTH ||
1803 41668 : result_status == PGRES_COPY_OUT ||
1804 : result_status == PGRES_COPY_IN)
1805 : {
1806 : /*
1807 : * For some obscure reason PQgetResult does *not* return a
1808 : * NULL in copy cases despite the result having been cleared,
1809 : * but keeps returning an "empty" result that we have to
1810 : * ignore manually.
1811 : */
1812 2 : result = NULL;
1813 : }
1814 41668 : else if ((end_pipeline || pset.requested_results > 0)
1815 108 : && PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF)
1816 : {
1817 : /*
1818 : * Error within a pipeline. All commands are aborted until
1819 : * the next synchronisation point. We need to consume all the
1820 : * results until this synchronisation point, or stop when
1821 : * there are no more result to discard.
1822 : *
1823 : * Checking the pipeline status is necessary for the case
1824 : * where the connection was reset. The new connection is not
1825 : * in any kind of pipeline state and thus has no result to
1826 : * discard.
1827 : */
1828 108 : result = discardAbortedPipelineResults();
1829 : }
1830 : else
1831 41560 : result = PQgetResult(pset.db);
1832 :
1833 : /*
1834 : * Get current timing measure in case an error occurs
1835 : */
1836 41670 : if (timing)
1837 : {
1838 2 : INSTR_TIME_SET_CURRENT(after);
1839 2 : INSTR_TIME_SUBTRACT(after, before);
1840 2 : *elapsed_msec = INSTR_TIME_GET_MILLISEC(after);
1841 : }
1842 :
1843 41670 : continue;
1844 : }
1845 302730 : else if (svpt_gone_p && !*svpt_gone_p)
1846 : {
1847 : /*
1848 : * Check if the user ran any command that would destroy our
1849 : * internal savepoint: If the user did COMMIT AND CHAIN, RELEASE
1850 : * or ROLLBACK, our savepoint is gone. If they issued a SAVEPOINT,
1851 : * releasing ours would remove theirs.
1852 : */
1853 302600 : const char *cmd = PQcmdStatus(result);
1854 :
1855 906092 : *svpt_gone_p = (strcmp(cmd, "COMMIT") == 0 ||
1856 300892 : strcmp(cmd, "SAVEPOINT") == 0 ||
1857 903080 : strcmp(cmd, "RELEASE") == 0 ||
1858 299588 : strcmp(cmd, "ROLLBACK") == 0);
1859 : }
1860 :
1861 302730 : result_status = PQresultStatus(result);
1862 :
1863 : /* must handle COPY before changing the current result */
1864 : Assert(result_status != PGRES_COPY_BOTH);
1865 302730 : if (result_status == PGRES_COPY_IN ||
1866 : result_status == PGRES_COPY_OUT)
1867 : {
1868 1462 : FILE *copy_stream = NULL;
1869 :
1870 1462 : if (PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF)
1871 : {
1872 : /*
1873 : * Running COPY within a pipeline can break the protocol
1874 : * synchronisation in multiple ways, and psql shows its limits
1875 : * when it comes to tracking this information.
1876 : *
1877 : * While in COPY mode, the backend process ignores additional
1878 : * Sync messages and will not send the matching ReadyForQuery
1879 : * expected by the frontend.
1880 : *
1881 : * Additionally, libpq automatically sends a Sync with the
1882 : * Copy message, creating an unexpected synchronisation point.
1883 : * A failure during COPY would leave the pipeline in an
1884 : * aborted state while the backend would be in a clean state,
1885 : * ready to process commands.
1886 : *
1887 : * Improving those issues would require modifications in how
1888 : * libpq handles pipelines and COPY. Hence, for the time
1889 : * being, we forbid the use of COPY within a pipeline,
1890 : * aborting the connection to avoid an inconsistent state on
1891 : * psql side if trying to use a COPY command.
1892 : */
1893 8 : pg_log_info("COPY in a pipeline is not supported, aborting connection");
1894 8 : exit(EXIT_BADCONN);
1895 : }
1896 :
1897 : /*
1898 : * For COPY OUT, direct the output to the default place (probably
1899 : * a pager pipe) for \watch, or to pset.copyStream for \copy,
1900 : * otherwise to pset.gfname if that's set, otherwise to
1901 : * pset.queryFout.
1902 : */
1903 1454 : if (result_status == PGRES_COPY_OUT)
1904 : {
1905 540 : if (is_watch)
1906 : {
1907 : /* invoked by \watch */
1908 0 : copy_stream = printQueryFout ? printQueryFout : pset.queryFout;
1909 : }
1910 540 : else if (pset.copyStream)
1911 : {
1912 : /* invoked by \copy */
1913 54 : copy_stream = pset.copyStream;
1914 : }
1915 486 : else if (pset.gfname)
1916 : {
1917 : /* COPY followed by \g filename or \g |program */
1918 26 : success &= SetupGOutput(&gfile_fout, &gfile_is_pipe);
1919 26 : if (gfile_fout)
1920 26 : copy_stream = gfile_fout;
1921 : }
1922 : else
1923 : {
1924 : /* fall back to the generic query output stream */
1925 460 : copy_stream = pset.queryFout;
1926 : }
1927 : }
1928 :
1929 : /*
1930 : * Even if the output stream could not be opened, we call
1931 : * HandleCopyResult() with a NULL output stream to collect and
1932 : * discard the COPY data.
1933 : */
1934 1454 : success &= HandleCopyResult(&result, copy_stream);
1935 : }
1936 :
1937 : /* If we have a chunked result, collect and print all chunks */
1938 302722 : if (result_status == PGRES_TUPLES_CHUNK)
1939 : {
1940 66 : FILE *tuples_fout = printQueryFout ? printQueryFout : pset.queryFout;
1941 66 : printQueryOpt my_popt = opt ? *opt : pset.popt;
1942 66 : int64 total_tuples = 0;
1943 66 : bool is_pager = false;
1944 66 : int flush_error = 0;
1945 :
1946 : /* initialize print options for partial table output */
1947 66 : my_popt.topt.start_table = true;
1948 66 : my_popt.topt.stop_table = false;
1949 66 : my_popt.topt.prior_records = 0;
1950 :
1951 : /* open \g file if needed */
1952 66 : success &= SetupGOutput(&gfile_fout, &gfile_is_pipe);
1953 66 : if (gfile_fout)
1954 0 : tuples_fout = gfile_fout;
1955 :
1956 : /* force use of pager for any chunked resultset going to stdout */
1957 66 : if (success && tuples_fout == stdout)
1958 : {
1959 66 : tuples_fout = PageOutput(INT_MAX, &(my_popt.topt));
1960 66 : is_pager = true;
1961 : }
1962 :
1963 : do
1964 : {
1965 : /*
1966 : * Display the current chunk of results, unless the output
1967 : * stream stopped working or we got canceled. We skip use of
1968 : * PrintQueryResult and go directly to printQuery, so that we
1969 : * can pass the correct is_pager value and because we don't
1970 : * want PrintQueryStatus to happen yet. Above, we rejected
1971 : * use of chunking for all cases in which PrintQueryResult
1972 : * would send the result to someplace other than printQuery.
1973 : */
1974 90 : if (success && !flush_error && !cancel_pressed)
1975 : {
1976 90 : printQuery(result, &my_popt, tuples_fout, is_pager, pset.logfile);
1977 90 : flush_error = fflush(tuples_fout);
1978 : }
1979 :
1980 : /* after the first result set, disallow header decoration */
1981 90 : my_popt.topt.start_table = false;
1982 :
1983 : /* count tuples before dropping the result */
1984 90 : my_popt.topt.prior_records += PQntuples(result);
1985 90 : total_tuples += PQntuples(result);
1986 :
1987 90 : ClearOrSaveResult(result);
1988 :
1989 : /* get the next result, loop if it's PGRES_TUPLES_CHUNK */
1990 90 : result = PQgetResult(pset.db);
1991 90 : } while (PQresultStatus(result) == PGRES_TUPLES_CHUNK);
1992 :
1993 : /* We expect an empty PGRES_TUPLES_OK, else there's a problem */
1994 66 : if (PQresultStatus(result) == PGRES_TUPLES_OK)
1995 : {
1996 : char buf[32];
1997 :
1998 : Assert(PQntuples(result) == 0);
1999 :
2000 : /* Display the footer using the empty result */
2001 60 : if (success && !flush_error && !cancel_pressed)
2002 : {
2003 60 : my_popt.topt.stop_table = true;
2004 60 : printQuery(result, &my_popt, tuples_fout, is_pager, pset.logfile);
2005 60 : fflush(tuples_fout);
2006 : }
2007 :
2008 60 : if (is_pager)
2009 60 : ClosePager(tuples_fout);
2010 :
2011 : /*
2012 : * It's possible the data is from a RETURNING clause, in which
2013 : * case we need to print query status.
2014 : */
2015 60 : PrintQueryStatus(result, printQueryFout);
2016 :
2017 : /*
2018 : * We must do a fake SetResultVariables(), since we don't have
2019 : * a PGresult corresponding to the whole query.
2020 : */
2021 60 : SetVariable(pset.vars, "ERROR", "false");
2022 60 : SetVariable(pset.vars, "SQLSTATE", "00000");
2023 60 : snprintf(buf, sizeof(buf), INT64_FORMAT, total_tuples);
2024 60 : SetVariable(pset.vars, "ROW_COUNT", buf);
2025 : /* Prevent SetResultVariables call below */
2026 60 : is_chunked_result = true;
2027 :
2028 : /* Clear the empty result so it isn't printed below */
2029 60 : ClearOrSaveResult(result);
2030 60 : result = NULL;
2031 : }
2032 : else
2033 : {
2034 : /* Probably an error report, so close the pager and print it */
2035 6 : if (is_pager)
2036 6 : ClosePager(tuples_fout);
2037 :
2038 6 : success &= AcceptResult(result, true);
2039 : /* SetResultVariables and ClearOrSaveResult happen below */
2040 : }
2041 : }
2042 :
2043 302722 : if (result_status == PGRES_PIPELINE_SYNC)
2044 : {
2045 : Assert(pset.piped_syncs > 0);
2046 :
2047 : /*
2048 : * Sync response, decrease the sync and requested_results
2049 : * counters.
2050 : */
2051 378 : pset.piped_syncs--;
2052 378 : pset.requested_results--;
2053 :
2054 : /*
2055 : * After a synchronisation point, reset success state to print
2056 : * possible successful results that will be processed after this.
2057 : */
2058 378 : success = true;
2059 :
2060 : /*
2061 : * If all syncs were processed and pipeline end was requested,
2062 : * exit pipeline mode.
2063 : */
2064 378 : if (end_pipeline && pset.piped_syncs == 0)
2065 276 : success &= PQexitPipelineMode(pset.db);
2066 : }
2067 302344 : else if (PQpipelineStatus(pset.db) != PQ_PIPELINE_OFF &&
2068 : result_status != PGRES_PIPELINE_SYNC)
2069 : {
2070 : /*
2071 : * In a pipeline with a non-sync response? Decrease the result
2072 : * counters.
2073 : */
2074 528 : pset.available_results--;
2075 528 : pset.requested_results--;
2076 : }
2077 :
2078 : /*
2079 : * Check PQgetResult() again. In the typical case of a single-command
2080 : * string, it will return NULL. Otherwise, we'll have other results
2081 : * to process. We need to do that to check whether this is the last.
2082 : */
2083 302722 : if (PQpipelineStatus(pset.db) == PQ_PIPELINE_OFF)
2084 302092 : next_result = PQgetResult(pset.db);
2085 : else
2086 : {
2087 : /*
2088 : * In pipeline mode, a NULL result indicates the end of the
2089 : * current query being processed. Call PQgetResult() once to
2090 : * consume this state.
2091 : */
2092 630 : if (result_status != PGRES_PIPELINE_SYNC)
2093 : {
2094 528 : next_result = PQgetResult(pset.db);
2095 : Assert(next_result == NULL);
2096 : }
2097 :
2098 : /* Now, we can get the next result in the pipeline. */
2099 630 : if (pset.requested_results > 0)
2100 552 : next_result = PQgetResult(pset.db);
2101 : }
2102 :
2103 302722 : last = (next_result == NULL);
2104 :
2105 : /*
2106 : * Update current timing measure.
2107 : *
2108 : * It will include the display of previous results, if any. This
2109 : * cannot be helped because the server goes on processing further
2110 : * queries anyway while the previous ones are being displayed. The
2111 : * parallel execution of the client display hides the server time when
2112 : * it is shorter.
2113 : *
2114 : * With combined queries, timing must be understood as an upper bound
2115 : * of the time spent processing them.
2116 : */
2117 302722 : if (timing)
2118 : {
2119 2 : INSTR_TIME_SET_CURRENT(after);
2120 2 : INSTR_TIME_SUBTRACT(after, before);
2121 2 : *elapsed_msec = INSTR_TIME_GET_MILLISEC(after);
2122 : }
2123 :
2124 : /*
2125 : * This may or may not print something depending on settings.
2126 : *
2127 : * A pipeline sync will have a non-NULL result but does not have
2128 : * anything to print, thus ignore results in this case.
2129 : */
2130 302722 : if (result != NULL && result_status != PGRES_PIPELINE_SYNC)
2131 : {
2132 : /*
2133 : * If results need to be printed into the file specified by \g,
2134 : * open it, unless we already did. Note that when pset.gfname is
2135 : * set, the passed-in value of printQueryFout is not used for
2136 : * tuple output, but it's still used for status output.
2137 : */
2138 301770 : FILE *tuples_fout = printQueryFout;
2139 :
2140 301770 : if (PQresultStatus(result) == PGRES_TUPLES_OK)
2141 132416 : success &= SetupGOutput(&gfile_fout, &gfile_is_pipe);
2142 301770 : if (gfile_fout)
2143 60 : tuples_fout = gfile_fout;
2144 301770 : if (success)
2145 301560 : success &= PrintQueryResult(result, last, opt,
2146 : tuples_fout, printQueryFout);
2147 : }
2148 :
2149 : /* set variables from last result, unless dealt with elsewhere */
2150 302722 : if (last && !is_watch && !is_chunked_result)
2151 300434 : SetResultVariables(result, success);
2152 :
2153 302722 : ClearOrSaveResult(result);
2154 302722 : result = next_result;
2155 :
2156 302722 : if (cancel_pressed && PQpipelineStatus(pset.db) == PQ_PIPELINE_OFF)
2157 : {
2158 : /*
2159 : * Outside of a pipeline, drop the next result, as well as any
2160 : * others not yet read.
2161 : *
2162 : * Within a pipeline, we can let the outer loop handle this as an
2163 : * aborted pipeline, which will discard then all the results.
2164 : */
2165 0 : ClearOrSaveResult(result);
2166 0 : ClearOrSaveAllResults();
2167 0 : break;
2168 : }
2169 : }
2170 :
2171 : /* close \g file if we opened it */
2172 342126 : CloseGOutput(gfile_fout, gfile_is_pipe);
2173 :
2174 : if (end_pipeline)
2175 : {
2176 : /* after a pipeline is processed, pipeline piped_syncs should be 0 */
2177 : Assert(pset.piped_syncs == 0);
2178 : /* all commands have been processed */
2179 : Assert(pset.piped_commands == 0);
2180 : /* all results were read */
2181 : Assert(pset.available_results == 0);
2182 : }
2183 : Assert(pset.requested_results == 0);
2184 342126 : SetPipelineVariables();
2185 :
2186 : /* may need this to recover from conn loss during COPY */
2187 342126 : if (!CheckConnection())
2188 0 : return -1;
2189 :
2190 342126 : if (cancel_pressed || return_early)
2191 4 : return 0;
2192 :
2193 342122 : return success ? 1 : -1;
2194 : }
2195 :
2196 :
2197 : /*
2198 : * Advance the given char pointer over white space and SQL comments.
2199 : */
2200 : static const char *
2201 108 : skip_white_space(const char *query)
2202 : {
2203 108 : int cnestlevel = 0; /* slash-star comment nest level */
2204 :
2205 132 : while (*query)
2206 : {
2207 132 : int mblen = PQmblenBounded(query, pset.encoding);
2208 :
2209 : /*
2210 : * Note: we assume the encoding is a superset of ASCII, so that for
2211 : * example "query[0] == '/'" is meaningful. However, we do NOT assume
2212 : * that the second and subsequent bytes of a multibyte character
2213 : * couldn't look like ASCII characters; so it is critical to advance
2214 : * by mblen, not 1, whenever we haven't exactly identified the
2215 : * character we are skipping over.
2216 : */
2217 132 : if (isspace((unsigned char) *query))
2218 24 : query += mblen;
2219 108 : else if (query[0] == '/' && query[1] == '*')
2220 : {
2221 0 : cnestlevel++;
2222 0 : query += 2;
2223 : }
2224 108 : else if (cnestlevel > 0 && query[0] == '*' && query[1] == '/')
2225 : {
2226 0 : cnestlevel--;
2227 0 : query += 2;
2228 : }
2229 108 : else if (cnestlevel == 0 && query[0] == '-' && query[1] == '-')
2230 : {
2231 0 : query += 2;
2232 :
2233 : /*
2234 : * We have to skip to end of line since any slash-star inside the
2235 : * -- comment does NOT start a slash-star comment.
2236 : */
2237 0 : while (*query)
2238 : {
2239 0 : if (*query == '\n')
2240 : {
2241 0 : query++;
2242 0 : break;
2243 : }
2244 0 : query += PQmblenBounded(query, pset.encoding);
2245 : }
2246 : }
2247 108 : else if (cnestlevel > 0)
2248 0 : query += mblen;
2249 : else
2250 108 : break; /* found first token */
2251 : }
2252 :
2253 108 : return query;
2254 : }
2255 :
2256 :
2257 : /*
2258 : * Check whether a command is one of those for which we should NOT start
2259 : * a new transaction block (ie, send a preceding BEGIN).
2260 : *
2261 : * These include the transaction control statements themselves, plus
2262 : * certain statements that the backend disallows inside transaction blocks.
2263 : */
2264 : static bool
2265 84 : command_no_begin(const char *query)
2266 : {
2267 : int wordlen;
2268 :
2269 : /*
2270 : * First we must advance over any whitespace and comments.
2271 : */
2272 84 : query = skip_white_space(query);
2273 :
2274 : /*
2275 : * Check word length (since "beginx" is not "begin").
2276 : */
2277 84 : wordlen = 0;
2278 564 : while (isalpha((unsigned char) query[wordlen]))
2279 480 : wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2280 :
2281 : /*
2282 : * Transaction control commands. These should include every keyword that
2283 : * gives rise to a TransactionStmt in the backend grammar, except for the
2284 : * savepoint-related commands.
2285 : *
2286 : * (We assume that START must be START TRANSACTION, since there is
2287 : * presently no other "START foo" command.)
2288 : */
2289 84 : if (wordlen == 5 && pg_strncasecmp(query, "abort", 5) == 0)
2290 0 : return true;
2291 84 : if (wordlen == 5 && pg_strncasecmp(query, "begin", 5) == 0)
2292 12 : return true;
2293 72 : if (wordlen == 5 && pg_strncasecmp(query, "start", 5) == 0)
2294 0 : return true;
2295 72 : if (wordlen == 6 && pg_strncasecmp(query, "commit", 6) == 0)
2296 0 : return true;
2297 72 : if (wordlen == 3 && pg_strncasecmp(query, "end", 3) == 0)
2298 0 : return true;
2299 72 : if (wordlen == 8 && pg_strncasecmp(query, "rollback", 8) == 0)
2300 0 : return true;
2301 72 : if (wordlen == 7 && pg_strncasecmp(query, "prepare", 7) == 0)
2302 : {
2303 : /* PREPARE TRANSACTION is a TC command, PREPARE foo is not */
2304 0 : query += wordlen;
2305 :
2306 0 : query = skip_white_space(query);
2307 :
2308 0 : wordlen = 0;
2309 0 : while (isalpha((unsigned char) query[wordlen]))
2310 0 : wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2311 :
2312 0 : if (wordlen == 11 && pg_strncasecmp(query, "transaction", 11) == 0)
2313 0 : return true;
2314 0 : return false;
2315 : }
2316 :
2317 : /*
2318 : * Commands not allowed within transactions. The statements checked for
2319 : * here should be exactly those that call PreventInTransactionBlock() in
2320 : * the backend.
2321 : */
2322 72 : if (wordlen == 6 && pg_strncasecmp(query, "vacuum", 6) == 0)
2323 0 : return true;
2324 72 : if (wordlen == 7 && pg_strncasecmp(query, "cluster", 7) == 0)
2325 : {
2326 : /* CLUSTER with any arguments is allowed in transactions */
2327 0 : query += wordlen;
2328 :
2329 0 : query = skip_white_space(query);
2330 :
2331 0 : if (isalpha((unsigned char) query[0]))
2332 0 : return false; /* has additional words */
2333 0 : return true; /* it's CLUSTER without arguments */
2334 : }
2335 :
2336 72 : if (wordlen == 6 && pg_strncasecmp(query, "create", 6) == 0)
2337 : {
2338 12 : query += wordlen;
2339 :
2340 12 : query = skip_white_space(query);
2341 :
2342 12 : wordlen = 0;
2343 72 : while (isalpha((unsigned char) query[wordlen]))
2344 60 : wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2345 :
2346 12 : if (wordlen == 8 && pg_strncasecmp(query, "database", 8) == 0)
2347 0 : return true;
2348 12 : if (wordlen == 10 && pg_strncasecmp(query, "tablespace", 10) == 0)
2349 0 : return true;
2350 :
2351 : /* CREATE [UNIQUE] INDEX CONCURRENTLY isn't allowed in xacts */
2352 12 : if (wordlen == 6 && pg_strncasecmp(query, "unique", 6) == 0)
2353 : {
2354 0 : query += wordlen;
2355 :
2356 0 : query = skip_white_space(query);
2357 :
2358 0 : wordlen = 0;
2359 0 : while (isalpha((unsigned char) query[wordlen]))
2360 0 : wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2361 : }
2362 :
2363 12 : if (wordlen == 5 && pg_strncasecmp(query, "index", 5) == 0)
2364 : {
2365 0 : query += wordlen;
2366 :
2367 0 : query = skip_white_space(query);
2368 :
2369 0 : wordlen = 0;
2370 0 : while (isalpha((unsigned char) query[wordlen]))
2371 0 : wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2372 :
2373 0 : if (wordlen == 12 && pg_strncasecmp(query, "concurrently", 12) == 0)
2374 0 : return true;
2375 : }
2376 :
2377 12 : return false;
2378 : }
2379 :
2380 60 : if (wordlen == 5 && pg_strncasecmp(query, "alter", 5) == 0)
2381 : {
2382 0 : query += wordlen;
2383 :
2384 0 : query = skip_white_space(query);
2385 :
2386 0 : wordlen = 0;
2387 0 : while (isalpha((unsigned char) query[wordlen]))
2388 0 : wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2389 :
2390 : /* ALTER SYSTEM isn't allowed in xacts */
2391 0 : if (wordlen == 6 && pg_strncasecmp(query, "system", 6) == 0)
2392 0 : return true;
2393 :
2394 0 : return false;
2395 : }
2396 :
2397 : /*
2398 : * Note: these tests will match DROP SYSTEM and REINDEX TABLESPACE, which
2399 : * aren't really valid commands so we don't care much. The other four
2400 : * possible matches are correct.
2401 : */
2402 60 : if ((wordlen == 4 && pg_strncasecmp(query, "drop", 4) == 0) ||
2403 0 : (wordlen == 7 && pg_strncasecmp(query, "reindex", 7) == 0))
2404 : {
2405 6 : query += wordlen;
2406 :
2407 6 : query = skip_white_space(query);
2408 :
2409 6 : wordlen = 0;
2410 36 : while (isalpha((unsigned char) query[wordlen]))
2411 30 : wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2412 :
2413 6 : if (wordlen == 8 && pg_strncasecmp(query, "database", 8) == 0)
2414 0 : return true;
2415 6 : if (wordlen == 6 && pg_strncasecmp(query, "system", 6) == 0)
2416 0 : return true;
2417 6 : if (wordlen == 10 && pg_strncasecmp(query, "tablespace", 10) == 0)
2418 0 : return true;
2419 12 : if (wordlen == 5 && (pg_strncasecmp(query, "index", 5) == 0 ||
2420 6 : pg_strncasecmp(query, "table", 5) == 0))
2421 : {
2422 6 : query += wordlen;
2423 6 : query = skip_white_space(query);
2424 6 : wordlen = 0;
2425 24 : while (isalpha((unsigned char) query[wordlen]))
2426 18 : wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2427 :
2428 : /*
2429 : * REINDEX [ TABLE | INDEX ] CONCURRENTLY are not allowed in
2430 : * xacts.
2431 : */
2432 6 : if (wordlen == 12 && pg_strncasecmp(query, "concurrently", 12) == 0)
2433 0 : return true;
2434 : }
2435 :
2436 : /* DROP INDEX CONCURRENTLY isn't allowed in xacts */
2437 6 : if (wordlen == 5 && pg_strncasecmp(query, "index", 5) == 0)
2438 : {
2439 0 : query += wordlen;
2440 :
2441 0 : query = skip_white_space(query);
2442 :
2443 0 : wordlen = 0;
2444 0 : while (isalpha((unsigned char) query[wordlen]))
2445 0 : wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2446 :
2447 0 : if (wordlen == 12 && pg_strncasecmp(query, "concurrently", 12) == 0)
2448 0 : return true;
2449 :
2450 0 : return false;
2451 : }
2452 :
2453 6 : return false;
2454 : }
2455 :
2456 : /* DISCARD ALL isn't allowed in xacts, but other variants are allowed. */
2457 54 : if (wordlen == 7 && pg_strncasecmp(query, "discard", 7) == 0)
2458 : {
2459 0 : query += wordlen;
2460 :
2461 0 : query = skip_white_space(query);
2462 :
2463 0 : wordlen = 0;
2464 0 : while (isalpha((unsigned char) query[wordlen]))
2465 0 : wordlen += PQmblenBounded(&query[wordlen], pset.encoding);
2466 :
2467 0 : if (wordlen == 3 && pg_strncasecmp(query, "all", 3) == 0)
2468 0 : return true;
2469 0 : return false;
2470 : }
2471 :
2472 54 : return false;
2473 : }
2474 :
2475 :
2476 : /*
2477 : * Test if the current user is a database superuser.
2478 : */
2479 : bool
2480 116 : is_superuser(void)
2481 : {
2482 : const char *val;
2483 :
2484 116 : if (!pset.db)
2485 0 : return false;
2486 :
2487 116 : val = PQparameterStatus(pset.db, "is_superuser");
2488 :
2489 116 : if (val && strcmp(val, "on") == 0)
2490 116 : return true;
2491 :
2492 0 : return false;
2493 : }
2494 :
2495 :
2496 : /*
2497 : * Test if the current session uses standard string literals.
2498 : */
2499 : bool
2500 656832 : standard_strings(void)
2501 : {
2502 : const char *val;
2503 :
2504 656832 : if (!pset.db)
2505 0 : return false;
2506 :
2507 656832 : val = PQparameterStatus(pset.db, "standard_conforming_strings");
2508 :
2509 656832 : if (val && strcmp(val, "on") == 0)
2510 656640 : return true;
2511 :
2512 192 : return false;
2513 : }
2514 :
2515 :
2516 : /*
2517 : * Return the session user of the current connection.
2518 : */
2519 : const char *
2520 0 : session_username(void)
2521 : {
2522 : const char *val;
2523 :
2524 0 : if (!pset.db)
2525 0 : return NULL;
2526 :
2527 0 : val = PQparameterStatus(pset.db, "session_authorization");
2528 0 : if (val)
2529 0 : return val;
2530 : else
2531 0 : return PQuser(pset.db);
2532 : }
2533 :
2534 :
2535 : /* expand_tilde
2536 : *
2537 : * substitute '~' with HOME or '~username' with username's home dir
2538 : *
2539 : */
2540 : void
2541 184 : expand_tilde(char **filename)
2542 : {
2543 184 : if (!filename || !(*filename))
2544 18 : return;
2545 :
2546 : /*
2547 : * WIN32 doesn't use tilde expansion for file names. Also, it uses tilde
2548 : * for short versions of long file names, though the tilde is usually
2549 : * toward the end, not at the beginning.
2550 : */
2551 : #ifndef WIN32
2552 :
2553 : /* try tilde expansion */
2554 166 : if (**filename == '~')
2555 : {
2556 : char *fn;
2557 : char oldp,
2558 : *p;
2559 : struct passwd *pw;
2560 : char home[MAXPGPATH];
2561 :
2562 0 : fn = *filename;
2563 0 : *home = '\0';
2564 :
2565 0 : p = fn + 1;
2566 0 : while (*p != '/' && *p != '\0')
2567 0 : p++;
2568 :
2569 0 : oldp = *p;
2570 0 : *p = '\0';
2571 :
2572 0 : if (*(fn + 1) == '\0')
2573 0 : get_home_path(home); /* ~ or ~/ only */
2574 0 : else if ((pw = getpwnam(fn + 1)) != NULL)
2575 0 : strlcpy(home, pw->pw_dir, sizeof(home)); /* ~user */
2576 :
2577 0 : *p = oldp;
2578 0 : if (strlen(home) != 0)
2579 : {
2580 : char *newfn;
2581 :
2582 0 : newfn = psprintf("%s%s", home, p);
2583 0 : free(fn);
2584 0 : *filename = newfn;
2585 : }
2586 : }
2587 : #endif
2588 : }
2589 :
2590 : /*
2591 : * Checks if connection string starts with either of the valid URI prefix
2592 : * designators.
2593 : *
2594 : * Returns the URI prefix length, 0 if the string doesn't contain a URI prefix.
2595 : *
2596 : * XXX This is a duplicate of the eponymous libpq function.
2597 : */
2598 : static int
2599 44 : uri_prefix_length(const char *connstr)
2600 : {
2601 : /* The connection URI must start with either of the following designators: */
2602 : static const char uri_designator[] = "postgresql://";
2603 : static const char short_uri_designator[] = "postgres://";
2604 :
2605 44 : if (strncmp(connstr, uri_designator,
2606 : sizeof(uri_designator) - 1) == 0)
2607 0 : return sizeof(uri_designator) - 1;
2608 :
2609 44 : if (strncmp(connstr, short_uri_designator,
2610 : sizeof(short_uri_designator) - 1) == 0)
2611 0 : return sizeof(short_uri_designator) - 1;
2612 :
2613 44 : return 0;
2614 : }
2615 :
2616 : /*
2617 : * Reset state related to extended query protocol
2618 : *
2619 : * Clean up any state related to bind parameters, statement name and
2620 : * PSQL_SEND_MODE. This needs to be called after processing a query or when
2621 : * running a new meta-command that uses the extended query protocol, like
2622 : * \parse, \bind, etc.
2623 : */
2624 : void
2625 344468 : clean_extended_state(void)
2626 : {
2627 : int i;
2628 :
2629 344468 : switch (pset.send_mode)
2630 : {
2631 36 : case PSQL_SEND_EXTENDED_CLOSE: /* \close_prepared */
2632 36 : free(pset.stmtName);
2633 36 : break;
2634 96 : case PSQL_SEND_EXTENDED_PARSE: /* \parse */
2635 96 : free(pset.stmtName);
2636 96 : break;
2637 798 : case PSQL_SEND_EXTENDED_QUERY_PARAMS: /* \bind */
2638 : case PSQL_SEND_EXTENDED_QUERY_PREPARED: /* \bind_named */
2639 1496 : for (i = 0; i < pset.bind_nparams; i++)
2640 698 : free(pset.bind_params[i]);
2641 798 : free(pset.bind_params);
2642 798 : free(pset.stmtName);
2643 798 : pset.bind_params = NULL;
2644 798 : break;
2645 343538 : case PSQL_SEND_QUERY:
2646 : case PSQL_SEND_START_PIPELINE_MODE: /* \startpipeline */
2647 : case PSQL_SEND_END_PIPELINE_MODE: /* \endpipeline */
2648 : case PSQL_SEND_PIPELINE_SYNC: /* \syncpipeline */
2649 : case PSQL_SEND_FLUSH: /* \flush */
2650 : case PSQL_SEND_GET_RESULTS: /* \getresults */
2651 : case PSQL_SEND_FLUSH_REQUEST: /* \flushrequest */
2652 343538 : break;
2653 : }
2654 :
2655 344468 : pset.stmtName = NULL;
2656 344468 : pset.send_mode = PSQL_SEND_QUERY;
2657 344468 : }
2658 :
2659 : /*
2660 : * Recognized connection string either starts with a valid URI prefix or
2661 : * contains a "=" in it.
2662 : *
2663 : * Must be consistent with parse_connection_string: anything for which this
2664 : * returns true should at least look like it's parseable by that routine.
2665 : *
2666 : * XXX This is a duplicate of the eponymous libpq function.
2667 : */
2668 : bool
2669 44 : recognized_connection_string(const char *connstr)
2670 : {
2671 44 : return uri_prefix_length(connstr) != 0 || strchr(connstr, '=') != NULL;
2672 : }
|
