ghidra-master/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/exporter/ExporterDialog.java
/* ###
 * 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.app.plugin.core.exporter;

import java.awt.BorderLayout;
import java.awt.Component;
import java.io.File;
import java.io.IOException;
import java.util.*;

import javax.swing.*;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;

import docking.DialogComponentProvider;
import docking.widgets.OptionDialog;
import docking.widgets.button.BrowseButton;
import docking.widgets.checkbox.GCheckBox;
import docking.widgets.combobox.GhidraComboBox;
import docking.widgets.filechooser.GhidraFileChooser;
import docking.widgets.filechooser.GhidraFileChooserMode;
import docking.widgets.label.GLabel;
import ghidra.app.plugin.core.help.AboutDomainObjectUtils;
import ghidra.app.util.*;
import ghidra.app.util.exporter.Exporter;
import ghidra.app.util.exporter.GzfExporter;
import ghidra.app.util.importer.MessageLog;
import ghidra.framework.main.FrontEndService;
import ghidra.framework.model.DomainFile;
import ghidra.framework.model.DomainObject;
import ghidra.framework.plugintool.PluginTool;
import ghidra.framework.preferences.Preferences;
import ghidra.program.model.address.AddressFactory;
import ghidra.program.model.listing.Program;
import ghidra.program.util.ProgramSelection;
import ghidra.util.*;
import ghidra.util.classfinder.ClassSearcher;
import ghidra.util.exception.CancelledException;
import ghidra.util.exception.VersionException;
import ghidra.util.filechooser.ExtensionFileFilter;
import ghidra.util.filechooser.GhidraFileFilter;
import ghidra.util.layout.PairLayout;
import ghidra.util.layout.VerticalLayout;
import ghidra.util.task.*;

/**
 * Dialog for exporting a program from a Ghidra project to an external file in one of the
 * supported export formats.
 */

public class ExporterDialog extends DialogComponentProvider implements AddressFactoryService {

	private static final String XML_WARNING =
		"   Warning: XML is lossy and intended only for transfering data to external tools. " +
			"GZF is the recommended format for saving and sharing program data.";

	private static String lastUsedExporterName = GzfExporter.NAME; // default to GZF first time

	private JButton optionsButton;
	private ProgramSelection currentSelection;
	private JCheckBox selectionCheckBox; // null for FrontEnd Tool use
	private JTextField filePathTextField;
	private JButton fileChooserButton;
	private GhidraComboBox<Exporter> comboBox;
	private final DomainFile domainFile;
	private boolean domainObjectWasSupplied;
	private DomainObject domainObject;
	private List<Option> options;
	private PluginTool tool;

	private JLabel selectionOnlyLabel;

	/**
	 * Construct a new ExporterDialog for exporting an entire program.
	 *
	 * @param tool the tool that launched this dialog.
	 * @param domainFile the program to export
	 */
	public ExporterDialog(PluginTool tool, DomainFile domainFile) {
		this(tool, domainFile, null, null);
	}

	/**
	 * Construct a new ExporterDialog for exporting a program, optionally only exported a
	 * selected region.
	 *
	 * @param tool the tool that launched this dialog.
	 * @param domainFile the program file to export. (may be proxy)
	 * @param domainObject the program to export if already open, otherwise null.
	 * @param selection the current program selection (ignored for FrontEnd Tool).
	 */
	public ExporterDialog(PluginTool tool, DomainFile domainFile, DomainObject domainObject,
			ProgramSelection selection) {
		super("Export " + domainFile.getName());
		this.tool = tool;
		this.domainFile = domainFile;
		this.domainObject = domainObject;
		this.currentSelection = selection;
		if (domainObject != null) {
			domainObjectWasSupplied = true;
			domainObject.addConsumer(this);
		}
		else {
			domainObject = getDomainObjectIfNeeded(TaskMonitor.DUMMY);
		}

		addWorkPanel(buildWorkPanel());
		addOKButton();
		addCancelButton();
		setHelpLocation(new HelpLocation("ExporterPlugin", "Exporter_Dialog"));

		// This dialog is temporary and will be closed when the task is finished.  Mark
		// it transient so no other windows will be parented to this dialog.
		setTransient(true);

		// need to initialize a few things
		selectedFormatChanged();
		validate();
	}

	@Override
	public void close() {
		super.close();
		if (domainObject != null) {
			domainObject.release(this);
		}
	}

	private boolean isFrontEndPlugin() {
		return tool.getService(FrontEndService.class) != null;
	}

	private JComponent buildWorkPanel() {
		JPanel panel = new JPanel(new VerticalLayout(5));
		panel.setBorder(BorderFactory.createEmptyBorder(10, 10, 10, 10));
		panel.add(buildMainPanel());
		panel.add(buildButtonPanel());
		return panel;
	}

	private Component buildButtonPanel() {
		JPanel panel = new JPanel(new BorderLayout());
		panel.setBorder(BorderFactory.createEmptyBorder(0, 10, 0, 10));
		JPanel innerPanel = new JPanel(new VerticalLayout(5));
		innerPanel.add(buildOptionsButton());
		panel.add(buildSelectionCheckboxPanel(), BorderLayout.WEST);
		panel.add(innerPanel, BorderLayout.EAST);
		return panel;
	}

	private Component buildOptionsButton() {
		optionsButton = new JButton("Options...");
		optionsButton.addActionListener(e -> showOptions());
		return optionsButton;
	}

	private void showOptions() {
		OptionValidator validator = optionList -> {
			try {
				getSelectedExporter().setOptions(optionList);
				return null;
			}
			catch (OptionException e) {
				return e.getMessage();   // OptionExceptions should have good message as to what is wrong
			}
			catch (Exception e) {
				return "Unexpected exception validating options: " + e.getMessage();
			}
		};
		AddressFactoryService svc = (domainObject instanceof Program) ? null : this;
		OptionsDialog optionsDialog = new OptionsDialog(options, validator, svc);
		optionsDialog
				.setHelpLocation(new HelpLocation("ExporterPlugin", getAnchorForSelectedFormat()));
		tool.showDialog(optionsDialog);
		if (!optionsDialog.wasCancelled()) {
			options = optionsDialog.getOptions();
		}

	}

	private String getAnchorForSelectedFormat() {
		Exporter selectedExporter = getSelectedExporter();
		String exporterName = selectedExporter.getName();
		return "Options_" + exporterName;
	}

	private Component buildMainPanel() {
		JPanel panel = new JPanel(new PairLayout(5, 5));
		panel.setBorder(BorderFactory.createEmptyBorder(10, 10, 10, 10));
		panel.add(new GLabel("Format: ", SwingConstants.RIGHT));
		panel.add(buildFormatChooser());
		panel.add(new GLabel("Output File: ", SwingConstants.RIGHT));
		panel.add(buildFilePanel());
		return panel;
	}

	private Component buildSelectionCheckboxPanel() {
		JPanel panel = new JPanel(new PairLayout(5, 5));
		selectionOnlyLabel = new GLabel("Selection Only:");
		if (!isFrontEndPlugin()) {
			selectionCheckBox = new GCheckBox("");
			updateSelectionCheckbox();
			panel.add(selectionOnlyLabel);
			panel.add(selectionCheckBox);
		}
		return panel;
	}

	private Component buildFilePanel() {
		filePathTextField = new JTextField();
		filePathTextField.setName("OUTPUT_FILE_TEXTFIELD");
		filePathTextField.setText(getFileName());
		filePathTextField.getDocument().addDocumentListener(new DocumentListener() {
			@Override
			public void changedUpdate(DocumentEvent e) {
				validate();
			}

			@Override
			public void insertUpdate(DocumentEvent e) {
				validate();
			}

			@Override
			public void removeUpdate(DocumentEvent e) {
				validate();
			}

		});

		fileChooserButton = new BrowseButton();
		fileChooserButton.addActionListener(e -> chooseDestinationFile());

		JPanel panel = new JPanel(new BorderLayout());
		panel.add(filePathTextField, BorderLayout.CENTER);
		panel.add(fileChooserButton, BorderLayout.EAST);
		return panel;
	}

	private String getFileName() {
		String name = domainFile.getName();
		File lastDir = getLastExportDirectory();
		return lastDir.getAbsolutePath() + File.separator + name;
	}

	private void chooseDestinationFile() {
		GhidraFileChooser chooser = new GhidraFileChooser(getComponent());
		chooser.setSelectedFile(getLastExportDirectory());
		chooser.setTitle("Select Output File");
		chooser.setApproveButtonText("Select Output File");
		chooser.setApproveButtonToolTipText("Select File");
		chooser.setFileSelectionMode(GhidraFileChooserMode.FILES_ONLY);

		chooser.setSelectedFileFilter(GhidraFileFilter.ALL);
		Exporter exporter = getSelectedExporter();
		if (exporter != null && exporter.getDefaultFileExtension() != null) {
			chooser.setFileFilter(
				new ExtensionFileFilter(exporter.getDefaultFileExtension(), exporter.getName()));
		}
		String filePath = filePathTextField.getText().trim();
		File currentFile = filePath.isEmpty() ? null : new File(filePath);
		if (currentFile != null) {
			chooser.setSelectedFile(currentFile);
		}
		File file = chooser.getSelectedFile();
		if (file != null) {
			setLastExportDirectory(file);
			filePathTextField.setText(file.getAbsolutePath());
		}
		chooser.dispose();
	}

	private void setLastExportDirectory(File file) {
		Preferences.setProperty(Preferences.LAST_EXPORT_DIRECTORY, file.getParent());
		Preferences.store();
	}

	private File getLastExportDirectory() {
		String lastDirStr = Preferences.getProperty(Preferences.LAST_EXPORT_DIRECTORY,
			System.getProperty("user.home"), true);
		return new File(lastDirStr);
	}

	private Component buildFormatChooser() {

		List<Exporter> exporters = getApplicableExporters(false);
		comboBox = new GhidraComboBox<>(exporters);

		Exporter defaultExporter = getDefaultExporter(exporters);
		if (defaultExporter != null) {
			comboBox.setSelectedItem(defaultExporter);
		}
		comboBox.addItemListener(e -> selectedFormatChanged());
		return comboBox;
	}

	/**
	 * This list generation will be based upon the open domainObject if available, otherwise
	 * the domainFile's content class will be used.
	 * @return list of exporters able to handle content
	 */
	private List<Exporter> getApplicableExporters(boolean preliminaryCheck) {
		List<Exporter> list = new ArrayList<>(ClassSearcher.getInstances(Exporter.class));
		list.removeIf(exporter -> !canExport(exporter, preliminaryCheck));
		Collections.sort(list, (o1, o2) -> o1.toString().compareTo(o2.toString()));
		return list;
	}

	private boolean canExport(Exporter exporter, boolean preliminaryCheck) {
		if (exporter.canExportDomainFile(domainFile)) {
			return true;
		}
		if (domainObject == null) {
			return preliminaryCheck
					? exporter.canExportDomainObject(domainFile.getDomainObjectClass())
					: false;
		}
		return exporter.canExportDomainObject(domainObject);
	}

	private Exporter getDefaultExporter(List<Exporter> list) {

		// first try the last one used
		for (Exporter exporter : list) {
			if (lastUsedExporterName.equals(exporter.getName())) {
				return exporter;
			}
		}

		return list.isEmpty() ? null : list.get(0);
	}

	private void selectedFormatChanged() {
		Exporter selectedExporter = getSelectedExporter();
		if (selectedExporter != null) {
			options = selectedExporter.getOptions(() -> domainObject);
		}
		validate();
		updateSelectionCheckbox();
	}

	private void updateSelectionCheckbox() {
		if (selectionCheckBox != null) {
			boolean shouldEnableCheckbox = shouldEnableCheckbox();
			selectionCheckBox.setSelected(shouldEnableCheckbox);
			selectionCheckBox.setEnabled(shouldEnableCheckbox);
			selectionOnlyLabel.setEnabled(shouldEnableCheckbox);
		}
	}

	private boolean shouldEnableCheckbox() {
		if (currentSelection == null || currentSelection.isEmpty()) {
			return false;
		}
		Exporter selectedExporter = getSelectedExporter();
		return selectedExporter != null && selectedExporter.supportsAddressRestrictedExport();
	}

	private void validate() {
		setOkEnabled(false);
		optionsButton.setEnabled(hasOptions());
		setStatusText("");
		if (getSelectedExporter() == null) {
			setStatusText("Please select an exporter format.");
			return;
		}
		String fileToExportInto = filePathTextField.getText();
		if (fileToExportInto.length() == 0) {
			setStatusText("Please enter a destination file.");
			return;
		}
		File file = new File(fileToExportInto);
		if (file.isDirectory()) {
			setStatusText("The specified output file is a directory.");
			return;
		}
		if (file.exists() && !file.canWrite()) {
			setStatusText("The specified output file is read-only.");
			return;
		}
		if (getSelectedExporter().getName().contains("XML")) {
			setStatusText(XML_WARNING);
		}
		setOkEnabled(true);
	}

	private boolean hasOptions() {
		return options != null && !options.isEmpty();
	}

	private Exporter getSelectedExporter() {
		return (Exporter) comboBox.getSelectedItem();
	}

	private File getSelectedOutputFile() {
		String filename = appendExporterFileExtension(filePathTextField.getText().trim());
		File outputFileName = new File(filename);
		if (outputFileName.getParent() == null) {
			File defaultParent = new File(System.getProperty("user.home"));
			outputFileName = new File(defaultParent, filename);
		}
		return outputFileName;
	}

	private String appendExporterFileExtension(String filename) {
		Exporter exporter = getSelectedExporter();
		String extension = exporter.getDefaultFileExtension();
		if (extension.isEmpty()) {
			return filename;
		}
		extension = "." + extension;
		if (!filename.toLowerCase().endsWith(extension.toLowerCase())) {
			return filename + extension;
		}
		return filename;
	}

	@Override
	protected void okCallback() {
		lastUsedExporterName = getSelectedExporter().getName();
		setLastExportDirectory(getSelectedOutputFile());
		if (doExport()) {
			close();
		}
	}

	private DomainObject getDomainObjectIfNeeded(TaskMonitor taskMonitor) {
		if (domainObject != null) {
			return domainObject;
		}

		// Only open if there is an exporter that can handle content class but can't handle
		// direct domain file export.  This avoids potential upgrade issues and preserves 
		// database in its current state for those exporters.
		boolean doOpen = false;
		for (Exporter exporter : getApplicableExporters(true)) {
			if (!exporter.canExportDomainFile(domainFile)) {
				doOpen = true;
				break;
			}
		}
		if (!doOpen) {
			return null;
		}

		if (SystemUtilities.isEventDispatchThread()) {
			TaskLauncher.launchModal("Opening File: " + domainFile.getName(),
				monitor -> doOpenFile(monitor));
		}
		else {
			doOpenFile(taskMonitor);
		}
		return domainObject;
	}

	private void doOpenFile(TaskMonitor monitor) {
		try {
			if (domainFile.isLinkFile()) {
				// Linked files are always subject to upgrade if needed and do not support
				// getImmutableDomainObject
				domainObject =
					domainFile.getReadOnlyDomainObject(this, DomainFile.DEFAULT_VERSION, monitor);
			}
			else {
				domainObject =
					domainFile.getImmutableDomainObject(this, DomainFile.DEFAULT_VERSION, monitor);
			}
		}
		catch (VersionException e) {
			String msg = "Could not open file: " + domainFile.getName() +
				"\n\nAvailable export options will be limited.";
			if (e.isUpgradable()) {
				msg +=
					"\n\nA data upgrade is required.  You may open file" +
						"\nin a tool first then Export if a different exporter" +
						"\nis required.";
			}
			else {
				msg += "\nFile was created with a newer version of Ghidra";
			}
			Msg.showError(this, getComponent(), "Error Opening File", msg);
		}
		catch (IOException e) {
			String msg = "Could not open file: " + domainFile.getName() +
				"\n\nAvailable export options will be limited.";
			Msg.showError(this, getComponent(), "Error Opening File", msg, e);
		}
		catch (CancelledException e) {
			// ignore
		}
	}

	/**
	 * Gets the address factory for the program to be exported, opening it if necessary.
	 */
	@Override
	public AddressFactory getAddressFactory() {
		if (domainObject instanceof Program p) {
			return p.getAddressFactory();
		}
		return null;
	}

	private boolean doExport() {

		ExportTask task = new ExportTask();
		TaskLauncher.launch(task);
		task.showResults();
		return task.getSuccess();
	}

	private class ExportTask extends Task {

		private boolean success;
		private boolean showResults;
		private Exporter exporter;

		public ExportTask() {
			super("Export " + domainFile.getName(), true, true, true, false);
		}

		@Override
		public void run(TaskMonitor monitor) throws CancelledException {

			exporter = getSelectedExporter();

			exporter.setExporterServiceProvider(tool);

			boolean exportDomainFile =
				!domainObjectWasSupplied && exporter.canExportDomainFile(domainFile);
			if (!exportDomainFile && domainFile == null) {
				return;
			}

			// Program selection only relavent if isFrontEndPlugin() is false
			ProgramSelection selection = getApplicableProgramSeletion();
			File outputFile = getSelectedOutputFile();

			try {
				if (outputFile.exists() &&
					OptionDialog.showOptionDialog(getComponent(), "Overwrite Existing File?",
						"The file " + outputFile + " already exists.\nDo you want to overwrite it?",
						"Overwrite", OptionDialog.QUESTION_MESSAGE) != OptionDialog.OPTION_ONE) {
					return;
				}
				if (options != null) {
					exporter.setOptions(options);
				}

				if (!domainObjectWasSupplied && exporter.canExportDomainFile(domainFile)) {
					success = exporter.export(outputFile, domainFile, monitor);
				}
				else {
					success = exporter.export(outputFile, domainObject, selection, monitor);
				}
				showResults = true;
			}
			catch (Exception e) {
				Msg.error(this, "Exception exporting", e);
				SystemUtilities.runSwingLater(() -> setStatusText(
					"Exception exporting: " + e.getMessage() + ".  If null, see log for details."));
			}
		}

		void showResults() {
			if (showResults) {
				displaySummaryResults(exporter);
			}
		}

		boolean getSuccess() {
			return success;
		}
	}

	private ProgramSelection getApplicableProgramSeletion() {
		if (selectionCheckBox != null && selectionCheckBox.isSelected()) {
			return currentSelection;
		}
		return null;
	}

	private void displaySummaryResults(Exporter exporter) {
		File outputFile = getSelectedOutputFile();
		StringBuffer resultsBuffer = new StringBuffer();

		resultsBuffer.append("Destination file:       " + outputFile.getAbsolutePath() + "\n\n");
		resultsBuffer.append("Destination file Size:  " + outputFile.length() + "\n");
		resultsBuffer.append("Format:                 " + exporter.getName() + "\n\n");

		MessageLog log = exporter.getMessageLog();
		resultsBuffer.append(log.toString());

		HelpLocation helpLocation = new HelpLocation(GenericHelpTopics.ABOUT, "About_Program");

		Object tmpConsumer = new Object();
		if (domainObject != null) {
			domainObject.addConsumer(tmpConsumer);
		}
		Swing.runLater(() -> {
			try {
				Map<String, String> metadata =
					domainObject != null ? domainObject.getMetadata() : domainFile.getMetadata();
				AboutDomainObjectUtils.displayInformation(tool, domainFile,
					metadata, "Export Results Summary", resultsBuffer.toString(),
					helpLocation);
			}
			finally {
				if (domainObject != null) {
					domainObject.release(tmpConsumer);
				}
			}
		});

	}

//==================================================================================================
// Methods for Testing
//==================================================================================================

	/**
	 * Get "Selection Only" checkbox. 
	 * @return checkbox or null if not available (e.g., FrontEnd Tool use)
	 */
	JCheckBox getSelectionCheckBox() {
		return selectionCheckBox;
	}

	JComboBox<Exporter> getExporterComboBox() {
		return comboBox;
	}

	JTextField getOutputFileTextField() {
		return filePathTextField;
	}

	public List<Option> getOptions() {
		return options;
	}
}
