/*
* Copyright 2004-2011 H2 Group. Multiple-Licensed under the H2 License,
* Version 1.0, and under the Eclipse Public License, Version 1.0
* (http://h2database.com/html/license.html).
* Initial Developer: H2 Group
*/
package org.h2.engine;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Properties;
import org.h2.command.dml.SetTypes;
import org.h2.constant.DbSettings;
import org.h2.constant.ErrorCode;
import org.h2.constant.SysProperties;
import org.h2.message.DbException;
import org.h2.security.SHA256;
import org.h2.util.IOUtils;
import org.h2.util.New;
import org.h2.util.StringUtils;
import org.h2.util.Utils;
/**
* Encapsulates the connection settings, including user name and password.
*/
public class ConnectionInfo implements Cloneable {
private static final HashSet<String> KNOWN_SETTINGS = New.hashSet();
private Properties prop = new Properties();
private String originalURL;
private String url;
private String user;
private byte[] filePasswordHash;
private byte[] userPasswordHash;
/**
* The database name
*/
private String name;
private String nameNormalized;
private boolean remote;
private boolean ssl;
private boolean persistent;
private boolean unnamed;
/**
* Create a connection info object.
*
* @param name the database name (including tags), but without the
* "jdbc:h2:" prefix
*/
public ConnectionInfo(String name) {
this.name = name;
this.url = Constants.START_URL + name;
parseName();
}
/**
* Create a connection info object.
*
* @param u the database URL (must start with jdbc:h2:)
* @param info the connection properties
*/
public ConnectionInfo(String u, Properties info) {
this.originalURL = u;
if (!u.startsWith(Constants.START_URL)) {
throw DbException.getInvalidValueException("url", u);
}
this.url = u;
readProperties(info);
readSettingsFromURL();
setUserName(removeProperty("USER", ""));
convertPasswords();
name = url.substring(Constants.START_URL.length());
parseName();
}
static {
ArrayList<String> list = SetTypes.getTypes();
HashSet<String> set = KNOWN_SETTINGS;
set.addAll(list);
String[] connectionTime = { "ACCESS_MODE_DATA", "AUTOCOMMIT", "CIPHER",
"CREATE", "CACHE_TYPE", "FILE_LOCK", "IGNORE_UNKNOWN_SETTINGS", "IFEXISTS",
"INIT", "PASSWORD", "RECOVER", "USER", "AUTO_SERVER", "NO_UPGRADE",
"AUTO_RECONNECT", "OPEN_NEW", "PAGE_SIZE", "PASSWORD_HASH", "JMX" };
for (String key : connectionTime) {
if (SysProperties.CHECK && set.contains(key)) {
DbException.throwInternalError(key);
}
set.add(key);
}
}
private static boolean isKnownSetting(String s) {
return KNOWN_SETTINGS.contains(s);
}
public Object clone() throws CloneNotSupportedException {
ConnectionInfo clone = (ConnectionInfo) super.clone();
clone.prop = (Properties) prop.clone();
clone.filePasswordHash = Utils.cloneByteArray(filePasswordHash);
clone.userPasswordHash = Utils.cloneByteArray(userPasswordHash);
return clone;
}
private void parseName() {
if (".".equals(name)) {
name = "mem:";
}
if (name.startsWith("tcp:")) {
remote = true;
name = name.substring("tcp:".length());
} else if (name.startsWith("ssl:")) {
remote = true;
ssl = true;
name = name.substring("ssl:".length());
} else if (name.startsWith("mem:")) {
persistent = false;
if ("mem:".equals(name)) {
unnamed = true;
}
} else if (name.startsWith("file:")) {
name = name.substring("file:".length());
persistent = true;
} else {
persistent = true;
}
if (persistent && !remote) {
if ("/".equals(SysProperties.FILE_SEPARATOR)) {
name = name.replace('\\', '/');
} else {
name = name.replace('/', '\\');
}
}
}
/**
* Set the base directory of persistent databases, unless the database is in
* the user home folder (~).
*
* @param dir the new base directory
*/
public void setBaseDir(String dir) {
if (persistent) {
String absDir = IOUtils.unwrap(IOUtils.getCanonicalPath(dir));
boolean absolute = IOUtils.isAbsolute(name);
String n;
String prefix = null;
if (absolute) {
n = name;
} else {
n = IOUtils.unwrap(name);
prefix = name.substring(0, name.length() - n.length());
n = dir + SysProperties.FILE_SEPARATOR + n;
}
String normalizedName = IOUtils.unwrap(IOUtils.getCanonicalPath(n));
if (normalizedName.equals(absDir) || !normalizedName.startsWith(absDir)) {
throw DbException.get(ErrorCode.IO_EXCEPTION_1, normalizedName + " outside " +
absDir);
}
if (!absolute) {
name = prefix + dir + SysProperties.FILE_SEPARATOR + IOUtils.unwrap(name);
}
}
}
/**
* Check if this is a remote connection.
*
* @return true if it is
*/
public boolean isRemote() {
return remote;
}
/**
* Check if the referenced database is persistent.
*
* @return true if it is
*/
public boolean isPersistent() {
return persistent;
}
/**
* Check if the referenced database is an unnamed in-memory database.
*
* @return true if it is
*/
boolean isUnnamedInMemory() {
return unnamed;
}
private void readProperties(Properties info) {
Object[] list = new Object[info.size()];
info.keySet().toArray(list);
DbSettings s = null;
for (Object k : list) {
String key = StringUtils.toUpperEnglish(k.toString());
if (prop.containsKey(key)) {
throw DbException.get(ErrorCode.DUPLICATE_PROPERTY_1, key);
}
Object value = info.get(k);
if (isKnownSetting(key)) {
prop.put(key, value);
} else {
if (s == null) {
s = getDbSettings();
}
if (s.containsKey(key)) {
prop.put(key, value);
}
}
}
}
private void readSettingsFromURL() {
DbSettings dbSettings = DbSettings.getInstance(null);
int idx = url.indexOf(';');
if (idx >= 0) {
String settings = url.substring(idx + 1);
url = url.substring(0, idx);
String[] list = StringUtils.arraySplit(settings, ';', false);
for (String setting : list) {
int equal = setting.indexOf('=');
if (equal < 0) {
throw getFormatException();
}
String value = setting.substring(equal + 1);
String key = setting.substring(0, equal);
key = StringUtils.toUpperEnglish(key);
if (!isKnownSetting(key) && !dbSettings.containsKey(key)) {
throw DbException.get(ErrorCode.UNSUPPORTED_SETTING_1, key);
}
String old = prop.getProperty(key);
if (old != null && !old.equals(value)) {
throw DbException.get(ErrorCode.DUPLICATE_PROPERTY_1, key);
}
prop.setProperty(key, value);
}
}
}
private char[] removePassword() {
Object p = prop.remove("PASSWORD");
if (p == null) {
return new char[0];
} else if (p instanceof char[]) {
return (char[]) p;
} else {
return p.toString().toCharArray();
}
}
/**
* Split the password property into file password and user password if
* necessary, and convert them to the internal hash format.
*/
private void convertPasswords() {
char[] password = removePassword();
boolean passwordHash = removeProperty("PASSWORD_HASH", false);
if (getProperty("CIPHER", null) != null) {
// split password into (filePassword+' '+userPassword)
int space = -1;
for (int i = 0, len = password.length; i < len; i++) {
if (password[i] == ' ') {
space = i;
break;
}
}
if (space < 0) {
throw DbException.get(ErrorCode.WRONG_PASSWORD_FORMAT);
}
char[] np = new char[password.length - space - 1];
char[] filePassword = new char[space];
System.arraycopy(password, space + 1, np, 0, np.length);
System.arraycopy(password, 0, filePassword, 0, space);
Arrays.fill(password, (char) 0);
password = np;
filePasswordHash = hashPassword(passwordHash, "file", filePassword);
}
userPasswordHash = hashPassword(passwordHash, user, password);
}
private static byte[] hashPassword(boolean passwordHash, String userName, char[] password) {
if (passwordHash) {
return StringUtils.convertHexToBytes(new String(password));
}
if (userName.length() == 0 && password.length == 0 && SysProperties.EMPTY_PASSWORD) {
return new byte[0];
}
return SHA256.getKeyPasswordHash(userName, password);
}
/**
* Get a boolean property if it is set and return the value.
*
* @param key the property name
* @param defaultValue the default value
* @return the value
*/
boolean getProperty(String key, boolean defaultValue) {
String x = getProperty(key, null);
if (x == null) {
return defaultValue;
}
// support 0 / 1 (like the parser)
if (x.length() == 1 && Character.isDigit(x.charAt(0))) {
return Integer.parseInt(x) != 0;
}
return Boolean.valueOf(x).booleanValue();
}
/**
* Remove a boolean property if it is set and return the value.
*
* @param key the property name
* @param defaultValue the default value
* @return the value
*/
public boolean removeProperty(String key, boolean defaultValue) {
String x = removeProperty(key, null);
return x == null ? defaultValue : Boolean.valueOf(x).booleanValue();
}
/**
* Remove a String property if it is set and return the value.
*
* @param key the property name
* @param defaultValue the default value
* @return the value
*/
String removeProperty(String key, String defaultValue) {
if (SysProperties.CHECK && !isKnownSetting(key)) {
DbException.throwInternalError(key);
}
Object x = prop.remove(key);
return x == null ? defaultValue : x.toString();
}
/**
* Get the unique and normalized database name (excluding settings).
*
* @return the database name
*/
public String getName() {
if (persistent) {
if (nameNormalized == null) {
String suffix = Constants.SUFFIX_PAGE_FILE;
String n = IOUtils.getCanonicalPath(name + suffix);
String fileName = IOUtils.getFileName(n);
if (fileName.length() < suffix.length() + 1) {
throw DbException.get(ErrorCode.INVALID_DATABASE_NAME_1, name);
}
nameNormalized = n.substring(0, n.length() - suffix.length());
}
return nameNormalized;
}
return name;
}
/**
* Get the file password hash if it is set.
*
* @return the password hash or null
*/
byte[] getFilePasswordHash() {
return filePasswordHash;
}
/**
* Get the name of the user.
*
* @return the user name
*/
public String getUserName() {
return user;
}
/**
* Get the user password hash.
*
* @return the password hash
*/
byte[] getUserPasswordHash() {
return userPasswordHash;
}
/**
* Get the property keys.
*
* @return the property keys
*/
String[] getKeys() {
String[] keys = new String[prop.size()];
prop.keySet().toArray(keys);
return keys;
}
/**
* Get the value of the given property.
*
* @param key the property key
* @return the value as a String
*/
String getProperty(String key) {
Object value = prop.get(key);
if (value == null || !(value instanceof String)) {
return null;
}
return value.toString();
}
/**
* Get the value of the given property.
*
* @param key the property key
* @param defaultValue the default value
* @return the value as a String
*/
int getProperty(String key, int defaultValue) {
if (SysProperties.CHECK && !isKnownSetting(key)) {
DbException.throwInternalError(key);
}
String s = getProperty(key);
return s == null ? defaultValue : Integer.parseInt(s);
}
/**
* Get the value of the given property.
*
* @param key the property key
* @param defaultValue the default value
* @return the value as a String
*/
public String getProperty(String key, String defaultValue) {
if (SysProperties.CHECK && !isKnownSetting(key)) {
DbException.throwInternalError(key);
}
String s = getProperty(key);
return s == null ? defaultValue : s;
}
/**
* Get the value of the given property.
*
* @param setting the setting id
* @param defaultValue the default value
* @return the value as a String
*/
String getProperty(int setting, String defaultValue) {
String key = SetTypes.getTypeName(setting);
String s = getProperty(key);
return s == null ? defaultValue : s;
}
/**
* Get the value of the given property.
*
* @param setting the setting id
* @param defaultValue the default value
* @return the value as an integer
*/
int getIntProperty(int setting, int defaultValue) {
String key = SetTypes.getTypeName(setting);
String s = getProperty(key, null);
try {
return s == null ? defaultValue : Integer.decode(s);
} catch (NumberFormatException e) {
return defaultValue;
}
}
/**
* Check if this is a remote connection with SSL enabled.
*
* @return true if it is
*/
boolean isSSL() {
return ssl;
}
/**
* Overwrite the user name. The user name is case-insensitive and stored in
* uppercase. English conversion is used.
*
* @param name the user name
*/
public void setUserName(String name) {
this.user = StringUtils.toUpperEnglish(name);
}
/**
* Set the user password hash.
*
* @param hash the new hash value
*/
public void setUserPasswordHash(byte[] hash) {
this.userPasswordHash = hash;
}
/**
* Set the file password hash.
*
* @param hash the new hash value
*/
public void setFilePasswordHash(byte[] hash) {
this.filePasswordHash = hash;
}
/**
* Overwrite a property.
*
* @param key the property name
* @param value the value
*/
public void setProperty(String key, String value) {
// value is null if the value is an object
if (value != null) {
prop.setProperty(key, value);
}
}
/**
* Get the database URL.
*
* @return the URL
*/
public String getURL() {
return url;
}
/**
* Get the complete original database URL.
*
* @return the database URL
*/
public String getOriginalURL() {
return originalURL;
}
/**
* Set the original database URL.
*
* @param url the database url
*/
public void setOriginalURL(String url) {
originalURL = url;
}
/**
* Generate an URL format exception.
*
* @return the exception
*/
DbException getFormatException() {
String format = Constants.URL_FORMAT;
return DbException.get(ErrorCode.URL_FORMAT_ERROR_2, format, url);
}
/**
* Switch to server mode, and set the server name and database key.
*
* @param serverKey the server name, '/', and the security key
*/
public void setServerKey(String serverKey) {
remote = true;
persistent = false;
this.name = serverKey;
}
DbSettings getDbSettings() {
DbSettings defaultSettings = DbSettings.getInstance(null);
HashMap<String, String> s = null;
for (Object k : prop.keySet()) {
String key = k.toString();
if (!isKnownSetting(key) && defaultSettings.containsKey(key)) {
if (s == null) {
s = New.hashMap();
}
s.put(key, prop.getProperty(key));
}
}
return DbSettings.getInstance(s);
}
}