summaryrefslogtreecommitdiffstats
path: root/hugolib/paths/themes.go
blob: a526953f16efd6602b3264ed47ab7e65f82ef058 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
// Copyright 2019 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
// 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 paths

import (
	"path/filepath"
	"strings"

	"github.com/gohugoio/hugo/config"
	"github.com/spf13/afero"
	"github.com/spf13/cast"
)

type ThemeConfig struct {
	// The theme name as provided by the folder name below /themes.
	Name string

	// Optional configuration filename (e.g. "/themes/mytheme/config.json").
	ConfigFilename string

	// Optional config read from the ConfigFile above.
	Cfg config.Provider
}

// Create file system, an ordered theme list from left to right, no duplicates.
type themesCollector struct {
	themesDir string
	fs        afero.Fs
	seen      map[string]bool
	themes    []ThemeConfig
}

func (c *themesCollector) isSeen(theme string) bool {
	loki := strings.ToLower(theme)
	if c.seen[loki] {
		return true
	}
	c.seen[loki] = true
	return false
}

func (c *themesCollector) addAndRecurse(themes ...string) error {
	for i := 0; i < len(themes); i++ {
		theme := themes[i]
		configFilename := c.getConfigFileIfProvided(theme)
		if !c.isSeen(theme) {
			tc, err := c.add(theme, configFilename)
			if err != nil {
				return err
			}
			if err := c.addThemeNamesFromTheme(tc); err != nil {
				return err
			}
		}
	}
	return nil
}

func (c *themesCollector) add(name, configFilename string) (ThemeConfig, error) {
	var cfg config.Provider
	var tc ThemeConfig

	if configFilename != "" {
		var err error
		cfg, err = config.FromFile(c.fs, configFilename)
		if err != nil {
			return tc, err
		}
	}

	tc = ThemeConfig{Name: name, ConfigFilename: configFilename, Cfg: cfg}
	c.themes = append(c.themes, tc)
	return tc, nil

}

func collectThemeNames(p *Paths) ([]ThemeConfig, error) {
	return CollectThemes(p.Fs.Source, p.AbsPathify(p.ThemesDir), p.Themes())

}

func CollectThemes(fs afero.Fs, themesDir string, themes []string) ([]ThemeConfig, error) {
	if len(themes) == 0 {
		return nil, nil
	}

	c := &themesCollector{
		fs:        fs,
		themesDir: themesDir,
		seen:      make(map[string]bool)}

	for i := 0; i < len(themes); i++ {
		theme := themes[i]
		if err := c.addAndRecurse(theme); err != nil {
			return nil, err
		}
	}

	return c.themes, nil

}

func (c *themesCollector) getConfigFileIfProvided(theme string) string {
	configDir := filepath.Join(c.themesDir, theme)

	var (
		configFilename string
		exists         bool
	)

	// Viper supports more, but this is the sub-set supported by Hugo.
	for _, configFormats := range config.ValidConfigFileExtensions {
		configFilename = filepath.Join(configDir, "config."+configFormats)
		exists, _ = afero.Exists(c.fs, configFilename)
		if exists {
			break
		}
	}

	if !exists {
		// No theme config set.
		return ""
	}

	return configFilename

}

func (c *themesCollector) addThemeNamesFromTheme(theme ThemeConfig) error {
	if theme.Cfg != nil && theme.Cfg.IsSet("theme") {
		v := theme.Cfg.Get("theme")
		switch vv := v.(type) {
		case []string:
			return c.addAndRecurse(vv...)
		case []interface{}:
			return c.addAndRecurse(cast.ToStringSlice(vv)...)
		default:
			return c.addAndRecurse(cast.ToString(vv))
		}
	}

	return nil
}