generated from mattermost/mattermost-plugin-starter-template
-
Notifications
You must be signed in to change notification settings - Fork 144
/
playbook_runs.go
1913 lines (1591 loc) · 64.1 KB
/
playbook_runs.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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package api
import (
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"sort"
"strconv"
"strings"
"time"
"github.com/gorilla/mux"
"github.com/mattermost/mattermost-plugin-playbooks/client"
"github.com/mattermost/mattermost-server/v6/model"
"github.com/pkg/errors"
pluginapi "github.com/mattermost/mattermost-plugin-api"
"github.com/mattermost/mattermost-plugin-playbooks/server/app"
"github.com/mattermost/mattermost-plugin-playbooks/server/bot"
"github.com/mattermost/mattermost-plugin-playbooks/server/config"
)
// PlaybookRunHandler is the API handler.
type PlaybookRunHandler struct {
*ErrorHandler
config config.Service
playbookRunService app.PlaybookRunService
playbookService app.PlaybookService
permissions *app.PermissionsService
licenseChecker app.LicenseChecker
pluginAPI *pluginapi.Client
poster bot.Poster
}
// NewPlaybookRunHandler Creates a new Plugin API handler.
func NewPlaybookRunHandler(
router *mux.Router,
playbookRunService app.PlaybookRunService,
playbookService app.PlaybookService,
permissions *app.PermissionsService,
licenseChecker app.LicenseChecker,
api *pluginapi.Client,
poster bot.Poster,
configService config.Service,
) *PlaybookRunHandler {
handler := &PlaybookRunHandler{
ErrorHandler: &ErrorHandler{},
playbookRunService: playbookRunService,
playbookService: playbookService,
pluginAPI: api,
poster: poster,
config: configService,
permissions: permissions,
licenseChecker: licenseChecker,
}
playbookRunsRouter := router.PathPrefix("/runs").Subrouter()
playbookRunsRouter.HandleFunc("", withContext(handler.getPlaybookRuns)).Methods(http.MethodGet)
playbookRunsRouter.HandleFunc("", withContext(handler.createPlaybookRunFromPost)).Methods(http.MethodPost)
playbookRunsRouter.HandleFunc("/dialog", withContext(handler.createPlaybookRunFromDialog)).Methods(http.MethodPost)
playbookRunsRouter.HandleFunc("/add-to-timeline-dialog", withContext(handler.addToTimelineDialog)).Methods(http.MethodPost)
playbookRunsRouter.HandleFunc("/owners", withContext(handler.getOwners)).Methods(http.MethodGet)
playbookRunsRouter.HandleFunc("/channels", withContext(handler.getChannels)).Methods(http.MethodGet)
playbookRunsRouter.HandleFunc("/checklist-autocomplete", withContext(handler.getChecklistAutocomplete)).Methods(http.MethodGet)
playbookRunsRouter.HandleFunc("/checklist-autocomplete-item", withContext(handler.getChecklistAutocompleteItem)).Methods(http.MethodGet)
playbookRunsRouter.HandleFunc("/runs-autocomplete", withContext(handler.getChannelRunsAutocomplete)).Methods(http.MethodGet)
playbookRunRouter := playbookRunsRouter.PathPrefix("/{id:[A-Za-z0-9]+}").Subrouter()
playbookRunRouter.HandleFunc("", withContext(handler.getPlaybookRun)).Methods(http.MethodGet)
playbookRunRouter.HandleFunc("/metadata", withContext(handler.getPlaybookRunMetadata)).Methods(http.MethodGet)
playbookRunRouter.HandleFunc("/status-updates", withContext(handler.getStatusUpdates)).Methods(http.MethodGet)
playbookRunRouter.HandleFunc("/request-update", withContext(handler.requestUpdate)).Methods(http.MethodPost)
playbookRunRouter.HandleFunc("/request-join-channel", withContext(handler.requestJoinChannel)).Methods(http.MethodPost)
playbookRunRouterAuthorized := playbookRunRouter.PathPrefix("").Subrouter()
playbookRunRouterAuthorized.Use(handler.checkEditPermissions)
playbookRunRouterAuthorized.HandleFunc("", withContext(handler.updatePlaybookRun)).Methods(http.MethodPatch)
playbookRunRouterAuthorized.HandleFunc("/owner", withContext(handler.changeOwner)).Methods(http.MethodPost)
playbookRunRouterAuthorized.HandleFunc("/status", withContext(handler.status)).Methods(http.MethodPost)
playbookRunRouterAuthorized.HandleFunc("/finish", withContext(handler.finish)).Methods(http.MethodPut)
playbookRunRouterAuthorized.HandleFunc("/finish-dialog", withContext(handler.finishDialog)).Methods(http.MethodPost)
playbookRunRouterAuthorized.HandleFunc("/update-status-dialog", withContext(handler.updateStatusDialog)).Methods(http.MethodPost)
playbookRunRouterAuthorized.HandleFunc("/reminder/button-update", withContext(handler.reminderButtonUpdate)).Methods(http.MethodPost)
playbookRunRouterAuthorized.HandleFunc("/reminder", withContext(handler.reminderReset)).Methods(http.MethodPost)
playbookRunRouterAuthorized.HandleFunc("/no-retrospective-button", withContext(handler.noRetrospectiveButton)).Methods(http.MethodPost)
playbookRunRouterAuthorized.HandleFunc("/timeline/{eventID:[A-Za-z0-9]+}", withContext(handler.removeTimelineEvent)).Methods(http.MethodDelete)
playbookRunRouterAuthorized.HandleFunc("/restore", withContext(handler.restore)).Methods(http.MethodPut)
playbookRunRouterAuthorized.HandleFunc("/status-update-enabled", withContext(handler.toggleStatusUpdates)).Methods(http.MethodPut)
channelRouter := playbookRunsRouter.PathPrefix("/channel/{channel_id:[A-Za-z0-9]+}").Subrouter()
channelRouter.HandleFunc("", withContext(handler.getPlaybookRunByChannel)).Methods(http.MethodGet)
channelRouter.HandleFunc("/runs", withContext(handler.getPlaybookRunsForChannelByUser)).Methods(http.MethodGet)
checklistsRouter := playbookRunRouterAuthorized.PathPrefix("/checklists").Subrouter()
checklistsRouter.HandleFunc("", withContext(handler.addChecklist)).Methods(http.MethodPost)
checklistsRouter.HandleFunc("/move", withContext(handler.moveChecklist)).Methods(http.MethodPost)
checklistsRouter.HandleFunc("/move-item", withContext(handler.moveChecklistItem)).Methods(http.MethodPost)
checklistRouter := checklistsRouter.PathPrefix("/{checklist:[0-9]+}").Subrouter()
checklistRouter.HandleFunc("", withContext(handler.removeChecklist)).Methods(http.MethodDelete)
checklistRouter.HandleFunc("/add", withContext(handler.addChecklistItem)).Methods(http.MethodPost)
checklistRouter.HandleFunc("/rename", withContext(handler.renameChecklist)).Methods(http.MethodPut)
checklistRouter.HandleFunc("/add-dialog", withContext(handler.addChecklistItemDialog)).Methods(http.MethodPost)
checklistRouter.HandleFunc("/skip", withContext(handler.checklistSkip)).Methods(http.MethodPut)
checklistRouter.HandleFunc("/restore", withContext(handler.checklistRestore)).Methods(http.MethodPut)
checklistRouter.HandleFunc("/duplicate", withContext(handler.duplicateChecklist)).Methods(http.MethodPost)
checklistItem := checklistRouter.PathPrefix("/item/{item:[0-9]+}").Subrouter()
checklistItem.HandleFunc("", withContext(handler.itemDelete)).Methods(http.MethodDelete)
checklistItem.HandleFunc("", withContext(handler.itemEdit)).Methods(http.MethodPut)
checklistItem.HandleFunc("/skip", withContext(handler.itemSkip)).Methods(http.MethodPut)
checklistItem.HandleFunc("/restore", withContext(handler.itemRestore)).Methods(http.MethodPut)
checklistItem.HandleFunc("/state", withContext(handler.itemSetState)).Methods(http.MethodPut)
checklistItem.HandleFunc("/assignee", withContext(handler.itemSetAssignee)).Methods(http.MethodPut)
checklistItem.HandleFunc("/command", withContext(handler.itemSetCommand)).Methods(http.MethodPut)
checklistItem.HandleFunc("/run", withContext(handler.itemRun)).Methods(http.MethodPost)
checklistItem.HandleFunc("/duplicate", withContext(handler.itemDuplicate)).Methods(http.MethodPost)
checklistItem.HandleFunc("/duedate", withContext(handler.itemSetDueDate)).Methods(http.MethodPut)
retrospectiveRouter := playbookRunRouterAuthorized.PathPrefix("/retrospective").Subrouter()
retrospectiveRouter.HandleFunc("", withContext(handler.updateRetrospective)).Methods(http.MethodPost)
retrospectiveRouter.HandleFunc("/publish", withContext(handler.publishRetrospective)).Methods(http.MethodPost)
followersRouter := playbookRunRouter.PathPrefix("/followers").Subrouter()
followersRouter.HandleFunc("", withContext(handler.follow)).Methods(http.MethodPut)
followersRouter.HandleFunc("", withContext(handler.unfollow)).Methods(http.MethodDelete)
followersRouter.HandleFunc("", withContext(handler.getFollowers)).Methods(http.MethodGet)
return handler
}
func (h *PlaybookRunHandler) checkEditPermissions(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
logger := getLogger(r)
vars := mux.Vars(r)
userID := r.Header.Get("Mattermost-User-ID")
playbookRun, err := h.playbookRunService.GetPlaybookRun(vars["id"])
if err != nil {
h.HandleError(w, logger, err)
return
}
if !h.PermissionsCheck(w, logger, h.permissions.RunManageProperties(userID, playbookRun.ID)) {
return
}
next.ServeHTTP(w, r)
})
}
// createPlaybookRunFromPost handles the POST /runs endpoint
func (h *PlaybookRunHandler) createPlaybookRunFromPost(c *Context, w http.ResponseWriter, r *http.Request) {
userID := r.Header.Get("Mattermost-User-ID")
var playbookRunCreateOptions client.PlaybookRunCreateOptions
if err := json.NewDecoder(r.Body).Decode(&playbookRunCreateOptions); err != nil {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "unable to decode playbook run create options", err)
return
}
playbookRun, err := h.createPlaybookRun(
app.PlaybookRun{
OwnerUserID: playbookRunCreateOptions.OwnerUserID,
TeamID: playbookRunCreateOptions.TeamID,
ChannelID: playbookRunCreateOptions.ChannelID,
Name: playbookRunCreateOptions.Name,
Summary: playbookRunCreateOptions.Description,
PostID: playbookRunCreateOptions.PostID,
PlaybookID: playbookRunCreateOptions.PlaybookID,
Type: playbookRunCreateOptions.Type,
},
userID,
playbookRunCreateOptions.CreatePublicRun,
app.RunSourcePost,
)
if errors.Is(err, app.ErrNoPermissions) {
h.HandleErrorWithCode(w, c.logger, http.StatusForbidden, "unable to create playbook run", err)
return
}
if errors.Is(err, app.ErrMalformedPlaybookRun) {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "unable to create playbook run", err)
return
}
if err != nil {
h.HandleError(w, c.logger, errors.Wrapf(err, "unable to create playbook run"))
return
}
h.poster.PublishWebsocketEventToUser(app.PlaybookRunCreatedWSEvent, map[string]interface{}{
"playbook_run": playbookRun,
}, userID)
w.Header().Add("Location", fmt.Sprintf("/api/v0/runs/%s", playbookRun.ID))
ReturnJSON(w, &playbookRun, http.StatusCreated)
}
// Note that this currently does nothing. This is temporary given the removal of stages. Will be used by status.
func (h *PlaybookRunHandler) updatePlaybookRun(c *Context, w http.ResponseWriter, r *http.Request) {
vars := mux.Vars(r)
playbookRunID := vars["id"]
oldPlaybookRun, err := h.playbookRunService.GetPlaybookRun(playbookRunID)
if err != nil {
h.HandleError(w, c.logger, err)
return
}
var updates app.UpdateOptions
if err = json.NewDecoder(r.Body).Decode(&updates); err != nil {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "unable to decode payload", err)
return
}
updatedPlaybookRun := oldPlaybookRun
ReturnJSON(w, updatedPlaybookRun, http.StatusOK)
}
// createPlaybookRunFromDialog handles the interactive dialog submission when a user presses confirm on
// the create playbook run dialog.
func (h *PlaybookRunHandler) createPlaybookRunFromDialog(c *Context, w http.ResponseWriter, r *http.Request) {
userID := r.Header.Get("Mattermost-User-ID")
var request *model.SubmitDialogRequest
err := json.NewDecoder(r.Body).Decode(&request)
if err != nil || request == nil {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "failed to decode SubmitDialogRequest", err)
return
}
if userID != request.UserId {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "interactive dialog's userID must be the same as the requester's userID", nil)
return
}
var state app.DialogState
err = json.Unmarshal([]byte(request.State), &state)
if err != nil {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "failed to unmarshal dialog state", err)
return
}
var playbookID, name string
if rawPlaybookID, ok := request.Submission[app.DialogFieldPlaybookIDKey].(string); ok {
playbookID = rawPlaybookID
}
if rawName, ok := request.Submission[app.DialogFieldNameKey].(string); ok {
name = rawName
}
playbook, err := h.playbookService.Get(playbookID)
if err != nil {
h.HandleErrorWithCode(w, c.logger, http.StatusInternalServerError, "unable to get playbook", err)
return
}
playbookRun, err := h.createPlaybookRun(
app.PlaybookRun{
OwnerUserID: request.UserId,
TeamID: request.TeamId,
ChannelID: playbook.GetRunChannelID(),
Name: name,
PostID: state.PostID,
PlaybookID: playbookID,
Type: app.RunTypePlaybook,
},
request.UserId,
nil,
app.RunSourceDialog,
)
if err != nil {
if errors.Is(err, app.ErrMalformedPlaybookRun) {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "unable to create playbook run", err)
return
}
if errors.Is(err, app.ErrNoPermissions) {
h.HandleErrorWithCode(w, c.logger, http.StatusForbidden, "not authorized to make runs from this playbook", err)
return
}
var msg string
if errors.Is(err, app.ErrChannelDisplayNameInvalid) {
msg = "The name is invalid or too long. Please use a valid name with fewer than 64 characters."
}
if msg != "" {
resp := &model.SubmitDialogResponse{
Errors: map[string]string{
app.DialogFieldNameKey: msg,
},
}
respBytes, _ := json.Marshal(resp)
_, _ = w.Write(respBytes)
return
}
h.HandleError(w, c.logger, err)
return
}
channel, err := h.pluginAPI.Channel.Get(playbookRun.ChannelID)
if err != nil {
h.HandleErrorWithCode(w, c.logger, http.StatusInternalServerError, "unable to get new channel", err)
return
}
// Delay sending the websocket message because the front end may try to change to the newly created
// channel, and the server may respond with a "channel not found" error. This happens in e2e tests,
// and possibly in the wild.
go func() {
time.Sleep(1 * time.Second) // arbitrary 1 second magic number
h.poster.PublishWebsocketEventToUser(app.PlaybookRunCreatedWSEvent, map[string]interface{}{
"client_id": state.ClientID,
"playbook_run": playbookRun,
"channel_name": channel.Name,
}, request.UserId)
}()
if err := h.postPlaybookRunCreatedMessage(playbookRun, request.ChannelId); err != nil {
h.HandleError(w, c.logger, err)
return
}
w.Header().Add("Location", fmt.Sprintf("/api/v0/runs/%s", playbookRun.ID))
w.WriteHeader(http.StatusCreated)
}
// addToTimelineDialog handles the interactive dialog submission when a user clicks the
// corresponding post action.
func (h *PlaybookRunHandler) addToTimelineDialog(c *Context, w http.ResponseWriter, r *http.Request) {
if !h.licenseChecker.TimelineAllowed() {
h.HandleErrorWithCode(w, c.logger, http.StatusForbidden, "timeline feature is not covered by current server license", nil)
return
}
userID := r.Header.Get("Mattermost-User-ID")
var request *model.SubmitDialogRequest
err := json.NewDecoder(r.Body).Decode(&request)
if err != nil || request == nil {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "failed to decode SubmitDialogRequest", err)
return
}
if userID != request.UserId {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "interactive dialog's userID must be the same as the requester's userID", nil)
return
}
var playbookRunID, summary string
if rawPlaybookRunID, ok := request.Submission[app.DialogFieldPlaybookRunKey].(string); ok {
playbookRunID = rawPlaybookRunID
}
if rawSummary, ok := request.Submission[app.DialogFieldSummary].(string); ok {
summary = rawSummary
}
playbookRun, incErr := h.playbookRunService.GetPlaybookRun(playbookRunID)
if incErr != nil {
h.HandleError(w, c.logger, incErr)
return
}
if !h.PermissionsCheck(w, c.logger, h.permissions.RunManageProperties(userID, playbookRun.ID)) {
return
}
var state app.DialogStateAddToTimeline
err = json.Unmarshal([]byte(request.State), &state)
if err != nil {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "failed to unmarshal dialog state", err)
return
}
post, err := h.pluginAPI.Post.GetPost(state.PostID)
if err != nil {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "couldn't get post ID", err)
return
}
if !h.pluginAPI.User.HasPermissionToChannel(userID, post.ChannelId, model.PermissionReadChannel) {
h.HandleErrorWithCode(w, c.logger, http.StatusForbidden, "no permission to post specified", nil)
}
if err = h.playbookRunService.AddPostToTimeline(playbookRunID, userID, post, summary); err != nil {
h.HandleError(w, c.logger, errors.Wrap(err, "failed to add post to timeline"))
return
}
w.WriteHeader(http.StatusOK)
}
func (h *PlaybookRunHandler) createPlaybookRun(playbookRun app.PlaybookRun, userID string, createPublicRun *bool, source string) (*app.PlaybookRun, error) {
// Validate initial data
if playbookRun.ID != "" {
return nil, errors.Wrap(app.ErrMalformedPlaybookRun, "playbook run already has an id")
}
if playbookRun.CreateAt != 0 {
return nil, errors.Wrap(app.ErrMalformedPlaybookRun, "playbook run channel already has created at date")
}
if playbookRun.TeamID == "" && playbookRun.ChannelID == "" {
return nil, errors.Wrap(app.ErrMalformedPlaybookRun, "must provide team or channel to create playbook run")
}
if playbookRun.OwnerUserID == "" {
return nil, errors.Wrap(app.ErrMalformedPlaybookRun, "missing owner user id of playbook run")
}
if strings.TrimSpace(playbookRun.Name) == "" && playbookRun.ChannelID == "" {
return nil, errors.Wrap(app.ErrMalformedPlaybookRun, "missing name of playbook run")
}
// Retrieve channel if needed and validate it
// If a channel is specified, ensure it's from the given team (if one provided), or
// just grab the team for that channel.
var channel *model.Channel
var err error
if playbookRun.ChannelID != "" {
channel, err = h.pluginAPI.Channel.Get(playbookRun.ChannelID)
if err != nil {
return nil, errors.Wrapf(err, "failed to get channel")
}
if playbookRun.TeamID == "" {
playbookRun.TeamID = channel.TeamId
} else if channel.TeamId != playbookRun.TeamID {
return nil, errors.Wrap(app.ErrMalformedPlaybookRun, "channel not in given team")
}
}
// Copy data from playbook if needed
public := true
if createPublicRun != nil {
public = *createPublicRun
}
var playbook *app.Playbook
if playbookRun.PlaybookID != "" {
var pb app.Playbook
pb, err = h.playbookService.Get(playbookRun.PlaybookID)
if err != nil {
return nil, errors.Wrapf(err, "failed to get playbook")
}
playbook = &pb
if playbook.DeleteAt != 0 {
return nil, errors.New("playbook is archived, cannot create a new run using an archived playbook")
}
if err = h.permissions.RunCreate(userID, *playbook); err != nil {
return nil, err
}
if source == "dialog" && playbook.ChannelMode == app.PlaybookRunLinkExistingChannel && playbookRun.ChannelID == "" {
return nil, errors.Wrap(app.ErrMalformedPlaybookRun, "playbook is configured to be linked to existing channel but no channel is configured. Run can not be created from dialog")
}
if createPublicRun == nil {
public = pb.CreatePublicPlaybookRun
}
playbookRun.SetChecklistFromPlaybook(*playbook)
playbookRun.SetConfigurationFromPlaybook(*playbook, source)
}
// Check the permissions on the channel: the user must be able to create it or,
// if one's already provided, they need to be able to manage it.
if channel == nil {
permission := model.PermissionCreatePrivateChannel
permissionMessage := "You are not able to create a private channel"
if public {
permission = model.PermissionCreatePublicChannel
permissionMessage = "You are not able to create a public channel"
}
if !h.pluginAPI.User.HasPermissionToTeam(userID, playbookRun.TeamID, permission) {
return nil, errors.Wrap(app.ErrNoPermissions, permissionMessage)
}
} else {
permission := model.PermissionManagePublicChannelProperties
permissionMessage := "You are not able to manage public channel properties"
if channel.Type == model.ChannelTypePrivate {
permission = model.PermissionManagePrivateChannelProperties
permissionMessage = "You are not able to manage private channel properties"
} else if channel.IsGroupOrDirect() {
permission = model.PermissionReadChannel
permissionMessage = "You do not have access to this channel"
}
if !h.pluginAPI.User.HasPermissionToChannel(userID, channel.Id, permission) {
return nil, errors.Wrap(app.ErrNoPermissions, permissionMessage)
}
}
// Check the permissions on the provided post: the user must have access to the post's channel
if playbookRun.PostID != "" {
var post *model.Post
post, err = h.pluginAPI.Post.GetPost(playbookRun.PostID)
if err != nil {
return nil, errors.Wrapf(err, "failed to get playbook run original post")
}
if !h.pluginAPI.User.HasPermissionToChannel(userID, post.ChannelId, model.PermissionReadChannel) {
return nil, errors.New("user does not have access to the channel containing the playbook run's original post")
}
}
playbookRunReturned, err := h.playbookRunService.CreatePlaybookRun(&playbookRun, playbook, userID, public)
if err != nil {
return nil, err
}
// force database retrieval to ensure all data is processed correctly (i.e participantIds)
return h.playbookRunService.GetPlaybookRun(playbookRunReturned.ID)
}
func (h *PlaybookRunHandler) getRequesterInfo(userID string) (app.RequesterInfo, error) {
return app.GetRequesterInfo(userID, h.pluginAPI)
}
// getPlaybookRuns handles the GET /runs endpoint.
func (h *PlaybookRunHandler) getPlaybookRuns(c *Context, w http.ResponseWriter, r *http.Request) {
userID := r.Header.Get("Mattermost-User-ID")
filterOptions, err := parsePlaybookRunsFilterOptions(r.URL, userID)
if err != nil {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "Bad parameter", err)
return
}
requesterInfo, err := h.getRequesterInfo(userID)
if err != nil {
h.HandleError(w, c.logger, err)
return
}
results, err := h.playbookRunService.GetPlaybookRuns(requesterInfo, *filterOptions)
if err != nil {
h.HandleError(w, c.logger, err)
return
}
ReturnJSON(w, results, http.StatusOK)
}
// getPlaybookRun handles the /runs/{id} endpoint.
func (h *PlaybookRunHandler) getPlaybookRun(c *Context, w http.ResponseWriter, r *http.Request) {
vars := mux.Vars(r)
playbookRunID := vars["id"]
userID := r.Header.Get("Mattermost-User-ID")
if !h.PermissionsCheck(w, c.logger, h.permissions.RunView(userID, playbookRunID)) {
return
}
playbookRunToGet, err := h.playbookRunService.GetPlaybookRun(playbookRunID)
if err != nil {
h.HandleError(w, c.logger, err)
return
}
ReturnJSON(w, playbookRunToGet, http.StatusOK)
}
// getPlaybookRunMetadata handles the /runs/{id}/metadata endpoint.
func (h *PlaybookRunHandler) getPlaybookRunMetadata(c *Context, w http.ResponseWriter, r *http.Request) {
vars := mux.Vars(r)
playbookRunID := vars["id"]
userID := r.Header.Get("Mattermost-User-ID")
if !h.PermissionsCheck(w, c.logger, h.permissions.RunView(userID, playbookRunID)) {
return
}
playbookRunMetadata, err := h.playbookRunService.GetPlaybookRunMetadata(playbookRunID)
if err != nil {
h.HandleError(w, c.logger, err)
return
}
ReturnJSON(w, playbookRunMetadata, http.StatusOK)
}
// getPlaybookRunByChannel handles the /runs/channel/{channel_id} endpoint.
// Notice that it returns both playbook runs as well as channel checklists
func (h *PlaybookRunHandler) getPlaybookRunByChannel(c *Context, w http.ResponseWriter, r *http.Request) {
vars := mux.Vars(r)
channelID := vars["channel_id"]
userID := r.Header.Get("Mattermost-User-ID")
// get playbook runs for the specific channel and user
playbookRunsResult, err := h.playbookRunService.GetPlaybookRuns(
app.RequesterInfo{
UserID: userID,
},
app.PlaybookRunFilterOptions{
ChannelID: channelID,
Page: 0,
PerPage: 2,
},
)
if err != nil {
h.HandleError(w, c.logger, err)
return
}
playbookRuns := playbookRunsResult.Items
if len(playbookRuns) == 0 {
h.HandleErrorWithCode(w, c.logger, http.StatusNotFound, "Not found",
errors.Errorf("playbook run for channel id %s not found", channelID))
return
}
if len(playbookRuns) > 1 {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "multiple runs in the channel", nil)
return
}
playbookRun := playbookRuns[0]
ReturnJSON(w, &playbookRun, http.StatusOK)
}
// getOwners handles the /runs/owners api endpoint.
func (h *PlaybookRunHandler) getOwners(c *Context, w http.ResponseWriter, r *http.Request) {
teamID := r.URL.Query().Get("team_id")
userID := r.Header.Get("Mattermost-User-ID")
options := app.PlaybookRunFilterOptions{
TeamID: teamID,
}
requesterInfo, err := h.getRequesterInfo(userID)
if err != nil {
h.HandleError(w, c.logger, err)
return
}
owners, err := h.playbookRunService.GetOwners(requesterInfo, options)
if err != nil {
h.HandleError(w, c.logger, errors.Wrapf(err, "failed to get owners"))
return
}
if owners == nil {
owners = []app.OwnerInfo{}
}
ReturnJSON(w, owners, http.StatusOK)
}
func (h *PlaybookRunHandler) getChannels(c *Context, w http.ResponseWriter, r *http.Request) {
userID := r.Header.Get("Mattermost-User-ID")
filterOptions, err := parsePlaybookRunsFilterOptions(r.URL, userID)
if err != nil {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "Bad parameter", err)
return
}
requesterInfo, err := h.getRequesterInfo(userID)
if err != nil {
h.HandleError(w, c.logger, err)
return
}
playbookRuns, err := h.playbookRunService.GetPlaybookRuns(requesterInfo, *filterOptions)
if err != nil {
h.HandleError(w, c.logger, errors.Wrapf(err, "failed to get playbookRuns"))
return
}
channelIds := make([]string, 0, len(playbookRuns.Items))
for _, playbookRun := range playbookRuns.Items {
channelIds = append(channelIds, playbookRun.ChannelID)
}
ReturnJSON(w, channelIds, http.StatusOK)
}
// changeOwner handles the /runs/{id}/change-owner api endpoint.
func (h *PlaybookRunHandler) changeOwner(c *Context, w http.ResponseWriter, r *http.Request) {
vars := mux.Vars(r)
userID := r.Header.Get("Mattermost-User-ID")
var params struct {
OwnerID string `json:"owner_id"`
}
if err := json.NewDecoder(r.Body).Decode(¶ms); err != nil {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "could not decode request body", err)
return
}
if err := h.playbookRunService.ChangeOwner(vars["id"], userID, params.OwnerID); err != nil {
h.HandleError(w, c.logger, err)
return
}
ReturnJSON(w, map[string]interface{}{}, http.StatusOK)
}
// updateStatusD handles the POST /runs/{id}/status endpoint, user has edit permissions
func (h *PlaybookRunHandler) status(c *Context, w http.ResponseWriter, r *http.Request) {
playbookRunID := mux.Vars(r)["id"]
userID := r.Header.Get("Mattermost-User-ID")
var options app.StatusUpdateOptions
if err := json.NewDecoder(r.Body).Decode(&options); err != nil {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "unable to decode body into StatusUpdateOptions", err)
return
}
if publicMsg, internalErr := h.updateStatus(playbookRunID, userID, options); internalErr != nil {
if errors.Is(internalErr, app.ErrNoPermissions) {
h.HandleErrorWithCode(w, c.logger, http.StatusForbidden, publicMsg, internalErr)
} else {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, publicMsg, internalErr)
}
return
}
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte(`{"status":"OK"}`))
}
// updateStatus returns a publicMessage and an internal error
func (h *PlaybookRunHandler) updateStatus(playbookRunID, userID string, options app.StatusUpdateOptions) (string, error) {
// user must be a participant to be able to post an update
if err := h.permissions.RunManageProperties(userID, playbookRunID); err != nil {
return "Not authorized", err
}
options.Message = strings.TrimSpace(options.Message)
if options.Message == "" {
return "message must not be empty", errors.New("message field empty")
}
if options.Reminder <= 0 && !options.FinishRun {
return "the reminder must be set and not 0", errors.New("reminder was 0")
}
if options.Reminder < 0 || options.FinishRun {
options.Reminder = 0
}
options.Reminder = options.Reminder * time.Second
if err := h.playbookRunService.UpdateStatus(playbookRunID, userID, options); err != nil {
return "An internal error has occurred. Check app server logs for details.", err
}
if options.FinishRun {
if err := h.playbookRunService.FinishPlaybookRun(playbookRunID, userID); err != nil {
return "An internal error has occurred. Check app server logs for details.", err
}
}
return "", nil
}
// updateStatusD handles the POST /runs/{id}/finish endpoint, user has edit permissions
func (h *PlaybookRunHandler) finish(c *Context, w http.ResponseWriter, r *http.Request) {
playbookRunID := mux.Vars(r)["id"]
userID := r.Header.Get("Mattermost-User-ID")
if err := h.playbookRunService.FinishPlaybookRun(playbookRunID, userID); err != nil {
h.HandleError(w, c.logger, err)
return
}
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte(`{"status":"OK"}`))
}
// getStatusUpdates handles the GET /runs/{id}/status endpoint
//
// Our goal is to deliver status updates to any user (when playbook is public) or
// any playbook member (when playbook is private). To do that we need to bypass the
// permissions system and avoid checking channel membership.
//
// This approach will be deprecated as a step towards channel-playbook decoupling.
func (h *PlaybookRunHandler) getStatusUpdates(c *Context, w http.ResponseWriter, r *http.Request) {
playbookRunID := mux.Vars(r)["id"]
userID := r.Header.Get("Mattermost-User-ID")
if !h.PermissionsCheck(w, c.logger, h.permissions.RunView(userID, playbookRunID)) {
h.HandleErrorWithCode(w, c.logger, http.StatusForbidden, "not authorized to get status updates", nil)
return
}
playbookRun, err := h.playbookRunService.GetPlaybookRun(playbookRunID)
if err != nil {
h.HandleError(w, c.logger, err)
return
}
posts := make([]*app.StatusPostComplete, 0)
for _, p := range playbookRun.StatusPosts {
post, err := h.pluginAPI.Post.GetPost(p.ID)
if err != nil {
c.logger.WithError(err).WithField("post_id", p.ID).Error("statusUpdates: can not retrieve post")
continue
}
// Given the fact that we are bypassing some permissions,
// an additional check is added to limit the risk
if post.Type == "custom_run_update" {
posts = append(posts, app.NewStatusPostComplete(post))
}
}
// sort by creation date, so that the first element is the newest post
sort.Slice(posts, func(i, j int) bool {
return posts[i].CreateAt > posts[j].CreateAt
})
ReturnJSON(w, posts, http.StatusOK)
}
// restore "un-finishes" a playbook run
func (h *PlaybookRunHandler) restore(c *Context, w http.ResponseWriter, r *http.Request) {
playbookRunID := mux.Vars(r)["id"]
userID := r.Header.Get("Mattermost-User-ID")
if err := h.playbookRunService.RestorePlaybookRun(playbookRunID, userID); err != nil {
h.HandleError(w, c.logger, err)
return
}
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte(`{"status":"OK"}`))
}
// requestUpdate posts a status update request message in the run's channel
func (h *PlaybookRunHandler) requestUpdate(c *Context, w http.ResponseWriter, r *http.Request) {
playbookRunID := mux.Vars(r)["id"]
userID := r.Header.Get("Mattermost-User-ID")
if !h.PermissionsCheck(w, c.logger, h.permissions.RunView(userID, playbookRunID)) {
h.HandleErrorWithCode(w, c.logger, http.StatusForbidden, "not authorized to post update request", nil)
return
}
if err := h.playbookRunService.RequestUpdate(playbookRunID, userID); err != nil {
h.HandleError(w, c.logger, err)
return
}
}
// requestJoinChannel posts a channel-join request message in the run's channel
func (h *PlaybookRunHandler) requestJoinChannel(c *Context, w http.ResponseWriter, r *http.Request) {
playbookRunID := mux.Vars(r)["id"]
userID := r.Header.Get("Mattermost-User-ID")
// user must be a participant to be able to request to join the channel
if !h.PermissionsCheck(w, c.logger, h.permissions.RunManageProperties(userID, playbookRunID)) {
h.HandleErrorWithCode(w, c.logger, http.StatusForbidden, "not authorized to request join channel", nil)
return
}
if err := h.playbookRunService.RequestJoinChannel(playbookRunID, userID); err != nil {
h.HandleError(w, c.logger, err)
return
}
}
// updateStatusDialog handles the POST /runs/{id}/finish-dialog endpoint, called when a
// user submits the Finish Run dialog.
func (h *PlaybookRunHandler) finishDialog(c *Context, w http.ResponseWriter, r *http.Request) {
playbookRunID := mux.Vars(r)["id"]
userID := r.Header.Get("Mattermost-User-ID")
playbookRun, incErr := h.playbookRunService.GetPlaybookRun(playbookRunID)
if incErr != nil {
h.HandleError(w, c.logger, incErr)
return
}
if !h.PermissionsCheck(w, c.logger, h.permissions.RunManageProperties(userID, playbookRun.ID)) {
return
}
if err := h.playbookRunService.FinishPlaybookRun(playbookRunID, userID); err != nil {
h.HandleError(w, c.logger, err)
return
}
}
func (h *PlaybookRunHandler) toggleStatusUpdates(c *Context, w http.ResponseWriter, r *http.Request) {
playbookRunID := mux.Vars(r)["id"]
userID := r.Header.Get("Mattermost-User-ID")
var payload struct {
StatusEnabled bool `json:"status_enabled"`
}
if err := json.NewDecoder(r.Body).Decode(&payload); err != nil {
h.HandleError(w, c.logger, err)
return
}
if err := h.playbookRunService.ToggleStatusUpdates(playbookRunID, userID, payload.StatusEnabled); err != nil {
h.HandleError(w, c.logger, err)
return
}
ReturnJSON(w, map[string]interface{}{"success": true}, http.StatusOK)
}
// updateStatusDialog handles the POST /runs/{id}/update-status-dialog endpoint, called when a
// user submits the Update Status dialog.
func (h *PlaybookRunHandler) updateStatusDialog(c *Context, w http.ResponseWriter, r *http.Request) {
playbookRunID := mux.Vars(r)["id"]
userID := r.Header.Get("Mattermost-User-ID")
var request *model.SubmitDialogRequest
err := json.NewDecoder(r.Body).Decode(&request)
if err != nil || request == nil {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "failed to decode SubmitDialogRequest", err)
return
}
var options app.StatusUpdateOptions
if message, ok := request.Submission[app.DialogFieldMessageKey]; ok {
messageStr, valid := message.(string)
if !valid {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "message must be a string", nil)
return
}
options.Message = messageStr
}
if reminderI, ok := request.Submission[app.DialogFieldReminderInSecondsKey]; ok {
reminderStr, valid := reminderI.(string)
if !valid {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "reminder must be a string", nil)
return
}
var reminder int
reminder, err = strconv.Atoi(reminderStr)
if err != nil {
h.HandleError(w, c.logger, err)
return
}
options.Reminder = time.Duration(reminder)
}
if finishB, ok := request.Submission[app.DialogFieldFinishRun]; ok {
var finish bool
if finish, ok = finishB.(bool); ok {
options.FinishRun = finish
}
}
if publicMsg, internalErr := h.updateStatus(playbookRunID, userID, options); internalErr != nil {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, publicMsg, internalErr)
return
}
w.WriteHeader(http.StatusOK)
}
// reminderButtonUpdate handles the POST /runs/{id}/reminder/button-update endpoint, called when a
// user clicks on the reminder interactive button
func (h *PlaybookRunHandler) reminderButtonUpdate(c *Context, w http.ResponseWriter, r *http.Request) {
playbookRunID := mux.Vars(r)["id"]
var requestData *model.PostActionIntegrationRequest
err := json.NewDecoder(r.Body).Decode(&requestData)
if err != nil || requestData == nil {
h.HandleErrorWithCode(w, c.logger, http.StatusBadRequest, "missing request data", nil)
return
}
if !h.PermissionsCheck(w, c.logger, h.permissions.RunManageProperties(requestData.UserId, playbookRunID)) {
return
}
if err = h.playbookRunService.OpenUpdateStatusDialog(playbookRunID, requestData.UserId, requestData.TriggerId); err != nil {
h.HandleError(w, c.logger, errors.New("reminderButtonUpdate failed to open update status dialog"))
return
}
ReturnJSON(w, nil, http.StatusOK)
}
// reminderReset handles the POST /runs/{id}/reminder endpoint, called when a
// user clicks on the reminder custom_update_status time selector
func (h *PlaybookRunHandler) reminderReset(c *Context, w http.ResponseWriter, r *http.Request) {
playbookRunID := mux.Vars(r)["id"]