user.go 28 KB

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