mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-21 20:46:30 -05:00
87 lines
2.5 KiB
Go
87 lines
2.5 KiB
Go
// 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 (
|
|
"strings"
|
|
|
|
"github.com/gohugoio/hugo/common/loggers"
|
|
"github.com/gohugoio/hugo/config"
|
|
"github.com/gohugoio/hugo/hugofs"
|
|
"github.com/gohugoio/hugo/hugolib/filesystems"
|
|
"github.com/gohugoio/hugo/hugolib/paths"
|
|
)
|
|
|
|
// PathSpec holds methods that decides how paths in URLs and files in Hugo should look like.
|
|
type PathSpec struct {
|
|
*paths.Paths
|
|
*filesystems.BaseFs
|
|
|
|
ProcessingStats *ProcessingStats
|
|
|
|
// The file systems to use
|
|
Fs *hugofs.Fs
|
|
|
|
// The config provider to use
|
|
Cfg config.Provider
|
|
}
|
|
|
|
// NewPathSpec creates a new PathSpec from the given filesystems and language.
|
|
func NewPathSpec(fs *hugofs.Fs, cfg config.Provider, logger loggers.Logger) (*PathSpec, error) {
|
|
return NewPathSpecWithBaseBaseFsProvided(fs, cfg, logger, nil)
|
|
}
|
|
|
|
// NewPathSpecWithBaseBaseFsProvided creates a new PathSpec from the given filesystems and language.
|
|
// If an existing BaseFs is provided, parts of that is reused.
|
|
func NewPathSpecWithBaseBaseFsProvided(fs *hugofs.Fs, cfg config.Provider, logger loggers.Logger, baseBaseFs *filesystems.BaseFs) (*PathSpec, error) {
|
|
p, err := paths.New(fs, cfg)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var options []func(*filesystems.BaseFs) error
|
|
if baseBaseFs != nil {
|
|
options = []func(*filesystems.BaseFs) error{
|
|
filesystems.WithBaseFs(baseBaseFs),
|
|
}
|
|
}
|
|
bfs, err := filesystems.NewBase(p, logger, options...)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
ps := &PathSpec{
|
|
Paths: p,
|
|
BaseFs: bfs,
|
|
Fs: fs,
|
|
Cfg: cfg,
|
|
ProcessingStats: NewProcessingStats(p.Lang()),
|
|
}
|
|
|
|
basePath := ps.BaseURL.Path()
|
|
if basePath != "" && basePath != "/" {
|
|
ps.BasePath = basePath
|
|
}
|
|
|
|
return ps, nil
|
|
}
|
|
|
|
// PermalinkForBaseURL creates a permalink from the given link and baseURL.
|
|
func (p *PathSpec) PermalinkForBaseURL(link, baseURL string) string {
|
|
link = strings.TrimPrefix(link, "/")
|
|
if !strings.HasSuffix(baseURL, "/") {
|
|
baseURL += "/"
|
|
}
|
|
return baseURL + link
|
|
}
|