user.go 44 KB

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