// Copyright 2018 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 langs import ( "sort" "strings" "github.com/gohugoio/hugo/common/maps" "github.com/gohugoio/hugo/config" "github.com/spf13/cast" ) // These are the settings that should only be looked up in the global Viper // config and not per language. // This list may not be complete, but contains only settings that we know // will be looked up in both. // This isn't perfect, but it is ultimately the user who shoots him/herself in // the foot. // See the pathSpec. var globalOnlySettings = map[string]bool{ strings.ToLower("defaultContentLanguageInSubdir"): true, strings.ToLower("defaultContentLanguage"): true, strings.ToLower("multilingual"): true, strings.ToLower("assetDir"): true, strings.ToLower("resourceDir"): true, } // Language manages specific-language configuration. type Language struct { Lang string LanguageName string Title string Weight int Disabled bool // If set per language, this tells Hugo that all content files without any // language indicator (e.g. my-page.en.md) is in this language. // This is usually a path relative to the working dir, but it can be an // absolute directory reference. It is what we get. ContentDir string Cfg config.Provider // These are params declared in the [params] section of the language merged with the // site's params, the most specific (language) wins on duplicate keys. params map[string]interface{} // These are config values, i.e. the settings declared outside of the [params] section of the language. // This is the map Hugo looks in when looking for configuration values (baseURL etc.). // Values in this map can also be fetched from the params map above. settings map[string]interface{} } func (l *Language) String() string { return l.Lang } // NewLanguage creates a new language. func NewLanguage(lang string, cfg config.Provider) *Language { // Note that language specific params will be overridden later. // We should improve that, but we need to make a copy: params := make(map[string]interface{}) for k, v := range cfg.GetStringMap("params") { params[k] = v } maps.ToLower(params) l := &Language{Lang: lang, ContentDir: cfg.GetString("contentDir"), Cfg: cfg, params: params, settings: make(map[string]interface{})} return l } // NewDefaultLanguage creates the default language for a config.Provider. // If not otherwise specified the default is "en". func NewDefaultLanguage(cfg config.Provider) *Language { defaultLang := cfg.GetString("defaultContentLanguage") if defaultLang == "" { defaultLang = "en" } return NewLanguage(defaultLang, cfg) } // Languages is a sortable list of languages. type Languages []*Language // NewLanguages creates a sorted list of languages. // NOTE: function is currently unused. func NewLanguages(l ...*Language) Languages { languages := make(Languages, len(l)) for i := 0; i < len(l); i++ { languages[i] = l[i] } sort.Sort(languages) return languages } func (l Languages) Len() int { return len(l) } func (l Languages) Less(i, j int) bool { wi, wj := l[i].Weight, l[j].Weight if wi == wj { return l[i].Lang < l[j].Lang } return wj == 0 || wi < wj } func (l Languages) Swap(i, j int) { l[i], l[j] = l[j], l[i] } // Params retunrs language-specific params merged with the global params. func (l *Language) Params() map[string]interface{} { return l.params } func (l Languages) AsSet() map[string]bool { m := make(map[string]bool) for _, lang := range l { m[lang.Lang] = true } return m } func (l Languages) AsOrdinalSet() map[string]int { m := make(map[string]int) for i, lang := range l { m[lang.Lang] = i } return m } // IsMultihost returns whether there are more than one language and at least one of // the languages has baseURL specificed on the language level. func (l Languages) IsMultihost() bool { if len(l) <= 1 { return false } for _, lang := range l { if lang.GetLocal("baseURL") != nil { return true } } return false } // SetParam sets a param with the given key and value. // SetParam is case-insensitive. func (l *Language) SetParam(k string, v interface{}) { l.params[strings.ToLower(k)] = v } // GetBool returns the value associated with the key as a boolean. func (l *Language) GetBool(key string) bool { return cast.ToBool(l.Get(key)) } // GetString returns the value associated with the key as a string. func (l *Language) GetString(key string) string { return cast.ToString(l.Get(key)) } // GetInt returns the value associated with the key as an int. func (l *Language) GetInt(key string) int { return cast.ToInt(l.Get(key)) } // GetStringMap returns the value associated with the key as a map of interfaces. func (l *Language) GetStringMap(key string) map[string]interface{} { return cast.ToStringMap(l.Get(key)) } // GetStringMapString returns the value associated with the key as a map of strings. func (l *Language) GetStringMapString(key string) map[string]string { return cast.ToStringMapString(l.Get(key)) } // GetStringSlice returns the value associated with the key as a slice of strings. func (l *Language) GetStringSlice(key string) []string { return cast.ToStringSlice(l.Get(key)) } // Get returns a value associated with the key relying on specified language. // Get is case-insensitive for a key. // // Get returns an interface. For a specific value use one of the Get____ methods. func (l *Language) Get(key string) interface{} { local := l.GetLocal(key) if local != nil { return local } return l.Cfg.Get(key) } // GetLocal gets a configuration value set on language level. It will // not fall back to any global value. // It will return nil if a value with the given key cannot be found. func (l *Language) GetLocal(key string) interface{} { if l == nil { panic("language not set") } key = strings.ToLower(key) if !globalOnlySettings[key] { if v, ok := l.settings[key]; ok { return v } } return nil } // Set sets the value for the key in the language's params. func (l *Language) Set(key string, value interface{}) { if l == nil { panic("language not set") } key = strings.ToLower(key) l.settings[key] = value } // IsSet checks whether the key is set in the language or the related config store. func (l *Language) IsSet(key string) bool { key = strings.ToLower(key) key = strings.ToLower(key) if !globalOnlySettings[key] { if _, ok := l.settings[key]; ok { return true } } return l.Cfg.IsSet(key) }