// Copyright 2016-present 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 helpers import ( "fmt" "github.com/spf13/hugo/config" "github.com/spf13/hugo/hugofs" ) // PathSpec holds methods that decides how paths in URLs and files in Hugo should look like. type PathSpec struct { BaseURL disablePathToLower bool removePathAccents bool uglyURLs bool canonifyURLs bool language *Language // pagination path handling paginatePath string theme string // Directories themesDir string layoutDir string workingDir string staticDir string // The PathSpec looks up its config settings in both the current language // and then in the global Viper config. // Some settings, the settings listed below, does not make sense to be set // on per-language-basis. We have no good way of protecting against this // other than a "white-list". See language.go. defaultContentLanguageInSubdir bool defaultContentLanguage string multilingual bool // The file systems to use fs *hugofs.Fs } func (p PathSpec) String() string { return fmt.Sprintf("PathSpec, language %q, prefix %q, multilingual: %T", p.language.Lang, p.getLanguagePrefix(), p.multilingual) } // NewPathSpec creats a new PathSpec from the given filesystems and Language. func NewPathSpec(fs *hugofs.Fs, cfg config.Provider) *PathSpec { // TODO(bep) output error handling baseURL, _ := newBaseURLFromString(cfg.GetString("baseURL")) ps := &PathSpec{ fs: fs, disablePathToLower: cfg.GetBool("disablePathToLower"), removePathAccents: cfg.GetBool("removePathAccents"), uglyURLs: cfg.GetBool("uglyURLs"), canonifyURLs: cfg.GetBool("canonifyURLs"), multilingual: cfg.GetBool("multilingual"), defaultContentLanguageInSubdir: cfg.GetBool("defaultContentLanguageInSubdir"), defaultContentLanguage: cfg.GetString("defaultContentLanguage"), paginatePath: cfg.GetString("paginatePath"), BaseURL: baseURL, themesDir: cfg.GetString("themesDir"), layoutDir: cfg.GetString("layoutDir"), workingDir: cfg.GetString("workingDir"), staticDir: cfg.GetString("staticDir"), theme: cfg.GetString("theme"), } if language, ok := cfg.(*Language); ok { ps.language = language } return ps } // PaginatePath returns the configured root path used for paginator pages. func (p *PathSpec) PaginatePath() string { return p.paginatePath }