user.go 47 KB

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