2017-03-03 09:47:43 +00:00
|
|
|
// Copyright 2017 The Hugo Authors. All rights reserved.
|
|
|
|
|
//
|
|
|
|
|
// 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
|
2017-03-19 14:25:32 +00:00
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
2017-03-03 09:47:43 +00:00
|
|
|
//
|
|
|
|
|
// 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.
|
|
|
|
|
|
|
|
|
|
package hugolib
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"bytes"
|
2017-03-16 08:09:26 +00:00
|
|
|
"fmt"
|
2017-03-03 09:47:43 +00:00
|
|
|
"html/template"
|
|
|
|
|
"io"
|
2017-03-16 08:09:26 +00:00
|
|
|
"path/filepath"
|
|
|
|
|
"runtime"
|
|
|
|
|
"strings"
|
|
|
|
|
|
2017-06-13 16:42:45 +00:00
|
|
|
"github.com/gohugoio/hugo/tpl"
|
2017-03-27 18:43:49 +00:00
|
|
|
|
2017-03-16 08:09:26 +00:00
|
|
|
jww "github.com/spf13/jwalterweatherman"
|
|
|
|
|
|
2017-06-13 16:42:45 +00:00
|
|
|
"github.com/gohugoio/hugo/helpers"
|
2017-03-03 09:47:43 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
const (
|
2017-06-08 21:12:39 +00:00
|
|
|
alias = "<!DOCTYPE html><html><head><title>{{ .Permalink }}</title><link rel=\"canonical\" href=\"{{ .Permalink }}\"/><meta name=\"robots\" content=\"noindex\"><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 name=\"robots\" content=\"noindex\"><meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\" /><meta http-equiv=\"refresh\" content=\"0; url={{ .Permalink }}\" /></head></html>"
|
2017-03-03 09:47:43 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
var defaultAliasTemplates *template.Template
|
|
|
|
|
|
|
|
|
|
func init() {
|
2017-03-27 18:43:49 +00:00
|
|
|
//TODO(bep) consolidate
|
2017-03-03 09:47:43 +00:00
|
|
|
defaultAliasTemplates = template.New("")
|
|
|
|
|
template.Must(defaultAliasTemplates.New("alias").Parse(alias))
|
|
|
|
|
template.Must(defaultAliasTemplates.New("alias-xhtml").Parse(aliasXHtml))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
type aliasHandler struct {
|
2017-04-30 19:52:56 +00:00
|
|
|
t tpl.TemplateFinder
|
2017-03-16 09:04:30 +00:00
|
|
|
log *jww.Notepad
|
|
|
|
|
allowRoot bool
|
2017-03-03 09:47:43 +00:00
|
|
|
}
|
|
|
|
|
|
2017-04-30 19:52:56 +00:00
|
|
|
func newAliasHandler(t tpl.TemplateFinder, l *jww.Notepad, allowRoot bool) aliasHandler {
|
2017-03-16 09:04:30 +00:00
|
|
|
return aliasHandler{t, l, allowRoot}
|
2017-03-03 09:47:43 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (a aliasHandler) renderAlias(isXHTML bool, permalink string, page *Page) (io.Reader, error) {
|
|
|
|
|
t := "alias"
|
|
|
|
|
if isXHTML {
|
|
|
|
|
t = "alias-xhtml"
|
|
|
|
|
}
|
|
|
|
|
|
Add Hugo Piper with SCSS support and much more
Before this commit, you would have to use page bundles to do image processing etc. in Hugo.
This commit adds
* A new `/assets` top-level project or theme dir (configurable via `assetDir`)
* A new template func, `resources.Get` which can be used to "get a resource" that can be further processed.
This means that you can now do this in your templates (or shortcodes):
```bash
{{ $sunset := (resources.Get "images/sunset.jpg").Fill "300x200" }}
```
This also adds a new `extended` build tag that enables powerful SCSS/SASS support with source maps. To compile this from source, you will also need a C compiler installed:
```
HUGO_BUILD_TAGS=extended mage install
```
Note that you can use output of the SCSS processing later in a non-SCSSS-enabled Hugo.
The `SCSS` processor is a _Resource transformation step_ and it can be chained with the many others in a pipeline:
```bash
{{ $css := resources.Get "styles.scss" | resources.ToCSS | resources.PostCSS | resources.Minify | resources.Fingerprint }}
<link rel="stylesheet" href="{{ $styles.RelPermalink }}" integrity="{{ $styles.Data.Digest }}" media="screen">
```
The transformation funcs above have aliases, so it can be shortened to:
```bash
{{ $css := resources.Get "styles.scss" | toCSS | postCSS | minify | fingerprint }}
<link rel="stylesheet" href="{{ $styles.RelPermalink }}" integrity="{{ $styles.Data.Digest }}" media="screen">
```
A quick tip would be to avoid the fingerprinting part, and possibly also the not-superfast `postCSS` when you're doing development, as it allows Hugo to be smarter about the rebuilding.
Documentation will follow, but have a look at the demo repo in https://github.com/bep/hugo-sass-test
New functions to create `Resource` objects:
* `resources.Get` (see above)
* `resources.FromString`: Create a Resource from a string.
New `Resource` transformation funcs:
* `resources.ToCSS`: Compile `SCSS` or `SASS` into `CSS`.
* `resources.PostCSS`: Process your CSS with PostCSS. Config file support (project or theme or passed as an option).
* `resources.Minify`: Currently supports `css`, `js`, `json`, `html`, `svg`, `xml`.
* `resources.Fingerprint`: Creates a fingerprinted version of the given Resource with Subresource Integrity..
* `resources.Concat`: Concatenates a list of Resource objects. Think of this as a poor man's bundler.
* `resources.ExecuteAsTemplate`: Parses and executes the given Resource and data context (e.g. .Site) as a Go template.
Fixes #4381
Fixes #4903
Fixes #4858
2018-02-20 09:02:14 +00:00
|
|
|
var templ tpl.Template
|
|
|
|
|
var found bool
|
2017-03-27 18:43:49 +00:00
|
|
|
|
|
|
|
|
if a.t != nil {
|
Add Hugo Piper with SCSS support and much more
Before this commit, you would have to use page bundles to do image processing etc. in Hugo.
This commit adds
* A new `/assets` top-level project or theme dir (configurable via `assetDir`)
* A new template func, `resources.Get` which can be used to "get a resource" that can be further processed.
This means that you can now do this in your templates (or shortcodes):
```bash
{{ $sunset := (resources.Get "images/sunset.jpg").Fill "300x200" }}
```
This also adds a new `extended` build tag that enables powerful SCSS/SASS support with source maps. To compile this from source, you will also need a C compiler installed:
```
HUGO_BUILD_TAGS=extended mage install
```
Note that you can use output of the SCSS processing later in a non-SCSSS-enabled Hugo.
The `SCSS` processor is a _Resource transformation step_ and it can be chained with the many others in a pipeline:
```bash
{{ $css := resources.Get "styles.scss" | resources.ToCSS | resources.PostCSS | resources.Minify | resources.Fingerprint }}
<link rel="stylesheet" href="{{ $styles.RelPermalink }}" integrity="{{ $styles.Data.Digest }}" media="screen">
```
The transformation funcs above have aliases, so it can be shortened to:
```bash
{{ $css := resources.Get "styles.scss" | toCSS | postCSS | minify | fingerprint }}
<link rel="stylesheet" href="{{ $styles.RelPermalink }}" integrity="{{ $styles.Data.Digest }}" media="screen">
```
A quick tip would be to avoid the fingerprinting part, and possibly also the not-superfast `postCSS` when you're doing development, as it allows Hugo to be smarter about the rebuilding.
Documentation will follow, but have a look at the demo repo in https://github.com/bep/hugo-sass-test
New functions to create `Resource` objects:
* `resources.Get` (see above)
* `resources.FromString`: Create a Resource from a string.
New `Resource` transformation funcs:
* `resources.ToCSS`: Compile `SCSS` or `SASS` into `CSS`.
* `resources.PostCSS`: Process your CSS with PostCSS. Config file support (project or theme or passed as an option).
* `resources.Minify`: Currently supports `css`, `js`, `json`, `html`, `svg`, `xml`.
* `resources.Fingerprint`: Creates a fingerprinted version of the given Resource with Subresource Integrity..
* `resources.Concat`: Concatenates a list of Resource objects. Think of this as a poor man's bundler.
* `resources.ExecuteAsTemplate`: Parses and executes the given Resource and data context (e.g. .Site) as a Go template.
Fixes #4381
Fixes #4903
Fixes #4858
2018-02-20 09:02:14 +00:00
|
|
|
templ, found = a.t.Lookup("alias.html")
|
2017-03-03 09:47:43 +00:00
|
|
|
}
|
|
|
|
|
|
Add Hugo Piper with SCSS support and much more
Before this commit, you would have to use page bundles to do image processing etc. in Hugo.
This commit adds
* A new `/assets` top-level project or theme dir (configurable via `assetDir`)
* A new template func, `resources.Get` which can be used to "get a resource" that can be further processed.
This means that you can now do this in your templates (or shortcodes):
```bash
{{ $sunset := (resources.Get "images/sunset.jpg").Fill "300x200" }}
```
This also adds a new `extended` build tag that enables powerful SCSS/SASS support with source maps. To compile this from source, you will also need a C compiler installed:
```
HUGO_BUILD_TAGS=extended mage install
```
Note that you can use output of the SCSS processing later in a non-SCSSS-enabled Hugo.
The `SCSS` processor is a _Resource transformation step_ and it can be chained with the many others in a pipeline:
```bash
{{ $css := resources.Get "styles.scss" | resources.ToCSS | resources.PostCSS | resources.Minify | resources.Fingerprint }}
<link rel="stylesheet" href="{{ $styles.RelPermalink }}" integrity="{{ $styles.Data.Digest }}" media="screen">
```
The transformation funcs above have aliases, so it can be shortened to:
```bash
{{ $css := resources.Get "styles.scss" | toCSS | postCSS | minify | fingerprint }}
<link rel="stylesheet" href="{{ $styles.RelPermalink }}" integrity="{{ $styles.Data.Digest }}" media="screen">
```
A quick tip would be to avoid the fingerprinting part, and possibly also the not-superfast `postCSS` when you're doing development, as it allows Hugo to be smarter about the rebuilding.
Documentation will follow, but have a look at the demo repo in https://github.com/bep/hugo-sass-test
New functions to create `Resource` objects:
* `resources.Get` (see above)
* `resources.FromString`: Create a Resource from a string.
New `Resource` transformation funcs:
* `resources.ToCSS`: Compile `SCSS` or `SASS` into `CSS`.
* `resources.PostCSS`: Process your CSS with PostCSS. Config file support (project or theme or passed as an option).
* `resources.Minify`: Currently supports `css`, `js`, `json`, `html`, `svg`, `xml`.
* `resources.Fingerprint`: Creates a fingerprinted version of the given Resource with Subresource Integrity..
* `resources.Concat`: Concatenates a list of Resource objects. Think of this as a poor man's bundler.
* `resources.ExecuteAsTemplate`: Parses and executes the given Resource and data context (e.g. .Site) as a Go template.
Fixes #4381
Fixes #4903
Fixes #4858
2018-02-20 09:02:14 +00:00
|
|
|
if !found {
|
2017-03-27 18:43:49 +00:00
|
|
|
def := defaultAliasTemplates.Lookup(t)
|
|
|
|
|
if def != nil {
|
|
|
|
|
templ = &tpl.TemplateAdapter{Template: def}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
}
|
2017-03-03 09:47:43 +00:00
|
|
|
data := struct {
|
|
|
|
|
Permalink string
|
|
|
|
|
Page *Page
|
|
|
|
|
}{
|
|
|
|
|
permalink,
|
|
|
|
|
page,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
buffer := new(bytes.Buffer)
|
2017-03-27 18:43:49 +00:00
|
|
|
err := templ.Execute(buffer, data)
|
2017-03-03 09:47:43 +00:00
|
|
|
if err != nil {
|
|
|
|
|
return nil, err
|
|
|
|
|
}
|
|
|
|
|
return buffer, nil
|
|
|
|
|
}
|
2017-03-16 08:09:26 +00:00
|
|
|
|
|
|
|
|
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) {
|
2017-03-27 18:43:49 +00:00
|
|
|
handler := newAliasHandler(s.Tmpl, s.Log, allowRoot)
|
2017-03-16 08:09:26 +00:00
|
|
|
|
|
|
|
|
isXHTML := strings.HasSuffix(path, ".xhtml")
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
}
|
|
|
|
|
|
:sparkles: Implement Page bundling and image handling
This commit is not the smallest in Hugo's history.
Some hightlights include:
* Page bundles (for complete articles, keeping images and content together etc.).
* Bundled images can be processed in as many versions/sizes as you need with the three methods `Resize`, `Fill` and `Fit`.
* Processed images are cached inside `resources/_gen/images` (default) in your project.
* Symbolic links (both files and dirs) are now allowed anywhere inside /content
* A new table based build summary
* The "Total in nn ms" now reports the total including the handling of the files inside /static. So if it now reports more than you're used to, it is just **more real** and probably faster than before (see below).
A site building benchmark run compared to `v0.31.1` shows that this should be slightly faster and use less memory:
```bash
▶ ./benchSite.sh "TOML,num_langs=.*,num_root_sections=5,num_pages=(500|1000),tags_per_page=5,shortcodes,render"
benchmark old ns/op new ns/op delta
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 101785785 78067944 -23.30%
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 185481057 149159919 -19.58%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 103149918 85679409 -16.94%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 203515478 169208775 -16.86%
benchmark old allocs new allocs delta
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 532464 391539 -26.47%
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 1056549 772702 -26.87%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 555974 406630 -26.86%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 1086545 789922 -27.30%
benchmark old bytes new bytes delta
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 53243246 43598155 -18.12%
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 105811617 86087116 -18.64%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 54558852 44545097 -18.35%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 106903858 86978413 -18.64%
```
Fixes #3651
Closes #3158
Fixes #1014
Closes #2021
Fixes #1240
Updates #3757
2017-07-24 07:00:23 +00:00
|
|
|
return s.publish(&s.PathSpec.ProcessingStats.Aliases, targetPath, aliasContent)
|
2017-03-16 08:09:26 +00:00
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
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)
|
|
|
|
|
}
|
|
|
|
|
|
2017-03-16 09:04:30 +00:00
|
|
|
return alias, nil
|
2017-03-16 08:09:26 +00:00
|
|
|
}
|
