Skip to content

support nested shortcodes #339

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
thmarx merged 2 commits into from
Dec 9, 2024
Merged

support nested shortcodes #339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e35cd5
support nested shortcodes
Dec 7, 2024
53c494b
update tests for nested shortcodes
Dec 9, 2024
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
317 changes: 162 additions & 155 deletions cms-content/src/main/java/com/condation/cms/content/shortcodes/TagParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
* <http://www.gnu.org/licenses/gpl-3.0.html>.
* #L%
*/

import com.condation.cms.api.model.Parameter;
import org.apache.commons.jexl3.JexlEngine;
import org.apache.commons.jexl3.MapContext;
Expand All @@ -31,162 +30,170 @@

public class TagParser {

private final JexlEngine engine;

public TagParser(JexlEngine engine) {
this.engine = engine;
}

// Klasse zur Speicherung der Tag-Informationen
public static record TagInfo (String name, Parameter rawAttributes, int startIndex, int endIndex) {}

// Erster Schritt: Alle Tags ermitteln und deren Positionen sowie Roh-Attribute speichern
public List<TagInfo> findTags(String text, TagMap tagHandlers) {
List<TagInfo> tags = new ArrayList<>();
int i = 0;

while (i < text.length()) {
if (text.charAt(i) == '[' && i + 1 < text.length() && text.charAt(i + 1) == '[') {
int tagStart = i;
int endTagIndex = findTagEnd(text, i);
if (endTagIndex != -1) {
String tagContent = text.substring(i + 2, endTagIndex).trim();
boolean isSelfClosing = tagContent.endsWith("/");

if (isSelfClosing) {
tagContent = tagContent.substring(0, tagContent.length() - 1).trim();
}

int spaceIndex = tagContent.indexOf(' ');
String tagName = spaceIndex == -1 ? tagContent : tagContent.substring(0, spaceIndex);
Parameter rawAttributes = spaceIndex == -1
? new Parameter()
: parseRawAttributes(tagContent.substring(spaceIndex + 1));

int closingTagIndex = -1;
if (!isSelfClosing) {
closingTagIndex = text.indexOf("[[/" + tagName + "]]", endTagIndex + 2);
if (closingTagIndex != -1) {
String content = text.substring(endTagIndex + 2, closingTagIndex);
rawAttributes.put("_content", content);
endTagIndex = closingTagIndex + ("[[/" + tagName + "]]").length() - 2;
}
}

if (tagHandlers.has(tagName)) {
tags.add(new TagInfo(tagName, rawAttributes, tagStart, endTagIndex + 2));
i = endTagIndex + 2; // Zum nächsten Tag springen
} else {
i++;
}
} else {
i++;
}
} else {
i++;
}
}
return tags;
}
private final JexlEngine engine;

public TagParser(JexlEngine engine) {
this.engine = engine;
}

// Klasse zur Speicherung der Tag-Informationen
public static record TagInfo(String name, Parameter rawAttributes, int startIndex, int endIndex) {

}

// Erster Schritt: Alle Tags ermitteln und deren Positionen sowie Roh-Attribute speichern
public List<TagInfo> findTags(String text, TagMap tagHandlers) {
List<TagInfo> tags = new ArrayList<>();
int i = 0;

while (i < text.length()) {
if (text.charAt(i) == '[' && i + 1 < text.length() && text.charAt(i + 1) == '[') {
int tagStart = i;
int endTagIndex = findTagEnd(text, i);
if (endTagIndex != -1) {
String tagContent = text.substring(i + 2, endTagIndex).trim();
boolean isSelfClosing = tagContent.endsWith("/");

if (isSelfClosing) {
tagContent = tagContent.substring(0, tagContent.length() - 1).trim();
}

int spaceIndex = tagContent.indexOf(' ');
String tagName = spaceIndex == -1 ? tagContent : tagContent.substring(0, spaceIndex);
Parameter rawAttributes = spaceIndex == -1
? new Parameter()
: parseRawAttributes(tagContent.substring(spaceIndex + 1));

int closingTagIndex = -1;
if (!isSelfClosing) {
closingTagIndex = text.indexOf("[[/" + tagName + "]]", endTagIndex + 2);
if (closingTagIndex != -1) {
String content = text.substring(endTagIndex + 2, closingTagIndex);
rawAttributes.put("_content", content);
endTagIndex = closingTagIndex + ("[[/" + tagName + "]]").length() - 2;
}
}

if (tagHandlers.has(tagName)) {
tags.add(new TagInfo(tagName, rawAttributes, tagStart, endTagIndex + 2));
i = endTagIndex + 2; // Zum nächsten Tag springen
} else {
i++;
}
} else {
i++;
}
} else {
i++;
}
}
return tags;
}

public String parse(String text, TagMap tagHandlers) {
return parse(text, tagHandlers, Collections.emptyMap());
}

// Zweiter Schritt: Tags basierend auf den gespeicherten Positionen ersetzen
public String parse(String text, TagMap tagHandlers, Map<String, Object> contextModel) {
// Erster Schritt: Finde alle Tags
List<TagInfo> tags = findTags(text, tagHandlers);

// Zweiter Schritt: Ersetze alle Tags im Text
StringBuilder result = new StringBuilder();
int lastIndex = 0;
for (TagInfo tag : tags) {
result.append(text, lastIndex, tag.startIndex); // Unveränderten Teil des Textes hinzufügen
Function<Parameter, String> handler = tagHandlers.get(tag.name);

// Im zweiten Schritt: Attribute auswerten
Parameter evaluatedAttributes = evaluateAttributes(tag.rawAttributes, contextModel);

result.append(handler.apply(evaluatedAttributes)); // Tag-Ersetzung
lastIndex = tag.endIndex; // Aktualisiere den Startpunkt für den nächsten Tag
}
result.append(text.substring(lastIndex)); // Füge den restlichen Text hinzu

return result.toString();
}

// Methode zum Finden des Endes eines Tags
private int findTagEnd(String text, int startIndex) {
for (int i = startIndex; i < text.length() - 1; i++) {
if (text.charAt(i) == ']' && text.charAt(i + 1) == ']') {
return i;
}
}
return -1; // Kein schließendes ']]' gefunden
}

// Methode zur Attribut-Analyse im ersten Schritt (Rohwerte als Strings speichern)
private Parameter parseRawAttributes(String attributesString) {
Parameter attributes = new Parameter();
StringBuilder key = new StringBuilder();
StringBuilder value = new StringBuilder();
boolean inQuotes = false;
boolean readingKey = true;

for (int i = 0; i < attributesString.length(); i++) {
char c = attributesString.charAt(i);
if (c == '"' || c == '\'') {
inQuotes = !inQuotes;
} else if (!inQuotes && (c == '=' || c == ' ')) {
if (readingKey) {
readingKey = false;
} else {
attributes.put(key.toString().trim(), value.toString().trim()); // Rohwert speichern
key.setLength(0);
value.setLength(0);
readingKey = true;
}
} else {
if (readingKey) {
key.append(c);
} else {
value.append(c);
}
}
}

// Letztes Attribut verarbeiten
if (key.length() > 0 && value.length() > 0) {
attributes.put(key.toString().trim(), value.toString().trim()); // Rohwert speichern
}

return attributes;
}

// Zweiter Schritt: Attribute auswerten
private Parameter evaluateAttributes(Parameter rawAttributes, Map<String, Object> contextModel) {
Parameter evaluatedAttributes = new Parameter();
for (Map.Entry<String, Object> entry : rawAttributes.entrySet()) {
String key = entry.getKey();
String rawValue = (String) entry.getValue(); // Rohwert als String
evaluatedAttributes.put(key, parseValue(rawValue, contextModel)); // Wert erst jetzt parsen
}
return evaluatedAttributes;
}

// Methode zur Auswertung von Attributwerten im zweiten Schritt
private Object parseValue(String value, Map<String, Object> contextModel) {
if (value.matches("\\d+")) {
return Integer.valueOf(value);
} else if (value.equalsIgnoreCase("true") || value.equalsIgnoreCase("false")) {
return Boolean.valueOf(value);
} else if (value.startsWith("${") && value.endsWith("}")) {
String expressionString = value.substring(2, value.length() - 1);

var expression = engine.createExpression(expressionString);
return expression.evaluate(new MapContext(contextModel));
}
return value;
}

// Zweiter Schritt: Tags basierend auf den gespeicherten Positionen ersetzen
public String parse(String text, TagMap tagHandlers, Map<String, Object> contextModel) {
// Erster Schritt: Finde alle Tags
List<TagInfo> tags = findTags(text, tagHandlers);

// Zweiter Schritt: Ersetze alle Tags im Text
StringBuilder result = new StringBuilder();
int lastIndex = 0;
for (TagInfo tag : tags) {
result.append(text, lastIndex, tag.startIndex); // Unveränderten Teil des Textes hinzufügen
Function<Parameter, String> handler = tagHandlers.get(tag.name);

// Im zweiten Schritt: Attribute auswerten
Parameter evaluatedAttributes = evaluateAttributes(tag.rawAttributes, contextModel);

if (evaluatedAttributes.containsKey("_content")) {
String rawContent = (String) evaluatedAttributes.get("_content");
String parsedContent = parse(rawContent, tagHandlers, contextModel); // Rekursives Parsen
evaluatedAttributes.put("_content", parsedContent);
}

result.append(handler.apply(evaluatedAttributes)); // Tag-Ersetzung
lastIndex = tag.endIndex; // Aktualisiere den Startpunkt für den nächsten Tag
}
result.append(text.substring(lastIndex)); // Füge den restlichen Text hinzu

return result.toString();
}

// Methode zum Finden des Endes eines Tags
private int findTagEnd(String text, int startIndex) {
for (int i = startIndex; i < text.length() - 1; i++) {
if (text.charAt(i) == ']' && text.charAt(i + 1) == ']') {
return i;
}
}
return -1; // Kein schließendes ']]' gefunden
}

// Methode zur Attribut-Analyse im ersten Schritt (Rohwerte als Strings speichern)
private Parameter parseRawAttributes(String attributesString) {
Parameter attributes = new Parameter();
StringBuilder key = new StringBuilder();
StringBuilder value = new StringBuilder();
boolean inQuotes = false;
boolean readingKey = true;

for (int i = 0; i < attributesString.length(); i++) {
char c = attributesString.charAt(i);
if (c == '"' || c == '\'') {
inQuotes = !inQuotes;
} else if (!inQuotes && (c == '=' || c == ' ')) {
if (readingKey) {
readingKey = false;
} else {
attributes.put(key.toString().trim(), value.toString().trim()); // Rohwert speichern
key.setLength(0);
value.setLength(0);
readingKey = true;
}
} else {
if (readingKey) {
key.append(c);
} else {
value.append(c);
}
}
}

// Letztes Attribut verarbeiten
if (key.length() > 0 && value.length() > 0) {
attributes.put(key.toString().trim(), value.toString().trim()); // Rohwert speichern
}

return attributes;
}

// Zweiter Schritt: Attribute auswerten
private Parameter evaluateAttributes(Parameter rawAttributes, Map<String, Object> contextModel) {
Parameter evaluatedAttributes = new Parameter();
for (Map.Entry<String, Object> entry : rawAttributes.entrySet()) {
String key = entry.getKey();
String rawValue = (String) entry.getValue(); // Rohwert als String
evaluatedAttributes.put(key, parseValue(rawValue, contextModel)); // Wert erst jetzt parsen
}
return evaluatedAttributes;
}

// Methode zur Auswertung von Attributwerten im zweiten Schritt
private Object parseValue(String value, Map<String, Object> contextModel) {
if (value.matches("\\d+")) {
return Integer.valueOf(value);
} else if (value.equalsIgnoreCase("true") || value.equalsIgnoreCase("false")) {
return Boolean.valueOf(value);
} else if (value.startsWith("${") && value.endsWith("}")) {
String expressionString = value.substring(2, value.length() - 1);

var expression = engine.createExpression(expressionString);
return expression.evaluate(new MapContext(contextModel));
}
return value;
}
}
34 changes: 34 additions & 0 deletions cms-content/src/test/java/com/condation/cms/content/shortcodes/TagParserTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,13 @@ void setup() {
return "message: " + params.get("message");
});

tagMap.put("parent", params -> {
return "<div class='parent'>%s</div>".formatted((String)params.get("_content"));
});
tagMap.put("nested", params -> {
return "nested";
});

this.tagParser = new TagParser(new JexlBuilder().create());
}

Expand Down Expand Up @@ -143,4 +150,31 @@ public void namespace() {
result = tagParser.parse("[[ns1:print message='Hello CondationCMS' /]]", tagMap);
Assertions.assertThat(result).isEqualTo("message: Hello CondationCMS");
}

@Test
public void multiline () {
String content = """
[[content]]
This is a multiline shortcode!
[[/content]]
""";

String result = tagParser.parse(content, tagMap);

Assertions.assertThat(result).isEqualToIgnoringWhitespace("This is a multiline shortcode!");
}

@Test
public void nested () {
String content = """
[[parent]]
[[nested /]]
[[/parent]]
""";

var tags = tagParser.findTags(content, tagMap);
Assertions.assertThat(tags.size()).isEqualTo(1);
String result = tagParser.parse(content, tagMap);
Assertions.assertThat(result).isEqualToIgnoringWhitespace("<div class='parent'>nested</div>");
}
}