Support Go time format strings in permalinks

In the vein of an ancient TODO about supporting custom date formatting with
strftime, this allows `:`-prefixed Go time format strings in permalink segments.
This allows users to customize date-based permalinks any way they need to.

For example, with a date of 2019-11-09, the permalink `/:06/:1/:2` will render
as `/19/11/9`.

See:

07978e4a49 (diff-0688a3b65c7f5d01aa216f8d9b57fd00R111-R112)
https://discourse.gohugo.io/t/implementing-additional-date-formats-for-permalinks/17860
https://github.com/gohugoio/hugo/pull/6488
This commit is contained in:
Luke Francl
2019-11-09 21:58:38 -08:00
committed by Bjørn Erik Pedersen
parent cafecca440
commit 70a1aa345b
3 changed files with 43 additions and 11 deletions

View File

@@ -20,6 +20,7 @@ import (
"regexp"
"strconv"
"strings"
"time"
"github.com/pkg/errors"
@@ -38,6 +39,24 @@ type PermalinkExpander struct {
ps *helpers.PathSpec
}
// Time for checking date formats. Every field is different than the
// Go reference time for date formatting. This ensures that formatting this date
// with a Go time format always has a different output than the format itself.
var referenceTime = time.Date(2019, time.November, 9, 23, 1, 42, 1, time.UTC)
// Return the callback for the given permalink attribute and a boolean indicating if the attribute is valid or not.
func (p PermalinkExpander) callback(attr string) (pageToPermaAttribute, bool) {
if callback, ok := p.knownPermalinkAttributes[attr]; ok {
return callback, true
}
if referenceTime.Format(attr) != attr {
return p.pageToPermalinkDate, true
}
return nil, false
}
// NewPermalinkExpander creates a new PermalinkExpander configured by the given
// PathSpec.
func NewPermalinkExpander(ps *helpers.PathSpec) (PermalinkExpander, error) {
@@ -109,7 +128,7 @@ func (l PermalinkExpander) parse(patterns map[string]string) (map[string]func(Pa
replacement := m[0]
attr := replacement[1:]
replacements[i] = replacement
callback, ok := l.knownPermalinkAttributes[attr]
callback, ok := l.callback(attr)
if !ok {
return nil, &permalinkExpandError{pattern: pattern, err: errPermalinkAttributeUnknown}
@@ -173,8 +192,8 @@ func (l PermalinkExpander) validate(pp string) bool {
}
for _, match := range matches {
k := strings.ToLower(match[0][1:])
if _, ok := l.knownPermalinkAttributes[k]; !ok {
k := match[0][1:]
if _, ok := l.callback(k); !ok {
return false
}
}
@@ -214,9 +233,8 @@ func (l PermalinkExpander) pageToPermalinkDate(p Page, dateField string) (string
case "yearday":
return strconv.Itoa(p.Date().YearDay()), nil
}
//TODO: support classic strftime escapes too
// (and pass those through despite not being in the map)
panic("coding error: should not be here")
return p.Date().Format(dateField), nil
}
// pageToPermalinkTitle returns the URL-safe form of the title