This is an automated email from the ASF dual-hosted git repository.
markt-asf pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/main by this push:
new a2d13ec502 Add support for '%%' to represent a literal '%' in the
access log
a2d13ec502 is described below
commit a2d13ec502dd8592ab5059ed20024245c59c1ce5
Author: Mark Thomas <[email protected]>
AuthorDate: Wed May 6 10:23:13 2026 +0100
Add support for '%%' to represent a literal '%' in the access log
Also fix various bugs with literal handling found in JSONAccessLogValve
while writing tests for literal '%' support.
Based on #1002 by Fabian Hahn.
---
.../catalina/valves/AbstractAccessLogValve.java | 1 +
.../apache/catalina/valves/JsonAccessLogValve.java | 29 ++++++++++++++++------
.../apache/catalina/valves/TestAccessLogValve.java | 4 +++
webapps/docs/changelog.xml | 4 +++
webapps/docs/config/valve.xml | 1 +
5 files changed, 32 insertions(+), 7 deletions(-)
diff --git a/java/org/apache/catalina/valves/AbstractAccessLogValve.java
b/java/org/apache/catalina/valves/AbstractAccessLogValve.java
index c7333c2aeb..46db6981cb 100644
--- a/java/org/apache/catalina/valves/AbstractAccessLogValve.java
+++ b/java/org/apache/catalina/valves/AbstractAccessLogValve.java
@@ -2138,6 +2138,7 @@ public abstract class AbstractAccessLogValve extends
ValveBase implements Access
*/
protected AccessLogElement createAccessLogElement(char pattern) {
return switch (pattern) {
+ case '%' -> new StringElement("%");
case 'a' -> new RemoteAddrElement();
case 'A' -> new LocalAddrElement(ipv6Canonical);
case 'b' -> new ByteSentElement(true);
diff --git a/java/org/apache/catalina/valves/JsonAccessLogValve.java
b/java/org/apache/catalina/valves/JsonAccessLogValve.java
index 9932d81a60..1750b005c1 100644
--- a/java/org/apache/catalina/valves/JsonAccessLogValve.java
+++ b/java/org/apache/catalina/valves/JsonAccessLogValve.java
@@ -151,6 +151,7 @@ public class JsonAccessLogValve extends AccessLogValve {
for (Character pattern : SUB_OBJECT_PATTERNS.keySet()) {
subTypeLists.put(pattern, new ArrayList<>());
}
+ boolean hasSimple = false;
boolean hasSub = false;
List<AccessLogElement> logElements = new
ArrayList<>(Arrays.asList(super.createLogElements()));
ListIterator<AccessLogElement> lit = logElements.listIterator();
@@ -162,9 +163,9 @@ public class JsonAccessLogValve extends AccessLogValve {
lit.remove();
continue;
}
+ AccessLogElement ale = wrappedLogElement.getDelegate();
// Remove items which should be written as
// Json objects and add them later in correct order
- AccessLogElement ale = wrappedLogElement.getDelegate();
if (ale instanceof HeaderElement) {
subTypeLists.get(Character.valueOf('i')).add(wrappedLogElement);
lit.remove();
@@ -185,6 +186,7 @@ public class JsonAccessLogValve extends AccessLogValve {
lit.remove();
} else {
// Keep the simple items and add separator
+ hasSimple = true;
lit.add(new CharElement(','));
}
}
@@ -194,11 +196,14 @@ public class JsonAccessLogValve extends AccessLogValve {
hasSub = true;
}
}
- // remove last comma (or possibly "},")
- lit.previous();
- lit.remove();
- // Last item was a sub object, close it
+ if (hasSimple || hasSub) {
+ // remove last comma (or possibly "},")
+ lit.previous();
+ lit.remove();
+ }
+ // Add closing }
if (hasSub) {
+ // Last item was a sub object, close it as well
lit.add(new StringElement("}}"));
} else {
lit.add(new CharElement('}'));
@@ -209,13 +214,23 @@ public class JsonAccessLogValve extends AccessLogValve {
@Override
protected AccessLogElement createAccessLogElement(String name, char
pattern) {
AccessLogElement ale = super.createAccessLogElement(name, pattern);
- return new JsonWrappedElement(pattern, name, true, ale);
+ if ('%' == pattern) {
+ // Uses a pattern but is literal text so no need to wrap.
+ return ale;
+ } else {
+ return new JsonWrappedElement(pattern, name, true, ale);
+ }
}
@Override
protected AccessLogElement createAccessLogElement(char pattern) {
AccessLogElement ale = super.createAccessLogElement(pattern);
- return new JsonWrappedElement(pattern, true, ale);
+ if ('%' == pattern) {
+ // Uses a pattern but is literal text so no need to wrap.
+ return ale;
+ } else {
+ return new JsonWrappedElement(pattern, true, ale);
+ }
}
private static class JsonWrappedElement implements AccessLogElement,
CachedElement {
diff --git a/test/org/apache/catalina/valves/TestAccessLogValve.java
b/test/org/apache/catalina/valves/TestAccessLogValve.java
index f29b892721..2bfae1ae80 100644
--- a/test/org/apache/catalina/valves/TestAccessLogValve.java
+++ b/test/org/apache/catalina/valves/TestAccessLogValve.java
@@ -90,6 +90,10 @@ public class TestAccessLogValve extends TomcatBaseTest {
public static Collection<Object[]> parameters() {
List<Object[]> parameterSets = new ArrayList<>();
+ parameterSets.add(new Object[] {"literal", TEXT_TYPE, "/", "abc",
"abc"});
+ parameterSets.add(new Object[] {"literal", JSON_TYPE, "/", "abc",
"\\{\\}"});
+ parameterSets.add(new Object[] {"pct-pct", TEXT_TYPE, "/", "%%", "%"});
+ parameterSets.add(new Object[] {"pct-pct", JSON_TYPE, "/", "%%",
"\\{\\}"});
parameterSets.add(new Object[] {"pct-a", TEXT_TYPE, "/", "%a",
LOCAL_IP_PATTERN});
parameterSets.add(new Object[] {"pct-a", JSON_TYPE, "/", "%a",
"\\{\"remoteAddr\":\"" + LOCAL_IP_PATTERN + "\"\\}"});
parameterSets.add(new Object[] {"pct-A", TEXT_TYPE, "/", "%A",
IP_PATTERN});
diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
index 43c34585d3..1f2e70b960 100644
--- a/webapps/docs/changelog.xml
+++ b/webapps/docs/changelog.xml
@@ -199,6 +199,10 @@
third-party library version information. (csutherl)
</add>
<!-- Entries for backport and removal before 12.0.0-M1 below this line
-->
+ <add>
+ Add support for literal <code>'%'</code> characters in access log
+ output. Based on pull request <pr>1002</pr> by Fabian Hahn. (markt)
+ </add>
</changelog>
</subsection>
<subsection name="Coyote">
diff --git a/webapps/docs/config/valve.xml b/webapps/docs/config/valve.xml
index b66e660830..dfee1d1d8b 100644
--- a/webapps/docs/config/valve.xml
+++ b/webapps/docs/config/valve.xml
@@ -282,6 +282,7 @@
the current request and response. The following pattern codes are
supported:</p>
<ul>
+ <li><b><code>%%</code></b> - Literal '%' character</li>
<li><b><code>%a</code></b> - Remote IP address.
See also <code>%{xxx}a</code> below.</li>
<li><b><code>%A</code></b> - Local IP address</li>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
