user.go 30 KB

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