user.go 32 KB

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