com.impossibl.postgres.jdbc.ConnectionUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pgjdbc-ng Show documentation
Show all versions of pgjdbc-ng Show documentation
PostgreSQL JDBC - NG - Driver
/**
* Copyright (c) 2013, impossibl.com
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of impossibl.com nor the names of its contributors may
* be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package com.impossibl.postgres.jdbc;
import com.impossibl.postgres.system.Settings;
import com.impossibl.postgres.system.SystemSettings;
import com.impossibl.postgres.types.SharedRegistry;
import static com.impossibl.postgres.jdbc.ErrorUtils.makeSQLException;
import static com.impossibl.postgres.jdbc.JDBCSettings.HOUSEKEEPER;
import static com.impossibl.postgres.jdbc.JDBCSettings.JDBC;
import static com.impossibl.postgres.system.SystemSettings.DATABASE_NAME;
import static com.impossibl.postgres.system.SystemSettings.DATABASE_URL;
import static com.impossibl.postgres.system.SystemSettings.PROTO;
import static com.impossibl.postgres.system.SystemSettings.SYS;
import static com.impossibl.postgres.utils.guava.Strings.emptyToNull;
import static com.impossibl.postgres.utils.guava.Strings.nullToEmpty;
import java.io.File;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.Inet6Address;
import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.net.URLDecoder;
import java.net.URLEncoder;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.logging.Logger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import static java.util.Comparator.comparing;
import io.netty.channel.unix.DomainSocketAddress;
/**
* Utility class for connection
* @author Kevin Wooten
* @author Jesper Pedersen
*/
class ConnectionUtil {
private static final String POSTGRES_UNIX_SOCKET_BASE_NAME = ".s.PGSQL";
private static final String POSTGRES_UNIX_SOCKET_INVALID_EXT = ".lock";
private static Logger logger = Logger.getLogger(ConnectionUtil.class.getName());
static class ConnectionSpecifier {
private List addresses;
private String database;
private Properties parameters;
ConnectionSpecifier() {
addresses = new ArrayList<>();
database = null;
parameters = new Properties();
}
String getDatabase() {
return database;
}
void setDatabase(String v) {
database = v;
}
List getAddresses() {
return addresses;
}
void prependAddress(SocketAddress v) {
addresses.add(0, v);
}
void appendAddress(SocketAddress v) {
addresses.add(v);
}
Properties getParameters() {
return parameters;
}
void addParameter(String key, String value) {
parameters.setProperty(key, value);
}
private List getAddresses(Class type) {
List found = new ArrayList<>();
for (SocketAddress address : addresses) {
if (type.isInstance(address)) {
found.add(type.cast(address));
}
}
return found;
}
private String getInetHosts() {
List inetAddresses = getAddresses(InetSocketAddress.class);
if (inetAddresses.isEmpty()) {
return null;
}
StringBuilder hosts = new StringBuilder();
Iterator addrIter = inetAddresses.iterator();
while (addrIter.hasNext()) {
InetSocketAddress addr = addrIter.next();
if (addr.getAddress() instanceof Inet6Address) {
hosts.append("[").append(addr.getHostString()).append("]");
}
else {
hosts.append(addr.getHostString());
}
if (addr.getPort() != 5432) {
hosts.append(':');
hosts.append(addr.getPort());
}
if (addrIter.hasNext()) {
hosts.append(",");
}
}
return hosts.toString();
}
private String getUnixPath() {
List unixSockets = getAddresses(DomainSocketAddress.class);
if (unixSockets.isEmpty()) {
return null;
}
return unixSockets.get(0).path();
}
private SortedSet> getSortedParameters() {
SortedSet> sortedParams =
new TreeSet<>(comparing((Map.Entry a) -> a.getKey().toString()).reversed());
sortedParams.addAll(parameters.entrySet());
return sortedParams;
}
private String getParameterQuery() {
if (parameters.isEmpty()) {
return null;
}
StringBuilder query = new StringBuilder();
Iterator> entryIter = getSortedParameters().iterator();
while (entryIter.hasNext()) {
Map.Entry entry = entryIter.next();
String key = entry.getKey().toString();
String value = emptyToNull(entry.getValue() != null ? entry.getValue().toString() : null);
try {
query.append(URLEncoder.encode(key, "UTF-8"));
}
catch (UnsupportedEncodingException e) {
query.append(entry.getKey());
}
if (value != null) {
query.append("=");
try {
query.append(URLEncoder.encode(value, "UTF-8"));
}
catch (UnsupportedEncodingException e) {
query.append(entry.getValue());
}
}
if (entryIter.hasNext()) {
query.append("&");
}
}
return query.toString();
}
String getURL() {
String url = "jdbc:pgsql:";
String inetHosts = getInetHosts();
if (inetHosts != null) {
url += "//" + inetHosts + "/";
}
if (database != null) {
try {
url += URLEncoder.encode(database, "UTF-8");
}
catch (UnsupportedEncodingException e) {
url += database;
}
}
String unixPath = getUnixPath();
String query = getParameterQuery();
if (unixPath != null || query != null) {
url += "?";
}
if (unixPath != null) {
url += "unixsocket=" + unixPath;
if (query != null) {
url += "&";
}
}
if (query != null) {
url += query;
}
return url;
}
/**
* {@inheritDoc}
*/
@Override
public String toString() {
return "ConnectionSpecifier[" +
"addresses=" + addresses +
"," +
"database=" + getDatabase() +
"," +
"parameters=" + getParameters() +
"]";
}
}
static PGDirectConnection createConnection(String url, Properties info, SharedRegistry.Factory sharedRegistryFactory) throws SQLException {
ConnectionSpecifier connSpec = parseURL(url);
if (connSpec == null) {
return null;
}
Settings settings = buildSettings(connSpec, info);
return createConnection(connSpec.addresses, settings, sharedRegistryFactory);
}
static PGDirectConnection createConnection(List addresses, Settings settings, SharedRegistry.Factory sharedRegistryFactory) throws SQLException {
SQLException lastException = null;
// Select housekeeper for connection
Housekeeper.Ref housekeeper = null;
if (settings.enabled(HOUSEKEEPER)) {
housekeeper = ThreadedHousekeeper.acquire();
}
// Try to connect to each provided address in turn returning the first
// successful connection
for (SocketAddress address : addresses) {
if (address instanceof InetSocketAddress) {
InetSocketAddress inetAddress = (InetSocketAddress) address;
if (inetAddress.isUnresolved()) {
lastException = new SQLException("Connection Error: address '" + inetAddress.getHostString() + "' is unresolved", "8001");
continue;
}
}
else if (address instanceof DomainSocketAddress) {
DomainSocketAddress domainAddress = (DomainSocketAddress) address;
File socketFile = new File(domainAddress.path());
if (!socketFile.exists()) {
lastException = new SQLException("Connection Error: unix socket '" + socketFile + "' does not exist", "8001");
continue;
}
}
try {
PGDirectConnection conn = new PGDirectConnection(address, settings, housekeeper);
conn.init(sharedRegistryFactory);
return conn;
}
catch (IOException e) {
lastException = makeSQLException("Connection Error: ", "8001", e);
}
}
//Couldn't connect so report that last exception we saw
if (lastException == null) {
lastException = new SQLException("Connection Error: unknown");
}
throw lastException;
}
/**
* Combines multiple sources of properties into one group. Connection info
* parameters take precedence over URL query parameters. Also, ensure
* that all required parameters has some default value.
*
* @param connSpec Connection specification as parsed
* @param connectInfo Connection info properties passed to connect
* @return Single group of settings
*/
private static Settings buildSettings(ConnectionSpecifier connSpec, Properties connectInfo) {
Settings settings = new Settings(JDBC, SYS, PROTO);
//Start by adding all parameters from the URL query string
settings.setAll(connSpec.getParameters());
//Add (or overwrite) parameters from the connection info
settings.setAll(connectInfo);
//Set PostgreSQL's database parameter from connSpec
settings.set(DATABASE_NAME, connSpec.getDatabase());
//Create & store URL
settings.set(DATABASE_URL, connSpec.getURL());
return settings;
}
/*
* URL Pattern jdbc:pgsql:(?://(?:(\w+)(?::(\w+))@)((?:[a-zA-Z0-9\-.]+|\[[0-9a-f:]+])(?::(?:\d+))?(?:,(?:[a-zA-Z0-9\-.]+|\[[0-9a-f:]+])(?::(?:\d+))?)*)/)?([^?&]+)(?:[?&](.*))?
* Capturing Groups:
* 1 = (host name, IPv4, IPv6 : port) pairs (optional)
* 2 = database name (required)
* 3 = parameters (optional)
*/
private static final Pattern URL_PATTERN =
Pattern.compile("jdbc:pgsql:(?://(?:(?[^:@]*)(?::(?[^@]*))?@)?(?(?:[a-zA-Z0-9\\-.]+|\\[[0-9a-f:]+])(?::(?:\\d+))?(?:,(?:[a-zA-Z0-9\\-.]+|\\[[0-9a-f:]+])(?::(?:\\d+))?)*)/)?(?[^?&/]+)(?:[?&](?.*))?");
private static final Pattern ADDRESS_PATTERN = Pattern.compile("(?:([a-zA-Z0-9\\-.]+|\\[[0-9a-f:]+])(?::(\\d+))?)");
/**
* Parses a URL connection string.
*
* Uses the URL_PATTERN to capture a hostname or ip address, port, database
* name and a list of parameters specified as query name=value pairs. All
* parts but the database name are optional.
*
* @param url
* Connection URL to parse
* @return Connection specifier of parsed URL
*/
static ConnectionSpecifier parseURL(String url) {
try {
//First match aginst the entire URL pattern. If that doesn't work
//then the url is invalid
Matcher urlMatcher = URL_PATTERN.matcher(url);
if (!urlMatcher.matches()) {
return null;
}
//Now build a conn-spec from the optional pieces of the URL
//
ConnectionSpecifier spec = new ConnectionSpecifier();
//Parse hosts into list of addresses
String hosts = nullToEmpty(urlMatcher.group("addresses"));
Matcher hostsMatcher = ADDRESS_PATTERN.matcher(hosts);
while (hostsMatcher.find()) {
String name = hostsMatcher.group(1);
String port = hostsMatcher.group(2);
if (port == null || port.isEmpty()) {
port = "5432";
}
InetSocketAddress address = new InetSocketAddress(name, Integer.parseInt(port));
spec.appendAddress(address);
}
//Assign the database
spec.setDatabase(URLDecoder.decode(urlMatcher.group("database"), "UTF-8"));
//Assign username/password (if available)
String username = urlMatcher.group("username");
if (username != null) {
username = URLDecoder.decode(username, "UTF-8");
spec.addParameter(SystemSettings.CREDENTIALS_USERNAME.getName(), username);
String password = urlMatcher.group("password");
if (password != null) {
password = URLDecoder.decode(password, "UTF-8");
spec.addParameter(SystemSettings.CREDENTIALS_PASSWORD.getName(), password);
}
}
//Parse the query string as a list of name=value pairs separated by '&'
//then assign them as extra parameters
String params = urlMatcher.group("parameters");
if (params != null && !params.isEmpty()) {
for (String nameValue : params.split("&")) {
String[] items = nameValue.split("=");
if (items.length == 1) {
String name = URLDecoder.decode(items[0], "UTF-8");
spec.addParameter(name, "");
}
else if (items.length == 2) {
String name = URLDecoder.decode(items[0], "UTF-8");
String value = URLDecoder.decode(items[1], "UTF-8");
spec.addParameter(name, value);
}
}
}
// Add unix socket address (if specified)
String unixSocketPath = spec.parameters.getProperty("unixsocket");
if (unixSocketPath != null) {
spec.parameters.remove("unixsocket");
File unixSocketFile = new File(unixSocketPath);
// If path is to a directory, try to find and append the PG socket
String[] files = unixSocketFile.list((dir, name) -> name.startsWith(POSTGRES_UNIX_SOCKET_BASE_NAME) && !name.endsWith(POSTGRES_UNIX_SOCKET_INVALID_EXT));
if (files != null && files.length != 0) {
if (files.length != 1) {
logger.warning("Multiple PostgreSQL unix sockets found in " + unixSocketPath + ", chose " + files[0] + " at random. Specify socket file to remove this warning.");
}
unixSocketFile = new File(unixSocketFile, files[0]);
}
// Prepend the address with the thought that if you're attempting to
// search multiple addresses, you're preferring the unix socket.
//
// This can be changed to allow the address in the regular hosts list
// if needed; an appropriate syntax will need to be determined.
spec.prependAddress(new DomainSocketAddress(unixSocketFile));
}
// If no addresses specified, add localhost
if (spec.addresses.isEmpty()) {
spec.appendAddress(new InetSocketAddress("localhost", 5432));
}
logger.fine("parseURL: " + url + " => " + spec);
return spec;
}
catch (Throwable e) {
return null;
}
}
}