From bcf800412f76f4e3e200af51e25bed6271bb5a9e Mon Sep 17 00:00:00 2001
From: Nils Streijffert <nils.streijffert@gmail.com>
Date: Wed, 26 Feb 2020 18:30:20 +0100
Subject: [PATCH] Add functionality to let the user import custom CSS file
 #5790

* Add CSS file type, add button in preferences to import a custom CSS file, started on import functionality

* Change so that the log uses format specifiers instead of string concatenation

* Add RadioButton for toggling custom theme

* Add preference for setting the path to custom CSS theme

* Load custom CSS if toggled

* Add missing language keys

* Remove check if the current theme is applied again, the check is removed since we don't need it

* Save path to the custom CSS file in program preferences
---
 .../jabref/gui/preferences/AppearanceTab.fxml |  1 +
 .../gui/preferences/AppearanceTabView.java    |  3 ++-
 .../preferences/AppearanceTabViewModel.java   | 13 +++++++++-
 .../gui/preferences/PreferencesDialog.fxml    |  5 ++++
 .../preferences/PreferencesDialogView.java    |  3 +++
 .../PreferencesDialogViewModel.java           | 15 +++++++++++
 .../java/org/jabref/gui/util/ThemeLoader.java | 26 ++++++++++++++-----
 .../jabref/logic/util/StandardFileType.java   |  3 ++-
 .../jabref/preferences/JabRefPreferences.java | 21 +++++++++++----
 src/main/resources/l10n/JabRef_en.properties  |  9 +++++++
 10 files changed, 84 insertions(+), 15 deletions(-)

diff --git a/src/main/java/org/jabref/gui/preferences/AppearanceTab.fxml b/src/main/java/org/jabref/gui/preferences/AppearanceTab.fxml
index ed2f9605c5e..ee90e52a715 100644
--- a/src/main/java/org/jabref/gui/preferences/AppearanceTab.fxml
+++ b/src/main/java/org/jabref/gui/preferences/AppearanceTab.fxml
@@ -29,4 +29,5 @@
     <Label styleClass="sectionHeader" text="%Visual theme"/>
     <RadioButton fx:id="themeLight" text="%Light theme" toggleGroup="$theme"/>
     <RadioButton fx:id="themeDark" text="%Dark theme" toggleGroup="$theme"/>
+    <RadioButton fx:id="customTheme" text="%Custom theme" toggleGroup="$theme" />
 </fx:root>
diff --git a/src/main/java/org/jabref/gui/preferences/AppearanceTabView.java b/src/main/java/org/jabref/gui/preferences/AppearanceTabView.java
index 54eebaeac8e..31b44d64337 100644
--- a/src/main/java/org/jabref/gui/preferences/AppearanceTabView.java
+++ b/src/main/java/org/jabref/gui/preferences/AppearanceTabView.java
@@ -20,6 +20,7 @@ public class AppearanceTabView extends AbstractPreferenceTabView<AppearanceTabVi
     @FXML public TextField fontSize;
     @FXML public RadioButton themeLight;
     @FXML public RadioButton themeDark;
+    @FXML public RadioButton customTheme;
 
     private final ControlsFxVisualizer validationVisualizer = new ControlsFxVisualizer();
 
@@ -43,7 +44,7 @@ public void initialize () {
 
         themeLight.selectedProperty().bindBidirectional(viewModel.themeLightProperty());
         themeDark.selectedProperty().bindBidirectional(viewModel.themeDarkProperty());
-
+        customTheme.selectedProperty().bindBidirectional(viewModel.customThemeProperty());
         validationVisualizer.setDecoration(new IconValidationDecorator());
         Platform.runLater(() -> validationVisualizer.initVisualization(viewModel.fontSizeValidationStatus(), fontSize));
     }
diff --git a/src/main/java/org/jabref/gui/preferences/AppearanceTabViewModel.java b/src/main/java/org/jabref/gui/preferences/AppearanceTabViewModel.java
index f2ee9d7a59b..a6bd9f76dcf 100644
--- a/src/main/java/org/jabref/gui/preferences/AppearanceTabViewModel.java
+++ b/src/main/java/org/jabref/gui/preferences/AppearanceTabViewModel.java
@@ -24,6 +24,7 @@ public class AppearanceTabViewModel implements PreferenceTabViewModel {
     private final StringProperty fontSizeProperty = new SimpleStringProperty();
     private final BooleanProperty themeLightProperty = new SimpleBooleanProperty();
     private final BooleanProperty themeDarkProperty = new SimpleBooleanProperty();
+    private final BooleanProperty themeCustomProperty = new SimpleBooleanProperty();
 
     private final DialogService dialogService;
     private final JabRefPreferences preferences;
@@ -60,11 +61,17 @@ public void setValues() {
             case ThemeLoader.DARK_CSS:
                 themeLightProperty.setValue(false);
                 themeDarkProperty.setValue(true);
+                themeCustomProperty.setValue(false);
                 break;
             case ThemeLoader.MAIN_CSS:
-            default:
                 themeLightProperty.setValue(true);
                 themeDarkProperty.setValue(false);
+                themeCustomProperty.setValue(false);
+                break;
+            default:
+                themeLightProperty.setValue(false);
+                themeDarkProperty.setValue(false);
+                themeCustomProperty.setValue(true);
         }
     }
 
@@ -87,6 +94,9 @@ public void storeSettings() {
         } else if (themeDarkProperty.getValue() && !preferences.get(JabRefPreferences.FX_THEME).equals(ThemeLoader.DARK_CSS)) {
             restartWarnings.add(Localization.lang("Theme changed to dark theme."));
             preferences.put(JabRefPreferences.FX_THEME, ThemeLoader.DARK_CSS);
+        } else if (themeCustomProperty.getValue()) {
+            restartWarnings.add(Localization.lang("Theme change to a custom theme."));
+            preferences.put(JabRefPreferences.FX_THEME, preferences.getPathToCustomTheme());
         }
     }
 
@@ -113,4 +123,5 @@ public boolean validateSettings() {
 
     public BooleanProperty themeDarkProperty() { return themeDarkProperty; }
 
+    public BooleanProperty customThemeProperty() { return themeCustomProperty; }
 }
diff --git a/src/main/java/org/jabref/gui/preferences/PreferencesDialog.fxml b/src/main/java/org/jabref/gui/preferences/PreferencesDialog.fxml
index d7ee3befc3e..8b80006330a 100644
--- a/src/main/java/org/jabref/gui/preferences/PreferencesDialog.fxml
+++ b/src/main/java/org/jabref/gui/preferences/PreferencesDialog.fxml
@@ -39,6 +39,11 @@
                     </Button>
                     <Button maxWidth="Infinity" onAction="#showAllPreferences" text="%Show preferences"/>
                     <Button maxWidth="Infinity" onAction="#resetPreferences" text="%Reset preferences"/>
+                    <Button maxWidth="Infinity" onAction="#importStyle" text="%Import CSS file">
+                        <tooltip>
+                            <Tooltip text="%Import custom CSS file" />
+                        </tooltip>
+                    </Button>
                 </VBox>
             </VBox>
             <ScrollPane fx:id="preferencesContainer" maxHeight="Infinity" maxWidth="Infinity"/>
diff --git a/src/main/java/org/jabref/gui/preferences/PreferencesDialogView.java b/src/main/java/org/jabref/gui/preferences/PreferencesDialogView.java
index b40a039ded6..046cd965092 100644
--- a/src/main/java/org/jabref/gui/preferences/PreferencesDialogView.java
+++ b/src/main/java/org/jabref/gui/preferences/PreferencesDialogView.java
@@ -114,4 +114,7 @@ private void savePreferencesAndCloseDialog() {
 
     @FXML
     void resetPreferences() { viewModel.resetPreferences(); }
+
+    @FXML
+    void importStyle() {viewModel.importCSSFile();}
 }
diff --git a/src/main/java/org/jabref/gui/preferences/PreferencesDialogViewModel.java b/src/main/java/org/jabref/gui/preferences/PreferencesDialogViewModel.java
index 1d2bfb61bc6..4001be6ed89 100644
--- a/src/main/java/org/jabref/gui/preferences/PreferencesDialogViewModel.java
+++ b/src/main/java/org/jabref/gui/preferences/PreferencesDialogViewModel.java
@@ -195,4 +195,19 @@ public void setValues() {
             preferencesTab.setValues();
         }
     }
+
+    public void importCSSFile() {
+        FileDialogConfiguration fileDialogConfiguration = new FileDialogConfiguration.Builder()
+                .addExtensionFilter(StandardFileType.CSS)
+                .withDefaultExtension(StandardFileType.CSS)
+                .withInitialDirectory(preferences.setLastPreferencesExportPath()).build();
+
+        dialogService.showFileOpenDialog(fileDialogConfiguration).ifPresent(file -> {
+
+            preferences.setPathToCustomTheme(file.toAbsolutePath().toString());
+
+            dialogService.showWarningDialogAndWait(Localization.lang("Import CSS"),
+                    Localization.lang("You must restart JabRef for this to come into effect."));
+        });
+    }
 }
diff --git a/src/main/java/org/jabref/gui/util/ThemeLoader.java b/src/main/java/org/jabref/gui/util/ThemeLoader.java
index 17065eb74a1..3f8cda5dbb5 100644
--- a/src/main/java/org/jabref/gui/util/ThemeLoader.java
+++ b/src/main/java/org/jabref/gui/util/ThemeLoader.java
@@ -1,5 +1,6 @@
 package org.jabref.gui.util;
 
+import java.io.File;
 import java.io.IOException;
 import java.net.MalformedURLException;
 import java.net.URI;
@@ -48,9 +49,10 @@ public ThemeLoader(FileUpdateMonitor fileUpdateMonitor, JabRefPreferences jabRef
 
         String cssVmArgument = System.getProperty("jabref.theme.css");
         String cssPreferences = jabRefPreferences.get(JabRefPreferences.FX_THEME);
+
         if (StringUtil.isNotBlank(cssVmArgument)) {
             // First priority: VM argument
-            LOGGER.info("Using css from VM option: " + cssVmArgument);
+            LOGGER.info("Using css from VM option: {}", cssVmArgument);
             URL cssVmUrl = null;
             try {
                 cssVmUrl = Paths.get(cssVmArgument).toUri().toURL();
@@ -60,13 +62,23 @@ public ThemeLoader(FileUpdateMonitor fileUpdateMonitor, JabRefPreferences jabRef
             additionalCssToLoad = Optional.ofNullable(cssVmUrl);
         } else if (StringUtil.isNotBlank(cssPreferences) && !MAIN_CSS.equalsIgnoreCase(cssPreferences)) {
             // Otherwise load css from preference
-            URL cssResource = JabRefFrame.class.getResource(cssPreferences);
-            if (cssResource != null) {
-                LOGGER.debug("Using css " + cssResource);
-                additionalCssToLoad = Optional.of(cssResource);
+            Optional<URL> cssResource = Optional.empty();
+            if (DARK_CSS.equals(cssPreferences)) {
+                cssResource = Optional.ofNullable(JabRefFrame.class.getResource(cssPreferences));
+            } else {
+                try {
+                    cssResource = Optional.of(new File(cssPreferences).toURI().toURL());
+                } catch (MalformedURLException e) {
+                    LOGGER.warn("Cannot load css {}", cssResource);
+                }
+            }
+
+            if (cssResource.isPresent()) {
+                LOGGER.debug("Using css {}", cssResource);
+                additionalCssToLoad = cssResource;
             } else {
                 additionalCssToLoad = Optional.empty();
-                LOGGER.warn("Cannot load css " + cssPreferences);
+                LOGGER.warn("Cannot load css {}", cssPreferences);
             }
         } else {
             additionalCssToLoad = Optional.empty();
@@ -104,7 +116,7 @@ private void addAndWatchForChanges(Scene scene, URL cssFile, int index) {
                 });
             }
         } catch (IOException | URISyntaxException | UnsupportedOperationException e) {
-            LOGGER.error("Could not watch css file for changes " + cssFile, e);
+            LOGGER.error("Could not watch css file for changes {}", cssFile, e);
         }
     }
 }
diff --git a/src/main/java/org/jabref/logic/util/StandardFileType.java b/src/main/java/org/jabref/logic/util/StandardFileType.java
index e89aa27982f..b6c83787ea6 100644
--- a/src/main/java/org/jabref/logic/util/StandardFileType.java
+++ b/src/main/java/org/jabref/logic/util/StandardFileType.java
@@ -38,7 +38,8 @@ public enum StandardFileType implements FileType {
     XML("xml"),
     JSON("json"),
     XMP("xmp"),
-    ZIP("zip");
+    ZIP("zip"),
+    CSS("css");
 
     private final List<String> extensions;
 
diff --git a/src/main/java/org/jabref/preferences/JabRefPreferences.java b/src/main/java/org/jabref/preferences/JabRefPreferences.java
index 08037697918..9738371c2d9 100644
--- a/src/main/java/org/jabref/preferences/JabRefPreferences.java
+++ b/src/main/java/org/jabref/preferences/JabRefPreferences.java
@@ -117,7 +117,7 @@ public class JabRefPreferences implements PreferencesService {
 
     /* contents of the defaults HashMap that are defined in this class.
      * There are more default parameters in this map which belong to separate preference classes.
-    */
+     */
     public static final String TEXSTUDIO_PATH = "TeXstudioPath";
     public static final String WIN_EDT_PATH = "winEdtPath";
     public static final String TEXMAKER_PATH = "texmakerPath";
@@ -403,6 +403,8 @@ public class JabRefPreferences implements PreferencesService {
     private static final int EXPORTER_FILENAME_INDEX = 1;
     private static final int EXPORTER_EXTENSION_INDEX = 2;
 
+    private static final String PATH_TO_CUSTOM_THEME = "pathToCustomTheme";
+
     // The only instance of this class:
     private static JabRefPreferences singleton;
     /**
@@ -759,6 +761,7 @@ private JabRefPreferences() {
 
         // set default theme
         defaults.put(JabRefPreferences.FX_THEME, ThemeLoader.MAIN_CSS);
+        defaults.put(JabRefPreferences.PATH_TO_CUSTOM_THEME, "");
 
         setLanguageDependentDefaultValues();
     }
@@ -968,6 +971,14 @@ private List<Field> getCustomTabFieldNames() {
         return customFields;
     }
 
+    public void setPathToCustomTheme(String path) {
+        put(PATH_TO_CUSTOM_THEME, path);
+    }
+
+    public String getPathToCustomTheme() {
+        return get(PATH_TO_CUSTOM_THEME);
+    }
+
     public void setLanguageDependentDefaultValues() {
         // Entry editor tab 0:
         defaults.put(CUSTOM_TAB_NAME + "_def0", Localization.lang("General"));
@@ -1129,7 +1140,7 @@ public BibDatabaseMode getDefaultBibDatabaseMode() {
      * Set the default value for a key. This is useful for plugins that need to add default values for the prefs keys
      * they use.
      *
-     * @param key The preferences key.
+     * @param key   The preferences key.
      * @param value The default value.
      */
     public void putDefaultValue(String key, Object value) {
@@ -1139,7 +1150,7 @@ public void putDefaultValue(String key, Object value) {
     /**
      * Stores a color in preferences.
      *
-     * @param key The key for this setting.
+     * @param key   The key for this setting.
      * @param color The Color to store.
      */
     public void putColor(String key, Color color) {
@@ -1356,7 +1367,7 @@ public void exportPreferences(Path file) throws JabRefException {
             prefs.exportSubtree(os);
         } catch (BackingStoreException | IOException ex) {
             throw new JabRefException("Could not export preferences", Localization.lang("Could not export preferences"),
-                                      ex);
+                                                  ex);
         }
     }
 
@@ -2097,7 +2108,7 @@ public void saveCustomEntryTypes() {
     }
 
     private void saveCustomEntryTypes(BibDatabaseMode bibDatabaseMode) {
-        List<BibEntryType> customBiblatexBibTexTypes = Globals.entryTypesManager.getAllTypes(bibDatabaseMode).stream()                                                  
+        List<BibEntryType> customBiblatexBibTexTypes = Globals.entryTypesManager.getAllTypes(bibDatabaseMode).stream()
                                                                                 .map(entryType -> entryType).collect(Collectors.toList());
 
         storeBibEntryTypes(customBiblatexBibTexTypes, bibDatabaseMode);
diff --git a/src/main/resources/l10n/JabRef_en.properties b/src/main/resources/l10n/JabRef_en.properties
index 5e1bd848dbd..04a0e0001bd 100644
--- a/src/main/resources/l10n/JabRef_en.properties
+++ b/src/main/resources/l10n/JabRef_en.properties
@@ -456,6 +456,14 @@ Importing=Importing
 
 Importing\ in\ unknown\ format=Importing in unknown format
 
+Import\ CSS=Import CSS
+
+Import\ CSS\ file=Import CSS file
+
+Import\ custom\ CSS\ file=Import custom CSS file
+
+Theme\ change\ to\ a\ custom\ theme.=Theme change to a custom theme.
+
 Include\ subgroups\:\ When\ selected,\ view\ entries\ contained\ in\ this\ group\ or\ its\ subgroups=Include subgroups: When selected, view entries contained in this group or its subgroups
 
 Independent\ group\:\ When\ selected,\ view\ only\ this\ group's\ entries=Independent group: When selected, view only this group's entries
@@ -2041,6 +2049,7 @@ Font=Font
 Visual\ theme=Visual theme
 Light\ theme=Light theme
 Dark\ theme=Dark theme
+Custom\ theme=Custom theme
 Overwrite\ existing\ keys=Overwrite existing keys
 Key\ patterns=Key patterns
 Size\:=Size: