mirror of
https://github.com/gohugoio/hugo.git
synced 2024-07-02 15:20:28 +00:00
8b8fb417ae
Thanks to @bep's new, brilliant helpers.Deprecated() function, the following functions or variables are transitioned to their new names, preserving backward compatibility for v0.14 and warning the user of upcoming obsolescence in v0.15: * .Url → .URL (for node, menu and paginator) * .Site.BaseUrl → .Site.BaseURL * .Site.Indexes → .Site.Taxonomies * .Site.Recent → .Site.Pages * getJson → getJSON * getCsv → getCSV * safeHtml → safeHTML * safeCss → safeCSS * safeUrl → safeURL Also fix related initialisms in strings and comments. Continued effort in fixing #959.
143 lines
3 KiB
Go
143 lines
3 KiB
Go
// Copyright © 2013-14 Steve Francia <spf@spf13.com>.
|
|
//
|
|
// Licensed under the Simple Public 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://opensource.org/licenses/Simple-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 (
|
|
"html/template"
|
|
"sync"
|
|
"time"
|
|
"github.com/spf13/hugo/helpers"
|
|
)
|
|
|
|
type Node struct {
|
|
RSSLink template.HTML
|
|
Site *SiteInfo
|
|
// layout string
|
|
Data map[string]interface{}
|
|
Title string
|
|
Description string
|
|
Keywords []string
|
|
Params map[string]interface{}
|
|
Date time.Time
|
|
Sitemap Sitemap
|
|
URLPath
|
|
paginator *pager
|
|
paginatorInit sync.Once
|
|
scratch *Scratch
|
|
}
|
|
|
|
func (n *Node) Now() time.Time {
|
|
return time.Now()
|
|
}
|
|
|
|
func (n *Node) HasMenuCurrent(menuID string, inme *MenuEntry) bool {
|
|
if inme.HasChildren() {
|
|
me := MenuEntry{Name: n.Title, URL: n.URL}
|
|
|
|
for _, child := range inme.Children {
|
|
if me.IsSameResource(child) {
|
|
return true
|
|
}
|
|
}
|
|
}
|
|
|
|
return false
|
|
}
|
|
|
|
func (n *Node) IsMenuCurrent(menuID string, inme *MenuEntry) bool {
|
|
|
|
me := MenuEntry{Name: n.Title, URL: n.URL}
|
|
if !me.IsSameResource(inme) {
|
|
return false
|
|
}
|
|
|
|
// this resource may be included in several menus
|
|
// search for it to make sure that it is in the menu with the given menuId
|
|
if menu, ok := (*n.Site.Menus)[menuID]; ok {
|
|
for _, menuEntry := range *menu {
|
|
if menuEntry.IsSameResource(inme) {
|
|
return true
|
|
}
|
|
|
|
descendantFound := n.isSameAsDescendantMenu(inme, menuEntry)
|
|
if descendantFound {
|
|
return descendantFound
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
return false
|
|
}
|
|
|
|
func (n *Node) Hugo() *HugoInfo {
|
|
return hugoInfo
|
|
}
|
|
|
|
func (n *Node) isSameAsDescendantMenu(inme *MenuEntry, parent *MenuEntry) bool {
|
|
if parent.HasChildren() {
|
|
for _, child := range parent.Children {
|
|
if child.IsSameResource(inme) {
|
|
return true
|
|
}
|
|
descendantFound := n.isSameAsDescendantMenu(inme, child)
|
|
if descendantFound {
|
|
return descendantFound
|
|
}
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
func (n *Node) RSSlink() template.HTML {
|
|
return n.RSSLink
|
|
}
|
|
|
|
func (n *Node) IsNode() bool {
|
|
return true
|
|
}
|
|
|
|
func (n *Node) IsPage() bool {
|
|
return !n.IsNode()
|
|
}
|
|
|
|
func (n *Node) Ref(ref string) (string, error) {
|
|
return n.Site.Ref(ref, nil)
|
|
}
|
|
|
|
func (n *Node) RelRef(ref string) (string, error) {
|
|
return n.Site.RelRef(ref, nil)
|
|
}
|
|
|
|
type URLPath struct {
|
|
URL string
|
|
Permalink template.HTML
|
|
Slug string
|
|
Section string
|
|
}
|
|
|
|
// Url is deprecated. Will be removed in 0.15.
|
|
func (n *Node) Url() string {
|
|
helpers.Deprecated("Node", ".Url", ".URL")
|
|
return n.URL
|
|
}
|
|
|
|
// Scratch returns the writable context associated with this Node.
|
|
func (n *Node) Scratch() *Scratch {
|
|
if n.scratch == nil {
|
|
n.scratch = newScratch()
|
|
}
|
|
return n.scratch
|
|
}
|