user.go 29 KB

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