psql: fix \connect with URIs and conninfo strings

psql was already accepting conninfo strings as the first parameter in
\connect, but the way it worked wasn't sane; some of the other
parameters would get the previous connection's values, causing it to
connect to a completely unexpected server or, more likely, not finding
any server at all because of completely wrong combinations of
parameters.

Fix by explicitely checking for a conninfo-looking parameter in the
dbname position; if one is found, use its complete specification rather
than mix with the other arguments.  Also, change tab-completion to not
try to complete conninfo/URI-looking "dbnames" and document that
conninfos are accepted as first argument.

There was a weak consensus to backpatch this, because while the behavior
of using the dbname as a conninfo is nowhere documented for \connect, it
is reasonable to expect that it works because it does work in many other
contexts.  Therefore this is backpatched all the way back to 9.0.

To implement this, routines previously private to libpq have been
duplicated so that psql can decide what looks like a conninfo/URI
string.  In back branches, just duplicate the same code all the way back
to 9.2, where URIs where introduced; 9.0 and 9.1 have a simpler version.
In master, the routines are moved to src/common and renamed.

Author: David Fetter, Andrew Dunstan.  Some editorialization by me
(probably earning a Gierth's "Sloppy" badge in the process.)
Reviewers: Andrew Gierth, Erik Rijkers, Pavel Stěhule, Stephen Frost,
Robert Haas, Andrew Dunstan.

diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml
index 9d9c573467c75865c61b948f11a5052920010fbe..0cf84ca16cbe1ade839d3b2ad8d334a1d2a1aa51 100644 (file)
--- a/doc/src/sgml/ref/psql-ref.sgml
+++ b/doc/src/sgml/ref/psql-ref.sgml
@@ -771,23 +771,31 @@ testdb=>
       </varlistentry>
 
       <varlistentry>
-        <term><literal>\c</literal> or <literal>\connect</literal> <literal>[ <replaceable class="parameter">dbname</replaceable> [ <replaceable class="parameter">username</replaceable> ] [ <replaceable class="parameter">host</replaceable> ] [ <replaceable class="parameter">port</replaceable> ] ]</literal></term>
+        <term><literal>\c</literal> or <literal>\connect</literal> <literal>[ <replaceable class="parameter">dbname</replaceable> [ <replaceable class="parameter">username</replaceable> ] [ <replaceable class="parameter">host</replaceable> ] [ <replaceable class="parameter">port</replaceable> ] ] | <replaceable class="parameter">conninfo</replaceable> </literal></term>
         <listitem>
         <para>
         Establishes a new connection to a <productname>PostgreSQL</>
-        server. If the new connection is successfully made, the
-        previous connection is closed. If any of <replaceable
-        class="parameter">dbname</replaceable>, <replaceable
-        class="parameter">username</replaceable>, <replaceable
-        class="parameter">host</replaceable> or <replaceable
-        class="parameter">port</replaceable> are omitted or specified
-        as <literal>-</literal>, the value of that parameter from the
-        previous connection is used. If there is no previous
-        connection, the <application>libpq</application> default for
-        the parameter's value is used.
+        server.  The connection parameters to use can be specified either
+        using a positional syntax, or using <literal>conninfo</> connection
+        strings as detailed in <xref linkend="libpq-connstring">.
         </para>
 
         <para>
+        When using positional parameters, if any of
+        <replaceable class="parameter">dbname</replaceable>,
+        <replaceable class="parameter">username</replaceable>,
+        <replaceable class="parameter">host</replaceable> or
+        <replaceable class="parameter">port</replaceable> are omitted or
+        specified as <literal>-</literal>, the value of that parameter from
+        the previous connection is used; if there is no previous connection,
+        the <application>libpq</application> default for the parameter's value
+        is used.  When using <literal>conninfo</> strings, no values from the
+        previous connection are used for the new connection.
+        </para>
+
+        <para>
+        If the new connection is successfully made, the previous
+        connection is closed.
         If the connection attempt failed (wrong user name, access
         denied, etc.), the previous connection will only be kept if
         <application>psql</application> is in interactive mode. When
@@ -797,6 +805,16 @@ testdb=&gt;
         mechanism that scripts are not accidentally acting on the
         wrong database on the other hand.
         </para>
+
+        <para>
+        Examples:
+        </para>
+<programlisting>
+=&gt; \c mydb myuser host.dom 6432
+=&gt; \c service=foo
+=&gt; \c "host=localhost port=5432 dbname=mydb connect_timeout=10 sslmode=disable"
+=&gt; \c postgresql://tom@localhost/mydb?application_name=myapp
+</programlisting>
         </listitem>
       </varlistentry>
 

diff --git a/src/bin/psql/command.c b/src/bin/psql/command.c
index b74db204ea27aee587c9bbc6978c1b9dc245b092..1f6c1914fefa2b01918cc33697088ded73610b62 100644 (file)
--- a/src/bin/psql/command.c
+++ b/src/bin/psql/command.c
@@ -1506,9 +1506,10 @@ do_connect(char *dbname, char *user, char *host, char *port)
        PGconn     *o_conn = pset.db,
                           *n_conn;
        char       *password = NULL;
+       bool            keep_password;
+       bool            has_connection_string;
 
-       if (!dbname)
-               dbname = PQdb(o_conn);
+       /* grab values from the old connection, unless supplied by caller */
        if (!user)
                user = PQuser(o_conn);
        if (!host)
@@ -1516,6 +1517,27 @@ do_connect(char *dbname, char *user, char *host, char *port)
        if (!port)
                port = PQport(o_conn);
 
+       has_connection_string =
+               dbname ? recognized_connection_string(dbname) : false;
+
+       /*
+        * Any change in the parameters read above makes us discard the password.
+        * We also discard it if we're to use a conninfo rather than the positional
+        * syntax.
+        */
+       keep_password =
+               ((strcmp(user, PQuser(o_conn)) == 0) &&
+                (!host || strcmp(host, PQhost(o_conn)) == 0) &&
+                (strcmp(port, PQport(o_conn)) == 0) &&
+                !has_connection_string);
+
+       /*
+        * Grab dbname from old connection unless supplied by caller.  No password
+        * discard if this changes: passwords aren't (usually) database-specific.
+        */
+       if (!dbname)
+               dbname = PQdb(o_conn);
+
        /*
         * If the user asked to be prompted for a password, ask for one now. If
         * not, use the password from the old connection, provided the username
@@ -1530,7 +1552,7 @@ do_connect(char *dbname, char *user, char *host, char *port)
        {
                password = prompt_for_password(user);
        }
-       else if (o_conn && user && strcmp(PQuser(o_conn), user) == 0)
+       else if (o_conn && keep_password)
        {
                password = strdup(PQpass(o_conn));
        }
@@ -1540,23 +1562,30 @@ do_connect(char *dbname, char *user, char *host, char *port)
 #define PARAMS_ARRAY_SIZE      8
                const char **keywords = pg_malloc(PARAMS_ARRAY_SIZE * sizeof(*keywords));
                const char **values = pg_malloc(PARAMS_ARRAY_SIZE * sizeof(*values));
-
-               keywords[0] = "host";
-               values[0] = host;
-               keywords[1] = "port";
-               values[1] = port;
-               keywords[2] = "user";
-               values[2] = user;
-               keywords[3] = "password";
-               values[3] = password;
-               keywords[4] = "dbname";
-               values[4] = dbname;
-               keywords[5] = "fallback_application_name";
-               values[5] = pset.progname;
-               keywords[6] = "client_encoding";
-               values[6] = (pset.notty || getenv("PGCLIENTENCODING")) ? NULL : "auto";
-               keywords[7] = NULL;
-               values[7] = NULL;
+               int                     paramnum = 0;
+
+               keywords[0] = "dbname";
+               values[0] = dbname;
+
+               if (!has_connection_string)
+               {
+                       keywords[++paramnum] = "host";
+                       values[paramnum] = host;
+                       keywords[++paramnum] = "port";
+                       values[paramnum] = port;
+                       keywords[++paramnum] = "user";
+                       values[paramnum] = user;
+               }
+               keywords[++paramnum] = "password";
+               values[paramnum] = password;
+               keywords[++paramnum] = "fallback_application_name";
+               values[paramnum] = pset.progname;
+               keywords[++paramnum] = "client_encoding";
+               values[paramnum] = (pset.notty || getenv("PGCLIENTENCODING")) ? NULL : "auto";
+
+               /* add array terminator */
+               keywords[++paramnum] = NULL;
+               values[paramnum] = NULL;
 
                n_conn = PQconnectdbParams(keywords, values, true);
 

diff --git a/src/bin/psql/common.c b/src/bin/psql/common.c
index 49ee47a8457457ca02b980a10985d0f926df6cb5..9a07ebc511c623b96448847a9217f229cf440733 100644 (file)
--- a/src/bin/psql/common.c
+++ b/src/bin/psql/common.c
@@ -1686,3 +1686,44 @@ expand_tilde(char **filename)
 
        return;
 }
+
+/*
+ * Checks if connection string starts with either of the valid URI prefix
+ * designators.
+ *
+ * Returns the URI prefix length, 0 if the string doesn't contain a URI prefix.
+ *
+ * XXX This is a duplicate of the eponymous libpq function.
+ */
+static int
+uri_prefix_length(const char *connstr)
+{
+       /* The connection URI must start with either of the following designators: */
+       static const char uri_designator[] = "postgresql://";
+       static const char short_uri_designator[] = "postgres://";
+
+       if (strncmp(connstr, uri_designator,
+                               sizeof(uri_designator) - 1) == 0)
+               return sizeof(uri_designator) - 1;
+
+       if (strncmp(connstr, short_uri_designator,
+                               sizeof(short_uri_designator) - 1) == 0)
+               return sizeof(short_uri_designator) - 1;
+
+       return 0;
+}
+
+/*
+ * Recognized connection string either starts with a valid URI prefix or
+ * contains a "=" in it.
+ *
+ * Must be consistent with parse_connection_string: anything for which this
+ * returns true should at least look like it's parseable by that routine.
+ *
+ * XXX This is a duplicate of the eponymous libpq function.
+ */
+bool
+recognized_connection_string(const char *connstr)
+{
+       return uri_prefix_length(connstr) != 0 || strchr(connstr, '=') != NULL;
+}

diff --git a/src/bin/psql/common.h b/src/bin/psql/common.h
index cfe0dadfd667d98df0d54de00b45433bf08ed47e..7364908360ea2e41af9e3296d6978cf16250b0b1 100644 (file)
--- a/src/bin/psql/common.h
+++ b/src/bin/psql/common.h
@@ -63,4 +63,6 @@ extern const char *session_username(void);
 
 extern void expand_tilde(char **filename);
 
+extern bool recognized_connection_string(const char *connstr);
+
 #endif   /* COMMON_H */

diff --git a/src/bin/psql/help.c b/src/bin/psql/help.c
index 4a303f9269a39bfbf725c6a843607b1ebd8401b0..b881f95f53f5c264d216af905408d01249a88f40 100644 (file)
--- a/src/bin/psql/help.c
+++ b/src/bin/psql/help.c
@@ -256,8 +256,8 @@ slashUsage(unsigned short int pager)
        fprintf(output, "\n");
 
        fprintf(output, _("Connection\n"));
-       fprintf(output, _("  \\c[onnect] [DBNAME|- USER|- HOST|- PORT|-]\n"
-       "                         connect to new database (currently \"%s\")\n"),
+       fprintf(output, _("  \\c[onnect] {[DBNAME|- USER|- HOST|- PORT|-] | conninfo}\n"
+                                         "                         connect to new database (currently \"%s\")\n"),
                        currdb);
        fprintf(output, _("  \\encoding [ENCODING]   show or set client encoding\n"));
        fprintf(output, _("  \\password [USERNAME]   securely change the password for a user\n"));

diff --git a/src/bin/psql/tab-complete.c b/src/bin/psql/tab-complete.c
index 870dd6f64bafb02d3a1fc92f3586d90bc73e756b..63424c502b4898d8b23f970bbf6cac5c1c874288 100644 (file)
--- a/src/bin/psql/tab-complete.c
+++ b/src/bin/psql/tab-complete.c
@@ -2938,8 +2938,10 @@ psql_completion(char *text, int start, int end)
 /* Backslash commands */
 /* TODO:  \dc \dd \dl */
        else if (strcmp(prev_wd, "\\connect") == 0 || strcmp(prev_wd, "\\c") == 0)
-               COMPLETE_WITH_QUERY(Query_for_list_of_databases);
-
+       {
+               if (!recognized_connection_string(text))
+                       COMPLETE_WITH_QUERY(Query_for_list_of_databases);
+       }
        else if (strncmp(prev_wd, "\\da", strlen("\\da")) == 0)
                COMPLETE_WITH_SCHEMA_QUERY(Query_for_list_of_aggregates, NULL);
        else if (strncmp(prev_wd, "\\db", strlen("\\db")) == 0)