user.go 27 KB

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