Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Always set a message-id on mails #17900

Merged
merged 8 commits into from
Dec 8, 2021
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions modules/setting/setting.go
Original file line number Diff line number Diff line change
Expand Up @@ -548,25 +548,25 @@ func SetCustomPathAndConf(providedCustom, providedConf, providedWorkPath string)

// LoadFromExisting initializes setting options from an existing config file (app.ini)
func LoadFromExisting() {
loadFromConf(false)
loadFromConf(false, "")
}

// LoadAllowEmpty initializes setting options, it's also fine that if the config file (app.ini) doesn't exist
func LoadAllowEmpty() {
loadFromConf(true)
loadFromConf(true, "")
}

// LoadForTest initializes setting options for tests
func LoadForTest() {
loadFromConf(true)
func LoadForTest(extraConfigs ...string) {
loadFromConf(true, strings.Join(extraConfigs, "\n"))
if err := PrepareAppDataPath(); err != nil {
log.Fatal("Can not prepare APP_DATA_PATH: %v", err)
}
}

// loadFromConf initializes configuration context.
// NOTE: do not print any log except error.
func loadFromConf(allowEmpty bool) {
func loadFromConf(allowEmpty bool, extraConfig string) {
Cfg = ini.Empty()

if WritePIDFile && len(PIDFile) > 0 {
Expand All @@ -585,6 +585,12 @@ func loadFromConf(allowEmpty bool) {
log.Fatal("Unable to find configuration file: %q.\nEnsure you are running in the correct environment or set the correct configuration file with -c.", CustomConf)
} // else: no config file, a config file might be created at CustomConf later (might not)

if extraConfig != "" {
if err = Cfg.Append([]byte(extraConfig)); err != nil {
log.Fatal("Unable to append more config: %v", err)
}
}

Cfg.NameMapper = ini.SnackCase

homeDir, err := com.HomeDir()
Expand Down
16 changes: 16 additions & 0 deletions services/mailer/mailer.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"bytes"
"crypto/tls"
"fmt"
"hash/fnv"
"io"
"net"
"net/smtp"
Expand Down Expand Up @@ -67,6 +68,10 @@ func (m *Message) ToMessage() *gomail.Message {
msg.SetBody("text/plain", plainBody)
msg.AddAlternative("text/html", m.Body)
}

if len(msg.GetHeader("Message-ID")) == 0 {
msg.SetHeader("Message-ID", m.generateAutoMessageID())
}
return msg
}

Expand All @@ -75,6 +80,17 @@ func (m *Message) SetHeader(field string, value ...string) {
m.Headers[field] = value
}

func (m *Message) generateAutoMessageID() string {
dateMs := m.Date.UnixNano() / 1e6
h := fnv.New64()
if len(m.To) > 0 {
_, _ = h.Write([]byte(m.To[0]))
}
_, _ = h.Write([]byte(m.Subject))
_, _ = h.Write([]byte(m.Body))
return fmt.Sprintf("<autogen-%d-%016x@%s>", dateMs, h.Sum64(), setting.Domain)
}

// NewMessageFrom creates new mail message object with custom From header.
func NewMessageFrom(to []string, fromDisplayName, fromAddress, subject, body string) *Message {
log.Trace("NewMessageFrom (body):\n%s", body)
Expand Down
39 changes: 39 additions & 0 deletions services/mailer/mailer_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
// Copyright 2021 The Gogs Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.

package mailer

import (
"testing"
"time"

"code.gitea.io/gitea/modules/setting"

"github.com/stretchr/testify/assert"
)

func TestGenerateMessageID(t *testing.T) {
setting.LoadForTest(`
[mailer]
ENABLED = true
FROM = [email protected]
`)
setting.NewServices()

date := time.Date(2000, 01, 02, 03, 04, 05, 06, time.UTC)
m := NewMessageFrom(nil, "display-name", "from-address", "subject", "body")
m.Date = date
gm := m.ToMessage()
assert.Equal(t, "<autogen-946782245000-41e8fc54a8ad3a3f@localhost>", gm.GetHeader("Message-ID")[0])

m = NewMessageFrom([]string{"[email protected]"}, "display-name", "from-address", "subject", "body")
m.Date = date
gm = m.ToMessage()
assert.Equal(t, "<autogen-946782245000-cc88ce3cfe9bd04f@localhost>", gm.GetHeader("Message-ID")[0])

m = NewMessageFrom([]string{"[email protected]"}, "display-name", "from-address", "subject", "body")
m.SetHeader("Message-ID", "<[email protected]>")
gm = m.ToMessage()
assert.Equal(t, "<[email protected]>", gm.GetHeader("Message-ID")[0])
}