-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feature add git workflow for slr search (#7625)
* Add study UI and Git support * Modify localization * Fix checkstyle * Fix test issues * Fix architecture test, modify some formulations in UI * Add DI for services * Get table views working standardize UI * Clean up * Make localization consistent * Compressed fxml and fixed minor visual issue (table cell too small) * Reduced code duplication Co-authored-by: Carl Christian Snethlage <cc.snethlage@gmail.com> Co-authored-by: Siedlerchr <siedlerkiller@gmail.com>
- Loading branch information
3 people
authored
Jul 4, 2021
1 parent
eed637a
commit f0709b7
Showing
26 changed files
with
1,612 additions
and
251 deletions.
There are no files selected for viewing
This file contains 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 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
90 changes: 0 additions & 90 deletions
90
src/main/java/org/jabref/gui/StartLiteratureReviewAction.java
This file was deleted.
Oops, something went wrong.
This file contains 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 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
127 changes: 127 additions & 0 deletions
127
src/main/java/org/jabref/gui/slr/ExistingStudySearchAction.java
This file contains 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,127 @@ | ||
| package org.jabref.gui.slr; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.file.Path; | ||
| import java.util.Objects; | ||
| import java.util.Optional; | ||
|
|
||
| import org.jabref.gui.DialogService; | ||
| import org.jabref.gui.JabRefFrame; | ||
| import org.jabref.gui.actions.SimpleCommand; | ||
| import org.jabref.gui.importer.actions.OpenDatabaseAction; | ||
| import org.jabref.gui.util.BackgroundTask; | ||
| import org.jabref.gui.util.DirectoryDialogConfiguration; | ||
| import org.jabref.gui.util.TaskExecutor; | ||
| import org.jabref.logic.crawler.Crawler; | ||
| import org.jabref.logic.exporter.SavePreferences; | ||
| import org.jabref.logic.git.SlrGitHandler; | ||
| import org.jabref.logic.importer.ImportFormatPreferences; | ||
| import org.jabref.logic.importer.ParseException; | ||
| import org.jabref.logic.l10n.Localization; | ||
| import org.jabref.model.entry.BibEntryTypesManager; | ||
| import org.jabref.model.util.FileUpdateMonitor; | ||
| import org.jabref.preferences.PreferencesService; | ||
|
|
||
| import org.eclipse.jgit.api.errors.GitAPIException; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| public class ExistingStudySearchAction extends SimpleCommand { | ||
| private static final Logger LOGGER = LoggerFactory.getLogger(ExistingStudySearchAction.class); | ||
|
|
||
| protected final DialogService dialogService; | ||
| protected final Path workingDirectory; | ||
|
|
||
| Path studyDirectory; | ||
|
|
||
| private final JabRefFrame frame; | ||
| private final FileUpdateMonitor fileUpdateMonitor; | ||
| private final TaskExecutor taskExecutor; | ||
| private final PreferencesService preferencesService; | ||
| private final ImportFormatPreferences importFormatPreferneces; | ||
| private final SavePreferences savePreferences; | ||
| // This can be either populated before crawl is called or is populated in the call using the directory dialog. This is helpful if the directory is selected in a previous dialog/UI element | ||
|
|
||
| public ExistingStudySearchAction(JabRefFrame frame, FileUpdateMonitor fileUpdateMonitor, TaskExecutor taskExecutor, PreferencesService preferencesService) { | ||
| this.frame = frame; | ||
| this.dialogService = frame.getDialogService(); | ||
| this.fileUpdateMonitor = fileUpdateMonitor; | ||
| this.workingDirectory = getInitialDirectory(preferencesService.getWorkingDir()); | ||
| this.taskExecutor = taskExecutor; | ||
| this.preferencesService = preferencesService; | ||
| this.importFormatPreferneces = preferencesService.getImportFormatPreferences(); | ||
| this.savePreferences = preferencesService.getSavePreferences(); | ||
| } | ||
|
|
||
| @Override | ||
| public void execute() { | ||
| // Reset before each execution | ||
| studyDirectory = null; | ||
| crawl(); | ||
| } | ||
|
|
||
| public void crawl() { | ||
| if (Objects.isNull(studyDirectory)) { | ||
| DirectoryDialogConfiguration directoryDialogConfiguration = new DirectoryDialogConfiguration.Builder() | ||
| .withInitialDirectory(workingDirectory) | ||
| .build(); | ||
|
|
||
| Optional<Path> studyRepositoryRoot = dialogService.showDirectorySelectionDialog(directoryDialogConfiguration); | ||
|
|
||
| if (studyRepositoryRoot.isEmpty()) { | ||
| // Do nothing if selection was canceled | ||
| return; | ||
| } | ||
| studyDirectory = studyRepositoryRoot.get(); | ||
| } | ||
|
|
||
| try { | ||
| setupRepository(studyDirectory); | ||
| } catch (IOException | GitAPIException e) { | ||
| dialogService.showErrorDialogAndWait(Localization.lang("Study repository could not be created"), e); | ||
| return; | ||
| } | ||
| final Crawler crawler; | ||
| try { | ||
| crawler = new Crawler(studyDirectory, new SlrGitHandler(studyDirectory), importFormatPreferneces, savePreferences, preferencesService.getTimestampPreferences(), new BibEntryTypesManager(), fileUpdateMonitor); | ||
| } catch (IOException | ParseException e) { | ||
| LOGGER.error("Error during reading of study definition file.", e); | ||
| dialogService.showErrorDialogAndWait(Localization.lang("Error during reading of study definition file."), e); | ||
| return; | ||
| } | ||
| dialogService.notify(Localization.lang("Searching")); | ||
| BackgroundTask.wrap(() -> { | ||
| crawler.performCrawl(); | ||
| return 0; // Return any value to make this a callable instead of a runnable. This allows throwing exceptions. | ||
| }) | ||
| .onFailure(e -> { | ||
| LOGGER.error("Error during persistence of crawling results."); | ||
| dialogService.showErrorDialogAndWait(Localization.lang("Error during persistence of crawling results."), e); | ||
| }) | ||
| .onSuccess(unused -> { | ||
| new OpenDatabaseAction(frame, preferencesService, dialogService).openFile(Path.of(studyDirectory.toString(), "studyResult.bib"), true); | ||
| // If finished reset command object for next use | ||
| studyDirectory = null; | ||
| }) | ||
| .executeWith(taskExecutor); | ||
| } | ||
|
|
||
| /** | ||
| * Hook for setting up the repository | ||
| */ | ||
| protected void setupRepository(Path studyRepositoryRoot) throws IOException, GitAPIException { | ||
| // Do nothing as repository is already setup | ||
| } | ||
|
|
||
| /** | ||
| * @return Path of current panel database directory or the standard working directory | ||
| */ | ||
| private Path getInitialDirectory(Path standardWorkingDirectory) { | ||
| if (frame.getBasePanelCount() == 0) { | ||
| return standardWorkingDirectory; | ||
| } else { | ||
| Optional<Path> databasePath = frame.getCurrentLibraryTab().getBibDatabaseContext().getDatabasePath(); | ||
| return databasePath.map(Path::getParent).orElse(standardWorkingDirectory); | ||
| } | ||
| } | ||
| } |
This file contains 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,3 @@ | ||
| .slr-tab { | ||
| -fx-padding: 1em; | ||
| } |
Oops, something went wrong.