user.go 47 KB

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