Repository navigation
Expand file tree
/
Copy pathbulk_message_handler_validator.go
More file actions
298 lines (252 loc) · 10.9 KB
/
Copy pathbulk_message_handler_validator.go
File metadata and controls
298 lines (252 loc) · 10.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
package validators
import (
"bytes"
"context"
"fmt"
"io"
"mime/multipart"
"net/url"
"strings"
"time"
"github.com/xuri/excelize/v2"
"github.com/NdoleStudio/httpsms/pkg/cache"
"github.com/NdoleStudio/httpsms/pkg/entities"
"github.com/NdoleStudio/httpsms/pkg/repositories"
"github.com/NdoleStudio/httpsms/pkg/requests"
"github.com/NdoleStudio/httpsms/pkg/services"
"github.com/NdoleStudio/httpsms/pkg/telemetry"
"github.com/dustin/go-humanize"
"github.com/jszwec/csvutil"
"github.com/nyaruka/phonenumbers"
"github.com/palantir/stacktrace"
)
// BulkMessageHandlerValidator validates models used in handlers.BillingHandler
type BulkMessageHandlerValidator struct {
validator
phoneService *services.PhoneService
userService *services.UserService
logger telemetry.Logger
tracer telemetry.Tracer
cache cache.Cache
}
// NewBulkMessageHandlerValidator creates a new handlers.BulkMessageHandlerValidator validator
func NewBulkMessageHandlerValidator(
logger telemetry.Logger,
tracer telemetry.Tracer,
phoneService *services.PhoneService,
userService *services.UserService,
appCache cache.Cache,
) (v *BulkMessageHandlerValidator) {
return &BulkMessageHandlerValidator{
logger: logger.WithService(fmt.Sprintf("%T", v)),
tracer: tracer,
userService: userService,
phoneService: phoneService,
cache: appCache,
}
}
// ValidateStore validates the requests.BillingUsageHistory request
func (v *BulkMessageHandlerValidator) ValidateStore(ctx context.Context, userID entities.UserID, header *multipart.FileHeader) ([]*requests.BulkMessage, *time.Location, url.Values) {
ctx, span, ctxLogger := v.tracer.StartWithLogger(ctx, v.logger)
defer span.End()
user, err := v.userService.GetByID(ctx, userID)
if err != nil {
result := url.Values{}
result.Add("document", "Cannot load your account. Please try again later or contact support.")
ctxLogger.Error(v.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, fmt.Sprintf("cannot load user [%s]", userID))))
return nil, nil, result
}
messages, result := v.parseFile(ctxLogger, user, header)
if len(result) != 0 {
return messages, user.Location(), result
}
if len(messages) == 0 {
result.Add("document", "The uploaded file doesn't contain any valid records. Make sure you are using the official httpSMS template.")
return messages, user.Location(), result
}
if len(messages) > 1000 {
result.Add("document", "The uploaded file must contain less than 1000 records.")
return messages, user.Location(), result
}
for index, message := range messages {
messages[index] = message.Sanitize()
}
result = v.validateMessages(ctx, messages, user.Location())
if len(result) != 0 {
return messages, user.Location(), result
}
result = v.validateOwners(ctx, userID, messages)
if len(result) != 0 {
return messages, user.Location(), result
}
return messages, user.Location(), result
}
func (v *BulkMessageHandlerValidator) parseFile(ctxLogger telemetry.Logger, user *entities.User, header *multipart.FileHeader) ([]*requests.BulkMessage, url.Values) {
if header.Header.Get("Content-Type") == "text/csv" || strings.HasSuffix(header.Filename, ".csv") {
return v.parseCSV(ctxLogger, user, header)
}
if header.Header.Get("Content-Type") == "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" || strings.HasSuffix(header.Filename, ".xlsx") {
return v.parseXlsx(ctxLogger, user, header)
}
ctxLogger.Error(stacktrace.NewError(fmt.Sprintf("cannot parse file [%s] for user [%s] with content type [%s]", header.Filename, user.ID, header.Header.Get("Content-Type"))))
result := url.Values{}
result.Add("document", fmt.Sprintf("The file [%s] is not a valid CSV or Excel file.", header.Filename))
return nil, result
}
func (v *BulkMessageHandlerValidator) parseXlsx(ctxLogger telemetry.Logger, user *entities.User, header *multipart.FileHeader) ([]*requests.BulkMessage, url.Values) {
content, result := v.parseBytes(ctxLogger, user.ID, header)
if len(result) != 0 {
return nil, result
}
excel, err := excelize.OpenReader(bytes.NewReader(content))
if err != nil {
ctxLogger.Error(stacktrace.Propagate(err, fmt.Sprintf("cannot generate excel file from [%s] for user [%s]", header.Filename, user.ID)))
result.Add("document", fmt.Sprintf("Cannot parse the uploaded excel file with name [%s].", header.Filename))
return nil, result
}
defer excel.Close()
rows, err := excel.GetRows(excel.GetSheetName(0))
if err != nil {
ctxLogger.Error(stacktrace.Propagate(err, fmt.Sprintf("cannot get rows from excel file [%s] for user [%s]", header.Filename, user.ID)))
result.Add("document", fmt.Sprintf("Cannot parse the uploaded excel file with name [%s].", header.Filename))
return nil, result
}
var messages []*requests.BulkMessage
for index, row := range rows {
if len(row) < 3 || strings.TrimSpace(row[0]) == "" || index == 0 {
continue
}
var sendTimeRaw string
if len(row) > 3 && strings.TrimSpace(row[3]) != "" {
ctxLogger.Info(fmt.Sprintf("excel time = [%s]", row[3]))
msg := &requests.BulkMessage{SendTime: strings.TrimSpace(row[3])}
sendAt := msg.GetSendTime(user.Location())
if sendAt == nil {
result.Add("document", fmt.Sprintf("Row [%d]: The SendTime [%s] is not in the correct format e.g [2006-01-02T15:04:05] where 2006 is the year, 01 is January, 02 is the second day of the month and the time is 15:04:05", index+1, row[3]))
return nil, result
}
sendTimeRaw = sendAt.Format(time.RFC3339)
}
var attachmentURLs string
if len(row) > 4 && strings.TrimSpace(row[4]) != "" {
attachmentURLs = strings.TrimSpace(row[4])
}
messages = append(messages, &requests.BulkMessage{
FromPhoneNumber: strings.TrimSpace(row[0]),
ToPhoneNumber: strings.TrimSpace(row[1]),
Content: row[2],
SendTime: sendTimeRaw,
AttachmentURLs: attachmentURLs,
})
}
return messages, url.Values{}
}
func (v *BulkMessageHandlerValidator) parseBytes(ctxLogger telemetry.Logger, userID entities.UserID, header *multipart.FileHeader) ([]byte, url.Values) {
result := url.Values{}
if header.Size >= 5000000 {
result.Add("document", fmt.Sprintf("The CSV file must be less than 500 KB the file you uploaded is [%s].", humanize.Bytes(uint64(header.Size))))
return nil, result
}
file, err := header.Open()
if err != nil {
ctxLogger.Error(stacktrace.Propagate(err, fmt.Sprintf("cannot open file [%s] for reading for user [%s]", header.Filename, userID)))
result.Add("document", fmt.Sprintf("Cannot open the uploaded file with name [%s].", header.Filename))
return nil, result
}
defer func() {
if e := file.Close(); e != nil {
ctxLogger.Error(stacktrace.Propagate(e, fmt.Sprintf("cannot close file [%s] for user [%s]", header.Filename, userID)))
}
}()
b := new(bytes.Buffer)
if _, err = io.Copy(b, file); err != nil {
ctxLogger.Error(stacktrace.Propagate(err, fmt.Sprintf("cannot copy file [%s] to buffer for user [%s]", header.Filename, userID)))
result.Add("document", fmt.Sprintf("Cannot read the conents of the uploaded file [%s].", header.Filename))
return nil, result
}
return b.Bytes(), result
}
func (v *BulkMessageHandlerValidator) parseCSV(ctxLogger telemetry.Logger, user *entities.User, header *multipart.FileHeader) ([]*requests.BulkMessage, url.Values) {
content, result := v.parseBytes(ctxLogger, user.ID, header)
if len(result) != 0 {
return nil, result
}
var messages []*requests.BulkMessage
if err := csvutil.Unmarshal(content, &messages); err != nil {
ctxLogger.Error(stacktrace.Propagate(err, fmt.Sprintf("cannot unmarshall contents [%s] into type [%T] for file [%s] and user [%s]", content, messages, header.Filename, user.ID)))
result.Add("document", fmt.Sprintf("Cannot read the contents of the uploaded file [%s].", header.Filename))
return nil, result
}
return messages, url.Values{}
}
func (v *BulkMessageHandlerValidator) validateMessages(_ context.Context, messages []*requests.BulkMessage, location *time.Location) url.Values {
result := url.Values{}
for index, message := range messages {
if message.AttachmentURLs != "" {
urls := strings.Split(message.AttachmentURLs, ",")
validAttachmentCount := 0
for _, u := range urls {
if strings.TrimSpace(u) != "" {
validAttachmentCount++
}
}
if validAttachmentCount > 10 {
result.Add("document", fmt.Sprintf("Row [%d]: You cannot attach more than 10 files per message.", index+2))
}
for _, u := range urls {
cleanURL := strings.TrimSpace(u)
if cleanURL == "" {
continue
}
parsedURL, err := url.ParseRequestURI(cleanURL)
if err != nil || parsedURL.Scheme == "" || parsedURL.Host == "" {
result.Add("document", fmt.Sprintf("Row [%d]: The attachment URL [%s] has an invalid url format.", index+2, cleanURL))
} else if parsedURL.Scheme != "http" && parsedURL.Scheme != "https" {
result.Add("document", fmt.Sprintf("Row [%d]: The attachment URL [%s] must use http or https.", index+2, cleanURL))
}
}
}
if _, err := phonenumbers.Parse(message.FromPhoneNumber, phonenumbers.UNKNOWN_REGION); err != nil {
result.Add("document", fmt.Sprintf("Row [%d]: The FromPhoneNumber [%s] is not a valid E.164 phone number", index+2, message.FromPhoneNumber))
}
if _, err := phonenumbers.Parse(message.ToPhoneNumber, phonenumbers.UNKNOWN_REGION); err != nil {
result.Add("document", fmt.Sprintf("Row [%d]: The ToPhoneNumber [%s] is not a valid E.164 phone number", index+2, message.ToPhoneNumber))
}
if len(message.Content) > 1024 {
result.Add("document", fmt.Sprintf("Row [%d]: The message content must be less than 1024 characters.", index+2))
}
if strings.TrimSpace(message.SendTime) != "" {
sendTime := message.GetSendTime(location)
if sendTime == nil {
result.Add("document", fmt.Sprintf("Row [%d]: The SendTime [%s] is not a valid date format. Use RFC3339 (e.g. 2023-11-11T02:10:01Z) or YYYY-MM-DDTHH:MM:SS.", index+2, message.SendTime))
} else if sendTime.After(time.Now().Add(420 * time.Hour)) {
result.Add("document", fmt.Sprintf("Row [%d]: The SendTime [%s] cannot be more than 20 days (420 hours) in the future.", index+2, sendTime.Format(time.RFC3339)))
}
}
}
return result
}
func (v *BulkMessageHandlerValidator) validateOwners(ctx context.Context, userID entities.UserID, messages []*requests.BulkMessage) url.Values {
numbers := map[string][]int{}
for index, message := range messages {
numbers[message.FromPhoneNumber] = append(numbers[message.FromPhoneNumber], index+2)
}
result := url.Values{}
for number, rows := range numbers {
_, err := v.phoneService.Load(ctx, userID, strings.TrimSpace(number))
if stacktrace.GetCode(err) == repositories.ErrCodeNotFound {
result.Add("document", fmt.Sprintf("Rows [%s]: The FromPhoneNumber [%s] is not registered on your account", v.toString(rows), number))
}
}
return result
}
func (v *BulkMessageHandlerValidator) toString(value []int) string {
result := strings.Builder{}
for index, row := range value {
if index != 0 {
result.WriteString(", ")
}
result.WriteString(fmt.Sprintf("%d", row))
}
return result.String()
}