user.go 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110
  1. // mautrix-whatsapp - A Matrix-WhatsApp puppeting bridge.
  2. // Copyright (C) 2020 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. "encoding/json"
  19. "errors"
  20. "fmt"
  21. "net/http"
  22. "sort"
  23. "strconv"
  24. "strings"
  25. "sync"
  26. "time"
  27. "github.com/skip2/go-qrcode"
  28. log "maunium.net/go/maulogger/v2"
  29. "github.com/Rhymen/go-whatsapp"
  30. waBinary "github.com/Rhymen/go-whatsapp/binary"
  31. waProto "github.com/Rhymen/go-whatsapp/binary/proto"
  32. "maunium.net/go/mautrix"
  33. "maunium.net/go/mautrix/event"
  34. "maunium.net/go/mautrix/format"
  35. "maunium.net/go/mautrix/id"
  36. "maunium.net/go/mautrix-whatsapp/database"
  37. "maunium.net/go/mautrix-whatsapp/types"
  38. "maunium.net/go/mautrix-whatsapp/whatsapp-ext"
  39. )
  40. type User struct {
  41. *database.User
  42. Conn *whatsappExt.ExtendedConn
  43. bridge *Bridge
  44. log log.Logger
  45. Admin bool
  46. Whitelisted bool
  47. RelaybotWhitelisted bool
  48. IsRelaybot bool
  49. ConnectionErrors int
  50. CommunityID string
  51. cleanDisconnection bool
  52. batteryWarningsSent int
  53. lastReconnection int64
  54. chatListReceived chan struct{}
  55. syncPortalsDone chan struct{}
  56. messages chan PortalMessage
  57. syncStart chan struct{}
  58. syncWait sync.WaitGroup
  59. mgmtCreateLock sync.Mutex
  60. }
  61. func (bridge *Bridge) GetUserByMXID(userID id.UserID) *User {
  62. _, isPuppet := bridge.ParsePuppetMXID(userID)
  63. if isPuppet || userID == bridge.Bot.UserID {
  64. return nil
  65. }
  66. bridge.usersLock.Lock()
  67. defer bridge.usersLock.Unlock()
  68. user, ok := bridge.usersByMXID[userID]
  69. if !ok {
  70. return bridge.loadDBUser(bridge.DB.User.GetByMXID(userID), &userID)
  71. }
  72. return user
  73. }
  74. func (bridge *Bridge) GetUserByJID(userID types.WhatsAppID) *User {
  75. bridge.usersLock.Lock()
  76. defer bridge.usersLock.Unlock()
  77. user, ok := bridge.usersByJID[userID]
  78. if !ok {
  79. return bridge.loadDBUser(bridge.DB.User.GetByJID(userID), nil)
  80. }
  81. return user
  82. }
  83. func (user *User) addToJIDMap() {
  84. user.bridge.usersLock.Lock()
  85. user.bridge.usersByJID[user.JID] = user
  86. user.bridge.usersLock.Unlock()
  87. }
  88. func (user *User) removeFromJIDMap() {
  89. user.bridge.usersLock.Lock()
  90. jidUser, ok := user.bridge.usersByJID[user.JID]
  91. if ok && user == jidUser {
  92. delete(user.bridge.usersByJID, user.JID)
  93. }
  94. user.bridge.usersLock.Unlock()
  95. user.bridge.Metrics.TrackLoginState(user.JID, false)
  96. }
  97. func (bridge *Bridge) GetAllUsers() []*User {
  98. bridge.usersLock.Lock()
  99. defer bridge.usersLock.Unlock()
  100. dbUsers := bridge.DB.User.GetAll()
  101. output := make([]*User, len(dbUsers))
  102. for index, dbUser := range dbUsers {
  103. user, ok := bridge.usersByMXID[dbUser.MXID]
  104. if !ok {
  105. user = bridge.loadDBUser(dbUser, nil)
  106. }
  107. output[index] = user
  108. }
  109. return output
  110. }
  111. func (bridge *Bridge) loadDBUser(dbUser *database.User, mxid *id.UserID) *User {
  112. if dbUser == nil {
  113. if mxid == nil {
  114. return nil
  115. }
  116. dbUser = bridge.DB.User.New()
  117. dbUser.MXID = *mxid
  118. dbUser.Insert()
  119. }
  120. user := bridge.NewUser(dbUser)
  121. bridge.usersByMXID[user.MXID] = user
  122. if len(user.JID) > 0 {
  123. bridge.usersByJID[user.JID] = user
  124. }
  125. if len(user.ManagementRoom) > 0 {
  126. bridge.managementRooms[user.ManagementRoom] = user
  127. }
  128. return user
  129. }
  130. func (user *User) GetPortals() []*Portal {
  131. keys := user.User.GetPortalKeys()
  132. portals := make([]*Portal, len(keys))
  133. user.bridge.portalsLock.Lock()
  134. for i, key := range keys {
  135. portal, ok := user.bridge.portalsByJID[key]
  136. if !ok {
  137. portal = user.bridge.loadDBPortal(user.bridge.DB.Portal.GetByJID(key), &key)
  138. }
  139. portals[i] = portal
  140. }
  141. user.bridge.portalsLock.Unlock()
  142. return portals
  143. }
  144. func (bridge *Bridge) NewUser(dbUser *database.User) *User {
  145. user := &User{
  146. User: dbUser,
  147. bridge: bridge,
  148. log: bridge.Log.Sub("User").Sub(string(dbUser.MXID)),
  149. IsRelaybot: false,
  150. chatListReceived: make(chan struct{}, 1),
  151. syncPortalsDone: make(chan struct{}, 1),
  152. syncStart: make(chan struct{}, 1),
  153. messages: make(chan PortalMessage, bridge.Config.Bridge.UserMessageBuffer),
  154. }
  155. user.RelaybotWhitelisted = user.bridge.Config.Bridge.Permissions.IsRelaybotWhitelisted(user.MXID)
  156. user.Whitelisted = user.bridge.Config.Bridge.Permissions.IsWhitelisted(user.MXID)
  157. user.Admin = user.bridge.Config.Bridge.Permissions.IsAdmin(user.MXID)
  158. go user.handleMessageLoop()
  159. return user
  160. }
  161. func (user *User) GetManagementRoom() id.RoomID {
  162. if len(user.ManagementRoom) == 0 {
  163. user.mgmtCreateLock.Lock()
  164. defer user.mgmtCreateLock.Unlock()
  165. if len(user.ManagementRoom) > 0 {
  166. return user.ManagementRoom
  167. }
  168. resp, err := user.bridge.Bot.CreateRoom(&mautrix.ReqCreateRoom{
  169. Topic: "WhatsApp bridge notices",
  170. IsDirect: true,
  171. })
  172. if err != nil {
  173. user.log.Errorln("Failed to auto-create management room:", err)
  174. } else {
  175. user.SetManagementRoom(resp.RoomID)
  176. }
  177. }
  178. return user.ManagementRoom
  179. }
  180. func (user *User) SetManagementRoom(roomID id.RoomID) {
  181. existingUser, ok := user.bridge.managementRooms[roomID]
  182. if ok {
  183. existingUser.ManagementRoom = ""
  184. existingUser.Update()
  185. }
  186. user.ManagementRoom = roomID
  187. user.bridge.managementRooms[user.ManagementRoom] = user
  188. user.Update()
  189. }
  190. func (user *User) SetSession(session *whatsapp.Session) {
  191. user.Session = session
  192. if session == nil {
  193. user.LastConnection = 0
  194. }
  195. user.Update()
  196. }
  197. func (user *User) Connect(evenIfNoSession bool) bool {
  198. if user.Conn != nil {
  199. return true
  200. } else if !evenIfNoSession && user.Session == nil {
  201. return false
  202. }
  203. user.log.Debugln("Connecting to WhatsApp")
  204. timeout := time.Duration(user.bridge.Config.Bridge.ConnectionTimeout)
  205. if timeout == 0 {
  206. timeout = 20
  207. }
  208. conn, err := whatsapp.NewConn(timeout * time.Second)
  209. if err != nil {
  210. user.log.Errorln("Failed to connect to WhatsApp:", err)
  211. user.sendMarkdownBridgeAlert("\u26a0 Failed to connect to WhatsApp server. " +
  212. "This indicates a network problem on the bridge server. See bridge logs for more info.")
  213. return false
  214. }
  215. user.Conn = whatsappExt.ExtendConn(conn)
  216. _ = user.Conn.SetClientName(user.bridge.Config.WhatsApp.OSName, user.bridge.Config.WhatsApp.BrowserName, WAVersion)
  217. user.log.Debugln("WhatsApp connection successful")
  218. user.Conn.AddHandler(user)
  219. return user.RestoreSession()
  220. }
  221. func (user *User) RestoreSession() bool {
  222. if user.Session != nil {
  223. sess, err := user.Conn.RestoreWithSession(*user.Session)
  224. if err == whatsapp.ErrAlreadyLoggedIn {
  225. return true
  226. } else if err != nil {
  227. user.log.Errorln("Failed to restore session:", err)
  228. if errors.Is(err, whatsapp.ErrUnpaired) {
  229. user.sendMarkdownBridgeAlert("\u26a0 Failed to connect to WhatsApp: unpaired from phone. " +
  230. "To re-pair your phone, use `delete-session` and then `login`.")
  231. } else {
  232. user.sendMarkdownBridgeAlert("\u26a0 Failed to connect to WhatsApp. Make sure WhatsApp " +
  233. "on your phone is reachable and use `reconnect` to try connecting again.")
  234. }
  235. user.log.Debugln("Disconnecting due to failed session restore...")
  236. _, err := user.Conn.Disconnect()
  237. if err != nil {
  238. user.log.Errorln("Failed to disconnect after failed session restore:", err)
  239. }
  240. return false
  241. }
  242. user.ConnectionErrors = 0
  243. user.SetSession(&sess)
  244. user.log.Debugln("Session restored successfully")
  245. user.PostLogin()
  246. }
  247. return true
  248. }
  249. func (user *User) HasSession() bool {
  250. return user.Session != nil
  251. }
  252. func (user *User) IsConnected() bool {
  253. return user.Conn != nil && user.Conn.IsConnected() && user.Conn.IsLoggedIn()
  254. }
  255. func (user *User) IsLoginInProgress() bool {
  256. return user.Conn != nil && user.Conn.IsLoginInProgress()
  257. }
  258. func (user *User) loginQrChannel(ce *CommandEvent, qrChan <-chan string, eventIDChan chan<- id.EventID) {
  259. var qrEventID id.EventID
  260. for code := range qrChan {
  261. if code == "stop" {
  262. return
  263. }
  264. qrCode, err := qrcode.Encode(code, qrcode.Low, 256)
  265. if err != nil {
  266. user.log.Errorln("Failed to encode QR code:", err)
  267. ce.Reply("Failed to encode QR code: %v", err)
  268. return
  269. }
  270. bot := user.bridge.AS.BotClient()
  271. resp, err := bot.UploadBytes(qrCode, "image/png")
  272. if err != nil {
  273. user.log.Errorln("Failed to upload QR code:", err)
  274. ce.Reply("Failed to upload QR code: %v", err)
  275. return
  276. }
  277. if qrEventID == "" {
  278. sendResp, err := bot.SendImage(ce.RoomID, code, resp.ContentURI)
  279. if err != nil {
  280. user.log.Errorln("Failed to send QR code to user:", err)
  281. return
  282. }
  283. qrEventID = sendResp.EventID
  284. eventIDChan <- qrEventID
  285. } else {
  286. _, err = bot.SendMessageEvent(ce.RoomID, event.EventMessage, &event.MessageEventContent{
  287. MsgType: event.MsgImage,
  288. Body: code,
  289. URL: resp.ContentURI.CUString(),
  290. NewContent: &event.MessageEventContent{
  291. MsgType: event.MsgImage,
  292. Body: code,
  293. URL: resp.ContentURI.CUString(),
  294. },
  295. RelatesTo: &event.RelatesTo{
  296. Type: event.RelReplace,
  297. EventID: qrEventID,
  298. },
  299. })
  300. if err != nil {
  301. user.log.Errorln("Failed to send edited QR code to user:", err)
  302. }
  303. }
  304. }
  305. }
  306. func (user *User) Login(ce *CommandEvent) {
  307. qrChan := make(chan string, 3)
  308. eventIDChan := make(chan id.EventID, 1)
  309. go user.loginQrChannel(ce, qrChan, eventIDChan)
  310. session, err := user.Conn.LoginWithRetry(qrChan, user.bridge.Config.Bridge.LoginQRRegenCount)
  311. qrChan <- "stop"
  312. if err != nil {
  313. var eventID id.EventID
  314. select {
  315. case eventID = <-eventIDChan:
  316. default:
  317. }
  318. reply := event.MessageEventContent{
  319. MsgType: event.MsgText,
  320. }
  321. if err == whatsapp.ErrAlreadyLoggedIn {
  322. reply.Body = "You're already logged in"
  323. } else if err == whatsapp.ErrLoginInProgress {
  324. reply.Body = "You have a login in progress already."
  325. } else if err == whatsapp.ErrLoginTimedOut {
  326. reply.Body = "QR code scan timed out. Please try again."
  327. } else {
  328. user.log.Warnln("Failed to log in:", err)
  329. reply.Body = fmt.Sprintf("Unknown error while logging in: %v", err)
  330. }
  331. msg := reply
  332. if eventID != "" {
  333. msg.NewContent = &reply
  334. msg.RelatesTo = &event.RelatesTo{
  335. Type: event.RelReplace,
  336. EventID: eventID,
  337. }
  338. }
  339. _, _ = ce.Bot.SendMessageEvent(ce.RoomID, event.EventMessage, &msg)
  340. return
  341. }
  342. // TODO there's a bit of duplication between this and the provisioning API login method
  343. // Also between the two logout methods (commands.go and provisioning.go)
  344. user.ConnectionErrors = 0
  345. user.JID = strings.Replace(user.Conn.Info.Wid, whatsappExt.OldUserSuffix, whatsappExt.NewUserSuffix, 1)
  346. user.addToJIDMap()
  347. user.SetSession(&session)
  348. ce.Reply("Successfully logged in, synchronizing chats...")
  349. user.PostLogin()
  350. }
  351. type Chat struct {
  352. Portal *Portal
  353. LastMessageTime uint64
  354. Contact whatsapp.Contact
  355. }
  356. type ChatList []Chat
  357. func (cl ChatList) Len() int {
  358. return len(cl)
  359. }
  360. func (cl ChatList) Less(i, j int) bool {
  361. return cl[i].LastMessageTime > cl[j].LastMessageTime
  362. }
  363. func (cl ChatList) Swap(i, j int) {
  364. cl[i], cl[j] = cl[j], cl[i]
  365. }
  366. func (user *User) PostLogin() {
  367. user.bridge.Metrics.TrackConnectionState(user.JID, true)
  368. user.bridge.Metrics.TrackLoginState(user.JID, true)
  369. user.log.Debugln("Locking processing of incoming messages and starting post-login sync")
  370. user.syncWait.Add(1)
  371. user.syncStart <- struct{}{}
  372. go user.intPostLogin()
  373. }
  374. func (user *User) tryAutomaticDoublePuppeting() {
  375. if len(user.bridge.Config.Bridge.LoginSharedSecret) == 0 {
  376. // Automatic login not enabled
  377. return
  378. } else if _, homeserver, _ := user.MXID.Parse(); homeserver != user.bridge.Config.Homeserver.Domain {
  379. // user is on another homeserver
  380. return
  381. }
  382. user.log.Debugln("Checking if double puppeting needs to be enabled")
  383. puppet := user.bridge.GetPuppetByJID(user.JID)
  384. if len(puppet.CustomMXID) > 0 {
  385. user.log.Debugln("User already has double-puppeting enabled")
  386. // Custom puppet already enabled
  387. return
  388. }
  389. accessToken, err := puppet.loginWithSharedSecret(user.MXID)
  390. if err != nil {
  391. user.log.Warnln("Failed to login with shared secret:", err)
  392. return
  393. }
  394. err = puppet.SwitchCustomMXID(accessToken, user.MXID)
  395. if err != nil {
  396. puppet.log.Warnln("Failed to switch to auto-logined custom puppet:", err)
  397. return
  398. }
  399. user.log.Infoln("Successfully automatically enabled custom puppet")
  400. }
  401. func (user *User) sendBridgeNotice(formatString string, args ...interface{}) {
  402. notice := fmt.Sprintf(formatString, args...)
  403. _, err := user.bridge.Bot.SendNotice(user.GetManagementRoom(), notice)
  404. if err != nil {
  405. user.log.Warnf("Failed to send bridge notice \"%s\": %v", notice, err)
  406. }
  407. }
  408. func (user *User) sendMarkdownBridgeAlert(formatString string, args ...interface{}) {
  409. notice := fmt.Sprintf(formatString, args...)
  410. content := format.RenderMarkdown(notice, true, false)
  411. _, err := user.bridge.Bot.SendMessageEvent(user.GetManagementRoom(), event.EventMessage, content)
  412. if err != nil {
  413. user.log.Warnf("Failed to send bridge alert \"%s\": %v", notice, err)
  414. }
  415. }
  416. func (user *User) postConnPing() bool {
  417. user.log.Debugln("Making post-connection ping")
  418. err := user.Conn.AdminTest()
  419. if err != nil {
  420. user.log.Errorfln("Post-connection ping failed: %v. Disconnecting and then reconnecting after a second", err)
  421. sess, disconnectErr := user.Conn.Disconnect()
  422. if disconnectErr != nil {
  423. user.log.Warnln("Error while disconnecting after failed post-connection ping:", disconnectErr)
  424. } else {
  425. user.Session = &sess
  426. }
  427. user.bridge.Metrics.TrackDisconnection(user.MXID)
  428. go func() {
  429. time.Sleep(1 * time.Second)
  430. user.tryReconnect(fmt.Sprintf("Post-connection ping failed: %v", err))
  431. }()
  432. return false
  433. } else {
  434. user.log.Debugln("Post-connection ping OK")
  435. return true
  436. }
  437. }
  438. func (user *User) intPostLogin() {
  439. defer user.syncWait.Done()
  440. user.lastReconnection = time.Now().Unix()
  441. user.createCommunity()
  442. user.tryAutomaticDoublePuppeting()
  443. user.log.Debugln("Waiting for chat list receive confirmation")
  444. select {
  445. case <-user.chatListReceived:
  446. user.log.Debugln("Chat list receive confirmation received in PostLogin")
  447. case <-time.After(time.Duration(user.bridge.Config.Bridge.ChatListWait) * time.Second):
  448. user.log.Warnln("Timed out waiting for chat list to arrive!")
  449. user.postConnPing()
  450. return
  451. }
  452. if !user.postConnPing() {
  453. user.log.Debugln("Post-connection ping failed, unlocking processing of incoming messages.")
  454. return
  455. }
  456. user.log.Debugln("Waiting for portal sync complete confirmation")
  457. select {
  458. case <-user.syncPortalsDone:
  459. user.log.Debugln("Post-connection portal sync complete, unlocking processing of incoming messages.")
  460. case <-time.After(time.Duration(user.bridge.Config.Bridge.PortalSyncWait) * time.Second):
  461. user.log.Warnln("Timed out waiting for portal sync to complete! Unlocking processing of incoming messages.")
  462. }
  463. }
  464. func (user *User) HandleStreamEvent(evt whatsappExt.StreamEvent) {
  465. if evt.Type == whatsappExt.StreamSleep {
  466. if user.lastReconnection+60 > time.Now().Unix() {
  467. user.lastReconnection = 0
  468. user.log.Infoln("Stream went to sleep soon after reconnection, making new post-connection ping in 20 seconds")
  469. go func() {
  470. time.Sleep(20 * time.Second)
  471. user.postConnPing()
  472. }()
  473. }
  474. } else {
  475. user.log.Infofln("Stream event: %+v", evt)
  476. }
  477. }
  478. func (user *User) HandleChatList(chats []whatsapp.Chat) {
  479. user.log.Infoln("Chat list received")
  480. chatMap := make(map[string]whatsapp.Chat)
  481. for _, chat := range user.Conn.Store.Chats {
  482. chatMap[chat.Jid] = chat
  483. }
  484. for _, chat := range chats {
  485. chatMap[chat.Jid] = chat
  486. }
  487. select {
  488. case user.chatListReceived <- struct{}{}:
  489. default:
  490. }
  491. go user.syncPortals(chatMap, false)
  492. }
  493. func (user *User) syncPortals(chatMap map[string]whatsapp.Chat, createAll bool) {
  494. if chatMap == nil {
  495. chatMap = user.Conn.Store.Chats
  496. }
  497. user.log.Infoln("Reading chat list")
  498. chats := make(ChatList, 0, len(chatMap))
  499. existingKeys := user.GetInCommunityMap()
  500. portalKeys := make([]database.PortalKeyWithMeta, 0, len(chatMap))
  501. for _, chat := range chatMap {
  502. ts, err := strconv.ParseUint(chat.LastMessageTime, 10, 64)
  503. if err != nil {
  504. user.log.Warnfln("Non-integer last message time in %s: %s", chat.Jid, chat.LastMessageTime)
  505. continue
  506. }
  507. portal := user.GetPortalByJID(chat.Jid)
  508. chats = append(chats, Chat{
  509. Portal: portal,
  510. Contact: user.Conn.Store.Contacts[chat.Jid],
  511. LastMessageTime: ts,
  512. })
  513. var inCommunity, ok bool
  514. if inCommunity, ok = existingKeys[portal.Key]; !ok || !inCommunity {
  515. inCommunity = user.addPortalToCommunity(portal)
  516. if portal.IsPrivateChat() {
  517. puppet := user.bridge.GetPuppetByJID(portal.Key.JID)
  518. user.addPuppetToCommunity(puppet)
  519. }
  520. }
  521. portalKeys = append(portalKeys, database.PortalKeyWithMeta{PortalKey: portal.Key, InCommunity: inCommunity})
  522. }
  523. user.log.Infoln("Read chat list, updating user-portal mapping")
  524. err := user.SetPortalKeys(portalKeys)
  525. if err != nil {
  526. user.log.Warnln("Failed to update user-portal mapping:", err)
  527. }
  528. sort.Sort(chats)
  529. limit := user.bridge.Config.Bridge.InitialChatSync
  530. if limit < 0 {
  531. limit = len(chats)
  532. }
  533. now := uint64(time.Now().Unix())
  534. user.log.Infoln("Syncing portals")
  535. for i, chat := range chats {
  536. if chat.LastMessageTime+user.bridge.Config.Bridge.SyncChatMaxAge < now {
  537. break
  538. }
  539. create := (chat.LastMessageTime >= user.LastConnection && user.LastConnection > 0) || i < limit
  540. if len(chat.Portal.MXID) > 0 || create || createAll {
  541. chat.Portal.Sync(user, chat.Contact)
  542. err := chat.Portal.BackfillHistory(user, chat.LastMessageTime)
  543. if err != nil {
  544. chat.Portal.log.Errorln("Error backfilling history:", err)
  545. }
  546. }
  547. }
  548. user.UpdateDirectChats(nil)
  549. user.log.Infoln("Finished syncing portals")
  550. select {
  551. case user.syncPortalsDone <- struct{}{}:
  552. default:
  553. }
  554. }
  555. func (user *User) getDirectChats() map[id.UserID][]id.RoomID {
  556. res := make(map[id.UserID][]id.RoomID)
  557. privateChats := user.bridge.DB.Portal.FindPrivateChats(user.JID)
  558. for _, portal := range privateChats {
  559. if len(portal.MXID) > 0 {
  560. res[user.bridge.FormatPuppetMXID(portal.Key.JID)] = []id.RoomID{portal.MXID}
  561. }
  562. }
  563. return res
  564. }
  565. func (user *User) UpdateDirectChats(chats map[id.UserID][]id.RoomID) {
  566. if !user.bridge.Config.Bridge.SyncDirectChatList {
  567. return
  568. }
  569. puppet := user.bridge.GetPuppetByCustomMXID(user.MXID)
  570. if puppet == nil || puppet.CustomIntent() == nil {
  571. return
  572. }
  573. intent := puppet.CustomIntent()
  574. method := http.MethodPatch
  575. if chats == nil {
  576. chats = user.getDirectChats()
  577. method = http.MethodPut
  578. }
  579. user.log.Debugln("Updating m.direct list on homeserver")
  580. var err error
  581. if user.bridge.Config.Homeserver.Asmux {
  582. urlPath := intent.BuildBaseURL("_matrix", "client", "unstable", "net.maunium.asmux", "dms")
  583. _, err = intent.MakeFullRequest(method, urlPath, http.Header{
  584. "X-Asmux-Auth": {user.bridge.AS.Registration.AppToken},
  585. }, chats, nil)
  586. } else {
  587. existingChats := make(map[id.UserID][]id.RoomID)
  588. err = intent.GetAccountData(event.AccountDataDirectChats.Type, &existingChats)
  589. if err != nil {
  590. user.log.Warnln("Failed to get m.direct list to update it:", err)
  591. return
  592. }
  593. for userID, rooms := range existingChats {
  594. if _, ok := user.bridge.ParsePuppetMXID(userID); !ok {
  595. // This is not a ghost user, include it in the new list
  596. chats[userID] = rooms
  597. } else if _, ok := chats[userID]; !ok && method == http.MethodPatch {
  598. // This is a ghost user, but we're not replacing the whole list, so include it too
  599. chats[userID] = rooms
  600. }
  601. }
  602. err = intent.SetAccountData(event.AccountDataDirectChats.Type, &chats)
  603. }
  604. if err != nil {
  605. user.log.Warnln("Failed to update m.direct list:", err)
  606. }
  607. }
  608. func (user *User) HandleContactList(contacts []whatsapp.Contact) {
  609. contactMap := make(map[string]whatsapp.Contact)
  610. for _, contact := range contacts {
  611. contactMap[contact.Jid] = contact
  612. }
  613. go user.syncPuppets(contactMap)
  614. }
  615. func (user *User) syncPuppets(contacts map[string]whatsapp.Contact) {
  616. if contacts == nil {
  617. contacts = user.Conn.Store.Contacts
  618. }
  619. user.log.Infoln("Syncing puppet info from contacts")
  620. for jid, contact := range contacts {
  621. if strings.HasSuffix(jid, whatsappExt.NewUserSuffix) {
  622. puppet := user.bridge.GetPuppetByJID(contact.Jid)
  623. puppet.Sync(user, contact)
  624. }
  625. }
  626. user.log.Infoln("Finished syncing puppet info from contacts")
  627. }
  628. func (user *User) updateLastConnectionIfNecessary() {
  629. if user.LastConnection+60 < uint64(time.Now().Unix()) {
  630. user.UpdateLastConnection()
  631. }
  632. }
  633. func (user *User) HandleError(err error) {
  634. if !errors.Is(err, whatsapp.ErrInvalidWsData) {
  635. user.log.Errorfln("WhatsApp error: %v", err)
  636. }
  637. if closed, ok := err.(*whatsapp.ErrConnectionClosed); ok {
  638. user.bridge.Metrics.TrackDisconnection(user.MXID)
  639. if closed.Code == 1000 && user.cleanDisconnection {
  640. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  641. user.cleanDisconnection = false
  642. user.log.Infoln("Clean disconnection by server")
  643. return
  644. }
  645. go user.tryReconnect(fmt.Sprintf("Your WhatsApp connection was closed with websocket status code %d", closed.Code))
  646. } else if failed, ok := err.(*whatsapp.ErrConnectionFailed); ok {
  647. user.bridge.Metrics.TrackDisconnection(user.MXID)
  648. user.ConnectionErrors++
  649. go user.tryReconnect(fmt.Sprintf("Your WhatsApp connection failed: %v", failed.Err))
  650. }
  651. // Otherwise unknown error, probably mostly harmless
  652. }
  653. func (user *User) tryReconnect(msg string) {
  654. user.bridge.Metrics.TrackConnectionState(user.JID, false)
  655. if user.ConnectionErrors > user.bridge.Config.Bridge.MaxConnectionAttempts {
  656. user.sendMarkdownBridgeAlert("%s. Use the `reconnect` command to reconnect.", msg)
  657. return
  658. }
  659. if user.bridge.Config.Bridge.ReportConnectionRetry {
  660. user.sendBridgeNotice("%s. Reconnecting...", msg)
  661. // Don't want the same error to be repeated
  662. msg = ""
  663. }
  664. var tries uint
  665. var exponentialBackoff bool
  666. baseDelay := time.Duration(user.bridge.Config.Bridge.ConnectionRetryDelay)
  667. if baseDelay < 0 {
  668. exponentialBackoff = true
  669. baseDelay = -baseDelay + 1
  670. }
  671. delay := baseDelay
  672. for user.ConnectionErrors <= user.bridge.Config.Bridge.MaxConnectionAttempts {
  673. err := user.Conn.Restore()
  674. if err == nil {
  675. user.ConnectionErrors = 0
  676. if user.bridge.Config.Bridge.ReportConnectionRetry {
  677. user.sendBridgeNotice("Reconnected successfully")
  678. }
  679. user.PostLogin()
  680. return
  681. } else if err.Error() == "init responded with 400" {
  682. user.log.Infoln("Got init 400 error when trying to reconnect, resetting connection...")
  683. sess, err := user.Conn.Disconnect()
  684. if err != nil {
  685. user.log.Debugln("Error while disconnecting for connection reset:", err)
  686. }
  687. if len(sess.Wid) > 0 {
  688. user.SetSession(&sess)
  689. }
  690. }
  691. user.log.Errorln("Error while trying to reconnect after disconnection:", err)
  692. tries++
  693. user.ConnectionErrors++
  694. if user.ConnectionErrors <= user.bridge.Config.Bridge.MaxConnectionAttempts {
  695. if exponentialBackoff {
  696. delay = (1 << tries) + baseDelay
  697. }
  698. if user.bridge.Config.Bridge.ReportConnectionRetry {
  699. user.sendBridgeNotice("Reconnection attempt failed: %v. Retrying in %d seconds...", err, delay)
  700. }
  701. time.Sleep(delay * time.Second)
  702. }
  703. }
  704. if user.bridge.Config.Bridge.ReportConnectionRetry {
  705. user.sendMarkdownBridgeAlert("%d reconnection attempts failed. Use the `reconnect` command to try to reconnect manually.", tries)
  706. } else {
  707. user.sendMarkdownBridgeAlert("\u26a0 %s. Additionally, %d reconnection attempts failed. Use the `reconnect` command to try to reconnect.", msg, tries)
  708. }
  709. }
  710. func (user *User) ShouldCallSynchronously() bool {
  711. return true
  712. }
  713. func (user *User) HandleJSONParseError(err error) {
  714. user.log.Errorln("WhatsApp JSON parse error:", err)
  715. }
  716. func (user *User) PortalKey(jid types.WhatsAppID) database.PortalKey {
  717. return database.NewPortalKey(jid, user.JID)
  718. }
  719. func (user *User) GetPortalByJID(jid types.WhatsAppID) *Portal {
  720. return user.bridge.GetPortalByJID(user.PortalKey(jid))
  721. }
  722. func (user *User) handleMessageLoop() {
  723. for {
  724. select {
  725. case msg := <-user.messages:
  726. user.GetPortalByJID(msg.chat).messages <- msg
  727. case <-user.syncStart:
  728. user.log.Debugln("Processing of incoming messages is locked")
  729. user.bridge.Metrics.TrackSyncLock(user.JID, true)
  730. user.syncWait.Wait()
  731. user.bridge.Metrics.TrackSyncLock(user.JID, false)
  732. user.log.Debugln("Processing of incoming messages unlocked")
  733. }
  734. }
  735. }
  736. func (user *User) putMessage(message PortalMessage) {
  737. select {
  738. case user.messages <- message:
  739. default:
  740. user.log.Warnln("Buffer is full, dropping message in", message.chat)
  741. }
  742. }
  743. func (user *User) HandleNewContact(contact whatsapp.Contact) {
  744. user.log.Debugfln("Contact message: %+v", contact)
  745. go func() {
  746. if strings.HasSuffix(contact.Jid, whatsappExt.OldUserSuffix) {
  747. contact.Jid = strings.Replace(contact.Jid, whatsappExt.OldUserSuffix, whatsappExt.NewUserSuffix, -1)
  748. }
  749. puppet := user.bridge.GetPuppetByJID(contact.Jid)
  750. puppet.UpdateName(user, contact)
  751. }()
  752. }
  753. func (user *User) HandleBatteryMessage(battery whatsapp.BatteryMessage) {
  754. user.log.Debugfln("Battery message: %+v", battery)
  755. var notice string
  756. if !battery.Plugged && battery.Percentage < 15 && user.batteryWarningsSent < 1 {
  757. notice = fmt.Sprintf("Phone battery low (%d %% remaining)", battery.Percentage)
  758. user.batteryWarningsSent = 1
  759. } else if !battery.Plugged && battery.Percentage < 5 && user.batteryWarningsSent < 2 {
  760. notice = fmt.Sprintf("Phone battery very low (%d %% remaining)", battery.Percentage)
  761. user.batteryWarningsSent = 2
  762. } else if battery.Percentage > 15 || battery.Plugged {
  763. user.batteryWarningsSent = 0
  764. }
  765. if notice != "" {
  766. go user.sendBridgeNotice("%s", notice)
  767. }
  768. }
  769. func (user *User) HandleTextMessage(message whatsapp.TextMessage) {
  770. user.putMessage(PortalMessage{message.Info.RemoteJid, user, message, message.Info.Timestamp})
  771. }
  772. func (user *User) HandleImageMessage(message whatsapp.ImageMessage) {
  773. user.putMessage(PortalMessage{message.Info.RemoteJid, user, message, message.Info.Timestamp})
  774. }
  775. func (user *User) HandleStickerMessage(message whatsapp.StickerMessage) {
  776. user.putMessage(PortalMessage{message.Info.RemoteJid, user, message, message.Info.Timestamp})
  777. }
  778. func (user *User) HandleVideoMessage(message whatsapp.VideoMessage) {
  779. user.putMessage(PortalMessage{message.Info.RemoteJid, user, message, message.Info.Timestamp})
  780. }
  781. func (user *User) HandleAudioMessage(message whatsapp.AudioMessage) {
  782. user.putMessage(PortalMessage{message.Info.RemoteJid, user, message, message.Info.Timestamp})
  783. }
  784. func (user *User) HandleDocumentMessage(message whatsapp.DocumentMessage) {
  785. user.putMessage(PortalMessage{message.Info.RemoteJid, user, message, message.Info.Timestamp})
  786. }
  787. func (user *User) HandleContactMessage(message whatsapp.ContactMessage) {
  788. user.putMessage(PortalMessage{message.Info.RemoteJid, user, message, message.Info.Timestamp})
  789. }
  790. func (user *User) HandleLocationMessage(message whatsapp.LocationMessage) {
  791. user.putMessage(PortalMessage{message.Info.RemoteJid, user, message, message.Info.Timestamp})
  792. }
  793. func (user *User) HandleMessageRevoke(message whatsappExt.MessageRevocation) {
  794. user.putMessage(PortalMessage{message.RemoteJid, user, message, 0})
  795. }
  796. type FakeMessage struct {
  797. Text string
  798. ID string
  799. Alert bool
  800. }
  801. func (user *User) HandleCallInfo(info whatsappExt.CallInfo) {
  802. if info.Data != nil {
  803. return
  804. }
  805. data := FakeMessage{
  806. ID: info.ID,
  807. }
  808. switch info.Type {
  809. case whatsappExt.CallOffer:
  810. if !user.bridge.Config.Bridge.CallNotices.Start {
  811. return
  812. }
  813. data.Text = "Incoming call"
  814. data.Alert = true
  815. case whatsappExt.CallOfferVideo:
  816. if !user.bridge.Config.Bridge.CallNotices.Start {
  817. return
  818. }
  819. data.Text = "Incoming video call"
  820. data.Alert = true
  821. case whatsappExt.CallTerminate:
  822. if !user.bridge.Config.Bridge.CallNotices.End {
  823. return
  824. }
  825. data.Text = "Call ended"
  826. data.ID += "E"
  827. default:
  828. return
  829. }
  830. portal := user.GetPortalByJID(info.From)
  831. if portal != nil {
  832. portal.messages <- PortalMessage{info.From, user, data, 0}
  833. }
  834. }
  835. func (user *User) HandlePresence(info whatsappExt.Presence) {
  836. puppet := user.bridge.GetPuppetByJID(info.SenderJID)
  837. switch info.Status {
  838. case whatsapp.PresenceUnavailable:
  839. _ = puppet.DefaultIntent().SetPresence("offline")
  840. case whatsapp.PresenceAvailable:
  841. if len(puppet.typingIn) > 0 && puppet.typingAt+15 > time.Now().Unix() {
  842. portal := user.bridge.GetPortalByMXID(puppet.typingIn)
  843. _, _ = puppet.IntentFor(portal).UserTyping(puppet.typingIn, false, 0)
  844. puppet.typingIn = ""
  845. puppet.typingAt = 0
  846. } else {
  847. _ = puppet.DefaultIntent().SetPresence("online")
  848. }
  849. case whatsapp.PresenceComposing:
  850. portal := user.GetPortalByJID(info.JID)
  851. if len(puppet.typingIn) > 0 && puppet.typingAt+15 > time.Now().Unix() {
  852. if puppet.typingIn == portal.MXID {
  853. return
  854. }
  855. _, _ = puppet.IntentFor(portal).UserTyping(puppet.typingIn, false, 0)
  856. }
  857. puppet.typingIn = portal.MXID
  858. puppet.typingAt = time.Now().Unix()
  859. _, _ = puppet.IntentFor(portal).UserTyping(portal.MXID, true, 15*1000)
  860. }
  861. }
  862. func (user *User) HandleMsgInfo(info whatsappExt.MsgInfo) {
  863. if (info.Command == whatsappExt.MsgInfoCommandAck || info.Command == whatsappExt.MsgInfoCommandAcks) && info.Acknowledgement == whatsappExt.AckMessageRead {
  864. portal := user.GetPortalByJID(info.ToJID)
  865. if len(portal.MXID) == 0 {
  866. return
  867. }
  868. go func() {
  869. intent := user.bridge.GetPuppetByJID(info.SenderJID).IntentFor(portal)
  870. for _, msgID := range info.IDs {
  871. msg := user.bridge.DB.Message.GetByJID(portal.Key, msgID)
  872. if msg == nil {
  873. continue
  874. }
  875. err := intent.MarkRead(portal.MXID, msg.MXID)
  876. if err != nil {
  877. user.log.Warnln("Failed to mark message %s as read by %s: %v", msg.MXID, info.SenderJID, err)
  878. }
  879. }
  880. }()
  881. }
  882. }
  883. func (user *User) HandleReceivedMessage(received whatsapp.ReceivedMessage) {
  884. if received.Type == "read" {
  885. user.markSelfRead(received.Jid, received.Index)
  886. } else {
  887. user.log.Debugfln("Unknown received message type: %+v", received)
  888. }
  889. }
  890. func (user *User) HandleReadMessage(read whatsapp.ReadMessage) {
  891. user.log.Debugfln("Received chat read message: %+v", read)
  892. user.markSelfRead(read.Jid, "")
  893. }
  894. func (user *User) markSelfRead(jid, messageID string) {
  895. if strings.HasSuffix(jid, whatsappExt.OldUserSuffix) {
  896. jid = strings.Replace(jid, whatsappExt.OldUserSuffix, whatsappExt.NewUserSuffix, -1)
  897. }
  898. puppet := user.bridge.GetPuppetByJID(user.JID)
  899. if puppet == nil {
  900. return
  901. }
  902. intent := puppet.CustomIntent()
  903. if intent == nil {
  904. return
  905. }
  906. portal := user.GetPortalByJID(jid)
  907. if portal == nil {
  908. return
  909. }
  910. var message *database.Message
  911. if messageID == "" {
  912. message = user.bridge.DB.Message.GetLastInChat(portal.Key)
  913. if message == nil {
  914. return
  915. }
  916. user.log.Debugfln("User read chat %s/%s in WhatsApp mobile (last known event: %s/%s)", portal.Key.JID, portal.MXID, message.JID, message.MXID)
  917. } else {
  918. message = user.bridge.DB.Message.GetByJID(portal.Key, messageID)
  919. if message == nil {
  920. return
  921. }
  922. user.log.Debugfln("User read message %s/%s in %s/%s in WhatsApp mobile", message.JID, message.MXID, portal.Key.JID, portal.MXID)
  923. }
  924. err := intent.MarkRead(portal.MXID, message.MXID)
  925. if err != nil {
  926. user.log.Warnfln("Failed to bridge own read receipt in %s: %v", jid, err)
  927. }
  928. }
  929. func (user *User) HandleCommand(cmd whatsappExt.Command) {
  930. switch cmd.Type {
  931. case whatsappExt.CommandPicture:
  932. if strings.HasSuffix(cmd.JID, whatsappExt.NewUserSuffix) {
  933. puppet := user.bridge.GetPuppetByJID(cmd.JID)
  934. go puppet.UpdateAvatar(user, cmd.ProfilePicInfo)
  935. } else {
  936. portal := user.GetPortalByJID(cmd.JID)
  937. go portal.UpdateAvatar(user, cmd.ProfilePicInfo, true)
  938. }
  939. case whatsappExt.CommandDisconnect:
  940. user.cleanDisconnection = true
  941. if cmd.Kind == "replaced" {
  942. go user.sendMarkdownBridgeAlert("\u26a0 Your WhatsApp connection was closed by the server because you opened another WhatsApp Web client.\n\n" +
  943. "Use the `reconnect` command to disconnect the other client and resume bridging.")
  944. } else {
  945. user.log.Warnln("Unknown kind of disconnect:", string(cmd.Raw))
  946. go user.sendMarkdownBridgeAlert("\u26a0 Your WhatsApp connection was closed by the server (reason code: %s).\n\n"+
  947. "Use the `reconnect` command to reconnect.", cmd.Kind)
  948. }
  949. }
  950. }
  951. func (user *User) HandleChatUpdate(cmd whatsappExt.ChatUpdate) {
  952. if cmd.Command != whatsappExt.ChatUpdateCommandAction {
  953. return
  954. }
  955. portal := user.GetPortalByJID(cmd.JID)
  956. if len(portal.MXID) == 0 {
  957. if cmd.Data.Action == whatsappExt.ChatActionIntroduce || cmd.Data.Action == whatsappExt.ChatActionCreate {
  958. go func() {
  959. err := portal.CreateMatrixRoom(user)
  960. if err != nil {
  961. user.log.Errorln("Failed to create portal room after receiving join event:", err)
  962. }
  963. }()
  964. }
  965. return
  966. }
  967. switch cmd.Data.Action {
  968. case whatsappExt.ChatActionNameChange:
  969. go portal.UpdateName(cmd.Data.NameChange.Name, cmd.Data.SenderJID, true)
  970. case whatsappExt.ChatActionAddTopic:
  971. go portal.UpdateTopic(cmd.Data.AddTopic.Topic, cmd.Data.SenderJID, true)
  972. case whatsappExt.ChatActionRemoveTopic:
  973. go portal.UpdateTopic("", cmd.Data.SenderJID, true)
  974. case whatsappExt.ChatActionPromote:
  975. go portal.ChangeAdminStatus(cmd.Data.UserChange.JIDs, true)
  976. case whatsappExt.ChatActionDemote:
  977. go portal.ChangeAdminStatus(cmd.Data.UserChange.JIDs, false)
  978. case whatsappExt.ChatActionAnnounce:
  979. go portal.RestrictMessageSending(cmd.Data.Announce)
  980. case whatsappExt.ChatActionRestrict:
  981. go portal.RestrictMetadataChanges(cmd.Data.Restrict)
  982. case whatsappExt.ChatActionRemove:
  983. go portal.HandleWhatsAppKick(cmd.Data.SenderJID, cmd.Data.UserChange.JIDs)
  984. case whatsappExt.ChatActionAdd:
  985. go portal.HandleWhatsAppInvite(cmd.Data.SenderJID, cmd.Data.UserChange.JIDs)
  986. case whatsappExt.ChatActionIntroduce:
  987. if cmd.Data.SenderJID != "unknown" {
  988. go portal.Sync(user, whatsapp.Contact{Jid: portal.Key.JID})
  989. }
  990. }
  991. }
  992. func (user *User) HandleJsonMessage(message string) {
  993. var msg json.RawMessage
  994. err := json.Unmarshal([]byte(message), &msg)
  995. if err != nil {
  996. return
  997. }
  998. user.log.Debugln("JSON message:", message)
  999. user.updateLastConnectionIfNecessary()
  1000. }
  1001. func (user *User) HandleRawMessage(message *waProto.WebMessageInfo) {
  1002. user.updateLastConnectionIfNecessary()
  1003. }
  1004. func (user *User) HandleUnknownBinaryNode(node *waBinary.Node) {
  1005. user.log.Debugfln("Unknown binary message: %+v", node)
  1006. }
  1007. func (user *User) NeedsRelaybot(portal *Portal) bool {
  1008. return !user.HasSession() || !user.IsInPortal(portal.Key)
  1009. }