Skip to content

Fix #160: Add proper text escaping in FormatHtml #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix #160: Add proper text escaping in FormatHtml #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions cmd/root_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"strings"
"testing"

"github.com/antchfx/xmlquery"
"github.com/sibprogrammer/xq/internal/utils"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
Expand Down Expand Up @@ -102,6 +103,57 @@ func TestRootCmd(t *testing.T) {
assert.ErrorContains(t, err, "invalid argument")
}

func TestEscapedTextNodes(t *testing.T) {
// Test case 1: ampersand entity - reproduce issue #160
// xq outputs bare & which fails when parsed as XML (used by -j flag)
t.Run("ampersand entity output is valid XML", func(t *testing.T) {
input := "<html>1 &amp; 2</html>"

// First pass: format the HTML
reader1 := strings.NewReader(input)
var output1 bytes.Buffer
err := utils.FormatHtml(reader1, &output1, "", utils.ColorsDisabled)
assert.Nil(t, err)

result1 := strings.TrimSpace(output1.String())
t.Logf("First pass output: %q", result1)

// Second pass: try to parse as XML (this is what `xq -j` does)
reader2 := strings.NewReader(result1)
_, err = xmlquery.Parse(reader2)
assert.Nil(t, err, "xq output should be parseable as XML (for -j flag)")
})

// Test case 2: less-than and greater-than entities - reproduce issue #160
// xq outputs bare < and > which are parsed as tags
t.Run("less-than and greater-than entities output is valid XML", func(t *testing.T) {
input := "<html>is &lt;bold&gt; a valid tag?</html>"

// First pass: format the HTML
reader1 := strings.NewReader(input)
var output1 bytes.Buffer
err := utils.FormatHtml(reader1, &output1, "", utils.ColorsDisabled)
assert.Nil(t, err)

result1 := strings.TrimSpace(output1.String())
t.Logf("First pass output: %q", result1)

// Second pass: try to parse as XML (this is what `xq -j` does)
reader2 := strings.NewReader(result1)
doc, err := xmlquery.Parse(reader2)
assert.Nil(t, err, "xq output should be parseable as XML (for -j flag)")

// Verify the text content is preserved correctly
if doc != nil {
textNode := xmlquery.FindOne(doc, "//html")
if textNode != nil {
assert.Equal(t, "is <bold> a valid tag?", textNode.InnerText(),
"Text content should preserve the literal < and > characters")
}
}
})
}

func TestProcessAsJSON(t *testing.T) {
tests := []struct {
name string
Expand Down
12 changes: 12 additions & 0 deletions internal/utils/utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,9 @@ func FormatHtml(reader io.Reader, writer io.Writer, indent string, colors int) e
case html.TextToken:
str := normalizeSpaces(string(tokenizer.Text()), indent, level)
hasContent = str != ""
if hasContent {
str = escapeTextContent(str)
}
_, _ = fmt.Fprint(writer, str)
case html.StartTagToken, html.SelfClosingTagToken:
if level > 0 {
Expand Down Expand Up @@ -585,6 +588,15 @@ func escapeText(input string) (string, error) {
return result, nil
}

func escapeTextContent(input string) string {
// Only escape the minimal set of characters needed for text content
// to avoid XML parsing errors: & < >
result := strings.ReplaceAll(input, "&", "&amp;")
result = strings.ReplaceAll(result, "<", "&lt;")
result = strings.ReplaceAll(result, ">", "&gt;")
return result
}

func normalizeSpaces(input string, indent string, level int) string {
if strings.TrimSpace(input) == "" {
input = ""
Expand Down