Added feature to group items within the context menu.

Author: bytebutcher

README.md

@@ -11,6 +11,7 @@ New context-menu-entries can be added using the "Add"-button. Each entry consist
 * **Command:** the command to be executed. You can use following placeholders:
 	* **%S:** will be replaced with the selected text
 	* **%F:** will be replaced with the path to a temporary file which contains the selected text
+* **Group:** the name of the sub-menu in which this entry will be shown. Might be empty
 * **Run in terminal:** defines whether a terminal-window should appear in which the configured command is executed. By default "xterm" is used as terminal-emulator. You can change the terminal-emulator in the "Miscellaneous Options" to your liking.
 * **Show preview:** gives you the chance to preview and change the command before executing it
 * **Output should replace selection:** will replace the selection with the output of the to be executed command
@@ -26,6 +27,8 @@ In addition you can add new entries via the "Custom command..."-context-menu-ent
 
 ![Burp-Send-To-Extension Context-Menu](images/burp-send-to-extension-context-menu-repeater.png)
 ![Burp-Send-To-Extension Context-Menu](images/burp-send-to-extension-context-menu-target-sitemap.png)
+![Burp-Send-To-Extension Context-Menu Groups](images/burp-send-to-extension-context-menu-groups.png)
+
 
 ## Save and load options
 

burp-send-to-extension/build.gradle

@@ -1,7 +1,7 @@
 apply plugin: 'java'
 
 group 'net.bytebutcher'
-version '0.94'
+version '0.95'
 
 sourceCompatibility = 1.8
 

burp-send-to-extension/src/main/java/net/bytebutcher/burpsendtoextension/gui/SendToAddDialog.form

@@ -3,7 +3,7 @@
   <grid id="27dc6" binding="formPanel" layout-manager="GridLayoutManager" row-count="3" column-count="1" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
     <margin top="10" left="10" bottom="10" right="10"/>
     <constraints>
-      <xy x="20" y="20" width="623" height="243"/>
+      <xy x="20" y="20" width="623" height="268"/>
     </constraints>
     <properties/>
     <border type="none"/>
@@ -52,7 +52,7 @@
           </component>
           <component id="af465" class="javax.swing.JCheckBox" binding="chkRunInTerminal">
             <constraints>
-              <grid row="2" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
+              <grid row="3" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
               <gridbag top="5" left="2" bottom="2" right="2" weightx="1.0" weighty="0.0"/>
             </constraints>
             <properties>
@@ -88,7 +88,7 @@
           </grid>
           <component id="1d8bf" class="javax.swing.JCheckBox" binding="chkShowPreviewPriorToExecution">
             <constraints>
-              <grid row="3" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
+              <grid row="4" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
               <gridbag top="5" left="2" bottom="2" right="2" weightx="0.0" weighty="0.0"/>
             </constraints>
             <properties>
@@ -98,7 +98,7 @@
           </component>
           <component id="512f7" class="javax.swing.JCheckBox" binding="chkOutputReplacesSelection">
             <constraints>
-              <grid row="4" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
+              <grid row="5" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
               <gridbag top="5" left="2" bottom="2" right="2" weightx="0.0" weighty="0.0"/>
             </constraints>
             <properties>
@@ -107,6 +107,24 @@
               <text value="&amp;Output should replace selection"/>
             </properties>
           </component>
+          <component id="c7d44" class="javax.swing.JLabel">
+            <constraints>
+              <grid row="2" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="0" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
+              <gridbag top="2" left="2" bottom="2" right="10" weightx="0.0" weighty="0.0"/>
+            </constraints>
+            <properties>
+              <text value="&amp;Group:"/>
+            </properties>
+          </component>
+          <component id="532e8" class="javax.swing.JTextField" binding="txtGroup">
+            <constraints>
+              <grid row="2" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="6" anchor="8" fill="1" indent="0" use-parent-layout="false">
+                <preferred-size width="150" height="-1"/>
+              </grid>
+              <gridbag top="2" left="2" bottom="2" right="2" weightx="1.0" weighty="0.0"/>
+            </constraints>
+            <properties/>
+          </component>
         </children>
       </grid>
       <grid id="86a29" layout-manager="GridLayoutManager" row-count="1" column-count="3" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">

burp-send-to-extension/src/main/java/net/bytebutcher/burpsendtoextension/gui/SendToAddDialog.java

@@ -10,7 +10,6 @@
 import javax.swing.*;
 import java.awt.*;
 import java.awt.event.ActionEvent;
-import java.util.Set;
 
 public class SendToAddDialog {
     private JTextField txtName;
@@ -22,25 +21,27 @@ public class SendToAddDialog {
     private JButton btnCommandHelp;
     private JCheckBox chkShowPreviewPriorToExecution;
     private JCheckBox chkOutputReplacesSelection;
+    private JTextField txtGroup;
     private final JDialog dialog;
 
     private boolean success = false;
-    private Set<String> names;
+    private java.util.List<CommandObject> commandObjects;
     private AbstractAction onOkActionListener;
     private AbstractAction onCancelActionListener;
 
-    public SendToAddDialog(JFrame parent, String title, Set<String> names) {
-        this.names = names;
+    public SendToAddDialog(JFrame parent, String title, java.util.List<CommandObject> commandObjects) {
+        this.commandObjects = commandObjects;
         this.dialog = initDialog(parent, title);
         initEventListener();
         initKeyboardShortcuts();
     }
 
-    public SendToAddDialog(JFrame parent, String title, Set<String> names, CommandObject commandObject) {
-        this(parent, title, names);
-        names.remove(commandObject.getName());
+    public SendToAddDialog(JFrame parent, String title, java.util.List<CommandObject> commandObjects, CommandObject commandObject) {
+        this(parent, title, commandObjects);
+        commandObjects.remove(commandObject);
         txtName.setText(commandObject.getName());
         txtCommand.setText(commandObject.getCommand());
+        txtGroup.setText(commandObject.getGroup());
         chkRunInTerminal.setSelected(commandObject.isRunInTerminal());
         chkShowPreviewPriorToExecution.setSelected(commandObject.shouldShowPreview());
         chkOutputReplacesSelection.setSelected(commandObject.shouldOutputReplaceSelection());
@@ -70,11 +71,11 @@ public void actionPerformed(ActionEvent e) {
                     );
                     return;
                 }
-                if (names.contains(getName())) {
+                if (!commandObjects.stream().noneMatch(commandObject -> getName().equals(commandObject.getName()) && getGroup().equals(commandObject.getGroup()))) {
                     DialogUtil.showErrorDialog(
                             dialog,
-                            "Name should be unique!",
-                            "Name already exists!"
+                            "Name already exists within the specified group!",
+                            "Combination of name and group already exists!"
                     );
                     return;
                 }
@@ -135,6 +136,10 @@ private String getCommand() {
         return txtCommand.getText();
     }
 
+    private String getGroup() {
+        return txtGroup.getText();
+    }
+
     private boolean isRunInTerminal() {
         return chkRunInTerminal.isSelected();
     }
@@ -148,7 +153,7 @@ private boolean shouldShowPreview() {
     }
 
     public CommandObject getCommandObject() {
-        return new CommandObject(getName(), getCommand(), isRunInTerminal(), shouldShowPreview(), shouldOutputReplaceSelection());
+        return new CommandObject(getName(), getCommand(), getGroup(), isRunInTerminal(), shouldShowPreview(), shouldOutputReplaceSelection());
     }
 
     {
@@ -210,7 +215,7 @@ public CommandObject getCommandObject() {
         chkRunInTerminal.setDisplayedMnemonicIndex(0);
         gbc = new GridBagConstraints();
         gbc.gridx = 1;
-        gbc.gridy = 2;
+        gbc.gridy = 3;
         gbc.weightx = 1.0;
         gbc.anchor = GridBagConstraints.WEST;
         gbc.insets = new Insets(5, 2, 2, 2);
@@ -234,7 +239,7 @@ public CommandObject getCommandObject() {
         chkShowPreviewPriorToExecution.setDisplayedMnemonicIndex(0);
         gbc = new GridBagConstraints();
         gbc.gridx = 1;
-        gbc.gridy = 3;
+        gbc.gridy = 4;
         gbc.anchor = GridBagConstraints.WEST;
         gbc.insets = new Insets(5, 2, 2, 2);
         panel1.add(chkShowPreviewPriorToExecution, gbc);
@@ -246,10 +251,29 @@ public CommandObject getCommandObject() {
         chkOutputReplacesSelection.setDisplayedMnemonicIndex(0);
         gbc = new GridBagConstraints();
         gbc.gridx = 1;
-        gbc.gridy = 4;
+        gbc.gridy = 5;
         gbc.anchor = GridBagConstraints.WEST;
         gbc.insets = new Insets(5, 2, 2, 2);
         panel1.add(chkOutputReplacesSelection, gbc);
+        final JLabel label4 = new JLabel();
+        label4.setText("Group:");
+        label4.setDisplayedMnemonic('G');
+        label4.setDisplayedMnemonicIndex(0);
+        gbc = new GridBagConstraints();
+        gbc.gridx = 0;
+        gbc.gridy = 2;
+        gbc.anchor = GridBagConstraints.WEST;
+        gbc.insets = new Insets(2, 2, 2, 10);
+        panel1.add(label4, gbc);
+        txtGroup = new JTextField();
+        gbc = new GridBagConstraints();
+        gbc.gridx = 1;
+        gbc.gridy = 2;
+        gbc.weightx = 1.0;
+        gbc.anchor = GridBagConstraints.WEST;
+        gbc.fill = GridBagConstraints.HORIZONTAL;
+        gbc.insets = new Insets(2, 2, 2, 2);
+        panel1.add(txtGroup, gbc);
         final JPanel panel3 = new JPanel();
         panel3.setLayout(new GridLayoutManager(1, 3, new Insets(0, 0, 0, 0), -1, -1));
         formPanel.add(panel3, new GridConstraints(2, 0, 1, 1, GridConstraints.ANCHOR_CENTER, GridConstraints.FILL_BOTH, GridConstraints.SIZEPOLICY_CAN_SHRINK | GridConstraints.SIZEPOLICY_CAN_GROW, GridConstraints.SIZEPOLICY_CAN_SHRINK | GridConstraints.SIZEPOLICY_CAN_GROW, null, null, null, 0, false));

burp-send-to-extension/src/main/java/net/bytebutcher/burpsendtoextension/gui/SendToContextMenu.java

@@ -1,6 +1,7 @@
 package net.bytebutcher.burpsendtoextension.gui;
 
 import burp.*;
+import com.google.common.collect.*;
 import net.bytebutcher.burpsendtoextension.gui.util.DialogUtil;
 import net.bytebutcher.burpsendtoextension.models.CommandObject;
 import net.bytebutcher.burpsendtoextension.utils.OsUtils;
@@ -88,7 +89,7 @@ public void actionPerformed(ActionEvent e) {
                 SendToAddDialog addDialog = new SendToAddDialog(
                         burpExtender.getParent(),
                         "Add and run custom command...",
-                        getCommandNames(commandObjects)
+                        commandObjects
                 );
                 if (addDialog.run()) {
                     CommandObject commandObject = addDialog.getCommandObject();
@@ -102,22 +103,46 @@ public void actionPerformed(ActionEvent e) {
         }));
         if (commandObjects.size() > 0) {
             sendToMenu.addSeparator();
+            HashMap<String, java.util.List<CommandObject>> groupedCommandObjects = Maps.newLinkedHashMap();
+            boolean hasEmptyGroup = false;
             for (final CommandObject commandObject : commandObjects) {
-                sendToMenu.add(new JMenuItem(new AbstractAction(commandObject.getName()) {
-
-                    @Override
-                    public void actionPerformed(ActionEvent e) {
-                        String result = runCommandObject(commandObject);
-                        if (commandObject.shouldOutputReplaceSelection() && result != null) {
-                            replaceSelectedText(result);
-                        }
-                    }
-                }));
+                String group = commandObject.getGroup();
+                if (group.isEmpty()) {
+                    sendToMenu.add(newCommandMenuItem(commandObject));
+                    hasEmptyGroup = true;
+                    continue;
+                }
+                if (!groupedCommandObjects.containsKey(group)) {
+                    groupedCommandObjects.put(group, Lists.newArrayList());
+                }
+                groupedCommandObjects.get(group).add(commandObject);
+            }
+            if (hasEmptyGroup && !groupedCommandObjects.isEmpty()) {
+                sendToMenu.addSeparator();
+            }
+            for (String group : groupedCommandObjects.keySet()) {
+                JMenu menuItem = new JMenu(group);
+                for (CommandObject commandObject : groupedCommandObjects.get(group)) {
+                    menuItem.add(newCommandMenuItem(commandObject));
+                }
+                sendToMenu.add(menuItem);
             }
         }
         sendToMenuBar.add(sendToMenu);
     }
 
+    private JMenuItem newCommandMenuItem(CommandObject commandObject) {
+        return new JMenuItem(new AbstractAction(commandObject.getName()) {
+            @Override
+            public void actionPerformed(ActionEvent e) {
+                String result = runCommandObject(commandObject);
+                if (commandObject.shouldOutputReplaceSelection() && result != null) {
+                    replaceSelectedText(result);
+                }
+            }
+        });
+    }
+
     private Set<String> getCommandNames(List<CommandObject> commandObjects) {
         Set<String> names = new HashSet<String>();
         for (CommandObject commandObject : commandObjects) {

burp-send-to-extension/src/main/java/net/bytebutcher/burpsendtoextension/gui/SendToTab.java

@@ -48,7 +48,7 @@ public SendToTab(final BurpExtender burpExtender) {
             public void actionPerformed(final ActionEvent e) {
                 new Thread(new Runnable() {
                     public void run() {
-                        SendToAddDialog addDialog = new SendToAddDialog(getParent(), "Add \"Send to\" context menu entry", sendToTable.getNames());
+                        SendToAddDialog addDialog = new SendToAddDialog(getParent(), "Add \"Send to\" context menu entry", sendToTable.getCommandObjects());
                         if (addDialog.run()) {
                             sendToTableListener.onAddButtonClick(e, addDialog.getCommandObject());
                         }
@@ -60,7 +60,7 @@ public void run() {
             @Override
             public void actionPerformed(ActionEvent e) {
                 CommandObject selectedCommandObject = sendToTable.getSelectedCommandObject();
-                SendToAddDialog editDialog = new SendToAddDialog(getParent(), "Edit \"Send to " + selectedCommandObject.getName() + "\" context menu entry", sendToTable.getNames(), selectedCommandObject);
+                SendToAddDialog editDialog = new SendToAddDialog(getParent(), "Edit \"Send to " + selectedCommandObject.getName() + "\" context menu entry", sendToTable.getCommandObjects(), selectedCommandObject);
                 if (editDialog.run()) {
                     sendToTableListener.onEditButtonClick(e, editDialog.getCommandObject());
                 }