From 7b54850c1648bdc6c26a4d2506bcd62f7168779b Mon Sep 17 00:00:00 2001 From: binwiederhier Date: Fri, 3 Jul 2026 21:04:06 -0400 Subject: [PATCH] Make twilioClient --- server/server.go | 6 +++-- server/server_account.go | 4 +-- server/server_twilio.go | 53 ++++++++++++++++++++++++++-------------- 3 files changed, 40 insertions(+), 23 deletions(-) diff --git a/server/server.go b/server/server.go index f58fadd1..1d8591ea 100644 --- a/server/server.go +++ b/server/server.go @@ -58,6 +58,7 @@ type Server struct { topics map[string]*topic visitors map[string]*visitor // ip: or user: firebaseClient *firebaseClient + twilio *twilioClient messages int64 // Total number of messages (persisted if messageCache enabled) messagesHistory []int64 // Last n values of the messages counter, used to determine rate userManager *user.Manager // Might be nil! @@ -295,6 +296,7 @@ func New(conf *Config) (*Server, error) { webPush: wp, attachment: attachmentStore, firebaseClient: firebaseClient, + twilio: newTwilioClient(conf, userManager), mailer: sender, topics: topics, userManager: userManager, @@ -838,7 +840,7 @@ func (s *Server) handlePublishInternal(r *http.Request, v *visitor) (*model.Mess } if call != "" { var httpErr *errHTTP - call, httpErr = s.convertPhoneNumber(v.User(), call) + call, httpErr = s.twilio.convertPhoneNumber(v.User(), call) if httpErr != nil { return nil, httpErr.With(t) } else if !vrate.CallAllowed() { @@ -887,7 +889,7 @@ func (s *Server) handlePublishInternal(r *http.Request, v *visitor) (*model.Mess go s.sendEmail(v, m, email) } if s.config.TwilioAccount != "" && call != "" { - go s.callPhone(v, r, m, call) + go s.twilio.callPhone(v, r, m, call) } if s.config.UpstreamBaseURL != "" && !unifiedpush { // UP messages are not sent to upstream go s.forwardPollRequest(v, m) diff --git a/server/server_account.go b/server/server_account.go index 4b80285a..17094d1d 100644 --- a/server/server_account.go +++ b/server/server_account.go @@ -613,7 +613,7 @@ func (s *Server) handleAccountPhoneNumberVerify(w http.ResponseWriter, r *http.R } // Actually add the unverified number, and send verification logvr(v, r).Tag(tagAccount).Field("phone_number", req.Number).Debug("Sending phone number verification") - if err := s.verifyPhoneNumber(v, r, req.Number, req.Channel); err != nil { + if err := s.twilio.verifyPhoneNumber(v, r, req.Number, req.Channel); err != nil { return err } return s.writeJSON(w, newSuccessResponse()) @@ -628,7 +628,7 @@ func (s *Server) handleAccountPhoneNumberAdd(w http.ResponseWriter, r *http.Requ if !phoneNumberRegex.MatchString(req.Number) { return errHTTPBadRequestPhoneNumberInvalid } - if err := s.verifyPhoneNumberCheck(v, r, req.Number, req.Code); err != nil { + if err := s.twilio.verifyPhoneNumberCheck(v, r, req.Number, req.Code); err != nil { return err } logvr(v, r).Tag(tagAccount).Field("phone_number", req.Number).Debug("Adding phone number as verified") diff --git a/server/server_twilio.go b/server/server_twilio.go index 03f9dcaf..08192621 100644 --- a/server/server_twilio.go +++ b/server/server_twilio.go @@ -16,6 +16,21 @@ import ( "heckel.io/ntfy/v2/util" ) +// twilioClient talks to the Twilio API to make phone calls (for the "Call" feature) and to verify +// phone numbers. It holds the Twilio configuration and the user manager (used to look up a user's +// verified phone numbers), so that this functionality is decoupled from the main Server. +type twilioClient struct { + config *Config + userManager *user.Manager // May be nil! +} + +func newTwilioClient(conf *Config, userManager *user.Manager) *twilioClient { + return &twilioClient{ + config: conf, + userManager: userManager, + } +} + // defaultTwilioCallFormatTemplate is the default TwiML template used for Twilio calls. // It can be overridden in the server configuration's twilio-call-format field. // @@ -52,11 +67,11 @@ type twilioCallData struct { // convertPhoneNumber checks if the given phone number is verified for the given user, and if so, returns the verified // phone number. It also converts a boolean string ("yes", "1", "true") to the first verified phone number. // If the user is anonymous, it will return an error. -func (s *Server) convertPhoneNumber(u *user.User, phoneNumber string) (string, *errHTTP) { +func (c *twilioClient) convertPhoneNumber(u *user.User, phoneNumber string) (string, *errHTTP) { if u == nil { return "", errHTTPBadRequestAnonymousCallsNotAllowed } - phoneNumbers, err := s.userManager.PhoneNumbers(u.ID) + phoneNumbers, err := c.userManager.PhoneNumbers(u.ID) if err != nil { return "", errHTTPInternalError } else if len(phoneNumbers) == 0 { @@ -72,14 +87,14 @@ func (s *Server) convertPhoneNumber(u *user.User, phoneNumber string) (string, * // callPhone calls the Twilio API to make a phone call to the given phone number, using the given message. // Failures will be logged, but not returned to the caller. -func (s *Server) callPhone(v *visitor, r *http.Request, m *model.Message, to string) { +func (c *twilioClient) callPhone(v *visitor, r *http.Request, m *model.Message, to string) { u, sender := v.User(), m.Sender.String() if u != nil { sender = u.Name } tmpl := defaultTwilioCallFormatTemplate - if s.config.TwilioCallFormat != nil { - tmpl = s.config.TwilioCallFormat + if c.config.TwilioCallFormat != nil { + tmpl = c.config.TwilioCallFormat } tags := make([]string, len(m.Tags)) for i, tag := range m.Tags { @@ -101,11 +116,11 @@ func (s *Server) callPhone(v *visitor, r *http.Request, m *model.Message, to str } body := bodyBuf.String() data := url.Values{} - data.Set("From", s.config.TwilioPhoneNumber) + data.Set("From", c.config.TwilioPhoneNumber) data.Set("To", to) data.Set("Twiml", body) ev := logvrm(v, r, m).Tag(tagTwilio).Field("twilio_to", to).FieldIf("twilio_body", body, log.TraceLevel).Debug("Sending Twilio request") - response, err := s.callPhoneInternal(data) + response, err := c.callPhoneInternal(data) if err != nil { ev.Field("twilio_response", response).Err(err).Warn("Error sending Twilio request") minc(metricCallsMadeFailure) @@ -115,15 +130,15 @@ func (s *Server) callPhone(v *visitor, r *http.Request, m *model.Message, to str minc(metricCallsMadeSuccess) } -func (s *Server) callPhoneInternal(data url.Values) (string, error) { - requestURL := fmt.Sprintf("%s/2010-04-01/Accounts/%s/Calls.json", s.config.TwilioCallsBaseURL, s.config.TwilioAccount) +func (c *twilioClient) callPhoneInternal(data url.Values) (string, error) { + requestURL := fmt.Sprintf("%s/2010-04-01/Accounts/%s/Calls.json", c.config.TwilioCallsBaseURL, c.config.TwilioAccount) req, err := http.NewRequest(http.MethodPost, requestURL, strings.NewReader(data.Encode())) if err != nil { return "", err } - req.Header.Set("User-Agent", "ntfy/"+s.config.BuildVersion) + req.Header.Set("User-Agent", "ntfy/"+c.config.BuildVersion) req.Header.Add("Content-Type", "application/x-www-form-urlencoded") - req.Header.Set("Authorization", util.BasicAuth(s.config.TwilioAccount, s.config.TwilioAuthToken)) + req.Header.Set("Authorization", util.BasicAuth(c.config.TwilioAccount, c.config.TwilioAuthToken)) resp, err := http.DefaultClient.Do(req) if err != nil { return "", err @@ -135,19 +150,19 @@ func (s *Server) callPhoneInternal(data url.Values) (string, error) { return string(response), nil } -func (s *Server) verifyPhoneNumber(v *visitor, r *http.Request, phoneNumber, channel string) error { +func (c *twilioClient) verifyPhoneNumber(v *visitor, r *http.Request, phoneNumber, channel string) error { ev := logvr(v, r).Tag(tagTwilio).Field("twilio_to", phoneNumber).Field("twilio_channel", channel).Debug("Sending phone verification") data := url.Values{} data.Set("To", phoneNumber) data.Set("Channel", channel) - requestURL := fmt.Sprintf("%s/v2/Services/%s/Verifications", s.config.TwilioVerifyBaseURL, s.config.TwilioVerifyService) + requestURL := fmt.Sprintf("%s/v2/Services/%s/Verifications", c.config.TwilioVerifyBaseURL, c.config.TwilioVerifyService) req, err := http.NewRequest(http.MethodPost, requestURL, strings.NewReader(data.Encode())) if err != nil { return err } - req.Header.Set("User-Agent", "ntfy/"+s.config.BuildVersion) + req.Header.Set("User-Agent", "ntfy/"+c.config.BuildVersion) req.Header.Add("Content-Type", "application/x-www-form-urlencoded") - req.Header.Set("Authorization", util.BasicAuth(s.config.TwilioAccount, s.config.TwilioAuthToken)) + req.Header.Set("Authorization", util.BasicAuth(c.config.TwilioAccount, c.config.TwilioAuthToken)) resp, err := http.DefaultClient.Do(req) if err != nil { return err @@ -161,19 +176,19 @@ func (s *Server) verifyPhoneNumber(v *visitor, r *http.Request, phoneNumber, cha return nil } -func (s *Server) verifyPhoneNumberCheck(v *visitor, r *http.Request, phoneNumber, code string) error { +func (c *twilioClient) verifyPhoneNumberCheck(v *visitor, r *http.Request, phoneNumber, code string) error { ev := logvr(v, r).Tag(tagTwilio).Field("twilio_to", phoneNumber).Debug("Checking phone verification") data := url.Values{} data.Set("To", phoneNumber) data.Set("Code", code) - requestURL := fmt.Sprintf("%s/v2/Services/%s/VerificationCheck", s.config.TwilioVerifyBaseURL, s.config.TwilioVerifyService) + requestURL := fmt.Sprintf("%s/v2/Services/%s/VerificationCheck", c.config.TwilioVerifyBaseURL, c.config.TwilioVerifyService) req, err := http.NewRequest(http.MethodPost, requestURL, strings.NewReader(data.Encode())) if err != nil { return err } - req.Header.Set("User-Agent", "ntfy/"+s.config.BuildVersion) + req.Header.Set("User-Agent", "ntfy/"+c.config.BuildVersion) req.Header.Add("Content-Type", "application/x-www-form-urlencoded") - req.Header.Set("Authorization", util.BasicAuth(s.config.TwilioAccount, s.config.TwilioAuthToken)) + req.Header.Set("Authorization", util.BasicAuth(c.config.TwilioAccount, c.config.TwilioAuthToken)) resp, err := http.DefaultClient.Do(req) if err != nil { return err