mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-21 20:46:30 -05:00
73 lines
2.3 KiB
Go
73 lines
2.3 KiB
Go
// Copyright 2017 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 safe provides template functions for escaping untrusted content or
|
|
// encapsulating trusted content.
|
|
package safe
|
|
|
|
import (
|
|
"html/template"
|
|
|
|
"github.com/gohugoio/hugo/helpers"
|
|
"github.com/spf13/cast"
|
|
)
|
|
|
|
// New returns a new instance of the safe-namespaced template functions.
|
|
func New() *Namespace {
|
|
return &Namespace{}
|
|
}
|
|
|
|
// Namespace provides template functions for the "safe" namespace.
|
|
type Namespace struct{}
|
|
|
|
// CSS returns a given string as html/template CSS content.
|
|
func (ns *Namespace) CSS(a any) (template.CSS, error) {
|
|
s, err := cast.ToStringE(a)
|
|
return template.CSS(s), err
|
|
}
|
|
|
|
// HTML returns a given string as html/template HTML content.
|
|
func (ns *Namespace) HTML(a any) (template.HTML, error) {
|
|
s, err := cast.ToStringE(a)
|
|
return template.HTML(s), err
|
|
}
|
|
|
|
// HTMLAttr returns a given string as html/template HTMLAttr content.
|
|
func (ns *Namespace) HTMLAttr(a any) (template.HTMLAttr, error) {
|
|
s, err := cast.ToStringE(a)
|
|
return template.HTMLAttr(s), err
|
|
}
|
|
|
|
// JS returns the given string as a html/template JS content.
|
|
func (ns *Namespace) JS(a any) (template.JS, error) {
|
|
s, err := cast.ToStringE(a)
|
|
return template.JS(s), err
|
|
}
|
|
|
|
// JSStr returns the given string as a html/template JSStr content.
|
|
func (ns *Namespace) JSStr(a any) (template.JSStr, error) {
|
|
s, err := cast.ToStringE(a)
|
|
return template.JSStr(s), err
|
|
}
|
|
|
|
// URL returns a given string as html/template URL content.
|
|
func (ns *Namespace) URL(a any) (template.URL, error) {
|
|
s, err := cast.ToStringE(a)
|
|
return template.URL(s), err
|
|
}
|
|
|
|
// SanitizeURL returns a given string as html/template URL content.
|
|
func (ns *Namespace) SanitizeURL(a any) (string, error) {
|
|
s, err := cast.ToStringE(a)
|
|
return helpers.SanitizeURL(s), err
|
|
}
|