feat(filter): 实现发件人黑白名单数据库迁移、控制器与API路由及收件列表联动

This commit is contained in:
xuans committed 2026-09-13 04:33:42 +08:00
1 parent b107090168
commit 48eaba57c1
9 files changed
+498 -38

No files matched your search

+261 -8
View File
@@ -3,12 +3,14 @@ package email
import (
"encoding/json"
"net/http"
"strconv"
"strings"
"time"
"git.pcux.cn/xuans/Smail/db"
"git.pcux.cn/xuans/Smail/dto/response"
"git.pcux.cn/xuans/Smail/models"
"git.pcux.cn/xuans/Smail/utils/address"
"git.pcux.cn/xuans/Smail/utils/context"
log "github.com/sirupsen/logrus"
"xorm.io/xorm"
@@ -23,8 +25,23 @@ type trustSenderRequest struct {
Trusted bool `json:"trusted"`
}
type senderFilterRequest struct {
ID int `json:"id"`
Email string `json:"email"`
FilterType string `json:"filter_type"`
}
type toggleSenderFilterRequest struct {
Email string `json:"email"`
TargetType string `json:"target_type"`
}
// ContactsList 查询当前用户的历史写信收件人列表(多租户严格隔离)
func ContactsList(ctx *context.Context, w http.ResponseWriter, req *http.Request) {
if ctx == nil || ctx.UserID <= 0 {
response.NewErrorResponse(response.NeedLogin, "请先登录", "").FPrint(w)
return
}
var contacts []models.UserContact
err := db.Instance.Table(&models.UserContact{}).
Where("user_id = ?", ctx.UserID).
@@ -42,6 +59,10 @@ func ContactsList(ctx *context.Context, w http.ResponseWriter, req *http.Request
// DeleteContact 删除当前用户的某项历史联系人记录
func DeleteContact(ctx *context.Context, w http.ResponseWriter, req *http.Request) {
if ctx == nil || ctx.UserID <= 0 {
response.NewErrorResponse(response.NeedLogin, "请先登录", "").FPrint(w)
return
}
var reqData deleteContactRequest
if err := json.NewDecoder(req.Body).Decode(&reqData); err != nil {
response.NewErrorResponse(response.ParamsError, "参数错误", "").FPrint(w)
@@ -67,6 +88,10 @@ func DeleteContact(ctx *context.Context, w http.ResponseWriter, req *http.Reques
// TrustSender 将发件人添加至信任白名单,或从中移除
func TrustSender(ctx *context.Context, w http.ResponseWriter, req *http.Request) {
if ctx == nil || ctx.UserID <= 0 {
response.NewErrorResponse(response.NeedLogin, "请先登录", "").FPrint(w)
return
}
var reqData trustSenderRequest
if err := json.NewDecoder(req.Body).Decode(&reqData); err != nil {
response.NewErrorResponse(response.ParamsError, "参数错误", "").FPrint(w)
@@ -78,22 +103,30 @@ func TrustSender(ctx *context.Context, w http.ResponseWriter, req *http.Request)
return
}
now := time.Now()
if reqData.Trusted {
var exists bool
var existing models.UserTrustedSender
has, err := db.Instance.Table(&models.UserTrustedSender{}).
Where("user_id = ? AND LOWER(email) = ?", ctx.UserID, email).
Exist(&models.UserTrustedSender{})
Get(&existing)
if err != nil {
log.WithContext(ctx).WithError(err).Error("check trusted sender failed")
response.NewErrorResponse(response.ServerError, "操作失败", "").FPrint(w)
return
}
exists = has
if !exists {
if has {
if existing.FilterType != models.FilterTypeWhitelist {
existing.FilterType = models.FilterTypeWhitelist
existing.UpdatedAt = &now
_, _ = db.Instance.ID(existing.ID).Cols("filter_type", "updated_at").Update(&existing)
}
} else {
item := models.UserTrustedSender{
UserID: ctx.UserID,
Email: email,
CreatedAt: time.Now(),
UserID: ctx.UserID,
Email: email,
FilterType: models.FilterTypeWhitelist,
CreatedAt: now,
UpdatedAt: &now,
}
if _, err := db.Instance.Insert(&item); err != nil {
log.WithContext(ctx).WithError(err).Error("insert trusted sender failed")
@@ -106,7 +139,227 @@ func TrustSender(ctx *context.Context, w http.ResponseWriter, req *http.Request)
Where("user_id = ? AND LOWER(email) = ?", ctx.UserID, email).
Delete(&models.UserTrustedSender{}); err != nil {
log.WithContext(ctx).WithError(err).Error("remove trusted sender failed")
response.NewErrorResponse(response.ServerError, "取消信任发件人失败", "").FPrint(w)
response.NewErrorResponse(response.ServerError, "添加信任发件人失败", "").FPrint(w)
return
}
}
response.NewSuccessResponse("ok").FPrint(w)
}
// SenderFiltersList 查询当前用户的发件人黑白名单列表(支持分页、搜索、类型筛选与统计)
func SenderFiltersList(ctx *context.Context, w http.ResponseWriter, req *http.Request) {
if ctx == nil || ctx.UserID <= 0 {
response.NewErrorResponse(response.NeedLogin, "请先登录", "").FPrint(w)
return
}
query := req.URL.Query()
filterType := strings.ToLower(strings.TrimSpace(query.Get("filter_type")))
keyword := strings.ToLower(strings.TrimSpace(query.Get("keyword")))
page, _ := strconv.Atoi(query.Get("page"))
if page <= 0 {
page = 1
}
pageSize, _ := strconv.Atoi(query.Get("page_size"))
if pageSize <= 0 || pageSize > 100 {
pageSize = 20
}
offset := (page - 1) * pageSize
session := db.Instance.Table(&models.UserTrustedSender{}).Where("user_id = ?", ctx.UserID)
if filterType == models.FilterTypeWhitelist || filterType == models.FilterTypeBlacklist {
session = session.And("filter_type = ?", filterType)
}
if keyword != "" {
session = session.And("LOWER(email) LIKE ?", "%"+keyword+"%")
}
var list []models.UserTrustedSender
total, err := session.OrderBy("created_at DESC").Limit(pageSize, offset).FindAndCount(&list)
if err != nil {
log.WithContext(ctx).WithError(err).Error("query sender filters failed")
response.NewErrorResponse(response.ServerError, "查询过滤名单失败", "").FPrint(w)
return
}
whitelistCount, _ := db.Instance.Table(&models.UserTrustedSender{}).
Where("user_id = ? AND filter_type = ?", ctx.UserID, models.FilterTypeWhitelist).
Count(&models.UserTrustedSender{})
blacklistCount, _ := db.Instance.Table(&models.UserTrustedSender{}).
Where("user_id = ? AND filter_type = ?", ctx.UserID, models.FilterTypeBlacklist).
Count(&models.UserTrustedSender{})
response.NewSuccessResponse(map[string]any{
"list": list,
"total": total,
"whitelist_count": whitelistCount,
"blacklist_count": blacklistCount,
"page": page,
"page_size": pageSize,
}).FPrint(w)
}
// AddSenderFilter 添加或更新当前用户的白名单/黑名单
func AddSenderFilter(ctx *context.Context, w http.ResponseWriter, req *http.Request) {
if ctx == nil || ctx.UserID <= 0 {
response.NewErrorResponse(response.NeedLogin, "请先登录", "").FPrint(w)
return
}
var reqData senderFilterRequest
if err := json.NewDecoder(req.Body).Decode(&reqData); err != nil {
response.NewErrorResponse(response.ParamsError, "参数错误", "").FPrint(w)
return
}
email := strings.ToLower(strings.TrimSpace(reqData.Email))
if email == "" || !address.IsValidEmailAddress(email) {
response.NewErrorResponse(response.ParamsError, "邮箱格式不正确", "").FPrint(w)
return
}
filterType := strings.ToLower(strings.TrimSpace(reqData.FilterType))
if filterType == "" {
filterType = models.FilterTypeWhitelist
}
if filterType != models.FilterTypeWhitelist && filterType != models.FilterTypeBlacklist {
response.NewErrorResponse(response.ParamsError, "名单类别必须为白名单或黑名单", "").FPrint(w)
return
}
now := time.Now()
var existing models.UserTrustedSender
has, err := db.Instance.Table(&models.UserTrustedSender{}).
Where("user_id = ? AND LOWER(email) = ?", ctx.UserID, email).
Get(&existing)
if err != nil {
log.WithContext(ctx).WithError(err).Error("check sender filter exists failed")
response.NewErrorResponse(response.ServerError, "操作失败", "").FPrint(w)
return
}
if has {
existing.FilterType = filterType
existing.UpdatedAt = &now
if _, err := db.Instance.ID(existing.ID).Cols("filter_type", "updated_at").Update(&existing); err != nil {
log.WithContext(ctx).WithError(err).Error("update sender filter failed")
response.NewErrorResponse(response.ServerError, "更新过滤名单失败", "").FPrint(w)
return
}
} else {
item := models.UserTrustedSender{
UserID: ctx.UserID,
Email: email,
FilterType: filterType,
CreatedAt: now,
UpdatedAt: &now,
}
if _, err := db.Instance.Insert(&item); err != nil {
log.WithContext(ctx).WithError(err).Error("insert sender filter failed")
response.NewErrorResponse(response.ServerError, "添加过滤名单失败", "").FPrint(w)
return
}
}
response.NewSuccessResponse("ok").FPrint(w)
}
// DeleteSenderFilter 删除发件人黑白名单条目(支持ID或邮箱地址删除)
func DeleteSenderFilter(ctx *context.Context, w http.ResponseWriter, req *http.Request) {
if ctx == nil || ctx.UserID <= 0 {
response.NewErrorResponse(response.NeedLogin, "请先登录", "").FPrint(w)
return
}
var reqData senderFilterRequest
if req.Body != nil {
_ = json.NewDecoder(req.Body).Decode(&reqData)
}
email := strings.ToLower(strings.TrimSpace(reqData.Email))
if reqData.ID <= 0 && email == "" {
if idVal, err := strconv.Atoi(req.URL.Query().Get("id")); err == nil && idVal > 0 {
reqData.ID = idVal
}
if qEmail := strings.ToLower(strings.TrimSpace(req.URL.Query().Get("email"))); qEmail != "" {
email = qEmail
}
}
session := db.Instance.Table(&models.UserTrustedSender{}).Where("user_id = ?", ctx.UserID)
if reqData.ID > 0 {
session = session.And("id = ?", reqData.ID)
} else if email != "" {
session = session.And("LOWER(email) = ?", email)
} else {
response.NewErrorResponse(response.ParamsError, "请指定要删除的记录ID或发件人邮箱", "").FPrint(w)
return
}
if _, err := session.Delete(&models.UserTrustedSender{}); err != nil {
log.WithContext(ctx).WithError(err).Error("delete sender filter failed")
response.NewErrorResponse(response.ServerError, "操作失败", "").FPrint(w)
return
}
response.NewSuccessResponse("ok").FPrint(w)
}
// ToggleSenderFilter 快速切换发件人的白名单/黑名单状态
func ToggleSenderFilter(ctx *context.Context, w http.ResponseWriter, req *http.Request) {
if ctx == nil || ctx.UserID <= 0 {
response.NewErrorResponse(response.NeedLogin, "请先登录", "").FPrint(w)
return
}
var reqData toggleSenderFilterRequest
if err := json.NewDecoder(req.Body).Decode(&reqData); err != nil {
response.NewErrorResponse(response.ParamsError, "参数错误", "").FPrint(w)
return
}
email := strings.ToLower(strings.TrimSpace(reqData.Email))
if email == "" || !address.IsValidEmailAddress(email) {
response.NewErrorResponse(response.ParamsError, "邮箱格式不正确", "").FPrint(w)
return
}
now := time.Now()
var existing models.UserTrustedSender
has, err := db.Instance.Table(&models.UserTrustedSender{}).
Where("user_id = ? AND LOWER(email) = ?", ctx.UserID, email).
Get(&existing)
if err != nil {
log.WithContext(ctx).WithError(err).Error("query sender filter for toggle failed")
response.NewErrorResponse(response.ServerError, "操作失败", "").FPrint(w)
return
}
targetType := strings.ToLower(strings.TrimSpace(reqData.TargetType))
if !has {
if targetType != models.FilterTypeWhitelist && targetType != models.FilterTypeBlacklist {
targetType = models.FilterTypeBlacklist
}
item := models.UserTrustedSender{
UserID: ctx.UserID,
Email: email,
FilterType: targetType,
CreatedAt: now,
UpdatedAt: &now,
}
if _, err := db.Instance.Insert(&item); err != nil {
log.WithContext(ctx).WithError(err).Error("insert toggled sender filter failed")
response.NewErrorResponse(response.ServerError, "操作失败", "").FPrint(w)
return
}
} else {
if targetType == "" {
if existing.FilterType == models.FilterTypeBlacklist {
targetType = models.FilterTypeWhitelist
} else {
targetType = models.FilterTypeBlacklist
}
}
existing.FilterType = targetType
existing.UpdatedAt = &now
if _, err := db.Instance.ID(existing.ID).Cols("filter_type", "updated_at").Update(&existing); err != nil {
log.WithContext(ctx).WithError(err).Error("update toggled sender filter failed")
response.NewErrorResponse(response.ServerError, "操作失败", "").FPrint(w)
return
}
}
+104
View File
@@ -133,3 +133,107 @@ func TestTrustSenderToggle(t *testing.T) {
t.Fatalf("expected trusted sender to be removed")
}
}
func TestSenderFiltersCRUDAndTenantIsolation(t *testing.T) {
setupContactsTestDB(t)
ctxUser1 := &context.Context{UserID: 1}
ctxUser2 := &context.Context{UserID: 2}
// 1. User 1 添加白名单
addBody, _ := json.Marshal(senderFilterRequest{Email: "partner@example.com", FilterType: models.FilterTypeWhitelist})
req := httptest.NewRequest(http.MethodPost, "/api/v1/email/sender-filters", bytes.NewReader(addBody))
w := httptest.NewRecorder()
AddSenderFilter(ctxUser1, w, req)
if w.Code != http.StatusOK {
t.Fatalf("expected 200, got %d", w.Code)
}
// 2. User 1 添加黑名单
addBody2, _ := json.Marshal(senderFilterRequest{Email: "spammer@badsite.com", FilterType: models.FilterTypeBlacklist})
req2 := httptest.NewRequest(http.MethodPost, "/api/v1/email/sender-filters", bytes.NewReader(addBody2))
w2 := httptest.NewRecorder()
AddSenderFilter(ctxUser1, w2, req2)
if w2.Code != http.StatusOK {
t.Fatalf("expected 200, got %d", w2.Code)
}
// 3. User 2 添加名单(用于多租户隔离验证)
addBody3, _ := json.Marshal(senderFilterRequest{Email: "secret@user2.com", FilterType: models.FilterTypeWhitelist})
req3 := httptest.NewRequest(http.MethodPost, "/api/v1/email/sender-filters", bytes.NewReader(addBody3))
w3 := httptest.NewRecorder()
AddSenderFilter(ctxUser2, w3, req3)
if w3.Code != http.StatusOK {
t.Fatalf("expected 200, got %d", w3.Code)
}
// 4. User 1 查询列表(应有 2 条:1 白 1 黑,统计正确)
listReq := httptest.NewRequest(http.MethodGet, "/api/v1/email/sender-filters", nil)
listW := httptest.NewRecorder()
SenderFiltersList(ctxUser1, listW, listReq)
if listW.Code != http.StatusOK {
t.Fatalf("expected 200, got %d", listW.Code)
}
var listResp struct {
Code int `json:"code"`
Data struct {
List []models.UserTrustedSender `json:"list"`
Total int64 `json:"total"`
WhitelistCount int64 `json:"whitelist_count"`
BlacklistCount int64 `json:"blacklist_count"`
} `json:"data"`
}
if err := json.Unmarshal(listW.Body.Bytes(), &listResp); err != nil {
t.Fatal(err)
}
if listResp.Data.Total != 2 || listResp.Data.WhitelistCount != 1 || listResp.Data.BlacklistCount != 1 {
t.Fatalf("unexpected counts: total=%d, white=%d, black=%d",
listResp.Data.Total, listResp.Data.WhitelistCount, listResp.Data.BlacklistCount)
}
for _, item := range listResp.Data.List {
if item.Email == "secret@user2.com" {
t.Fatalf("tenant isolation violation: user1 saw user2 filter")
}
}
// 5. 快速切换(Toggle)白名单 -> 黑名单
toggleBody, _ := json.Marshal(toggleSenderFilterRequest{Email: "partner@example.com"})
toggleReq := httptest.NewRequest(http.MethodPost, "/api/v1/email/sender-filters/toggle", bytes.NewReader(toggleBody))
toggleW := httptest.NewRecorder()
ToggleSenderFilter(ctxUser1, toggleW, toggleReq)
if toggleW.Code != http.StatusOK {
t.Fatalf("expected 200, got %d", toggleW.Code)
}
var updated models.UserTrustedSender
has, err := db.Instance.Table(&models.UserTrustedSender{}).
Where("user_id = ? AND LOWER(email) = ?", 1, "partner@example.com").
Get(&updated)
if err != nil || !has || updated.FilterType != models.FilterTypeBlacklist {
t.Fatalf("expected partner@example.com to be toggled to blacklist, got filter_type=%s", updated.FilterType)
}
// 6. 删除黑名单条目
delBody, _ := json.Marshal(senderFilterRequest{Email: "spammer@badsite.com"})
delReq := httptest.NewRequest(http.MethodDelete, "/api/v1/email/sender-filters", bytes.NewReader(delBody))
delW := httptest.NewRecorder()
DeleteSenderFilter(ctxUser1, delW, delReq)
if delW.Code != http.StatusOK {
t.Fatalf("expected 200, got %d", delW.Code)
}
hasSpammer, _ := db.Instance.Table(&models.UserTrustedSender{}).
Where("user_id = ? AND LOWER(email) = ?", 1, "spammer@badsite.com").
Exist(&models.UserTrustedSender{})
if hasSpammer {
t.Fatalf("expected spammer to be deleted")
}
// 7. 再次确认 User 2 数据完整未受影响
hasU2, _ := db.Instance.Table(&models.UserTrustedSender{}).
Where("user_id = ? AND LOWER(email) = ?", 2, "secret@user2.com").
Exist(&models.UserTrustedSender{})
if !hasU2 {
t.Fatalf("user 2 data was corrupted")
}
}
+39 -24
View File
@@ -31,15 +31,17 @@ type emailListResponse struct {
}
type emilItem struct {
ID int `json:"id"`
Title string `json:"title"`
Desc string `json:"desc"`
Datetime string `json:"datetime"`
IsRead bool `json:"is_read"`
Sender User `json:"sender"`
To []User `json:"to"`
Dangerous bool `json:"dangerous"`
Error string `json:"error"`
ID int `json:"id"`
Title string `json:"title"`
Desc string `json:"desc"`
Datetime string `json:"datetime"`
IsRead bool `json:"is_read"`
Sender User `json:"sender"`
To []User `json:"to"`
Dangerous bool `json:"dangerous"`
IsTrusted bool `json:"is_trusted"`
IsBlacklisted bool `json:"is_blacklisted"`
Error string `json:"error"`
}
type User struct {
@@ -81,11 +83,17 @@ func EmailList(ctx *context.Context, w http.ResponseWriter, req *http.Request) {
response.NewErrorResponse(response.ServerError, "读取邮件列表失败", "").FPrint(w)
return
}
trustedMap := make(map[string]bool)
var trustedSenders []models.UserTrustedSender
if err := db.Instance.Table(&models.UserTrustedSender{}).Where("user_id = ?", ctx.UserID).Find(&trustedSenders); err == nil {
for _, item := range trustedSenders {
trustedMap[strings.ToLower(strings.TrimSpace(item.Email))] = true
whitelistMap := make(map[string]bool)
blacklistMap := make(map[string]bool)
var senderFilters []models.UserTrustedSender
if err := db.Instance.Table(&models.UserTrustedSender{}).Where("user_id = ?", ctx.UserID).Find(&senderFilters); err == nil {
for _, item := range senderFilters {
addr := strings.ToLower(strings.TrimSpace(item.Email))
if item.FilterType == models.FilterTypeBlacklist {
blacklistMap[addr] = true
} else {
whitelistMap[addr] = true
}
}
}
@@ -109,20 +117,27 @@ func EmailList(ctx *context.Context, w http.ResponseWriter, req *http.Request) {
return
}
authentication := parsemail.NewEmailAuthentication(email.SPFCheck == 1, email.DKIMCheck == 1)
senderAddr := strings.ToLower(strings.TrimSpace(sender.EmailAddress))
isTrusted := whitelistMap[senderAddr]
isBlacklisted := blacklistMap[senderAddr]
dangerous := authentication.Dangerous
if trustedMap[strings.ToLower(strings.TrimSpace(sender.EmailAddress))] {
if isBlacklisted {
dangerous = true
} else if isTrusted {
dangerous = false
}
items = append(items, &emilItem{
ID: email.Id,
Title: email.Subject,
Desc: email.Text.String,
Datetime: email.SendDate.Format("2006-01-02 15:04:05"),
IsRead: email.IsRead == 1,
Sender: sender,
To: recipients,
Dangerous: dangerous,
Error: email.Error.String,
ID: email.Id,
Title: email.Subject,
Desc: email.Text.String,
Datetime: email.SendDate.Format("2006-01-02 15:04:05"),
IsRead: email.IsRead == 1,
Sender: sender,
To: recipients,
Dangerous: dangerous,
IsTrusted: isTrusted,
IsBlacklisted: isBlacklisted,
Error: email.Error.String,
})
}