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

server/public/model/report.go

@@ -0,0 +1,185 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package model
+
+import (
+	"net/http"
+	"slices"
+	"strconv"
+	"time"
+)
+
+const (
+	ReportDurationAllTime       = "all_time"
+	ReportDurationLast30Days    = "last_30_days"
+	ReportDurationPreviousMonth = "previous_month"
+	ReportDurationLast6Months   = "last_6_months"
+
+	ReportingMaxPageSize = 100
+
+	GuestFilterAll             = "all"
+	GuestFilterSingleChannel   = "single_channel"
+	GuestFilterMultipleChannel = "multi_channel"
+)
+
+var (
+	ReportExportFormats = []string{"csv"}
+
+	UserReportSortColumns = []string{"CreateAt", "Username", "FirstName", "LastName", "Nickname", "Email", "Roles"}
+
+	AllowedGuestFilters = []string{GuestFilterAll, GuestFilterSingleChannel, GuestFilterMultipleChannel}
+)
+
+type ReportableObject interface {
+	ToReport() []string
+}
+
+type ReportingBaseOptions struct {
+	SortDesc        bool
+	Direction       string // Accepts only "prev" or "next"
+	PageSize        int
+	SortColumn      string
+	FromColumnValue string
+	FromId          string
+	DateRange       string
+	StartAt         int64
+	EndAt           int64
+}
+
+func GetReportDateRange(dateRange string, now time.Time) (int64, int64) {
+	startAt := int64(0)
+	endAt := int64(0)
+
+	if dateRange == ReportDurationLast30Days {
+		startAt = now.AddDate(0, 0, -30).UnixMilli()
+	} else if dateRange == ReportDurationPreviousMonth {
+		startOfMonth := time.Date(now.Year(), now.Month(), 1, 0, 0, 0, 0, time.Local)
+		startAt = startOfMonth.AddDate(0, -1, 0).UnixMilli()
+		endAt = startOfMonth.UnixMilli()
+	} else if dateRange == ReportDurationLast6Months {
+		startAt = now.AddDate(0, -6, -0).UnixMilli()
+	}
+
+	return startAt, endAt
+}
+
+func (options *ReportingBaseOptions) PopulateDateRange(now time.Time) {
+	startAt, endAt := GetReportDateRange(options.DateRange, now)
+
+	options.StartAt = startAt
+	options.EndAt = endAt
+}
+
+func (options *ReportingBaseOptions) IsValid() *AppError {
+	if options.EndAt > 0 && options.StartAt > options.EndAt {
+		return NewAppError("ReportingBaseOptions.IsValid", "model.reporting_base_options.is_valid.bad_date_range", nil, "", http.StatusBadRequest)
+	}
+
+	return nil
+}
+
+type UserReportQuery struct {
+	User
+	UserPostStats
+	ChannelCount *int
+	Teams        string
+}
+
+type UserReport struct {
+	User
+	UserPostStats
+	ChannelCount *int   `json:"channel_count,omitempty"`
+	Teams        string `json:"teams,omitempty"`
+}
+
+func (u *UserReport) ToReport() []string {
+	lastStatusAt := ""
+	if u.LastStatusAt != nil {
+		lastStatusAt = time.UnixMilli(*u.LastStatusAt).String()
+	}
+	lastPostDate := ""
+	if u.LastPostDate != nil {
+		lastPostDate = time.UnixMilli(*u.LastPostDate).String()
+	}
+	daysActive := ""
+	if u.DaysActive != nil {
+		daysActive = strconv.Itoa(*u.DaysActive)
+	}
+	totalPosts := ""
+	if u.TotalPosts != nil {
+		totalPosts = strconv.Itoa(*u.TotalPosts)
+	}
+	channelCount := ""
+	if u.ChannelCount != nil {
+		channelCount = strconv.Itoa(*u.ChannelCount)
+	}
+	lastLogin := ""
+	if u.LastLogin > 0 {
+		lastLogin = time.UnixMilli(u.LastLogin).String()
+	}
+
+	deleteAt := ""
+	if u.DeleteAt > 0 {
+		deleteAt = time.UnixMilli(u.DeleteAt).String()
+	}
+
+	return []string{
+		u.Id,
+		u.Username,
+		u.Email,
+		time.UnixMilli(u.CreateAt).String(),
+		u.User.GetDisplayName(ShowNicknameFullName),
+		u.Roles,
+		lastLogin,
+		lastStatusAt,
+		lastPostDate,
+		daysActive,
+		totalPosts,
+		channelCount,
+		u.Teams,
+		deleteAt,
+	}
+}
+
+type UserReportOptions struct {
+	ReportingBaseOptions
+	Role         string
+	Team         string
+	HasNoTeam    bool
+	HideActive   bool
+	HideInactive bool
+	SearchTerm   string
+	GuestFilter  string
+}
+
+func (u *UserReportOptions) IsValid() *AppError {
+	if appErr := u.ReportingBaseOptions.IsValid(); appErr != nil {
+		return appErr
+	}
+
+	// Validate against the columns we allow sorting for
+	if !slices.Contains(UserReportSortColumns, u.SortColumn) {
+		return NewAppError("UserReportOptions.IsValid", "model.user_report_options.is_valid.invalid_sort_column", nil, "", http.StatusBadRequest)
+	}
+
+	if u.GuestFilter != "" && !slices.Contains(AllowedGuestFilters, u.GuestFilter) {
+		return NewAppError("UserReportOptions.IsValid", "model.user_report_options.is_valid.invalid_guest_filter", nil, "", http.StatusBadRequest)
+	}
+
+	return nil
+}
+
+func (u *UserReportQuery) ToReport() *UserReport {
+	u.ClearNonProfileFields(true)
+	return &UserReport{
+		User:          u.User,
+		UserPostStats: u.UserPostStats,
+		ChannelCount:  u.ChannelCount,
+		Teams:         u.Teams,
+	}
+}
+
+func IsValidReportExportFormat(format string) bool {
+	return slices.Contains(ReportExportFormats, format)
+}