user.go 35 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082
  1. // mautrix-whatsapp - A Matrix-WhatsApp puppeting bridge.
  2. // Copyright (C) 2021 Tulir Asokan
  3. //
  4. // This program is free software: you can redistribute it and/or modify
  5. // it under the terms of the GNU Affero General Public License as published by
  6. // the Free Software Foundation, either version 3 of the License, or
  7. // (at your option) any later version.
  8. //
  9. // This program is distributed in the hope that it will be useful,
  10. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. // GNU Affero General Public License for more details.
  13. //
  14. // You should have received a copy of the GNU Affero General Public License
  15. // along with this program. If not, see <https://www.gnu.org/licenses/>.
  16. package main
  17. import (
  18. "context"
  19. "encoding/json"
  20. "errors"
  21. "fmt"
  22. "math"
  23. "net/http"
  24. "strconv"
  25. "strings"
  26. "sync"
  27. "time"
  28. log "maunium.net/go/maulogger/v2"
  29. "maunium.net/go/mautrix"
  30. "maunium.net/go/mautrix/appservice"
  31. "maunium.net/go/mautrix/event"
  32. "maunium.net/go/mautrix/format"
  33. "maunium.net/go/mautrix/id"
  34. "maunium.net/go/mautrix/pushrules"
  35. "go.mau.fi/whatsmeow"
  36. "go.mau.fi/whatsmeow/appstate"
  37. waProto "go.mau.fi/whatsmeow/binary/proto"
  38. "go.mau.fi/whatsmeow/store"
  39. "go.mau.fi/whatsmeow/types"
  40. "go.mau.fi/whatsmeow/types/events"
  41. waLog "go.mau.fi/whatsmeow/util/log"
  42. "maunium.net/go/mautrix-whatsapp/database"
  43. )
  44. type User struct {
  45. *database.User
  46. Client *whatsmeow.Client
  47. Session *store.Device
  48. bridge *Bridge
  49. log log.Logger
  50. Admin bool
  51. Whitelisted bool
  52. RelayWhitelisted bool
  53. mgmtCreateLock sync.Mutex
  54. spaceCreateLock sync.Mutex
  55. connLock sync.Mutex
  56. historySyncs chan *events.HistorySync
  57. prevBridgeStatus *BridgeState
  58. lastPresence types.Presence
  59. spaceMembershipChecked bool
  60. lastPhoneOfflineWarning time.Time
  61. }
  62. func (bridge *Bridge) getUserByMXID(userID id.UserID, onlyIfExists bool) *User {
  63. _, isPuppet := bridge.ParsePuppetMXID(userID)
  64. if isPuppet || userID == bridge.Bot.UserID {
  65. return nil
  66. }
  67. bridge.usersLock.Lock()
  68. defer bridge.usersLock.Unlock()
  69. user, ok := bridge.usersByMXID[userID]
  70. if !ok {
  71. userIDPtr := &userID
  72. if onlyIfExists {
  73. userIDPtr = nil
  74. }
  75. return bridge.loadDBUser(bridge.DB.User.GetByMXID(userID), userIDPtr)
  76. }
  77. return user
  78. }
  79. func (bridge *Bridge) GetUserByMXID(userID id.UserID) *User {
  80. return bridge.getUserByMXID(userID, false)
  81. }
  82. func (bridge *Bridge) GetUserByMXIDIfExists(userID id.UserID) *User {
  83. return bridge.getUserByMXID(userID, true)
  84. }
  85. func (bridge *Bridge) GetUserByJID(jid types.JID) *User {
  86. bridge.usersLock.Lock()
  87. defer bridge.usersLock.Unlock()
  88. user, ok := bridge.usersByUsername[jid.User]
  89. if !ok {
  90. return bridge.loadDBUser(bridge.DB.User.GetByUsername(jid.User), nil)
  91. }
  92. return user
  93. }
  94. func (user *User) addToJIDMap() {
  95. user.bridge.usersLock.Lock()
  96. user.bridge.usersByUsername[user.JID.User] = user
  97. user.bridge.usersLock.Unlock()
  98. }
  99. func (user *User) removeFromJIDMap(state BridgeStateEvent) {
  100. user.bridge.usersLock.Lock()
  101. jidUser, ok := user.bridge.usersByUsername[user.JID.User]
  102. if ok && user == jidUser {
  103. delete(user.bridge.usersByUsername, user.JID.User)
  104. }
  105. user.bridge.usersLock.Unlock()
  106. user.bridge.Metrics.TrackLoginState(user.JID, false)
  107. user.sendBridgeState(BridgeState{StateEvent: state})
  108. }
  109. func (bridge *Bridge) GetAllUsers() []*User {
  110. bridge.usersLock.Lock()
  111. defer bridge.usersLock.Unlock()
  112. dbUsers := bridge.DB.User.GetAll()
  113. output := make([]*User, len(dbUsers))
  114. for index, dbUser := range dbUsers {
  115. user, ok := bridge.usersByMXID[dbUser.MXID]
  116. if !ok {
  117. user = bridge.loadDBUser(dbUser, nil)
  118. }
  119. output[index] = user
  120. }
  121. return output
  122. }
  123. func (bridge *Bridge) loadDBUser(dbUser *database.User, mxid *id.UserID) *User {
  124. if dbUser == nil {
  125. if mxid == nil {
  126. return nil
  127. }
  128. dbUser = bridge.DB.User.New()
  129. dbUser.MXID = *mxid
  130. dbUser.Insert()
  131. }
  132. user := bridge.NewUser(dbUser)
  133. bridge.usersByMXID[user.MXID] = user
  134. if !user.JID.IsEmpty() {
  135. var err error
  136. user.Session, err = bridge.WAContainer.GetDevice(user.JID)
  137. if err != nil {
  138. user.log.Errorfln("Failed to load user's whatsapp session: %v", err)
  139. } else if user.Session == nil {
  140. user.log.Warnfln("Didn't find session data for %s, treating user as logged out", user.JID)
  141. user.JID = types.EmptyJID
  142. user.Update()
  143. } else {
  144. bridge.usersByUsername[user.JID.User] = user
  145. }
  146. }
  147. if len(user.ManagementRoom) > 0 {
  148. bridge.managementRooms[user.ManagementRoom] = user
  149. }
  150. return user
  151. }
  152. func (bridge *Bridge) NewUser(dbUser *database.User) *User {
  153. user := &User{
  154. User: dbUser,
  155. bridge: bridge,
  156. log: bridge.Log.Sub("User").Sub(string(dbUser.MXID)),
  157. historySyncs: make(chan *events.HistorySync, 32),
  158. lastPresence: types.PresenceUnavailable,
  159. }
  160. user.RelayWhitelisted = user.bridge.Config.Bridge.Permissions.IsRelayWhitelisted(user.MXID)
  161. user.Whitelisted = user.bridge.Config.Bridge.Permissions.IsWhitelisted(user.MXID)
  162. user.Admin = user.bridge.Config.Bridge.Permissions.IsAdmin(user.MXID)
  163. go user.handleHistorySyncsLoop()
  164. return user
  165. }
  166. func (user *User) ensureInvited(intent *appservice.IntentAPI, roomID id.RoomID, isDirect bool) (ok bool) {
  167. inviteContent := event.Content{
  168. Parsed: &event.MemberEventContent{
  169. Membership: event.MembershipInvite,
  170. IsDirect: isDirect,
  171. },
  172. Raw: map[string]interface{}{},
  173. }
  174. customPuppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  175. if customPuppet != nil && customPuppet.CustomIntent() != nil {
  176. inviteContent.Raw["fi.mau.will_auto_accept"] = true
  177. }
  178. _, err := intent.SendStateEvent(roomID, event.StateMember, user.MXID.String(), &inviteContent)
  179. var httpErr mautrix.HTTPError
  180. if err != nil && errors.As(err, &httpErr) && httpErr.RespError != nil && strings.Contains(httpErr.RespError.Err, "is already in the room") {
  181. user.bridge.StateStore.SetMembership(roomID, user.MXID, event.MembershipJoin)
  182. ok = true
  183. return
  184. } else if err != nil {
  185. user.log.Warnfln("Failed to invite user to %s: %v", roomID, err)
  186. } else {
  187. ok = true
  188. }
  189. if customPuppet != nil && customPuppet.CustomIntent() != nil {
  190. err = customPuppet.CustomIntent().EnsureJoined(roomID, appservice.EnsureJoinedParams{IgnoreCache: true})
  191. if err != nil {
  192. user.log.Warnfln("Failed to auto-join %s: %v", roomID, err)
  193. ok = false
  194. } else {
  195. ok = true
  196. }
  197. }
  198. return
  199. }
  200. func (user *User) GetSpaceRoom() id.RoomID {
  201. if !user.bridge.Config.Bridge.PersonalFilteringSpaces {
  202. return ""
  203. }
  204. if len(user.SpaceRoom) == 0 {
  205. user.spaceCreateLock.Lock()
  206. defer user.spaceCreateLock.Unlock()
  207. if len(user.SpaceRoom) > 0 {
  208. return user.SpaceRoom
  209. }
  210. resp, err := user.bridge.Bot.CreateRoom(&mautrix.ReqCreateRoom{
  211. Visibility: "private",
  212. Name: "WhatsApp",
  213. Topic: "Your WhatsApp bridged chats",
  214. InitialState: []*event.Event{{
  215. Type: event.StateRoomAvatar,
  216. Content: event.Content{
  217. Parsed: &event.RoomAvatarEventContent{
  218. URL: user.bridge.Config.AppService.Bot.ParsedAvatar,
  219. },
  220. },
  221. }},
  222. CreationContent: map[string]interface{}{
  223. "type": event.RoomTypeSpace,
  224. },
  225. PowerLevelOverride: &event.PowerLevelsEventContent{
  226. Users: map[id.UserID]int{
  227. user.bridge.Bot.UserID: 9001,
  228. user.MXID: 50,
  229. },
  230. },
  231. })
  232. if err != nil {
  233. user.log.Errorln("Failed to auto-create space room:", err)
  234. } else {
  235. user.SpaceRoom = resp.RoomID
  236. user.Update()
  237. user.ensureInvited(user.bridge.Bot, user.SpaceRoom, false)
  238. }
  239. } else if !user.spaceMembershipChecked && !user.bridge.StateStore.IsInRoom(user.SpaceRoom, user.MXID) {
  240. user.ensureInvited(user.bridge.Bot, user.SpaceRoom, false)
  241. }
  242. user.spaceMembershipChecked = true
  243. return user.SpaceRoom
  244. }
  245. func (user *User) GetManagementRoom() id.RoomID {
  246. if len(user.ManagementRoom) == 0 {
  247. user.mgmtCreateLock.Lock()
  248. defer user.mgmtCreateLock.Unlock()
  249. if len(user.ManagementRoom) > 0 {
  250. return user.ManagementRoom
  251. }
  252. creationContent := make(map[string]interface{})
  253. if !user.bridge.Config.Bridge.FederateRooms {
  254. creationContent["m.federate"] = false
  255. }
  256. resp, err := user.bridge.Bot.CreateRoom(&mautrix.ReqCreateRoom{
  257. Topic: "WhatsApp bridge notices",
  258. IsDirect: true,
  259. CreationContent: creationContent,
  260. })
  261. if err != nil {
  262. user.log.Errorln("Failed to auto-create management room:", err)
  263. } else {
  264. user.SetManagementRoom(resp.RoomID)
  265. }
  266. }
  267. return user.ManagementRoom
  268. }
  269. func (user *User) SetManagementRoom(roomID id.RoomID) {
  270. existingUser, ok := user.bridge.managementRooms[roomID]
  271. if ok {
  272. existingUser.ManagementRoom = ""
  273. existingUser.Update()
  274. }
  275. user.ManagementRoom = roomID
  276. user.bridge.managementRooms[user.ManagementRoom] = user
  277. user.Update()
  278. }
  279. type waLogger struct{ l log.Logger }
  280. func (w *waLogger) Debugf(msg string, args ...interface{}) { w.l.Debugfln(msg, args...) }
  281. func (w *waLogger) Infof(msg string, args ...interface{}) { w.l.Infofln(msg, args...) }
  282. func (w *waLogger) Warnf(msg string, args ...interface{}) { w.l.Warnfln(msg, args...) }
  283. func (w *waLogger) Errorf(msg string, args ...interface{}) { w.l.Errorfln(msg, args...) }
  284. func (w *waLogger) Sub(module string) waLog.Logger { return &waLogger{l: w.l.Sub(module)} }
  285. var ErrAlreadyLoggedIn = errors.New("already logged in")
  286. func (user *User) createClient(sess *store.Device) {
  287. user.Client = whatsmeow.NewClient(sess, &waLogger{user.log.Sub("Client")})
  288. user.Client.AddEventHandler(user.HandleEvent)
  289. user.Client.SetForceActiveDeliveryReceipts(user.bridge.Config.Bridge.ForceActiveDeliveryReceipts)
  290. user.Client.GetMessageForRetry = func(to types.JID, id types.MessageID) *waProto.Message {
  291. user.bridge.Metrics.TrackRetryReceipt(0, false)
  292. return nil
  293. }
  294. user.Client.PreRetryCallback = func(receipt *events.Receipt, retryCount int, msg *waProto.Message) bool {
  295. user.bridge.Metrics.TrackRetryReceipt(retryCount, true)
  296. return true
  297. }
  298. }
  299. func (user *User) Login(ctx context.Context) (<-chan whatsmeow.QRChannelItem, error) {
  300. user.connLock.Lock()
  301. defer user.connLock.Unlock()
  302. if user.Session != nil {
  303. return nil, ErrAlreadyLoggedIn
  304. } else if user.Client != nil {
  305. user.unlockedDeleteConnection()
  306. }
  307. newSession := user.bridge.WAContainer.NewDevice()
  308. newSession.Log = &waLogger{user.log.Sub("Session")}
  309. user.createClient(newSession)
  310. qrChan, err := user.Client.GetQRChannel(ctx)
  311. if err != nil {
  312. return nil, fmt.Errorf("failed to get QR channel: %w", err)
  313. }
  314. err = user.Client.Connect()
  315. if err != nil {
  316. return nil, fmt.Errorf("failed to connect to WhatsApp: %w", err)
  317. }
  318. return qrChan, nil
  319. }
  320. func (user *User) Connect() bool {
  321. user.connLock.Lock()
  322. defer user.connLock.Unlock()
  323. if user.Client != nil {
  324. return user.Client.IsConnected()
  325. } else if user.Session == nil {
  326. return false
  327. }
  328. user.log.Debugln("Connecting to WhatsApp")
  329. user.sendBridgeState(BridgeState{StateEvent: StateConnecting, Error: WAConnecting})
  330. user.createClient(user.Session)
  331. err := user.Client.Connect()
  332. if err != nil {
  333. user.log.Warnln("Error connecting to WhatsApp:", err)
  334. return false
  335. }
  336. return true
  337. }
  338. func (user *User) unlockedDeleteConnection() {
  339. if user.Client == nil {
  340. return
  341. }
  342. user.Client.Disconnect()
  343. user.Client.RemoveEventHandlers()
  344. user.Client = nil
  345. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  346. }
  347. func (user *User) DeleteConnection() {
  348. user.connLock.Lock()
  349. defer user.connLock.Unlock()
  350. user.unlockedDeleteConnection()
  351. }
  352. func (user *User) HasSession() bool {
  353. return user.Session != nil
  354. }
  355. func (user *User) DeleteSession() {
  356. if user.Session != nil {
  357. err := user.Session.Delete()
  358. if err != nil {
  359. user.log.Warnln("Failed to delete session:", err)
  360. }
  361. user.Session = nil
  362. }
  363. if !user.JID.IsEmpty() {
  364. user.JID = types.EmptyJID
  365. user.Update()
  366. }
  367. }
  368. func (user *User) IsConnected() bool {
  369. return user.Client != nil && user.Client.IsConnected()
  370. }
  371. func (user *User) IsLoggedIn() bool {
  372. return user.IsConnected() && user.Client.IsLoggedIn()
  373. }
  374. func (user *User) tryAutomaticDoublePuppeting() {
  375. if !user.bridge.Config.CanAutoDoublePuppet(user.MXID) {
  376. return
  377. }
  378. user.log.Debugln("Checking if double puppeting needs to be enabled")
  379. puppet := user.bridge.GetPuppetByJID(user.JID)
  380. if len(puppet.CustomMXID) > 0 {
  381. user.log.Debugln("User already has double-puppeting enabled")
  382. // Custom puppet already enabled
  383. return
  384. }
  385. accessToken, err := puppet.loginWithSharedSecret(user.MXID)
  386. if err != nil {
  387. user.log.Warnln("Failed to login with shared secret:", err)
  388. return
  389. }
  390. err = puppet.SwitchCustomMXID(accessToken, user.MXID)
  391. if err != nil {
  392. puppet.log.Warnln("Failed to switch to auto-logined custom puppet:", err)
  393. return
  394. }
  395. user.log.Infoln("Successfully automatically enabled custom puppet")
  396. }
  397. func (user *User) sendMarkdownBridgeAlert(formatString string, args ...interface{}) {
  398. if user.bridge.Config.Bridge.DisableBridgeAlerts {
  399. return
  400. }
  401. notice := fmt.Sprintf(formatString, args...)
  402. content := format.RenderMarkdown(notice, true, false)
  403. _, err := user.bridge.Bot.SendMessageEvent(user.GetManagementRoom(), event.EventMessage, content)
  404. if err != nil {
  405. user.log.Warnf("Failed to send bridge alert \"%s\": %v", notice, err)
  406. }
  407. }
  408. const callEventMaxAge = 15 * time.Minute
  409. func (user *User) handleCallStart(sender types.JID, id, callType string, ts time.Time) {
  410. if !user.bridge.Config.Bridge.CallStartNotices || ts.Add(callEventMaxAge).Before(time.Now()) {
  411. return
  412. }
  413. portal := user.GetPortalByJID(sender)
  414. text := "Incoming call"
  415. if callType != "" {
  416. text = fmt.Sprintf("Incoming %s call", callType)
  417. }
  418. portal.messages <- PortalMessage{
  419. fake: &fakeMessage{
  420. Sender: sender,
  421. Text: text,
  422. ID: id,
  423. Time: ts,
  424. Important: true,
  425. },
  426. source: user,
  427. }
  428. }
  429. const PhoneDisconnectWarningTime = 12 * 24 * time.Hour // 12 days
  430. const PhoneDisconnectPingTime = 10 * 24 * time.Hour
  431. const PhoneMinPingInterval = 24 * time.Hour
  432. func (user *User) sendHackyPhonePing() {
  433. msgID := whatsmeow.GenerateMessageID()
  434. user.PhoneLastPinged = time.Now()
  435. ts, err := user.Client.SendMessage(user.JID.ToNonAD(), msgID, &waProto.Message{
  436. ProtocolMessage: &waProto.ProtocolMessage{},
  437. })
  438. if err != nil {
  439. user.log.Warnfln("Failed to send hacky phone ping: %v", err)
  440. } else {
  441. user.log.Debugfln("Sent hacky phone ping %s/%s because phone has been offline for >10 days", msgID, ts)
  442. user.PhoneLastPinged = ts
  443. user.Update()
  444. }
  445. }
  446. func (user *User) PhoneRecentlySeen(doPing bool) bool {
  447. if doPing && !user.PhoneLastSeen.IsZero() && user.PhoneLastSeen.Add(PhoneDisconnectPingTime).Before(time.Now()) && user.PhoneLastPinged.Add(PhoneMinPingInterval).Before(time.Now()) {
  448. // Over 10 days since the phone was seen and over a day since the last somewhat hacky ping, send a new ping.
  449. go user.sendHackyPhonePing()
  450. }
  451. return user.PhoneLastSeen.IsZero() || user.PhoneLastSeen.Add(PhoneDisconnectWarningTime).After(time.Now())
  452. }
  453. // phoneSeen records a timestamp when the user's main device was seen online.
  454. // The stored timestamp can later be used to warn the user if the main device is offline for too long.
  455. func (user *User) phoneSeen(ts time.Time) {
  456. if user.PhoneLastSeen.Add(1 * time.Hour).After(ts) {
  457. // The last seen timestamp isn't going to be perfectly accurate in any case,
  458. // so don't spam the database with an update every time there's an event.
  459. return
  460. } else if !user.PhoneRecentlySeen(false) && user.GetPrevBridgeState().Error == WAPhoneOffline && user.IsConnected() {
  461. user.log.Debugfln("Saw phone after current bridge state said it has been offline, switching state back to connected")
  462. go user.sendBridgeState(BridgeState{StateEvent: StateConnected})
  463. }
  464. user.PhoneLastSeen = ts
  465. go user.Update()
  466. }
  467. func formatDisconnectTime(dur time.Duration) string {
  468. days := int(math.Floor(dur.Hours() / 24))
  469. hours := int(dur.Hours()) % 24
  470. if hours == 0 {
  471. return fmt.Sprintf("%d days", days)
  472. } else if hours == 1 {
  473. return fmt.Sprintf("%d days and 1 hour", days)
  474. } else {
  475. return fmt.Sprintf("%d days and %d hours", days, hours)
  476. }
  477. }
  478. func (user *User) sendPhoneOfflineWarning() {
  479. if user.lastPhoneOfflineWarning.Add(12 * time.Hour).After(time.Now()) {
  480. // Don't spam the warning too much
  481. return
  482. }
  483. user.lastPhoneOfflineWarning = time.Now()
  484. timeSinceSeen := time.Now().Sub(user.PhoneLastSeen)
  485. user.sendMarkdownBridgeAlert("Your phone hasn't been seen in %s. The server will force the bridge to log out if the phone is not active at least every 2 weeks.", formatDisconnectTime(timeSinceSeen))
  486. }
  487. func (user *User) HandleEvent(event interface{}) {
  488. switch v := event.(type) {
  489. case *events.LoggedOut:
  490. go user.handleLoggedOut(v.OnConnect, v.Reason)
  491. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  492. user.bridge.Metrics.TrackLoginState(user.JID, false)
  493. case *events.Connected:
  494. user.bridge.Metrics.TrackConnectionState(user.JID, true)
  495. user.bridge.Metrics.TrackLoginState(user.JID, true)
  496. if len(user.Client.Store.PushName) > 0 {
  497. go func() {
  498. err := user.Client.SendPresence(user.lastPresence)
  499. if err != nil {
  500. user.log.Warnln("Failed to send initial presence:", err)
  501. }
  502. }()
  503. }
  504. go user.tryAutomaticDoublePuppeting()
  505. case *events.OfflineSyncPreview:
  506. user.log.Infofln("Server says it's going to send %d messages and %d receipts that were missed during downtime", v.Messages, v.Receipts)
  507. go user.sendBridgeState(BridgeState{
  508. StateEvent: StateBackfilling,
  509. Message: fmt.Sprintf("backfilling %d messages and %d receipts", v.Messages, v.Receipts),
  510. })
  511. case *events.OfflineSyncCompleted:
  512. if !user.PhoneRecentlySeen(true) {
  513. user.log.Infofln("Offline sync completed, but phone last seen date is still %s - sending phone offline bridge status", user.PhoneLastSeen)
  514. go user.sendBridgeState(BridgeState{StateEvent: StateTransientDisconnect, Error: WAPhoneOffline})
  515. } else {
  516. if user.GetPrevBridgeState().StateEvent == StateBackfilling {
  517. user.log.Infoln("Offline sync completed")
  518. }
  519. go user.sendBridgeState(BridgeState{StateEvent: StateConnected})
  520. }
  521. case *events.AppStateSyncComplete:
  522. if len(user.Client.Store.PushName) > 0 && v.Name == appstate.WAPatchCriticalBlock {
  523. err := user.Client.SendPresence(user.lastPresence)
  524. if err != nil {
  525. user.log.Warnln("Failed to send presence after app state sync:", err)
  526. }
  527. } else if v.Name == appstate.WAPatchCriticalUnblockLow {
  528. go func() {
  529. err := user.ResyncContacts()
  530. if err != nil {
  531. user.log.Errorln("Failed to resync puppets: %v", err)
  532. }
  533. }()
  534. }
  535. case *events.PushNameSetting:
  536. // Send presence available when connecting and when the pushname is changed.
  537. // This makes sure that outgoing messages always have the right pushname.
  538. err := user.Client.SendPresence(user.lastPresence)
  539. if err != nil {
  540. user.log.Warnln("Failed to send presence after push name update:", err)
  541. }
  542. case *events.PairSuccess:
  543. user.PhoneLastSeen = time.Now()
  544. user.Session = user.Client.Store
  545. user.JID = v.ID
  546. user.addToJIDMap()
  547. user.Update()
  548. case *events.StreamError:
  549. var message string
  550. if v.Code != "" {
  551. message = fmt.Sprintf("Unknown stream error with code %s", v.Code)
  552. } else if children := v.Raw.GetChildren(); len(children) > 0 {
  553. message = fmt.Sprintf("Unknown stream error (contains %s node)", children[0].Tag)
  554. } else {
  555. message = "Unknown stream error"
  556. }
  557. go user.sendBridgeState(BridgeState{StateEvent: StateUnknownError, Message: message})
  558. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  559. case *events.ConnectFailure:
  560. go user.sendBridgeState(BridgeState{StateEvent: StateUnknownError, Message: fmt.Sprintf("Unknown connection failure: %s", v.Reason)})
  561. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  562. case *events.ClientOutdated:
  563. user.log.Errorfln("Got a client outdated connect failure. The bridge is likely out of date, please update immediately.")
  564. go user.sendBridgeState(BridgeState{StateEvent: StateUnknownError, Message: "Connect failure: 405 client outdated"})
  565. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  566. case *events.TemporaryBan:
  567. go user.sendBridgeState(BridgeState{StateEvent: StateBadCredentials, Message: v.String()})
  568. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  569. case *events.Disconnected:
  570. go user.sendBridgeState(BridgeState{StateEvent: StateTransientDisconnect})
  571. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  572. case *events.Contact:
  573. go user.syncPuppet(v.JID, "contact event")
  574. case *events.PushName:
  575. go user.syncPuppet(v.JID, "push name event")
  576. case *events.GroupInfo:
  577. go user.handleGroupUpdate(v)
  578. case *events.JoinedGroup:
  579. go user.handleGroupCreate(v)
  580. case *events.Picture:
  581. go user.handlePictureUpdate(v)
  582. case *events.Receipt:
  583. if v.IsFromMe && v.Sender.Device == 0 {
  584. user.phoneSeen(v.Timestamp)
  585. }
  586. go user.handleReceipt(v)
  587. case *events.ChatPresence:
  588. go user.handleChatPresence(v)
  589. case *events.Message:
  590. portal := user.GetPortalByMessageSource(v.Info.MessageSource)
  591. portal.messages <- PortalMessage{evt: v, source: user}
  592. case *events.MediaRetry:
  593. user.phoneSeen(v.Timestamp)
  594. portal := user.GetPortalByJID(v.ChatID)
  595. portal.mediaRetries <- PortalMediaRetry{evt: v, source: user}
  596. case *events.CallOffer:
  597. user.handleCallStart(v.CallCreator, v.CallID, "", v.Timestamp)
  598. case *events.CallOfferNotice:
  599. user.handleCallStart(v.CallCreator, v.CallID, v.Type, v.Timestamp)
  600. case *events.IdentityChange:
  601. puppet := user.bridge.GetPuppetByJID(v.JID)
  602. portal := user.GetPortalByJID(v.JID)
  603. if len(portal.MXID) > 0 && user.bridge.Config.Bridge.IdentityChangeNotices {
  604. text := fmt.Sprintf("Your security code with %s changed.", puppet.Displayname)
  605. if v.Implicit {
  606. text = fmt.Sprintf("Your security code with %s (device #%d) changed.", puppet.Displayname, v.JID.Device)
  607. }
  608. portal.messages <- PortalMessage{
  609. fake: &fakeMessage{
  610. Sender: v.JID,
  611. Text: text,
  612. ID: strconv.FormatInt(v.Timestamp.Unix(), 10),
  613. Time: v.Timestamp,
  614. Important: false,
  615. },
  616. source: user,
  617. }
  618. }
  619. case *events.CallTerminate, *events.CallRelayLatency, *events.CallAccept, *events.UnknownCallEvent:
  620. // ignore
  621. case *events.UndecryptableMessage:
  622. portal := user.GetPortalByMessageSource(v.Info.MessageSource)
  623. portal.messages <- PortalMessage{undecryptable: v, source: user}
  624. case *events.HistorySync:
  625. user.historySyncs <- v
  626. case *events.Mute:
  627. portal := user.GetPortalByJID(v.JID)
  628. if portal != nil {
  629. var mutedUntil time.Time
  630. if v.Action.GetMuted() {
  631. mutedUntil = time.Unix(v.Action.GetMuteEndTimestamp(), 0)
  632. }
  633. go user.updateChatMute(nil, portal, mutedUntil)
  634. }
  635. case *events.Archive:
  636. portal := user.GetPortalByJID(v.JID)
  637. if portal != nil {
  638. go user.updateChatTag(nil, portal, user.bridge.Config.Bridge.ArchiveTag, v.Action.GetArchived())
  639. }
  640. case *events.Pin:
  641. portal := user.GetPortalByJID(v.JID)
  642. if portal != nil {
  643. go user.updateChatTag(nil, portal, user.bridge.Config.Bridge.PinnedTag, v.Action.GetPinned())
  644. }
  645. case *events.AppState:
  646. // Ignore
  647. default:
  648. user.log.Debugfln("Unknown type of event in HandleEvent: %T", v)
  649. }
  650. }
  651. func (user *User) updateChatMute(intent *appservice.IntentAPI, portal *Portal, mutedUntil time.Time) {
  652. if len(portal.MXID) == 0 || !user.bridge.Config.Bridge.MuteBridging {
  653. return
  654. } else if intent == nil {
  655. doublePuppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  656. if doublePuppet == nil || doublePuppet.CustomIntent() == nil {
  657. return
  658. }
  659. intent = doublePuppet.CustomIntent()
  660. }
  661. var err error
  662. if mutedUntil.IsZero() && mutedUntil.Before(time.Now()) {
  663. user.log.Debugfln("Portal %s is muted until %s, unmuting...", portal.MXID, mutedUntil)
  664. err = intent.DeletePushRule("global", pushrules.RoomRule, string(portal.MXID))
  665. } else {
  666. user.log.Debugfln("Portal %s is muted until %s, muting...", portal.MXID, mutedUntil)
  667. err = intent.PutPushRule("global", pushrules.RoomRule, string(portal.MXID), &mautrix.ReqPutPushRule{
  668. Actions: []pushrules.PushActionType{pushrules.ActionDontNotify},
  669. })
  670. }
  671. if err != nil && !errors.Is(err, mautrix.MNotFound) {
  672. user.log.Warnfln("Failed to update push rule for %s through double puppet: %v", portal.MXID, err)
  673. }
  674. }
  675. type CustomTagData struct {
  676. Order json.Number `json:"order"`
  677. DoublePuppet string `json:"fi.mau.double_puppet_source"`
  678. }
  679. type CustomTagEventContent struct {
  680. Tags map[string]CustomTagData `json:"tags"`
  681. }
  682. func (user *User) updateChatTag(intent *appservice.IntentAPI, portal *Portal, tag string, active bool) {
  683. if len(portal.MXID) == 0 || len(tag) == 0 {
  684. return
  685. } else if intent == nil {
  686. doublePuppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  687. if doublePuppet == nil || doublePuppet.CustomIntent() == nil {
  688. return
  689. }
  690. intent = doublePuppet.CustomIntent()
  691. }
  692. var existingTags CustomTagEventContent
  693. err := intent.GetTagsWithCustomData(portal.MXID, &existingTags)
  694. if err != nil && !errors.Is(err, mautrix.MNotFound) {
  695. user.log.Warnfln("Failed to get tags of %s: %v", portal.MXID, err)
  696. }
  697. currentTag, ok := existingTags.Tags[tag]
  698. if active && !ok {
  699. user.log.Debugln("Adding tag", tag, "to", portal.MXID)
  700. data := CustomTagData{"0.5", doublePuppetValue}
  701. err = intent.AddTagWithCustomData(portal.MXID, tag, &data)
  702. } else if !active && ok && currentTag.DoublePuppet == doublePuppetValue {
  703. user.log.Debugln("Removing tag", tag, "from", portal.MXID)
  704. err = intent.RemoveTag(portal.MXID, tag)
  705. } else {
  706. err = nil
  707. }
  708. if err != nil {
  709. user.log.Warnfln("Failed to update tag %s for %s through double puppet: %v", tag, portal.MXID, err)
  710. }
  711. }
  712. type CustomReadReceipt struct {
  713. Timestamp int64 `json:"ts,omitempty"`
  714. DoublePuppetSource string `json:"fi.mau.double_puppet_source,omitempty"`
  715. }
  716. type CustomReadMarkers struct {
  717. mautrix.ReqSetReadMarkers
  718. ReadExtra CustomReadReceipt `json:"com.beeper.read.extra"`
  719. FullyReadExtra CustomReadReceipt `json:"com.beeper.fully_read.extra"`
  720. }
  721. func (user *User) syncChatDoublePuppetDetails(portal *Portal, justCreated bool) {
  722. doublePuppet := portal.bridge.GetPuppetByCustomMXID(user.MXID)
  723. if doublePuppet == nil {
  724. return
  725. }
  726. if doublePuppet == nil || doublePuppet.CustomIntent() == nil || len(portal.MXID) == 0 {
  727. return
  728. }
  729. if justCreated || !user.bridge.Config.Bridge.TagOnlyOnCreate {
  730. chat, err := user.Client.Store.ChatSettings.GetChatSettings(portal.Key.JID)
  731. if err != nil {
  732. user.log.Warnfln("Failed to get settings of %s: %v", portal.Key.JID, err)
  733. return
  734. }
  735. intent := doublePuppet.CustomIntent()
  736. if portal.Key.JID == types.StatusBroadcastJID && justCreated && user.bridge.Config.Bridge.MuteStatusBroadcast {
  737. user.updateChatMute(intent, portal, time.Now().Add(365*24*time.Hour))
  738. user.updateChatTag(intent, portal, user.bridge.Config.Bridge.ArchiveTag, true)
  739. return
  740. } else if !chat.Found {
  741. return
  742. }
  743. user.updateChatMute(intent, portal, chat.MutedUntil)
  744. user.updateChatTag(intent, portal, user.bridge.Config.Bridge.ArchiveTag, chat.Archived)
  745. user.updateChatTag(intent, portal, user.bridge.Config.Bridge.PinnedTag, chat.Pinned)
  746. }
  747. }
  748. func (user *User) getDirectChats() map[id.UserID][]id.RoomID {
  749. res := make(map[id.UserID][]id.RoomID)
  750. privateChats := user.bridge.DB.Portal.FindPrivateChats(user.JID.ToNonAD())
  751. for _, portal := range privateChats {
  752. if len(portal.MXID) > 0 {
  753. res[user.bridge.FormatPuppetMXID(portal.Key.JID)] = []id.RoomID{portal.MXID}
  754. }
  755. }
  756. return res
  757. }
  758. func (user *User) UpdateDirectChats(chats map[id.UserID][]id.RoomID) {
  759. if !user.bridge.Config.Bridge.SyncDirectChatList {
  760. return
  761. }
  762. puppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  763. if puppet == nil || puppet.CustomIntent() == nil {
  764. return
  765. }
  766. intent := puppet.CustomIntent()
  767. method := http.MethodPatch
  768. if chats == nil {
  769. chats = user.getDirectChats()
  770. method = http.MethodPut
  771. }
  772. user.log.Debugln("Updating m.direct list on homeserver")
  773. var err error
  774. if user.bridge.Config.Homeserver.Asmux {
  775. urlPath := intent.BuildBaseURL("_matrix", "client", "unstable", "com.beeper.asmux", "dms")
  776. _, err = intent.MakeFullRequest(mautrix.FullRequest{
  777. Method: method,
  778. URL: urlPath,
  779. Headers: http.Header{"X-Asmux-Auth": {user.bridge.AS.Registration.AppToken}},
  780. RequestJSON: chats,
  781. })
  782. } else {
  783. existingChats := make(map[id.UserID][]id.RoomID)
  784. err = intent.GetAccountData(event.AccountDataDirectChats.Type, &existingChats)
  785. if err != nil {
  786. user.log.Warnln("Failed to get m.direct list to update it:", err)
  787. return
  788. }
  789. for userID, rooms := range existingChats {
  790. if _, ok := user.bridge.ParsePuppetMXID(userID); !ok {
  791. // This is not a ghost user, include it in the new list
  792. chats[userID] = rooms
  793. } else if _, ok := chats[userID]; !ok && method == http.MethodPatch {
  794. // This is a ghost user, but we're not replacing the whole list, so include it too
  795. chats[userID] = rooms
  796. }
  797. }
  798. err = intent.SetAccountData(event.AccountDataDirectChats.Type, &chats)
  799. }
  800. if err != nil {
  801. user.log.Warnln("Failed to update m.direct list:", err)
  802. }
  803. }
  804. func (user *User) handleLoggedOut(onConnect bool, reason events.ConnectFailureReason) {
  805. user.sendBridgeState(BridgeState{StateEvent: StateBadCredentials, Error: WALoggedOut, Message: reason.String()})
  806. user.JID = types.EmptyJID
  807. user.Update()
  808. if onConnect {
  809. user.sendMarkdownBridgeAlert("Connecting to WhatsApp failed as the device was unlinked (error %s). Please link the bridge to your phone again.", reason)
  810. } else {
  811. user.sendMarkdownBridgeAlert("You were logged out from another device. Please link the bridge to your phone again.")
  812. }
  813. }
  814. func (user *User) GetPortalByMessageSource(ms types.MessageSource) *Portal {
  815. jid := ms.Chat
  816. if ms.IsIncomingBroadcast() {
  817. if ms.IsFromMe {
  818. jid = ms.BroadcastListOwner.ToNonAD()
  819. } else {
  820. jid = ms.Sender.ToNonAD()
  821. }
  822. if jid.IsEmpty() {
  823. return nil
  824. }
  825. }
  826. return user.bridge.GetPortalByJID(database.NewPortalKey(jid, user.JID))
  827. }
  828. func (user *User) GetPortalByJID(jid types.JID) *Portal {
  829. return user.bridge.GetPortalByJID(database.NewPortalKey(jid, user.JID))
  830. }
  831. func (user *User) syncPuppet(jid types.JID, reason string) {
  832. user.bridge.GetPuppetByJID(jid).SyncContact(user, false, reason)
  833. }
  834. func (user *User) ResyncContacts() error {
  835. contacts, err := user.Client.Store.Contacts.GetAllContacts()
  836. if err != nil {
  837. return fmt.Errorf("failed to get cached contacts: %w", err)
  838. }
  839. user.log.Infofln("Resyncing displaynames with %d contacts", len(contacts))
  840. for jid, contact := range contacts {
  841. puppet := user.bridge.GetPuppetByJID(jid)
  842. if puppet != nil {
  843. puppet.Sync(user, contact)
  844. } else {
  845. user.log.Warnfln("Got a nil puppet for %s while syncing contacts", jid)
  846. }
  847. }
  848. return nil
  849. }
  850. func (user *User) ResyncGroups(createPortals bool) error {
  851. groups, err := user.Client.GetJoinedGroups()
  852. if err != nil {
  853. return fmt.Errorf("failed to get group list from server: %w", err)
  854. }
  855. for _, group := range groups {
  856. portal := user.GetPortalByJID(group.JID)
  857. if len(portal.MXID) == 0 {
  858. if createPortals {
  859. err = portal.CreateMatrixRoom(user, group, true)
  860. if err != nil {
  861. return fmt.Errorf("failed to create room for %s: %w", group.JID, err)
  862. }
  863. }
  864. } else {
  865. portal.UpdateMatrixRoom(user, group)
  866. }
  867. }
  868. return nil
  869. }
  870. const WATypingTimeout = 15 * time.Second
  871. func (user *User) handleChatPresence(presence *events.ChatPresence) {
  872. puppet := user.bridge.GetPuppetByJID(presence.Sender)
  873. portal := user.GetPortalByJID(presence.Chat)
  874. if puppet == nil || portal == nil || len(portal.MXID) == 0 {
  875. return
  876. }
  877. if presence.State == types.ChatPresenceComposing {
  878. if puppet.typingIn != "" && puppet.typingAt.Add(WATypingTimeout).Before(time.Now()) {
  879. if puppet.typingIn == portal.MXID {
  880. return
  881. }
  882. _, _ = puppet.IntentFor(portal).UserTyping(puppet.typingIn, false, 0)
  883. }
  884. _, _ = puppet.IntentFor(portal).UserTyping(portal.MXID, true, WATypingTimeout.Milliseconds())
  885. puppet.typingIn = portal.MXID
  886. puppet.typingAt = time.Now()
  887. } else {
  888. _, _ = puppet.IntentFor(portal).UserTyping(portal.MXID, false, 0)
  889. puppet.typingIn = ""
  890. }
  891. }
  892. func (user *User) handleReceipt(receipt *events.Receipt) {
  893. if receipt.Type != events.ReceiptTypeRead && receipt.Type != events.ReceiptTypeReadSelf {
  894. return
  895. }
  896. portal := user.GetPortalByMessageSource(receipt.MessageSource)
  897. if portal == nil || len(portal.MXID) == 0 {
  898. return
  899. }
  900. portal.receipts <- PortalReceipt{evt: receipt, source: user}
  901. }
  902. func makeReadMarkerContent(eventID id.EventID, doublePuppet bool) CustomReadMarkers {
  903. var extra CustomReadReceipt
  904. if doublePuppet {
  905. extra.DoublePuppetSource = doublePuppetValue
  906. }
  907. return CustomReadMarkers{
  908. ReqSetReadMarkers: mautrix.ReqSetReadMarkers{
  909. Read: eventID,
  910. FullyRead: eventID,
  911. },
  912. ReadExtra: extra,
  913. FullyReadExtra: extra,
  914. }
  915. }
  916. func (user *User) markSelfReadFull(portal *Portal) {
  917. puppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  918. if puppet == nil || puppet.CustomIntent() == nil {
  919. return
  920. }
  921. lastMessage := user.bridge.DB.Message.GetLastInChat(portal.Key)
  922. if lastMessage == nil {
  923. return
  924. }
  925. user.SetLastReadTS(portal.Key, lastMessage.Timestamp)
  926. err := puppet.CustomIntent().SetReadMarkers(portal.MXID, makeReadMarkerContent(lastMessage.MXID, true))
  927. if err != nil {
  928. user.log.Warnfln("Failed to mark %s (last message) in %s as read: %v", lastMessage.MXID, portal.MXID, err)
  929. } else {
  930. user.log.Debugfln("Marked %s (last message) in %s as read", lastMessage.MXID, portal.MXID)
  931. }
  932. }
  933. func (user *User) handleGroupCreate(evt *events.JoinedGroup) {
  934. portal := user.GetPortalByJID(evt.JID)
  935. if len(portal.MXID) == 0 {
  936. err := portal.CreateMatrixRoom(user, &evt.GroupInfo, true)
  937. if err != nil {
  938. user.log.Errorln("Failed to create Matrix room after join notification: %v", err)
  939. }
  940. } else {
  941. portal.UpdateMatrixRoom(user, &evt.GroupInfo)
  942. }
  943. }
  944. func (user *User) handleGroupUpdate(evt *events.GroupInfo) {
  945. portal := user.GetPortalByJID(evt.JID)
  946. if portal == nil || len(portal.MXID) == 0 {
  947. user.log.Debugfln("Ignoring group info update in chat with no portal: %+v", evt)
  948. return
  949. }
  950. switch {
  951. case evt.Announce != nil:
  952. portal.RestrictMessageSending(evt.Announce.IsAnnounce)
  953. case evt.Locked != nil:
  954. portal.RestrictMetadataChanges(evt.Locked.IsLocked)
  955. case evt.Name != nil:
  956. portal.UpdateName(evt.Name.Name, evt.Name.NameSetBy, true)
  957. case evt.Topic != nil:
  958. portal.UpdateTopic(evt.Topic.Topic, evt.Topic.TopicSetBy, true)
  959. case evt.Leave != nil:
  960. if evt.Sender != nil && !evt.Sender.IsEmpty() {
  961. portal.HandleWhatsAppKick(user, *evt.Sender, evt.Leave)
  962. }
  963. case evt.Join != nil:
  964. portal.HandleWhatsAppInvite(user, evt.Sender, evt.Join)
  965. case evt.Promote != nil:
  966. portal.ChangeAdminStatus(evt.Promote, true)
  967. case evt.Demote != nil:
  968. portal.ChangeAdminStatus(evt.Demote, false)
  969. case evt.Ephemeral != nil:
  970. portal.UpdateGroupDisappearingMessages(evt.Sender, evt.Timestamp, evt.Ephemeral.DisappearingTimer)
  971. }
  972. }
  973. func (user *User) handlePictureUpdate(evt *events.Picture) {
  974. if evt.JID.Server == types.DefaultUserServer {
  975. puppet := user.bridge.GetPuppetByJID(evt.JID)
  976. user.log.Debugfln("Received picture update for puppet %s (current: %s, new: %s)", evt.JID, puppet.Avatar, evt.PictureID)
  977. if puppet.Avatar != evt.PictureID {
  978. puppet.UpdateAvatar(user)
  979. }
  980. } else if portal := user.GetPortalByJID(evt.JID); portal != nil {
  981. user.log.Debugfln("Received picture update for portal %s (current: %s, new: %s)", evt.JID, portal.Avatar, evt.PictureID)
  982. if portal.Avatar != evt.PictureID {
  983. portal.UpdateAvatar(user, evt.Author, true)
  984. }
  985. }
  986. }
  987. func (user *User) StartPM(jid types.JID, reason string) (*Portal, *Puppet, bool, error) {
  988. user.log.Debugln("Starting PM with", jid, "from", reason)
  989. puppet := user.bridge.GetPuppetByJID(jid)
  990. puppet.SyncContact(user, true, reason)
  991. portal := user.GetPortalByJID(puppet.JID)
  992. if len(portal.MXID) > 0 {
  993. ok := portal.ensureUserInvited(user)
  994. if !ok {
  995. portal.log.Warnfln("ensureUserInvited(%s) returned false, creating new portal", user.MXID)
  996. portal.MXID = ""
  997. } else {
  998. return portal, puppet, false, nil
  999. }
  1000. }
  1001. err := portal.CreateMatrixRoom(user, nil, false)
  1002. return portal, puppet, true, err
  1003. }