Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Handle empty or all-blank PAGER setting more sanely in psql.
authorTom Lane <tgl@sss.pgh.pa.us>
Wed, 7 Dec 2016 17:19:56 +0000 (12:19 -0500)
committerTom Lane <tgl@sss.pgh.pa.us>
Wed, 7 Dec 2016 17:19:56 +0000 (12:19 -0500)
If the PAGER environment variable is set but contains an empty string,
psql would pass it to "sh" which would silently exit, causing whatever
query output we were printing to vanish entirely.  This is quite
mystifying; it took a long time for us to figure out that this was the
cause of Joseph Brenner's trouble report.  Rather than allowing that
to happen, we should treat this as another way to specify "no pager".
(We could alternatively treat it as selecting the default pager, but
it seems more likely that the former is what the user meant to achieve
by setting PAGER this way.)

Nonempty, but all-white-space, PAGER values have the same behavior, and
it's pretty easy to test for that, so let's handle that case the same way.

Most other cases of faulty PAGER values will result in the shell printing
some kind of complaint to stderr, which should be enough to diagnose the
problem, so we don't need to work harder than this.  (Note that there's
been an intentional decision not to be very chatty about apparent failure
returns from the pager process, since that may happen if, eg, the user
quits the pager with control-C or some such.  I'd just as soon not start
splitting hairs about which exit codes might merit making our own report.)

libpq's old PQprint() function was already on board with ignoring empty
PAGER values, but for consistency, make it ignore all-white-space values
as well.

It's been like this a long time, so back-patch to all supported branches.

Discussion: https://postgr.es/m/CAFfgvXWLOE2novHzYjmQK8-J6TmHz42G8f3X0SORM44+stUGmw@mail.gmail.com

doc/src/sgml/ref/psql-ref.sgml
src/bin/psql/print.c
src/interfaces/libpq/fe-print.c

index fdcc62a4493528c7223d5f18e1a58e755ad0e8f6..7a43a6936b88e9fcf56ff6a52fbc9d0213964d6a 100644 (file)
@@ -3450,8 +3450,9 @@ $endif
       If the query results do not fit on the screen, they are piped
       through this command.  Typical values are
       <literal>more</literal> or <literal>less</literal>.  The default
-      is platform-dependent.  The use of the pager can be disabled by
-      using the <command>\pset</command> command.
+      is platform-dependent.  Use of the pager can be disabled by setting
+      <envar>PAGER</envar> to empty, or by using pager-related options of
+      the <command>\pset</command> command.
      </para>
     </listitem>
    </varlistentry>
index 6dfd1cbec9aa2530b8772da757adc2f1b9445228..85ac76b8fe3f412e705e14e633b15dbaa2f20575 100644 (file)
@@ -2205,6 +2205,12 @@ PageOutput(int lines, unsigned short int pager)
            pagerprog = getenv("PAGER");
            if (!pagerprog)
                pagerprog = DEFAULT_PAGER;
+           else
+           {
+               /* if PAGER is empty or all-white-space, don't use pager */
+               if (strspn(pagerprog, " \t\r\n") == strlen(pagerprog))
+                   return stdout;
+           }
 #ifndef WIN32
            pqsignal(SIGPIPE, SIG_IGN);
 #endif
index 2fb4de3663441668a1e7409365fe01b6f7f677f6..e0b713e943ae3ea8e33cabd89897dbd797ca7fa7 100644 (file)
@@ -166,8 +166,9 @@ PQprint(FILE *fout, const PGresult *res, const PQprintOpt *po)
            screen_size.ws_col = 80;
 #endif
            pagerenv = getenv("PAGER");
+           /* if PAGER is unset, empty or all-white-space, don't use pager */
            if (pagerenv != NULL &&
-               pagerenv[0] != '\0' &&
+               strspn(pagerenv, " \t\r\n") != strlen(pagerenv) &&
                !po->html3 &&
                ((po->expanded &&
                  nTups * (nFields + 1) >= screen_size.ws_row) ||