Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

CommandLineBuilder doesn't escape, and only quotes with single-quote tick when arg has space. 

Signed-off-by: Joakim Erdfelt <joakim.erdfelt@gmail.com>
This commit is contained in:
Joakim Erdfelt 2023-02-06 15:46:50 -06:00
parent 5ca878f334
commit 8c992b9c93
No known key found for this signature in database
GPG Key ID: 2D0E1FB8FE4B68B4
3 changed files with 48 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
jetty-start/src/main/java/org/eclipse/jetty/start/CommandLineBuilder.java
View File

@ -19,17 +19,6 @@ import java.util.List;
public class CommandLineBuilder
{
// Matrix of 7-bit characters that needs escaping on command line.
private static final boolean[] NEEDS_ESCAPING = new boolean[127];
static
{
for (char c : " %$\\{}[]()\"|<>&;`!".toCharArray())
{
NEEDS_ESCAPING[c] = true;
}
}
public static File findExecutable(File root, String path)
{
String npath = path.replace('/', File.separatorChar);
@ -70,40 +59,10 @@ public class CommandLineBuilder
*
* @param arg the argument to quote
* @return the quoted and escaped argument
* @deprecated use {@link #escape(String) instead}
*/
@Deprecated
public static String quote(String arg)
{
return escape(arg);
}
/**
* Escape the raw string to make it suitable for use on a command line.
*
* @param arg the argument to escape
* @return the escaped argument
*/
public static String escape(String arg)
{
StringBuilder buf = new StringBuilder();
boolean escaped = false;
boolean quoted = false;
for (char c : arg.toCharArray())
{
if (!quoted && !escaped && NEEDS_ESCAPING[c])
{
buf.append("\\");
}
// don't quote text in single quotes
if (!escaped && (c == '\''))
{
quoted = !quoted;
}
escaped = (c == '\\');
buf.append(c);
}
return buf.toString();
return "'" + arg + "'";
}
private List<String> args;
@ -130,7 +89,7 @@ public class CommandLineBuilder
{
if (arg != null)
{
args.add(escape(arg));
args.add(arg);
}
}
@ -153,11 +112,11 @@ public class CommandLineBuilder
{
if ((value != null) && (value.length() > 0))
{
args.add(escape(name + "=" + value));
args.add(name + "=" + value);
}
else
{
args.add(escape(name));
args.add(name);
}
}
@ -203,6 +162,31 @@ public class CommandLineBuilder
return buf.toString();
}
/**
* A version of {@link #toString()} where every arg is evaluated for potential {@code '} (single-quote tick) wrapping.
*
* @param delim the delimiter between args, use {@code ' '} (space) for shell executable command line.
* @return the toString but each arg that has spaces is surrounded by {@code '} (single-quote tick)
*/
public String toQuotedString(String delim)
{
StringBuilder buf = new StringBuilder();
for (String arg : args)
{
if (buf.length() > 0)
buf.append(delim);
boolean needsQuotes = (arg.contains(" "));
if (needsQuotes)
buf.append("'");
buf.append(arg);
if (needsQuotes)
buf.append("'");
}
return buf.toString();
}
public void debug()
{
if (!StartLog.isDebugEnabled())

2
jetty-start/src/main/java/org/eclipse/jetty/start/Main.java
View File

@ -440,7 +440,7 @@ public class Main
if (args.isDryRun())
{
CommandLineBuilder cmd = args.getMainArgs(args.getDryRunParts());
System.out.println(cmd.toString(StartLog.isDebugEnabled() ? " \\\n" : " "));
System.out.println(cmd.toQuotedString(StartLog.isDebugEnabled() ? " \\\n" : " "));
}
if (args.isStopCommand())

39
jetty-start/src/test/java/org/eclipse/jetty/start/CommandLineBuilderTest.java
View File

@ -13,7 +13,6 @@
package org.eclipse.jetty.start;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import static org.hamcrest.MatcherAssert.assertThat;
@ -27,43 +26,41 @@ public class CommandLineBuilderTest
CommandLineBuilder cmd = new CommandLineBuilder("java");
cmd.addEqualsArg("-Djava.io.tmpdir", "/home/java/temp dir/");
cmd.addArg("--version");
assertThat(cmd.toString(), is("java -Djava.io.tmpdir=/home/java/temp\\ dir/ --version"));
assertThat(cmd.toQuotedString(" "), is("java '-Djava.io.tmpdir=/home/java/temp dir/' --version"));
}
@Test
public void testEscapedSimple()
public void testSimpleHomeNoSpace()
{
assertEscaping("/opt/jetty", "/opt/jetty");
CommandLineBuilder cmd = new CommandLineBuilder("java");
cmd.addEqualsArg("-Djetty.home", "/opt/jetty");
assertThat(cmd.toQuotedString(" "), is("java -Djetty.home=/opt/jetty"));
}
@Test
public void testEscapedSpaceInPath()
public void testSimpleHomeWithSpace()
{
assertEscaping("/opt/jetty 7/home", "/opt/jetty\\ 7/home");
CommandLineBuilder cmd = new CommandLineBuilder("java");
cmd.addEqualsArg("-Djetty.home", "/opt/jetty 10/home");
assertThat(cmd.toQuotedString(" "), is("java '-Djetty.home=/opt/jetty 10/home'"));
}
@Test
public void testEscapedSpaceAndQuotesInPath()
{
assertEscaping("/opt/jetty 7 \"special\"/home", "/opt/jetty\\ 7\\ \\\"special\\\"/home");
}
@Test
public void testEscapedFormattingString()
{
assertEscaping("%{client}a - %u %{dd/MMM/yyyy:HH:mm:ss ZZZ|GMT}t \"%r\" %s %O \"%{Referer}i\" \"%{User-Agent}i\"",
"\\%\\{client\\}a\\ -\\ \\%u\\ \\%\\{dd/MMM/yyyy:HH:mm:ss\\ ZZZ\\|GMT\\}t\\ \\\"\\%r\\\"\\ \\%s\\ \\%O\\ \\\"\\%\\{Referer\\}i\\\"\\ \\\"\\%\\{User-Agent\\}i\\\"");
CommandLineBuilder cmd = new CommandLineBuilder("java");
cmd.addEqualsArg("-Djetty.home", "/opt/jetty");
cmd.addEqualsArg("jetty.requestlog.formatter", "%{client}a - %u %{dd/MMM/yyyy:HH:mm:ss ZZZ|GMT}t \"%r\" %s %O \"%{Referer}i\" \"%{User-Agent}i\"");
assertThat(cmd.toQuotedString(" "), is("java -Djetty.home=/opt/jetty 'jetty.requestlog.formatter=%{client}a - %u %{dd/MMM/yyyy:HH:mm:ss ZZZ|GMT}t \"%r\" %s %O \"%{Referer}i\" \"%{User-Agent}i\"'"));
}
@Test
public void testEscapeQuotationMarks()
public void testEscapeUnicode()
{
assertEscaping("-XX:OnOutOfMemoryError='kill -9 %p'", "-XX:OnOutOfMemoryError='kill -9 %p'");
}
private void assertEscaping(String raw, String expected)
{
String actual = CommandLineBuilder.escape(raw);
assertThat("Escaped version of [" + raw + "]", actual, is(expected));
CommandLineBuilder cmd = new CommandLineBuilder("java");
cmd.addEqualsArg("-Djetty.home", "/opt/jetty");
cmd.addEqualsArg("monetary.symbol", "€");
assertThat(cmd.toQuotedString(" "), is("java -Djetty.home=/opt/jetty monetary.symbol=€"));
}
}