user.go 43 KB

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