go/engine/favorite_list.go - master - githubmirror/client

go/engine/favorite_list.go
95 строк2 KB
Maxwell Krohn
all callers of API#Get() switched over to libkb.MetaContext (#16460)
08 мар 2019, 06:20
08 мар 2019, 06:20a5dce81
// Copyright 2015 Keybase, Inc. All rights reserved. Use of
// this source code is governed by the included BSD license.

package engine

import (
	"github.com/keybase/client/go/libkb"
	keybase1 "github.com/keybase/client/go/protocol/keybase1"
)

// FavoriteList is an engine.
type FavoriteList struct {
	libkb.Contextified
	result FavoritesAPIResult
}

// NewFavoriteList creates a FavoriteList engine.
func NewFavoriteList(g *libkb.GlobalContext) *FavoriteList {
	return &FavoriteList{
		Contextified: libkb.NewContextified(g),
	}
}

// Name is the unique engine name.
func (e *FavoriteList) Name() string {
	return "FavoriteList"
}

// GetPrereqs returns the engine prereqs.
func (e *FavoriteList) Prereqs() Prereqs {
	return Prereqs{
		Device: true,
	}
}

// RequiredUIs returns the required UIs.
func (e *FavoriteList) RequiredUIs() []libkb.UIKind {
	return []libkb.UIKind{}
}

// SubConsumers returns the other UI consumers for this engine.
func (e *FavoriteList) SubConsumers() []libkb.UIConsumer {
	return nil
}

type FavoritesAPIResult struct {
	Status    libkb.AppStatus   `json:"status"`
	Favorites []keybase1.Folder `json:"favorites"`
	Ignored   []keybase1.Folder `json:"ignored"`
	New       []keybase1.Folder `json:"new"`
}

func (f *FavoritesAPIResult) GetAppStatus() *libkb.AppStatus {
	return &f.Status
}

func (e *FavoriteList) cacheFolder(m libkb.MetaContext, folder keybase1.Folder) {
	if folder.FolderType != keybase1.FolderType_TEAM || folder.TeamID == nil || folder.TeamID.IsNil() {
		return
	}
	name, err := keybase1.TeamNameFromString(folder.Name)
	if err != nil {
		m.Debug("cannot cache folder %+v: %s", folder, err)
		return
	}
	m.G().Resolver.CacheTeamResolution(m, *folder.TeamID, name)
}

func (e *FavoriteList) cacheFolders(m libkb.MetaContext, folders []keybase1.Folder) {
	for _, f := range folders {
		e.cacheFolder(m, f)
	}
}

// Run starts the engine.
func (e *FavoriteList) Run(m libkb.MetaContext) error {
	arg := libkb.NewRetryAPIArg("kbfs/favorite/list")
	arg.SessionType = libkb.APISessionTypeREQUIRED
	err := m.G().API.GetDecode(m, arg, &e.result)
	if err != nil {
		return err
	}
	e.cacheFolders(m, e.result.Favorites)
	e.cacheFolders(m, e.result.New)
	return nil
}

// Favorites returns the list of favorites that Run generated.
func (e *FavoriteList) Result() keybase1.FavoritesResult {
	return keybase1.FavoritesResult{
		FavoriteFolders: e.result.Favorites,
		IgnoredFolders:  e.result.Ignored,
		NewFolders:      e.result.New,
	}
}