Skip to content

fix property value leak in DefaultParser.handleProperties #441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rootvector2 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix property value leak in DefaultParser.handleProperties #441

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions src/main/java/org/apache/commons/cli/DefaultParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -505,16 +505,17 @@ private void handleProperties(final Properties properties) throws ParseException
if (!cmd.hasOption(option) && !selected) {
// get the value from the properties
final String value = properties.getProperty(option);
if (opt.hasArg()) {
if (opt.isValuesEmpty()) {
opt.processValue(stripLeadingAndTrailingQuotesDefaultOff(value));
}
} else if (!("yes".equalsIgnoreCase(value) || "true".equalsIgnoreCase(value) || "1".equalsIgnoreCase(value))) {
if (!opt.hasArg() && !("yes".equalsIgnoreCase(value) || "true".equalsIgnoreCase(value) || "1".equalsIgnoreCase(value))) {
// if the value is not yes, true or 1 then don't add the option to the CommandLine
continue;
}
// handleOption() adds a copy of the option to the CommandLine; apply the value to that copy, not to the
// option registered in options, otherwise the value survives this parse() call and is reused by the next one
handleOption(opt);
currentOption = null;
if (currentOption != null) {
currentOption.processValue(stripLeadingAndTrailingQuotesDefaultOff(value));
currentOption = null;
}
}
}
}
Expand Down
17 changes: 17 additions & 0 deletions src/test/java/org/apache/commons/cli/AbstractParserTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -667,6 +667,23 @@ void testReuseOptionsTwice() throws Exception {
assertThrows(MissingOptionException.class, () -> parser.parse(options, new String[0]));
}

@Test
void testReuseOptionsWithProperties() throws Exception {
final Options options = new Options();
options.addOption(OptionBuilder.hasArg().create('a'));
// first parsing, the value comes from the properties
final Properties properties = new Properties();
properties.setProperty("a", "one");
assertEquals("one", parse(parser, options, null, properties).getOptionValue("a"));
// second parsing, with the same Options instance and the value on the command line
final CommandLine cmd = parser.parse(options, new String[] { "-a", "two" });
assertEquals("two", cmd.getOptionValue("a"));
assertEquals(0, cmd.getArgList().size());
// third parsing, with the same Options instance and another default value
properties.setProperty("a", "three");
assertEquals("three", parse(parser, options, null, properties).getOptionValue("a"));
}

@Test
void testShortOptionConcatenatedQuoteHandling() throws Exception {
final CommandLine cl = parser.parse(options, new String[] { "-b\"quoted string\"" });
Expand Down