user.go 44 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351
  1. // mautrix-whatsapp - A Matrix-WhatsApp puppeting bridge.
  2. // Copyright (C) 2022 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. "crypto/hmac"
  20. "crypto/sha256"
  21. "encoding/binary"
  22. "encoding/json"
  23. "errors"
  24. "fmt"
  25. "math"
  26. "math/rand"
  27. "net/http"
  28. "strconv"
  29. "strings"
  30. "sync"
  31. "time"
  32. log "maunium.net/go/maulogger/v2"
  33. "maunium.net/go/mautrix"
  34. "maunium.net/go/mautrix/appservice"
  35. "maunium.net/go/mautrix/bridge"
  36. "maunium.net/go/mautrix/bridge/bridgeconfig"
  37. "maunium.net/go/mautrix/event"
  38. "maunium.net/go/mautrix/format"
  39. "maunium.net/go/mautrix/id"
  40. "maunium.net/go/mautrix/pushrules"
  41. "go.mau.fi/whatsmeow"
  42. "go.mau.fi/whatsmeow/appstate"
  43. waProto "go.mau.fi/whatsmeow/binary/proto"
  44. "go.mau.fi/whatsmeow/store"
  45. "go.mau.fi/whatsmeow/types"
  46. "go.mau.fi/whatsmeow/types/events"
  47. waLog "go.mau.fi/whatsmeow/util/log"
  48. "maunium.net/go/mautrix-whatsapp/database"
  49. )
  50. type User struct {
  51. *database.User
  52. Client *whatsmeow.Client
  53. Session *store.Device
  54. bridge *WABridge
  55. log log.Logger
  56. Admin bool
  57. Whitelisted bool
  58. RelayWhitelisted bool
  59. PermissionLevel bridgeconfig.PermissionLevel
  60. mgmtCreateLock sync.Mutex
  61. spaceCreateLock sync.Mutex
  62. connLock sync.Mutex
  63. historySyncs chan *events.HistorySync
  64. lastPresence types.Presence
  65. historySyncLoopsStarted bool
  66. spaceMembershipChecked bool
  67. lastPhoneOfflineWarning time.Time
  68. groupListCache []*types.GroupInfo
  69. groupListCacheLock sync.Mutex
  70. groupListCacheTime time.Time
  71. BackfillQueue *BackfillQueue
  72. BridgeState *bridge.BridgeStateQueue
  73. resyncQueue map[types.JID]resyncQueueItem
  74. resyncQueueLock sync.Mutex
  75. nextResync time.Time
  76. }
  77. type resyncQueueItem struct {
  78. portal *Portal
  79. puppet *Puppet
  80. }
  81. func (br *WABridge) getUserByMXID(userID id.UserID, onlyIfExists bool) *User {
  82. _, isPuppet := br.ParsePuppetMXID(userID)
  83. if isPuppet || userID == br.Bot.UserID {
  84. return nil
  85. }
  86. br.usersLock.Lock()
  87. defer br.usersLock.Unlock()
  88. user, ok := br.usersByMXID[userID]
  89. if !ok {
  90. userIDPtr := &userID
  91. if onlyIfExists {
  92. userIDPtr = nil
  93. }
  94. return br.loadDBUser(br.DB.User.GetByMXID(userID), userIDPtr)
  95. }
  96. return user
  97. }
  98. func (br *WABridge) GetUserByMXID(userID id.UserID) *User {
  99. return br.getUserByMXID(userID, false)
  100. }
  101. func (br *WABridge) GetIUser(userID id.UserID, create bool) bridge.User {
  102. u := br.getUserByMXID(userID, !create)
  103. if u == nil {
  104. return nil
  105. }
  106. return u
  107. }
  108. func (user *User) GetPermissionLevel() bridgeconfig.PermissionLevel {
  109. return user.PermissionLevel
  110. }
  111. func (user *User) GetManagementRoomID() id.RoomID {
  112. return user.ManagementRoom
  113. }
  114. func (user *User) GetMXID() id.UserID {
  115. return user.MXID
  116. }
  117. func (user *User) GetCommandState() map[string]interface{} {
  118. return nil
  119. }
  120. func (br *WABridge) GetUserByMXIDIfExists(userID id.UserID) *User {
  121. return br.getUserByMXID(userID, true)
  122. }
  123. func (br *WABridge) GetUserByJID(jid types.JID) *User {
  124. br.usersLock.Lock()
  125. defer br.usersLock.Unlock()
  126. user, ok := br.usersByUsername[jid.User]
  127. if !ok {
  128. return br.loadDBUser(br.DB.User.GetByUsername(jid.User), nil)
  129. }
  130. return user
  131. }
  132. func (user *User) addToJIDMap() {
  133. user.bridge.usersLock.Lock()
  134. user.bridge.usersByUsername[user.JID.User] = user
  135. user.bridge.usersLock.Unlock()
  136. }
  137. func (user *User) removeFromJIDMap(state bridge.State) {
  138. user.bridge.usersLock.Lock()
  139. jidUser, ok := user.bridge.usersByUsername[user.JID.User]
  140. if ok && user == jidUser {
  141. delete(user.bridge.usersByUsername, user.JID.User)
  142. }
  143. user.bridge.usersLock.Unlock()
  144. user.bridge.Metrics.TrackLoginState(user.JID, false)
  145. user.BridgeState.Send(state)
  146. }
  147. func (br *WABridge) GetAllUsers() []*User {
  148. br.usersLock.Lock()
  149. defer br.usersLock.Unlock()
  150. dbUsers := br.DB.User.GetAll()
  151. output := make([]*User, len(dbUsers))
  152. for index, dbUser := range dbUsers {
  153. user, ok := br.usersByMXID[dbUser.MXID]
  154. if !ok {
  155. user = br.loadDBUser(dbUser, nil)
  156. }
  157. output[index] = user
  158. }
  159. return output
  160. }
  161. func (br *WABridge) loadDBUser(dbUser *database.User, mxid *id.UserID) *User {
  162. if dbUser == nil {
  163. if mxid == nil {
  164. return nil
  165. }
  166. dbUser = br.DB.User.New()
  167. dbUser.MXID = *mxid
  168. dbUser.Insert()
  169. }
  170. user := br.NewUser(dbUser)
  171. br.usersByMXID[user.MXID] = user
  172. if !user.JID.IsEmpty() {
  173. var err error
  174. user.Session, err = br.WAContainer.GetDevice(user.JID)
  175. if err != nil {
  176. user.log.Errorfln("Failed to load user's whatsapp session: %v", err)
  177. } else if user.Session == nil {
  178. user.log.Warnfln("Didn't find session data for %s, treating user as logged out", user.JID)
  179. user.JID = types.EmptyJID
  180. user.Update()
  181. } else {
  182. user.Session.Log = &waLogger{user.log.Sub("Session")}
  183. br.usersByUsername[user.JID.User] = user
  184. }
  185. }
  186. if len(user.ManagementRoom) > 0 {
  187. br.managementRooms[user.ManagementRoom] = user
  188. }
  189. return user
  190. }
  191. func (br *WABridge) NewUser(dbUser *database.User) *User {
  192. user := &User{
  193. User: dbUser,
  194. bridge: br,
  195. log: br.Log.Sub("User").Sub(string(dbUser.MXID)),
  196. historySyncs: make(chan *events.HistorySync, 32),
  197. lastPresence: types.PresenceUnavailable,
  198. resyncQueue: make(map[types.JID]resyncQueueItem),
  199. }
  200. user.PermissionLevel = user.bridge.Config.Bridge.Permissions.Get(user.MXID)
  201. user.RelayWhitelisted = user.PermissionLevel >= bridgeconfig.PermissionLevelRelay
  202. user.Whitelisted = user.PermissionLevel >= bridgeconfig.PermissionLevelUser
  203. user.Admin = user.PermissionLevel >= bridgeconfig.PermissionLevelAdmin
  204. user.BridgeState = br.NewBridgeStateQueue(user, user.log)
  205. go user.puppetResyncLoop()
  206. return user
  207. }
  208. const resyncMinInterval = 7 * 24 * time.Hour
  209. const resyncLoopInterval = 4 * time.Hour
  210. func (user *User) puppetResyncLoop() {
  211. user.nextResync = time.Now().Add(resyncLoopInterval).Add(-time.Duration(rand.Intn(3600)) * time.Second)
  212. for {
  213. time.Sleep(user.nextResync.Sub(time.Now()))
  214. user.nextResync = time.Now().Add(resyncLoopInterval)
  215. user.doPuppetResync()
  216. }
  217. }
  218. func (user *User) EnqueuePuppetResync(puppet *Puppet) {
  219. if puppet.LastSync.Add(resyncMinInterval).After(time.Now()) {
  220. return
  221. }
  222. user.resyncQueueLock.Lock()
  223. if _, exists := user.resyncQueue[puppet.JID]; !exists {
  224. user.resyncQueue[puppet.JID] = resyncQueueItem{puppet: puppet}
  225. user.log.Debugfln("Enqueued resync for %s (next sync in %s)", puppet.JID, user.nextResync.Sub(time.Now()))
  226. }
  227. user.resyncQueueLock.Unlock()
  228. }
  229. func (user *User) EnqueuePortalResync(portal *Portal) {
  230. if portal.IsPrivateChat() || portal.LastSync.Add(resyncMinInterval).After(time.Now()) {
  231. return
  232. }
  233. user.resyncQueueLock.Lock()
  234. if _, exists := user.resyncQueue[portal.Key.JID]; !exists {
  235. user.resyncQueue[portal.Key.JID] = resyncQueueItem{portal: portal}
  236. user.log.Debugfln("Enqueued resync for %s (next sync in %s)", portal.Key.JID, user.nextResync.Sub(time.Now()))
  237. }
  238. user.resyncQueueLock.Unlock()
  239. }
  240. func (user *User) doPuppetResync() {
  241. if !user.IsLoggedIn() {
  242. return
  243. }
  244. user.resyncQueueLock.Lock()
  245. if len(user.resyncQueue) == 0 {
  246. user.resyncQueueLock.Unlock()
  247. return
  248. }
  249. queue := user.resyncQueue
  250. user.resyncQueue = make(map[types.JID]resyncQueueItem)
  251. user.resyncQueueLock.Unlock()
  252. var puppetJIDs []types.JID
  253. var puppets []*Puppet
  254. var portals []*Portal
  255. for jid, item := range queue {
  256. var lastSync time.Time
  257. if item.puppet != nil {
  258. lastSync = item.puppet.LastSync
  259. } else if item.portal != nil {
  260. lastSync = item.portal.LastSync
  261. }
  262. if lastSync.Add(resyncMinInterval).After(time.Now()) {
  263. user.log.Debugfln("Not resyncing %s, last sync was %s ago", jid, time.Now().Sub(lastSync))
  264. continue
  265. }
  266. if item.puppet != nil {
  267. puppets = append(puppets, item.puppet)
  268. puppetJIDs = append(puppetJIDs, jid)
  269. } else if item.portal != nil {
  270. portals = append(portals, item.portal)
  271. }
  272. }
  273. for _, portal := range portals {
  274. user.log.Debugfln("Doing background sync for %s", portal.Key.JID)
  275. portal.UpdateMatrixRoom(user, nil)
  276. }
  277. if len(puppetJIDs) == 0 {
  278. return
  279. }
  280. user.log.Debugfln("Doing background sync for users: %+v", puppetJIDs)
  281. infos, err := user.Client.GetUserInfo(puppetJIDs)
  282. if err != nil {
  283. user.log.Errorfln("Error getting user info for background sync: %v", err)
  284. return
  285. }
  286. for _, puppet := range puppets {
  287. info, ok := infos[puppet.JID]
  288. if !ok {
  289. user.log.Warnfln("Didn't get info for %s in background sync", puppet.JID)
  290. continue
  291. }
  292. var contactPtr *types.ContactInfo
  293. contact, err := user.Session.Contacts.GetContact(puppet.JID)
  294. if err != nil {
  295. user.log.Warnfln("Failed to get contact info for %s in background sync: %v", puppet.JID, err)
  296. } else if contact.Found {
  297. contactPtr = &contact
  298. }
  299. puppet.Sync(user, contactPtr, info.PictureID != "" && info.PictureID != puppet.Avatar)
  300. }
  301. }
  302. func (user *User) ensureInvited(intent *appservice.IntentAPI, roomID id.RoomID, isDirect bool) (ok bool) {
  303. inviteContent := event.Content{
  304. Parsed: &event.MemberEventContent{
  305. Membership: event.MembershipInvite,
  306. IsDirect: isDirect,
  307. },
  308. Raw: map[string]interface{}{},
  309. }
  310. customPuppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  311. if customPuppet != nil && customPuppet.CustomIntent() != nil {
  312. inviteContent.Raw["fi.mau.will_auto_accept"] = true
  313. }
  314. _, err := intent.SendStateEvent(roomID, event.StateMember, user.MXID.String(), &inviteContent)
  315. var httpErr mautrix.HTTPError
  316. if err != nil && errors.As(err, &httpErr) && httpErr.RespError != nil && strings.Contains(httpErr.RespError.Err, "is already in the room") {
  317. user.bridge.StateStore.SetMembership(roomID, user.MXID, event.MembershipJoin)
  318. ok = true
  319. return
  320. } else if err != nil {
  321. user.log.Warnfln("Failed to invite user to %s: %v", roomID, err)
  322. } else {
  323. ok = true
  324. }
  325. if customPuppet != nil && customPuppet.CustomIntent() != nil {
  326. err = customPuppet.CustomIntent().EnsureJoined(roomID, appservice.EnsureJoinedParams{IgnoreCache: true})
  327. if err != nil {
  328. user.log.Warnfln("Failed to auto-join %s: %v", roomID, err)
  329. ok = false
  330. } else {
  331. ok = true
  332. }
  333. }
  334. return
  335. }
  336. func (user *User) GetSpaceRoom() id.RoomID {
  337. if !user.bridge.Config.Bridge.PersonalFilteringSpaces {
  338. return ""
  339. }
  340. if len(user.SpaceRoom) == 0 {
  341. user.spaceCreateLock.Lock()
  342. defer user.spaceCreateLock.Unlock()
  343. if len(user.SpaceRoom) > 0 {
  344. return user.SpaceRoom
  345. }
  346. resp, err := user.bridge.Bot.CreateRoom(&mautrix.ReqCreateRoom{
  347. Visibility: "private",
  348. Name: "WhatsApp",
  349. Topic: "Your WhatsApp bridged chats",
  350. InitialState: []*event.Event{{
  351. Type: event.StateRoomAvatar,
  352. Content: event.Content{
  353. Parsed: &event.RoomAvatarEventContent{
  354. URL: user.bridge.Config.AppService.Bot.ParsedAvatar,
  355. },
  356. },
  357. }},
  358. CreationContent: map[string]interface{}{
  359. "type": event.RoomTypeSpace,
  360. },
  361. PowerLevelOverride: &event.PowerLevelsEventContent{
  362. Users: map[id.UserID]int{
  363. user.bridge.Bot.UserID: 9001,
  364. user.MXID: 50,
  365. },
  366. },
  367. })
  368. if err != nil {
  369. user.log.Errorln("Failed to auto-create space room:", err)
  370. } else {
  371. user.SpaceRoom = resp.RoomID
  372. user.Update()
  373. user.ensureInvited(user.bridge.Bot, user.SpaceRoom, false)
  374. }
  375. } else if !user.spaceMembershipChecked && !user.bridge.StateStore.IsInRoom(user.SpaceRoom, user.MXID) {
  376. user.ensureInvited(user.bridge.Bot, user.SpaceRoom, false)
  377. }
  378. user.spaceMembershipChecked = true
  379. return user.SpaceRoom
  380. }
  381. func (user *User) GetManagementRoom() id.RoomID {
  382. if len(user.ManagementRoom) == 0 {
  383. user.mgmtCreateLock.Lock()
  384. defer user.mgmtCreateLock.Unlock()
  385. if len(user.ManagementRoom) > 0 {
  386. return user.ManagementRoom
  387. }
  388. creationContent := make(map[string]interface{})
  389. if !user.bridge.Config.Bridge.FederateRooms {
  390. creationContent["m.federate"] = false
  391. }
  392. resp, err := user.bridge.Bot.CreateRoom(&mautrix.ReqCreateRoom{
  393. Topic: "WhatsApp bridge notices",
  394. IsDirect: true,
  395. CreationContent: creationContent,
  396. })
  397. if err != nil {
  398. user.log.Errorln("Failed to auto-create management room:", err)
  399. } else {
  400. user.SetManagementRoom(resp.RoomID)
  401. }
  402. }
  403. return user.ManagementRoom
  404. }
  405. func (user *User) SetManagementRoom(roomID id.RoomID) {
  406. existingUser, ok := user.bridge.managementRooms[roomID]
  407. if ok {
  408. existingUser.ManagementRoom = ""
  409. existingUser.Update()
  410. }
  411. user.ManagementRoom = roomID
  412. user.bridge.managementRooms[user.ManagementRoom] = user
  413. user.Update()
  414. }
  415. type waLogger struct{ l log.Logger }
  416. func (w *waLogger) Debugf(msg string, args ...interface{}) { w.l.Debugfln(msg, args...) }
  417. func (w *waLogger) Infof(msg string, args ...interface{}) { w.l.Infofln(msg, args...) }
  418. func (w *waLogger) Warnf(msg string, args ...interface{}) { w.l.Warnfln(msg, args...) }
  419. func (w *waLogger) Errorf(msg string, args ...interface{}) { w.l.Errorfln(msg, args...) }
  420. func (w *waLogger) Sub(module string) waLog.Logger { return &waLogger{l: w.l.Sub(module)} }
  421. var ErrAlreadyLoggedIn = errors.New("already logged in")
  422. func (user *User) obfuscateJID(jid types.JID) string {
  423. // Turn the first 4 bytes of HMAC-SHA256(hs_token, phone) into a number and replace the middle of the actual phone with that deterministic random number.
  424. randomNumber := binary.BigEndian.Uint32(hmac.New(sha256.New, []byte(user.bridge.Config.AppService.HSToken)).Sum([]byte(jid.User))[:4])
  425. return fmt.Sprintf("+%s-%d-%s:%d", jid.User[:1], randomNumber, jid.User[len(jid.User)-2:], jid.Device)
  426. }
  427. func (user *User) createClient(sess *store.Device) {
  428. user.Client = whatsmeow.NewClient(sess, &waLogger{user.log.Sub("Client")})
  429. user.Client.AddEventHandler(user.HandleEvent)
  430. user.Client.SetForceActiveDeliveryReceipts(user.bridge.Config.Bridge.ForceActiveDeliveryReceipts)
  431. user.Client.GetMessageForRetry = func(requester, to types.JID, id types.MessageID) *waProto.Message {
  432. Segment.Track(user.MXID, "WhatsApp incoming retry (message not found)", map[string]interface{}{
  433. "requester": user.obfuscateJID(requester),
  434. "messageID": id,
  435. })
  436. user.bridge.Metrics.TrackRetryReceipt(0, false)
  437. return nil
  438. }
  439. user.Client.PreRetryCallback = func(receipt *events.Receipt, messageID types.MessageID, retryCount int, msg *waProto.Message) bool {
  440. Segment.Track(user.MXID, "WhatsApp incoming retry (accepted)", map[string]interface{}{
  441. "requester": user.obfuscateJID(receipt.Sender),
  442. "messageID": messageID,
  443. "retryCount": retryCount,
  444. })
  445. user.bridge.Metrics.TrackRetryReceipt(retryCount, true)
  446. return true
  447. }
  448. }
  449. func (user *User) Login(ctx context.Context) (<-chan whatsmeow.QRChannelItem, error) {
  450. user.connLock.Lock()
  451. defer user.connLock.Unlock()
  452. if user.Session != nil {
  453. return nil, ErrAlreadyLoggedIn
  454. } else if user.Client != nil {
  455. user.unlockedDeleteConnection()
  456. }
  457. newSession := user.bridge.WAContainer.NewDevice()
  458. newSession.Log = &waLogger{user.log.Sub("Session")}
  459. user.createClient(newSession)
  460. qrChan, err := user.Client.GetQRChannel(ctx)
  461. if err != nil {
  462. return nil, fmt.Errorf("failed to get QR channel: %w", err)
  463. }
  464. err = user.Client.Connect()
  465. if err != nil {
  466. return nil, fmt.Errorf("failed to connect to WhatsApp: %w", err)
  467. }
  468. return qrChan, nil
  469. }
  470. func (user *User) Connect() bool {
  471. user.connLock.Lock()
  472. defer user.connLock.Unlock()
  473. if user.Client != nil {
  474. return user.Client.IsConnected()
  475. } else if user.Session == nil {
  476. return false
  477. }
  478. user.log.Debugln("Connecting to WhatsApp")
  479. user.BridgeState.Send(bridge.State{StateEvent: bridge.StateConnecting, Error: WAConnecting})
  480. user.createClient(user.Session)
  481. err := user.Client.Connect()
  482. if err != nil {
  483. user.log.Warnln("Error connecting to WhatsApp:", err)
  484. user.BridgeState.Send(bridge.State{
  485. StateEvent: bridge.StateUnknownError,
  486. Error: WAConnectionFailed,
  487. Info: map[string]interface{}{
  488. "go_error": err.Error(),
  489. },
  490. })
  491. return false
  492. }
  493. return true
  494. }
  495. func (user *User) unlockedDeleteConnection() {
  496. if user.Client == nil {
  497. return
  498. }
  499. user.Client.Disconnect()
  500. user.Client.RemoveEventHandlers()
  501. user.Client = nil
  502. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  503. }
  504. func (user *User) DeleteConnection() {
  505. user.connLock.Lock()
  506. defer user.connLock.Unlock()
  507. user.unlockedDeleteConnection()
  508. }
  509. func (user *User) HasSession() bool {
  510. return user.Session != nil
  511. }
  512. func (user *User) DeleteSession() {
  513. if user.Session != nil {
  514. err := user.Session.Delete()
  515. if err != nil {
  516. user.log.Warnln("Failed to delete session:", err)
  517. }
  518. user.Session = nil
  519. }
  520. if !user.JID.IsEmpty() {
  521. user.JID = types.EmptyJID
  522. user.Update()
  523. }
  524. // Delete all of the backfill and history sync data.
  525. user.bridge.DB.Backfill.DeleteAll(user.MXID)
  526. user.bridge.DB.HistorySync.DeleteAllConversations(user.MXID)
  527. user.bridge.DB.HistorySync.DeleteAllMessages(user.MXID)
  528. user.bridge.DB.MediaBackfillRequest.DeleteAllMediaBackfillRequests(user.MXID)
  529. }
  530. func (user *User) IsConnected() bool {
  531. return user.Client != nil && user.Client.IsConnected()
  532. }
  533. func (user *User) IsLoggedIn() bool {
  534. return user.IsConnected() && user.Client.IsLoggedIn()
  535. }
  536. func (user *User) tryAutomaticDoublePuppeting() {
  537. if !user.bridge.Config.CanAutoDoublePuppet(user.MXID) {
  538. return
  539. }
  540. user.log.Debugln("Checking if double puppeting needs to be enabled")
  541. puppet := user.bridge.GetPuppetByJID(user.JID)
  542. if len(puppet.CustomMXID) > 0 {
  543. user.log.Debugln("User already has double-puppeting enabled")
  544. // Custom puppet already enabled
  545. return
  546. }
  547. accessToken, err := puppet.loginWithSharedSecret(user.MXID)
  548. if err != nil {
  549. user.log.Warnln("Failed to login with shared secret:", err)
  550. return
  551. }
  552. err = puppet.SwitchCustomMXID(accessToken, user.MXID)
  553. if err != nil {
  554. puppet.log.Warnln("Failed to switch to auto-logined custom puppet:", err)
  555. return
  556. }
  557. user.log.Infoln("Successfully automatically enabled custom puppet")
  558. }
  559. func (user *User) sendMarkdownBridgeAlert(formatString string, args ...interface{}) {
  560. if user.bridge.Config.Bridge.DisableBridgeAlerts {
  561. return
  562. }
  563. notice := fmt.Sprintf(formatString, args...)
  564. content := format.RenderMarkdown(notice, true, false)
  565. _, err := user.bridge.Bot.SendMessageEvent(user.GetManagementRoom(), event.EventMessage, content)
  566. if err != nil {
  567. user.log.Warnf("Failed to send bridge alert \"%s\": %v", notice, err)
  568. }
  569. }
  570. const callEventMaxAge = 15 * time.Minute
  571. func (user *User) handleCallStart(sender types.JID, id, callType string, ts time.Time) {
  572. if !user.bridge.Config.Bridge.CallStartNotices || ts.Add(callEventMaxAge).Before(time.Now()) {
  573. return
  574. }
  575. portal := user.GetPortalByJID(sender)
  576. text := "Incoming call"
  577. if callType != "" {
  578. text = fmt.Sprintf("Incoming %s call", callType)
  579. }
  580. portal.messages <- PortalMessage{
  581. fake: &fakeMessage{
  582. Sender: sender,
  583. Text: text,
  584. ID: id,
  585. Time: ts,
  586. Important: true,
  587. },
  588. source: user,
  589. }
  590. }
  591. const PhoneDisconnectWarningTime = 12 * 24 * time.Hour // 12 days
  592. const PhoneDisconnectPingTime = 10 * 24 * time.Hour
  593. const PhoneMinPingInterval = 24 * time.Hour
  594. func (user *User) sendHackyPhonePing() {
  595. user.PhoneLastPinged = time.Now()
  596. msgID := whatsmeow.GenerateMessageID()
  597. keyIDs := make([]*waProto.AppStateSyncKeyId, 0, 1)
  598. lastKeyID, err := user.GetLastAppStateKeyID()
  599. if lastKeyID != nil {
  600. keyIDs = append(keyIDs, &waProto.AppStateSyncKeyId{
  601. KeyId: lastKeyID,
  602. })
  603. } else {
  604. user.log.Warnfln("Failed to get last app state key ID to send hacky phone ping: %v - sending empty request", err)
  605. }
  606. ts, err := user.Client.SendMessage(context.Background(), user.JID.ToNonAD(), msgID, &waProto.Message{
  607. ProtocolMessage: &waProto.ProtocolMessage{
  608. Type: waProto.ProtocolMessage_APP_STATE_SYNC_KEY_REQUEST.Enum(),
  609. AppStateSyncKeyRequest: &waProto.AppStateSyncKeyRequest{
  610. KeyIds: keyIDs,
  611. },
  612. },
  613. })
  614. if err != nil {
  615. user.log.Warnfln("Failed to send hacky phone ping: %v", err)
  616. } else {
  617. user.log.Debugfln("Sent hacky phone ping %s/%s because phone has been offline for >10 days", msgID, ts.Unix())
  618. user.PhoneLastPinged = ts
  619. user.Update()
  620. }
  621. }
  622. func (user *User) PhoneRecentlySeen(doPing bool) bool {
  623. if doPing && !user.PhoneLastSeen.IsZero() && user.PhoneLastSeen.Add(PhoneDisconnectPingTime).Before(time.Now()) && user.PhoneLastPinged.Add(PhoneMinPingInterval).Before(time.Now()) {
  624. // Over 10 days since the phone was seen and over a day since the last somewhat hacky ping, send a new ping.
  625. go user.sendHackyPhonePing()
  626. }
  627. return user.PhoneLastSeen.IsZero() || user.PhoneLastSeen.Add(PhoneDisconnectWarningTime).After(time.Now())
  628. }
  629. // phoneSeen records a timestamp when the user's main device was seen online.
  630. // The stored timestamp can later be used to warn the user if the main device is offline for too long.
  631. func (user *User) phoneSeen(ts time.Time) {
  632. if user.PhoneLastSeen.Add(1 * time.Hour).After(ts) {
  633. // The last seen timestamp isn't going to be perfectly accurate in any case,
  634. // so don't spam the database with an update every time there's an event.
  635. return
  636. } else if !user.PhoneRecentlySeen(false) {
  637. if user.BridgeState.GetPrev().Error == WAPhoneOffline && user.IsConnected() {
  638. user.log.Debugfln("Saw phone after current bridge state said it has been offline, switching state back to connected")
  639. go user.BridgeState.Send(bridge.State{StateEvent: bridge.StateConnected})
  640. } else {
  641. user.log.Debugfln("Saw phone after current bridge state said it has been offline, not sending new bridge state (prev: %s, connected: %t)", user.BridgeState.GetPrev().Error, user.IsConnected())
  642. }
  643. }
  644. user.PhoneLastSeen = ts
  645. go user.Update()
  646. }
  647. func formatDisconnectTime(dur time.Duration) string {
  648. days := int(math.Floor(dur.Hours() / 24))
  649. hours := int(dur.Hours()) % 24
  650. if hours == 0 {
  651. return fmt.Sprintf("%d days", days)
  652. } else if hours == 1 {
  653. return fmt.Sprintf("%d days and 1 hour", days)
  654. } else {
  655. return fmt.Sprintf("%d days and %d hours", days, hours)
  656. }
  657. }
  658. func (user *User) sendPhoneOfflineWarning() {
  659. if user.lastPhoneOfflineWarning.Add(12 * time.Hour).After(time.Now()) {
  660. // Don't spam the warning too much
  661. return
  662. }
  663. user.lastPhoneOfflineWarning = time.Now()
  664. timeSinceSeen := time.Now().Sub(user.PhoneLastSeen)
  665. 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))
  666. }
  667. func (user *User) HandleEvent(event interface{}) {
  668. switch v := event.(type) {
  669. case *events.LoggedOut:
  670. go user.handleLoggedOut(v.OnConnect, v.Reason)
  671. case *events.Connected:
  672. user.bridge.Metrics.TrackConnectionState(user.JID, true)
  673. user.bridge.Metrics.TrackLoginState(user.JID, true)
  674. if len(user.Client.Store.PushName) > 0 {
  675. go func() {
  676. err := user.Client.SendPresence(user.lastPresence)
  677. if err != nil {
  678. user.log.Warnln("Failed to send initial presence:", err)
  679. }
  680. }()
  681. }
  682. go user.tryAutomaticDoublePuppeting()
  683. if user.bridge.Config.Bridge.HistorySync.Backfill && !user.historySyncLoopsStarted {
  684. go user.handleHistorySyncsLoop()
  685. user.historySyncLoopsStarted = true
  686. }
  687. case *events.OfflineSyncPreview:
  688. user.log.Infofln("Server says it's going to send %d messages and %d receipts that were missed during downtime", v.Messages, v.Receipts)
  689. go user.BridgeState.Send(bridge.State{
  690. StateEvent: bridge.StateBackfilling,
  691. Message: fmt.Sprintf("backfilling %d messages and %d receipts", v.Messages, v.Receipts),
  692. })
  693. case *events.OfflineSyncCompleted:
  694. if !user.PhoneRecentlySeen(true) {
  695. user.log.Infofln("Offline sync completed, but phone last seen date is still %s - sending phone offline bridge status", user.PhoneLastSeen)
  696. go user.BridgeState.Send(bridge.State{StateEvent: bridge.StateTransientDisconnect, Error: WAPhoneOffline})
  697. } else {
  698. if user.BridgeState.GetPrev().StateEvent == bridge.StateBackfilling {
  699. user.log.Infoln("Offline sync completed")
  700. }
  701. go user.BridgeState.Send(bridge.State{StateEvent: bridge.StateConnected})
  702. }
  703. case *events.AppStateSyncComplete:
  704. if len(user.Client.Store.PushName) > 0 && v.Name == appstate.WAPatchCriticalBlock {
  705. err := user.Client.SendPresence(user.lastPresence)
  706. if err != nil {
  707. user.log.Warnln("Failed to send presence after app state sync:", err)
  708. }
  709. } else if v.Name == appstate.WAPatchCriticalUnblockLow {
  710. go func() {
  711. err := user.ResyncContacts(false)
  712. if err != nil {
  713. user.log.Errorln("Failed to resync puppets: %v", err)
  714. }
  715. }()
  716. }
  717. case *events.PushNameSetting:
  718. // Send presence available when connecting and when the pushname is changed.
  719. // This makes sure that outgoing messages always have the right pushname.
  720. err := user.Client.SendPresence(user.lastPresence)
  721. if err != nil {
  722. user.log.Warnln("Failed to send presence after push name update:", err)
  723. }
  724. case *events.PairSuccess:
  725. user.PhoneLastSeen = time.Now()
  726. user.Session = user.Client.Store
  727. user.JID = v.ID
  728. user.addToJIDMap()
  729. user.Update()
  730. case *events.StreamError:
  731. var message string
  732. if v.Code != "" {
  733. message = fmt.Sprintf("Unknown stream error with code %s", v.Code)
  734. } else if children := v.Raw.GetChildren(); len(children) > 0 {
  735. message = fmt.Sprintf("Unknown stream error (contains %s node)", children[0].Tag)
  736. } else {
  737. message = "Unknown stream error"
  738. }
  739. go user.BridgeState.Send(bridge.State{StateEvent: bridge.StateUnknownError, Message: message})
  740. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  741. case *events.ConnectFailure:
  742. go user.BridgeState.Send(bridge.State{StateEvent: bridge.StateUnknownError, Message: fmt.Sprintf("Unknown connection failure: %s", v.Reason)})
  743. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  744. case *events.ClientOutdated:
  745. user.log.Errorfln("Got a client outdated connect failure. The bridge is likely out of date, please update immediately.")
  746. go user.BridgeState.Send(bridge.State{StateEvent: bridge.StateUnknownError, Message: "Connect failure: 405 client outdated"})
  747. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  748. case *events.TemporaryBan:
  749. go user.BridgeState.Send(bridge.State{StateEvent: bridge.StateBadCredentials, Message: v.String()})
  750. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  751. case *events.Disconnected:
  752. // Don't send the normal transient disconnect state if we're already in a different transient disconnect state.
  753. // TODO remove this if/when the phone offline state is moved to a sub-state of CONNECTED
  754. if user.BridgeState.GetPrev().Error != WAPhoneOffline && user.PhoneRecentlySeen(false) {
  755. go user.BridgeState.Send(bridge.State{StateEvent: bridge.StateTransientDisconnect, Message: "Disconnected from WhatsApp. Trying to reconnect."})
  756. }
  757. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  758. case *events.Contact:
  759. go user.syncPuppet(v.JID, "contact event")
  760. case *events.PushName:
  761. go user.syncPuppet(v.JID, "push name event")
  762. case *events.BusinessName:
  763. go user.syncPuppet(v.JID, "business name event")
  764. case *events.GroupInfo:
  765. user.groupListCache = nil
  766. go user.handleGroupUpdate(v)
  767. case *events.JoinedGroup:
  768. user.groupListCache = nil
  769. go user.handleGroupCreate(v)
  770. case *events.Picture:
  771. go user.handlePictureUpdate(v)
  772. case *events.Receipt:
  773. if v.IsFromMe && v.Sender.Device == 0 {
  774. user.phoneSeen(v.Timestamp)
  775. }
  776. go user.handleReceipt(v)
  777. case *events.ChatPresence:
  778. go user.handleChatPresence(v)
  779. case *events.Message:
  780. portal := user.GetPortalByMessageSource(v.Info.MessageSource)
  781. portal.messages <- PortalMessage{evt: v, source: user}
  782. case *events.MediaRetry:
  783. user.phoneSeen(v.Timestamp)
  784. portal := user.GetPortalByJID(v.ChatID)
  785. portal.mediaRetries <- PortalMediaRetry{evt: v, source: user}
  786. case *events.CallOffer:
  787. user.handleCallStart(v.CallCreator, v.CallID, "", v.Timestamp)
  788. case *events.CallOfferNotice:
  789. user.handleCallStart(v.CallCreator, v.CallID, v.Type, v.Timestamp)
  790. case *events.IdentityChange:
  791. puppet := user.bridge.GetPuppetByJID(v.JID)
  792. portal := user.GetPortalByJID(v.JID)
  793. if len(portal.MXID) > 0 && user.bridge.Config.Bridge.IdentityChangeNotices {
  794. text := fmt.Sprintf("Your security code with %s changed.", puppet.Displayname)
  795. if v.Implicit {
  796. text = fmt.Sprintf("Your security code with %s (device #%d) changed.", puppet.Displayname, v.JID.Device)
  797. }
  798. portal.messages <- PortalMessage{
  799. fake: &fakeMessage{
  800. Sender: v.JID,
  801. Text: text,
  802. ID: strconv.FormatInt(v.Timestamp.Unix(), 10),
  803. Time: v.Timestamp,
  804. Important: false,
  805. },
  806. source: user,
  807. }
  808. }
  809. case *events.CallTerminate, *events.CallRelayLatency, *events.CallAccept, *events.UnknownCallEvent:
  810. // ignore
  811. case *events.UndecryptableMessage:
  812. portal := user.GetPortalByMessageSource(v.Info.MessageSource)
  813. portal.messages <- PortalMessage{undecryptable: v, source: user}
  814. case *events.HistorySync:
  815. if user.bridge.Config.Bridge.HistorySync.Backfill {
  816. user.historySyncs <- v
  817. }
  818. case *events.Mute:
  819. portal := user.GetPortalByJID(v.JID)
  820. if portal != nil {
  821. var mutedUntil time.Time
  822. if v.Action.GetMuted() {
  823. mutedUntil = time.Unix(v.Action.GetMuteEndTimestamp(), 0)
  824. }
  825. go user.updateChatMute(nil, portal, mutedUntil)
  826. }
  827. case *events.Archive:
  828. portal := user.GetPortalByJID(v.JID)
  829. if portal != nil {
  830. go user.updateChatTag(nil, portal, user.bridge.Config.Bridge.ArchiveTag, v.Action.GetArchived())
  831. }
  832. case *events.Pin:
  833. portal := user.GetPortalByJID(v.JID)
  834. if portal != nil {
  835. go user.updateChatTag(nil, portal, user.bridge.Config.Bridge.PinnedTag, v.Action.GetPinned())
  836. }
  837. case *events.AppState:
  838. // Ignore
  839. case *events.KeepAliveTimeout:
  840. go user.BridgeState.Send(bridge.State{StateEvent: bridge.StateTransientDisconnect, Error: WAKeepaliveTimeout})
  841. case *events.KeepAliveRestored:
  842. user.log.Infof("Keepalive restored after timeouts, sending connected event")
  843. go user.BridgeState.Send(bridge.State{StateEvent: bridge.StateConnected})
  844. case *events.MarkChatAsRead:
  845. if user.bridge.Config.Bridge.SyncManualMarkedUnread {
  846. user.markUnread(user.GetPortalByJID(v.JID), !v.Action.GetRead())
  847. }
  848. default:
  849. user.log.Debugfln("Unknown type of event in HandleEvent: %T", v)
  850. }
  851. }
  852. func (user *User) updateChatMute(intent *appservice.IntentAPI, portal *Portal, mutedUntil time.Time) {
  853. if len(portal.MXID) == 0 || !user.bridge.Config.Bridge.MuteBridging {
  854. return
  855. } else if intent == nil {
  856. doublePuppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  857. if doublePuppet == nil || doublePuppet.CustomIntent() == nil {
  858. return
  859. }
  860. intent = doublePuppet.CustomIntent()
  861. }
  862. var err error
  863. if mutedUntil.IsZero() && mutedUntil.Before(time.Now()) {
  864. user.log.Debugfln("Portal %s is muted until %s, unmuting...", portal.MXID, mutedUntil)
  865. err = intent.DeletePushRule("global", pushrules.RoomRule, string(portal.MXID))
  866. } else {
  867. user.log.Debugfln("Portal %s is muted until %s, muting...", portal.MXID, mutedUntil)
  868. err = intent.PutPushRule("global", pushrules.RoomRule, string(portal.MXID), &mautrix.ReqPutPushRule{
  869. Actions: []pushrules.PushActionType{pushrules.ActionDontNotify},
  870. })
  871. }
  872. if err != nil && !errors.Is(err, mautrix.MNotFound) {
  873. user.log.Warnfln("Failed to update push rule for %s through double puppet: %v", portal.MXID, err)
  874. }
  875. }
  876. type CustomTagData struct {
  877. Order json.Number `json:"order"`
  878. DoublePuppet string `json:"fi.mau.double_puppet_source"`
  879. }
  880. type CustomTagEventContent struct {
  881. Tags map[string]CustomTagData `json:"tags"`
  882. }
  883. func (user *User) updateChatTag(intent *appservice.IntentAPI, portal *Portal, tag string, active bool) {
  884. if len(portal.MXID) == 0 || len(tag) == 0 {
  885. return
  886. } else if intent == nil {
  887. doublePuppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  888. if doublePuppet == nil || doublePuppet.CustomIntent() == nil {
  889. return
  890. }
  891. intent = doublePuppet.CustomIntent()
  892. }
  893. var existingTags CustomTagEventContent
  894. err := intent.GetTagsWithCustomData(portal.MXID, &existingTags)
  895. if err != nil && !errors.Is(err, mautrix.MNotFound) {
  896. user.log.Warnfln("Failed to get tags of %s: %v", portal.MXID, err)
  897. }
  898. currentTag, ok := existingTags.Tags[tag]
  899. if active && !ok {
  900. user.log.Debugln("Adding tag", tag, "to", portal.MXID)
  901. data := CustomTagData{"0.5", doublePuppetValue}
  902. err = intent.AddTagWithCustomData(portal.MXID, tag, &data)
  903. } else if !active && ok && currentTag.DoublePuppet == doublePuppetValue {
  904. user.log.Debugln("Removing tag", tag, "from", portal.MXID)
  905. err = intent.RemoveTag(portal.MXID, tag)
  906. } else {
  907. err = nil
  908. }
  909. if err != nil {
  910. user.log.Warnfln("Failed to update tag %s for %s through double puppet: %v", tag, portal.MXID, err)
  911. }
  912. }
  913. type CustomReadReceipt struct {
  914. Timestamp int64 `json:"ts,omitempty"`
  915. DoublePuppetSource string `json:"fi.mau.double_puppet_source,omitempty"`
  916. }
  917. type CustomReadMarkers struct {
  918. mautrix.ReqSetReadMarkers
  919. ReadExtra CustomReadReceipt `json:"com.beeper.read.extra"`
  920. FullyReadExtra CustomReadReceipt `json:"com.beeper.fully_read.extra"`
  921. }
  922. func (user *User) syncChatDoublePuppetDetails(portal *Portal, justCreated bool) {
  923. doublePuppet := portal.bridge.GetPuppetByCustomMXID(user.MXID)
  924. if doublePuppet == nil {
  925. return
  926. }
  927. if doublePuppet == nil || doublePuppet.CustomIntent() == nil || len(portal.MXID) == 0 {
  928. return
  929. }
  930. if justCreated || !user.bridge.Config.Bridge.TagOnlyOnCreate {
  931. chat, err := user.Client.Store.ChatSettings.GetChatSettings(portal.Key.JID)
  932. if err != nil {
  933. user.log.Warnfln("Failed to get settings of %s: %v", portal.Key.JID, err)
  934. return
  935. }
  936. intent := doublePuppet.CustomIntent()
  937. if portal.Key.JID == types.StatusBroadcastJID && justCreated {
  938. if user.bridge.Config.Bridge.MuteStatusBroadcast {
  939. user.updateChatMute(intent, portal, time.Now().Add(365*24*time.Hour))
  940. }
  941. if len(user.bridge.Config.Bridge.StatusBroadcastTag) > 0 {
  942. user.updateChatTag(intent, portal, user.bridge.Config.Bridge.StatusBroadcastTag, true)
  943. }
  944. return
  945. } else if !chat.Found {
  946. return
  947. }
  948. user.updateChatMute(intent, portal, chat.MutedUntil)
  949. user.updateChatTag(intent, portal, user.bridge.Config.Bridge.ArchiveTag, chat.Archived)
  950. user.updateChatTag(intent, portal, user.bridge.Config.Bridge.PinnedTag, chat.Pinned)
  951. }
  952. }
  953. func (user *User) getDirectChats() map[id.UserID][]id.RoomID {
  954. res := make(map[id.UserID][]id.RoomID)
  955. privateChats := user.bridge.DB.Portal.FindPrivateChats(user.JID.ToNonAD())
  956. for _, portal := range privateChats {
  957. if len(portal.MXID) > 0 {
  958. res[user.bridge.FormatPuppetMXID(portal.Key.JID)] = []id.RoomID{portal.MXID}
  959. }
  960. }
  961. return res
  962. }
  963. func (user *User) UpdateDirectChats(chats map[id.UserID][]id.RoomID) {
  964. if !user.bridge.Config.Bridge.SyncDirectChatList {
  965. return
  966. }
  967. puppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  968. if puppet == nil || puppet.CustomIntent() == nil {
  969. return
  970. }
  971. intent := puppet.CustomIntent()
  972. method := http.MethodPatch
  973. if chats == nil {
  974. chats = user.getDirectChats()
  975. method = http.MethodPut
  976. }
  977. user.log.Debugln("Updating m.direct list on homeserver")
  978. var err error
  979. if user.bridge.Config.Homeserver.Asmux {
  980. urlPath := intent.BuildClientURL("unstable", "com.beeper.asmux", "dms")
  981. _, err = intent.MakeFullRequest(mautrix.FullRequest{
  982. Method: method,
  983. URL: urlPath,
  984. Headers: http.Header{"X-Asmux-Auth": {user.bridge.AS.Registration.AppToken}},
  985. RequestJSON: chats,
  986. })
  987. } else {
  988. existingChats := make(map[id.UserID][]id.RoomID)
  989. err = intent.GetAccountData(event.AccountDataDirectChats.Type, &existingChats)
  990. if err != nil {
  991. user.log.Warnln("Failed to get m.direct list to update it:", err)
  992. return
  993. }
  994. for userID, rooms := range existingChats {
  995. if _, ok := user.bridge.ParsePuppetMXID(userID); !ok {
  996. // This is not a ghost user, include it in the new list
  997. chats[userID] = rooms
  998. } else if _, ok := chats[userID]; !ok && method == http.MethodPatch {
  999. // This is a ghost user, but we're not replacing the whole list, so include it too
  1000. chats[userID] = rooms
  1001. }
  1002. }
  1003. err = intent.SetAccountData(event.AccountDataDirectChats.Type, &chats)
  1004. }
  1005. if err != nil {
  1006. user.log.Warnln("Failed to update m.direct list:", err)
  1007. }
  1008. }
  1009. func (user *User) handleLoggedOut(onConnect bool, reason events.ConnectFailureReason) {
  1010. errorCode := WAUnknownLogout
  1011. if reason == events.ConnectFailureLoggedOut {
  1012. errorCode = WALoggedOut
  1013. } else if reason == events.ConnectFailureMainDeviceGone {
  1014. errorCode = WAMainDeviceGone
  1015. }
  1016. user.removeFromJIDMap(bridge.State{StateEvent: bridge.StateBadCredentials, Error: errorCode})
  1017. user.DeleteConnection()
  1018. user.Session = nil
  1019. user.JID = types.EmptyJID
  1020. user.Update()
  1021. if onConnect {
  1022. user.sendMarkdownBridgeAlert("Connecting to WhatsApp failed as the device was unlinked (error %s). Please link the bridge to your phone again.", reason)
  1023. } else {
  1024. user.sendMarkdownBridgeAlert("You were logged out from another device. Please link the bridge to your phone again.")
  1025. }
  1026. }
  1027. func (user *User) GetPortalByMessageSource(ms types.MessageSource) *Portal {
  1028. jid := ms.Chat
  1029. if ms.IsIncomingBroadcast() {
  1030. if ms.IsFromMe {
  1031. jid = ms.BroadcastListOwner.ToNonAD()
  1032. } else {
  1033. jid = ms.Sender.ToNonAD()
  1034. }
  1035. if jid.IsEmpty() {
  1036. return nil
  1037. }
  1038. }
  1039. return user.bridge.GetPortalByJID(database.NewPortalKey(jid, user.JID))
  1040. }
  1041. func (user *User) GetPortalByJID(jid types.JID) *Portal {
  1042. return user.bridge.GetPortalByJID(database.NewPortalKey(jid, user.JID))
  1043. }
  1044. func (user *User) syncPuppet(jid types.JID, reason string) {
  1045. user.bridge.GetPuppetByJID(jid).SyncContact(user, false, false, reason)
  1046. }
  1047. func (user *User) ResyncContacts(forceAvatarSync bool) error {
  1048. contacts, err := user.Client.Store.Contacts.GetAllContacts()
  1049. if err != nil {
  1050. return fmt.Errorf("failed to get cached contacts: %w", err)
  1051. }
  1052. user.log.Infofln("Resyncing displaynames with %d contacts", len(contacts))
  1053. for jid, contact := range contacts {
  1054. puppet := user.bridge.GetPuppetByJID(jid)
  1055. if puppet != nil {
  1056. puppet.Sync(user, &contact, forceAvatarSync)
  1057. } else {
  1058. user.log.Warnfln("Got a nil puppet for %s while syncing contacts", jid)
  1059. }
  1060. }
  1061. return nil
  1062. }
  1063. func (user *User) ResyncGroups(createPortals bool) error {
  1064. groups, err := user.Client.GetJoinedGroups()
  1065. if err != nil {
  1066. return fmt.Errorf("failed to get group list from server: %w", err)
  1067. }
  1068. for _, group := range groups {
  1069. portal := user.GetPortalByJID(group.JID)
  1070. if len(portal.MXID) == 0 {
  1071. if createPortals {
  1072. err = portal.CreateMatrixRoom(user, group, true, true)
  1073. if err != nil {
  1074. return fmt.Errorf("failed to create room for %s: %w", group.JID, err)
  1075. }
  1076. }
  1077. } else {
  1078. portal.UpdateMatrixRoom(user, group)
  1079. }
  1080. }
  1081. return nil
  1082. }
  1083. const WATypingTimeout = 15 * time.Second
  1084. func (user *User) handleChatPresence(presence *events.ChatPresence) {
  1085. puppet := user.bridge.GetPuppetByJID(presence.Sender)
  1086. portal := user.GetPortalByJID(presence.Chat)
  1087. if puppet == nil || portal == nil || len(portal.MXID) == 0 {
  1088. return
  1089. }
  1090. if presence.State == types.ChatPresenceComposing {
  1091. if puppet.typingIn != "" && puppet.typingAt.Add(WATypingTimeout).Before(time.Now()) {
  1092. if puppet.typingIn == portal.MXID {
  1093. return
  1094. }
  1095. _, _ = puppet.IntentFor(portal).UserTyping(puppet.typingIn, false, 0)
  1096. }
  1097. _, _ = puppet.IntentFor(portal).UserTyping(portal.MXID, true, WATypingTimeout.Milliseconds())
  1098. puppet.typingIn = portal.MXID
  1099. puppet.typingAt = time.Now()
  1100. } else {
  1101. _, _ = puppet.IntentFor(portal).UserTyping(portal.MXID, false, 0)
  1102. puppet.typingIn = ""
  1103. }
  1104. }
  1105. func (user *User) handleReceipt(receipt *events.Receipt) {
  1106. if receipt.Type != events.ReceiptTypeRead && receipt.Type != events.ReceiptTypeReadSelf {
  1107. return
  1108. }
  1109. portal := user.GetPortalByMessageSource(receipt.MessageSource)
  1110. if portal == nil || len(portal.MXID) == 0 {
  1111. return
  1112. }
  1113. portal.messages <- PortalMessage{receipt: receipt, source: user}
  1114. }
  1115. func makeReadMarkerContent(eventID id.EventID, doublePuppet bool) CustomReadMarkers {
  1116. var extra CustomReadReceipt
  1117. if doublePuppet {
  1118. extra.DoublePuppetSource = doublePuppetValue
  1119. }
  1120. return CustomReadMarkers{
  1121. ReqSetReadMarkers: mautrix.ReqSetReadMarkers{
  1122. Read: eventID,
  1123. FullyRead: eventID,
  1124. },
  1125. ReadExtra: extra,
  1126. FullyReadExtra: extra,
  1127. }
  1128. }
  1129. func (user *User) markSelfReadFull(portal *Portal) {
  1130. puppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  1131. if puppet == nil || puppet.CustomIntent() == nil {
  1132. return
  1133. }
  1134. lastMessage := user.bridge.DB.Message.GetLastInChat(portal.Key)
  1135. if lastMessage == nil {
  1136. return
  1137. }
  1138. user.SetLastReadTS(portal.Key, lastMessage.Timestamp)
  1139. err := puppet.CustomIntent().SetReadMarkers(portal.MXID, makeReadMarkerContent(lastMessage.MXID, true))
  1140. if err != nil {
  1141. user.log.Warnfln("Failed to mark %s (last message) in %s as read: %v", lastMessage.MXID, portal.MXID, err)
  1142. } else {
  1143. user.log.Debugfln("Marked %s (last message) in %s as read", lastMessage.MXID, portal.MXID)
  1144. }
  1145. }
  1146. func (user *User) markUnread(portal *Portal, unread bool) {
  1147. puppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  1148. if puppet == nil || puppet.CustomIntent() == nil {
  1149. return
  1150. }
  1151. err := puppet.CustomIntent().SetRoomAccountData(portal.MXID, "m.marked_unread",
  1152. map[string]bool{"unread": unread})
  1153. if err != nil {
  1154. user.log.Warnfln("Failed to mark %s as unread via m.marked_unread: %v", portal.MXID, err)
  1155. } else {
  1156. user.log.Debugfln("Marked %s as unread via m.marked_unread: %v", portal.MXID, err)
  1157. }
  1158. err = puppet.CustomIntent().SetRoomAccountData(portal.MXID, "com.famedly.marked_unread",
  1159. map[string]bool{"unread": unread})
  1160. if err != nil {
  1161. user.log.Warnfln("Failed to mark %s as unread via com.famedly.marked_unread: %v", portal.MXID, err)
  1162. } else {
  1163. user.log.Debugfln("Marked %s as unread via com.famedly.marked_unread: %v", portal.MXID, err)
  1164. }
  1165. }
  1166. func (user *User) handleGroupCreate(evt *events.JoinedGroup) {
  1167. portal := user.GetPortalByJID(evt.JID)
  1168. if len(portal.MXID) == 0 {
  1169. err := portal.CreateMatrixRoom(user, &evt.GroupInfo, true, true)
  1170. if err != nil {
  1171. user.log.Errorln("Failed to create Matrix room after join notification: %v", err)
  1172. }
  1173. } else {
  1174. portal.UpdateMatrixRoom(user, &evt.GroupInfo)
  1175. }
  1176. }
  1177. func (user *User) handleGroupUpdate(evt *events.GroupInfo) {
  1178. portal := user.GetPortalByJID(evt.JID)
  1179. if portal == nil || len(portal.MXID) == 0 {
  1180. user.log.Debugfln("Ignoring group info update in chat with no portal: %+v", evt)
  1181. return
  1182. }
  1183. switch {
  1184. case evt.Announce != nil:
  1185. portal.RestrictMessageSending(evt.Announce.IsAnnounce)
  1186. case evt.Locked != nil:
  1187. portal.RestrictMetadataChanges(evt.Locked.IsLocked)
  1188. case evt.Name != nil:
  1189. portal.UpdateName(evt.Name.Name, evt.Name.NameSetBy, true)
  1190. case evt.Topic != nil:
  1191. portal.UpdateTopic(evt.Topic.Topic, evt.Topic.TopicSetBy, true)
  1192. case evt.Leave != nil:
  1193. if evt.Sender != nil && !evt.Sender.IsEmpty() {
  1194. portal.HandleWhatsAppKick(user, *evt.Sender, evt.Leave)
  1195. }
  1196. case evt.Join != nil:
  1197. portal.HandleWhatsAppInvite(user, evt.Sender, evt.Join)
  1198. case evt.Promote != nil:
  1199. portal.ChangeAdminStatus(evt.Promote, true)
  1200. case evt.Demote != nil:
  1201. portal.ChangeAdminStatus(evt.Demote, false)
  1202. case evt.Ephemeral != nil:
  1203. portal.UpdateGroupDisappearingMessages(evt.Sender, evt.Timestamp, evt.Ephemeral.DisappearingTimer)
  1204. }
  1205. }
  1206. func (user *User) handlePictureUpdate(evt *events.Picture) {
  1207. if evt.JID.Server == types.DefaultUserServer {
  1208. puppet := user.bridge.GetPuppetByJID(evt.JID)
  1209. user.log.Debugfln("Received picture update for puppet %s (current: %s, new: %s)", evt.JID, puppet.Avatar, evt.PictureID)
  1210. if puppet.Avatar != evt.PictureID {
  1211. puppet.Sync(user, nil, true)
  1212. }
  1213. } else if portal := user.GetPortalByJID(evt.JID); portal != nil {
  1214. user.log.Debugfln("Received picture update for portal %s (current: %s, new: %s)", evt.JID, portal.Avatar, evt.PictureID)
  1215. if portal.Avatar != evt.PictureID {
  1216. portal.UpdateAvatar(user, evt.Author, true)
  1217. }
  1218. }
  1219. }
  1220. func (user *User) StartPM(jid types.JID, reason string) (*Portal, *Puppet, bool, error) {
  1221. user.log.Debugln("Starting PM with", jid, "from", reason)
  1222. puppet := user.bridge.GetPuppetByJID(jid)
  1223. puppet.SyncContact(user, true, false, reason)
  1224. portal := user.GetPortalByJID(puppet.JID)
  1225. if len(portal.MXID) > 0 {
  1226. ok := portal.ensureUserInvited(user)
  1227. if !ok {
  1228. portal.log.Warnfln("ensureUserInvited(%s) returned false, creating new portal", user.MXID)
  1229. portal.MXID = ""
  1230. } else {
  1231. return portal, puppet, false, nil
  1232. }
  1233. }
  1234. err := portal.CreateMatrixRoom(user, nil, false, true)
  1235. return portal, puppet, true, err
  1236. }
  1237. const groupListCacheMaxAge = 24 * time.Hour
  1238. func (user *User) getCachedGroupList() ([]*types.GroupInfo, error) {
  1239. user.groupListCacheLock.Lock()
  1240. defer user.groupListCacheLock.Unlock()
  1241. if user.groupListCache != nil && user.groupListCacheTime.Add(groupListCacheMaxAge).After(time.Now()) {
  1242. return user.groupListCache, nil
  1243. }
  1244. var err error
  1245. user.groupListCache, err = user.Client.GetJoinedGroups()
  1246. user.groupListCacheTime = time.Now()
  1247. return user.groupListCache, err
  1248. }