user.go 29 KB

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