corso/src/pkg/backup/details/groups.go

package details

import (
	"strconv"
	"strings"
	"time"

	"github.com/alcionai/clues"
	"github.com/dustin/go-humanize"

	"github.com/alcionai/corso/src/pkg/dttm"
	"github.com/alcionai/corso/src/pkg/path"
)

// NewGroupsLocationIDer builds a LocationIDer for the groups.
func NewGroupsLocationIDer(
	category path.CategoryType,
	driveID string,
	escapedFolders ...string,
) (uniqueLoc, error) {
	if err := path.ValidateServiceAndCategory(path.GroupsService, category); err != nil {
		return uniqueLoc{}, clues.Wrap(err, "making groups LocationIDer")
	}

	pb := path.Builder{}.Append(category.String())
	prefixElems := 1

	if len(driveID) > 0 { // non sp paths don't have driveID
		pb = pb.Append(driveID)

		prefixElems = 2
	}

	pb = pb.Append(escapedFolders...)

	return uniqueLoc{pb, prefixElems}, nil
}

// GroupsInfo describes a groups item
type GroupsInfo struct {
	ItemType ItemType  `json:"itemType,omitempty"`
	Modified time.Time `json:"modified,omitempty"`

	// Channels Specific
	Message   ChannelMessageInfo `json:"message,omitempty"`
	LastReply ChannelMessageInfo `json:"lastReply,omitempty"`

	// Conversations Specific
	Post ConversationPostInfo `json:"post,omitempty"`

	// SharePoint specific
	Created    time.Time `json:"created,omitempty"`
	DriveName  string    `json:"driveName,omitempty"`
	DriveID    string    `json:"driveID,omitempty"`
	ItemName   string    `json:"itemName,omitempty"`
	Owner      string    `json:"owner,omitempty"`
	ParentPath string    `json:"parentPath,omitempty"`
	SiteID     string    `json:"siteID,omitempty"`
	Size       int64     `json:"size,omitempty"`
	WebURL     string    `json:"webURL,omitempty"`
}

type ConversationPostInfo struct {
	CreatedAt time.Time `json:"createdAt,omitempty"`
	Creator   string    `json:"creator,omitempty"`
	Preview   string    `json:"preview,omitempty"`
	Size      int64     `json:"size,omitempty"`
	Topic     string    `json:"topic,omitempty"`
}

type ChannelMessageInfo struct {
	AttachmentNames []string  `json:"attachmentNames,omitempty"`
	CreatedAt       time.Time `json:"createdAt,omitempty"`
	Creator         string    `json:"creator,omitempty"`
	Preview         string    `json:"preview,omitempty"`
	ReplyCount      int       `json:"replyCount"`
	Size            int64     `json:"size,omitempty"`
	Subject         string    `json:"subject,omitempty"`
}

// Headers returns the human-readable names of properties in a gropusInfo
// for printing out to a terminal in a columnar display.
func (i GroupsInfo) Headers() []string {
	switch i.ItemType {
	case SharePointLibrary:
		return []string{"ItemName", "Library", "ParentPath", "Size", "Owner", "Created", "Modified"}
	case GroupsChannelMessage:
		return []string{"Message", "Channel", "Subject", "Replies", "Creator", "Created", "Last Reply"}
	case GroupsConversationPost:
		return []string{"Post", "Conversation", "Sender", "Created"}
	}

	return []string{}
}

// Values returns the values matching the Headers list for printing
// out to a terminal in a columnar display.
func (i GroupsInfo) Values() []string {
	switch i.ItemType {
	case SharePointLibrary:
		return []string{
			i.ItemName,
			i.DriveName,
			i.ParentPath,
			humanize.Bytes(uint64(i.Size)),
			i.Owner,
			dttm.FormatToTabularDisplay(i.Created),
			dttm.FormatToTabularDisplay(i.Modified),
		}
	case GroupsChannelMessage:
		lastReply := dttm.FormatToTabularDisplay(i.LastReply.CreatedAt)
		if i.LastReply.CreatedAt.IsZero() {
			lastReply = ""
		}

		return []string{
			// html parsing may produce newlines, which we'll want to avoid
			strings.ReplaceAll(i.Message.Preview, "\n", "\\n"),
			i.ParentPath,
			i.Message.Subject,
			strconv.Itoa(i.Message.ReplyCount),
			i.Message.Creator,
			dttm.FormatToTabularDisplay(i.Message.CreatedAt),
			lastReply,
		}
	case GroupsConversationPost:
		return []string{
			// html parsing may produce newlines, which we'll want to avoid
			strings.ReplaceAll(i.Post.Preview, "\n", "\\n"),
			i.Post.Topic,
			i.Post.Creator,
			dttm.FormatToTabularDisplay(i.Post.CreatedAt),
		}
	}

	return []string{}
}

func (i *GroupsInfo) UpdateParentPath(newLocPath *path.Builder) {
	i.ParentPath = newLocPath.String()
}

func (i *GroupsInfo) uniqueLocation(baseLoc *path.Builder) (*uniqueLoc, error) {
	var (
		loc uniqueLoc
		err error
	)

	switch i.ItemType {
	case SharePointLibrary:
		if len(i.DriveID) == 0 {
			return nil, clues.New("empty drive ID")
		}

		loc, err = NewGroupsLocationIDer(path.LibrariesCategory, i.DriveID, baseLoc.Elements()...)
	case GroupsChannelMessage:
		loc, err = NewGroupsLocationIDer(path.ChannelMessagesCategory, "", baseLoc.Elements()...)
	case GroupsConversationPost:
		loc, err = NewGroupsLocationIDer(path.ConversationPostsCategory, "", baseLoc.Elements()...)
	}

	return &loc, err
}

func (i *GroupsInfo) updateFolder(f *FolderInfo) error {
	f.DataType = i.ItemType

	switch i.ItemType {
	case SharePointLibrary:
		return updateFolderWithinDrive(SharePointLibrary, i.DriveName, i.DriveID, f)
	case GroupsChannelMessage, GroupsConversationPost:
		return nil
	}

	return clues.New("unsupported ItemType for GroupsInfo").With("item_type", i.ItemType)
}