-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Expand file tree
/
Copy pathmanager.go
More file actions
873 lines (748 loc) · 23.6 KB
/
Copy pathmanager.go
File metadata and controls
873 lines (748 loc) · 23.6 KB
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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
package manager
import (
"crypto/sha1"
"encoding/hex"
"errors"
"fmt"
"html/template"
"log"
"net/textproto"
"net/url"
"path"
"regexp"
"strings"
"sync"
"time"
"maps"
"github.com/Masterminds/sprig/v3"
"github.com/knadh/listmonk/internal/i18n"
"github.com/knadh/listmonk/internal/notifs"
"github.com/knadh/listmonk/models"
"golang.org/x/text/cases"
"golang.org/x/text/language"
)
// attribInlineEmbed is the HTML attrib used to mark <img> tags whose source
// should be embedded as a multipart cid inline attachment.
const attribInlineEmbed = "data-embed"
var (
reInlineImage = regexp.MustCompile(`(?is)<img\b[^>]*\b` + attribInlineEmbed + `\b[^>]*>`)
reImgSrc = regexp.MustCompile(`(?is)(\s)src\s*=\s*(?:"([^"]*)"|'([^']*)')`)
)
const (
// BaseTPL is the name of the base template.
BaseTPL = "base"
// ContentTpl is the name of the compiled message.
ContentTpl = "content"
dummyUUID = "00000000-0000-0000-0000-000000000000"
)
// Store represents a data backend, such as a database,
// that provides subscriber and campaign records.
type Store interface {
NextCampaigns(currentIDs []int64, sentCounts []int64) ([]*models.Campaign, error)
NextSubscribers(campID, limit int) ([]models.Subscriber, error)
GetCampaign(campID int) (*models.Campaign, error)
GetAttachment(mediaID int) (models.Attachment, error)
GetInlineAttachmentByFilename(filename string) (models.Attachment, string, error)
GetMediaURLByFilename(filename string) (string, error)
UpdateCampaignStatus(campID int, status string) error
UpdateCampaignCounts(campID int, toSend int, sent int, lastSubID int) error
CreateLink(url string) (string, error)
BlocklistSubscriber(id int64) error
DeleteSubscriber(id int64) error
}
// Messenger is an interface for a generic messaging backend,
// for instance, e-mail, SMS etc.
type Messenger interface {
Name() string
Push(models.Message) error
Flush() error
Close() error
}
// CampStats contains campaign stats like per minute send rate.
type CampStats struct {
SendRate int
}
// Manager handles the scheduling, processing, and queuing of campaigns
// and message pushes.
type Manager struct {
cfg Config
store Store
i18n *i18n.I18n
messengers map[string]Messenger
fnNotify func(subject string, data any) error
log *log.Logger
// Campaigns that are currently running.
pipes map[int]*pipe
pipesMut sync.RWMutex
tpls map[int]*models.Template
tplsMut sync.RWMutex
// Links generated using Track() are cached here so as to not query
// the database for the link UUID for every message sent. This has to
// be locked as it may be used externally when previewing campaigns.
links map[string]string
linksMut sync.RWMutex
nextPipes chan *pipe
campMsgQ chan CampaignMessage
msgQ chan models.Message
// Sliding window keeps track of the total number of messages sent in a period
// and on reaching the specified limit, waits until the window is over before
// sending further messages.
slidingCount int
slidingStart time.Time
tplFuncs template.FuncMap
}
// CampaignMessage represents an instance of campaign message to be pushed out,
// specific to a subscriber, via the campaign's messenger.
type CampaignMessage struct {
Campaign *models.Campaign
Subscriber models.Subscriber
from string
to string
subject string
body []byte
altBody []byte
unsubURL string
headers models.Headers
pipe *pipe
}
// Config has parameters for configuring the manager.
type Config struct {
// Number of subscribers to pull from the DB in a single iteration.
BatchSize int
Concurrency int
MessageRate int
MaxSendErrors int
SlidingWindow bool
SlidingWindowDuration time.Duration
SlidingWindowRate int
RequeueOnError bool
FromEmail string
IndividualTracking bool
DisableTracking bool
LinkTrackURL string
UnsubURL string
OptinURL string
MessageURL string
ViewTrackURL string
ArchiveURL string
RootURL string
UnsubHeader bool
// Interval to scan the DB for active campaign checkpoints.
ScanInterval time.Duration
// ScanCampaigns indicates whether this instance of manager will scan the DB
// for active campaigns and process them.
// This can be used to run multiple instances of listmonk
// (exposed to the internet, private etc.) where only one does campaign
// processing while the others handle other kinds of traffic.
ScanCampaigns bool
}
var pushTimeout = time.Second * 3
// New returns a new instance of Mailer.
func New(cfg Config, store Store, i *i18n.I18n, l *log.Logger) *Manager {
if cfg.BatchSize < 1 {
cfg.BatchSize = 1000
}
if cfg.Concurrency < 1 {
cfg.Concurrency = 1
}
if cfg.MessageRate < 1 {
cfg.MessageRate = 1
}
m := &Manager{
cfg: cfg,
store: store,
i18n: i,
fnNotify: func(subject string, data any) error {
return notifs.NotifySystem(subject, notifs.TplCampaignStatus, data, nil)
},
log: l,
messengers: make(map[string]Messenger),
pipes: make(map[int]*pipe),
tpls: make(map[int]*models.Template),
links: make(map[string]string),
nextPipes: make(chan *pipe, 1000),
campMsgQ: make(chan CampaignMessage, cfg.Concurrency*cfg.MessageRate*2),
msgQ: make(chan models.Message, cfg.Concurrency*cfg.MessageRate*2),
slidingStart: time.Now(),
}
m.tplFuncs = m.makeGnericFuncMap()
return m
}
// AddMessenger adds a Messenger messaging backend to the manager.
func (m *Manager) AddMessenger(msg Messenger) error {
id := msg.Name()
if _, ok := m.messengers[id]; ok {
return fmt.Errorf("messenger '%s' is already loaded", id)
}
m.messengers[id] = msg
return nil
}
// PushMessage pushes an arbitrary non-campaign Message to be sent out by the workers.
// It times out if the queue is busy.
func (m *Manager) PushMessage(msg models.Message) error {
t := time.NewTicker(pushTimeout)
defer t.Stop()
select {
case m.msgQ <- msg:
case <-t.C:
m.log.Printf("message push timed out: '%s'", msg.Subject)
return errors.New("message push timed out")
}
return nil
}
// PushCampaignMessage pushes a campaign messages into a queue to be sent out by the workers.
// It times out if the queue is busy.
func (m *Manager) PushCampaignMessage(msg CampaignMessage) error {
t := time.NewTicker(pushTimeout)
defer t.Stop()
// Load any media/attachments.
if err := m.attachMedia(msg.Campaign); err != nil {
return err
}
select {
case m.campMsgQ <- msg:
case <-t.C:
m.log.Printf("message push timed out: '%s'", msg.Subject())
return errors.New("message push timed out")
}
return nil
}
// HasMessenger checks if a given messenger is registered.
func (m *Manager) HasMessenger(id string) bool {
_, ok := m.messengers[id]
return ok
}
// HasRunningCampaigns checks if there are any active campaigns.
func (m *Manager) HasRunningCampaigns() bool {
m.pipesMut.Lock()
defer m.pipesMut.Unlock()
return len(m.pipes) > 0
}
// GetCampaignStats returns campaign statistics.
func (m *Manager) GetCampaignStats(id int) CampStats {
n := 0
m.pipesMut.Lock()
if c, ok := m.pipes[id]; ok {
n = int(c.rate.Rate())
}
m.pipesMut.Unlock()
return CampStats{SendRate: n}
}
// Run is a blocking function (that should be invoked as a goroutine)
// that scans the data source at regular intervals for pending campaigns,
// and queues them for processing. The process queue fetches batches of
// subscribers and pushes messages to them for each queued campaign
// until all subscribers are exhausted, at which point, a campaign is marked
// as "finished".
func (m *Manager) Run() {
if m.cfg.ScanCampaigns {
// Periodically scan campaigns and push running campaigns to nextPipes
// to fetch subscribers from the campaign.
go m.scanCampaigns(m.cfg.ScanInterval)
}
// Spawn N message workers.
for i := 0; i < m.cfg.Concurrency; i++ {
go m.worker()
}
// Indefinitely wait on the pipe queue to fetch the next set of subscribers
// for any active campaigns.
for p := range m.nextPipes {
has, err := p.NextSubscribers()
if err != nil {
m.log.Printf("error processing campaign batch (%s): %v", p.camp.Name, err)
// If the batch fails, stop the pipe and release it so that it doesn't hang forever.
// The cleanup() records the state in DB and scanCampaigns() picks it up at a later point.
p.Stop(false)
p.wg.Done()
continue
}
if has {
// There are more subscribers to fetch. Queue again.
select {
case m.nextPipes <- p:
default:
// If the queue is full for any reason, stop the pipe and release it.
// The cleanup() records the state in DB and scanCampaigns() picks it up
// at a later point.
p.Stop(false)
p.wg.Done()
}
} else {
// The pipe is created with a +1 on the waitgroup pseudo counter
// so that it immediately waits. Subsequently, every message created
// is incremented in the counter in pipe.newMessage(), and when it's'
// processed (or ignored when a campaign is paused or cancelled),
// the count is's reduced in worker().
//
// This marks down the original non-message +1, causing the waitgroup
// to be released and the pipe to end, triggering the pg.Wait()
// in newPipe() that calls pipe.cleanup().
p.wg.Done()
}
}
}
// CacheTpl caches a template for ad-hoc use. This is currently only used by tx templates.
func (m *Manager) CacheTpl(id int, tpl *models.Template) {
if body, atts := m.ApplyInlineImages(tpl.Body); len(atts) > 0 {
tpl.Body = body
tpl.Attachments = atts
if err := tpl.Compile(m.GenericTemplateFuncs()); err != nil {
m.log.Printf("error recompiling tx template %d after inline image: %v", id, err)
return
}
}
m.tplsMut.Lock()
m.tpls[id] = tpl
m.tplsMut.Unlock()
}
// DeleteTpl deletes a cached template.
func (m *Manager) DeleteTpl(id int) {
m.tplsMut.Lock()
delete(m.tpls, id)
m.tplsMut.Unlock()
}
// GetTpl returns a cached template.
func (m *Manager) GetTpl(id int) (*models.Template, error) {
m.tplsMut.RLock()
tpl, ok := m.tpls[id]
m.tplsMut.RUnlock()
if !ok {
return nil, fmt.Errorf("template %d not found", id)
}
return tpl, nil
}
// TemplateFuncs returns the template functions to be applied into
// compiled campaign templates.
func (m *Manager) TemplateFuncs(c *models.Campaign) template.FuncMap {
f := template.FuncMap{
"TrackLink": func(url string, msg *CampaignMessage) string {
if m.cfg.DisableTracking {
return url
}
subUUID := msg.Subscriber.UUID
if !m.cfg.IndividualTracking {
subUUID = dummyUUID
}
return m.trackLink(url, msg.Campaign.UUID, subUUID)
},
"TrackView": func(msg *CampaignMessage) template.HTML {
if m.cfg.DisableTracking {
return template.HTML("")
}
subUUID := msg.Subscriber.UUID
if !m.cfg.IndividualTracking {
subUUID = dummyUUID
}
return template.HTML(fmt.Sprintf(`<img src="%s" alt="" />`,
fmt.Sprintf(m.cfg.ViewTrackURL, msg.Campaign.UUID, subUUID)))
},
"UnsubscribeURL": func(msg *CampaignMessage) string {
return msg.unsubURL
},
"ManageURL": func(msg *CampaignMessage) string {
return msg.unsubURL + "?manage=true"
},
"OptinURL": func(msg *CampaignMessage) string {
// Add list IDs.
// TODO: Show private lists list on optin e-mail
return fmt.Sprintf(m.cfg.OptinURL, msg.Subscriber.UUID, "")
},
"MessageURL": func(msg *CampaignMessage) string {
return fmt.Sprintf(m.cfg.MessageURL, c.UUID, msg.Subscriber.UUID)
},
"ArchiveURL": func() string {
return m.cfg.ArchiveURL
},
"RootURL": func() string {
return m.cfg.RootURL
},
}
maps.Copy(f, m.tplFuncs)
return f
}
func (m *Manager) GenericTemplateFuncs() template.FuncMap {
return m.tplFuncs
}
// StopCampaign marks a running campaign as stopped so that all its queued messages are ignored.
func (m *Manager) StopCampaign(id int) {
m.pipesMut.RLock()
if p, ok := m.pipes[id]; ok {
p.Stop(false)
}
m.pipesMut.RUnlock()
}
// Close closes and exits the campaign manager.
func (m *Manager) Close() {
close(m.nextPipes)
close(m.msgQ)
}
// scanCampaigns is a blocking function that periodically scans the data source
// for campaigns to process and dispatches them to the manager. It feeds campaigns
// into nextPipes.
func (m *Manager) scanCampaigns(tick time.Duration) {
t := time.NewTicker(tick)
defer t.Stop()
// Periodically scan the data source for campaigns to process.
for range t.C {
ids, counts := m.getCurrentCampaigns()
campaigns, err := m.store.NextCampaigns(ids, counts)
if err != nil {
m.log.Printf("error fetching campaigns: %v", err)
continue
}
for _, c := range campaigns {
// Create a new pipe that'll handle this campaign's states.
p, err := m.newPipe(c)
if err != nil {
m.log.Printf("error processing campaign (%s): %v", c.Name, err)
continue
}
m.log.Printf("start processing campaign (%s)", c.Name)
// If subscriber processing is busy, move on. Blocking and waiting
// can end up in a race condition where the waiting campaign's
// state in the data source has changed.
select {
case m.nextPipes <- p:
default:
// If the queue is full for any reason, stop the pipe and release it.
// The cleanup() records the state in DB and scanCampaigns() picks it up
// at a later point.
p.Stop(false)
p.wg.Done()
}
}
}
}
// worker is a blocking function that perpetually listents to events (message) on different
// queues and processes them.
func (m *Manager) worker() {
// Counter to keep track of the message / sec rate limit.
numMsg := 0
for {
select {
// Campaign message.
case msg, ok := <-m.campMsgQ:
if !ok {
return
}
// If the campaign has ended or stopped, ignore the message.
if msg.pipe != nil && msg.pipe.stopped.Load() {
// Reduce the message counter on the pipe.
msg.pipe.wg.Done()
continue
}
// Pause on hitting the message rate.
if numMsg >= m.cfg.MessageRate {
time.Sleep(time.Second)
numMsg = 0
}
numMsg++
// Outgoing message.
out := models.Message{
From: msg.from,
To: []string{msg.to},
Subject: msg.subject,
ContentType: msg.Campaign.ContentType,
Body: msg.body,
AltBody: msg.altBody,
Subscriber: msg.Subscriber,
Campaign: msg.Campaign,
Attachments: msg.Campaign.Attachments,
}
h := textproto.MIMEHeader{}
h.Set(models.EmailHeaderCampaignUUID, msg.Campaign.UUID)
h.Set(models.EmailHeaderSubscriberUUID, msg.Subscriber.UUID)
// Attach List-Unsubscribe headers?
if m.cfg.UnsubHeader {
h.Set("List-Unsubscribe-Post", "List-Unsubscribe=One-Click")
h.Set("List-Unsubscribe", `<`+msg.unsubURL+`>`)
}
// Attach any custom headers.
for _, set := range msg.headers {
for hdr, val := range set {
h.Add(hdr, val)
}
}
// Set the headers.
out.Headers = h
// Push the message to the messenger.
err := m.messengers[msg.Campaign.Messenger].Push(out)
if err != nil {
m.log.Printf("error sending message in campaign %s: subscriber %d: %v", msg.Campaign.Name, msg.Subscriber.ID, err)
}
// Increment the send rate or the error counter if there was an error.
if msg.pipe != nil {
// Mark the message as done.
msg.pipe.wg.Done()
if err != nil {
// Call the error callback, which keeps track of the error count
// and stops the campaign if the error count exceeds the threshold.
msg.pipe.OnError()
} else {
id := uint64(msg.Subscriber.ID)
if id > msg.pipe.lastID.Load() {
msg.pipe.lastID.Store(uint64(msg.Subscriber.ID))
}
msg.pipe.rate.Incr(1)
msg.pipe.sent.Add(1)
}
}
// Arbitrary message.
case msg, ok := <-m.msgQ:
if !ok {
return
}
// Push the message to the messenger.
if err := m.messengers[msg.Messenger].Push(msg); err != nil {
m.log.Printf("error sending message '%s': %v", msg.Subject, err)
}
}
}
}
// getCurrentCampaigns returns the IDs of campaigns currently being processed
// and their sent counts.
func (m *Manager) getCurrentCampaigns() ([]int64, []int64) {
// Needs to return an empty slice in case there are no campaigns.
m.pipesMut.RLock()
defer m.pipesMut.RUnlock()
var (
ids = make([]int64, 0, len(m.pipes))
counts = make([]int64, 0, len(m.pipes))
)
for _, p := range m.pipes {
ids = append(ids, int64(p.camp.ID))
// Get the sent counts for campaigns and reset them to 0
// as in the database, they're stored cumulatively (sent += $newSent).
counts = append(counts, p.sent.Load())
p.sent.Store(0)
}
return ids, counts
}
// trackLink register a URL and return its UUID to be used in message templates
// for tracking links.
func (m *Manager) trackLink(url, campUUID, subUUID string) string {
if m.cfg.DisableTracking {
return url
}
url = strings.ReplaceAll(url, "&", "&")
m.linksMut.RLock()
if uu, ok := m.links[url]; ok {
m.linksMut.RUnlock()
return fmt.Sprintf(m.cfg.LinkTrackURL, uu, campUUID, subUUID)
}
m.linksMut.RUnlock()
// Register link.
uu, err := m.store.CreateLink(url)
if err != nil {
m.log.Printf("error registering tracking for link '%s': %v", url, err)
// If the registration fails, fail over to the original URL.
return url
}
m.linksMut.Lock()
m.links[url] = uu
m.linksMut.Unlock()
return fmt.Sprintf(m.cfg.LinkTrackURL, uu, campUUID, subUUID)
}
// sendNotif sends a notification to registered admin e-mails.
func (m *Manager) sendNotif(c *models.Campaign, status, reason string) error {
var (
subject = fmt.Sprintf("%s: %s", cases.Title(language.Und).String(status), c.Name)
data = map[string]any{
"ID": c.ID,
"Name": c.Name,
"Status": status,
"Sent": c.Sent,
"ToSend": c.ToSend,
"Reason": reason,
}
)
return m.fnNotify(subject, data)
}
// makeGnericFuncMap returns a generic template func map with custom template
// functions and sprig template functions.
func (m *Manager) makeGnericFuncMap() template.FuncMap {
funcs := template.FuncMap{
"Date": func(layout string) string {
if layout == "" {
layout = time.ANSIC
}
return time.Now().Format(layout)
},
"L": func() *i18n.I18n {
return m.i18n
},
"Safe": func(safeHTML string) template.HTML {
return template.HTML(safeHTML)
},
}
// Copy spring functions.
sprigFuncs := sprig.GenericFuncMap()
delete(sprigFuncs, "env")
delete(sprigFuncs, "expandenv")
delete(sprigFuncs, "getHostByName")
maps.Copy(funcs, sprigFuncs)
return funcs
}
// attachMedia loads any media/attachments from the media store and attaches
// the byte blobs to the campaign. Inline attachments are skipped as they're
// loaded earlier by LoadInlineImages().
func (m *Manager) attachMedia(c *models.Campaign) error {
// Already loaded if any non-inline attachment is present.
for _, a := range c.Attachments {
if !a.IsInline {
return nil
}
}
for _, mid := range []int64(c.MediaIDs) {
a, err := m.store.GetAttachment(int(mid))
if err != nil {
return fmt.Errorf("error fetching attachment %d on campaign %s: %v", mid, c.Name, err)
}
c.Attachments = append(c.Attachments, a)
}
return nil
}
// LoadInlineImages resolves any <img ... data-embed ...> tags in the campaign
// body and template body one time before CompileTemplate.
func (m *Manager) LoadInlineImages(c *models.Campaign) error {
if c.ContentType == models.CampaignContentTypePlain {
return nil
}
cidCache := make(map[string]string)
body, atts := m.applyInlineImages(c.Body, cidCache)
c.Body = body
tplBody, tplAtts := m.applyInlineImages(c.TemplateBody, cidCache)
c.TemplateBody = tplBody
atts = append(atts, tplAtts...)
c.Attachments = append(c.Attachments, atts...)
return nil
}
// ApplyInlineImages scans body for <img ... data-embed ...> tags, resolves
// each unique src filename to a media item, attaches it as an inline part, and
// rewrites the matched img src to cid.
func (m *Manager) ApplyInlineImages(body string) (string, []models.Attachment) {
return m.applyInlineImages(body, make(map[string]string))
}
func (m *Manager) applyInlineImages(body string, cache map[string]string) (string, []models.Attachment) {
if !strings.Contains(body, attribInlineEmbed) {
return body, nil
}
var atts []models.Attachment
out := reInlineImage.ReplaceAllStringFunc(body, func(tag string) string {
src := extractSrc(tag)
if src == "" || strings.HasPrefix(strings.ToLower(src), "cid:") {
return tag
}
fname := filenameFromSrc(src)
if fname == "" {
return tag
}
cid, ok := cache[src]
if !ok {
if a, c, err := m.store.GetInlineAttachmentByFilename(fname); err == nil {
atts = append(atts, a)
cid = c
} else {
m.log.Printf("inline image %q not embedded: %v", src, err)
}
cache[src] = cid
}
if cid == "" {
return tag
}
return reImgSrc.ReplaceAllString(tag, `${1}src="cid:`+cid+`"`)
})
return out, atts
}
// ApplyArchiveImages resolves any <img ... data-embed ...> tags in the campaign
// body and template body to public media URLs. The archive is rendered as a
// standalone HTML page and not a MIME message, so cid: cannot resolve there.
func (m *Manager) ApplyArchiveImages(c *models.Campaign) {
if c.ContentType == models.CampaignContentTypePlain {
return
}
cache := make(map[string]string)
c.Body = m.applyArchiveImages(c.Body, cache)
c.TemplateBody = m.applyArchiveImages(c.TemplateBody, cache)
}
func (m *Manager) applyArchiveImages(body string, cache map[string]string) string {
if !strings.Contains(body, attribInlineEmbed) {
return body
}
return reInlineImage.ReplaceAllStringFunc(body, func(tag string) string {
src := extractSrc(tag)
if src == "" || strings.HasPrefix(strings.ToLower(src), "cid:") {
return tag
}
fname := filenameFromSrc(src)
if fname == "" {
return tag
}
u, ok := cache[src]
if !ok {
s, err := m.store.GetMediaURLByFilename(fname)
if err != nil {
m.log.Printf("archive image %q not resolved: %v", src, err)
}
u = s
cache[src] = u
}
if u == "" {
return tag
}
return reImgSrc.ReplaceAllString(tag, `${1}src="`+u+`"`)
})
}
// MakeContentID returns a standard `Content-ID` value (without the angle brackets).
func MakeContentID(key string) string {
sum := sha1.Sum([]byte(key))
return hex.EncodeToString(sum[:8]) + "@email"
}
// filenameFromSrc extracts a media filename from an <img src> value (ignoring
// any URLs and just capturing the filename.
func filenameFromSrc(src string) string {
if src == "" {
return ""
}
p := src
if u, err := url.Parse(src); err == nil && u.Path != "" {
p = u.Path
}
return path.Base(p)
}
// MakeAttachmentHeader returns a textproto.MIMEHeader for an email
// attachment. Default encoding is base64 and contentType is application/octet-stream.
func MakeAttachmentHeader(filename, encoding, contentType string) textproto.MIMEHeader {
return makeAttachmentHeader("attachment", filename, encoding, contentType, "")
}
// MakeInlineAttachmentHeader returns a textproto.MIMEHeader for an inline
// image attachment referenced from the HTML body via a cid URL.
func MakeInlineAttachmentHeader(filename, encoding, contentType, contentID string) textproto.MIMEHeader {
return makeAttachmentHeader("inline", filename, encoding, contentType, contentID)
}
func makeAttachmentHeader(disposition, filename, encoding, contentType, contentID string) textproto.MIMEHeader {
if encoding == "" {
encoding = "base64"
}
if contentType == "" {
contentType = "application/octet-stream"
}
h := textproto.MIMEHeader{}
h.Set("Content-Disposition", disposition+"; filename="+filename)
h.Set("Content-Type", fmt.Sprintf("%s; name=\""+filename+"\"", contentType))
h.Set("Content-Transfer-Encoding", encoding)
if contentID != "" {
h.Set("Content-ID", "<"+contentID+">")
}
return h
}
func extractSrc(tag string) string {
m := reImgSrc.FindStringSubmatch(tag)
if len(m) == 0 {
return ""
}
if m[2] != "" {
return m[2]
}
return m[3]
}