Ghidra is a software reverse engineering (SRE) framework
/* ###
* 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 docking.widgets;
import java.awt.BorderLayout;
import java.awt.event.KeyEvent;
import java.util.List;
import javax.swing.*;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import org.apache.commons.lang3.StringUtils;
import docking.*;
import docking.widgets.button.GRadioButton;
import docking.widgets.combobox.GhidraComboBox;
import docking.widgets.label.GLabel;
import docking.widgets.search.FindDialogSearcher;
import docking.widgets.search.SearchResults;
import utility.function.Callback;
/**
* A dialog used to perform text searches on a text display.
*/
public class FindDialog extends ReusableDialogComponentProvider {
protected GhidraComboBox<String> comboBox;
protected FindDialogSearcher searcher;
protected SearchResults searchResults;
private JButton nextButton;
private JButton previousButton;
private JButton findAllButton;
private boolean isFindButtonApiDisabled;
private JRadioButton stringRadioButton;
private JRadioButton regexRadioButton;
private Callback closedCallback = Callback.dummy();
public FindDialog(String title, FindDialogSearcher searcher) {
super(title, false, true, true, true);
this.searcher = searcher;
addWorkPanel(buildMainPanel());
buildFindButtons();
addDismissButton();
}
public void setFindAllEnabled(boolean enabled) {
isFindButtonApiDisabled = !enabled;
findAllButton.setEnabled(enabled);
}
@Override
public void dispose() {
searcher.dispose();
super.dispose();
}
public void setClosedCallback(Callback c) {
this.closedCallback = Callback.dummyIfNull(c);
}
protected void buildFindButtons() {
nextButton = new JButton("Next");
nextButton.setMnemonic('N');
nextButton.getAccessibleContext().setAccessibleName("Next");
nextButton.addActionListener(ev -> doSearch(true));
addButton(nextButton);
setDefaultButton(nextButton);
previousButton = new JButton("Previous");
previousButton.setMnemonic('P');
previousButton.getAccessibleContext().setAccessibleName("Previous");
previousButton.addActionListener(ev -> doSearch(false));
addButton(previousButton);
findAllButton = new JButton("Find All");
findAllButton.setMnemonic('A');
findAllButton.getAccessibleContext().setAccessibleName("Find All");
findAllButton.addActionListener(ev -> doSearchAll());
addButton(findAllButton);
enableButtons(false);
}
private JPanel buildMainPanel() {
ButtonGroup formatGroup = new ButtonGroup();
stringRadioButton = new GRadioButton("String", true);
stringRadioButton.getAccessibleContext().setAccessibleName("String");
regexRadioButton = new GRadioButton("Regular Expression", false);
regexRadioButton.getAccessibleContext().setAccessibleName("Regular Expresion");
formatGroup.add(stringRadioButton);
formatGroup.add(regexRadioButton);
comboBox = new GhidraComboBox<>();
comboBox.setEditable(true);
comboBox.addActionListener(e -> doSearch(true));
comboBox.getAccessibleContext().setAccessibleName("Checkboxes");
comboBox.setColumns(20);
comboBox.addDocumentListener(new DocumentListener() {
@Override
public void changedUpdate(DocumentEvent e) {
handleDocumentUpdate();
}
@Override
public void insertUpdate(DocumentEvent e) {
handleDocumentUpdate();
}
@Override
public void removeUpdate(DocumentEvent e) {
handleDocumentUpdate();
}
private void handleDocumentUpdate() {
String text = comboBox.getText();
enableButtons(text.length() != 0);
}
});
JLabel findLabel = new GLabel("Find: ");
findLabel.getAccessibleContext().setAccessibleName("Find");
// associate this label with a mnemonic key that activates the text field
findLabel.setDisplayedMnemonic(KeyEvent.VK_N);
comboBox.associateLabel(findLabel);
JPanel mainPanel = new JPanel(new BorderLayout());
JPanel textPanel = new JPanel();
textPanel.getAccessibleContext().setAccessibleName("Find Label and Checkboxes");
textPanel.add(findLabel);
textPanel.add(comboBox);
mainPanel.add(textPanel, BorderLayout.NORTH);
mainPanel.add(buildFormatPanel(), BorderLayout.SOUTH);
mainPanel.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));
mainPanel.getAccessibleContext().setAccessibleName("Find");
return mainPanel;
}
protected void enableButtons(boolean b) {
nextButton.setEnabled(b);
previousButton.setEnabled(b);
if (!isFindButtonApiDisabled) {
findAllButton.setEnabled(b);
}
}
private JPanel buildFormatPanel() {
JPanel formatPanel = new JPanel();
formatPanel.setBorder(BorderFactory.createTitledBorder("Format"));
formatPanel.setLayout(new BoxLayout(formatPanel, BoxLayout.Y_AXIS));
formatPanel.add(stringRadioButton);
formatPanel.add(regexRadioButton);
formatPanel.getAccessibleContext().setAccessibleName("Format");
return formatPanel;
}
public void next() {
doSearch(true);
}
public void previous() {
doSearch(false);
}
protected boolean useRegex() {
return regexRadioButton.isSelected();
}
protected void doSearch(boolean forward) {
if (!nextButton.isEnabled()) {
return; // don't search while disabled
}
clearStatusText();
boolean useRegex = regexRadioButton.isSelected();
String searchText = comboBox.getText();
CursorPosition cursorPosition = searcher.getCursorPosition();
searchResults = searcher.search(searchText, cursorPosition, forward, useRegex);
//
// First, just search in the current direction.
//
if (searchResults != null) {
storeSearchText(searchText);
return;
}
//
// Did not find the text in the current direction. Wrap and try one more time.
//
String wrapMessage;
if (forward) {
wrapMessage = "Reached the bottom, continued from top";
cursorPosition = searcher.getStart();
}
else {
wrapMessage = "Reached the top, continued from the bottom";
cursorPosition = searcher.getEnd();
}
searchResults = searcher.search(searchText, cursorPosition, forward, useRegex);
if (searchResults != null) {
storeSearchText(searchText);
notifyUser(wrapMessage);
return;
}
//
// At this point, we wrapped our search and did *not* find a match. This can only
// happen if there is no matching text anywhere in the document, as after wrapping
// we will again find the previous match, if it exists.
//
notifyUser("Not found");
}
private void notifyUser(String message) {
setStatus(message);
// -don't allow searching again while notifying
// -make sure the user can see it
enableButtons(false);
alertMessage(() -> {
String text = comboBox.getText();
enableButtons(text.length() != 0);
});
}
protected void doSearchAll() {
DockingWindowManager dwm = DockingWindowManager.getActiveInstance();
if (dwm == null) {
return; // not sure this can happen
}
// Note: we do not save the SearchResults in this dialog. They will be managed by the
// provider we create below. This is in contrast to a single search, which will results.
// Further, when this method closes this dialog, the dialog's current results are cleared.
String searchText = getSearchText();
SearchResults results = searcher.searchAll(searchText, useRegex());
if (results.isEmpty()) {
setStatus("No results found");
return;
}
// save off searches that find results so users can reuse them later
storeSearchText(getSearchText());
String resultsName = results.getName();
if (StringUtils.isBlank(resultsName)) {
resultsName = "";
}
else {
resultsName = "[%s]".formatted(resultsName);
}
String dialogTitle = getTitle();
// e.g., Help Find: 'text' [Foo.html]
String subTitle = ": '%s' %s".formatted(searchText, resultsName);
Tool tool = dwm.getTool();
FindDialogResultsProvider provider =
new FindDialogResultsProvider(tool, dialogTitle, subTitle, results);
// set the tab text to the short and descriptive search term
provider.setTabText("'%s'".formatted(searchText));
close();
}
@Override
public void toFront() {
super.toFront();
String text = comboBox.getText();
enableButtons(text.length() != 0);
}
@Override
protected void dialogShown() {
clearStatusText();
}
@Override
protected void dialogClosed() {
comboBox.setText("");
if (searchResults != null) {
searchResults.dispose();
searchResults = null;
}
closedCallback.call();
}
public FindDialogSearcher getSearcher() {
return searcher;
}
String getText() {
if (isVisible()) {
return comboBox.getText();
}
return null;
}
void setStatus(String statusText) {
setStatusText(statusText);
}
public void setSearchText(String text) {
String searchText = text == null ? comboBox.getText() : text;
comboBox.setSelectedItem(searchText);
}
public String getSearchText() {
return comboBox.getText();
}
public void setHistory(List<String> history) {
history.forEach(comboBox::addToModel);
}
protected void storeSearchText(String text) {
MutableComboBoxModel<String> model = (MutableComboBoxModel<String>) comboBox.getModel();
model.insertElementAt(text, 0);
int size = model.getSize();
for (int i = 1; i < size; i++) {
String element = model.getElementAt(i);
if (element.equals(text)) { // already in the list, remove it
model.removeElementAt(i);
break;
}
}
// do this last since removing items may change the selected item
model.setSelectedItem(text);
}
}