Fix 11102 by allowing users to add local bst files to preview layout list

src/main/java/org/jabref/gui/preferences/preview/PreviewTab.java

@@ -34,7 +34,7 @@
 import org.jabref.gui.util.FileDialogConfiguration;
 import org.jabref.gui.util.IconValidationDecorator;
 import org.jabref.gui.util.ViewModelListCellFactory;
 import org.jabref.logic.bst.BstPreviewLayout;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.logic.preview.PreviewLayout;
 import org.jabref.logic.util.StandardFileType;
@@ -121,10 +121,9 @@
                 .withInitialDirectory(preferencesService.getFilePreferences().getWorkingDirectory())
                 .build();
 
+
         dialogService.showFileOpenDialog(fileDialogConfiguration).ifPresent(bstFile -> {
-            BstPreviewLayout bstPreviewLayout = new BstPreviewLayout(bstFile);
-            viewModel.availableListProperty().add(bstPreviewLayout);
-            viewModel.chosenListProperty().add(bstPreviewLayout);
+            viewModel.addBstStyle(bstFile);
         });
     }
 

src/main/java/org/jabref/gui/preferences/preview/PreviewTabViewModel.java

@@ -1,5 +1,6 @@
 package org.jabref.gui.preferences.preview;
 
+import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
@@ -11,6 +12,7 @@
 import javafx.beans.property.BooleanProperty;
 import javafx.beans.property.ListProperty;
 import javafx.beans.property.ObjectProperty;
+import javafx.beans.property.Property;
 import javafx.beans.property.SimpleBooleanProperty;
 import javafx.beans.property.SimpleListProperty;
 import javafx.beans.property.SimpleObjectProperty;
@@ -33,6 +35,7 @@
 import org.jabref.gui.util.CustomLocalDragboard;
 import org.jabref.gui.util.NoSelectionModel;
 import org.jabref.gui.util.TaskExecutor;
+import org.jabref.logic.bst.BstPreviewLayout;
 import org.jabref.logic.citationstyle.CitationStyle;
 import org.jabref.logic.citationstyle.CitationStylePreviewLayout;
 import org.jabref.logic.l10n.Localization;
@@ -70,6 +73,8 @@
     private final ListProperty<PreviewLayout> chosenListProperty = new SimpleListProperty<>(FXCollections.observableArrayList());
     private final ObjectProperty<MultipleSelectionModel<PreviewLayout>> chosenSelectionModelProperty = new SimpleObjectProperty<>(new NoSelectionModel<>());
 
+    private final ListProperty<Path> bstStylesPaths = new SimpleListProperty<>(FXCollections.observableArrayList());
+
     private final BooleanProperty selectedIsEditableProperty = new SimpleBooleanProperty(false);
     private final ObjectProperty<PreviewLayout> selectedLayoutProperty = new SimpleObjectProperty<>();
     private final StringProperty sourceTextProperty = new SimpleStringProperty("");
@@ -123,6 +128,7 @@
             availableListProperty.getValue().add(previewPreferences.getCustomPreviewLayout());
         }
 
+
         BackgroundTask.wrap(CitationStyle::discoverCitationStyles)
                       .onSuccess(styles -> styles.stream()
                                                  .map(style -> new CitationStylePreviewLayout(style, Globals.entryTypesManager))
@@ -135,6 +141,12 @@
                           dialogService.showErrorDialogAndWait(Localization.lang("Error adding discovered CitationStyles"), ex);
                       })
                       .executeWith(taskExecutor);
+        bstStylesPaths.clear();
+        bstStylesPaths.addAll(previewPreferences.getBstPreviewLayoutPaths());
+        bstStylesPaths.forEach(path -> {
+            BstPreviewLayout layout = new BstPreviewLayout(path);
+            availableListProperty.add(layout);
+        });
     }
 
     public void setPreviewLayout(PreviewLayout selectedLayout) {
@@ -194,10 +206,11 @@
         previewPreferences.setShowPreviewAsExtraTab(showAsExtraTabProperty.getValue());
         previewPreferences.setShowPreviewEntryTableTooltip(showPreviewInEntryTableTooltip.getValue());
         previewPreferences.setCustomPreviewLayout((TextBasedPreviewLayout) customLayout);
+        previewPreferences.setBstPreviewLayoutPaths(bstStylesPaths);
 
         if (!chosenSelectionModelProperty.getValue().getSelectedItems().isEmpty()) {
             previewPreferences.setLayoutCyclePosition(chosenListProperty.getValue().indexOf(
-                    chosenSelectionModelProperty.getValue().getSelectedItems().get(0)));
+                    chosenSelectionModelProperty.getValue().getSelectedItems().getFirst()));
         }
     }
 
@@ -483,4 +496,11 @@
     public StringProperty sourceTextProperty() {
         return sourceTextProperty;
     }
+
+    public void addBstStyle(Path bstFile) {
+        BstPreviewLayout bstPreviewLayout = new BstPreviewLayout(bstFile);
+        bstStylesPaths.add(bstFile);
+        availableListProperty().add(bstPreviewLayout);
+        chosenListProperty().add(bstPreviewLayout);
+    }
 }

src/main/java/org/jabref/logic/bst/BstFunctions.java

@@ -306,7 +306,7 @@ private void bstAddPeriod(BstVMVisitor visitor, ParserRuleContext ctx) {
     }
 
     /**
-     * Executes the function whose name is the entry type of an entry.
+     * Executes the function whose name is the entry type of entry.
      * For example if an entry is of type book, this function executes
      * the book function. When given as an argument to the ITERATE
      * command, call.type$ actually produces the output for the entries.
@@ -447,7 +447,7 @@ private void bstEmpty(BstVMVisitor visitor, ParserRuleContext ctx) {
             throw new BstVMException("Operand does not match function empty$ (line %d)".formatted(ctx.start.getLine()));
         }
 
-        boolean result = "".equals(s.trim());
+        boolean result = s.trim().isEmpty();
         LOGGER.trace("empty$({}) result: {}", s, result);
         stack.push(result ? BstVM.TRUE : BstVM.FALSE);
     }

src/main/java/org/jabref/logic/bst/BstPreviewLayout.java

@@ -12,6 +12,7 @@
 import org.jabref.logic.layout.format.RemoveLatexCommandsFormatter;
 import org.jabref.logic.layout.format.RemoveTilde;
 import org.jabref.logic.preview.PreviewLayout;
+import org.jabref.logic.util.StandardFileType;
 import org.jabref.model.database.BibDatabaseContext;
 import org.jabref.model.entry.BibEntry;
 
@@ -98,4 +99,11 @@ public String getName() {
     public String getText() {
         return source;
     }
+
+    /**
+     * Checks if the given style file is a BST file by checking the extension
+     */
+    public static boolean isBstStyleFile(String styleFile) {
+        return StandardFileType.BST.getExtensions().stream().anyMatch(styleFile::endsWith);
+    }
 }

src/main/java/org/jabref/preferences/JabRefPreferences.java

@@ -63,6 +63,7 @@
 import org.jabref.gui.theme.Theme;
 import org.jabref.logic.JabRefException;
 import org.jabref.logic.bibtex.FieldPreferences;
+import org.jabref.logic.bst.BstPreviewLayout;
 import org.jabref.logic.citationkeypattern.CitationKeyPattern;
 import org.jabref.logic.citationkeypattern.CitationKeyPatternPreferences;
 import org.jabref.logic.citationkeypattern.GlobalCitationKeyPatterns;
@@ -386,6 +387,7 @@ public class JabRefPreferences implements PreferencesService {
     public static final String CYCLE_PREVIEW = "cyclePreview";
     public static final String PREVIEW_AS_TAB = "previewAsTab";
     public static final String PREVIEW_IN_ENTRY_TABLE_TOOLTIP = "previewInEntryTableTooltip";
+    public static final String PREVIEW_BST_LAYOUT_PATHS = "previewBstLayoutPaths";
 
     // UI
     private static final String FONT_FAMILY = "fontFamily";
@@ -515,7 +517,7 @@ private JabRefPreferences() {
                 importPreferences(Path.of("jabref.xml"));
             }
         } catch (JabRefException e) {
-            LOGGER.warn("Could not import preferences from jabref.xml: " + e.getMessage(), e);
+            LOGGER.warn("Could not import preferences from jabref.xml: {}", e.getMessage(), e);
         }
 
         // load user preferences
@@ -1088,7 +1090,7 @@ public void flush() {
             try {
                 exportPreferences(Path.of("jabref.xml"));
             } catch (JabRefException e) {
-                LOGGER.warn("Could not export preferences for memory stick mode: " + e.getMessage(), e);
+                LOGGER.warn("Could not export preferences for memory stick mode: {}", e.getMessage(), e);
             }
         }
         try {
@@ -1643,7 +1645,7 @@ private String getProxyPassword() {
             } catch (PasswordAccessException ex) {
                 LOGGER.warn("JabRef uses proxy password from key store but no password is stored");
             } catch (Exception ex) {
-                LOGGER.warn("JabRef could not open the key store");
+                LOGGER.warn("JabRef could not open the key store", ex);
             }
         }
         return (String) defaults.get(PROXY_PASSWORD);
@@ -2110,7 +2112,8 @@ public InternalPreferences getInternalPreferences() {
             if (!newValue) {
                 try {
                     Files.deleteIfExists(Path.of("jabref.xml"));
-                } catch (IOException e) {
+                } catch (
+                        IOException e) {
                     LOGGER.warn("Error accessing filesystem", e);
                 }
             }
@@ -2431,17 +2434,25 @@ public PreviewPreferences getPreviewPreferences() {
                 new TextBasedPreviewLayout(style, getLayoutFormatterPreferences(), Globals.journalAbbreviationRepository),
                 (String) defaults.get(PREVIEW_STYLE),
                 getBoolean(PREVIEW_AS_TAB),
-                getBoolean(PREVIEW_IN_ENTRY_TABLE_TOOLTIP));
+                getBoolean(PREVIEW_IN_ENTRY_TABLE_TOOLTIP),
+                getStringList(PREVIEW_BST_LAYOUT_PATHS).stream()
+                                                       .map(Path::of)
+                                                       .collect(Collectors.toList())
+        );
 
         previewPreferences.getLayoutCycle().addListener((InvalidationListener) c -> storePreviewLayouts(previewPreferences.getLayoutCycle()));
         EasyBind.listen(previewPreferences.layoutCyclePositionProperty(), (obs, oldValue, newValue) -> putInt(CYCLE_PREVIEW_POS, newValue));
         EasyBind.listen(previewPreferences.customPreviewLayoutProperty(), (obs, oldValue, newValue) -> put(PREVIEW_STYLE, newValue.getText()));
         EasyBind.listen(previewPreferences.showPreviewAsExtraTabProperty(), (obs, oldValue, newValue) -> putBoolean(PREVIEW_AS_TAB, newValue));
         EasyBind.listen(previewPreferences.showPreviewEntryTableTooltip(), (obs, oldValue, newValue) -> putBoolean(PREVIEW_IN_ENTRY_TABLE_TOOLTIP, newValue));
-
+        previewPreferences.getBstPreviewLayoutPaths().addListener((InvalidationListener) c -> storeBstPaths(previewPreferences.getBstPreviewLayoutPaths()));
         return this.previewPreferences;
     }
 
+    private void storeBstPaths(List<Path> bstPaths) {
+        putStringList(PREVIEW_BST_LAYOUT_PATHS, bstPaths.stream().map(Path::toAbsolutePath).map(Path::toString).toList());
+    }
+
     private List<PreviewLayout> getPreviewLayouts(String style) {
         List<String> cycle = getStringList(CYCLE_PREVIEW);
 
@@ -2456,11 +2467,17 @@ private List<PreviewLayout> getPreviewLayouts(String style) {
                             return CitationStyle.createCitationStyleFromFile(layout)
                                                 .map(file -> (PreviewLayout) new CitationStylePreviewLayout(file, Globals.entryTypesManager))
                                                 .orElse(null);
+                        }
+                        if (BstPreviewLayout.isBstStyleFile(layout)) {
+                            return getStringList(PREVIEW_BST_LAYOUT_PATHS).stream()
+                                                                          .filter(path -> path.endsWith(layout)).map(Path::of)
+                                                                          .map(file -> (BstPreviewLayout) new BstPreviewLayout(file))
+                                                                          .findFirst()
+                                                                          .orElse(null);
                         } else {
                             return new TextBasedPreviewLayout(style, getLayoutFormatterPreferences(), Globals.journalAbbreviationRepository);
                         }
-                    })
-                    .filter(Objects::nonNull)
+                    }).filter(Objects::nonNull)
                     .collect(Collectors.toList());
     }
 
@@ -2541,9 +2558,9 @@ private Map<SidePaneType, Integer> getSidePanePreferredPositions() {
                 SidePaneType type = Enum.valueOf(SidePaneType.class, name);
                 preferredPositions.put(type, Integer.parseInt(componentPositions.get(i)));
             } catch (NumberFormatException e) {
-                LOGGER.debug("Invalid number format for side pane component '" + name + "'", e);
+                LOGGER.debug("Invalid number format for side pane component '{}'", name, e);
             } catch (IllegalArgumentException e) {
-                LOGGER.debug("Following component is not a side pane: '" + name + "'", e);
+                LOGGER.debug("Following component is not a side pane: '{}'", name, e);
             }
         }
 
@@ -3016,7 +3033,8 @@ private void storeFetcherKeysToKeyring(List<String> names, List<String> keys) {
                 if (StringUtil.isNullOrEmpty(keys.get(i))) {
                     try {
                         keyring.deletePassword("org.jabref.customapikeys", names.get(i));
-                    } catch (PasswordAccessException ex) {
+                    } catch (
+                            PasswordAccessException ex) {
                         // Already removed
                     }
                 } else {
@@ -3027,7 +3045,7 @@ private void storeFetcherKeysToKeyring(List<String> names, List<String> keys) {
                 }
             }
         } catch (Exception ex) {
-            LOGGER.error("Unable to open key store");
+            LOGGER.error("Unable to open key store", ex);
         }
     }
 

src/main/java/org/jabref/preferences/PreviewPreferences.java

@@ -1,5 +1,6 @@
 package org.jabref.preferences;
 
+import java.nio.file.Path;
 import java.util.List;
 
 import javafx.beans.property.BooleanProperty;
@@ -24,19 +25,22 @@ public class PreviewPreferences {
     private final StringProperty defaultCustomPreviewLayout;
     private final BooleanProperty showPreviewAsExtraTab;
     private final BooleanProperty showPreviewEntryTableTooltip;
+    private final ObservableList<Path> bstPreviewLayoutPaths;
 
     public PreviewPreferences(List<PreviewLayout> layoutCycle,
                               int layoutCyclePosition,
                               TextBasedPreviewLayout customPreviewLayout,
                               String defaultCustomPreviewLayout,
                               boolean showPreviewAsExtraTab,
-                              boolean showPreviewEntryTableTooltip) {
+                              boolean showPreviewEntryTableTooltip,
+                              List<Path> bstPreviewLayoutPaths) {
         this.layoutCycle = FXCollections.observableArrayList(layoutCycle);
         this.layoutCyclePosition = new SimpleIntegerProperty(layoutCyclePosition);
         this.customPreviewLayout = new SimpleObjectProperty<>(customPreviewLayout);
         this.defaultCustomPreviewLayout = new SimpleStringProperty(defaultCustomPreviewLayout);
         this.showPreviewAsExtraTab = new SimpleBooleanProperty(showPreviewAsExtraTab);
         this.showPreviewEntryTableTooltip = new SimpleBooleanProperty(showPreviewEntryTableTooltip);
+        this.bstPreviewLayoutPaths = FXCollections.observableList(bstPreviewLayoutPaths);
     }
 
     public ObservableList<PreviewLayout> getLayoutCycle() {
@@ -112,4 +116,12 @@ public void setShowPreviewEntryTableTooltip(boolean showPreviewEntryTableTooltip
     public BooleanProperty showPreviewEntryTableTooltip() {
         return showPreviewEntryTableTooltip;
     }
+
+    public ObservableList<Path> getBstPreviewLayoutPaths() {
+        return bstPreviewLayoutPaths;
+    }
+
+    public void setBstPreviewLayoutPaths(List<Path> bstPreviewLayoutPaths) {
+        this.bstPreviewLayoutPaths.setAll(bstPreviewLayoutPaths);
+    }
 }