2019-01-02 06:33:26 -05:00
|
|
|
// Copyright 2019 The Hugo Authors. All rights reserved.
|
2016-10-15 07:35:32 -04: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.
|
|
|
|
|
|
|
|
|
|
package hugolib
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"path/filepath"
|
2017-03-16 05:04:30 -04:00
|
|
|
"runtime"
|
2016-10-15 07:35:32 -04:00
|
|
|
"testing"
|
2017-01-10 04:55:03 -05:00
|
|
|
|
Add support for theme composition and inheritance
This commit adds support for theme composition and inheritance in Hugo.
With this, it helps thinking about a theme as a set of ordered components:
```toml
theme = ["my-shortcodes", "base-theme", "hyde"]
```
The theme definition example above in `config.toml` creates a theme with the 3 components with presedence from left to right.
So, Hugo will, for any given file, data entry etc., look first in the project, and then in `my-shortcode`, `base-theme` and lastly `hyde`.
Hugo uses two different algorithms to merge the filesystems, depending on the file type:
* For `i18n` and `data` files, Hugo merges deeply using the translation id and data key inside the files.
* For `static`, `layouts` (templates) and `archetypes` files, these are merged on file level. So the left-most file will be chosen.
The name used in the `theme` definition above must match a folder in `/your-site/themes`, e.g. `/your-site/themes/my-shortcodes`. There are plans to improve on this and get a URL scheme so this can be resolved automatically.
Also note that a component that is part of a theme can have its own configuration file, e.g. `config.toml`. There are currently some restrictions to what a theme component can configure:
* `params` (global and per language)
* `menu` (global and per language)
* `outputformats` and `mediatypes`
The same rules apply here: The left-most param/menu etc. with the same ID will win. There are some hidden and experimental namespace support in the above, which we will work to improve in the future, but theme authors are encouraged to create their own namespaces to avoid naming conflicts.
A final note: Themes/components can also have a `theme` definition in their `config.toml` and similar, which is the "inheritance" part of this commit's title. This is currently not supported by the Hugo theme site. We will have to wait for some "auto dependency" feature to be implemented for that to happen, but this can be a powerful feature if you want to create your own theme-variant based on others.
Fixes #4460
Fixes #4450
2018-03-01 09:01:25 -05:00
|
|
|
"github.com/gohugoio/hugo/common/loggers"
|
|
|
|
|
|
2019-08-10 15:05:17 -04:00
|
|
|
qt "github.com/frankban/quicktest"
|
2016-10-15 07:35:32 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
const pageWithAlias = `---
|
|
|
|
|
title: Has Alias
|
2019-03-30 12:08:25 -04:00
|
|
|
aliases: ["/foo/bar/", "rel"]
|
2016-10-15 07:35:32 -04:00
|
|
|
---
|
|
|
|
|
For some moments the old man did not reply. He stood with bowed head, buried in deep thought. But at last he spoke.
|
|
|
|
|
`
|
|
|
|
|
|
2017-03-24 06:25:25 -04:00
|
|
|
const pageWithAliasMultipleOutputs = `---
|
|
|
|
|
title: Has Alias for HTML and AMP
|
2019-03-30 12:08:25 -04:00
|
|
|
aliases: ["/foo/bar/"]
|
2017-03-24 06:25:25 -04:00
|
|
|
outputs: ["HTML", "AMP", "JSON"]
|
|
|
|
|
---
|
|
|
|
|
For some moments the old man did not reply. He stood with bowed head, buried in deep thought. But at last he spoke.
|
|
|
|
|
`
|
|
|
|
|
|
2020-12-02 07:23:25 -05:00
|
|
|
const (
|
|
|
|
|
basicTemplate = "<html><body>{{.Content}}</body></html>"
|
|
|
|
|
aliasTemplate = "<html><body>ALIASTEMPLATE</body></html>"
|
|
|
|
|
)
|
2016-10-15 07:35:32 -04:00
|
|
|
|
|
|
|
|
func TestAlias(t *testing.T) {
|
2017-02-04 22:20:06 -05:00
|
|
|
t.Parallel()
|
2019-08-10 15:05:17 -04:00
|
|
|
c := qt.New(t)
|
2016-10-15 07:35:32 -04:00
|
|
|
|
2020-06-14 05:14:56 -04:00
|
|
|
tests := []struct {
|
2020-06-14 17:33:00 -04:00
|
|
|
fileSuffix string
|
|
|
|
|
urlPrefix string
|
|
|
|
|
urlSuffix string
|
|
|
|
|
settings map[string]interface{}
|
2020-06-14 05:14:56 -04:00
|
|
|
}{
|
2020-06-14 17:33:00 -04:00
|
|
|
{"/index.html", "http://example.com", "/", map[string]interface{}{"baseURL": "http://example.com"}},
|
2020-06-16 19:05:53 -04:00
|
|
|
{"/index.html", "http://example.com/some/path", "/", map[string]interface{}{"baseURL": "http://example.com/some/path"}},
|
2020-06-14 17:33:00 -04:00
|
|
|
{"/index.html", "http://example.com", "/", map[string]interface{}{"baseURL": "http://example.com", "canonifyURLs": true}},
|
|
|
|
|
{"/index.html", "../..", "/", map[string]interface{}{"relativeURLs": true}},
|
|
|
|
|
{".html", "", ".html", map[string]interface{}{"uglyURLs": true}},
|
2020-06-14 05:14:56 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
for _, test := range tests {
|
|
|
|
|
b := newTestSitesBuilder(t)
|
|
|
|
|
b.WithSimpleConfigFileAndSettings(test.settings).WithContent("blog/page.md", pageWithAlias)
|
|
|
|
|
b.CreateSites().Build(BuildCfg{})
|
|
|
|
|
|
|
|
|
|
c.Assert(len(b.H.Sites), qt.Equals, 1)
|
|
|
|
|
c.Assert(len(b.H.Sites[0].RegularPages()), qt.Equals, 1)
|
|
|
|
|
|
|
|
|
|
// the real page
|
2020-06-14 17:33:00 -04:00
|
|
|
b.AssertFileContent("public/blog/page"+test.fileSuffix, "For some moments the old man")
|
2020-06-14 05:14:56 -04:00
|
|
|
// the alias redirectors
|
2022-03-01 23:27:52 -05:00
|
|
|
b.AssertFileContent("public/foo/bar"+test.fileSuffix, "<meta http-equiv=\"refresh\" content=\"0; url="+test.urlPrefix+"/blog/page"+test.urlSuffix+"\">")
|
|
|
|
|
b.AssertFileContent("public/blog/rel"+test.fileSuffix, "<meta http-equiv=\"refresh\" content=\"0; url="+test.urlPrefix+"/blog/page"+test.urlSuffix+"\">")
|
2020-06-14 05:14:56 -04:00
|
|
|
}
|
2016-10-15 07:35:32 -04:00
|
|
|
}
|
|
|
|
|
|
2017-03-24 06:25:25 -04:00
|
|
|
func TestAliasMultipleOutputFormats(t *testing.T) {
|
|
|
|
|
t.Parallel()
|
|
|
|
|
|
2019-08-10 15:05:17 -04:00
|
|
|
c := qt.New(t)
|
2018-03-17 14:24:02 -04:00
|
|
|
|
|
|
|
|
b := newTestSitesBuilder(t)
|
2019-03-30 12:08:25 -04:00
|
|
|
b.WithSimpleConfigFile().WithContent("blog/page.md", pageWithAliasMultipleOutputs)
|
2017-03-24 06:25:25 -04:00
|
|
|
|
2018-03-17 14:24:02 -04:00
|
|
|
b.WithTemplates(
|
|
|
|
|
"_default/single.html", basicTemplate,
|
|
|
|
|
"_default/single.amp.html", basicTemplate,
|
|
|
|
|
"_default/single.json", basicTemplate)
|
2017-03-24 06:25:25 -04:00
|
|
|
|
2018-03-17 14:24:02 -04:00
|
|
|
b.CreateSites().Build(BuildCfg{})
|
2017-03-24 06:25:25 -04:00
|
|
|
|
|
|
|
|
// the real pages
|
2019-03-30 12:08:25 -04:00
|
|
|
b.AssertFileContent("public/blog/page/index.html", "For some moments the old man")
|
|
|
|
|
b.AssertFileContent("public/amp/blog/page/index.html", "For some moments the old man")
|
|
|
|
|
b.AssertFileContent("public/blog/page/index.json", "For some moments the old man")
|
2017-03-24 06:25:25 -04:00
|
|
|
|
|
|
|
|
// the alias redirectors
|
2018-03-17 14:24:02 -04:00
|
|
|
b.AssertFileContent("public/foo/bar/index.html", "<meta http-equiv=\"refresh\" content=\"0; ")
|
2019-03-30 11:46:18 -04:00
|
|
|
b.AssertFileContent("public/amp/foo/bar/index.html", "<meta http-equiv=\"refresh\" content=\"0; ")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(b.CheckExists("public/foo/bar/index.json"), qt.Equals, false)
|
2017-03-24 06:25:25 -04:00
|
|
|
}
|
|
|
|
|
|
2016-10-15 07:35:32 -04:00
|
|
|
func TestAliasTemplate(t *testing.T) {
|
2017-02-04 22:20:06 -05:00
|
|
|
t.Parallel()
|
2016-10-15 07:35:32 -04:00
|
|
|
|
2018-03-17 14:24:02 -04:00
|
|
|
b := newTestSitesBuilder(t)
|
|
|
|
|
b.WithSimpleConfigFile().WithContent("page.md", pageWithAlias).WithTemplatesAdded("alias.html", aliasTemplate)
|
2017-01-10 04:55:03 -05:00
|
|
|
|
2018-03-17 14:24:02 -04:00
|
|
|
b.CreateSites().Build(BuildCfg{})
|
2016-10-15 07:35:32 -04:00
|
|
|
|
|
|
|
|
// the real page
|
2018-03-17 14:24:02 -04:00
|
|
|
b.AssertFileContent("public/page/index.html", "For some moments the old man")
|
2016-10-15 07:35:32 -04:00
|
|
|
// the alias redirector
|
2018-03-17 14:24:02 -04:00
|
|
|
b.AssertFileContent("public/foo/bar/index.html", "ALIASTEMPLATE")
|
2016-10-15 07:35:32 -04:00
|
|
|
}
|
2017-03-16 05:04:30 -04:00
|
|
|
|
|
|
|
|
func TestTargetPathHTMLRedirectAlias(t *testing.T) {
|
Add support for theme composition and inheritance
This commit adds support for theme composition and inheritance in Hugo.
With this, it helps thinking about a theme as a set of ordered components:
```toml
theme = ["my-shortcodes", "base-theme", "hyde"]
```
The theme definition example above in `config.toml` creates a theme with the 3 components with presedence from left to right.
So, Hugo will, for any given file, data entry etc., look first in the project, and then in `my-shortcode`, `base-theme` and lastly `hyde`.
Hugo uses two different algorithms to merge the filesystems, depending on the file type:
* For `i18n` and `data` files, Hugo merges deeply using the translation id and data key inside the files.
* For `static`, `layouts` (templates) and `archetypes` files, these are merged on file level. So the left-most file will be chosen.
The name used in the `theme` definition above must match a folder in `/your-site/themes`, e.g. `/your-site/themes/my-shortcodes`. There are plans to improve on this and get a URL scheme so this can be resolved automatically.
Also note that a component that is part of a theme can have its own configuration file, e.g. `config.toml`. There are currently some restrictions to what a theme component can configure:
* `params` (global and per language)
* `menu` (global and per language)
* `outputformats` and `mediatypes`
The same rules apply here: The left-most param/menu etc. with the same ID will win. There are some hidden and experimental namespace support in the above, which we will work to improve in the future, but theme authors are encouraged to create their own namespaces to avoid naming conflicts.
A final note: Themes/components can also have a `theme` definition in their `config.toml` and similar, which is the "inheritance" part of this commit's title. This is currently not supported by the Hugo theme site. We will have to wait for some "auto dependency" feature to be implemented for that to happen, but this can be a powerful feature if you want to create your own theme-variant based on others.
Fixes #4460
Fixes #4450
2018-03-01 09:01:25 -05:00
|
|
|
h := newAliasHandler(nil, loggers.NewErrorLogger(), false)
|
2017-03-16 05:04:30 -04:00
|
|
|
|
|
|
|
|
errIsNilForThisOS := runtime.GOOS != "windows"
|
|
|
|
|
|
|
|
|
|
tests := []struct {
|
|
|
|
|
value string
|
|
|
|
|
expected string
|
|
|
|
|
errIsNil bool
|
|
|
|
|
}{
|
|
|
|
|
{"", "", false},
|
|
|
|
|
{"s", filepath.FromSlash("s/index.html"), true},
|
|
|
|
|
{"/", "", false},
|
|
|
|
|
{"alias 1", filepath.FromSlash("alias 1/index.html"), true},
|
|
|
|
|
{"alias 2/", filepath.FromSlash("alias 2/index.html"), true},
|
|
|
|
|
{"alias 3.html", "alias 3.html", true},
|
|
|
|
|
{"alias4.html", "alias4.html", true},
|
|
|
|
|
{"/alias 5.html", "alias 5.html", true},
|
|
|
|
|
{"/трям.html", "трям.html", true},
|
|
|
|
|
{"../../../../tmp/passwd", "", false},
|
|
|
|
|
{"/foo/../../../../tmp/passwd", filepath.FromSlash("tmp/passwd/index.html"), true},
|
|
|
|
|
{"foo/../../../../tmp/passwd", "", false},
|
|
|
|
|
{"C:\\Windows", filepath.FromSlash("C:\\Windows/index.html"), errIsNilForThisOS},
|
|
|
|
|
{"/trailing-space /", filepath.FromSlash("trailing-space /index.html"), errIsNilForThisOS},
|
|
|
|
|
{"/trailing-period./", filepath.FromSlash("trailing-period./index.html"), errIsNilForThisOS},
|
|
|
|
|
{"/tab\tseparated/", filepath.FromSlash("tab\tseparated/index.html"), errIsNilForThisOS},
|
|
|
|
|
{"/chrome/?p=help&ctx=keyboard#topic=3227046", filepath.FromSlash("chrome/?p=help&ctx=keyboard#topic=3227046/index.html"), errIsNilForThisOS},
|
|
|
|
|
{"/LPT1/Printer/", filepath.FromSlash("LPT1/Printer/index.html"), errIsNilForThisOS},
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
for _, test := range tests {
|
|
|
|
|
path, err := h.targetPathAlias(test.value)
|
|
|
|
|
if (err == nil) != test.errIsNil {
|
|
|
|
|
t.Errorf("Expected err == nil => %t, got: %t. err: %s", test.errIsNil, err == nil, err)
|
|
|
|
|
continue
|
|
|
|
|
}
|
|
|
|
|
if err == nil && path != test.expected {
|
2019-03-30 12:08:25 -04:00
|
|
|
t.Errorf("Expected: %q, got: %q", test.expected, path)
|
2017-03-16 05:04:30 -04:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
