user.go 32 KB

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