Fix EXPLAIN so that it doesn't emit invalid XML in corner cases.
authorTom Lane
Thu, 20 Oct 2016 21:17:50 +0000 (17:17 -0400)
committerTom Lane
Thu, 20 Oct 2016 21:18:05 +0000 (17:18 -0400)
commitadb199711a8cc5f1f283b2bc7e4f76ed4b6def72
tree9fb0313bb6ed80500f4e0908d83650b5d8455413
parenta8518738ae8c92813da13a13a2c79ab13c79263f
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>
src/backend/commands/explain.c