Skip to content

Commit

Permalink
Introduced UiCommands to replace clumsy gui interface
Browse files Browse the repository at this point in the history
  • Loading branch information
@calixtus
calixtus committed Nov 1, 2023
1 parent d6d17e8 commit 6907f80
Show file tree
Hide file tree
Showing 10 changed files with 189 additions and 208 deletions.
6 changes: 3 additions & 3 deletions build.gradle
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,15 @@ group = "org.jabref"
version = project.findProperty('projVersion') ?: '100.0.0'

java {
sourceCompatibility = JavaVersion.VERSION_19
targetCompatibility = JavaVersion.VERSION_19
sourceCompatibility = JavaVersion.VERSION_21
targetCompatibility = JavaVersion.VERSION_21
// Workaround needed for Eclipse, probably because of https://github.com/gradle/gradle/issues/16922
// Should be removed as soon as Gradle 7.0.1 is released ( https://github.com/gradle/gradle/issues/16922#issuecomment-828217060 )
modularity.inferModulePath.set(false)

toolchain {
// If this is updated, also update .devcontainer/devcontainer.json#L34
languageVersion = JavaLanguageVersion.of(20)
languageVersion = JavaLanguageVersion.of(21)
}
}

Expand Down
35 changes: 19 additions & 16 deletions src/main/java/org/jabref/cli/ArgumentProcessor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import org.jabref.gui.externalfiles.AutoSetFileLinksUtil;
import org.jabref.gui.undo.NamedCompound;
import org.jabref.logic.JabRefException;
import org.jabref.logic.UiCommand;
import org.jabref.logic.bibtex.FieldPreferences;
import org.jabref.logic.citationkeypattern.CitationKeyGenerator;
import org.jabref.logic.exporter.AtomicFileWriter;
Expand Down Expand Up @@ -64,28 +65,31 @@
import org.slf4j.LoggerFactory;

public class ArgumentProcessor {

private static final Logger LOGGER = LoggerFactory.getLogger(ArgumentProcessor.class);
private final JabRefCLI cli;

// Written once by processArguments()
private List<ParserResult> parserResults = List.of();
public enum Mode { INITIAL_START, REMOTE_START }

private final JabRefCLI cli;

private final Mode startupMode;

private final PreferencesService preferencesService;
private final FileUpdateMonitor fileUpdateMonitor;
private final BibEntryTypesManager entryTypesManager;

private boolean noGUINeeded;
private final List<UiCommand> uiCommands = new ArrayList<>();

/**
* First call the constructor, then call {@link #processArguments()}.
* Afterward, you can access the {@link #getParserResults()} and other getters.
* Afterward, you can access the {@link #getUiCommands()}.
*/
public ArgumentProcessor(String[] args,
Mode startupMode,
PreferencesService preferencesService,
FileUpdateMonitor fileUpdateMonitor,
BibEntryTypesManager entryTypesManager) throws org.apache.commons.cli.ParseException {
BibEntryTypesManager entryTypesManager)
throws org.apache.commons.cli.ParseException {
this.cli = new JabRefCLI(args);
this.startupMode = startupMode;
this.preferencesService = preferencesService;
Expand Down Expand Up @@ -185,19 +189,17 @@ private Optional<ParserResult> importFile(Path file, String importFormat) {
}
}

public List<ParserResult> getParserResults() {
return parserResults;
}

public void processArguments() {
uiCommands.clear();
noGUINeeded = false;

if ((startupMode == Mode.INITIAL_START) && cli.isShowVersion()) {
cli.displayVersion();
}

if ((startupMode == Mode.INITIAL_START) && cli.isHelp()) {
JabRefCLI.printUsage(preferencesService);
noGUINeeded = true;
this.parserResults = Collections.emptyList();
return;
}

Expand All @@ -221,7 +223,6 @@ public void processArguments() {
if (cli.isExportMatches()) {
if (!loaded.isEmpty()) {
if (!exportMatches(loaded)) {
this.parserResults = Collections.emptyList();
return;
}
} else {
Expand Down Expand Up @@ -281,7 +282,9 @@ public void processArguments() {
jumpToKey(loaded, cli.getJumpToKey());
}

this.parserResults = loaded;
if (!cli.isBlank() && !loaded.isEmpty()) {
uiCommands.add(new UiCommand.OpenDatabases(loaded));
}
}

private void writeMetadataToPdf(List<ParserResult> loaded,
Expand Down Expand Up @@ -781,7 +784,7 @@ private void jumpToKey(List<ParserResult> loaded, String citationKey) {
for (ParserResult parserResult : loaded) {
Optional<BibEntry> entry = parserResult.getDatabase().getEntryByCitationKey(citationKey);
if (entry.isPresent()) {
parserResult.setEntryToFocus(entry.get());
uiCommands.add(new UiCommand.JumpToEntryKey(parserResult, entry.get()));
return;
}
}
Expand All @@ -796,7 +799,7 @@ public boolean shouldShutDown() {
return cli.isDisableGui() || cli.isShowVersion() || noGUINeeded;
}

public enum Mode {
INITIAL_START, REMOTE_START
public List<UiCommand> getUiCommands() {
return uiCommands;
}
}
13 changes: 12 additions & 1 deletion src/main/java/org/jabref/cli/Launcher.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,14 @@
import java.nio.file.DirectoryStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Map;

import org.jabref.gui.Globals;
import org.jabref.gui.MainApplication;
import org.jabref.logic.UiCommand;
import org.jabref.logic.journals.JournalAbbreviationLoader;
import org.jabref.logic.l10n.Localization;
import org.jabref.logic.net.ProxyAuthenticator;
Expand Down Expand Up @@ -100,7 +103,15 @@ public static void main(String[] args) {
System.exit(0);
}

MainApplication.main(argumentProcessor.getParserResults(), argumentProcessor.isBlank(), preferences, fileUpdateMonitor, ARGUMENTS);
List<UiCommand> uiCommands = new ArrayList<>(argumentProcessor.getUiCommands());
List<String> lastFiles = preferences.getGuiPreferences().getLastFilesOpened();
if (!argumentProcessor.isBlank() && preferences.getWorkspacePreferences().shouldOpenLastEdited() && !lastFiles.isEmpty()) {
for (String file : lastFiles) {
uiCommands.add(new UiCommand.OpenDatabaseFromPath(Path.of(file)));
}
}

MainApplication.main(uiCommands, preferences, fileUpdateMonitor, ARGUMENTS);
} catch (ParseException e) {
LOGGER.error("Problem parsing arguments", e);
JabRefCLI.printUsage(preferences);
Expand Down
128 changes: 128 additions & 0 deletions src/main/java/org/jabref/gui/JabRefFrame.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import java.io.IOException;
import java.nio.file.Path;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
Expand Down Expand Up @@ -44,6 +45,7 @@
import org.jabref.gui.help.HelpAction;
import org.jabref.gui.importer.ImportEntriesDialog;
import org.jabref.gui.importer.NewEntryAction;
import org.jabref.gui.importer.ParserResultWarningDialog;
import org.jabref.gui.importer.actions.OpenDatabaseAction;
import org.jabref.gui.keyboard.KeyBinding;
import org.jabref.gui.keyboard.KeyBindingRepository;
Expand All @@ -57,11 +59,15 @@
import org.jabref.gui.util.BackgroundTask;
import org.jabref.gui.util.DefaultTaskExecutor;
import org.jabref.gui.util.TaskExecutor;
import org.jabref.logic.UiCommand;
import org.jabref.logic.help.HelpFile;
import org.jabref.logic.importer.ImportCleanup;
import org.jabref.logic.importer.ParserResult;
import org.jabref.logic.l10n.Localization;
import org.jabref.logic.shared.DatabaseLocation;
import org.jabref.logic.shared.DatabaseNotSupportedException;
import org.jabref.logic.shared.exception.InvalidDBMSConnectionPropertiesException;
import org.jabref.logic.shared.exception.NotASharedDatabaseException;
import org.jabref.logic.undo.AddUndoableActionEvent;
import org.jabref.logic.undo.UndoChangeEvent;
import org.jabref.logic.undo.UndoRedoEvent;
Expand Down Expand Up @@ -958,6 +964,128 @@ public Stage getMainStage() {
return mainStage;
}

public void handleUiCommands(List<UiCommand> uiCommands) {
for (UiCommand uiCommand : uiCommands) {
switch (uiCommand) {
case UiCommand.OpenDatabaseFromPath command ->
getOpenDatabaseAction().openFile(command.path());
case UiCommand.JumpToEntryKey jumpToEntryKey -> {
Optional<LibraryTab> libraryTab = getLibraryTabs().stream()
.filter(tab -> tab.getDatabase()
.equals(jumpToEntryKey.parserResult()
.getDatabase()))
.findFirst();
libraryTab.ifPresent(tab -> {
tab.clearAndSelect(jumpToEntryKey.bibEntry());
showLibraryTab(tab);
});
}
case UiCommand.OpenDatabases command ->
openDatabases(command.parserResults());
}
}
}

private void openDatabases(List<ParserResult> parserResults) {
final List<ParserResult> toOpenTab = new ArrayList<>();

// Remove invalid databases
List<ParserResult> invalidDatabases = parserResults.stream()
.filter(ParserResult::isInvalid)
.toList();
final List<ParserResult> failed = new ArrayList<>(invalidDatabases);
parserResults.removeAll(invalidDatabases);

// passed file (we take the first one) should be focused
Path focusedFile = parserResults.stream()
.findFirst()
.flatMap(ParserResult::getPath)
.orElse(prefs.getGuiPreferences()
.getLastFocusedFile())
.toAbsolutePath();

// Add all bibDatabases databases to the frame:
boolean first = false;
for (ParserResult pr : parserResults) {
// Define focused tab
if (pr.getPath().filter(path -> path.toAbsolutePath().equals(focusedFile)).isPresent()) {
first = true;
}

if (pr.getDatabase().isShared()) {
try {
OpenDatabaseAction.openSharedDatabase(
pr,
this,
dialogService,
prefs,
stateManager,
entryTypesManager,
fileUpdateMonitor,
undoManager,
Globals.TASK_EXECUTOR);
} catch (
SQLException |
DatabaseNotSupportedException |
InvalidDBMSConnectionPropertiesException |
NotASharedDatabaseException e) {

LOGGER.error("Connection error", e);
dialogService.showErrorDialogAndWait(
Localization.lang("Connection error"),
Localization.lang("A local copy will be opened."),
e);
toOpenTab.add(pr);
}
} else if (pr.toOpenTab()) {
// things to be appended to an opened tab should be done after opening all tabs
// add them to the list
toOpenTab.add(pr);
} else {
addTab(pr, first);
first = false;
}
}

// finally add things to the currently opened tab
for (ParserResult parserResult : toOpenTab) {
addTab(parserResult, first);
first = false;
}

for (ParserResult pr : failed) {
String message = Localization.lang("Error opening file '%0'",
pr.getPath().map(Path::toString).orElse("(File name unknown)")) + "\n" +
pr.getErrorMessage();

dialogService.showErrorDialogAndWait(Localization.lang("Error opening file"), message);
}

// Display warnings, if any
int tabNumber = 0;
for (ParserResult pr : parserResults) {
ParserResultWarningDialog.showParserResultWarningDialog(pr, this, tabNumber++);
}

// After adding the databases, go through each and see if
// any post open actions need to be done. For instance, checking
// if we found new entry types that can be imported, or checking
// if the database contents should be modified due to new features
// in this version of JabRef.
// Note that we have to check whether i does not go over getBasePanelCount().
// This is because importToOpen might have been used, which adds to
// loadedDatabases, but not to getBasePanelCount()

for (int i = 0; (i < parserResults.size()) && (i < getBasePanelCount()); i++) {
ParserResult pr = parserResults.get(i);
LibraryTab libraryTab = getLibraryTabAt(i);

OpenDatabaseAction.performPostOpenActions(libraryTab, pr);
}

LOGGER.debug("Finished adding panels");
}

/**
* The action concerned with closing the window.
*/
Expand Down
Loading

0 comments on commit 6907f80

Please sign in to comment.