feat: implement Git pull & push with semantic merge support (#13744)

Author: wanling0000

jabgui/src/main/java/org/jabref/gui/actions/ActionHelper.java

@@ -10,6 +10,8 @@
 import javafx.collections.ObservableList;
 
 import org.jabref.gui.StateManager;
+import org.jabref.logic.git.GitHandler;
+import org.jabref.logic.git.util.GitHandlerRegistry;
 import org.jabref.logic.preferences.CliPreferences;
 import org.jabref.logic.shared.DatabaseLocation;
 import org.jabref.logic.util.io.FileUtil;
@@ -104,4 +106,21 @@ public static BooleanExpression hasLinkedFileForSelectedEntries(StateManager sta
         return BooleanExpression.booleanExpression(EasyBind.reduce(stateManager.getSelectedEntries(),
                 entries -> entries.anyMatch(entry -> !entry.getFiles().isEmpty())));
     }
+
+    public static BooleanExpression needsGitRemoteConfigured(StateManager stateManager) {
+        return BooleanExpression.booleanExpression(
+                EasyBind.map(stateManager.activeDatabaseProperty(), contextOptional -> {
+                    if (contextOptional.isPresent()) {
+                        return contextOptional.get().getDatabasePath()
+                                         .map(path -> {
+                                             GitHandler handler = new GitHandlerRegistry().get(path.getParent());
+                                             return handler != null && handler.hasRemote("origin");
+                                         })
+                                         .orElse(false);
+                    } else {
+                        return false;
+                    }
+                })
+        );
+    }
 }

jabgui/src/main/java/org/jabref/gui/frame/MainMenu.java

@@ -38,6 +38,8 @@
 import org.jabref.gui.externalfiles.DownloadFullTextAction;
 import org.jabref.gui.externalfiles.FindUnlinkedFilesAction;
 import org.jabref.gui.git.GitCommitAction;
+import org.jabref.gui.git.GitPullAction;
+import org.jabref.gui.git.GitPushAction;
 import org.jabref.gui.git.GitShareToGitHubAction;
 import org.jabref.gui.help.AboutAction;
 import org.jabref.gui.help.ErrorConsoleAction;
@@ -180,10 +182,11 @@ private void createMenu() {
                 new SeparatorMenuItem(),
 
                 // region: Sharing of the library
-
                 // TODO: Should be only enabled if not yet shared.
                 factory.createSubMenu(StandardActions.GIT,
                         factory.createMenuItem(StandardActions.GIT_COMMIT, new GitCommitAction(dialogService, stateManager)),
+                        factory.createMenuItem(StandardActions.GIT_PULL, new GitPullAction(dialogService, stateManager, preferences, taskExecutor)),
+                        factory.createMenuItem(StandardActions.GIT_PUSH, new GitPushAction(dialogService, stateManager, preferences, taskExecutor)),
                         new SeparatorMenuItem(),
                         factory.createMenuItem(StandardActions.GIT_SHARE, new GitShareToGitHubAction(dialogService, stateManager))
                 ),

jabgui/src/main/java/org/jabref/gui/git/GitPullAction.java

@@ -2,10 +2,12 @@
 
 import java.io.IOException;
 import java.nio.file.Path;
+import java.util.List;
 import java.util.Optional;
 
 import org.jabref.gui.DialogService;
 import org.jabref.gui.StateManager;
+import org.jabref.gui.actions.ActionHelper;
 import org.jabref.gui.actions.SimpleCommand;
 import org.jabref.gui.preferences.GuiPreferences;
 import org.jabref.logic.JabRefException;
@@ -14,12 +16,15 @@
 import org.jabref.logic.git.conflicts.GitConflictResolverStrategy;
 import org.jabref.logic.git.merge.GitSemanticMergeExecutor;
 import org.jabref.logic.git.merge.GitSemanticMergeExecutorImpl;
+import org.jabref.logic.git.model.PullResult;
 import org.jabref.logic.git.util.GitHandlerRegistry;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.logic.util.BackgroundTask;
 import org.jabref.logic.util.TaskExecutor;
 import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.entry.BibEntry;
 
+import com.airhacks.afterburner.injection.Injector;
 import org.eclipse.jgit.api.errors.GitAPIException;
 
 public class GitPullAction extends SimpleCommand {
@@ -28,18 +33,17 @@ public class GitPullAction extends SimpleCommand {
     private final StateManager stateManager;
     private final GuiPreferences guiPreferences;
     private final TaskExecutor taskExecutor;
-    private final GitHandlerRegistry handlerRegistry;
 
     public GitPullAction(DialogService dialogService,
                          StateManager stateManager,
                          GuiPreferences guiPreferences,
-                         TaskExecutor taskExecutor,
-                         GitHandlerRegistry handlerRegistry) {
+                         TaskExecutor taskExecutor) {
         this.dialogService = dialogService;
         this.stateManager = stateManager;
         this.guiPreferences = guiPreferences;
         this.taskExecutor = taskExecutor;
-        this.handlerRegistry = handlerRegistry;
+
+        this.executable.bind(ActionHelper.needsDatabase(stateManager).and(ActionHelper.needsGitRemoteConfigured(stateManager)));
     }
 
     @Override
@@ -64,57 +68,87 @@ public void execute() {
         }
 
         Path bibFilePath = bibFilePathOpt.get();
-        GitHandler handler = new GitHandler(bibFilePath.getParent());
-        GitConflictResolverDialog dialog = new GitConflictResolverDialog(dialogService, guiPreferences);
-        GitConflictResolverStrategy resolver = new GuiGitConflictResolverStrategy(dialog);
-        GitSemanticMergeExecutor mergeExecutor = new GitSemanticMergeExecutorImpl(guiPreferences.getImportFormatPreferences());
 
-        GitSyncService syncService = new GitSyncService(guiPreferences.getImportFormatPreferences(), handlerRegistry, resolver, mergeExecutor);
-        GitStatusViewModel statusViewModel = new GitStatusViewModel(stateManager, bibFilePath);
-        GitPullViewModel viewModel = new GitPullViewModel(syncService, statusViewModel);
+        GitHandlerRegistry registry = Injector.instantiateModelOrService(GitHandlerRegistry.class);
+        GitStatusViewModel gitStatusViewModel = GitStatusViewModel.fromPathAndContext(stateManager, taskExecutor, registry, bibFilePath);
 
         BackgroundTask
-                .wrap(() -> viewModel.pull())
+                .wrap(() -> doPull(activeDatabase, bibFilePath, stateManager, registry))
                 .onSuccess(result -> {
-                    if (result.isSuccessful()) {
+                    if (result.noop()) {
                         dialogService.showInformationDialogAndWait(
                                 Localization.lang("Git Pull"),
-                                Localization.lang("Successfully merged and updated.")
-                        );
-                    } else {
-                        dialogService.showWarningDialogAndWait(
-                                Localization.lang("Git Pull"),
-                                Localization.lang("Merge completed with conflicts.")
-                        );
-                    }
-                })
-                .onFailure(ex -> {
-                    if (ex instanceof JabRefException e) {
-                        dialogService.showErrorDialogAndWait(
-                                Localization.lang("Git Pull Failed"),
-                                e.getLocalizedMessage(),
-                                e
-                        );
-                    } else if (ex instanceof GitAPIException e) {
-                        dialogService.showErrorDialogAndWait(
-                                Localization.lang("Git Pull Failed"),
-                                Localization.lang("An unexpected Git error occurred: %0", e.getLocalizedMessage()),
-                                e
-                        );
-                    } else if (ex instanceof IOException e) {
-                        dialogService.showErrorDialogAndWait(
-                                Localization.lang("Git Pull Failed"),
-                                Localization.lang("I/O error: %0", e.getLocalizedMessage()),
-                                e
-                        );
-                    } else {
-                        dialogService.showErrorDialogAndWait(
-                                Localization.lang("Git Pull Failed"),
-                                Localization.lang("Unexpected error: %0", ex.getLocalizedMessage()),
-                                ex
+                                Localization.lang("Already up to date.")
                         );
+                    } else if (result.isSuccessful()) {
+                        try {
+                            replaceWithMergedEntries(result.getMergedEntries(), activeDatabase);
+                            gitStatusViewModel.refresh(bibFilePath);
+                            dialogService.showInformationDialogAndWait(
+                                    Localization.lang("Git Pull"),
+                                    Localization.lang("Merged and updated."));
+                        } catch (IOException | JabRefException ex) {
+                            showPullError(ex);
+                        }
                     }
                 })
+                .onFailure(exception -> showPullError(exception))
                 .executeWith(taskExecutor);
     }
+
+    private PullResult doPull(BibDatabaseContext databaseContext, Path bibPath, StateManager stateManager, GitHandlerRegistry registry) throws IOException, GitAPIException, JabRefException {
+        GitSyncService syncService = buildSyncService(bibPath, registry);
+        GitHandler handler = registry.get(bibPath.getParent());
+        String user = guiPreferences.getGitPreferences().getUsername();
+        String pat = guiPreferences.getGitPreferences().getPat();
+        handler.setCredentials(user, pat);
+        return syncService.fetchAndMerge(databaseContext, bibPath);
+    }
+
+    private GitSyncService buildSyncService(Path bibPath, GitHandlerRegistry handlerRegistry) throws JabRefException {
+        GitConflictResolverDialog dialog = new GitConflictResolverDialog(dialogService, guiPreferences);
+        GitConflictResolverStrategy resolver = new GuiGitConflictResolverStrategy(dialog);
+        GitSemanticMergeExecutor mergeExecutor = new GitSemanticMergeExecutorImpl(guiPreferences.getImportFormatPreferences());
+
+        return new GitSyncService(guiPreferences.getImportFormatPreferences(), handlerRegistry, resolver, mergeExecutor);
+    }
+
+    private void showPullError(Throwable exception) {
+        if (exception instanceof JabRefException e) {
+            dialogService.showErrorDialogAndWait(
+                    Localization.lang("Git Pull Failed"),
+                    e.getLocalizedMessage(),
+                    e
+            );
+        } else if (exception instanceof GitAPIException e) {
+            dialogService.showErrorDialogAndWait(
+                    Localization.lang("Git Pull Failed"),
+                    Localization.lang("An unexpected Git error occurred: %0", e.getLocalizedMessage()),
+                    e
+            );
+        } else if (exception instanceof IOException e) {
+            dialogService.showErrorDialogAndWait(
+                    Localization.lang("Git Pull Failed"),
+                    Localization.lang("I/O error: %0", e.getLocalizedMessage()),
+                    e
+            );
+        } else {
+            dialogService.showErrorDialogAndWait(
+                    Localization.lang("Git Pull Failed"),
+                    Localization.lang("Unexpected error: %0", exception.getLocalizedMessage()),
+                    exception
+            );
+        }
+    }
+
+    private void replaceWithMergedEntries(List<BibEntry> mergedEntries, BibDatabaseContext databaseContext) throws IOException, JabRefException {
+        List<BibEntry> currentEntries = List.copyOf(databaseContext.getDatabase().getEntries());
+        for (BibEntry entry : currentEntries) {
+            databaseContext.getDatabase().removeEntry(entry);
+        }
+
+        for (BibEntry entry : mergedEntries) {
+            databaseContext.getDatabase().insertEntry(new BibEntry(entry));
+        }
+    }
 }