user.go 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838
  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. "sync"
  24. "time"
  25. log "maunium.net/go/maulogger/v2"
  26. "go.mau.fi/whatsmeow/appstate"
  27. waProto "go.mau.fi/whatsmeow/binary/proto"
  28. "maunium.net/go/mautrix/appservice"
  29. "maunium.net/go/mautrix/pushrules"
  30. "go.mau.fi/whatsmeow"
  31. "go.mau.fi/whatsmeow/store"
  32. "go.mau.fi/whatsmeow/types"
  33. "go.mau.fi/whatsmeow/types/events"
  34. waLog "go.mau.fi/whatsmeow/util/log"
  35. "maunium.net/go/mautrix"
  36. "maunium.net/go/mautrix/event"
  37. "maunium.net/go/mautrix/format"
  38. "maunium.net/go/mautrix/id"
  39. "maunium.net/go/mautrix-whatsapp/database"
  40. )
  41. type User struct {
  42. *database.User
  43. Client *whatsmeow.Client
  44. Session *store.Device
  45. bridge *Bridge
  46. log log.Logger
  47. Admin bool
  48. Whitelisted bool
  49. RelayWhitelisted bool
  50. mgmtCreateLock sync.Mutex
  51. connLock sync.Mutex
  52. historySyncs chan *events.HistorySync
  53. prevBridgeStatus *BridgeState
  54. }
  55. func (bridge *Bridge) GetUserByMXID(userID id.UserID) *User {
  56. _, isPuppet := bridge.ParsePuppetMXID(userID)
  57. if isPuppet || userID == bridge.Bot.UserID {
  58. return nil
  59. }
  60. bridge.usersLock.Lock()
  61. defer bridge.usersLock.Unlock()
  62. user, ok := bridge.usersByMXID[userID]
  63. if !ok {
  64. return bridge.loadDBUser(bridge.DB.User.GetByMXID(userID), &userID)
  65. }
  66. return user
  67. }
  68. func (bridge *Bridge) GetUserByJID(jid types.JID) *User {
  69. bridge.usersLock.Lock()
  70. defer bridge.usersLock.Unlock()
  71. user, ok := bridge.usersByUsername[jid.User]
  72. if !ok {
  73. return bridge.loadDBUser(bridge.DB.User.GetByUsername(jid.User), nil)
  74. }
  75. return user
  76. }
  77. func (user *User) addToJIDMap() {
  78. user.bridge.usersLock.Lock()
  79. user.bridge.usersByUsername[user.JID.User] = user
  80. user.bridge.usersLock.Unlock()
  81. }
  82. func (user *User) removeFromJIDMap(state BridgeStateEvent) {
  83. user.bridge.usersLock.Lock()
  84. jidUser, ok := user.bridge.usersByUsername[user.JID.User]
  85. if ok && user == jidUser {
  86. delete(user.bridge.usersByUsername, user.JID.User)
  87. }
  88. user.bridge.usersLock.Unlock()
  89. user.bridge.Metrics.TrackLoginState(user.JID, false)
  90. user.sendBridgeState(BridgeState{StateEvent: state, Error: WANotLoggedIn})
  91. }
  92. func (bridge *Bridge) GetAllUsers() []*User {
  93. bridge.usersLock.Lock()
  94. defer bridge.usersLock.Unlock()
  95. dbUsers := bridge.DB.User.GetAll()
  96. output := make([]*User, len(dbUsers))
  97. for index, dbUser := range dbUsers {
  98. user, ok := bridge.usersByMXID[dbUser.MXID]
  99. if !ok {
  100. user = bridge.loadDBUser(dbUser, nil)
  101. }
  102. output[index] = user
  103. }
  104. return output
  105. }
  106. func (bridge *Bridge) loadDBUser(dbUser *database.User, mxid *id.UserID) *User {
  107. if dbUser == nil {
  108. if mxid == nil {
  109. return nil
  110. }
  111. dbUser = bridge.DB.User.New()
  112. dbUser.MXID = *mxid
  113. dbUser.Insert()
  114. }
  115. user := bridge.NewUser(dbUser)
  116. bridge.usersByMXID[user.MXID] = user
  117. if !user.JID.IsEmpty() {
  118. var err error
  119. user.Session, err = bridge.WAContainer.GetDevice(user.JID)
  120. if err != nil {
  121. user.log.Errorfln("Failed to load user's whatsapp session: %v", err)
  122. } else if user.Session == nil {
  123. user.log.Warnfln("Didn't find session data for %s, treating user as logged out", user.JID)
  124. user.JID = types.EmptyJID
  125. user.Update()
  126. } else {
  127. bridge.usersByUsername[user.JID.User] = user
  128. }
  129. }
  130. if len(user.ManagementRoom) > 0 {
  131. bridge.managementRooms[user.ManagementRoom] = user
  132. }
  133. return user
  134. }
  135. func (bridge *Bridge) NewUser(dbUser *database.User) *User {
  136. user := &User{
  137. User: dbUser,
  138. bridge: bridge,
  139. log: bridge.Log.Sub("User").Sub(string(dbUser.MXID)),
  140. historySyncs: make(chan *events.HistorySync, 32),
  141. }
  142. user.RelayWhitelisted = user.bridge.Config.Bridge.Permissions.IsRelayWhitelisted(user.MXID)
  143. user.Whitelisted = user.bridge.Config.Bridge.Permissions.IsWhitelisted(user.MXID)
  144. user.Admin = user.bridge.Config.Bridge.Permissions.IsAdmin(user.MXID)
  145. go func() {
  146. for evt := range user.historySyncs {
  147. if evt == nil {
  148. return
  149. }
  150. user.handleHistorySync(evt.Data)
  151. }
  152. }()
  153. return user
  154. }
  155. func (user *User) GetManagementRoom() id.RoomID {
  156. if len(user.ManagementRoom) == 0 {
  157. user.mgmtCreateLock.Lock()
  158. defer user.mgmtCreateLock.Unlock()
  159. if len(user.ManagementRoom) > 0 {
  160. return user.ManagementRoom
  161. }
  162. creationContent := make(map[string]interface{})
  163. if !user.bridge.Config.Bridge.FederateRooms {
  164. creationContent["m.federate"] = false
  165. }
  166. resp, err := user.bridge.Bot.CreateRoom(&mautrix.ReqCreateRoom{
  167. Topic: "WhatsApp bridge notices",
  168. IsDirect: true,
  169. CreationContent: creationContent,
  170. })
  171. if err != nil {
  172. user.log.Errorln("Failed to auto-create management room:", err)
  173. } else {
  174. user.SetManagementRoom(resp.RoomID)
  175. }
  176. }
  177. return user.ManagementRoom
  178. }
  179. func (user *User) SetManagementRoom(roomID id.RoomID) {
  180. existingUser, ok := user.bridge.managementRooms[roomID]
  181. if ok {
  182. existingUser.ManagementRoom = ""
  183. existingUser.Update()
  184. }
  185. user.ManagementRoom = roomID
  186. user.bridge.managementRooms[user.ManagementRoom] = user
  187. user.Update()
  188. }
  189. type waLogger struct{ l log.Logger }
  190. func (w *waLogger) Debugf(msg string, args ...interface{}) { w.l.Debugfln(msg, args...) }
  191. func (w *waLogger) Infof(msg string, args ...interface{}) { w.l.Infofln(msg, args...) }
  192. func (w *waLogger) Warnf(msg string, args ...interface{}) { w.l.Warnfln(msg, args...) }
  193. func (w *waLogger) Errorf(msg string, args ...interface{}) { w.l.Errorfln(msg, args...) }
  194. func (w *waLogger) Sub(module string) waLog.Logger { return &waLogger{l: w.l.Sub(module)} }
  195. var ErrAlreadyLoggedIn = errors.New("already logged in")
  196. func (user *User) Login(ctx context.Context) (<-chan whatsmeow.QRChannelItem, error) {
  197. user.connLock.Lock()
  198. defer user.connLock.Unlock()
  199. if user.Session != nil {
  200. return nil, ErrAlreadyLoggedIn
  201. } else if user.Client != nil {
  202. user.unlockedDeleteConnection()
  203. }
  204. newSession := user.bridge.WAContainer.NewDevice()
  205. newSession.Log = &waLogger{user.log.Sub("Session")}
  206. user.Client = whatsmeow.NewClient(newSession, &waLogger{user.log.Sub("Client")})
  207. user.Client.AddEventHandler(user.HandleEvent)
  208. qrChan, err := user.Client.GetQRChannel(ctx)
  209. if err != nil {
  210. return nil, fmt.Errorf("failed to get QR channel: %w", err)
  211. }
  212. err = user.Client.Connect()
  213. if err != nil {
  214. return nil, fmt.Errorf("failed to connect to WhatsApp: %w", err)
  215. }
  216. return qrChan, nil
  217. }
  218. func (user *User) Connect() bool {
  219. user.connLock.Lock()
  220. defer user.connLock.Unlock()
  221. if user.Client != nil {
  222. return user.Client.IsConnected()
  223. } else if user.Session == nil {
  224. return false
  225. }
  226. user.log.Debugln("Connecting to WhatsApp")
  227. user.sendBridgeState(BridgeState{StateEvent: StateConnecting, Error: WAConnecting})
  228. user.Client = whatsmeow.NewClient(user.Session, &waLogger{user.log.Sub("Client")})
  229. user.Client.AddEventHandler(user.HandleEvent)
  230. err := user.Client.Connect()
  231. if err != nil {
  232. user.log.Warnln("Error connecting to WhatsApp:", err)
  233. return false
  234. }
  235. return true
  236. }
  237. func (user *User) unlockedDeleteConnection() {
  238. if user.Client == nil {
  239. return
  240. }
  241. user.Client.Disconnect()
  242. user.Client.RemoveEventHandlers()
  243. user.Client = nil
  244. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  245. }
  246. func (user *User) DeleteConnection() {
  247. user.connLock.Lock()
  248. defer user.connLock.Unlock()
  249. user.unlockedDeleteConnection()
  250. }
  251. func (user *User) HasSession() bool {
  252. return user.Session != nil
  253. }
  254. func (user *User) DeleteSession() {
  255. if user.Session != nil {
  256. err := user.Session.Delete()
  257. if err != nil {
  258. user.log.Warnln("Failed to delete session:", err)
  259. }
  260. user.Session = nil
  261. }
  262. if !user.JID.IsEmpty() {
  263. user.JID = types.EmptyJID
  264. user.Update()
  265. }
  266. }
  267. func (user *User) IsConnected() bool {
  268. return user.Client != nil && user.Client.IsConnected()
  269. }
  270. func (user *User) IsLoggedIn() bool {
  271. return user.IsConnected() && user.Client.IsLoggedIn
  272. }
  273. func (user *User) tryAutomaticDoublePuppeting() {
  274. if !user.bridge.Config.CanDoublePuppet(user.MXID) {
  275. return
  276. }
  277. user.log.Debugln("Checking if double puppeting needs to be enabled")
  278. puppet := user.bridge.GetPuppetByJID(user.JID)
  279. if len(puppet.CustomMXID) > 0 {
  280. user.log.Debugln("User already has double-puppeting enabled")
  281. // Custom puppet already enabled
  282. return
  283. }
  284. accessToken, err := puppet.loginWithSharedSecret(user.MXID)
  285. if err != nil {
  286. user.log.Warnln("Failed to login with shared secret:", err)
  287. return
  288. }
  289. err = puppet.SwitchCustomMXID(accessToken, user.MXID)
  290. if err != nil {
  291. puppet.log.Warnln("Failed to switch to auto-logined custom puppet:", err)
  292. return
  293. }
  294. user.log.Infoln("Successfully automatically enabled custom puppet")
  295. }
  296. func (user *User) sendBridgeNotice(formatString string, args ...interface{}) {
  297. notice := fmt.Sprintf(formatString, args...)
  298. _, err := user.bridge.Bot.SendNotice(user.GetManagementRoom(), notice)
  299. if err != nil {
  300. user.log.Warnf("Failed to send bridge notice \"%s\": %v", notice, err)
  301. }
  302. }
  303. func (user *User) sendMarkdownBridgeAlert(formatString string, args ...interface{}) {
  304. notice := fmt.Sprintf(formatString, args...)
  305. content := format.RenderMarkdown(notice, true, false)
  306. _, err := user.bridge.Bot.SendMessageEvent(user.GetManagementRoom(), event.EventMessage, content)
  307. if err != nil {
  308. user.log.Warnf("Failed to send bridge alert \"%s\": %v", notice, err)
  309. }
  310. }
  311. func containsSupportedMessages(conv *waProto.Conversation) bool {
  312. for _, msg := range conv.GetMessages() {
  313. if containsSupportedMessage(msg.GetMessage().GetMessage()) {
  314. return true
  315. }
  316. }
  317. return false
  318. }
  319. type portalToBackfill struct {
  320. portal *Portal
  321. conv *waProto.Conversation
  322. }
  323. func (user *User) handleHistorySync(evt *waProto.HistorySync) {
  324. if evt.GetSyncType() != waProto.HistorySync_RECENT && evt.GetSyncType() != waProto.HistorySync_FULL {
  325. return
  326. }
  327. user.log.Infofln("Handling history sync with type %s, chunk order %d, progress %d%%", evt.GetSyncType(), evt.GetChunkOrder(), evt.GetProgress())
  328. maxAge := user.bridge.Config.Bridge.HistorySync.MaxAge
  329. minLastMsgToCreate := time.Now().Add(-time.Duration(maxAge) * time.Second)
  330. createRooms := user.bridge.Config.Bridge.HistorySync.CreatePortals
  331. portalsToBackfill := make([]portalToBackfill, 0)
  332. for _, conv := range evt.GetConversations() {
  333. jid, err := types.ParseJID(conv.GetId())
  334. if err != nil {
  335. user.log.Warnfln("Failed to parse chat JID '%s' in history sync: %v", conv.GetId(), err)
  336. continue
  337. }
  338. muteEnd := time.Unix(int64(conv.GetMuteEndTime()), 0)
  339. if muteEnd.After(time.Now()) {
  340. _ = user.Client.Store.ChatSettings.PutMutedUntil(jid, muteEnd)
  341. }
  342. if conv.GetArchived() {
  343. _ = user.Client.Store.ChatSettings.PutArchived(jid, true)
  344. }
  345. if conv.GetPinned() > 0 {
  346. _ = user.Client.Store.ChatSettings.PutPinned(jid, true)
  347. }
  348. lastMsg := time.Unix(int64(conv.GetConversationTimestamp()), 0)
  349. portal := user.GetPortalByJID(jid)
  350. if createRooms && len(portal.MXID) == 0 {
  351. if !containsSupportedMessages(conv) {
  352. user.log.Debugfln("Not creating portal for %s: no interesting messages found", portal.Key.JID)
  353. continue
  354. } else if maxAge > 0 && !lastMsg.After(minLastMsgToCreate) {
  355. user.log.Debugfln("Not creating portal for %s: last message older than limit (%s)", portal.Key.JID, lastMsg)
  356. continue
  357. }
  358. user.log.Debugln("Creating portal for", portal.Key.JID, "as part of history sync handling")
  359. err = portal.CreateMatrixRoom(user, nil)
  360. if err != nil {
  361. user.log.Warnfln("Failed to create room for %s during backfill: %v", portal.Key.JID, err)
  362. continue
  363. }
  364. }
  365. if len(portal.MXID) == 0 {
  366. user.log.Debugln("No room created, not bridging history sync payload for", portal.Key.JID)
  367. } else if !user.bridge.Config.Bridge.HistorySync.Backfill {
  368. user.log.Debugln("Backfill is disabled, not bridging history sync payload for", portal.Key.JID)
  369. } else {
  370. portalsToBackfill = append(portalsToBackfill, portalToBackfill{portal, conv})
  371. }
  372. }
  373. for _, ptb := range portalsToBackfill {
  374. user.log.Debugln("Bridging history sync payload for", ptb.portal.Key.JID)
  375. ptb.portal.backfill(user, ptb.conv.GetMessages())
  376. if !ptb.conv.GetMarkedAsUnread() && ptb.conv.GetUnreadCount() == 0 {
  377. user.markSelfReadFull(ptb.portal)
  378. }
  379. }
  380. user.log.Infofln("Finished handling history sync with type %s, chunk order %d, progress %d%%", evt.GetSyncType(), evt.GetChunkOrder(), evt.GetProgress())
  381. }
  382. func (user *User) HandleEvent(event interface{}) {
  383. switch v := event.(type) {
  384. case *events.LoggedOut:
  385. go user.handleLoggedOut(v.OnConnect)
  386. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  387. user.bridge.Metrics.TrackLoginState(user.JID, false)
  388. case *events.Connected:
  389. go user.sendBridgeState(BridgeState{StateEvent: StateConnected})
  390. user.bridge.Metrics.TrackConnectionState(user.JID, true)
  391. user.bridge.Metrics.TrackLoginState(user.JID, true)
  392. go func() {
  393. err := user.Client.SendPresence(types.PresenceUnavailable)
  394. if err != nil {
  395. user.log.Warnln("Failed to send initial presence:", err)
  396. }
  397. }()
  398. go user.tryAutomaticDoublePuppeting()
  399. case *events.AppStateSyncComplete:
  400. if len(user.Client.Store.PushName) > 0 && v.Name == appstate.WAPatchCriticalBlock {
  401. err := user.Client.SendPresence(types.PresenceUnavailable)
  402. if err != nil {
  403. user.log.Warnln("Failed to send presence after app state sync:", err)
  404. }
  405. }
  406. case *events.PushNameSetting:
  407. // Send presence available when connecting and when the pushname is changed.
  408. // This makes sure that outgoing messages always have the right pushname.
  409. err := user.Client.SendPresence(types.PresenceUnavailable)
  410. if err != nil {
  411. user.log.Warnln("Failed to send presence after push name update:", err)
  412. }
  413. case *events.PairSuccess:
  414. user.Session = user.Client.Store
  415. user.JID = v.ID
  416. user.addToJIDMap()
  417. user.Update()
  418. case *events.ConnectFailure, *events.StreamError:
  419. go user.sendBridgeState(BridgeState{StateEvent: StateUnknownError})
  420. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  421. case *events.Disconnected:
  422. go user.sendBridgeState(BridgeState{StateEvent: StateTransientDisconnect})
  423. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  424. case *events.Contact:
  425. go user.syncPuppet(v.JID)
  426. case *events.PushName:
  427. go user.syncPuppet(v.JID)
  428. case *events.GroupInfo:
  429. go user.handleGroupUpdate(v)
  430. case *events.JoinedGroup:
  431. go user.handleGroupCreate(v)
  432. case *events.Picture:
  433. go user.handlePictureUpdate(v)
  434. case *events.Receipt:
  435. go user.handleReceipt(v)
  436. case *events.ChatPresence:
  437. go user.handleChatPresence(v)
  438. case *events.Message:
  439. portal := user.GetPortalByJID(v.Info.Chat)
  440. portal.messages <- PortalMessage{evt: v, source: user}
  441. case *events.UndecryptableMessage:
  442. portal := user.GetPortalByJID(v.Info.Chat)
  443. portal.messages <- PortalMessage{undecryptable: v, source: user}
  444. case *events.HistorySync:
  445. user.historySyncs <- v
  446. case *events.Mute:
  447. portal := user.GetPortalByJID(v.JID)
  448. if portal != nil {
  449. var mutedUntil time.Time
  450. if v.Action.GetMuted() {
  451. mutedUntil = time.Unix(v.Action.GetMuteEndTimestamp(), 0)
  452. }
  453. go user.updateChatMute(nil, portal, mutedUntil)
  454. }
  455. case *events.Archive:
  456. portal := user.GetPortalByJID(v.JID)
  457. if portal != nil {
  458. go user.updateChatTag(nil, portal, user.bridge.Config.Bridge.ArchiveTag, v.Action.GetArchived())
  459. }
  460. case *events.Pin:
  461. portal := user.GetPortalByJID(v.JID)
  462. if portal != nil {
  463. go user.updateChatTag(nil, portal, user.bridge.Config.Bridge.PinnedTag, v.Action.GetPinned())
  464. }
  465. case *events.AppState:
  466. // Ignore
  467. default:
  468. user.log.Debugfln("Unknown type of event in HandleEvent: %T", v)
  469. }
  470. }
  471. func (user *User) updateChatMute(intent *appservice.IntentAPI, portal *Portal, mutedUntil time.Time) {
  472. if len(portal.MXID) == 0 || !user.bridge.Config.Bridge.MuteBridging {
  473. return
  474. } else if intent == nil {
  475. doublePuppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  476. if doublePuppet == nil || doublePuppet.CustomIntent() == nil {
  477. return
  478. }
  479. intent = doublePuppet.CustomIntent()
  480. }
  481. var err error
  482. if mutedUntil.IsZero() && mutedUntil.Before(time.Now()) {
  483. user.log.Debugfln("Portal %s is muted until %d, unmuting...", portal.MXID, mutedUntil)
  484. err = intent.DeletePushRule("global", pushrules.RoomRule, string(portal.MXID))
  485. } else {
  486. user.log.Debugfln("Portal %s is muted until %d, muting...", portal.MXID, mutedUntil)
  487. err = intent.PutPushRule("global", pushrules.RoomRule, string(portal.MXID), &mautrix.ReqPutPushRule{
  488. Actions: []pushrules.PushActionType{pushrules.ActionDontNotify},
  489. })
  490. }
  491. if err != nil && !errors.Is(err, mautrix.MNotFound) {
  492. user.log.Warnfln("Failed to update push rule for %s through double puppet: %v", portal.MXID, err)
  493. }
  494. }
  495. type CustomTagData struct {
  496. Order json.Number `json:"order"`
  497. DoublePuppet bool `json:"net.maunium.whatsapp.puppet"`
  498. }
  499. type CustomTagEventContent struct {
  500. Tags map[string]CustomTagData `json:"tags"`
  501. }
  502. func (user *User) updateChatTag(intent *appservice.IntentAPI, portal *Portal, tag string, active bool) {
  503. if len(portal.MXID) == 0 || len(tag) == 0 {
  504. return
  505. } else if intent == nil {
  506. doublePuppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  507. if doublePuppet == nil || doublePuppet.CustomIntent() == nil {
  508. return
  509. }
  510. intent = doublePuppet.CustomIntent()
  511. }
  512. var existingTags CustomTagEventContent
  513. err := intent.GetTagsWithCustomData(portal.MXID, &existingTags)
  514. if err != nil && !errors.Is(err, mautrix.MNotFound) {
  515. user.log.Warnfln("Failed to get tags of %s: %v", portal.MXID, err)
  516. }
  517. currentTag, ok := existingTags.Tags[tag]
  518. if active && !ok {
  519. user.log.Debugln("Adding tag", tag, "to", portal.MXID)
  520. data := CustomTagData{"0.5", true}
  521. err = intent.AddTagWithCustomData(portal.MXID, tag, &data)
  522. } else if !active && ok && currentTag.DoublePuppet {
  523. user.log.Debugln("Removing tag", tag, "from", portal.MXID)
  524. err = intent.RemoveTag(portal.MXID, tag)
  525. } else {
  526. err = nil
  527. }
  528. if err != nil {
  529. user.log.Warnfln("Failed to update tag %s for %s through double puppet: %v", tag, portal.MXID, err)
  530. }
  531. }
  532. type CustomReadReceipt struct {
  533. Timestamp int64 `json:"ts,omitempty"`
  534. DoublePuppet bool `json:"net.maunium.whatsapp.puppet,omitempty"`
  535. }
  536. func (user *User) syncChatDoublePuppetDetails(portal *Portal, justCreated bool) {
  537. doublePuppet := portal.bridge.GetPuppetByCustomMXID(user.MXID)
  538. if doublePuppet == nil {
  539. return
  540. }
  541. if doublePuppet == nil || doublePuppet.CustomIntent() == nil || len(portal.MXID) == 0 {
  542. return
  543. }
  544. if justCreated || !user.bridge.Config.Bridge.TagOnlyOnCreate {
  545. chat, err := user.Client.Store.ChatSettings.GetChatSettings(portal.Key.JID)
  546. if err != nil {
  547. user.log.Warnfln("Failed to get settings of %s: %v", portal.Key.JID, err)
  548. return
  549. }
  550. intent := doublePuppet.CustomIntent()
  551. user.updateChatMute(intent, portal, chat.MutedUntil)
  552. user.updateChatTag(intent, portal, user.bridge.Config.Bridge.ArchiveTag, chat.Archived)
  553. user.updateChatTag(intent, portal, user.bridge.Config.Bridge.PinnedTag, chat.Pinned)
  554. }
  555. }
  556. func (user *User) getDirectChats() map[id.UserID][]id.RoomID {
  557. res := make(map[id.UserID][]id.RoomID)
  558. privateChats := user.bridge.DB.Portal.FindPrivateChats(user.JID.ToNonAD())
  559. for _, portal := range privateChats {
  560. if len(portal.MXID) > 0 {
  561. res[user.bridge.FormatPuppetMXID(portal.Key.JID)] = []id.RoomID{portal.MXID}
  562. }
  563. }
  564. return res
  565. }
  566. func (user *User) UpdateDirectChats(chats map[id.UserID][]id.RoomID) {
  567. if !user.bridge.Config.Bridge.SyncDirectChatList {
  568. return
  569. }
  570. puppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  571. if puppet == nil || puppet.CustomIntent() == nil {
  572. return
  573. }
  574. intent := puppet.CustomIntent()
  575. method := http.MethodPatch
  576. if chats == nil {
  577. chats = user.getDirectChats()
  578. method = http.MethodPut
  579. }
  580. user.log.Debugln("Updating m.direct list on homeserver")
  581. var err error
  582. if user.bridge.Config.Homeserver.Asmux {
  583. urlPath := intent.BuildBaseURL("_matrix", "client", "unstable", "com.beeper.asmux", "dms")
  584. _, err = intent.MakeFullRequest(mautrix.FullRequest{
  585. Method: method,
  586. URL: urlPath,
  587. Headers: http.Header{"X-Asmux-Auth": {user.bridge.AS.Registration.AppToken}},
  588. RequestJSON: chats,
  589. })
  590. } else {
  591. existingChats := make(map[id.UserID][]id.RoomID)
  592. err = intent.GetAccountData(event.AccountDataDirectChats.Type, &existingChats)
  593. if err != nil {
  594. user.log.Warnln("Failed to get m.direct list to update it:", err)
  595. return
  596. }
  597. for userID, rooms := range existingChats {
  598. if _, ok := user.bridge.ParsePuppetMXID(userID); !ok {
  599. // This is not a ghost user, include it in the new list
  600. chats[userID] = rooms
  601. } else if _, ok := chats[userID]; !ok && method == http.MethodPatch {
  602. // This is a ghost user, but we're not replacing the whole list, so include it too
  603. chats[userID] = rooms
  604. }
  605. }
  606. err = intent.SetAccountData(event.AccountDataDirectChats.Type, &chats)
  607. }
  608. if err != nil {
  609. user.log.Warnln("Failed to update m.direct list:", err)
  610. }
  611. }
  612. func (user *User) handleLoggedOut(onConnect bool) {
  613. user.JID = types.EmptyJID
  614. user.Update()
  615. if onConnect {
  616. user.sendMarkdownBridgeAlert("Connecting to WhatsApp failed as the device was logged out. Please link the bridge to your phone again.")
  617. } else {
  618. user.sendMarkdownBridgeAlert("You were logged out from another device. Please link the bridge to your phone again.")
  619. }
  620. user.sendBridgeState(BridgeState{StateEvent: StateBadCredentials, Error: WANotLoggedIn})
  621. }
  622. func (user *User) GetPortalByJID(jid types.JID) *Portal {
  623. return user.bridge.GetPortalByJID(database.NewPortalKey(jid, user.JID))
  624. }
  625. func (user *User) syncPuppet(jid types.JID) {
  626. user.bridge.GetPuppetByJID(jid).SyncContact(user, false)
  627. }
  628. const WATypingTimeout = 15 * time.Second
  629. func (user *User) handleChatPresence(presence *events.ChatPresence) {
  630. puppet := user.bridge.GetPuppetByJID(presence.Sender)
  631. portal := user.GetPortalByJID(presence.Chat)
  632. if puppet == nil || portal == nil || len(portal.MXID) == 0 {
  633. return
  634. }
  635. if presence.State == types.ChatPresenceComposing {
  636. if puppet.typingIn != "" && puppet.typingAt.Add(WATypingTimeout).Before(time.Now()) {
  637. if puppet.typingIn == portal.MXID {
  638. return
  639. }
  640. _, _ = puppet.IntentFor(portal).UserTyping(puppet.typingIn, false, 0)
  641. }
  642. _, _ = puppet.IntentFor(portal).UserTyping(portal.MXID, true, WATypingTimeout.Milliseconds())
  643. puppet.typingIn = portal.MXID
  644. puppet.typingAt = time.Now()
  645. } else {
  646. _, _ = puppet.IntentFor(portal).UserTyping(portal.MXID, false, 0)
  647. puppet.typingIn = ""
  648. }
  649. }
  650. func (user *User) handleReceipt(receipt *events.Receipt) {
  651. if receipt.Type != events.ReceiptTypeRead {
  652. return
  653. }
  654. portal := user.GetPortalByJID(receipt.Chat)
  655. if portal == nil || len(portal.MXID) == 0 {
  656. return
  657. }
  658. if receipt.IsFromMe {
  659. user.markSelfRead(portal, receipt.MessageID)
  660. } else {
  661. intent := user.bridge.GetPuppetByJID(receipt.Sender).IntentFor(portal)
  662. ok := user.markOtherRead(portal, intent, receipt.MessageID)
  663. if !ok {
  664. // Message not found, try any previous IDs
  665. for i := len(receipt.PreviousIDs) - 1; i >= 0; i-- {
  666. ok = user.markOtherRead(portal, intent, receipt.PreviousIDs[i])
  667. if ok {
  668. break
  669. }
  670. }
  671. }
  672. }
  673. }
  674. func (user *User) markOtherRead(portal *Portal, intent *appservice.IntentAPI, messageID types.MessageID) bool {
  675. msg := user.bridge.DB.Message.GetByJID(portal.Key, messageID)
  676. if msg == nil || msg.IsFakeMXID() {
  677. return false
  678. }
  679. err := intent.MarkReadWithContent(portal.MXID, msg.MXID, &CustomReadReceipt{DoublePuppet: intent.IsCustomPuppet})
  680. if err != nil {
  681. user.log.Warnfln("Failed to mark message %s as read by %s: %v", msg.MXID, intent.UserID, err)
  682. }
  683. return true
  684. }
  685. func (user *User) markSelfRead(portal *Portal, messageID types.MessageID) {
  686. puppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  687. if puppet == nil || puppet.CustomIntent() == nil {
  688. return
  689. }
  690. var message *database.Message
  691. if messageID == "" {
  692. message = user.bridge.DB.Message.GetLastInChat(portal.Key)
  693. if message == nil {
  694. return
  695. }
  696. user.log.Debugfln("User read chat %s/%s in WhatsApp mobile (last known event: %s/%s)", portal.Key.JID, portal.MXID, message.JID, message.MXID)
  697. } else {
  698. message = user.bridge.DB.Message.GetByJID(portal.Key, messageID)
  699. if message == nil || message.IsFakeMXID() {
  700. return
  701. }
  702. user.log.Debugfln("User read message %s/%s in %s/%s in WhatsApp mobile", message.JID, message.MXID, portal.Key.JID, portal.MXID)
  703. }
  704. err := puppet.CustomIntent().MarkReadWithContent(portal.MXID, message.MXID, &CustomReadReceipt{DoublePuppet: true})
  705. if err != nil {
  706. user.log.Warnfln("Failed to bridge own read receipt in %s: %v", portal.Key.JID, err)
  707. }
  708. }
  709. func (user *User) markSelfReadFull(portal *Portal) {
  710. puppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  711. if puppet == nil || puppet.CustomIntent() == nil {
  712. return
  713. }
  714. lastMessage := user.bridge.DB.Message.GetLastInChat(portal.Key)
  715. if lastMessage == nil {
  716. return
  717. }
  718. err := puppet.CustomIntent().MarkReadWithContent(portal.MXID, lastMessage.MXID, &CustomReadReceipt{DoublePuppet: true})
  719. if err != nil {
  720. user.log.Warnfln("Failed to mark %s in %s as read after backfill: %v", lastMessage.MXID, portal.MXID, err)
  721. }
  722. }
  723. func (user *User) handleGroupCreate(evt *events.JoinedGroup) {
  724. portal := user.GetPortalByJID(evt.JID)
  725. if len(portal.MXID) == 0 {
  726. err := portal.CreateMatrixRoom(user, &evt.GroupInfo)
  727. if err != nil {
  728. user.log.Errorln("Failed to create Matrix room after join notification: %v", err)
  729. }
  730. } else {
  731. portal.UpdateMatrixRoom(user, &evt.GroupInfo)
  732. }
  733. }
  734. func (user *User) handleGroupUpdate(evt *events.GroupInfo) {
  735. portal := user.GetPortalByJID(evt.JID)
  736. if portal == nil || len(portal.MXID) == 0 {
  737. user.log.Debugfln("Ignoring group info update in chat with no portal: %+v", evt)
  738. return
  739. }
  740. switch {
  741. case evt.Announce != nil:
  742. portal.RestrictMessageSending(evt.Announce.IsAnnounce)
  743. case evt.Locked != nil:
  744. portal.RestrictMetadataChanges(evt.Locked.IsLocked)
  745. case evt.Name != nil:
  746. portal.UpdateName(evt.Name.Name, evt.Name.NameSetBy, true)
  747. case evt.Topic != nil:
  748. portal.UpdateTopic(evt.Topic.Topic, evt.Topic.TopicSetBy, true)
  749. case evt.Leave != nil:
  750. if evt.Sender != nil && !evt.Sender.IsEmpty() {
  751. portal.HandleWhatsAppKick(user, *evt.Sender, evt.Leave)
  752. }
  753. case evt.Join != nil:
  754. portal.HandleWhatsAppInvite(user, evt.Sender, evt.Join)
  755. case evt.Promote != nil:
  756. portal.ChangeAdminStatus(evt.Promote, true)
  757. case evt.Demote != nil:
  758. portal.ChangeAdminStatus(evt.Demote, false)
  759. }
  760. }
  761. func (user *User) handlePictureUpdate(evt *events.Picture) {
  762. if evt.JID.Server == types.DefaultUserServer {
  763. puppet := user.bridge.GetPuppetByJID(evt.JID)
  764. if puppet.Avatar != evt.PictureID {
  765. puppet.UpdateAvatar(user)
  766. }
  767. } else {
  768. portal := user.GetPortalByJID(evt.JID)
  769. if portal != nil && portal.Avatar != evt.PictureID {
  770. portal.UpdateAvatar(user, evt.Author, true)
  771. }
  772. }
  773. }