mirrors/bisq
1
0
Fork 0
mirror of https://github.com/bisq-network/bisq.git synced 2025-03-13 11:09:10 +01:00
Code Issues Projects Releases Packages Wiki Activity

Qualify relative --configFile value with appDataDir

Browse source 
This behavior had already been implemented prior to this commit, but has
now been tested and improved with refactoring and logging messages.

Note that this approach emulates Bitcoin Core's own behavior. When
running, for example, `bitcoind -conf=rel/path/to/bitcoin.conf`, the
relative path is prefixed / fully qualified by the value of the
`datadir` option. So if `datadir` equals `~/Library/Application
Support/Bitcoin`, then the `conf` option value above would be fully
qualified as

    ~/Library/Application Support/Bitcoin/rel/path/to/bitcoin.conf

If the argument to `-conf` is an absolute path, e.g.
`/tmp/bitcoin.conf`, then that absolute path is used without further
modification or qualification. It is assumed that the rationale for this
behavior is to avoid accidentally running against the wrong conf file
because `bitcoind` was invoked in a different directory than usual or
because a malicious actor replaced the relative conf file with their own
version.

Bisq's new `--configFile` option works (and is now tested to work) in
the same way: relative paths get prefixed by the value of
Config.getAppDataDir(), and absolute paths are processed unmodified.
This commit is contained in:
Chris Beams 2020-01-09 14:54:28 +01:00
parent e1f54e95b1
commit 3d991e009a
No known key found for this signature in database
GPG key ID: 3D214F8F5BC5ED73
2 changed files with 39 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
common/src/main/java/bisq/common/config/Config.java
View file

@ -25,6 +25,9 @@ import java.io.UncheckedIOException;
import java.util.List;
import java.util.Optional;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.qos.logback.classic.Level;
import static com.google.common.base.Preconditions.checkNotNull;
@ -33,6 +36,8 @@ import static java.util.stream.Collectors.toList;
public class Config {
private static final Logger log = LoggerFactory.getLogger(Config.class);
// option name constants typically used for @Named parameter injection
public static final String APP_NAME = "appName";
private static final String APP_DATA_DIR = "appDataDir";
@ -172,8 +177,8 @@ public class Config {
public Config(String defaultAppName, File defaultUserDataDir, String... args) {
this.defaultAppName = defaultAppName;
this.defaultUserDataDir = defaultUserDataDir;
this.defaultAppDataDir = new File(this.defaultUserDataDir, this.defaultAppName);
this.defaultConfigFile = new File(this.defaultAppDataDir, DEFAULT_CONFIG_FILE_NAME);
this.defaultAppDataDir = new File(defaultUserDataDir, defaultAppName);
this.defaultConfigFile = absoluteConfigFile(defaultAppDataDir, DEFAULT_CONFIG_FILE_NAME);
AbstractOptionSpec<Void> helpOpt =
parser.accepts("help", "Print this help text")
@ -535,14 +540,17 @@ public class Config {
options.addOptionSet(cliOpts);
File configFile = null;
OptionSpec<?>[] disallowedOpts = new OptionSpec<?>[] { helpOpt, configFileOpt };
final boolean cliHasConfigFileOpt = cliOpts.has(configFileOpt);
boolean configFileHasBeenProcessed = false;
if (cliHasConfigFileOpt) {
configFile = new File(cliOpts.valueOf(configFileOpt));
Optional<OptionSet> configFileOpts = parseOptionsFrom(configFile, parser, helpOpt, configFileOpt);
if (configFileOpts.isPresent()) {
options.addOptionSet(configFileOpts.get());
configFileHasBeenProcessed = true;
if (configFile.isAbsolute()) {
Optional<OptionSet> configFileOpts = parseOptionsFrom(configFile, disallowedOpts);
if (configFileOpts.isPresent()) {
options.addOptionSet(configFileOpts.get());
configFileHasBeenProcessed = true;
}
}
}
@ -550,13 +558,13 @@ public class Config {
this.userDataDir = options.valueOf(userDataDirOpt);
this.appDataDir = mkAppDataDir(options.has(appDataDirOpt) ?
options.valueOf(appDataDirOpt) :
new File(this.userDataDir, this.appName));
new File(userDataDir, appName));
if (!configFileHasBeenProcessed) {
configFile = cliHasConfigFileOpt && !configFile.isAbsolute() ?
new File(this.appDataDir, configFile.getPath()) : // TODO: test
new File(this.appDataDir, DEFAULT_CONFIG_FILE_NAME);
Optional<OptionSet> configFileOpts = parseOptionsFrom(configFile, parser, helpOpt, configFileOpt);
absoluteConfigFile(appDataDir, configFile.getPath()) :
absoluteConfigFile(appDataDir, DEFAULT_CONFIG_FILE_NAME);
Optional<OptionSet> configFileOpts = parseOptionsFrom(configFile, disallowedOpts);
configFileOpts.ifPresent(options::addOptionSet);
}
@ -635,11 +643,22 @@ public class Config {
BASE_CURRENCY_NETWORK_VALUE = baseCurrencyNetwork;
}
private Optional<OptionSet> parseOptionsFrom(File file, OptionParser parser, OptionSpec<?>... disallowedOpts) {
if (!file.isAbsolute() || !file.exists())
return Optional.empty();
private static File absoluteConfigFile(File parentDir, String relativeConfigFilePath) {
return new File(parentDir, relativeConfigFilePath);
}
ConfigFileReader configFileReader = new ConfigFileReader(file);
private Optional<OptionSet> parseOptionsFrom(File configFile, OptionSpec<?>[] disallowedOpts) {
if (!configFile.exists()) {
// The default config file is optional; return silently if it does not exist.
// But if a non-default config file path has been specified and does not exist,
// issue a warning first.
if (!configFile.equals(absoluteConfigFile(appDataDir, DEFAULT_CONFIG_FILE_NAME)))
log.warn("The specified config file '{}' does not exist.", configFile);
return Optional.empty();
}
ConfigFileReader configFileReader = new ConfigFileReader(configFile);
String[] optionLines = configFileReader.getOptionLines().stream()
.map(o -> "--" + o) // prepend dashes expected by jopt parser below
.collect(toList())

7
common/src/test/java/bisq/common/config/ConfigTests.java
View file

@ -1,7 +1,6 @@
package bisq.common.config;
import java.nio.file.Files;
import java.nio.file.Path;
import java.io.ByteArrayOutputStream;
import java.io.File;
@ -145,6 +144,12 @@ public class ConfigTests {
assertThat(config.getConfigFile(), equalTo(configFile));
}
@Test
public void whenConfigFileOptionIsSetToRelativePath_thenThePathIsPrefixedByAppDataDir() {
Config config = new Config("--configFile=my-bisq.properties");
assertThat(config.getConfigFile(), equalTo(new File(config.getAppDataDir(), "my-bisq.properties")));
}
@Test
public void whenAppNameIsSetInConfigFile_thenDataDirPropertiesReflectItsValue() throws IOException {
File configFile = File.createTempFile("bisq", "properties");