[MM-228] Add feature to update custom status and status of the user during meeting

build/custom.mk

@@ -21,7 +21,7 @@ GO_BUILD_FLAGS = -ldflags '$(LDFLAGS)'
 mock:
 ifneq ($(HAS_SERVER),)
 	go install github.com/golang/mock/[email protected]
-	mockgen -destination calendar/jobs/mock_cluster/mock_cluster.go github.com/mattermost/mattermost-plugin-api/cluster JobPluginAPI
+	mockgen -destination calendar/jobs/mock_cluster/mock_cluster.go github.com/mattermost/mattermost/server/public/pluginapi/cluster JobPluginAPI
 	mockgen -destination calendar/engine/mock_engine/mock_engine.go $(REPOSITORY_URL)/calendar/engine Engine
 	mockgen -destination calendar/engine/mock_welcomer/mock_welcomer.go -package mock_welcomer $(REPOSITORY_URL)/calendar/engine Welcomer
 	mockgen -destination calendar/engine/mock_plugin_api/mock_plugin_api.go -package mock_plugin_api $(REPOSITORY_URL)/calendar/engine PluginAPI

calendar/engine/availability.go

@@ -5,6 +5,7 @@ package engine
 
 import (
 	"fmt"
+	"sort"
 	"time"
 
 	"github.com/mattermost/mattermost/server/public/model"
@@ -109,7 +110,7 @@ func (m *mscalendar) retrieveUsersToSync(userIndex store.UserIndex, syncJobSumma
 		}
 
 		// If user does not have the proper features enabled, just go to the next one
-		if !(user.Settings.UpdateStatus || user.Settings.ReceiveReminders) {
+		if !(user.Settings.UpdateStatusFromOptions != NotSetStatusOption || user.Settings.ReceiveReminders || user.Settings.SetCustomStatus) {
 			continue
 		}
 
@@ -230,7 +231,7 @@ func (m *mscalendar) setUserStatuses(users []*store.User, calendarViews []*remot
 	numberOfLogs, numberOfUserStatusChange, numberOfUserErrorInStatusChange := 0, 0, 0
 	toUpdate := []*store.User{}
 	for _, u := range users {
-		if u.Settings.UpdateStatus {
+		if u.Settings.UpdateStatusFromOptions != NotSetStatusOption || u.Settings.SetCustomStatus {
 			toUpdate = append(toUpdate, u)
 		}
 	}
@@ -279,37 +280,124 @@ func (m *mscalendar) setUserStatuses(users []*store.User, calendarViews []*remot
 		}
 
 		var err error
-		res, isStatusChanged, err = m.setStatusFromCalendarView(user, status, view)
-		if err != nil {
-			if numberOfLogs < logTruncateLimit {
-				m.Logger.Warnf("Error setting user %s status. err=%v", user.MattermostUserID, err)
-			} else if numberOfLogs == logTruncateLimit {
-				m.Logger.Warnf(logTruncateMsg)
+		if user.Settings.UpdateStatusFromOptions != NotSetStatusOption {
+			res, isStatusChanged, err = m.setStatusFromCalendarView(user, status, view)
+			if err != nil {
+				if numberOfLogs < logTruncateLimit {
+					m.Logger.Warnf("Error setting user %s status. err=%v", user.MattermostUserID, err)
+				} else if numberOfLogs == logTruncateLimit {
+					m.Logger.Warnf(logTruncateMsg)
+				}
+				numberOfLogs++
+				numberOfUserErrorInStatusChange++
+			}
+			if isStatusChanged {
+				numberOfUserStatusChange++
 			}
-			numberOfLogs++
-			numberOfUserErrorInStatusChange++
 		}
-		if isStatusChanged {
-			numberOfUserStatusChange++
+
+		if user.Settings.SetCustomStatus {
+			res, isStatusChanged, err = m.setCustomStatusFromCalendarView(user, view)
+			if err != nil {
+				if numberOfLogs < logTruncateLimit {
+					m.Logger.Warnf("Error setting user %s status. err=%v", user.MattermostUserID, err)
+				} else if numberOfLogs == logTruncateLimit {
+					m.Logger.Warnf(logTruncateMsg)
+				}
+				numberOfLogs++
+				numberOfUserErrorInStatusChange++
+			}
+
+			// Increment count only when we have not updated the status of the user from the options to have status change count per user.
+			if isStatusChanged && user.Settings.UpdateStatusFromOptions == NotSetStatusOption {
+				numberOfUserStatusChange++
+			}
 		}
 	}
+
 	if res != "" {
 		return res, numberOfUserStatusChange, numberOfUserErrorInStatusChange, nil
 	}
 
 	return utils.JSONBlock(calendarViews), numberOfUserStatusChange, numberOfUserErrorInStatusChange, nil
 }
 
+func (m *mscalendar) setCustomStatusFromCalendarView(user *store.User, res *remote.ViewCalendarResponse) (string, bool, error) {
+	isStatusChanged := false
+	if !user.Settings.SetCustomStatus {
+		return "User doesn't want to set custom status", isStatusChanged, nil
+	}
+
+	events := filterBusyEvents(res.Events)
+	if len(events) == 0 {
+		if user.IsCustomStatusSet {
+			if err := m.PluginAPI.RemoveMattermostUserCustomStatus(user.MattermostUserID); err != nil {
+				m.Logger.Warnf("Error removing user %s custom status. err=%v", user.MattermostUserID, err)
+			}
+
+			if err := m.Store.StoreUserCustomStatusUpdates(user.MattermostUserID, false); err != nil {
+				return "", isStatusChanged, err
+			}
+		}
+
+		return "No event present to set custom status", isStatusChanged, nil
+	}
+
+	if checkOverlappingEvents(events) {
+		return "Overlapping events, not setting a custom status", isStatusChanged, nil
+	}
+
+	// Not setting custom status for events without attendees since those are unlikely to be meetings.
+	if len(events[0].Attendees) < 1 {
+		return "No attendee present, not setting custom status", isStatusChanged, nil
+	}
+
+	currentUser, err := m.PluginAPI.GetMattermostUser(user.MattermostUserID)
+	if err != nil {
+		return "", isStatusChanged, err
+	}
+
+	currentCustomStatus := currentUser.GetCustomStatus()
+	if currentCustomStatus != nil && !user.IsCustomStatusSet {
+		return "User already have a custom status set, ignoring custom status change", isStatusChanged, nil
+	}
+
+	if appErr := m.PluginAPI.UpdateMattermostUserCustomStatus(user.MattermostUserID, &model.CustomStatus{
+		Emoji:     "calendar",
+		Text:      "In a meeting",
+		ExpiresAt: events[0].End.Time(),
+		Duration:  "date_and_time",
+	}); appErr != nil {
+		return "", isStatusChanged, appErr
+	}
+
+	isStatusChanged = true
+	if err := m.Store.StoreUserCustomStatusUpdates(user.MattermostUserID, true); err != nil {
+		return "", isStatusChanged, err
+	}
+
+	return "", isStatusChanged, nil
+}
+
 func (m *mscalendar) setStatusFromCalendarView(user *store.User, status *model.Status, res *remote.ViewCalendarResponse) (string, bool, error) {
 	isStatusChanged := false
 	currentStatus := status.Status
+	if user.Settings.UpdateStatusFromOptions == "" {
+		return "No value set from options to update status", isStatusChanged, nil
+	}
+
 	if currentStatus == model.StatusOffline && !user.Settings.GetConfirmation {
 		return "User offline and does not want status change confirmations. No status change", isStatusChanged, nil
 	}
 
 	events := filterBusyEvents(res.Events)
+
+	sort.Slice(events, func(i, j int) bool {
+		return events[i].Start.Time().UnixMicro() < events[j].Start.Time().UnixMicro()
+	})
+
 	busyStatus := model.StatusDnd
-	if user.Settings.ReceiveNotificationsDuringMeeting {
+	if user.Settings.UpdateStatusFromOptions == AwayStatusOption {
 		busyStatus = model.StatusAway
 	}
 
@@ -338,6 +426,15 @@ func (m *mscalendar) setStatusFromCalendarView(user *store.User, status *model.S
 		return message, isStatusChanged, nil
 	}
 
+	if checkOverlappingEvents(events) {
+		return "Overlapping events, not updating status", isStatusChanged, nil
+	}
+
+	// Not setting custom status for events without attendees since those are unlikely to be meetings.
+	if len(events[0].Attendees) < 1 {
+		return "No attendee present, not updating status", isStatusChanged, nil
+	}
+
 	remoteHashes := []string{}
 	for _, e := range events {
 		if e.IsCancelled {
@@ -424,7 +521,7 @@ func (m *mscalendar) setStatusOrAskUser(user *store.User, currentStatus *model.S
 
 	if !isFree {
 		toSet = model.StatusDnd
-		if user.Settings.ReceiveNotificationsDuringMeeting {
+		if user.Settings.UpdateStatusFromOptions == AwayStatusOption {
 			toSet = model.StatusAway
 		}
 		if !user.Settings.GetConfirmation {
@@ -566,9 +663,24 @@ func (m *mscalendar) notifyUpcomingEvents(mattermostUserID string, events []*rem
 func filterBusyEvents(events []*remote.Event) []*remote.Event {
 	result := []*remote.Event{}
 	for _, e := range events {
-		if e.ShowAs == "busy" {
+		if e.ShowAs == "busy" && !e.IsCancelled {
 			result = append(result, e)
 		}
 	}
 	return result
 }
+
+// Function to check for overlapping events.
+func checkOverlappingEvents(events []*remote.Event) bool {
+	if len(events) <= 1 {
+		return false
+	}
+
+	for i := 1; i < len(events); i++ {
+		if events[i-1].End.Time().UnixMicro() > events[i].Start.Time().UnixMicro() {
+			return true
+		}
+	}
+
+	return false
+}