github.com/keybase/client/go@v0.0.0-20240309051027-028f7c731f8b/kbfs/kbfsedits/user_history.go

// Copyright 2018 Keybase Inc. All rights reserved.
// Use of this source code is governed by a BSD
// license that can be found in the LICENSE file.

package kbfsedits

import (
	"context"
	"fmt"
	"sort"
	"strings"
	"sync"

	"github.com/keybase/client/go/kbfs/tlf"
	"github.com/keybase/client/go/libkb"
	"github.com/keybase/client/go/logger"
	"github.com/keybase/client/go/protocol/keybase1"
)

const (
	// MaxClusters is the max number of TLF writer clusters to return
	// in a user history.
	MaxClusters = 10

	// The minimum number of self-clusters that should appear in the
	// history for the logged-in user.
	minNumSelfClusters = 3
)

type tlfKey struct {
	tlfName tlf.CanonicalName
	tlfType tlf.Type
}

// UserHistory keeps a sorted list of the top known TLF edit
// histories, and can convert those histories into keybase1 protocol
// structs.  TLF histories must be updated by an external caller
// whenever they change.
type UserHistory struct {
	lock      sync.RWMutex
	histories map[tlfKey]writersByRevision
	log       logger.Logger
	vlog      *libkb.VDebugLog
}

// NewUserHistory constructs a UserHistory instance.
func NewUserHistory(log logger.Logger, vlog *libkb.VDebugLog) *UserHistory {
	return &UserHistory{
		histories: make(map[tlfKey]writersByRevision),
		log:       log,
		vlog:      vlog,
	}
}

// UpdateHistory should be called whenever the edit history for a
// given TLF gets new information.
func (uh *UserHistory) UpdateHistory(
	tlfName tlf.CanonicalName, tlfType tlf.Type, tlfHistory *TlfHistory,
	loggedInUser string) {
	uh.vlog.CLogf(
		context.TODO(), libkb.VLog1, "Updating user history for TLF %s, "+
			"user %s", tlfName, loggedInUser)
	history := tlfHistory.getHistory(loggedInUser)
	key := tlfKey{tlfName, tlfType}

	uh.lock.Lock()
	defer uh.lock.Unlock()
	uh.histories[key] = history
}

func (uh *UserHistory) getTlfHistoryLocked(
	tlfName tlf.CanonicalName, tlfType tlf.Type) (
	history keybase1.FSFolderEditHistory) {
	key := tlfKey{tlfName, tlfType}
	tlfHistory, ok := uh.histories[key]
	if !ok {
		return keybase1.FSFolderEditHistory{}
	}

	folder := keybase1.Folder{
		Name:       string(tlfName),
		FolderType: tlfType.FolderType(),
		Private:    tlfType == tlf.Private,
	}
	history.Folder = folder
	if len(tlfHistory) == 0 {
		return history
	}
	if len(tlfHistory[0].notifications) > 0 {
		history.ServerTime = keybase1.ToTime(
			tlfHistory[0].notifications[0].Time)
		// If there are no notifications (only deletes), leave
		// `ServerTime` unset.
	}
	history.History = make(
		[]keybase1.FSFolderWriterEditHistory, len(tlfHistory))
	for i, wn := range tlfHistory {
		history.History[i].WriterName = wn.writerName
		history.History[i].Edits = make(
			[]keybase1.FSFolderWriterEdit, len(wn.notifications))
		for j, n := range wn.notifications {
			history.History[i].Edits[j].Filename = n.Filename
			history.History[i].Edits[j].ServerTime = keybase1.ToTime(n.Time)
			switch n.Type {
			case NotificationCreate:
				history.History[i].Edits[j].NotificationType =
					keybase1.FSNotificationType_FILE_CREATED
			case NotificationModify:
				history.History[i].Edits[j].NotificationType =
					keybase1.FSNotificationType_FILE_MODIFIED
			default:
				panic(fmt.Sprintf("Unknown notification type %s", n.Type))
			}
		}

		history.History[i].Deletes = make(
			[]keybase1.FSFolderWriterEdit, len(wn.deletes))
		for j, n := range wn.deletes {
			history.History[i].Deletes[j].Filename = n.Filename
			history.History[i].Deletes[j].ServerTime = keybase1.ToTime(n.Time)
			history.History[i].Deletes[j].NotificationType =
				keybase1.FSNotificationType_FILE_DELETED
		}
	}
	return history
}

// GetTlfHistory returns the edit history of a given TLF, converted to
// keybase1 protocol structs.
func (uh *UserHistory) GetTlfHistory(
	tlfName tlf.CanonicalName, tlfType tlf.Type) (
	history keybase1.FSFolderEditHistory) {
	uh.lock.RLock()
	defer uh.lock.RUnlock()
	return uh.getTlfHistoryLocked(tlfName, tlfType)
}

type historyClusters []keybase1.FSFolderEditHistory

func (hc historyClusters) Len() int {
	return len(hc)
}

func (hc historyClusters) Less(i, j int) bool {
	iTime := hc[i].ServerTime
	jTime := hc[j].ServerTime

	if iTime == 0 && jTime == 0 {
		// If both are zero, use the times of the first delete instead.
		if len(hc[i].History[0].Deletes) > 0 {
			iTime = hc[i].History[0].Deletes[0].ServerTime
		}
		if len(hc[j].History[0].Deletes) > 0 {
			jTime = hc[j].History[0].Deletes[0].ServerTime
		}
	}

	return iTime > jTime
}

func (hc historyClusters) Swap(i, j int) {
	hc[i], hc[j] = hc[j], hc[i]
}

// Get returns the full edit history for the user, converted to
// keybase1 protocol structs.
func (uh *UserHistory) Get(loggedInUser string) (
	history []keybase1.FSFolderEditHistory) {
	uh.lock.RLock()
	defer uh.lock.RUnlock()
	uh.vlog.CLogf(
		context.TODO(), libkb.VLog1, "User history requested: %s", loggedInUser)
	var clusters historyClusters
	for key := range uh.histories {
		history := uh.getTlfHistoryLocked(key.tlfName, key.tlfType)

		// Only include public TLFs if they match the logged-in user.
		if history.Folder.FolderType == keybase1.FolderType_PUBLIC {
			names := strings.Split(history.Folder.Name, ",")
			match := false
			for _, name := range names {
				if name == loggedInUser {
					match = true
					break
				}
			}
			if !match {
				continue
			}
		}

		// Break it up into individual clusters
		for _, wh := range history.History {
			if len(wh.Edits) > 0 || len(wh.Deletes) > 0 {
				var serverTime keybase1.Time
				if len(wh.Edits) > 0 {
					serverTime = wh.Edits[0].ServerTime
				}
				clusters = append(clusters, keybase1.FSFolderEditHistory{
					Folder:     history.Folder,
					ServerTime: serverTime,
					History:    []keybase1.FSFolderWriterEditHistory{wh},
				})
			}
		}
	}

	// We need to sort these by the ServerTime of these particular edits,
	// not by the full TLF time.
	sort.Sort(clusters)

	// TODO: consolidate neighboring clusters that share the same folder?
	if len(clusters) > MaxClusters {
		// Find the top self-clusters.
		loggedInIndices := make([]int, 0, minNumSelfClusters)
		for i, c := range clusters {
			if c.History[0].WriterName == loggedInUser {
				loggedInIndices = append(loggedInIndices, i)
			}
			if len(loggedInIndices) == minNumSelfClusters {
				break
			}
		}

		// Move each self-cluster into its rightful spot at the end of
		// the slice, unless it's already at a lower index.
		for i, loggedInIndex := range loggedInIndices {
			newLoggedInIndex := MaxClusters - (len(loggedInIndices) - i)
			if loggedInIndex < newLoggedInIndex {
				continue
			}
			clusters[newLoggedInIndex] = clusters[loggedInIndex]
		}

		return clusters[:MaxClusters]
	}
	return clusters
}

// Clear erases all saved histories; TLFs must be re-added.
func (uh *UserHistory) Clear() {
	uh.lock.Lock()
	defer uh.lock.Unlock()
	uh.histories = make(map[tlfKey]writersByRevision)
}

// ClearTLF removes a TLF from this UserHistory.
func (uh *UserHistory) ClearTLF(tlfName tlf.CanonicalName, tlfType tlf.Type) {
	key := tlfKey{tlfName, tlfType}
	uh.lock.Lock()
	defer uh.lock.Unlock()
	delete(uh.histories, key)
}