snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)

server/platform/shared/templates/templates.go

@@ -0,0 +1,74 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package templates
+
+import (
+	"bytes"
+	"html/template"
+	"io"
+	"path/filepath"
+	"sync"
+
+	"github.com/mattermost/mattermost/server/v8/channels/utils/fileutils"
+)
+
+// Container represents a set of templates that can be render
+type Container struct {
+	templates *template.Template
+	mutex     sync.RWMutex
+}
+
+// Data contains the data used to populate the template variables, it has Props
+// that can be of any type and HTML that only can be `template.HTML` types.
+type Data struct {
+	Props map[string]any
+	HTML  map[string]template.HTML
+}
+
+func GetTemplateDirectory() (string, bool) {
+	return fileutils.FindDir("templates")
+}
+
+// NewFromTemplates creates a new templates container using a
+// `template.Template` object
+func NewFromTemplate(templates *template.Template) *Container {
+	return &Container{templates: templates}
+}
+
+// New creates a new templates container scanning a directory.
+func New(directory string) (*Container, error) {
+	c := &Container{}
+
+	htmlTemplates, err := template.ParseGlob(filepath.Join(directory, "*.html"))
+	if err != nil {
+		return nil, err
+	}
+	c.templates = htmlTemplates
+
+	return c, nil
+}
+
+// RenderToString renders the template referenced with the template name using
+// the data provided and return a string with the result
+func (c *Container) RenderToString(templateName string, data Data) (string, error) {
+	var text bytes.Buffer
+	if err := c.Render(&text, templateName, data); err != nil {
+		return "", err
+	}
+	return text.String(), nil
+}
+
+// RenderToString renders the template referenced with the template name using
+// the data provided and write it to the writer provided
+func (c *Container) Render(w io.Writer, templateName string, data Data) error {
+	c.mutex.RLock()
+	htmlTemplates := c.templates
+	c.mutex.RUnlock()
+
+	if err := htmlTemplates.ExecuteTemplate(w, templateName, data); err != nil {
+		return err
+	}
+
+	return nil
+}

server/platform/shared/templates/templates_test.go

@@ -0,0 +1,67 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package templates
+
+import (
+	"bytes"
+	"html/template"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestNew_BadDirectory(t *testing.T) {
+	container, err := New("notarealdirectory")
+	assert.Nil(t, container)
+	assert.Error(t, err)
+}
+
+func TestRender(t *testing.T) {
+	tpl := template.New("test")
+	_, err := tpl.Parse(`{{ define "foo" }}foo{{ .Props.Bar }}{{ end }}`)
+	require.NoError(t, err)
+	mt := NewFromTemplate(tpl)
+
+	data := Data{
+		Props: map[string]any{
+			"Bar": "bar",
+		},
+	}
+	text, err := mt.RenderToString("foo", data)
+	require.NoError(t, err)
+	assert.Equal(t, "foobar", text)
+
+	buf := &bytes.Buffer{}
+	require.NoError(t, mt.Render(buf, "foo", data))
+	assert.Equal(t, "foobar", buf.String())
+}
+
+func TestRenderError(t *testing.T) {
+	tpl := template.New("test")
+	_, err := tpl.Parse(`{{ define "foo" }}foo{{ .Foo.Bar }}bar{{ end }}`)
+	require.NoError(t, err)
+	mt := NewFromTemplate(tpl)
+
+	text, err := mt.RenderToString("foo", Data{})
+	require.Error(t, err)
+	assert.Equal(t, "", text)
+
+	buf := &bytes.Buffer{}
+	assert.Error(t, mt.Render(buf, "foo", Data{}))
+	assert.Equal(t, "foo", buf.String())
+}
+
+func TestRenderUnknownTemplate(t *testing.T) {
+	tpl := template.New("")
+	mt := NewFromTemplate(tpl)
+
+	text, err := mt.RenderToString("foo", Data{})
+	require.Error(t, err)
+	assert.Equal(t, "", text)
+
+	buf := &bytes.Buffer{}
+	assert.Error(t, mt.Render(buf, "foo", Data{}))
+	assert.Equal(t, "", buf.String())
+}