summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/mattermost/mattermost-server/v6/model/bot.go
diff options
context:
space:
mode:
authorWim <wim@42.be>2021-10-16 23:11:32 +0200
committerWim <wim@42.be>2021-10-16 23:23:24 +0200
commit20f6c05ec50739d31f4dbe9fde0d223f2c43f6e8 (patch)
tree230edca06449a8d1755f08aabf45a03e07e6f17c /vendor/github.com/mattermost/mattermost-server/v6/model/bot.go
parent57fce93af7f64f025cec6f3ed6088163086bc9fe (diff)
downloadmatterbridge-msglm-20f6c05ec50739d31f4dbe9fde0d223f2c43f6e8.tar.gz
matterbridge-msglm-20f6c05ec50739d31f4dbe9fde0d223f2c43f6e8.tar.bz2
matterbridge-msglm-20f6c05ec50739d31f4dbe9fde0d223f2c43f6e8.zip
Update vendor
Diffstat (limited to 'vendor/github.com/mattermost/mattermost-server/v6/model/bot.go')
-rw-r--r--vendor/github.com/mattermost/mattermost-server/v6/model/bot.go204
1 files changed, 204 insertions, 0 deletions
diff --git a/vendor/github.com/mattermost/mattermost-server/v6/model/bot.go b/vendor/github.com/mattermost/mattermost-server/v6/model/bot.go
new file mode 100644
index 00000000..fe9b9078
--- /dev/null
+++ b/vendor/github.com/mattermost/mattermost-server/v6/model/bot.go
@@ -0,0 +1,204 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package model
+
+import (
+ "fmt"
+ "net/http"
+ "strings"
+ "unicode/utf8"
+)
+
+const (
+ BotDisplayNameMaxRunes = UserFirstNameMaxRunes
+ BotDescriptionMaxRunes = 1024
+ BotCreatorIdMaxRunes = KeyValuePluginIdMaxRunes // UserId or PluginId
+ BotWarnMetricBotUsername = "mattermost-advisor"
+ BotSystemBotUsername = "system-bot"
+)
+
+// Bot is a special type of User meant for programmatic interactions.
+// Note that the primary key of a bot is the UserId, and matches the primary key of the
+// corresponding user.
+type Bot struct {
+ UserId string `json:"user_id"`
+ Username string `json:"username"`
+ DisplayName string `json:"display_name,omitempty"`
+ Description string `json:"description,omitempty"`
+ OwnerId string `json:"owner_id"`
+ LastIconUpdate int64 `json:"last_icon_update,omitempty"`
+ CreateAt int64 `json:"create_at"`
+ UpdateAt int64 `json:"update_at"`
+ DeleteAt int64 `json:"delete_at"`
+}
+
+// BotPatch is a description of what fields to update on an existing bot.
+type BotPatch struct {
+ Username *string `json:"username"`
+ DisplayName *string `json:"display_name"`
+ Description *string `json:"description"`
+}
+
+// BotGetOptions acts as a filter on bulk bot fetching queries.
+type BotGetOptions struct {
+ OwnerId string
+ IncludeDeleted bool
+ OnlyOrphaned bool
+ Page int
+ PerPage int
+}
+
+// BotList is a list of bots.
+type BotList []*Bot
+
+// Trace describes the minimum information required to identify a bot for the purpose of logging.
+func (b *Bot) Trace() map[string]interface{} {
+ return map[string]interface{}{"user_id": b.UserId}
+}
+
+// Clone returns a shallow copy of the bot.
+func (b *Bot) Clone() *Bot {
+ copy := *b
+ return &copy
+}
+
+// IsValid validates the bot and returns an error if it isn't configured correctly.
+func (b *Bot) IsValid() *AppError {
+ if !IsValidId(b.UserId) {
+ return NewAppError("Bot.IsValid", "model.bot.is_valid.user_id.app_error", b.Trace(), "", http.StatusBadRequest)
+ }
+
+ if !IsValidUsername(b.Username) {
+ return NewAppError("Bot.IsValid", "model.bot.is_valid.username.app_error", b.Trace(), "", http.StatusBadRequest)
+ }
+
+ if utf8.RuneCountInString(b.DisplayName) > BotDisplayNameMaxRunes {
+ return NewAppError("Bot.IsValid", "model.bot.is_valid.user_id.app_error", b.Trace(), "", http.StatusBadRequest)
+ }
+
+ if utf8.RuneCountInString(b.Description) > BotDescriptionMaxRunes {
+ return NewAppError("Bot.IsValid", "model.bot.is_valid.description.app_error", b.Trace(), "", http.StatusBadRequest)
+ }
+
+ if b.OwnerId == "" || utf8.RuneCountInString(b.OwnerId) > BotCreatorIdMaxRunes {
+ return NewAppError("Bot.IsValid", "model.bot.is_valid.creator_id.app_error", b.Trace(), "", http.StatusBadRequest)
+ }
+
+ if b.CreateAt == 0 {
+ return NewAppError("Bot.IsValid", "model.bot.is_valid.create_at.app_error", b.Trace(), "", http.StatusBadRequest)
+ }
+
+ if b.UpdateAt == 0 {
+ return NewAppError("Bot.IsValid", "model.bot.is_valid.update_at.app_error", b.Trace(), "", http.StatusBadRequest)
+ }
+
+ return nil
+}
+
+// PreSave should be run before saving a new bot to the database.
+func (b *Bot) PreSave() {
+ b.CreateAt = GetMillis()
+ b.UpdateAt = b.CreateAt
+ b.DeleteAt = 0
+}
+
+// PreUpdate should be run before saving an updated bot to the database.
+func (b *Bot) PreUpdate() {
+ b.UpdateAt = GetMillis()
+}
+
+// Etag generates an etag for caching.
+func (b *Bot) Etag() string {
+ return Etag(b.UserId, b.UpdateAt)
+}
+
+// Patch modifies an existing bot with optional fields from the given patch.
+// TODO 6.0: consider returning a boolean to indicate whether or not the patch
+// applied any changes.
+func (b *Bot) Patch(patch *BotPatch) {
+ if patch.Username != nil {
+ b.Username = *patch.Username
+ }
+
+ if patch.DisplayName != nil {
+ b.DisplayName = *patch.DisplayName
+ }
+
+ if patch.Description != nil {
+ b.Description = *patch.Description
+ }
+}
+
+// WouldPatch returns whether or not the given patch would be applied or not.
+func (b *Bot) WouldPatch(patch *BotPatch) bool {
+ if patch == nil {
+ return false
+ }
+ if patch.Username != nil && *patch.Username != b.Username {
+ return true
+ }
+ if patch.DisplayName != nil && *patch.DisplayName != b.DisplayName {
+ return true
+ }
+ if patch.Description != nil && *patch.Description != b.Description {
+ return true
+ }
+ return false
+}
+
+// UserFromBot returns a user model describing the bot fields stored in the User store.
+func UserFromBot(b *Bot) *User {
+ return &User{
+ Id: b.UserId,
+ Username: b.Username,
+ Email: NormalizeEmail(fmt.Sprintf("%s@localhost", b.Username)),
+ FirstName: b.DisplayName,
+ Roles: SystemUserRoleId,
+ }
+}
+
+// BotFromUser returns a bot model given a user model
+func BotFromUser(u *User) *Bot {
+ return &Bot{
+ OwnerId: u.Id,
+ UserId: u.Id,
+ Username: u.Username,
+ DisplayName: u.GetDisplayName(ShowUsername),
+ }
+}
+
+// Etag computes the etag for a list of bots.
+func (l *BotList) Etag() string {
+ id := "0"
+ var t int64 = 0
+ var delta int64 = 0
+
+ for _, v := range *l {
+ if v.UpdateAt > t {
+ t = v.UpdateAt
+ id = v.UserId
+ }
+
+ }
+
+ return Etag(id, t, delta, len(*l))
+}
+
+// MakeBotNotFoundError creates the error returned when a bot does not exist, or when the user isn't allowed to query the bot.
+// The errors must the same in both cases to avoid leaking that a user is a bot.
+func MakeBotNotFoundError(userId string) *AppError {
+ return NewAppError("SqlBotStore.Get", "store.sql_bot.get.missing.app_error", map[string]interface{}{"user_id": userId}, "", http.StatusNotFound)
+}
+
+func IsBotDMChannel(channel *Channel, botUserID string) bool {
+ if channel.Type != ChannelTypeDirect {
+ return false
+ }
+
+ if !strings.HasPrefix(channel.Name, botUserID+"__") && !strings.HasSuffix(channel.Name, "__"+botUserID) {
+ return false
+ }
+
+ return true
+}