github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/target/htmlredirect.go

137 lines
4.3 KiB
Go
Raw Normal View History

Move alias rendering to target
2013-09-12 19:17:53 -04:00
package target
import (
Add /index.html to unadorned alias paths Bring code to be better in line with documentation.
2013-09-13 17:46:34 -04:00
"bytes"
Validate aliases to prevent directory traversal etc. Add validation before creating aliases: * Prevent creating aliases outside webroot (public/ dir) * Skip empty "" alias * Skip "/" → "/index.html", which gets overwritten anyway * Refuse to create Windows-invalid filenames on Windows; warn on other platforms * In case of invalid aliases, after skipping them, return `err = nil` to prevent the error passing up all the way to `hugolib.Render()` and causing Hugo to abort. * Update alias tests. Fixes #701: Add support for alias with whitespace Fixes #1418: Add validation for alias
2015-09-13 08:36:08 -04:00
"fmt"
Add /index.html to unadorned alias paths Bring code to be better in line with documentation.
2013-09-13 17:46:34 -04:00
"html/template"
converted path 2 filepath
2014-11-06 11:06:29 -05:00
"path/filepath"
Validate aliases to prevent directory traversal etc. Add validation before creating aliases: * Prevent creating aliases outside webroot (public/ dir) * Skip empty "" alias * Skip "/" → "/index.html", which gets overwritten anyway * Refuse to create Windows-invalid filenames on Windows; warn on other platforms * In case of invalid aliases, after skipping them, return `err = nil` to prevent the error passing up all the way to `hugolib.Render()` and causing Hugo to abort. * Update alias tests. Fixes #701: Add support for alias with whitespace Fixes #1418: Add validation for alias
2015-09-13 08:36:08 -04:00
"runtime"
Move alias rendering to target
2013-09-12 19:17:53 -04:00
"strings"
moving writeToDisk to helpers to make it more accessible
2014-05-01 13:13:11 -04:00
"github.com/spf13/hugo/helpers"
Migrating Hugo to Afero for filesystem calls.
2014-11-01 11:57:29 -04:00
"github.com/spf13/hugo/hugofs"
Validate aliases to prevent directory traversal etc. Add validation before creating aliases: * Prevent creating aliases outside webroot (public/ dir) * Skip empty "" alias * Skip "/" → "/index.html", which gets overwritten anyway * Refuse to create Windows-invalid filenames on Windows; warn on other platforms * In case of invalid aliases, after skipping them, return `err = nil` to prevent the error passing up all the way to `hugolib.Render()` and causing Hugo to abort. * Update alias tests. Fixes #701: Add support for alias with whitespace Fixes #1418: Add validation for alias
2015-09-13 08:36:08 -04:00
jww "github.com/spf13/jwalterweatherman"
Move alias rendering to target
2013-09-12 19:17:53 -04:00
)
Move alias logic to target module I want to move all logic to writing aliases to target so I can pave the way for writing aliases specific to other runtimes (like .htaccess for apache or a script for updating AWS or symlinking on a filesystem).
2013-09-13 00:18:13 -04:00
const ALIAS = "<!DOCTYPE html><html><head><link rel=\"canonical\" href=\"{{ .Permalink }}\"/><meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\" /><meta http-equiv=\"refresh\" content=\"0;url={{ .Permalink }}\" /></head></html>"
Add /index.html to unadorned alias paths Bring code to be better in line with documentation.
2013-09-13 17:46:34 -04:00
const ALIAS_XHTML = "<!DOCTYPE html><html xmlns=\"http://www.w3.org/1999/xhtml\"><head><link rel=\"canonical\" href=\"{{ .Permalink }}\"/><meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\" /><meta http-equiv=\"refresh\" content=\"0;url={{ .Permalink }}\" /></head></html>"
Move alias logic to target module I want to move all logic to writing aliases to target so I can pave the way for writing aliases specific to other runtimes (like .htaccess for apache or a script for updating AWS or symlinking on a filesystem).
2013-09-13 00:18:13 -04:00
var DefaultAliasTemplates *template.Template
func init() {
DefaultAliasTemplates = template.New("")
template.Must(DefaultAliasTemplates.New("alias").Parse(ALIAS))
template.Must(DefaultAliasTemplates.New("alias-xhtml").Parse(ALIAS_XHTML))
}
type AliasPublisher interface {
Translator
Publish(string, template.HTML) error
}
Move alias rendering to target
2013-09-12 19:17:53 -04:00
type HTMLRedirectAlias struct {
PublishDir string
Add /index.html to unadorned alias paths Bring code to be better in line with documentation.
2013-09-13 17:46:34 -04:00
Templates *template.Template
Move alias rendering to target
2013-09-12 19:17:53 -04:00
}
func (h *HTMLRedirectAlias) Translate(alias string) (aliasPath string, err error) {
Validate aliases to prevent directory traversal etc. Add validation before creating aliases: * Prevent creating aliases outside webroot (public/ dir) * Skip empty "" alias * Skip "/" → "/index.html", which gets overwritten anyway * Refuse to create Windows-invalid filenames on Windows; warn on other platforms * In case of invalid aliases, after skipping them, return `err = nil` to prevent the error passing up all the way to `hugolib.Render()` and causing Hugo to abort. * Update alias tests. Fixes #701: Add support for alias with whitespace Fixes #1418: Add validation for alias
2015-09-13 08:36:08 -04:00
originalAlias := alias
Add /index.html to unadorned alias paths Bring code to be better in line with documentation.
2013-09-13 17:46:34 -04:00
if len(alias) <= 0 {
Validate aliases to prevent directory traversal etc. Add validation before creating aliases: * Prevent creating aliases outside webroot (public/ dir) * Skip empty "" alias * Skip "/" → "/index.html", which gets overwritten anyway * Refuse to create Windows-invalid filenames on Windows; warn on other platforms * In case of invalid aliases, after skipping them, return `err = nil` to prevent the error passing up all the way to `hugolib.Render()` and causing Hugo to abort. * Update alias tests. Fixes #701: Add support for alias with whitespace Fixes #1418: Add validation for alias
2015-09-13 08:36:08 -04:00
return "", fmt.Errorf("Alias \"\" is an empty string")
}
alias = filepath.Clean(alias)
components := strings.Split(alias, helpers.FilePathSeparator)
if alias == helpers.FilePathSeparator {
return "", fmt.Errorf("Alias \"%s\" resolves to website root directory", originalAlias)
Add /index.html to unadorned alias paths Bring code to be better in line with documentation.
2013-09-13 17:46:34 -04:00
}
Validate aliases to prevent directory traversal etc. Add validation before creating aliases: * Prevent creating aliases outside webroot (public/ dir) * Skip empty "" alias * Skip "/" → "/index.html", which gets overwritten anyway * Refuse to create Windows-invalid filenames on Windows; warn on other platforms * In case of invalid aliases, after skipping them, return `err = nil` to prevent the error passing up all the way to `hugolib.Render()` and causing Hugo to abort. * Update alias tests. Fixes #701: Add support for alias with whitespace Fixes #1418: Add validation for alias
2015-09-13 08:36:08 -04:00
// Validate against directory traversal
if components[0] == ".." {
return "", fmt.Errorf("Alias \"%s\" traverses outside the website root directory", originalAlias)
}
Add "control code" and "trailing space" to alias validation
2015-09-14 14:18:54 -04:00
// Handle Windows file and directory naming restrictions
// See "Naming Files, Paths, and Namespaces" on MSDN
// https://msdn.microsoft.com/en-us/library/aa365247%28v=VS.85%29.aspx?f=255&MSPPError=-2147217396
Validate aliases to prevent directory traversal etc. Add validation before creating aliases: * Prevent creating aliases outside webroot (public/ dir) * Skip empty "" alias * Skip "/" → "/index.html", which gets overwritten anyway * Refuse to create Windows-invalid filenames on Windows; warn on other platforms * In case of invalid aliases, after skipping them, return `err = nil` to prevent the error passing up all the way to `hugolib.Render()` and causing Hugo to abort. * Update alias tests. Fixes #701: Add support for alias with whitespace Fixes #1418: Add validation for alias
2015-09-13 08:36:08 -04:00
msgs := []string{}
reservedNames := []string{"CON", "PRN", "AUX", "NUL", "COM1", "COM2", "COM3", "COM4", "COM5", "COM6", "COM7", "COM8", "COM9", "LPT1", "LPT2", "LPT3", "LPT4", "LPT5", "LPT6", "LPT7", "LPT8", "LPT9"}
if strings.ContainsAny(alias, ":*?\"<>|") {
Add "control code" and "trailing space" to alias validation
2015-09-14 14:18:54 -04:00
msgs = append(msgs, fmt.Sprintf("Alias \"%s\" contains invalid characters on Windows: : * ? \" < > |", originalAlias))
Validate aliases to prevent directory traversal etc. Add validation before creating aliases: * Prevent creating aliases outside webroot (public/ dir) * Skip empty "" alias * Skip "/" → "/index.html", which gets overwritten anyway * Refuse to create Windows-invalid filenames on Windows; warn on other platforms * In case of invalid aliases, after skipping them, return `err = nil` to prevent the error passing up all the way to `hugolib.Render()` and causing Hugo to abort. * Update alias tests. Fixes #701: Add support for alias with whitespace Fixes #1418: Add validation for alias
2015-09-13 08:36:08 -04:00
}
Add "control code" and "trailing space" to alias validation
2015-09-14 14:18:54 -04:00
for _, ch := range alias {
if ch < ' ' {
msgs = append(msgs, fmt.Sprintf("Alias \"%s\" contains ASCII control code (0x00 to 0x1F), invalid on Windows: : * ? \" < > |", originalAlias))
continue
}
}
for _, comp := range components {
if strings.HasSuffix(comp, " ") || strings.HasSuffix(comp, ".") {
msgs = append(msgs, fmt.Sprintf("Alias \"%s\" contains component with a trailing space or period, problematic on Windows", originalAlias))
Validate aliases to prevent directory traversal etc. Add validation before creating aliases: * Prevent creating aliases outside webroot (public/ dir) * Skip empty "" alias * Skip "/" → "/index.html", which gets overwritten anyway * Refuse to create Windows-invalid filenames on Windows; warn on other platforms * In case of invalid aliases, after skipping them, return `err = nil` to prevent the error passing up all the way to `hugolib.Render()` and causing Hugo to abort. * Update alias tests. Fixes #701: Add support for alias with whitespace Fixes #1418: Add validation for alias
2015-09-13 08:36:08 -04:00
}
for _, r := range reservedNames {
Add "control code" and "trailing space" to alias validation
2015-09-14 14:18:54 -04:00
if comp == r {
Validate aliases to prevent directory traversal etc. Add validation before creating aliases: * Prevent creating aliases outside webroot (public/ dir) * Skip empty "" alias * Skip "/" → "/index.html", which gets overwritten anyway * Refuse to create Windows-invalid filenames on Windows; warn on other platforms * In case of invalid aliases, after skipping them, return `err = nil` to prevent the error passing up all the way to `hugolib.Render()` and causing Hugo to abort. * Update alias tests. Fixes #701: Add support for alias with whitespace Fixes #1418: Add validation for alias
2015-09-13 08:36:08 -04:00
msgs = append(msgs, fmt.Sprintf("Alias \"%s\" contains component with reserved name \"%s\" on Windows", originalAlias, r))
}
}
}
if len(msgs) > 0 {
if runtime.GOOS == "windows" {
for _, m := range msgs {
jww.ERROR.Println(m)
}
return "", fmt.Errorf("Cannot create \"%s\": Windows filename restriction", originalAlias)
} else {
for _, m := range msgs {
jww.WARN.Println(m)
}
}
}
// Add the final touch
if strings.HasPrefix(alias, helpers.FilePathSeparator) {
alias = alias[1:]
}
if strings.HasSuffix(alias, helpers.FilePathSeparator) {
Move alias rendering to target
2013-09-12 19:17:53 -04:00
alias = alias + "index.html"
Add /index.html to unadorned alias paths Bring code to be better in line with documentation.
2013-09-13 17:46:34 -04:00
} else if !strings.HasSuffix(alias, ".html") {
Validate aliases to prevent directory traversal etc. Add validation before creating aliases: * Prevent creating aliases outside webroot (public/ dir) * Skip empty "" alias * Skip "/" → "/index.html", which gets overwritten anyway * Refuse to create Windows-invalid filenames on Windows; warn on other platforms * In case of invalid aliases, after skipping them, return `err = nil` to prevent the error passing up all the way to `hugolib.Render()` and causing Hugo to abort. * Update alias tests. Fixes #701: Add support for alias with whitespace Fixes #1418: Add validation for alias
2015-09-13 08:36:08 -04:00
alias = alias + helpers.FilePathSeparator + "index.html"
Move alias rendering to target
2013-09-12 19:17:53 -04:00
}
Validate aliases to prevent directory traversal etc. Add validation before creating aliases: * Prevent creating aliases outside webroot (public/ dir) * Skip empty "" alias * Skip "/" → "/index.html", which gets overwritten anyway * Refuse to create Windows-invalid filenames on Windows; warn on other platforms * In case of invalid aliases, after skipping them, return `err = nil` to prevent the error passing up all the way to `hugolib.Render()` and causing Hugo to abort. * Update alias tests. Fixes #701: Add support for alias with whitespace Fixes #1418: Add validation for alias
2015-09-13 08:36:08 -04:00
if originalAlias != alias {
jww.INFO.Printf("Alias \"%s\" translated to \"%s\"\n", originalAlias, alias)
}
return filepath.Join(h.PublishDir, alias), nil
Move alias rendering to target
2013-09-12 19:17:53 -04:00
}
Move alias logic to target module I want to move all logic to writing aliases to target so I can pave the way for writing aliases specific to other runtimes (like .htaccess for apache or a script for updating AWS or symlinking on a filesystem).
2013-09-13 00:18:13 -04:00
type AliasNode struct {
Permalink template.HTML
}
func (h *HTMLRedirectAlias) Publish(path string, permalink template.HTML) (err error) {
if path, err = h.Translate(path); err != nil {
Validate aliases to prevent directory traversal etc. Add validation before creating aliases: * Prevent creating aliases outside webroot (public/ dir) * Skip empty "" alias * Skip "/" → "/index.html", which gets overwritten anyway * Refuse to create Windows-invalid filenames on Windows; warn on other platforms * In case of invalid aliases, after skipping them, return `err = nil` to prevent the error passing up all the way to `hugolib.Render()` and causing Hugo to abort. * Update alias tests. Fixes #701: Add support for alias with whitespace Fixes #1418: Add validation for alias
2015-09-13 08:36:08 -04:00
jww.ERROR.Printf("%s, skipping.", err)
return nil
Move alias logic to target module I want to move all logic to writing aliases to target so I can pave the way for writing aliases specific to other runtimes (like .htaccess for apache or a script for updating AWS or symlinking on a filesystem).
2013-09-13 00:18:13 -04:00
}
t := "alias"
if strings.HasSuffix(path, ".xhtml") {
t = "alias-xhtml"
}
template := DefaultAliasTemplates
if h.Templates != nil {
template = h.Templates
}
buffer := new(bytes.Buffer)
err = template.ExecuteTemplate(buffer, t, &AliasNode{permalink})
if err != nil {
return
}
Migrating Hugo to Afero for filesystem calls.
2014-11-01 11:57:29 -04:00
return helpers.WriteToDisk(path, buffer, hugofs.DestinationFS)
Move alias logic to target module I want to move all logic to writing aliases to target so I can pave the way for writing aliases specific to other runtimes (like .htaccess for apache or a script for updating AWS or symlinking on a filesystem).
2013-09-13 00:18:13 -04:00
}
Reference in a new issue Copy permalink