Skip to content

Commit

Permalink
markup/goldmark: Fail on invalid Markdown attributes
Browse files Browse the repository at this point in the history
  • Loading branch information
bep committed Mar 15, 2023
1 parent 0fbab7c commit b0b1b76
Show file tree
Hide file tree
Showing 5 changed files with 89 additions and 10 deletions.
10 changes: 10 additions & 0 deletions common/herrors/error_locator.go
Expand Up @@ -61,6 +61,16 @@ var OffsetMatcher = func(m LineMatcher) int {
return -1
}

// ContainsMatcher is a line matcher that matches by line content.
func ContainsMatcher(text string) func(m LineMatcher) int {
return func(m LineMatcher) int {
if idx := strings.Index(m.Line, text); idx != -1 {
return idx + 1
}
return -1
}
}

// ErrorContext contains contextual information about an error. This will
// typically be the lines surrounding some problem in a file.
type ErrorContext struct {
Expand Down
14 changes: 14 additions & 0 deletions common/herrors/file_error.go
Expand Up @@ -392,3 +392,17 @@ func extractPosition(e error) (pos text.Position) {
}
return
}

// TextSegmentError is an error with a text segment attached.
type TextSegmentError struct {
Segment string
Err error
}

func (e TextSegmentError) Unwrap() error {
return e.Err
}

func (e TextSegmentError) Error() string {
return e.Err.Error()
}
8 changes: 7 additions & 1 deletion hugolib/page.go
Expand Up @@ -617,7 +617,13 @@ func (p *pageState) wrapError(err error) error {
}
}

return herrors.NewFileErrorFromFile(err, filename, p.s.SourceSpec.Fs.Source, herrors.NopLineMatcher)
lineMatcher := herrors.NopLineMatcher

if textSegmentErr, ok := err.(*herrors.TextSegmentError); ok {
lineMatcher = herrors.ContainsMatcher(textSegmentErr.Segment)
}

return herrors.NewFileErrorFromFile(err, filename, p.s.SourceSpec.Fs.Source, lineMatcher)

}

Expand Down
39 changes: 39 additions & 0 deletions markup/goldmark/codeblocks/integration_test.go
Expand Up @@ -18,6 +18,8 @@ import (
"strings"
"testing"

qt "github.com/frankban/quicktest"

"github.com/gohugoio/hugo/hugolib"
)

Expand Down Expand Up @@ -384,3 +386,40 @@ Common
}

}

// Issue 10835
func TestAttributesValidation(t *testing.T) {
t.Parallel()

files := `
-- hugo.toml --
disableKinds = ["taxonomy", "term"]
-- content/p1.md --
---
title: "p1"
---
## Issue 10835
§§§bash { color=red dimensions=300x200 }
Hello, World!
§§§
-- layouts/index.html --
-- layouts/_default/single.html --
{{ .Content }}
-- layouts/_default/_markup/render-codeblock.html --
Attributes: {{ .Attributes }}|Type: {{ .Type }}|
`

b, err := hugolib.NewIntegrationTestBuilder(
hugolib.IntegrationTestConfig{
T: t,
TxtarString: files,
},
).BuildE()

b.Assert(err, qt.Not(qt.IsNil))
b.Assert(err.Error(), qt.Contains, "p1.md:7:9\": failed to parse Markdown attributes; you may need to quote the values")

}
28 changes: 19 additions & 9 deletions markup/goldmark/codeblocks/render.go
Expand Up @@ -15,6 +15,7 @@ package codeblocks

import (
"bytes"
"errors"
"fmt"
"strings"
"sync"
Expand Down Expand Up @@ -101,7 +102,10 @@ func (r *htmlRenderer) renderCodeBlock(w util.BufWriter, src []byte, node ast.No
}

// IsDefaultCodeBlockRendererProvider
attrs := getAttributes(n.b, info)
attrs, attrStr, err := getAttributes(n.b, info)
if err != nil {
return ast.WalkStop, &herrors.TextSegmentError{Err: err, Segment: attrStr}
}
cbctx := &codeBlockContext{
page: ctx.DocumentContext().Document,
lang: lang,
Expand All @@ -123,7 +127,7 @@ func (r *htmlRenderer) renderCodeBlock(w util.BufWriter, src []byte, node ast.No

cr := renderer.(hooks.CodeBlockRenderer)

err := cr.RenderCodeblock(
err = cr.RenderCodeblock(
ctx.RenderContext().Ctx,
w,
cbctx,
Expand Down Expand Up @@ -182,30 +186,36 @@ func getLang(node *ast.FencedCodeBlock, src []byte) string {
return lang
}

func getAttributes(node *ast.FencedCodeBlock, infostr []byte) []ast.Attribute {
func getAttributes(node *ast.FencedCodeBlock, infostr []byte) ([]ast.Attribute, string, error) {
if node.Attributes() != nil {
return node.Attributes()
return node.Attributes(), "", nil
}
if infostr != nil {
attrStartIdx := -1
attrEndIdx := -1

for idx, char := range infostr {
if char == '{' {
if attrEndIdx == -1 && char == '{' {
attrStartIdx = idx
}
if attrStartIdx != -1 && char == '}' {
attrEndIdx = idx
break
}
}

if attrStartIdx != -1 {
if attrStartIdx != -1 && attrEndIdx != -1 {
n := ast.NewTextBlock() // dummy node for storing attributes
attrStr := infostr[attrStartIdx:]
attrStr := infostr[attrStartIdx : attrEndIdx+1]
if attrs, hasAttr := parser.ParseAttributes(text.NewReader(attrStr)); hasAttr {
for _, attr := range attrs {
n.SetAttribute(attr.Name, attr.Value)
}
return n.Attributes()
return n.Attributes(), "", nil
} else {
return nil, string(attrStr), errors.New("failed to parse Markdown attributes; you may need to quote the values")
}
}
}
return nil
return nil, "", nil
}

0 comments on commit b0b1b76

Please sign in to comment.