LCOV - code coverage report
Current view: top level - src/bin/psql - prompt.c (source / functions) Hit Total Coverage
Test: PostgreSQL 13beta1 Lines: 62 186 33.3 %
Date: 2020-06-03 08:06:29 Functions: 1 1 100.0 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : /*
       2             :  * psql - the PostgreSQL interactive terminal
       3             :  *
       4             :  * Copyright (c) 2000-2020, PostgreSQL Global Development Group
       5             :  *
       6             :  * src/bin/psql/prompt.c
       7             :  */
       8             : #include "postgres_fe.h"
       9             : 
      10             : #ifdef WIN32
      11             : #include <io.h>
      12             : #include <win32.h>
      13             : #endif
      14             : 
      15             : #include "common.h"
      16             : #include "common/string.h"
      17             : #include "input.h"
      18             : #include "prompt.h"
      19             : #include "settings.h"
      20             : 
      21             : /*--------------------------
      22             :  * get_prompt
      23             :  *
      24             :  * Returns a statically allocated prompt made by interpolating certain
      25             :  * tcsh style escape sequences into pset.vars "PROMPT1|2|3".
      26             :  * (might not be completely multibyte safe)
      27             :  *
      28             :  * Defined interpolations are:
      29             :  * %M - database server "hostname.domainname", "[local]" for AF_UNIX
      30             :  *      sockets, "[local:/dir/name]" if not default
      31             :  * %m - like %M, but hostname only (before first dot), or always "[local]"
      32             :  * %p - backend pid
      33             :  * %> - database server port number
      34             :  * %n - database user name
      35             :  * %/ - current database
      36             :  * %~ - like %/ but "~" when database name equals user name
      37             :  * %w - whitespace of the same width as the most recent output of PROMPT1
      38             :  * %# - "#" if superuser, ">" otherwise
      39             :  * %R - in prompt1 normally =, or ^ if single line mode,
      40             :  *          or a ! if session is not connected to a database;
      41             :  *      in prompt2 -, *, ', or ";
      42             :  *      in prompt3 nothing
      43             :  * %x - transaction status: empty, *, !, ? (unknown or no connection)
      44             :  * %l - The line number inside the current statement, starting from 1.
      45             :  * %? - the error code of the last query (not yet implemented)
      46             :  * %% - a percent sign
      47             :  *
      48             :  * %[0-9]          - the character with the given decimal code
      49             :  * %0[0-7]         - the character with the given octal code
      50             :  * %0x[0-9A-Fa-f]  - the character with the given hexadecimal code
      51             :  *
      52             :  * %`command`      - The result of executing command in /bin/sh with trailing
      53             :  *                   newline stripped.
      54             :  * %:name:         - The value of the psql variable 'name'
      55             :  * (those will not be rescanned for more escape sequences!)
      56             :  *
      57             :  * %[ ... %]       - tell readline that the contained text is invisible
      58             :  *
      59             :  * If the application-wide prompts become NULL somehow, the returned string
      60             :  * will be empty (not NULL!).
      61             :  *--------------------------
      62             :  */
      63             : 
      64             : char *
      65          18 : get_prompt(promptStatus_t status, ConditionalStack cstack)
      66             : {
      67             : #define MAX_PROMPT_SIZE 256
      68             :     static char destination[MAX_PROMPT_SIZE + 1];
      69             :     char        buf[MAX_PROMPT_SIZE + 1];
      70          18 :     bool        esc = false;
      71             :     const char *p;
      72          18 :     const char *prompt_string = "? ";
      73             :     static size_t last_prompt1_width = 0;
      74             : 
      75          18 :     switch (status)
      76             :     {
      77          18 :         case PROMPT_READY:
      78          18 :             prompt_string = pset.prompt1;
      79          18 :             break;
      80             : 
      81           0 :         case PROMPT_CONTINUE:
      82             :         case PROMPT_SINGLEQUOTE:
      83             :         case PROMPT_DOUBLEQUOTE:
      84             :         case PROMPT_DOLLARQUOTE:
      85             :         case PROMPT_COMMENT:
      86             :         case PROMPT_PAREN:
      87           0 :             prompt_string = pset.prompt2;
      88           0 :             break;
      89             : 
      90           0 :         case PROMPT_COPY:
      91           0 :             prompt_string = pset.prompt3;
      92           0 :             break;
      93             :     }
      94             : 
      95          18 :     destination[0] = '\0';
      96             : 
      97          18 :     for (p = prompt_string;
      98         180 :          *p && strlen(destination) < sizeof(destination) - 1;
      99         162 :          p++)
     100             :     {
     101         162 :         memset(buf, 0, sizeof(buf));
     102         162 :         if (esc)
     103             :         {
     104          72 :             switch (*p)
     105             :             {
     106             :                     /* Current database */
     107          18 :                 case '/':
     108          18 :                     if (pset.db)
     109          18 :                         strlcpy(buf, PQdb(pset.db), sizeof(buf));
     110          18 :                     break;
     111           0 :                 case '~':
     112           0 :                     if (pset.db)
     113             :                     {
     114             :                         const char *var;
     115             : 
     116           0 :                         if (strcmp(PQdb(pset.db), PQuser(pset.db)) == 0 ||
     117           0 :                             ((var = getenv("PGDATABASE")) && strcmp(var, PQdb(pset.db)) == 0))
     118           0 :                             strlcpy(buf, "~", sizeof(buf));
     119             :                         else
     120           0 :                             strlcpy(buf, PQdb(pset.db), sizeof(buf));
     121             :                     }
     122           0 :                     break;
     123             : 
     124             :                     /* Whitespace of the same width as the last PROMPT1 */
     125           0 :                 case 'w':
     126           0 :                     if (pset.db)
     127           0 :                         memset(buf, ' ',
     128           0 :                                Min(last_prompt1_width, sizeof(buf) - 1));
     129           0 :                     break;
     130             : 
     131             :                     /* DB server hostname (long/short) */
     132           0 :                 case 'M':
     133             :                 case 'm':
     134           0 :                     if (pset.db)
     135             :                     {
     136           0 :                         const char *host = PQhost(pset.db);
     137             : 
     138             :                         /* INET socket */
     139           0 :                         if (host && host[0] && !is_absolute_path(host))
     140             :                         {
     141           0 :                             strlcpy(buf, host, sizeof(buf));
     142           0 :                             if (*p == 'm')
     143           0 :                                 buf[strcspn(buf, ".")] = '\0';
     144             :                         }
     145             :                         /* UNIX socket */
     146             :                         else
     147             :                         {
     148           0 :                             if (!host
     149           0 :                                 || strcmp(host, DEFAULT_PGSOCKET_DIR) == 0
     150           0 :                                 || *p == 'm')
     151           0 :                                 strlcpy(buf, "[local]", sizeof(buf));
     152             :                             else
     153           0 :                                 snprintf(buf, sizeof(buf), "[local:%s]", host);
     154             :                         }
     155             :                     }
     156           0 :                     break;
     157             :                     /* DB server port number */
     158           0 :                 case '>':
     159           0 :                     if (pset.db && PQport(pset.db))
     160           0 :                         strlcpy(buf, PQport(pset.db), sizeof(buf));
     161           0 :                     break;
     162             :                     /* DB server user name */
     163           0 :                 case 'n':
     164           0 :                     if (pset.db)
     165           0 :                         strlcpy(buf, session_username(), sizeof(buf));
     166           0 :                     break;
     167             :                     /* backend pid */
     168           0 :                 case 'p':
     169           0 :                     if (pset.db)
     170             :                     {
     171           0 :                         int         pid = PQbackendPID(pset.db);
     172             : 
     173           0 :                         if (pid)
     174           0 :                             snprintf(buf, sizeof(buf), "%d", pid);
     175             :                     }
     176           0 :                     break;
     177             : 
     178           0 :                 case '0':
     179             :                 case '1':
     180             :                 case '2':
     181             :                 case '3':
     182             :                 case '4':
     183             :                 case '5':
     184             :                 case '6':
     185             :                 case '7':
     186           0 :                     *buf = (char) strtol(p, unconstify(char **, &p), 8);
     187           0 :                     --p;
     188           0 :                     break;
     189          18 :                 case 'R':
     190             :                     switch (status)
     191             :                     {
     192          18 :                         case PROMPT_READY:
     193          18 :                             if (cstack != NULL && !conditional_active(cstack))
     194           0 :                                 buf[0] = '@';
     195          18 :                             else if (!pset.db)
     196           0 :                                 buf[0] = '!';
     197          18 :                             else if (!pset.singleline)
     198          18 :                                 buf[0] = '=';
     199             :                             else
     200           0 :                                 buf[0] = '^';
     201          18 :                             break;
     202           0 :                         case PROMPT_CONTINUE:
     203           0 :                             buf[0] = '-';
     204           0 :                             break;
     205           0 :                         case PROMPT_SINGLEQUOTE:
     206           0 :                             buf[0] = '\'';
     207           0 :                             break;
     208           0 :                         case PROMPT_DOUBLEQUOTE:
     209           0 :                             buf[0] = '"';
     210           0 :                             break;
     211           0 :                         case PROMPT_DOLLARQUOTE:
     212           0 :                             buf[0] = '$';
     213           0 :                             break;
     214           0 :                         case PROMPT_COMMENT:
     215           0 :                             buf[0] = '*';
     216           0 :                             break;
     217           0 :                         case PROMPT_PAREN:
     218           0 :                             buf[0] = '(';
     219           0 :                             break;
     220           0 :                         default:
     221           0 :                             buf[0] = '\0';
     222           0 :                             break;
     223             :                     }
     224          18 :                     break;
     225             : 
     226          18 :                 case 'x':
     227          18 :                     if (!pset.db)
     228           0 :                         buf[0] = '?';
     229             :                     else
     230          18 :                         switch (PQtransactionStatus(pset.db))
     231             :                         {
     232          18 :                             case PQTRANS_IDLE:
     233          18 :                                 buf[0] = '\0';
     234          18 :                                 break;
     235           0 :                             case PQTRANS_ACTIVE:
     236             :                             case PQTRANS_INTRANS:
     237           0 :                                 buf[0] = '*';
     238           0 :                                 break;
     239           0 :                             case PQTRANS_INERROR:
     240           0 :                                 buf[0] = '!';
     241           0 :                                 break;
     242           0 :                             default:
     243           0 :                                 buf[0] = '?';
     244           0 :                                 break;
     245             :                         }
     246          18 :                     break;
     247             : 
     248           0 :                 case 'l':
     249           0 :                     snprintf(buf, sizeof(buf), UINT64_FORMAT, pset.stmt_lineno);
     250           0 :                     break;
     251             : 
     252           0 :                 case '?':
     253             :                     /* not here yet */
     254           0 :                     break;
     255             : 
     256          18 :                 case '#':
     257          18 :                     if (is_superuser())
     258          18 :                         buf[0] = '#';
     259             :                     else
     260           0 :                         buf[0] = '>';
     261          18 :                     break;
     262             : 
     263             :                     /* execute command */
     264           0 :                 case '`':
     265             :                     {
     266           0 :                         int         cmdend = strcspn(p + 1, "`");
     267           0 :                         char       *file = pnstrdup(p + 1, cmdend);
     268           0 :                         FILE       *fd = popen(file, "r");
     269             : 
     270           0 :                         if (fd)
     271             :                         {
     272           0 :                             if (fgets(buf, sizeof(buf), fd) == NULL)
     273           0 :                                 buf[0] = '\0';
     274           0 :                             pclose(fd);
     275             :                         }
     276             : 
     277             :                         /* strip trailing newline and carriage return */
     278           0 :                         (void) pg_strip_crlf(buf);
     279             : 
     280           0 :                         free(file);
     281           0 :                         p += cmdend + 1;
     282           0 :                         break;
     283             :                     }
     284             : 
     285             :                     /* interpolate variable */
     286           0 :                 case ':':
     287             :                     {
     288           0 :                         int         nameend = strcspn(p + 1, ":");
     289           0 :                         char       *name = pnstrdup(p + 1, nameend);
     290             :                         const char *val;
     291             : 
     292           0 :                         val = GetVariable(pset.vars, name);
     293           0 :                         if (val)
     294           0 :                             strlcpy(buf, val, sizeof(buf));
     295           0 :                         free(name);
     296           0 :                         p += nameend + 1;
     297           0 :                         break;
     298             :                     }
     299             : 
     300           0 :                 case '[':
     301             :                 case ']':
     302             : #if defined(USE_READLINE) && defined(RL_PROMPT_START_IGNORE)
     303             : 
     304             :                     /*
     305             :                      * readline >=4.0 undocumented feature: non-printing
     306             :                      * characters in prompt strings must be marked as such, in
     307             :                      * order to properly display the line during editing.
     308             :                      */
     309           0 :                     buf[0] = (*p == '[') ? RL_PROMPT_START_IGNORE : RL_PROMPT_END_IGNORE;
     310           0 :                     buf[1] = '\0';
     311             : #endif                          /* USE_READLINE */
     312           0 :                     break;
     313             : 
     314           0 :                 default:
     315           0 :                     buf[0] = *p;
     316           0 :                     buf[1] = '\0';
     317           0 :                     break;
     318             : 
     319             :             }
     320          72 :             esc = false;
     321             :         }
     322          90 :         else if (*p == '%')
     323          72 :             esc = true;
     324             :         else
     325             :         {
     326          18 :             buf[0] = *p;
     327          18 :             buf[1] = '\0';
     328          18 :             esc = false;
     329             :         }
     330             : 
     331         162 :         if (!esc)
     332          90 :             strlcat(destination, buf, sizeof(destination));
     333             :     }
     334             : 
     335             :     /* Compute the visible width of PROMPT1, for PROMPT2's %w */
     336          18 :     if (prompt_string == pset.prompt1)
     337             :     {
     338          18 :         char       *p = destination;
     339          18 :         char       *end = p + strlen(p);
     340          18 :         bool        visible = true;
     341             : 
     342          18 :         last_prompt1_width = 0;
     343         216 :         while (*p)
     344             :         {
     345             : #if defined(USE_READLINE) && defined(RL_PROMPT_START_IGNORE)
     346         198 :             if (*p == RL_PROMPT_START_IGNORE)
     347             :             {
     348           0 :                 visible = false;
     349           0 :                 ++p;
     350             :             }
     351         198 :             else if (*p == RL_PROMPT_END_IGNORE)
     352             :             {
     353           0 :                 visible = true;
     354           0 :                 ++p;
     355             :             }
     356             :             else
     357             : #endif
     358             :             {
     359             :                 int         chlen,
     360             :                             chwidth;
     361             : 
     362         198 :                 chlen = PQmblen(p, pset.encoding);
     363         198 :                 if (p + chlen > end)
     364           0 :                     break;      /* Invalid string */
     365             : 
     366         198 :                 if (visible)
     367             :                 {
     368         198 :                     chwidth = PQdsplen(p, pset.encoding);
     369             : 
     370         198 :                     if (*p == '\n')
     371           0 :                         last_prompt1_width = 0;
     372         198 :                     else if (chwidth > 0)
     373         198 :                         last_prompt1_width += chwidth;
     374             :                 }
     375             : 
     376         198 :                 p += chlen;
     377             :             }
     378             :         }
     379             :     }
     380             : 
     381          18 :     return destination;
     382             : }

Generated by: LCOV version 1.13