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

150 lines
5 KiB
Go
Raw Normal View History

Add readFile template func This also includes a refactor of the hugofs package and its usage. The motivation for that is: The Afero filesystems are brilliant. Hugo's way of adding a dozen of global variables for the different filesystems was a mistake. In readFile (and also in some other places in Hugo today) we need a way to restrict the access inside the working dir. We could use ioutil.ReadFile and implement the path checking, checking the base path and the dots ("..") etc. But it is obviously better to use an Afero BasePathFs combined witha ReadOnlyFs. We could create a use-once-filesystem and handle the initialization ourselves, but since this is also useful to others and the initialization depends on some other global state (which would mean to create a new file system on every invocation), we might as well do it properly and encapsulate the predefined set of filesystems. This change also leads the way, if needed, to encapsulate the file systems in a struct, making it possible to have several file system sets in action at once (parallel multilanguage site building? With Moore's law and all...) Fixes #1551
2016-03-21 19:28:42 -04:00
// Copyright 2016 The Hugo Authors. All rights reserved.
Add copyright header to that source files that don’t have one. See #1646
2015-12-10 17:19:38 -05:00
//
// 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.
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
)
Update the alias generated HTML files to conform to the W3C HTML spec - W3C recommends that there be a [whitespace character][1] between the `;` and the `url=` portions. - W3C also recommends that there be a [title][2] child in the `head` element [1]: https://www.w3.org/TR/html-markup/meta.http-equiv.refresh.html [2]: https://www.w3.org/TR/html-markup/head.html Closes #1933
2016-03-07 15:05:51 -05:00
const alias = "<!DOCTYPE html><html><head><title>{{ .Permalink }}</title><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>"
const aliasXHtml = "<!DOCTYPE html><html xmlns=\"http://www.w3.org/1999/xhtml\"><head><title>{{ .Permalink }}</title><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
target: Fix some Golint warnings
2016-03-22 19:44:51 -04:00
var defaultAliasTemplates *template.Template
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
func init() {
target: Fix some Golint warnings
2016-03-22 19:44:51 -04:00
defaultAliasTemplates = template.New("")
template.Must(defaultAliasTemplates.New("alias").Parse(alias))
template.Must(defaultAliasTemplates.New("alias-xhtml").Parse(aliasXHtml))
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 AliasPublisher interface {
Translator
Implement support for alias templates This change adds a canonical alias.html template that is used for page redirects, and passes the page as data to the template under .Page Fixes #2533 Closes #2576
2016-10-15 07:35:32 -04:00
Publish(path string, permalink string, page interface{}) error
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
}
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
Redirect to main language from root See #2312 See #2309
2016-08-04 14:41:30 -04:00
AllowRoot bool // for the language redirects
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)
Redirect to main language from root See #2312 See #2309
2016-08-04 14:41:30 -04:00
if !h.AllowRoot && alias == helpers.FilePathSeparator {
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 \"%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)
target: Fix some Golint warnings
2016-03-22 19:44:51 -04:00
}
for _, m := range msgs {
jww.WARN.Println(m)
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 the final touch
target: Simplify
2016-11-23 12:46:32 -05:00
alias = strings.TrimPrefix(alias, helpers.FilePathSeparator)
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 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 on Node and Page should be of string This change fixes #1384.
2015-10-16 23:45:49 -04:00
Permalink string
Implement support for alias templates This change adds a canonical alias.html template that is used for page redirects, and passes the page as data to the template under .Page Fixes #2533 Closes #2576
2016-10-15 07:35:32 -04:00
Page interface{}
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
}
Implement support for alias templates This change adds a canonical alias.html template that is used for page redirects, and passes the page as data to the template under .Page Fixes #2533 Closes #2576
2016-10-15 07:35:32 -04:00
func (h *HTMLRedirectAlias) Publish(path string, permalink string, page interface{}) (err error) {
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
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"
}
target: Fix some Golint warnings
2016-03-22 19:44:51 -04:00
template := defaultAliasTemplates
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
if h.Templates != nil {
template = h.Templates
Implement support for alias templates This change adds a canonical alias.html template that is used for page redirects, and passes the page as data to the template under .Page Fixes #2533 Closes #2576
2016-10-15 07:35:32 -04:00
t = "alias.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
}
buffer := new(bytes.Buffer)
Implement support for alias templates This change adds a canonical alias.html template that is used for page redirects, and passes the page as data to the template under .Page Fixes #2533 Closes #2576
2016-10-15 07:35:32 -04:00
err = template.ExecuteTemplate(buffer, t, &AliasNode{permalink, page})
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
if err != nil {
return
}
Add readFile template func This also includes a refactor of the hugofs package and its usage. The motivation for that is: The Afero filesystems are brilliant. Hugo's way of adding a dozen of global variables for the different filesystems was a mistake. In readFile (and also in some other places in Hugo today) we need a way to restrict the access inside the working dir. We could use ioutil.ReadFile and implement the path checking, checking the base path and the dots ("..") etc. But it is obviously better to use an Afero BasePathFs combined witha ReadOnlyFs. We could create a use-once-filesystem and handle the initialization ourselves, but since this is also useful to others and the initialization depends on some other global state (which would mean to create a new file system on every invocation), we might as well do it properly and encapsulate the predefined set of filesystems. This change also leads the way, if needed, to encapsulate the file systems in a struct, making it possible to have several file system sets in action at once (parallel multilanguage site building? With Moore's law and all...) Fixes #1551
2016-03-21 19:28:42 -04:00
return helpers.WriteToDisk(path, buffer, hugofs.Destination())
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