summaryrefslogtreecommitdiff
path: root/cmd/generate/mailstuff/thread_alg.go
blob: 1b351e9b5de7792ad1e38944f67c966fd6d47250 (plain)
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
package mailstuff

import (
	"regexp"
	"strings"
)

// https://www.jwz.org/doc/threading.html

// TODO: See ./jwz.md for RFC 5256 changes we might want to bring in.

// Definitions /////////////////////////////////////////////////////////////////

type jwzContainer struct {
	Message  *jwzMessage
	Parent   *jwzContainer
	Children Set[*jwzContainer]
}

type jwzMessage struct {
	Subject    string
	ID         jwzID
	References []jwzID
}

type jwzID = MessageID //string

func (ancestor *jwzContainer) IsAncestorOf(descendent *jwzContainer) bool {
	if ancestor == descendent {
		return true
	}
	for child := range ancestor.Children {
		if child.IsAncestorOf(descendent) {
			return true
		}
	}
	return false
}

// The Algorithm ///////////////////////////////////////////////////////////////

var jwzSubjectRE = regexp.MustCompile(`^(?:\s*[Rr][Ee](?:\[[0-9]+\])?:)*`)

func jwzThreadMessages(msgs map[jwzID]*jwzMessage) Set[*jwzContainer] {
	idTable := make(map[jwzID]*jwzContainer, len(msgs))

	// 1. For each message
	for _, msg := range msgs {
		// A.
		msgContainer := idTable[msg.ID]
		if msgContainer != nil && msgContainer.Message == nil {
			msgContainer.Message = msg
		} else {
			msgContainer = &jwzContainer{
				Message:  msg,
				Children: make(Set[*jwzContainer]),
			}
			idTable[msg.ID] = msgContainer
		}
		// B.
		for _, refID := range msg.References {
			refContainer := idTable[refID]
			if refContainer == nil {
				refContainer = &jwzContainer{
					Children: make(Set[*jwzContainer]),
				}
				idTable[refID] = refContainer
			}
		}
		for i := 0; i+1 < len(msg.References); i++ {
			parent := idTable[msg.References[i]]
			child := idTable[msg.References[i+1]]
			if child.Parent == nil && !parent.IsAncestorOf(child) && !child.IsAncestorOf(parent) {
				parent.Children.Insert(child)
				child.Parent = parent
			}
		}
		// C.
		if len(msg.References) == 0 {
			if msgContainer.Parent != nil {
				delete(msgContainer.Parent.Children, msgContainer)
			}
			msgContainer.Parent = nil
		} else {
			msgContainer.Parent = idTable[msg.References[len(msg.References)-1]]
			msgContainer.Parent.Children.Insert(msgContainer)
		}
	}

	// 2. Find the root Set
	root := &jwzContainer{
		Children: make(Set[*jwzContainer]),
	}
	for _, container := range idTable {
		if container.Parent == nil {
			container.Parent = root
			root.Children.Insert(container)
		}
	}

	// 3. Discard id_table
	idTable = nil

	// 4. Prune empty containers
	var recurse func(*jwzContainer)
	recurse = func(container *jwzContainer) {
		// Recurse.  This is a touch complicated because
		// `recurse(child)` might insert into
		// `container.Children`, and those insertions might
		// not be emitted by the range loop
		for visited := make(Set[*jwzContainer]); ; {
			beforeSize := len(visited)
			for child := range container.Children {
				if visited.Has(child) {
					continue
				}
				recurse(child)
				visited.Insert(child)
			}
			if len(visited) == beforeSize {
				break
			}
		}
		if container.Parent == nil {
			return
		}
		// Main.
		if container.Message == nil {
			if len(container.Children) == 0 { // A.
				delete(container.Parent.Children, container)
			} else { // B.
				if len(container.Children) == 1 || container.Parent != root {
					for child := range container.Children {
						container.Parent.Children.Insert(child)
						child.Parent = container.Parent
					}
					delete(container.Parent.Children, container)
				}
			}
		}
	}
	recurse(root)

	// 5. Group root Set by subject
	// A.
	subjectTable := make(map[string]*jwzContainer)
	// B.
	for this := range root.Children {
		var subject string
		if this.Message != nil {
			subject = this.Message.Subject
		} else {
			subject = this.Children.PickOne().Message.Subject
		}
		prefix := jwzSubjectRE.FindString(subject)
		subject = strings.TrimSpace(subject[len(prefix):])
		if subject == "" {
			continue
		}
		if other := subjectTable[subject]; other == nil {
			subjectTable[subject] = this
		} else if other.Message == nil {
			subjectTable[subject] = this
		} else if jwzSubjectRE.MatchString(other.Message.Subject) && prefix == "" {
			subjectTable[subject] = this
		}
	}
	// C.
	for this := range root.Children {
		var subject string
		if this.Message != nil {
			subject = this.Message.Subject
		} else {
			subject = this.Children.PickOne().Message.Subject
		}
		prefix := jwzSubjectRE.FindString(subject)
		subject = strings.TrimSpace(subject[len(prefix):])

		other := subjectTable[subject]
		if other == nil || other == this {
			continue
		}

		switch {
		case this.Message == nil && other.Message == nil:
			for child := range this.Children {
				other.Children.Insert(child)
				child.Parent = other
			}
			delete(root.Children, this)
		case (this.Message == nil) != (other.Message == nil):
			var empty, nonEmpty *jwzContainer
			if this.Message == nil {
				empty = this
				nonEmpty = other
			} else {
				empty = other
				nonEmpty = this
			}
			empty.Children.Insert(nonEmpty)
			nonEmpty.Parent = empty
		case other.Message != nil && !jwzSubjectRE.MatchString(other.Message.Subject) && prefix != "":
			other.Children.Insert(this)
			this.Parent = other
		// skip the reverse of the above case--it happened implicitly
		default:
			newParent := &jwzContainer{
				Children: make(Set[*jwzContainer], 2),
			}
			newParent.Children.Insert(this)
			this.Parent = newParent
			newParent.Children.Insert(other)
			other.Parent = newParent
			subjectTable[subject] = newParent
			root.Children.Insert(newParent)
			delete(root.Children, this)
			delete(root.Children, other)
		}
	}

	// 6. Now you're done threading
	for child := range root.Children {
		child.Parent = nil
	}
	return root.Children
}