From 42ed1a17d6580b31b0881549cf27ed240e362bc6 Mon Sep 17 00:00:00 2001 From: Elyahu41 Date: Fri, 6 Nov 2026 10:50:36 -0500 Subject: [PATCH] Escape text in ZmanimFormatter.toXML / toJSON, GeoLocation.toXML and Zman.toXML A location name (or zman label / description) containing ", &, < or a backslash was written verbatim, so the output was not well-formed XML or valid JSON. Text values are now escaped (XML entities; RFC 8259 JSON escapes). Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_015Er4Sx7LnKzzCbgDEatxkU --- .../kosherjava/zmanim/util/GeoLocation.java | 7 +- .../java/com/kosherjava/zmanim/util/Zman.java | 4 +- .../zmanim/util/ZmanimFormatter.java | 77 ++++++++++++++++--- .../util/SerializationRegressionTest.java | 29 +++++++ 4 files changed, 102 insertions(+), 15 deletions(-) diff --git a/src/main/java/com/kosherjava/zmanim/util/GeoLocation.java b/src/main/java/com/kosherjava/zmanim/util/GeoLocation.java index 22d56420..1dc7ba07 100644 --- a/src/main/java/com/kosherjava/zmanim/util/GeoLocation.java +++ b/src/main/java/com/kosherjava/zmanim/util/GeoLocation.java @@ -608,14 +608,15 @@ public double getRhumbLineDistance(GeoLocation location) { */ public String toXML() { return "\n" + - "\t" + getLocationName() + "\n" + + "\t" + ZmanimFormatter.escapeXml(getLocationName()) + "\n" + "\t" + getLatitude() + "\n" + "\t" + getLongitude() + "\n" + "\t" + getElevation() + " Meters" + "\n" + "\t" + getHorizonElevationAtSunrise() + " Meters" + "\n" + "\t" + getHorizonElevationAtSunset() + " Meters" + "\n" + - "\t" + getZoneId().getId() + "\n" + - "\t" + getZoneId().getDisplayName(TextStyle.FULL, Locale.ENGLISH) + "\n" + + "\t" + ZmanimFormatter.escapeXml(getZoneId().getId()) + "\n" + + "\t" + ZmanimFormatter.escapeXml(getZoneId().getDisplayName(TextStyle.FULL, Locale.ENGLISH)) + + "\n" + ""; } diff --git a/src/main/java/com/kosherjava/zmanim/util/Zman.java b/src/main/java/com/kosherjava/zmanim/util/Zman.java index 3ffaf14b..a200a949 100644 --- a/src/main/java/com/kosherjava/zmanim/util/Zman.java +++ b/src/main/java/com/kosherjava/zmanim/util/Zman.java @@ -317,13 +317,13 @@ public String toXML() { DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss.SSS").withZone(zoneId); StringBuilder sb = new StringBuilder(); sb.append("\n"); - sb.append("\t\n"); + sb.append("\t\n"); sb.append("\t").append(getZman() == null ? "": formatter.format(getZman())).append("\n"); if (getGeoLocation() != null) { sb.append("\t").append(getGeoLocation().toXML().replaceAll("\n", "\n\t")); } sb.append("\n\t").append(getDuration()).append("\n"); - sb.append("\t").append(getDescription()).append("\n"); + sb.append("\t").append(ZmanimFormatter.escapeXml(getDescription())).append("\n"); sb.append(""); return sb.toString(); } diff --git a/src/main/java/com/kosherjava/zmanim/util/ZmanimFormatter.java b/src/main/java/com/kosherjava/zmanim/util/ZmanimFormatter.java index 7608ab01..1ce249c9 100644 --- a/src/main/java/com/kosherjava/zmanim/util/ZmanimFormatter.java +++ b/src/main/java/com/kosherjava/zmanim/util/ZmanimFormatter.java @@ -350,13 +350,13 @@ public static String toXML(AstronomicalCalendar astronomicalCalendar) { } sb.append(" date=\"").append(df.format(localDate)).append("\""); sb.append(" type=\"").append(astronomicalCalendar.getClass().getName()).append("\""); - sb.append(" algorithm=\"").append(astronomicalCalendar.getAstronomicalCalculator().getCalculatorName()).append("\""); - sb.append(" location=\"").append(astronomicalCalendar.getGeoLocation().getLocationName()).append("\""); + sb.append(" algorithm=\"").append(escapeXml(astronomicalCalendar.getAstronomicalCalculator().getCalculatorName())).append("\""); + sb.append(" location=\"").append(escapeXml(astronomicalCalendar.getGeoLocation().getLocationName())).append("\""); sb.append(" latitude=\"").append(astronomicalCalendar.getGeoLocation().getLatitude()).append("\""); sb.append(" longitude=\"").append(astronomicalCalendar.getGeoLocation().getLongitude()).append("\""); sb.append(" elevation=\"").append(astronomicalCalendar.getGeoLocation().getElevation()).append("\""); - sb.append(" timeZoneName=\"").append(timeZoneName).append("\""); - sb.append(" timeZoneID=\"").append(geoLocation.getZoneId().getId()).append("\""); + sb.append(" timeZoneName=\"").append(escapeXml(timeZoneName)).append("\""); + sb.append(" timeZoneID=\"").append(escapeXml(geoLocation.getZoneId().getId())).append("\""); sb.append(" timeZoneOffset=\"").append(offsetHours).append("\""); //sb.append(" useElevationAllZmanim=\"").append(astronomicalCalendar.useElevationAllZmanim()).append("\""); //TODO likely using reflection sb.append(">\n"); @@ -380,7 +380,7 @@ public static String toXML(AstronomicalCalendar astronomicalCalendar) { } else if (value instanceof Duration) {// shaah zmanis durationList.add(new Zman((Duration)value, tagName)); } else { // will probably never enter this block, but is present to be future-proof - otherList.add("<" + tagName + ">" + value + ""); + otherList.add("<" + tagName + ">" + escapeXml(String.valueOf(value)) + ""); } } catch (Exception e) { e.printStackTrace(); @@ -469,13 +469,13 @@ public static String toJSON(AstronomicalCalendar astronomicalCalendar) { StringBuilder sb = new StringBuilder("{\n\"metadata\":{\n"); sb.append("\t\"date\":\"").append(df.format(localDate)).append("\",\n"); sb.append("\t\"type\":\"").append(astronomicalCalendar.getClass().getName()).append("\",\n"); - sb.append("\t\"algorithm\":\"").append(astronomicalCalendar.getAstronomicalCalculator().getCalculatorName()).append("\",\n"); - sb.append("\t\"location\":\"").append(geoLocation.getLocationName()).append("\",\n"); + sb.append("\t\"algorithm\":\"").append(escapeJson(astronomicalCalendar.getAstronomicalCalculator().getCalculatorName())).append("\",\n"); + sb.append("\t\"location\":\"").append(escapeJson(geoLocation.getLocationName())).append("\",\n"); sb.append("\t\"latitude\":\"").append(geoLocation.getLatitude()).append("\",\n"); sb.append("\t\"longitude\":\"").append(geoLocation.getLongitude()).append("\",\n"); sb.append("\t\"elevation\":\"").append(geoLocation.getElevation()).append("\",\n"); - sb.append("\t\"timeZoneName\":\"").append(timeZoneName).append("\",\n"); - sb.append("\t\"timeZoneID\":\"").append(geoLocation.getZoneId().getId()).append("\",\n"); + sb.append("\t\"timeZoneName\":\"").append(escapeJson(timeZoneName)).append("\",\n"); + sb.append("\t\"timeZoneID\":\"").append(escapeJson(geoLocation.getZoneId().getId())).append("\",\n"); sb.append("\t\"timeZoneOffset\":\"").append(offsetHours).append("\""); sb.append("},\n\""); @@ -510,7 +510,7 @@ public static String toJSON(AstronomicalCalendar astronomicalCalendar) { } else if (value instanceof Duration) {// shaah zmanis durationList.add(new Zman((Duration)value, tagName)); } else { // will probably never enter this block, but is present to be future-proof - otherList.add("\"" + tagName + "\":\"" + value + "\","); + otherList.add("\"" + tagName + "\":\"" + escapeJson(String.valueOf(value)) + "\","); } } catch (Exception e) { e.printStackTrace(); @@ -546,6 +546,63 @@ public static String toJSON(AstronomicalCalendar astronomicalCalendar) { * @param method the method in question * @return if the method should be included in serialization */ + /** + * Escapes text for use in XML element content or a double quoted attribute value: {@code &}, {@code <}, {@code >}, + * {@code "} and {@code '} are replaced by their predefined entities. + * @param text the text to escape. A {@code null} is written as "{@code null}", as before. + * @return the escaped text + */ + static String escapeXml(String text) { + if (text == null) { + return "null"; + } + StringBuilder sb = new StringBuilder(text.length()); + for (int i = 0; i < text.length(); i++) { + char c = text.charAt(i); + switch (c) { + case '&': sb.append("&"); break; + case '<': sb.append("<"); break; + case '>': sb.append(">"); break; + case '"': sb.append("""); break; + case '\'': sb.append("'"); break; + default: sb.append(c); + } + } + return sb.toString(); + } + + /** + * Escapes text for use inside a JSON string: {@code "} and {@code \} are backslash escaped and control characters are + * written as escape sequences, as RFC 8259 requires. + * @param text the text to escape. A {@code null} is written as "{@code null}", as before. + * @return the escaped text + */ + static String escapeJson(String text) { + if (text == null) { + return "null"; + } + StringBuilder sb = new StringBuilder(text.length()); + for (int i = 0; i < text.length(); i++) { + char c = text.charAt(i); + switch (c) { + case '"': sb.append("\\\""); break; + case '\\': sb.append("\\\\"); break; + case '\n': sb.append("\\n"); break; + case '\r': sb.append("\\r"); break; + case '\t': sb.append("\\t"); break; + case '\b': sb.append("\\b"); break; + case '\f': sb.append("\\f"); break; + default: + if (c < 0x20) { + sb.append(String.format("\\u%04x", (int) c)); + } else { + sb.append(c); + } + } + } + return sb.toString(); + } + private static boolean includeMethod(Method method) { if (method.getParameterTypes().length > 0) return false; // Skip get methods with parameters since we do not know what value to pass diff --git a/src/test/java/com/kosherjava/zmanim/util/SerializationRegressionTest.java b/src/test/java/com/kosherjava/zmanim/util/SerializationRegressionTest.java index fa59be2c..01ce72b0 100644 --- a/src/test/java/com/kosherjava/zmanim/util/SerializationRegressionTest.java +++ b/src/test/java/com/kosherjava/zmanim/util/SerializationRegressionTest.java @@ -48,4 +48,33 @@ public void astronomicalCalendarPreservesSubSecondPrecision() { assertFalse(actualEpochMillis % 1000 == 0); assertTrue(Math.abs(expectedEpochMillis - actualEpochMillis) < 1000); } + + /** A location name with XML / JSON special characters, e.g. a name with an ampersand or a quote. */ + private static final String SPECIAL_NAME = "Ta\"l & \\ x"; + + private static void assertWellFormedXml(String xml) throws Exception { + javax.xml.parsers.DocumentBuilderFactory.newInstance().newDocumentBuilder() + .parse(new java.io.ByteArrayInputStream(xml.getBytes(java.nio.charset.StandardCharsets.UTF_8))); + } + + @Test + public void toXmlEscapesSpecialCharacters() throws Exception { + GeoLocation geoLocation = new GeoLocation(SPECIAL_NAME, 40.0828, -74.2094, ZoneId.of("America/New_York")); + com.kosherjava.zmanim.ComprehensiveZmanimCalendar calendar = new com.kosherjava.zmanim.ComprehensiveZmanimCalendar(geoLocation); + String xml = ZmanimFormatter.toXML(calendar); + assertWellFormedXml(xml); + assertTrue(xml.contains("location=\"Ta"l & <Ma'alot> \\ x\"")); + + assertWellFormedXml(geoLocation.toXML()); + Zman zman = new Zman(Instant.parse("2026-03-23T10:56:01.123Z"), geoLocation, "Alos & "); + zman.setDescription("16.1\u00b0 \"degrees\""); + assertWellFormedXml(zman.toXML()); + } + + @Test + public void toJsonEscapesSpecialCharacters() { + GeoLocation geoLocation = new GeoLocation(SPECIAL_NAME + "\n", 40.0828, -74.2094, ZoneId.of("America/New_York")); + String json = ZmanimFormatter.toJSON(new com.kosherjava.zmanim.ComprehensiveZmanimCalendar(geoLocation)); + assertTrue(json.contains("\"location\":\"Ta\\\"l & \\\\ x\\n\",")); + } }