Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 0336665

Browse files
committed
Fix EXPLAIN so that it doesn't emit invalid XML in corner cases.
With track_io_timing = on, EXPLAIN (ANALYZE, BUFFERS) will emit fields named like "I/O Read Time". The slash makes that invalid as an XML element name, so that adding FORMAT XML would produce invalid XML. We already have code in there to translate spaces to dashes, so let's generalize that to convert anything that isn't a valid XML name character, viz letters, digits, hyphens, underscores, and periods. We could just reject slashes, which would run a bit faster. But the fact that this went unnoticed for so long doesn't give me a warm feeling that we'd notice the next creative violation, so let's make it a permanent fix. Reported by Markus Winand, though this isn't his initial patch proposal. Back-patch to 9.2 where track_io_timing was added. The problem is only latent in 9.1, so I don't feel a need to fix it there. Discussion: <E0BF6A45-68E8-45E6-918F-741FB332C6BB@winand.at>
1 parent 845a8ea commit 0336665

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/backend/commands/explain.c

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3310,21 +3310,23 @@ ExplainSeparatePlans(ExplainState *es)
33103310
* Optionally, OR in X_NOWHITESPACE to suppress the whitespace we'd normally
33113311
* add.
33123312
*
3313-
* XML tag names can't contain white space, so we replace any spaces in
3314-
* "tagname" with dashes.
3313+
* XML restricts tag names more than our other output formats, eg they can't
3314+
* contain white space or slashes. Replace invalid characters with dashes,
3315+
* so that for example "I/O Read Time" becomes "I-O-Read-Time".
33153316
*/
33163317
static void
33173318
ExplainXMLTag(const char *tagname, int flags, ExplainState *es)
33183319
{
33193320
const char *s;
3321+
const char *valid = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_.";
33203322

33213323
if ((flags & X_NOWHITESPACE) == 0)
33223324
appendStringInfoSpaces(es->str, 2 * es->indent);
33233325
appendStringInfoCharMacro(es->str, '<');
33243326
if ((flags & X_CLOSING) != 0)
33253327
appendStringInfoCharMacro(es->str, '/');
33263328
for (s = tagname; *s; s++)
3327-
appendStringInfoCharMacro(es->str, (*s == ' ') ? '-' : *s);
3329+
appendStringInfoChar(es->str, strchr(valid, *s) ? *s : '-');
33283330
if ((flags & X_CLOSE_IMMEDIATE) != 0)
33293331
appendStringInfoString(es->str, " /");
33303332
appendStringInfoCharMacro(es->str, '>');

0 commit comments

Comments
 (0)