mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-29 17:12:07 -05:00
4e14cf7607
This commit prevents the most commons case of infinite recursion in link render hooks when the `linkify` option is enabled (see below). This is always a user error, but getting a `stack overflow` (the current stack limit in Go is 1 GB on 64-bit, 250 MB on 32-bit) error isn't very helpful. This fix will not prevent all such errors, though, but we may do better once #9570 is in place. So, these will fail: ``` <a href="{{ .Destination | safeURL }}" >{{ .Text | markdownify }}</a> <a href="{{ .Destination | safeURL }}" >{{ .Text | .Page.RenderString }}</a> ``` `.Text` is already rendered to `HTML`. The above needs to be rewritten to: ``` <a href="{{ .Destination | safeURL }}" >{{ .Text | safeHTML }}</a> <a href="{{ .Destination | safeURL }}" >{{ .Text | safeHTML }}</a> ``` Fixes #8959
537 lines
11 KiB
Go
537 lines
11 KiB
Go
// Copyright 2021 The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package goldmark_test
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
"testing"
|
|
|
|
qt "github.com/frankban/quicktest"
|
|
|
|
"github.com/gohugoio/hugo/hugolib"
|
|
)
|
|
|
|
// Issue 9463
|
|
func TestAttributeExclusion(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
files := `
|
|
-- config.toml --
|
|
[markup.goldmark.renderer]
|
|
unsafe = false
|
|
[markup.goldmark.parser.attribute]
|
|
block = true
|
|
title = true
|
|
-- content/p1.md --
|
|
---
|
|
title: "p1"
|
|
---
|
|
## Heading {class="a" onclick="alert('heading')"}
|
|
|
|
> Blockquote
|
|
{class="b" ondblclick="alert('blockquote')"}
|
|
|
|
~~~bash {id="c" onmouseover="alert('code fence')" LINENOS=true}
|
|
foo
|
|
~~~
|
|
-- layouts/_default/single.html --
|
|
{{ .Content }}
|
|
`
|
|
|
|
b := hugolib.NewIntegrationTestBuilder(
|
|
hugolib.IntegrationTestConfig{
|
|
T: t,
|
|
TxtarString: files,
|
|
NeedsOsFS: false,
|
|
},
|
|
).Build()
|
|
|
|
b.AssertFileContent("public/p1/index.html", `
|
|
<h2 class="a" id="heading">
|
|
<blockquote class="b">
|
|
<div class="highlight" id="c">
|
|
`)
|
|
}
|
|
|
|
// Issue 9511
|
|
func TestAttributeExclusionWithRenderHook(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
files := `
|
|
-- content/p1.md --
|
|
---
|
|
title: "p1"
|
|
---
|
|
## Heading {onclick="alert('renderhook')" data-foo="bar"}
|
|
-- layouts/_default/single.html --
|
|
{{ .Content }}
|
|
-- layouts/_default/_markup/render-heading.html --
|
|
<h{{ .Level }}
|
|
{{- range $k, $v := .Attributes -}}
|
|
{{- printf " %s=%q" $k $v | safeHTMLAttr -}}
|
|
{{- end -}}
|
|
>{{ .Text | safeHTML }}</h{{ .Level }}>
|
|
`
|
|
|
|
b := hugolib.NewIntegrationTestBuilder(
|
|
hugolib.IntegrationTestConfig{
|
|
T: t,
|
|
TxtarString: files,
|
|
NeedsOsFS: false,
|
|
},
|
|
).Build()
|
|
|
|
b.AssertFileContent("public/p1/index.html", `
|
|
<h2 data-foo="bar" id="heading">Heading</h2>
|
|
`)
|
|
}
|
|
|
|
func TestAttributesDefaultRenderer(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
files := `
|
|
-- content/p1.md --
|
|
---
|
|
title: "p1"
|
|
---
|
|
## Heading Attribute Which Needs Escaping { class="a < b" }
|
|
-- layouts/_default/single.html --
|
|
{{ .Content }}
|
|
`
|
|
|
|
b := hugolib.NewIntegrationTestBuilder(
|
|
hugolib.IntegrationTestConfig{
|
|
T: t,
|
|
TxtarString: files,
|
|
NeedsOsFS: false,
|
|
},
|
|
).Build()
|
|
|
|
b.AssertFileContent("public/p1/index.html", `
|
|
class="a < b"
|
|
`)
|
|
}
|
|
|
|
// Issue 9558.
|
|
func TestAttributesHookNoEscape(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
files := `
|
|
-- content/p1.md --
|
|
---
|
|
title: "p1"
|
|
---
|
|
## Heading Attribute Which Needs Escaping { class="Smith & Wesson" }
|
|
-- layouts/_default/_markup/render-heading.html --
|
|
plain: |{{- range $k, $v := .Attributes -}}{{ $k }}: {{ $v }}|{{ end }}|
|
|
safeHTML: |{{- range $k, $v := .Attributes -}}{{ $k }}: {{ $v | safeHTML }}|{{ end }}|
|
|
-- layouts/_default/single.html --
|
|
{{ .Content }}
|
|
`
|
|
|
|
b := hugolib.NewIntegrationTestBuilder(
|
|
hugolib.IntegrationTestConfig{
|
|
T: t,
|
|
TxtarString: files,
|
|
NeedsOsFS: false,
|
|
},
|
|
).Build()
|
|
|
|
b.AssertFileContent("public/p1/index.html", `
|
|
plain: |class: Smith & Wesson|id: heading-attribute-which-needs-escaping|
|
|
safeHTML: |class: Smith & Wesson|id: heading-attribute-which-needs-escaping|
|
|
`)
|
|
}
|
|
|
|
// Issue 9504
|
|
func TestLinkInTitle(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
files := `
|
|
-- config.toml --
|
|
-- content/p1.md --
|
|
---
|
|
title: "p1"
|
|
---
|
|
## Hello [Test](https://example.com)
|
|
-- layouts/_default/single.html --
|
|
{{ .Content }}
|
|
-- layouts/_default/_markup/render-heading.html --
|
|
<h{{ .Level }} id="{{ .Anchor | safeURL }}">
|
|
{{ .Text | safeHTML }}
|
|
<a class="anchor" href="#{{ .Anchor | safeURL }}">#</a>
|
|
</h{{ .Level }}>
|
|
-- layouts/_default/_markup/render-link.html --
|
|
<a href="{{ .Destination | safeURL }}"{{ with .Title}} title="{{ . }}"{{ end }}>{{ .Text | safeHTML }}</a>
|
|
|
|
`
|
|
|
|
b := hugolib.NewIntegrationTestBuilder(
|
|
hugolib.IntegrationTestConfig{
|
|
T: t,
|
|
TxtarString: files,
|
|
NeedsOsFS: false,
|
|
},
|
|
).Build()
|
|
|
|
b.AssertFileContent("public/p1/index.html",
|
|
"<h2 id=\"hello-testhttpsexamplecom\">\n Hello <a href=\"https://example.com\">Test</a>\n\n <a class=\"anchor\" href=\"#hello-testhttpsexamplecom\">#</a>\n</h2>",
|
|
)
|
|
}
|
|
|
|
func TestHighlight(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
files := `
|
|
-- config.toml --
|
|
[markup]
|
|
[markup.highlight]
|
|
anchorLineNos = false
|
|
codeFences = true
|
|
guessSyntax = false
|
|
hl_Lines = ''
|
|
lineAnchors = ''
|
|
lineNoStart = 1
|
|
lineNos = false
|
|
lineNumbersInTable = true
|
|
noClasses = false
|
|
style = 'monokai'
|
|
tabWidth = 4
|
|
-- layouts/_default/single.html --
|
|
{{ .Content }}
|
|
-- content/p1.md --
|
|
---
|
|
title: "p1"
|
|
---
|
|
|
|
## Code Fences
|
|
|
|
§§§bash
|
|
LINE1
|
|
§§§
|
|
|
|
## Code Fences No Lexer
|
|
|
|
§§§moo
|
|
LINE1
|
|
§§§
|
|
|
|
## Code Fences Simple Attributes
|
|
|
|
§§A§bash { .myclass id="myid" }
|
|
LINE1
|
|
§§A§
|
|
|
|
## Code Fences Line Numbers
|
|
|
|
§§§bash {linenos=table,hl_lines=[8,"15-17"],linenostart=199}
|
|
LINE1
|
|
LINE2
|
|
LINE3
|
|
LINE4
|
|
LINE5
|
|
LINE6
|
|
LINE7
|
|
LINE8
|
|
§§§
|
|
|
|
|
|
|
|
|
|
`
|
|
|
|
b := hugolib.NewIntegrationTestBuilder(
|
|
hugolib.IntegrationTestConfig{
|
|
T: t,
|
|
TxtarString: files,
|
|
},
|
|
).Build()
|
|
|
|
b.AssertFileContent("public/p1/index.html",
|
|
"<div class=\"highlight\"><pre tabindex=\"0\" class=\"chroma\"><code class=\"language-bash\" data-lang=\"bash\"><span class=\"line\"><span class=\"cl\">LINE1\n</span></span></code></pre></div>",
|
|
"Code Fences No Lexer</h2>\n<pre tabindex=\"0\"><code class=\"language-moo\" data-lang=\"moo\">LINE1\n</code></pre>",
|
|
"lnt",
|
|
)
|
|
}
|
|
|
|
func BenchmarkRenderHooks(b *testing.B) {
|
|
files := `
|
|
-- config.toml --
|
|
-- layouts/_default/_markup/render-heading.html --
|
|
<h{{ .Level }} id="{{ .Anchor | safeURL }}">
|
|
{{ .Text | safeHTML }}
|
|
<a class="anchor" href="#{{ .Anchor | safeURL }}">#</a>
|
|
</h{{ .Level }}>
|
|
-- layouts/_default/_markup/render-link.html --
|
|
<a href="{{ .Destination | safeURL }}"{{ with .Title}} title="{{ . }}"{{ end }}>{{ .Text | safeHTML }}</a>
|
|
-- layouts/_default/single.html --
|
|
{{ .Content }}
|
|
`
|
|
|
|
content := `
|
|
|
|
## Hello1 [Test](https://example.com)
|
|
|
|
A.
|
|
|
|
## Hello2 [Test](https://example.com)
|
|
|
|
B.
|
|
|
|
## Hello3 [Test](https://example.com)
|
|
|
|
C.
|
|
|
|
## Hello4 [Test](https://example.com)
|
|
|
|
D.
|
|
|
|
[Test](https://example.com)
|
|
|
|
## Hello5
|
|
|
|
|
|
`
|
|
|
|
for i := 1; i < 100; i++ {
|
|
files += fmt.Sprintf("\n-- content/posts/p%d.md --\n"+content, i+1)
|
|
}
|
|
|
|
cfg := hugolib.IntegrationTestConfig{
|
|
T: b,
|
|
TxtarString: files,
|
|
}
|
|
builders := make([]*hugolib.IntegrationTestBuilder, b.N)
|
|
|
|
for i := range builders {
|
|
builders[i] = hugolib.NewIntegrationTestBuilder(cfg)
|
|
}
|
|
|
|
b.ResetTimer()
|
|
|
|
for i := 0; i < b.N; i++ {
|
|
builders[i].Build()
|
|
}
|
|
}
|
|
|
|
func BenchmarkCodeblocks(b *testing.B) {
|
|
files := `
|
|
-- config.toml --
|
|
[markup]
|
|
[markup.highlight]
|
|
anchorLineNos = false
|
|
codeFences = true
|
|
guessSyntax = false
|
|
hl_Lines = ''
|
|
lineAnchors = ''
|
|
lineNoStart = 1
|
|
lineNos = false
|
|
lineNumbersInTable = true
|
|
noClasses = true
|
|
style = 'monokai'
|
|
tabWidth = 4
|
|
-- layouts/_default/single.html --
|
|
{{ .Content }}
|
|
`
|
|
|
|
content := `
|
|
|
|
FENCEgo
|
|
package main
|
|
import "fmt"
|
|
func main() {
|
|
fmt.Println("hello world")
|
|
}
|
|
FENCE
|
|
|
|
FENCEbash
|
|
#!/bin/bash
|
|
# Usage: Hello World Bash Shell Script Using Variables
|
|
# Author: Vivek Gite
|
|
# -------------------------------------------------
|
|
|
|
# Define bash shell variable called var
|
|
# Avoid spaces around the assignment operator (=)
|
|
var="Hello World"
|
|
|
|
# print it
|
|
echo "$var"
|
|
|
|
# Another way of printing it
|
|
printf "%s\n" "$var"
|
|
FENCE
|
|
`
|
|
|
|
content = strings.ReplaceAll(content, "FENCE", "```")
|
|
|
|
for i := 1; i < 100; i++ {
|
|
files += fmt.Sprintf("\n-- content/posts/p%d.md --\n"+content, i+1)
|
|
}
|
|
|
|
cfg := hugolib.IntegrationTestConfig{
|
|
T: b,
|
|
TxtarString: files,
|
|
}
|
|
builders := make([]*hugolib.IntegrationTestBuilder, b.N)
|
|
|
|
for i := range builders {
|
|
builders[i] = hugolib.NewIntegrationTestBuilder(cfg)
|
|
}
|
|
|
|
b.ResetTimer()
|
|
|
|
for i := 0; i < b.N; i++ {
|
|
builders[i].Build()
|
|
}
|
|
}
|
|
|
|
// Iisse #8959
|
|
func TestHookInfiniteRecursion(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
for _, renderFunc := range []string{"markdownify", ".Page.RenderString"} {
|
|
t.Run(renderFunc, func(t *testing.T) {
|
|
|
|
files := `
|
|
-- config.toml --
|
|
-- layouts/_default/_markup/render-link.html --
|
|
<a href="{{ .Destination | safeURL }}">{{ .Text | RENDERFUNC }}</a>
|
|
-- layouts/_default/single.html --
|
|
{{ .Content }}
|
|
-- content/p1.md --
|
|
---
|
|
title: "p1"
|
|
---
|
|
|
|
https://example.org
|
|
|
|
a@b.com
|
|
|
|
|
|
`
|
|
|
|
files = strings.ReplaceAll(files, "RENDERFUNC", renderFunc)
|
|
|
|
b, err := hugolib.NewIntegrationTestBuilder(
|
|
hugolib.IntegrationTestConfig{
|
|
T: t,
|
|
TxtarString: files,
|
|
},
|
|
).BuildE()
|
|
|
|
b.Assert(err, qt.IsNotNil)
|
|
b.Assert(err.Error(), qt.Contains, "text is already rendered, repeating it may cause infinite recursion")
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
// Issue 9594
|
|
func TestQuotesInImgAltAttr(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
files := `
|
|
-- config.toml --
|
|
[markup.goldmark.extensions]
|
|
typographer = false
|
|
-- content/p1.md --
|
|
---
|
|
title: "p1"
|
|
---
|
|
|
|
-- layouts/_default/single.html --
|
|
{{ .Content }}
|
|
`
|
|
|
|
b := hugolib.NewIntegrationTestBuilder(
|
|
hugolib.IntegrationTestConfig{
|
|
T: t,
|
|
TxtarString: files,
|
|
},
|
|
).Build()
|
|
|
|
b.AssertFileContent("public/p1/index.html", `
|
|
<img src="b.jpg" alt=""a"">
|
|
`)
|
|
}
|
|
|
|
func TestLinkifyProtocol(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
runTest := func(protocol string, withHook bool) *hugolib.IntegrationTestBuilder {
|
|
|
|
files := `
|
|
-- config.toml --
|
|
[markup.goldmark]
|
|
[markup.goldmark.extensions]
|
|
linkify = true
|
|
linkifyProtocol = "PROTOCOL"
|
|
-- content/p1.md --
|
|
---
|
|
title: "p1"
|
|
---
|
|
Link no procol: www.example.org
|
|
Link http procol: http://www.example.org
|
|
Link https procol: https://www.example.org
|
|
|
|
-- layouts/_default/single.html --
|
|
{{ .Content }}
|
|
`
|
|
files = strings.ReplaceAll(files, "PROTOCOL", protocol)
|
|
|
|
if withHook {
|
|
files += `-- layouts/_default/_markup/render-link.html --
|
|
<a href="{{ .Destination | safeURL }}">{{ .Text | safeHTML }}</a>`
|
|
}
|
|
|
|
return hugolib.NewIntegrationTestBuilder(
|
|
hugolib.IntegrationTestConfig{
|
|
T: t,
|
|
TxtarString: files,
|
|
},
|
|
).Build()
|
|
|
|
}
|
|
|
|
for _, withHook := range []bool{false, true} {
|
|
|
|
b := runTest("https", withHook)
|
|
|
|
b.AssertFileContent("public/p1/index.html",
|
|
"Link no procol: <a href=\"https://www.example.org\">www.example.org</a>",
|
|
"Link http procol: <a href=\"http://www.example.org\">http://www.example.org</a>",
|
|
"Link https procol: <a href=\"https://www.example.org\">https://www.example.org</a></p>",
|
|
)
|
|
|
|
b = runTest("http", withHook)
|
|
|
|
b.AssertFileContent("public/p1/index.html",
|
|
"Link no procol: <a href=\"http://www.example.org\">www.example.org</a>",
|
|
"Link http procol: <a href=\"http://www.example.org\">http://www.example.org</a>",
|
|
"Link https procol: <a href=\"https://www.example.org\">https://www.example.org</a></p>",
|
|
)
|
|
|
|
b = runTest("gopher", withHook)
|
|
|
|
b.AssertFileContent("public/p1/index.html",
|
|
"Link no procol: <a href=\"gopher://www.example.org\">www.example.org</a>",
|
|
"Link http procol: <a href=\"http://www.example.org\">http://www.example.org</a>",
|
|
"Link https procol: <a href=\"https://www.example.org\">https://www.example.org</a></p>",
|
|
)
|
|
|
|
}
|
|
}
|