ghidra-master/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/string/StringModel.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.string;

import java.io.*;
import java.util.*;

public class StringModel {

	private int[][][] asciiTrigramStorage;
	private int[][] beginStringTrigramStorage, endStringTrigramStorage;
	private long totalNumTrigrams;

	private static HashMap<Integer, String[]> asciiNumToDescription;

	static {
		asciiNumToDescription = new HashMap<Integer, String[]>();
		asciiNumToDescription.put(0, new String[] { "[NUL]", "null" });
		asciiNumToDescription.put(1, new String[] { "[SOH]", "start of header" });
		asciiNumToDescription.put(2, new String[] { "[STX]", "start of text" });
		asciiNumToDescription.put(3, new String[] { "[ETX]", "end of text" });
		asciiNumToDescription.put(4, new String[] { "[EOT]", "end of transmission" });
		asciiNumToDescription.put(5, new String[] { "[ENQ]", "enquiry" });
		asciiNumToDescription.put(6, new String[] { "[ACK]", "acknowledgement" });
		asciiNumToDescription.put(7, new String[] { "[BEL]", "bell" });
		asciiNumToDescription.put(8, new String[] { "[BS]", "backspace" });
		asciiNumToDescription.put(9, new String[] { "[HT]", "horizontal tab" });
		asciiNumToDescription.put(10, new String[] { "[LF]", "line feed" });
		asciiNumToDescription.put(11, new String[] { "[VT]", "vertical tab" });
		asciiNumToDescription.put(12, new String[] { "[FF]", "form feed" });
		asciiNumToDescription.put(13, new String[] { "[CR]", "carriage return" });
		asciiNumToDescription.put(14, new String[] { "[SO]", "shift out" });
		asciiNumToDescription.put(15, new String[] { "[SI]", "shift in" });
		asciiNumToDescription.put(16, new String[] { "[DLE]", "data link escape" });
		asciiNumToDescription.put(17, new String[] { "[DC1]", "device control 1" });
		asciiNumToDescription.put(18, new String[] { "[DC2]", "device control 2" });
		asciiNumToDescription.put(19, new String[] { "[DC3]", "device control 3" });
		asciiNumToDescription.put(20, new String[] { "[DC4]", "device control 4" });
		asciiNumToDescription.put(21, new String[] { "[NAK]", "negative acknowledge" });
		asciiNumToDescription.put(22, new String[] { "[SYN]", "synchronous idle" });
		asciiNumToDescription.put(23, new String[] { "[ETB]", "end of transmission block" });
		asciiNumToDescription.put(24, new String[] { "[CAN]", "cancel" });
		asciiNumToDescription.put(25, new String[] { "[EM]", "end of medium" });
		asciiNumToDescription.put(26, new String[] { "[SUB]", "substitute" });
		asciiNumToDescription.put(27, new String[] { "[ESC]", "escape" });
		asciiNumToDescription.put(28, new String[] { "[FS]", "file separator" });
		asciiNumToDescription.put(29, new String[] { "[GS]", "group separator" });
		asciiNumToDescription.put(30, new String[] { "[RS]", "record separator" });
		asciiNumToDescription.put(31, new String[] { "[US]", "unit separator" });
		asciiNumToDescription.put(32, new String[] { "[SP]", "space" });
		asciiNumToDescription.put(127, new String[] { "[DEL]", "delete" });
	}

	private static String[] textReps = new String[128];
	static {
		for (int i = 0; i < textReps.length; i++) {

			if ((i >= 33) && (i <= 126)) {
				textReps[i] = Character.valueOf((char) i).toString();
			}
			else {
				if (asciiNumToDescription.containsKey(i)) {
					textReps[i] = asciiNumToDescription.get(i)[0];
				}
				else {
					System.err.println("ERROR: Could not find character mapping for ASCII code " +
						i);
				}
			}
		}
	}

	public StringModel(int[][][] asciiTrigrams, int[][] beginTrigram, int[][] endTrigram,
			long numTrigrams) {
		asciiTrigramStorage = asciiTrigrams;
		beginStringTrigramStorage = beginTrigram;
		endStringTrigramStorage = endTrigram;
		totalNumTrigrams = numTrigrams;
	}

	public void setTrigramCounts(int[][][] asciiTrigrams, int[][] beginTrigram, int[][] endTrigram,
			long numTrigrams) {
		asciiTrigramStorage = asciiTrigrams;
		beginStringTrigramStorage = beginTrigram;
		endStringTrigramStorage = endTrigram;
		totalNumTrigrams = numTrigrams;
	}

	public int[][][] getTrigramCounts() {
		return asciiTrigramStorage;
	}

	public int[][] getBeginTrigramCounts() {
		return beginStringTrigramStorage;
	}

	public int[][] getEndTrigramCounts() {
		return endStringTrigramStorage;
	}

	public long getTotalNumTrigrams() {
		return totalNumTrigrams;
	}

	public void writeTrigramModelFile(String trigramFilename, List<String> trainingFiles,
			String modelType, File outputPath) throws IOException {

		// Create desired output filepath
		File outputFile = new File(outputPath, trigramFilename);

		// Store information about "special" characters that will need to be clarified
		// in comments
		HashSet<Integer> commentsNeeded = new HashSet<Integer>();

		for (int i = 0; i < 128; i++) {
			for (int j = 0; j < 128; j++) {
				for (int k = 0; k < 128; k++) {
					if (asciiTrigramStorage[i][j][k] > 0) {
						if (asciiNumToDescription.containsKey(i)) {
							commentsNeeded.add(i);
						}
						if (asciiNumToDescription.containsKey(j)) {
							commentsNeeded.add(j);
						}
						if (asciiNumToDescription.containsKey(k)) {
							commentsNeeded.add(k);
						}
					}
				}
			}
		}

		try (BufferedWriter out =
				new BufferedWriter(
					new OutputStreamWriter(new FileOutputStream(outputFile), "ASCII"))) {

			out.write("# Model Type: " + modelType);
			out.newLine();

			for (String trFile : trainingFiles) {
				out.write("# Training file: " + trFile);
				out.newLine();
			}

			out.write("# [^] denotes beginning of string");
			out.newLine();
			out.write("# [$] denotes end of string");
			out.newLine();

			for (Integer asciiNum : commentsNeeded) {
				String[] charDetails = asciiNumToDescription.get(asciiNum);
				out.write("# " + charDetails[0] + " denotes " + charDetails[1]);
				out.newLine();
			}
			out.newLine();

			for (int i = 0; i < 128; i++) {
				for (int j = 0; j < 128; j++) {
					for (int k = 0; k < 128; k++) {
						if (asciiTrigramStorage[i][j][k] > 0) {
							out.write(textReps[i] + "\t" + textReps[j] + "\t" + textReps[k] + "\t" +
								asciiTrigramStorage[i][j][k]);
							out.newLine();
						}
					}
				}
			}

			for (int i = 0; i < 128; i++) {
				for (int j = 0; j < 128; j++) {
					if (beginStringTrigramStorage[i][j] != 0) {
						out.write("[^]\t" + textReps[i] + "\t" + textReps[j] + "\t" +
							beginStringTrigramStorage[i][j]);
						out.newLine();
					}
				}
			}

			for (int i = 0; i < 128; i++) {
				for (int j = 0; j < 128; j++) {
					if (endStringTrigramStorage[i][j] != 0) {
						out.write(textReps[i] + "\t" + textReps[j] + "\t[$]\t" +
							endStringTrigramStorage[i][j]);
						out.newLine();
					}
				}
			}
		}
		catch (UnsupportedEncodingException e) {
			System.err.println("Error creating String Model file: " + e.toString());
			System.exit(0);
		}
		catch (FileNotFoundException e) {
			System.err.println("Error creating String Model file: " + e.toString());
			System.exit(0);
		}
	}
}
