getClassInfos() {
+ return classInfos;
+ }
+
+ @Override
+ public String toString() {
+ return extension.toString();
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(extension);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (obj == null) {
+ return false;
+ }
+ if (getClass() != obj.getClass()) {
+ return false;
+ }
+ ExtensionInstallationInfo other = (ExtensionInstallationInfo) obj;
+ return Objects.equals(extension, other.extension);
+ }
+}
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionInstaller.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionInstaller.java
index 319bb26435..48ce015f12 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionInstaller.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionInstaller.java
@@ -46,7 +46,7 @@ import utility.application.ApplicationLayout;
*
*
* Extensions may be installed/uninstalled by users at runtime, using the
- * {@link ExtensionTableProvider}. Installation consists of unzipping the extension archive to an
+ * {@link ExtensionTableDialog}. Installation consists of unzipping the extension archive to an
* installation folder, currently {ghidra user settings dir}/Extensions. To uninstall,
* the unpacked folder is simply removed.
*/
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionRowObject.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionRowObject.java
new file mode 100644
index 0000000000..10e69ab0d6
--- /dev/null
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionRowObject.java
@@ -0,0 +1,74 @@
+/* ###
+ * IP: GHIDRA
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package ghidra.framework.project.extensions;
+
+import java.util.Objects;
+import java.util.Set;
+
+import ghidra.util.classfinder.ClassFileInfo;
+import ghidra.util.extensions.ExtensionDetails;
+
+class ExtensionRowObject {
+
+ private ExtensionDetails extension;
+ private ExtensionInstallationInfo info;
+
+ ExtensionRowObject(ExtensionDetails extension) {
+ this.extension = Objects.requireNonNull(extension);
+ }
+
+ ExtensionRowObject(ExtensionDetails extension, ExtensionInstallationInfo info) {
+ this(extension);
+ this.info = info;
+ }
+
+ public ExtensionDetails getExtension() {
+ return extension;
+ }
+
+ public Set getClassInfos() {
+ if (info == null) {
+ return Set.of(); // not installed
+ }
+ return info.getClassInfos();
+ }
+
+ @Override
+ public String toString() {
+ return extension.toString();
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(extension);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (obj == null) {
+ return false;
+ }
+ if (getClass() != obj.getClass()) {
+ return false;
+ }
+ ExtensionRowObject other = (ExtensionRowObject) obj;
+ return Objects.equals(extension, other.extension);
+ }
+
+}
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTableProvider.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTableDialog.java
similarity index 75%
rename from Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTableProvider.java
rename to Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTableDialog.java
index 3164509eec..e47200d42a 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTableProvider.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTableDialog.java
@@ -42,7 +42,7 @@ import resources.Icons;
* Component Provider that shows the known extensions in Ghidra in a {@link GTable}. Users may
* install/uninstall extensions, or add new ones.
*/
-public class ExtensionTableProvider extends DialogComponentProvider {
+public class ExtensionTableDialog extends DialogComponentProvider {
private static final String LAST_IMPORT_DIRECTORY_KEY = "LastExtensionImportDirectory";
@@ -55,7 +55,7 @@ public class ExtensionTableProvider extends DialogComponentProvider {
*
* @param tool the plugin tool
*/
- public ExtensionTableProvider(PluginTool tool) {
+ public ExtensionTableDialog(PluginTool tool) {
super("Install Extensions");
addWorkPanel(createMainPanel(tool));
setHelpLocation(new HelpLocation(GenericHelpTopics.FRONT_END, "Extensions"));
@@ -73,12 +73,11 @@ public class ExtensionTableProvider extends DialogComponentProvider {
extensionTablePanel = new ExtensionTablePanel(tool);
extensionTablePanel.getAccessibleContext().setAccessibleName("Extenstion Table");
- ExtensionDetailsPanel extensionDetailsPanel =
- new ExtensionDetailsPanel(extensionTablePanel);
- extensionDetailsPanel.getAccessibleContext().setAccessibleName("Extension Details");
+ ExtensionDetailsPanel detailsPanel = new ExtensionDetailsPanel(extensionTablePanel);
+ detailsPanel.getAccessibleContext().setAccessibleName("Extension Details");
- final JSplitPane splitPane =
- new JSplitPane(JSplitPane.VERTICAL_SPLIT, extensionTablePanel, extensionDetailsPanel);
+ JSplitPane splitPane =
+ new JSplitPane(JSplitPane.VERTICAL_SPLIT, extensionTablePanel, detailsPanel);
splitPane.setResizeWeight(.75);
splitPane.getAccessibleContext().setAccessibleName("Extension Table and Details");
panel.add(splitPane, BorderLayout.CENTER);
@@ -86,7 +85,7 @@ public class ExtensionTableProvider extends DialogComponentProvider {
splitPane.setDividerLocation(.75);
createAddAction(extensionTablePanel);
- createRefreshAction(extensionTablePanel, extensionDetailsPanel);
+ createRefreshAction(extensionTablePanel, detailsPanel);
addOKButton();
panel.getAccessibleContext().setAccessibleName("Extension Table Provider");
@@ -129,41 +128,12 @@ public class ExtensionTableProvider extends DialogComponentProvider {
return false;
}
Object contextObject = context.getContextObject();
- return ExtensionTableProvider.this == contextObject;
+ return ExtensionTableDialog.this == contextObject;
}
@Override
public void actionPerformed(ActionContext context) {
-
- // Don't let the user attempt to install anything if they don't have write
- // permissions on the installation dir.
- ResourceFile installDir =
- Application.getApplicationLayout().getExtensionInstallationDirs().get(0);
- if (!installDir.exists() && !installDir.mkdir()) {
- Msg.showError(this, null, "Directory Error",
- "Cannot install/uninstall extensions: Failed to create extension " +
- "installation directory: " + installDir);
- }
- if (!installDir.canWrite()) {
- Msg.showError(this, null, "Permissions Error",
- "Cannot install/uninstall extensions: Invalid write permissions on " +
- "installation directory: " + installDir);
- return;
- }
-
- GhidraFileChooser chooser = new GhidraFileChooser(getComponent());
- chooser.setFileSelectionMode(GhidraFileChooserMode.FILES_AND_DIRECTORIES);
- chooser.setLastDirectoryPreference(LAST_IMPORT_DIRECTORY_KEY);
- chooser.setTitle("Select Extension");
- chooser.addFileFilter(new ExtensionFileFilter());
-
- List files = chooser.getSelectedFiles();
- chooser.dispose();
-
- if (installExtensions(files)) {
- panel.refreshTable();
- requireRestart = true;
- }
+ doAddExtension(panel);
}
};
@@ -175,6 +145,38 @@ public class ExtensionTableProvider extends DialogComponentProvider {
addAction(addAction);
}
+ private void doAddExtension(ExtensionTablePanel panel) {
+ // Don't let the user attempt to install anything if they don't have write
+ // permissions on the installation dir.
+ List dirs = Application.getApplicationLayout().getExtensionInstallationDirs();
+ ResourceFile installDir = dirs.get(0);
+ if (!installDir.exists() && !installDir.mkdir()) {
+ Msg.showError(this, null, "Directory Error",
+ "Cannot install/uninstall extensions: Failed to create extension " +
+ "installation directory: " + installDir);
+ }
+ if (!installDir.canWrite()) {
+ Msg.showError(this, null, "Permissions Error",
+ "Cannot install/uninstall extensions: Invalid write permissions on " +
+ "installation directory: " + installDir);
+ return;
+ }
+
+ GhidraFileChooser chooser = new GhidraFileChooser(getComponent());
+ chooser.setFileSelectionMode(GhidraFileChooserMode.FILES_AND_DIRECTORIES);
+ chooser.setLastDirectoryPreference(LAST_IMPORT_DIRECTORY_KEY);
+ chooser.setTitle("Select Extension");
+ chooser.addFileFilter(new ExtensionFileFilter());
+
+ List files = chooser.getSelectedFiles();
+ chooser.dispose();
+
+ if (installExtensions(files)) {
+ panel.refreshTable();
+ requireRestart = true;
+ }
+ }
+
private boolean installExtensions(List files) {
boolean didInstall = false;
for (File file : files) {
@@ -183,9 +185,9 @@ public class ExtensionTableProvider extends DialogComponentProvider {
// instead of a fully built extension.
if (new File(file, "build.gradle").isFile()) {
Msg.showWarn(this, null, "Invalid Extension",
- "The selected extension " +
- "contains a 'build.gradle' file.\nGhidra does not support installing " +
- "extensions in source form.\nPlease build the extension and try again.");
+ "The selected extension contains a 'build.gradle' file.\n" +
+ "Ghidra does not support installing extensions in source form.\n" +
+ "Please build the extension and try again.");
continue;
}
@@ -196,7 +198,7 @@ public class ExtensionTableProvider extends DialogComponentProvider {
}
/**
- * Creates an action to refresh the extensions list.
+ * Creates an action to refresh the extensions list.
*
* @param tablePanel the table to be refreshed
* @param detailsPanel the details to be refreshed
@@ -210,7 +212,7 @@ public class ExtensionTableProvider extends DialogComponentProvider {
@Override
public boolean isEnabledForContext(ActionContext context) {
Object contextObject = context.getContextObject();
- return ExtensionTableProvider.this == contextObject;
+ return ExtensionTableDialog.this == contextObject;
}
@Override
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTableModel.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTableModel.java
index eace5cabd1..263102a6fd 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTableModel.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTableModel.java
@@ -37,18 +37,19 @@ import ghidra.util.task.TaskMonitor;
* Model for the {@link ExtensionTablePanel}. This defines 5 columns for displaying information in
* {@link ExtensionDetails} objects:
*
- * - Installed (checkbox)
+ * - Installation Status
* - Name
* - Description
- * - Installation directory (hidden)
- * - Archive directory (hidden)
+ * - Version
+ * - Installation Directory (hidden)
+ * - Archive File (hidden)
*
*
* All columns are for display purposes only, except for the installed column, which
* is a checkbox allowing users to install/uninstall a particular extension.
*
*/
-class ExtensionTableModel extends ThreadedTableModel {
+class ExtensionTableModel extends ThreadedTableModel {
/** We don't care about the ordering of other columns, but the install/uninstall checkbox should be
the first one and the name col is our initial sort column. */
@@ -56,7 +57,7 @@ class ExtensionTableModel extends ThreadedTableModel {
final static int NAME_COL = 1;
/** This is the data source for the model. Whatever is here will be displayed in the table. */
- private Set extensions;
+ private Set extensions;
private Map originalInstallStates = new HashMap<>();
/**
@@ -69,9 +70,9 @@ class ExtensionTableModel extends ThreadedTableModel {
}
@Override
- protected TableColumnDescriptor createTableColumnDescriptor() {
+ protected TableColumnDescriptor createTableColumnDescriptor() {
- TableColumnDescriptor descriptor = new TableColumnDescriptor<>();
+ TableColumnDescriptor descriptor = new TableColumnDescriptor<>();
descriptor.addVisibleColumn(new ExtensionInstalledColumn(), INSTALLED_COL, true);
descriptor.addVisibleColumn(new ExtensionNameColumn(), NAME_COL, true);
@@ -111,27 +112,23 @@ class ExtensionTableModel extends ThreadedTableModel {
@Override
public void setValueAt(Object aValue, int rowIndex, int columnIndex) {
- // We only care about the install column here, as it's the only one that
- // is editable.
+ // We only care about the install column here, as it's the only one that is editable.
if (columnIndex != INSTALLED_COL) {
return;
}
- // If the user does not have write permissions on the installation dir, they cannot
- // install.
- ResourceFile installDir =
- Application.getApplicationLayout().getExtensionInstallationDirs().get(0);
+ // If the user does not have write permissions on the installation dir, they cannot install.
+ List dirs = Application.getApplicationLayout().getExtensionInstallationDirs();
+ ResourceFile installDir = dirs.get(0);
if (!installDir.exists() && !installDir.mkdir()) {
Msg.showError(this, null, "Directory Error",
- "Cannot install/uninstall extensions: Failed to create extension installation " +
- "directory.\nSee the \"Ghidra Extension Notes\" section of the Ghidra " +
- "Installation Guide for more information.");
+ "Cannot install/uninstall extensions: Failed to create installation directory.\n" +
+ "See the 'Ghidra Extension Notes' section of the Ghidra Installation Guide.");
}
if (!installDir.canWrite()) {
Msg.showError(this, null, "Permissions Error",
- "Cannot install/uninstall extensions: Invalid write permissions on installation " +
- "directory.\nSee the \"Ghidra Extension Notes\" section of the Ghidra " +
- "Installation Guide for more information.");
+ "Cannot install/uninstall extensions: Cannot write to installation directory.\n" +
+ "See the 'Ghidra Extension Notes' section of the Ghidra Installation Guide.");
return;
}
@@ -165,8 +162,9 @@ class ExtensionTableModel extends ThreadedTableModel {
// This is a programming error
Msg.error(this,
- "Unable install an extension that no longer exists. Restart Ghidra and " +
- "try manually installing the extension: '" + extension.getName() + "'");
+ "Unable install an extension that no longer exists.\n" +
+ "Restart Ghidra and try manually installing the extension: '" +
+ extension.getName() + "'");
}
/**
@@ -187,7 +185,7 @@ class ExtensionTableModel extends ThreadedTableModel {
}
@Override
- protected void doLoad(Accumulator accumulator, TaskMonitor monitor)
+ protected void doLoad(Accumulator accumulator, TaskMonitor monitor)
throws CancelledException {
if (extensions != null) {
accumulator.addAll(extensions);
@@ -196,22 +194,29 @@ class ExtensionTableModel extends ThreadedTableModel {
ExtensionUtils.reload();
Set archived = ExtensionUtils.getArchiveExtensions();
- Set installed = ExtensionUtils.getInstalledExtensions();
-
- // don't show archived extensions that have been installed
- for (ExtensionDetails extension : installed) {
- if (archived.remove(extension)) {
- Msg.trace(this,
- "Not showing archived extension that has been installed. Archive path: " +
- extension.getArchivePath()); // useful for debugging
- }
- }
+ Set installed = ExtensionInstallationInfo.get();
extensions = new HashSet<>();
- extensions.addAll(installed);
- extensions.addAll(archived);
- for (ExtensionDetails e : extensions) {
+ // don't show archived extensions that have been installed
+ for (ExtensionInstallationInfo info : installed) {
+
+ ExtensionDetails e = info.getExtension();
+ if (archived.remove(e)) {
+ Msg.trace(this,
+ "Not showing archived extension that has been installed. Archive path: " +
+ e.getArchivePath()); // useful for debugging
+ }
+
+ extensions.add(new ExtensionRowObject(e, info));
+ }
+
+ for (ExtensionDetails e : archived) {
+ extensions.add(new ExtensionRowObject(e));
+ }
+
+ for (ExtensionRowObject ro : extensions) {
+ ExtensionDetails e = ro.getExtension();
String name = e.getName();
if (originalInstallStates.containsKey(name)) {
continue; // preserve the original value
@@ -229,7 +234,8 @@ class ExtensionTableModel extends ThreadedTableModel {
*/
public boolean hasModelChanged() {
- for (ExtensionDetails e : extensions) {
+ for (ExtensionRowObject ro : extensions) {
+ ExtensionDetails e = ro.getExtension();
Boolean wasInstalled = originalInstallStates.get(e.getName());
if (wasInstalled == null) {
return false;
@@ -248,7 +254,12 @@ class ExtensionTableModel extends ThreadedTableModel {
* @param model the list to use as the model
*/
public void setModelData(List model) {
- extensions = new HashSet<>(model);
+
+ extensions = new HashSet<>();
+ for (ExtensionDetails e : model) {
+ extensions.add(new ExtensionRowObject(e));
+ }
+
reload();
}
@@ -270,14 +281,18 @@ class ExtensionTableModel extends ThreadedTableModel {
* @return the selected extension, or null if nothing is selected
*/
private ExtensionDetails getSelectedExtension(int row) {
- return getRowObject(row);
+ ExtensionRowObject ro = getRowObject(row);
+ if (ro != null) {
+ return ro.getExtension();
+ }
+ return null;
}
/**
* Table column for displaying the extension name.
*/
private class ExtensionNameColumn
- extends AbstractDynamicTableColumn {
+ extends AbstractDynamicTableColumn {
private ExtRenderer renderer = new ExtRenderer();
@@ -292,9 +307,9 @@ class ExtensionTableModel extends ThreadedTableModel {
}
@Override
- public String getValue(ExtensionDetails rowObject, Settings settings, Object data,
+ public String getValue(ExtensionRowObject rowObject, Settings settings, Object data,
ServiceProvider sp) throws IllegalArgumentException {
- return rowObject.getName();
+ return rowObject.getExtension().getName();
}
@Override
@@ -307,7 +322,7 @@ class ExtensionTableModel extends ThreadedTableModel {
* Table column for displaying the extension description.
*/
private class ExtensionDescriptionColumn
- extends AbstractDynamicTableColumn {
+ extends AbstractDynamicTableColumn {
private ExtRenderer renderer = new ExtRenderer();
@@ -322,9 +337,9 @@ class ExtensionTableModel extends ThreadedTableModel {
}
@Override
- public String getValue(ExtensionDetails rowObject, Settings settings, Object data,
+ public String getValue(ExtensionRowObject rowObject, Settings settings, Object data,
ServiceProvider sp) throws IllegalArgumentException {
- return rowObject.getDescription();
+ return rowObject.getExtension().getDescription();
}
@Override
@@ -337,7 +352,7 @@ class ExtensionTableModel extends ThreadedTableModel {
* Table column for displaying the extension description.
*/
private class ExtensionVersionColumn
- extends AbstractDynamicTableColumn {
+ extends AbstractDynamicTableColumn {
private ExtRenderer renderer = new ExtRenderer();
@@ -352,10 +367,10 @@ class ExtensionTableModel extends ThreadedTableModel {
}
@Override
- public String getValue(ExtensionDetails rowObject, Settings settings, Object data,
+ public String getValue(ExtensionRowObject rowObject, Settings settings, Object data,
ServiceProvider sp) throws IllegalArgumentException {
- String version = rowObject.getVersion();
+ String version = rowObject.getExtension().getVersion();
// Check for the default version value. If this is still set, then no version has been
// established so just display an empty string.
@@ -376,7 +391,7 @@ class ExtensionTableModel extends ThreadedTableModel {
* Table column for displaying the extension installation status.
*/
private class ExtensionInstalledColumn
- extends AbstractDynamicTableColumn {
+ extends AbstractDynamicTableColumn {
@Override
public String getColumnName() {
@@ -389,9 +404,9 @@ class ExtensionTableModel extends ThreadedTableModel {
}
@Override
- public Boolean getValue(ExtensionDetails rowObject, Settings settings, Object data,
+ public Boolean getValue(ExtensionRowObject rowObject, Settings settings, Object data,
ServiceProvider sp) throws IllegalArgumentException {
- return rowObject.isInstalled();
+ return rowObject.getExtension().isInstalled();
}
}
@@ -399,7 +414,7 @@ class ExtensionTableModel extends ThreadedTableModel {
* Table column for displaying the extension installation directory.
*/
private class ExtensionInstallationDirColumn
- extends AbstractDynamicTableColumn {
+ extends AbstractDynamicTableColumn {
@Override
public String getColumnName() {
@@ -412,9 +427,9 @@ class ExtensionTableModel extends ThreadedTableModel {
}
@Override
- public String getValue(ExtensionDetails rowObject, Settings settings, Object data,
+ public String getValue(ExtensionRowObject rowObject, Settings settings, Object data,
ServiceProvider sp) throws IllegalArgumentException {
- return rowObject.getInstallPath();
+ return rowObject.getExtension().getInstallPath();
}
}
@@ -422,7 +437,7 @@ class ExtensionTableModel extends ThreadedTableModel {
* Table column for displaying the extension archive file.
*/
private class ExtensionArchiveFileColumn
- extends AbstractDynamicTableColumn {
+ extends AbstractDynamicTableColumn {
@Override
public String getColumnName() {
@@ -435,9 +450,9 @@ class ExtensionTableModel extends ThreadedTableModel {
}
@Override
- public String getValue(ExtensionDetails rowObject, Settings settings, Object data,
+ public String getValue(ExtensionRowObject rowObject, Settings settings, Object data,
ServiceProvider sp) throws IllegalArgumentException {
- return rowObject.getArchivePath();
+ return rowObject.getExtension().getArchivePath();
}
}
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTablePanel.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTablePanel.java
index 68ca08ab90..07216093b5 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTablePanel.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionTablePanel.java
@@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -36,7 +36,7 @@ import help.HelpService;
*/
public class ExtensionTablePanel extends JPanel {
- private GTableFilterPanel tableFilterPanel;
+ private GTableFilterPanel tableFilterPanel;
private ExtensionTableModel tableModel;
private GTable table;
@@ -85,7 +85,7 @@ public class ExtensionTablePanel extends JPanel {
return table;
}
- public ExtensionDetails getSelectedItem() {
+ public ExtensionRowObject getSelectedItem() {
return tableFilterPanel.getSelectedItem();
}
@@ -96,15 +96,6 @@ public class ExtensionTablePanel extends JPanel {
tableModel.refreshTable();
}
- /**
- * Returns the filter panel.
- *
- * @return the filter panel
- */
- public GTableFilterPanel getFilterPanel() {
- return tableFilterPanel;
- }
-
/**
* Replaces the contents of the table with the given list of extensions.
*
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/tool/ExtensionsEnabledState.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/tool/ExtensionsEnabledState.java
index 936c4efae7..1ed5b04f3d 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/tool/ExtensionsEnabledState.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/tool/ExtensionsEnabledState.java
@@ -18,6 +18,8 @@ package ghidra.framework.project.tool;
import java.util.Map;
import java.util.Set;
+import ghidra.util.classfinder.ClassFileInfo;
+
/**
* An interface to help describe extensions' enable state for a given tool.
*/
@@ -26,18 +28,18 @@ public interface ExtensionsEnabledState {
/**
* {@return a map of all known extensions to a set of their plugins}
*/
- public Map>> getAllKnownExtensions();
+ public Map> getAllKnownExtensions();
/**
* All plugins installed in the current tool will be removed from the given set. This allows the
* client to have a set of plugins that are not currently installed.
* @param allPlugins the plugins set to update
*/
- public void removeInstalledPlugins(Set> allPlugins);
+ public void removeInstalledPlugins(Set allPlugins);
/**
* Shows a window to prompt the user to configure any new extension plugins.
* @param newPlugins the new extension plugins
*/
- public void propmtToConfigureNewPlugins(Set> newPlugins);
+ public void propmtToConfigureNewPlugins(Set newPlugins);
}
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/tool/ToolExtensionsEnabledState.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/tool/ToolExtensionsEnabledState.java
index 6f24ca7a03..b8b17abf4f 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/tool/ToolExtensionsEnabledState.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/tool/ToolExtensionsEnabledState.java
@@ -16,26 +16,25 @@
package ghidra.framework.project.tool;
import java.io.File;
-import java.net.URL;
import java.util.*;
import java.util.stream.Collectors;
import docking.widgets.OptionDialog;
-import generic.json.Json;
import ghidra.framework.plugintool.*;
import ghidra.framework.plugintool.dialog.PluginInstallerDialog;
import ghidra.framework.plugintool.util.PluginDescription;
+import ghidra.framework.project.extensions.ExtensionInstallationInfo;
import ghidra.util.SystemUtilities;
-import ghidra.util.classfinder.ClassSearcher;
+import ghidra.util.classfinder.ClassFileInfo;
import ghidra.util.extensions.ExtensionDetails;
-import ghidra.util.extensions.ExtensionUtils;
-import utilities.util.FileUtilities;
/**
* The default extension state for a {@link PluginTool}.
*/
class ToolExtensionsEnabledState implements ExtensionsEnabledState {
+ private static String PLUGIN_SUFFIX = Plugin.class.getSimpleName();
+
private PluginTool tool;
ToolExtensionsEnabledState(PluginTool tool) {
@@ -43,33 +42,61 @@ class ToolExtensionsEnabledState implements ExtensionsEnabledState {
}
@Override
- public Map>> getAllKnownExtensions() {
+ public Map> getAllKnownExtensions() {
- Set extensions = getExtensions();
+ Set extensions = getExtensions();
if (extensions.isEmpty()) {
return Map.of();
}
- Map>> plugins = new HashMap<>();
- Set pluginPaths = getAllPluginPaths();
- for (ExtensionDetails extension : extensions) {
- Set> classes = findPluginsLoadedFromExtension(extension, pluginPaths);
- plugins.put(extension.getName(), classes);
+ Map> result = new HashMap<>();
+ for (ExtensionInstallationInfo info : extensions) {
+
+ ExtensionDetails extension = info.getExtension();
+ Set plugins = getPlugins(info);
+ if (plugins.isEmpty()) {
+ continue;
+ }
+
+ result.put(extension.getName(), plugins);
}
- return plugins;
+ return result;
+ }
+
+ private Set getPlugins(ExtensionInstallationInfo info) {
+
+ Set result = new HashSet<>();
+ Set classInfos = info.getClassInfos();
+ for (ClassFileInfo classInfo : classInfos) {
+ String suffix = classInfo.suffix();
+ if (PLUGIN_SUFFIX.equals(suffix)) {
+ result.add(classInfo);
+ }
+ }
+ return result;
}
@Override
- public void removeInstalledPlugins(Set> plugins) {
+ public void removeInstalledPlugins(Set plugins) {
List activePlugins = tool.getManagedPlugins();
- for (Plugin plugin : activePlugins) {
- Class clazz = plugin.getClass();
- plugins.remove(clazz);
+
+ Set activeClassNames = activePlugins.stream()
+ .map(Plugin::getClass)
+ .map(Class::getName)
+ .collect(Collectors.toSet());
+
+ Iterator it = plugins.iterator();
+ while (it.hasNext()) {
+ ClassFileInfo info = it.next();
+ String name = info.name();
+ if (activeClassNames.contains(name)) {
+ it.remove();
+ }
}
}
@Override
- public void propmtToConfigureNewPlugins(Set> plugins) {
+ public void propmtToConfigureNewPlugins(Set plugins) {
// Offer the user a chance to configure any newly discovered plugins
int option = OptionDialog.showYesNoDialog(tool.getToolFrame(), "New Plugins Found!",
"New extension plugins detected. Would you like to configure them?");
@@ -81,20 +108,20 @@ class ToolExtensionsEnabledState implements ExtensionsEnabledState {
}
}
- private static Set getAllPluginPaths() {
- Set paths = new HashSet<>();
- List> plugins = ClassSearcher.getClasses(Plugin.class);
- for (Class plugin : plugins) {
- paths.add(new PluginPath(plugin));
- }
- return paths;
- }
+ private static Set getExtensions() {
- private static Set getExtensions() {
- Set installedExtensions = ExtensionUtils.getActiveInstalledExtensions();
- return installedExtensions.stream()
- .filter(e -> !isRepoExtension(e))
- .collect(Collectors.toSet());
+ Set infos = ExtensionInstallationInfo.get();
+ Iterator it = infos.iterator();
+ while (it.hasNext()) {
+
+ ExtensionInstallationInfo info = it.next();
+ ExtensionDetails e = info.getExtension();
+ if (isRepoExtension(e) || e.isPendingUninstall()) {
+ it.remove();
+ }
+ }
+
+ return infos;
}
/**
@@ -117,45 +144,6 @@ class ToolExtensionsEnabledState implements ExtensionsEnabledState {
return false;
}
- /**
- * Finds all plugin classes loaded from a particular extension folder.
- *
- * This uses the {@link ClassSearcher} to find all Plugin.class objects on the
- * classpath. For each class, the original resource file is compared against the
- * given extension folder and the jar files for that extension.
- *
- * @param extension the extension from which to find plugins
- * @param pluginPaths all loaded plugin paths
- * @return list of {@link Plugin} classes, or empty list if none found
- */
- private static Set> findPluginsLoadedFromExtension(ExtensionDetails extension,
- Set pluginPaths) {
-
- if (!extension.isInstalled()) {
- return Collections.emptySet();
- }
-
- // Find any jar files in the directory provided
- Set jarPaths = extension.getLibraries();
-
- // Now get all Plugin.class file paths and see if any of them were loaded from one of the
- // extension the given extension directory
- Set> result = new HashSet<>();
- for (PluginPath pluginPath : pluginPaths) {
- if (pluginPath.isFrom(extension.getInstallDir())) {
- result.add(pluginPath.getPluginClass());
- continue;
- }
-
- for (URL jarUrl : jarPaths) {
- if (pluginPath.isFrom(jarUrl)) {
- result.add(pluginPath.getPluginClass());
- }
- }
- }
- return result;
- }
-
/**
* Finds all {@link PluginDescription} objects that match a given set of plugin classes. This
* effectively tells the caller which of the given plugins have been loaded by the class loader.
@@ -167,7 +155,7 @@ class ToolExtensionsEnabledState implements ExtensionsEnabledState {
* @param plugins the list of plugin classes to search for
* @return list of plugin descriptions
*/
- private List getPluginDescriptions(Set> plugins) {
+ private List getPluginDescriptions(Set plugins) {
// First define the list of plugin descriptions to return
List descriptions = new ArrayList<>();
@@ -178,11 +166,11 @@ class ToolExtensionsEnabledState implements ExtensionsEnabledState {
pluginsConfiguration.getManagedPluginDescriptions();
// see if an entry exists in the list of all loaded plugins
- for (Class plugin : plugins) {
- String pluginName = plugin.getSimpleName();
+ for (ClassFileInfo info : plugins) {
+ String pluginName = info.simpleName();
Optional desc = allPluginDescriptions.stream()
- .filter(d -> (pluginName.equals(d.getName())))
+ .filter(d -> pluginName.equals(d.getName()))
.findAny();
if (desc.isPresent()) {
descriptions.add(desc.get());
@@ -192,35 +180,4 @@ class ToolExtensionsEnabledState implements ExtensionsEnabledState {
return descriptions;
}
- private static class PluginPath {
- private Class pluginClass;
- private String pluginLocation;
- private File pluginFile;
-
- PluginPath(Class pluginClass) {
- this.pluginClass = pluginClass;
- String name = pluginClass.getName();
- URL url = pluginClass.getResource('/' + name.replace('.', '/') + ".class");
- this.pluginLocation = url.getPath();
- this.pluginFile = new File(pluginLocation);
- }
-
- public boolean isFrom(File dir) {
- return FileUtilities.isPathContainedWithin(dir, pluginFile);
- }
-
- boolean isFrom(URL jarUrl) {
- String jarPath = jarUrl.getPath();
- return pluginLocation.contains(jarPath);
- }
-
- Class getPluginClass() {
- return pluginClass;
- }
-
- @Override
- public String toString() {
- return Json.toString(this);
- }
- }
}
diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/tool/ToolExtensionsStatusManager.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/tool/ToolExtensionsStatusManager.java
index 0553c8250f..e3b6654dd2 100644
--- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/tool/ToolExtensionsStatusManager.java
+++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/project/tool/ToolExtensionsStatusManager.java
@@ -25,6 +25,7 @@ import org.jdom2.Element;
import ghidra.util.NumericUtilities;
import ghidra.util.Swing;
+import ghidra.util.classfinder.ClassFileInfo;
import ghidra.util.xml.XmlUtilities;
/**
@@ -39,7 +40,7 @@ class ToolExtensionsStatusManager {
private static final String XML_ATTR_EXTENSION_NAME = "NAME";
private static final String XML_ATTR_EXTENSION_PLUGIN_CLASS = "CLASS";
- private Set> newExtensionPlugins = new HashSet<>();
+ private Set newExtensionPlugins = new HashSet<>();
private ExtensionsEnabledState extensionsState;
ToolExtensionsStatusManager(ExtensionsEnabledState extensionState) {
@@ -60,21 +61,21 @@ class ToolExtensionsStatusManager {
void saveToXml(Element xml) {
- Map>> pluginsByExtension =
+ Map> pluginsByExtension =
extensionsState.getAllKnownExtensions();
Element extensionsParent = new Element(XML_TAG_EXTENSIONS);
- Set>>> entries = pluginsByExtension.entrySet();
- for (Entry>> entry : entries) {
+ Set>> entries = pluginsByExtension.entrySet();
+ for (Entry> entry : entries) {
String name = entry.getKey();
Element extensionsElement = new Element(XML_TAG_EXTENSION);
setExtensionName(extensionsElement, name);
extensionsParent.addContent(extensionsElement);
- Set> plugins = entry.getValue();
- for (Class clazz : plugins) {
- String className = clazz.getName();
+ Set infos = entry.getValue();
+ for (ClassFileInfo info : infos) {
+ String className = info.name();
Element pluginElement = new Element(XML_TAG_PLUGIN);
pluginElement.setAttribute(XML_ATTR_EXTENSION_PLUGIN_CLASS, className);
extensionsElement.addContent(pluginElement);
@@ -98,7 +99,7 @@ class ToolExtensionsStatusManager {
5) Save the new extension plugins for later user prompting when saving to xml.
*/
- Map>> extensionPlugins = extensionsState.getAllKnownExtensions();
+ Map> extensionPlugins = extensionsState.getAllKnownExtensions();
Map xmlMementosByName = getKnownExtensions(xml);
Set names = extensionPlugins.keySet();
Set newExtensions = new HashSet<>(names);
@@ -115,7 +116,7 @@ class ToolExtensionsStatusManager {
}
}
- Set> newPlugins = newExtensions.stream()
+ Set newPlugins = newExtensions.stream()
.map(name -> extensionPlugins.get(name)) // classes by extension name
.flatMap(set -> set.stream()) // map all sets to a single stream
.collect(Collectors.toSet());
@@ -129,19 +130,19 @@ class ToolExtensionsStatusManager {
}
private static boolean hasNewPlugins(ExtensionMemento xmlMemento,
- Map>> pluginsByExtensionName) {
+ Map> pluginsByExtensionName) {
// If the xml memento is empty, it is either the old style xml that did not save plugin
// names or is the new style xml, but the extension did not previously have any plugins. In
// this case, we want to prompt the user if there are plugins to install.
Set xmlClassNames = xmlMemento.pluginClassNames();
- Set> cpPluginClasses = pluginsByExtensionName.get(xmlMemento.name());
+ Set cpPluginClasses = pluginsByExtensionName.get(xmlMemento.name());
if (xmlClassNames.isEmpty() && !cpPluginClasses.isEmpty()) {
return true;
}
List cpNames = cpPluginClasses.stream()
- .map(c -> c.getName())
+ .map(c -> c.name())
.collect(Collectors.toList());
cpNames.removeAll(xmlClassNames);
diff --git a/Ghidra/Test/IntegrationTest/src/screen/java/help/screenshot/FrontEndPluginScreenShots.java b/Ghidra/Test/IntegrationTest/src/screen/java/help/screenshot/FrontEndPluginScreenShots.java
index e8822cf2d4..95a5e03ad5 100644
--- a/Ghidra/Test/IntegrationTest/src/screen/java/help/screenshot/FrontEndPluginScreenShots.java
+++ b/Ghidra/Test/IntegrationTest/src/screen/java/help/screenshot/FrontEndPluginScreenShots.java
@@ -43,7 +43,7 @@ import ghidra.framework.main.wizard.project.*;
import ghidra.framework.model.*;
import ghidra.framework.preferences.Preferences;
import ghidra.framework.project.extensions.ExtensionTablePanel;
-import ghidra.framework.project.extensions.ExtensionTableProvider;
+import ghidra.framework.project.extensions.ExtensionTableDialog;
import ghidra.framework.remote.User;
import ghidra.framework.store.LockException;
import ghidra.program.database.ProgramContentHandler;
@@ -190,8 +190,8 @@ public class FrontEndPluginScreenShots extends GhidraScreenShotGenerator {
performAction("Extensions", "Project Window", false);
waitForSwing();
- ExtensionTableProvider provider =
- (ExtensionTableProvider) getDialog(ExtensionTableProvider.class);
+ ExtensionTableDialog provider =
+ (ExtensionTableDialog) getDialog(ExtensionTableDialog.class);
Object panel = getInstanceField("extensionTablePanel", provider);
GTable table = (GTable) getInstanceField("table", panel);
Congfigure menu to
+ enable any plugins added by newly installed extensions.
+ The easiest way to find the plugins + for a given extension is to use the table view of all known plugins. To see all plugins + for an extension:
icon to show all plugins +
If the checkbox is not editable,
+ that means that means the extension is installed and canont be uninistalled. This can
+ happen in development mode with extensions that live in source control.