user.go 30 KB

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