Best practice suggests escaping greater than and less than characters in attribute data

Author: stephen-webb

src/main/cpp/htmllayout.cpp

@@ -127,7 +127,7 @@ void HTMLLayout::format(LogString& output,
 	output.append(LOG4CXX_EOL);
 
 	output.append(LOG4CXX_STR("<td title=\""));
-	Transform::appendEscapingQuote(output, event->getLoggerName());
+	Transform::appendEscapingTags(output, event->getLoggerName());
 	output.append(LOG4CXX_STR(" logger\">"));
 	Transform::appendEscapingTags(output, event->getLoggerName());
 	output.append(LOG4CXX_STR("</td>"));

src/main/cpp/transform.cpp

@@ -129,28 +129,3 @@ void Transform::appendEscapingCDATA(
 
 	buf.append(input, start, input.length() - start);
 }
-
-void Transform::appendEscapingQuote(
-	LogString& buf, const LogString& input)
-{
-	if (input.empty())
-		return;
-	logchar quote { 0x22 /* " */ };
-	size_t start = 0;
-	size_t index = input.find(quote, start);
-
-	while (index != input.npos)
-	{
-		if (start < index)
-			buf.append(input, start, index - start);
-		buf.append(LOG4CXX_STR("&quot;"));
-        start = index + 1;
-		if (start < input.size())
-			index = input.find(quote, start);
-		else
-			index = input.npos;
-	}
-
-	if (start < input.size())
-		buf.append(input, start, input.size() - start);
-}

src/main/cpp/xmllayout.cpp

@@ -80,13 +80,13 @@ void XMLLayout::format(LogString& output,
 {
 	output.reserve(m_priv->expectedPatternLength + event->getMessage().size());
 	output.append(LOG4CXX_STR("<log4j:event logger=\""));
-	Transform::appendEscapingQuote(output, event->getLoggerName());
+	Transform::appendEscapingTags(output, event->getLoggerName());
 	output.append(LOG4CXX_STR("\" timestamp=\""));
 	StringHelper::toString(event->getTimeStamp() / 1000L, p, output);
 	output.append(LOG4CXX_STR("\" level=\""));
-	Transform::appendEscapingQuote(output, event->getLevel()->toString());
+	Transform::appendEscapingTags(output, event->getLevel()->toString());
 	output.append(LOG4CXX_STR("\" thread=\""));
-	Transform::appendEscapingQuote(output, event->getThreadName());
+	Transform::appendEscapingTags(output, event->getThreadName());
 	output.append(LOG4CXX_STR("\">"));
 	output.append(LOG4CXX_EOL);
 
@@ -112,13 +112,13 @@ void XMLLayout::format(LogString& output,
 		output.append(LOG4CXX_STR("<log4j:locationInfo class=\""));
 		const LocationInfo& locInfo = event->getLocationInformation();
 		LOG4CXX_DECODE_CHAR(className, locInfo.getClassName());
-		Transform::appendEscapingQuote(output, className);
+		Transform::appendEscapingTags(output, className);
 		output.append(LOG4CXX_STR("\" method=\""));
 		LOG4CXX_DECODE_CHAR(method, locInfo.getMethodName());
-		Transform::appendEscapingQuote(output, method);
+		Transform::appendEscapingTags(output, method);
 		output.append(LOG4CXX_STR("\" file=\""));
 		LOG4CXX_DECODE_CHAR(fileName, locInfo.getFileName());
-		Transform::appendEscapingQuote(output, fileName);
+		Transform::appendEscapingTags(output, fileName);
 		output.append(LOG4CXX_STR("\" line=\""));
 		StringHelper::toString(locInfo.getLineNumber(), p, output);
 		output.append(LOG4CXX_STR("\"/>"));
@@ -142,9 +142,9 @@ void XMLLayout::format(LogString& output,
 				if (event->getMDC(key, value))
 				{
 					output.append(LOG4CXX_STR("<log4j:data name=\""));
-					Transform::appendEscapingQuote(output, key);
+					Transform::appendEscapingTags(output, key);
 					output.append(LOG4CXX_STR("\" value=\""));
-					Transform::appendEscapingQuote(output, value);
+					Transform::appendEscapingTags(output, value);
 					output.append(LOG4CXX_STR("\"/>"));
 					output.append(LOG4CXX_EOL);
 				}
@@ -157,9 +157,9 @@ void XMLLayout::format(LogString& output,
 				if (event->getProperty(key, value))
 				{
 					output.append(LOG4CXX_STR("<log4j:data name=\""));
-					Transform::appendEscapingQuote(output, key);
+					Transform::appendEscapingTags(output, key);
 					output.append(LOG4CXX_STR("\" value=\""));
-					Transform::appendEscapingQuote(output, value);
+					Transform::appendEscapingTags(output, value);
 					output.append(LOG4CXX_STR("\"/>"));
 					output.append(LOG4CXX_EOL);
 				}

src/main/include/log4cxx/helpers/transform.h

@@ -54,13 +54,6 @@ class LOG4CXX_EXPORT Transform
 		*/
 		static void appendEscapingCDATA(
 			LogString& buf, const LogString& input);
-
-		/**
-		* Add \c input to \c buf with double quote characters replaced with <b>&amp;quot;</b>.
-		*
-		* @param buf output stream holding the XML data to this point.
-		*/
-		static void appendEscapingQuote(LogString& buf, const LogString& input);
 }; // class Transform
 }  // namespace helpers
 } //namespace log4cxx