demus/openhab-core
1
0
Fork 0
mirror of https://github.com/danieldemus/openhab-core.git synced 2026-07-29 12:34:22 +02:00
Code Issues 1 Packages Projects Releases Wiki Activity

Perform simple escaping when building event sources (#5196)

Browse Source 
Bundle cannot contain the actor separator ($) or the
delegation separator (=>), and actor cannot contain the delegation
separator.

Also rename the package parameter to bundle, to make it clearer they
shouldn't be any more specific than the full bundle package name.

Signed-off-by: Cody Cutrer <cody@cutrer.us>
This commit is contained in:
Cody Cutrer
2025-12-16 17:22:41 +01:00
committed by GitHub
parent c3deec6d21
commit 46b9cf8f0a
2 changed files with 39 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bundles/org.openhab.core/src/main/java/org/openhab/core/events/AbstractEvent.java
+31 -15
View File
@@ -24,6 +24,7 @@ import org.eclipse.jdt.annotation.Nullable;
public abstract class AbstractEvent implements Event {
public static final String ACTOR_SEPARATOR = "$";
public static final String DELEGATION_SEPARATOR = "=>";
public static final String DELEGATION_ESCAPE = "__";
private final String topic;
@@ -99,43 +100,58 @@ public abstract class AbstractEvent implements Event {
}
/**
* Utility method to build a source string from a package and an optional actor.
* Utility method to build a source string from a bundle and an optional actor.
*
* @param packageName the package (such as org.openhab.core.thing or org.openhab.binding.matter)
* Bundle names may not contain the actor separator.
*
* The actor, if present, will be replaced with `__` to disallow the delegation separator.
* Consequently, `__` will be doubled as an escape sequence.
*
* @param bundle the bundle (such as org.openhab.core.thing or org.openhab.binding.matter)
* @param actor the actor
* @return the final source string
*/
public static String buildSource(String packageName, @Nullable String actor) {
public static String buildSource(String bundle, @Nullable String actor) {
if (bundle.contains(ACTOR_SEPARATOR)) {
throw new IllegalArgumentException("Bundle must not contain the actor separator '" + ACTOR_SEPARATOR + "'");
}
if (bundle.contains(DELEGATION_SEPARATOR)) {
throw new IllegalArgumentException(
"Bundle must not contain the delegation separator '" + DELEGATION_SEPARATOR + "'");
}
if (actor == null || actor.isEmpty()) {
return packageName;
return bundle;
}
return packageName + ACTOR_SEPARATOR + actor;
actor = actor.replace(DELEGATION_ESCAPE, DELEGATION_ESCAPE + DELEGATION_ESCAPE);
actor = actor.replace(DELEGATION_SEPARATOR, DELEGATION_ESCAPE);
return bundle + ACTOR_SEPARATOR + actor;
}
/**
* Utility method to build a delegated source string from an original source and a package
* Utility method to build a delegated source string from an original source and a bundle
*
* @param originalSource the original source (may be null)
* @param packageName the package (such as org.openhab.core.thing or org.openhab.binding.matter)
* @param bundle the bundle (such as org.openhab.core.thing or org.openhab.binding.matter)
* @return the final source string
*/
public static String buildDelegatedSource(@Nullable String originalSource, String packageName) {
public static String buildDelegatedSource(@Nullable String originalSource, String bundle) {
if (originalSource == null || originalSource.isEmpty()) {
return packageName;
return bundle;
}
return originalSource + DELEGATION_SEPARATOR + packageName;
return originalSource + DELEGATION_SEPARATOR + bundle;
}
/**
* Utility method to build a delegated source string from an original source, a package and an optional actor.
* Utility method to build a delegated source string from an original source, a bundle and an optional actor.
*
* @param originalSource the original source (may be null)
* @param packageName the package (such as org.openhab.core.thing or org.openhab.binding.matter)
* @param bundle the bundle (such as org.openhab.core.thing or org.openhab.binding.matter)
* @param actor the actor
* @return the final source string
*/
public static String buildDelegatedSource(@Nullable String originalSource, String packageName,
@Nullable String actor) {
return buildDelegatedSource(originalSource, buildSource(packageName, actor));
public static String buildDelegatedSource(@Nullable String originalSource, String bundle, @Nullable String actor) {
return buildDelegatedSource(originalSource, buildSource(bundle, actor));
}
}
bundles/org.openhab.core/src/test/java/org/openhab/core/events/AbstractEventTest.java
+8
View File
@@ -28,6 +28,14 @@ public class AbstractEventTest {
public void testBuildSource() throws Exception {
assertEquals(AbstractEvent.buildSource("org.openhab.core.thing", null), "org.openhab.core.thing");
assertEquals(AbstractEvent.buildSource("org.openhab.core.thing", "actor"), "org.openhab.core.thing$actor");
assertEquals(AbstractEvent.buildSource("org.openhab.core.io.rest", "my=>actor"),
"org.openhab.core.io.rest$my__actor");
assertEquals(AbstractEvent.buildSource("org.openhab.core.io.rest", "my__actor"),
"org.openhab.core.io.rest$my____actor");
assertThrows(IllegalArgumentException.class,
() -> AbstractEvent.buildSource("org.openhab$core.thing", "actor"));
assertThrows(IllegalArgumentException.class,
() -> AbstractEvent.buildSource("org.openhab.core=>thing", "actor"));
}
@Test