user.go 44 KB

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