github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-03-25 13:41:42 +00:00
Code Issues Projects Releases Packages Wiki Activity

Handle 404 thread safely

Browse source 
Replaces hack that temporarily changes a global flag.

Fixes 
Fixes
This commit is contained in:
bep 2015-03-07 15:18:00 +01:00
parent 851badcb7e
commit 602ceec06d
3 changed files with 87 additions and 25 deletions

13
hugolib/site.go
View file

@ -1268,8 +1268,6 @@ func (s *Site) RenderSitemap() error {
sitemapDefault := parseSitemap(viper.GetStringMap("Sitemap")) sitemapDefault := parseSitemap(viper.GetStringMap("Sitemap"))
optChanged := false
n := s.NewNode() n := s.NewNode()
// Prepend homepage to the list of pages // Prepend homepage to the list of pages
@ -1295,23 +1293,12 @@ func (s *Site) RenderSitemap() error {
} }
} }
// Force `UglyUrls` option to force `sitemap.xml` file name
switch s.PageTarget().(type) {
case *target.Filesystem:
s.PageTarget().(*target.PagePub).UglyUrls = true
optChanged = true
}
smLayouts := []string{"sitemap.xml", "_default/sitemap.xml", "_internal/_default/sitemap.xml"} smLayouts := []string{"sitemap.xml", "_default/sitemap.xml", "_internal/_default/sitemap.xml"}
if err := s.renderAndWriteXML("sitemap", "sitemap.xml", n, s.appendThemeTemplates(smLayouts)...); err != nil { if err := s.renderAndWriteXML("sitemap", "sitemap.xml", n, s.appendThemeTemplates(smLayouts)...); err != nil {
return err return err
} }
if optChanged {
s.PageTarget().(*target.PagePub).UglyUrls = viper.GetBool("UglyUrls")
}
return nil return nil
} }

97
hugolib/site_test.go
View file

@ -50,6 +50,20 @@ more text
` `
) )
func createAndRenderPages(t *testing.T, s *Site) {
if err := s.CreatePages(); err != nil {
t.Fatalf("Unable to create pages: %s", err)
}
if err := s.BuildSiteMeta(); err != nil {
t.Fatalf("Unable to build site metadata: %s", err)
}
if err := s.RenderPages(); err != nil {
t.Fatalf("Unable to render pages. %s", err)
}
}
func templatePrep(s *Site) { func templatePrep(s *Site) {
s.Tmpl = tpl.New() s.Tmpl = tpl.New()
s.Tmpl.LoadTemplates(s.absLayoutDir()) s.Tmpl.LoadTemplates(s.absLayoutDir())
@ -293,6 +307,77 @@ func TestDraftAndFutureRender(t *testing.T) {
viper.Set("BuildFuture", false) viper.Set("BuildFuture", false)
} }
// Issue #939
func Test404ShouldAlwaysHaveUglyUrls(t *testing.T) {
for _, uglyUrls := range []bool{true, false} {
doTest404ShouldAlwaysHaveUglyUrls(t, uglyUrls)
}
}
func doTest404ShouldAlwaysHaveUglyUrls(t *testing.T, uglyUrls bool) {
viper.Set("verbose", true)
viper.Set("baseurl", "http://auth/bub")
viper.Set("DisableSitemap", false)
viper.Set("DisableRSS", false)
viper.Set("UglyUrls", uglyUrls)
sources := []source.ByteSource{
{filepath.FromSlash("sect/doc1.html"), []byte("---\nmarkup: markdown\n---\n# title\nsome *content*")},
}
s := &Site{
Source: &source.InMemorySource{ByteSource: sources},
Targets: targetList{Page: &target.PagePub{UglyUrls: uglyUrls}},
}
s.initializeSiteInfo()
templatePrep(s)
must(s.addTemplate("index.html", "Home Sweet Home"))
must(s.addTemplate("_default/single.html", "{{.Content}}"))
must(s.addTemplate("404.html", "Page Not Found"))
// make sure the XML files also end up with ugly urls
must(s.addTemplate("rss.xml", "<root>RSS</root>"))
must(s.addTemplate("sitemap.xml", "<root>SITEMAP</root>"))
createAndRenderPages(t, s)
s.RenderHomePage()
s.RenderSitemap()
var expectedPagePath string
if uglyUrls {
expectedPagePath = "sect/doc1.html"
} else {
expectedPagePath = "sect/doc1/index.html"
}
tests := []struct {
doc string
expected string
}{
{filepath.FromSlash("index.html"), "Home Sweet Home"},
{filepath.FromSlash(expectedPagePath), "\n\n<h1 id=\"title:5d74edbb89ef198cd37882b687940cda\">title</h1>\n\n<p>some <em>content</em></p>\n"},
{filepath.FromSlash("404.html"), "Page Not Found"},
{filepath.FromSlash("index.xml"), "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?>\n<root>RSS</root>"},
{filepath.FromSlash("sitemap.xml"), "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?>\n<root>SITEMAP</root>"},
}
for _, test := range tests {
file, err := hugofs.DestinationFS.Open(test.doc)
if err != nil {
t.Fatalf("Did not find %s in target.", test.doc)
}
content := helpers.ReaderToBytes(file)
if !bytes.Equal(content, []byte(test.expected)) {
t.Errorf("%s content expected:\n%q\ngot:\n%q", test.doc, test.expected, string(content))
}
}
}
func TestSkipRender(t *testing.T) { func TestSkipRender(t *testing.T) {
hugofs.DestinationFS = new(afero.MemMapFs) hugofs.DestinationFS = new(afero.MemMapFs)
sources := []source.ByteSource{ sources := []source.ByteSource{
@ -321,17 +406,7 @@ func TestSkipRender(t *testing.T) {
must(s.addTemplate("head", "<head><script src=\"script.js\"></script></head>")) must(s.addTemplate("head", "<head><script src=\"script.js\"></script></head>"))
must(s.addTemplate("head_abs", "<head><script src=\"/script.js\"></script></head>")) must(s.addTemplate("head_abs", "<head><script src=\"/script.js\"></script></head>"))
if err := s.CreatePages(); err != nil { createAndRenderPages(t, s)
t.Fatalf("Unable to create pages: %s", err)
}
if err := s.BuildSiteMeta(); err != nil {
t.Fatalf("Unable to build site metadata: %s", err)
}
if err := s.RenderPages(); err != nil {
t.Fatalf("Unable to render pages. %s", err)
}
tests := []struct { tests := []struct {
doc string doc string

2
target/page.go
View file

@ -46,7 +46,7 @@ func (pp *PagePub) Translate(src string) (dest string, err error) {
dir = filepath.Join(pp.PublishDir, dir) dir = filepath.Join(pp.PublishDir, dir)
} }
if pp.UglyUrls || file == "index.html" { if pp.UglyUrls || file == "index.html" || file == "404.html" {
return filepath.Join(dir, fmt.Sprintf("%s%s", name, ext)), nil return filepath.Join(dir, fmt.Sprintf("%s%s", name, ext)), nil
} }