user.go 34 KB

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