Fix the context actions!

Author: mahaloz

libbs/api/decompiler_interface.py

@@ -991,6 +991,13 @@ def find_current_decompiler(force: str = None) -> Optional[str]:
             if "License is not valid" in str(e):
                 _l.warning("Binary Ninja license is invalid, skipping...")
 
+        # Ghidra
+        this_obj = DecompilerInterface._find_global_in_call_frames("__this__")
+        if (this_obj is not None) and (hasattr(this_obj, "currentProgram")):
+            available.add(GHIDRA_DECOMPILER)
+            if not force:
+                return GHIDRA_DECOMPILER
+
         # angr-management
         try:
             import angr
@@ -1015,15 +1022,6 @@ def find_current_decompiler(force: str = None) -> Optional[str]:
         except Exception:
             pass
 
-        # Ghidra
-        # It is always available, and we don't have an import check, because when started in headless mode we create
-        # the interface by which ghidra can now be imported.
-        this_obj = DecompilerInterface._find_global_in_call_frames("__this__")
-        if (this_obj is not None) and (hasattr(this_obj, "currentProgram")):
-            available.add(GHIDRA_DECOMPILER)
-            if not force:
-                return GHIDRA_DECOMPILER
-
         if not available:
             _l.critical("LibBS was unable to find the current decompiler you are running in or any headless instances!")
             return None

libbs/decompilers/ghidra/README.md

@@ -22,7 +22,7 @@ def get_private_class(path: str):
 from ghidra.program.model.listing import CodeUnit
 from ghidra.app.cmd.comments import SetCommentCmd
 from ghidra.app.cmd.label import RenameLabelCmd
-from ghidra.app.context import ProgramLocationContextAction
+from ghidra.app.context import ProgramLocationContextAction, ProgramLocationActionContext
 from ghidra.app.decompiler import DecompInterface
 from ghidra.app.plugin.core.analysis import AutoAnalysisManager
 from ghidra.app.util.cparser.C import CParserUtils
@@ -31,6 +31,7 @@ def get_private_class(path: str):
 from ghidra.util.data import DataTypeParser
 from ghidra.util.exception import CancelledException
 from docking.action import MenuData
+from docking.action.builder import ActionBuilder
 
 EnumDB = get_private_class("ghidra.program.database.data.EnumDB")
 StructureDB = get_private_class("ghidra.program.database.data.StructureDB")
@@ -48,7 +49,9 @@ def get_private_class(path: str):
     "CodeSymbol",
     "FunctionSymbol",
     "ProgramLocationContextAction",
+    "ProgramLocationActionContext",
     "MenuData",
+    "ActionBuilder",
     "HighFunctionDBUtil",
     "DataTypeConflictHandler",
     "StructureDataType",

libbs/decompilers/ghidra/compat/bridge.py

@@ -207,21 +207,20 @@ def create_data_monitor(deci: "GhidraDecompilerInterface"):
     return data_monitor
 
 
-def create_context_action(name, action_string, callback_func, category=None):
-    """
-    TODO: this is broken due to JPype: you can't subclass a Ghidra class. To fix this requires
-        creating a Java class that allows us to _implement_ ProgramLocationContextAction in Python.
-    """
-    from .compat.imports import ProgramLocationContextAction, MenuData
-
-    # XXX: you can't ever use super().__init__() due to JPype limitations with Java class subclassing
-    class GenericDecompilerCtxAction(ProgramLocationContextAction):
-        def actionPerformed(self, ctx):
-            threading.Thread(target=callback_func, daemon=True).start()
-
-    action = GenericDecompilerCtxAction(name, category)
-    category_list = category.split("/") if category else []
-    category_start = category_list[0] if category_list else category
-    action.setPopupMenuData(MenuData(category_list + [action_string], None, category_start))
-
-    return action
+def create_context_action(name, action_string, callback_func, category=None, plugin_name="libbs_ghidra", tool=None):
+    from .compat.imports import ProgramLocationActionContext, ActionBuilder
+    def _invoke(ctx: ProgramLocationActionContext):
+        threading.Thread(target=callback_func, daemon=True).start()
+
+    menu_path = []
+    if category is not None and "/" in category:
+        menu_path.extend(category.split("/"))
+    menu_path.append(action_string)
+
+    b = (ActionBuilder(name, plugin_name)
+            .popupMenuPath(list(menu_path))
+            .withContext(ProgramLocationActionContext)
+            .validContextWhen(lambda ctx: ctx is not None and ctx.getAddress() is not None)
+            .onAction(_invoke))
+
+    return b.buildAndInstall(tool)

libbs/decompilers/ghidra/compat/imports.py

@@ -153,8 +153,6 @@ def gui_run_on_main_thread(self, func, *args, **kwargs):
         return self._results_queue.get()
 
     def gui_register_ctx_menu(self, name, action_string, callback_func, category=None) -> bool:
-        # TODO: this is currently broken, see create_context_action for why
-        return None
         from .hooks import create_context_action
 
         def callback_func_wrap(*args, **kwargs):
@@ -163,8 +161,10 @@ def callback_func_wrap(*args, **kwargs):
             except Exception as e:
                 self.warning(f"Exception in ctx menu callback {name}: {e}")
                 raise
-        ctx_menu_action = create_context_action(name, action_string, callback_func_wrap, category or "LibBS")
-        self.flat_api.getState().getTool().addAction(ctx_menu_action)
+        create_context_action(
+            name, action_string, callback_func_wrap, category=(category or "LibBS"),
+            tool=self.flat_api.getState().getTool()
+        )
         return True
 
     def gui_ask_for_string(self, question, title="Plugin Question") -> str: