user.go 30 KB

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