From cd35f54d42e0dfb274a5ea7848fc62cf537e14f0 Mon Sep 17 00:00:00 2001 From: "David M. Johnson" Date: Sun, 15 Nov 2026 15:00:51 -0500 Subject: [PATCH] Serialize theme data with Jackson --- .../ui/struts2/ajax/ThemeDataServlet.java | 76 ++++++------------- .../ui/struts2/ajax/ThemeDataServletTest.java | 11 ++- 2 files changed, 34 insertions(+), 53 deletions(-) diff --git a/app/src/main/java/org/apache/roller/weblogger/ui/struts2/ajax/ThemeDataServlet.java b/app/src/main/java/org/apache/roller/weblogger/ui/struts2/ajax/ThemeDataServlet.java index 925455d02..bb5e0cee8 100644 --- a/app/src/main/java/org/apache/roller/weblogger/ui/struts2/ajax/ThemeDataServlet.java +++ b/app/src/main/java/org/apache/roller/weblogger/ui/struts2/ajax/ThemeDataServlet.java @@ -17,7 +17,7 @@ */ package org.apache.roller.weblogger.ui.struts2.ajax; -import org.apache.commons.text.StringEscapeUtils; +import com.fasterxml.jackson.databind.ObjectMapper; import org.apache.roller.weblogger.WebloggerException; import org.apache.roller.weblogger.business.WebloggerFactory; import org.apache.roller.weblogger.business.themes.SharedTheme; @@ -25,10 +25,6 @@ import org.apache.roller.weblogger.pojos.ThemeResource; import java.io.IOException; -import java.io.PrintWriter; -import java.util.ArrayList; -import java.util.Iterator; -import java.util.List; import jakarta.servlet.ServletException; import jakarta.servlet.http.HttpServlet; import jakarta.servlet.http.HttpServletRequest; @@ -44,6 +40,23 @@ */ public class ThemeDataServlet extends HttpServlet { + private static final ObjectMapper JSON = new ObjectMapper(); + + private record ThemeData( + String id, String name, String description, String previewPath) { + } + + private static ThemeData dataFor(SharedTheme theme) { + String id = theme.getId(); + ThemeResource preview = theme.getPreviewImage(); + String previewPath = preview == null + ? null + : "/themes/" + id + "/" + preview.getPath(); + + return new ThemeData( + id, theme.getName(), theme.getDescription(), previewPath); + } + @Override protected void doPost( HttpServletRequest request, HttpServletResponse response) @@ -56,19 +69,17 @@ public void doGet( HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { - List themes; - String themeId; - - themeId = request.getParameter("theme"); + String themeId = request.getParameter("theme"); ThemeManager themeMgr = WebloggerFactory.getWeblogger().getThemeManager(); + Object payload; if (themeId == null) { - themes = themeMgr.getEnabledThemesList(); + payload = themeMgr.getEnabledThemesList().stream() + .map(ThemeDataServlet::dataFor) + .toList(); } else { - themes = new ArrayList<>(1); try { - SharedTheme theme = themeMgr.getTheme(themeId); - themes.add(theme); + payload = dataFor(themeMgr.getTheme(themeId)); } catch (WebloggerException e) { response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "ERROR fetching theme data"); return; @@ -76,44 +87,7 @@ public void doGet( } response.setContentType("application/json; charset=utf-8"); - PrintWriter pw = response.getWriter(); - if (themeId == null) { - pw.println("[" ); - } - for (Iterator it = themes.iterator(); it.hasNext();) { - SharedTheme theme = it.next(); - // Theme metadata comes from theme.xml, which an operator can edit - // or install; escape it so a quote or newline cannot break out of - // the string and produce malformed JSON. - pw.print(" { \"id\" : \""); - pw.print(StringEscapeUtils.escapeJson(theme.getId())); - pw.print("\", "); - pw.print("\"name\" : \""); - pw.print(StringEscapeUtils.escapeJson(theme.getName())); - pw.print("\", "); - pw.print("\"description\" : \""); - pw.print(StringEscapeUtils.escapeJson(theme.getDescription())); - pw.print("\", "); - // theme.xml can name a preview image that isn't there, and then the - // theme has none - pw.print("\"previewPath\" : "); - ThemeResource preview = theme.getPreviewImage(); - if (preview == null) { - pw.print("null"); - } else { - pw.print("\""); - pw.print(StringEscapeUtils.escapeJson( - "/themes" + "/" + theme.getId() + "/" + preview.getPath())); - pw.print("\""); - } - pw.print(" }"); - if (it.hasNext()) { - pw.println(", "); - } - } - if (themeId == null) { - pw.println("]" ); - } + response.getWriter().write(JSON.writeValueAsString(payload)); response.flushBuffer(); } } diff --git a/app/src/test/java/org/apache/roller/weblogger/ui/struts2/ajax/ThemeDataServletTest.java b/app/src/test/java/org/apache/roller/weblogger/ui/struts2/ajax/ThemeDataServletTest.java index 1d87b26c5..c2b6041f4 100644 --- a/app/src/test/java/org/apache/roller/weblogger/ui/struts2/ajax/ThemeDataServletTest.java +++ b/app/src/test/java/org/apache/roller/weblogger/ui/struts2/ajax/ThemeDataServletTest.java @@ -51,8 +51,8 @@ public class ThemeDataServletTest { private static SharedTheme theme(String id, String previewPath) { SharedTheme theme = mock(SharedTheme.class); when(theme.getId()).thenReturn(id); - when(theme.getName()).thenReturn(id + " name"); - when(theme.getDescription()).thenReturn(id + " description"); + when(theme.getName()).thenReturn(id + " \"name\""); + when(theme.getDescription()).thenReturn("first line\nsecond line"); if (previewPath != null) { ThemeResource preview = mock(ThemeResource.class); when(preview.getPath()).thenReturn(previewPath); @@ -97,6 +97,13 @@ public void aThemeWithAPreviewImageHasItsPath() throws Exception { themeData("basic").get("previewPath").asText()); } + @Test + public void themeMetadataWithQuotesAndNewlinesIsValidJson() throws Exception { + JsonNode theme = themeData("basic"); + assertEquals("basic \"name\"", theme.get("name").asText()); + assertEquals("first line\nsecond line", theme.get("description").asText()); + } + @Test public void theThemeListIncludesThemesWithoutAPreviewImage() throws Exception { JsonNode list = themeData(null);