user.go 48 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437
  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.GetMessageForRetry = func(requester, to types.JID, id types.MessageID) *waProto.Message {
  446. Segment.Track(user.MXID, "WhatsApp incoming retry (message not found)", map[string]interface{}{
  447. "requester": user.obfuscateJID(requester),
  448. "messageID": id,
  449. })
  450. user.bridge.Metrics.TrackRetryReceipt(0, false)
  451. return nil
  452. }
  453. user.Client.PreRetryCallback = func(receipt *events.Receipt, messageID types.MessageID, retryCount int, msg *waProto.Message) bool {
  454. Segment.Track(user.MXID, "WhatsApp incoming retry (accepted)", map[string]interface{}{
  455. "requester": user.obfuscateJID(receipt.Sender),
  456. "messageID": messageID,
  457. "retryCount": retryCount,
  458. })
  459. user.bridge.Metrics.TrackRetryReceipt(retryCount, true)
  460. return true
  461. }
  462. }
  463. func (user *User) Login(ctx context.Context) (<-chan whatsmeow.QRChannelItem, error) {
  464. user.connLock.Lock()
  465. defer user.connLock.Unlock()
  466. if user.Session != nil {
  467. return nil, ErrAlreadyLoggedIn
  468. } else if user.Client != nil {
  469. user.unlockedDeleteConnection()
  470. }
  471. newSession := user.bridge.WAContainer.NewDevice()
  472. newSession.Log = &waLogger{user.log.Sub("Session")}
  473. user.createClient(newSession)
  474. qrChan, err := user.Client.GetQRChannel(ctx)
  475. if err != nil {
  476. return nil, fmt.Errorf("failed to get QR channel: %w", err)
  477. }
  478. err = user.Client.Connect()
  479. if err != nil {
  480. return nil, fmt.Errorf("failed to connect to WhatsApp: %w", err)
  481. }
  482. return qrChan, nil
  483. }
  484. func (user *User) Connect() bool {
  485. user.connLock.Lock()
  486. defer user.connLock.Unlock()
  487. if user.Client != nil {
  488. return user.Client.IsConnected()
  489. } else if user.Session == nil {
  490. return false
  491. }
  492. user.log.Debugln("Connecting to WhatsApp")
  493. user.BridgeState.Send(status.BridgeState{StateEvent: status.StateConnecting, Error: WAConnecting})
  494. user.createClient(user.Session)
  495. err := user.Client.Connect()
  496. if err != nil {
  497. user.log.Warnln("Error connecting to WhatsApp:", err)
  498. user.BridgeState.Send(status.BridgeState{
  499. StateEvent: status.StateUnknownError,
  500. Error: WAConnectionFailed,
  501. Info: map[string]interface{}{
  502. "go_error": err.Error(),
  503. },
  504. })
  505. return false
  506. }
  507. return true
  508. }
  509. func (user *User) unlockedDeleteConnection() {
  510. if user.Client == nil {
  511. return
  512. }
  513. user.Client.Disconnect()
  514. user.Client.RemoveEventHandlers()
  515. user.Client = nil
  516. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  517. }
  518. func (user *User) DeleteConnection() {
  519. user.connLock.Lock()
  520. defer user.connLock.Unlock()
  521. user.unlockedDeleteConnection()
  522. }
  523. func (user *User) HasSession() bool {
  524. return user.Session != nil
  525. }
  526. func (user *User) DeleteSession() {
  527. if user.Session != nil {
  528. err := user.Session.Delete()
  529. if err != nil {
  530. user.log.Warnln("Failed to delete session:", err)
  531. }
  532. user.Session = nil
  533. }
  534. if !user.JID.IsEmpty() {
  535. user.JID = types.EmptyJID
  536. user.Update()
  537. }
  538. // Delete all of the backfill and history sync data.
  539. user.bridge.DB.Backfill.DeleteAll(user.MXID)
  540. user.bridge.DB.HistorySync.DeleteAllConversations(user.MXID)
  541. user.bridge.DB.HistorySync.DeleteAllMessages(user.MXID)
  542. user.bridge.DB.MediaBackfillRequest.DeleteAllMediaBackfillRequests(user.MXID)
  543. }
  544. func (user *User) IsConnected() bool {
  545. return user.Client != nil && user.Client.IsConnected()
  546. }
  547. func (user *User) IsLoggedIn() bool {
  548. return user.IsConnected() && user.Client.IsLoggedIn()
  549. }
  550. func (user *User) tryAutomaticDoublePuppeting() {
  551. if !user.bridge.Config.CanAutoDoublePuppet(user.MXID) {
  552. return
  553. }
  554. user.log.Debugln("Checking if double puppeting needs to be enabled")
  555. puppet := user.bridge.GetPuppetByJID(user.JID)
  556. if len(puppet.CustomMXID) > 0 {
  557. user.log.Debugln("User already has double-puppeting enabled")
  558. // Custom puppet already enabled
  559. return
  560. }
  561. accessToken, err := puppet.loginWithSharedSecret(user.MXID)
  562. if err != nil {
  563. user.log.Warnln("Failed to login with shared secret:", err)
  564. return
  565. }
  566. err = puppet.SwitchCustomMXID(accessToken, user.MXID)
  567. if err != nil {
  568. puppet.log.Warnln("Failed to switch to auto-logined custom puppet:", err)
  569. return
  570. }
  571. user.log.Infoln("Successfully automatically enabled custom puppet")
  572. }
  573. func (user *User) sendMarkdownBridgeAlert(formatString string, args ...interface{}) {
  574. if user.bridge.Config.Bridge.DisableBridgeAlerts {
  575. return
  576. }
  577. notice := fmt.Sprintf(formatString, args...)
  578. content := format.RenderMarkdown(notice, true, false)
  579. _, err := user.bridge.Bot.SendMessageEvent(user.GetManagementRoom(), event.EventMessage, content)
  580. if err != nil {
  581. user.log.Warnf("Failed to send bridge alert \"%s\": %v", notice, err)
  582. }
  583. }
  584. const callEventMaxAge = 15 * time.Minute
  585. func (user *User) handleCallStart(sender types.JID, id, callType string, ts time.Time) {
  586. if !user.bridge.Config.Bridge.CallStartNotices || ts.Add(callEventMaxAge).Before(time.Now()) {
  587. return
  588. }
  589. portal := user.GetPortalByJID(sender)
  590. text := "Incoming call"
  591. if callType != "" {
  592. text = fmt.Sprintf("Incoming %s call", callType)
  593. }
  594. portal.messages <- PortalMessage{
  595. fake: &fakeMessage{
  596. Sender: sender,
  597. Text: text,
  598. ID: id,
  599. Time: ts,
  600. Important: true,
  601. },
  602. source: user,
  603. }
  604. }
  605. const PhoneDisconnectWarningTime = 12 * 24 * time.Hour // 12 days
  606. const PhoneDisconnectPingTime = 10 * 24 * time.Hour
  607. const PhoneMinPingInterval = 24 * time.Hour
  608. func (user *User) sendHackyPhonePing() {
  609. user.PhoneLastPinged = time.Now()
  610. msgID := whatsmeow.GenerateMessageID()
  611. keyIDs := make([]*waProto.AppStateSyncKeyId, 0, 1)
  612. lastKeyID, err := user.GetLastAppStateKeyID()
  613. if lastKeyID != nil {
  614. keyIDs = append(keyIDs, &waProto.AppStateSyncKeyId{
  615. KeyId: lastKeyID,
  616. })
  617. } else {
  618. user.log.Warnfln("Failed to get last app state key ID to send hacky phone ping: %v - sending empty request", err)
  619. }
  620. resp, err := user.Client.SendMessage(context.Background(), user.JID.ToNonAD(), &waProto.Message{
  621. ProtocolMessage: &waProto.ProtocolMessage{
  622. Type: waProto.ProtocolMessage_APP_STATE_SYNC_KEY_REQUEST.Enum(),
  623. AppStateSyncKeyRequest: &waProto.AppStateSyncKeyRequest{
  624. KeyIds: keyIDs,
  625. },
  626. },
  627. }, whatsmeow.SendRequestExtra{Peer: true, ID: msgID})
  628. if err != nil {
  629. user.log.Warnfln("Failed to send hacky phone ping: %v", err)
  630. } else {
  631. user.log.Debugfln("Sent hacky phone ping %s/%s because phone has been offline for >10 days", msgID, resp.Timestamp.Unix())
  632. user.PhoneLastPinged = resp.Timestamp
  633. user.Update()
  634. }
  635. }
  636. func (user *User) PhoneRecentlySeen(doPing bool) bool {
  637. if doPing && !user.PhoneLastSeen.IsZero() && user.PhoneLastSeen.Add(PhoneDisconnectPingTime).Before(time.Now()) && user.PhoneLastPinged.Add(PhoneMinPingInterval).Before(time.Now()) {
  638. // Over 10 days since the phone was seen and over a day since the last somewhat hacky ping, send a new ping.
  639. go user.sendHackyPhonePing()
  640. }
  641. return user.PhoneLastSeen.IsZero() || user.PhoneLastSeen.Add(PhoneDisconnectWarningTime).After(time.Now())
  642. }
  643. // phoneSeen records a timestamp when the user's main device was seen online.
  644. // The stored timestamp can later be used to warn the user if the main device is offline for too long.
  645. func (user *User) phoneSeen(ts time.Time) {
  646. if user.PhoneLastSeen.Add(1 * time.Hour).After(ts) {
  647. // The last seen timestamp isn't going to be perfectly accurate in any case,
  648. // so don't spam the database with an update every time there's an event.
  649. return
  650. } else if !user.PhoneRecentlySeen(false) {
  651. if user.BridgeState.GetPrev().Error == WAPhoneOffline && user.IsConnected() {
  652. user.log.Debugfln("Saw phone after current bridge state said it has been offline, switching state back to connected")
  653. user.BridgeState.Send(status.BridgeState{StateEvent: status.StateConnected})
  654. } else {
  655. 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())
  656. }
  657. }
  658. user.PhoneLastSeen = ts
  659. go user.Update()
  660. }
  661. func formatDisconnectTime(dur time.Duration) string {
  662. days := int(math.Floor(dur.Hours() / 24))
  663. hours := int(dur.Hours()) % 24
  664. if hours == 0 {
  665. return fmt.Sprintf("%d days", days)
  666. } else if hours == 1 {
  667. return fmt.Sprintf("%d days and 1 hour", days)
  668. } else {
  669. return fmt.Sprintf("%d days and %d hours", days, hours)
  670. }
  671. }
  672. func (user *User) sendPhoneOfflineWarning() {
  673. if user.lastPhoneOfflineWarning.Add(12 * time.Hour).After(time.Now()) {
  674. // Don't spam the warning too much
  675. return
  676. }
  677. user.lastPhoneOfflineWarning = time.Now()
  678. timeSinceSeen := time.Now().Sub(user.PhoneLastSeen)
  679. 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))
  680. }
  681. func (user *User) HandleEvent(event interface{}) {
  682. switch v := event.(type) {
  683. case *events.LoggedOut:
  684. go user.handleLoggedOut(v.OnConnect, v.Reason)
  685. case *events.Connected:
  686. user.bridge.Metrics.TrackConnectionState(user.JID, true)
  687. user.bridge.Metrics.TrackLoginState(user.JID, true)
  688. if len(user.Client.Store.PushName) > 0 {
  689. go func() {
  690. err := user.Client.SendPresence(user.lastPresence)
  691. if err != nil {
  692. user.log.Warnln("Failed to send initial presence:", err)
  693. }
  694. }()
  695. }
  696. go user.tryAutomaticDoublePuppeting()
  697. if user.bridge.Config.Bridge.HistorySync.Backfill && !user.historySyncLoopsStarted {
  698. go user.handleHistorySyncsLoop()
  699. user.historySyncLoopsStarted = true
  700. }
  701. case *events.OfflineSyncPreview:
  702. user.log.Infofln("Server says it's going to send %d messages and %d receipts that were missed during downtime", v.Messages, v.Receipts)
  703. user.BridgeState.Send(status.BridgeState{
  704. StateEvent: status.StateBackfilling,
  705. Message: fmt.Sprintf("backfilling %d messages and %d receipts", v.Messages, v.Receipts),
  706. })
  707. case *events.OfflineSyncCompleted:
  708. if !user.PhoneRecentlySeen(true) {
  709. user.log.Infofln("Offline sync completed, but phone last seen date is still %s - sending phone offline bridge status", user.PhoneLastSeen)
  710. user.BridgeState.Send(status.BridgeState{StateEvent: status.StateTransientDisconnect, Error: WAPhoneOffline})
  711. } else {
  712. if user.BridgeState.GetPrev().StateEvent == status.StateBackfilling {
  713. user.log.Infoln("Offline sync completed")
  714. }
  715. user.BridgeState.Send(status.BridgeState{StateEvent: status.StateConnected})
  716. }
  717. case *events.AppStateSyncComplete:
  718. if len(user.Client.Store.PushName) > 0 && v.Name == appstate.WAPatchCriticalBlock {
  719. err := user.Client.SendPresence(user.lastPresence)
  720. if err != nil {
  721. user.log.Warnln("Failed to send presence after app state sync:", err)
  722. }
  723. } else if v.Name == appstate.WAPatchCriticalUnblockLow {
  724. go func() {
  725. err := user.ResyncContacts(false)
  726. if err != nil {
  727. user.log.Errorln("Failed to resync puppets: %v", err)
  728. }
  729. }()
  730. }
  731. case *events.PushNameSetting:
  732. // Send presence available when connecting and when the pushname is changed.
  733. // This makes sure that outgoing messages always have the right pushname.
  734. err := user.Client.SendPresence(user.lastPresence)
  735. if err != nil {
  736. user.log.Warnln("Failed to send presence after push name update:", err)
  737. }
  738. _, _, err = user.Client.Store.Contacts.PutPushName(user.JID.ToNonAD(), v.Action.GetName())
  739. if err != nil {
  740. user.log.Warnln("Failed to update push name in store:", err)
  741. }
  742. go user.syncPuppet(user.JID.ToNonAD(), "push name setting")
  743. case *events.PairSuccess:
  744. user.PhoneLastSeen = time.Now()
  745. user.Session = user.Client.Store
  746. user.JID = v.ID
  747. user.addToJIDMap()
  748. user.Update()
  749. case *events.StreamError:
  750. var message string
  751. if v.Code != "" {
  752. message = fmt.Sprintf("Unknown stream error with code %s", v.Code)
  753. } else if children := v.Raw.GetChildren(); len(children) > 0 {
  754. message = fmt.Sprintf("Unknown stream error (contains %s node)", children[0].Tag)
  755. } else {
  756. message = "Unknown stream error"
  757. }
  758. user.BridgeState.Send(status.BridgeState{StateEvent: status.StateUnknownError, Message: message})
  759. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  760. case *events.StreamReplaced:
  761. if user.bridge.Config.Bridge.CrashOnStreamReplaced {
  762. user.log.Infofln("Stopping bridge due to StreamReplaced event")
  763. user.bridge.ManualStop(60)
  764. } else {
  765. user.BridgeState.Send(status.BridgeState{StateEvent: status.StateUnknownError, Message: "Stream replaced"})
  766. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  767. user.sendMarkdownBridgeAlert("The bridge was started in another location. Use `reconnect` to reconnect this one.")
  768. }
  769. case *events.ConnectFailure:
  770. user.BridgeState.Send(status.BridgeState{StateEvent: status.StateUnknownError, Message: fmt.Sprintf("Unknown connection failure: %s (%s)", v.Reason, v.Message)})
  771. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  772. user.bridge.Metrics.TrackConnectionFailure(fmt.Sprintf("status-%d", v.Reason))
  773. case *events.ClientOutdated:
  774. user.log.Errorfln("Got a client outdated connect failure. The bridge is likely out of date, please update immediately.")
  775. user.BridgeState.Send(status.BridgeState{StateEvent: status.StateUnknownError, Message: "Connect failure: 405 client outdated"})
  776. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  777. user.bridge.Metrics.TrackConnectionFailure("client-outdated")
  778. case *events.TemporaryBan:
  779. user.BridgeState.Send(status.BridgeState{StateEvent: status.StateBadCredentials, Message: v.String()})
  780. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  781. user.bridge.Metrics.TrackConnectionFailure("temporary-ban")
  782. case *events.Disconnected:
  783. // Don't send the normal transient disconnect state if we're already in a different transient disconnect state.
  784. // TODO remove this if/when the phone offline state is moved to a sub-state of CONNECTED
  785. if user.BridgeState.GetPrev().Error != WAPhoneOffline && user.PhoneRecentlySeen(false) {
  786. user.BridgeState.Send(status.BridgeState{StateEvent: status.StateTransientDisconnect, Error: WADisconnected})
  787. }
  788. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  789. case *events.Contact:
  790. go user.syncPuppet(v.JID, "contact event")
  791. case *events.PushName:
  792. go user.syncPuppet(v.JID, "push name event")
  793. case *events.BusinessName:
  794. go user.syncPuppet(v.JID, "business name event")
  795. case *events.GroupInfo:
  796. user.groupListCache = nil
  797. go user.handleGroupUpdate(v)
  798. case *events.JoinedGroup:
  799. user.groupListCache = nil
  800. go user.handleGroupCreate(v)
  801. case *events.Picture:
  802. go user.handlePictureUpdate(v)
  803. case *events.Receipt:
  804. if v.IsFromMe && v.Sender.Device == 0 {
  805. user.phoneSeen(v.Timestamp)
  806. }
  807. go user.handleReceipt(v)
  808. case *events.ChatPresence:
  809. go user.handleChatPresence(v)
  810. case *events.Message:
  811. portal := user.GetPortalByMessageSource(v.Info.MessageSource)
  812. portal.messages <- PortalMessage{evt: v, source: user}
  813. case *events.MediaRetry:
  814. user.phoneSeen(v.Timestamp)
  815. portal := user.GetPortalByJID(v.ChatID)
  816. portal.mediaRetries <- PortalMediaRetry{evt: v, source: user}
  817. case *events.CallOffer:
  818. user.handleCallStart(v.CallCreator, v.CallID, "", v.Timestamp)
  819. case *events.CallOfferNotice:
  820. user.handleCallStart(v.CallCreator, v.CallID, v.Type, v.Timestamp)
  821. case *events.IdentityChange:
  822. puppet := user.bridge.GetPuppetByJID(v.JID)
  823. portal := user.GetPortalByJID(v.JID)
  824. if len(portal.MXID) > 0 && user.bridge.Config.Bridge.IdentityChangeNotices {
  825. text := fmt.Sprintf("Your security code with %s changed.", puppet.Displayname)
  826. if v.Implicit {
  827. text = fmt.Sprintf("Your security code with %s (device #%d) changed.", puppet.Displayname, v.JID.Device)
  828. }
  829. portal.messages <- PortalMessage{
  830. fake: &fakeMessage{
  831. Sender: v.JID,
  832. Text: text,
  833. ID: strconv.FormatInt(v.Timestamp.Unix(), 10),
  834. Time: v.Timestamp,
  835. Important: false,
  836. },
  837. source: user,
  838. }
  839. }
  840. case *events.CallTerminate, *events.CallRelayLatency, *events.CallAccept, *events.UnknownCallEvent:
  841. // ignore
  842. case *events.UndecryptableMessage:
  843. portal := user.GetPortalByMessageSource(v.Info.MessageSource)
  844. portal.messages <- PortalMessage{undecryptable: v, source: user}
  845. case *events.HistorySync:
  846. if user.bridge.Config.Bridge.HistorySync.Backfill {
  847. user.historySyncs <- v
  848. }
  849. case *events.Mute:
  850. portal := user.GetPortalByJID(v.JID)
  851. if portal != nil {
  852. var mutedUntil time.Time
  853. if v.Action.GetMuted() {
  854. mutedUntil = time.Unix(v.Action.GetMuteEndTimestamp(), 0)
  855. }
  856. go user.updateChatMute(nil, portal, mutedUntil)
  857. }
  858. case *events.Archive:
  859. portal := user.GetPortalByJID(v.JID)
  860. if portal != nil {
  861. go user.updateChatTag(nil, portal, user.bridge.Config.Bridge.ArchiveTag, v.Action.GetArchived())
  862. }
  863. case *events.Pin:
  864. portal := user.GetPortalByJID(v.JID)
  865. if portal != nil {
  866. go user.updateChatTag(nil, portal, user.bridge.Config.Bridge.PinnedTag, v.Action.GetPinned())
  867. }
  868. case *events.AppState:
  869. // Ignore
  870. case *events.KeepAliveTimeout:
  871. user.BridgeState.Send(status.BridgeState{StateEvent: status.StateTransientDisconnect, Error: WAKeepaliveTimeout})
  872. case *events.KeepAliveRestored:
  873. user.log.Infof("Keepalive restored after timeouts, sending connected event")
  874. user.BridgeState.Send(status.BridgeState{StateEvent: status.StateConnected})
  875. case *events.MarkChatAsRead:
  876. if user.bridge.Config.Bridge.SyncManualMarkedUnread {
  877. user.markUnread(user.GetPortalByJID(v.JID), !v.Action.GetRead())
  878. }
  879. case *events.DeleteForMe:
  880. portal := user.GetPortalByJID(v.ChatJID)
  881. if portal != nil {
  882. portal.deleteForMe(user, v)
  883. }
  884. case *events.DeleteChat:
  885. portal := user.GetPortalByJID(v.JID)
  886. if portal != nil {
  887. portal.HandleWhatsAppDeleteChat(user)
  888. }
  889. default:
  890. user.log.Debugfln("Unknown type of event in HandleEvent: %T", v)
  891. }
  892. }
  893. func (user *User) updateChatMute(intent *appservice.IntentAPI, portal *Portal, mutedUntil time.Time) {
  894. if len(portal.MXID) == 0 || !user.bridge.Config.Bridge.MuteBridging {
  895. return
  896. } else if intent == nil {
  897. doublePuppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  898. if doublePuppet == nil || doublePuppet.CustomIntent() == nil {
  899. return
  900. }
  901. intent = doublePuppet.CustomIntent()
  902. }
  903. var err error
  904. if mutedUntil.IsZero() && mutedUntil.Before(time.Now()) {
  905. user.log.Debugfln("Portal %s is muted until %s, unmuting...", portal.MXID, mutedUntil)
  906. err = intent.DeletePushRule("global", pushrules.RoomRule, string(portal.MXID))
  907. } else {
  908. user.log.Debugfln("Portal %s is muted until %s, muting...", portal.MXID, mutedUntil)
  909. err = intent.PutPushRule("global", pushrules.RoomRule, string(portal.MXID), &mautrix.ReqPutPushRule{
  910. Actions: []pushrules.PushActionType{pushrules.ActionDontNotify},
  911. })
  912. }
  913. if err != nil && !errors.Is(err, mautrix.MNotFound) {
  914. user.log.Warnfln("Failed to update push rule for %s through double puppet: %v", portal.MXID, err)
  915. }
  916. }
  917. type CustomTagData struct {
  918. Order json.Number `json:"order"`
  919. DoublePuppet string `json:"fi.mau.double_puppet_source"`
  920. }
  921. type CustomTagEventContent struct {
  922. Tags map[string]CustomTagData `json:"tags"`
  923. }
  924. func (user *User) updateChatTag(intent *appservice.IntentAPI, portal *Portal, tag string, active bool) {
  925. if len(portal.MXID) == 0 || len(tag) == 0 {
  926. return
  927. } else if intent == nil {
  928. doublePuppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  929. if doublePuppet == nil || doublePuppet.CustomIntent() == nil {
  930. return
  931. }
  932. intent = doublePuppet.CustomIntent()
  933. }
  934. var existingTags CustomTagEventContent
  935. err := intent.GetTagsWithCustomData(portal.MXID, &existingTags)
  936. if err != nil && !errors.Is(err, mautrix.MNotFound) {
  937. user.log.Warnfln("Failed to get tags of %s: %v", portal.MXID, err)
  938. }
  939. currentTag, ok := existingTags.Tags[tag]
  940. if active && !ok {
  941. user.log.Debugln("Adding tag", tag, "to", portal.MXID)
  942. data := CustomTagData{Order: "0.5", DoublePuppet: user.bridge.Name}
  943. err = intent.AddTagWithCustomData(portal.MXID, tag, &data)
  944. } else if !active && ok && currentTag.DoublePuppet == user.bridge.Name {
  945. user.log.Debugln("Removing tag", tag, "from", portal.MXID)
  946. err = intent.RemoveTag(portal.MXID, tag)
  947. } else {
  948. err = nil
  949. }
  950. if err != nil {
  951. user.log.Warnfln("Failed to update tag %s for %s through double puppet: %v", tag, portal.MXID, err)
  952. }
  953. }
  954. type CustomReadReceipt struct {
  955. Timestamp int64 `json:"ts,omitempty"`
  956. DoublePuppetSource string `json:"fi.mau.double_puppet_source,omitempty"`
  957. }
  958. type CustomReadMarkers struct {
  959. mautrix.ReqSetReadMarkers
  960. ReadExtra CustomReadReceipt `json:"com.beeper.read.extra"`
  961. FullyReadExtra CustomReadReceipt `json:"com.beeper.fully_read.extra"`
  962. }
  963. func (user *User) syncChatDoublePuppetDetails(portal *Portal, justCreated bool) {
  964. doublePuppet := portal.bridge.GetPuppetByCustomMXID(user.MXID)
  965. if doublePuppet == nil {
  966. return
  967. }
  968. if doublePuppet == nil || doublePuppet.CustomIntent() == nil || len(portal.MXID) == 0 {
  969. return
  970. }
  971. if justCreated || !user.bridge.Config.Bridge.TagOnlyOnCreate {
  972. chat, err := user.Client.Store.ChatSettings.GetChatSettings(portal.Key.JID)
  973. if err != nil {
  974. user.log.Warnfln("Failed to get settings of %s: %v", portal.Key.JID, err)
  975. return
  976. }
  977. intent := doublePuppet.CustomIntent()
  978. if portal.Key.JID == types.StatusBroadcastJID && justCreated {
  979. if user.bridge.Config.Bridge.MuteStatusBroadcast {
  980. user.updateChatMute(intent, portal, time.Now().Add(365*24*time.Hour))
  981. }
  982. if len(user.bridge.Config.Bridge.StatusBroadcastTag) > 0 {
  983. user.updateChatTag(intent, portal, user.bridge.Config.Bridge.StatusBroadcastTag, true)
  984. }
  985. return
  986. } else if !chat.Found {
  987. return
  988. }
  989. user.updateChatMute(intent, portal, chat.MutedUntil)
  990. user.updateChatTag(intent, portal, user.bridge.Config.Bridge.ArchiveTag, chat.Archived)
  991. user.updateChatTag(intent, portal, user.bridge.Config.Bridge.PinnedTag, chat.Pinned)
  992. }
  993. }
  994. func (user *User) getDirectChats() map[id.UserID][]id.RoomID {
  995. res := make(map[id.UserID][]id.RoomID)
  996. privateChats := user.bridge.DB.Portal.FindPrivateChats(user.JID.ToNonAD())
  997. for _, portal := range privateChats {
  998. if len(portal.MXID) > 0 {
  999. res[user.bridge.FormatPuppetMXID(portal.Key.JID)] = []id.RoomID{portal.MXID}
  1000. }
  1001. }
  1002. return res
  1003. }
  1004. func (user *User) UpdateDirectChats(chats map[id.UserID][]id.RoomID) {
  1005. if !user.bridge.Config.Bridge.SyncDirectChatList {
  1006. return
  1007. }
  1008. puppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  1009. if puppet == nil || puppet.CustomIntent() == nil {
  1010. return
  1011. }
  1012. intent := puppet.CustomIntent()
  1013. method := http.MethodPatch
  1014. if chats == nil {
  1015. chats = user.getDirectChats()
  1016. method = http.MethodPut
  1017. }
  1018. user.log.Debugln("Updating m.direct list on homeserver")
  1019. var err error
  1020. if user.bridge.Config.Homeserver.Software == bridgeconfig.SoftwareAsmux {
  1021. urlPath := intent.BuildClientURL("unstable", "com.beeper.asmux", "dms")
  1022. _, err = intent.MakeFullRequest(mautrix.FullRequest{
  1023. Method: method,
  1024. URL: urlPath,
  1025. Headers: http.Header{"X-Asmux-Auth": {user.bridge.AS.Registration.AppToken}},
  1026. RequestJSON: chats,
  1027. })
  1028. } else {
  1029. existingChats := make(map[id.UserID][]id.RoomID)
  1030. err = intent.GetAccountData(event.AccountDataDirectChats.Type, &existingChats)
  1031. if err != nil {
  1032. user.log.Warnln("Failed to get m.direct list to update it:", err)
  1033. return
  1034. }
  1035. for userID, rooms := range existingChats {
  1036. if _, ok := user.bridge.ParsePuppetMXID(userID); !ok {
  1037. // This is not a ghost user, include it in the new list
  1038. chats[userID] = rooms
  1039. } else if _, ok := chats[userID]; !ok && method == http.MethodPatch {
  1040. // This is a ghost user, but we're not replacing the whole list, so include it too
  1041. chats[userID] = rooms
  1042. }
  1043. }
  1044. err = intent.SetAccountData(event.AccountDataDirectChats.Type, &chats)
  1045. }
  1046. if err != nil {
  1047. user.log.Warnln("Failed to update m.direct list:", err)
  1048. }
  1049. }
  1050. func (user *User) handleLoggedOut(onConnect bool, reason events.ConnectFailureReason) {
  1051. errorCode := WAUnknownLogout
  1052. if reason == events.ConnectFailureLoggedOut {
  1053. errorCode = WALoggedOut
  1054. } else if reason == events.ConnectFailureMainDeviceGone {
  1055. errorCode = WAMainDeviceGone
  1056. }
  1057. user.removeFromJIDMap(status.BridgeState{StateEvent: status.StateBadCredentials, Error: errorCode})
  1058. user.DeleteConnection()
  1059. user.Session = nil
  1060. user.JID = types.EmptyJID
  1061. user.Update()
  1062. if onConnect {
  1063. user.sendMarkdownBridgeAlert("Connecting to WhatsApp failed as the device was unlinked (error %s). Please link the bridge to your phone again.", reason)
  1064. } else {
  1065. user.sendMarkdownBridgeAlert("You were logged out from another device. Please link the bridge to your phone again.")
  1066. }
  1067. }
  1068. func (user *User) GetPortalByMessageSource(ms types.MessageSource) *Portal {
  1069. jid := ms.Chat
  1070. if ms.IsIncomingBroadcast() {
  1071. if ms.IsFromMe {
  1072. jid = ms.BroadcastListOwner.ToNonAD()
  1073. } else {
  1074. jid = ms.Sender.ToNonAD()
  1075. }
  1076. if jid.IsEmpty() {
  1077. return nil
  1078. }
  1079. }
  1080. return user.bridge.GetPortalByJID(database.NewPortalKey(jid, user.JID))
  1081. }
  1082. func (user *User) GetPortalByJID(jid types.JID) *Portal {
  1083. return user.bridge.GetPortalByJID(database.NewPortalKey(jid, user.JID))
  1084. }
  1085. func (user *User) syncPuppet(jid types.JID, reason string) {
  1086. user.bridge.GetPuppetByJID(jid).SyncContact(user, false, false, reason)
  1087. }
  1088. func (user *User) ResyncContacts(forceAvatarSync bool) error {
  1089. contacts, err := user.Client.Store.Contacts.GetAllContacts()
  1090. if err != nil {
  1091. return fmt.Errorf("failed to get cached contacts: %w", err)
  1092. }
  1093. user.log.Infofln("Resyncing displaynames with %d contacts", len(contacts))
  1094. for jid, contact := range contacts {
  1095. puppet := user.bridge.GetPuppetByJID(jid)
  1096. if puppet != nil {
  1097. puppet.Sync(user, &contact, forceAvatarSync, true)
  1098. } else {
  1099. user.log.Warnfln("Got a nil puppet for %s while syncing contacts", jid)
  1100. }
  1101. }
  1102. return nil
  1103. }
  1104. func (user *User) ResyncGroups(createPortals bool) error {
  1105. groups, err := user.Client.GetJoinedGroups()
  1106. if err != nil {
  1107. return fmt.Errorf("failed to get group list from server: %w", err)
  1108. }
  1109. user.groupListCacheLock.Lock()
  1110. user.groupListCache = groups
  1111. user.groupListCacheTime = time.Now()
  1112. user.groupListCacheLock.Unlock()
  1113. for _, group := range groups {
  1114. portal := user.GetPortalByJID(group.JID)
  1115. if len(portal.MXID) == 0 {
  1116. if createPortals {
  1117. err = portal.CreateMatrixRoom(user, group, true, true)
  1118. if err != nil {
  1119. return fmt.Errorf("failed to create room for %s: %w", group.JID, err)
  1120. }
  1121. }
  1122. } else {
  1123. portal.UpdateMatrixRoom(user, group)
  1124. }
  1125. }
  1126. return nil
  1127. }
  1128. const WATypingTimeout = 15 * time.Second
  1129. func (user *User) handleChatPresence(presence *events.ChatPresence) {
  1130. puppet := user.bridge.GetPuppetByJID(presence.Sender)
  1131. portal := user.GetPortalByJID(presence.Chat)
  1132. if puppet == nil || portal == nil || len(portal.MXID) == 0 {
  1133. return
  1134. }
  1135. if presence.State == types.ChatPresenceComposing {
  1136. if puppet.typingIn != "" && puppet.typingAt.Add(WATypingTimeout).Before(time.Now()) {
  1137. if puppet.typingIn == portal.MXID {
  1138. return
  1139. }
  1140. _, _ = puppet.IntentFor(portal).UserTyping(puppet.typingIn, false, 0)
  1141. }
  1142. _, _ = puppet.IntentFor(portal).UserTyping(portal.MXID, true, WATypingTimeout)
  1143. puppet.typingIn = portal.MXID
  1144. puppet.typingAt = time.Now()
  1145. } else {
  1146. _, _ = puppet.IntentFor(portal).UserTyping(portal.MXID, false, 0)
  1147. puppet.typingIn = ""
  1148. }
  1149. }
  1150. func (user *User) handleReceipt(receipt *events.Receipt) {
  1151. if receipt.Type != events.ReceiptTypeRead && receipt.Type != events.ReceiptTypeReadSelf {
  1152. return
  1153. }
  1154. portal := user.GetPortalByMessageSource(receipt.MessageSource)
  1155. if portal == nil || len(portal.MXID) == 0 {
  1156. return
  1157. }
  1158. portal.messages <- PortalMessage{receipt: receipt, source: user}
  1159. }
  1160. func (user *User) makeReadMarkerContent(eventID id.EventID, doublePuppet bool) CustomReadMarkers {
  1161. var extra CustomReadReceipt
  1162. if doublePuppet {
  1163. extra.DoublePuppetSource = user.bridge.Name
  1164. }
  1165. return CustomReadMarkers{
  1166. ReqSetReadMarkers: mautrix.ReqSetReadMarkers{
  1167. Read: eventID,
  1168. FullyRead: eventID,
  1169. },
  1170. ReadExtra: extra,
  1171. FullyReadExtra: extra,
  1172. }
  1173. }
  1174. func (user *User) markSelfReadFull(portal *Portal) {
  1175. puppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  1176. if puppet == nil || puppet.CustomIntent() == nil {
  1177. return
  1178. }
  1179. lastMessage := user.bridge.DB.Message.GetLastInChat(portal.Key)
  1180. if lastMessage == nil {
  1181. return
  1182. }
  1183. user.SetLastReadTS(portal.Key, lastMessage.Timestamp)
  1184. err := puppet.CustomIntent().SetReadMarkers(portal.MXID, user.makeReadMarkerContent(lastMessage.MXID, true))
  1185. if err != nil {
  1186. user.log.Warnfln("Failed to mark %s (last message) in %s as read: %v", lastMessage.MXID, portal.MXID, err)
  1187. } else {
  1188. user.log.Debugfln("Marked %s (last message) in %s as read", lastMessage.MXID, portal.MXID)
  1189. }
  1190. }
  1191. func (user *User) markUnread(portal *Portal, unread bool) {
  1192. puppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  1193. if puppet == nil || puppet.CustomIntent() == nil {
  1194. return
  1195. }
  1196. err := puppet.CustomIntent().SetRoomAccountData(portal.MXID, "m.marked_unread",
  1197. map[string]bool{"unread": unread})
  1198. if err != nil {
  1199. user.log.Warnfln("Failed to mark %s as unread via m.marked_unread: %v", portal.MXID, err)
  1200. } else {
  1201. user.log.Debugfln("Marked %s as unread via m.marked_unread: %v", portal.MXID, err)
  1202. }
  1203. err = puppet.CustomIntent().SetRoomAccountData(portal.MXID, "com.famedly.marked_unread",
  1204. map[string]bool{"unread": unread})
  1205. if err != nil {
  1206. user.log.Warnfln("Failed to mark %s as unread via com.famedly.marked_unread: %v", portal.MXID, err)
  1207. } else {
  1208. user.log.Debugfln("Marked %s as unread via com.famedly.marked_unread: %v", portal.MXID, err)
  1209. }
  1210. }
  1211. func (user *User) handleGroupCreate(evt *events.JoinedGroup) {
  1212. portal := user.GetPortalByJID(evt.JID)
  1213. if evt.CreateKey == "" && len(portal.MXID) == 0 && portal.Key.JID != user.skipGroupCreateDelay {
  1214. user.log.Debugfln("Delaying handling group create with empty key to avoid race conditions")
  1215. time.Sleep(5 * time.Second)
  1216. }
  1217. if len(portal.MXID) == 0 {
  1218. if user.createKeyDedup != "" && evt.CreateKey == user.createKeyDedup {
  1219. user.log.Debugfln("Ignoring group create event with key %s", evt.CreateKey)
  1220. return
  1221. }
  1222. err := portal.CreateMatrixRoom(user, &evt.GroupInfo, true, true)
  1223. if err != nil {
  1224. user.log.Errorln("Failed to create Matrix room after join notification: %v", err)
  1225. }
  1226. } else {
  1227. portal.UpdateMatrixRoom(user, &evt.GroupInfo)
  1228. }
  1229. }
  1230. func (user *User) handleGroupUpdate(evt *events.GroupInfo) {
  1231. portal := user.GetPortalByJID(evt.JID)
  1232. with := user.zlog.With().
  1233. Str("chat_jid", evt.JID.String()).
  1234. Interface("group_event", evt)
  1235. if portal != nil {
  1236. with = with.Str("portal_mxid", portal.MXID.String())
  1237. }
  1238. log := with.Logger()
  1239. if portal == nil || len(portal.MXID) == 0 {
  1240. log.Debug().Msg("Ignoring group info update in chat with no portal")
  1241. return
  1242. }
  1243. switch {
  1244. case evt.Announce != nil:
  1245. log.Debug().Msg("Group announcement mode (message send permission) changed")
  1246. portal.RestrictMessageSending(evt.Announce.IsAnnounce)
  1247. case evt.Locked != nil:
  1248. log.Debug().Msg("Group locked mode (metadata change permission) changed")
  1249. portal.RestrictMetadataChanges(evt.Locked.IsLocked)
  1250. case evt.Name != nil:
  1251. log.Debug().Msg("Group name changed")
  1252. portal.UpdateName(evt.Name.Name, evt.Name.NameSetBy, true)
  1253. case evt.Topic != nil:
  1254. log.Debug().Msg("Group topic changed")
  1255. portal.UpdateTopic(evt.Topic.Topic, evt.Topic.TopicSetBy, true)
  1256. case evt.Leave != nil:
  1257. log.Debug().Msg("Someone left the group")
  1258. if evt.Sender != nil && !evt.Sender.IsEmpty() {
  1259. portal.HandleWhatsAppKick(user, *evt.Sender, evt.Leave)
  1260. }
  1261. case evt.Join != nil:
  1262. log.Debug().Msg("Someone joined the group")
  1263. portal.HandleWhatsAppInvite(user, evt.Sender, evt.Join)
  1264. case evt.Promote != nil:
  1265. log.Debug().Msg("Someone was promoted to admin")
  1266. portal.ChangeAdminStatus(evt.Promote, true)
  1267. case evt.Demote != nil:
  1268. log.Debug().Msg("Someone was demoted from admin")
  1269. portal.ChangeAdminStatus(evt.Demote, false)
  1270. case evt.Ephemeral != nil:
  1271. log.Debug().Msg("Group ephemeral mode (disappearing message timer) changed")
  1272. portal.UpdateGroupDisappearingMessages(evt.Sender, evt.Timestamp, evt.Ephemeral.DisappearingTimer)
  1273. case evt.Link != nil:
  1274. log.Debug().Msg("Group parent changed")
  1275. if evt.Link.Type == types.GroupLinkChangeTypeParent {
  1276. portal.UpdateParentGroup(user, evt.Link.Group.JID, true)
  1277. }
  1278. case evt.Unlink != nil:
  1279. log.Debug().Msg("Group parent removed")
  1280. if evt.Unlink.Type == types.GroupLinkChangeTypeParent && portal.ParentGroup == evt.Unlink.Group.JID {
  1281. portal.UpdateParentGroup(user, types.EmptyJID, true)
  1282. }
  1283. case evt.Delete != nil:
  1284. log.Debug().Msg("Group deleted")
  1285. portal.Delete()
  1286. portal.Cleanup(false)
  1287. default:
  1288. log.Warn().Msg("Unhandled group info update")
  1289. }
  1290. }
  1291. func (user *User) handlePictureUpdate(evt *events.Picture) {
  1292. if evt.JID.Server == types.DefaultUserServer {
  1293. puppet := user.bridge.GetPuppetByJID(evt.JID)
  1294. user.log.Debugfln("Received picture update for puppet %s (current: %s, new: %s)", evt.JID, puppet.Avatar, evt.PictureID)
  1295. if puppet.Avatar != evt.PictureID {
  1296. puppet.Sync(user, nil, true, false)
  1297. }
  1298. } else if portal := user.GetPortalByJID(evt.JID); portal != nil {
  1299. user.log.Debugfln("Received picture update for portal %s (current: %s, new: %s)", evt.JID, portal.Avatar, evt.PictureID)
  1300. if portal.Avatar != evt.PictureID {
  1301. portal.UpdateAvatar(user, evt.Author, true)
  1302. }
  1303. }
  1304. }
  1305. func (user *User) StartPM(jid types.JID, reason string) (*Portal, *Puppet, bool, error) {
  1306. user.log.Debugln("Starting PM with", jid, "from", reason)
  1307. puppet := user.bridge.GetPuppetByJID(jid)
  1308. puppet.SyncContact(user, true, false, reason)
  1309. portal := user.GetPortalByJID(puppet.JID)
  1310. if len(portal.MXID) > 0 {
  1311. ok := portal.ensureUserInvited(user)
  1312. if !ok {
  1313. portal.log.Warnfln("ensureUserInvited(%s) returned false, creating new portal", user.MXID)
  1314. portal.MXID = ""
  1315. } else {
  1316. return portal, puppet, false, nil
  1317. }
  1318. }
  1319. err := portal.CreateMatrixRoom(user, nil, false, true)
  1320. return portal, puppet, true, err
  1321. }
  1322. const groupListCacheMaxAge = 24 * time.Hour
  1323. func (user *User) getCachedGroupList() ([]*types.GroupInfo, error) {
  1324. user.groupListCacheLock.Lock()
  1325. defer user.groupListCacheLock.Unlock()
  1326. if user.groupListCache != nil && user.groupListCacheTime.Add(groupListCacheMaxAge).After(time.Now()) {
  1327. return user.groupListCache, nil
  1328. }
  1329. var err error
  1330. user.groupListCache, err = user.Client.GetJoinedGroups()
  1331. user.groupListCacheTime = time.Now()
  1332. return user.groupListCache, err
  1333. }