hugo/hugolib/page__paths.go
2024-02-18 12:16:30 +01:00

167 lines
4.5 KiB
Go

// 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 hugolib
import (
"net/url"
"strings"
"github.com/gohugoio/hugo/output"
"github.com/gohugoio/hugo/resources/kinds"
"github.com/gohugoio/hugo/resources/page"
)
func newPagePaths(ps *pageState) (pagePaths, error) {
s := ps.s
pm := ps.m
targetPathDescriptor, err := createTargetPathDescriptor(ps)
if err != nil {
return pagePaths{}, err
}
var outputFormats output.Formats
if ps.m.isStandalone() {
outputFormats = output.Formats{ps.m.standaloneOutputFormat}
} else {
outputFormats = pm.outputFormats()
if len(outputFormats) == 0 {
return pagePaths{}, nil
}
if pm.noRender() {
outputFormats = outputFormats[:1]
}
}
pageOutputFormats := make(page.OutputFormats, len(outputFormats))
targets := make(map[string]targetPathsHolder)
for i, f := range outputFormats {
desc := targetPathDescriptor
desc.Type = f
paths := page.CreateTargetPaths(desc)
var relPermalink, permalink string
// If a page is headless or bundled in another,
// it will not get published on its own and it will have no links.
// We also check the build options if it's set to not render or have
// a link.
if !pm.noLink() && !pm.bundled {
relPermalink = paths.RelPermalink(s.PathSpec)
permalink = paths.PermalinkForOutputFormat(s.PathSpec, f)
}
pageOutputFormats[i] = page.NewOutputFormat(relPermalink, permalink, len(outputFormats) == 1, f)
// Use the main format for permalinks, usually HTML.
permalinksIndex := 0
if f.Permalinkable {
// Unless it's permalinkable
permalinksIndex = i
}
targets[f.Name] = targetPathsHolder{
paths: paths,
OutputFormat: pageOutputFormats[permalinksIndex],
}
}
var out page.OutputFormats
if !pm.noLink() {
out = pageOutputFormats
}
return pagePaths{
outputFormats: out,
firstOutputFormat: pageOutputFormats[0],
targetPaths: targets,
targetPathDescriptor: targetPathDescriptor,
}, nil
}
type pagePaths struct {
outputFormats page.OutputFormats
firstOutputFormat page.OutputFormat
targetPaths map[string]targetPathsHolder
targetPathDescriptor page.TargetPathDescriptor
}
func (l pagePaths) OutputFormats() page.OutputFormats {
return l.outputFormats
}
func createTargetPathDescriptor(p *pageState) (page.TargetPathDescriptor, error) {
s := p.s
d := s.Deps
pm := p.m
alwaysInSubDir := p.Kind() == kinds.KindSitemap
pageInfoPage := p.PathInfo()
pageInfoCurrentSection := p.CurrentSection().PathInfo()
if p.s.Conf.DisablePathToLower() {
pageInfoPage = pageInfoPage.Unnormalized()
pageInfoCurrentSection = pageInfoCurrentSection.Unnormalized()
}
desc := page.TargetPathDescriptor{
PathSpec: d.PathSpec,
Kind: p.Kind(),
Path: pageInfoPage,
Section: pageInfoCurrentSection,
UglyURLs: s.h.Conf.IsUglyURLs(p.Section()),
ForcePrefix: s.h.Conf.IsMultihost() || alwaysInSubDir,
URL: pm.pageConfig.URL,
}
if pm.Slug() != "" {
desc.BaseName = pm.Slug()
} else if pm.isStandalone() && pm.standaloneOutputFormat.BaseName != "" {
desc.BaseName = pm.standaloneOutputFormat.BaseName
} else {
desc.BaseName = pageInfoPage.BaseNameNoIdentifier()
}
desc.PrefixFilePath = s.getLanguageTargetPathLang(alwaysInSubDir)
desc.PrefixLink = s.getLanguagePermalinkLang(alwaysInSubDir)
opath, err := d.ResourceSpec.Permalinks.Expand(p.Section(), p)
if err != nil {
return desc, err
}
if opath != "" {
opath, _ = url.QueryUnescape(opath)
if strings.HasSuffix(opath, "//") {
// When rewriting the _index of the section the permalink config is applied to,
// we get double slashes at the end sometimes; clear them up here
opath = strings.TrimSuffix(opath, "/")
}
desc.ExpandedPermalink = opath
if p.File() != nil {
s.Log.Debugf("Set expanded permalink path for %s %s to %#v", p.Kind(), p.File().Path(), opath)
} else {
s.Log.Debugf("Set expanded permalink path for %s in %v to %#v", p.Kind(), desc.Section.Path(), opath)
}
}
return desc, nil
}