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
|
package main
import (
"fmt"
"github.com/gatherstars-com/jwz"
"github.com/jhillyerd/enmime"
"io/fs"
"log"
"net/mail"
"os"
"path/filepath"
"regexp"
"strings"
"time"
)
// buildEnvelopes finds all email files beneath the given emlDir (files starting with .eml), parses them
// and returns a slice full of all the envelopes that we parsed in to existence
//
func buildEnvelopes(emlDir string, sizeHint int) ([]jwz.Threadable, error) {
duprem := make(map[string]string)
// 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([]jwz.Threadable, 0, sizeHint)
var ignored int
_ = filepath.WalkDir(emlDir, func(path string, d fs.DirEntry, err error) error {
if err != nil {
log.Printf("cannot process file %s because: %s", 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 shows a non-fatal error. File '%s', error: %#v", path, ee)
} else {
log.Printf("enmime parse yields severe error. File: '%s', error: %#v", path, ee)
return nil
}
}
}
// All is good, so let's accumulate the email, unless it's a duplicate, which sometimes happens
// with spammers and test email sets from Kaggle. We will keep duplicates in the input directory but ignore
// them for processing in this example. The actual unit test processes all the emails in testdata so that
// dealing with garbage input is tested, but here we are creating a visual, so let's just remove the
// Manchester United.
//
thisID := envelope.GetHeader("Message-Id")
ent, present := duprem[thisID]
if present {
log.Printf("Duplicate message id(%s) in file '%s' ignored in favor of file '%s'", thisID, path, ent)
ignored++
} else {
duprem[thisID] = path
email := NewEmail(envelope)
emails = append(emails, email)
}
return nil
})
log.Printf("Parsed %d email, with %d ignored for a total of %d", len(emails), ignored, len(emails)+ignored)
return emails, nil
}
// Email implements the Threadable interface - see the interface documentation for the function docs.
// This is what a user of this package needs to provide to thread their messages, though you don't have to use
// enmime of course.
//
// You can put anything in here as only next and child are required, though you need some sort of
// reference to the email, or at least a few parts of it, such as the Subject, Message-Id, and References
// headers.
//
// You could also add a prev field if you need doubly linked next lists, which can make some things easier
// etc. Or use a container or something. This is the simplest example - you should get the idea, big nose.
//
type Email struct {
email *enmime.Envelope
next jwz.Threadable
parent jwz.Threadable
child jwz.Threadable
dummy bool
forID string
}
// GetNext the next Threadable in the chain, if any
//
func (e *Email) GetNext() jwz.Threadable {
return e.next
}
// GetChild the child Threadable of this node, if any
//
func (e *Email) GetChild() jwz.Threadable {
return e.child
}
// GetParent the parent Threadable of this node, if any
//
func (e *Email) GetParent() jwz.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("<.*?>")
// MessageThreadID the id of this email message
//
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]*")
// SimplifiedSubject the email subject without any Re: prefixes. If this
// Threadable is a dummy, but it has a child, we try to use the subject in the
// child, if it has one. Note that this is only used for threading if there are
// no references etc
//
func (e *Email) SimplifiedSubject() string {
if e.dummy {
return ""
}
subj := e.email.GetHeader("Subject")
subj = re.ReplaceAllString(subj, "")
return strings.Trim(subj, " ")
}
// Subject the subject as defined in the email, plus a few adornments so that humans can see that
// the threading is correct and see the sort order
//
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.MessageThreadID())
}
// 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()
}
// SubjectIsReply true if the Subject header of this email appears to indicate it is a reply to something.
// This is only used if there are no references in the Threadables that otherwise show that relationship
func (e *Email) SubjectIsReply() bool {
if e.dummy {
return false
}
subj := e.email.GetHeader("Subject")
return re.MatchString(subj)
}
// SetNext allows us to change or add a pointer to the next Threadable in a set of emails
//
func (e *Email) SetNext(next jwz.Threadable) {
e.next = next
}
// SetChild allows us to add or change the child Threadable of this node
//
func (e *Email) SetChild(kid jwz.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 jwz.Threadable) {
e.parent = parent
}
// MakeDummy manufactures a placeholder Threadable that other Threadables can become children of. See
// interface documentation for more details - note that this may be subject to change to also supply the
// MessageID that this dummy is placeholder for, if we have it
//
func (e *Email) MakeDummy(forID string) jwz.Threadable {
return &Email{
dummy: true,
forID: forID,
}
}
// IsDummy true if this Threadable is a Manchester United supporter
//
func (e *Email) IsDummy() bool {
return e.dummy
}
// NewEmail creates a new structure that implements the jwz.Threadable interface. it should be obvious that
// your struct can contain whatever you want it to, so long as it obeys the jwz.Threadable contract. Here,
// we use it to pass around a pointer to the enmime envelope that we have parsed an email into.
//
func NewEmail(envelope *enmime.Envelope) jwz.Threadable {
e := &Email{
email: envelope,
dummy: false,
}
return e
}
// byDate is a sort comparison function that is used to call in to the Threadable Sort utility function and
// sort the threads by Date
//
func byDate(t1 jwz.Threadable, t2 jwz.Threadable) bool {
return t1.GetDate().Before(t2.GetDate())
}
|