[WIP] Happy days git integration wp3 #12773
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| package org.jabref.gui.importer.actions; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.file.Path; | ||
| import java.util.Optional; | ||
|
|
||
| import org.jabref.gui.DialogService; | ||
| import org.jabref.logic.git.GitClientHandler; | ||
| import org.jabref.logic.importer.ParserResult; | ||
| import org.jabref.logic.preferences.CliPreferences; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * This action checks whether this BIB file is contained in a Git repository. If so, | ||
| * then the file is tagged as "versioned" in BibDatabaseContext and a git pull is | ||
| * attempted. | ||
| */ | ||
| public class CheckForVersionControlAction implements GUIPostOpenAction { | ||
| private static final Logger LOGGER = LoggerFactory.getLogger(CheckForVersionControlAction.class); | ||
| private GitClientHandler gitClientHandler; | ||
|
|
||
| @Override | ||
| public boolean isActionNecessary(ParserResult parserResult, DialogService dialogService, CliPreferences preferences) { | ||
| Optional<Path> path = parserResult.getDatabaseContext().getDatabasePath(); | ||
| if (path.isEmpty()) { | ||
| return false; | ||
| } | ||
| this.gitClientHandler = new GitClientHandler(path.get(), | ||
| dialogService, | ||
| preferences.getGitPreferences()); | ||
|
Comment on lines
+30
to
+32
There was a problem hiding this comment. This is a side effect of a simple Maybe bind the GitClienthandler to the BibDatbaseContext? |
||
| return gitClientHandler.isGitRepository(); | ||
| } | ||
|
|
||
| @Override | ||
| public void performAction(ParserResult parserResult, DialogService dialogService, CliPreferences preferencesService) { | ||
| parserResult.getDatabaseContext().setVersioned(true); | ||
|
|
||
| try { | ||
| this.gitClientHandler.pullOnCurrentBranch(); | ||
| } catch (IOException e) { | ||
| LOGGER.error("Failed to pull.", e); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| package org.jabref.gui.shared; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.file.Path; | ||
| import java.util.Optional; | ||
|
|
||
| import org.jabref.gui.DialogService; | ||
| import org.jabref.gui.StateManager; | ||
| import org.jabref.gui.actions.SimpleCommand; | ||
| import org.jabref.gui.preferences.GuiPreferences; | ||
| import org.jabref.logic.git.GitClientHandler; | ||
| import org.jabref.model.database.BibDatabaseContext; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| public class GitPullAction extends SimpleCommand { | ||
| private static final Logger LOGGER = LoggerFactory.getLogger(GitPullAction.class); | ||
|
|
||
| private final GuiPreferences preferences; | ||
| private final DialogService dialogService; | ||
| private final StateManager stateManager; | ||
|
|
||
| public GitPullAction( | ||
| GuiPreferences preferences, | ||
| DialogService dialogService, | ||
| StateManager stateManager) { | ||
| this.preferences = preferences; | ||
| this.dialogService = dialogService; | ||
| this.stateManager = stateManager; | ||
| } | ||
| /** | ||
|
|
||
| * Contains logic for performing Git operations on the active database repository. | ||
| * The method verifies that an active database exists and is not empty | ||
| * then creates a GitClientHandler with the parent directory of the database path. | ||
| * If the directory is a Git repository, performs a pull operation on the current branch. | ||
| * Will log any errors that occur during the pull operation. | ||
| */ | ||
|
|
||
|
There was a problem hiding this comment. Please remove empty line - JavaDoc is connected to the method directly. |
||
| @Override | ||
| public void execute() { | ||
|
There was a problem hiding this comment. The method lacks JavaDoc despite being a public method that performs complex Git operations. Complex public methods should have comprehensive documentation. |
||
| if (stateManager.getActiveDatabase().isEmpty()) { | ||
| return; | ||
| } | ||
| BibDatabaseContext databaseContext = stateManager.getActiveDatabase().get(); | ||
|
|
||
| Optional<Path> path = databaseContext.getDatabasePath(); | ||
| if (path.isEmpty()) { | ||
| return; | ||
| } | ||
|
|
||
| GitClientHandler gitClientHandler = new GitClientHandler(path.get().getParent(), | ||
| dialogService, | ||
| preferences.getGitPreferences()); | ||
| if (gitClientHandler.isGitRepository()) { | ||
| try { | ||
| gitClientHandler.pullOnCurrentBranch(); | ||
| } catch (IOException e) { | ||
| LOGGER.error("Failed to Pull", e); | ||
| } | ||
| } else { | ||
| LOGGER.info("Not a git repository at path: {}", path.get()); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| package org.jabref.gui.shared; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.file.Path; | ||
| import java.util.Optional; | ||
|
|
||
| import org.jabref.gui.DialogService; | ||
| import org.jabref.gui.StateManager; | ||
| import org.jabref.gui.actions.SimpleCommand; | ||
| import org.jabref.gui.preferences.GuiPreferences; | ||
| import org.jabref.logic.git.GitClientHandler; | ||
| import org.jabref.model.database.BibDatabaseContext; | ||
|
|
||
| import org.eclipse.jgit.api.errors.GitAPIException; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| public class GitPushAction extends SimpleCommand { | ||
| private static final Logger LOGGER = LoggerFactory.getLogger(GitPushAction.class); | ||
|
|
||
| private final GuiPreferences preferences; | ||
| private final DialogService dialogService; | ||
| private final StateManager stateManager; | ||
|
|
||
| public GitPushAction( | ||
| GuiPreferences preferences, | ||
| DialogService dialogService, | ||
| StateManager stateManager) { | ||
| this.preferences = preferences; | ||
| this.dialogService = dialogService; | ||
| this.stateManager = stateManager; | ||
| } | ||
|
|
||
| @Override | ||
| public void execute() { | ||
| if (stateManager.getActiveDatabase().isEmpty()) { | ||
| return; | ||
| } | ||
| BibDatabaseContext databaseContext = stateManager.getActiveDatabase().get(); | ||
|
|
||
| Optional<Path> path = databaseContext.getDatabasePath(); | ||
| if (path.isEmpty()) { | ||
| return; | ||
| } | ||
|
|
||
| GitClientHandler gitClientHandler = new GitClientHandler(path.get().getParent(), | ||
| dialogService, | ||
| preferences.getGitPreferences()); | ||
| if (gitClientHandler.isGitRepository()) { | ||
| try { | ||
| gitClientHandler.createCommitOnCurrentBranch("Automatic update via JabRef", false); | ||
|
There was a problem hiding this comment. This string appears twice in your code - please introduce a constant. |
||
| gitClientHandler.pushCommitsToRemoteRepository(); | ||
| } catch (IOException | GitAPIException e) { | ||
| dialogService.showErrorDialogAndWait(e); | ||
| } | ||
| } else { | ||
| LOGGER.info("Not a git repository at path: {}", path); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lifecycle is strange - the
GitClientHandlershould be bound to theBibdatabaseContext(orlibraryTab), shouldn't it?There is also an instance in
src/main/java/org/jabref/gui/importer/actions/CheckForVersionControlAction.java. I think, the instance should be shared?