github.com/linchen2chris/hugo@v0.0.0-20230307053224-cec209389705/tpl/safe/init.go (about)

     1  // Copyright 2017 The Hugo Authors. All rights reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  // http://www.apache.org/licenses/LICENSE-2.0
     7  //
     8  // Unless required by applicable law or agreed to in writing, software
     9  // distributed under the License is distributed on an "AS IS" BASIS,
    10  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package safe
    15  
    16  import (
    17  	"context"
    18  
    19  	"github.com/gohugoio/hugo/deps"
    20  	"github.com/gohugoio/hugo/tpl/internal"
    21  )
    22  
    23  const name = "safe"
    24  
    25  func init() {
    26  	f := func(d *deps.Deps) *internal.TemplateFuncsNamespace {
    27  		ctx := New()
    28  
    29  		ns := &internal.TemplateFuncsNamespace{
    30  			Name:    name,
    31  			Context: func(cctx context.Context, args ...any) (any, error) { return ctx, nil },
    32  		}
    33  
    34  		ns.AddMethodMapping(ctx.CSS,
    35  			[]string{"safeCSS"},
    36  			[][2]string{
    37  				{`{{ "Bat&Man" | safeCSS | safeCSS }}`, `Bat&Man`},
    38  			},
    39  		)
    40  
    41  		ns.AddMethodMapping(ctx.HTML,
    42  			[]string{"safeHTML"},
    43  			[][2]string{
    44  				{`{{ "Bat&Man" | safeHTML | safeHTML }}`, `Bat&Man`},
    45  				{`{{ "Bat&Man" | safeHTML }}`, `Bat&Man`},
    46  			},
    47  		)
    48  
    49  		ns.AddMethodMapping(ctx.HTMLAttr,
    50  			[]string{"safeHTMLAttr"},
    51  			[][2]string{},
    52  		)
    53  
    54  		ns.AddMethodMapping(ctx.JS,
    55  			[]string{"safeJS"},
    56  			[][2]string{
    57  				{`{{ "(1*2)" | safeJS | safeJS }}`, `(1*2)`},
    58  			},
    59  		)
    60  
    61  		ns.AddMethodMapping(ctx.JSStr,
    62  			[]string{"safeJSStr"},
    63  			[][2]string{},
    64  		)
    65  
    66  		ns.AddMethodMapping(ctx.URL,
    67  			[]string{"safeURL"},
    68  			[][2]string{
    69  				{`{{ "http://gohugo.io" | safeURL | safeURL }}`, `http://gohugo.io`},
    70  			},
    71  		)
    72  
    73  		ns.AddMethodMapping(ctx.SanitizeURL,
    74  			[]string{"sanitizeURL", "sanitizeurl"},
    75  			[][2]string{},
    76  		)
    77  
    78  		return ns
    79  	}
    80  
    81  	internal.AddTemplateFuncsNamespace(f)
    82  }