user.go 30 KB

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