Skip to content

Add toggle for assembly/decompiled view in deobfuscation preview #946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
luiox wants to merge 1 commit into from
+76 −26
Closed

Add toggle for assembly/decompiled view in deobfuscation preview #946

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 72 additions & 26 deletions recaf-ui/src/main/java/software/coley/recaf/ui/window/DeobfuscationWindow.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,8 @@
import javafx.collections.ObservableList;
import javafx.geometry.Insets;
import javafx.geometry.Pos;
import javafx.scene.control.Button;
import javafx.scene.control.CheckBox;
import javafx.scene.control.Label;
import javafx.scene.control.ListView;
import javafx.scene.control.SplitPane;
import javafx.scene.control.Tab;
import javafx.scene.control.TabPane;
import javafx.scene.control.TreeCell;
import javafx.scene.control.TreeItem;
import javafx.scene.control.TreeView;
import javafx.scene.layout.BorderPane;
import javafx.scene.layout.HBox;
import javafx.scene.layout.StackPane;
import javafx.scene.layout.VBox;
import javafx.scene.control.*;
import javafx.scene.layout.*;
import javafx.scene.text.TextAlignment;
import org.kordamp.ikonli.Ikon;
import org.kordamp.ikonli.carbonicons.CarbonIcons;
Expand Down Expand Up @@ -81,6 +69,10 @@
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;
import software.coley.recaf.services.assembler.AssemblerPipelineManager;
import software.coley.recaf.services.assembler.JvmAssemblerPipeline;
import software.coley.recaf.path.ClassPathNode;
import software.coley.recaf.path.DirectoryPathNode;

/**
* Pane for previewing deobfuscation transformers.
Expand All @@ -96,6 +88,7 @@ public class DeobfuscationWindow extends RecafStage {
private final ObservableList<CategorizedTransformer> transformerOrder = FXCollections.observableArrayList();
private final BooleanProperty hasSelection = new SimpleBooleanProperty();
private final WorkspaceManager workspaceManager;
private final AssemblerPipelineManager assemblerPipelineManager;

@Inject
@SuppressWarnings("unchecked")
Expand All @@ -107,11 +100,13 @@ public DeobfuscationWindow(@Nonnull TransformationManager transformationManager,
@Nonnull CellConfigurationService configurationService,
@Nonnull Actions actions,
@Nonnull WorkspaceExplorerConfig explorerConfig,
@Nonnull Instance<SearchBar> searchBarProvider) {
@Nonnull Instance<SearchBar> searchBarProvider,
@Nonnull AssemblerPipelineManager assemblerPipelineManager) {
this.transformationManager = transformationManager;
this.transformationApplierService = transformationApplierService;
this.workspaceManager = workspaceManager;
this.decompilerManager = decompilerManager;
this.assemblerPipelineManager = assemblerPipelineManager;

BorderPane transformerTreePane = new BorderPane();
{
Expand Down Expand Up @@ -316,12 +311,36 @@ protected void updateItem(CategorizedTransformer item, boolean isEmpty) {
title.getStyleClass().add(Styles.TITLE_4);
title.setPadding(new Insets(0, 0, 5, 5));

HBox titleBox = new HBox();
titleBox.setAlignment(Pos.CENTER_LEFT);
titleBox.getChildren().add(title);

TransformPreview beforePreview = new TransformPreview(languageAssociation, searchBarProvider.get(), false);
TransformPreview afterPreview = new TransformPreview(languageAssociation, searchBarProvider.get(), true);

// Create a shared toggleButton and add it to the title bar
ToggleButton toggleButton = new ToggleButton();
toggleButton.setText(Lang.get("deobf.preview.switch-decompiler"));
toggleButton.setSelected(true);
toggleButton.selectedProperty().addListener((obs, oldVal, newVal) -> {
boolean showAssembly = newVal;
toggleButton.setText(showAssembly ? Lang.get("deobf.preview.switch-decompiler") : Lang.get("deobf.preview.disassemble-decompiler"));
// update preview
beforePreview.setShowAssembly(showAssembly);
afterPreview.setShowAssembly(showAssembly);
});

// Use Region elastic padding to push the toggleButton to the far right
Region spacer = new Region();
HBox.setHgrow(spacer, Priority.ALWAYS);
titleBox.getChildren().add(spacer);
titleBox.getChildren().add(toggleButton);
titleBox.setSpacing(10);

Tab beforeTab = new Tab();
Tab afterTab = new Tab();
beforeTab.setClosable(false);
afterTab.setClosable(false);
TransformPreview beforePreview = new TransformPreview(languageAssociation, searchBarProvider.get(), false);
TransformPreview afterPreview = new TransformPreview(languageAssociation, searchBarProvider.get(), true);
beforeTab.setContent(beforePreview);
afterTab.setContent(afterPreview);
beforeTab.textProperty().bind(Lang.getBinding("misc.before"));
Expand Down Expand Up @@ -374,7 +393,7 @@ protected void updateItem(CategorizedTransformer item, boolean isEmpty) {
StackPane wrapper = new StackPane(tabs, tools);
StackPane.setMargin(tools, new Insets(20));
wrapper.setAlignment(Pos.BOTTOM_RIGHT);
transformPreviewPane.setTop(title);
transformPreviewPane.setTop(titleBox);
transformPreviewPane.setCenter(wrapper);
transformPreviewPane.setBottom(tools);
}
Expand Down Expand Up @@ -417,6 +436,7 @@ private class TransformPreview extends BorderPane {
private final boolean andApply;
private final Editor editor;
private ClassInfo classInfo;
private boolean showAssembly = true;

private TransformPreview(@Nonnull FileTypeSyntaxAssociationService languageAssociation, @Nonnull SearchBar searchBar, boolean andApply) {
this.andApply = andApply;
Expand All @@ -433,6 +453,11 @@ public void setClassInfo(@Nonnull ClassInfo classInfo) {
this.classInfo = classInfo;
}

public void setShowAssembly(boolean showAssembly) {
this.showAssembly = showAssembly;
decompile();
}

private void decompile() {
if (classInfo == null) {
editor.setText(Lang.get("deobf.preview.noselection"));
Expand Down Expand Up @@ -462,15 +487,36 @@ private void decompile() {
}
}

// TODO: Pull out common decompile code with "AbstractDecompilePane" to do this more aesthetically
// - And by that I mean include the animation
// - And the error handling
// - But not the rest of the unrelated "editing" capabilities of the "AbstractDecompilePane"
decompilerManager.decompile(workspaceManager.getCurrent(), jvmClass).whenCompleteAsync((result, error) -> {
if (result != null) {
editor.setText(result.getText());
if (showAssembly) {
// disassemble view
try {
JvmAssemblerPipeline pipeline = assemblerPipelineManager.newJvmAssemblerPipeline(workspaceManager.getCurrent());
String packageName = jvmClass.getPackageName();
DirectoryPathNode dirNode = new DirectoryPathNode(packageName);
ClassPathNode path = new ClassPathNode(dirNode, jvmClass);
var result = pipeline.disassemble(path);
if (result.isOk()) {
editor.setText(result.get());
} else {
editor.setText("// Failed to disassemble: " + result.errors());
}
} catch (Exception e) {
editor.setText("// Exception during disassembly: " + e.getMessage());
}
}, FxThreadUtil.executor());
} else {
// TODO: Pull out common decompile code with "AbstractDecompilePane" to do this more aesthetically
// - And by that I mean include the animation
// - And the error handling
// - But not the rest of the unrelated "editing" capabilities of the "AbstractDecompilePane"
// decompiler view
decompilerManager.decompile(workspaceManager.getCurrent(), jvmClass).whenCompleteAsync((result, error) -> {
if (result != null) {
editor.setText(result.getText());
} else if (error != null) {
editor.setText("// Decompile error: " + error.getMessage());
}
}, FxThreadUtil.executor());
}
}
}

Expand Down
2 changes: 2 additions & 0 deletions recaf-ui/src/main/resources/translations/en_US.lang
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,6 +459,8 @@ deobf.order.suc=Missing recommended successors
deobf.preview.title=Preview
deobf.preview.pick=Pick preview class
deobf.preview.noselection=// No class is selected, pick a class to preview\n// the transformation before & after states
deobf.preview.switch-decompiler=Switch to decompiled view
deobf.preview.disassemble-decompiler=Switch to assembly view
deobf.tree.generic=Generic
deobf.tree.generic.anticrasher=Anti-Crasher
deobf.tree.generic.optimize=Optimization
Expand Down
2 changes: 2 additions & 0 deletions recaf-ui/src/main/resources/translations/zh_CN.lang
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,8 @@ deobf.order.suc=缺少推荐的后置转换器
deobf.preview.title=预览
deobf.preview.pick=选择预览的类
deobf.preview.noselection=// 未选择任何类，请选择一个类进行预览\n// 以查看转换前后的状态
deobf.preview.switch-decompiler=切换为反编译视图
deobf.preview.disassemble-decompiler=切换为汇编视图
deobf.tree.generic=通用
deobf.tree.generic.anticrasher=防崩溃
deobf.tree.generic.optimize=优化
Expand Down