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

server/public/pluginapi/experimental/panel/panel.go

@@ -0,0 +1,171 @@
+package panel
+
+import (
+	"errors"
+
+	"github.com/mattermost/mattermost/server/public/model"
+	"github.com/mattermost/mattermost/server/public/pluginapi/experimental/bot/logger"
+	"github.com/mattermost/mattermost/server/public/pluginapi/experimental/bot/poster"
+	"github.com/mattermost/mattermost/server/public/pluginapi/experimental/common"
+	"github.com/mattermost/mattermost/server/public/pluginapi/experimental/panel/settings"
+)
+
+type Panel interface {
+	Set(userID, settingID string, value any) error
+	Print(userID string)
+	ToPost(userID string) (*model.Post, error)
+	Clear(userID string) error
+	URL() string
+	GetSettingIDs() []string
+}
+
+type panel struct {
+	settings       map[string]settings.Setting
+	settingKeys    []string
+	poster         poster.Poster
+	logger         logger.Logger
+	store          Store
+	settingHandler string
+	pluginURL      string
+}
+
+func NewSettingsPanel(
+	settingList []settings.Setting,
+	p poster.Poster,
+	l logger.Logger,
+	store Store,
+	settingHandler,
+	pluginURL string,
+) Panel {
+	settingsMap := make(map[string]settings.Setting)
+	settingKeys := []string{}
+	for _, s := range settingList {
+		settingsMap[s.GetID()] = s
+		settingKeys = append(settingKeys, s.GetID())
+	}
+
+	panel := &panel{
+		settings:       settingsMap,
+		settingKeys:    settingKeys,
+		poster:         p,
+		logger:         l,
+		store:          store,
+		settingHandler: settingHandler,
+		pluginURL:      pluginURL,
+	}
+
+	return panel
+}
+
+func (p *panel) Set(userID, settingID string, value any) error {
+	s, ok := p.settings[settingID]
+	if !ok {
+		return errors.New("cannot find setting " + settingID)
+	}
+
+	err := s.Set(userID, value)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+func (p *panel) GetSettingIDs() []string {
+	return p.settingKeys
+}
+
+func (p *panel) URL() string {
+	return p.settingHandler
+}
+
+func (p *panel) Print(userID string) {
+	err := p.cleanPreviousSettingsPosts(userID)
+	if err != nil {
+		p.logger.Errorf("could not clean previous setting post, %s", err.Error())
+	}
+
+	sas := []*model.MessageAttachment{}
+	for _, key := range p.settingKeys {
+		s := p.settings[key]
+		sa, loopErr := s.GetMessageAttachments(userID, p.pluginURL+p.settingHandler, p.isSettingDisabled(userID, s))
+		if loopErr != nil {
+			p.logger.Errorf("error creating the message attachment, err=%s", loopErr.Error())
+			continue
+		}
+		sas = append(sas, sa)
+	}
+	postID, err := p.poster.DMWithAttachments(userID, sas...)
+	if err != nil {
+		p.logger.Errorf("error creating the message, err=%s", err.Error())
+		return
+	}
+
+	err = p.store.SetPanelPostID(userID, postID)
+	if err != nil {
+		p.logger.Errorf("could not set the post IDs, err=%s", err.Error())
+	}
+}
+
+func (p *panel) ToPost(userID string) (*model.Post, error) {
+	post := &model.Post{}
+
+	sas := []*model.MessageAttachment{}
+	for _, key := range p.settingKeys {
+		s := p.settings[key]
+		sa, err := s.GetMessageAttachments(userID, p.pluginURL+p.settingHandler, p.isSettingDisabled(userID, s))
+		if err != nil {
+			p.logger.Errorf("error creating the message attachment for setting %s, err=%s", s.GetID(), err.Error())
+			continue
+		}
+		sas = append(sas, sa)
+	}
+
+	model.ParseMessageAttachment(post, sas)
+	return post, nil
+}
+
+func (p *panel) cleanPreviousSettingsPosts(userID string) error {
+	postID, err := p.store.GetPanelPostID(userID)
+	if err == common.ErrNotFound {
+		return nil
+	}
+
+	if err != nil {
+		return err
+	}
+
+	err = p.poster.DeletePost(postID)
+	if err != nil {
+		p.logger.Errorf("could not delete setting post, %s", err)
+	}
+
+	err = p.store.DeletePanelPostID(userID)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (p *panel) Clear(userID string) error {
+	return p.cleanPreviousSettingsPosts(userID)
+}
+
+func (p *panel) isSettingDisabled(userID string, s settings.Setting) bool {
+	dependencyID := s.GetDependency()
+	if dependencyID == "" {
+		return false
+	}
+	dependency, ok := p.settings[dependencyID]
+	if !ok {
+		p.logger.Errorf("settings dependency %s not found", dependencyID)
+		return false
+	}
+
+	value, err := dependency.Get(userID)
+	if err != nil {
+		p.logger.Errorf("cannot get dependency %s value", dependencyID)
+		return false
+	}
+	return s.IsDisabled(value)
+}