gomuks/matrix/rooms/room.go

420 lines
12 KiB
Go
Raw Normal View History

// gomuks - A terminal Matrix client written in Go.
// Copyright (C) 2018 Tulir Asokan
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package rooms
import (
"fmt"
"sort"
2018-03-22 16:36:06 +01:00
"sync"
"time"
"maunium.net/go/gomatrix"
2018-04-24 15:51:40 +02:00
"maunium.net/go/gomuks/debug"
)
2018-04-22 20:05:42 +02:00
type RoomNameSource int
const (
2018-04-22 23:04:10 +02:00
ExplicitRoomName RoomNameSource = iota
2018-04-22 20:05:42 +02:00
CanonicalAliasRoomName
AliasRoomName
MemberRoomName
)
2018-04-24 01:13:17 +02:00
// RoomTag is a tag given to a specific room.
type RoomTag struct {
// The name of the tag.
Tag string
// The order of the tag.
Order string
2018-04-24 01:13:17 +02:00
}
type UnreadMessage struct {
EventID string
Counted bool
Highlight bool
}
// Room represents a single Matrix room.
type Room struct {
*gomatrix.Room
// Whether or not the user has left the room.
HasLeft bool
2018-03-21 22:29:58 +01:00
// The first batch of events that has been fetched for this room.
// Used for fetching additional history.
2018-03-22 16:36:06 +01:00
PrevBatch string
2018-03-21 22:29:58 +01:00
// The MXID of the user whose session this room was created for.
2018-03-22 16:36:06 +01:00
SessionUserID string
// The number of unread messages that were notified about.
UnreadMessages []UnreadMessage
unreadCountCache *int
highlightCache *bool
// Whether or not this room is marked as a direct chat.
IsDirect bool
2018-04-24 01:13:17 +02:00
// List of tags given to this room
RawTags []RoomTag
// Timestamp of previously received actual message.
LastReceivedMessage time.Time
2018-03-21 22:29:58 +01:00
// MXID -> Member cache calculated from membership events.
2018-03-22 16:36:06 +01:00
memberCache map[string]*Member
2018-03-23 13:44:36 +01:00
// The first non-SessionUserID member in the room. Calculated at
// the same time as memberCache.
firstMemberCache *Member
2018-03-23 13:44:36 +01:00
// The name of the room. Calculated from the state event name,
// canonical_alias or alias or the member cache.
2018-03-22 16:36:06 +01:00
nameCache string
2018-04-22 20:05:42 +02:00
// The event type from which the name cache was calculated from.
nameCacheSource RoomNameSource
2018-03-21 22:29:58 +01:00
// The topic of the room. Directly fetched from the m.room.topic state event.
2018-03-22 16:36:06 +01:00
topicCache string
2018-04-22 20:05:42 +02:00
// The canonical alias of the room. Directly fetched from the m.room.canonical_alias state event.
canonicalAliasCache string
// The list of aliases. Directly fetched from the m.room.aliases state event.
aliasesCache []string
2018-03-22 16:36:06 +01:00
2018-03-23 13:44:36 +01:00
// fetchHistoryLock is used to make sure multiple goroutines don't fetch
// history for this room at the same time.
2018-03-23 00:07:44 +01:00
fetchHistoryLock *sync.Mutex
2018-03-22 16:36:06 +01:00
}
2018-03-23 13:44:36 +01:00
// LockHistory locks the history fetching mutex.
// If the mutex is nil, it will be created.
2018-03-22 16:36:06 +01:00
func (room *Room) LockHistory() {
if room.fetchHistoryLock == nil {
room.fetchHistoryLock = &sync.Mutex{}
}
room.fetchHistoryLock.Lock()
}
2018-03-23 13:44:36 +01:00
// UnlockHistory unlocks the history fetching mutex.
// If the mutex is nil, this does nothing.
2018-03-22 16:36:06 +01:00
func (room *Room) UnlockHistory() {
if room.fetchHistoryLock != nil {
room.fetchHistoryLock.Unlock()
}
}
// MarkRead clears the new message statuses on this room.
func (room *Room) MarkRead(eventID string) {
readToIndex := -1
for index, unreadMessage := range room.UnreadMessages {
if unreadMessage.EventID == eventID {
readToIndex = index
}
}
if readToIndex >= 0 {
room.UnreadMessages = room.UnreadMessages[readToIndex+1:]
room.highlightCache = nil
room.unreadCountCache = nil
}
}
func (room *Room) UnreadCount() int {
if room.unreadCountCache == nil {
room.unreadCountCache = new(int)
for _, unreadMessage := range room.UnreadMessages {
if unreadMessage.Counted {
*room.unreadCountCache++
}
}
}
return *room.unreadCountCache
}
func (room *Room) Highlighted() bool {
if room.highlightCache == nil {
room.highlightCache = new(bool)
for _, unreadMessage := range room.UnreadMessages {
if unreadMessage.Highlight {
*room.highlightCache = true
break
}
}
}
return *room.highlightCache
}
func (room *Room) HasNewMessages() bool {
return len(room.UnreadMessages) > 0
}
func (room *Room) AddUnread(eventID string, counted, highlight bool) {
room.UnreadMessages = append(room.UnreadMessages, UnreadMessage{
EventID: eventID,
Counted: counted,
Highlight: highlight,
})
if counted {
if room.unreadCountCache == nil {
room.unreadCountCache = new(int)
}
*room.unreadCountCache++
}
if highlight {
if room.highlightCache == nil {
room.highlightCache = new(bool)
}
*room.highlightCache = true
}
}
2018-04-24 01:13:17 +02:00
func (room *Room) Tags() []RoomTag {
if len(room.RawTags) == 0 {
if room.IsDirect {
return []RoomTag{{"net.maunium.gomuks.fake.direct", "0.5"}}
}
return []RoomTag{{"", "0.5"}}
2018-04-24 01:13:17 +02:00
}
return room.RawTags
}
// UpdateState updates the room's current state with the given Event. This will clobber events based
// on the type/state_key combination.
func (room *Room) UpdateState(event *gomatrix.Event) {
_, exists := room.State[event.Type]
if !exists {
room.State[event.Type] = make(map[string]*gomatrix.Event)
}
switch event.Type {
2018-04-22 20:05:42 +02:00
case "m.room.name":
room.nameCache = ""
case "m.room.canonical_alias":
if room.nameCacheSource >= CanonicalAliasRoomName {
room.nameCache = ""
}
room.canonicalAliasCache = ""
case "m.room.aliases":
if room.nameCacheSource >= AliasRoomName {
room.nameCache = ""
}
room.aliasesCache = nil
case "m.room.member":
room.memberCache = nil
room.firstMemberCache = nil
2018-04-22 20:05:42 +02:00
if room.nameCacheSource >= MemberRoomName {
room.nameCache = ""
}
case "m.room.topic":
room.topicCache = ""
}
2018-04-24 15:51:40 +02:00
stateKey := ""
if event.StateKey != nil {
stateKey = *event.StateKey
}
if event.Type != "m.room.member" {
2018-04-24 16:12:08 +02:00
debug.Printf("Updating state %s#%s for %s", event.Type, stateKey, room.ID)
2018-04-24 15:51:40 +02:00
}
if event.StateKey == nil {
room.State[event.Type][""] = event
} else {
room.State[event.Type][*event.StateKey] = event
}
}
// GetStateEvent returns the state event for the given type/state_key combo, or nil.
func (room *Room) GetStateEvent(eventType string, stateKey string) *gomatrix.Event {
stateEventMap, _ := room.State[eventType]
event, _ := stateEventMap[stateKey]
return event
}
// GetStateEvents returns the state events for the given type.
func (room *Room) GetStateEvents(eventType string) map[string]*gomatrix.Event {
stateEventMap, _ := room.State[eventType]
return stateEventMap
}
// GetTopic returns the topic of the room.
func (room *Room) GetTopic() string {
if len(room.topicCache) == 0 {
topicEvt := room.GetStateEvent("m.room.topic", "")
if topicEvt != nil {
room.topicCache, _ = topicEvt.Content["topic"].(string)
}
}
return room.topicCache
}
2018-04-22 20:05:42 +02:00
func (room *Room) GetCanonicalAlias() string {
if len(room.canonicalAliasCache) == 0 {
canonicalAliasEvt := room.GetStateEvent("m.room.canonical_alias", "")
if canonicalAliasEvt != nil {
room.canonicalAliasCache, _ = canonicalAliasEvt.Content["alias"].(string)
} else {
room.canonicalAliasCache = "-"
}
}
if room.canonicalAliasCache == "-" {
return ""
}
return room.canonicalAliasCache
}
// GetAliases returns the list of aliases that point to this room.
func (room *Room) GetAliases() []string {
if room.aliasesCache == nil {
aliasEvents := room.GetStateEvents("m.room.aliases")
room.aliasesCache = []string{}
for _, event := range aliasEvents {
aliases, _ := event.Content["aliases"].([]interface{})
newAliases := make([]string, len(room.aliasesCache)+len(aliases))
copy(newAliases, room.aliasesCache)
for index, alias := range aliases {
newAliases[len(room.aliasesCache)+index], _ = alias.(string)
2018-04-22 20:05:42 +02:00
}
room.aliasesCache = newAliases
}
}
return room.aliasesCache
}
// updateNameFromNameEvent updates the room display name to be the name set in the name event.
func (room *Room) updateNameFromNameEvent() {
nameEvt := room.GetStateEvent("m.room.name", "")
if nameEvt != nil {
room.nameCache, _ = nameEvt.Content["name"].(string)
}
}
// updateNameFromAliases updates the room display name to be the first room alias it finds.
//
2018-04-22 20:05:42 +02:00
// Deprecated: the Client-Server API recommends against using non-canonical aliases as display name.
func (room *Room) updateNameFromAliases() {
// TODO the spec says clients should not use m.room.aliases for room names.
// However, Riot also uses m.room.aliases, so this is here now.
aliases := room.GetAliases()
if len(aliases) > 0 {
sort.Sort(sort.StringSlice(aliases))
room.nameCache = aliases[0]
}
}
// updateNameFromMembers updates the room display name based on the members in this room.
//
// The room name depends on the number of users:
// Less than two users -> "Empty room"
// Exactly two users -> The display name of the other user.
// More than two users -> The display name of one of the other users, followed
// by "and X others", where X is the number of users
// excluding the local user and the named user.
func (room *Room) updateNameFromMembers() {
members := room.GetMembers()
if len(members) <= 1 {
room.nameCache = "Empty room"
} else if room.firstMemberCache == nil {
room.nameCache = "Room"
} else if len(members) == 2 {
room.nameCache = room.firstMemberCache.DisplayName
} else {
firstMember := room.firstMemberCache.DisplayName
room.nameCache = fmt.Sprintf("%s and %d others", firstMember, len(members)-2)
}
}
// updateNameCache updates the room display name based on the room state in the order
2018-03-21 22:29:58 +01:00
// specified in spec section 11.2.2.5.
func (room *Room) updateNameCache() {
if len(room.nameCache) == 0 {
room.updateNameFromNameEvent()
2018-04-22 20:05:42 +02:00
room.nameCacheSource = ExplicitRoomName
}
if len(room.nameCache) == 0 {
2018-04-22 20:05:42 +02:00
room.nameCache = room.GetCanonicalAlias()
room.nameCacheSource = CanonicalAliasRoomName
}
if len(room.nameCache) == 0 {
room.updateNameFromAliases()
2018-04-22 20:05:42 +02:00
room.nameCacheSource = AliasRoomName
}
if len(room.nameCache) == 0 {
room.updateNameFromMembers()
2018-04-22 20:05:42 +02:00
room.nameCacheSource = MemberRoomName
}
}
// GetTitle returns the display name of the room.
//
// The display name is returned from the cache.
// If the cache is empty, it is updated first.
func (room *Room) GetTitle() string {
room.updateNameCache()
return room.nameCache
}
// createMemberCache caches all member events into a easily processable MXID -> *Member map.
2018-03-18 20:24:03 +01:00
func (room *Room) createMemberCache() map[string]*Member {
cache := make(map[string]*Member)
events := room.GetStateEvents("m.room.member")
room.firstMemberCache = nil
if events != nil {
for userID, event := range events {
member := eventToRoomMember(userID, event)
if room.firstMemberCache == nil && userID != room.SessionUserID {
room.firstMemberCache = member
}
if member.Membership != "leave" {
cache[member.UserID] = member
}
}
}
room.memberCache = cache
return cache
}
// GetMembers returns the members in this room.
//
// The members are returned from the cache.
// If the cache is empty, it is updated first.
2018-03-18 20:24:03 +01:00
func (room *Room) GetMembers() map[string]*Member {
if len(room.memberCache) == 0 || room.firstMemberCache == nil {
room.createMemberCache()
}
return room.memberCache
}
// GetMember returns the member with the given MXID.
// If the member doesn't exist, nil is returned.
2018-03-18 20:24:03 +01:00
func (room *Room) GetMember(userID string) *Member {
if len(room.memberCache) == 0 {
room.createMemberCache()
}
member, _ := room.memberCache[userID]
return member
}
2018-03-22 20:44:46 +01:00
// GetSessionOwner returns the Member instance of the user whose session this room was created for.
func (room *Room) GetSessionOwner() *Member {
return room.GetMember(room.SessionUserID)
}
// NewRoom creates a new Room with the given ID
func NewRoom(roomID, owner string) *Room {
return &Room{
2018-03-22 16:36:06 +01:00
Room: gomatrix.NewRoom(roomID),
fetchHistoryLock: &sync.Mutex{},
SessionUserID: owner,
}
}