getProjectRootFolder() from flatAPI does not seem to be working in 9.1

[james-tate]

Describe the bug
A clear and concise description of the bug.
This does not seem to be working in https://ghidra.re/ghidra_docs/api/ghidra/program/flatapi/FlatProgramAPI.html#getProjectRootFolder()

To Reproduce
Steps to reproduce the behavior:

1. Open Python inside of GUI
2. Execute getProjectRootFolder() inside of Python window

Expected behavior
Similar functionality to https://ghidra.re/ghidra_docs/api/ghidra/app/script/GhidraScript.html#askProjectFolder(java.lang.String)

Screenshots

getProjectRootFolder()
Traceback (most recent call last):
File "python", line 1, in
NameError: name 'getProjectRootFolder' is not defined

Attachments
If applicable, please attach any files that caused problems or log files generated by the software.

Environment (please complete the following information):

• OS: [Linux]
• Java Version: [12.0]
• Ghidra Version: [9.1]

[astrelsky]

It is accessible from a GhidraScript but not from Python. At first I thought it was because it is a protected method but this does not appear to be the case as both currentProgram and monitor are protected members yet are accessible from python.

[ryanmkurtz]

Here is the code that explains the behavior:

ghidra/Ghidra/Features/Python/src/main/java/ghidra/python/GhidraPythonInterpreter.java

Lines 322 to 359 in a0aff4f

	private void injectScriptHierarchy(PythonScript script) {
	if (script == null) {
	return;
	}
	// Loop though the script class hierarchy
	for (Class<?> scriptClass = script.getClass(); scriptClass != Object.class; scriptClass =
	scriptClass.getSuperclass()) {
	// Add public and protected fields
	for (Field field : scriptClass.getDeclaredFields()) {
	if (Modifier.isPublic(field.getModifiers()) ||
	Modifier.isProtected(field.getModifiers())) {
	try {
	field.setAccessible(true);
	setVariable(field.getName(), field.get(script));
	}
	catch (IllegalAccessException iae) {
	throw new AssertException("Unexpected security manager being used!");
	}
	}
	}
	// Add public methods only once. Ignore inner classes.
	if (!scriptMethodsInjected) {
	for (Method method : scriptClass.getDeclaredMethods()) {
	if (!method.getName().contains("$") &&
	Modifier.isPublic(method.getModifiers())) {
	method.setAccessible(true);
	setMethod(script, method);
	}
	}
	}
	}
	scriptMethodsInjected = true;
	}

Only public methods are getting added to the python environment. I can't think of a good reason why this is being done, since it should mimic the java environment as closely as possibly.

[astrelsky]

@ryanmkurtz that is what I had thought. It is strange though because currentProgram is a protected member yet it is accessible. It doesn't make sense to add protected members but not protected methods.

[ryanmkurtz]

Im working on a fix.

[ryanmkurtz]

Doh, the obvious/simple fix of just adding protected methods didn't quite work:

>>> getProjectRootFolder()
Suppressing exception: exceptions.SystemErrorSystemError: Attempted to make
Java method visible, but it isn't callable[method=getProjectRootFolder, class=class
ghidra.app.script.GhidraScript]

I'll have to dig into this more.

[ryanmkurtz]

Looks like it's Jython blocking it:

    public void addMethod(Method m) {
        // Only add public methods unless we're overriding
        if (!Modifier.isPublic(m.getModifiers()) && Options.respectJavaAccessibility) {
            return;
        }

Just have to figure out how to set Options.respectJavaAccessibility programmatically.

[astrelsky]

Looks like it's Jython blocking it:

    public void addMethod(Method m) {
        // Only add public methods unless we're overriding
        if (!Modifier.isPublic(m.getModifiers()) && Options.respectJavaAccessibility) {
            return;
        }

Just have to figure out how to set Options.respectJavaAccessibility programmatically.

It's not programmatically, but try specifying -D python.security.respectJavaAccessibility=false when launching ghidra. source

The problem here I think would be that it would always allow python to access protected/private methods/members and not just the ones in GhidraScript.

[ryanmkurtz]

It seems to be working. I'll put the fix in.