Add status change confirmation

server/api/api.go

@@ -31,4 +31,5 @@ func Init(h *httputils.Handler, env mscalendar.Env, notificationProcessor mscale
 	postActionRouter.HandleFunc(config.PathDecline, api.postActionDecline).Methods("POST")
 	postActionRouter.HandleFunc(config.PathTentative, api.postActionTentative).Methods("POST")
 	postActionRouter.HandleFunc(config.PathRespond, api.postActionRespond).Methods("POST")
+	postActionRouter.HandleFunc(config.PathConfirmStatusChange, api.postActionConfirmStatusChange).Methods("POST")
 }

server/api/post_action.go

@@ -4,6 +4,7 @@
 package api
 
 import (
+	"fmt"
 	"net/http"
 
 	"github.com/mattermost/mattermost-server/v5/model"
@@ -81,3 +82,49 @@ func (api *api) postActionRespond(w http.ResponseWriter, req *http.Request) {
 		return
 	}
 }
+
+func (api *api) postActionConfirmStatusChange(w http.ResponseWriter, req *http.Request) {
+	mattermostUserID := req.Header.Get("Mattermost-User-ID")
+	if mattermostUserID == "" {
+		http.Error(w, "Not authorized", http.StatusUnauthorized)
+		return
+	}
+
+	response := model.PostActionIntegrationResponse{}
+	post := &model.Post{}
+
+	request := model.PostActionIntegrationRequestFromJson(req.Body)
+	if request == nil {
+		http.Error(w, "invalid request", http.StatusBadRequest)
+		return
+	}
+
+	value, ok := request.Context["value"].(bool)
+	if !ok {
+		http.Error(w, `No recognizable value for property "value"`, http.StatusBadRequest)
+		return
+	}
+
+	returnText := "The status has not been changed."
+	if value {
+		changeTo, ok := request.Context["change_to"]
+		if !ok {
+			http.Error(w, "No state to change", http.StatusBadRequest)
+			return
+		}
+		stringChangeTo := changeTo.(string)
+		api.PluginAPI.UpdateMattermostUserStatus(mattermostUserID, stringChangeTo)
+		returnText = fmt.Sprintf("The status has been changed to %s.", stringChangeTo)
+	}
+
+	sa := &model.SlackAttachment{
+		Title: "Status Change",
+		Text:  returnText,
+	}
+
+	model.ParseSlackAttachment(post, []*model.SlackAttachment{sa})
+
+	response.Update = post
+	w.Header().Set("Content-Type", "application/json")
+	w.Write(response.ToJson())
+}

server/config/const.go

@@ -12,16 +12,17 @@ const (
 	Repository      = "mattermost-plugin-mscalendar"
 	CommandTrigger  = "mscalendar"
 
-	PathOAuth2       = "/oauth2"
-	PathComplete     = "/complete"
-	PathAPI          = "/api/v1"
-	PathPostAction   = "/action"
-	PathRespond      = "/respond"
-	PathAccept       = "/accept"
-	PathDecline      = "/decline"
-	PathTentative    = "/tentative"
-	PathNotification = "/notification/v1"
-	PathEvent        = "/event"
+	PathOAuth2              = "/oauth2"
+	PathComplete            = "/complete"
+	PathAPI                 = "/api/v1"
+	PathPostAction          = "/action"
+	PathRespond             = "/respond"
+	PathAccept              = "/accept"
+	PathDecline             = "/decline"
+	PathTentative           = "/tentative"
+	PathConfirmStatusChange = "/confirm"
+	PathNotification        = "/notification/v1"
+	PathEvent               = "/event"
 
 	FullPathEventNotification = PathNotification + PathEvent
 	FullPathOAuth2Redirect    = PathOAuth2 + PathComplete

server/mscalendar/availability.go

@@ -7,6 +7,8 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/mattermost/mattermost-plugin-mscalendar/server/config"
+	"github.com/mattermost/mattermost-plugin-mscalendar/server/mscalendar/views"
 	"github.com/mattermost/mattermost-plugin-mscalendar/server/remote"
 	"github.com/mattermost/mattermost-plugin-mscalendar/server/store"
 	"github.com/mattermost/mattermost-plugin-mscalendar/server/utils"
@@ -115,7 +117,7 @@ func (m *mscalendar) setUserStatuses(filteredUsers store.UserIndex, schedules []
 			continue
 		}
 
-		res = m.setStatusFromAvailability(mattermostUserID, status, s.AvailabilityView)
+		res = m.setStatusFromAvailability(mattermostUserID, status, s)
 	}
 	if res != "" {
 		return res, nil
@@ -136,31 +138,58 @@ func (m *mscalendar) GetAvailabilities(remoteUserID string, scheduleIDs []string
 	return client.GetSchedule(remoteUserID, scheduleIDs, start, end, availabilityTimeWindowSize)
 }
 
-func (m *mscalendar) setStatusFromAvailability(mattermostUserID, currentStatus string, av remote.AvailabilityView) string {
-	currentAvailability := av[0]
+func (m *mscalendar) setStatusFromAvailability(mattermostUserID, currentStatus string, s *remote.ScheduleInformation) string {
+	currentAvailability := s.AvailabilityView[0]
+	u := NewUser(mattermostUserID)
+
+	if !m.ShouldChangeStatus(u) {
+		return "Status not changed by user configuration."
+	}
+
+	if !m.HasAvailabilityChanged(u, currentAvailability) {
+		ok, newEventTime := m.HasNewEventStarted(u, s)
+		if !ok {
+			return "Status not changed because there is no update since last status change."
+		}
+		u.LastStatusUpdateEventTime = *newEventTime
+	}
+
+	u.LastStatusUpdateAvailability = currentAvailability
+	m.Store.StoreUser(u.User)
+
+	url := fmt.Sprintf("%s%s%s", m.Config.PluginURLPath, config.PathPostAction, config.PathConfirmStatusChange)
 
 	switch currentAvailability {
 	case remote.AvailabilityViewFree:
 		if currentStatus == "dnd" {
+			if m.ShouldNotifyStatusChange(u) {
+				m.Poster.DMWithAttachments(mattermostUserID, views.RenderStatusChangeNotificationView(s.ScheduleItems, "Online", url))
+				return fmt.Sprintf("User asked for status change from %s to online", currentStatus)
+			}
 			m.PluginAPI.UpdateMattermostUserStatus(mattermostUserID, "online")
 			return fmt.Sprintf("User is free. Setting user from %s to online.", currentStatus)
-		} else {
-			return fmt.Sprintf("User is free, and is already set to %s.", currentStatus)
 		}
+		return fmt.Sprintf("User is free, and is already set to %s.", currentStatus)
 	case remote.AvailabilityViewTentative, remote.AvailabilityViewBusy:
 		if currentStatus != "dnd" {
+			if m.ShouldNotifyStatusChange(u) {
+				m.Poster.DMWithAttachments(mattermostUserID, views.RenderStatusChangeNotificationView(s.ScheduleItems, "Do Not Disturb", url))
+				return fmt.Sprintf("User asked for status change from %s to dnd.", currentStatus)
+			}
 			m.PluginAPI.UpdateMattermostUserStatus(mattermostUserID, "dnd")
 			return fmt.Sprintf("User is busy. Setting user from %s to dnd.", currentStatus)
-		} else {
-			return fmt.Sprintf("User is busy, and is already set to %s.", currentStatus)
 		}
+		return fmt.Sprintf("User is busy, and is already set to %s.", currentStatus)
 	case remote.AvailabilityViewOutOfOffice:
 		if currentStatus != "offline" {
+			if m.ShouldNotifyStatusChange(u) {
+				m.Poster.DMWithAttachments(mattermostUserID, views.RenderStatusChangeNotificationView(s.ScheduleItems, "Offline", url))
+				return fmt.Sprintf("User asked for status change fom %s to offline", currentStatus)
+			}
 			m.PluginAPI.UpdateMattermostUserStatus(mattermostUserID, "offline")
 			return fmt.Sprintf("User is out of office. Setting user from %s to offline", currentStatus)
-		} else {
-			return fmt.Sprintf("User is out of office, and is already set to %s.", currentStatus)
 		}
+		return fmt.Sprintf("User is out of office, and is already set to %s.", currentStatus)
 	case remote.AvailabilityViewWorkingElsewhere:
 		return fmt.Sprintf("User is working elsewhere. Pending implementation.")
 	}

server/mscalendar/availability_test.go

@@ -108,6 +108,15 @@ func TestSyncStatusAll(t *testing.T) {
 					Mail: "bot_email@example.com",
 				},
 			}, nil).Times(1)
+			s.EXPECT().LoadUser("user_mm_id").Return(&store.User{
+				MattermostUserID: "user_mm_id",
+				OAuth2Token:      token,
+				Remote: &remote.User{
+					ID:   "user_remote_id",
+					Mail: "user_email@example.com",
+				},
+			}, nil).Times(1)
+			s.EXPECT().StoreUser(gomock.Any()).Return(nil).Times(1)
 
 			mockPluginAPI.EXPECT().GetMattermostUser("bot_mm_id").Return(&model.User{}, nil).Times(1)
 
@@ -122,7 +131,7 @@ func TestSyncStatusAll(t *testing.T) {
 			if tc.newStatus == "" {
 				mockPluginAPI.EXPECT().UpdateMattermostUserStatus("user_mm_id", gomock.Any()).Times(0)
 			} else {
-				mockPluginAPI.EXPECT().UpdateMattermostUserStatus("user_mm_id", tc.newStatus).Times(1)
+				poster.EXPECT().DMWithAttachments("user_mm_id", gomock.Any()).Return(nil)
 			}
 
 			mscalendar := New(env, "")

server/mscalendar/user.go

@@ -111,6 +111,41 @@ func (user *User) Markdown() string {
 	}
 }
 
+func (m *mscalendar) ShouldNotifyStatusChange(u *User) bool {
+	err := m.ExpandRemoteUser(u)
+	if err != nil {
+		return false
+	}
+	// TODO: finish when related PRs are merged
+	return true
+}
+
+func (m *mscalendar) ShouldChangeStatus(u *User) bool {
+	err := m.ExpandRemoteUser(u)
+	if err != nil {
+		return false
+	}
+	// TODO: finish when related PRs are merged
+	return true
+}
+
+func (m *mscalendar) HasAvailabilityChanged(u *User, currentAvailability byte) bool {
+	err := m.ExpandRemoteUser(u)
+	if err != nil {
+		return false
+	}
+	return u.LastStatusUpdateAvailability != currentAvailability
+}
+
+func (m *mscalendar) HasNewEventStarted(u *User, schedule *remote.ScheduleInformation) (bool, *remote.DateTime) {
+	for _, e := range schedule.ScheduleItems {
+		if e.Start.Time().After(u.LastStatusUpdateEventTime.Time()) {
+			return true, &e.Start
+		}
+	}
+	return false, nil
+}
+
 func (m *mscalendar) DisconnectUser(mattermostUserID string) error {
 	err := m.Filter(
 		withClient,

server/mscalendar/views/status_change_notification.go

@@ -0,0 +1,63 @@
+package views
+
+import (
+	"fmt"
+	"time"
+
+	"github.com/mattermost/mattermost-plugin-mscalendar/server/remote"
+	"github.com/mattermost/mattermost-server/v5/model"
+)
+
+func RenderStatusChangeNotificationView(events []*remote.ScheduleItem, status, url string) *model.SlackAttachment {
+	for _, e := range events {
+		if e.Start.Time().After(time.Now()) {
+			return statusChangeAttachments(e, status, url)
+		}
+	}
+	return statusChangeAttachments(nil, status, url)
+}
+
+func renderScheduleItem(si *remote.ScheduleItem, status string) string {
+	if si == nil {
+		return fmt.Sprintf("You have no upcoming events.\n Shall I change your status to %s?", status)
+	}
+
+	resp := fmt.Sprintf("Your event with subject `%s` will start soon.", si.Subject)
+	if si.Subject == "" {
+		resp = "An event with no subject will start soon."
+	}
+
+	resp += "\nShall I change your status to %s?"
+	return resp
+}
+
+func statusChangeAttachments(event *remote.ScheduleItem, status, url string) *model.SlackAttachment {
+	actionYes := &model.PostAction{
+		Name: "Yes",
+		Integration: &model.PostActionIntegration{
+			URL: url,
+			Context: map[string]interface{}{
+				"value":     true,
+				"change_to": status,
+			},
+		},
+	}
+
+	actionNo := &model.PostAction{
+		Name: "No",
+		Integration: &model.PostActionIntegration{
+			URL: url,
+			Context: map[string]interface{}{
+				"value": false,
+			},
+		},
+	}
+
+	sa := &model.SlackAttachment{
+		Title:   "Status change",
+		Text:    renderScheduleItem(event, status),
+		Actions: []*model.PostAction{actionYes, actionNo},
+	}
+
+	return sa
+}

server/remote/schedule.go

@@ -11,6 +11,15 @@ const (
 	AvailabilityViewWorkingElsewhere = '4'
 )
 
+const (
+	ScheduleStatusFree             = "free"
+	ScheduleStatusTentative        = "tentative"
+	ScheduleStatusBusy             = "busy"
+	ScheduleStatusOof              = "oof"
+	ScheduleStatusWorkingElsewhere = "workingElsewhere"
+	ScheduleStatusUnknown          = "unknown"
+)
+
 type ScheduleInformationError struct {
 	Message      string `json:"message"`
 	ResponseCode string `json:"responseCode"`
@@ -29,7 +38,16 @@ type ScheduleInformation struct {
 
 	Error *ScheduleInformationError `json:"error"`
 
-	// ScheduleItems []interface{} `json:"scheduleItems,omitempty"`
+	ScheduleItems []*ScheduleItem `json:"scheduleItems,omitempty"`
 	// WorkingHours interface{} `json:"workingHours,omitempty"`
 	// Error *FreeBusyError `json:"error,omitempty"`
 }
+
+type ScheduleItem struct {
+	IsPrivate bool
+	Status    string
+	Subject   string
+	Location  string
+	Start     DateTime
+	End       DateTime
+}

server/store/user_store.go

@@ -28,11 +28,13 @@ type UserShort struct {
 }
 
 type User struct {
-	PluginVersion    string
-	Remote           *remote.User
-	MattermostUserID string
-	OAuth2Token      *oauth2.Token
-	Settings         Settings `json:"mattermostSettings,omitempty"`
+	PluginVersion                string
+	Remote                       *remote.User
+	MattermostUserID             string
+	OAuth2Token                  *oauth2.Token
+	Settings                     Settings `json:"mattermostSettings,omitempty"`
+	LastStatusUpdateAvailability byte
+	LastStatusUpdateEventTime    remote.DateTime
 }
 
 type Settings struct {