guilds_tree.go 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514
  1. package chat
  2. import (
  3. "fmt"
  4. "log/slog"
  5. "github.com/ayn2op/discordo/internal/clipboard"
  6. "github.com/ayn2op/discordo/internal/config"
  7. "github.com/ayn2op/discordo/internal/ui"
  8. "github.com/ayn2op/tview"
  9. "github.com/ayn2op/tview/help"
  10. "github.com/ayn2op/tview/keybind"
  11. "github.com/diamondburned/arikawa/v3/discord"
  12. "github.com/diamondburned/arikawa/v3/gateway"
  13. "github.com/diamondburned/ningen/v3"
  14. "github.com/gdamore/tcell/v3"
  15. )
  16. type dmNode struct{}
  17. type guildsTree struct {
  18. *tview.TreeView
  19. chat *Model
  20. cfg *config.Config
  21. // Fast-path indexes for frequent event handlers (read updates, picker
  22. // navigation). They mirror the current rendered tree and are rebuilt on
  23. // READY before nodes are added.
  24. guildNodeByID map[discord.GuildID]*tview.TreeNode
  25. channelNodeByID map[discord.ChannelID]*tview.TreeNode
  26. dmRootNode *tview.TreeNode
  27. guildState *guildState
  28. }
  29. var _ help.KeyMap = (*guildsTree)(nil)
  30. func newGuildsTree(cfg *config.Config, chatView *Model) *guildsTree {
  31. gt := &guildsTree{
  32. TreeView: tview.NewTreeView(),
  33. cfg: cfg,
  34. chat: chatView,
  35. guildNodeByID: make(map[discord.GuildID]*tview.TreeNode),
  36. channelNodeByID: make(map[discord.ChannelID]*tview.TreeNode),
  37. guildState: loadGuildState(),
  38. }
  39. gt.Box = ui.ConfigureBox(gt.Box, &cfg.Theme)
  40. gt.
  41. SetRoot(tview.NewTreeNode("")).
  42. SetTopLevel(1).
  43. SetMarkers(tview.TreeMarkers{
  44. Expanded: cfg.Sidebar.Markers.Expanded,
  45. Collapsed: cfg.Sidebar.Markers.Collapsed,
  46. Leaf: cfg.Sidebar.Markers.Leaf,
  47. }).
  48. SetGraphics(cfg.Theme.GuildsTree.Graphics).
  49. SetGraphicsColor(tcell.GetColor(cfg.Theme.GuildsTree.GraphicsColor)).
  50. SetTitle("Guilds")
  51. return gt
  52. }
  53. func (gt *guildsTree) selectActionDesc() string {
  54. desc := "select"
  55. if node := gt.GetCurrentNode(); node != nil {
  56. if len(node.GetChildren()) > 0 {
  57. if node.IsExpanded() {
  58. desc = "collapse"
  59. } else {
  60. desc = "expand"
  61. }
  62. } else {
  63. switch node.GetReference().(type) {
  64. case discord.GuildID, dmNode:
  65. desc = "expand"
  66. }
  67. }
  68. }
  69. return desc
  70. }
  71. func (gt *guildsTree) ShortHelp() []keybind.Keybind {
  72. cfg := gt.cfg.Keybinds.GuildsTree
  73. selectCurrent := cfg.SelectCurrent.Keybind
  74. collapseParent := cfg.CollapseParentNode.Keybind
  75. selectHelp := selectCurrent.Help()
  76. selectCurrent.SetHelp(selectHelp.Key, gt.selectActionDesc())
  77. collapseHelp := collapseParent.Help()
  78. collapseParent.SetHelp(collapseHelp.Key, "collapse parent")
  79. shortHelp := []keybind.Keybind{cfg.Up.Keybind, cfg.Down.Keybind, selectCurrent}
  80. if gt.canCollapseParent(gt.GetCurrentNode()) {
  81. shortHelp = append(shortHelp, collapseParent)
  82. }
  83. return shortHelp
  84. }
  85. func (gt *guildsTree) FullHelp() [][]keybind.Keybind {
  86. cfg := gt.cfg.Keybinds.GuildsTree
  87. selectCurrent := cfg.SelectCurrent.Keybind
  88. collapseParent := cfg.CollapseParentNode.Keybind
  89. selectHelp := selectCurrent.Help()
  90. selectCurrent.SetHelp(selectHelp.Key, gt.selectActionDesc())
  91. collapseHelp := collapseParent.Help()
  92. collapseParent.SetHelp(collapseHelp.Key, "collapse parent")
  93. actions := []keybind.Keybind{selectCurrent, cfg.MoveToParentNode.Keybind}
  94. if gt.canCollapseParent(gt.GetCurrentNode()) {
  95. actions = append(actions, collapseParent)
  96. }
  97. return [][]keybind.Keybind{
  98. {cfg.Up.Keybind, cfg.Down.Keybind, cfg.Top.Keybind, cfg.Bottom.Keybind},
  99. actions,
  100. {cfg.YankID.Keybind},
  101. }
  102. }
  103. func (gt *guildsTree) canCollapseParent(node *tview.TreeNode) bool {
  104. if node == nil {
  105. return false
  106. }
  107. path := gt.GetPath(node)
  108. // Path layout is [root, ..., node]. A non-root parent means at least 3 nodes.
  109. if len(path) < 3 {
  110. return false
  111. }
  112. parent := path[len(path)-2]
  113. return parent != nil && parent.GetLevel() != 0
  114. }
  115. func (gt *guildsTree) resetNodeIndex() {
  116. // Keep allocated map capacity; READY can rebuild often during reconnects.
  117. clear(gt.guildNodeByID)
  118. clear(gt.channelNodeByID)
  119. gt.dmRootNode = nil
  120. }
  121. func (gt *guildsTree) createFolderNode(folder gateway.GuildFolder, guildsByID map[discord.GuildID]*gateway.GuildCreateEvent) {
  122. name := "Folder"
  123. if folder.Name != "" {
  124. name = folder.Name
  125. }
  126. folderNode := tview.NewTreeNode(name).SetExpanded(gt.cfg.Theme.GuildsTree.AutoExpandFolders)
  127. if folder.Color != 0 {
  128. folderStyle := tcell.StyleDefault.Foreground(tcell.NewHexColor(int32(folder.Color)))
  129. gt.setNodeLineStyle(folderNode, folderStyle)
  130. }
  131. gt.GetRoot().AddChild(folderNode)
  132. for _, guildID := range folder.GuildIDs {
  133. if guildEvent, ok := guildsByID[guildID]; ok {
  134. gt.createGuildNode(folderNode, guildEvent.Guild)
  135. }
  136. }
  137. }
  138. func (gt *guildsTree) unreadStyle(indication ningen.UnreadIndication) tcell.Style {
  139. var style tcell.Style
  140. switch indication {
  141. case ningen.ChannelRead:
  142. style = style.Dim(true)
  143. case ningen.ChannelMentioned:
  144. style = style.Underline(true)
  145. fallthrough
  146. case ningen.ChannelUnread:
  147. style = style.Bold(true)
  148. }
  149. return style
  150. }
  151. func (gt *guildsTree) getGuildNodeStyle(guildID discord.GuildID) tcell.Style {
  152. indication := gt.chat.state.GuildIsUnread(guildID, ningen.GuildUnreadOpts{UnreadOpts: ningen.UnreadOpts{IncludeMutedCategories: true}})
  153. return gt.unreadStyle(indication)
  154. }
  155. func (gt *guildsTree) getChannelNodeStyle(channelID discord.ChannelID) tcell.Style {
  156. indication := gt.chat.state.ChannelIsUnread(channelID, ningen.UnreadOpts{IncludeMutedCategories: true})
  157. return gt.unreadStyle(indication)
  158. }
  159. func (gt *guildsTree) createGuildNode(n *tview.TreeNode, guild discord.Guild) {
  160. expanded := gt.guildState.isExpanded(guild.ID)
  161. guildNode := tview.NewTreeNode(guild.Name).
  162. SetReference(guild.ID).
  163. SetExpandable(true).
  164. SetExpanded(expanded).
  165. SetIndent(gt.cfg.Theme.GuildsTree.Indents.Guild)
  166. gt.setNodeLineStyle(guildNode, gt.getGuildNodeStyle(guild.ID))
  167. n.AddChild(guildNode)
  168. gt.guildNodeByID[guild.ID] = guildNode
  169. }
  170. func (gt *guildsTree) createChannelNode(node *tview.TreeNode, channel discord.Channel) {
  171. if channel.Type != discord.DirectMessage && channel.Type != discord.GroupDM && channel.Type != discord.GuildCategory && !gt.chat.state.HasPermissions(channel.ID, discord.PermissionViewChannel) {
  172. return
  173. }
  174. channelNode := tview.NewTreeNode(ui.ChannelToString(channel, gt.cfg.Icons, gt.chat.state)).SetReference(channel.ID)
  175. gt.setNodeLineStyle(channelNode, gt.getChannelNodeStyle(channel.ID))
  176. switch channel.Type {
  177. case discord.DirectMessage:
  178. channelNode.SetIndent(gt.cfg.Theme.GuildsTree.Indents.DM)
  179. case discord.GroupDM:
  180. channelNode.SetIndent(gt.cfg.Theme.GuildsTree.Indents.GroupDM)
  181. case discord.GuildCategory:
  182. channelNode.SetIndent(gt.cfg.Theme.GuildsTree.Indents.Category)
  183. channelNode.SetExpandable(true).SetExpanded(gt.guildState.isChannelExpanded(channel.ID, true))
  184. case discord.GuildForum:
  185. channelNode.SetIndent(gt.cfg.Theme.GuildsTree.Indents.Forum)
  186. channelNode.SetExpandable(true).SetExpanded(gt.guildState.isChannelExpanded(channel.ID, false))
  187. default:
  188. channelNode.SetIndent(gt.cfg.Theme.GuildsTree.Indents.Channel)
  189. }
  190. node.AddChild(channelNode)
  191. gt.channelNodeByID[channel.ID] = channelNode
  192. gt.setNodeLineStyle(channelNode, gt.getChannelNodeStyle(channel.ID))
  193. }
  194. func (gt *guildsTree) setNodeLineStyle(node *tview.TreeNode, style tcell.Style) {
  195. line := node.GetLine()
  196. for i := range line {
  197. line[i].Style = style
  198. }
  199. node.SetLine(line)
  200. }
  201. func (gt *guildsTree) createChannelNodes(node *tview.TreeNode, channels []discord.Channel) {
  202. // Preserve exact ordering semantics:
  203. // 1) top-level non-categories (in input order),
  204. // 2) categories that have at least one child in the source slice (in input order),
  205. // 3) parented channels under already-created categories (in input order).
  206. //
  207. // We precompute parent presence once to avoid the O(n^2) category-child scan.
  208. hasChildByParentID := make(map[discord.ChannelID]struct{}, len(channels))
  209. for _, channel := range channels {
  210. if channel.ParentID.IsValid() {
  211. hasChildByParentID[channel.ParentID] = struct{}{}
  212. }
  213. }
  214. for _, channel := range channels {
  215. if channel.Type != discord.GuildCategory && !channel.ParentID.IsValid() {
  216. gt.createChannelNode(node, channel)
  217. }
  218. }
  219. for _, channel := range channels {
  220. if channel.Type == discord.GuildCategory {
  221. if _, ok := hasChildByParentID[channel.ID]; ok {
  222. gt.createChannelNode(node, channel)
  223. }
  224. }
  225. }
  226. for _, channel := range channels {
  227. if channel.ParentID.IsValid() {
  228. // Parent categories are inserted earlier in this function, so this
  229. // lookup is O(1) and avoids per-channel subtree walks.
  230. parent := gt.channelNodeByID[channel.ParentID]
  231. if parent != nil {
  232. gt.createChannelNode(parent, channel)
  233. }
  234. }
  235. }
  236. }
  237. func (gt *guildsTree) persistExpandState(ref any, expanded bool) {
  238. switch ref := ref.(type) {
  239. case discord.GuildID:
  240. go gt.guildState.setExpanded(ref, expanded)
  241. case discord.ChannelID:
  242. go gt.guildState.setChannelExpanded(ref, expanded)
  243. }
  244. }
  245. func (gt *guildsTree) onSelected(node *tview.TreeNode) tview.Command {
  246. if len(node.GetChildren()) != 0 {
  247. node.SetExpanded(!node.IsExpanded())
  248. gt.persistExpandState(node.GetReference(), node.IsExpanded())
  249. return nil
  250. }
  251. switch ref := node.GetReference().(type) {
  252. case discord.GuildID:
  253. go gt.chat.state.MemberState.Subscribe(ref)
  254. channels, err := gt.chat.state.Cabinet.Channels(ref)
  255. if err != nil {
  256. slog.Error("failed to get channels", "err", err, "guild_id", ref)
  257. return nil
  258. }
  259. ui.SortGuildChannels(channels)
  260. gt.createChannelNodes(node, channels)
  261. node.Expand()
  262. go gt.guildState.setExpanded(ref, true)
  263. return nil
  264. case discord.ChannelID:
  265. channel, err := gt.chat.state.Cabinet.Channel(ref)
  266. if err != nil {
  267. slog.Error("failed to get channel from state", "err", err, "channel_id", ref)
  268. return nil
  269. }
  270. // Handle forum channels differently - they contain threads, not direct messages
  271. if channel.Type == discord.GuildForum {
  272. // Get all channels from the guild - this includes active threads from GuildCreateEvent
  273. allChannels, err := gt.chat.state.Cabinet.Channels(channel.GuildID)
  274. if err != nil {
  275. slog.Error("failed to get channels for forum threads", "err", err, "guild_id", channel.GuildID)
  276. return nil
  277. }
  278. // Filter for threads that belong to this forum channel
  279. var forumThreads []discord.Channel
  280. for _, ch := range allChannels {
  281. if ch.ParentID == channel.ID && (ch.Type == discord.GuildPublicThread ||
  282. ch.Type == discord.GuildPrivateThread ||
  283. ch.Type == discord.GuildAnnouncementThread) {
  284. forumThreads = append(forumThreads, ch)
  285. }
  286. }
  287. // Add threads as child nodes
  288. for _, thread := range forumThreads {
  289. gt.createChannelNode(node, thread)
  290. }
  291. node.Expand()
  292. return nil
  293. }
  294. return gt.loadChannel(*channel)
  295. case dmNode: // Direct messages folder
  296. channels, err := gt.chat.state.PrivateChannels()
  297. if err != nil {
  298. slog.Error("failed to get private channels", "err", err)
  299. return nil
  300. }
  301. ui.SortPrivateChannels(channels)
  302. for _, c := range channels {
  303. gt.createChannelNode(node, c)
  304. }
  305. node.Expand()
  306. return nil
  307. }
  308. return nil
  309. }
  310. func (gt *guildsTree) loadChannel(channel discord.Channel) tview.Command {
  311. limit := uint(gt.cfg.MessagesLimit)
  312. return func() tview.Event {
  313. messages, err := gt.chat.state.Messages(channel.ID, limit)
  314. if err != nil {
  315. slog.Error("failed to get messages", "err", err, "channel_id", channel.ID, "limit", limit)
  316. return nil
  317. }
  318. // Use the newest fetched message ID for MarkRead — channel.LastMessageID
  319. // can be stale in the cabinet cache, causing some channels to remain unread.
  320. // Messages are snowflake-ordered, so the last element is the newest.
  321. lastMsgID := channel.LastMessageID
  322. if len(messages) > 0 {
  323. if newest := messages[len(messages)-1].ID; newest > lastMsgID {
  324. lastMsgID = newest
  325. }
  326. }
  327. if lastMsgID.IsValid() {
  328. go gt.chat.state.ReadState.MarkRead(channel.ID, lastMsgID)
  329. }
  330. if guildID := channel.GuildID; guildID.IsValid() {
  331. gt.chat.messagesList.requestGuildMembers(guildID, messages)
  332. }
  333. return newChannelLoadedEvent(channel, messages)
  334. }
  335. }
  336. func (gt *guildsTree) collapseParentNode(node *tview.TreeNode) {
  337. path := gt.GetPath(node)
  338. if len(path) < 3 {
  339. return
  340. }
  341. parent := path[len(path)-2]
  342. if parent == nil || parent.GetLevel() == 0 {
  343. return
  344. }
  345. parent.Collapse()
  346. gt.persistExpandState(parent.GetReference(), false)
  347. gt.SetCurrentNode(parent)
  348. }
  349. func (gt *guildsTree) HandleEvent(event tview.Event) tview.Command {
  350. switch event := event.(type) {
  351. case *tview.TreeViewSelectedEvent:
  352. return gt.onSelected(event.Node)
  353. case *tview.KeyEvent:
  354. handler := gt.TreeView.HandleEvent
  355. switch {
  356. case keybind.Matches(event, gt.cfg.Keybinds.GuildsTree.CollapseParentNode.Keybind):
  357. gt.collapseParentNode(gt.GetCurrentNode())
  358. return nil
  359. case keybind.Matches(event, gt.cfg.Keybinds.GuildsTree.MoveToParentNode.Keybind):
  360. return handler(tcell.NewEventKey(tcell.KeyRune, "K", tcell.ModNone))
  361. case keybind.Matches(event, gt.cfg.Keybinds.GuildsTree.Up.Keybind):
  362. return handler(tcell.NewEventKey(tcell.KeyUp, "", tcell.ModNone))
  363. case keybind.Matches(event, gt.cfg.Keybinds.GuildsTree.Down.Keybind):
  364. return handler(tcell.NewEventKey(tcell.KeyDown, "", tcell.ModNone))
  365. case keybind.Matches(event, gt.cfg.Keybinds.GuildsTree.Top.Keybind):
  366. gt.Move(gt.GetRowCount() * -1)
  367. return nil
  368. case keybind.Matches(event, gt.cfg.Keybinds.GuildsTree.Bottom.Keybind):
  369. gt.Move(gt.GetRowCount())
  370. return nil
  371. case keybind.Matches(event, gt.cfg.Keybinds.GuildsTree.SelectCurrent.Keybind):
  372. return handler(tcell.NewEventKey(tcell.KeyEnter, "", tcell.ModNone))
  373. case keybind.Matches(event, gt.cfg.Keybinds.GuildsTree.YankID.Keybind):
  374. return gt.yankID()
  375. case event.Key() == tcell.KeyEsc:
  376. // ESC cycles: input → messages → guilds → input
  377. if cmd := gt.chat.focusMessageInput(); cmd != nil {
  378. return cmd
  379. }
  380. return gt.chat.focusMessagesList()
  381. case event.Key() == tcell.KeyRight:
  382. return gt.chat.focusMessagesList()
  383. }
  384. // Do not fall through to TreeView defaults for unmatched keys.
  385. return nil
  386. }
  387. return gt.TreeView.HandleEvent(event)
  388. }
  389. func (gt *guildsTree) yankID() tview.Command {
  390. node := gt.GetCurrentNode()
  391. if node == nil {
  392. return nil
  393. }
  394. // Reference of a tree node in the guilds tree is its ID.
  395. // discord.Snowflake (discord.GuildID and discord.ChannelID) have the String method.
  396. if id, ok := node.GetReference().(fmt.Stringer); ok {
  397. return func() tview.Event {
  398. if err := clipboard.Write(clipboard.FmtText, []byte(id.String())); err != nil {
  399. slog.Error("failed to copy node id", "err", err)
  400. }
  401. return nil
  402. }
  403. }
  404. return nil
  405. }
  406. func (gt *guildsTree) findNodeByReference(reference any) *tview.TreeNode {
  407. switch ref := reference.(type) {
  408. case discord.GuildID:
  409. return gt.guildNodeByID[ref]
  410. case discord.ChannelID:
  411. return gt.channelNodeByID[ref]
  412. case dmNode:
  413. return gt.dmRootNode
  414. default:
  415. // Fallback keeps this helper safe for non-indexed custom references.
  416. var found *tview.TreeNode
  417. gt.GetRoot().Walk(func(node, _ *tview.TreeNode) bool {
  418. if node.GetReference() == reference {
  419. found = node
  420. return false
  421. }
  422. return true
  423. })
  424. return found
  425. }
  426. }
  427. func (gt *guildsTree) findNodeByChannelID(channelID discord.ChannelID) *tview.TreeNode {
  428. channel, err := gt.chat.state.Cabinet.Channel(channelID)
  429. if err != nil {
  430. slog.Error("failed to get channel", "channel_id", channelID, "err", err)
  431. return nil
  432. }
  433. var reference any
  434. if guildID := channel.GuildID; guildID.IsValid() {
  435. reference = guildID
  436. } else {
  437. reference = dmNode{}
  438. }
  439. if parentNode := gt.findNodeByReference(reference); parentNode != nil {
  440. if len(parentNode.GetChildren()) == 0 {
  441. gt.onSelected(parentNode)
  442. }
  443. }
  444. node := gt.findNodeByReference(channelID)
  445. return node
  446. }
  447. func (gt *guildsTree) expandPathToNode(node *tview.TreeNode) {
  448. if node == nil {
  449. return
  450. }
  451. for _, n := range gt.GetPath(node) {
  452. n.Expand()
  453. }
  454. }