Skip to content

Serialize theme data with Jackson #282

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
mraible merged 1 commit into from
Nov 15, 2026
+34 −53
Merged

Serialize theme data with Jackson #282

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
76 changes: 25 additions & 51 deletions app/src/main/java/org/apache/roller/weblogger/ui/struts2/ajax/ThemeDataServlet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,14 @@
*/
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;
import org.apache.roller.weblogger.business.themes.ThemeManager;
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;
Expand All @@ -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)
Expand All @@ -56,64 +69,25 @@ public void doGet(
HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {

List<SharedTheme> 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;
}
}

response.setContentType("application/json; charset=utf-8");
PrintWriter pw = response.getWriter();
if (themeId == null) {
pw.println("[" );
}
for (Iterator<SharedTheme> 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();
}
}
11 changes: 9 additions & 2 deletions app/src/test/java/org/apache/roller/weblogger/ui/struts2/ajax/ThemeDataServletTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down Expand Up @@ -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);
Expand Down
Loading