4 "github.com/google/go-cmp/cmp"
7 "maunium.net/go/mautrix"
8 "maunium.net/go/mautrix/event"
9 "maunium.net/go/mautrix/id"
17 activeTime = 5 * time.Minute
18 // 15 minutes idling = PL 1.
19 minPowerScore = 15 * 60 * idleScore
21 // 1 year fulltime active dev = PL 10.
22 maxPowerScore = 3600 * (365*24*idleScore + 8*261*(activeScore-idleScore))
24 // Do not touch users outside this range.
27 // Expire power level if no event for 1 month. Level comes back on next event, including join.
28 powerExpireTime = time.Hour * 24 * 30
29 // Maximum count of ACL entries. Should avoid hitting the 64k limit.
30 maxPowerLevelEntries = 2048
33 func logPowerLevelBounds() {
34 for i := minPowerLevel; i <= maxPowerLevel; i++ {
35 score := minPowerScore * math.Pow(maxPowerScore/minPowerScore, float64(i-minPowerLevel)/float64(maxPowerLevel-minPowerLevel))
36 log.Printf("Power level %d requires score %v (= %v idle or %v active).",
38 time.Duration(float64(time.Second)*score/idleScore),
39 time.Duration(float64(time.Second)*score/activeScore),
44 func computePowerLevel(def int, score Score) (int, float64) {
45 points := score.Idle.Seconds()*idleScore + score.Active.Seconds()*activeScore
47 return def, math.Inf(-1)
49 raw := minPowerLevel + (maxPowerLevel-minPowerLevel)*math.Log(points/minPowerScore)/math.Log(maxPowerScore/minPowerScore)
50 if raw < minPowerLevel {
53 if points > maxPowerScore {
54 return maxPowerLevel, raw
56 return int(math.Floor(raw)), raw
59 func allPowerLevels(roomLevels *event.PowerLevelsEventContent) []int {
60 ret := make([]int, 0, len(roomLevels.Events)+5)
61 for _, level := range roomLevels.Events {
62 ret = append(ret, level)
64 ret = append(ret, roomLevels.EventsDefault)
65 if roomLevels.InvitePtr != nil {
66 ret = append(ret, *roomLevels.InvitePtr)
68 if roomLevels.KickPtr != nil {
69 ret = append(ret, *roomLevels.KickPtr)
71 if roomLevels.BanPtr != nil {
72 ret = append(ret, *roomLevels.BanPtr)
74 if roomLevels.RedactPtr != nil {
75 ret = append(ret, *roomLevels.RedactPtr)
80 func syncPowerLevels(client *mautrix.Client, room id.RoomID, roomGroup []id.RoomID, scores map[id.RoomID]map[id.UserID]*Score, force bool) {
81 roomLevels := roomPowerLevels[room]
82 if roomLevels == nil {
83 log.Printf("trying to ensure power levels for room %v, but did not get power level map yet", room)
87 for _, level := range allPowerLevels(roomLevels) {
88 if minPowerLevel <= level && level <= maxPowerLevel {
93 log.Printf("room %v skipping because PLs currently do not matter", room)
96 log.Printf("room %v considering to update PLs", room)
98 for user, score := range scores[room] {
99 // Expire users that for some reason did not get pruned from the database.
100 // This may cause them to lose their power level below.
101 if _, found := roomUsers[room][user]; !found && score.CurrentState != NotActive {
102 log.Printf("Pruning long inactive user %v from room %v.", user, room)
103 setUserStateAt(room, user, time.Now(), NotActive, NotActive)
104 score.CurrentState = NotActive
108 newRoomLevels := *roomLevels
109 newRoomLevels.Users = make(map[id.UserID]int)
110 for user, level := range roomLevels.Users {
111 if level == roomLevels.UsersDefault {
114 // TODO: Also skip users who aren't in the room for ages.
115 score := scores[room][user]
116 if level >= minPowerLevel && level <= maxPowerLevel && score.CurrentState == NotActive && time.Now().After(score.LastEvent.Add(powerExpireTime)) {
117 // User is inactive - prune them from the power level list. Saves space.
118 // But this doesn't mark the list dirty as there is no need to send an update.
119 log.Printf("room %v user %v power level: PRUNE %v (%v)", room, user, level, score)
122 newRoomLevels.Users[user] = level
125 log.Printf("room %v", room)
126 for user, score := range scores[room] {
127 if score.CurrentState == NotActive {
128 // Do not add/bump power levels for users not in the room.
131 prevLevel := roomLevels.Users[user]
132 level, raw := computePowerLevel(roomLevels.UsersDefault, *score)
133 for _, otherRoom := range roomGroup {
134 if otherRoom == room {
137 otherScore := scores[otherRoom][user]
138 if otherScore == nil {
141 otherLevel, otherRaw := computePowerLevel(roomLevels.UsersDefault, *otherScore)
142 if otherLevel > level {
149 if prevLevel < minApplyLevel {
150 log.Printf("room %v user %v power level: SKIP_TOO_LOW %v -> %v (%v, %v)", room, user, prevLevel, level, raw, score)
151 } else if prevLevel > maxApplyLevel {
152 log.Printf("room %v user %v power level: SKIP_TOO_HIGH %v -> %v (%v, %v)", room, user, prevLevel, level, raw, score)
153 } else if level < prevLevel {
154 log.Printf("room %v user %v power level: SKIP_WOULD_LOWER %v -> %v (%v, %v)", room, user, prevLevel, level, raw, score)
155 } else if level > prevLevel {
156 log.Printf("room %v user %v power level: INCREASE %v -> %v (%v, %v)", room, user, prevLevel, level, raw, score)
157 newRoomLevels.Users[user] = level
160 log.Printf("room %v user %v power level: KEEP %v -> %v (%v, %v)", room, user, prevLevel, level, raw, score)
163 clearPowerLevel := minPowerLevel
164 for len(newRoomLevels.Users) > maxPowerLevelEntries && clearPowerLevel <= maxPowerLevel {
165 log.Printf("room %v not including power level %d to reduce message size", clearPowerLevel)
166 for user, level := range newRoomLevels.Users {
167 if level == clearPowerLevel {
168 delete(newRoomLevels.Users, user)
175 diff := cmp.Diff(roomLevels.Users, newRoomLevels.Users)
176 log.Printf("room %v power level update:\n%v", room, diff)
177 _, err := client.SendStateEvent(room, event.StatePowerLevels, "", makeDefaultsExplicit(&newRoomLevels))
179 log.Printf("Failed to update power levels: %v", err)
182 log.Printf("room %v nothing to update", room)
186 type powerLevelsWithDefaults struct {
187 // This struct is a copy of the public stuff in event.PowerLevelsEventContent,
188 // but with omitempty removed on users_default and events_default to work around
189 // https://github.com/matrix-org/dendrite/issues/2983
190 Users map[id.UserID]int `json:"users,omitempty"`
191 UsersDefault int `json:"users_default"`
192 Events map[string]int `json:"events,omitempty"`
193 EventsDefault int `json:"events_default"`
194 Notifications *event.NotificationPowerLevels `json:"notifications,omitempty"`
195 StateDefaultPtr *int `json:"state_default,omitempty"`
196 InvitePtr *int `json:"invite,omitempty"`
197 KickPtr *int `json:"kick,omitempty"`
198 BanPtr *int `json:"ban,omitempty"`
199 RedactPtr *int `json:"redact,omitempty"`
200 HistoricalPtr *int `json:"historical,omitempty"`
203 func makeDefaultsExplicit(roomLevels *event.PowerLevelsEventContent) *powerLevelsWithDefaults {
204 // Copying over all exported fields using reflect.
205 // Doing it this way so if a new field is added to event.PowerLevelsEventContent, this code panics.
206 var withDefaults powerLevelsWithDefaults
207 src := reflect.ValueOf(roomLevels).Elem()
208 dst := reflect.ValueOf(&withDefaults).Elem()
209 for i := 0; i < src.Type().NumField(); i++ {
210 srcField := src.Type().Field(i)
211 if !srcField.IsExported() {
214 dst.FieldByName(srcField.Name).Set(src.Field(i))