github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-04-20 16:33:32 +00:00
Code Issues Projects Releases Packages Wiki Activity

hugolib: Normalize permalink path segments

Browse source 
When constructing permalinks, ensure that path segments are normalized
with PathSpec.MakeSegment instead of PathSpec.URLize.

Fixes #4926
This commit is contained in:
Cameron Moore 2018-09-14 04:35:26 -05:00 • committed by Bjørn Erik Pedersen
parent 555a5612b2
commit 06976ebb87
2 changed files with 30 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
hugolib/permalinks.go
View file

@ -154,7 +154,7 @@ func pageToPermalinkDate(p *Page, dateField string) (string, error) {
func pageToPermalinkTitle(p *Page, _ string) (string, error) { func pageToPermalinkTitle(p *Page, _ string) (string, error) {
// Page contains Node which has Title // Page contains Node which has Title
// (also contains URLPath which has Slug, sometimes) // (also contains URLPath which has Slug, sometimes)
return p.s.PathSpec.URLize(p.title), nil return p.s.PathSpec.MakeSegment(p.title), nil
} }
// pageToPermalinkFilename returns the URL-safe form of the filename // pageToPermalinkFilename returns the URL-safe form of the filename
@ -166,7 +166,7 @@ func pageToPermalinkFilename(p *Page, _ string) (string, error) {
_, name = filepath.Split(dir) _, name = filepath.Split(dir)
} }
return p.s.PathSpec.URLize(name), nil return p.s.PathSpec.MakeSegment(name), nil
} }
// if the page has a slug, return the slug, else return the title // if the page has a slug, return the slug, else return the title
@ -181,20 +181,30 @@ func pageToPermalinkSlugElseTitle(p *Page, a string) (string, error) {
if strings.HasSuffix(p.Slug, "-") { if strings.HasSuffix(p.Slug, "-") {
p.Slug = p.Slug[0 : len(p.Slug)-1] p.Slug = p.Slug[0 : len(p.Slug)-1]
} }
return p.s.PathSpec.URLize(p.Slug), nil return p.s.PathSpec.MakeSegment(p.Slug), nil
} }
return pageToPermalinkTitle(p, a) return pageToPermalinkTitle(p, a)
} }
func pageToPermalinkSection(p *Page, _ string) (string, error) { func pageToPermalinkSection(p *Page, _ string) (string, error) {
// Page contains Node contains URLPath which has Section // Page contains Node contains URLPath which has Section
return p.Section(), nil return p.s.PathSpec.MakeSegment(p.Section()), nil
} }
func pageToPermalinkSections(p *Page, _ string) (string, error) { func pageToPermalinkSections(p *Page, _ string) (string, error) {
// TODO(bep) we have some superflous URLize in this file, but let's // TODO(bep) we have some superflous URLize in this file, but let's
// deal with that later. // deal with that later.
return path.Join(p.CurrentSection().sections...), nil
cs := p.CurrentSection()
if cs == nil {
return "", errors.New("\":sections\" attribute requires parent page but is nil")
}
sections := make([]string, len(cs.sections))
for i := range cs.sections {
sections[i] = p.s.PathSpec.MakeSegment(cs.sections[i])
}
return path.Join(sections...), nil
} }
func init() { func init() {

40
hugolib/permalinks_test.go
View file

@ -19,36 +19,26 @@ import (
) )
// testdataPermalinks is used by a couple of tests; the expandsTo content is // testdataPermalinks is used by a couple of tests; the expandsTo content is
// subject to the data in SIMPLE_PAGE_JSON. // subject to the data in simplePageJSON.
var testdataPermalinks = []struct { var testdataPermalinks = []struct {
spec string spec string
valid bool valid bool
expandsTo string expandsTo string
}{ }{
//{"/:year/:month/:title/", true, "/2012/04/spf13-vim-3.0-release-and-new-website/"}, {":title", true, "spf13-vim-3.0-release-and-new-website"},
//{"/:title", true, "/spf13-vim-3.0-release-and-new-website"},
//{":title", true, "spf13-vim-3.0-release-and-new-website"},
//{"/blog/:year/:yearday/:title", true, "/blog/2012/97/spf13-vim-3.0-release-and-new-website"},
{"/:year-:month-:title", true, "/2012-04-spf13-vim-3.0-release-and-new-website"}, {"/:year-:month-:title", true, "/2012-04-spf13-vim-3.0-release-and-new-website"},
{"/blog/:year-:month-:title", true, "/blog/2012-04-spf13-vim-3.0-release-and-new-website"},
{"/blog-:year-:month-:title", true, "/blog-2012-04-spf13-vim-3.0-release-and-new-website"}, {"/:year/:yearday/:month/:monthname/:day/:weekday/:weekdayname/", true, "/2012/97/04/April/06/5/Friday/"}, // Dates
//{"/blog/:fred", false, ""}, {"/:section/", true, "/blue/"}, // Section
//{"/:year//:title", false, ""}, {"/:title/", true, "/spf13-vim-3.0-release-and-new-website/"}, // Title
//{ {"/:slug/", true, "/spf13-vim-3-0-release-and-new-website/"}, // Slug
//"/:section/:year/:month/:day/:weekdayname/:yearday/:title", {"/:filename/", true, "/test-page/"}, // Filename
//true, // TODO(moorereason): need test scaffolding for this.
//"/blue/2012/04/06/Friday/97/spf13-vim-3.0-release-and-new-website", //{"/:sections/", false, "/blue/"}, // Sections
//},
//{ // Failures
//"/:weekday/:weekdayname/:month/:monthname", {"/blog/:fred", false, ""},
//true, {"/:year//:title", false, ""},
//"/5/Friday/04/April",
//},
//{
//"/:slug/:title",
//true,
//"/spf13-vim-3-0-release-and-new-website/spf13-vim-3.0-release-and-new-website",
//},
} }
func TestPermalinkValidation(t *testing.T) { func TestPermalinkValidation(t *testing.T) {
@ -75,7 +65,7 @@ func TestPermalinkExpansion(t *testing.T) {
page, err := s.NewPageFrom(strings.NewReader(simplePageJSON), "blue/test-page.md") page, err := s.NewPageFrom(strings.NewReader(simplePageJSON), "blue/test-page.md")
if err != nil { if err != nil {
t.Fatalf("failed before we began, could not parse SIMPLE_PAGE_JSON: %s", err) t.Fatalf("failed before we began, could not parse simplePageJSON: %s", err)
} }
for _, item := range testdataPermalinks { for _, item := range testdataPermalinks {
if !item.valid { if !item.valid {