Adjust extra lines generated by psql to be valid SQL comments.

nathan-bossart · nathan-bossart · commit 19c590f6a795 · 2023-07-26T17:02:39.000-07:00
psql's --echo-hidden, --log-file, and --single-step options generate extra lines to clearly separate queries from other output. Presently, these extra lines are not valid SQL comments, which makes them a hazard for anyone trying to copy/paste the decorated queries into a client or query editor. This commit replaces the starting and ending asterisks in these extra lines with forward slashes so that they are valid SQL comments that can be copy/pasted without incident. Author: Kirk Wolak Reviewed-by: Pavel Stehule, Laurenz Albe, Tom Lane, Alvaro Herrera, Andrey Borodin Discussion: https://postgr.es/m/CACLU5mTFJRJYtbvmZ26txGgmXWQo0hkGhH2o3hEquUPmSbGtBw%40mail.gmail.com
diff --git a/src/bin/psql/command.c b/src/bin/psql/command.c
@@ -5395,16 +5395,16 @@ echo_hidden_command(const char *query)
 {
 	if (pset.echo_hidden != PSQL_ECHO_HIDDEN_OFF)
 	{
-		printf(_("********* QUERY **********\n"
+		printf(_("/******** QUERY *********/\n"
 				 "%s\n"
-				 "**************************\n\n"), query);
+				 "/************************/\n\n"), query);
 		fflush(stdout);
 		if (pset.logfile)
 		{
 			fprintf(pset.logfile,
-					_("********* QUERY **********\n"
+					_("/******** QUERY *********/\n"
 					  "%s\n"
-					  "**************************\n\n"), query);
+					  "/************************/\n\n"), query);
 			fflush(pset.logfile);
 		}
 
diff --git a/src/bin/psql/common.c b/src/bin/psql/common.c
@@ -589,16 +589,16 @@ PSQLexec(const char *query)
 
 	if (pset.echo_hidden != PSQL_ECHO_HIDDEN_OFF)
 	{
-		printf(_("********* QUERY **********\n"
+		printf(_("/******** QUERY *********/\n"
 				 "%s\n"
-				 "**************************\n\n"), query);
+				 "/************************/\n\n"), query);
 		fflush(stdout);
 		if (pset.logfile)
 		{
 			fprintf(pset.logfile,
-					_("********* QUERY **********\n"
+					_("/******** QUERY *********/\n"
 					  "%s\n"
-					  "**************************\n\n"), query);
+					  "/************************/\n\n"), query);
 			fflush(pset.logfile);
 		}
 
@@ -1060,9 +1060,9 @@ SendQuery(const char *query)
 		char		buf[3];
 
 		fflush(stderr);
-		printf(_("***(Single step mode: verify command)*******************************************\n"
+		printf(_("/**(Single step mode: verify command)******************************************/\n"
 				 "%s\n"
-				 "***(press return to proceed or enter x and return to cancel)********************\n"),
+				 "/**(press return to proceed or enter x and return to cancel)*******************/\n"),
 			   query);
 		fflush(stdout);
 		if (fgets(buf, sizeof(buf), stdin) != NULL)
@@ -1080,9 +1080,9 @@ SendQuery(const char *query)
 	if (pset.logfile)
 	{
 		fprintf(pset.logfile,
-				_("********* QUERY **********\n"
+				_("/******** QUERY *********/\n"
 				  "%s\n"
-				  "**************************\n\n"), query);
+				  "/************************/\n\n"), query);
 		fflush(pset.logfile);
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -5395,16 +5395,16 @@ echo_hidden_command(const char *query)`
`5395`	`5395`	`{`
`5396`	`5396`	`if (pset.echo_hidden != PSQL_ECHO_HIDDEN_OFF)`
`5397`	`5397`	`{`
`5398`		`- printf(_("******* QUERY ********\n"`
	`5398`	`+ printf(_("/****** QUERY *******/\n"`
`5399`	`5399`	`"%s\n"`
`5400`		`- "**************************\n\n"), query);`
	`5400`	`+ "/************************/\n\n"), query);`
`5401`	`5401`	`fflush(stdout);`
`5402`	`5402`	`if (pset.logfile)`
`5403`	`5403`	`{`
`5404`	`5404`	`fprintf(pset.logfile,`
`5405`		`- _("******* QUERY ********\n"`
	`5405`	`+ _("/****** QUERY *******/\n"`
`5406`	`5406`	`"%s\n"`
`5407`		`- "**************************\n\n"), query);`
	`5407`	`+ "/************************/\n\n"), query);`
`5408`	`5408`	`fflush(pset.logfile);`
`5409`	`5409`	`}`
`5410`	`5410`