-
Notifications
You must be signed in to change notification settings - Fork 171
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e376934
commit 670835d
Showing
1 changed file
with
94 additions
and
95 deletions.
There are no files selected for viewing
189 changes: 94 additions & 95 deletions
189
src/main/java/net/snowflake/client/config/SFClientConfigParser.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,119 +1,118 @@ | ||
| package net.snowflake.client.config; | ||
|
|
||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import net.snowflake.client.jdbc.SnowflakeDriver; | ||
| import net.snowflake.client.log.SFLogger; | ||
| import net.snowflake.client.log.SFLoggerFactory; | ||
| import static net.snowflake.client.jdbc.SnowflakeUtil.systemGetEnv; | ||
| import static net.snowflake.client.jdbc.SnowflakeUtil.systemGetProperty; | ||
|
|
||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Paths; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import static net.snowflake.client.jdbc.SnowflakeUtil.systemGetEnv; | ||
| import static net.snowflake.client.jdbc.SnowflakeUtil.systemGetProperty; | ||
| import net.snowflake.client.jdbc.SnowflakeDriver; | ||
| import net.snowflake.client.log.SFLogger; | ||
| import net.snowflake.client.log.SFLoggerFactory; | ||
|
|
||
| public class SFClientConfigParser { | ||
| private static final SFLogger logger = SFLoggerFactory.getLogger(SFClientConfigParser.class); | ||
| public static final String SF_CLIENT_CONFIG_FILE_NAME = "sf_client_config.json"; | ||
| public static final String SF_CLIENT_CONFIG_ENV_NAME = "SF_CLIENT_CONFIG_FILE"; | ||
| private static final SFLogger logger = SFLoggerFactory.getLogger(SFClientConfigParser.class); | ||
| public static final String SF_CLIENT_CONFIG_FILE_NAME = "sf_client_config.json"; | ||
| public static final String SF_CLIENT_CONFIG_ENV_NAME = "SF_CLIENT_CONFIG_FILE"; | ||
|
|
||
| /** | ||
| * Construct SFClientConfig from client config file passed by user. This method searches the | ||
| * config file in following order: 1. configFilePath param which is read from connection URL or | ||
| * connection property. 2. Environment variable: SF_CLIENT_CONFIG_FILE containing full path to | ||
| * sf_client_config file. 3. Searches for default config file name(sf_client_config.json under the | ||
| * driver directory from where the driver gets loaded. 4. Searches for default config file | ||
| * name(sf_client_config.json) under user home directory 5. Searches for default config file | ||
| * name(sf_client_config.json) under tmp directory. | ||
| * | ||
| * @param configFilePath SF_CLIENT_CONFIG_FILE parameter read from connection URL or connection | ||
| * properties | ||
| * @return SFClientConfig | ||
| */ | ||
| public static SFClientConfig loadSFClientConfig(String configFilePath) throws IOException { | ||
| String derivedConfigFilePath = null; | ||
| if (configFilePath != null && !configFilePath.isEmpty()) { | ||
| // 1. Try to read the file at configFilePath. | ||
| derivedConfigFilePath = configFilePath; | ||
| } else if (System.getenv().containsKey(SF_CLIENT_CONFIG_ENV_NAME)) { | ||
| // 2. If SF_CLIENT_CONFIG_ENV_NAME is set, read from env. | ||
| derivedConfigFilePath = systemGetEnv(SF_CLIENT_CONFIG_ENV_NAME); | ||
| } else { | ||
| // 3. Read SF_CLIENT_CONFIG_FILE_NAME from where jdbc jar is loaded. | ||
| String driverLocation = | ||
| Paths.get(getConfigFilePathFromJDBCJarLocation(), SF_CLIENT_CONFIG_FILE_NAME).toString(); | ||
| if (Files.exists(Paths.get(driverLocation))) { | ||
| derivedConfigFilePath = driverLocation; | ||
| } else { | ||
| // 4. Read SF_CLIENT_CONFIG_FILE_NAME if it is present in user home directory. | ||
| String userHomeFilePath = | ||
| Paths.get(systemGetProperty("user.home"), SF_CLIENT_CONFIG_FILE_NAME).toString(); | ||
| if (Files.exists(Paths.get(userHomeFilePath))) { | ||
| derivedConfigFilePath = userHomeFilePath; | ||
| } | ||
| } | ||
| /** | ||
| * Construct SFClientConfig from client config file passed by user. This method searches the | ||
| * config file in following order: 1. configFilePath param which is read from connection URL or | ||
| * connection property. 2. Environment variable: SF_CLIENT_CONFIG_FILE containing full path to | ||
| * sf_client_config file. 3. Searches for default config file name(sf_client_config.json under the | ||
| * driver directory from where the driver gets loaded. 4. Searches for default config file | ||
| * name(sf_client_config.json) under user home directory 5. Searches for default config file | ||
| * name(sf_client_config.json) under tmp directory. | ||
| * | ||
| * @param configFilePath SF_CLIENT_CONFIG_FILE parameter read from connection URL or connection | ||
| * properties | ||
| * @return SFClientConfig | ||
| */ | ||
| public static SFClientConfig loadSFClientConfig(String configFilePath) throws IOException { | ||
| String derivedConfigFilePath = null; | ||
| if (configFilePath != null && !configFilePath.isEmpty()) { | ||
| // 1. Try to read the file at configFilePath. | ||
| derivedConfigFilePath = configFilePath; | ||
| } else if (System.getenv().containsKey(SF_CLIENT_CONFIG_ENV_NAME)) { | ||
| // 2. If SF_CLIENT_CONFIG_ENV_NAME is set, read from env. | ||
| derivedConfigFilePath = systemGetEnv(SF_CLIENT_CONFIG_ENV_NAME); | ||
| } else { | ||
| // 3. Read SF_CLIENT_CONFIG_FILE_NAME from where jdbc jar is loaded. | ||
| String driverLocation = | ||
| Paths.get(getConfigFilePathFromJDBCJarLocation(), SF_CLIENT_CONFIG_FILE_NAME).toString(); | ||
| if (Files.exists(Paths.get(driverLocation))) { | ||
| derivedConfigFilePath = driverLocation; | ||
| } else { | ||
| // 4. Read SF_CLIENT_CONFIG_FILE_NAME if it is present in user home directory. | ||
| String userHomeFilePath = | ||
| Paths.get(systemGetProperty("user.home"), SF_CLIENT_CONFIG_FILE_NAME).toString(); | ||
| if (Files.exists(Paths.get(userHomeFilePath))) { | ||
| derivedConfigFilePath = userHomeFilePath; | ||
| } | ||
| if (derivedConfigFilePath != null) { | ||
| try { | ||
| File configFile = new File(derivedConfigFilePath); | ||
| ObjectMapper objectMapper = new ObjectMapper(); | ||
| SFClientConfig clientConfig = objectMapper.readValue(configFile, SFClientConfig.class); | ||
| clientConfig.setConfigFilePath(derivedConfigFilePath); | ||
|
|
||
| return clientConfig; | ||
| } catch (IOException e) { | ||
| String customErrorMessage = | ||
| "Error while reading config file at location: " + derivedConfigFilePath; | ||
| throw new IOException(customErrorMessage, e); | ||
| } | ||
| } | ||
| // return null if none of the above conditions are satisfied. | ||
| return null; | ||
| } | ||
| } | ||
| if (derivedConfigFilePath != null) { | ||
| try { | ||
| File configFile = new File(derivedConfigFilePath); | ||
| ObjectMapper objectMapper = new ObjectMapper(); | ||
| SFClientConfig clientConfig = objectMapper.readValue(configFile, SFClientConfig.class); | ||
| clientConfig.setConfigFilePath(derivedConfigFilePath); | ||
|
|
||
| public static String getConfigFilePathFromJDBCJarLocation() { | ||
| try { | ||
| if (SnowflakeDriver.class.getProtectionDomain() != null | ||
| && SnowflakeDriver.class.getProtectionDomain().getCodeSource() != null | ||
| && SnowflakeDriver.class.getProtectionDomain().getCodeSource().getLocation() != null) { | ||
| return clientConfig; | ||
| } catch (IOException e) { | ||
| String customErrorMessage = | ||
| "Error while reading config file at location: " + derivedConfigFilePath; | ||
| throw new IOException(customErrorMessage, e); | ||
| } | ||
| } | ||
| // return null if none of the above conditions are satisfied. | ||
| return null; | ||
| } | ||
|
|
||
| String jarPath = | ||
| SnowflakeDriver.class.getProtectionDomain().getCodeSource().getLocation().getPath(); | ||
| public static String getConfigFilePathFromJDBCJarLocation() { | ||
| try { | ||
| if (SnowflakeDriver.class.getProtectionDomain() != null | ||
| && SnowflakeDriver.class.getProtectionDomain().getCodeSource() != null | ||
| && SnowflakeDriver.class.getProtectionDomain().getCodeSource().getLocation() != null) { | ||
|
|
||
| // remove /snowflake-jdbc-3.13.29.jar and anything that follows it from the path. | ||
| String updatedPath = new File(jarPath).getParentFile().getPath(); | ||
| String jarPath = | ||
| SnowflakeDriver.class.getProtectionDomain().getCodeSource().getLocation().getPath(); | ||
|
|
||
| if (systemGetProperty("os.name") != null | ||
| && systemGetProperty("os.name").toLowerCase().startsWith("windows")) { | ||
| // remove /snowflake-jdbc-3.13.29.jar and anything that follows it from the path. | ||
| String updatedPath = new File(jarPath).getParentFile().getPath(); | ||
|
|
||
| //Find the Windows file path pattern: ex) C:\ or D:\ | ||
| Pattern windowsFilePattern = Pattern.compile("[C-Z]:[\\\\/]"); | ||
| Matcher matcher = windowsFilePattern.matcher(updatedPath); | ||
| String prefix = ""; | ||
| if (systemGetProperty("os.name") != null | ||
| && systemGetProperty("os.name").toLowerCase().startsWith("windows")) { | ||
|
|
||
| // Path translation for windows | ||
| if (updatedPath.startsWith("/")) { | ||
| updatedPath = updatedPath.substring(1); | ||
| } else if (updatedPath.startsWith("file:\\")) { | ||
| updatedPath = updatedPath.substring(6); | ||
| } else if (updatedPath.startsWith("\\")) { | ||
| updatedPath = updatedPath.substring(2); | ||
| } else if (matcher.find() && matcher.start() != 0) { | ||
| prefix = updatedPath.substring(0, matcher.start()); | ||
| updatedPath = updatedPath.substring(matcher.start()); | ||
| } | ||
| updatedPath = prefix + updatedPath.replace("/", "\\"); | ||
| } | ||
| return updatedPath; | ||
| } | ||
| // Find the Windows file path pattern: ex) C:\ or D:\ | ||
| Pattern windowsFilePattern = Pattern.compile("[C-Z]:[\\\\/]"); | ||
| Matcher matcher = windowsFilePattern.matcher(updatedPath); | ||
| String prefix = ""; | ||
|
|
||
| return ""; | ||
| } catch (Exception ex) { | ||
| // return empty path and move to step 4 of loadSFClientConfig() | ||
| return ""; | ||
| // Path translation for windows | ||
| if (updatedPath.startsWith("/")) { | ||
| updatedPath = updatedPath.substring(1); | ||
| } else if (updatedPath.startsWith("file:\\")) { | ||
| updatedPath = updatedPath.substring(6); | ||
| } else if (updatedPath.startsWith("\\")) { | ||
| updatedPath = updatedPath.substring(2); | ||
| } else if (matcher.find() && matcher.start() != 0) { | ||
| prefix = updatedPath.substring(0, matcher.start()); | ||
| updatedPath = updatedPath.substring(matcher.start()); | ||
| } | ||
| updatedPath = prefix + updatedPath.replace("/", "\\"); | ||
| } | ||
| return updatedPath; | ||
| } | ||
|
|
||
| return ""; | ||
| } catch (Exception ex) { | ||
| // return empty path and move to step 4 of loadSFClientConfig() | ||
| return ""; | ||
| } | ||
| } | ||
| } |