Age Owner Branch data TLA Line data Source code
1 : : /*
2 : : * psql - the PostgreSQL interactive terminal
3 : : *
4 : : * Copyright (c) 2000-2024, PostgreSQL Global Development Group
5 : : *
6 : : * src/bin/psql/command.c
7 : : */
8 : : #include "postgres_fe.h"
9 : :
10 : : #include <ctype.h>
11 : : #include <time.h>
12 : : #include <pwd.h>
13 : : #include <utime.h>
14 : : #ifndef WIN32
15 : : #include <sys/stat.h> /* for stat() */
16 : : #include <sys/time.h> /* for setitimer() */
17 : : #include <fcntl.h> /* open() flags */
18 : : #include <unistd.h> /* for geteuid(), getpid(), stat() */
19 : : #else
20 : : #include <win32.h>
21 : : #include <io.h>
22 : : #include <fcntl.h>
23 : : #include <direct.h>
24 : : #include <sys/stat.h> /* for stat() */
25 : : #endif
26 : :
27 : : #include "catalog/pg_class_d.h"
28 : : #include "command.h"
29 : : #include "common.h"
30 : : #include "common/logging.h"
31 : : #include "common/string.h"
32 : : #include "copy.h"
33 : : #include "crosstabview.h"
34 : : #include "describe.h"
35 : : #include "fe_utils/cancel.h"
36 : : #include "fe_utils/print.h"
37 : : #include "fe_utils/string_utils.h"
38 : : #include "help.h"
39 : : #include "input.h"
40 : : #include "large_obj.h"
41 : : #include "libpq-fe.h"
42 : : #include "libpq/pqcomm.h"
43 : : #include "mainloop.h"
44 : : #include "portability/instr_time.h"
45 : : #include "pqexpbuffer.h"
46 : : #include "psqlscanslash.h"
47 : : #include "settings.h"
48 : : #include "variables.h"
49 : :
50 : : /*
51 : : * Editable database object types.
52 : : */
53 : : typedef enum EditableObjectType
54 : : {
55 : : EditableFunction,
56 : : EditableView,
57 : : } EditableObjectType;
58 : :
59 : : /* local function declarations */
60 : : static backslashResult exec_command(const char *cmd,
61 : : PsqlScanState scan_state,
62 : : ConditionalStack cstack,
63 : : PQExpBuffer query_buf,
64 : : PQExpBuffer previous_buf);
65 : : static backslashResult exec_command_a(PsqlScanState scan_state, bool active_branch);
66 : : static backslashResult exec_command_bind(PsqlScanState scan_state, bool active_branch);
67 : : static backslashResult exec_command_C(PsqlScanState scan_state, bool active_branch);
68 : : static backslashResult exec_command_connect(PsqlScanState scan_state, bool active_branch);
69 : : static backslashResult exec_command_cd(PsqlScanState scan_state, bool active_branch,
70 : : const char *cmd);
71 : : static backslashResult exec_command_conninfo(PsqlScanState scan_state, bool active_branch);
72 : : static backslashResult exec_command_copy(PsqlScanState scan_state, bool active_branch);
73 : : static backslashResult exec_command_copyright(PsqlScanState scan_state, bool active_branch);
74 : : static backslashResult exec_command_crosstabview(PsqlScanState scan_state, bool active_branch);
75 : : static backslashResult exec_command_d(PsqlScanState scan_state, bool active_branch,
76 : : const char *cmd);
77 : : static bool exec_command_dfo(PsqlScanState scan_state, const char *cmd,
78 : : const char *pattern,
79 : : bool show_verbose, bool show_system);
80 : : static backslashResult exec_command_edit(PsqlScanState scan_state, bool active_branch,
81 : : PQExpBuffer query_buf, PQExpBuffer previous_buf);
82 : : static backslashResult exec_command_ef_ev(PsqlScanState scan_state, bool active_branch,
83 : : PQExpBuffer query_buf, bool is_func);
84 : : static backslashResult exec_command_echo(PsqlScanState scan_state, bool active_branch,
85 : : const char *cmd);
86 : : static backslashResult exec_command_elif(PsqlScanState scan_state, ConditionalStack cstack,
87 : : PQExpBuffer query_buf);
88 : : static backslashResult exec_command_else(PsqlScanState scan_state, ConditionalStack cstack,
89 : : PQExpBuffer query_buf);
90 : : static backslashResult exec_command_endif(PsqlScanState scan_state, ConditionalStack cstack,
91 : : PQExpBuffer query_buf);
92 : : static backslashResult exec_command_encoding(PsqlScanState scan_state, bool active_branch);
93 : : static backslashResult exec_command_errverbose(PsqlScanState scan_state, bool active_branch);
94 : : static backslashResult exec_command_f(PsqlScanState scan_state, bool active_branch);
95 : : static backslashResult exec_command_g(PsqlScanState scan_state, bool active_branch,
96 : : const char *cmd);
97 : : static backslashResult process_command_g_options(char *first_option,
98 : : PsqlScanState scan_state,
99 : : bool active_branch,
100 : : const char *cmd);
101 : : static backslashResult exec_command_gdesc(PsqlScanState scan_state, bool active_branch);
102 : : static backslashResult exec_command_getenv(PsqlScanState scan_state, bool active_branch,
103 : : const char *cmd);
104 : : static backslashResult exec_command_gexec(PsqlScanState scan_state, bool active_branch);
105 : : static backslashResult exec_command_gset(PsqlScanState scan_state, bool active_branch);
106 : : static backslashResult exec_command_help(PsqlScanState scan_state, bool active_branch);
107 : : static backslashResult exec_command_html(PsqlScanState scan_state, bool active_branch);
108 : : static backslashResult exec_command_include(PsqlScanState scan_state, bool active_branch,
109 : : const char *cmd);
110 : : static backslashResult exec_command_if(PsqlScanState scan_state, ConditionalStack cstack,
111 : : PQExpBuffer query_buf);
112 : : static backslashResult exec_command_list(PsqlScanState scan_state, bool active_branch,
113 : : const char *cmd);
114 : : static backslashResult exec_command_lo(PsqlScanState scan_state, bool active_branch,
115 : : const char *cmd);
116 : : static backslashResult exec_command_out(PsqlScanState scan_state, bool active_branch);
117 : : static backslashResult exec_command_print(PsqlScanState scan_state, bool active_branch,
118 : : PQExpBuffer query_buf, PQExpBuffer previous_buf);
119 : : static backslashResult exec_command_password(PsqlScanState scan_state, bool active_branch);
120 : : static backslashResult exec_command_prompt(PsqlScanState scan_state, bool active_branch,
121 : : const char *cmd);
122 : : static backslashResult exec_command_pset(PsqlScanState scan_state, bool active_branch);
123 : : static backslashResult exec_command_quit(PsqlScanState scan_state, bool active_branch);
124 : : static backslashResult exec_command_reset(PsqlScanState scan_state, bool active_branch,
125 : : PQExpBuffer query_buf);
126 : : static backslashResult exec_command_s(PsqlScanState scan_state, bool active_branch);
127 : : static backslashResult exec_command_set(PsqlScanState scan_state, bool active_branch);
128 : : static backslashResult exec_command_setenv(PsqlScanState scan_state, bool active_branch,
129 : : const char *cmd);
130 : : static backslashResult exec_command_sf_sv(PsqlScanState scan_state, bool active_branch,
131 : : const char *cmd, bool is_func);
132 : : static backslashResult exec_command_t(PsqlScanState scan_state, bool active_branch);
133 : : static backslashResult exec_command_T(PsqlScanState scan_state, bool active_branch);
134 : : static backslashResult exec_command_timing(PsqlScanState scan_state, bool active_branch);
135 : : static backslashResult exec_command_unset(PsqlScanState scan_state, bool active_branch,
136 : : const char *cmd);
137 : : static backslashResult exec_command_write(PsqlScanState scan_state, bool active_branch,
138 : : const char *cmd,
139 : : PQExpBuffer query_buf, PQExpBuffer previous_buf);
140 : : static backslashResult exec_command_watch(PsqlScanState scan_state, bool active_branch,
141 : : PQExpBuffer query_buf, PQExpBuffer previous_buf);
142 : : static backslashResult exec_command_x(PsqlScanState scan_state, bool active_branch);
143 : : static backslashResult exec_command_z(PsqlScanState scan_state, bool active_branch,
144 : : const char *cmd);
145 : : static backslashResult exec_command_shell_escape(PsqlScanState scan_state, bool active_branch);
146 : : static backslashResult exec_command_slash_command_help(PsqlScanState scan_state, bool active_branch);
147 : : static char *read_connect_arg(PsqlScanState scan_state);
148 : : static PQExpBuffer gather_boolean_expression(PsqlScanState scan_state);
149 : : static bool is_true_boolean_expression(PsqlScanState scan_state, const char *name);
150 : : static void ignore_boolean_expression(PsqlScanState scan_state);
151 : : static void ignore_slash_options(PsqlScanState scan_state);
152 : : static void ignore_slash_filepipe(PsqlScanState scan_state);
153 : : static void ignore_slash_whole_line(PsqlScanState scan_state);
154 : : static bool is_branching_command(const char *cmd);
155 : : static void save_query_text_state(PsqlScanState scan_state, ConditionalStack cstack,
156 : : PQExpBuffer query_buf);
157 : : static void discard_query_text(PsqlScanState scan_state, ConditionalStack cstack,
158 : : PQExpBuffer query_buf);
159 : : static bool copy_previous_query(PQExpBuffer query_buf, PQExpBuffer previous_buf);
160 : : static bool do_connect(enum trivalue reuse_previous_specification,
161 : : char *dbname, char *user, char *host, char *port);
162 : : static void wait_until_connected(PGconn *conn);
163 : : static bool do_edit(const char *filename_arg, PQExpBuffer query_buf,
164 : : int lineno, bool discard_on_quit, bool *edited);
165 : : static bool do_shell(const char *command);
166 : : static bool do_watch(PQExpBuffer query_buf, double sleep, int iter, int min_rows);
167 : : static bool lookup_object_oid(EditableObjectType obj_type, const char *desc,
168 : : Oid *obj_oid);
169 : : static bool get_create_object_cmd(EditableObjectType obj_type, Oid oid,
170 : : PQExpBuffer buf);
171 : : static int strip_lineno_from_objdesc(char *obj);
172 : : static int count_lines_in_buf(PQExpBuffer buf);
173 : : static void print_with_linenumbers(FILE *output, char *lines, bool is_func);
174 : : static void minimal_error_message(PGresult *res);
175 : :
176 : : static void printSSLInfo(void);
177 : : static void printGSSInfo(void);
178 : : static bool printPsetInfo(const char *param, printQueryOpt *popt);
179 : : static char *pset_value_string(const char *param, printQueryOpt *popt);
180 : :
181 : : #ifdef WIN32
182 : : static void checkWin32Codepage(void);
183 : : #endif
184 : :
185 : :
186 : :
187 : : /*----------
188 : : * HandleSlashCmds:
189 : : *
190 : : * Handles all the different commands that start with '\'.
191 : : * Ordinarily called by MainLoop().
192 : : *
193 : : * scan_state is a lexer working state that is set to continue scanning
194 : : * just after the '\'. The lexer is advanced past the command and all
195 : : * arguments on return.
196 : : *
197 : : * cstack is the current \if stack state. This will be examined, and
198 : : * possibly modified by conditional commands.
199 : : *
200 : : * query_buf contains the query-so-far, which may be modified by
201 : : * execution of the backslash command (for example, \r clears it).
202 : : *
203 : : * previous_buf contains the query most recently sent to the server
204 : : * (empty if none yet). This should not be modified here, but some
205 : : * commands copy its content into query_buf.
206 : : *
207 : : * query_buf and previous_buf will be NULL when executing a "-c"
208 : : * command-line option.
209 : : *
210 : : * Returns a status code indicating what action is desired, see command.h.
211 : : *----------
212 : : */
213 : :
214 : : backslashResult
7360 tgl@sss.pgh.pa.us 215 :CBC 6598 : HandleSlashCmds(PsqlScanState scan_state,
216 : : ConditionalStack cstack,
217 : : PQExpBuffer query_buf,
218 : : PQExpBuffer previous_buf)
219 : : {
220 : : backslashResult status;
221 : : char *cmd;
222 : : char *arg;
223 : :
4139 andrew@dunslane.net 224 [ - + ]: 6598 : Assert(scan_state != NULL);
2572 tgl@sss.pgh.pa.us 225 [ - + ]: 6598 : Assert(cstack != NULL);
226 : :
227 : : /* Parse off the command name */
7360 228 : 6598 : cmd = psql_scan_slash_command(scan_state);
229 : :
230 : : /* And try to execute it */
2572 231 : 6598 : status = exec_command(cmd, scan_state, cstack, query_buf, previous_buf);
232 : :
6692 peter_e@gmx.net 233 [ + + ]: 6597 : if (status == PSQL_CMD_UNKNOWN)
234 : : {
1840 peter@eisentraut.org 235 : 9 : pg_log_error("invalid command \\%s", cmd);
8768 bruce@momjian.us 236 [ - + ]: 9 : if (pset.cur_cmd_interactive)
737 tgl@sss.pgh.pa.us 237 :UBC 0 : pg_log_error_hint("Try \\? for help.");
6692 peter_e@gmx.net 238 :CBC 9 : status = PSQL_CMD_ERROR;
239 : : }
240 : :
241 [ + + ]: 6597 : if (status != PSQL_CMD_ERROR)
242 : : {
243 : : /*
244 : : * Eat any remaining arguments after a valid command. We want to
245 : : * suppress evaluation of backticks in this situation, so transiently
246 : : * push an inactive conditional-stack entry.
247 : : */
2572 tgl@sss.pgh.pa.us 248 : 6067 : bool active_branch = conditional_active(cstack);
249 : :
250 : 6067 : conditional_stack_push(cstack, IFSTATE_IGNORED);
7056 251 [ + + ]: 6082 : while ((arg = psql_scan_slash_option(scan_state,
252 : : OT_NORMAL, NULL, false)))
253 : : {
2572 254 [ + - ]: 15 : if (active_branch)
1840 peter@eisentraut.org 255 : 15 : pg_log_warning("\\%s: extra argument \"%s\" ignored", cmd, arg);
7056 tgl@sss.pgh.pa.us 256 : 15 : free(arg);
257 : : }
2572 258 : 6067 : conditional_stack_pop(cstack);
259 : : }
260 : : else
261 : : {
262 : : /* silently throw away rest of line after an erroneous command */
7056 263 [ + + ]: 533 : while ((arg = psql_scan_slash_option(scan_state,
264 : : OT_WHOLE_LINE, NULL, false)))
265 : 3 : free(arg);
266 : : }
267 : :
268 : : /* if there is a trailing \\, swallow it */
7360 269 : 6597 : psql_scan_slash_command_end(scan_state);
270 : :
271 : 6597 : free(cmd);
272 : :
273 : : /* some commands write to queryFout, so make sure output is sent */
6317 274 : 6597 : fflush(pset.queryFout);
275 : :
8928 bruce@momjian.us 276 : 6597 : return status;
277 : : }
278 : :
279 : :
280 : : /*
281 : : * Subroutine to actually try to execute a backslash command.
282 : : *
283 : : * The typical "success" result code is PSQL_CMD_SKIP_LINE, although some
284 : : * commands return something else. Failure result code is PSQL_CMD_ERROR,
285 : : * unless PSQL_CMD_UNKNOWN is more appropriate.
286 : : */
287 : : static backslashResult
2572 tgl@sss.pgh.pa.us 288 : 6598 : exec_command(const char *cmd,
289 : : PsqlScanState scan_state,
290 : : ConditionalStack cstack,
291 : : PQExpBuffer query_buf,
292 : : PQExpBuffer previous_buf)
293 : : {
294 : : backslashResult status;
295 : 6598 : bool active_branch = conditional_active(cstack);
296 : :
297 : : /*
298 : : * In interactive mode, warn when we're ignoring a command within a false
299 : : * \if-branch. But we continue on, so as to parse and discard the right
300 : : * amount of parameter text. Each individual backslash command subroutine
301 : : * is responsible for doing nothing after discarding appropriate
302 : : * arguments, if !active_branch.
303 : : */
304 [ + + - + ]: 6598 : if (pset.cur_cmd_interactive && !active_branch &&
2572 tgl@sss.pgh.pa.us 305 [ # # ]:UBC 0 : !is_branching_command(cmd))
306 : : {
1840 peter@eisentraut.org 307 : 0 : pg_log_warning("\\%s command ignored; use \\endif or Ctrl-C to exit current \\if block",
308 : : cmd);
309 : : }
310 : :
2572 tgl@sss.pgh.pa.us 311 [ + + ]:CBC 6598 : if (strcmp(cmd, "a") == 0)
312 : 21 : status = exec_command_a(scan_state, active_branch);
516 peter@eisentraut.org 313 [ + + ]: 6577 : else if (strcmp(cmd, "bind") == 0)
314 : 21 : status = exec_command_bind(scan_state, active_branch);
2572 tgl@sss.pgh.pa.us 315 [ + + ]: 6556 : else if (strcmp(cmd, "C") == 0)
316 : 3 : status = exec_command_C(scan_state, active_branch);
317 [ + + + + ]: 6553 : else if (strcmp(cmd, "c") == 0 || strcmp(cmd, "connect") == 0)
318 : 152 : status = exec_command_connect(scan_state, active_branch);
319 [ + + ]: 6401 : else if (strcmp(cmd, "cd") == 0)
320 : 3 : status = exec_command_cd(scan_state, active_branch, cmd);
321 [ + + ]: 6398 : else if (strcmp(cmd, "conninfo") == 0)
322 : 3 : status = exec_command_conninfo(scan_state, active_branch);
323 [ + + ]: 6395 : else if (pg_strcasecmp(cmd, "copy") == 0)
324 : 84 : status = exec_command_copy(scan_state, active_branch);
325 [ + + ]: 6311 : else if (strcmp(cmd, "copyright") == 0)
326 : 4 : status = exec_command_copyright(scan_state, active_branch);
327 [ + + ]: 6307 : else if (strcmp(cmd, "crosstabview") == 0)
328 : 69 : status = exec_command_crosstabview(scan_state, active_branch);
329 [ + + ]: 6238 : else if (cmd[0] == 'd')
330 : 3152 : status = exec_command_d(scan_state, active_branch, cmd);
331 [ + + - + ]: 3086 : else if (strcmp(cmd, "e") == 0 || strcmp(cmd, "edit") == 0)
332 : 3 : status = exec_command_edit(scan_state, active_branch,
333 : : query_buf, previous_buf);
334 [ + + ]: 3083 : else if (strcmp(cmd, "ef") == 0)
2412 335 : 3 : status = exec_command_ef_ev(scan_state, active_branch, query_buf, true);
2572 336 [ + + ]: 3080 : else if (strcmp(cmd, "ev") == 0)
2412 337 : 3 : status = exec_command_ef_ev(scan_state, active_branch, query_buf, false);
1745 338 [ + + + + ]: 3077 : else if (strcmp(cmd, "echo") == 0 || strcmp(cmd, "qecho") == 0 ||
339 [ + + ]: 2684 : strcmp(cmd, "warn") == 0)
2572 340 : 399 : status = exec_command_echo(scan_state, active_branch, cmd);
341 [ + + ]: 2678 : else if (strcmp(cmd, "elif") == 0)
342 : 24 : status = exec_command_elif(scan_state, cstack, query_buf);
343 [ + + ]: 2654 : else if (strcmp(cmd, "else") == 0)
344 : 66 : status = exec_command_else(scan_state, cstack, query_buf);
345 [ + + ]: 2588 : else if (strcmp(cmd, "endif") == 0)
346 : 86 : status = exec_command_endif(scan_state, cstack, query_buf);
347 [ + + ]: 2502 : else if (strcmp(cmd, "encoding") == 0)
348 : 3 : status = exec_command_encoding(scan_state, active_branch);
349 [ + + ]: 2499 : else if (strcmp(cmd, "errverbose") == 0)
350 : 7 : status = exec_command_errverbose(scan_state, active_branch);
351 [ + + ]: 2492 : else if (strcmp(cmd, "f") == 0)
352 : 3 : status = exec_command_f(scan_state, active_branch);
353 [ + + + + ]: 2489 : else if (strcmp(cmd, "g") == 0 || strcmp(cmd, "gx") == 0)
354 : 97 : status = exec_command_g(scan_state, active_branch, cmd);
2413 355 [ + + ]: 2392 : else if (strcmp(cmd, "gdesc") == 0)
356 : 34 : status = exec_command_gdesc(scan_state, active_branch);
846 357 [ + + ]: 2358 : else if (strcmp(cmd, "getenv") == 0)
358 : 138 : status = exec_command_getenv(scan_state, active_branch, cmd);
2572 359 [ + + ]: 2220 : else if (strcmp(cmd, "gexec") == 0)
360 : 25 : status = exec_command_gexec(scan_state, active_branch);
361 [ + + ]: 2195 : else if (strcmp(cmd, "gset") == 0)
362 : 332 : status = exec_command_gset(scan_state, active_branch);
363 [ + + + + ]: 1863 : else if (strcmp(cmd, "h") == 0 || strcmp(cmd, "help") == 0)
364 : 5 : status = exec_command_help(scan_state, active_branch);
365 [ + - + + ]: 1858 : else if (strcmp(cmd, "H") == 0 || strcmp(cmd, "html") == 0)
366 : 3 : status = exec_command_html(scan_state, active_branch);
367 [ + + + - ]: 1855 : else if (strcmp(cmd, "i") == 0 || strcmp(cmd, "include") == 0 ||
368 [ + + - + ]: 1852 : strcmp(cmd, "ir") == 0 || strcmp(cmd, "include_relative") == 0)
369 : 6 : status = exec_command_include(scan_state, active_branch, cmd);
370 [ + + ]: 1849 : else if (strcmp(cmd, "if") == 0)
371 : 89 : status = exec_command_if(scan_state, cstack, query_buf);
372 [ + + + - ]: 1760 : else if (strcmp(cmd, "l") == 0 || strcmp(cmd, "list") == 0 ||
373 [ + - - + ]: 1757 : strcmp(cmd, "l+") == 0 || strcmp(cmd, "list+") == 0)
374 : 3 : status = exec_command_list(scan_state, active_branch, cmd);
375 [ + + ]: 1757 : else if (strncmp(cmd, "lo_", 3) == 0)
376 : 31 : status = exec_command_lo(scan_state, active_branch, cmd);
377 [ + + - + ]: 1726 : else if (strcmp(cmd, "o") == 0 || strcmp(cmd, "out") == 0)
378 : 15 : status = exec_command_out(scan_state, active_branch);
379 [ + + - + ]: 1711 : else if (strcmp(cmd, "p") == 0 || strcmp(cmd, "print") == 0)
2569 380 : 21 : status = exec_command_print(scan_state, active_branch,
381 : : query_buf, previous_buf);
2572 382 [ + + ]: 1690 : else if (strcmp(cmd, "password") == 0)
383 : 4 : status = exec_command_password(scan_state, active_branch);
384 [ + + ]: 1686 : else if (strcmp(cmd, "prompt") == 0)
385 : 3 : status = exec_command_prompt(scan_state, active_branch, cmd);
386 [ + + ]: 1683 : else if (strcmp(cmd, "pset") == 0)
387 : 870 : status = exec_command_pset(scan_state, active_branch);
388 [ + + + + ]: 813 : else if (strcmp(cmd, "q") == 0 || strcmp(cmd, "quit") == 0)
389 : 62 : status = exec_command_quit(scan_state, active_branch);
390 [ + + + + ]: 751 : else if (strcmp(cmd, "r") == 0 || strcmp(cmd, "reset") == 0)
391 : 38 : status = exec_command_reset(scan_state, active_branch, query_buf);
392 [ + + ]: 713 : else if (strcmp(cmd, "s") == 0)
393 : 3 : status = exec_command_s(scan_state, active_branch);
394 [ + + ]: 710 : else if (strcmp(cmd, "set") == 0)
395 : 475 : status = exec_command_set(scan_state, active_branch);
396 [ + + ]: 235 : else if (strcmp(cmd, "setenv") == 0)
397 : 9 : status = exec_command_setenv(scan_state, active_branch, cmd);
398 [ + + + + ]: 226 : else if (strcmp(cmd, "sf") == 0 || strcmp(cmd, "sf+") == 0)
2412 399 : 29 : status = exec_command_sf_sv(scan_state, active_branch, cmd, true);
2572 400 [ + + - + ]: 197 : else if (strcmp(cmd, "sv") == 0 || strcmp(cmd, "sv+") == 0)
2412 401 : 51 : status = exec_command_sf_sv(scan_state, active_branch, cmd, false);
2572 402 [ + + ]: 146 : else if (strcmp(cmd, "t") == 0)
403 : 35 : status = exec_command_t(scan_state, active_branch);
404 [ + + ]: 111 : else if (strcmp(cmd, "T") == 0)
405 : 3 : status = exec_command_T(scan_state, active_branch);
406 [ + + ]: 108 : else if (strcmp(cmd, "timing") == 0)
407 : 5 : status = exec_command_timing(scan_state, active_branch);
408 [ + + ]: 103 : else if (strcmp(cmd, "unset") == 0)
409 : 19 : status = exec_command_unset(scan_state, active_branch, cmd);
410 [ + + - + ]: 84 : else if (strcmp(cmd, "w") == 0 || strcmp(cmd, "write") == 0)
411 : 6 : status = exec_command_write(scan_state, active_branch, cmd,
412 : : query_buf, previous_buf);
413 [ + + ]: 78 : else if (strcmp(cmd, "watch") == 0)
414 : 13 : status = exec_command_watch(scan_state, active_branch,
415 : : query_buf, previous_buf);
416 [ + + ]: 65 : else if (strcmp(cmd, "x") == 0)
417 : 38 : status = exec_command_x(scan_state, active_branch);
463 dean.a.rasheed@gmail 418 [ + + - + ]: 27 : else if (strcmp(cmd, "z") == 0 || strcmp(cmd, "zS") == 0)
419 : 12 : status = exec_command_z(scan_state, active_branch, cmd);
2572 tgl@sss.pgh.pa.us 420 [ + + ]: 15 : else if (strcmp(cmd, "!") == 0)
421 : 3 : status = exec_command_shell_escape(scan_state, active_branch);
422 [ + + ]: 12 : else if (strcmp(cmd, "?") == 0)
423 : 3 : status = exec_command_slash_command_help(scan_state, active_branch);
424 : : else
425 : 9 : status = PSQL_CMD_UNKNOWN;
426 : :
427 : : /*
428 : : * All the commands that return PSQL_CMD_SEND want to execute previous_buf
429 : : * if query_buf is empty. For convenience we implement that here, not in
430 : : * the individual command subroutines.
431 : : */
432 [ + + ]: 6597 : if (status == PSQL_CMD_SEND)
1107 433 : 539 : (void) copy_previous_query(query_buf, previous_buf);
434 : :
2572 435 : 6597 : return status;
436 : : }
437 : :
438 : :
439 : : /*
440 : : * \a -- toggle field alignment
441 : : *
442 : : * This makes little sense but we keep it around.
443 : : */
444 : : static backslashResult
445 : 21 : exec_command_a(PsqlScanState scan_state, bool active_branch)
446 : : {
447 : 21 : bool success = true;
448 : :
449 [ + + ]: 21 : if (active_branch)
450 : : {
8857 peter_e@gmx.net 451 [ + + ]: 18 : if (pset.popt.topt.format != PRINT_ALIGNED)
6438 tgl@sss.pgh.pa.us 452 : 9 : success = do_pset("format", "aligned", &pset.popt, pset.quiet);
453 : : else
454 : 9 : success = do_pset("format", "unaligned", &pset.popt, pset.quiet);
455 : : }
456 : :
2572 457 [ + - ]: 21 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
458 : : }
459 : :
460 : : /*
461 : : * \bind -- set query parameters
462 : : */
463 : : static backslashResult
516 peter@eisentraut.org 464 : 21 : exec_command_bind(PsqlScanState scan_state, bool active_branch)
465 : : {
466 : 21 : backslashResult status = PSQL_CMD_SKIP_LINE;
467 : :
468 [ + + ]: 21 : if (active_branch)
469 : : {
470 : : char *opt;
471 : 18 : int nparams = 0;
472 : 18 : int nalloc = 0;
473 : :
474 : 18 : pset.bind_params = NULL;
475 : :
476 [ + + ]: 30 : while ((opt = psql_scan_slash_option(scan_state, OT_NORMAL, NULL, false)))
477 : : {
478 : 12 : nparams++;
479 [ + - ]: 12 : if (nparams > nalloc)
480 : : {
481 [ + + ]: 12 : nalloc = nalloc ? nalloc * 2 : 1;
482 : 12 : pset.bind_params = pg_realloc_array(pset.bind_params, char *, nalloc);
483 : : }
417 michael@paquier.xyz 484 : 12 : pset.bind_params[nparams - 1] = opt;
485 : : }
486 : :
516 peter@eisentraut.org 487 : 18 : pset.bind_nparams = nparams;
488 : 18 : pset.bind_flag = true;
489 : : }
490 : : else
86 michael@paquier.xyz 491 :GNC 3 : ignore_slash_options(scan_state);
492 : :
516 peter@eisentraut.org 493 :CBC 21 : return status;
494 : : }
495 : :
496 : : /*
497 : : * \C -- override table title (formerly change HTML caption)
498 : : */
499 : : static backslashResult
2572 tgl@sss.pgh.pa.us 500 : 3 : exec_command_C(PsqlScanState scan_state, bool active_branch)
501 : : {
502 : 3 : bool success = true;
503 : :
504 [ - + ]: 3 : if (active_branch)
505 : : {
7360 tgl@sss.pgh.pa.us 506 :UBC 0 : char *opt = psql_scan_slash_option(scan_state,
507 : : OT_NORMAL, NULL, true);
508 : :
6438 509 : 0 : success = do_pset("title", opt, &pset.popt, pset.quiet);
8768 bruce@momjian.us 510 : 0 : free(opt);
511 : : }
512 : : else
2572 tgl@sss.pgh.pa.us 513 :CBC 3 : ignore_slash_options(scan_state);
514 : :
515 [ + - ]: 3 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
516 : : }
517 : :
518 : : /*
519 : : * \c or \connect -- connect to database using the specified parameters.
520 : : *
521 : : * \c [-reuse-previous=BOOL] dbname user host port
522 : : *
523 : : * Specifying a parameter as '-' is equivalent to omitting it. Examples:
524 : : *
525 : : * \c - - hst Connect to current database on current port of
526 : : * host "hst" as current user.
527 : : * \c - usr - prt Connect to current database on port "prt" of current host
528 : : * as user "usr".
529 : : * \c dbs Connect to database "dbs" on current port of current host
530 : : * as current user.
531 : : */
532 : : static backslashResult
533 : 152 : exec_command_connect(PsqlScanState scan_state, bool active_branch)
534 : : {
535 : 152 : bool success = true;
536 : :
537 [ + + ]: 152 : if (active_branch)
538 : : {
539 : : static const char prefix[] = "-reuse-previous=";
540 : : char *opt1,
541 : : *opt2,
542 : : *opt3,
543 : : *opt4;
2631 544 : 149 : enum trivalue reuse_previous = TRI_DEFAULT;
545 : :
6587 neilc@samurai.com 546 : 149 : opt1 = read_connect_arg(scan_state);
2806 noah@leadboat.com 547 [ + + + + ]: 149 : if (opt1 != NULL && strncmp(opt1, prefix, sizeof(prefix) - 1) == 0)
548 : : {
549 : : bool on_off;
550 : :
2631 tgl@sss.pgh.pa.us 551 : 8 : success = ParseVariableBool(opt1 + sizeof(prefix) - 1,
552 : : "-reuse-previous",
553 : : &on_off);
554 [ + - ]: 8 : if (success)
555 : : {
556 [ + - ]: 8 : reuse_previous = on_off ? TRI_YES : TRI_NO;
557 : 8 : free(opt1);
558 : 8 : opt1 = read_connect_arg(scan_state);
559 : : }
560 : : }
561 : :
562 [ + - ]: 149 : if (success) /* give up if reuse_previous was invalid */
563 : : {
564 : 149 : opt2 = read_connect_arg(scan_state);
565 : 149 : opt3 = read_connect_arg(scan_state);
566 : 149 : opt4 = read_connect_arg(scan_state);
567 : :
568 : 149 : success = do_connect(reuse_previous, opt1, opt2, opt3, opt4);
569 : :
570 : 149 : free(opt2);
571 : 149 : free(opt3);
572 : 149 : free(opt4);
573 : : }
8768 bruce@momjian.us 574 : 149 : free(opt1);
575 : : }
576 : : else
2572 tgl@sss.pgh.pa.us 577 : 3 : ignore_slash_options(scan_state);
578 : :
579 [ + - ]: 152 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
580 : : }
581 : :
582 : : /*
583 : : * \cd -- change directory
584 : : */
585 : : static backslashResult
586 : 3 : exec_command_cd(PsqlScanState scan_state, bool active_branch, const char *cmd)
587 : : {
588 : 3 : bool success = true;
589 : :
590 [ - + ]: 3 : if (active_branch)
591 : : {
7360 tgl@sss.pgh.pa.us 592 :UBC 0 : char *opt = psql_scan_slash_option(scan_state,
593 : : OT_NORMAL, NULL, true);
594 : : char *dir;
595 : :
8378 peter_e@gmx.net 596 [ # # ]: 0 : if (opt)
597 : 0 : dir = opt;
598 : : else
599 : : {
600 : : #ifndef WIN32
601 : : /* This should match get_home_path() */
826 tgl@sss.pgh.pa.us 602 : 0 : dir = getenv("HOME");
603 [ # # # # ]: 0 : if (dir == NULL || dir[0] == '\0')
604 : : {
605 : 0 : uid_t user_id = geteuid();
606 : : struct passwd *pw;
607 : :
608 : 0 : errno = 0; /* clear errno before call */
609 : 0 : pw = getpwuid(user_id);
610 [ # # ]: 0 : if (pw)
611 : 0 : dir = pw->pw_dir;
612 : : else
613 : : {
614 [ # # ]: 0 : pg_log_error("could not get home directory for user ID %ld: %s",
615 : : (long) user_id,
616 : : errno ? strerror(errno) : _("user does not exist"));
617 : 0 : success = false;
618 : : }
619 : : }
620 : : #else /* WIN32 */
621 : :
622 : : /*
623 : : * On Windows, 'cd' without arguments prints the current
624 : : * directory, so if someone wants to code this here instead...
625 : : */
626 : : dir = "/";
627 : : #endif /* WIN32 */
628 : : }
629 : :
630 [ # # # # ]: 0 : if (success &&
631 : 0 : chdir(dir) < 0)
632 : : {
1840 peter@eisentraut.org 633 : 0 : pg_log_error("\\%s: could not change directory to \"%s\": %m",
634 : : cmd, dir);
8378 peter_e@gmx.net 635 : 0 : success = false;
636 : : }
637 : :
668 peter@eisentraut.org 638 : 0 : free(opt);
639 : : }
640 : : else
2572 tgl@sss.pgh.pa.us 641 :CBC 3 : ignore_slash_options(scan_state);
642 : :
643 [ + - ]: 3 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
644 : : }
645 : :
646 : : /*
647 : : * \conninfo -- display information about the current connection
648 : : */
649 : : static backslashResult
650 : 3 : exec_command_conninfo(PsqlScanState scan_state, bool active_branch)
651 : : {
652 [ - + ]: 3 : if (active_branch)
653 : : {
5017 rhaas@postgresql.org 654 :UBC 0 : char *db = PQdb(pset.db);
655 : :
5014 656 [ # # ]: 0 : if (db == NULL)
4711 peter_e@gmx.net 657 : 0 : printf(_("You are currently not connected to a database.\n"));
658 : : else
659 : : {
2081 tgl@sss.pgh.pa.us 660 : 0 : char *host = PQhost(pset.db);
1973 alvherre@alvh.no-ip. 661 : 0 : char *hostaddr = PQhostaddr(pset.db);
662 : :
1236 peter@eisentraut.org 663 [ # # ]: 0 : if (is_unixsock_path(host))
664 : : {
665 : : /* hostaddr overrides host */
1973 alvherre@alvh.no-ip. 666 [ # # # # ]: 0 : if (hostaddr && *hostaddr)
667 : 0 : printf(_("You are connected to database \"%s\" as user \"%s\" on address \"%s\" at port \"%s\".\n"),
668 : : db, PQuser(pset.db), hostaddr, PQport(pset.db));
669 : : else
670 : 0 : printf(_("You are connected to database \"%s\" as user \"%s\" via socket in \"%s\" at port \"%s\".\n"),
671 : : db, PQuser(pset.db), host, PQport(pset.db));
672 : : }
673 : : else
674 : : {
675 [ # # # # : 0 : if (hostaddr && *hostaddr && strcmp(host, hostaddr) != 0)
# # ]
676 : 0 : printf(_("You are connected to database \"%s\" as user \"%s\" on host \"%s\" (address \"%s\") at port \"%s\".\n"),
677 : : db, PQuser(pset.db), host, hostaddr, PQport(pset.db));
678 : : else
679 : 0 : printf(_("You are connected to database \"%s\" as user \"%s\" on host \"%s\" at port \"%s\".\n"),
680 : : db, PQuser(pset.db), host, PQport(pset.db));
681 : : }
4322 rhaas@postgresql.org 682 : 0 : printSSLInfo();
1838 sfrost@snowman.net 683 : 0 : printGSSInfo();
684 : : }
685 : : }
686 : :
2572 tgl@sss.pgh.pa.us 687 :CBC 3 : return PSQL_CMD_SKIP_LINE;
688 : : }
689 : :
690 : : /*
691 : : * \copy -- run a COPY command
692 : : */
693 : : static backslashResult
694 : 84 : exec_command_copy(PsqlScanState scan_state, bool active_branch)
695 : : {
696 : 84 : bool success = true;
697 : :
698 [ + + ]: 84 : if (active_branch)
699 : : {
7360 700 : 81 : char *opt = psql_scan_slash_option(scan_state,
701 : : OT_WHOLE_LINE, NULL, false);
702 : :
703 : 81 : success = do_copy(opt);
704 : 81 : free(opt);
705 : : }
706 : : else
2572 707 : 3 : ignore_slash_whole_line(scan_state);
708 : :
709 [ + + ]: 84 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
710 : : }
711 : :
712 : : /*
713 : : * \copyright -- print copyright notice
714 : : */
715 : : static backslashResult
716 : 4 : exec_command_copyright(PsqlScanState scan_state, bool active_branch)
717 : : {
718 [ + + ]: 4 : if (active_branch)
8928 bruce@momjian.us 719 : 1 : print_copyright();
720 : :
2572 tgl@sss.pgh.pa.us 721 : 4 : return PSQL_CMD_SKIP_LINE;
722 : : }
723 : :
724 : : /*
725 : : * \crosstabview -- execute a query and display result in crosstab
726 : : */
727 : : static backslashResult
728 : 69 : exec_command_crosstabview(PsqlScanState scan_state, bool active_branch)
729 : : {
730 : 69 : backslashResult status = PSQL_CMD_SKIP_LINE;
731 : :
732 [ + + ]: 69 : if (active_branch)
733 : : {
734 : : int i;
735 : :
2922 736 [ + + ]: 330 : for (i = 0; i < lengthof(pset.ctv_args); i++)
737 : 264 : pset.ctv_args[i] = psql_scan_slash_option(scan_state,
738 : : OT_NORMAL, NULL, true);
2928 alvherre@alvh.no-ip. 739 : 66 : pset.crosstab_flag = true;
740 : 66 : status = PSQL_CMD_SEND;
741 : : }
742 : : else
2572 tgl@sss.pgh.pa.us 743 : 3 : ignore_slash_options(scan_state);
744 : :
745 : 69 : return status;
746 : : }
747 : :
748 : : /*
749 : : * \d* commands
750 : : */
751 : : static backslashResult
752 : 3152 : exec_command_d(PsqlScanState scan_state, bool active_branch, const char *cmd)
753 : : {
754 : 3152 : backslashResult status = PSQL_CMD_SKIP_LINE;
755 : 3152 : bool success = true;
756 : :
757 [ + + ]: 3152 : if (active_branch)
758 : : {
759 : : char *pattern;
760 : : bool show_verbose,
761 : : show_system;
762 : :
763 : : /* We don't do SQLID reduction on the pattern yet */
7360 764 : 3149 : pattern = psql_scan_slash_option(scan_state,
765 : : OT_NORMAL, NULL, true);
766 : :
8768 bruce@momjian.us 767 : 3149 : show_verbose = strchr(cmd, '+') ? true : false;
5563 768 : 3149 : show_system = strchr(cmd, 'S') ? true : false;
769 : :
8928 770 [ + + + + : 3149 : switch (cmd[1])
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + - ]
771 : : {
772 : 1792 : case '\0':
773 : : case '+':
774 : : case 'S':
7918 tgl@sss.pgh.pa.us 775 [ + + ]: 1792 : if (pattern)
5563 bruce@momjian.us 776 : 1786 : success = describeTableDetails(pattern, show_verbose, show_system);
777 : : else
778 : : /* standard listing of interesting things */
4060 kgrittn@postgresql.o 779 : 6 : success = listTables("tvmsE", NULL, show_verbose, show_system);
8928 bruce@momjian.us 780 : 1792 : break;
2868 alvherre@alvh.no-ip. 781 : 108 : case 'A':
782 : : {
1498 akorotkov@postgresql 783 : 108 : char *pattern2 = NULL;
784 : :
785 [ + + + + : 108 : if (pattern && cmd[2] != '\0' && cmd[2] != '+')
+ + ]
786 : 69 : pattern2 = psql_scan_slash_option(scan_state, OT_NORMAL, NULL, true);
787 : :
788 [ + + + + : 108 : switch (cmd[2])
+ - ]
789 : : {
790 : 39 : case '\0':
791 : : case '+':
792 : 39 : success = describeAccessMethods(pattern, show_verbose);
793 : 39 : break;
794 : 15 : case 'c':
795 : 15 : success = listOperatorClasses(pattern, pattern2, show_verbose);
796 : 15 : break;
797 : 18 : case 'f':
798 : 18 : success = listOperatorFamilies(pattern, pattern2, show_verbose);
799 : 18 : break;
800 : 18 : case 'o':
801 : 18 : success = listOpFamilyOperators(pattern, pattern2, show_verbose);
802 : 18 : break;
803 : 18 : case 'p':
1373 804 : 18 : success = listOpFamilyFunctions(pattern, pattern2, show_verbose);
1498 805 : 18 : break;
1498 akorotkov@postgresql 806 :UBC 0 : default:
807 : 0 : status = PSQL_CMD_UNKNOWN;
808 : 0 : break;
809 : : }
810 : :
668 peter@eisentraut.org 811 :CBC 108 : free(pattern2);
812 : : }
2868 alvherre@alvh.no-ip. 813 : 108 : break;
8928 bruce@momjian.us 814 : 24 : case 'a':
5577 815 : 24 : success = describeAggregates(pattern, show_verbose, show_system);
8928 816 : 24 : break;
7240 tgl@sss.pgh.pa.us 817 : 12 : case 'b':
7213 bruce@momjian.us 818 : 12 : success = describeTablespaces(pattern, show_verbose);
7240 tgl@sss.pgh.pa.us 819 : 12 : break;
7768 820 : 27 : case 'c':
738 821 [ + + ]: 27 : if (strncmp(cmd, "dconfig", 7) == 0)
822 : 6 : success = describeConfigurationParameters(pattern,
823 : : show_verbose,
824 : : show_system);
825 : : else
826 : 21 : success = listConversions(pattern,
827 : : show_verbose,
828 : : show_system);
7768 829 : 27 : break;
830 : 21 : case 'C':
4637 rhaas@postgresql.org 831 : 21 : success = listCasts(pattern, show_verbose);
7768 tgl@sss.pgh.pa.us 832 : 21 : break;
8928 bruce@momjian.us 833 : 39 : case 'd':
5125 tgl@sss.pgh.pa.us 834 [ + + ]: 39 : if (strncmp(cmd, "ddp", 3) == 0)
5305 835 : 18 : success = listDefaultACLs(pattern);
836 : : else
837 : 21 : success = objectDescription(pattern, show_system);
8928 bruce@momjian.us 838 : 39 : break;
7768 tgl@sss.pgh.pa.us 839 : 24 : case 'D':
4633 rhaas@postgresql.org 840 : 24 : success = listDomains(pattern, show_verbose, show_system);
7768 tgl@sss.pgh.pa.us 841 : 24 : break;
5472 bruce@momjian.us 842 : 146 : case 'f': /* function subsystem */
843 [ + - ]: 146 : switch (cmd[2])
844 : : {
845 : 146 : case '\0':
846 : : case '+':
847 : : case 'S':
848 : : case 'a':
849 : : case 'n':
850 : : case 'p':
851 : : case 't':
852 : : case 'w':
1103 tgl@sss.pgh.pa.us 853 : 146 : success = exec_command_dfo(scan_state, cmd, pattern,
854 : : show_verbose, show_system);
5472 bruce@momjian.us 855 : 146 : break;
5472 bruce@momjian.us 856 :UBC 0 : default:
857 : 0 : status = PSQL_CMD_UNKNOWN;
858 : 0 : break;
859 : : }
8928 bruce@momjian.us 860 :CBC 146 : break;
7440 861 : 12 : case 'g':
862 : : /* no longer distinct from \du */
2928 sfrost@snowman.net 863 : 12 : success = describeRoles(pattern, show_verbose, show_system);
7440 bruce@momjian.us 864 : 12 : break;
8928 865 : 3 : case 'l':
829 tgl@sss.pgh.pa.us 866 : 3 : success = listLargeObjects(show_verbose);
8928 bruce@momjian.us 867 : 3 : break;
4833 rhaas@postgresql.org 868 : 15 : case 'L':
869 : 15 : success = listLanguages(pattern, show_verbose, show_system);
870 : 15 : break;
7768 tgl@sss.pgh.pa.us 871 : 12 : case 'n':
4908 872 : 12 : success = listSchemas(pattern, show_verbose, show_system);
7768 873 : 12 : break;
8928 bruce@momjian.us 874 : 31 : case 'o':
1103 tgl@sss.pgh.pa.us 875 : 31 : success = exec_command_dfo(scan_state, cmd, pattern,
876 : : show_verbose, show_system);
8928 bruce@momjian.us 877 : 31 : break;
4810 peter_e@gmx.net 878 : 21 : case 'O':
879 : 21 : success = listCollations(pattern, show_verbose, show_system);
880 : 21 : break;
8928 bruce@momjian.us 881 : 36 : case 'p':
463 dean.a.rasheed@gmail 882 : 36 : success = permissionsList(pattern, show_system);
8928 bruce@momjian.us 883 : 36 : break;
1834 alvherre@alvh.no-ip. 884 : 54 : case 'P':
885 : : {
886 [ + - ]: 54 : switch (cmd[2])
887 : : {
888 : 54 : case '\0':
889 : : case '+':
890 : : case 't':
891 : : case 'i':
892 : : case 'n':
893 : 54 : success = listPartitionedTables(&cmd[2], pattern, show_verbose);
894 : 54 : break;
1834 alvherre@alvh.no-ip. 895 :UBC 0 : default:
896 : 0 : status = PSQL_CMD_UNKNOWN;
897 : 0 : break;
898 : : }
899 : : }
1834 alvherre@alvh.no-ip. 900 :CBC 54 : break;
8928 bruce@momjian.us 901 : 34 : case 'T':
5577 902 : 34 : success = describeTypes(pattern, show_verbose, show_system);
8928 903 : 34 : break;
904 : 147 : case 't':
905 : : case 'v':
906 : : case 'm':
907 : : case 'i':
908 : : case 's':
909 : : case 'E':
5577 910 : 147 : success = listTables(&cmd[1], pattern, show_verbose, show_system);
8928 911 : 147 : break;
5303 alvherre@alvh.no-ip. 912 : 15 : case 'r':
913 [ + + + - ]: 15 : if (cmd[2] == 'd' && cmd[3] == 's')
914 : 12 : {
915 : 12 : char *pattern2 = NULL;
916 : :
917 [ + - ]: 12 : if (pattern)
918 : 12 : pattern2 = psql_scan_slash_option(scan_state,
919 : : OT_NORMAL, NULL, true);
920 : 12 : success = listDbRoleSettings(pattern, pattern2);
921 : :
668 peter@eisentraut.org 922 : 12 : free(pattern2);
923 : : }
270 tgl@sss.pgh.pa.us 924 [ + - ]: 3 : else if (cmd[2] == 'g')
925 : 3 : success = describeRoleGrants(pattern, show_system);
926 : : else
2572 tgl@sss.pgh.pa.us 927 :UBC 0 : status = PSQL_CMD_UNKNOWN;
5303 alvherre@alvh.no-ip. 928 :CBC 15 : break;
2642 peter_e@gmx.net 929 : 243 : case 'R':
930 [ + + - ]: 243 : switch (cmd[2])
931 : : {
932 : 168 : case 'p':
933 [ + + ]: 168 : if (show_verbose)
934 : 144 : success = describePublications(pattern);
935 : : else
936 : 24 : success = listPublications(pattern);
937 : 168 : break;
938 : 75 : case 's':
939 : 75 : success = describeSubscriptions(pattern, show_verbose);
940 : 75 : break;
2642 peter_e@gmx.net 941 :UBC 0 : default:
942 : 0 : status = PSQL_CMD_UNKNOWN;
943 : : }
2642 peter_e@gmx.net 944 :CBC 243 : break;
8376 bruce@momjian.us 945 : 3 : case 'u':
2928 sfrost@snowman.net 946 : 3 : success = describeRoles(pattern, show_verbose, show_system);
8207 bruce@momjian.us 947 : 3 : break;
6081 tgl@sss.pgh.pa.us 948 : 84 : case 'F': /* text search subsystem */
949 [ + + + + : 84 : switch (cmd[2])
- ]
950 : : {
951 : 21 : case '\0':
952 : : case '+':
953 : 21 : success = listTSConfigs(pattern, show_verbose);
954 : 21 : break;
955 : 21 : case 'p':
956 : 21 : success = listTSParsers(pattern, show_verbose);
957 : 21 : break;
958 : 21 : case 'd':
959 : 21 : success = listTSDictionaries(pattern, show_verbose);
960 : 21 : break;
961 : 21 : case 't':
962 : 21 : success = listTSTemplates(pattern, show_verbose);
963 : 21 : break;
6081 tgl@sss.pgh.pa.us 964 :UBC 0 : default:
965 : 0 : status = PSQL_CMD_UNKNOWN;
966 : 0 : break;
967 : : }
6081 tgl@sss.pgh.pa.us 968 :CBC 84 : break;
5595 peter_e@gmx.net 969 : 156 : case 'e': /* SQL/MED subsystem */
5421 bruce@momjian.us 970 [ + + + + : 156 : switch (cmd[2])
- ]
971 : : {
5595 peter_e@gmx.net 972 : 60 : case 's':
973 : 60 : success = listForeignServers(pattern, show_verbose);
974 : 60 : break;
975 : 30 : case 'u':
976 : 30 : success = listUserMappings(pattern, show_verbose);
977 : 30 : break;
978 : 57 : case 'w':
979 : 57 : success = listForeignDataWrappers(pattern, show_verbose);
980 : 57 : break;
4852 rhaas@postgresql.org 981 : 9 : case 't':
982 : 9 : success = listForeignTables(pattern, show_verbose);
983 : 9 : break;
5595 peter_e@gmx.net 984 :UBC 0 : default:
985 : 0 : status = PSQL_CMD_UNKNOWN;
986 : 0 : break;
987 : : }
5595 peter_e@gmx.net 988 :CBC 156 : break;
4753 bruce@momjian.us 989 : 27 : case 'x': /* Extensions */
4814 tgl@sss.pgh.pa.us 990 [ + + ]: 27 : if (show_verbose)
991 : 15 : success = listExtensionContents(pattern);
992 : : else
993 : 12 : success = listExtensions(pattern);
994 : 27 : break;
1180 tomas.vondra@postgre 995 : 51 : case 'X': /* Extended Statistics */
996 : 51 : success = listExtendedStats(pattern);
997 : 51 : break;
4288 rhaas@postgresql.org 998 : 12 : case 'y': /* Event Triggers */
999 : 12 : success = listEventTriggers(pattern, show_verbose);
1000 : 12 : break;
8928 bruce@momjian.us 1001 :UBC 0 : default:
6692 peter_e@gmx.net 1002 : 0 : status = PSQL_CMD_UNKNOWN;
1003 : : }
1004 : :
668 peter@eisentraut.org 1005 :CBC 3149 : free(pattern);
1006 : : }
1007 : : else
2572 tgl@sss.pgh.pa.us 1008 : 3 : ignore_slash_options(scan_state);
1009 : :
1010 [ + + ]: 3152 : if (!success)
1011 : 457 : status = PSQL_CMD_ERROR;
1012 : :
1013 : 3152 : return status;
1014 : : }
1015 : :
1016 : : /* \df and \do; messy enough to split out of exec_command_d */
1017 : : static bool
1103 1018 : 177 : exec_command_dfo(PsqlScanState scan_state, const char *cmd,
1019 : : const char *pattern,
1020 : : bool show_verbose, bool show_system)
1021 : : {
1022 : : bool success;
1023 : : char *arg_patterns[FUNC_MAX_ARGS];
1024 : 177 : int num_arg_patterns = 0;
1025 : :
1026 : : /* Collect argument-type patterns too */
1027 [ + + ]: 177 : if (pattern) /* otherwise it was just \df or \do */
1028 : : {
1029 : : char *ap;
1030 : :
1031 : 217 : while ((ap = psql_scan_slash_option(scan_state,
1032 [ + + ]: 217 : OT_NORMAL, NULL, true)) != NULL)
1033 : : {
1034 : 42 : arg_patterns[num_arg_patterns++] = ap;
1035 [ - + ]: 42 : if (num_arg_patterns >= FUNC_MAX_ARGS)
1103 tgl@sss.pgh.pa.us 1036 :UBC 0 : break; /* protect limited-size array */
1037 : : }
1038 : : }
1039 : :
1103 tgl@sss.pgh.pa.us 1040 [ + + ]:CBC 177 : if (cmd[1] == 'f')
1041 : 146 : success = describeFunctions(&cmd[2], pattern,
1042 : : arg_patterns, num_arg_patterns,
1043 : : show_verbose, show_system);
1044 : : else
1045 : 31 : success = describeOperators(pattern,
1046 : : arg_patterns, num_arg_patterns,
1047 : : show_verbose, show_system);
1048 : :
1049 [ + + ]: 219 : while (--num_arg_patterns >= 0)
1050 : 42 : free(arg_patterns[num_arg_patterns]);
1051 : :
1052 : 177 : return success;
1053 : : }
1054 : :
1055 : : /*
1056 : : * \e or \edit -- edit the current query buffer, or edit a file and
1057 : : * make it the query buffer
1058 : : */
1059 : : static backslashResult
2572 1060 : 3 : exec_command_edit(PsqlScanState scan_state, bool active_branch,
1061 : : PQExpBuffer query_buf, PQExpBuffer previous_buf)
1062 : : {
1063 : 3 : backslashResult status = PSQL_CMD_SKIP_LINE;
1064 : :
1065 [ - + ]: 3 : if (active_branch)
1066 : : {
8768 bruce@momjian.us 1067 [ # # ]:UBC 0 : if (!query_buf)
1068 : : {
1840 peter@eisentraut.org 1069 : 0 : pg_log_error("no query buffer");
6692 peter_e@gmx.net 1070 : 0 : status = PSQL_CMD_ERROR;
1071 : : }
1072 : : else
1073 : : {
1074 : : char *fname;
4994 tgl@sss.pgh.pa.us 1075 : 0 : char *ln = NULL;
1076 : 0 : int lineno = -1;
1077 : :
7360 1078 : 0 : fname = psql_scan_slash_option(scan_state,
1079 : : OT_NORMAL, NULL, true);
7184 1080 [ # # ]: 0 : if (fname)
1081 : : {
1082 : : /* try to get separate lineno arg */
4994 1083 : 0 : ln = psql_scan_slash_option(scan_state,
1084 : : OT_NORMAL, NULL, true);
1085 [ # # ]: 0 : if (ln == NULL)
1086 : : {
1087 : : /* only one arg; maybe it is lineno not fname */
1088 [ # # ]: 0 : if (fname[0] &&
1089 [ # # ]: 0 : strspn(fname, "0123456789") == strlen(fname))
1090 : : {
1091 : : /* all digits, so assume it is lineno */
1092 : 0 : ln = fname;
1093 : 0 : fname = NULL;
1094 : : }
1095 : : }
1096 : : }
1097 [ # # ]: 0 : if (ln)
1098 : : {
1099 : 0 : lineno = atoi(ln);
1100 [ # # ]: 0 : if (lineno < 1)
1101 : : {
1840 peter@eisentraut.org 1102 : 0 : pg_log_error("invalid line number: %s", ln);
4994 tgl@sss.pgh.pa.us 1103 : 0 : status = PSQL_CMD_ERROR;
1104 : : }
1105 : : }
1106 [ # # ]: 0 : if (status != PSQL_CMD_ERROR)
1107 : : {
1108 : : bool discard_on_quit;
1109 : :
1110 : 0 : expand_tilde(&fname);
1111 [ # # ]: 0 : if (fname)
1112 : : {
1113 : 0 : canonicalize_path(fname);
1114 : : /* Always clear buffer if the file isn't modified */
1107 1115 : 0 : discard_on_quit = true;
1116 : : }
1117 : : else
1118 : : {
1119 : : /*
1120 : : * If query_buf is empty, recall previous query for
1121 : : * editing. But in that case, the query buffer should be
1122 : : * emptied if editing doesn't modify the file.
1123 : : */
1124 : 0 : discard_on_quit = copy_previous_query(query_buf,
1125 : : previous_buf);
1126 : : }
1127 : :
1128 [ # # ]: 0 : if (do_edit(fname, query_buf, lineno, discard_on_quit, NULL))
4994 1129 : 0 : status = PSQL_CMD_NEWEDIT;
1130 : : else
1131 : 0 : status = PSQL_CMD_ERROR;
1132 : : }
1133 : :
1134 : : /*
1135 : : * On error while editing or if specifying an incorrect line
1136 : : * number, reset the query buffer.
1137 : : */
207 michael@paquier.xyz 1138 [ # # ]:UNC 0 : if (status == PSQL_CMD_ERROR)
1139 : 0 : resetPQExpBuffer(query_buf);
1140 : :
668 peter@eisentraut.org 1141 :UBC 0 : free(fname);
1142 : 0 : free(ln);
1143 : : }
1144 : : }
1145 : : else
2572 tgl@sss.pgh.pa.us 1146 :CBC 3 : ignore_slash_options(scan_state);
1147 : :
1148 : 3 : return status;
1149 : : }
1150 : :
1151 : : /*
1152 : : * \ef/\ev -- edit the named function/view, or
1153 : : * present a blank CREATE FUNCTION/VIEW template if no argument is given
1154 : : */
1155 : : static backslashResult
2412 1156 : 6 : exec_command_ef_ev(PsqlScanState scan_state, bool active_branch,
1157 : : PQExpBuffer query_buf, bool is_func)
1158 : : {
2572 1159 : 6 : backslashResult status = PSQL_CMD_SKIP_LINE;
1160 : :
1161 [ - + ]: 6 : if (active_branch)
1162 : : {
2412 tgl@sss.pgh.pa.us 1163 :UBC 0 : char *obj_desc = psql_scan_slash_option(scan_state,
1164 : : OT_WHOLE_LINE,
1165 : : NULL, true);
4994 1166 : 0 : int lineno = -1;
1167 : :
850 1168 [ # # ]: 0 : if (!query_buf)
1169 : : {
1840 peter@eisentraut.org 1170 : 0 : pg_log_error("no query buffer");
5699 tgl@sss.pgh.pa.us 1171 : 0 : status = PSQL_CMD_ERROR;
1172 : : }
1173 : : else
1174 : : {
2412 1175 : 0 : Oid obj_oid = InvalidOid;
1176 : 0 : EditableObjectType eot = is_func ? EditableFunction : EditableView;
1177 : :
1178 : 0 : lineno = strip_lineno_from_objdesc(obj_desc);
4994 1179 [ # # ]: 0 : if (lineno == 0)
1180 : : {
1181 : : /* error already reported */
1182 : 0 : status = PSQL_CMD_ERROR;
1183 : : }
2412 1184 [ # # ]: 0 : else if (!obj_desc)
1185 : : {
1186 : : /* set up an empty command to fill in */
1187 : 0 : resetPQExpBuffer(query_buf);
1188 [ # # ]: 0 : if (is_func)
1189 : 0 : appendPQExpBufferStr(query_buf,
1190 : : "CREATE FUNCTION ( )\n"
1191 : : " RETURNS \n"
1192 : : " LANGUAGE \n"
1193 : : " -- common options: IMMUTABLE STABLE STRICT SECURITY DEFINER\n"
1194 : : "AS $function$\n"
1195 : : "\n$function$\n");
1196 : : else
1197 : 0 : appendPQExpBufferStr(query_buf,
1198 : : "CREATE VIEW AS\n"
1199 : : " SELECT \n"
1200 : : " -- something...\n");
1201 : : }
1202 [ # # ]: 0 : else if (!lookup_object_oid(eot, obj_desc, &obj_oid))
1203 : : {
1204 : : /* error already reported */
5699 1205 : 0 : status = PSQL_CMD_ERROR;
1206 : : }
2412 1207 [ # # ]: 0 : else if (!get_create_object_cmd(eot, obj_oid, query_buf))
1208 : : {
1209 : : /* error already reported */
5699 1210 : 0 : status = PSQL_CMD_ERROR;
1211 : : }
2412 1212 [ # # # # ]: 0 : else if (is_func && lineno > 0)
1213 : : {
1214 : : /*
1215 : : * lineno "1" should correspond to the first line of the
1216 : : * function body. We expect that pg_get_functiondef() will
1217 : : * emit that on a line beginning with "AS ", "BEGIN ", or
1218 : : * "RETURN ", and that there can be no such line before the
1219 : : * real start of the function body. Increment lineno by the
1220 : : * number of lines before that line, so that it becomes
1221 : : * relative to the first line of the function definition.
1222 : : */
4994 1223 : 0 : const char *lines = query_buf->data;
1224 : :
1225 [ # # ]: 0 : while (*lines != '\0')
1226 : : {
499 1227 [ # # ]: 0 : if (strncmp(lines, "AS ", 3) == 0 ||
1228 [ # # ]: 0 : strncmp(lines, "BEGIN ", 6) == 0 ||
1229 [ # # ]: 0 : strncmp(lines, "RETURN ", 7) == 0)
1230 : : break;
4994 1231 : 0 : lineno++;
1232 : : /* find start of next line */
1233 : 0 : lines = strchr(lines, '\n');
1234 [ # # ]: 0 : if (!lines)
1235 : 0 : break;
1236 : 0 : lines++;
1237 : : }
1238 : : }
1239 : : }
1240 : :
5699 1241 [ # # ]: 0 : if (status != PSQL_CMD_ERROR)
1242 : : {
5421 bruce@momjian.us 1243 : 0 : bool edited = false;
1244 : :
1107 tgl@sss.pgh.pa.us 1245 [ # # ]: 0 : if (!do_edit(NULL, query_buf, lineno, true, &edited))
5699 1246 : 0 : status = PSQL_CMD_ERROR;
1247 [ # # ]: 0 : else if (!edited)
5499 peter_e@gmx.net 1248 : 0 : puts(_("No changes"));
1249 : : else
5699 tgl@sss.pgh.pa.us 1250 : 0 : status = PSQL_CMD_NEWEDIT;
1251 : : }
1252 : :
1253 : : /*
1254 : : * On error while doing object lookup or while editing, or if
1255 : : * specifying an incorrect line number, reset the query buffer.
1256 : : */
207 michael@paquier.xyz 1257 [ # # ]:UNC 0 : if (status == PSQL_CMD_ERROR)
1258 : 0 : resetPQExpBuffer(query_buf);
1259 : :
668 peter@eisentraut.org 1260 :UBC 0 : free(obj_desc);
1261 : : }
1262 : : else
2572 tgl@sss.pgh.pa.us 1263 :CBC 6 : ignore_slash_whole_line(scan_state);
1264 : :
1265 : 6 : return status;
1266 : : }
1267 : :
1268 : : /*
1269 : : * \echo, \qecho, and \warn -- echo arguments to stdout, query output, or stderr
1270 : : */
1271 : : static backslashResult
1272 : 399 : exec_command_echo(PsqlScanState scan_state, bool active_branch, const char *cmd)
1273 : : {
1274 [ + + ]: 399 : if (active_branch)
1275 : : {
1276 : : char *value;
1277 : : char quoted;
8768 bruce@momjian.us 1278 : 330 : bool no_newline = false;
1279 : 330 : bool first = true;
1280 : : FILE *fout;
1281 : :
1282 [ + + ]: 330 : if (strcmp(cmd, "qecho") == 0)
1283 : 6 : fout = pset.queryFout;
1745 tgl@sss.pgh.pa.us 1284 [ + + ]: 324 : else if (strcmp(cmd, "warn") == 0)
1285 : 6 : fout = stderr;
1286 : : else
8768 bruce@momjian.us 1287 : 318 : fout = stdout;
1288 : :
7360 tgl@sss.pgh.pa.us 1289 [ + + ]: 949 : while ((value = psql_scan_slash_option(scan_state,
1290 : : OT_NORMAL, "ed, false)))
1291 : : {
1745 1292 [ + + + + : 619 : if (first && !no_newline && !quoted && strcmp(value, "-n") == 0)
+ + + + ]
8768 bruce@momjian.us 1293 : 3 : no_newline = true;
1294 : : else
1295 : : {
1296 [ + + ]: 616 : if (first)
1297 : 330 : first = false;
1298 : : else
1299 : 286 : fputc(' ', fout);
1300 : 616 : fputs(value, fout);
1301 : : }
1302 : 619 : free(value);
1303 : : }
1304 [ + + ]: 330 : if (!no_newline)
1305 : 327 : fputs("\n", fout);
1306 : : }
1307 : : else
2572 tgl@sss.pgh.pa.us 1308 : 69 : ignore_slash_options(scan_state);
1309 : :
1310 : 399 : return PSQL_CMD_SKIP_LINE;
1311 : : }
1312 : :
1313 : : /*
1314 : : * \encoding -- set/show client side encoding
1315 : : */
1316 : : static backslashResult
1317 : 3 : exec_command_encoding(PsqlScanState scan_state, bool active_branch)
1318 : : {
1319 [ - + ]: 3 : if (active_branch)
1320 : : {
7360 tgl@sss.pgh.pa.us 1321 :UBC 0 : char *encoding = psql_scan_slash_option(scan_state,
1322 : : OT_NORMAL, NULL, false);
1323 : :
8768 bruce@momjian.us 1324 [ # # ]: 0 : if (!encoding)
1325 : : {
1326 : : /* show encoding */
8819 ishii@postgresql.org 1327 : 0 : puts(pg_encoding_to_char(pset.encoding));
1328 : : }
1329 : : else
1330 : : {
1331 : : /* set encoding */
1332 [ # # ]: 0 : if (PQsetClientEncoding(pset.db, encoding) == -1)
1840 peter@eisentraut.org 1333 : 0 : pg_log_error("%s: invalid encoding name or conversion procedure not found", encoding);
1334 : : else
1335 : : {
1336 : : /* save encoding info into psql internal data */
8819 ishii@postgresql.org 1337 : 0 : pset.encoding = PQclientEncoding(pset.db);
7596 tgl@sss.pgh.pa.us 1338 : 0 : pset.popt.topt.encoding = pset.encoding;
1339 : 0 : SetVariable(pset.vars, "ENCODING",
1340 : : pg_encoding_to_char(pset.encoding));
1341 : : }
8768 bruce@momjian.us 1342 : 0 : free(encoding);
1343 : : }
1344 : : }
1345 : : else
2572 tgl@sss.pgh.pa.us 1346 :CBC 3 : ignore_slash_options(scan_state);
1347 : :
1348 : 3 : return PSQL_CMD_SKIP_LINE;
1349 : : }
1350 : :
1351 : : /*
1352 : : * \errverbose -- display verbose message from last failed query
1353 : : */
1354 : : static backslashResult
1355 : 7 : exec_command_errverbose(PsqlScanState scan_state, bool active_branch)
1356 : : {
1357 [ + + ]: 7 : if (active_branch)
1358 : : {
2933 1359 [ + + ]: 4 : if (pset.last_error_result)
1360 : : {
1361 : : char *msg;
1362 : :
1363 : 3 : msg = PQresultVerboseErrorMessage(pset.last_error_result,
1364 : : PQERRORS_VERBOSE,
1365 : : PQSHOW_CONTEXT_ALWAYS);
1366 [ + - ]: 3 : if (msg)
1367 : : {
1840 peter@eisentraut.org 1368 : 3 : pg_log_error("%s", msg);
2933 tgl@sss.pgh.pa.us 1369 : 3 : PQfreemem(msg);
1370 : : }
1371 : : else
2933 tgl@sss.pgh.pa.us 1372 :UBC 0 : puts(_("out of memory"));
1373 : : }
1374 : : else
2885 peter_e@gmx.net 1375 :CBC 1 : puts(_("There is no previous error."));
1376 : : }
1377 : :
2572 tgl@sss.pgh.pa.us 1378 : 7 : return PSQL_CMD_SKIP_LINE;
1379 : : }
1380 : :
1381 : : /*
1382 : : * \f -- change field separator
1383 : : */
1384 : : static backslashResult
1385 : 3 : exec_command_f(PsqlScanState scan_state, bool active_branch)
1386 : : {
1387 : 3 : bool success = true;
1388 : :
1389 [ - + ]: 3 : if (active_branch)
1390 : : {
2572 tgl@sss.pgh.pa.us 1391 :UBC 0 : char *fname = psql_scan_slash_option(scan_state,
1392 : : OT_NORMAL, NULL, false);
1393 : :
1394 : 0 : success = do_pset("fieldsep", fname, &pset.popt, pset.quiet);
8768 bruce@momjian.us 1395 : 0 : free(fname);
1396 : : }
1397 : : else
2572 tgl@sss.pgh.pa.us 1398 :CBC 3 : ignore_slash_options(scan_state);
1399 : :
1400 [ + - ]: 3 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
1401 : : }
1402 : :
1403 : : /*
1404 : : * \g [(pset-option[=pset-value] ...)] [filename/shell-command]
1405 : : * \gx [(pset-option[=pset-value] ...)] [filename/shell-command]
1406 : : *
1407 : : * Send the current query. If pset options are specified, they are made
1408 : : * active just for this query. If a filename or pipe command is given,
1409 : : * the query output goes there. \gx implicitly sets "expanded=on" along
1410 : : * with any other pset options that are specified.
1411 : : */
1412 : : static backslashResult
1413 : 97 : exec_command_g(PsqlScanState scan_state, bool active_branch, const char *cmd)
1414 : : {
1415 : 97 : backslashResult status = PSQL_CMD_SKIP_LINE;
1416 : : char *fname;
1417 : :
1418 : : /*
1419 : : * Because the option processing for this is fairly complicated, we do it
1420 : : * and then decide whether the branch is active.
1421 : : */
1468 1422 : 97 : fname = psql_scan_slash_option(scan_state,
1423 : : OT_FILEPIPE, NULL, false);
1424 : :
1425 [ + + + + ]: 97 : if (fname && fname[0] == '(')
1426 : : {
1427 : : /* Consume pset options through trailing ')' ... */
1428 : 6 : status = process_command_g_options(fname + 1, scan_state,
1429 : : active_branch, cmd);
1430 : 6 : free(fname);
1431 : : /* ... and again attempt to scan the filename. */
1432 : 6 : fname = psql_scan_slash_option(scan_state,
1433 : : OT_FILEPIPE, NULL, false);
1434 : : }
1435 : :
1436 [ + - + + ]: 97 : if (status == PSQL_CMD_SKIP_LINE && active_branch)
1437 : : {
8833 peter_e@gmx.net 1438 [ + + ]: 88 : if (!fname)
8857 1439 : 72 : pset.gfname = NULL;
1440 : : else
1441 : : {
7401 bruce@momjian.us 1442 : 16 : expand_tilde(&fname);
7385 neilc@samurai.com 1443 : 16 : pset.gfname = pg_strdup(fname);
1444 : : }
2595 sfrost@snowman.net 1445 [ + + ]: 88 : if (strcmp(cmd, "gx") == 0)
1446 : : {
1447 : : /* save settings if not done already, then force expanded=on */
1468 tgl@sss.pgh.pa.us 1448 [ + + ]: 15 : if (pset.gsavepopt == NULL)
1449 : 12 : pset.gsavepopt = savePsetInfo(&pset.popt);
1450 : 15 : pset.popt.topt.expanded = 1;
1451 : : }
6692 peter_e@gmx.net 1452 : 88 : status = PSQL_CMD_SEND;
1453 : : }
1454 : :
1468 tgl@sss.pgh.pa.us 1455 : 97 : free(fname);
1456 : :
2572 1457 : 97 : return status;
1458 : : }
1459 : :
1460 : : /*
1461 : : * Process parenthesized pset options for \g
1462 : : *
1463 : : * Note: okay to modify first_option, but not to free it; caller does that
1464 : : */
1465 : : static backslashResult
1468 1466 : 6 : process_command_g_options(char *first_option, PsqlScanState scan_state,
1467 : : bool active_branch, const char *cmd)
1468 : : {
1469 : 6 : bool success = true;
1470 : 6 : bool found_r_paren = false;
1471 : :
1472 : : do
1473 : : {
1474 : : char *option;
1475 : : size_t optlen;
1476 : :
1477 : : /* If not first time through, collect a new option */
1478 [ + + ]: 9 : if (first_option)
1479 : 6 : option = first_option;
1480 : : else
1481 : : {
1482 : 3 : option = psql_scan_slash_option(scan_state,
1483 : : OT_NORMAL, NULL, false);
1484 [ - + ]: 3 : if (!option)
1485 : : {
1468 tgl@sss.pgh.pa.us 1486 [ # # ]:UBC 0 : if (active_branch)
1487 : : {
1488 : 0 : pg_log_error("\\%s: missing right parenthesis", cmd);
1489 : 0 : success = false;
1490 : : }
1491 : 0 : break;
1492 : : }
1493 : : }
1494 : :
1495 : : /* Check for terminating right paren, and remove it from string */
1468 tgl@sss.pgh.pa.us 1496 :CBC 9 : optlen = strlen(option);
1497 [ + - + + ]: 9 : if (optlen > 0 && option[optlen - 1] == ')')
1498 : : {
1499 : 6 : option[--optlen] = '\0';
1500 : 6 : found_r_paren = true;
1501 : : }
1502 : :
1503 : : /* If there was anything besides parentheses, parse/execute it */
1504 [ + - ]: 9 : if (optlen > 0)
1505 : : {
1506 : : /* We can have either "name" or "name=value" */
1507 : 9 : char *valptr = strchr(option, '=');
1508 : :
1509 [ + - ]: 9 : if (valptr)
1510 : 9 : *valptr++ = '\0';
1511 [ + - ]: 9 : if (active_branch)
1512 : : {
1513 : : /* save settings if not done already, then apply option */
1514 [ + + ]: 9 : if (pset.gsavepopt == NULL)
1515 : 6 : pset.gsavepopt = savePsetInfo(&pset.popt);
1516 : 9 : success &= do_pset(option, valptr, &pset.popt, true);
1517 : : }
1518 : : }
1519 : :
1520 : : /* Clean up after this option. We should not free first_option. */
1521 [ + + ]: 9 : if (first_option)
1522 : 6 : first_option = NULL;
1523 : : else
1524 : 3 : free(option);
1525 [ + + ]: 9 : } while (!found_r_paren);
1526 : :
1527 : : /* If we failed after already changing some options, undo side-effects */
1528 [ - + - - : 6 : if (!success && active_branch && pset.gsavepopt)
- - ]
1529 : : {
1468 tgl@sss.pgh.pa.us 1530 :UBC 0 : restorePsetInfo(&pset.popt, pset.gsavepopt);
1531 : 0 : pset.gsavepopt = NULL;
1532 : : }
1533 : :
1468 tgl@sss.pgh.pa.us 1534 [ + - ]:CBC 6 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
1535 : : }
1536 : :
1537 : : /*
1538 : : * \gdesc -- describe query result
1539 : : */
1540 : : static backslashResult
2413 1541 : 34 : exec_command_gdesc(PsqlScanState scan_state, bool active_branch)
1542 : : {
1543 : 34 : backslashResult status = PSQL_CMD_SKIP_LINE;
1544 : :
1545 [ + - ]: 34 : if (active_branch)
1546 : : {
1547 : 34 : pset.gdesc_flag = true;
1548 : 34 : status = PSQL_CMD_SEND;
1549 : : }
1550 : :
1551 : 34 : return status;
1552 : : }
1553 : :
1554 : : /*
1555 : : * \getenv -- set variable from environment variable
1556 : : */
1557 : : static backslashResult
846 1558 : 138 : exec_command_getenv(PsqlScanState scan_state, bool active_branch,
1559 : : const char *cmd)
1560 : : {
1561 : 138 : bool success = true;
1562 : :
1563 [ + - ]: 138 : if (active_branch)
1564 : : {
1565 : 138 : char *myvar = psql_scan_slash_option(scan_state,
1566 : : OT_NORMAL, NULL, false);
1567 : 138 : char *envvar = psql_scan_slash_option(scan_state,
1568 : : OT_NORMAL, NULL, false);
1569 : :
1570 [ + - - + ]: 138 : if (!myvar || !envvar)
1571 : : {
846 tgl@sss.pgh.pa.us 1572 :UBC 0 : pg_log_error("\\%s: missing required argument", cmd);
1573 : 0 : success = false;
1574 : : }
1575 : : else
1576 : : {
846 tgl@sss.pgh.pa.us 1577 :CBC 138 : char *envval = getenv(envvar);
1578 : :
1579 [ + + - + ]: 138 : if (envval && !SetVariable(pset.vars, myvar, envval))
846 tgl@sss.pgh.pa.us 1580 :UBC 0 : success = false;
1581 : : }
846 tgl@sss.pgh.pa.us 1582 :CBC 138 : free(myvar);
1583 : 138 : free(envvar);
1584 : : }
1585 : : else
846 tgl@sss.pgh.pa.us 1586 :UBC 0 : ignore_slash_options(scan_state);
1587 : :
846 tgl@sss.pgh.pa.us 1588 [ + - ]:CBC 138 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
1589 : : }
1590 : :
1591 : : /*
1592 : : * \gexec -- send query and execute each field of result
1593 : : */
1594 : : static backslashResult
2572 1595 : 25 : exec_command_gexec(PsqlScanState scan_state, bool active_branch)
1596 : : {
1597 : 25 : backslashResult status = PSQL_CMD_SKIP_LINE;
1598 : :
1599 [ + + ]: 25 : if (active_branch)
1600 : : {
2932 1601 : 22 : pset.gexec_flag = true;
1602 : 22 : status = PSQL_CMD_SEND;
1603 : : }
1604 : :
2572 1605 : 25 : return status;
1606 : : }
1607 : :
1608 : : /*
1609 : : * \gset [prefix] -- send query and store result into variables
1610 : : */
1611 : : static backslashResult
1612 : 332 : exec_command_gset(PsqlScanState scan_state, bool active_branch)
1613 : : {
1614 : 332 : backslashResult status = PSQL_CMD_SKIP_LINE;
1615 : :
1616 [ + + ]: 332 : if (active_branch)
1617 : : {
4089 1618 : 329 : char *prefix = psql_scan_slash_option(scan_state,
1619 : : OT_NORMAL, NULL, false);
1620 : :
1621 [ + + ]: 329 : if (prefix)
1622 : 42 : pset.gset_prefix = prefix;
1623 : : else
1624 : : {
1625 : : /* we must set a non-NULL prefix to trigger storing */
1626 : 287 : pset.gset_prefix = pg_strdup("");
1627 : : }
1628 : : /* gset_prefix is freed later */
1629 : 329 : status = PSQL_CMD_SEND;
1630 : : }
1631 : : else
2572 1632 : 3 : ignore_slash_options(scan_state);
1633 : :
1634 : 332 : return status;
1635 : : }
1636 : :
1637 : : /*
1638 : : * \help [topic] -- print help about SQL commands
1639 : : */
1640 : : static backslashResult
1641 : 5 : exec_command_help(PsqlScanState scan_state, bool active_branch)
1642 : : {
1643 [ + + ]: 5 : if (active_branch)
1644 : : {
7360 1645 : 2 : char *opt = psql_scan_slash_option(scan_state,
1646 : : OT_WHOLE_LINE, NULL, true);
1647 : :
1648 : 2 : helpSQL(opt, pset.popt.topt.pager);
1649 : 2 : free(opt);
1650 : : }
1651 : : else
2572 1652 : 3 : ignore_slash_whole_line(scan_state);
1653 : :
1654 : 5 : return PSQL_CMD_SKIP_LINE;
1655 : : }
1656 : :
1657 : : /*
1658 : : * \H and \html -- toggle HTML formatting
1659 : : */
1660 : : static backslashResult
1661 : 3 : exec_command_html(PsqlScanState scan_state, bool active_branch)
1662 : : {
1663 : 3 : bool success = true;
1664 : :
1665 [ - + ]: 3 : if (active_branch)
1666 : : {
8857 peter_e@gmx.net 1667 [ # # ]:UBC 0 : if (pset.popt.topt.format != PRINT_HTML)
6438 tgl@sss.pgh.pa.us 1668 : 0 : success = do_pset("format", "html", &pset.popt, pset.quiet);
1669 : : else
1670 : 0 : success = do_pset("format", "aligned", &pset.popt, pset.quiet);
1671 : : }
1672 : :
2572 tgl@sss.pgh.pa.us 1673 [ + - ]:CBC 3 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
1674 : : }
1675 : :
1676 : : /*
1677 : : * \i and \ir -- include a file
1678 : : */
1679 : : static backslashResult
1680 : 6 : exec_command_include(PsqlScanState scan_state, bool active_branch, const char *cmd)
1681 : : {
1682 : 6 : bool success = true;
1683 : :
1684 [ - + ]: 6 : if (active_branch)
1685 : : {
7360 tgl@sss.pgh.pa.us 1686 :UBC 0 : char *fname = psql_scan_slash_option(scan_state,
1687 : : OT_NORMAL, NULL, true);
1688 : :
8833 peter_e@gmx.net 1689 [ # # ]: 0 : if (!fname)
1690 : : {
1840 peter@eisentraut.org 1691 : 0 : pg_log_error("\\%s: missing required argument", cmd);
8928 bruce@momjian.us 1692 : 0 : success = false;
1693 : : }
1694 : : else
1695 : : {
1696 : : bool include_relative;
1697 : :
4666 rhaas@postgresql.org 1698 : 0 : include_relative = (strcmp(cmd, "ir") == 0
1699 [ # # # # ]: 0 : || strcmp(cmd, "include_relative") == 0);
7401 bruce@momjian.us 1700 : 0 : expand_tilde(&fname);
3050 rhaas@postgresql.org 1701 : 0 : success = (process_file(fname, include_relative) == EXIT_SUCCESS);
8768 bruce@momjian.us 1702 : 0 : free(fname);
1703 : : }
1704 : : }
1705 : : else
2572 tgl@sss.pgh.pa.us 1706 :CBC 6 : ignore_slash_options(scan_state);
1707 : :
1708 [ + - ]: 6 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
1709 : : }
1710 : :
1711 : : /*
1712 : : * \if <expr> -- beginning of an \if..\endif block
1713 : : *
1714 : : * <expr> is parsed as a boolean expression. Invalid expressions will emit a
1715 : : * warning and be treated as false. Statements that follow a false expression
1716 : : * will be parsed but ignored. Note that in the case where an \if statement
1717 : : * is itself within an inactive section of a block, then the entire inner
1718 : : * \if..\endif block will be parsed but ignored.
1719 : : */
1720 : : static backslashResult
1721 : 89 : exec_command_if(PsqlScanState scan_state, ConditionalStack cstack,
1722 : : PQExpBuffer query_buf)
1723 : : {
1724 [ + + ]: 89 : if (conditional_active(cstack))
1725 : : {
1726 : : /*
1727 : : * First, push a new active stack entry; this ensures that the lexer
1728 : : * will perform variable substitution and backtick evaluation while
1729 : : * scanning the expression. (That should happen anyway, since we know
1730 : : * we're in an active outer branch, but let's be sure.)
1731 : : */
1732 : 86 : conditional_stack_push(cstack, IFSTATE_TRUE);
1733 : :
1734 : : /* Remember current query state in case we need to restore later */
1735 : 86 : save_query_text_state(scan_state, cstack, query_buf);
1736 : :
1737 : : /*
1738 : : * Evaluate the expression; if it's false, change to inactive state.
1739 : : */
1740 [ + + ]: 86 : if (!is_true_boolean_expression(scan_state, "\\if expression"))
1741 : 50 : conditional_stack_poke(cstack, IFSTATE_FALSE);
1742 : : }
1743 : : else
1744 : : {
1745 : : /*
1746 : : * We're within an inactive outer branch, so this entire \if block
1747 : : * will be ignored. We don't want to evaluate the expression, so push
1748 : : * the "ignored" stack state before scanning it.
1749 : : */
1750 : 3 : conditional_stack_push(cstack, IFSTATE_IGNORED);
1751 : :
1752 : : /* Remember current query state in case we need to restore later */
1753 : 3 : save_query_text_state(scan_state, cstack, query_buf);
1754 : :
1755 : 3 : ignore_boolean_expression(scan_state);
1756 : : }
1757 : :
1758 : 89 : return PSQL_CMD_SKIP_LINE;
1759 : : }
1760 : :
1761 : : /*
1762 : : * \elif <expr> -- alternative branch in an \if..\endif block
1763 : : *
1764 : : * <expr> is evaluated the same as in \if <expr>.
1765 : : */
1766 : : static backslashResult
1767 : 24 : exec_command_elif(PsqlScanState scan_state, ConditionalStack cstack,
1768 : : PQExpBuffer query_buf)
1769 : : {
1770 : 24 : bool success = true;
1771 : :
1772 [ + + + + : 24 : switch (conditional_stack_peek(cstack))
+ - ]
1773 : : {
1774 : 3 : case IFSTATE_TRUE:
1775 : :
1776 : : /*
1777 : : * Just finished active branch of this \if block. Update saved
1778 : : * state so we will keep whatever data was put in query_buf by the
1779 : : * active branch.
1780 : : */
1781 : 3 : save_query_text_state(scan_state, cstack, query_buf);
1782 : :
1783 : : /*
1784 : : * Discard \elif expression and ignore the rest until \endif.
1785 : : * Switch state before reading expression to ensure proper lexer
1786 : : * behavior.
1787 : : */
1788 : 3 : conditional_stack_poke(cstack, IFSTATE_IGNORED);
1789 : 3 : ignore_boolean_expression(scan_state);
1790 : 3 : break;
1791 : 12 : case IFSTATE_FALSE:
1792 : :
1793 : : /*
1794 : : * Discard any query text added by the just-skipped branch.
1795 : : */
1796 : 12 : discard_query_text(scan_state, cstack, query_buf);
1797 : :
1798 : : /*
1799 : : * Have not yet found a true expression in this \if block, so this
1800 : : * might be the first. We have to change state before examining
1801 : : * the expression, or the lexer won't do the right thing.
1802 : : */
1803 : 12 : conditional_stack_poke(cstack, IFSTATE_TRUE);
1804 [ + + ]: 12 : if (!is_true_boolean_expression(scan_state, "\\elif expression"))
1805 : 9 : conditional_stack_poke(cstack, IFSTATE_FALSE);
1806 : 12 : break;
1807 : 3 : case IFSTATE_IGNORED:
1808 : :
1809 : : /*
1810 : : * Discard any query text added by the just-skipped branch.
1811 : : */
1812 : 3 : discard_query_text(scan_state, cstack, query_buf);
1813 : :
1814 : : /*
1815 : : * Skip expression and move on. Either the \if block already had
1816 : : * an active section, or whole block is being skipped.
1817 : : */
1818 : 3 : ignore_boolean_expression(scan_state);
1819 : 3 : break;
1820 : 3 : case IFSTATE_ELSE_TRUE:
1821 : : case IFSTATE_ELSE_FALSE:
1840 peter@eisentraut.org 1822 : 3 : pg_log_error("\\elif: cannot occur after \\else");
2572 tgl@sss.pgh.pa.us 1823 : 3 : success = false;
1824 : 3 : break;
1825 : 3 : case IFSTATE_NONE:
1826 : : /* no \if to elif from */
1840 peter@eisentraut.org 1827 : 3 : pg_log_error("\\elif: no matching \\if");
2572 tgl@sss.pgh.pa.us 1828 : 3 : success = false;
1829 : 3 : break;
1830 : : }
1831 : :
1832 [ + + ]: 24 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
1833 : : }
1834 : :
1835 : : /*
1836 : : * \else -- final alternative in an \if..\endif block
1837 : : *
1838 : : * Statements within an \else branch will only be executed if
1839 : : * all previous \if and \elif expressions evaluated to false
1840 : : * and the block was not itself being ignored.
1841 : : */
1842 : : static backslashResult
1843 : 66 : exec_command_else(PsqlScanState scan_state, ConditionalStack cstack,
1844 : : PQExpBuffer query_buf)
1845 : : {
1846 : 66 : bool success = true;
1847 : :
1848 [ + + + + : 66 : switch (conditional_stack_peek(cstack))
+ - ]
1849 : : {
1850 : 30 : case IFSTATE_TRUE:
1851 : :
1852 : : /*
1853 : : * Just finished active branch of this \if block. Update saved
1854 : : * state so we will keep whatever data was put in query_buf by the
1855 : : * active branch.
1856 : : */
1857 : 30 : save_query_text_state(scan_state, cstack, query_buf);
1858 : :
1859 : : /* Now skip the \else branch */
1860 : 30 : conditional_stack_poke(cstack, IFSTATE_ELSE_FALSE);
1861 : 30 : break;
1862 : 24 : case IFSTATE_FALSE:
1863 : :
1864 : : /*
1865 : : * Discard any query text added by the just-skipped branch.
1866 : : */
1867 : 24 : discard_query_text(scan_state, cstack, query_buf);
1868 : :
1869 : : /*
1870 : : * We've not found any true \if or \elif expression, so execute
1871 : : * the \else branch.
1872 : : */
1873 : 24 : conditional_stack_poke(cstack, IFSTATE_ELSE_TRUE);
1874 : 24 : break;
1875 : 6 : case IFSTATE_IGNORED:
1876 : :
1877 : : /*
1878 : : * Discard any query text added by the just-skipped branch.
1879 : : */
1880 : 6 : discard_query_text(scan_state, cstack, query_buf);
1881 : :
1882 : : /*
1883 : : * Either we previously processed the active branch of this \if,
1884 : : * or the whole \if block is being skipped. Either way, skip the
1885 : : * \else branch.
1886 : : */
1887 : 6 : conditional_stack_poke(cstack, IFSTATE_ELSE_FALSE);
1888 : 6 : break;
1889 : 3 : case IFSTATE_ELSE_TRUE:
1890 : : case IFSTATE_ELSE_FALSE:
1840 peter@eisentraut.org 1891 : 3 : pg_log_error("\\else: cannot occur after \\else");
2572 tgl@sss.pgh.pa.us 1892 : 3 : success = false;
1893 : 3 : break;
1894 : 3 : case IFSTATE_NONE:
1895 : : /* no \if to else from */
1840 peter@eisentraut.org 1896 : 3 : pg_log_error("\\else: no matching \\if");
2572 tgl@sss.pgh.pa.us 1897 : 3 : success = false;
1898 : 3 : break;
1899 : : }
1900 : :
1901 [ + + ]: 66 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
1902 : : }
1903 : :
1904 : : /*
1905 : : * \endif -- ends an \if...\endif block
1906 : : */
1907 : : static backslashResult
1908 : 86 : exec_command_endif(PsqlScanState scan_state, ConditionalStack cstack,
1909 : : PQExpBuffer query_buf)
1910 : : {
1911 : 86 : bool success = true;
1912 : :
1913 [ + + + - ]: 86 : switch (conditional_stack_peek(cstack))
1914 : : {
1915 : 24 : case IFSTATE_TRUE:
1916 : : case IFSTATE_ELSE_TRUE:
1917 : : /* Close the \if block, keeping the query text */
1918 : 24 : success = conditional_stack_pop(cstack);
1919 [ - + ]: 24 : Assert(success);
1920 : 24 : break;
1921 : 59 : case IFSTATE_FALSE:
1922 : : case IFSTATE_IGNORED:
1923 : : case IFSTATE_ELSE_FALSE:
1924 : :
1925 : : /*
1926 : : * Discard any query text added by the just-skipped branch.
1927 : : */
1928 : 59 : discard_query_text(scan_state, cstack, query_buf);
1929 : :
1930 : : /* Close the \if block */
1931 : 59 : success = conditional_stack_pop(cstack);
1932 [ - + ]: 59 : Assert(success);
1933 : 59 : break;
1934 : 3 : case IFSTATE_NONE:
1935 : : /* no \if to end */
1840 peter@eisentraut.org 1936 : 3 : pg_log_error("\\endif: no matching \\if");
2572 tgl@sss.pgh.pa.us 1937 : 3 : success = false;
1938 : 3 : break;
1939 : : }
1940 : :
1941 [ + + ]: 86 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
1942 : : }
1943 : :
1944 : : /*
1945 : : * \l -- list databases
1946 : : */
1947 : : static backslashResult
1948 : 3 : exec_command_list(PsqlScanState scan_state, bool active_branch, const char *cmd)
1949 : : {
1950 : 3 : bool success = true;
1951 : :
1952 [ - + ]: 3 : if (active_branch)
1953 : : {
1954 : : char *pattern;
1955 : : bool show_verbose;
1956 : :
4060 peter_e@gmx.net 1957 :UBC 0 : pattern = psql_scan_slash_option(scan_state,
1958 : : OT_NORMAL, NULL, true);
1959 : :
1960 : 0 : show_verbose = strchr(cmd, '+') ? true : false;
1961 : :
1962 : 0 : success = listAllDbs(pattern, show_verbose);
1963 : :
668 peter@eisentraut.org 1964 : 0 : free(pattern);
1965 : : }
1966 : : else
2572 tgl@sss.pgh.pa.us 1967 :CBC 3 : ignore_slash_options(scan_state);
1968 : :
1969 [ + - ]: 3 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
1970 : : }
1971 : :
1972 : : /*
1973 : : * \lo_* -- large object operations
1974 : : */
1975 : : static backslashResult
1976 : 31 : exec_command_lo(PsqlScanState scan_state, bool active_branch, const char *cmd)
1977 : : {
1978 : 31 : backslashResult status = PSQL_CMD_SKIP_LINE;
1979 : 31 : bool success = true;
1980 : :
1981 [ + + ]: 31 : if (active_branch)
1982 : : {
1983 : : char *opt1,
1984 : : *opt2;
1985 : :
7360 1986 : 28 : opt1 = psql_scan_slash_option(scan_state,
1987 : : OT_NORMAL, NULL, true);
1988 : 28 : opt2 = psql_scan_slash_option(scan_state,
1989 : : OT_NORMAL, NULL, true);
1990 : :
8928 bruce@momjian.us 1991 [ + + ]: 28 : if (strcmp(cmd + 3, "export") == 0)
1992 : : {
8833 peter_e@gmx.net 1993 [ - + ]: 3 : if (!opt2)
1994 : : {
1840 peter@eisentraut.org 1995 :UBC 0 : pg_log_error("\\%s: missing required argument", cmd);
8928 bruce@momjian.us 1996 : 0 : success = false;
1997 : : }
1998 : : else
1999 : : {
7401 bruce@momjian.us 2000 :CBC 3 : expand_tilde(&opt2);
8833 peter_e@gmx.net 2001 : 3 : success = do_lo_export(opt1, opt2);
2002 : : }
2003 : : }
2004 : :
8928 bruce@momjian.us 2005 [ + + ]: 25 : else if (strcmp(cmd + 3, "import") == 0)
2006 : : {
8833 peter_e@gmx.net 2007 [ - + ]: 7 : if (!opt1)
2008 : : {
1840 peter@eisentraut.org 2009 :UBC 0 : pg_log_error("\\%s: missing required argument", cmd);
8928 bruce@momjian.us 2010 : 0 : success = false;
2011 : : }
2012 : : else
2013 : : {
7401 bruce@momjian.us 2014 :CBC 7 : expand_tilde(&opt1);
8424 2015 : 7 : success = do_lo_import(opt1, opt2);
2016 : : }
2017 : : }
2018 : :
8928 2019 [ + + ]: 18 : else if (strcmp(cmd + 3, "list") == 0)
829 tgl@sss.pgh.pa.us 2020 : 3 : success = listLargeObjects(false);
2021 [ + + ]: 15 : else if (strcmp(cmd + 3, "list+") == 0)
2022 : 3 : success = listLargeObjects(true);
2023 : :
8928 bruce@momjian.us 2024 [ + - ]: 12 : else if (strcmp(cmd + 3, "unlink") == 0)
2025 : : {
8833 peter_e@gmx.net 2026 [ - + ]: 12 : if (!opt1)
2027 : : {
1840 peter@eisentraut.org 2028 :UBC 0 : pg_log_error("\\%s: missing required argument", cmd);
8928 bruce@momjian.us 2029 : 0 : success = false;
2030 : : }
2031 : : else
8833 peter_e@gmx.net 2032 :CBC 12 : success = do_lo_unlink(opt1);
2033 : : }
2034 : :
2035 : : else
6692 peter_e@gmx.net 2036 :UBC 0 : status = PSQL_CMD_UNKNOWN;
2037 : :
8768 bruce@momjian.us 2038 :CBC 28 : free(opt1);
2039 : 28 : free(opt2);
2040 : : }
2041 : : else
2572 tgl@sss.pgh.pa.us 2042 : 3 : ignore_slash_options(scan_state);
2043 : :
2044 [ - + ]: 31 : if (!success)
2572 tgl@sss.pgh.pa.us 2045 :UBC 0 : status = PSQL_CMD_ERROR;
2046 : :
2572 tgl@sss.pgh.pa.us 2047 :CBC 31 : return status;
2048 : : }
2049 : :
2050 : : /*
2051 : : * \o -- set query output
2052 : : */
2053 : : static backslashResult
2054 : 15 : exec_command_out(PsqlScanState scan_state, bool active_branch)
2055 : : {
2056 : 15 : bool success = true;
2057 : :
2058 [ + + ]: 15 : if (active_branch)
2059 : : {
7360 2060 : 12 : char *fname = psql_scan_slash_option(scan_state,
2061 : : OT_FILEPIPE, NULL, true);
2062 : :
7401 bruce@momjian.us 2063 : 12 : expand_tilde(&fname);
8833 peter_e@gmx.net 2064 : 12 : success = setQFout(fname);
8768 bruce@momjian.us 2065 : 12 : free(fname);
2066 : : }
2067 : : else
2572 tgl@sss.pgh.pa.us 2068 : 3 : ignore_slash_filepipe(scan_state);
2069 : :
2070 [ + - ]: 15 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
2071 : : }
2072 : :
2073 : : /*
2074 : : * \p -- print the current query buffer
2075 : : */
2076 : : static backslashResult
2077 : 21 : exec_command_print(PsqlScanState scan_state, bool active_branch,
2078 : : PQExpBuffer query_buf, PQExpBuffer previous_buf)
2079 : : {
2080 [ + + ]: 21 : if (active_branch)
2081 : : {
2082 : : /*
2083 : : * We want to print the same thing \g would execute, but not to change
2084 : : * the query buffer state; so we can't use copy_previous_query().
2085 : : * Also, beware of possibility that buffer pointers are NULL.
2086 : : */
8928 bruce@momjian.us 2087 [ + - + + ]: 18 : if (query_buf && query_buf->len > 0)
2088 : 9 : puts(query_buf->data);
2569 tgl@sss.pgh.pa.us 2089 [ + - + - ]: 9 : else if (previous_buf && previous_buf->len > 0)
2090 : 9 : puts(previous_buf->data);
6438 tgl@sss.pgh.pa.us 2091 [ # # ]:UBC 0 : else if (!pset.quiet)
6991 bruce@momjian.us 2092 : 0 : puts(_("Query buffer is empty."));
8892 JanWieck@Yahoo.com 2093 :CBC 18 : fflush(stdout);
2094 : : }
2095 : :
2572 tgl@sss.pgh.pa.us 2096 : 21 : return PSQL_CMD_SKIP_LINE;
2097 : : }
2098 : :
2099 : : /*
2100 : : * \password -- set user password
2101 : : */
2102 : : static backslashResult
2103 : 4 : exec_command_password(PsqlScanState scan_state, bool active_branch)
2104 : : {
2105 : 4 : bool success = true;
2106 : :
2107 [ + + ]: 4 : if (active_branch)
2108 : : {
884 2109 : 1 : char *user = psql_scan_slash_option(scan_state,
2110 : : OT_SQLID, NULL, true);
879 2111 : 1 : char *pw1 = NULL;
2112 : 1 : char *pw2 = NULL;
2113 : : PQExpBufferData buf;
2114 : : PromptInterruptContext prompt_ctx;
2115 : :
884 2116 [ - + ]: 1 : if (user == NULL)
2117 : : {
2118 : : /* By default, the command applies to CURRENT_USER */
2119 : : PGresult *res;
2120 : :
884 tgl@sss.pgh.pa.us 2121 :UBC 0 : res = PSQLexec("SELECT CURRENT_USER");
2122 [ # # ]: 0 : if (!res)
2123 : 0 : return PSQL_CMD_ERROR;
2124 : :
2125 : 0 : user = pg_strdup(PQgetvalue(res, 0, 0));
2126 : 0 : PQclear(res);
2127 : : }
2128 : :
2129 : : /* Set up to let SIGINT cancel simple_prompt_extended() */
879 tgl@sss.pgh.pa.us 2130 :CBC 1 : prompt_ctx.jmpbuf = sigint_interrupt_jmp;
2131 : 1 : prompt_ctx.enabled = &sigint_interrupt_enabled;
2132 : 1 : prompt_ctx.canceled = false;
2133 : :
884 2134 : 1 : initPQExpBuffer(&buf);
2135 : 1 : printfPQExpBuffer(&buf, _("Enter new password for user \"%s\": "), user);
2136 : :
879 2137 : 1 : pw1 = simple_prompt_extended(buf.data, false, &prompt_ctx);
2138 [ + - ]: 1 : if (!prompt_ctx.canceled)
2139 : 1 : pw2 = simple_prompt_extended("Enter it again: ", false, &prompt_ctx);
2140 : :
2141 [ - + ]: 1 : if (prompt_ctx.canceled)
2142 : : {
2143 : : /* fail silently */
879 tgl@sss.pgh.pa.us 2144 :UBC 0 : success = false;
2145 : : }
879 tgl@sss.pgh.pa.us 2146 [ - + ]:CBC 1 : else if (strcmp(pw1, pw2) != 0)
2147 : : {
1840 peter@eisentraut.org 2148 :UBC 0 : pg_log_error("Passwords didn't match.");
6692 peter_e@gmx.net 2149 : 0 : success = false;
2150 : : }
2151 : : else
2152 : : {
96 mail@joeconway.com 2153 :GNC 1 : PGresult *res = PQchangePassword(pset.db, user, pw1);
2154 : :
2155 [ - + ]: 1 : if (PQresultStatus(res) != PGRES_COMMAND_OK)
2156 : : {
1840 peter@eisentraut.org 2157 :UBC 0 : pg_log_info("%s", PQerrorMessage(pset.db));
6692 peter_e@gmx.net 2158 : 0 : success = false;
2159 : : }
2160 : :
96 mail@joeconway.com 2161 :GNC 1 : PQclear(res);
2162 : : }
2163 : :
884 tgl@sss.pgh.pa.us 2164 :CBC 1 : free(user);
668 peter@eisentraut.org 2165 : 1 : free(pw1);
2166 : 1 : free(pw2);
884 tgl@sss.pgh.pa.us 2167 : 1 : termPQExpBuffer(&buf);
2168 : : }
2169 : : else
2572 2170 : 3 : ignore_slash_options(scan_state);
2171 : :
2172 [ + - ]: 4 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
2173 : : }
2174 : :
2175 : : /*
2176 : : * \prompt -- prompt and set variable
2177 : : */
2178 : : static backslashResult
2179 : 3 : exec_command_prompt(PsqlScanState scan_state, bool active_branch,
2180 : : const char *cmd)
2181 : : {
2182 : 3 : bool success = true;
2183 : :
2184 [ - + ]: 3 : if (active_branch)
2185 : : {
2186 : : char *opt,
5995 bruce@momjian.us 2187 :UBC 0 : *prompt_text = NULL;
2188 : : char *arg1,
2189 : : *arg2;
2190 : :
6260 2191 : 0 : arg1 = psql_scan_slash_option(scan_state, OT_NORMAL, NULL, false);
2192 : 0 : arg2 = psql_scan_slash_option(scan_state, OT_NORMAL, NULL, false);
2193 : :
2194 [ # # ]: 0 : if (!arg1)
2195 : : {
1840 peter@eisentraut.org 2196 : 0 : pg_log_error("\\%s: missing required argument", cmd);
6260 bruce@momjian.us 2197 : 0 : success = false;
2198 : : }
2199 : : else
2200 : : {
2201 : : char *result;
2202 : : PromptInterruptContext prompt_ctx;
2203 : :
2204 : : /* Set up to let SIGINT cancel simple_prompt_extended() */
877 tgl@sss.pgh.pa.us 2205 : 0 : prompt_ctx.jmpbuf = sigint_interrupt_jmp;
2206 : 0 : prompt_ctx.enabled = &sigint_interrupt_enabled;
2207 : 0 : prompt_ctx.canceled = false;
2208 : :
6260 bruce@momjian.us 2209 [ # # ]: 0 : if (arg2)
2210 : : {
2211 : 0 : prompt_text = arg1;
2212 : 0 : opt = arg2;
2213 : : }
2214 : : else
2215 : 0 : opt = arg1;
2216 : :
2217 [ # # ]: 0 : if (!pset.inputfile)
2218 : : {
877 tgl@sss.pgh.pa.us 2219 : 0 : result = simple_prompt_extended(prompt_text, true, &prompt_ctx);
2220 : : }
2221 : : else
2222 : : {
6260 bruce@momjian.us 2223 [ # # ]: 0 : if (prompt_text)
2224 : : {
2225 : 0 : fputs(prompt_text, stdout);
2226 : 0 : fflush(stdout);
2227 : : }
2228 : 0 : result = gets_fromFile(stdin);
2784 tgl@sss.pgh.pa.us 2229 [ # # ]: 0 : if (!result)
2230 : : {
1840 peter@eisentraut.org 2231 : 0 : pg_log_error("\\%s: could not read value for variable",
2232 : : cmd);
2784 tgl@sss.pgh.pa.us 2233 : 0 : success = false;
2234 : : }
2235 : : }
2236 : :
877 2237 [ # # # # ]: 0 : if (prompt_ctx.canceled ||
2238 [ # # ]: 0 : (result && !SetVariable(pset.vars, opt, result)))
6260 bruce@momjian.us 2239 : 0 : success = false;
2240 : :
668 peter@eisentraut.org 2241 : 0 : free(result);
2242 : 0 : free(prompt_text);
6260 bruce@momjian.us 2243 : 0 : free(opt);
2244 : : }
2245 : : }
2246 : : else
2572 tgl@sss.pgh.pa.us 2247 :CBC 3 : ignore_slash_options(scan_state);
2248 : :
2249 [ + - ]: 3 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
2250 : : }
2251 : :
2252 : : /*
2253 : : * \pset -- set printing parameters
2254 : : */
2255 : : static backslashResult
2256 : 870 : exec_command_pset(PsqlScanState scan_state, bool active_branch)
2257 : : {
2258 : 870 : bool success = true;
2259 : :
2260 [ + + ]: 870 : if (active_branch)
2261 : : {
7360 2262 : 864 : char *opt0 = psql_scan_slash_option(scan_state,
2263 : : OT_NORMAL, NULL, false);
2264 : 864 : char *opt1 = psql_scan_slash_option(scan_state,
2265 : : OT_NORMAL, NULL, false);
2266 : :
8833 peter_e@gmx.net 2267 [ + + ]: 864 : if (!opt0)
2268 : : {
2269 : : /* list all variables */
2270 : :
2271 : : int i;
2272 : : static const char *const my_list[] = {
2273 : : "border", "columns", "csv_fieldsep", "expanded", "fieldsep",
2274 : : "fieldsep_zero", "footer", "format", "linestyle", "null",
2275 : : "numericlocale", "pager", "pager_min_lines",
2276 : : "recordsep", "recordsep_zero",
2277 : : "tableattr", "title", "tuples_only",
2278 : : "unicode_border_linestyle",
2279 : : "unicode_column_linestyle",
2280 : : "unicode_header_linestyle",
2281 : : "xheader_width",
2282 : : NULL
2283 : : };
2284 : :
3808 2285 [ + + ]: 69 : for (i = 0; my_list[i] != NULL; i++)
2286 : : {
3249 bruce@momjian.us 2287 : 66 : char *val = pset_value_string(my_list[i], &pset.popt);
2288 : :
3466 peter_e@gmx.net 2289 : 66 : printf("%-24s %s\n", my_list[i], val);
2290 : 66 : free(val);
2291 : : }
2292 : :
3808 2293 : 3 : success = true;
2294 : : }
2295 : : else
6438 tgl@sss.pgh.pa.us 2296 : 861 : success = do_pset(opt0, opt1, &pset.popt, pset.quiet);
2297 : :
8768 bruce@momjian.us 2298 : 864 : free(opt0);
2299 : 864 : free(opt1);
2300 : : }
2301 : : else
2572 tgl@sss.pgh.pa.us 2302 : 6 : ignore_slash_options(scan_state);
2303 : :
2304 [ + + ]: 870 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
2305 : : }
2306 : :
2307 : : /*
2308 : : * \q or \quit -- exit psql
2309 : : */
2310 : : static backslashResult
2311 : 62 : exec_command_quit(PsqlScanState scan_state, bool active_branch)
2312 : : {
2313 : 62 : backslashResult status = PSQL_CMD_SKIP_LINE;
2314 : :
2315 [ + + ]: 62 : if (active_branch)
6692 peter_e@gmx.net 2316 : 36 : status = PSQL_CMD_TERMINATE;
2317 : :
2572 tgl@sss.pgh.pa.us 2318 : 62 : return status;
2319 : : }
2320 : :
2321 : : /*
2322 : : * \r -- reset (clear) the query buffer
2323 : : */
2324 : : static backslashResult
2325 : 38 : exec_command_reset(PsqlScanState scan_state, bool active_branch,
2326 : : PQExpBuffer query_buf)
2327 : : {
2328 [ + + ]: 38 : if (active_branch)
2329 : : {
8928 bruce@momjian.us 2330 : 35 : resetPQExpBuffer(query_buf);
7360 tgl@sss.pgh.pa.us 2331 : 35 : psql_scan_reset(scan_state);
6438 2332 [ + + ]: 35 : if (!pset.quiet)
6991 bruce@momjian.us 2333 : 26 : puts(_("Query buffer reset (cleared)."));
2334 : : }
2335 : :
2572 tgl@sss.pgh.pa.us 2336 : 38 : return PSQL_CMD_SKIP_LINE;
2337 : : }
2338 : :
2339 : : /*
2340 : : * \s -- save history in a file or show it on the screen
2341 : : */
2342 : : static backslashResult
2343 : 3 : exec_command_s(PsqlScanState scan_state, bool active_branch)
2344 : : {
2345 : 3 : bool success = true;
2346 : :
2347 [ - + ]: 3 : if (active_branch)
2348 : : {
7360 tgl@sss.pgh.pa.us 2349 :UBC 0 : char *fname = psql_scan_slash_option(scan_state,
2350 : : OT_NORMAL, NULL, true);
2351 : :
7401 bruce@momjian.us 2352 : 0 : expand_tilde(&fname);
3506 tgl@sss.pgh.pa.us 2353 : 0 : success = printHistory(fname, pset.popt.topt.pager);
6438 2354 [ # # # # : 0 : if (success && !pset.quiet && fname)
# # ]
3813 2355 : 0 : printf(_("Wrote history to file \"%s\".\n"), fname);
7075 bruce@momjian.us 2356 [ # # ]: 0 : if (!fname)
2357 : 0 : putchar('\n');
8768 2358 : 0 : free(fname);
2359 : : }
2360 : : else
2572 tgl@sss.pgh.pa.us 2361 :CBC 3 : ignore_slash_options(scan_state);
2362 : :
2363 [ + - ]: 3 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
2364 : : }
2365 : :
2366 : : /*
2367 : : * \set -- set variable
2368 : : */
2369 : : static backslashResult
2370 : 475 : exec_command_set(PsqlScanState scan_state, bool active_branch)
2371 : : {
2372 : 475 : bool success = true;
2373 : :
2374 [ + + ]: 475 : if (active_branch)
2375 : : {
7360 2376 : 472 : char *opt0 = psql_scan_slash_option(scan_state,
2377 : : OT_NORMAL, NULL, false);
2378 : :
8833 peter_e@gmx.net 2379 [ - + ]: 472 : if (!opt0)
2380 : : {
2381 : : /* list all variables */
7696 bruce@momjian.us 2382 :UBC 0 : PrintVariables(pset.vars);
8928 2383 : 0 : success = true;
2384 : : }
2385 : : else
2386 : : {
2387 : : /*
2388 : : * Set variable to the concatenation of the arguments.
2389 : : */
2390 : : char *newval;
2391 : : char *opt;
2392 : :
7360 tgl@sss.pgh.pa.us 2393 :CBC 472 : opt = psql_scan_slash_option(scan_state,
2394 : : OT_NORMAL, NULL, false);
7385 neilc@samurai.com 2395 [ + + ]: 472 : newval = pg_strdup(opt ? opt : "");
8768 bruce@momjian.us 2396 : 472 : free(opt);
2397 : :
7360 tgl@sss.pgh.pa.us 2398 [ + + ]: 707 : while ((opt = psql_scan_slash_option(scan_state,
2399 : : OT_NORMAL, NULL, false)))
2400 : : {
3435 2401 : 235 : newval = pg_realloc(newval, strlen(newval) + strlen(opt) + 1);
8768 bruce@momjian.us 2402 : 235 : strcat(newval, opt);
2403 : 235 : free(opt);
2404 : : }
2405 : :
6438 tgl@sss.pgh.pa.us 2406 [ + + ]: 472 : if (!SetVariable(pset.vars, opt0, newval))
8928 bruce@momjian.us 2407 : 12 : success = false;
2408 : :
8768 2409 : 472 : free(newval);
2410 : : }
2411 : 472 : free(opt0);
2412 : : }
2413 : : else
2572 tgl@sss.pgh.pa.us 2414 : 3 : ignore_slash_options(scan_state);
2415 : :
2416 [ + + ]: 475 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
2417 : : }
2418 : :
2419 : : /*
2420 : : * \setenv -- set environment variable
2421 : : */
2422 : : static backslashResult
2423 : 9 : exec_command_setenv(PsqlScanState scan_state, bool active_branch,
2424 : : const char *cmd)
2425 : : {
2426 : 9 : bool success = true;
2427 : :
2428 [ + + ]: 9 : if (active_branch)
2429 : : {
4515 andrew@dunslane.net 2430 : 6 : char *envvar = psql_scan_slash_option(scan_state,
2431 : : OT_NORMAL, NULL, false);
2432 : 6 : char *envval = psql_scan_slash_option(scan_state,
2433 : : OT_NORMAL, NULL, false);
2434 : :
2435 [ - + ]: 6 : if (!envvar)
2436 : : {
1840 peter@eisentraut.org 2437 :UBC 0 : pg_log_error("\\%s: missing required argument", cmd);
4515 andrew@dunslane.net 2438 : 0 : success = false;
2439 : : }
4326 bruce@momjian.us 2440 [ - + ]:CBC 6 : else if (strchr(envvar, '=') != NULL)
2441 : : {
1840 peter@eisentraut.org 2442 :UBC 0 : pg_log_error("\\%s: environment variable name must not contain \"=\"",
2443 : : cmd);
4515 andrew@dunslane.net 2444 : 0 : success = false;
2445 : : }
4515 andrew@dunslane.net 2446 [ + + ]:CBC 6 : else if (!envval)
2447 : : {
2448 : : /* No argument - unset the environment variable */
2449 : 3 : unsetenv(envvar);
2450 : 3 : success = true;
2451 : : }
2452 : : else
2453 : : {
2454 : : /* Set variable to the value of the next argument */
1201 tgl@sss.pgh.pa.us 2455 : 3 : setenv(envvar, envval, 1);
4515 andrew@dunslane.net 2456 : 3 : success = true;
2457 : : }
2458 : 6 : free(envvar);
2459 : 6 : free(envval);
2460 : : }
2461 : : else
2572 tgl@sss.pgh.pa.us 2462 : 3 : ignore_slash_options(scan_state);
2463 : :
2464 [ + - ]: 9 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
2465 : : }
2466 : :
2467 : : /*
2468 : : * \sf/\sv -- show a function/view's source code
2469 : : */
2470 : : static backslashResult
2412 2471 : 80 : exec_command_sf_sv(PsqlScanState scan_state, bool active_branch,
2472 : : const char *cmd, bool is_func)
2473 : : {
2572 2474 : 80 : backslashResult status = PSQL_CMD_SKIP_LINE;
2475 : :
2476 [ + + ]: 80 : if (active_branch)
2477 : : {
2412 2478 : 74 : bool show_linenumbers = (strchr(cmd, '+') != NULL);
2479 : : PQExpBuffer buf;
2480 : : char *obj_desc;
2481 : 74 : Oid obj_oid = InvalidOid;
2482 : 74 : EditableObjectType eot = is_func ? EditableFunction : EditableView;
2483 : :
2484 : 74 : buf = createPQExpBuffer();
2485 : 74 : obj_desc = psql_scan_slash_option(scan_state,
2486 : : OT_WHOLE_LINE, NULL, true);
850 2487 [ - + ]: 74 : if (!obj_desc)
2488 : : {
2412 tgl@sss.pgh.pa.us 2489 [ # # ]:UBC 0 : if (is_func)
1840 peter@eisentraut.org 2490 : 0 : pg_log_error("function name is required");
2491 : : else
2492 : 0 : pg_log_error("view name is required");
4992 tgl@sss.pgh.pa.us 2493 : 0 : status = PSQL_CMD_ERROR;
2494 : : }
2412 tgl@sss.pgh.pa.us 2495 [ - + ]:CBC 74 : else if (!lookup_object_oid(eot, obj_desc, &obj_oid))
2496 : : {
2497 : : /* error already reported */
4992 tgl@sss.pgh.pa.us 2498 :UBC 0 : status = PSQL_CMD_ERROR;
2499 : : }
2412 tgl@sss.pgh.pa.us 2500 [ - + ]:CBC 74 : else if (!get_create_object_cmd(eot, obj_oid, buf))
2501 : : {
2502 : : /* error already reported */
4992 tgl@sss.pgh.pa.us 2503 :UBC 0 : status = PSQL_CMD_ERROR;
2504 : : }
2505 : : else
2506 : : {
2507 : : FILE *output;
2508 : : bool is_pager;
2509 : :
2510 : : /* Select output stream: stdout, pager, or file */
4992 tgl@sss.pgh.pa.us 2511 [ + - ]:CBC 74 : if (pset.queryFout == stdout)
2512 : : {
2513 : : /* count lines in function to see if pager is needed */
2412 2514 : 74 : int lineno = count_lines_in_buf(buf);
2515 : :
3305 andrew@dunslane.net 2516 : 74 : output = PageOutput(lineno, &(pset.popt.topt));
4992 tgl@sss.pgh.pa.us 2517 : 74 : is_pager = true;
2518 : : }
2519 : : else
2520 : : {
2521 : : /* use previously set output file, without pager */
4992 tgl@sss.pgh.pa.us 2522 :UBC 0 : output = pset.queryFout;
2523 : 0 : is_pager = false;
2524 : : }
2525 : :
4992 tgl@sss.pgh.pa.us 2526 [ + + ]:CBC 74 : if (show_linenumbers)
2527 : : {
2528 : : /* add line numbers */
499 2529 : 9 : print_with_linenumbers(output, buf->data, is_func);
2530 : : }
2531 : : else
2532 : : {
2533 : : /* just send the definition to output */
2412 2534 : 65 : fputs(buf->data, output);
2535 : : }
2536 : :
3208 2537 [ + - ]: 74 : if (is_pager)
2538 : 74 : ClosePager(output);
2539 : : }
2540 : :
668 peter@eisentraut.org 2541 : 74 : free(obj_desc);
2412 tgl@sss.pgh.pa.us 2542 : 74 : destroyPQExpBuffer(buf);
2543 : : }
2544 : : else
2572 2545 : 6 : ignore_slash_whole_line(scan_state);
2546 : :
2547 : 80 : return status;
2548 : : }
2549 : :
2550 : : /*
2551 : : * \t -- turn off table headers and row count
2552 : : */
2553 : : static backslashResult
2554 : 35 : exec_command_t(PsqlScanState scan_state, bool active_branch)
2555 : : {
2556 : 35 : bool success = true;
2557 : :
2558 [ + + ]: 35 : if (active_branch)
2559 : : {
6252 bruce@momjian.us 2560 : 32 : char *opt = psql_scan_slash_option(scan_state,
2561 : : OT_NORMAL, NULL, true);
2562 : :
2563 : 32 : success = do_pset("tuples_only", opt, &pset.popt, pset.quiet);
2564 : 32 : free(opt);
2565 : : }
2566 : : else
2572 tgl@sss.pgh.pa.us 2567 : 3 : ignore_slash_options(scan_state);
2568 : :
2569 [ + - ]: 35 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
2570 : : }
2571 : :
2572 : : /*
2573 : : * \T -- define html <table ...> attributes
2574 : : */
2575 : : static backslashResult
2576 : 3 : exec_command_T(PsqlScanState scan_state, bool active_branch)
2577 : : {
2578 : 3 : bool success = true;
2579 : :
2580 [ - + ]: 3 : if (active_branch)
2581 : : {
7360 tgl@sss.pgh.pa.us 2582 :UBC 0 : char *value = psql_scan_slash_option(scan_state,
2583 : : OT_NORMAL, NULL, false);
2584 : :
6438 2585 : 0 : success = do_pset("tableattr", value, &pset.popt, pset.quiet);
8768 bruce@momjian.us 2586 : 0 : free(value);
2587 : : }
2588 : : else
2572 tgl@sss.pgh.pa.us 2589 :CBC 3 : ignore_slash_options(scan_state);
2590 : :
2591 [ + - ]: 3 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
2592 : : }
2593 : :
2594 : : /*
2595 : : * \timing -- enable/disable timing of queries
2596 : : */
2597 : : static backslashResult
2598 : 5 : exec_command_timing(PsqlScanState scan_state, bool active_branch)
2599 : : {
2600 : 5 : bool success = true;
2601 : :
2602 [ + + ]: 5 : if (active_branch)
2603 : : {
5786 heikki.linnakangas@i 2604 : 2 : char *opt = psql_scan_slash_option(scan_state,
2605 : : OT_NORMAL, NULL, false);
2606 : :
2607 [ + - ]: 2 : if (opt)
2631 tgl@sss.pgh.pa.us 2608 : 2 : success = ParseVariableBool(opt, "\\timing", &pset.timing);
2609 : : else
5786 heikki.linnakangas@i 2610 :UBC 0 : pset.timing = !pset.timing;
6438 tgl@sss.pgh.pa.us 2611 [ - + ]:CBC 2 : if (!pset.quiet)
2612 : : {
8076 bruce@momjian.us 2613 [ # # ]:UBC 0 : if (pset.timing)
6991 2614 : 0 : puts(_("Timing is on."));
2615 : : else
2616 : 0 : puts(_("Timing is off."));
2617 : : }
5786 heikki.linnakangas@i 2618 :CBC 2 : free(opt);
2619 : : }
2620 : : else
2572 tgl@sss.pgh.pa.us 2621 : 3 : ignore_slash_options(scan_state);
2622 : :
2623 [ + - ]: 5 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
2624 : : }
2625 : :
2626 : : /*
2627 : : * \unset -- unset variable
2628 : : */
2629 : : static backslashResult
2630 : 19 : exec_command_unset(PsqlScanState scan_state, bool active_branch,
2631 : : const char *cmd)
2632 : : {
2633 : 19 : bool success = true;
2634 : :
2635 [ + + ]: 19 : if (active_branch)
2636 : : {
7360 2637 : 16 : char *opt = psql_scan_slash_option(scan_state,
2638 : : OT_NORMAL, NULL, false);
2639 : :
8768 bruce@momjian.us 2640 [ - + ]: 16 : if (!opt)
2641 : : {
1840 peter@eisentraut.org 2642 :UBC 0 : pg_log_error("\\%s: missing required argument", cmd);
8768 bruce@momjian.us 2643 : 0 : success = false;
2644 : : }
8122 tgl@sss.pgh.pa.us 2645 [ - + ]:CBC 16 : else if (!SetVariable(pset.vars, opt, NULL))
8768 bruce@momjian.us 2646 :UBC 0 : success = false;
2647 : :
8768 bruce@momjian.us 2648 :CBC 16 : free(opt);
2649 : : }
2650 : : else
2572 tgl@sss.pgh.pa.us 2651 : 3 : ignore_slash_options(scan_state);
2652 : :
2653 [ + - ]: 19 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
2654 : : }
2655 : :
2656 : : /*
2657 : : * \w -- write query buffer to file
2658 : : */
2659 : : static backslashResult
2660 : 6 : exec_command_write(PsqlScanState scan_state, bool active_branch,
2661 : : const char *cmd,
2662 : : PQExpBuffer query_buf, PQExpBuffer previous_buf)
2663 : : {
2664 : 6 : backslashResult status = PSQL_CMD_SKIP_LINE;
2665 : :
2666 [ - + ]: 6 : if (active_branch)
2667 : : {
2572 tgl@sss.pgh.pa.us 2668 :UBC 0 : char *fname = psql_scan_slash_option(scan_state,
2669 : : OT_FILEPIPE, NULL, true);
8928 bruce@momjian.us 2670 : 0 : FILE *fd = NULL;
8833 peter_e@gmx.net 2671 : 0 : bool is_pipe = false;
2672 : :
8768 bruce@momjian.us 2673 [ # # ]: 0 : if (!query_buf)
2674 : : {
1840 peter@eisentraut.org 2675 : 0 : pg_log_error("no query buffer");
6692 peter_e@gmx.net 2676 : 0 : status = PSQL_CMD_ERROR;
2677 : : }
2678 : : else
2679 : : {
8768 bruce@momjian.us 2680 [ # # ]: 0 : if (!fname)
2681 : : {
1840 peter@eisentraut.org 2682 : 0 : pg_log_error("\\%s: missing required argument", cmd);
2572 tgl@sss.pgh.pa.us 2683 : 0 : status = PSQL_CMD_ERROR;
2684 : : }
2685 : : else
2686 : : {
2687 : 0 : expand_tilde(&fname);
8768 bruce@momjian.us 2688 [ # # ]: 0 : if (fname[0] == '|')
2689 : : {
2690 : 0 : is_pipe = true;
594 tgl@sss.pgh.pa.us 2691 : 0 : fflush(NULL);
3055 2692 : 0 : disable_sigpipe_trap();
8768 bruce@momjian.us 2693 : 0 : fd = popen(&fname[1], "w");
2694 : : }
2695 : : else
2696 : : {
7217 2697 : 0 : canonicalize_path(fname);
8768 2698 : 0 : fd = fopen(fname, "w");
2699 : : }
2700 [ # # ]: 0 : if (!fd)
2701 : : {
1840 peter@eisentraut.org 2702 : 0 : pg_log_error("%s: %m", fname);
2572 tgl@sss.pgh.pa.us 2703 : 0 : status = PSQL_CMD_ERROR;
2704 : : }
2705 : : }
2706 : : }
2707 : :
8928 bruce@momjian.us 2708 [ # # ]: 0 : if (fd)
2709 : : {
2710 : : int result;
2711 : :
2712 : : /*
2713 : : * We want to print the same thing \g would execute, but not to
2714 : : * change the query buffer state; so we can't use
2715 : : * copy_previous_query(). Also, beware of possibility that buffer
2716 : : * pointers are NULL.
2717 : : */
2718 [ # # # # ]: 0 : if (query_buf && query_buf->len > 0)
2719 : 0 : fprintf(fd, "%s\n", query_buf->data);
2572 tgl@sss.pgh.pa.us 2720 [ # # # # ]: 0 : else if (previous_buf && previous_buf->len > 0)
2721 : 0 : fprintf(fd, "%s\n", previous_buf->data);
2722 : :
8833 peter_e@gmx.net 2723 [ # # ]: 0 : if (is_pipe)
2724 : : {
8928 bruce@momjian.us 2725 : 0 : result = pclose(fd);
2726 : :
516 peter@eisentraut.org 2727 [ # # ]: 0 : if (result != 0)
2728 : : {
2729 : 0 : pg_log_error("%s: %s", fname, wait_result_to_str(result));
2730 : 0 : status = PSQL_CMD_ERROR;
2731 : : }
374 tgl@sss.pgh.pa.us 2732 : 0 : SetShellResultVariables(result);
2733 : : }
2734 : : else
2735 : : {
8928 bruce@momjian.us 2736 : 0 : result = fclose(fd);
2737 : :
516 peter@eisentraut.org 2738 [ # # ]: 0 : if (result == EOF)
2739 : : {
2740 : 0 : pg_log_error("%s: %m", fname);
2741 : 0 : status = PSQL_CMD_ERROR;
2742 : : }
2743 : : }
2744 : : }
2745 : :
3055 tgl@sss.pgh.pa.us 2746 [ # # ]: 0 : if (is_pipe)
2747 : 0 : restore_sigpipe_trap();
2748 : :
8768 bruce@momjian.us 2749 : 0 : free(fname);
2750 : : }
2751 : : else
2572 tgl@sss.pgh.pa.us 2752 :CBC 6 : ignore_slash_filepipe(scan_state);
2753 : :
2754 : 6 : return status;
2755 : : }
2756 : :
2757 : : /*
2758 : : * \watch -- execute a query every N seconds.
2759 : : * Optionally, stop after M iterations.
2760 : : */
2761 : : static backslashResult
2762 : 13 : exec_command_watch(PsqlScanState scan_state, bool active_branch,
2763 : : PQExpBuffer query_buf, PQExpBuffer previous_buf)
2764 : : {
2765 : 13 : bool success = true;
2766 : :
2767 [ + + ]: 13 : if (active_branch)
2768 : : {
374 2769 : 10 : bool have_sleep = false;
2770 : 10 : bool have_iter = false;
229 dgustafsson@postgres 2771 :GNC 10 : bool have_min_rows = false;
2946 tgl@sss.pgh.pa.us 2772 :CBC 10 : double sleep = 2;
374 2773 : 10 : int iter = 0;
229 dgustafsson@postgres 2774 :GNC 10 : int min_rows = 0;
2775 : :
2776 : : /*
2777 : : * Parse arguments. We allow either an unlabeled interval or
2778 : : * "name=value", where name is from the set ('i', 'interval', 'c',
2779 : : * 'count', 'm', 'min_rows').
2780 : : */
374 tgl@sss.pgh.pa.us 2781 [ + + ]:CBC 25 : while (success)
2782 : : {
2783 : 18 : char *opt = psql_scan_slash_option(scan_state,
2784 : : OT_NORMAL, NULL, true);
2785 : : char *valptr;
2786 : : char *opt_end;
2787 : :
2788 [ + + ]: 18 : if (!opt)
2789 : 3 : break; /* no more arguments */
2790 : :
2791 : 15 : valptr = strchr(opt, '=');
2792 [ + + ]: 15 : if (valptr)
2793 : : {
2794 : : /* Labeled argument */
2795 : 9 : valptr++;
2796 [ + + ]: 9 : if (strncmp("i=", opt, strlen("i=")) == 0 ||
2797 [ - + ]: 7 : strncmp("interval=", opt, strlen("interval=")) == 0)
2798 : : {
2799 [ - + ]: 2 : if (have_sleep)
2800 : : {
374 tgl@sss.pgh.pa.us 2801 :UBC 0 : pg_log_error("\\watch: interval value is specified more than once");
2802 : 0 : success = false;
2803 : : }
2804 : : else
2805 : : {
374 tgl@sss.pgh.pa.us 2806 :CBC 2 : have_sleep = true;
2807 : 2 : errno = 0;
2808 : 2 : sleep = strtod(valptr, &opt_end);
2809 [ + - + - : 2 : if (sleep < 0 || *opt_end || errno == ERANGE)
- + ]
2810 : : {
374 tgl@sss.pgh.pa.us 2811 :UBC 0 : pg_log_error("\\watch: incorrect interval value \"%s\"", valptr);
2812 : 0 : success = false;
2813 : : }
2814 : : }
2815 : : }
374 tgl@sss.pgh.pa.us 2816 [ + + ]:CBC 7 : else if (strncmp("c=", opt, strlen("c=")) == 0 ||
374 tgl@sss.pgh.pa.us 2817 [ - + ]:GBC 4 : strncmp("count=", opt, strlen("count=")) == 0)
2818 : : {
374 tgl@sss.pgh.pa.us 2819 [ + + ]:CBC 3 : if (have_iter)
2820 : : {
2821 : 1 : pg_log_error("\\watch: iteration count is specified more than once");
2822 : 1 : success = false;
2823 : : }
2824 : : else
2825 : : {
2826 : 2 : have_iter = true;
2827 : 2 : errno = 0;
2828 : 2 : iter = strtoint(valptr, &opt_end, 10);
2829 [ + - + - : 2 : if (iter <= 0 || *opt_end || errno == ERANGE)
- + ]
2830 : : {
374 tgl@sss.pgh.pa.us 2831 :UBC 0 : pg_log_error("\\watch: incorrect iteration count \"%s\"", valptr);
2832 : 0 : success = false;
2833 : : }
2834 : : }
2835 : : }
229 dgustafsson@postgres 2836 [ + + ]:GNC 4 : else if (strncmp("m=", opt, strlen("m=")) == 0 ||
2837 [ + - ]: 1 : strncmp("min_rows=", opt, strlen("min_rows=")) == 0)
2838 : : {
2839 [ + + ]: 4 : if (have_min_rows)
2840 : : {
2841 : 1 : pg_log_error("\\watch: minimum row count specified more than once");
2842 : 1 : success = false;
2843 : : }
2844 : : else
2845 : : {
2846 : 3 : have_min_rows = true;
2847 : 3 : errno = 0;
2848 : 3 : min_rows = strtoint(valptr, &opt_end, 10);
2849 [ + + + - : 3 : if (min_rows <= 0 || *opt_end || errno == ERANGE)
- + ]
2850 : : {
2851 : 1 : pg_log_error("\\watch: incorrect minimum row count \"%s\"", valptr);
2852 : 1 : success = false;
2853 : : }
2854 : : }
2855 : : }
2856 : : else
2857 : : {
374 tgl@sss.pgh.pa.us 2858 :UBC 0 : pg_log_error("\\watch: unrecognized parameter \"%s\"", opt);
2859 : 0 : success = false;
2860 : : }
2861 : : }
2862 : : else
2863 : : {
2864 : : /* Unlabeled argument: take it as interval */
374 tgl@sss.pgh.pa.us 2865 [ + + ]:CBC 6 : if (have_sleep)
2866 : : {
2867 : 1 : pg_log_error("\\watch: interval value is specified more than once");
2868 : 1 : success = false;
2869 : : }
2870 : : else
2871 : : {
2872 : 5 : have_sleep = true;
2873 : 5 : errno = 0;
2874 : 5 : sleep = strtod(opt, &opt_end);
2875 [ + + + + : 5 : if (sleep < 0 || *opt_end || errno == ERANGE)
+ + ]
2876 : : {
2877 : 3 : pg_log_error("\\watch: incorrect interval value \"%s\"", opt);
2878 : 3 : success = false;
2879 : : }
2880 : : }
2881 : : }
2882 : :
4028 2883 : 15 : free(opt);
2884 : : }
2885 : :
2886 : : /* If we parsed arguments successfully, do the command */
374 2887 [ + + ]: 10 : if (success)
2888 : : {
2889 : : /* If query_buf is empty, recall and execute previous query */
2890 : 3 : (void) copy_previous_query(query_buf, previous_buf);
2891 : :
229 dgustafsson@postgres 2892 :GNC 3 : success = do_watch(query_buf, sleep, iter, min_rows);
2893 : : }
2894 : :
2895 : : /* Reset the query buffer as though for \r */
4028 tgl@sss.pgh.pa.us 2896 :CBC 9 : resetPQExpBuffer(query_buf);
2897 : 9 : psql_scan_reset(scan_state);
2898 : : }
2899 : : else
2572 2900 : 3 : ignore_slash_options(scan_state);
2901 : :
2902 [ + + ]: 12 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
2903 : : }
2904 : :
2905 : : /*
2906 : : * \x -- set or toggle expanded table representation
2907 : : */
2908 : : static backslashResult
2909 : 38 : exec_command_x(PsqlScanState scan_state, bool active_branch)
2910 : : {
2911 : 38 : bool success = true;
2912 : :
2913 [ + + ]: 38 : if (active_branch)
2914 : : {
6252 bruce@momjian.us 2915 : 35 : char *opt = psql_scan_slash_option(scan_state,
2916 : : OT_NORMAL, NULL, true);
2917 : :
2918 : 35 : success = do_pset("expanded", opt, &pset.popt, pset.quiet);
2919 : 35 : free(opt);
2920 : : }
2921 : : else
2572 tgl@sss.pgh.pa.us 2922 : 3 : ignore_slash_options(scan_state);
2923 : :
2924 [ + - ]: 38 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
2925 : : }
2926 : :
2927 : : /*
2928 : : * \z -- list table privileges (equivalent to \dp)
2929 : : */
2930 : : static backslashResult
463 dean.a.rasheed@gmail 2931 : 12 : exec_command_z(PsqlScanState scan_state, bool active_branch, const char *cmd)
2932 : : {
2572 tgl@sss.pgh.pa.us 2933 : 12 : bool success = true;
2934 : :
2935 [ + + ]: 12 : if (active_branch)
2936 : : {
2937 : : char *pattern;
2938 : : bool show_system;
2939 : :
463 dean.a.rasheed@gmail 2940 : 9 : pattern = psql_scan_slash_option(scan_state,
2941 : : OT_NORMAL, NULL, true);
2942 : :
2943 : 9 : show_system = strchr(cmd, 'S') ? true : false;
2944 : :
2945 : 9 : success = permissionsList(pattern, show_system);
2946 : :
668 peter@eisentraut.org 2947 : 9 : free(pattern);
2948 : : }
2949 : : else
2572 tgl@sss.pgh.pa.us 2950 : 3 : ignore_slash_options(scan_state);
2951 : :
2952 [ + - ]: 12 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
2953 : : }
2954 : :
2955 : : /*
2956 : : * \! -- execute shell command
2957 : : */
2958 : : static backslashResult
2959 : 3 : exec_command_shell_escape(PsqlScanState scan_state, bool active_branch)
2960 : : {
2961 : 3 : bool success = true;
2962 : :
2963 [ - + ]: 3 : if (active_branch)
2964 : : {
7360 tgl@sss.pgh.pa.us 2965 :LBC (2) : char *opt = psql_scan_slash_option(scan_state,
2966 : : OT_WHOLE_LINE, NULL, false);
2967 : :
2968 : (2) : success = do_shell(opt);
2969 : (2) : free(opt);
2970 : : }
2971 : : else
2572 tgl@sss.pgh.pa.us 2972 :CBC 3 : ignore_slash_whole_line(scan_state);
2973 : :
2974 [ + - ]: 3 : return success ? PSQL_CMD_SKIP_LINE : PSQL_CMD_ERROR;
2975 : : }
2976 : :
2977 : : /*
2978 : : * \? -- print help about backslash commands
2979 : : */
2980 : : static backslashResult
2981 : 3 : exec_command_slash_command_help(PsqlScanState scan_state, bool active_branch)
2982 : : {
2983 [ - + ]: 3 : if (active_branch)
2984 : : {
3505 andres@anarazel.de 2985 :UBC 0 : char *opt0 = psql_scan_slash_option(scan_state,
2986 : : OT_NORMAL, NULL, false);
2987 : :
2988 [ # # # # ]: 0 : if (!opt0 || strcmp(opt0, "commands") == 0)
2989 : 0 : slashUsage(pset.popt.topt.pager);
2990 [ # # ]: 0 : else if (strcmp(opt0, "options") == 0)
2991 : 0 : usage(pset.popt.topt.pager);
2992 [ # # ]: 0 : else if (strcmp(opt0, "variables") == 0)
2993 : 0 : helpVariables(pset.popt.topt.pager);
2994 : : else
2995 : 0 : slashUsage(pset.popt.topt.pager);
2996 : :
668 peter@eisentraut.org 2997 : 0 : free(opt0);
2998 : : }
2999 : : else
2572 tgl@sss.pgh.pa.us 3000 :CBC 3 : ignore_slash_options(scan_state);
3001 : :
3002 : 3 : return PSQL_CMD_SKIP_LINE;
3003 : : }
3004 : :
3005 : :
3006 : : /*
3007 : : * Read and interpret an argument to the \connect slash command.
3008 : : *
3009 : : * Returns a malloc'd string, or NULL if no/empty argument.
3010 : : */
3011 : : static char *
3012 : 604 : read_connect_arg(PsqlScanState scan_state)
3013 : : {
3014 : : char *result;
3015 : : char quote;
3016 : :
3017 : : /*
3018 : : * Ideally we should treat the arguments as SQL identifiers. But for
3019 : : * backwards compatibility with 7.2 and older pg_dump files, we have to
3020 : : * take unquoted arguments verbatim (don't downcase them). For now,
3021 : : * double-quoted arguments may be stripped of double quotes (as if SQL
3022 : : * identifiers). By 7.4 or so, pg_dump files can be expected to
3023 : : * double-quote all mixed-case \connect arguments, and then we can get rid
3024 : : * of OT_SQLIDHACK.
3025 : : */
3026 : 604 : result = psql_scan_slash_option(scan_state, OT_SQLIDHACK, "e, true);
3027 : :
3028 [ + + ]: 604 : if (!result)
3029 : 492 : return NULL;
3030 : :
3031 [ + + ]: 112 : if (quote)
3032 : 9 : return result;
3033 : :
3034 [ + - + + ]: 103 : if (*result == '\0' || strcmp(result, "-") == 0)
3035 : : {
2453 3036 : 90 : free(result);
2572 3037 : 90 : return NULL;
3038 : : }
3039 : :
3040 : 13 : return result;
3041 : : }
3042 : :
3043 : : /*
3044 : : * Read a boolean expression, return it as a PQExpBuffer string.
3045 : : *
3046 : : * Note: anything more or less than one token will certainly fail to be
3047 : : * parsed by ParseVariableBool, so we don't worry about complaining here.
3048 : : * This routine's return data structure will need to be rethought anyway
3049 : : * to support likely future extensions such as "\if defined VARNAME".
3050 : : */
3051 : : static PQExpBuffer
3052 : 107 : gather_boolean_expression(PsqlScanState scan_state)
3053 : : {
3054 : 107 : PQExpBuffer exp_buf = createPQExpBuffer();
3055 : 107 : int num_options = 0;
3056 : : char *value;
3057 : :
3058 : : /* collect all arguments for the conditional command into exp_buf */
3059 : 220 : while ((value = psql_scan_slash_option(scan_state,
3060 [ + + ]: 220 : OT_NORMAL, NULL, false)) != NULL)
3061 : : {
3062 : : /* add spaces between tokens */
3063 [ + + ]: 113 : if (num_options > 0)
3064 : 6 : appendPQExpBufferChar(exp_buf, ' ');
3065 : 113 : appendPQExpBufferStr(exp_buf, value);
3066 : 113 : num_options++;
3067 : 113 : free(value);
3068 : : }
3069 : :
3070 : 107 : return exp_buf;
3071 : : }
3072 : :
3073 : : /*
3074 : : * Read a boolean expression, return true if the expression
3075 : : * was a valid boolean expression that evaluated to true.
3076 : : * Otherwise return false.
3077 : : *
3078 : : * Note: conditional stack's top state must be active, else lexer will
3079 : : * fail to expand variables and backticks.
3080 : : */
3081 : : static bool
3082 : 98 : is_true_boolean_expression(PsqlScanState scan_state, const char *name)
3083 : : {
3084 : 98 : PQExpBuffer buf = gather_boolean_expression(scan_state);
3085 : 98 : bool value = false;
3086 : 98 : bool success = ParseVariableBool(buf->data, name, &value);
3087 : :
3088 : 98 : destroyPQExpBuffer(buf);
3089 [ + + + + ]: 98 : return success && value;
3090 : : }
3091 : :
3092 : : /*
3093 : : * Read a boolean expression, but do nothing with it.
3094 : : *
3095 : : * Note: conditional stack's top state must be INACTIVE, else lexer will
3096 : : * expand variables and backticks, which we do not want here.
3097 : : */
3098 : : static void
3099 : 9 : ignore_boolean_expression(PsqlScanState scan_state)
3100 : : {
3101 : 9 : PQExpBuffer buf = gather_boolean_expression(scan_state);
3102 : :
3103 : 9 : destroyPQExpBuffer(buf);
3104 : 9 : }
3105 : :
3106 : : /*
3107 : : * Read and discard "normal" slash command options.
3108 : : *
3109 : : * This should be used for inactive-branch processing of any slash command
3110 : : * that eats one or more OT_NORMAL, OT_SQLID, or OT_SQLIDHACK parameters.
3111 : : * We don't need to worry about exactly how many it would eat, since the
3112 : : * cleanup logic in HandleSlashCmds would silently discard any extras anyway.
3113 : : */
3114 : : static void
3115 : 156 : ignore_slash_options(PsqlScanState scan_state)
3116 : : {
3117 : : char *arg;
3118 : :
3119 : 375 : while ((arg = psql_scan_slash_option(scan_state,
3120 [ + + ]: 375 : OT_NORMAL, NULL, false)) != NULL)
3121 : 219 : free(arg);
3122 : 156 : }
3123 : :
3124 : : /*
3125 : : * Read and discard FILEPIPE slash command argument.
3126 : : *
3127 : : * This *MUST* be used for inactive-branch processing of any slash command
3128 : : * that takes an OT_FILEPIPE option. Otherwise we might consume a different
3129 : : * amount of option text in active and inactive cases.
3130 : : */
3131 : : static void
3132 : 9 : ignore_slash_filepipe(PsqlScanState scan_state)
3133 : : {
3134 : 9 : char *arg = psql_scan_slash_option(scan_state,
3135 : : OT_FILEPIPE, NULL, false);
3136 : :
668 peter@eisentraut.org 3137 : 9 : free(arg);
2572 tgl@sss.pgh.pa.us 3138 : 9 : }
3139 : :
3140 : : /*
3141 : : * Read and discard whole-line slash command argument.
3142 : : *
3143 : : * This *MUST* be used for inactive-branch processing of any slash command
3144 : : * that takes an OT_WHOLE_LINE option. Otherwise we might consume a different
3145 : : * amount of option text in active and inactive cases.
3146 : : *
3147 : : * Note: although callers might pass "semicolon" as either true or false,
3148 : : * we need not duplicate that here, since it doesn't affect the amount of
3149 : : * input text consumed.
3150 : : */
3151 : : static void
3152 : 21 : ignore_slash_whole_line(PsqlScanState scan_state)
3153 : : {
3154 : 21 : char *arg = psql_scan_slash_option(scan_state,
3155 : : OT_WHOLE_LINE, NULL, false);
3156 : :
668 peter@eisentraut.org 3157 : 21 : free(arg);
2572 tgl@sss.pgh.pa.us 3158 : 21 : }
3159 : :
3160 : : /*
3161 : : * Return true if the command given is a branching command.
3162 : : */
3163 : : static bool
2572 tgl@sss.pgh.pa.us 3164 :UBC 0 : is_branching_command(const char *cmd)
3165 : : {
3166 : 0 : return (strcmp(cmd, "if") == 0 ||
3167 [ # # ]: 0 : strcmp(cmd, "elif") == 0 ||
3168 [ # # # # ]: 0 : strcmp(cmd, "else") == 0 ||
3169 [ # # ]: 0 : strcmp(cmd, "endif") == 0);
3170 : : }
3171 : :
3172 : : /*
3173 : : * Prepare to possibly restore query buffer to its current state
3174 : : * (cf. discard_query_text).
3175 : : *
3176 : : * We need to remember the length of the query buffer, and the lexer's
3177 : : * notion of the parenthesis nesting depth.
3178 : : */
3179 : : static void
2572 tgl@sss.pgh.pa.us 3180 :CBC 122 : save_query_text_state(PsqlScanState scan_state, ConditionalStack cstack,
3181 : : PQExpBuffer query_buf)
3182 : : {
3183 [ + - ]: 122 : if (query_buf)
3184 : 122 : conditional_stack_set_query_len(cstack, query_buf->len);
3185 : 122 : conditional_stack_set_paren_depth(cstack,
3186 : : psql_scan_get_paren_depth(scan_state));
3187 : 122 : }
3188 : :
3189 : : /*
3190 : : * Discard any query text absorbed during an inactive conditional branch.
3191 : : *
3192 : : * We must discard data that was appended to query_buf during an inactive
3193 : : * \if branch. We don't have to do anything there if there's no query_buf.
3194 : : *
3195 : : * Also, reset the lexer state to the same paren depth there was before.
3196 : : * (The rest of its state doesn't need attention, since we could not be
3197 : : * inside a comment or literal or partial token.)
3198 : : */
3199 : : static void
3200 : 104 : discard_query_text(PsqlScanState scan_state, ConditionalStack cstack,
3201 : : PQExpBuffer query_buf)
3202 : : {
3203 [ + - ]: 104 : if (query_buf)
3204 : : {
3205 : 104 : int new_len = conditional_stack_get_query_len(cstack);
3206 : :
3207 [ + - + - ]: 104 : Assert(new_len >= 0 && new_len <= query_buf->len);
3208 : 104 : query_buf->len = new_len;
3209 : 104 : query_buf->data[new_len] = '\0';
3210 : : }
3211 : 104 : psql_scan_set_paren_depth(scan_state,
3212 : : conditional_stack_get_paren_depth(cstack));
3213 : 104 : }
3214 : :
3215 : : /*
3216 : : * If query_buf is empty, copy previous_buf into it.
3217 : : *
3218 : : * This is used by various slash commands for which re-execution of a
3219 : : * previous query is a common usage. For convenience, we allow the
3220 : : * case of query_buf == NULL (and do nothing).
3221 : : *
3222 : : * Returns "true" if the previous query was copied into the query
3223 : : * buffer, else "false".
3224 : : */
3225 : : static bool
3226 : 542 : copy_previous_query(PQExpBuffer query_buf, PQExpBuffer previous_buf)
3227 : : {
3228 [ + - + + ]: 542 : if (query_buf && query_buf->len == 0)
3229 : : {
3230 : 48 : appendPQExpBufferStr(query_buf, previous_buf->data);
1107 3231 : 48 : return true;
3232 : : }
3233 : 494 : return false;
3234 : : }
3235 : :
3236 : : /*
3237 : : * Ask the user for a password; 'username' is the username the
3238 : : * password is for, if one has been explicitly specified.
3239 : : * Returns a malloc'd string.
3240 : : * If 'canceled' is provided, *canceled will be set to true if the prompt
3241 : : * is canceled via SIGINT, and to false otherwise.
3242 : : */
3243 : : static char *
877 tgl@sss.pgh.pa.us 3244 :UBC 0 : prompt_for_password(const char *username, bool *canceled)
3245 : : {
3246 : : char *result;
3247 : : PromptInterruptContext prompt_ctx;
3248 : :
3249 : : /* Set up to let SIGINT cancel simple_prompt_extended() */
3250 : 0 : prompt_ctx.jmpbuf = sigint_interrupt_jmp;
3251 : 0 : prompt_ctx.enabled = &sigint_interrupt_enabled;
3252 : 0 : prompt_ctx.canceled = false;
3253 : :
2267 3254 [ # # # # ]: 0 : if (username == NULL || username[0] == '\0')
877 3255 : 0 : result = simple_prompt_extended("Password: ", false, &prompt_ctx);
3256 : : else
3257 : : {
3258 : : char *prompt_text;
3259 : :
3827 3260 : 0 : prompt_text = psprintf(_("Password for user %s: "), username);
877 3261 : 0 : result = simple_prompt_extended(prompt_text, false, &prompt_ctx);
6587 neilc@samurai.com 3262 : 0 : free(prompt_text);
3263 : : }
3264 : :
877 tgl@sss.pgh.pa.us 3265 [ # # ]: 0 : if (canceled)
3266 : 0 : *canceled = prompt_ctx.canceled;
3267 : :
1319 3268 : 0 : return result;
3269 : : }
3270 : :
3271 : : static bool
6587 neilc@samurai.com 3272 :CBC 24 : param_is_newly_set(const char *old_val, const char *new_val)
3273 : : {
3274 [ - + ]: 24 : if (new_val == NULL)
6587 neilc@samurai.com 3275 :UBC 0 : return false;
3276 : :
6587 neilc@samurai.com 3277 [ + - - + ]:CBC 24 : if (old_val == NULL || strcmp(old_val, new_val) != 0)
6587 neilc@samurai.com 3278 :UBC 0 : return true;
3279 : :
6587 neilc@samurai.com 3280 :CBC 24 : return false;
3281 : : }
3282 : :
3283 : : /*
3284 : : * do_connect -- handler for \connect
3285 : : *
3286 : : * Connects to a database with given parameters. If we are told to re-use
3287 : : * parameters, parameters from the previous connection are used where the
3288 : : * command's own options do not supply a value. Otherwise, libpq defaults
3289 : : * are used.
3290 : : *
3291 : : * In interactive mode, if connection fails with the given parameters,
3292 : : * the old connection will be kept.
3293 : : */
3294 : : static bool
2806 noah@leadboat.com 3295 : 149 : do_connect(enum trivalue reuse_previous_specification,
3296 : : char *dbname, char *user, char *host, char *port)
3297 : : {
6402 bruce@momjian.us 3298 : 149 : PGconn *o_conn = pset.db,
1271 tgl@sss.pgh.pa.us 3299 : 149 : *n_conn = NULL;
3300 : : PQconninfoOption *cinfo;
3301 : 149 : int nconnopts = 0;
3302 : 149 : bool same_host = false;
6402 bruce@momjian.us 3303 : 149 : char *password = NULL;
3304 : : char *client_encoding;
1271 tgl@sss.pgh.pa.us 3305 : 149 : bool success = true;
3306 : 149 : bool keep_password = true;
3307 : : bool has_connection_string;
3308 : : bool reuse_previous;
3309 : :
1270 3310 : 149 : has_connection_string = dbname ?
3311 [ + + + + ]: 149 : recognized_connection_string(dbname) : false;
3312 : :
3313 : : /* Complain if we have additional arguments after a connection string. */
3314 [ + + + - : 149 : if (has_connection_string && (user || host || port))
+ - - + ]
3315 : : {
1270 tgl@sss.pgh.pa.us 3316 :UBC 0 : pg_log_error("Do not give user, host, or port separately when using a connection string");
4260 bruce@momjian.us 3317 : 0 : return false;
3318 : : }
3319 : :
2806 noah@leadboat.com 3320 [ + - + ]:CBC 149 : switch (reuse_previous_specification)
3321 : : {
3322 : 8 : case TRI_YES:
3323 : 8 : reuse_previous = true;
3324 : 8 : break;
2806 noah@leadboat.com 3325 :UBC 0 : case TRI_NO:
3326 : 0 : reuse_previous = false;
3327 : 0 : break;
2806 noah@leadboat.com 3328 :CBC 141 : default:
3329 : 141 : reuse_previous = !has_connection_string;
3330 : 141 : break;
3331 : : }
3332 : :
3333 : : /*
3334 : : * If we intend to re-use connection parameters, collect them out of the
3335 : : * old connection, then replace individual values as necessary. (We may
3336 : : * need to resort to looking at pset.dead_conn, if the connection died
3337 : : * previously.) Otherwise, obtain a PQconninfoOption array containing
3338 : : * libpq's defaults, and modify that. Note this function assumes that
3339 : : * PQconninfo, PQconndefaults, and PQconninfoParse will all produce arrays
3340 : : * containing the same options in the same order.
3341 : : */
1973 alvherre@alvh.no-ip. 3342 [ + - ]: 149 : if (reuse_previous)
3343 : : {
1269 tgl@sss.pgh.pa.us 3344 [ + - ]: 149 : if (o_conn)
3345 : 149 : cinfo = PQconninfo(o_conn);
1269 tgl@sss.pgh.pa.us 3346 [ # # ]:UBC 0 : else if (pset.dead_conn)
3347 : 0 : cinfo = PQconninfo(pset.dead_conn);
3348 : : else
3349 : : {
3350 : : /* This is reachable after a non-interactive \connect failure */
3351 : 0 : pg_log_error("No database connection exists to re-use parameters from");
3352 : 0 : return false;
3353 : : }
3354 : : }
3355 : : else
1271 3356 : 0 : cinfo = PQconndefaults();
3357 : :
1271 tgl@sss.pgh.pa.us 3358 [ + - ]:CBC 149 : if (cinfo)
3359 : : {
3360 [ + + ]: 149 : if (has_connection_string)
3361 : : {
3362 : : /* Parse the connstring and insert values into cinfo */
3363 : : PQconninfoOption *replcinfo;
3364 : : char *errmsg;
3365 : :
3366 : 8 : replcinfo = PQconninfoParse(dbname, &errmsg);
3367 [ + - ]: 8 : if (replcinfo)
3368 : : {
3369 : : PQconninfoOption *ci;
3370 : : PQconninfoOption *replci;
1270 3371 : 8 : bool have_password = false;
3372 : :
1271 3373 : 8 : for (ci = cinfo, replci = replcinfo;
3374 [ + + + - ]: 336 : ci->keyword && replci->keyword;
3375 : 328 : ci++, replci++)
3376 : : {
3377 [ - + ]: 328 : Assert(strcmp(ci->keyword, replci->keyword) == 0);
3378 : : /* Insert value from connstring if one was provided */
3379 [ + + ]: 328 : if (replci->val)
3380 : : {
3381 : : /*
3382 : : * We know that both val strings were allocated by
3383 : : * libpq, so the least messy way to avoid memory leaks
3384 : : * is to swap them.
3385 : : */
3386 : 8 : char *swap = replci->val;
3387 : :
3388 : 8 : replci->val = ci->val;
3389 : 8 : ci->val = swap;
3390 : :
3391 : : /*
3392 : : * Check whether connstring provides options affecting
3393 : : * password re-use. While any change in user, host,
3394 : : * hostaddr, or port causes us to ignore the old
3395 : : * connection's password, we don't force that for
3396 : : * dbname, since passwords aren't database-specific.
3397 : : */
1270 3398 [ + - ]: 8 : if (replci->val == NULL ||
3399 [ + - ]: 8 : strcmp(ci->val, replci->val) != 0)
3400 : : {
3401 [ + - ]: 8 : if (strcmp(replci->keyword, "user") == 0 ||
3402 [ + - ]: 8 : strcmp(replci->keyword, "host") == 0 ||
3403 [ + - ]: 8 : strcmp(replci->keyword, "hostaddr") == 0 ||
3404 [ - + ]: 8 : strcmp(replci->keyword, "port") == 0)
1270 tgl@sss.pgh.pa.us 3405 :UBC 0 : keep_password = false;
3406 : : }
3407 : : /* Also note whether connstring contains a password. */
1270 tgl@sss.pgh.pa.us 3408 [ - + ]:CBC 8 : if (strcmp(replci->keyword, "password") == 0)
1270 tgl@sss.pgh.pa.us 3409 :UBC 0 : have_password = true;
3410 : : }
1118 tgl@sss.pgh.pa.us 3411 [ - + ]:CBC 320 : else if (!reuse_previous)
3412 : : {
3413 : : /*
3414 : : * When we have a connstring and are not re-using
3415 : : * parameters, swap *all* entries, even those not set
3416 : : * by the connstring. This avoids absorbing
3417 : : * environment-dependent defaults from the result of
3418 : : * PQconndefaults(). We don't want to do that because
3419 : : * they'd override service-file entries if the
3420 : : * connstring specifies a service parameter, whereas
3421 : : * the priority should be the other way around. libpq
3422 : : * can certainly recompute any defaults we don't pass
3423 : : * here. (In this situation, it's a bit wasteful to
3424 : : * have called PQconndefaults() at all, but not doing
3425 : : * so would require yet another major code path here.)
3426 : : */
1118 tgl@sss.pgh.pa.us 3427 :UBC 0 : replci->val = ci->val;
3428 : 0 : ci->val = NULL;
3429 : : }
3430 : : }
1271 tgl@sss.pgh.pa.us 3431 [ + - + - ]:CBC 8 : Assert(ci->keyword == NULL && replci->keyword == NULL);
3432 : :
3433 : : /* While here, determine how many option slots there are */
3434 : 8 : nconnopts = ci - cinfo;
3435 : :
3436 : 8 : PQconninfoFree(replcinfo);
3437 : :
3438 : : /*
3439 : : * If the connstring contains a password, tell the loop below
3440 : : * that we may use it, regardless of other settings (i.e.,
3441 : : * cinfo's password is no longer an "old" password).
3442 : : */
1270 3443 [ - + ]: 8 : if (have_password)
1270 tgl@sss.pgh.pa.us 3444 :UBC 0 : keep_password = true;
3445 : :
3446 : : /* Don't let code below try to inject dbname into params. */
1271 tgl@sss.pgh.pa.us 3447 :CBC 8 : dbname = NULL;
3448 : : }
3449 : : else
3450 : : {
3451 : : /* PQconninfoParse failed */
1271 tgl@sss.pgh.pa.us 3452 [ # # ]:UBC 0 : if (errmsg)
3453 : : {
3454 : 0 : pg_log_error("%s", errmsg);
3455 : 0 : PQfreemem(errmsg);
3456 : : }
3457 : : else
3458 : 0 : pg_log_error("out of memory");
3459 : 0 : success = false;
3460 : : }
3461 : : }
3462 : : else
3463 : : {
3464 : : /*
3465 : : * If dbname isn't a connection string, then we'll inject it and
3466 : : * the other parameters into the keyword array below. (We can't
3467 : : * easily insert them into the cinfo array because of memory
3468 : : * management issues: PQconninfoFree would misbehave on Windows.)
3469 : : * However, to avoid dependencies on the order in which parameters
3470 : : * appear in the array, make a preliminary scan to set
3471 : : * keep_password and same_host correctly.
3472 : : *
3473 : : * While any change in user, host, or port causes us to ignore the
3474 : : * old connection's password, we don't force that for dbname,
3475 : : * since passwords aren't database-specific.
3476 : : */
3477 : : PQconninfoOption *ci;
3478 : :
1271 tgl@sss.pgh.pa.us 3479 [ + + ]:CBC 5922 : for (ci = cinfo; ci->keyword; ci++)
3480 : : {
3481 [ - + - - ]: 5781 : if (user && strcmp(ci->keyword, "user") == 0)
3482 : : {
1271 tgl@sss.pgh.pa.us 3483 [ # # # # ]:UBC 0 : if (!(ci->val && strcmp(user, ci->val) == 0))
3484 : 0 : keep_password = false;
3485 : : }
1271 tgl@sss.pgh.pa.us 3486 [ - + - - ]:CBC 5781 : else if (host && strcmp(ci->keyword, "host") == 0)
3487 : : {
1271 tgl@sss.pgh.pa.us 3488 [ # # # # ]:UBC 0 : if (ci->val && strcmp(host, ci->val) == 0)
3489 : 0 : same_host = true;
3490 : : else
3491 : 0 : keep_password = false;
3492 : : }
1271 tgl@sss.pgh.pa.us 3493 [ - + - - ]:CBC 5781 : else if (port && strcmp(ci->keyword, "port") == 0)
3494 : : {
1271 tgl@sss.pgh.pa.us 3495 [ # # # # ]:UBC 0 : if (!(ci->val && strcmp(port, ci->val) == 0))
3496 : 0 : keep_password = false;
3497 : : }
3498 : : }
3499 : :
3500 : : /* While here, determine how many option slots there are */
1271 tgl@sss.pgh.pa.us 3501 :CBC 141 : nconnopts = ci - cinfo;
3502 : : }
3503 : : }
3504 : : else
3505 : : {
3506 : : /* We failed to create the cinfo structure */
1271 tgl@sss.pgh.pa.us 3507 :UBC 0 : pg_log_error("out of memory");
3508 : 0 : success = false;
3509 : : }
3510 : :
3511 : : /*
3512 : : * If the user asked to be prompted for a password, ask for one now. If
3513 : : * not, use the password from the old connection, provided the username
3514 : : * etc have not changed. Otherwise, try to connect without a password
3515 : : * first, and then ask for a password if needed.
3516 : : *
3517 : : * XXX: this behavior leads to spurious connection attempts recorded in
3518 : : * the postmaster's log. But libpq offers no API that would let us obtain
3519 : : * a password and then continue with the first connection attempt.
3520 : : */
1271 tgl@sss.pgh.pa.us 3521 [ - + - - ]:CBC 149 : if (pset.getPassword == TRI_YES && success)
3522 : : {
877 tgl@sss.pgh.pa.us 3523 :UBC 0 : bool canceled = false;
3524 : :
3525 : : /*
3526 : : * If a connstring or URI is provided, we don't know which username
3527 : : * will be used, since we haven't dug that out of the connstring.
3528 : : * Don't risk issuing a misleading prompt. As in startup.c, it does
3529 : : * not seem worth working harder, since this getPassword setting is
3530 : : * normally only used in noninteractive cases.
3531 : : */
3532 [ # # ]: 0 : password = prompt_for_password(has_connection_string ? NULL : user,
3533 : : &canceled);
3534 : 0 : success = !canceled;
3535 : : }
3536 : :
3537 : : /*
3538 : : * Consider whether to force client_encoding to "auto" (overriding
3539 : : * anything in the connection string). We do so if we have a terminal
3540 : : * connection and there is no PGCLIENTENCODING environment setting.
3541 : : */
1232 tgl@sss.pgh.pa.us 3542 [ - + - - ]:CBC 149 : if (pset.notty || getenv("PGCLIENTENCODING"))
3543 : 149 : client_encoding = NULL;
3544 : : else
1232 tgl@sss.pgh.pa.us 3545 :UBC 0 : client_encoding = "auto";
3546 : :
3547 : : /* Loop till we have a connection or fail, which we might've already */
1271 tgl@sss.pgh.pa.us 3548 [ + - ]:CBC 149 : while (success)
3549 : : {
3550 : 149 : const char **keywords = pg_malloc((nconnopts + 1) * sizeof(*keywords));
3551 : 149 : const char **values = pg_malloc((nconnopts + 1) * sizeof(*values));
3552 : 149 : int paramnum = 0;
3553 : : PQconninfoOption *ci;
3554 : :
3555 : : /*
3556 : : * Copy non-default settings into the PQconnectdbParams parameter
3557 : : * arrays; but inject any values specified old-style, as well as any
3558 : : * interactively-obtained password, and a couple of fields we want to
3559 : : * set forcibly.
3560 : : *
3561 : : * If you change this code, see also the initial-connection code in
3562 : : * main().
3563 : : */
3564 [ + + ]: 6258 : for (ci = cinfo; ci->keyword; ci++)
3565 : : {
3566 : 6109 : keywords[paramnum] = ci->keyword;
3567 : :
3568 [ + + + + ]: 6109 : if (dbname && strcmp(ci->keyword, "dbname") == 0)
3569 : 6 : values[paramnum++] = dbname;
3570 [ - + - - ]: 6103 : else if (user && strcmp(ci->keyword, "user") == 0)
1271 tgl@sss.pgh.pa.us 3571 :UBC 0 : values[paramnum++] = user;
1271 tgl@sss.pgh.pa.us 3572 [ - + - - ]:CBC 6103 : else if (host && strcmp(ci->keyword, "host") == 0)
1271 tgl@sss.pgh.pa.us 3573 :UBC 0 : values[paramnum++] = host;
1271 tgl@sss.pgh.pa.us 3574 [ - + - - :CBC 6103 : else if (host && !same_host && strcmp(ci->keyword, "hostaddr") == 0)
- - ]
3575 : : {
3576 : : /* If we're changing the host value, drop any old hostaddr */
1271 tgl@sss.pgh.pa.us 3577 :UBC 0 : values[paramnum++] = NULL;
3578 : : }
1271 tgl@sss.pgh.pa.us 3579 [ - + - - ]:CBC 6103 : else if (port && strcmp(ci->keyword, "port") == 0)
1271 tgl@sss.pgh.pa.us 3580 :UBC 0 : values[paramnum++] = port;
3581 : : /* If !keep_password, we unconditionally drop old password */
1270 tgl@sss.pgh.pa.us 3582 [ + - - + ]:CBC 6103 : else if ((password || !keep_password) &&
1270 tgl@sss.pgh.pa.us 3583 [ # # ]:UBC 0 : strcmp(ci->keyword, "password") == 0)
1271 3584 : 0 : values[paramnum++] = password;
1271 tgl@sss.pgh.pa.us 3585 [ + + ]:CBC 6103 : else if (strcmp(ci->keyword, "fallback_application_name") == 0)
3586 : 149 : values[paramnum++] = pset.progname;
1232 3587 [ - + ]: 5954 : else if (client_encoding &&
1232 tgl@sss.pgh.pa.us 3588 [ # # ]:UBC 0 : strcmp(ci->keyword, "client_encoding") == 0)
3589 : 0 : values[paramnum++] = client_encoding;
1271 tgl@sss.pgh.pa.us 3590 [ + + ]:CBC 5954 : else if (ci->val)
3591 : 2837 : values[paramnum++] = ci->val;
3592 : : /* else, don't bother making libpq parse this keyword */
3593 : : }
3594 : : /* add array terminator */
3595 : 149 : keywords[paramnum] = NULL;
3300 alvherre@alvh.no-ip. 3596 : 149 : values[paramnum] = NULL;
3597 : :
3598 : : /* Note we do not want libpq to re-expand the dbname parameter */
12 rhaas@postgresql.org 3599 :GNC 149 : n_conn = PQconnectStartParams(keywords, values, false);
3600 : :
3300 alvherre@alvh.no-ip. 3601 :CBC 149 : pg_free(keywords);
3602 : 149 : pg_free(values);
3603 : :
12 rhaas@postgresql.org 3604 :GNC 149 : wait_until_connected(n_conn);
6587 neilc@samurai.com 3605 [ + - ]:CBC 149 : if (PQstatus(n_conn) == CONNECTION_OK)
3606 : 149 : break;
3607 : :
3608 : : /*
3609 : : * Connection attempt failed; either retry the connection attempt with
3610 : : * a new password, or give up.
3611 : : */
5526 peter_e@gmx.net 3612 [ # # # # :UBC 0 : if (!password && PQconnectionNeedsPassword(n_conn) && pset.getPassword != TRI_NO)
# # ]
8928 bruce@momjian.us 3613 : 0 : {
877 tgl@sss.pgh.pa.us 3614 : 0 : bool canceled = false;
3615 : :
3616 : : /*
3617 : : * Prompt for password using the username we actually connected
3618 : : * with --- it might've come out of "dbname" rather than "user".
3619 : : */
3620 : 0 : password = prompt_for_password(PQuser(n_conn), &canceled);
6587 neilc@samurai.com 3621 : 0 : PQfinish(n_conn);
1271 tgl@sss.pgh.pa.us 3622 : 0 : n_conn = NULL;
877 3623 : 0 : success = !canceled;
6587 neilc@samurai.com 3624 : 0 : continue;
3625 : : }
3626 : :
3627 : : /*
3628 : : * We'll report the error below ... unless n_conn is NULL, indicating
3629 : : * that libpq didn't have enough memory to make a PGconn.
3630 : : */
1271 tgl@sss.pgh.pa.us 3631 [ # # ]: 0 : if (n_conn == NULL)
3632 : 0 : pg_log_error("out of memory");
3633 : :
3634 : 0 : success = false;
3635 : : } /* end retry loop */
3636 : :
3637 : : /* Release locally allocated data, whether we succeeded or not */
667 peter@eisentraut.org 3638 :CBC 149 : pg_free(password);
651 3639 : 149 : PQconninfoFree(cinfo);
3640 : :
1271 tgl@sss.pgh.pa.us 3641 [ - + ]: 149 : if (!success)
3642 : : {
3643 : : /*
3644 : : * Failed to connect to the database. In interactive mode, keep the
3645 : : * previous connection to the DB; in scripting mode, close our
3646 : : * previous connection as well.
3647 : : */
8768 bruce@momjian.us 3648 [ # # ]:UBC 0 : if (pset.cur_cmd_interactive)
3649 : : {
1271 tgl@sss.pgh.pa.us 3650 [ # # ]: 0 : if (n_conn)
3651 : : {
3652 : 0 : pg_log_info("%s", PQerrorMessage(n_conn));
3653 : 0 : PQfinish(n_conn);
3654 : : }
3655 : :
3656 : : /* pset.db is left unmodified */
6587 neilc@samurai.com 3657 [ # # ]: 0 : if (o_conn)
1840 peter@eisentraut.org 3658 : 0 : pg_log_info("Previous connection kept");
3659 : : }
3660 : : else
3661 : : {
1271 tgl@sss.pgh.pa.us 3662 [ # # ]: 0 : if (n_conn)
3663 : : {
3664 : 0 : pg_log_error("\\connect: %s", PQerrorMessage(n_conn));
3665 : 0 : PQfinish(n_conn);
3666 : : }
3667 : :
6587 neilc@samurai.com 3668 [ # # ]: 0 : if (o_conn)
3669 : : {
3670 : : /*
3671 : : * Transition to having no connection.
3672 : : *
3673 : : * Unlike CheckConnection(), we close the old connection
3674 : : * immediately to prevent its parameters from being re-used.
3675 : : * This is so that a script cannot accidentally reuse
3676 : : * parameters it did not expect to. Otherwise, the state
3677 : : * cleanup should be the same as in CheckConnection().
3678 : : */
3679 : 0 : PQfinish(o_conn);
3680 : 0 : pset.db = NULL;
1686 tgl@sss.pgh.pa.us 3681 : 0 : ResetCancelConn();
3682 : 0 : UnsyncVariables();
3683 : : }
3684 : :
3685 : : /* On the same reasoning, release any dead_conn to prevent reuse */
1269 3686 [ # # ]: 0 : if (pset.dead_conn)
3687 : : {
3688 : 0 : PQfinish(pset.dead_conn);
3689 : 0 : pset.dead_conn = NULL;
3690 : : }
3691 : : }
3692 : :
6587 neilc@samurai.com 3693 : 0 : return false;
3694 : : }
3695 : :
3696 : : /*
3697 : : * Replace the old connection with the new one, and update
3698 : : * connection-dependent variables. Keep the resynchronization logic in
3699 : : * sync with CheckConnection().
3700 : : */
6587 neilc@samurai.com 3701 :CBC 149 : PQsetNoticeProcessor(n_conn, NoticeProcessor, NULL);
3702 : 149 : pset.db = n_conn;
7596 tgl@sss.pgh.pa.us 3703 : 149 : SyncVariables();
5161 bruce@momjian.us 3704 : 149 : connection_warnings(false); /* Must be after SyncVariables */
3705 : :
3706 : : /* Tell the user about the new connection */
6438 tgl@sss.pgh.pa.us 3707 [ + + ]: 149 : if (!pset.quiet)
3708 : : {
3203 noah@leadboat.com 3709 [ + - + - ]: 24 : if (!o_conn ||
3710 [ - + ]: 24 : param_is_newly_set(PQhost(o_conn), PQhost(pset.db)) ||
5003 tgl@sss.pgh.pa.us 3711 : 12 : param_is_newly_set(PQport(o_conn), PQport(pset.db)))
5014 rhaas@postgresql.org 3712 :UBC 0 : {
557 drowley@postgresql.o 3713 : 0 : char *connhost = PQhost(pset.db);
1973 alvherre@alvh.no-ip. 3714 : 0 : char *hostaddr = PQhostaddr(pset.db);
3715 : :
557 drowley@postgresql.o 3716 [ # # ]: 0 : if (is_unixsock_path(connhost))
3717 : : {
3718 : : /* hostaddr overrides connhost */
1973 alvherre@alvh.no-ip. 3719 [ # # # # ]: 0 : if (hostaddr && *hostaddr)
3720 : 0 : printf(_("You are now connected to database \"%s\" as user \"%s\" on address \"%s\" at port \"%s\".\n"),
3721 : : PQdb(pset.db), PQuser(pset.db), hostaddr, PQport(pset.db));
3722 : : else
3723 : 0 : printf(_("You are now connected to database \"%s\" as user \"%s\" via socket in \"%s\" at port \"%s\".\n"),
3724 : : PQdb(pset.db), PQuser(pset.db), connhost, PQport(pset.db));
3725 : : }
3726 : : else
3727 : : {
557 drowley@postgresql.o 3728 [ # # # # : 0 : if (hostaddr && *hostaddr && strcmp(connhost, hostaddr) != 0)
# # ]
1973 alvherre@alvh.no-ip. 3729 : 0 : printf(_("You are now connected to database \"%s\" as user \"%s\" on host \"%s\" (address \"%s\") at port \"%s\".\n"),
3730 : : PQdb(pset.db), PQuser(pset.db), connhost, hostaddr, PQport(pset.db));
3731 : : else
3732 : 0 : printf(_("You are now connected to database \"%s\" as user \"%s\" on host \"%s\" at port \"%s\".\n"),
3733 : : PQdb(pset.db), PQuser(pset.db), connhost, PQport(pset.db));
3734 : : }
3735 : : }
3736 : : else
5003 tgl@sss.pgh.pa.us 3737 :CBC 12 : printf(_("You are now connected to database \"%s\" as user \"%s\".\n"),
3738 : : PQdb(pset.db), PQuser(pset.db));
3739 : : }
3740 : :
3741 : : /* Drop no-longer-needed connection(s) */
6587 neilc@samurai.com 3742 [ + - ]: 149 : if (o_conn)
3743 : 149 : PQfinish(o_conn);
1269 tgl@sss.pgh.pa.us 3744 [ - + ]: 149 : if (pset.dead_conn)
3745 : : {
1269 tgl@sss.pgh.pa.us 3746 :UBC 0 : PQfinish(pset.dead_conn);
3747 : 0 : pset.dead_conn = NULL;
3748 : : }
3749 : :
6587 neilc@samurai.com 3750 :CBC 149 : return true;
3751 : : }
3752 : :
3753 : : /*
3754 : : * Processes the connection sequence described by PQconnectStartParams(). Don't
3755 : : * worry about reporting errors in this function. Our caller will check the
3756 : : * connection's status, and report appropriately.
3757 : : */
3758 : : static void
12 rhaas@postgresql.org 3759 :GNC 149 : wait_until_connected(PGconn *conn)
3760 : : {
3761 : 149 : bool forRead = false;
3762 : :
3763 : : while (true)
3764 : 155 : {
3765 : : int rc;
3766 : : int sock;
3767 : : time_t end_time;
3768 : :
3769 : : /*
3770 : : * On every iteration of the connection sequence, let's check if the
3771 : : * user has requested a cancellation.
3772 : : */
3773 [ - + ]: 304 : if (cancel_pressed)
12 rhaas@postgresql.org 3774 :UNC 0 : break;
3775 : :
3776 : : /*
3777 : : * Do not assume that the socket remains the same across
3778 : : * PQconnectPoll() calls.
3779 : : */
12 rhaas@postgresql.org 3780 :GNC 304 : sock = PQsocket(conn);
3781 [ - + ]: 304 : if (sock == -1)
12 rhaas@postgresql.org 3782 :UNC 0 : break;
3783 : :
3784 : : /*
3785 : : * If the user sends SIGINT between the cancel_pressed check, and
3786 : : * polling of the socket, it will not be recognized. Instead, we will
3787 : : * just wait until the next step in the connection sequence or
3788 : : * forever, which might require users to send SIGTERM or SIGQUIT.
3789 : : *
3790 : : * Some solutions would include the "self-pipe trick," using
3791 : : * pselect(2) and ppoll(2), or using a timeout.
3792 : : *
3793 : : * The self-pipe trick requires a bit of code to setup. pselect(2) and
3794 : : * ppoll(2) are not on all the platforms we support. The simplest
3795 : : * solution happens to just be adding a timeout, so let's wait for 1
3796 : : * second and check cancel_pressed again.
3797 : : */
12 rhaas@postgresql.org 3798 :GNC 304 : end_time = time(NULL) + 1;
3799 : 304 : rc = PQsocketPoll(sock, forRead, !forRead, end_time);
3800 [ - + ]: 304 : if (rc == -1)
12 rhaas@postgresql.org 3801 :UNC 0 : return;
3802 : :
12 rhaas@postgresql.org 3803 [ + + - - :GNC 304 : switch (PQconnectPoll(conn))
- ]
3804 : : {
3805 : 149 : case PGRES_POLLING_OK:
3806 : : case PGRES_POLLING_FAILED:
3807 : 149 : return;
3808 : 155 : case PGRES_POLLING_READING:
3809 : 155 : forRead = true;
3810 : 155 : continue;
12 rhaas@postgresql.org 3811 :UNC 0 : case PGRES_POLLING_WRITING:
3812 : 0 : forRead = false;
3813 : 0 : continue;
3814 : 0 : case PGRES_POLLING_ACTIVE:
3815 : 0 : pg_unreachable();
3816 : : }
3817 : : }
3818 : : }
3819 : :
3820 : : void
5171 bruce@momjian.us 3821 :CBC 151 : connection_warnings(bool in_startup)
3822 : : {
5766 3823 [ + + + + ]: 151 : if (!pset.quiet && !pset.notty)
3824 : : {
4037 heikki.linnakangas@i 3825 : 2 : int client_ver = PG_VERSION_NUM;
3826 : : char cverbuf[32];
3827 : : char sverbuf[32];
3828 : :
5766 bruce@momjian.us 3829 [ - + ]: 2 : if (pset.sversion != client_ver)
3830 : : {
3831 : : const char *server_version;
3832 : :
3833 : : /* Try to get full text form, might include "devel" etc */
5766 bruce@momjian.us 3834 :UBC 0 : server_version = PQparameterStatus(pset.db, "server_version");
3835 : : /* Otherwise fall back on pset.sversion */
3836 [ # # ]: 0 : if (!server_version)
3837 : : {
2798 tgl@sss.pgh.pa.us 3838 : 0 : formatPGVersionNumber(pset.sversion, true,
3839 : : sverbuf, sizeof(sverbuf));
3840 : 0 : server_version = sverbuf;
3841 : : }
3842 : :
5421 bruce@momjian.us 3843 : 0 : printf(_("%s (%s, server %s)\n"),
3844 : : pset.progname, PG_VERSION, server_version);
3845 : : }
3846 : : /* For version match, only print psql banner on startup. */
5171 bruce@momjian.us 3847 [ + - ]:CBC 2 : else if (in_startup)
5766 3848 : 2 : printf("%s (%s)\n", pset.progname, PG_VERSION);
3849 : :
3850 : : /*
3851 : : * Warn if server's major version is newer than ours, or if server
3852 : : * predates our support cutoff (currently 9.2).
3853 : : */
850 tgl@sss.pgh.pa.us 3854 [ + - ]: 2 : if (pset.sversion / 100 > client_ver / 100 ||
3855 [ - + ]: 2 : pset.sversion < 90200)
2798 tgl@sss.pgh.pa.us 3856 :UBC 0 : printf(_("WARNING: %s major version %s, server major version %s.\n"
3857 : : " Some psql features might not work.\n"),
3858 : : pset.progname,
3859 : : formatPGVersionNumber(client_ver, false,
3860 : : cverbuf, sizeof(cverbuf)),
3861 : : formatPGVersionNumber(pset.sversion, false,
3862 : : sverbuf, sizeof(sverbuf)));
3863 : :
3864 : : #ifdef WIN32
3865 : : if (in_startup)
3866 : : checkWin32Codepage();
3867 : : #endif
5766 bruce@momjian.us 3868 :CBC 2 : printSSLInfo();
1838 sfrost@snowman.net 3869 : 2 : printGSSInfo();
3870 : : }
5766 bruce@momjian.us 3871 : 151 : }
3872 : :
3873 : :
3874 : : /*
3875 : : * printSSLInfo
3876 : : *
3877 : : * Prints information about the current SSL connection, if SSL is in use
3878 : : */
3879 : : static void
3880 : 2 : printSSLInfo(void)
3881 : : {
3882 : : const char *protocol;
3883 : : const char *cipher;
3884 : : const char *compression;
3885 : : const char *alpn;
3886 : :
3358 heikki.linnakangas@i 3887 [ + - ]: 2 : if (!PQsslInUse(pset.db))
5766 bruce@momjian.us 3888 : 2 : return; /* no SSL */
3889 : :
3358 heikki.linnakangas@i 3890 :UBC 0 : protocol = PQsslAttribute(pset.db, "protocol");
3891 : 0 : cipher = PQsslAttribute(pset.db, "cipher");
1131 michael@paquier.xyz 3892 : 0 : compression = PQsslAttribute(pset.db, "compression");
6 heikki.linnakangas@i 3893 :UNC 0 : alpn = PQsslAttribute(pset.db, "alpn");
3894 : :
3895 [ # # # # : 0 : printf(_("SSL connection (protocol: %s, cipher: %s, compression: %s, ALPN: %s)\n"),
# # # # #
# ]
3896 : : protocol ? protocol : _("unknown"),
3897 : : cipher ? cipher : _("unknown"),
3898 : : (compression && strcmp(compression, "off") != 0) ? _("on") : _("off"),
3899 : : alpn ? alpn : _("none"));
3900 : : }
3901 : :
3902 : : /*
3903 : : * printGSSInfo
3904 : : *
3905 : : * Prints information about the current GSSAPI connection, if GSSAPI encryption is in use
3906 : : */
3907 : : static void
1838 sfrost@snowman.net 3908 :CBC 2 : printGSSInfo(void)
3909 : : {
3910 [ + - ]: 2 : if (!PQgssEncInUse(pset.db))
3911 : 2 : return; /* no GSSAPI encryption in use */
3912 : :
1682 peter@eisentraut.org 3913 :UBC 0 : printf(_("GSSAPI-encrypted connection\n"));
3914 : : }
3915 : :
3916 : :
3917 : : /*
3918 : : * checkWin32Codepage
3919 : : *
3920 : : * Prints a warning when win32 console codepage differs from Windows codepage
3921 : : */
3922 : : #ifdef WIN32
3923 : : static void
3924 : : checkWin32Codepage(void)
3925 : : {
3926 : : unsigned int wincp,
3927 : : concp;
3928 : :
3929 : : wincp = GetACP();
3930 : : concp = GetConsoleCP();
3931 : : if (wincp != concp)
3932 : : {
3933 : : printf(_("WARNING: Console code page (%u) differs from Windows code page (%u)\n"
3934 : : " 8-bit characters might not work correctly. See psql reference\n"
3935 : : " page \"Notes for Windows users\" for details.\n"),
3936 : : concp, wincp);
3937 : : }
3938 : : }
3939 : : #endif
3940 : :
3941 : :
3942 : : /*
3943 : : * SyncVariables
3944 : : *
3945 : : * Make psql's internal variables agree with connection state upon
3946 : : * establishing a new connection.
3947 : : */
3948 : : void
7596 tgl@sss.pgh.pa.us 3949 :CBC 8108 : SyncVariables(void)
3950 : : {
3951 : : char vbuf[32];
3952 : : const char *server_version;
3953 : :
3954 : : /* get stuff from connection */
3955 : 8108 : pset.encoding = PQclientEncoding(pset.db);
3956 : 8108 : pset.popt.topt.encoding = pset.encoding;
6438 3957 : 8108 : pset.sversion = PQserverVersion(pset.db);
3958 : :
8768 bruce@momjian.us 3959 : 8108 : SetVariable(pset.vars, "DBNAME", PQdb(pset.db));
3960 : 8108 : SetVariable(pset.vars, "USER", PQuser(pset.db));
3961 : 8108 : SetVariable(pset.vars, "HOST", PQhost(pset.db));
3962 : 8108 : SetVariable(pset.vars, "PORT", PQport(pset.db));
3963 : 8108 : SetVariable(pset.vars, "ENCODING", pg_encoding_to_char(pset.encoding));
3964 : :
3965 : : /* this bit should match connection_warnings(): */
3966 : : /* Try to get full text form of version, might include "devel" etc */
2413 tgl@sss.pgh.pa.us 3967 : 8108 : server_version = PQparameterStatus(pset.db, "server_version");
3968 : : /* Otherwise fall back on pset.sversion */
3969 [ - + ]: 8108 : if (!server_version)
3970 : : {
2413 tgl@sss.pgh.pa.us 3971 :UBC 0 : formatPGVersionNumber(pset.sversion, true, vbuf, sizeof(vbuf));
3972 : 0 : server_version = vbuf;
3973 : : }
2413 tgl@sss.pgh.pa.us 3974 :CBC 8108 : SetVariable(pset.vars, "SERVER_VERSION_NAME", server_version);
3975 : :
3976 : 8108 : snprintf(vbuf, sizeof(vbuf), "%d", pset.sversion);
3977 : 8108 : SetVariable(pset.vars, "SERVER_VERSION_NUM", vbuf);
3978 : :
3979 : : /* send stuff to it, too */
6438 3980 : 8108 : PQsetErrorVerbosity(pset.db, pset.verbosity);
3144 3981 : 8108 : PQsetErrorContextVisibility(pset.db, pset.show_context);
8928 bruce@momjian.us 3982 : 8108 : }
3983 : :
3984 : : /*
3985 : : * UnsyncVariables
3986 : : *
3987 : : * Clear variables that should be not be set when there is no connection.
3988 : : */
3989 : : void
7596 tgl@sss.pgh.pa.us 3990 :UBC 0 : UnsyncVariables(void)
3991 : : {
3992 : 0 : SetVariable(pset.vars, "DBNAME", NULL);
3993 : 0 : SetVariable(pset.vars, "USER", NULL);
3994 : 0 : SetVariable(pset.vars, "HOST", NULL);
3995 : 0 : SetVariable(pset.vars, "PORT", NULL);
3996 : 0 : SetVariable(pset.vars, "ENCODING", NULL);
2413 3997 : 0 : SetVariable(pset.vars, "SERVER_VERSION_NAME", NULL);
3998 : 0 : SetVariable(pset.vars, "SERVER_VERSION_NUM", NULL);
8842 peter_e@gmx.net 3999 : 0 : }
4000 : :
4001 : :
4002 : : /*
4003 : : * helper for do_edit(): actually invoke the editor
4004 : : *
4005 : : * Returns true on success, false if we failed to invoke the editor or
4006 : : * it returned nonzero status. (An error message is printed for failed-
4007 : : * to-invoke cases, but not if the editor returns nonzero status.)
4008 : : */
4009 : : static bool
4994 tgl@sss.pgh.pa.us 4010 : 0 : editFile(const char *fname, int lineno)
4011 : : {
4012 : : const char *editorName;
4648 peter_e@gmx.net 4013 : 0 : const char *editor_lineno_arg = NULL;
4014 : : char *sys;
4015 : : int result;
4016 : :
4139 andrew@dunslane.net 4017 [ # # ]: 0 : Assert(fname != NULL);
4018 : :
4019 : : /* Find an editor to use */
8928 bruce@momjian.us 4020 : 0 : editorName = getenv("PSQL_EDITOR");
4021 [ # # ]: 0 : if (!editorName)
4022 : 0 : editorName = getenv("EDITOR");
4023 [ # # ]: 0 : if (!editorName)
4024 : 0 : editorName = getenv("VISUAL");
4025 [ # # ]: 0 : if (!editorName)
4026 : 0 : editorName = DEFAULT_EDITOR;
4027 : :
4028 : : /* Get line number argument, if we need it. */
4994 tgl@sss.pgh.pa.us 4029 [ # # ]: 0 : if (lineno > 0)
4030 : : {
4648 peter_e@gmx.net 4031 : 0 : editor_lineno_arg = getenv("PSQL_EDITOR_LINENUMBER_ARG");
4032 : : #ifdef DEFAULT_EDITOR_LINENUMBER_ARG
4033 [ # # ]: 0 : if (!editor_lineno_arg)
4034 : 0 : editor_lineno_arg = DEFAULT_EDITOR_LINENUMBER_ARG;
4035 : : #endif
4036 [ # # ]: 0 : if (!editor_lineno_arg)
4037 : : {
1840 peter@eisentraut.org 4038 : 0 : pg_log_error("environment variable PSQL_EDITOR_LINENUMBER_ARG must be set to specify a line number");
4994 tgl@sss.pgh.pa.us 4039 : 0 : return false;
4040 : : }
4041 : : }
4042 : :
4043 : : /*
4044 : : * On Unix the EDITOR value should *not* be quoted, since it might include
4045 : : * switches, eg, EDITOR="pico -t"; it's up to the user to put quotes in it
4046 : : * if necessary. But this policy is not very workable on Windows, due to
4047 : : * severe brain damage in their command shell plus the fact that standard
4048 : : * program paths include spaces.
4049 : : */
4050 : : #ifndef WIN32
4051 [ # # ]: 0 : if (lineno > 0)
3827 4052 : 0 : sys = psprintf("exec %s %s%d '%s'",
4053 : : editorName, editor_lineno_arg, lineno, fname);
4054 : : else
4055 : 0 : sys = psprintf("exec %s '%s'",
4056 : : editorName, fname);
4057 : : #else
4058 : : if (lineno > 0)
4059 : : sys = psprintf("\"%s\" %s%d \"%s\"",
4060 : : editorName, editor_lineno_arg, lineno, fname);
4061 : : else
4062 : : sys = psprintf("\"%s\" \"%s\"",
4063 : : editorName, fname);
4064 : : #endif
594 4065 : 0 : fflush(NULL);
8928 bruce@momjian.us 4066 : 0 : result = system(sys);
8853 peter_e@gmx.net 4067 [ # # ]: 0 : if (result == -1)
1840 peter@eisentraut.org 4068 : 0 : pg_log_error("could not start editor \"%s\"", editorName);
8768 bruce@momjian.us 4069 [ # # ]: 0 : else if (result == 127)
1840 peter@eisentraut.org 4070 : 0 : pg_log_error("could not start /bin/sh");
8928 bruce@momjian.us 4071 : 0 : free(sys);
4072 : :
4073 : 0 : return result == 0;
4074 : : }
4075 : :
4076 : :
4077 : : /*
4078 : : * do_edit -- handler for \e
4079 : : *
4080 : : * If you do not specify a filename, the current query buffer will be copied
4081 : : * into a temporary file.
4082 : : *
4083 : : * After this function is done, the resulting file will be copied back into the
4084 : : * query buffer. As an exception to this, the query buffer will be emptied
4085 : : * if the file was not modified (or the editor failed) and the caller passes
4086 : : * "discard_on_quit" = true.
4087 : : *
4088 : : * If "edited" isn't NULL, *edited will be set to true if the query buffer
4089 : : * is successfully replaced.
4090 : : */
4091 : : static bool
4994 tgl@sss.pgh.pa.us 4092 : 0 : do_edit(const char *filename_arg, PQExpBuffer query_buf,
4093 : : int lineno, bool discard_on_quit, bool *edited)
4094 : : {
4095 : : char fnametmp[MAXPGPATH];
8540 peter_e@gmx.net 4096 : 0 : FILE *stream = NULL;
4097 : : const char *fname;
8928 bruce@momjian.us 4098 : 0 : bool error = false;
4099 : : int fd;
4100 : : struct stat before,
4101 : : after;
4102 : :
4103 [ # # ]: 0 : if (filename_arg)
4104 : 0 : fname = filename_arg;
4105 : : else
4106 : : {
4107 : : /* make a temp file to edit */
4108 : : #ifndef WIN32
7101 4109 : 0 : const char *tmpdir = getenv("TMPDIR");
4110 : :
4111 [ # # ]: 0 : if (!tmpdir)
4112 : 0 : tmpdir = "/tmp";
4113 : : #else
4114 : : char tmpdir[MAXPGPATH];
4115 : : int ret;
4116 : :
4117 : : ret = GetTempPath(MAXPGPATH, tmpdir);
4118 : : if (ret == 0 || ret > MAXPGPATH)
4119 : : {
4120 : : pg_log_error("could not locate temporary directory: %s",
4121 : : !ret ? strerror(errno) : "");
4122 : : return false;
4123 : : }
4124 : : #endif
4125 : :
4126 : : /*
4127 : : * No canonicalize_path() here. EDIT.EXE run from CMD.EXE prepends the
4128 : : * current directory to the supplied path unless we use only
4129 : : * backslashes, so we do that.
4130 : : */
4131 : : #ifndef WIN32
4517 peter_e@gmx.net 4132 : 0 : snprintf(fnametmp, sizeof(fnametmp), "%s%spsql.edit.%d.sql", tmpdir,
6756 bruce@momjian.us 4133 : 0 : "/", (int) getpid());
4134 : : #else
4135 : : snprintf(fnametmp, sizeof(fnametmp), "%s%spsql.edit.%d.sql", tmpdir,
4136 : : "" /* trailing separator already present */ , (int) getpid());
4137 : : #endif
4138 : :
8928 4139 : 0 : fname = (const char *) fnametmp;
4140 : :
8424 4141 : 0 : fd = open(fname, O_WRONLY | O_CREAT | O_EXCL, 0600);
8541 4142 [ # # ]: 0 : if (fd != -1)
4143 : 0 : stream = fdopen(fd, "w");
4144 : :
4145 [ # # # # ]: 0 : if (fd == -1 || !stream)
4146 : : {
1840 peter@eisentraut.org 4147 : 0 : pg_log_error("could not open temporary file \"%s\": %m", fname);
8928 bruce@momjian.us 4148 : 0 : error = true;
4149 : : }
4150 : : else
4151 : : {
4152 : 0 : unsigned int ql = query_buf->len;
4153 : :
4154 : : /* force newline-termination of what we send to editor */
1605 tgl@sss.pgh.pa.us 4155 [ # # # # ]: 0 : if (ql > 0 && query_buf->data[ql - 1] != '\n')
4156 : : {
8928 bruce@momjian.us 4157 : 0 : appendPQExpBufferChar(query_buf, '\n');
4158 : 0 : ql++;
4159 : : }
4160 : :
4161 [ # # ]: 0 : if (fwrite(query_buf->data, 1, ql, stream) != ql)
4162 : : {
1840 peter@eisentraut.org 4163 : 0 : pg_log_error("%s: %m", fname);
4164 : :
3697 sfrost@snowman.net 4165 [ # # ]: 0 : if (fclose(stream) != 0)
1840 peter@eisentraut.org 4166 : 0 : pg_log_error("%s: %m", fname);
4167 : :
3697 sfrost@snowman.net 4168 [ # # ]: 0 : if (remove(fname) != 0)
1840 peter@eisentraut.org 4169 : 0 : pg_log_error("%s: %m", fname);
4170 : :
8928 bruce@momjian.us 4171 : 0 : error = true;
4172 : : }
7384 tgl@sss.pgh.pa.us 4173 [ # # ]: 0 : else if (fclose(stream) != 0)
4174 : : {
1840 peter@eisentraut.org 4175 : 0 : pg_log_error("%s: %m", fname);
3697 sfrost@snowman.net 4176 [ # # ]: 0 : if (remove(fname) != 0)
1840 peter@eisentraut.org 4177 : 0 : pg_log_error("%s: %m", fname);
7384 tgl@sss.pgh.pa.us 4178 : 0 : error = true;
4179 : : }
4180 : : else
4181 : : {
4182 : : struct utimbuf ut;
4183 : :
4184 : : /*
4185 : : * Try to set the file modification time of the temporary file
4186 : : * a few seconds in the past. Otherwise, the low granularity
4187 : : * (one second, or even worse on some filesystems) that we can
4188 : : * portably measure with stat(2) could lead us to not
4189 : : * recognize a modification, if the user typed very quickly.
4190 : : *
4191 : : * This is a rather unlikely race condition, so don't error
4192 : : * out if the utime(2) call fails --- that would make the cure
4193 : : * worse than the disease.
4194 : : */
1129 4195 : 0 : ut.modtime = ut.actime = time(NULL) - 2;
4196 : 0 : (void) utime(fname, &ut);
4197 : : }
4198 : : }
4199 : : }
4200 : :
8928 bruce@momjian.us 4201 [ # # # # ]: 0 : if (!error && stat(fname, &before) != 0)
4202 : : {
1840 peter@eisentraut.org 4203 : 0 : pg_log_error("%s: %m", fname);
8928 bruce@momjian.us 4204 : 0 : error = true;
4205 : : }
4206 : :
4207 : : /* call editor */
4208 [ # # ]: 0 : if (!error)
4994 tgl@sss.pgh.pa.us 4209 : 0 : error = !editFile(fname, lineno);
4210 : :
8928 bruce@momjian.us 4211 [ # # # # ]: 0 : if (!error && stat(fname, &after) != 0)
4212 : : {
1840 peter@eisentraut.org 4213 : 0 : pg_log_error("%s: %m", fname);
8928 bruce@momjian.us 4214 : 0 : error = true;
4215 : : }
4216 : :
4217 : : /* file was edited if the size or modification time has changed */
1129 tgl@sss.pgh.pa.us 4218 [ # # ]: 0 : if (!error &&
4219 [ # # ]: 0 : (before.st_size != after.st_size ||
4220 [ # # ]: 0 : before.st_mtime != after.st_mtime))
4221 : : {
7217 bruce@momjian.us 4222 : 0 : stream = fopen(fname, PG_BINARY_R);
8928 4223 [ # # ]: 0 : if (!stream)
4224 : : {
1840 peter@eisentraut.org 4225 : 0 : pg_log_error("%s: %m", fname);
8928 bruce@momjian.us 4226 : 0 : error = true;
4227 : : }
4228 : : else
4229 : : {
4230 : : /* read file back into query_buf */
4231 : : char line[1024];
4232 : :
4233 : 0 : resetPQExpBuffer(query_buf);
8539 tgl@sss.pgh.pa.us 4234 [ # # ]: 0 : while (fgets(line, sizeof(line), stream) != NULL)
8784 peter_e@gmx.net 4235 : 0 : appendPQExpBufferStr(query_buf, line);
4236 : :
8768 bruce@momjian.us 4237 [ # # ]: 0 : if (ferror(stream))
4238 : : {
1840 peter@eisentraut.org 4239 : 0 : pg_log_error("%s: %m", fname);
8768 bruce@momjian.us 4240 : 0 : error = true;
1107 tgl@sss.pgh.pa.us 4241 : 0 : resetPQExpBuffer(query_buf);
4242 : : }
5699 4243 [ # # ]: 0 : else if (edited)
4244 : : {
4245 : 0 : *edited = true;
4246 : : }
4247 : :
8928 bruce@momjian.us 4248 : 0 : fclose(stream);
4249 : : }
4250 : : }
4251 : : else
4252 : : {
4253 : : /*
4254 : : * If the file was not modified, and the caller requested it, discard
4255 : : * the query buffer.
4256 : : */
1107 tgl@sss.pgh.pa.us 4257 [ # # ]: 0 : if (discard_on_quit)
4258 : 0 : resetPQExpBuffer(query_buf);
4259 : : }
4260 : :
4261 : : /* remove temp file */
8769 bruce@momjian.us 4262 [ # # ]: 0 : if (!filename_arg)
4263 : : {
8768 4264 [ # # ]: 0 : if (remove(fname) == -1)
4265 : : {
1840 peter@eisentraut.org 4266 : 0 : pg_log_error("%s: %m", fname);
8768 bruce@momjian.us 4267 : 0 : error = true;
4268 : : }
4269 : : }
4270 : :
8928 4271 : 0 : return !error;
4272 : : }
4273 : :
4274 : :
4275 : :
4276 : : /*
4277 : : * process_file
4278 : : *
4279 : : * Reads commands from filename and passes them to the main processing loop.
4280 : : * Handler for \i and \ir, but can be used for other things as well. Returns
4281 : : * MainLoop() error code.
4282 : : *
4283 : : * If use_relative_path is true and filename is not an absolute path, then open
4284 : : * the file from where the currently processed file (if any) is located.
4285 : : */
4286 : : int
3050 rhaas@postgresql.org 4287 :CBC 7724 : process_file(char *filename, bool use_relative_path)
4288 : : {
4289 : : FILE *fd;
4290 : : int result;
4291 : : char *oldfilename;
4292 : : char relpath[MAXPGPATH];
4293 : :
8928 bruce@momjian.us 4294 [ + + ]: 7724 : if (!filename)
4295 : : {
4266 rhaas@postgresql.org 4296 : 2139 : fd = stdin;
4297 : 2139 : filename = NULL;
4298 : : }
4299 [ + + ]: 5585 : else if (strcmp(filename, "-") != 0)
4300 : : {
5248 bruce@momjian.us 4301 : 15 : canonicalize_path(filename);
4302 : :
4303 : : /*
4304 : : * If we were asked to resolve the pathname relative to the location
4305 : : * of the currently executing script, and there is one, and this is a
4306 : : * relative pathname, then prepend all but the last pathname component
4307 : : * of the current script to this pathname.
4308 : : */
4301 tgl@sss.pgh.pa.us 4309 [ - + - - ]: 15 : if (use_relative_path && pset.inputfile &&
4301 tgl@sss.pgh.pa.us 4310 [ # # # # ]:UBC 0 : !is_absolute_path(filename) && !has_drive_prefix(filename))
4311 : : {
4312 : 0 : strlcpy(relpath, pset.inputfile, sizeof(relpath));
4666 rhaas@postgresql.org 4313 : 0 : get_parent_directory(relpath);
4314 : 0 : join_path_components(relpath, relpath, filename);
4315 : 0 : canonicalize_path(relpath);
4316 : :
4317 : 0 : filename = relpath;
4318 : : }
4319 : :
5248 bruce@momjian.us 4320 :CBC 15 : fd = fopen(filename, PG_BINARY_R);
4321 : :
4427 peter_e@gmx.net 4322 [ - + ]: 15 : if (!fd)
4323 : : {
1840 peter@eisentraut.org 4324 :UBC 0 : pg_log_error("%s: %m", filename);
4427 peter_e@gmx.net 4325 : 0 : return EXIT_FAILURE;
4326 : : }
4327 : : }
4328 : : else
4329 : : {
4427 peter_e@gmx.net 4330 :CBC 5570 : fd = stdin;
4331 : 5570 : filename = "<stdin>"; /* for future error messages */
4332 : : }
4333 : :
8768 bruce@momjian.us 4334 : 7724 : oldfilename = pset.inputfile;
4335 : 7724 : pset.inputfile = filename;
4336 : :
1840 peter@eisentraut.org 4337 : 7724 : pg_logging_config(pset.inputfile ? 0 : PG_LOG_FLAG_TERSE);
4338 : :
8853 peter_e@gmx.net 4339 : 7724 : result = MainLoop(fd);
4340 : :
4919 rhaas@postgresql.org 4341 [ + + ]: 7712 : if (fd != stdin)
4342 : 15 : fclose(fd);
4343 : :
8848 peter_e@gmx.net 4344 : 7712 : pset.inputfile = oldfilename;
4345 : :
1840 peter@eisentraut.org 4346 : 7712 : pg_logging_config(pset.inputfile ? 0 : PG_LOG_FLAG_TERSE);
4347 : :
8820 peter_e@gmx.net 4348 : 7712 : return result;
4349 : : }
4350 : :
4351 : :
4352 : :
4353 : : static const char *
8928 bruce@momjian.us 4354 : 3 : _align2string(enum printFormat in)
4355 : : {
4356 [ - + - - : 3 : switch (in)
- - - - -
- - ]
4357 : : {
8207 bruce@momjian.us 4358 :UBC 0 : case PRINT_NOTHING:
8928 4359 : 0 : return "nothing";
4360 : : break;
8928 bruce@momjian.us 4361 :CBC 3 : case PRINT_ALIGNED:
4362 : 3 : return "aligned";
4363 : : break;
1986 michael@paquier.xyz 4364 :UBC 0 : case PRINT_ASCIIDOC:
4365 : 0 : return "asciidoc";
4366 : : break;
1966 tgl@sss.pgh.pa.us 4367 : 0 : case PRINT_CSV:
4368 : 0 : return "csv";
4369 : : break;
8928 bruce@momjian.us 4370 : 0 : case PRINT_HTML:
4371 : 0 : return "html";
4372 : : break;
4373 : 0 : case PRINT_LATEX:
4374 : 0 : return "latex";
4375 : : break;
4105 4376 : 0 : case PRINT_LATEX_LONGTABLE:
4377 : 0 : return "latex-longtable";
4378 : : break;
6884 4379 : 0 : case PRINT_TROFF_MS:
4380 : 0 : return "troff-ms";
4381 : : break;
1986 michael@paquier.xyz 4382 : 0 : case PRINT_UNALIGNED:
4383 : 0 : return "unaligned";
4384 : : break;
4385 : 0 : case PRINT_WRAPPED:
4386 : 0 : return "wrapped";
4387 : : break;
4388 : : }
8928 bruce@momjian.us 4389 : 0 : return "unknown";
4390 : : }
4391 : :
4392 : : /*
4393 : : * Parse entered Unicode linestyle. If ok, update *linestyle and return
4394 : : * true, else return false.
4395 : : */
4396 : : static bool
3085 tgl@sss.pgh.pa.us 4397 : 0 : set_unicode_line_style(const char *value, size_t vallen,
4398 : : unicode_linestyle *linestyle)
4399 : : {
3502 sfrost@snowman.net 4400 [ # # ]: 0 : if (pg_strncasecmp("single", value, vallen) == 0)
4401 : 0 : *linestyle = UNICODE_LINESTYLE_SINGLE;
4402 [ # # ]: 0 : else if (pg_strncasecmp("double", value, vallen) == 0)
4403 : 0 : *linestyle = UNICODE_LINESTYLE_DOUBLE;
4404 : : else
4405 : 0 : return false;
4406 : 0 : return true;
4407 : : }
4408 : :
4409 : : static const char *
3502 sfrost@snowman.net 4410 :CBC 9 : _unicode_linestyle2string(int linestyle)
4411 : : {
4412 [ + - - ]: 9 : switch (linestyle)
4413 : : {
4414 : 9 : case UNICODE_LINESTYLE_SINGLE:
4415 : 9 : return "single";
4416 : : break;
3502 sfrost@snowman.net 4417 :UBC 0 : case UNICODE_LINESTYLE_DOUBLE:
4418 : 0 : return "double";
4419 : : break;
4420 : : }
4421 : 0 : return "unknown";
4422 : : }
4423 : :
4424 : : /*
4425 : : * do_pset
4426 : : *
4427 : : * Performs the assignment "param = value", where value could be NULL;
4428 : : * for some params that has an effect such as inversion, for others
4429 : : * it does nothing.
4430 : : *
4431 : : * Adjusts the state of the formatting options at *popt. (In practice that
4432 : : * is always pset.popt, but maybe someday it could be different.)
4433 : : *
4434 : : * If successful and quiet is false, then invokes printPsetInfo() to report
4435 : : * the change.
4436 : : *
4437 : : * Returns true if successful, else false (eg for invalid param or value).
4438 : : */
4439 : : bool
8768 bruce@momjian.us 4440 :CBC 957 : do_pset(const char *param, const char *value, printQueryOpt *popt, bool quiet)
4441 : : {
8928 4442 : 957 : size_t vallen = 0;
4443 : :
4139 andrew@dunslane.net 4444 [ - + ]: 957 : Assert(param != NULL);
4445 : :
8928 bruce@momjian.us 4446 [ + + ]: 957 : if (value)
4447 : 892 : vallen = strlen(value);
4448 : :
4449 : : /* set format */
4450 [ + + ]: 957 : if (strcmp(param, "format") == 0)
4451 : : {
4452 : : static const struct fmt
4453 : : {
4454 : : const char *name;
4455 : : enum printFormat number;
4456 : : } formats[] =
4457 : : {
4458 : : /* remember to update error message below when adding more */
4459 : : {"aligned", PRINT_ALIGNED},
4460 : : {"asciidoc", PRINT_ASCIIDOC},
4461 : : {"csv", PRINT_CSV},
4462 : : {"html", PRINT_HTML},
4463 : : {"latex", PRINT_LATEX},
4464 : : {"troff-ms", PRINT_TROFF_MS},
4465 : : {"unaligned", PRINT_UNALIGNED},
4466 : : {"wrapped", PRINT_WRAPPED}
4467 : : };
4468 : :
4469 [ + - ]: 307 : if (!value)
4470 : : ;
4471 : : else
4472 : : {
1978 tgl@sss.pgh.pa.us 4473 : 307 : int match_pos = -1;
4474 : :
4475 [ + + ]: 2742 : for (int i = 0; i < lengthof(formats); i++)
4476 : : {
4477 [ + + ]: 2438 : if (pg_strncasecmp(formats[i].name, value, vallen) == 0)
4478 : : {
4479 [ + + ]: 307 : if (match_pos < 0)
4480 : 304 : match_pos = i;
4481 : : else
4482 : : {
1840 peter@eisentraut.org 4483 : 3 : pg_log_error("\\pset: ambiguous abbreviation \"%s\" matches both \"%s\" and \"%s\"",
4484 : : value,
4485 : : formats[match_pos].name, formats[i].name);
1978 tgl@sss.pgh.pa.us 4486 : 3 : return false;
4487 : : }
4488 : : }
4489 : : }
1966 4490 [ + + ]: 304 : if (match_pos >= 0)
4491 : 301 : popt->topt.format = formats[match_pos].number;
4492 [ + - ]: 3 : else if (pg_strncasecmp("latex-longtable", value, vallen) == 0)
4493 : : {
4494 : : /*
4495 : : * We must treat latex-longtable specially because latex is a
4496 : : * prefix of it; if both were in the table above, we'd think
4497 : : * "latex" is ambiguous.
4498 : : */
4499 : 3 : popt->topt.format = PRINT_LATEX_LONGTABLE;
4500 : : }
4501 : : else
4502 : : {
1840 peter@eisentraut.org 4503 :UBC 0 : pg_log_error("\\pset: allowed formats are aligned, asciidoc, csv, html, latex, latex-longtable, troff-ms, unaligned, wrapped");
1978 tgl@sss.pgh.pa.us 4504 : 0 : return false;
4505 : : }
4506 : : }
4507 : : }
4508 : :
4509 : : /* set table line style */
5297 tgl@sss.pgh.pa.us 4510 [ + + ]:CBC 650 : else if (strcmp(param, "linestyle") == 0)
4511 : : {
4512 [ + - ]: 15 : if (!value)
4513 : : ;
4514 [ + + ]: 15 : else if (pg_strncasecmp("ascii", value, vallen) == 0)
4515 : 9 : popt->topt.line_style = &pg_asciiformat;
5257 4516 [ + - ]: 6 : else if (pg_strncasecmp("old-ascii", value, vallen) == 0)
4517 : 6 : popt->topt.line_style = &pg_asciiformat_old;
5297 tgl@sss.pgh.pa.us 4518 [ # # ]:UBC 0 : else if (pg_strncasecmp("unicode", value, vallen) == 0)
4519 : 0 : popt->topt.line_style = &pg_utf8format;
4520 : : else
4521 : : {
1840 peter@eisentraut.org 4522 : 0 : pg_log_error("\\pset: allowed line styles are ascii, old-ascii, unicode");
5297 tgl@sss.pgh.pa.us 4523 : 0 : return false;
4524 : : }
4525 : : }
4526 : :
4527 : : /* set unicode border line style */
3502 sfrost@snowman.net 4528 [ - + ]:CBC 635 : else if (strcmp(param, "unicode_border_linestyle") == 0)
4529 : : {
3502 sfrost@snowman.net 4530 [ # # ]:UBC 0 : if (!value)
4531 : : ;
3085 tgl@sss.pgh.pa.us 4532 [ # # ]: 0 : else if (set_unicode_line_style(value, vallen,
4533 : : &popt->topt.unicode_border_linestyle))
4534 : 0 : refresh_utf8format(&(popt->topt));
4535 : : else
4536 : : {
1840 peter@eisentraut.org 4537 : 0 : pg_log_error("\\pset: allowed Unicode border line styles are single, double");
3502 sfrost@snowman.net 4538 : 0 : return false;
4539 : : }
4540 : : }
4541 : :
4542 : : /* set unicode column line style */
3502 sfrost@snowman.net 4543 [ - + ]:CBC 635 : else if (strcmp(param, "unicode_column_linestyle") == 0)
4544 : : {
3502 sfrost@snowman.net 4545 [ # # ]:UBC 0 : if (!value)
4546 : : ;
3085 tgl@sss.pgh.pa.us 4547 [ # # ]: 0 : else if (set_unicode_line_style(value, vallen,
4548 : : &popt->topt.unicode_column_linestyle))
4549 : 0 : refresh_utf8format(&(popt->topt));
4550 : : else
4551 : : {
1840 peter@eisentraut.org 4552 : 0 : pg_log_error("\\pset: allowed Unicode column line styles are single, double");
3502 sfrost@snowman.net 4553 : 0 : return false;
4554 : : }
4555 : : }
4556 : :
4557 : : /* set unicode header line style */
3502 sfrost@snowman.net 4558 [ - + ]:CBC 635 : else if (strcmp(param, "unicode_header_linestyle") == 0)
4559 : : {
3502 sfrost@snowman.net 4560 [ # # ]:UBC 0 : if (!value)
4561 : : ;
3085 tgl@sss.pgh.pa.us 4562 [ # # ]: 0 : else if (set_unicode_line_style(value, vallen,
4563 : : &popt->topt.unicode_header_linestyle))
4564 : 0 : refresh_utf8format(&(popt->topt));
4565 : : else
4566 : : {
1840 peter@eisentraut.org 4567 : 0 : pg_log_error("\\pset: allowed Unicode header line styles are single, double");
3502 sfrost@snowman.net 4568 : 0 : return false;
4569 : : }
4570 : : }
4571 : :
4572 : : /* set border style/width */
8928 bruce@momjian.us 4573 [ + + ]:CBC 635 : else if (strcmp(param, "border") == 0)
4574 : : {
4575 [ + - ]: 201 : if (value)
4576 : 201 : popt->topt.border = atoi(value);
4577 : : }
4578 : :
4579 : : /* set expanded/vertical mode */
3392 tgl@sss.pgh.pa.us 4580 [ + - ]: 434 : else if (strcmp(param, "x") == 0 ||
4581 [ + + ]: 434 : strcmp(param, "expanded") == 0 ||
4582 [ - + ]: 269 : strcmp(param, "vertical") == 0)
4583 : : {
4537 peter_e@gmx.net 4584 [ + + - + ]: 165 : if (value && pg_strcasecmp(value, "auto") == 0)
4537 peter_e@gmx.net 4585 :UBC 0 : popt->topt.expanded = 2;
4537 peter_e@gmx.net 4586 [ + + ]:CBC 165 : else if (value)
4587 : : {
4588 : : bool on_off;
4589 : :
2631 tgl@sss.pgh.pa.us 4590 [ + - ]: 130 : if (ParseVariableBool(value, NULL, &on_off))
4591 : 130 : popt->topt.expanded = on_off ? 1 : 0;
4592 : : else
4593 : : {
2631 tgl@sss.pgh.pa.us 4594 :UBC 0 : PsqlVarEnumError(param, value, "on, off, auto");
4595 : 0 : return false;
4596 : : }
4597 : : }
4598 : : else
6252 bruce@momjian.us 4599 :CBC 35 : popt->topt.expanded = !popt->topt.expanded;
4600 : : }
4601 : :
4602 : : /* header line width in expanded mode */
629 andrew@dunslane.net 4603 [ - + ]: 269 : else if (strcmp(param, "xheader_width") == 0)
4604 : : {
331 tgl@sss.pgh.pa.us 4605 [ # # ]:UBC 0 : if (!value)
4606 : : ;
629 andrew@dunslane.net 4607 [ # # ]: 0 : else if (pg_strcasecmp(value, "full") == 0)
4608 : 0 : popt->topt.expanded_header_width_type = PRINT_XHEADER_FULL;
4609 [ # # ]: 0 : else if (pg_strcasecmp(value, "column") == 0)
4610 : 0 : popt->topt.expanded_header_width_type = PRINT_XHEADER_COLUMN;
4611 [ # # ]: 0 : else if (pg_strcasecmp(value, "page") == 0)
4612 : 0 : popt->topt.expanded_header_width_type = PRINT_XHEADER_PAGE;
4613 : : else
4614 : : {
331 alvherre@alvh.no-ip. 4615 : 0 : int intval = atoi(value);
4616 : :
4617 [ # # ]: 0 : if (intval == 0)
4618 : : {
peter@eisentraut.org 4619 : 0 : pg_log_error("\\pset: allowed xheader_width values are \"%s\" (default), \"%s\", \"%s\", or a number specifying the exact width", "full", "column", "page");
629 andrew@dunslane.net 4620 : 0 : return false;
4621 : : }
4622 : :
331 alvherre@alvh.no-ip. 4623 : 0 : popt->topt.expanded_header_width_type = PRINT_XHEADER_EXACT_WIDTH;
4624 : 0 : popt->topt.expanded_header_exact_width = intval;
4625 : : }
4626 : : }
4627 : :
4628 : : /* field separator for CSV format */
1966 tgl@sss.pgh.pa.us 4629 [ + + ]:CBC 269 : else if (strcmp(param, "csv_fieldsep") == 0)
4630 : : {
4631 [ + - ]: 30 : if (value)
4632 : : {
4633 : : /* CSV separator has to be a one-byte character */
4634 [ + + ]: 30 : if (strlen(value) != 1)
4635 : : {
1840 peter@eisentraut.org 4636 : 9 : pg_log_error("\\pset: csv_fieldsep must be a single one-byte character");
1966 tgl@sss.pgh.pa.us 4637 : 9 : return false;
4638 : : }
4639 [ + + + + : 21 : if (value[0] == '"' || value[0] == '\n' || value[0] == '\r')
+ + ]
4640 : : {
1840 peter@eisentraut.org 4641 : 9 : pg_log_error("\\pset: csv_fieldsep cannot be a double quote, a newline, or a carriage return");
1966 tgl@sss.pgh.pa.us 4642 : 9 : return false;
4643 : : }
4644 : 12 : popt->topt.csvFieldSep[0] = value[0];
4645 : : }
4646 : : }
4647 : :
4648 : : /* locale-aware numeric output */
6845 bruce@momjian.us 4649 [ + + ]: 239 : else if (strcmp(param, "numericlocale") == 0)
4650 : : {
6252 4651 [ + - ]: 6 : if (value)
2631 tgl@sss.pgh.pa.us 4652 : 6 : return ParseVariableBool(value, param, &popt->topt.numericLocale);
4653 : : else
6252 bruce@momjian.us 4654 :UBC 0 : popt->topt.numericLocale = !popt->topt.numericLocale;
4655 : : }
4656 : :
4657 : : /* null display */
8928 bruce@momjian.us 4658 [ + + ]:CBC 233 : else if (strcmp(param, "null") == 0)
4659 : : {
4660 [ + - ]: 39 : if (value)
4661 : : {
4662 : 39 : free(popt->nullPrint);
7385 neilc@samurai.com 4663 : 39 : popt->nullPrint = pg_strdup(value);
4664 : : }
4665 : : }
4666 : :
4667 : : /* field separator for unaligned text */
8928 bruce@momjian.us 4668 [ + + ]: 194 : else if (strcmp(param, "fieldsep") == 0)
4669 : : {
4670 [ + - ]: 3 : if (value)
4671 : : {
4448 peter_e@gmx.net 4672 : 3 : free(popt->topt.fieldSep.separator);
4673 : 3 : popt->topt.fieldSep.separator = pg_strdup(value);
4674 : 3 : popt->topt.fieldSep.separator_zero = false;
4675 : : }
4676 : : }
4677 : :
4678 [ - + ]: 191 : else if (strcmp(param, "fieldsep_zero") == 0)
4679 : : {
4448 peter_e@gmx.net 4680 :UBC 0 : free(popt->topt.fieldSep.separator);
4681 : 0 : popt->topt.fieldSep.separator = NULL;
4682 : 0 : popt->topt.fieldSep.separator_zero = true;
4683 : : }
4684 : :
4685 : : /* record separator for unaligned text */
8853 peter_e@gmx.net 4686 [ - + ]:CBC 191 : else if (strcmp(param, "recordsep") == 0)
4687 : : {
8853 peter_e@gmx.net 4688 [ # # ]:UBC 0 : if (value)
4689 : : {
4448 4690 : 0 : free(popt->topt.recordSep.separator);
4691 : 0 : popt->topt.recordSep.separator = pg_strdup(value);
4692 : 0 : popt->topt.recordSep.separator_zero = false;
4693 : : }
4694 : : }
4695 : :
4448 peter_e@gmx.net 4696 [ - + ]:CBC 191 : else if (strcmp(param, "recordsep_zero") == 0)
4697 : : {
4448 peter_e@gmx.net 4698 :UBC 0 : free(popt->topt.recordSep.separator);
4699 : 0 : popt->topt.recordSep.separator = NULL;
4700 : 0 : popt->topt.recordSep.separator_zero = true;
4701 : : }
4702 : :
4703 : : /* toggle between full and tuples-only format */
8928 bruce@momjian.us 4704 [ + - + + ]:CBC 191 : else if (strcmp(param, "t") == 0 || strcmp(param, "tuples_only") == 0)
4705 : : {
6252 4706 [ + + ]: 140 : if (value)
2631 tgl@sss.pgh.pa.us 4707 : 122 : return ParseVariableBool(value, param, &popt->topt.tuples_only);
4708 : : else
6252 bruce@momjian.us 4709 : 18 : popt->topt.tuples_only = !popt->topt.tuples_only;
4710 : : }
4711 : :
4712 : : /* set title override */
3114 4713 [ + - + + ]: 51 : else if (strcmp(param, "C") == 0 || strcmp(param, "title") == 0)
4714 : : {
8928 4715 : 3 : free(popt->title);
4716 [ - + ]: 3 : if (!value)
8928 bruce@momjian.us 4717 :UBC 0 : popt->title = NULL;
4718 : : else
7385 neilc@samurai.com 4719 :CBC 3 : popt->title = pg_strdup(value);
4720 : : }
4721 : :
4722 : : /* set HTML table tag options */
8928 bruce@momjian.us 4723 [ + - + + ]: 48 : else if (strcmp(param, "T") == 0 || strcmp(param, "tableattr") == 0)
4724 : : {
4725 : 24 : free(popt->topt.tableAttr);
4726 [ + + ]: 24 : if (!value)
4727 : 12 : popt->topt.tableAttr = NULL;
4728 : : else
7385 neilc@samurai.com 4729 : 12 : popt->topt.tableAttr = pg_strdup(value);
4730 : : }
4731 : :
4732 : : /* toggle use of pager */
8928 bruce@momjian.us 4733 [ - + ]: 24 : else if (strcmp(param, "pager") == 0)
4734 : : {
7282 tgl@sss.pgh.pa.us 4735 [ # # # # ]:UBC 0 : if (value && pg_strcasecmp(value, "always") == 0)
7559 bruce@momjian.us 4736 : 0 : popt->topt.pager = 2;
6252 4737 [ # # ]: 0 : else if (value)
4738 : : {
4739 : : bool on_off;
4740 : :
2631 tgl@sss.pgh.pa.us 4741 [ # # ]: 0 : if (!ParseVariableBool(value, NULL, &on_off))
4742 : : {
4743 : 0 : PsqlVarEnumError(param, value, "on, off, always");
4744 : 0 : return false;
4745 : : }
4746 : 0 : popt->topt.pager = on_off ? 1 : 0;
4747 : : }
7828 bruce@momjian.us 4748 [ # # ]: 0 : else if (popt->topt.pager == 1)
7559 4749 : 0 : popt->topt.pager = 0;
4750 : : else
4751 : 0 : popt->topt.pager = 1;
4752 : : }
4753 : :
4754 : : /* set minimum lines for pager use */
3305 andrew@dunslane.net 4755 [ - + ]:CBC 24 : else if (strcmp(param, "pager_min_lines") == 0)
4756 : : {
331 alvherre@alvh.no-ip. 4757 [ # # ]:UBC 0 : if (value &&
4758 [ # # ]: 0 : !ParseVariableNum(value, "pager_min_lines", &popt->topt.pager_min_lines))
4759 : 0 : return false;
4760 : : }
4761 : :
4762 : : /* disable "(x rows)" footer */
8373 peter_e@gmx.net 4763 [ - + ]:CBC 24 : else if (strcmp(param, "footer") == 0)
4764 : : {
6252 bruce@momjian.us 4765 [ # # ]:UBC 0 : if (value)
2631 tgl@sss.pgh.pa.us 4766 : 0 : return ParseVariableBool(value, param, &popt->topt.default_footer);
4767 : : else
4366 rhaas@postgresql.org 4768 : 0 : popt->topt.default_footer = !popt->topt.default_footer;
4769 : : }
4770 : :
4771 : : /* set border style/width */
5820 bruce@momjian.us 4772 [ + - ]:CBC 24 : else if (strcmp(param, "columns") == 0)
4773 : : {
4774 [ + - ]: 24 : if (value)
4775 : 24 : popt->topt.columns = atoi(value);
4776 : : }
4777 : : else
4778 : : {
1840 peter@eisentraut.org 4779 :UBC 0 : pg_log_error("\\pset: unknown option: %s", param);
3846 rhaas@postgresql.org 4780 : 0 : return false;
4781 : : }
4782 : :
3808 peter_e@gmx.net 4783 [ - + ]:CBC 808 : if (!quiet)
3808 peter_e@gmx.net 4784 :UBC 0 : printPsetInfo(param, &pset.popt);
4785 : :
3846 rhaas@postgresql.org 4786 :CBC 808 : return true;
4787 : : }
4788 : :
4789 : : /*
4790 : : * printPsetInfo: print the state of the "param" formatting parameter in popt.
4791 : : */
4792 : : static bool
1468 tgl@sss.pgh.pa.us 4793 :UBC 0 : printPsetInfo(const char *param, printQueryOpt *popt)
4794 : : {
3846 rhaas@postgresql.org 4795 [ # # ]: 0 : Assert(param != NULL);
4796 : :
4797 : : /* show border style/width */
4798 [ # # ]: 0 : if (strcmp(param, "border") == 0)
3466 peter_e@gmx.net 4799 : 0 : printf(_("Border style is %d.\n"), popt->topt.border);
4800 : :
4801 : : /* show the target width for the wrapped format */
3846 rhaas@postgresql.org 4802 [ # # ]: 0 : else if (strcmp(param, "columns") == 0)
4803 : : {
4804 [ # # ]: 0 : if (!popt->topt.columns)
3466 peter_e@gmx.net 4805 : 0 : printf(_("Target width is unset.\n"));
4806 : : else
4807 : 0 : printf(_("Target width is %d.\n"), popt->topt.columns);
4808 : : }
4809 : :
4810 : : /* show expanded/vertical mode */
3846 rhaas@postgresql.org 4811 [ # # # # : 0 : else if (strcmp(param, "x") == 0 || strcmp(param, "expanded") == 0 || strcmp(param, "vertical") == 0)
# # ]
4812 : : {
4813 [ # # ]: 0 : if (popt->topt.expanded == 1)
3466 peter_e@gmx.net 4814 : 0 : printf(_("Expanded display is on.\n"));
3846 rhaas@postgresql.org 4815 [ # # ]: 0 : else if (popt->topt.expanded == 2)
3466 peter_e@gmx.net 4816 : 0 : printf(_("Expanded display is used automatically.\n"));
4817 : : else
4818 : 0 : printf(_("Expanded display is off.\n"));
4819 : : }
4820 : :
4821 : : /* show xheader width value */
629 andrew@dunslane.net 4822 [ # # ]: 0 : else if (strcmp(param, "xheader_width") == 0)
4823 : : {
4824 [ # # ]: 0 : if (popt->topt.expanded_header_width_type == PRINT_XHEADER_FULL)
331 peter@eisentraut.org 4825 : 0 : printf(_("Expanded header width is \"%s\".\n"), "full");
629 andrew@dunslane.net 4826 [ # # ]: 0 : else if (popt->topt.expanded_header_width_type == PRINT_XHEADER_COLUMN)
331 peter@eisentraut.org 4827 : 0 : printf(_("Expanded header width is \"%s\".\n"), "column");
629 andrew@dunslane.net 4828 [ # # ]: 0 : else if (popt->topt.expanded_header_width_type == PRINT_XHEADER_PAGE)
331 peter@eisentraut.org 4829 : 0 : printf(_("Expanded header width is \"%s\".\n"), "page");
629 andrew@dunslane.net 4830 [ # # ]: 0 : else if (popt->topt.expanded_header_width_type == PRINT_XHEADER_EXACT_WIDTH)
4831 : 0 : printf(_("Expanded header width is %d.\n"), popt->topt.expanded_header_exact_width);
4832 : : }
4833 : :
4834 : : /* show field separator for CSV format */
1966 tgl@sss.pgh.pa.us 4835 [ # # ]: 0 : else if (strcmp(param, "csv_fieldsep") == 0)
4836 : : {
4837 : 0 : printf(_("Field separator for CSV is \"%s\".\n"),
4838 : : popt->topt.csvFieldSep);
4839 : : }
4840 : :
4841 : : /* show field separator for unaligned text */
3846 rhaas@postgresql.org 4842 [ # # ]: 0 : else if (strcmp(param, "fieldsep") == 0)
4843 : : {
4844 [ # # ]: 0 : if (popt->topt.fieldSep.separator_zero)
3466 peter_e@gmx.net 4845 : 0 : printf(_("Field separator is zero byte.\n"));
4846 : : else
4847 : 0 : printf(_("Field separator is \"%s\".\n"),
4848 : : popt->topt.fieldSep.separator);
4849 : : }
4850 : :
3846 rhaas@postgresql.org 4851 [ # # ]: 0 : else if (strcmp(param, "fieldsep_zero") == 0)
4852 : : {
3466 peter_e@gmx.net 4853 : 0 : printf(_("Field separator is zero byte.\n"));
4854 : : }
4855 : :
4856 : : /* show disable "(x rows)" footer */
3846 rhaas@postgresql.org 4857 [ # # ]: 0 : else if (strcmp(param, "footer") == 0)
4858 : : {
4859 [ # # ]: 0 : if (popt->topt.default_footer)
3466 peter_e@gmx.net 4860 : 0 : printf(_("Default footer is on.\n"));
4861 : : else
4862 : 0 : printf(_("Default footer is off.\n"));
4863 : : }
4864 : :
4865 : : /* show format */
3846 rhaas@postgresql.org 4866 [ # # ]: 0 : else if (strcmp(param, "format") == 0)
4867 : : {
3466 peter_e@gmx.net 4868 : 0 : printf(_("Output format is %s.\n"), _align2string(popt->topt.format));
4869 : : }
4870 : :
4871 : : /* show table line style */
3846 rhaas@postgresql.org 4872 [ # # ]: 0 : else if (strcmp(param, "linestyle") == 0)
4873 : : {
3466 peter_e@gmx.net 4874 : 0 : printf(_("Line style is %s.\n"),
4875 : : get_line_style(&popt->topt)->name);
4876 : : }
4877 : :
4878 : : /* show null display */
3846 rhaas@postgresql.org 4879 [ # # ]: 0 : else if (strcmp(param, "null") == 0)
4880 : : {
3466 peter_e@gmx.net 4881 [ # # ]: 0 : printf(_("Null display is \"%s\".\n"),
4882 : : popt->nullPrint ? popt->nullPrint : "");
4883 : : }
4884 : :
4885 : : /* show locale-aware numeric output */
3846 rhaas@postgresql.org 4886 [ # # ]: 0 : else if (strcmp(param, "numericlocale") == 0)
4887 : : {
4888 [ # # ]: 0 : if (popt->topt.numericLocale)
3466 peter_e@gmx.net 4889 : 0 : printf(_("Locale-adjusted numeric output is on.\n"));
4890 : : else
4891 : 0 : printf(_("Locale-adjusted numeric output is off.\n"));
4892 : : }
4893 : :
4894 : : /* show toggle use of pager */
3846 rhaas@postgresql.org 4895 [ # # ]: 0 : else if (strcmp(param, "pager") == 0)
4896 : : {
4897 [ # # ]: 0 : if (popt->topt.pager == 1)
3466 peter_e@gmx.net 4898 : 0 : printf(_("Pager is used for long output.\n"));
3846 rhaas@postgresql.org 4899 [ # # ]: 0 : else if (popt->topt.pager == 2)
3466 peter_e@gmx.net 4900 : 0 : printf(_("Pager is always used.\n"));
4901 : : else
4902 : 0 : printf(_("Pager usage is off.\n"));
4903 : : }
4904 : :
4905 : : /* show minimum lines for pager use */
3305 andrew@dunslane.net 4906 [ # # ]: 0 : else if (strcmp(param, "pager_min_lines") == 0)
4907 : : {
3091 peter_e@gmx.net 4908 : 0 : printf(ngettext("Pager won't be used for less than %d line.\n",
4909 : : "Pager won't be used for less than %d lines.\n",
4910 : : popt->topt.pager_min_lines),
4911 : : popt->topt.pager_min_lines);
4912 : : }
4913 : :
4914 : : /* show record separator for unaligned text */
3846 rhaas@postgresql.org 4915 [ # # ]: 0 : else if (strcmp(param, "recordsep") == 0)
4916 : : {
4917 [ # # ]: 0 : if (popt->topt.recordSep.separator_zero)
3466 peter_e@gmx.net 4918 : 0 : printf(_("Record separator is zero byte.\n"));
3846 rhaas@postgresql.org 4919 [ # # ]: 0 : else if (strcmp(popt->topt.recordSep.separator, "\n") == 0)
3466 peter_e@gmx.net 4920 : 0 : printf(_("Record separator is <newline>.\n"));
4921 : : else
4922 : 0 : printf(_("Record separator is \"%s\".\n"),
4923 : : popt->topt.recordSep.separator);
4924 : : }
4925 : :
3846 rhaas@postgresql.org 4926 [ # # ]: 0 : else if (strcmp(param, "recordsep_zero") == 0)
4927 : : {
3466 peter_e@gmx.net 4928 : 0 : printf(_("Record separator is zero byte.\n"));
4929 : : }
4930 : :
4931 : : /* show HTML table tag options */
3846 rhaas@postgresql.org 4932 [ # # # # ]: 0 : else if (strcmp(param, "T") == 0 || strcmp(param, "tableattr") == 0)
4933 : : {
4934 [ # # ]: 0 : if (popt->topt.tableAttr)
3466 peter_e@gmx.net 4935 : 0 : printf(_("Table attributes are \"%s\".\n"),
4936 : : popt->topt.tableAttr);
4937 : : else
4938 : 0 : printf(_("Table attributes unset.\n"));
4939 : : }
4940 : :
4941 : : /* show title override */
3114 bruce@momjian.us 4942 [ # # # # ]: 0 : else if (strcmp(param, "C") == 0 || strcmp(param, "title") == 0)
4943 : : {
3846 rhaas@postgresql.org 4944 [ # # ]: 0 : if (popt->title)
3466 peter_e@gmx.net 4945 : 0 : printf(_("Title is \"%s\".\n"), popt->title);
4946 : : else
4947 : 0 : printf(_("Title is unset.\n"));
4948 : : }
4949 : :
4950 : : /* show toggle between full and tuples-only format */
3846 rhaas@postgresql.org 4951 [ # # # # ]: 0 : else if (strcmp(param, "t") == 0 || strcmp(param, "tuples_only") == 0)
4952 : : {
4953 [ # # ]: 0 : if (popt->topt.tuples_only)
3466 peter_e@gmx.net 4954 : 0 : printf(_("Tuples only is on.\n"));
4955 : : else
4956 : 0 : printf(_("Tuples only is off.\n"));
4957 : : }
4958 : :
4959 : : /* Unicode style formatting */
3502 sfrost@snowman.net 4960 [ # # ]: 0 : else if (strcmp(param, "unicode_border_linestyle") == 0)
4961 : : {
3055 peter_e@gmx.net 4962 : 0 : printf(_("Unicode border line style is \"%s\".\n"),
4963 : : _unicode_linestyle2string(popt->topt.unicode_border_linestyle));
4964 : : }
4965 : :
3502 sfrost@snowman.net 4966 [ # # ]: 0 : else if (strcmp(param, "unicode_column_linestyle") == 0)
4967 : : {
3055 peter_e@gmx.net 4968 : 0 : printf(_("Unicode column line style is \"%s\".\n"),
4969 : : _unicode_linestyle2string(popt->topt.unicode_column_linestyle));
4970 : : }
4971 : :
3502 sfrost@snowman.net 4972 [ # # ]: 0 : else if (strcmp(param, "unicode_header_linestyle") == 0)
4973 : : {
3055 peter_e@gmx.net 4974 : 0 : printf(_("Unicode header line style is \"%s\".\n"),
4975 : : _unicode_linestyle2string(popt->topt.unicode_header_linestyle));
4976 : : }
4977 : :
4978 : : else
4979 : : {
1840 peter@eisentraut.org 4980 : 0 : pg_log_error("\\pset: unknown option: %s", param);
8928 bruce@momjian.us 4981 : 0 : return false;
4982 : : }
4983 : :
4984 : 0 : return true;
4985 : : }
4986 : :
4987 : : /*
4988 : : * savePsetInfo: make a malloc'd copy of the data in *popt.
4989 : : *
4990 : : * Possibly this should be somewhere else, but it's a bit specific to psql.
4991 : : */
4992 : : printQueryOpt *
1468 tgl@sss.pgh.pa.us 4993 :CBC 18 : savePsetInfo(const printQueryOpt *popt)
4994 : : {
4995 : : printQueryOpt *save;
4996 : :
4997 : 18 : save = (printQueryOpt *) pg_malloc(sizeof(printQueryOpt));
4998 : :
4999 : : /* Flat-copy all the scalar fields, then duplicate sub-structures. */
5000 : 18 : memcpy(save, popt, sizeof(printQueryOpt));
5001 : :
5002 : : /* topt.line_style points to const data that need not be duplicated */
5003 [ + - ]: 18 : if (popt->topt.fieldSep.separator)
5004 : 18 : save->topt.fieldSep.separator = pg_strdup(popt->topt.fieldSep.separator);
5005 [ + - ]: 18 : if (popt->topt.recordSep.separator)
5006 : 18 : save->topt.recordSep.separator = pg_strdup(popt->topt.recordSep.separator);
5007 [ - + ]: 18 : if (popt->topt.tableAttr)
1468 tgl@sss.pgh.pa.us 5008 :UBC 0 : save->topt.tableAttr = pg_strdup(popt->topt.tableAttr);
1468 tgl@sss.pgh.pa.us 5009 [ - + ]:CBC 18 : if (popt->nullPrint)
1468 tgl@sss.pgh.pa.us 5010 :UBC 0 : save->nullPrint = pg_strdup(popt->nullPrint);
1468 tgl@sss.pgh.pa.us 5011 [ - + ]:CBC 18 : if (popt->title)
1468 tgl@sss.pgh.pa.us 5012 :UBC 0 : save->title = pg_strdup(popt->title);
5013 : :
5014 : : /*
5015 : : * footers and translate_columns are never set in psql's print settings,
5016 : : * so we needn't write code to duplicate them.
5017 : : */
1468 tgl@sss.pgh.pa.us 5018 [ - + ]:CBC 18 : Assert(popt->footers == NULL);
5019 [ - + ]: 18 : Assert(popt->translate_columns == NULL);
5020 : :
5021 : 18 : return save;
5022 : : }
5023 : :
5024 : : /*
5025 : : * restorePsetInfo: restore *popt from the previously-saved copy *save,
5026 : : * then free *save.
5027 : : */
5028 : : void
5029 : 18 : restorePsetInfo(printQueryOpt *popt, printQueryOpt *save)
5030 : : {
5031 : : /* Free all the old data we're about to overwrite the pointers to. */
5032 : :
5033 : : /* topt.line_style points to const data that need not be duplicated */
668 peter@eisentraut.org 5034 : 18 : free(popt->topt.fieldSep.separator);
5035 : 18 : free(popt->topt.recordSep.separator);
5036 : 18 : free(popt->topt.tableAttr);
5037 : 18 : free(popt->nullPrint);
5038 : 18 : free(popt->title);
5039 : :
5040 : : /*
5041 : : * footers and translate_columns are never set in psql's print settings,
5042 : : * so we needn't write code to duplicate them.
5043 : : */
1468 tgl@sss.pgh.pa.us 5044 [ - + ]: 18 : Assert(popt->footers == NULL);
5045 [ - + ]: 18 : Assert(popt->translate_columns == NULL);
5046 : :
5047 : : /* Now we may flat-copy all the fields, including pointers. */
5048 : 18 : memcpy(popt, save, sizeof(printQueryOpt));
5049 : :
5050 : : /* Lastly, free "save" ... but its sub-structures now belong to popt. */
5051 : 18 : free(save);
5052 : 18 : }
5053 : :
5054 : : static const char *
3466 peter_e@gmx.net 5055 : 18 : pset_bool_string(bool val)
5056 : : {
5057 [ + + ]: 18 : return val ? "on" : "off";
5058 : : }
5059 : :
5060 : :
5061 : : static char *
5062 : 12 : pset_quoted_string(const char *str)
5063 : : {
3458 tgl@sss.pgh.pa.us 5064 : 12 : char *ret = pg_malloc(strlen(str) * 2 + 3);
3466 peter_e@gmx.net 5065 : 12 : char *r = ret;
5066 : :
5067 : 12 : *r++ = '\'';
5068 : :
5069 [ + + ]: 21 : for (; *str; str++)
5070 : : {
5071 [ + + ]: 9 : if (*str == '\n')
5072 : : {
5073 : 3 : *r++ = '\\';
5074 : 3 : *r++ = 'n';
5075 : : }
5076 [ - + ]: 6 : else if (*str == '\'')
5077 : : {
3466 peter_e@gmx.net 5078 :UBC 0 : *r++ = '\\';
5079 : 0 : *r++ = '\'';
5080 : : }
5081 : : else
3466 peter_e@gmx.net 5082 :CBC 6 : *r++ = *str;
5083 : : }
5084 : :
5085 : 12 : *r++ = '\'';
5086 : 12 : *r = '\0';
5087 : :
5088 : 12 : return ret;
5089 : : }
5090 : :
5091 : :
5092 : : /*
5093 : : * Return a malloc'ed string for the \pset value.
5094 : : *
5095 : : * Note that for some string parameters, print.c distinguishes between unset
5096 : : * and empty string, but for others it doesn't. This function should produce
5097 : : * output that produces the correct setting when fed back into \pset.
5098 : : */
5099 : : static char *
1468 tgl@sss.pgh.pa.us 5100 : 66 : pset_value_string(const char *param, printQueryOpt *popt)
5101 : : {
3466 peter_e@gmx.net 5102 [ - + ]: 66 : Assert(param != NULL);
5103 : :
5104 [ + + ]: 66 : if (strcmp(param, "border") == 0)
5105 : 3 : return psprintf("%d", popt->topt.border);
5106 [ + + ]: 63 : else if (strcmp(param, "columns") == 0)
5107 : 3 : return psprintf("%d", popt->topt.columns);
1966 tgl@sss.pgh.pa.us 5108 [ + + ]: 60 : else if (strcmp(param, "csv_fieldsep") == 0)
5109 : 3 : return pset_quoted_string(popt->topt.csvFieldSep);
3466 peter_e@gmx.net 5110 [ + + ]: 57 : else if (strcmp(param, "expanded") == 0)
5111 [ + - ]: 6 : return pstrdup(popt->topt.expanded == 2
5112 : : ? "auto"
5113 : 3 : : pset_bool_string(popt->topt.expanded));
5114 [ + + ]: 54 : else if (strcmp(param, "fieldsep") == 0)
5115 [ + - ]: 3 : return pset_quoted_string(popt->topt.fieldSep.separator
5116 : : ? popt->topt.fieldSep.separator
5117 : : : "");
5118 [ + + ]: 51 : else if (strcmp(param, "fieldsep_zero") == 0)
5119 : 3 : return pstrdup(pset_bool_string(popt->topt.fieldSep.separator_zero));
5120 [ + + ]: 48 : else if (strcmp(param, "footer") == 0)
5121 : 3 : return pstrdup(pset_bool_string(popt->topt.default_footer));
5122 [ + + ]: 45 : else if (strcmp(param, "format") == 0)
586 drowley@postgresql.o 5123 : 3 : return pstrdup(_align2string(popt->topt.format));
3466 peter_e@gmx.net 5124 [ + + ]: 42 : else if (strcmp(param, "linestyle") == 0)
586 drowley@postgresql.o 5125 : 3 : return pstrdup(get_line_style(&popt->topt)->name);
3466 peter_e@gmx.net 5126 [ + + ]: 39 : else if (strcmp(param, "null") == 0)
5127 [ - + ]: 3 : return pset_quoted_string(popt->nullPrint
5128 : : ? popt->nullPrint
5129 : : : "");
5130 [ + + ]: 36 : else if (strcmp(param, "numericlocale") == 0)
5131 : 3 : return pstrdup(pset_bool_string(popt->topt.numericLocale));
5132 [ + + ]: 33 : else if (strcmp(param, "pager") == 0)
5133 : 3 : return psprintf("%d", popt->topt.pager);
3305 andrew@dunslane.net 5134 [ + + ]: 30 : else if (strcmp(param, "pager_min_lines") == 0)
5135 : 3 : return psprintf("%d", popt->topt.pager_min_lines);
3466 peter_e@gmx.net 5136 [ + + ]: 27 : else if (strcmp(param, "recordsep") == 0)
5137 [ + - ]: 3 : return pset_quoted_string(popt->topt.recordSep.separator
5138 : : ? popt->topt.recordSep.separator
5139 : : : "");
5140 [ + + ]: 24 : else if (strcmp(param, "recordsep_zero") == 0)
5141 : 3 : return pstrdup(pset_bool_string(popt->topt.recordSep.separator_zero));
5142 [ + + ]: 21 : else if (strcmp(param, "tableattr") == 0)
5143 [ - + ]: 3 : return popt->topt.tableAttr ? pset_quoted_string(popt->topt.tableAttr) : pstrdup("");
5144 [ + + ]: 18 : else if (strcmp(param, "title") == 0)
5145 [ - + ]: 3 : return popt->title ? pset_quoted_string(popt->title) : pstrdup("");
5146 [ + + ]: 15 : else if (strcmp(param, "tuples_only") == 0)
5147 : 3 : return pstrdup(pset_bool_string(popt->topt.tuples_only));
5148 [ + + ]: 12 : else if (strcmp(param, "unicode_border_linestyle") == 0)
5149 : 3 : return pstrdup(_unicode_linestyle2string(popt->topt.unicode_border_linestyle));
5150 [ + + ]: 9 : else if (strcmp(param, "unicode_column_linestyle") == 0)
5151 : 3 : return pstrdup(_unicode_linestyle2string(popt->topt.unicode_column_linestyle));
5152 [ + + ]: 6 : else if (strcmp(param, "unicode_header_linestyle") == 0)
5153 : 3 : return pstrdup(_unicode_linestyle2string(popt->topt.unicode_header_linestyle));
629 andrew@dunslane.net 5154 [ + - ]: 3 : else if (strcmp(param, "xheader_width") == 0)
5155 : : {
5156 [ + - ]: 3 : if (popt->topt.expanded_header_width_type == PRINT_XHEADER_FULL)
331 tgl@sss.pgh.pa.us 5157 : 3 : return pstrdup("full");
629 andrew@dunslane.net 5158 [ # # ]:UBC 0 : else if (popt->topt.expanded_header_width_type == PRINT_XHEADER_COLUMN)
331 tgl@sss.pgh.pa.us 5159 : 0 : return pstrdup("column");
629 andrew@dunslane.net 5160 [ # # ]: 0 : else if (popt->topt.expanded_header_width_type == PRINT_XHEADER_PAGE)
331 tgl@sss.pgh.pa.us 5161 : 0 : return pstrdup("page");
5162 : : else
5163 : : {
5164 : : /* must be PRINT_XHEADER_EXACT_WIDTH */
5165 : : char wbuff[32];
5166 : :
629 andrew@dunslane.net 5167 : 0 : snprintf(wbuff, sizeof(wbuff), "%d",
5168 : : popt->topt.expanded_header_exact_width);
5169 : 0 : return pstrdup(wbuff);
5170 : : }
5171 : : }
5172 : : else
3466 peter_e@gmx.net 5173 : 0 : return pstrdup("ERROR");
5174 : : }
5175 : :
5176 : :
5177 : :
5178 : : #ifndef WIN32
5179 : : #define DEFAULT_SHELL "/bin/sh"
5180 : : #else
5181 : : /*
5182 : : * CMD.EXE is in different places in different Win32 releases so we
5183 : : * have to rely on the path to find it.
5184 : : */
5185 : : #define DEFAULT_SHELL "cmd.exe"
5186 : : #endif
5187 : :
5188 : : static bool
8928 bruce@momjian.us 5189 :LBC (2) : do_shell(const char *command)
5190 : : {
5191 : : int result;
5192 : :
594 tgl@sss.pgh.pa.us 5193 : (2) : fflush(NULL);
8928 bruce@momjian.us 5194 [ # # ]: (2) : if (!command)
5195 : : {
5196 : : char *sys;
5197 : : const char *shellName;
5198 : :
7099 bruce@momjian.us 5199 :UBC 0 : shellName = getenv("SHELL");
5200 : : #ifdef WIN32
5201 : : if (shellName == NULL)
5202 : : shellName = getenv("COMSPEC");
5203 : : #endif
8928 5204 [ # # ]: 0 : if (shellName == NULL)
5205 : 0 : shellName = DEFAULT_SHELL;
5206 : :
5207 : : /* See EDITOR handling comment for an explanation */
5208 : : #ifndef WIN32
3827 tgl@sss.pgh.pa.us 5209 : 0 : sys = psprintf("exec %s", shellName);
5210 : : #else
5211 : : sys = psprintf("\"%s\"", shellName);
5212 : : #endif
8928 bruce@momjian.us 5213 : 0 : result = system(sys);
5214 : 0 : free(sys);
5215 : : }
5216 : : else
8928 bruce@momjian.us 5217 :LBC (2) : result = system(command);
5218 : :
374 tgl@sss.pgh.pa.us 5219 : (2) : SetShellResultVariables(result);
5220 : :
8928 bruce@momjian.us 5221 [ # # # # ]: (2) : if (result == 127 || result == -1)
5222 : : {
1840 peter@eisentraut.org 5223 :UBC 0 : pg_log_error("\\!: failed");
8928 bruce@momjian.us 5224 : 0 : return false;
5225 : : }
8928 bruce@momjian.us 5226 :LBC (2) : return true;
5227 : : }
5228 : :
5229 : : /*
5230 : : * do_watch -- handler for \watch
5231 : : *
5232 : : * We break this out of exec_command to avoid having to plaster "volatile"
5233 : : * onto a bunch of exec_command's variables to silence stupider compilers.
5234 : : */
5235 : : static bool
229 dgustafsson@postgres 5236 :GNC 3 : do_watch(PQExpBuffer query_buf, double sleep, int iter, int min_rows)
5237 : : {
2946 tgl@sss.pgh.pa.us 5238 :CBC 3 : long sleep_ms = (long) (sleep * 1000);
4028 5239 : 3 : printQueryOpt myopt = pset.popt;
5240 : : const char *strftime_fmt;
5241 : : const char *user_title;
5242 : : char *title;
1006 tmunro@postgresql.or 5243 : 3 : const char *pagerprog = NULL;
5244 : 3 : FILE *pagerpipe = NULL;
5245 : : int title_len;
2946 tgl@sss.pgh.pa.us 5246 : 3 : int res = 0;
37 tgl@sss.pgh.pa.us 5247 :GNC 3 : bool done = false;
5248 : : #ifndef WIN32
5249 : : sigset_t sigalrm_sigchld_sigint;
5250 : : sigset_t sigalrm_sigchld;
5251 : : sigset_t sigint;
5252 : : struct itimerval interval;
5253 : : #endif
5254 : :
4028 tgl@sss.pgh.pa.us 5255 [ + - - + ]:CBC 3 : if (!query_buf || query_buf->len <= 0)
5256 : : {
1840 peter@eisentraut.org 5257 :UBC 0 : pg_log_error("\\watch cannot be used with an empty query");
4028 tgl@sss.pgh.pa.us 5258 : 0 : return false;
5259 : : }
5260 : :
5261 : : #ifndef WIN32
1006 tmunro@postgresql.or 5262 :CBC 3 : sigemptyset(&sigalrm_sigchld_sigint);
5263 : 3 : sigaddset(&sigalrm_sigchld_sigint, SIGCHLD);
5264 : 3 : sigaddset(&sigalrm_sigchld_sigint, SIGALRM);
5265 : 3 : sigaddset(&sigalrm_sigchld_sigint, SIGINT);
5266 : :
5267 : 3 : sigemptyset(&sigalrm_sigchld);
5268 : 3 : sigaddset(&sigalrm_sigchld, SIGCHLD);
5269 : 3 : sigaddset(&sigalrm_sigchld, SIGALRM);
5270 : :
5271 : 3 : sigemptyset(&sigint);
5272 : 3 : sigaddset(&sigint, SIGINT);
5273 : :
5274 : : /*
5275 : : * Block SIGALRM and SIGCHLD before we start the timer and the pager (if
5276 : : * configured), to avoid races. sigwait() will receive them.
5277 : : */
5278 : 3 : sigprocmask(SIG_BLOCK, &sigalrm_sigchld, NULL);
5279 : :
5280 : : /*
5281 : : * Set a timer to interrupt sigwait() so we can run the query at the
5282 : : * requested intervals.
5283 : : */
5284 : 3 : interval.it_value.tv_sec = sleep_ms / 1000;
5285 : 3 : interval.it_value.tv_usec = (sleep_ms % 1000) * 1000;
5286 : 3 : interval.it_interval = interval.it_value;
5287 [ - + ]: 3 : if (setitimer(ITIMER_REAL, &interval, NULL) < 0)
5288 : : {
1006 tmunro@postgresql.or 5289 :UBC 0 : pg_log_error("could not set timer: %m");
5290 : 0 : done = true;
5291 : : }
5292 : : #endif
5293 : :
5294 : : /*
5295 : : * For \watch, we ignore the size of the result and always use the pager
5296 : : * as long as we're talking to a terminal and "\pset pager" is enabled.
5297 : : * However, we'll only use the pager identified by PSQL_WATCH_PAGER. We
5298 : : * ignore the regular PSQL_PAGER or PAGER environment variables, because
5299 : : * traditional pagers probably won't be very useful for showing a stream
5300 : : * of results.
5301 : : */
5302 : : #ifndef WIN32
1006 tmunro@postgresql.or 5303 :CBC 3 : pagerprog = getenv("PSQL_WATCH_PAGER");
5304 : : /* if variable is empty or all-white-space, don't use pager */
338 tgl@sss.pgh.pa.us 5305 [ - + - - ]: 3 : if (pagerprog && strspn(pagerprog, " \t\r\n") == strlen(pagerprog))
338 tgl@sss.pgh.pa.us 5306 :UBC 0 : pagerprog = NULL;
5307 : : #endif
338 tgl@sss.pgh.pa.us 5308 [ - + - - :CBC 3 : if (pagerprog && myopt.topt.pager &&
- - ]
338 tgl@sss.pgh.pa.us 5309 [ # # ]:UBC 0 : isatty(fileno(stdin)) && isatty(fileno(stdout)))
5310 : : {
594 5311 : 0 : fflush(NULL);
1006 tmunro@postgresql.or 5312 : 0 : disable_sigpipe_trap();
5313 : 0 : pagerpipe = popen(pagerprog, "w");
5314 : :
5315 [ # # ]: 0 : if (!pagerpipe)
5316 : : /* silently proceed without pager */
5317 : 0 : restore_sigpipe_trap();
5318 : : }
5319 : :
5320 : : /*
5321 : : * Choose format for timestamps. We might eventually make this a \pset
5322 : : * option. In the meantime, using a variable for the format suppresses
5323 : : * overly-anal-retentive gcc warnings about %c being Y2K sensitive.
5324 : : */
2860 tgl@sss.pgh.pa.us 5325 :CBC 3 : strftime_fmt = "%c";
5326 : :
5327 : : /*
5328 : : * Set up rendering options, in particular, disable the pager unless
5329 : : * PSQL_WATCH_PAGER was successfully launched.
5330 : : */
1006 tmunro@postgresql.or 5331 [ + - ]: 3 : if (!pagerpipe)
5332 : 3 : myopt.topt.pager = 0;
5333 : :
5334 : : /*
5335 : : * If there's a title in the user configuration, make sure we have room
5336 : : * for it in the title buffer. Allow 128 bytes for the timestamp plus 128
5337 : : * bytes for the rest.
5338 : : */
2946 tgl@sss.pgh.pa.us 5339 : 3 : user_title = myopt.title;
2860 5340 [ - + ]: 3 : title_len = (user_title ? strlen(user_title) : 0) + 256;
2946 5341 : 3 : title = pg_malloc(title_len);
5342 : :
5343 : : /* Loop to run query and then sleep awhile */
37 tgl@sss.pgh.pa.us 5344 [ + - ]:GNC 8 : while (!done)
4028 tgl@sss.pgh.pa.us 5345 :ECB (2) : {
5346 : : time_t timer;
5347 : : char timebuf[128];
5348 : :
5349 : : /*
5350 : : * Prepare title for output. Note that we intentionally include a
5351 : : * newline at the end of the title; this is somewhat historical but it
5352 : : * makes for reasonably nicely formatted output in simple cases.
5353 : : */
4028 tgl@sss.pgh.pa.us 5354 :CBC 8 : timer = time(NULL);
2860 5355 : 8 : strftime(timebuf, sizeof(timebuf), strftime_fmt, localtime(&timer));
5356 : :
2946 5357 [ - + ]: 8 : if (user_title)
2946 tgl@sss.pgh.pa.us 5358 :UBC 0 : snprintf(title, title_len, _("%s\t%s (every %gs)\n"),
5359 : : user_title, timebuf, sleep);
5360 : : else
2946 tgl@sss.pgh.pa.us 5361 :CBC 8 : snprintf(title, title_len, _("%s (every %gs)\n"),
5362 : : timebuf, sleep);
4028 5363 : 8 : myopt.title = title;
5364 : :
5365 : : /* Run the query and print out the result */
229 dgustafsson@postgres 5366 :GNC 8 : res = PSQLexecWatch(query_buf->data, &myopt, pagerpipe, min_rows);
5367 : :
5368 : : /*
5369 : : * PSQLexecWatch handles the case where we can no longer repeat the
5370 : : * query, and returns 0 or -1.
5371 : : */
2946 tgl@sss.pgh.pa.us 5372 [ + + ]:CBC 7 : if (res <= 0)
4028 tgl@sss.pgh.pa.us 5373 :GBC 2 : break;
5374 : :
5375 : : /* If we have iteration count, check that it's not exceeded yet */
374 tgl@sss.pgh.pa.us 5376 [ + + + + ]:CBC 6 : if (iter && (--iter <= 0))
5377 : 1 : break;
5378 : :
5379 : : /* Quit if error on pager pipe (probably pager has quit) */
1006 tmunro@postgresql.or 5380 [ - + - - ]: 5 : if (pagerpipe && ferror(pagerpipe))
1006 tmunro@postgresql.or 5381 :UBC 0 : break;
5382 : :
395 michael@paquier.xyz 5383 [ - + ]:CBC 5 : if (sleep == 0)
395 michael@paquier.xyz 5384 :UBC 0 : continue;
5385 : :
5386 : : #ifdef WIN32
5387 : :
5388 : : /*
5389 : : * Wait a while before running the query again. Break the sleep into
5390 : : * short intervals (at most 1s); that's probably unnecessary since
5391 : : * pg_usleep is interruptible on Windows, but it's cheap insurance.
5392 : : */
5393 : : for (long i = sleep_ms; i > 0;)
5394 : : {
5395 : : long s = Min(i, 1000L);
5396 : :
5397 : : pg_usleep(s * 1000L);
5398 : : if (cancel_pressed)
5399 : : {
5400 : : done = true;
5401 : : break;
5402 : : }
5403 : : i -= s;
5404 : : }
5405 : : #else
5406 : : /* sigwait() will handle SIGINT. */
1006 tmunro@postgresql.or 5407 :CBC 5 : sigprocmask(SIG_BLOCK, &sigint, NULL);
5408 [ - + ]: 5 : if (cancel_pressed)
1006 tmunro@postgresql.or 5409 :UBC 0 : done = true;
5410 : :
5411 : : /* Wait for SIGINT, SIGCHLD or SIGALRM. */
1006 tmunro@postgresql.or 5412 [ + - ]:CBC 5 : while (!done)
5413 : : {
5414 : : int signal_received;
5415 : :
1004 5416 : 5 : errno = sigwait(&sigalrm_sigchld_sigint, &signal_received);
5417 [ - + ]: 5 : if (errno != 0)
5418 : : {
5419 : : /* Some other signal arrived? */
1006 tmunro@postgresql.or 5420 [ # # ]:UBC 0 : if (errno == EINTR)
5421 : 0 : continue;
5422 : : else
5423 : : {
5424 : 0 : pg_log_error("could not wait for signals: %m");
5425 : 0 : done = true;
5426 : 0 : break;
5427 : : }
5428 : : }
5429 : : /* On ^C or pager exit, it's time to stop running the query. */
1006 tmunro@postgresql.or 5430 [ + - - + ]:CBC 5 : if (signal_received == SIGINT || signal_received == SIGCHLD)
1006 tmunro@postgresql.or 5431 :UBC 0 : done = true;
5432 : : /* Otherwise, we must have SIGALRM. Time to run the query again. */
1006 tmunro@postgresql.or 5433 :CBC 5 : break;
5434 : : }
5435 : :
5436 : : /* Unblock SIGINT so that slow queries can be interrupted. */
5437 : 5 : sigprocmask(SIG_UNBLOCK, &sigint, NULL);
5438 : : #endif
5439 : : }
5440 : :
5441 [ - + ]: 2 : if (pagerpipe)
5442 : : {
1006 tmunro@postgresql.or 5443 :UBC 0 : pclose(pagerpipe);
5444 : 0 : restore_sigpipe_trap();
5445 : : }
5446 : : else
5447 : : {
5448 : : /*
5449 : : * If the terminal driver echoed "^C", libedit/libreadline might be
5450 : : * confused about the cursor position. Therefore, inject a newline
5451 : : * before the next prompt is displayed. We only do this when not
5452 : : * using a pager, because pagers are expected to restore the screen to
5453 : : * a sane state on exit.
5454 : : */
644 tmunro@postgresql.or 5455 :CBC 2 : fprintf(stdout, "\n");
5456 : 2 : fflush(stdout);
5457 : : }
5458 : :
5459 : : #ifndef WIN32
5460 : : /* Disable the interval timer. */
1006 5461 : 2 : memset(&interval, 0, sizeof(interval));
5462 : 2 : setitimer(ITIMER_REAL, &interval, NULL);
5463 : : /* Unblock SIGINT, SIGCHLD and SIGALRM. */
5464 : 2 : sigprocmask(SIG_UNBLOCK, &sigalrm_sigchld_sigint, NULL);
5465 : : #endif
5466 : :
2946 tgl@sss.pgh.pa.us 5467 : 2 : pg_free(title);
5468 : 2 : return (res >= 0);
5469 : : }
5470 : :
5471 : : /*
5472 : : * a little code borrowed from PSQLexec() to manage ECHO_HIDDEN output.
5473 : : * returns true unless we have ECHO_HIDDEN_NOEXEC.
5474 : : */
5475 : : static bool
3208 5476 : 148 : echo_hidden_command(const char *query)
5477 : : {
3431 andrew@dunslane.net 5478 [ - + ]: 148 : if (pset.echo_hidden != PSQL_ECHO_HIDDEN_OFF)
5479 : : {
263 nathan@postgresql.or 5480 :UNC 0 : printf(_("/******** QUERY *********/\n"
5481 : : "%s\n"
5482 : : "/************************/\n\n"), query);
3431 andrew@dunslane.net 5483 :UBC 0 : fflush(stdout);
5484 [ # # ]: 0 : if (pset.logfile)
5485 : : {
5486 : 0 : fprintf(pset.logfile,
263 nathan@postgresql.or 5487 :UNC 0 : _("/******** QUERY *********/\n"
5488 : : "%s\n"
5489 : : "/************************/\n\n"), query);
3431 andrew@dunslane.net 5490 :UBC 0 : fflush(pset.logfile);
5491 : : }
5492 : :
5493 [ # # ]: 0 : if (pset.echo_hidden == PSQL_ECHO_HIDDEN_NOEXEC)
5494 : 0 : return false;
5495 : : }
3431 andrew@dunslane.net 5496 :CBC 148 : return true;
5497 : : }
5498 : :
5499 : : /*
5500 : : * Look up the object identified by obj_type and desc. If successful,
5501 : : * store its OID in *obj_oid and return true, else return false.
5502 : : *
5503 : : * Note that we'll fail if the object doesn't exist OR if there are multiple
5504 : : * matching candidates OR if there's something syntactically wrong with the
5505 : : * object description; unfortunately it can be hard to tell the difference.
5506 : : */
5507 : : static bool
3208 tgl@sss.pgh.pa.us 5508 : 74 : lookup_object_oid(EditableObjectType obj_type, const char *desc,
5509 : : Oid *obj_oid)
5510 : : {
5699 5511 : 74 : bool result = true;
3208 5512 : 74 : PQExpBuffer query = createPQExpBuffer();
5513 : : PGresult *res;
5514 : :
5515 [ + + - ]: 74 : switch (obj_type)
5516 : : {
5517 : 26 : case EditableFunction:
5518 : :
5519 : : /*
5520 : : * We have a function description, e.g. "x" or "x(int)". Issue a
5521 : : * query to retrieve the function's OID using a cast to regproc or
5522 : : * regprocedure (as appropriate).
5523 : : */
5524 : 26 : appendPQExpBufferStr(query, "SELECT ");
5525 : 26 : appendStringLiteralConn(query, desc, pset.db);
5526 : 26 : appendPQExpBuffer(query, "::pg_catalog.%s::pg_catalog.oid",
5527 [ + + ]: 26 : strchr(desc, '(') ? "regprocedure" : "regproc");
5528 : 26 : break;
5529 : :
5530 : 48 : case EditableView:
5531 : :
5532 : : /*
5533 : : * Convert view name (possibly schema-qualified) to OID. Note:
5534 : : * this code doesn't check if the relation is actually a view.
5535 : : * We'll detect that in get_create_object_cmd().
5536 : : */
5537 : 48 : appendPQExpBufferStr(query, "SELECT ");
5538 : 48 : appendStringLiteralConn(query, desc, pset.db);
1746 drowley@postgresql.o 5539 : 48 : appendPQExpBufferStr(query, "::pg_catalog.regclass::pg_catalog.oid");
3208 tgl@sss.pgh.pa.us 5540 : 48 : break;
5541 : : }
5542 : :
5543 [ - + ]: 74 : if (!echo_hidden_command(query->data))
5544 : : {
3430 andrew@dunslane.net 5545 :UBC 0 : destroyPQExpBuffer(query);
3431 5546 : 0 : return false;
5547 : : }
3431 andrew@dunslane.net 5548 :CBC 74 : res = PQexec(pset.db, query->data);
5699 tgl@sss.pgh.pa.us 5549 [ + - + - ]: 74 : if (PQresultStatus(res) == PGRES_TUPLES_OK && PQntuples(res) == 1)
3208 5550 : 74 : *obj_oid = atooid(PQgetvalue(res, 0, 0));
5551 : : else
5552 : : {
5699 tgl@sss.pgh.pa.us 5553 :UBC 0 : minimal_error_message(res);
5554 : 0 : result = false;
5555 : : }
5556 : :
5699 tgl@sss.pgh.pa.us 5557 :CBC 74 : PQclear(res);
5558 : 74 : destroyPQExpBuffer(query);
5559 : :
5560 : 74 : return result;
5561 : : }
5562 : :
5563 : : /*
5564 : : * Construct a "CREATE OR REPLACE ..." command that describes the specified
5565 : : * database object. If successful, the result is stored in buf.
5566 : : */
5567 : : static bool
3208 5568 : 74 : get_create_object_cmd(EditableObjectType obj_type, Oid oid,
5569 : : PQExpBuffer buf)
5570 : : {
5699 5571 : 74 : bool result = true;
3208 5572 : 74 : PQExpBuffer query = createPQExpBuffer();
5573 : : PGresult *res;
5574 : :
5575 [ + + - ]: 74 : switch (obj_type)
5576 : : {
5577 : 26 : case EditableFunction:
5578 : 26 : printfPQExpBuffer(query,
5579 : : "SELECT pg_catalog.pg_get_functiondef(%u)",
5580 : : oid);
5581 : 26 : break;
5582 : :
5583 : 48 : case EditableView:
5584 : :
5585 : : /*
5586 : : * pg_get_viewdef() just prints the query, so we must prepend
5587 : : * CREATE for ourselves. We must fully qualify the view name to
5588 : : * ensure the right view gets replaced. Also, check relation kind
5589 : : * to be sure it's a view.
5590 : : *
5591 : : * Starting with PG 9.4, views may have WITH [LOCAL|CASCADED]
5592 : : * CHECK OPTION. These are not part of the view definition
5593 : : * returned by pg_get_viewdef() and so need to be retrieved
5594 : : * separately. Materialized views (introduced in 9.3) may have
5595 : : * arbitrary storage parameter reloptions.
5596 : : */
2900 dean.a.rasheed@gmail 5597 [ + - ]: 48 : if (pset.sversion >= 90400)
5598 : : {
5599 : 48 : printfPQExpBuffer(query,
5600 : : "SELECT nspname, relname, relkind, "
5601 : : "pg_catalog.pg_get_viewdef(c.oid, true), "
5602 : : "pg_catalog.array_remove(pg_catalog.array_remove(c.reloptions,'check_option=local'),'check_option=cascaded') AS reloptions, "
5603 : : "CASE WHEN 'check_option=local' = ANY (c.reloptions) THEN 'LOCAL'::text "
5604 : : "WHEN 'check_option=cascaded' = ANY (c.reloptions) THEN 'CASCADED'::text ELSE NULL END AS checkoption "
5605 : : "FROM pg_catalog.pg_class c "
5606 : : "LEFT JOIN pg_catalog.pg_namespace n "
5607 : : "ON c.relnamespace = n.oid WHERE c.oid = %u",
5608 : : oid);
5609 : : }
5610 : : else
5611 : : {
2900 dean.a.rasheed@gmail 5612 :UBC 0 : printfPQExpBuffer(query,
5613 : : "SELECT nspname, relname, relkind, "
5614 : : "pg_catalog.pg_get_viewdef(c.oid, true), "
5615 : : "c.reloptions AS reloptions, "
5616 : : "NULL AS checkoption "
5617 : : "FROM pg_catalog.pg_class c "
5618 : : "LEFT JOIN pg_catalog.pg_namespace n "
5619 : : "ON c.relnamespace = n.oid WHERE c.oid = %u",
5620 : : oid);
5621 : : }
3208 tgl@sss.pgh.pa.us 5622 :CBC 48 : break;
5623 : : }
5624 : :
5625 [ - + ]: 74 : if (!echo_hidden_command(query->data))
5626 : : {
3430 andrew@dunslane.net 5627 :UBC 0 : destroyPQExpBuffer(query);
3431 5628 : 0 : return false;
5629 : : }
3431 andrew@dunslane.net 5630 :CBC 74 : res = PQexec(pset.db, query->data);
5699 tgl@sss.pgh.pa.us 5631 [ + - + - ]: 74 : if (PQresultStatus(res) == PGRES_TUPLES_OK && PQntuples(res) == 1)
5632 : : {
5633 : 74 : resetPQExpBuffer(buf);
3208 5634 [ + + - ]: 74 : switch (obj_type)
5635 : : {
5636 : 26 : case EditableFunction:
5637 : 26 : appendPQExpBufferStr(buf, PQgetvalue(res, 0, 0));
5638 : 26 : break;
5639 : :
5640 : 48 : case EditableView:
5641 : : {
5642 : 48 : char *nspname = PQgetvalue(res, 0, 0);
5643 : 48 : char *relname = PQgetvalue(res, 0, 1);
5644 : 48 : char *relkind = PQgetvalue(res, 0, 2);
5645 : 48 : char *viewdef = PQgetvalue(res, 0, 3);
2900 dean.a.rasheed@gmail 5646 : 48 : char *reloptions = PQgetvalue(res, 0, 4);
5647 : 48 : char *checkoption = PQgetvalue(res, 0, 5);
5648 : :
5649 : : /*
5650 : : * If the backend ever supports CREATE OR REPLACE
5651 : : * MATERIALIZED VIEW, allow that here; but as of today it
5652 : : * does not, so editing a matview definition in this way
5653 : : * is impossible.
5654 : : */
3208 tgl@sss.pgh.pa.us 5655 [ + - ]: 48 : switch (relkind[0])
5656 : : {
5657 : : #ifdef NOT_USED
5658 : : case RELKIND_MATVIEW:
5659 : : appendPQExpBufferStr(buf, "CREATE OR REPLACE MATERIALIZED VIEW ");
5660 : : break;
5661 : : #endif
2593 5662 : 48 : case RELKIND_VIEW:
3208 5663 : 48 : appendPQExpBufferStr(buf, "CREATE OR REPLACE VIEW ");
5664 : 48 : break;
3208 tgl@sss.pgh.pa.us 5665 :UBC 0 : default:
1840 peter@eisentraut.org 5666 : 0 : pg_log_error("\"%s.%s\" is not a view",
5667 : : nspname, relname);
3208 tgl@sss.pgh.pa.us 5668 : 0 : result = false;
5669 : 0 : break;
5670 : : }
3208 tgl@sss.pgh.pa.us 5671 :CBC 48 : appendPQExpBuffer(buf, "%s.", fmtId(nspname));
2900 dean.a.rasheed@gmail 5672 : 48 : appendPQExpBufferStr(buf, fmtId(relname));
5673 : :
5674 : : /* reloptions, if not an empty array "{}" */
5675 [ + - - + ]: 48 : if (reloptions != NULL && strlen(reloptions) > 2)
5676 : : {
2900 dean.a.rasheed@gmail 5677 :UBC 0 : appendPQExpBufferStr(buf, "\n WITH (");
5678 [ # # ]: 0 : if (!appendReloptionsArray(buf, reloptions, "",
5679 : : pset.encoding,
5680 : 0 : standard_strings()))
5681 : : {
1840 peter@eisentraut.org 5682 : 0 : pg_log_error("could not parse reloptions array");
2900 dean.a.rasheed@gmail 5683 : 0 : result = false;
5684 : : }
2434 peter_e@gmx.net 5685 : 0 : appendPQExpBufferChar(buf, ')');
5686 : : }
5687 : :
5688 : : /* View definition from pg_get_viewdef (a SELECT query) */
2900 dean.a.rasheed@gmail 5689 :CBC 48 : appendPQExpBuffer(buf, " AS\n%s", viewdef);
5690 : :
5691 : : /* Get rid of the semicolon that pg_get_viewdef appends */
3208 tgl@sss.pgh.pa.us 5692 [ + - + - ]: 48 : if (buf->len > 0 && buf->data[buf->len - 1] == ';')
5693 : 48 : buf->data[--(buf->len)] = '\0';
5694 : :
5695 : : /* WITH [LOCAL|CASCADED] CHECK OPTION */
2900 dean.a.rasheed@gmail 5696 [ + - - + ]: 48 : if (checkoption && checkoption[0] != '\0')
2900 dean.a.rasheed@gmail 5697 :UBC 0 : appendPQExpBuffer(buf, "\n WITH %s CHECK OPTION",
5698 : : checkoption);
5699 : : }
3208 tgl@sss.pgh.pa.us 5700 :CBC 48 : break;
5701 : : }
5702 : : /* Make sure result ends with a newline */
5703 [ + - + + ]: 74 : if (buf->len > 0 && buf->data[buf->len - 1] != '\n')
5704 : 48 : appendPQExpBufferChar(buf, '\n');
5705 : : }
5706 : : else
5707 : : {
5699 tgl@sss.pgh.pa.us 5708 :UBC 0 : minimal_error_message(res);
5709 : 0 : result = false;
5710 : : }
5711 : :
5699 tgl@sss.pgh.pa.us 5712 :CBC 74 : PQclear(res);
5713 : 74 : destroyPQExpBuffer(query);
5714 : :
5715 : 74 : return result;
5716 : : }
5717 : :
5718 : : /*
5719 : : * If the given argument of \ef or \ev ends with a line number, delete the line
5720 : : * number from the argument string and return it as an integer. (We need
5721 : : * this kluge because we're too lazy to parse \ef's function or \ev's view
5722 : : * argument carefully --- we just slop it up in OT_WHOLE_LINE mode.)
5723 : : *
5724 : : * Returns -1 if no line number is present, 0 on error, or a positive value
5725 : : * on success.
5726 : : */
5727 : : static int
3208 tgl@sss.pgh.pa.us 5728 :UBC 0 : strip_lineno_from_objdesc(char *obj)
5729 : : {
5730 : : char *c;
5731 : : int lineno;
5732 : :
5733 [ # # # # ]: 0 : if (!obj || obj[0] == '\0')
4994 5734 : 0 : return -1;
5735 : :
3208 5736 : 0 : c = obj + strlen(obj) - 1;
5737 : :
5738 : : /*
5739 : : * This business of parsing backwards is dangerous as can be in a
5740 : : * multibyte environment: there is no reason to believe that we are
5741 : : * looking at the first byte of a character, nor are we necessarily
5742 : : * working in a "safe" encoding. Fortunately the bitpatterns we are
5743 : : * looking for are unlikely to occur as non-first bytes, but beware of
5744 : : * trying to expand the set of cases that can be recognized. We must
5745 : : * guard the <ctype.h> macros by using isascii() first, too.
5746 : : */
5747 : :
5748 : : /* skip trailing whitespace */
5749 [ # # # # : 0 : while (c > obj && isascii((unsigned char) *c) && isspace((unsigned char) *c))
# # ]
4994 5750 : 0 : c--;
5751 : :
5752 : : /* must have a digit as last non-space char */
3208 5753 [ # # # # : 0 : if (c == obj || !isascii((unsigned char) *c) || !isdigit((unsigned char) *c))
# # ]
4994 5754 : 0 : return -1;
5755 : :
5756 : : /* find start of digit string */
3208 5757 [ # # # # : 0 : while (c > obj && isascii((unsigned char) *c) && isdigit((unsigned char) *c))
# # ]
4994 5758 : 0 : c--;
5759 : :
5760 : : /* digits must be separated from object name by space or closing paren */
5761 : : /* notice also that we are not allowing an empty object name ... */
3208 5762 [ # # # # ]: 0 : if (c == obj || !isascii((unsigned char) *c) ||
4981 5763 [ # # # # ]: 0 : !(isspace((unsigned char) *c) || *c == ')'))
4994 5764 : 0 : return -1;
5765 : :
5766 : : /* parse digit string */
5767 : 0 : c++;
5768 : 0 : lineno = atoi(c);
5769 [ # # ]: 0 : if (lineno < 1)
5770 : : {
1840 peter@eisentraut.org 5771 : 0 : pg_log_error("invalid line number: %s", c);
4994 tgl@sss.pgh.pa.us 5772 : 0 : return 0;
5773 : : }
5774 : :
5775 : : /* strip digit string from object name */
5776 : 0 : *c = '\0';
5777 : :
5778 : 0 : return lineno;
5779 : : }
5780 : :
5781 : : /*
5782 : : * Count number of lines in the buffer.
5783 : : * This is used to test if pager is needed or not.
5784 : : */
5785 : : static int
3208 tgl@sss.pgh.pa.us 5786 :CBC 74 : count_lines_in_buf(PQExpBuffer buf)
5787 : : {
5788 : 74 : int lineno = 0;
5789 : 74 : const char *lines = buf->data;
5790 : :
5791 [ + + ]: 1136 : while (*lines != '\0')
5792 : : {
5793 : 1062 : lineno++;
5794 : : /* find start of next line */
5795 : 1062 : lines = strchr(lines, '\n');
5796 [ - + ]: 1062 : if (!lines)
3208 tgl@sss.pgh.pa.us 5797 :UBC 0 : break;
3208 tgl@sss.pgh.pa.us 5798 :CBC 1062 : lines++;
5799 : : }
5800 : :
5801 : 74 : return lineno;
5802 : : }
5803 : :
5804 : : /*
5805 : : * Write text at *lines to output with line numbers.
5806 : : *
5807 : : * For functions, lineno "1" should correspond to the first line of the
5808 : : * function body; lines before that are unnumbered. We expect that
5809 : : * pg_get_functiondef() will emit that on a line beginning with "AS ",
5810 : : * "BEGIN ", or "RETURN ", and that there can be no such line before
5811 : : * the real start of the function body.
5812 : : *
5813 : : * Caution: this scribbles on *lines.
5814 : : */
5815 : : static void
499 5816 : 9 : print_with_linenumbers(FILE *output, char *lines, bool is_func)
5817 : : {
5818 : 9 : bool in_header = is_func;
3208 5819 : 9 : int lineno = 0;
5820 : :
5821 [ + + ]: 96 : while (*lines != '\0')
5822 : : {
5823 : : char *eol;
5824 : :
499 5825 [ + + ]: 87 : if (in_header &&
5826 [ + - ]: 45 : (strncmp(lines, "AS ", 3) == 0 ||
5827 [ + + ]: 45 : strncmp(lines, "BEGIN ", 6) == 0 ||
5828 [ + + ]: 39 : strncmp(lines, "RETURN ", 7) == 0))
3208 5829 : 9 : in_header = false;
5830 : :
5831 : : /* increment lineno only for body's lines */
5832 [ + + ]: 87 : if (!in_header)
5833 : 51 : lineno++;
5834 : :
5835 : : /* find and mark end of current line */
5836 : 87 : eol = strchr(lines, '\n');
5837 [ + - ]: 87 : if (eol != NULL)
5838 : 87 : *eol = '\0';
5839 : :
5840 : : /* show current line as appropriate */
5841 [ + + ]: 87 : if (in_header)
5842 : 36 : fprintf(output, " %s\n", lines);
5843 : : else
5844 : 51 : fprintf(output, "%-7d %s\n", lineno, lines);
5845 : :
5846 : : /* advance to next line, if any */
5847 [ - + ]: 87 : if (eol == NULL)
3208 tgl@sss.pgh.pa.us 5848 :UBC 0 : break;
3208 tgl@sss.pgh.pa.us 5849 :CBC 87 : lines = ++eol;
5850 : : }
5851 : 9 : }
5852 : :
5853 : : /*
5854 : : * Report just the primary error; this is to avoid cluttering the output
5855 : : * with, for instance, a redisplay of the internally generated query
5856 : : */
5857 : : static void
5699 tgl@sss.pgh.pa.us 5858 :UBC 0 : minimal_error_message(PGresult *res)
5859 : : {
5860 : : PQExpBuffer msg;
5861 : : const char *fld;
5862 : :
5863 : 0 : msg = createPQExpBuffer();
5864 : :
5865 : 0 : fld = PQresultErrorField(res, PG_DIAG_SEVERITY);
5866 [ # # ]: 0 : if (fld)
5867 : 0 : printfPQExpBuffer(msg, "%s: ", fld);
5868 : : else
5869 : 0 : printfPQExpBuffer(msg, "ERROR: ");
5870 : 0 : fld = PQresultErrorField(res, PG_DIAG_MESSAGE_PRIMARY);
5871 [ # # ]: 0 : if (fld)
5872 : 0 : appendPQExpBufferStr(msg, fld);
5873 : : else
5874 : 0 : appendPQExpBufferStr(msg, "(not available)");
2434 peter_e@gmx.net 5875 : 0 : appendPQExpBufferChar(msg, '\n');
5876 : :
1840 peter@eisentraut.org 5877 : 0 : pg_log_error("%s", msg->data);
5878 : :
5699 tgl@sss.pgh.pa.us 5879 : 0 : destroyPQExpBuffer(msg);
5880 : 0 : }
|
