forked from keybase/client
/
list_tracking.go
214 lines (184 loc) · 5.9 KB
/
list_tracking.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
// Copyright 2015 Keybase, Inc. All rights reserved. Use of
// this source code is governed by the included BSD license.
package engine
import (
"errors"
"fmt"
"regexp"
"sort"
"time"
"github.com/keybase/client/go/libkb"
keybase1 "github.com/keybase/client/go/protocol/keybase1"
jsonw "github.com/keybase/go-jsonw"
)
type ListTrackingEngineArg struct {
Assertion string
UID keybase1.UID
CachedOnly bool
// If CachedOnly is set and StalenessWindow is non-nil, will load with
// StaleOK and use the relaxed CachedOnlyStalenessWindow instead.
CachedOnlyStalenessWindow *time.Duration
JSON bool
Verbose bool
Filter string
}
// ListTrackingEngine loads the follows of the given user using their sigchain,
// but relies on the server to filter out users who have reset after the follow
// statement.
type ListTrackingEngine struct {
arg *ListTrackingEngineArg
tableResult keybase1.UserSummarySet
jsonResult string
libkb.Contextified
disableTrackerSyncerForTest bool
}
func NewListTrackingEngine(g *libkb.GlobalContext, arg *ListTrackingEngineArg) *ListTrackingEngine {
return &ListTrackingEngine{
arg: arg,
Contextified: libkb.NewContextified(g),
}
}
func (e *ListTrackingEngine) Name() string {
return "ListTracking"
}
func (e *ListTrackingEngine) Prereqs() Prereqs { return Prereqs{} }
func (e *ListTrackingEngine) RequiredUIs() []libkb.UIKind { return []libkb.UIKind{} }
func (e *ListTrackingEngine) SubConsumers() []libkb.UIConsumer { return nil }
func (e *ListTrackingEngine) Run(m libkb.MetaContext) (err error) {
uid, err := lookupUID(m, e.arg.UID, e.arg.Assertion, e.arg.CachedOnly)
if err != nil {
return err
}
// Get version according to server so we can filter out reset users later
ts := libkb.NewServertrustTrackerSyncer(m.G(), m.G().GetMyUID(), libkb.FollowDirectionFollowing)
var tsErr error
if e.disableTrackerSyncerForTest {
tsErr = errors.New("tracker syncer disabled for test")
} else if e.arg.CachedOnly {
tsErr = libkb.RunSyncerCached(m, ts, uid)
} else {
tsErr = libkb.RunSyncer(m, ts, uid, false /* loggedIn */, false /* forceReload */)
}
useServerLookup := false
serverLookup := make(map[keybase1.UID]struct{})
fullNames := make(map[keybase1.UID]string)
if tsErr != nil {
m.Warning("failed to load following list from server (cachedOnly=%t); continuing: %s", e.arg.CachedOnly, tsErr)
} else {
useServerLookup = true
m.Debug("got following list from server (len=%d, cachedOnly=%t); using it to filter sigchain list", len(ts.Result().Users), e.arg.CachedOnly)
for _, user := range ts.Result().Users {
serverLookup[user.Uid] = struct{}{}
fullNames[user.Uid] = user.FullName
}
}
// Load unstubbed so we get track links
larg := libkb.NewLoadUserArgWithMetaContext(m).
WithUID(uid).
WithStubMode(libkb.StubModeUnstubbed).
WithCachedOnly(e.arg.CachedOnly).
WithSelf(uid.Exists() && uid.Equal(m.G().GetMyUID()))
if e.arg.CachedOnly && e.arg.CachedOnlyStalenessWindow != nil {
larg = larg.WithStaleOK(true)
}
upak, _, err := m.G().GetUPAKLoader().LoadV2(larg)
if err != nil {
return err
}
if upak == nil {
return libkb.UserNotFoundError{}
}
if e.arg.CachedOnly && e.arg.CachedOnlyStalenessWindow != nil {
if m.G().Clock().Since(keybase1.FromTime(upak.Uvv.CachedAt)) > *e.arg.CachedOnlyStalenessWindow {
msg := fmt.Sprintf("upak was cached but exceeded custom staleness window %v", *e.arg.CachedOnlyStalenessWindow)
return libkb.UserNotFoundError{UID: uid, Msg: msg}
}
}
unfilteredTracks := upak.Current.RemoteTracks
var rxx *regexp.Regexp
if e.arg.Filter != "" {
rxx, err = regexp.Compile(e.arg.Filter)
if err != nil {
return err
}
}
// Filter out any marked reset by server, or due to Filter argument
var filteredTracks []keybase1.RemoteTrack
for _, track := range unfilteredTracks {
trackedUID := track.Uid
if useServerLookup {
if _, ok := serverLookup[trackedUID]; !ok {
m.Debug("filtering out uid %s in sigchain list but not provided by server", trackedUID)
continue
}
}
if rxx != nil && !rxx.MatchString(track.Username) {
continue
}
filteredTracks = append(filteredTracks, track)
}
sort.Slice(filteredTracks, func(i, j int) bool {
return filteredTracks[i].Username < filteredTracks[j].Username
})
if e.arg.JSON {
return e.runJSON(m, filteredTracks, e.arg.Verbose)
}
return e.runTable(m, filteredTracks, fullNames)
}
func (e *ListTrackingEngine) runTable(m libkb.MetaContext, filteredTracks []keybase1.RemoteTrack, fullNames map[keybase1.UID]string) error {
e.tableResult = keybase1.UserSummarySet{}
for _, track := range filteredTracks {
linkID := track.LinkID
entry := keybase1.UserSummary{
Uid: track.Uid,
Username: track.Username,
LinkID: &linkID,
FullName: fullNames[track.Uid],
}
e.tableResult.Users = append(e.tableResult.Users, entry)
}
return nil
}
func condenseRecord(t keybase1.RemoteTrack) (*jsonw.Wrapper, error) {
out := jsonw.NewDictionary()
err := out.SetKey("uid", libkb.UIDWrapper(t.Uid))
if err != nil {
return nil, err
}
err = out.SetKey("username", jsonw.NewString(t.Username))
if err != nil {
return nil, err
}
err = out.SetKey("link_id", jsonw.NewString(t.LinkID.String()))
if err != nil {
return nil, err
}
return out, nil
}
func (e *ListTrackingEngine) runJSON(m libkb.MetaContext, filteredTracks []keybase1.RemoteTrack, verbose bool) error {
var tmp []*jsonw.Wrapper
for _, track := range filteredTracks {
var rec *jsonw.Wrapper
var e2 error
if rec, e2 = condenseRecord(track); e2 != nil {
m.Warning("In conversion to JSON: %s", e2)
}
if e2 == nil {
tmp = append(tmp, rec)
}
}
ret := jsonw.NewArray(len(tmp))
for i, r := range tmp {
if err := ret.SetIndex(i, r); err != nil {
return err
}
}
e.jsonResult = ret.MarshalPretty()
return nil
}
func (e *ListTrackingEngine) TableResult() keybase1.UserSummarySet {
return e.tableResult
}
func (e *ListTrackingEngine) JSONResult() string {
return e.jsonResult
}