summaryrefslogtreecommitdiffstats
path: root/hugolib/alias.go
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2017-03-16 09:09:26 +0100
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2017-03-27 15:43:56 +0200
commitd76e5f36b412eb68be3cd5a53bacc099ec46280f (patch)
tree74e58982ee76819afde7e4da30389900912da5ae /hugolib/alias.go
parentad8cea87f363b00f43632aaac679eaef00144efa (diff)
hugolib: Pull all alias handling into one file
Diffstat (limited to 'hugolib/alias.go')
-rw-r--r--hugolib/alias.go128
1 files changed, 123 insertions, 5 deletions
diff --git a/hugolib/alias.go b/hugolib/alias.go
index 67c9dc785..9a23d6d0b 100644
--- a/hugolib/alias.go
+++ b/hugolib/alias.go
@@ -3,7 +3,7 @@
// 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
+// http://wwa.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,
@@ -15,13 +15,21 @@ package hugolib
import (
"bytes"
+ "fmt"
"html/template"
"io"
+ "path/filepath"
+ "runtime"
+ "strings"
+
+ jww "github.com/spf13/jwalterweatherman"
+
+ "github.com/spf13/hugo/helpers"
)
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>"
- 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>"
+ aliasXHtml = "<!DOCTYPE html><html xmlns=\"http://wwa.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>"
)
var defaultAliasTemplates *template.Template
@@ -33,11 +41,14 @@ func init() {
}
type aliasHandler struct {
- Templates *template.Template
+ Templates *template.Template
+ log *jww.Notepad
+ allowRoot bool
+ publishDir string
}
-func newAliasHandler(t *template.Template) aliasHandler {
- return aliasHandler{t}
+func newAliasHandler(t *template.Template, l *jww.Notepad, allowRoot bool, publishDir string) aliasHandler {
+ return aliasHandler{t, l, allowRoot, publishDir}
}
func (a aliasHandler) renderAlias(isXHTML bool, permalink string, page *Page) (io.Reader, error) {
@@ -67,3 +78,110 @@ func (a aliasHandler) renderAlias(isXHTML bool, permalink string, page *Page) (i
}
return buffer, nil
}
+
+func (s *Site) writeDestAlias(path, permalink string, p *Page) (err error) {
+ return s.publishDestAlias(false, path, permalink, p)
+}
+
+func (s *Site) publishDestAlias(allowRoot bool, path, permalink string, p *Page) (err error) {
+
+ handler := newAliasHandler(s.Tmpl.Lookup("alias.html"), s.Log, allowRoot, s.absPublishDir())
+
+ isXHTML := strings.HasSuffix(path, ".xhtml")
+
+ if s.Info.relativeURLs {
+ // convert `permalink` into URI relative to location of `path`
+ baseURL := helpers.SanitizeURLKeepTrailingSlash(s.Cfg.GetString("baseURL"))
+ if strings.HasPrefix(permalink, baseURL) {
+ permalink = "/" + strings.TrimPrefix(permalink, baseURL)
+ }
+ permalink, err = helpers.GetRelativePath(permalink, path)
+ if err != nil {
+ s.Log.ERROR.Println("Failed to make a RelativeURL alias:", path, "redirecting to", permalink)
+ }
+ permalink = filepath.ToSlash(permalink)
+ }
+ s.Log.DEBUG.Println("creating alias:", path, "redirecting to", permalink)
+
+ targetPath, err := handler.targetPathAlias(path)
+ if err != nil {
+ return err
+ }
+
+ aliasContent, err := handler.renderAlias(isXHTML, permalink, p)
+ if err != nil {
+ return err
+ }
+
+ return s.publish(targetPath, aliasContent)
+
+}
+
+func (a aliasHandler) targetPathAlias(src string) (string, error) {
+ originalAlias := src
+ if len(src) <= 0 {
+ return "", fmt.Errorf("Alias \"\" is an empty string")
+ }
+
+ alias := filepath.Clean(src)
+ components := strings.Split(alias, helpers.FilePathSeparator)
+
+ if !a.allowRoot && alias == helpers.FilePathSeparator {
+ return "", fmt.Errorf("Alias \"%s\" resolves to website root directory", originalAlias)
+ }
+
+ // Validate against directory traversal
+ if components[0] == ".." {
+ return "", fmt.Errorf("Alias \"%s\" traverses outside the website root directory", originalAlias)
+ }
+
+ // 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
+ msgs := []string{}
+ reservedNames := []string{"CON", "PRN", "AUX", "NUL", "COM0", "COM1", "COM2", "COM3", "COM4", "COM5", "COM6", "COM7", "COM8", "COM9", "LPT0", "LPT1", "LPT2", "LPT3", "LPT4", "LPT5", "LPT6", "LPT7", "LPT8", "LPT9"}
+
+ if strings.ContainsAny(alias, ":*?\"<>|") {
+ msgs = append(msgs, fmt.Sprintf("Alias \"%s\" contains invalid characters on Windows: : * ? \" < > |", originalAlias))
+ }
+ 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))
+ }
+ for _, r := range reservedNames {
+ if comp == r {
+ 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 {
+ a.log.ERROR.Println(m)
+ }
+ return "", fmt.Errorf("Cannot create \"%s\": Windows filename restriction", originalAlias)
+ }
+ for _, m := range msgs {
+ a.log.WARN.Println(m)
+ }
+ }
+
+ // Add the final touch
+ alias = strings.TrimPrefix(alias, helpers.FilePathSeparator)
+ if strings.HasSuffix(alias, helpers.FilePathSeparator) {
+ alias = alias + "index.html"
+ } else if !strings.HasSuffix(alias, ".html") {
+ alias = alias + helpers.FilePathSeparator + "index.html"
+ }
+ if originalAlias != alias {
+ a.log.INFO.Printf("Alias \"%s\" translated to \"%s\"\n", originalAlias, alias)
+ }
+
+ return filepath.Join(a.publishDir, alias), nil
+}
generated by cgit v1.2.3 (git 2.25.1) at 2024-08-06 17:53:16 +0000