user.go 46 KB

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