user.go 29 KB

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