File: graph.go

package info (click to toggle)
bettercap 2.33.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 8,668 kB
  • sloc: sh: 154; makefile: 76; python: 52; ansic: 9
file content (425 lines) | stat: -rw-r--r-- 8,932 bytes parent folder | download
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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
package graph

import (
	"encoding/json"
	"fmt"
	"github.com/bettercap/bettercap/session"
	"github.com/evilsocket/islazy/fs"
	"path"
	"sync"
	"time"
)

var Loaded = (* Graph)(nil)

type NodeCallback func(*Node)
type EdgeCallback func(*Node, []Edge, *Node)

type Graph struct {
	sync.Mutex

	path  string
	edges *Edges
}

func NewGraph(path string) (*Graph, error) {
	if edges, err := LoadEdges(path); err != nil {
		return nil, err
	} else {
		Loaded = &Graph{
			path:  path,
			edges: edges,
		}
		return Loaded, nil
	}
}

func (g *Graph) EachNode(cb NodeCallback) error {
	g.Lock()
	defer g.Unlock()

	for _, nodeType := range NodeTypes {
		err := fs.Glob(g.path, fmt.Sprintf("%s_*.json", nodeType), func(fileName string) error {
			if node, err := ReadNode(fileName); err != nil {
				return err
			} else {
				cb(node)
			}
			return nil
		})
		if err != nil {
			return err
		}
	}
	return nil
}

func (g *Graph) EachEdge(cb EdgeCallback) error {
	g.Lock()
	defer g.Unlock()

	return g.edges.ForEachEdge(func(fromID string, edges []Edge, toID string) error {
		var left, right *Node
		var err error

		leftFileName := path.Join(g.path, fromID+".json")
		rightFileName := path.Join(g.path, toID+".json")

		if left, err = ReadNode(leftFileName); err != nil {
			return err
		} else if right, err = ReadNode(rightFileName); err != nil {
			return err
		}

		cb(left, edges, right)

		return nil
	})
}

func (g *Graph) Traverse(root string, onNode NodeCallback, onEdge EdgeCallback) error {
	if root == "" {
		// traverse the entire graph
		if err := g.EachNode(onNode); err != nil {
			return err
		} else if err = g.EachEdge(onEdge); err != nil {
			return err
		}
	} else {
		// start by a specific node
		roots, err := g.FindOtherTypes("", root)
		if err != nil {
			return err
		}

		stack := NewStack()
		for _, root := range roots {
			stack.Push(root)
		}

		type edgeBucket struct {
			left  *Node
			edges []Edge
			right *Node
		}

		allEdges := make([]edgeBucket, 0)
		visited := make(map[string]bool)

		for {
			if last := stack.Pop(); last == nil {
				break
			} else {
				node := last.(*Node)
				nodeID := node.String()
				if _, found := visited[nodeID]; found {
					continue
				} else {
					visited[nodeID] = true
				}

				onNode(node)

				// collect all edges starting from this node
				err = g.edges.ForEachEdgeFrom(nodeID, func(_ string, edges []Edge, toID string) error {
					rightFileName := path.Join(g.path, toID+".json")
					if right, err := ReadNode(rightFileName); err != nil {
						return err
					} else {
						// collect new node
						if _, found := visited[toID]; !found {
							stack.Push(right)
						}
						// collect all edges, we'll emit this later
						allEdges = append(allEdges, edgeBucket{
							left:  node,
							edges: edges,
							right: right,
						})
					}
					return nil
				})
			}
		}

		for _, edge := range allEdges {
			onEdge(edge.left, edge.edges, edge.right)
		}
	}

	return nil
}

func (g *Graph) IsConnected(nodeType string, nodeID string) bool {
	return g.edges.IsConnected(fmt.Sprintf("%s_%s", nodeType, nodeID))
}

func (g *Graph) Dot(filter, layout, name string, disconnected bool) (string, int, int, error) {
	size := 0
	discarded := 0

	data := fmt.Sprintf("digraph %s {\n", name)
	data += fmt.Sprintf("  layout=%s\n", layout)

	typeMap := make(map[NodeType]bool)

	type typeCount struct {
		edge  Edge
		count int
	}

	if err := g.Traverse(filter, func(node *Node) {
		include := false
		if disconnected {
			include = true
		} else {
			include = g.edges.IsConnected(node.String())
		}

		if include {
			size++
			typeMap[node.Type] = true
			data += fmt.Sprintf("  %s\n", node.Dot(filter == node.ID))
		} else {
			discarded++
		}
	}, func(left *Node, edges []Edge, right *Node) {
		// collect counters by edge type in order to calculate proportional widths
		byType := make(map[string]typeCount)
		tot := len(edges)

		for _, edge := range edges {
			if c, found := byType[string(edge.Type)]; found {
				c.count++
			} else {
				byType[string(edge.Type)] = typeCount{
					edge:  edge,
					count: 1,
				}
			}
		}

		max := 2.0
		for _, c := range byType {
			w := max * float64(c.count/tot)
			if w < 0.5 {
				w = 0.5
			}
			data += fmt.Sprintf("  %s\n", c.edge.Dot(left, right, w))
		}
	}); err != nil {
		return "", 0, 0, err
	}

	/*
		data += "\n"
		data += "node [style=filled height=0.55 fontname=\"Verdana\" fontsize=10];\n"
		data += "subgraph legend {\n" +
				"graph[style=dotted];\n" +
				"label = \"Legend\";\n"

		var types []NodeType
		for nodeType, _ := range typeMap {
			types = append(types, nodeType)
			node := Node{
				Type:        nodeType,
				Annotations: nodeTypeDescs[nodeType],
				Dummy:       true,
			}
			data += fmt.Sprintf("  %s\n", node.Dot(false))
		}

		ntypes := len(types)
		for i := 0; i < ntypes - 1; i++ {
			data += fmt.Sprintf("  \"%s\" -> \"%s\" [style=invis];\n", types[i], types[i + 1])
		}
		data += "}\n"
	*/

	data += "\n"
	data += "  overlap=false\n"
	data += "}"

	return data, size, discarded, nil
}

func (g *Graph) JSON(filter string, disconnected bool) (string, int, int, error) {
	size := 0
	discarded := 0

	type link struct {
		Source string      `json:"source"`
		Target string      `json:"target"`
		Edge   interface{} `json:"edge"`
	}

	type data struct {
		Nodes []map[string]interface{} `json:"nodes"`
		Links []link                   `json:"links"`
	}

	jsData := data{
		Nodes: make([]map[string]interface{}, 0),
		Links: make([]link, 0),
	}

	if err := g.Traverse(filter, func(node *Node) {
		include := false
		if disconnected {
			include = true
		} else {
			include = g.edges.IsConnected(node.String())
		}

		if include {
			size++

			if nm, err := node.ToMap(); err != nil {
				panic(err)
			} else {
				// patch id
				nm["id"] = node.String()
				jsData.Nodes = append(jsData.Nodes, nm)
			}
		} else {
			discarded++
		}
	}, func(left *Node, edges []Edge, right *Node) {
		for _, edge := range edges {
			jsData.Links = append(jsData.Links, link{
				Source: left.String(),
				Target: right.String(),
				Edge:   edge,
			})
		}
	}); err != nil {
		return "", 0, 0, err
	}

	if raw, err := json.Marshal(jsData); err != nil {
		return "", 0, 0, err
	} else {
		return string(raw), size, discarded, nil
	}
}

func (g *Graph) FindNode(t NodeType, id string) (*Node, error) {
	g.Lock()
	defer g.Unlock()

	nodeFileName := path.Join(g.path, fmt.Sprintf("%s_%s.json", t, id))
	if fs.Exists(nodeFileName) {
		return ReadNode(nodeFileName)
	}

	return nil, nil
}

func (g *Graph) FindOtherTypes(t NodeType, id string) ([]*Node, error) {
	g.Lock()
	defer g.Unlock()

	var otherNodes []*Node

	for _, otherType := range NodeTypes {
		if otherType != t {
			if nodeFileName := path.Join(g.path, fmt.Sprintf("%s_%s.json", otherType, id)); fs.Exists(nodeFileName) {
				if node, err := ReadNode(nodeFileName); err != nil {
					return nil, err
				} else {
					otherNodes = append(otherNodes, node)
				}
			}
		}
	}

	return otherNodes, nil
}

func (g *Graph) CreateNode(t NodeType, id string, entity interface{}, annotations string) (*Node, error) {
	g.Lock()
	defer g.Unlock()

	node := &Node{
		Type:        t,
		ID:          id,
		Entity:      entity,
		Annotations: annotations,
	}

	nodeFileName := path.Join(g.path, fmt.Sprintf("%s.json", node.String()))
	if err := CreateNode(nodeFileName, node); err != nil {
		return nil, err
	}

	session.I.Events.Add("graph.node.new", node)

	return node, nil
}

func (g *Graph) UpdateNode(node *Node) error {
	g.Lock()
	defer g.Unlock()

	nodeFileName := path.Join(g.path, fmt.Sprintf("%s.json", node.String()))
	if err := UpdateNode(nodeFileName, node); err != nil {
		return err
	}

	return nil
}

func (g *Graph) FindLastEdgeOfType(from, to *Node, edgeType EdgeType) (*Edge, error) {
	edges := g.edges.FindEdges(from.String(), to.String(), true)
	num := len(edges)
	for i := range edges {
		// loop backwards
		idx := num - 1 - i
		edge := edges[idx]
		if edge.Type == edgeType {
			return &edge, nil
		}
	}
	return nil, nil
}

func (g *Graph) FindLastRecentEdgeOfType(from, to *Node, edgeType EdgeType, staleTime time.Duration) (*Edge, error) {
	edges := g.edges.FindEdges(from.String(), to.String(), true)
	num := len(edges)
	for i := range edges {
		// loop backwards
		idx := num - 1 - i
		edge := edges[idx]
		if edge.Type == edgeType {
			if time.Since(edge.CreatedAt) >= staleTime {
				return nil, nil
			}
			return &edge, nil
		}
	}

	return nil, nil
}

func (g *Graph) CreateEdge(from, to *Node, edgeType EdgeType) (*Edge, error) {
	edge := Edge{
		Type:      edgeType,
		CreatedAt: time.Now(),
	}

	if session.I.GPS.Updated.IsZero() == false {
		edge.Position = &session.I.GPS
	}

	if err := g.edges.Connect(from.String(), to.String(), edge); err != nil {
		return nil, err
	}

	session.I.Events.Add("graph.edge.new", EdgeEvent{
		Left:  from,
		Edge:  &edge,
		Right: to,
	})

	return &edge, nil
}