Skip to content

Sendmail command #13079

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

Merged
merged 25 commits into from
Oct 24, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
016b35b
Add SendSync method
zhiburt Oct 8, 2020
538d0db
Add sendmail command
zhiburt Oct 8, 2020
8ecbcc7
add checks that if either title or content is empty then error out
zhiburt Oct 9, 2020
5c0524a
Add a confirmation step
zhiburt Oct 9, 2020
2abad3e
Add --force option to bypass confirm step
zhiburt Oct 9, 2020
9c98e13
Move implementation of runSendMail to a different file
zhiburt Oct 9, 2020
a750b18
Add copyrighting comment
zhiburt Oct 9, 2020
3cb7d18
Make content optional
zhiburt Oct 12, 2020
d3723b5
Fix import style
zhiburt Oct 12, 2020
087129c
Merge branch 'master' of https://github.com/go-gitea/gitea into sendm…
zhiburt Oct 15, 2020
2ed24b5
Use batch when getting all users
zhiburt Oct 15, 2020
6f4b38d
Merge branch 'sendmail_command' of github.com:zhiburt/gitea into send…
zhiburt Oct 15, 2020
59a1bee
Send emails one by one instead of as one chunck
zhiburt Oct 16, 2020
f5a108d
Send messages concurantly
zhiburt Oct 16, 2020
5b5f8c5
Use SendAsync+Flush instead of SendSync
zhiburt Oct 19, 2020
042c259
Add timeout parameter to sendemail command
zhiburt Oct 19, 2020
a25d8be
Fix spelling mistake
zhiburt Oct 19, 2020
b350eea
Update cmd/admin.go
zhiburt Oct 23, 2020
3d5b393
Connect to a running Gitea instance
zhiburt Oct 23, 2020
cee82ff
Merge branch 'sendmail_command' of github.com:zhiburt/gitea into send…
zhiburt Oct 23, 2020
6968eb9
Fix mispelling
zhiburt Oct 23, 2020
af3cff6
Add copyright comment
zhiburt Oct 23, 2020
b959bf1
Merge branch 'master' into sendmail_command
lunny Oct 24, 2020
1b9f0ee
Merge branch 'master' into sendmail_command
techknowlogick Oct 24, 2020
490fa03
Merge branch 'master' into sendmail_command
techknowlogick Oct 24, 2020
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
23 changes: 23 additions & 0 deletions cmd/admin.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ var (
subcmdRepoSyncReleases,
subcmdRegenerate,
subcmdAuth,
subcmdSendMail,
},
}

Expand Down Expand Up @@ -282,6 +283,28 @@ var (
Action: runAddOauth,
Flags: oauthCLIFlags,
}

subcmdSendMail = cli.Command{
Name: "sendmail",
Usage: "Send a message to all users",
Action: runSendMail,
Flags: []cli.Flag{
cli.StringFlag{
Name: "title",
Usage: `a title of a message`,
Value: "",
},
cli.StringFlag{
Name: "content",
Usage: "a content of a message",
Value: "",
},
cli.BoolFlag{
Name: "force,f",
Usage: "A flag to bypass a confirmation step",
},
},
}
)

func runChangePassword(c *cli.Context) error {
Expand Down
20 changes: 20 additions & 0 deletions cmd/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ package cmd
import (
"errors"
"fmt"
"strings"

"code.gitea.io/gitea/models"
"code.gitea.io/gitea/modules/setting"
Expand All @@ -32,6 +33,25 @@ func argsSet(c *cli.Context, args ...string) error {
return nil
}

// confirm waits for user input which confirms an action
func confirm() (bool, error) {
var response string

_, err := fmt.Scanln(&response)
if err != nil {
return false, err
}

switch strings.ToLower(response) {
case "y", "yes":
return true, nil
case "n", "no":
return false, nil
default:
return false, errors.New(response + " isn't a correct confirmation string")
}
}

func initDB() error {
return initDBDisableConsole(false)
}
Expand Down
48 changes: 48 additions & 0 deletions cmd/mailer.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
// Copyright 2020 The Gitea 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 cmd

import (
"fmt"
"net/http"

"code.gitea.io/gitea/modules/private"
"github.com/urfave/cli"
)

func runSendMail(c *cli.Context) error {
if err := argsSet(c, "title"); err != nil {
return err
}

subject := c.String("title")
confirmSkiped := c.Bool("force")
body := c.String("content")

if !confirmSkiped {
if len(body) == 0 {
fmt.Print("warning: Content is empty")
}

fmt.Print("Proceed with sending email? [Y/n] ")
isConfirmed, err := confirm()
if err != nil {
return err
} else if !isConfirmed {
fmt.Println("The mail was not sent")
return nil
}
}

status, message := private.SendEmail(subject, body, nil)
if status != http.StatusOK {
fmt.Printf("error: %s", message)
return nil
}

fmt.Printf("Succseded: %s", message)

return nil
}
53 changes: 53 additions & 0 deletions modules/private/mail.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
// Copyright 2020 The Gitea 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 private

import (
"encoding/json"
"fmt"
"io/ioutil"
"net/http"

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

// Email structure holds a data for sending general emails
type Email struct {
Subject string
Message string
To []string
}

// SendEmail calls the internal SendEmail function
//
// It accepts a list of usernames.
// If DB contains these users it will send the email to them.
//
// If to list == nil its supposed to send an email to every
// user present in DB
func SendEmail(subject, message string, to []string) (int, string) {
reqURL := setting.LocalURL + "api/internal/mail/send"

req := newInternalRequest(reqURL, "POST")
req = req.Header("Content-Type", "application/json")
jsonBytes, _ := json.Marshal(Email{
Subject: subject,
Message: message,
To: to,
})
req.Body(jsonBytes)
resp, err := req.Response()
if err != nil {
return http.StatusInternalServerError, fmt.Sprintf("Unable to contact gitea: %v", err.Error())
}
defer resp.Body.Close()

body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return http.StatusInternalServerError, fmt.Sprintf("Response body error: %v", err.Error())
}

return http.StatusOK, fmt.Sprintf("Was sent %s from %d", body, len(to))
}
1 change: 1 addition & 0 deletions routers/private/internal.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,6 @@ func RegisterRoutes(m *macaron.Macaron) {
m.Post("/manager/release-and-reopen-logging", ReleaseReopenLogging)
m.Post("/manager/add-logger", bind(private.LoggerOptions{}), AddLogger)
m.Post("/manager/remove-logger/:group/:name", RemoveLogger)
m.Post("/mail/send", SendEmail)
}, CheckInternalToken)
}
67 changes: 67 additions & 0 deletions routers/private/mail.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
// Copyright 2020 The Gitea 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 private

import (
"fmt"
"net/http"
"strconv"

"code.gitea.io/gitea/models"
"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/private"
"code.gitea.io/gitea/services/mailer"
"gitea.com/macaron/macaron"
)

// SendEmail pushes messages to mail queue
//
// It doesn't wait before each message will be processed
func SendEmail(ctx *macaron.Context, mail private.Email) {
var emails []string
if len(mail.To) > 0 {
for _, uname := range mail.To {
user, err := models.GetUserByName(uname)
if err != nil {
err := fmt.Sprintf("Failed to get user information: %v", err)
log.Error(err)
ctx.JSON(http.StatusInternalServerError, map[string]interface{}{
"err": err,
})
return
}

if user != nil {
emails = append(emails, user.Email)
}
}
} else {
err := models.IterateUser(func(user *models.User) error {
emails = append(emails, user.Email)
return nil
})
if err != nil {
err := fmt.Sprintf("Failed to find users: %v", err)
log.Error(err)
ctx.JSON(http.StatusInternalServerError, map[string]interface{}{
"err": err,
})
return
}
}

sendEmail(ctx, mail.Subject, mail.Message, emails)
}

func sendEmail(ctx *macaron.Context, subject, message string, to []string) {
for _, email := range to {
msg := mailer.NewMessage([]string{email}, subject, message)
mailer.SendAsync(msg)
}

wasSent := strconv.Itoa(len(to))

ctx.PlainText(http.StatusOK, []byte(wasSent))
}