CM-33449 - Add Action Toolbar (#55)

MarshalX · web-flow · commit a3cb5cd04870 · 2024-03-13T12:19:52.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,9 +4,10 @@
 
 ## [Unreleased]
 
-## [1.5.0] - 2024-03-XX
+## [1.5.0] - 2024-03-13
 
 - Add SCA Violation Card
+- Add action toolbar to the Cycode tab
 - Add the on-demand scan of an entire project for Secrets
 
 ## [1.4.0] - 2024-02-28
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/CycodeContentTab.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/CycodeContentTab.kt
@@ -2,13 +2,20 @@ package com.cycode.plugin.components.toolWindow
 
 import com.cycode.plugin.components.toolWindow.components.treeView.TreeView
 import com.intellij.openapi.project.Project
+import com.intellij.openapi.ui.SimpleToolWindowPanel
 import javax.swing.JPanel
 
-class CycodeContentTab(project: Project) {
+class CycodeContentTab(project: Project) : SimpleToolWindowPanel(false, false) {
     private val treeView = TreeView(project)
 
+    init {
+        setContent(treeView)
+    }
+
     fun updateContent(rightPanel: JPanel): JPanel {
         treeView.refreshTree()
         return treeView.replaceRightPanel(rightPanel)
     }
+
+    fun getTreeView() = treeView
 }
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/CycodeToolWindowFactory.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/CycodeToolWindowFactory.kt
@@ -1,6 +1,7 @@
 package com.cycode.plugin.components.toolWindow
 
 import com.cycode.plugin.components.toolWindow.components.authContentTab.AuthContentTab
+import com.cycode.plugin.components.toolWindow.components.cycodeActionToolBar.CycodeActionToolbar
 import com.cycode.plugin.components.toolWindow.components.loadingContentTab.LoadingContentTab
 import com.cycode.plugin.components.toolWindow.components.scanContentTab.ScanContentTab
 import com.cycode.plugin.icons.PluginIcons
@@ -30,8 +31,12 @@ class CycodeToolWindowFactory : DumbAware, ToolWindowFactory {
         val contentTab = CycodeContentTab(project)
         TabManager.addTab(project, contentTab)
 
+        CycodeActionToolbar().attachActionToolbar(contentTab)
+
         val initRightPanel = getRightPanelDependingOnState(project)
-        val toolWindowContent = createToolWindowContent(contentTab.updateContent(initRightPanel))
+        contentTab.updateContent(initRightPanel)
+
+        val toolWindowContent = createToolWindowContent(contentTab)
         toolWindow.contentManager.addContent(toolWindowContent)
 
         Disposer.register(service, toolWindowContent)
@@ -66,7 +71,7 @@ private fun createToolWindowContent(component: JPanel): Content {
     return ContentFactory.SERVICE.getInstance().createContent(component, null, false)
 }
 
-private fun getRightPanelDependingOnState(project: Project): JPanel {
+fun getRightPanelDependingOnState(project: Project): JPanel {
     val service = cycode(project)
     val pluginState = pluginState()
 
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/ActionToolBar.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/ActionToolBar.kt
@@ -0,0 +1,39 @@
+package com.cycode.plugin.components.toolWindow.components.cycodeActionToolBar
+
+import com.cycode.plugin.CycodeBundle
+import com.cycode.plugin.components.toolWindow.CycodeContentTab
+import com.cycode.plugin.components.toolWindow.components.cycodeActionToolBar.actions.*
+import com.intellij.openapi.actionSystem.ActionManager
+import com.intellij.openapi.actionSystem.ActionToolbar
+import com.intellij.openapi.actionSystem.DefaultActionGroup
+
+class CycodeActionToolbar {
+    fun attachActionToolbar(contentTab: CycodeContentTab): ActionToolbar {
+        val actionGroup = DefaultActionGroup().apply {
+            add(HomeAction.create(contentTab))
+            addSeparator()
+            add(RunAllAction.create(contentTab))
+            addSeparator()
+            add(ExpandAllAction.create(contentTab))
+            add(CollapseAllAction.create(contentTab))
+            addSeparator()
+            add(FilterBySeverityAction.create(contentTab, "Critical"))
+            add(FilterBySeverityAction.create(contentTab, "High"))
+            add(FilterBySeverityAction.create(contentTab, "Medium"))
+            add(FilterBySeverityAction.create(contentTab, "Low"))
+            addSeparator()
+            add(ClearAction.create(contentTab))
+            addSeparator()
+            add(SettingsAction.create(contentTab))
+            add(HelpAction.create(contentTab))
+        }
+
+        val toolbar = ActionManager.getInstance().createActionToolbar(
+            CycodeBundle.message("toolbarId"), actionGroup, true
+        )
+        toolbar.setTargetComponent(contentTab)
+        contentTab.toolbar = toolbar.component
+
+        return toolbar
+    }
+}
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/ClearAction.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/ClearAction.kt
@@ -0,0 +1,32 @@
+package com.cycode.plugin.components.toolWindow.components.cycodeActionToolBar.actions
+
+import com.cycode.plugin.CycodeBundle
+import com.cycode.plugin.components.toolWindow.CycodeContentTab
+import com.cycode.plugin.services.scanResults
+import com.intellij.codeInsight.daemon.DaemonCodeAnalyzer
+import com.intellij.icons.AllIcons
+import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.project.DumbAwareAction
+import java.util.function.Supplier
+
+class ClearAction(private val contentTab: CycodeContentTab) :
+    DumbAwareAction(Supplier { CycodeBundle.message("toolbarClearAction") }, AllIcons.Actions.GC) {
+    companion object {
+        fun create(contentTab: CycodeContentTab): ClearAction {
+            return ClearAction(contentTab)
+        }
+    }
+
+    override fun actionPerformed(e: AnActionEvent) {
+        val project = e.project ?: return
+        scanResults(project).clear()
+        contentTab.getTreeView().refreshTree()
+        DaemonCodeAnalyzer.getInstance(project).restart()
+    }
+
+    override fun update(e: AnActionEvent) {
+        e.presentation.isEnabled = e.project != null &&
+                !e.project!!.isDisposed &&
+                scanResults(e.project!!).hasResults()
+    }
+}
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/CollapseAllAction.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/CollapseAllAction.kt
@@ -0,0 +1,18 @@
+package com.cycode.plugin.components.toolWindow.components.cycodeActionToolBar.actions
+
+import com.cycode.plugin.components.toolWindow.CycodeContentTab
+import com.intellij.ide.CommonActionsManager
+import com.intellij.ide.DefaultTreeExpander
+import com.intellij.openapi.actionSystem.AnAction
+
+class CollapseAllAction {
+    companion object {
+        fun create(contentTab: CycodeContentTab): AnAction {
+            val tree = contentTab.getTreeView().getTree()
+            val treeExpander = DefaultTreeExpander(tree)
+
+            val commonActionsManager = CommonActionsManager.getInstance()
+            return commonActionsManager.createCollapseAllAction(treeExpander, tree)
+        }
+    }
+}
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/ExpandAllAction.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/ExpandAllAction.kt
@@ -0,0 +1,18 @@
+package com.cycode.plugin.components.toolWindow.components.cycodeActionToolBar.actions
+
+import com.cycode.plugin.components.toolWindow.CycodeContentTab
+import com.intellij.ide.CommonActionsManager
+import com.intellij.ide.DefaultTreeExpander
+import com.intellij.openapi.actionSystem.AnAction
+
+class ExpandAllAction {
+    companion object {
+        fun create(contentTab: CycodeContentTab): AnAction {
+            val tree = contentTab.getTreeView().getTree()
+            val treeExpander = DefaultTreeExpander(tree)
+
+            val commonActionsManager = CommonActionsManager.getInstance()
+            return commonActionsManager.createExpandAllAction(treeExpander, tree)
+        }
+    }
+}
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/FilterBySeverityAction.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/FilterBySeverityAction.kt
@@ -0,0 +1,69 @@
+package com.cycode.plugin.components.toolWindow.components.cycodeActionToolBar.actions
+
+import com.cycode.plugin.CycodeBundle
+import com.cycode.plugin.components.toolWindow.CycodeContentTab
+import com.cycode.plugin.icons.PluginIcons
+import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.actionSystem.ToggleAction
+import com.intellij.openapi.project.DumbAware
+import com.intellij.openapi.project.Project
+import java.util.function.Supplier
+
+private class SeverityFilterManager {
+    // FIXME(MarshalX): remove closed projects?
+
+    companion object {
+        val INSTANCE = SeverityFilterManager()
+    }
+
+    private val severityFilterStates = mutableMapOf<Project, SeverityFilterState>()
+
+    fun getOrCreateState(project: Project): SeverityFilterState {
+        return severityFilterStates.getOrPut(project) { SeverityFilterState() }
+    }
+}
+
+
+private class SeverityFilterState {
+    private val selectedFilters = mutableMapOf<String, Boolean>()
+
+    fun setState(filter: String, selected: Boolean) {
+        selectedFilters[filter.toLowerCase()] = selected
+    }
+
+    fun getState(filter: String): Boolean {
+        // by default, all filters are selected
+        return selectedFilters.getOrDefault(filter.toLowerCase(), true)
+    }
+
+    fun exportState(): Map<String, Boolean> {
+        return selectedFilters
+    }
+}
+
+class FilterBySeverityAction(private val contentTab: CycodeContentTab, private val severity: String) :
+    ToggleAction(
+        Supplier { CycodeBundle.message("toolbarFilterBySeverityAction", severity) },
+        PluginIcons.getSeverityIcon(severity)
+    ),
+    DumbAware {
+    companion object {
+        fun create(contentTab: CycodeContentTab, severity: String): FilterBySeverityAction {
+            return FilterBySeverityAction(contentTab, severity)
+        }
+    }
+
+    override fun isSelected(e: AnActionEvent): Boolean {
+        val project = e.project ?: return false
+        val stateManager = SeverityFilterManager.INSTANCE.getOrCreateState(project)
+        return stateManager.getState(severity)
+    }
+
+    override fun setSelected(e: AnActionEvent, state: Boolean) {
+        val project = e.project ?: return
+        val stateManager = SeverityFilterManager.INSTANCE.getOrCreateState(project)
+        stateManager.setState(severity, state)
+
+        contentTab.getTreeView().updateSeverityFilter(stateManager.exportState())
+    }
+}
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/HelpAction.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/HelpAction.kt
@@ -0,0 +1,26 @@
+package com.cycode.plugin.components.toolWindow.components.cycodeActionToolBar.actions
+
+import com.cycode.plugin.CycodeBundle
+import com.cycode.plugin.components.openURL
+import com.cycode.plugin.components.toolWindow.CycodeContentTab
+import com.intellij.icons.AllIcons
+import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.project.DumbAwareAction
+import java.util.function.Supplier
+
+class HelpAction :
+    DumbAwareAction(Supplier { CycodeBundle.message("toolbarHelpAction") }, AllIcons.Actions.Help) {
+    companion object {
+        fun create(contentTab: CycodeContentTab): HelpAction {
+            return HelpAction()
+        }
+    }
+
+    override fun actionPerformed(e: AnActionEvent) {
+        openURL(CycodeBundle.message("docsUrl"))
+    }
+
+    override fun update(e: AnActionEvent) {
+        e.presentation.isEnabled = e.project != null && !e.project!!.isDisposed
+    }
+}
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/HomeAction.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/HomeAction.kt
@@ -0,0 +1,27 @@
+package com.cycode.plugin.components.toolWindow.components.cycodeActionToolBar.actions
+
+import com.cycode.plugin.CycodeBundle
+import com.cycode.plugin.components.toolWindow.CycodeContentTab
+import com.cycode.plugin.components.toolWindow.getRightPanelDependingOnState
+import com.intellij.icons.AllIcons
+import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.project.DumbAwareAction
+import java.util.function.Supplier
+
+class HomeAction(private val contentTab: CycodeContentTab) :
+    DumbAwareAction(Supplier { CycodeBundle.message("toolbarHomeAction") }, AllIcons.Actions.Back) {
+    companion object {
+        fun create(contentTab: CycodeContentTab): HomeAction {
+            return HomeAction(contentTab)
+        }
+    }
+
+    override fun actionPerformed(e: AnActionEvent) {
+        val initRightPanel = getRightPanelDependingOnState(e.project!!)
+        contentTab.updateContent(initRightPanel)
+    }
+
+    override fun update(e: AnActionEvent) {
+        e.presentation.isEnabled = e.project != null && !e.project!!.isDisposed
+    }
+}
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/RunAllAction.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/RunAllAction.kt
@@ -0,0 +1,34 @@
+package com.cycode.plugin.components.toolWindow.components.cycodeActionToolBar.actions
+
+import com.cycode.plugin.CycodeBundle
+import com.cycode.plugin.components.toolWindow.CycodeContentTab
+import com.cycode.plugin.services.cycode
+import com.cycode.plugin.services.pluginState
+import com.intellij.icons.AllIcons
+import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.project.DumbAwareAction
+import java.util.function.Supplier
+
+class RunAllAction :
+    DumbAwareAction(Supplier { CycodeBundle.message("toolbarRunAllAction") }, AllIcons.Actions.RunAll) {
+    companion object {
+        fun create(contentTab: CycodeContentTab): RunAllAction {
+            return RunAllAction()
+        }
+    }
+
+    override fun actionPerformed(e: AnActionEvent) {
+        // TODO(MarshalX): we should tracks all running scans and use pub-sub messaging to update UI
+        //  we can provide "stop" action only after that
+        val project = e.project ?: return
+        val service = cycode(project)
+        service.startSecretScanForCurrentProject()
+        service.startScaScanForCurrentProject()
+    }
+
+    override fun update(e: AnActionEvent) {
+        e.presentation.isEnabled = e.project != null &&
+                !e.project!!.isDisposed &&
+                pluginState().cliAuthed
+    }
+}
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/SettingsAction.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/cycodeActionToolBar/actions/SettingsAction.kt
@@ -0,0 +1,30 @@
+package com.cycode.plugin.components.toolWindow.components.cycodeActionToolBar.actions
+
+import com.cycode.plugin.CycodeBundle
+import com.cycode.plugin.components.toolWindow.CycodeContentTab
+import com.cycode.plugin.settings.ApplicationSettingsConfigurable
+import com.intellij.icons.AllIcons
+import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.options.ShowSettingsUtil
+import com.intellij.openapi.project.DumbAwareAction
+import java.util.function.Supplier
+
+class SettingsAction :
+    DumbAwareAction(Supplier { CycodeBundle.message("toolbarSettingsAction") }, AllIcons.General.GearPlain) {
+    companion object {
+        fun create(contentTab: CycodeContentTab): SettingsAction {
+            return SettingsAction()
+        }
+    }
+
+    override fun actionPerformed(e: AnActionEvent) {
+        val project = e.project ?: return
+        ShowSettingsUtil.getInstance().showSettingsDialog(
+            project, ApplicationSettingsConfigurable::class.java
+        )
+    }
+
+    override fun update(e: AnActionEvent) {
+        e.presentation.isEnabled = e.project != null && !e.project!!.isDisposed
+    }
+}
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/treeView/TreeView.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/treeView/TreeView.kt
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/treeView/components/detectionNodeContextMenu/DetectionNodeContextMenu.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/treeView/components/detectionNodeContextMenu/DetectionNodeContextMenu.kt
diff --git a/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/treeView/nodes/RootNodes.kt b/src/main/kotlin/com/cycode/plugin/components/toolWindow/components/treeView/nodes/RootNodes.kt
diff --git a/src/main/kotlin/com/cycode/plugin/icons/PluginIcons.kt b/src/main/kotlin/com/cycode/plugin/icons/PluginIcons.kt
diff --git a/src/main/resources/messages/CycodeBundle.properties b/src/main/resources/messages/CycodeBundle.properties
