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

server/public/model/team.go

@@ -0,0 +1,316 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package model
+
+import (
+	"fmt"
+	"net/http"
+	"regexp"
+	"strings"
+	"unicode/utf8"
+)
+
+const (
+	TeamOpen                    = "O"
+	TeamInvite                  = "I"
+	TeamAllowedDomainsMaxLength = 500
+	TeamCompanyNameMaxLength    = 64
+	TeamDescriptionMaxLength    = 255
+	TeamDisplayNameMaxRunes     = 64
+	TeamEmailMaxLength          = 128
+	TeamNameMaxLength           = 64
+	TeamNameMinLength           = 2
+)
+
+type Team struct {
+	Id                  string  `json:"id"`
+	CreateAt            int64   `json:"create_at"`
+	UpdateAt            int64   `json:"update_at"`
+	DeleteAt            int64   `json:"delete_at"`
+	DisplayName         string  `json:"display_name"`
+	Name                string  `json:"name"`
+	Description         string  `json:"description"`
+	Email               string  `json:"email"`
+	Type                string  `json:"type"`
+	CompanyName         string  `json:"company_name"`
+	AllowedDomains      string  `json:"allowed_domains"`
+	InviteId            string  `json:"invite_id"`
+	AllowOpenInvite     bool    `json:"allow_open_invite"`
+	LastTeamIconUpdate  int64   `json:"last_team_icon_update,omitempty"`
+	SchemeId            *string `json:"scheme_id"`
+	GroupConstrained    *bool   `json:"group_constrained"`
+	PolicyID            *string `json:"policy_id"` // Data Retention policy — unrelated to ABAC below
+	CloudLimitsArchived bool    `json:"cloud_limits_archived"`
+
+	// Not persisted; derived by the store via EXISTS on AccessControlPolicies(Type='team').
+	// Use HasMembershipPolicyAction for enforcement — this is a read-path signal only.
+	PolicyEnforced bool            `json:"policy_enforced"`
+	PolicyActions  map[string]bool `json:"policy_actions,omitempty"` // hydrated lazily; nil when not hydrated
+	PolicyIsActive bool            `json:"policy_is_active"`
+
+	// Not persisted; a transient per-viewer hint set on public, policy-enforced
+	// teams the requesting user qualifies to join and is not already a member of.
+	// Never set on private teams. Carries no policy detail.
+	Recommended bool `json:"recommended,omitempty"`
+}
+
+// HasPolicyAction is nil-safe; returns false when PolicyActions is nil or empty.
+func (o *Team) HasPolicyAction(action string) bool {
+	if o == nil || len(o.PolicyActions) == 0 {
+		return false
+	}
+	return o.PolicyActions[action]
+}
+
+func (o *Team) HasMembershipPolicyAction() bool {
+	return o.HasPolicyAction(AccessControlPolicyActionMembership)
+}
+
+func (o *Team) Auditable() map[string]any {
+	return map[string]any{
+		"id":                    o.Id,
+		"create_at":             o.CreateAt,
+		"update_at":             o.UpdateAt,
+		"delete_at":             o.DeleteAt,
+		"type":                  o.Type,
+		"invite_id":             o.InviteId,
+		"allow_open_invite":     o.AllowOpenInvite,
+		"scheme_id":             o.SchemeId,
+		"group_constrained":     o.GroupConstrained,
+		"policy_id":             o.PolicyID,
+		"cloud_limits_archived": o.CloudLimitsArchived,
+	}
+}
+
+func (o *Team) LogClone() any {
+	return o.Auditable()
+}
+
+type TeamPatch struct {
+	DisplayName         *string `json:"display_name"`
+	Description         *string `json:"description"`
+	CompanyName         *string `json:"company_name"`
+	AllowedDomains      *string `json:"allowed_domains"`
+	AllowOpenInvite     *bool   `json:"allow_open_invite"`
+	GroupConstrained    *bool   `json:"group_constrained"`
+	CloudLimitsArchived *bool   `json:"cloud_limits_archived"`
+}
+
+func (o *TeamPatch) Auditable() map[string]any {
+	return map[string]any{
+		"allow_open_invite":     o.AllowOpenInvite,
+		"group_constrained":     o.GroupConstrained,
+		"cloud_limits_archived": o.CloudLimitsArchived,
+	}
+}
+
+type TeamForExport struct {
+	Team
+	SchemeName *string
+}
+
+type Invites struct {
+	Invites []map[string]string `json:"invites"`
+}
+
+type TeamsWithCount struct {
+	Teams      []*Team `json:"teams"`
+	TotalCount int64   `json:"total_count"`
+}
+
+func (o *Invites) ToEmailList() []string {
+	emailList := make([]string, 0, len(o.Invites))
+	for _, invite := range o.Invites {
+		emailList = append(emailList, invite["email"])
+	}
+	return emailList
+}
+
+func (o *Team) Etag() string {
+	return Etag(o.Id, o.UpdateAt)
+}
+
+func (o *Team) IsValid() *AppError {
+	if !IsValidId(o.Id) {
+		return NewAppError("Team.IsValid", "model.team.is_valid.id.app_error", nil, "", http.StatusBadRequest)
+	}
+
+	if o.CreateAt == 0 {
+		return NewAppError("Team.IsValid", "model.team.is_valid.create_at.app_error", nil, "id="+o.Id, http.StatusBadRequest)
+	}
+
+	if o.UpdateAt == 0 {
+		return NewAppError("Team.IsValid", "model.team.is_valid.update_at.app_error", nil, "id="+o.Id, http.StatusBadRequest)
+	}
+
+	if len(o.Email) > TeamEmailMaxLength {
+		return NewAppError("Team.IsValid", "model.team.is_valid.email.app_error", nil, "id="+o.Id, http.StatusBadRequest)
+	}
+
+	if o.Email != "" && !IsValidEmail(o.Email) {
+		return NewAppError("Team.IsValid", "model.team.is_valid.email.app_error", nil, "id="+o.Id, http.StatusBadRequest)
+	}
+
+	if utf8.RuneCountInString(o.DisplayName) == 0 || utf8.RuneCountInString(o.DisplayName) > TeamDisplayNameMaxRunes {
+		return NewAppError("Team.IsValid", "model.team.is_valid.name.app_error", nil, "id="+o.Id, http.StatusBadRequest)
+	}
+
+	if len(o.Name) > TeamNameMaxLength {
+		return NewAppError("Team.IsValid", "model.team.is_valid.url.app_error", nil, "id="+o.Id, http.StatusBadRequest)
+	}
+
+	if len(o.Description) > TeamDescriptionMaxLength {
+		return NewAppError("Team.IsValid", "model.team.is_valid.description.app_error", nil, "id="+o.Id, http.StatusBadRequest)
+	}
+
+	if o.InviteId == "" {
+		return NewAppError("Team.IsValid", "model.team.is_valid.invite_id.app_error", nil, "id="+o.Id, http.StatusBadRequest)
+	}
+
+	if IsReservedTeamName(o.Name) {
+		return NewAppError("Team.IsValid", "model.team.is_valid.reserved.app_error", nil, "id="+o.Id, http.StatusBadRequest)
+	}
+
+	if !IsValidTeamName(o.Name) {
+		return NewAppError("Team.IsValid", "model.team.is_valid.characters.app_error", nil, "id="+o.Id, http.StatusBadRequest)
+	}
+
+	if !(o.Type == TeamOpen || o.Type == TeamInvite) {
+		return NewAppError("Team.IsValid", "model.team.is_valid.type.app_error", nil, "id="+o.Id, http.StatusBadRequest)
+	}
+
+	if len(o.CompanyName) > TeamCompanyNameMaxLength {
+		return NewAppError("Team.IsValid", "model.team.is_valid.company.app_error", nil, "id="+o.Id, http.StatusBadRequest)
+	}
+
+	if len(o.AllowedDomains) > TeamAllowedDomainsMaxLength {
+		return NewAppError("Team.IsValid", "model.team.is_valid.domains.app_error", nil, "id="+o.Id, http.StatusBadRequest)
+	}
+
+	return nil
+}
+
+func (o *Team) PreSave() {
+	if o.Id == "" {
+		o.Id = NewId()
+	}
+
+	o.CreateAt = GetMillis()
+	o.UpdateAt = o.CreateAt
+
+	o.Name = SanitizeUnicode(o.Name)
+	o.DisplayName = SanitizeUnicode(o.DisplayName)
+	o.Description = SanitizeUnicode(o.Description)
+	o.CompanyName = SanitizeUnicode(o.CompanyName)
+
+	if o.InviteId == "" {
+		o.InviteId = NewId()
+	}
+}
+
+func (o *Team) PreUpdate() {
+	o.UpdateAt = GetMillis()
+	o.Name = SanitizeUnicode(o.Name)
+	o.DisplayName = SanitizeUnicode(o.DisplayName)
+	o.Description = SanitizeUnicode(o.Description)
+	o.CompanyName = SanitizeUnicode(o.CompanyName)
+}
+
+func IsReservedTeamName(s string) bool {
+	s = strings.ToLower(s)
+
+	for _, value := range reservedName {
+		if strings.Index(s, value) == 0 {
+			return true
+		}
+	}
+
+	return false
+}
+
+func IsValidTeamName(s string) bool {
+	if !isValidAlphaNum(s) {
+		return false
+	}
+
+	if len(s) < TeamNameMinLength {
+		return false
+	}
+
+	return true
+}
+
+var validTeamNameCharacter = regexp.MustCompile(`^[a-z0-9-]$`)
+
+func CleanTeamName(s string) string {
+	s = strings.ToLower(strings.Replace(s, " ", "-", -1))
+
+	for _, value := range reservedName {
+		if strings.Index(s, value) == 0 {
+			s = strings.Replace(s, value, "", -1)
+		}
+	}
+
+	s = strings.TrimSpace(s)
+
+	for _, c := range s {
+		char := fmt.Sprintf("%c", c)
+		if !validTeamNameCharacter.MatchString(char) {
+			s = strings.Replace(s, char, "", -1)
+		}
+	}
+
+	s = strings.Trim(s, "-")
+
+	if !IsValidTeamName(s) {
+		s = NewId()
+	}
+
+	return s
+}
+
+func (o *Team) Sanitize() {
+	o.Email = ""
+	o.InviteId = ""
+}
+
+func (o *Team) Patch(patch *TeamPatch) {
+	if patch.DisplayName != nil {
+		o.DisplayName = *patch.DisplayName
+	}
+
+	if patch.Description != nil {
+		o.Description = *patch.Description
+	}
+
+	if patch.CompanyName != nil {
+		o.CompanyName = *patch.CompanyName
+	}
+
+	if patch.AllowedDomains != nil {
+		o.AllowedDomains = *patch.AllowedDomains
+	}
+
+	if patch.AllowOpenInvite != nil {
+		o.AllowOpenInvite = *patch.AllowOpenInvite
+	}
+
+	if patch.GroupConstrained != nil {
+		o.GroupConstrained = patch.GroupConstrained
+	}
+
+	if patch.CloudLimitsArchived != nil {
+		o.CloudLimitsArchived = *patch.CloudLimitsArchived
+	}
+}
+
+func (o *Team) IsGroupConstrained() bool {
+	return o.GroupConstrained != nil && *o.GroupConstrained
+}
+
+// ShallowCopy returns a shallow copy of team.
+func (o *Team) ShallowCopy() *Team {
+	c := *o
+	return &c
+}