ghidra-master/Ghidra/Features/Base/src/test.slow/java/ghidra/app/plugin/core/searchmem/MemSearchHexTest.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.searchmem;

import static org.junit.Assert.*;

import java.awt.Component;
import java.awt.Container;
import java.nio.charset.StandardCharsets;
import java.util.List;

import javax.swing.*;
import javax.swing.border.Border;
import javax.swing.border.TitledBorder;

import org.junit.Before;
import org.junit.Test;

import docking.widgets.fieldpanel.support.Highlight;
import ghidra.GhidraOptions;
import ghidra.app.plugin.core.table.TableComponentProvider;
import ghidra.app.services.MarkerSet;
import ghidra.app.util.viewer.field.BytesFieldFactory;
import ghidra.framework.options.Options;
import ghidra.program.database.ProgramBuilder;
import ghidra.program.model.address.Address;
import ghidra.program.model.data.Pointer32DataType;
import ghidra.program.model.listing.Program;
import ghidra.program.model.mem.MemoryBlock;

/**
 * Tests for the Hex format in searching memory.
 */
public class MemSearchHexTest extends AbstractMemSearchTest {

	public MemSearchHexTest() {
		super();
	}

	@Override
	@Before
	public void setUp() throws Exception {
		super.setUp();
		selectRadioButton("Hex");
	}

	@Override
	protected Program buildProgram() throws Exception {
		ProgramBuilder builder = new ProgramBuilder("TestX86", ProgramBuilder._X86);
		builder.createMemory(".text", Long.toHexString(0x1001000), 0x6600);
		builder.createMemory(".data", Long.toHexString(0x1008000), 0x600);
		builder.createMemory(".rsrc", Long.toHexString(0x100A000), 0x5400);
		builder.createMemory(".bound_import_table", Long.toHexString(0xF0000248), 0xA8);
		builder.createMemory(".debug_data", Long.toHexString(0xF0001300), 0x1C);
		MemoryBlock overlayBlock = builder.createOverlayMemory("otherOverlay", "OTHER:0", 100);

		//create and disassemble a function
		builder.setBytes("0x01002cf5",
			"55 8b ec 83 7d 14 00 56 8b 35 e0 10 00 01 57 74 09 ff 75 14 ff d6 8b f8 eb 02 33 " +
				"ff ff 75 10 ff d6 03 c7 8d 44 00 02 50 6a 40 ff 15 dc 10 00 01 8b f0 85 f6 74 27 " +
				"56 ff 75 14 ff 75 10 e8 5c ff ff ff ff 75 18 ff 75 0c 56 ff 75 08 ff 15 04 12 00 " +
				"01 56 8b f8 ff 15 c0 10 00 01 eb 14 ff 75 18 ff 75 0c ff 75 10 ff 75 08 ff 15 04 " +
				"12 00 01 8b f8 8b c7 5f 5e 5d c2 14");
		builder.disassemble("0x01002cf5", 0x121, true);
		builder.createFunction("0x01002cf5");

		//create and disassemble some code not in a function
		builder.setBytes("0x010029bd", "ff 15 c4 10 00 01 8b d8 33 f6 3b de 74 06");
		builder.disassemble("0x10029bd", 0xe, true);

		builder.setBytes("0x10035f5", "f3 a5 99 b9 30 fd ff ff ff 75 08 f7 f9");
		builder.disassemble("0x10035f5", 0xd, true);

		builder.setBytes("0x10040d9", "8b 0d 58 80 00 01");
		builder.disassemble("0x10040d9", 0x6, true);

		//create some data

		builder.setBytes("0x1001004", "85 4f dc 77");
		builder.applyDataType("0x1001004", new Pointer32DataType(), 1);
		builder.createEncodedString("0x01001708", "Notepad", StandardCharsets.UTF_16BE, true);
		builder.createEncodedString("0x01001740", "something else", StandardCharsets.UTF_16BE,
			true);
		builder.createEncodedString("0x010013cc", "notepad.exe", StandardCharsets.US_ASCII, true);

		//create some undefined data
		builder.setBytes("0x1001500", "4e 00 65 00 77 00");
		builder.setBytes("0x1003000", "55 00");

		builder.setBytes("0x1004100", "64 00 00 00");//100 dec
		builder.setBytes("0x1004120", "50 ff 75 08");//7.4027124e-34 float
		builder.setBytes("0x1004135", "64 00 00 00");//100 dec
		builder.setBytes("0x1004200", "50 ff 75 08 e8 8d 3c 00");//1.588386874245921e-307
		builder.setBytes("0x1004247", "50 ff 75 08");//7.4027124e-34 float
		builder.setBytes("0x1004270", "65 00 6e 00 64 00 69 00");//29555302058557541 qword

		builder.setBytes(overlayBlock.getStart().toString(), "00 01 02 03 04 05 06 07 08 09");

		return builder.getProgram();
	}

	@Test
	public void testDisplayDialog() throws Exception {
		assertTrue(searchAction.isEnabled());

		// dig up the components of the dialog
		dialog = waitForDialogComponent(MemSearchDialog.class);
		assertNotNull(dialog);
		assertNotNull(valueComboBox);
		assertNotNull(hexLabel);

		assertButtonState("Hex", true, true);
		assertButtonState("String", true, false);
		assertButtonState("Decimal", true, false);
		assertButtonState("Binary", true, false);
		assertButtonState("Regular Expression", true, false);
		assertButtonState("Little Endian", true, true);
		assertButtonState("Big Endian", true, false);
		assertButtonState("Search Selection", false, false);

		assertEnabled("Next", false);
		assertEnabled("Previous", false);
		assertEnabled("Search All", false);
		assertEnabled("Dismiss", true);

		JPanel p = findTitledJPanel(pane, "Format Options");
		assertNotNull(p);
		assertTrue(p.isVisible());
	}

	@Test
	public void testHexInvalidEntry() {
		// enter a non-hex digit; the search field should not accept it
		setValueText("z");

		assertEquals("", valueField.getText());
	}

	@Test
	public void testHexEnterSpaces() {
		// verify that more than 16 digits are allowed if spaces are entered
		setValueText("01 23 45 67 89 a b c d e f 1 2 3");
		assertEquals("01 23 45 67 89 a b c d e f 1 2 3", valueField.getText());
	}

	@Test
	public void testHexNoSpaces() {
		// enter a hex sequence (no spaces) more than 2 digits;
		// the hex label should display the bytes reversed
		setValueText("012345678");
		assertEquals("78 56 34 12 00 ", hexLabel.getText());
	}

	@Test
	public void testHexBigLittleEndian() throws Exception {
		// switch between little and big endian;
		// verify the hex label
		setValueText("012345678");

		pressButtonByText(pane, "Big Endian", true);

		waitForSwing();
		assertEquals("00 12 34 56 78 ", hexLabel.getText());
	}

	@Test
	public void testHexSpaceBetweenBytes() throws Exception {
		// enter a hex sequence where each byte is separated by a space;
		// ensure that the byte order setting has no effect on the sequence
		setValueText("01 23 45 67 89");
		assertEquals("01 23 45 67 89", valueField.getText());

		pressButtonByText(pane, "Big Endian", true);

		assertEquals("01 23 45 67 89", valueField.getText());
	}
	
	@Test
	public void testHexPasteNumberWithPrefixAndSuffix() {
		// paste a number with a hex prefix;
		// the prefix should be removed before the insertion
		setValueText("0xabcdef");
		assertEquals("abcdef", valueField.getText());
		
		setValueText("$68000"); 
		assertEquals("68000", valueField.getText());
		
		// same for 'h' the suffix
		setValueText("ABCDEFh");
		assertEquals("ABCDEF", valueField.getText());
		
		// should also somehow work with leading and trailing white spaces
		setValueText("  0X321  ");
		assertEquals("321", valueField.getText().strip());
		setValueText("  123H ");
		assertEquals("123", valueField.getText().strip());
	}

	@Test
	public void testHexSearch() throws Exception {

		goTo(0x01001000);

		List<Address> addrs = addrs(0x1002d06, 0x1002d2c, 0x1002d50);

		setValueText("14 ff");

		performSearchTest(addrs, "Next");
	}

	@Test
	public void testHexSearchNext() throws Exception {
		// hit the enter key in the values field;
		// should go to next match found

		goTo(0x01001000);

		//@formatter:off
		List<Address> addrs = addrs(
			0x01002d06,
			0x01002d11,
			0x01002d2c,
			0x01002d2f,
			0x01002d37,
			0x01002d3a,
			0x01002d3e,
			0x01002d52,
			0x01002d55,
			0x01002d58,
			0x01002d5b,
			0x010035fd,
			0x01004122,
			0x01004202,
			0x01004249
		);
		//@formatter:on

		setValueText("75");

		performSearchTest(addrs, "Next");

	}

	@Test
	public void testHexContiguousSelection() throws Exception {

		makeSelection(tool, program, range(0x01002cf5, 0x01002d6d));

		assertSearchSelectionSelected();

		setValueText("50");

		performSearchTest(addrs(0x01002d1c), "Next");
	}

	@Test
	public void testHexNonContiguousSelection() throws Exception {

		makeSelection(tool, program, range(0x01002cf5, 0x01002d6d), range(0x01004100, 0x01004300));

		assertSearchSelectionSelected();

		setValueText("50");

		List<Address> addrs = addrs(0x01002d1c, 0x01004120, 0x01004200, 0x01004247);

		performSearchTest(addrs, "Next");
	}

	@Test
	public void testHexSelectionNotOn() throws Exception {

		goTo(0x0100106c);

		// make a selection but turn off the Selection checkbox;
		// the search should go outside the selection

		makeSelection(tool, program, range(0x01002cf5, 0x01002d6d), range(0x01004100, 0x010041ff));

		// select Search All option to turn off searching only in selection
		assertButtonState("Search All", true, false);

		// Note: this is 'Search All' for the search type, not the JButton on the button panel
		pressButtonByText(pane, "Search All");

		List<Address> addrs = addrs(0x01002d1c, 0x01004120, 0x01004200, 0x01004247);

		setValueText("50");

		performSearchTest(addrs, "Next");
	}

	@Test
	public void testHexSearchAll() throws Exception {
		// QueryResults should get displayed
		// test the marker stuff
		goTo(0x1004180);

		setValueText("50");
		pressSearchAllButton();

		waitForSearch("Search Memory - ", 4);

		List<Address> addrs = addrs(0x01002d1c, 0x01004120, 0x01004200, 0x01004247);

		checkMarkerSet(addrs);
	}

	@Test
	public void testHexSearchAll2() throws Exception {
		// enter search string for multiple byte match
		// ff 15
		setValueText("ff 15");
		pressSearchAllButton();

		waitForSearch("Search Memory - ", 5);

		List<Address> addrs = addrs(0x01002d1f, 0x01002d41, 0x01002d4a, 0x01002d5e, 0x010029bd);

		checkMarkerSet(addrs);
	}

	@Test
	public void testHexSearchAllAlign8() throws Exception {
		// QueryResults should get displayed
		// test the marker stuff

		JTextField alignment = (JTextField) findComponentByName(dialog.getComponent(), "Alignment");
		setText(alignment, "8");

		setValueText("8b");
		pressSearchAllButton();

		waitForSearch("Search Memory - ", 1);

		checkMarkerSet(addrs(0x01002d48));
	}

	@Test
	public void testHexHighlight() throws Exception {

		setValueText("80 00 01");

		pressSearchAllButton();

		waitForSearch("Search Memory - ", 1);

		Highlight[] h = getByteHighlights(addr(0x10040d9), "8b 0d 58 80 00 01");
		assertEquals(1, h.length);
		assertEquals(9, h[0].getStart());
		assertEquals(16, h[0].getEnd());
	}

	@Test
	public void testHexHighlight2() throws Exception {
		setValueText("01 8b");
		pressSearchAllButton();

		waitForSearch("Search Memory - ", 3);

		Highlight[] h = getByteHighlights(addr(0x10029bd), "ff 15 d4 10 00 01");
		assertEquals(1, h.length);
		assertEquals(15, h[0].getStart());
		// end is not important since the match crosses code units
	}

	@Test
	public void testHexHighlight3() throws Exception {
		setValueText("d8 33 f6 3b");
		pressSearchAllButton();

		waitForSearch("Search Memory - ", 1);

		Highlight[] h = getByteHighlights(addr(0x10029c3), "8b d8");
		assertEquals(1, h.length);
		assertEquals(3, h[0].getStart());
		// end is not important since the match crosses code units

	}

	@Test
	public void testHexHighlight4() throws Exception {
		setValueText("fd ff ff");
		pressSearchAllButton();

		waitForSearch("Search Memory - ", 1);

		Highlight[] h = getByteHighlights(addr(0x10035f8), "b9 30 fd ff ff");
		assertEquals(1, h.length);
		assertEquals(6, h[0].getStart());
		assertEquals(13, h[0].getEnd());
	}

	@Test
	public void testHighlightGroupSize() throws Exception {
		Options opt = tool.getOptions(GhidraOptions.CATEGORY_BROWSER_FIELDS);
		opt.setInt(BytesFieldFactory.BYTE_GROUP_SIZE_MSG, 3);
		opt.setString(BytesFieldFactory.DELIMITER_MSG, "#@#");

		setValueText("fd ff ff");
		pressSearchAllButton();

		waitForSearch("Search Memory - ", 1);

		Highlight[] h = getByteHighlights(addr(0x10035f8), "b930fd#@#ffff");
		assertEquals(1, h.length);
		assertEquals(4, h[0].getStart());
		assertEquals(12, h[0].getEnd());

	}

	@Test
	public void testMarkersRemoved() throws Exception {
		setValueText("ff 15");
		pressSearchAllButton();
		waitForSearch("Search Memory - ", 5);

		List<Address> startList = addrs(0x01002d1f, 0x01002d41, 0x01002d4a, 0x01002d5e, 0x010029bd);

		checkMarkerSet(startList);

		TableComponentProvider<?>[] providers = tableServicePlugin.getManagedComponents();
		assertEquals(1, providers.length);
		assertTrue(tool.isVisible(providers[0]));

		//close it
		runSwing(() -> providers[0].closeComponent());

		MarkerSet markerSet = markerService.getMarkerSet("Memory Search Results", program);
		assertNull(markerSet);
	}

	@Test
	public void testHexSearchPreviousNotFound() throws Exception {

		goTo(0x01001000);

		setValueText("75");
		pressButtonByText(pane, "Previous");
		waitForSearchTask();

		assertEquals("Not Found", getStatusText());
	}

	@Test
	public void testHexSearchPrevious() throws Exception {
		// enter search string for multiple byte match
		// ff 15

		//start at 1002d6d and search backwards
		goTo(0x1002d6d);

		setValueText("ff 15");

		List<Address> addrs = addrs(0x01002d5e, 0x01002d4a, 0x01002d41, 0x01002d1f, 0x010029bd);

		performSearchTest(addrs, "Previous");
	}

	@Test
	public void testHexSearchPreviousAlign2() throws Exception {
		// enter search string for multiple byte match
		// ff 15

		goTo(0x1002d6d);

		setAlignment("2");

		setValueText("ff 15");

		List<Address> addrs = addrs(0x01002d5e, 0x01002d4a);

		performSearchTest(addrs, "Previous");
	}

	@Test
	public void testHexSearchBackwardsInSelection() throws Exception {

		goTo(0x01003000);

		makeSelection(tool, program, range(0x01002cf5, 0x01002d6d));

		assertSearchSelectionSelected();

		setValueText("50");

		performSearchTest(addrs(0x01002d1c), "Previous");
	}

	@Test
	public void testHexSearchBackwardsNonContiguousSelection() throws Exception {

		goTo(0x01005000);

		makeSelection(tool, program, range(0x01002cf5, 0x01002d6d), range(0x01004100, 0x01004300));

		assertSearchSelectionSelected();

		List<Address> addrs = addrs(0x01004247, 0x01004200, 0x01004120, 0x01002d1c);

		setValueText("50");

		performSearchTest(addrs, "Previous");
	}

	@Test
	public void testHexWildcardSearch() throws Exception {
		goTo(0x01001000);

		List<Address> addrs = addrs(0x01002d0b, 0x01002d25, 0x01002d48, 0x01002d64);

		setValueText("8b f?");

		performSearchTest(addrs, "Next");
	}

	@Test
	public void testHexWildcardSearch_SingleWildcardCharacter_QuestionMark() throws Exception {

		//
		// This tests that a single wildcard character will get converted to a value of '00' and
		// a mast of 'FF'.   This allows a single '?' character to be used in place of '??'.
		//

		goTo(0x01001000);

		List<Address> addrs = addrs(0x01001004, 0x01002d27);

		setValueText("85 ?");

		performSearchTest(addrs, "Next");
	}

	@Test
	public void testHexWildcardSearch_SingleWildcardCharacter_Dot() throws Exception {

		//
		// This tests that a single wildcard character will get converted to a value of '00' and
		// a mast of 'FF'.   This allows a single '.' character to be used in place of '..'.
		//

		goTo(0x01001000);

		List<Address> addrs = addrs(0x01001004, 0x01002d27);

		setValueText("85 .");

		performSearchTest(addrs, "Next");
	}

	@Test
	public void testHexWildcardSearchBackwards() throws Exception {

		goTo(0x01005000);

		List<Address> addrs = addrs(0x01002d64, 0x01002d48, 0x01002d25, 0x01002d0b);

		setValueText("8b f?");

		performSearchTest(addrs, "Previous");
	}

	@Test
	public void testHexWildcardSearchAll() throws Exception {
		// QueryResults should get displayed
		// test the marker stuff

		setValueText("8b f?");
		pressSearchAllButton();
		waitForSearch("Search Memory - ", 4);

		List<Address> addrs = addrs(0x01002d64, 0x01002d48, 0x01002d25, 0x01002d0b);

		checkMarkerSet(addrs);
	}

	@Test
	public void testHexByteOrder() throws Exception {
		selectRadioButton("Big Endian");

		goTo(0x01001000);

		setValueText("8bec");

		performSearchTest(addrs(0x01002cf6), "Next");
	}

	@Test
	public void testSearchInOtherSpace() throws Exception {
		goTo(0x01001000);

		setValueText("01 02 03 04 05 06 07 08 09");

		selectRadioButton("All Blocks");

		List<Address> addrs = addrs(program.getAddressFactory().getAddress("otherOverlay:1"));
		performSearchTest(addrs, "Next");
	}

	@Test
	public void testValueComboBox() throws Exception {
		setValueText("00 65");

		pressSearchButton("Next");
		setValueText("");

		setValueText("d1 e1");
		pressSearchButton("Next");
		setValueText("");

		setValueText("0123456");
		pressSearchButton("Next");
		setValueText("");

		// the combo box should list most recently entered values
		DefaultComboBoxModel<?> cbModel = (DefaultComboBoxModel<?>) valueComboBox.getModel();
		assertEquals(3, cbModel.getSize());
		assertEquals("0123456", cbModel.getElementAt(0));
		assertEquals("d1 e1", cbModel.getElementAt(1));
		assertEquals("00 65", cbModel.getElementAt(2));
	}

	@Test
	public void testRepeatSearchAction() throws Exception {

		setValueText("8b f8");
		pressSearchButton("Next");

		assertEquals(addr(0x01002d0b), currentAddress());

		repeatSearch();

		assertEquals(addr(0x01002d48), currentAddress());
	}

	@Test
	public void testSearchBackwardsWhenAtFirstAddressWithCurrentMatch() throws Exception {
		setValueText("00");

		pressSearchButton("Next");
		pressSearchButton("Previous");
		pressSearchButton("Previous");

		assertEquals("Not Found", getStatusText());
	}

//==================================================================================================
// Private Methods
//==================================================================================================

	private JPanel findTitledJPanel(Container container, String title) {
		if (container instanceof JPanel) {
			JPanel p = (JPanel) container;
			Border b = p.getBorder();
			if ((b instanceof TitledBorder) && ((TitledBorder) b).getTitle().equals(title)) {
				return p;
			}
		}
		Component[] comps = container.getComponents();
		for (Component element : comps) {
			if (element instanceof Container) {
				JPanel p = findTitledJPanel((Container) element, title);
				if (p != null) {
					return p;
				}
			}
		}
		return null;
	}

}
