Skip to content

[ISSUE #9439] Add escape for win in the method returning broker configuration #9440

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

Merged
RongtongJin merged 1 commit into from
Jun 5, 2025
Merged

[ISSUE #9439] Add escape for win in the method returning broker configuration #9440

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
1 change: 1 addition & 0 deletions broker/src/main/java/org/apache/rocketmq/broker/processor/AdminBrokerProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1066,6 +1066,7 @@ private RemotingCommand getBrokerConfig(ChannelHandlerContext ctx, RemotingComma
String content = this.brokerController.getConfiguration().getAllConfigsFormatString();
if (content != null && content.length() > 0) {
try {
content = MixAll.adjustConfigForPlatform(content);
response.setBody(content.getBytes(MixAll.DEFAULT_CHARSET));
} catch (UnsupportedEncodingException e) {
LOGGER.error("AdminBrokerProcessor#getBrokerConfig: unexpected error, caller={}",
Expand Down
9 changes: 9 additions & 0 deletions common/src/main/java/org/apache/rocketmq/common/MixAll.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -557,4 +557,13 @@ public static boolean topicAllowsLMQ(String topic) {
&& !topic.startsWith(TopicValidator.SYSTEM_TOPIC_PREFIX)
&& !topic.equals(TopicValidator.RMQ_SYS_SCHEDULE_TOPIC);
}

public static String adjustConfigForPlatform(String config) {
if (StringUtils.isNotBlank(config)) {
if (isWindows()) {
config = StringUtils.replace(config, "\\", "\\\\");
}
}
return config;
}
}
39 changes: 39 additions & 0 deletions common/src/test/java/org/apache/rocketmq/common/MixAllTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,43 @@ public void testIsLmq() {
testLmq = "%LMQ%GID_TEST";
assertThat(MixAll.isLmq(testLmq)).isTrue();
}

@Test
public void testAdjustConfigForPlatform_OnWindows() {
if (MixAll.isWindows()) {
String configWithSingleBackslash = "data\\path\\config\\file.properties";
String adjusted = MixAll.adjustConfigForPlatform(configWithSingleBackslash);
assertThat(adjusted).isEqualTo("data\\\\path\\\\config\\\\file.properties");
Comment thread
Crazylychee marked this conversation as resolved.

String configWithMultipleBackslashes = "C:\\\\RocketMQ\\\\logs\\\\broker.log";
adjusted = MixAll.adjustConfigForPlatform(configWithMultipleBackslashes);
assertThat(adjusted).isEqualTo("C:\\\\\\\\RocketMQ\\\\\\\\logs\\\\\\\\broker.log");

String configWithoutBackslash = "listenPort=10911";
adjusted = MixAll.adjustConfigForPlatform(configWithoutBackslash);
assertThat(adjusted).isEqualTo("listenPort=10911");

String emptyConfig = "";
adjusted = MixAll.adjustConfigForPlatform(emptyConfig);
assertThat(adjusted).isEqualTo("");

adjusted = MixAll.adjustConfigForPlatform(null);
assertThat(adjusted).isNull();
} else {
String configWithSingleBackslash = "/home/rocketmq/conf/broker.conf";
String adjusted = MixAll.adjustConfigForPlatform(configWithSingleBackslash);
assertThat(adjusted).isEqualTo("/home/rocketmq/conf/broker.conf");

String linuxPathWithBackslash = "some\\directory\\file.txt";
adjusted = MixAll.adjustConfigForPlatform(linuxPathWithBackslash);
assertThat(adjusted).isEqualTo("some\\directory\\file.txt");

String emptyConfig = "";
adjusted = MixAll.adjustConfigForPlatform(emptyConfig);
assertThat(adjusted).isEqualTo("");

adjusted = MixAll.adjustConfigForPlatform(null);
assertThat(adjusted).isNull();
}
}
}
1 change: 1 addition & 0 deletions container/src/main/java/org/apache/rocketmq/container/BrokerContainerProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,7 @@ private RemotingCommand getBrokerConfig(ChannelHandlerContext ctx, RemotingComma
String content = this.brokerContainer.getConfiguration().getAllConfigsFormatString();
if (content != null && content.length() > 0) {
try {
content = MixAll.adjustConfigForPlatform(content);
response.setBody(content.getBytes(MixAll.DEFAULT_CHARSET));
} catch (UnsupportedEncodingException e) {
LOGGER.error("", e);
Expand Down
1 change: 1 addition & 0 deletions ...er/src/main/java/org/apache/rocketmq/controller/processor/ControllerRequestProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,7 @@ private RemotingCommand handleGetControllerConfig(ChannelHandlerContext ctx, Rem
String content = this.controllerManager.getConfiguration().getAllConfigsFormatString();
if (content != null && content.length() > 0) {
try {
content = MixAll.adjustConfigForPlatform(content);
response.setBody(content.getBytes(MixAll.DEFAULT_CHARSET));
} catch (UnsupportedEncodingException e) {
log.error("getConfig error, ", e);
Expand Down
1 change: 1 addition & 0 deletions namesrv/src/main/java/org/apache/rocketmq/namesrv/processor/DefaultRequestProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -658,6 +658,7 @@ private RemotingCommand getConfig(ChannelHandlerContext ctx, RemotingCommand req
String content = this.namesrvController.getConfiguration().getAllConfigsFormatString();
if (StringUtils.isNotBlank(content)) {
try {
content = MixAll.adjustConfigForPlatform(content);
response.setBody(content.getBytes(MixAll.DEFAULT_CHARSET));
} catch (UnsupportedEncodingException e) {
log.error("getConfig error, ", e);
Expand Down
Loading