focalboard/server/services/store/store.go

//go:generate mockgen -destination=mockstore/mockstore.go -package mockstore . Store
//go:generate go run ./generators/main.go
package store

import (
	"time"

	"github.com/mattermost/focalboard/server/model"

	mmModel "github.com/mattermost/mattermost-server/v6/model"
)

const CardLimitTimestampSystemKey = "card_limit_timestamp"

// Store represents the abstraction of the data storage.
type Store interface {
	GetBlocks(opts model.QueryBlocksOptions) ([]*model.Block, error)
	GetBlocksWithParentAndType(boardID, parentID string, blockType string) ([]*model.Block, error)
	GetBlocksWithParent(boardID, parentID string) ([]*model.Block, error)
	GetBlocksByIDs(ids []string) ([]*model.Block, error)
	GetBlocksWithType(boardID, blockType string) ([]*model.Block, error)
	GetSubTree2(boardID, blockID string, opts model.QuerySubtreeOptions) ([]*model.Block, error)
	GetBlocksForBoard(boardID string) ([]*model.Block, error)
	// @withTransaction
	InsertBlock(block *model.Block, userID string) error
	// @withTransaction
	DeleteBlock(blockID string, modifiedBy string) error
	// @withTransaction
	InsertBlocks(blocks []*model.Block, userID string) error
	// @withTransaction
	UndeleteBlock(blockID string, modifiedBy string) error
	// @withTransaction
	UndeleteBoard(boardID string, modifiedBy string) error
	GetBlockCountsByType() (map[string]int64, error)
	GetBoardCount() (int64, error)
	GetBlock(blockID string) (*model.Block, error)
	// @withTransaction
	PatchBlock(blockID string, blockPatch *model.BlockPatch, userID string) error
	GetBlockHistory(blockID string, opts model.QueryBlockHistoryOptions) ([]*model.Block, error)
	GetBlockHistoryDescendants(boardID string, opts model.QueryBlockHistoryOptions) ([]*model.Block, error)
	GetBlockHistoryNewestChildren(parentID string, opts model.QueryBlockHistoryChildOptions) ([]*model.Block, bool, error)
	GetBoardHistory(boardID string, opts model.QueryBoardHistoryOptions) ([]*model.Board, error)
	GetBoardAndCardByID(blockID string) (board *model.Board, card *model.Block, err error)
	GetBoardAndCard(block *model.Block) (board *model.Board, card *model.Block, err error)
	// @withTransaction
	DuplicateBoard(boardID string, userID string, toTeam string, asTemplate bool) (*model.BoardsAndBlocks, []*model.BoardMember, error)
	// @withTransaction
	DuplicateBlock(boardID string, blockID string, userID string, asTemplate bool) ([]*model.Block, error)
	// @withTransaction
	PatchBlocks(blockPatches *model.BlockPatchBatch, userID string) error

	Shutdown() error

	GetSystemSetting(key string) (string, error)
	GetSystemSettings() (map[string]string, error)
	SetSystemSetting(key, value string) error

	GetRegisteredUserCount() (int, error)
	GetUserByID(userID string) (*model.User, error)
	GetUsersList(userIDs []string, showEmail, showName bool) ([]*model.User, error)
	GetUserByEmail(email string) (*model.User, error)
	GetUserByUsername(username string) (*model.User, error)
	CreateUser(user *model.User) (*model.User, error)
	UpdateUser(user *model.User) (*model.User, error)
	UpdateUserPassword(username, password string) error
	UpdateUserPasswordByID(userID, password string) error
	GetUsersByTeam(teamID string, asGuestID string, showEmail, showName bool) ([]*model.User, error)
	SearchUsersByTeam(teamID string, searchQuery string, asGuestID string, excludeBots bool, showEmail, showName bool) ([]*model.User, error)
	PatchUserPreferences(userID string, patch model.UserPreferencesPatch) (mmModel.Preferences, error)
	GetUserPreferences(userID string) (mmModel.Preferences, error)

	GetActiveUserCount(updatedSecondsAgo int64) (int, error)
	GetSession(token string, expireTime int64) (*model.Session, error)
	CreateSession(session *model.Session) error
	RefreshSession(session *model.Session) error
	UpdateSession(session *model.Session) error
	DeleteSession(sessionID string) error
	CleanUpSessions(expireTime int64) error

	UpsertSharing(sharing model.Sharing) error
	GetSharing(rootID string) (*model.Sharing, error)

	UpsertTeamSignupToken(team model.Team) error
	UpsertTeamSettings(team model.Team) error
	GetTeam(ID string) (*model.Team, error)
	GetTeamsForUser(userID string) ([]*model.Team, error)
	GetAllTeams() ([]*model.Team, error)
	GetTeamCount() (int64, error)

	InsertBoard(board *model.Board, userID string) (*model.Board, error)
	// @withTransaction
	InsertBoardWithAdmin(board *model.Board, userID string) (*model.Board, *model.BoardMember, error)
	// @withTransaction
	PatchBoard(boardID string, boardPatch *model.BoardPatch, userID string) (*model.Board, error)
	GetBoard(id string) (*model.Board, error)
	GetBoardsForUserAndTeam(userID, teamID string, includePublicBoards bool) ([]*model.Board, error)
	GetBoardsInTeamByIds(boardIDs []string, teamID string) ([]*model.Board, error)
	// @withTransaction
	DeleteBoard(boardID, userID string) error

	SaveMember(bm *model.BoardMember) (*model.BoardMember, error)
	DeleteMember(boardID, userID string) error
	GetMemberForBoard(boardID, userID string) (*model.BoardMember, error)
	GetBoardMemberHistory(boardID, userID string, limit uint64) ([]*model.BoardMemberHistoryEntry, error)
	GetMembersForBoard(boardID string) ([]*model.BoardMember, error)
	GetMembersForUser(userID string) ([]*model.BoardMember, error)
	CanSeeUser(seerID string, seenID string) (bool, error)
	SearchBoardsForUser(term string, searchField model.BoardSearchField, userID string, includePublicBoards bool) ([]*model.Board, error)
	SearchBoardsForUserInTeam(teamID, term, userID string) ([]*model.Board, error)

	// @withTransaction
	CreateBoardsAndBlocksWithAdmin(bab *model.BoardsAndBlocks, userID string) (*model.BoardsAndBlocks, []*model.BoardMember, error)
	// @withTransaction
	CreateBoardsAndBlocks(bab *model.BoardsAndBlocks, userID string) (*model.BoardsAndBlocks, error)
	// @withTransaction
	PatchBoardsAndBlocks(pbab *model.PatchBoardsAndBlocks, userID string) (*model.BoardsAndBlocks, error)
	// @withTransaction
	DeleteBoardsAndBlocks(dbab *model.DeleteBoardsAndBlocks, userID string) error

	GetCategory(id string) (*model.Category, error)

	GetUserCategories(userID, teamID string) ([]model.Category, error)
	// @withTransaction
	CreateCategory(category model.Category) error
	UpdateCategory(category model.Category) error
	DeleteCategory(categoryID, userID, teamID string) error
	ReorderCategories(userID, teamID string, newCategoryOrder []string) ([]string, error)

	GetUserCategoryBoards(userID, teamID string) ([]model.CategoryBoards, error)

	GetFileInfo(id string) (*mmModel.FileInfo, error)
	SaveFileInfo(fileInfo *mmModel.FileInfo) error

	// @withTransaction
	AddUpdateCategoryBoard(userID, categoryID string, boardIDs []string) error
	ReorderCategoryBoards(categoryID string, newBoardsOrder []string) ([]string, error)
	SetBoardVisibility(userID, categoryID, boardID string, visible bool) error

	CreateSubscription(sub *model.Subscription) (*model.Subscription, error)
	DeleteSubscription(blockID string, subscriberID string) error
	GetSubscription(blockID string, subscriberID string) (*model.Subscription, error)
	GetSubscriptions(subscriberID string) ([]*model.Subscription, error)
	GetSubscribersForBlock(blockID string) ([]*model.Subscriber, error)
	GetSubscribersCountForBlock(blockID string) (int, error)
	UpdateSubscribersNotifiedAt(blockID string, notifiedAt int64) error

	UpsertNotificationHint(hint *model.NotificationHint, notificationFreq time.Duration) (*model.NotificationHint, error)
	DeleteNotificationHint(blockID string) error
	GetNotificationHint(blockID string) (*model.NotificationHint, error)
	GetNextNotificationHint(remove bool) (*model.NotificationHint, error)

	RemoveDefaultTemplates(boards []*model.Board) error
	GetTemplateBoards(teamID, userID string) ([]*model.Board, error)

	// @withTransaction
	RunDataRetention(globalRetentionDate int64, batchSize int64) (int64, error)

	GetUsedCardsCount() (int, error)
	GetCardLimitTimestamp() (int64, error)
	UpdateCardLimitTimestamp(cardLimit int) (int64, error)

	DBType() string
	DBVersion() string

	GetLicense() *mmModel.License
	GetCloudLimits() (*mmModel.ProductLimits, error)
	SearchUserChannels(teamID, userID, query string) ([]*mmModel.Channel, error)
	GetChannel(teamID, channelID string) (*mmModel.Channel, error)
	PostMessage(message, postType, channelID string) error
	SendMessage(message, postType string, receipts []string) error

	// Insights
	GetTeamBoardsInsights(teamID string, userID string, since int64, offset int, limit int, boardIDs []string) (*model.BoardInsightsList, error)
	GetUserBoardsInsights(teamID string, userID string, since int64, offset int, limit int, boardIDs []string) (*model.BoardInsightsList, error)
	GetUserTimezone(userID string) (string, error)

	// Compliance
	GetBoardsForCompliance(opts model.QueryBoardsForComplianceOptions) ([]*model.Board, bool, error)
	GetBoardsComplianceHistory(opts model.QueryBoardsComplianceHistoryOptions) ([]*model.BoardHistory, bool, error)
	GetBlocksComplianceHistory(opts model.QueryBlocksComplianceHistoryOptions) ([]*model.BlockHistory, bool, error)

	// For unit testing only
	DeleteBoardRecord(boardID, modifiedBy string) error
	DeleteBlockRecord(blockID, modifiedBy string) error
}

type NotSupportedError struct {
	msg string
}

func NewNotSupportedError(msg string) NotSupportedError {
	return NotSupportedError{msg: msg}
}

func (pe NotSupportedError) Error() string {
	return pe.msg
}