gf/os/gview/gview.go
2021-01-17 21:46:25 +08:00

145 lines
4.6 KiB
Go

// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
// Package gview implements a template engine based on text/template.
//
// Reserved template variable names:
// I18nLanguage: Assign this variable to define i18n language for each page.
package gview
import (
"github.com/gogf/gf/container/gmap"
"github.com/gogf/gf/internal/intlog"
"github.com/gogf/gf"
"github.com/gogf/gf/container/garray"
"github.com/gogf/gf/os/gcmd"
"github.com/gogf/gf/os/gfile"
"github.com/gogf/gf/os/glog"
)
// View object for template engine.
type View struct {
paths *garray.StrArray // Searching array for path, NOT concurrent-safe for performance purpose.
data map[string]interface{} // Global template variables.
funcMap map[string]interface{} // Global template function map.
fileCacheMap *gmap.StrAnyMap // File cache map.
config Config // Extra configuration for the view.
}
type (
Params = map[string]interface{} // Params is type for template params.
FuncMap = map[string]interface{} // FuncMap is type for custom template functions.
)
var (
// Default view object.
defaultViewObj *View
)
// checkAndInitDefaultView checks and initializes the default view object.
// The default view object will be initialized just once.
func checkAndInitDefaultView() {
if defaultViewObj == nil {
defaultViewObj = New()
}
}
// ParseContent parses the template content directly using the default view object
// and returns the parsed content.
func ParseContent(content string, params ...Params) (string, error) {
checkAndInitDefaultView()
return defaultViewObj.ParseContent(content, params...)
}
// New returns a new view object.
// The parameter <path> specifies the template directory path to load template files.
func New(path ...string) *View {
view := &View{
paths: garray.NewStrArray(),
data: make(map[string]interface{}),
funcMap: make(map[string]interface{}),
fileCacheMap: gmap.NewStrAnyMap(true),
config: DefaultConfig(),
}
if len(path) > 0 && len(path[0]) > 0 {
if err := view.SetPath(path[0]); err != nil {
intlog.Error(err)
}
} else {
// Customized dir path from env/cmd.
if envPath := gcmd.GetWithEnv("gf.gview.path").String(); envPath != "" {
if gfile.Exists(envPath) {
if err := view.SetPath(envPath); err != nil {
intlog.Error(err)
}
} else {
if errorPrint() {
glog.Errorf("Template directory path does not exist: %s", envPath)
}
}
} else {
// Dir path of working dir.
if err := view.SetPath(gfile.Pwd()); err != nil {
intlog.Error(err)
}
// Dir path of binary.
if selfPath := gfile.SelfDir(); selfPath != "" && gfile.Exists(selfPath) {
if err := view.AddPath(selfPath); err != nil {
intlog.Error(err)
}
}
// Dir path of main package.
if mainPath := gfile.MainPkgPath(); mainPath != "" && gfile.Exists(mainPath) {
if err := view.AddPath(mainPath); err != nil {
intlog.Error(err)
}
}
}
}
view.SetDelimiters("{{", "}}")
// default build-in variables.
view.data["GF"] = map[string]interface{}{
"version": gf.VERSION,
}
// default build-in functions.
view.BindFuncMap(FuncMap{
"eq": view.buildInFuncEq,
"ne": view.buildInFuncNe,
"lt": view.buildInFuncLt,
"le": view.buildInFuncLe,
"gt": view.buildInFuncGt,
"ge": view.buildInFuncGe,
"text": view.buildInFuncText,
"html": view.buildInFuncHtmlEncode,
"htmlencode": view.buildInFuncHtmlEncode,
"htmldecode": view.buildInFuncHtmlDecode,
"encode": view.buildInFuncHtmlEncode,
"decode": view.buildInFuncHtmlDecode,
"url": view.buildInFuncUrlEncode,
"urlencode": view.buildInFuncUrlEncode,
"urldecode": view.buildInFuncUrlDecode,
"date": view.buildInFuncDate,
"substr": view.buildInFuncSubStr,
"strlimit": view.buildInFuncStrLimit,
"concat": view.buildInFuncConcat,
"replace": view.buildInFuncReplace,
"compare": view.buildInFuncCompare,
"hidestr": view.buildInFuncHideStr,
"highlight": view.buildInFuncHighlight,
"toupper": view.buildInFuncToUpper,
"tolower": view.buildInFuncToLower,
"nl2br": view.buildInFuncNl2Br,
"include": view.buildInFuncInclude,
"dump": view.buildInFuncDump,
"map": view.buildInFuncMap,
"maps": view.buildInFuncMaps,
"json": view.buildInFuncJson,
})
return view
}