BillionMail gives you open-source MailServer, NewsLetter, Email Marketing — fully self-hosted, dev-friendly, and free from monthly fees. Join the discord: https://discord.gg/asfXzBUhZr
Improve api sender ip whitelist
lotk5636aeecfd14
diff --git a/core/api/batch_mail/batch_mail.go b/core/api/batch_mail/batch_mail.goindex 3e2debb1..63ea9d49 100644--- a/core/api/batch_mail/batch_mail.go+++ b/core/api/batch_mail/batch_mail.go@@ -18,6 +18,7 @@ type IBatchMailV1 interface {ApiTemplatesDelete(ctx context.Context, req *v1.ApiTemplatesDeleteReq) (res *v1.ApiTemplatesDeleteRes, err error)ApiMailSend(ctx context.Context, req *v1.ApiMailSendReq) (res *v1.ApiMailSendRes, err error)ListTasks(ctx context.Context, req *v1.ListTasksReq) (res *v1.ListTasksRes, err error)+ TaskOverview(ctx context.Context, req *v1.TaskOverviewReq) (res *v1.TaskOverviewRes, err error)DeleteTask(ctx context.Context, req *v1.DeleteTaskReq) (res *v1.DeleteTaskRes, err error)CreateTask(ctx context.Context, req *v1.CreateTaskReq) (res *v1.CreateTaskRes, err error)GetTaskSendCount(ctx context.Context, req *v1.GetTaskSendCountReq) (res *v1.GetTaskSendCountRes, err error)diff --git a/core/api/batch_mail/v1/api_mail.go b/core/api/batch_mail/v1/api_mail.goindex 7aa8c702..3b2f952a 100644--- a/core/api/batch_mail/v1/api_mail.go+++ b/core/api/batch_mail/v1/api_mail.go@@ -71,14 +71,15 @@ type ApiTemplatesListReq struct {type ApiTemplatesInfo struct {ApiTemplates- SendCount int `json:"send_count" dc:"send count"`- SuccessCount int `json:"success_count" dc:"success count"`- FailCount int `json:"fail_count" dc:"fail count"`- OpenRate float64 `json:"open_rate" dc:"open rate"`- ClickRate float64 `json:"click_rate" dc:"click rate"`- DeliveryRate float64 `json:"delivery_rate" dc:"delivery rate"`- BounceRate float64 `json:"bounce_rate" dc:"bounce rate"`- UnsubscribeCount int `json:"unsubscribe_count" dc:"unsubscribe count"`+ SendCount int `json:"send_count" dc:"send count"`+ SuccessCount int `json:"success_count" dc:"success count"`+ FailCount int `json:"fail_count" dc:"fail count"`+ OpenRate float64 `json:"open_rate" dc:"open rate"`+ ClickRate float64 `json:"click_rate" dc:"click rate"`+ DeliveryRate float64 `json:"delivery_rate" dc:"delivery rate"`+ BounceRate float64 `json:"bounce_rate" dc:"bounce rate"`+ UnsubscribeCount int `json:"unsubscribe_count" dc:"unsubscribe count"`+ IpWhitelist []string `json:"ip_whitelist" dc:"IP whitelist"`}type ApiTemplatesListRes struct {@@ -122,6 +123,8 @@ type ApiTemplatesCreateReq struct {Unsubscribe int `json:"unsubscribe" dc:"unsubscribe"`Active int `json:"active" dc:"active"`ExpireTime int `json:"expire_time" dc:"expire time"` // 0 is a permanently valid unit of seconds+ //IpWhitelistEnabled int `json:"ip_whitelist_enabled" dc:"ip whitelist enabled"`+ IpWhitelist []string `json:"ip_whitelist" dc:"ip whitelist"`}type ApiTemplatesCreateRes struct {@@ -143,6 +146,8 @@ type ApiTemplatesUpdateReq struct {Active int `json:"active" dc:"active"`ExpireTime int `json:"expire_time" dc:"Key expiration time (0 is permanent)"`ResetKey bool `json:"reset_key" dc:"reset key"`+ //IpWhitelistEnabled int `json:"ip_whitelist_enabled" dc:"ip whitelist enabled"`+ IpWhitelist []string `json:"ip_whitelist" dc:"ip whitelist"`}type ApiTemplatesUpdateRes struct {@@ -160,11 +165,10 @@ type ApiTemplatesDeleteRes struct {}type ApiMailSendReq struct {- g.Meta `path:"/batch_mail/api/send" method:"post" tags:"ApiMail" summary:"call api send mail"`- Authorization string `json:"authorization" dc:"Authorization" in:"header"`- ApiKey string `json:"x-api-key" dc:"API Key" in:"header"`- Addresser string `json:"addresser" dc:"addresser"`- Recipient string `json:"recipient" dc:"recipient"`+ g.Meta `path:"/batch_mail/api/send" method:"post" tags:"ApiMail" summary:"call api send mail"`+ ApiKey string `json:"x-api-key" dc:"API Key" in:"header"`+ Addresser string `json:"addresser" dc:"addresser"`+ Recipient string `json:"recipient" dc:"recipient"`}type ApiMailSendRes struct {diff --git a/core/api/batch_mail/v1/batch_mail.go b/core/api/batch_mail/v1/batch_mail.goindex b00dcf90..f7af1ed6 100644--- a/core/api/batch_mail/v1/batch_mail.go+++ b/core/api/batch_mail/v1/batch_mail.go@@ -45,12 +45,12 @@ type TaskDetail struct {TemplateName string `json:"template_name" dc:"template name"`SuccessCount int `json:"success_count" dc:"success count"`ErrorCount int `json:"error_count" dc:"error count"`- Opened int `json:"opened" dc:"opened count"`- Clicked int `json:"clicked" dc:"clicked count"`- DeliveryRate float64 `json:"delivery_rate" dc:"delivery rate"`- BounceRate float64 `json:"bounce_rate" dc:"bounce rate"`- OpenRate float64 `json:"open_rate" dc:"open rate"`- ClickRate float64 `json:"click_rate" dc:"click rate"`+ //Opened int `json:"opened" dc:"opened count"`+ //Clicked int `json:"clicked" dc:"clicked count"`+ //DeliveryRate float64 `json:"delivery_rate" dc:"delivery rate"`+ //BounceRate float64 `json:"bounce_rate" dc:"bounce rate"`+ //OpenRate float64 `json:"open_rate" dc:"open rate"`+ //ClickRate float64 `json:"click_rate" dc:"click rate"`}type ListTasksReq struct {@@ -70,6 +70,30 @@ type ListTasksRes struct {} `json:"data"`}+type TaskSummaryStats struct {+ Sends int `json:"sends"`+ Delivered int `json:"delivered"`+ Bounced int `json:"bounced"`+ Opened int `json:"opened"`+ Clicked int `json:"clicked"`+ DeliveryRate float64 `json:"delivery_rate"`+ BounceRate float64 `json:"bounce_rate"`+ OpenRate float64 `json:"open_rate"`+ ClickRate float64 `json:"click_rate"`+}++type TaskOverviewReq struct {+ g.Meta `path:"/batch_mail/task/overview" method:"get" tags:"BatchMail" summary:"get task overview"`+ Authorization string `json:"authorization" dc:"Authorization" in:"header"`+ StartTime int `json:"start_time" dc:"start time"`+ EndTime int `json:"end_time" dc:"end time"`+}++type TaskOverviewRes struct {+ api_v1.StandardRes+ Data TaskSummaryStats `json:"data"`+}+type DeleteTaskReq struct {g.Meta `path:"/batch_mail/task/delete" method:"post" tags:"BatchMail" summary:"delete task"`Authorization string `json:"authorization" dc:"Authorization" in:"header"`diff --git a/core/internal/controller/batch_mail/batch_mail_v1_api_mail_send.go b/core/internal/controller/batch_mail/batch_mail_v1_api_mail_send.goindex 11462942..93358b87 100644--- a/core/internal/controller/batch_mail/batch_mail_v1_api_mail_send.go+++ b/core/internal/controller/batch_mail/batch_mail_v1_api_mail_send.go@@ -20,12 +20,12 @@ import (func (c *ControllerV1) ApiMailSend(ctx context.Context, req *v1.ApiMailSendReq) (res *v1.ApiMailSendRes, err error) {res = &v1.ApiMailSendRes{}-+ clientIP := g.RequestFromCtx(ctx).GetClientIp()// 1. check API Key- apiTemplate, err := getApiTemplateByKey(ctx, req.ApiKey)+ apiTemplate, err := getApiTemplateByKey(ctx, req.ApiKey, clientIP)if err != nil {res.Code = 1001- res.SetError(gerror.New(public.LangCtx(ctx, "API key is invalid")))+ res.SetError(gerror.New(public.LangCtx(ctx, err.Error())))return res, nil}@@ -84,14 +84,28 @@ func (c *ControllerV1) ApiMailSend(ctx context.Context, req *v1.ApiMailSendReq)}// get API template-func getApiTemplateByKey(ctx context.Context, apiKey string) (*entity.ApiTemplates, error) {+func getApiTemplateByKey(ctx context.Context, apiKey string, clientIP string) (*entity.ApiTemplates, error) {var apiTemplate entity.ApiTemplateserr := g.DB().Model("api_templates").Where("api_key", apiKey).Where("active", 1).Scan(&apiTemplate)if err != nil || apiTemplate.Id == 0 {return nil, gerror.New(public.LangCtx(ctx, "API key is invalid"))}- // todo检查 是否开启ip白名单+ ipcount, err := g.DB().Model("api_ip_whitelist").+ Where("api_id", apiTemplate.Id).Count()+ if err == nil && ipcount > 0 {++ count, err := g.DB().Model("api_ip_whitelist").+ Where("api_id", apiTemplate.Id).+ Where("ip", clientIP).+ Count()+ if err != nil {+ return nil, err+ }+ if count == 0 {+ return nil, gerror.New(public.LangCtx(ctx, "IP not allowed"))+ }+ }return &apiTemplate, nil}diff --git a/core/internal/controller/batch_mail/batch_mail_v1_api_templates_create.go b/core/internal/controller/batch_mail/batch_mail_v1_api_templates_create.goindex a3ace176..c37fa641 100644--- a/core/internal/controller/batch_mail/batch_mail_v1_api_templates_create.go+++ b/core/internal/controller/batch_mail/batch_mail_v1_api_templates_create.go@@ -8,6 +8,8 @@ import ("encoding/hex""github.com/gogf/gf/v2/errors/gerror""github.com/gogf/gf/v2/frame/g"+ "net"+ "strings""time")@@ -37,8 +39,18 @@ func (c *ControllerV1) ApiTemplatesCreate(ctx context.Context, req *v1.ApiTemplareturn nil, err}+ tx, err := g.DB().Begin(ctx)+ if err != nil {+ return nil, err+ }+ defer func() {+ if err != nil {+ tx.Rollback()+ }+ }()+// create API template- _, err = g.DB().Model("api_templates").Insert(g.Map{+ result, err := tx.Model("api_templates").Insert(g.Map{"api_key": apiKey,"api_name": req.ApiName,"template_id": req.TemplateId,@@ -49,14 +61,47 @@ func (c *ControllerV1) ApiTemplatesCreate(ctx context.Context, req *v1.ApiTempla"track_open": 1,"track_click": 1,"active": req.Active,- "expire_time": req.ExpireTime, // 0 is a permanently valid unit of seconds+ "expire_time": 0,"last_key_update_time": time.Now().Unix(),+ //"ip_whitelist_enabled": req.IpWhitelistEnabled,})if err != nil {return nil, err}+ apiId, err := result.LastInsertId()+ if err != nil {+ return nil, err+ }++ if len(req.IpWhitelist) > 0 {+ now := time.Now().Unix()+ for _, ip := range req.IpWhitelist {+ ip = strings.TrimSpace(ip)+ if ip == "" {+ continue+ }++ if net.ParseIP(ip) == nil {+ continue+ }++ _, err = tx.Model("api_ip_whitelist").Insert(g.Map{+ "api_id": apiId,+ "ip": strings.TrimSpace(ip),+ "create_time": now,+ })+ if err != nil {+ return nil, err+ }+ }+ }++ if err = tx.Commit(); err != nil {+ return nil, err+ }+res.SetSuccess(public.LangCtx(ctx, "Create API successfully"))return res, nil}diff --git a/core/internal/controller/batch_mail/batch_mail_v1_api_templates_list.go b/core/internal/controller/batch_mail/batch_mail_v1_api_templates_list.goindex 4ddf5530..8e906cda 100644--- a/core/internal/controller/batch_mail/batch_mail_v1_api_templates_list.go+++ b/core/internal/controller/batch_mail/batch_mail_v1_api_templates_list.go@@ -114,6 +114,21 @@ func (c *ControllerV1) ApiTemplatesList(ctx context.Context, req *v1.ApiTemplateCount()}item.UnsubscribeCount = unsubscribeCount+ // get IP whitelist+ var ipRows []struct{ Ip string }+ err = g.DB().Model("api_ip_whitelist").+ Where("api_id", item.Id).+ Fields("ip").+ Scan(&ipRows)+ if err != nil {+ g.Log().Error(ctx, "Failed to get IP whitelist:", err)+ continue+ }+ ips := make([]string, 0, len(ipRows))+ for _, row := range ipRows {+ ips = append(ips, row.Ip)+ }+ item.IpWhitelist = ips}res.Data.Total = totaldiff --git a/core/internal/controller/batch_mail/batch_mail_v1_api_templates_update.go b/core/internal/controller/batch_mail/batch_mail_v1_api_templates_update.goindex 76bd41c6..7f08f3c0 100644--- a/core/internal/controller/batch_mail/batch_mail_v1_api_templates_update.go+++ b/core/internal/controller/batch_mail/batch_mail_v1_api_templates_update.go@@ -6,6 +6,8 @@ import ("context""github.com/gogf/gf/v2/errors/gerror""github.com/gogf/gf/v2/frame/g"+ "net"+ "strings""time")@@ -13,6 +15,7 @@ func (c *ControllerV1) ApiTemplatesUpdate(ctx context.Context, req *v1.ApiTemplares = &v1.ApiTemplatesUpdateRes{}// verify if API exists+count, err := g.DB().Model("api_templates").Where("id", req.ID).Count()if err != nil {return nil, err@@ -29,6 +32,17 @@ func (c *ControllerV1) ApiTemplatesUpdate(ctx context.Context, req *v1.ApiTemplaif count == 0 {return nil, gerror.New(public.LangCtx(ctx, "Email template does not exist"))}++ tx, err := g.DB().Begin(ctx)+ if err != nil {+ return nil, err+ }+ defer func() {+ if err != nil {+ tx.Rollback()+ }+ }()+// current timenow := time.Now().Unix()@@ -44,18 +58,10 @@ func (c *ControllerV1) ApiTemplatesUpdate(ctx context.Context, req *v1.ApiTempla"active": req.Active,"expire_time": req.ExpireTime,"update_time": now,+ //"ip_whitelist_enabled": req.IpWhitelistEnabled,}- if req.ResetKey {- apiKey, err := generateApiKey()- if err != nil {- return nil, err- }- updateMap["api_key"] = apiKey- updateMap["last_key_update_time"] = now- }-- _, err = g.DB().Model("api_templates").+ _, err = tx.Model("api_templates").Where("id", req.ID).Update(updateMap)@@ -63,6 +69,39 @@ func (c *ControllerV1) ApiTemplatesUpdate(ctx context.Context, req *v1.ApiTemplareturn nil, err}+ // ip+ _, err = tx.Model("api_ip_whitelist").+ Where("api_id", req.ID).+ Delete()+ if err != nil {+ return nil, err+ }++ if len(req.IpWhitelist) > 0 {+ for _, ip := range req.IpWhitelist {+ ip = strings.TrimSpace(ip)+ if ip == "" {+ continue+ }++ if net.ParseIP(ip) == nil {+ continue+ }+ _, err = tx.Model("api_ip_whitelist").Insert(g.Map{+ "api_id": req.ID,+ "ip": strings.TrimSpace(ip),+ "create_time": now,+ })+ if err != nil {+ return nil, err+ }+ }+ }++ if err = tx.Commit(); err != nil {+ return nil, err+ }+res.SetSuccess(public.LangCtx(ctx, "Update API successfully"))return res, nil}diff --git a/core/internal/controller/batch_mail/batch_mail_v1_list_tasks.go b/core/internal/controller/batch_mail/batch_mail_v1_list_tasks.goindex 4beda4f2..ce813e30 100644--- a/core/internal/controller/batch_mail/batch_mail_v1_list_tasks.go+++ b/core/internal/controller/batch_mail/batch_mail_v1_list_tasks.go@@ -31,13 +31,13 @@ func (c *ControllerV1) ListTasks(ctx context.Context, req *v1.ListTasksReq) (resdetail.SentCount = stats["sends"].(int)detail.SuccessCount = stats["delivered"].(int)- detail.Opened = stats["opened"].(int)- detail.Clicked = stats["clicked"].(int)+ //detail.Opened = stats["opened"].(int)+ //detail.Clicked = stats["clicked"].(int)detail.ErrorCount = stats["bounced"].(int)- detail.DeliveryRate = stats["delivery_rate"].(float64)- detail.BounceRate = stats["bounce_rate"].(float64)- detail.OpenRate = stats["open_rate"].(float64)- detail.ClickRate = stats["click_rate"].(float64)+ //detail.DeliveryRate = stats["delivery_rate"].(float64)+ //detail.BounceRate = stats["bounce_rate"].(float64)+ //detail.OpenRate = stats["open_rate"].(float64)+ //detail.ClickRate = stats["click_rate"].(float64)}sentCount := detail.SentCount@@ -123,35 +123,35 @@ func GetTaskStats(ctx context.Context, taskId int64) map[string]interface{} {delivered := result["delivered"].Int()bounced := result["bounced"].Int()- // 通过campaign_id查打开和点击- campaignId := int(taskId)- openedCount, _ := g.DB().Model("mailstat_opened").- Where("campaign_id", campaignId).- Fields("count(distinct postfix_message_id) as opened").- Value()- clickedCount, _ := g.DB().Model("mailstat_clicked").- Where("campaign_id", campaignId).- Fields("count(distinct postfix_message_id) as clicked").- Value()+ //// 通过campaign_id查打开和点击+ //campaignId := int(taskId)+ //openedCount, _ := g.DB().Model("mailstat_opened").+ // Where("campaign_id", campaignId).+ // Fields("count(distinct postfix_message_id) as opened").+ // Value()+ //clickedCount, _ := g.DB().Model("mailstat_clicked").+ // Where("campaign_id", campaignId).+ // Fields("count(distinct postfix_message_id) as clicked").+ // Value()stats := map[string]interface{}{"sends": sends,"delivered": delivered,- "opened": openedCount.Int(),- "clicked": clickedCount.Int(),- "bounced": bounced,+ //"opened": openedCount.Int(),+ //"clicked": clickedCount.Int(),+ "bounced": bounced,}if sends > 0 {stats["delivery_rate"] = public.Round(float64(delivered)/float64(sends)*100, 2)stats["bounce_rate"] = public.Round(float64(bounced)/float64(sends)*100, 2)- stats["open_rate"] = public.Round(float64(stats["opened"].(int))/float64(sends)*100, 2)- stats["click_rate"] = public.Round(float64(stats["clicked"].(int))/float64(sends)*100, 2)+ //stats["open_rate"] = public.Round(float64(stats["opened"].(int))/float64(sends)*100, 2)+ //stats["click_rate"] = public.Round(float64(stats["clicked"].(int))/float64(sends)*100, 2)} else {stats["delivery_rate"] = 0.0stats["bounce_rate"] = 0.0- stats["open_rate"] = 0.0- stats["click_rate"] = 0.0+ //stats["open_rate"] = 0.0+ //stats["click_rate"] = 0.0}return statsdiff --git a/core/internal/controller/batch_mail/batch_mail_v1_task_overview.go b/core/internal/controller/batch_mail/batch_mail_v1_task_overview.gonew file mode 100644index 00000000..117eb0e5--- /dev/null+++ b/core/internal/controller/batch_mail/batch_mail_v1_task_overview.go@@ -0,0 +1,72 @@+package batch_mail++import (+ "billionmail-core/internal/service/public"+ "context"+ "github.com/gogf/gf/v2/frame/g"+ "time"++ "billionmail-core/api/batch_mail/v1"+)++func (c *ControllerV1) TaskOverview(ctx context.Context, req *v1.TaskOverviewReq) (res *v1.TaskOverviewRes, err error) {+ res = &v1.TaskOverviewRes{}++ startTime := req.StartTime+ endTime := req.EndTime+ if startTime > 0 && endTime < 0 {+ endTime = int(time.Now().Unix())+ }++ query := g.DB().Model("mailstat_send_mails")+ if startTime > 0 {+ query = query.Where("log_time_millis > ?", startTime*1000-1)+ }+ if endTime > 0 {+ query = query.Where("log_time_millis < ?", endTime*1000+1)+ }+ query = query.Fields(+ "count(*) as sends",+ "coalesce(sum(case when status='sent' and dsn like '2.%' then 1 else 0 end), 0) as delivered",+ "coalesce(sum(case when status='bounced' then 1 else 0 end), 0) as bounced",+ )+ result, err := query.One()+ if err != nil {+ return nil, err+ }+ sends := result["sends"].Int()+ delivered := result["delivered"].Int()+ bounced := result["bounced"].Int()++ openedCount, _ := g.DB().Model("mailstat_opened").+ WhereGTE("log_time_millis", startTime*1000).+ WhereLTE("log_time_millis", endTime*1000).+ Fields("count(distinct postfix_message_id) as opened").+ Value()+ clickedCount, _ := g.DB().Model("mailstat_clicked").+ WhereGTE("log_time_millis", startTime*1000).+ WhereLTE("log_time_millis", endTime*1000).+ Fields("count(distinct postfix_message_id) as clicked").+ Value()++ var deliveryRate, bounceRate, openRate, clickRate float64+ if sends > 0 {+ deliveryRate = public.Round(float64(delivered)/float64(sends)*100, 2)+ bounceRate = public.Round(float64(bounced)/float64(sends)*100, 2)+ openRate = public.Round(float64(openedCount.Int())/float64(sends)*100, 2)+ clickRate = public.Round(float64(clickedCount.Int())/float64(sends)*100, 2)+ }++ res.Data.Sends = sends+ res.Data.Delivered = delivered+ res.Data.Bounced = bounced+ res.Data.Opened = openedCount.Int()+ res.Data.Clicked = clickedCount.Int()+ res.Data.DeliveryRate = deliveryRate+ res.Data.BounceRate = bounceRate+ res.Data.OpenRate = openRate+ res.Data.ClickRate = clickRate++ res.SetSuccess(public.LangCtx(ctx, "Success"))+ return res, nil+}diff --git a/core/internal/service/database_initialization/batch_mail.go b/core/internal/service/database_initialization/batch_mail.goindex e975292f..4b6ba1c8 100644--- a/core/internal/service/database_initialization/batch_mail.go+++ b/core/internal/service/database_initialization/batch_mail.go@@ -129,6 +129,14 @@ func init() {send_time INTEGER NOT NULL DEFAULT EXTRACT(EPOCH FROM NOW()))`,+ `CREATE TABLE IF NOT EXISTS api_ip_whitelist (+ id SERIAL PRIMARY KEY,+ api_id INTEGER NOT NULL,+ ip VARCHAR(45) NOT NULL,+ create_time INTEGER NOT NULL DEFAULT EXTRACT(EPOCH FROM NOW()),+ FOREIGN KEY (api_id) REFERENCES api_templates(id) ON DELETE CASCADE+ )`,+`CREATE INDEX IF NOT EXISTS idx_unsubscribe_email ON unsubscribe_records (email)`,`CREATE INDEX IF NOT EXISTS idx_unsubscribe_time ON unsubscribe_records (unsubscribe_time)`,`CREATE INDEX IF NOT EXISTS idx_bm_contacts_email ON bm_contacts (email)`,