aboutsummaryrefslogtreecommitdiff
path: root/room.go
blob: 19c686524af49a134e762368567ecf34a8fbf153 (plain)
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
// 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 main

import (
	"maunium.net/go/gomatrix"
)

// Room represents a single Matrix room.
type Room struct {
	*gomatrix.Room

	PrevBatch   string
	memberCache map[string]*RoomMember
	nameCache   string
	topicCache  string
}

// 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 {
	case "m.room.member":
		room.memberCache = nil
	case "m.room.name":
	case "m.room.canonical_alias":
	case "m.room.alias":
		room.nameCache = ""
	case "m.room.topic":
		room.topicCache = ""
	}
	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
}

// GetTitle returns the display title of the room.
func (room *Room) GetTitle() string {
	if len(room.nameCache) == 0 {
		nameEvt := room.GetStateEvent("m.room.name", "")
		if nameEvt != nil {
			room.nameCache, _ = nameEvt.Content["name"].(string)
		}
	}
	if len(room.nameCache) == 0 {
		canonicalAliasEvt := room.GetStateEvent("m.room.canonical_alias", "")
		if canonicalAliasEvt != nil {
			room.nameCache, _ = canonicalAliasEvt.Content["alias"].(string)
		}
	}
	if len(room.nameCache) == 0 {
		// 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.
		aliasEvents := room.GetStateEvents("m.room.aliases")
		for _, event := range aliasEvents {
			aliases, _ := event.Content["aliases"].([]interface{})
			if len(aliases) > 0 {
				room.nameCache, _ = aliases[0].(string)
				break
			}
		}
	}
	if len(room.nameCache) == 0 {
		// TODO follow other title rules in spec
		room.nameCache = room.ID
	}
	return room.nameCache
}

type RoomMember struct {
	UserID      string `json:"-"`
	Membership  string `json:"membership"`
	DisplayName string `json:"displayname"`
	AvatarURL   string `json:"avatar_url"`
}

func eventToRoomMember(userID string, event *gomatrix.Event) *RoomMember {
	if event == nil {
		return &RoomMember{
			UserID:     userID,
			Membership: "leave",
		}
	}
	membership, _ := event.Content["membership"].(string)
	avatarURL, _ := event.Content["avatar_url"].(string)

	displayName, _ := event.Content["displayname"].(string)
	if len(displayName) == 0 {
		displayName = userID
	}

	return &RoomMember{
		UserID:      userID,
		Membership:  membership,
		DisplayName: displayName,
		AvatarURL:   avatarURL,
	}
}

func (room *Room) createMemberCache() map[string]*RoomMember {
	cache := make(map[string]*RoomMember)
	events := room.GetStateEvents("m.room.member")
	if events != nil {
		for userID, event := range events {
			member := eventToRoomMember(userID, event)
			if member.Membership != "leave" {
				cache[member.UserID] = member
			}
		}
	}
	room.memberCache = cache
	return cache
}

func (room *Room) GetMembers() map[string]*RoomMember {
	if len(room.memberCache) == 0 {
		room.createMemberCache()
	}
	return room.memberCache
}

func (room *Room) GetMember(userID string) *RoomMember {
	if len(room.memberCache) == 0 {
		room.createMemberCache()
	}
	member, _ := room.memberCache[userID]
	return member
}

// NewRoom creates a new Room with the given ID
func NewRoom(roomID string) *Room {
	return &Room{
		Room: gomatrix.NewRoom(roomID),
	}
}