user.go 47 KB

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