user.go 33 KB

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