mirror of
https://github.com/mattermost/mattermost.git
synced 2026-02-11 14:54:34 -05:00
61db53dd1a
Some checks are pending
API / build (push) Waiting to run
Server CI / Compute Go Version (push) Waiting to run
Server CI / Check mocks (push) Blocked by required conditions
Server CI / Check go mod tidy (push) Blocked by required conditions
Server CI / check-style (push) Blocked by required conditions
Server CI / Check serialization methods for hot structs (push) Blocked by required conditions
Server CI / Vet API (push) Blocked by required conditions
Server CI / Check migration files (push) Blocked by required conditions
Server CI / Generate email templates (push) Blocked by required conditions
Server CI / Check store layers (push) Blocked by required conditions
Server CI / Check mmctl docs (push) Blocked by required conditions
Server CI / Postgres with binary parameters (push) Blocked by required conditions
Server CI / Postgres (push) Blocked by required conditions
Server CI / Postgres (FIPS) (push) Blocked by required conditions
Server CI / Generate Test Coverage (push) Blocked by required conditions
Server CI / Run mmctl tests (push) Blocked by required conditions
Server CI / Run mmctl tests (FIPS) (push) Blocked by required conditions
Server CI / Build mattermost server app (push) Blocked by required conditions
Web App CI / check-lint (push) Waiting to run
Web App CI / check-i18n (push) Waiting to run
Web App CI / check-types (push) Waiting to run
Web App CI / test (push) Waiting to run
Web App CI / build (push) Waiting to run
* [MM-66718] Remove unneeded HTML templates watcher The templates package currently supports filesystem watching to automatically reload templates when files change. This feature is unnecessary in production and adds complexity. Changes: - Removed NewWithWatcher() function from templates package - Removed Close() method from Container - Removed watch-related fields (watch, stop, stopped) from Container - Removed fsnotify dependency usage - Updated server.go to use New() instead of NewWithWatcher() - Updated email/helper_test.go to use New() - Removed watcher-related tests from templates_test.go Template updates now require a server restart, which provides clearer behavior and reduces code complexity. * Remove unused fsnotify dependency
74 lines
1.9 KiB
Go
74 lines
1.9 KiB
Go
// 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
|
|
}
|