ghidra-master/Ghidra/Features/Base/src/main/java/ghidra/app/script/JavaScriptProvider.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.script;

import java.io.*;
import java.lang.reflect.InvocationTargetException;
import java.util.Collections;
import java.util.regex.Pattern;

import org.osgi.framework.Bundle;

import generic.jar.ResourceFile;
import ghidra.app.plugin.core.osgi.*;
import ghidra.util.Msg;
import ghidra.util.task.TaskMonitor;

/**
 * The provider for Ghidra Scripts written in Java
 */
public class JavaScriptProvider extends GhidraScriptProvider {
	private static final Pattern BLOCK_COMMENT_START = Pattern.compile("/\\*");
	private static final Pattern BLOCK_COMMENT_END = Pattern.compile("\\*/");

	private final BundleHost bundleHost;

	/**
	 * Create a new {@link JavaScriptProvider} associated with the current bundle host used by
	 * scripting.
	 */
	public JavaScriptProvider() {
		bundleHost = GhidraScriptUtil.getBundleHost();
	}

	/**
	 * Get the {@link GhidraSourceBundle} containing the given source file, assuming it already
	 * exists.
	 * 
	 * @param sourceFile the source file
	 * @return the bundle
	 */
	public GhidraSourceBundle getBundleForSource(ResourceFile sourceFile) {
		ResourceFile sourceDir = GhidraScriptUtil.findSourceDirectoryContaining(sourceFile);
		if (sourceDir == null) {
			return null;
		}
		return (GhidraSourceBundle) bundleHost.getExistingGhidraBundle(sourceDir);
	}

	@Override
	public String getDescription() {
		return "Java";
	}

	@Override
	public String getExtension() {
		return ".java";
	}

	@Override
	public boolean deleteScript(ResourceFile sourceFile) {
		try {
			Bundle osgiBundle = getBundleForSource(sourceFile).getOSGiBundle();
			if (osgiBundle != null) {
				bundleHost.deactivateSynchronously(osgiBundle);
			}
		}
		catch (GhidraBundleException e) {
			Msg.error(this, "Error while deactivating bundle for delete", e);
			return false;
		}
		return super.deleteScript(sourceFile);
	}

	@Override
	public GhidraScript getScriptInstance(ResourceFile sourceFile, PrintWriter writer)
			throws GhidraScriptLoadException {
		try {
			Class<?> clazz = loadClass(sourceFile, writer);

			if (GhidraScript.class.isAssignableFrom(clazz)) {
				GhidraScript script = (GhidraScript) clazz.getDeclaredConstructor().newInstance();
				script.setSourceFile(sourceFile);
				return script;
			}

			throw new GhidraScriptLoadException(
				"Ghidra scripts in Java must extend " + GhidraScript.class.getName() + ". " +
					sourceFile.getName() + " does not.");
		}
		catch (ClassNotFoundException e) {
			throw new GhidraScriptLoadException("The class could not be found. " +
				"It must be the public class of the .java file: " + e.getMessage(), e);
		}
		catch (NoClassDefFoundError e) {
			throw new GhidraScriptLoadException("The class could not be found or loaded, " +
				"perhaps due to a previous initialization error: " + e.getMessage(), e);
		}
		catch (ExceptionInInitializerError e) {
			throw new GhidraScriptLoadException(
				"Error during class initialization: " + e.getException(), e.getException());
		}
		catch (InvocationTargetException e) {
			throw new GhidraScriptLoadException(
				"Error during class construction: " + e.getTargetException(),
				e.getTargetException());
		}
		catch (NoSuchMethodException e) {
			throw new GhidraScriptLoadException(
				"The default constructor does not exist: " + e.getMessage(), e);
		}
		catch (IllegalAccessException e) {
			throw new GhidraScriptLoadException(
				"The class or its default constructor is not accessible: " + e.getMessage(), e);
		}
		catch (Exception e) {
			throw new GhidraScriptLoadException("Unexpected error: " + e);
		}
	}

	/**
	 * Activate and build the {@link GhidraSourceBundle} containing {@code sourceFile} then load the
	 * script's class from its class loader.
	 * 
	 * @param sourceFile the source file
	 * @param writer the target for build messages
	 * @return the loaded {@link Class} object
	 * @throws Exception if build, activation, or class loading fail
	 */
	public Class<?> loadClass(ResourceFile sourceFile, PrintWriter writer) throws Exception {
		GhidraSourceBundle bundle = getBundleForSource(sourceFile);
		if (bundle == null) {
			throw new ClassNotFoundException(
				"Failed to find source bundle containing script: " + sourceFile.toString());
		}

		bundleHost.activateAll(Collections.singletonList(bundle), TaskMonitor.DUMMY, writer);
		String classname = bundle.classNameForScript(sourceFile);
		Bundle osgiBundle = bundle.getOSGiBundle();
		if (osgiBundle == null) {
			throw new ClassNotFoundException(
				"Failed to get OSGi bundle containing script: " + sourceFile.toString());
		}
		Class<?> clazz = osgiBundle.loadClass(classname); // throws ClassNotFoundException
		return clazz;
	}

	@Override
	public void createNewScript(ResourceFile newScript, String category) throws IOException {
		String scriptName = newScript.getName();
		String className = scriptName;
		int dotpos = scriptName.lastIndexOf('.');
		if (dotpos >= 0) {
			className = scriptName.substring(0, dotpos);
		}
		PrintWriter writer = new PrintWriter(new FileWriter(newScript.getFile(false)));

		writeHeader(writer, category);

		writer.println("import ghidra.app.script.GhidraScript;");

		for (Package pkg : Package.getPackages()) {
			if (pkg.getName().startsWith("ghidra.program.model.")) {
				writer.println("import " + pkg.getName() + ".*;");
			}
		}

		writer.println("");

		writer.println("public class " + className + " extends GhidraScript {");
		writer.println("");

		writer.println("    public void run() throws Exception {");

		writeBody(writer);

		writer.println("    }");
		writer.println("");
		writer.println("}");
		writer.close();
	}

	/**
	 * {@inheritDoc}
	 * 
	 * <p>
	 * For Java this is "/*".
	 */
	@Override
	public Pattern getBlockCommentStart() {
		return BLOCK_COMMENT_START;
	}

	/**
	 * {@inheritDoc}
	 * 
	 * <p>
	 * In Java this is an asterisk followed by a forward slash.
	 */
	@Override
	public Pattern getBlockCommentEnd() {
		return BLOCK_COMMENT_END;
	}

	@Override
	public String getCommentCharacter() {
		return "//";
	}

	@Override
	protected String getCertifyHeaderStart() {
		return "/* ###";
	}

	@Override
	protected String getCertifyHeaderEnd() {
		return "*/";
	}

	@Override
	protected String getCertificationBodyPrefix() {
		return "*";
	}

	/**
	 * {@inheritDoc}
	 * 
	 * <p>
	 * Fix script name for search in script directories, such as Java package parts in the name and
	 * inner class names.
	 *
	 * <p>
	 * This method can handle names with '$' (inner classes) and names with '.' characters for
	 * package separators
	 *
	 * <p>
	 * It is part of a poorly specified behavior that is due for future amendment, see
	 * {@link GhidraScriptUtil#fixupName(String)}.
	 *
	 * @param scriptName the name of the script
	 * @return the name as a '.java' file path (with '/'s and not '.'s)
	 */
	@Override
	protected String fixupName(String scriptName) {
		scriptName = scriptName.substring(0, scriptName.length() - 5);

		String path = scriptName.replace('.', '/');
		int innerClassIndex = path.indexOf('$');
		if (innerClassIndex != -1) {
			path = path.substring(0, innerClassIndex);
		}
		return path + ".java";
	}
}
