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 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
|
package jwz
import (
"fmt"
"github.com/jhillyerd/enmime"
"io/fs"
"log"
"net/mail"
"os"
"path/filepath"
"regexp"
"strings"
"testing"
"time"
)
// Where we are going to store the emails. We know that the test data is of a fair size, so we tell the slice that
// in advance
//
var Emails = make([]Threadable, 0, 3000)
// TestMain sets up everything for the other test(s). It essentially parses a largish set of publicly available
// Emails in to a structure that can then be used to perform email threading testing. To perform the parsing, we
// use the enmime package at https://github.com/jhillyerd/enmime
//
func TestMain(m *testing.M) {
// Parse all the emails in the test directory
//
loadEmails()
// OK, we have a fairly large email set all parsed, so now we can let the real tests run
//
os.Exit(m.Run())
}
func loadEmails() {
_ = filepath.WalkDir("test/testdata", func(path string, d fs.DirEntry, err error) error {
if err != nil {
log.Printf("cannot process directory/file %s because: %#v", path, err)
os.Exit(1)
}
if d.IsDir() {
// Skip any directory entries, including the base test data dir
//
return nil
}
// We only look at files that have an eml extension
//
if !strings.HasSuffix(path, ".eml") {
return nil
}
f, e := os.Open(path)
if e != nil {
return err
}
envelope, e1 := enmime.ReadEnvelope(f)
_ = f.Close()
if e1 != nil {
log.Printf("cannot parse email file error = %v", e1)
return nil
}
// See if the parser thinks that there are errors - the error recording in the package
// is unfortunately a little hokey in that we just get some strings and will have to do
// lots of processing if it is left that way. I would prefer to contribute some code that
// processes errors like the AWS SDK, so we can check the types of error/warning etc.
//
if len(envelope.Errors) > 0 {
for _, ee := range envelope.Errors {
if ee.Severe {
log.Printf("enmime parse yields severe error. File '%s', error: %#v", path, ee)
return nil
}
log.Printf("enmime shows a non-fatal error. File '%s'm error: %#v", path, ee)
}
}
// All is good, so let's accumulate the email
//
email := NewEmail(envelope)
Emails = append(Emails, email)
return nil
})
}
// EmailRoot is a structure that implements the ThreadableRoot interface. I have not used ThreadableRoot
// here, but this is what it needs to look like if your input structure is not just a slice of Threadable
//
type EmailRoot struct {
// This is some structure of the emails you want to thread, that you know how to traverse
//
emails []Threadable
// You need some sort of position holder, which in this silly example is an index in the struct
//
position int
}
// Next sets the internal cursor to the next available Threadable
//
func (e *EmailRoot) Next() bool {
e.position = e.position + 1
if e.position < len(e.emails) {
return true
}
return false
}
// Get returns the Threadable at the current internal cursor position
//
func (e *EmailRoot) Get() Threadable {
return e.emails[e.position]
}
// NewThreadableRoot returns a struct instance that can be traversed using the ThreadableRoot interface
//
func NewThreadableRoot(emails []Threadable) ThreadableRoot {
tr := &EmailRoot{
emails: emails,
position: -1,
}
return tr
}
// Email is structure that implements the Threadable interface - this is what a user of this
// package needs to do.
//
type Email struct {
email *enmime.Envelope
next Threadable
parent Threadable
child Threadable
dummy bool
forID string
}
func (e *Email) GetNext() Threadable {
return e.next
}
func (e *Email) GetChild() Threadable {
return e.child
}
// GetParent the parent Threadable of this node, if any
//
func (e *Email) GetParent() Threadable {
return e.parent
}
// GetDate extracts the timestamp from the enmime envelope contained in the supplied Threadable
//
func (e *Email) GetDate() time.Time {
// We can have dummies because we are likely to have parsed a set of emails with incomplete threads,
// where the start of the thread or sub thread was referenced, but we did not get to parse it, at least yet.
// This means it will be a placeholder as the root for the thread, so we can use the time of the child as the
// time of this email.
//
if e.IsDummy() {
if e.GetChild() != nil {
return e.GetChild().GetDate()
}
// Protect against having nothing in the children that knows what time it is. So, back to the
// beginning of time according to Unix
//
return time.Unix(0, 0)
}
emailDateStr := e.email.GetHeader("Date")
d, err := mail.ParseDate(emailDateStr)
if err != nil {
return time.Unix(0, 0)
}
return d
}
var idre = regexp.MustCompile("<.*?>")
func (e *Email) MessageThreadID() string {
if e.dummy {
return e.forID
}
ref := e.email.GetHeader("Message-Id")
refs := idre.FindAllString(ref, -1)
if len(refs) > 0 {
return refs[0]
}
return "<bogus-id-in-email>"
}
func (e *Email) MessageThreadReferences() []string {
if e.dummy {
return nil
}
// This should be a nicely formatted field that has unique IDs enclosed within <>, and each of those should be
// space separated. However, it isn't as simple as this because all sorts of garbage mail clients have been programmed
// over the years by people who did not understand what the References field was (I'm looking at you
// Comcast, for instance). We can get things like:
//
// 1) References: Your message of Friday... <actual-ID> (Some garbage the programmer thought might be useful)
// 2) References: me@mydomain.com (This isn't even a reference, it is the sender's email)
// 3) References: <ref-1><ref-2><ref-3> (Either a pure bug, or they misread the spec)
//
// Further to this, we also need to filter out the following:
//
// 4) References: <this message-id> (The client author places this email as the first in the
// reference chain)
// 5) References: <ref-1><ref-2><ref-1> A pure bug somewhere in the chain repeats a reference
//
// The RFC has now been cleaned up to exactly specify this field, but we have to assume there are still
// 20 year old email clients out there and cater for them. Especially when we are testing with ancient
// public email bodies.
//
ref := e.email.GetHeader("References")
// Find all the correctly delimited references, which takes care of 1) and 3)
//
rawRefs := idre.FindAllString(ref, -1)
// Find the message Id, so we can take care of 4)
//
m := e.MessageThreadID()
// Find the From address, so we can deal with 2). Even though ignoring this would be harmless in that we would just
// think it is an email we never saw, it is wrong not to deal with here. We can avoid the clutter in the database
// by filtering them out.
//
fa, _ := e.email.AddressList("From")
// Make a set, so we can remove duplicates and deal with 5)
//
set := make(map[string]interface{})
// This will be our final return set, after de-fucking the references
//
var refs = make([]string, 0, len(rawRefs))
// Now we range through the references that the email has given us and make sure that the reference does
// not run afoul of 2), 4) or 5)
//
for _, r := range rawRefs {
// 2) and 5)
//
if _, repeated := set[r]; r != m && !repeated {
set[r] = nil
// Technically, From: can have more than one sender (back in the day before email lists
// got sorted), we will never see this in practice, but, in for a pound, in for a penny
//
var found bool = false
for _, f := range fa {
if r == "<"+f.Address+">" {
found = true
break
}
}
if !found {
// If we got thorough all of those checks, then Phew! Made it!
//
refs = append(refs, r)
}
}
}
return refs
}
var re = regexp.MustCompile("[Rr][Ee][ \t]*:[ \t]*")
func (e *Email) SimplifiedSubject() string {
if e.dummy {
return ""
}
subj := e.email.GetHeader("Subject")
subj = re.ReplaceAllString(subj, "")
return subj
}
func (e *Email) Subject() string {
if e.dummy {
if e.child != nil {
return e.child.Subject() + " :: node synthesized by https://gatherstars.com/"
}
return fmt.Sprintf("Placeholder %s - manufactured by https://gatherstars.com/", e.forID)
}
// Add in the date for a bit of extra information
//
var sb strings.Builder
t := e.GetDate()
sb.WriteString(t.UTC().String())
sb.WriteString(" : ")
sb.WriteString(strings.Trim(e.email.GetHeader("Subject"), " "))
return sb.String()
}
func (e *Email) SubjectIsReply() bool {
subj := e.email.GetHeader("Subject")
return re.MatchString(subj)
}
func (e *Email) SetNext(next Threadable) {
e.next = next
}
func (e *Email) SetChild(kid Threadable) {
e.child = kid
if kid != nil {
kid.SetParent(e)
}
}
// SetParent allows us to add or change the parent Threadable of this node
//
func (e *Email) SetParent(parent Threadable) {
e.parent = parent
}
func (e *Email) MakeDummy(forID string) Threadable {
return &Email{
dummy: true,
forID: forID,
}
}
func (e *Email) IsDummy() bool {
return e.dummy
}
func NewEmail(envelope *enmime.Envelope) Threadable {
e := &Email{
email: envelope,
dummy: false,
}
return e
}
func ExampleThreader_ThreadSlice() {
// Emails := loadEmails() - your function to load emails into a slice
//
// Create a threader and thread using the slice of Threadable in the slice called Emails
//
threader := NewThreader()
sliceRoot, err := threader.ThreadSlice(Emails)
if err != nil {
fmt.Printf("func ThreadSlice() error = %#v", err)
return
}
// Make sure that number we got back, not including dummies, is the same as we sent in
//
var nc int
Count(sliceRoot, &nc)
if nc != 2387 {
fmt.Printf("expected %d emails after threading, but got %d back", 2387, nc)
} else {
fmt.Printf("There are %d test emails", nc)
}
// Output: There are 2387 test emails
}
func TestThreader_ThreadSlice(t1 *testing.T) {
// Emails := loadEmails() - your function to load emails into a slice
//
// Create a threader and thread using the slice of Threadable in the slice called Emails
//
threader := NewThreader()
sliceRoot, err := threader.ThreadSlice(Emails)
if err != nil {
t1.Errorf("func ThreadSlice() error = %#v", err)
}
// Make sure that number we got back, not including dummies, is the same as we sent in
//
var nc int
Count(sliceRoot, &nc)
if nc != 2387 {
t1.Errorf("expected %d emails after threading, but got %d back", 2387, nc)
}
}
func ExampleThreader_ThreadRoot() {
// Emails := loadEmails() - your function to load emails into a slice
//
// Create a threader and thread using the slice of Threadable in the slice called Emails
//
tr := NewThreadableRoot(Emails)
threader := NewThreader()
treeRoot, err := threader.ThreadRoot(tr)
if err != nil {
fmt.Printf("func ThreadRoot() error = %#v", err)
}
if treeRoot == nil {
fmt.Printf("received no output from the threading algorithm")
}
// Make sure that number we got back, not including dummies, is the same as we sent in
//
var nc int
Count(treeRoot, &nc)
if nc != 2387 {
fmt.Printf("expected %d emails afer threading, but got %d back", 2387, nc)
} else {
fmt.Printf("There are %d test emails", nc)
}
// Output: There are 2387 test emails
}
func TestThreader_ThreadRoot(t1 *testing.T) {
// Emails := loadEmails() - your function to load emails into a slice
//
// Create a threader and thread using the ThreadableRootInterface to traverse the emails
//
tr := NewThreadableRoot(Emails)
threader := NewThreader()
treeRoot, err := threader.ThreadRoot(tr)
if err != nil {
t1.Errorf("ThreadRoot() error = %#v", err)
}
if treeRoot == nil {
t1.Errorf("received no output from the threading algorithm")
}
// Make sure that number we got back, not including dummies, is the same as we sent in
//
var nc int
Count(treeRoot, &nc)
if nc != 2387 {
t1.Errorf("expected %d emails after threading, but got %d back", 2387, nc)
}
}
|