user.go 28 KB

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