portal.go 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236
  1. // mautrix-whatsapp - A Matrix-WhatsApp puppeting bridge.
  2. // Copyright (C) 2019 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. "bytes"
  19. "encoding/gob"
  20. "encoding/hex"
  21. "fmt"
  22. "image"
  23. "image/gif"
  24. "image/jpeg"
  25. "image/png"
  26. "math/rand"
  27. "mime"
  28. "net/http"
  29. "strings"
  30. "sync"
  31. "time"
  32. "github.com/Rhymen/go-whatsapp"
  33. waProto "github.com/Rhymen/go-whatsapp/binary/proto"
  34. log "maunium.net/go/maulogger/v2"
  35. "maunium.net/go/mautrix"
  36. "maunium.net/go/mautrix-appservice"
  37. "maunium.net/go/mautrix-whatsapp/database"
  38. "maunium.net/go/mautrix-whatsapp/types"
  39. "maunium.net/go/mautrix-whatsapp/whatsapp-ext"
  40. )
  41. func (bridge *Bridge) GetPortalByMXID(mxid types.MatrixRoomID) *Portal {
  42. bridge.portalsLock.Lock()
  43. defer bridge.portalsLock.Unlock()
  44. portal, ok := bridge.portalsByMXID[mxid]
  45. if !ok {
  46. dbPortal := bridge.DB.Portal.GetByMXID(mxid)
  47. if dbPortal == nil {
  48. return nil
  49. }
  50. portal = bridge.NewPortal(dbPortal)
  51. bridge.portalsByJID[portal.Key] = portal
  52. if len(portal.MXID) > 0 {
  53. bridge.portalsByMXID[portal.MXID] = portal
  54. }
  55. }
  56. return portal
  57. }
  58. func (bridge *Bridge) GetPortalByJID(key database.PortalKey) *Portal {
  59. bridge.portalsLock.Lock()
  60. defer bridge.portalsLock.Unlock()
  61. portal, ok := bridge.portalsByJID[key]
  62. if !ok {
  63. dbPortal := bridge.DB.Portal.GetByJID(key)
  64. if dbPortal == nil {
  65. dbPortal = bridge.DB.Portal.New()
  66. dbPortal.Key = key
  67. dbPortal.Insert()
  68. }
  69. portal = bridge.NewPortal(dbPortal)
  70. bridge.portalsByJID[portal.Key] = portal
  71. if len(portal.MXID) > 0 {
  72. bridge.portalsByMXID[portal.MXID] = portal
  73. }
  74. }
  75. return portal
  76. }
  77. func (bridge *Bridge) GetAllPortals() []*Portal {
  78. bridge.portalsLock.Lock()
  79. defer bridge.portalsLock.Unlock()
  80. dbPortals := bridge.DB.Portal.GetAll()
  81. output := make([]*Portal, len(dbPortals))
  82. for index, dbPortal := range dbPortals {
  83. portal, ok := bridge.portalsByJID[dbPortal.Key]
  84. if !ok {
  85. portal = bridge.NewPortal(dbPortal)
  86. bridge.portalsByJID[portal.Key] = portal
  87. if len(dbPortal.MXID) > 0 {
  88. bridge.portalsByMXID[dbPortal.MXID] = portal
  89. }
  90. }
  91. output[index] = portal
  92. }
  93. return output
  94. }
  95. func (bridge *Bridge) NewPortal(dbPortal *database.Portal) *Portal {
  96. portal := &Portal{
  97. Portal: dbPortal,
  98. bridge: bridge,
  99. log: bridge.Log.Sub(fmt.Sprintf("Portal/%s", dbPortal.Key)),
  100. messageLocks: make(map[types.WhatsAppMessageID]sync.Mutex),
  101. recentlyHandled: [recentlyHandledLength]types.WhatsAppMessageID{},
  102. messages: make(chan PortalMessage, 128),
  103. }
  104. go portal.handleMessageLoop()
  105. return portal
  106. }
  107. const recentlyHandledLength = 100
  108. type PortalMessage struct {
  109. chat string
  110. source *User
  111. data interface{}
  112. timestamp uint64
  113. }
  114. type Portal struct {
  115. *database.Portal
  116. bridge *Bridge
  117. log log.Logger
  118. avatarURL string
  119. roomCreateLock sync.Mutex
  120. messageLocksLock sync.Mutex
  121. messageLocks map[types.WhatsAppMessageID]sync.Mutex
  122. recentlyHandled [recentlyHandledLength]types.WhatsAppMessageID
  123. recentlyHandledLock sync.Mutex
  124. recentlyHandledIndex uint8
  125. backfillLock sync.Mutex
  126. lastMessageTs uint64
  127. messages chan PortalMessage
  128. isPrivate *bool
  129. }
  130. const MaxMessageAgeToCreatePortal = 5 * 60 // 5 minutes
  131. func (portal *Portal) handleMessageLoop() {
  132. for msg := range portal.messages {
  133. if len(portal.MXID) == 0 {
  134. if msg.timestamp+MaxMessageAgeToCreatePortal < uint64(time.Now().Unix()) {
  135. portal.log.Debugln("Not creating portal room for incoming message as the message is too old.")
  136. continue
  137. }
  138. err := portal.CreateMatrixRoom(msg.source)
  139. if err != nil {
  140. portal.log.Errorln("Failed to create portal room:", err)
  141. return
  142. }
  143. }
  144. portal.backfillLock.Lock()
  145. portal.handleMessage(msg)
  146. portal.backfillLock.Unlock()
  147. }
  148. }
  149. func (portal *Portal) handleMessage(msg PortalMessage) {
  150. switch data := msg.data.(type) {
  151. case whatsapp.TextMessage:
  152. portal.HandleTextMessage(msg.source, data)
  153. case whatsapp.ImageMessage:
  154. portal.HandleMediaMessage(msg.source, data.Download, data.Thumbnail, data.Info, data.Type, data.Caption)
  155. case whatsapp.VideoMessage:
  156. portal.HandleMediaMessage(msg.source, data.Download, data.Thumbnail, data.Info, data.Type, data.Caption)
  157. case whatsapp.AudioMessage:
  158. portal.HandleMediaMessage(msg.source, data.Download, nil, data.Info, data.Type, "")
  159. case whatsapp.DocumentMessage:
  160. portal.HandleMediaMessage(msg.source, data.Download, data.Thumbnail, data.Info, data.Type, data.Title)
  161. case whatsappExt.MessageRevocation:
  162. portal.HandleMessageRevoke(msg.source, data)
  163. }
  164. }
  165. func (portal *Portal) getMessageLock(messageID types.WhatsAppMessageID) sync.Mutex {
  166. portal.messageLocksLock.Lock()
  167. defer portal.messageLocksLock.Unlock()
  168. lock, ok := portal.messageLocks[messageID]
  169. if !ok {
  170. portal.messageLocks[messageID] = lock
  171. }
  172. return lock
  173. }
  174. func (portal *Portal) deleteMessageLock(messageID types.WhatsAppMessageID) {
  175. portal.messageLocksLock.Lock()
  176. delete(portal.messageLocks, messageID)
  177. portal.messageLocksLock.Unlock()
  178. }
  179. func (portal *Portal) isRecentlyHandled(id types.WhatsAppMessageID) bool {
  180. start := portal.recentlyHandledIndex
  181. for i := start; i != start; i = (i - 1) % recentlyHandledLength {
  182. if portal.recentlyHandled[i] == id {
  183. return true
  184. }
  185. }
  186. return false
  187. }
  188. func (portal *Portal) isDuplicate(id types.WhatsAppMessageID) bool {
  189. msg := portal.bridge.DB.Message.GetByJID(portal.Key, id)
  190. if msg != nil {
  191. return true
  192. }
  193. return false
  194. }
  195. func init() {
  196. gob.Register(&waProto.Message{})
  197. }
  198. func (portal *Portal) markHandled(source *User, message *waProto.WebMessageInfo, mxid types.MatrixEventID) {
  199. msg := portal.bridge.DB.Message.New()
  200. msg.Chat = portal.Key
  201. msg.JID = message.GetKey().GetId()
  202. msg.MXID = mxid
  203. msg.Timestamp = message.GetMessageTimestamp()
  204. if message.GetKey().GetFromMe() {
  205. msg.Sender = source.JID
  206. } else if portal.IsPrivateChat() {
  207. msg.Sender = portal.Key.JID
  208. } else {
  209. msg.Sender = message.GetKey().GetParticipant()
  210. if len(msg.Sender) == 0 {
  211. msg.Sender = message.GetParticipant()
  212. }
  213. }
  214. msg.Content = message.Message
  215. msg.Insert()
  216. portal.recentlyHandledLock.Lock()
  217. index := portal.recentlyHandledIndex
  218. portal.recentlyHandledIndex = (portal.recentlyHandledIndex + 1) % recentlyHandledLength
  219. portal.recentlyHandledLock.Unlock()
  220. portal.recentlyHandled[index] = msg.JID
  221. }
  222. func (portal *Portal) startHandling(info whatsapp.MessageInfo) (*sync.Mutex, bool) {
  223. if portal.lastMessageTs > info.Timestamp+1 || portal.isRecentlyHandled(info.Id) {
  224. return nil, false
  225. }
  226. lock := portal.getMessageLock(info.Id)
  227. lock.Lock()
  228. if portal.isDuplicate(info.Id) {
  229. lock.Unlock()
  230. return nil, false
  231. }
  232. portal.lastMessageTs = info.Timestamp
  233. return &lock, true
  234. }
  235. func (portal *Portal) finishHandling(source *User, message *waProto.WebMessageInfo, mxid types.MatrixEventID) {
  236. portal.markHandled(source, message, mxid)
  237. id := message.GetKey().GetId()
  238. portal.deleteMessageLock(id)
  239. portal.log.Debugln("Handled message", id, "->", mxid)
  240. }
  241. func (portal *Portal) SyncParticipants(metadata *whatsappExt.GroupInfo) {
  242. changed := false
  243. levels, err := portal.MainIntent().PowerLevels(portal.MXID)
  244. if err != nil {
  245. levels = portal.GetBasePowerLevels()
  246. changed = true
  247. }
  248. for _, participant := range metadata.Participants {
  249. user := portal.bridge.GetUserByJID(participant.JID)
  250. if user != nil && !portal.bridge.AS.StateStore.IsInvited(portal.MXID, user.MXID) {
  251. _, err = portal.MainIntent().InviteUser(portal.MXID, &mautrix.ReqInviteUser{
  252. UserID: user.MXID,
  253. })
  254. if err != nil {
  255. portal.log.Warnfln("Failed to invite %s to %s: %v", user.MXID, portal.MXID, err)
  256. }
  257. }
  258. puppet := portal.bridge.GetPuppetByJID(participant.JID)
  259. err := puppet.IntentFor(portal).EnsureJoined(portal.MXID)
  260. if err != nil {
  261. portal.log.Warnfln("Failed to make puppet of %s join %s: %v", participant.JID, portal.MXID, err)
  262. }
  263. expectedLevel := 0
  264. if participant.IsSuperAdmin {
  265. expectedLevel = 95
  266. } else if participant.IsAdmin {
  267. expectedLevel = 50
  268. }
  269. changed = levels.EnsureUserLevel(puppet.MXID, expectedLevel) || changed
  270. if user != nil {
  271. changed = levels.EnsureUserLevel(user.MXID, expectedLevel) || changed
  272. }
  273. }
  274. if changed {
  275. _, err = portal.MainIntent().SetPowerLevels(portal.MXID, levels)
  276. if err != nil {
  277. portal.log.Errorln("Failed to change power levels:", err)
  278. }
  279. }
  280. }
  281. func (portal *Portal) UpdateAvatar(user *User, avatar *whatsappExt.ProfilePicInfo) bool {
  282. if avatar == nil {
  283. var err error
  284. avatar, err = user.Conn.GetProfilePicThumb(portal.Key.JID)
  285. if err != nil {
  286. portal.log.Errorln(err)
  287. return false
  288. }
  289. }
  290. if avatar.Status != 0 {
  291. return false
  292. }
  293. if portal.Avatar == avatar.Tag {
  294. return false
  295. }
  296. data, err := avatar.DownloadBytes()
  297. if err != nil {
  298. portal.log.Warnln("Failed to download avatar:", err)
  299. return false
  300. }
  301. mimeType := http.DetectContentType(data)
  302. resp, err := portal.MainIntent().UploadBytes(data, mimeType)
  303. if err != nil {
  304. portal.log.Warnln("Failed to upload avatar:", err)
  305. return false
  306. }
  307. portal.avatarURL = resp.ContentURI
  308. if len(portal.MXID) > 0 {
  309. _, err = portal.MainIntent().SetRoomAvatar(portal.MXID, resp.ContentURI)
  310. if err != nil {
  311. portal.log.Warnln("Failed to set room topic:", err)
  312. return false
  313. }
  314. }
  315. portal.Avatar = avatar.Tag
  316. return true
  317. }
  318. func (portal *Portal) UpdateName(name string, setBy types.WhatsAppID) bool {
  319. if portal.Name != name {
  320. intent := portal.MainIntent()
  321. if len(setBy) > 0 {
  322. intent = portal.bridge.GetPuppetByJID(setBy).IntentFor(portal)
  323. }
  324. _, err := intent.SetRoomName(portal.MXID, name)
  325. if err == nil {
  326. portal.Name = name
  327. return true
  328. }
  329. portal.log.Warnln("Failed to set room name:", err)
  330. }
  331. return false
  332. }
  333. func (portal *Portal) UpdateTopic(topic string, setBy types.WhatsAppID) bool {
  334. if portal.Topic != topic {
  335. intent := portal.MainIntent()
  336. if len(setBy) > 0 {
  337. intent = portal.bridge.GetPuppetByJID(setBy).IntentFor(portal)
  338. }
  339. _, err := intent.SetRoomTopic(portal.MXID, topic)
  340. if err == nil {
  341. portal.Topic = topic
  342. return true
  343. }
  344. portal.log.Warnln("Failed to set room topic:", err)
  345. }
  346. return false
  347. }
  348. func (portal *Portal) UpdateMetadata(user *User) bool {
  349. if portal.IsPrivateChat() {
  350. return false
  351. } else if portal.IsStatusBroadcastRoom() {
  352. update := false
  353. update = portal.UpdateName("WhatsApp Status Broadcast", "") || update
  354. update = portal.UpdateTopic("WhatsApp status updates from your contacts", "") || update
  355. return update
  356. }
  357. metadata, err := user.Conn.GetGroupMetaData(portal.Key.JID)
  358. if err != nil {
  359. portal.log.Errorln(err)
  360. return false
  361. }
  362. if metadata.Status != 0 {
  363. // 401: access denied
  364. // 404: group does (no longer) exist
  365. // 500: ??? happens with status@broadcast
  366. // TODO: update the room, e.g. change priority level
  367. // to send messages to moderator
  368. return false
  369. }
  370. portal.SyncParticipants(metadata)
  371. update := false
  372. update = portal.UpdateName(metadata.Name, metadata.NameSetBy) || update
  373. update = portal.UpdateTopic(metadata.Topic, metadata.TopicSetBy) || update
  374. return update
  375. }
  376. func (portal *Portal) Sync(user *User, contact whatsapp.Contact) {
  377. if portal.IsPrivateChat() {
  378. return
  379. }
  380. portal.log.Infoln("Syncing portal for", user.MXID)
  381. if len(portal.MXID) == 0 {
  382. portal.Name = contact.Name
  383. err := portal.CreateMatrixRoom(user)
  384. if err != nil {
  385. portal.log.Errorln("Failed to create portal room:", err)
  386. return
  387. }
  388. } else {
  389. err := portal.MainIntent().EnsureInvited(portal.MXID, user.MXID)
  390. if err != nil {
  391. portal.log.Warnfln("Failed to ensure %s is invited to %s: %v", user.MXID, portal.MXID, err)
  392. }
  393. }
  394. update := false
  395. update = portal.UpdateMetadata(user) || update
  396. if !portal.IsStatusBroadcastRoom() {
  397. update = portal.UpdateAvatar(user, nil) || update
  398. }
  399. if update {
  400. portal.Update()
  401. }
  402. }
  403. func (portal *Portal) GetBasePowerLevels() *mautrix.PowerLevels {
  404. anyone := 0
  405. nope := 99
  406. return &mautrix.PowerLevels{
  407. UsersDefault: anyone,
  408. EventsDefault: anyone,
  409. RedactPtr: &anyone,
  410. StateDefaultPtr: &nope,
  411. BanPtr: &nope,
  412. InvitePtr: &nope,
  413. Users: map[string]int{
  414. portal.MainIntent().UserID: 100,
  415. },
  416. Events: map[string]int{
  417. mautrix.StateRoomName.Type: anyone,
  418. mautrix.StateRoomAvatar.Type: anyone,
  419. mautrix.StateTopic.Type: anyone,
  420. },
  421. }
  422. }
  423. func (portal *Portal) ChangeAdminStatus(jids []string, setAdmin bool) {
  424. levels, err := portal.MainIntent().PowerLevels(portal.MXID)
  425. if err != nil {
  426. levels = portal.GetBasePowerLevels()
  427. }
  428. newLevel := 0
  429. if setAdmin {
  430. newLevel = 50
  431. }
  432. changed := false
  433. for _, jid := range jids {
  434. puppet := portal.bridge.GetPuppetByJID(jid)
  435. changed = levels.EnsureUserLevel(puppet.MXID, newLevel) || changed
  436. user := portal.bridge.GetUserByJID(jid)
  437. if user != nil {
  438. changed = levels.EnsureUserLevel(user.MXID, newLevel) || changed
  439. }
  440. }
  441. if changed {
  442. _, err = portal.MainIntent().SetPowerLevels(portal.MXID, levels)
  443. if err != nil {
  444. portal.log.Errorln("Failed to change power levels:", err)
  445. }
  446. }
  447. }
  448. func (portal *Portal) RestrictMessageSending(restrict bool) {
  449. levels, err := portal.MainIntent().PowerLevels(portal.MXID)
  450. if err != nil {
  451. levels = portal.GetBasePowerLevels()
  452. }
  453. if restrict {
  454. levels.EventsDefault = 50
  455. } else {
  456. levels.EventsDefault = 0
  457. }
  458. _, err = portal.MainIntent().SetPowerLevels(portal.MXID, levels)
  459. if err != nil {
  460. portal.log.Errorln("Failed to change power levels:", err)
  461. }
  462. }
  463. func (portal *Portal) RestrictMetadataChanges(restrict bool) {
  464. levels, err := portal.MainIntent().PowerLevels(portal.MXID)
  465. if err != nil {
  466. levels = portal.GetBasePowerLevels()
  467. }
  468. newLevel := 0
  469. if restrict {
  470. newLevel = 50
  471. }
  472. changed := false
  473. changed = levels.EnsureEventLevel(mautrix.StateRoomName, newLevel) || changed
  474. changed = levels.EnsureEventLevel(mautrix.StateRoomAvatar, newLevel) || changed
  475. changed = levels.EnsureEventLevel(mautrix.StateTopic, newLevel) || changed
  476. if changed {
  477. _, err = portal.MainIntent().SetPowerLevels(portal.MXID, levels)
  478. if err != nil {
  479. portal.log.Errorln("Failed to change power levels:", err)
  480. }
  481. }
  482. }
  483. func (portal *Portal) BackfillHistory(user *User, lastMessageTime uint64) error {
  484. if !portal.bridge.Config.Bridge.RecoverHistory {
  485. return nil
  486. }
  487. portal.backfillLock.Lock()
  488. defer portal.backfillLock.Unlock()
  489. lastMessage := portal.bridge.DB.Message.GetLastInChat(portal.Key)
  490. if lastMessage == nil {
  491. return nil
  492. }
  493. if lastMessage.Timestamp <= lastMessageTime {
  494. portal.log.Debugln("Not backfilling: no new messages")
  495. return nil
  496. }
  497. lastMessageID := lastMessage.JID
  498. portal.log.Infoln("Backfilling history since", lastMessageID, "for", user.MXID)
  499. for len(lastMessageID) > 0 {
  500. portal.log.Debugln("Backfilling history: 50 messages after", lastMessageID)
  501. resp, err := user.Conn.LoadMessagesAfter(portal.Key.JID, lastMessageID, 50)
  502. if err != nil {
  503. return err
  504. }
  505. messages, ok := resp.Content.([]interface{})
  506. if !ok {
  507. return fmt.Errorf("history response not a list")
  508. } else if len(messages) == 0 {
  509. break
  510. }
  511. portal.handleHistory(user, messages)
  512. lastMessageProto, ok := messages[len(messages)-1].(*waProto.WebMessageInfo)
  513. if ok {
  514. lastMessageID = lastMessageProto.GetKey().GetId()
  515. }
  516. }
  517. portal.log.Infoln("Backfilling finished")
  518. return nil
  519. }
  520. func (portal *Portal) FillInitialHistory(user *User) error {
  521. if portal.bridge.Config.Bridge.InitialHistoryFill == 0 {
  522. return nil
  523. }
  524. n := portal.bridge.Config.Bridge.InitialHistoryFill
  525. portal.log.Infoln("Filling initial history, maximum", n, "messages")
  526. var messages []interface{}
  527. before := ""
  528. chunkNum := 1
  529. for n > 0 {
  530. count := 100
  531. if n < count {
  532. count = n
  533. }
  534. portal.log.Debugfln("Fetching chunk %d (%d messages / %d cap) before message %s", chunkNum, count, n, before)
  535. resp, err := user.Conn.LoadMessagesBefore(portal.Key.JID, before, count)
  536. if err != nil {
  537. return err
  538. }
  539. chunk, ok := resp.Content.([]interface{})
  540. if !ok {
  541. return fmt.Errorf("history response not a list")
  542. } else if len(chunk) == 0 {
  543. portal.log.Infoln("Chunk empty, starting handling of loaded messages")
  544. break
  545. }
  546. messages = append(messages, chunk...)
  547. portal.log.Debugfln("Fetched chunk and received %d messages", len(chunk))
  548. n -= len(chunk)
  549. before = chunk[0].(*waProto.WebMessageInfo).GetKey().GetId()
  550. if len(before) == 0 {
  551. portal.log.Infoln("No message ID for first message, starting handling of loaded messages")
  552. break
  553. }
  554. }
  555. portal.handleHistory(user, messages)
  556. return nil
  557. }
  558. func (portal *Portal) handleHistory(user *User, messages []interface{}) {
  559. portal.log.Infoln("Handling", len(messages), "messages of history")
  560. for _, rawMessage := range messages {
  561. message, ok := rawMessage.(*waProto.WebMessageInfo)
  562. if !ok {
  563. portal.log.Warnln("Unexpected non-WebMessageInfo item in history response:", rawMessage)
  564. continue
  565. }
  566. data := whatsapp.ParseProtoMessage(message)
  567. portal.handleMessage(PortalMessage{portal.Key.JID, user, data, message.GetMessageTimestamp()})
  568. }
  569. }
  570. func (portal *Portal) CreateMatrixRoom(user *User) error {
  571. portal.roomCreateLock.Lock()
  572. defer portal.roomCreateLock.Unlock()
  573. if len(portal.MXID) > 0 {
  574. return nil
  575. }
  576. intent := portal.MainIntent()
  577. if err := intent.EnsureRegistered(); err != nil {
  578. return err
  579. }
  580. portal.log.Infoln("Creating Matrix room. Info source:", user.MXID)
  581. var metadata *whatsappExt.GroupInfo
  582. isPrivateChat := false
  583. if portal.IsPrivateChat() {
  584. portal.Name = ""
  585. portal.Topic = "WhatsApp private chat"
  586. isPrivateChat = true
  587. } else if portal.IsStatusBroadcastRoom() {
  588. portal.Name = "WhatsApp Status Broadcast"
  589. portal.Topic = "WhatsApp status updates from your contacts"
  590. } else {
  591. var err error
  592. metadata, err = user.Conn.GetGroupMetaData(portal.Key.JID)
  593. if err == nil && metadata.Status == 0 {
  594. portal.Name = metadata.Name
  595. portal.Topic = metadata.Topic
  596. }
  597. portal.UpdateAvatar(user, nil)
  598. }
  599. initialState := []*mautrix.Event{{
  600. Type: mautrix.StatePowerLevels,
  601. Content: mautrix.Content{
  602. PowerLevels: portal.GetBasePowerLevels(),
  603. },
  604. }}
  605. if len(portal.avatarURL) > 0 {
  606. initialState = append(initialState, &mautrix.Event{
  607. Type: mautrix.StateRoomAvatar,
  608. Content: mautrix.Content{
  609. URL: portal.avatarURL,
  610. },
  611. })
  612. }
  613. resp, err := intent.CreateRoom(&mautrix.ReqCreateRoom{
  614. Visibility: "private",
  615. Name: portal.Name,
  616. Topic: portal.Topic,
  617. Invite: []string{user.MXID},
  618. Preset: "private_chat",
  619. IsDirect: isPrivateChat,
  620. InitialState: initialState,
  621. })
  622. if err != nil {
  623. return err
  624. }
  625. portal.MXID = resp.RoomID
  626. portal.Update()
  627. if metadata != nil {
  628. portal.SyncParticipants(metadata)
  629. }
  630. err = portal.FillInitialHistory(user)
  631. if err != nil {
  632. portal.log.Errorln("Failed to fill history:", err)
  633. }
  634. return nil
  635. }
  636. func (portal *Portal) IsPrivateChat() bool {
  637. if portal.isPrivate == nil {
  638. val := strings.HasSuffix(portal.Key.JID, whatsappExt.NewUserSuffix)
  639. portal.isPrivate = &val
  640. }
  641. return *portal.isPrivate
  642. }
  643. func (portal *Portal) IsStatusBroadcastRoom() bool {
  644. return portal.Key.JID == "status@broadcast"
  645. }
  646. func (portal *Portal) MainIntent() *appservice.IntentAPI {
  647. if portal.IsPrivateChat() {
  648. return portal.bridge.GetPuppetByJID(portal.Key.JID).DefaultIntent()
  649. }
  650. return portal.bridge.Bot
  651. }
  652. func (portal *Portal) GetMessageIntent(user *User, info whatsapp.MessageInfo) *appservice.IntentAPI {
  653. if info.FromMe {
  654. if portal.IsPrivateChat() {
  655. return portal.bridge.GetPuppetByJID(user.JID).CustomIntent()
  656. }
  657. return portal.bridge.GetPuppetByJID(user.JID).IntentFor(portal)
  658. } else if portal.IsPrivateChat() {
  659. return portal.MainIntent()
  660. } else if len(info.SenderJid) == 0 {
  661. if len(info.Source.GetParticipant()) != 0 {
  662. info.SenderJid = info.Source.GetParticipant()
  663. } else {
  664. return nil
  665. }
  666. }
  667. return portal.bridge.GetPuppetByJID(info.SenderJid).IntentFor(portal)
  668. }
  669. func (portal *Portal) SetReply(content *mautrix.Content, info whatsapp.MessageInfo) {
  670. if len(info.QuotedMessageID) == 0 {
  671. return
  672. }
  673. message := portal.bridge.DB.Message.GetByJID(portal.Key, info.QuotedMessageID)
  674. if message != nil {
  675. event, err := portal.MainIntent().GetEvent(portal.MXID, message.MXID)
  676. if err != nil {
  677. portal.log.Warnln("Failed to get reply target:", err)
  678. return
  679. }
  680. event.Content.RemoveReplyFallback()
  681. content.SetReply(event)
  682. }
  683. return
  684. }
  685. func (portal *Portal) HandleMessageRevoke(user *User, message whatsappExt.MessageRevocation) {
  686. msg := portal.bridge.DB.Message.GetByJID(portal.Key, message.Id)
  687. if msg == nil {
  688. return
  689. }
  690. var intent *appservice.IntentAPI
  691. if message.FromMe {
  692. if portal.IsPrivateChat() {
  693. intent = portal.bridge.GetPuppetByJID(user.JID).CustomIntent()
  694. } else {
  695. intent = portal.bridge.GetPuppetByJID(user.JID).IntentFor(portal)
  696. }
  697. } else if len(message.Participant) > 0 {
  698. intent = portal.bridge.GetPuppetByJID(message.Participant).IntentFor(portal)
  699. }
  700. if intent == nil {
  701. intent = portal.MainIntent()
  702. }
  703. _, err := intent.RedactEvent(portal.MXID, msg.MXID)
  704. if err != nil {
  705. portal.log.Errorln("Failed to redact %s: %v", msg.JID, err)
  706. return
  707. }
  708. msg.Delete()
  709. }
  710. type MessageContent struct {
  711. *mautrix.Content
  712. IsCustomPuppet bool `json:"net.maunium.whatsapp.puppet,omitempty"`
  713. }
  714. func (portal *Portal) HandleTextMessage(source *User, message whatsapp.TextMessage) {
  715. if len(portal.MXID) == 0 {
  716. return
  717. }
  718. lock, ok := portal.startHandling(message.Info)
  719. if !ok {
  720. return
  721. }
  722. defer lock.Unlock()
  723. intent := portal.GetMessageIntent(source, message.Info)
  724. if intent == nil {
  725. return
  726. }
  727. content := &mautrix.Content{
  728. Body: message.Text,
  729. MsgType: mautrix.MsgText,
  730. }
  731. portal.bridge.Formatter.ParseWhatsApp(content)
  732. portal.SetReply(content, message.Info)
  733. _, _ = intent.UserTyping(portal.MXID, false, 0)
  734. resp, err := intent.SendMassagedMessageEvent(portal.MXID, mautrix.EventMessage, &MessageContent{content, intent.IsCustomPuppet}, int64(message.Info.Timestamp*1000))
  735. if err != nil {
  736. portal.log.Errorfln("Failed to handle message %s: %v", message.Info.Id, err)
  737. return
  738. }
  739. portal.finishHandling(source, message.Info.Source, resp.EventID)
  740. }
  741. func (portal *Portal) HandleMediaMessage(source *User, download func() ([]byte, error), thumbnail []byte, info whatsapp.MessageInfo, mimeType, caption string) {
  742. if len(portal.MXID) == 0 {
  743. return
  744. }
  745. lock, ok := portal.startHandling(info)
  746. if !ok {
  747. return
  748. }
  749. defer lock.Unlock()
  750. intent := portal.GetMessageIntent(source, info)
  751. if intent == nil {
  752. return
  753. }
  754. data, err := download()
  755. if err != nil {
  756. portal.log.Errorfln("Failed to download media for %s: %v", info.Id, err)
  757. return
  758. }
  759. uploaded, err := intent.UploadBytes(data, mimeType)
  760. if err != nil {
  761. portal.log.Errorfln("Failed to upload media for %s: %v", err)
  762. return
  763. }
  764. fileName := info.Id
  765. exts, _ := mime.ExtensionsByType(mimeType)
  766. if exts != nil && len(exts) > 0 {
  767. fileName += exts[0]
  768. }
  769. content := &mautrix.Content{
  770. Body: fileName,
  771. URL: uploaded.ContentURI,
  772. Info: &mautrix.FileInfo{
  773. Size: len(data),
  774. MimeType: mimeType,
  775. },
  776. }
  777. portal.SetReply(content, info)
  778. if thumbnail != nil {
  779. thumbnailMime := http.DetectContentType(thumbnail)
  780. uploadedThumbnail, _ := intent.UploadBytes(thumbnail, thumbnailMime)
  781. if uploadedThumbnail != nil {
  782. content.Info.ThumbnailURL = uploadedThumbnail.ContentURI
  783. cfg, _, _ := image.DecodeConfig(bytes.NewReader(data))
  784. content.Info.ThumbnailInfo = &mautrix.FileInfo{
  785. Size: len(thumbnail),
  786. Width: cfg.Width,
  787. Height: cfg.Height,
  788. MimeType: thumbnailMime,
  789. }
  790. }
  791. }
  792. switch strings.ToLower(strings.Split(mimeType, "/")[0]) {
  793. case "image":
  794. content.MsgType = mautrix.MsgImage
  795. cfg, _, _ := image.DecodeConfig(bytes.NewReader(data))
  796. content.Info.Width = cfg.Width
  797. content.Info.Height = cfg.Height
  798. case "video":
  799. content.MsgType = mautrix.MsgVideo
  800. case "audio":
  801. content.MsgType = mautrix.MsgAudio
  802. default:
  803. content.MsgType = mautrix.MsgFile
  804. }
  805. _, _ = intent.UserTyping(portal.MXID, false, 0)
  806. ts := int64(info.Timestamp * 1000)
  807. resp, err := intent.SendMassagedMessageEvent(portal.MXID, mautrix.EventMessage, &MessageContent{content, intent.IsCustomPuppet}, ts)
  808. if err != nil {
  809. portal.log.Errorfln("Failed to handle message %s: %v", info.Id, err)
  810. return
  811. }
  812. if len(caption) > 0 {
  813. captionContent := &mautrix.Content{
  814. Body: caption,
  815. MsgType: mautrix.MsgNotice,
  816. }
  817. portal.bridge.Formatter.ParseWhatsApp(captionContent)
  818. _, err := intent.SendMassagedMessageEvent(portal.MXID, mautrix.EventMessage, &MessageContent{captionContent, intent.IsCustomPuppet}, ts)
  819. if err != nil {
  820. portal.log.Warnfln("Failed to handle caption of message %s: %v", info.Id, err)
  821. }
  822. // TODO store caption mxid?
  823. }
  824. portal.finishHandling(source, info.Source, resp.EventID)
  825. }
  826. func makeMessageID() *string {
  827. b := make([]byte, 10)
  828. rand.Read(b)
  829. str := strings.ToUpper(hex.EncodeToString(b))
  830. return &str
  831. }
  832. func (portal *Portal) downloadThumbnail(evt *mautrix.Event) []byte {
  833. if evt.Content.Info == nil || len(evt.Content.Info.ThumbnailURL) == 0 {
  834. return nil
  835. }
  836. thumbnail, err := portal.MainIntent().DownloadBytes(evt.Content.Info.ThumbnailURL)
  837. if err != nil {
  838. portal.log.Errorln("Failed to download thumbnail in %s: %v", evt.ID, err)
  839. return nil
  840. }
  841. thumbnailType := http.DetectContentType(thumbnail)
  842. var img image.Image
  843. switch thumbnailType {
  844. case "image/png":
  845. img, err = png.Decode(bytes.NewReader(thumbnail))
  846. case "image/gif":
  847. img, err = gif.Decode(bytes.NewReader(thumbnail))
  848. case "image/jpeg":
  849. return thumbnail
  850. default:
  851. return nil
  852. }
  853. var buf bytes.Buffer
  854. err = jpeg.Encode(&buf, img, &jpeg.Options{
  855. Quality: jpeg.DefaultQuality,
  856. })
  857. if err != nil {
  858. portal.log.Errorln("Failed to re-encode thumbnail in %s: %v", evt.ID, err)
  859. return nil
  860. }
  861. return buf.Bytes()
  862. }
  863. func (portal *Portal) preprocessMatrixMedia(sender *User, evt *mautrix.Event, mediaType whatsapp.MediaType) *MediaUpload {
  864. if evt.Content.Info == nil {
  865. evt.Content.Info = &mautrix.FileInfo{}
  866. }
  867. caption := evt.Content.Body
  868. exts, err := mime.ExtensionsByType(evt.Content.Info.MimeType)
  869. for _, ext := range exts {
  870. if strings.HasSuffix(caption, ext) {
  871. caption = ""
  872. break
  873. }
  874. }
  875. content, err := portal.MainIntent().DownloadBytes(evt.Content.URL)
  876. if err != nil {
  877. portal.log.Errorfln("Failed to download media in %s: %v", evt.ID, err)
  878. return nil
  879. }
  880. url, mediaKey, fileEncSHA256, fileSHA256, fileLength, err := sender.Conn.Upload(bytes.NewReader(content), mediaType)
  881. if err != nil {
  882. portal.log.Errorfln("Failed to upload media in %s: %v", evt.ID, err)
  883. return nil
  884. }
  885. return &MediaUpload{
  886. Caption: caption,
  887. URL: url,
  888. MediaKey: mediaKey,
  889. FileEncSHA256: fileEncSHA256,
  890. FileSHA256: fileSHA256,
  891. FileLength: fileLength,
  892. Thumbnail: portal.downloadThumbnail(evt),
  893. }
  894. }
  895. type MediaUpload struct {
  896. Caption string
  897. URL string
  898. MediaKey []byte
  899. FileEncSHA256 []byte
  900. FileSHA256 []byte
  901. FileLength uint64
  902. Thumbnail []byte
  903. }
  904. func (portal *Portal) HandleMatrixMessage(sender *User, evt *mautrix.Event) {
  905. if portal.IsPrivateChat() && sender.JID != portal.Key.Receiver {
  906. return
  907. }
  908. portal.log.Debugfln("Received event %s", evt.ID)
  909. ts := uint64(evt.Timestamp / 1000)
  910. status := waProto.WebMessageInfo_ERROR
  911. fromMe := true
  912. info := &waProto.WebMessageInfo{
  913. Key: &waProto.MessageKey{
  914. FromMe: &fromMe,
  915. Id: makeMessageID(),
  916. RemoteJid: &portal.Key.JID,
  917. },
  918. MessageTimestamp: &ts,
  919. Message: &waProto.Message{},
  920. Status: &status,
  921. }
  922. ctxInfo := &waProto.ContextInfo{}
  923. replyToID := evt.Content.GetReplyTo()
  924. if len(replyToID) > 0 {
  925. evt.Content.RemoveReplyFallback()
  926. msg := portal.bridge.DB.Message.GetByMXID(replyToID)
  927. if msg != nil && msg.Content != nil {
  928. ctxInfo.StanzaId = &msg.JID
  929. ctxInfo.Participant = &msg.Sender
  930. ctxInfo.QuotedMessage = msg.Content
  931. }
  932. }
  933. var err error
  934. switch evt.Content.MsgType {
  935. case mautrix.MsgText, mautrix.MsgEmote:
  936. text := evt.Content.Body
  937. if evt.Content.Format == mautrix.FormatHTML {
  938. text = portal.bridge.Formatter.ParseMatrix(evt.Content.FormattedBody)
  939. }
  940. if evt.Content.MsgType == mautrix.MsgEmote {
  941. text = "/me " + text
  942. }
  943. ctxInfo.MentionedJid = mentionRegex.FindAllString(text, -1)
  944. for index, mention := range ctxInfo.MentionedJid {
  945. ctxInfo.MentionedJid[index] = mention[1:] + whatsappExt.NewUserSuffix
  946. }
  947. if ctxInfo.StanzaId != nil || ctxInfo.MentionedJid != nil {
  948. info.Message.ExtendedTextMessage = &waProto.ExtendedTextMessage{
  949. Text: &text,
  950. ContextInfo: ctxInfo,
  951. }
  952. } else {
  953. info.Message.Conversation = &text
  954. }
  955. case mautrix.MsgImage:
  956. media := portal.preprocessMatrixMedia(sender, evt, whatsapp.MediaImage)
  957. if media == nil {
  958. return
  959. }
  960. info.Message.ImageMessage = &waProto.ImageMessage{
  961. Caption: &media.Caption,
  962. JpegThumbnail: media.Thumbnail,
  963. Url: &media.URL,
  964. MediaKey: media.MediaKey,
  965. Mimetype: &evt.Content.GetInfo().MimeType,
  966. FileEncSha256: media.FileEncSHA256,
  967. FileSha256: media.FileSHA256,
  968. FileLength: &media.FileLength,
  969. }
  970. case mautrix.MsgVideo:
  971. media := portal.preprocessMatrixMedia(sender, evt, whatsapp.MediaVideo)
  972. if media == nil {
  973. return
  974. }
  975. duration := uint32(evt.Content.GetInfo().Duration)
  976. info.Message.VideoMessage = &waProto.VideoMessage{
  977. Caption: &media.Caption,
  978. JpegThumbnail: media.Thumbnail,
  979. Url: &media.URL,
  980. MediaKey: media.MediaKey,
  981. Mimetype: &evt.Content.GetInfo().MimeType,
  982. Seconds: &duration,
  983. FileEncSha256: media.FileEncSHA256,
  984. FileSha256: media.FileSHA256,
  985. FileLength: &media.FileLength,
  986. }
  987. case mautrix.MsgAudio:
  988. media := portal.preprocessMatrixMedia(sender, evt, whatsapp.MediaAudio)
  989. if media == nil {
  990. return
  991. }
  992. duration := uint32(evt.Content.GetInfo().Duration)
  993. info.Message.AudioMessage = &waProto.AudioMessage{
  994. Url: &media.URL,
  995. MediaKey: media.MediaKey,
  996. Mimetype: &evt.Content.GetInfo().MimeType,
  997. Seconds: &duration,
  998. FileEncSha256: media.FileEncSHA256,
  999. FileSha256: media.FileSHA256,
  1000. FileLength: &media.FileLength,
  1001. }
  1002. case mautrix.MsgFile:
  1003. media := portal.preprocessMatrixMedia(sender, evt, whatsapp.MediaDocument)
  1004. if media == nil {
  1005. return
  1006. }
  1007. info.Message.DocumentMessage = &waProto.DocumentMessage{
  1008. Url: &media.URL,
  1009. MediaKey: media.MediaKey,
  1010. Mimetype: &evt.Content.GetInfo().MimeType,
  1011. FileEncSha256: media.FileEncSHA256,
  1012. FileSha256: media.FileSHA256,
  1013. FileLength: &media.FileLength,
  1014. }
  1015. default:
  1016. portal.log.Debugln("Unhandled Matrix event:", evt)
  1017. return
  1018. }
  1019. portal.markHandled(sender, info, evt.ID)
  1020. portal.log.Debugln("Sending event", evt.ID, "to WhatsApp")
  1021. _, err = sender.Conn.Send(info)
  1022. if err != nil {
  1023. portal.log.Errorfln("Error handling Matrix event %s: %v", evt.ID, err)
  1024. } else {
  1025. portal.log.Debugln("Handled Matrix event:", evt)
  1026. }
  1027. }
  1028. func (portal *Portal) HandleMatrixRedaction(sender *User, evt *mautrix.Event) {
  1029. if portal.IsPrivateChat() && sender.JID != portal.Key.Receiver {
  1030. return
  1031. }
  1032. msg := portal.bridge.DB.Message.GetByMXID(evt.Redacts)
  1033. if msg.Sender != sender.JID {
  1034. return
  1035. }
  1036. ts := uint64(evt.Timestamp / 1000)
  1037. status := waProto.WebMessageInfo_PENDING
  1038. protoMsgType := waProto.ProtocolMessage_REVOKE
  1039. fromMe := true
  1040. info := &waProto.WebMessageInfo{
  1041. Key: &waProto.MessageKey{
  1042. FromMe: &fromMe,
  1043. Id: makeMessageID(),
  1044. RemoteJid: &portal.Key.JID,
  1045. },
  1046. MessageTimestamp: &ts,
  1047. Message: &waProto.Message{
  1048. ProtocolMessage: &waProto.ProtocolMessage{
  1049. Type: &protoMsgType,
  1050. Key: &waProto.MessageKey{
  1051. FromMe: &fromMe,
  1052. Id: &msg.JID,
  1053. RemoteJid: &portal.Key.JID,
  1054. },
  1055. },
  1056. },
  1057. Status: &status,
  1058. }
  1059. _, err := sender.Conn.Send(info)
  1060. if err != nil {
  1061. portal.log.Errorfln("Error handling Matrix redaction: %s: %v", evt.ID, err)
  1062. } else {
  1063. portal.log.Debugln("Handled Matrix redaction:", evt)
  1064. }
  1065. }
  1066. func (portal *Portal) Delete() {
  1067. portal.Portal.Delete()
  1068. delete(portal.bridge.portalsByJID, portal.Key)
  1069. if len(portal.MXID) > 0 {
  1070. delete(portal.bridge.portalsByMXID, portal.MXID)
  1071. }
  1072. }
  1073. func (portal *Portal) Cleanup(puppetsOnly bool) {
  1074. if len(portal.MXID) == 0 {
  1075. return
  1076. }
  1077. if portal.IsPrivateChat() {
  1078. _, err := portal.MainIntent().LeaveRoom(portal.MXID)
  1079. if err != nil {
  1080. portal.log.Warnln("Failed to leave private chat portal with main intent:", err)
  1081. }
  1082. return
  1083. }
  1084. intent := portal.MainIntent()
  1085. members, err := intent.JoinedMembers(portal.MXID)
  1086. if err != nil {
  1087. portal.log.Errorln("Failed to get portal members for cleanup:", err)
  1088. return
  1089. }
  1090. for member, _ := range members.Joined {
  1091. if member == intent.UserID {
  1092. continue
  1093. }
  1094. puppet := portal.bridge.GetPuppetByMXID(member)
  1095. if puppet != nil {
  1096. _, err = puppet.DefaultIntent().LeaveRoom(portal.MXID)
  1097. if err != nil {
  1098. portal.log.Errorln("Error leaving as puppet while cleaning up portal:", err)
  1099. }
  1100. } else if !puppetsOnly {
  1101. _, err = intent.KickUser(portal.MXID, &mautrix.ReqKickUser{UserID: member, Reason: "Deleting portal"})
  1102. if err != nil {
  1103. portal.log.Errorln("Error kicking user while cleaning up portal:", err)
  1104. }
  1105. }
  1106. }
  1107. _, err = intent.LeaveRoom(portal.MXID)
  1108. if err != nil {
  1109. portal.log.Errorln("Error leaving with main intent while cleaning up portal:", err)
  1110. }
  1111. }
  1112. func (portal *Portal) HandleMatrixLeave(sender *User) {
  1113. if portal.IsPrivateChat() {
  1114. portal.log.Debugln("User left private chat portal, cleaning up and deleting...")
  1115. portal.Delete()
  1116. portal.Cleanup(false)
  1117. return
  1118. }
  1119. }
  1120. func (portal *Portal) HandleMatrixKick(sender *User, event *mautrix.Event) {
  1121. // TODO
  1122. }