-
Notifications
You must be signed in to change notification settings - Fork 0
/
helpers.go
376 lines (303 loc) · 9.77 KB
/
helpers.go
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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
package server
import (
"bytes"
"context"
"encoding/json"
"encoding/xml"
"errors"
"flag"
"fmt"
"net/http"
"os"
"path/filepath"
"strconv"
"strings"
"time"
"github.com/Daskott/kronus/server/auth"
"github.com/Daskott/kronus/server/models"
"github.com/Daskott/kronus/server/pbscheduler"
"github.com/Daskott/kronus/server/work"
"github.com/Daskott/kronus/utils"
"github.com/go-co-op/gocron"
"github.com/go-playground/validator"
"github.com/gorilla/mux"
"gorm.io/gorm"
)
// ---------------------------------------------------------------------------------//
// Handler Helper functions
// --------------------------------------------------------------------------------//
func writeResponse(rw http.ResponseWriter, payLoad ResponsePayload, statusCode int) {
rw.WriteHeader(statusCode)
json.NewEncoder(rw).Encode(payLoad)
if statusCode >= http.StatusInternalServerError {
logg.Error(payLoad.Errors)
return
}
if statusCode >= http.StatusBadRequest {
logg.Info(payLoad.Errors)
}
}
func writeErrMsgForSmsWebhook(rw http.ResponseWriter, err error) {
logg.Error(err)
errMsg := "Sorry an application error has occured.\nPlease try again later"
msgBytes, err := xml.Marshal(&TwilioSmsResponse{Message: errMsg})
if err != nil {
logg.Errorf("writeErrMsgForSmsWebhook: %v", err)
}
writeSmsWebHookResponse(rw, msgBytes, http.StatusOK)
}
func writeSmsWebHookResponse(rw http.ResponseWriter, body []byte, status int) {
rw.WriteHeader(status)
rw.Write(body)
}
func removeUnknownFields(args map[string]interface{}, validFields map[string]bool) {
for key := range args {
if !validFields[key] {
delete(args, key)
}
}
}
func RegisterValidators(validate *validator.Validate) error {
err := validate.RegisterValidation("password", func(fl validator.FieldLevel) bool {
// if whitespace in password return false
err := validate.Var(fl.Field().String(), "contains= ")
if err == nil {
return false
}
return len(fl.Field().String()) > 0
})
if err != nil {
return err
}
err = validate.RegisterValidation("time_stamp", func(fl validator.FieldLevel) bool {
timeSegments := strings.Split(fl.Field().String(), ":")
if len(timeSegments) < 2 {
return false
}
hour, err := strconv.Atoi(timeSegments[0])
if err != nil {
return false
}
minute, err := strconv.Atoi(timeSegments[1])
if err != nil {
return false
}
err = validate.Var(hour, "min=0,max=23")
if err != nil {
return false
}
err = validate.Var(minute, "min=0,max=59")
return err == nil
})
if err != nil {
return err
}
return nil
}
// ---------------------------------------------------------------------------------//
// Middleware Helper functions
// --------------------------------------------------------------------------------//
func decodeAndVerifyAuthHeader(authHeaderValue string) DecodedJWT {
authHeaderList := strings.Split(authHeaderValue, "Bearer ")
if len(authHeaderList) < 2 {
return DecodedJWT{ErrorMsg: "no token provided"}
}
tokenClaims, err := auth.DecodeJWT(authHeaderList[1], authKeyPair)
if err != nil {
return DecodedJWT{ErrorMsg: "invalid token provided"}
}
// validate that the user account still exists
_, err = models.FindUserBy("id", tokenClaims.Subject)
if err != nil {
return DecodedJWT{ErrorMsg: "invalid token provided"}
}
return DecodedJWT{Claims: tokenClaims}
}
// client is only able to update/view their own record unless client is an admin
// who can GET/DELETE certain user resources
func canAccessUserResource(r *http.Request, userClaims *auth.KronusTokenClaims) bool {
allowedMethodsForAdmins := map[string]bool{"GET": true, "DELETE": true}
deniedPathsForAdmin := []string{"/contacts"}
if mux.Vars(r)["uid"] == userClaims.Subject {
return true
}
if !userClaims.IsAdmin {
return false
}
if !allowedMethodsForAdmins[r.Method] {
return false
}
for _, deniedPath := range deniedPathsForAdmin {
if strings.Contains(r.URL.Path, deniedPath) {
return false
}
}
return true
}
func isValidCronExpression(expression string) bool {
_, err := gocron.NewScheduler(time.UTC).Cron(expression).Do(func() {})
return err == nil
}
// ---------------------------------------------------------------------------------//
// Server Helper functions
// --------------------------------------------------------------------------------//
func serve(server *http.Server) {
logg.Infof("Kronus server is listening on port:%v", server.Addr)
if err := server.ListenAndServe(); err != nil && err != http.ErrServerClosed {
logg.Fatal(err)
}
}
func cleanup(workerPool *work.WorkerPoolAdapter, server *http.Server, backupDb bool) {
// Stop all jobs i.e. liveliness probes & regular server jobs
workerPool.Stop()
if backupDb {
backupSqliteDb(nil)
}
// Shutdown server gracefully
ctxShutDown, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
if err := server.Shutdown(ctxShutDown); err != nil {
logg.Fatalf("Kronus server shutdown failed:%+s", err)
}
logg.Infof("Kronus server stopped properly")
}
// configDirectory retrieves the directory to store kronus configs
// Or logs an error message and then calls os.Exit if it's unable to.
func configDirectory(devMode bool) string {
// Use 'kronus' folder in home directory for prod
configFolderName := "kronus"
rootDir, err := os.UserHomeDir()
fatalOnError(err)
// Use 'dev' folder in current directory for dev mode
if devMode {
configFolderName = "dev"
rootDir, err = os.Getwd()
fatalOnError(err)
}
configDir := filepath.Join(rootDir, configFolderName)
err = utils.CreateDirIfNotExist(configDir)
fatalOnError(err)
return configDir
}
func fatalOnError(err error) {
if err != nil {
logg.Fatal(err)
}
}
// ---------------------------------------------------------------------------------//
// Sms Helper functions
// --------------------------------------------------------------------------------//
func handleProbeMsgReply(user models.User, message string) ([]byte, error) {
probe, err := user.LastProbe()
if err != nil {
// If no probe - do nothing
if errors.Is(err, gorm.ErrRecordNotFound) {
return []byte("<Response />"), nil
}
return nil, err
}
pendingProbe, err := probe.IsPending()
if err != nil {
return nil, err
}
// If no pending probe - do nothing
if !pendingProbe {
return []byte("<Response />"), nil
}
// Determine if user probe was 'good' or 'bad' from their reply i.e. message
probe.LastResponse = message
probeStatusName := probe.StatusFromLastResponse()
// if unable to determine probe status from msg - save 'LastResponse' & do nothing
if probeStatusName == "" {
probe.Save()
return []byte("<Response />"), nil
}
probeStatus, err := models.FindProbeStatus(probeStatusName)
if err != nil {
return nil, err
}
probe.ProbeStatusID = probeStatus.ID
probe.Save()
msg := "👍"
if probeStatusName == models.BAD_PROBE {
msg = "Hang in there! Reaching out to your emergency contact ASAP."
// Equeue job to send out message to emergency contact
err = workerPool.Perform(work.JobParams{
Name: pbscheduler.EmergencyProbeName(probe.UserID),
Handler: pbscheduler.SEND_EMERGENCY_PROBE_HANDLER,
Args: map[string]interface{}{
"user_id": probe.UserID,
"probe_id": probe.ID,
"probe_status": models.BAD_PROBE,
},
})
if err != nil {
return nil, err
}
}
return xml.Marshal(&TwilioSmsResponse{Message: msg})
}
func handlePingCmd(input string) ([]byte, error) {
outputBuffer := new(bytes.Buffer)
pingCmd := flag.NewFlagSet("ping", flag.ContinueOnError)
pingCmd.SetOutput(outputBuffer)
err := pingCmd.Parse(strings.Split(input, " ")[1:])
if err != nil {
return xml.Marshal(&TwilioSmsResponse{Message: outputBuffer.String()})
}
return xml.Marshal(&TwilioSmsResponse{Message: "PONG!"})
}
func handleDynamicProbeCmd(user *models.User, input string) ([]byte, error) {
var err error
outputBuffer := new(bytes.Buffer)
probeCmd := flag.NewFlagSet("probe", flag.ContinueOnError)
probeCmd.SetOutput(outputBuffer)
inPtr := probeCmd.Int("in", 5, "Minutes 4rm now to check on u")
retriesPtr := probeCmd.Int("retries", 3, "No. of retries if no response")
waitPtr := probeCmd.Int("wait", 10, "No. of minutes to wait for ur response")
// Parse Arguments without the name of command
err = probeCmd.Parse(strings.Split(input, " ")[1:])
if err != nil {
return xml.Marshal(&TwilioSmsResponse{Message: outputBuffer.String()})
}
if _, err := user.EmergencyContact(); err != nil {
if errors.Is(err, gorm.ErrRecordNotFound) {
return xml.Marshal(&TwilioSmsResponse{Message: "An emergency contact is required to use the 'probe' cmd"})
}
return []byte{}, err
}
err = workerPool.PerformIn(*inPtr*60, work.JobParams{
Name: pbscheduler.SEND_DYNAMIC_PROBE_HANDLER,
Handler: pbscheduler.SEND_DYNAMIC_PROBE_HANDLER,
Args: map[string]interface{}{
"first_name": user.FirstName,
"last_name": user.LastName,
"user_id": user.ID,
"max_retries": *retriesPtr,
"wait_time_in_minutes": *waitPtr,
},
})
if err != nil {
return nil, err
}
return xml.Marshal(&TwilioSmsResponse{Message: fmt.Sprintf(
"👍. Will check on you in %v minutes & retry %v time(s) if no response, "+
"before reaching out to your emergency contact.", *inPtr, *retriesPtr)})
}
func handleHelpCmd(input string) ([]byte, error) {
outputBuffer := new(bytes.Buffer)
usageCmd := flag.NewFlagSet("usage", flag.ContinueOnError)
usageCmd.SetOutput(outputBuffer)
err := usageCmd.Parse(strings.Split(input, " ")[1:])
if err != nil {
return xml.Marshal(&TwilioSmsResponse{Message: outputBuffer.String()})
}
res := `Usage:
[command]
Available Commands:
usage List available commands
probe Ask kronus to check on you in a couple minutes
ping Health check for the server
Use "[command] --help" for more information about a command.`
return xml.Marshal(&TwilioSmsResponse{Message: res})
}