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

CHANGELOG.md

@@ -18,6 +18,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We added tooltip on main table cells that shows cell content or cell content and entry preview if set in preferences. [10925](https://github.com/JabRef/jabref/issues/10925)
 - We added the ability to add a keyword/crossref when typing the separator character (e.g., comma) in the keywords/crossref fields. [#11178](https://github.com/JabRef/jabref/issues/11178)
 - We added an exporter and improved the importer for Endnote XML format. [#11137](https://github.com/JabRef/jabref/issues/11137)
+- We added a button in gui to give users an easy option to select and add local bst files to available styles in preview layout list. [#11102](https://github.com/JabRef/jabref/issues/11102)
 
 ### Changed
 

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

@@ -22,6 +22,7 @@
     <CheckBox fx:id="showAsTabCheckBox" text="%Show preview as a tab in entry editor"/>
     <CheckBox fx:id="showPreviewTooltipCheckBox" text="Show preview in entry table tooltip"/>
     <HBox spacing="4.0">
+        <Button fx:id="bstFileButton" text="Select BST File" onAction="#selectBstFile" />
         <VBox spacing="4.0" HBox.hgrow="ALWAYS">
             <Label text="%Available" styleClass="sectionHeader"/>
             <CustomTextField fx:id="searchBox" promptText="%Filter" VBox.vgrow="NEVER" prefHeight="20.0"/>

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

@@ -1,10 +1,13 @@
 package org.jabref.gui.preferences.preview;
 
+import java.io.File;
+import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.List;
 
 import javafx.application.Platform;
 import javafx.beans.property.ListProperty;
+import javafx.event.ActionEvent;
 import javafx.fxml.FXML;
 import javafx.scene.control.Button;
 import javafx.scene.control.CheckBox;
@@ -18,6 +21,7 @@
 import javafx.scene.input.KeyEvent;
 import javafx.scene.input.MouseEvent;
 import javafx.scene.input.TransferMode;
+import javafx.stage.FileChooser;
 
 import org.jabref.gui.Globals;
 import org.jabref.gui.StateManager;
@@ -32,6 +36,7 @@
 import org.jabref.gui.util.BindingsHelper;
 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.TestEntry;
@@ -104,6 +109,20 @@ public String getTabName() {
         return Localization.lang("Entry preview");
     }
 
+    @FXML
+    private void selectBstFile(ActionEvent event) {
+    FileChooser fileChooser = new FileChooser();
+    fileChooser.setTitle("Select BST File");
+    fileChooser.getExtensionFilters().add(new FileChooser.ExtensionFilter("BST Files", "*.bst"));
+
+    File selectedFile = fileChooser.showOpenDialog(null);
+    if (selectedFile != null) {
+        String filePath = selectedFile.getAbsolutePath();
+        BstPreviewLayout bstPreviewLayout = new BstPreviewLayout(Path.of(filePath));
+        viewModel.availableListProperty().add(bstPreviewLayout);
+    }
+}
+
     public void initialize() {
         this.viewModel = new PreviewTabViewModel(dialogService, preferencesService.getPreviewPreferences(), taskExecutor, stateManager);
         lastKeyPressTime = System.currentTimeMillis();

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

@@ -52,11 +52,11 @@
 /**
  * This class is Preferences -> Entry Preview tab model
  * <p>
- *     {@link PreviewTab} is the controller of Entry Preview tab
+ * {@link PreviewTab} is the controller of Entry Preview tab
  * </p>
  *
  * @see PreviewTab
- * */
+ */
 public class PreviewTabViewModel implements PreferenceTabViewModel {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(PreviewTabViewModel.class);
@@ -103,10 +103,10 @@ public PreviewTabViewModel(DialogService dialogService,
                 chosenListProperty,
                 input -> !chosenListProperty.getValue().isEmpty(),
                 ValidationMessage.error("%s > %s %n %n %s".formatted(
-                        Localization.lang("Entry preview"),
-                        Localization.lang("Selected"),
-                        Localization.lang("Selected Layouts can not be empty")
-                )
+                                Localization.lang("Entry preview"),
+                                Localization.lang("Selected"),
+                                Localization.lang("Selected Layouts can not be empty")
+                        )
                 )
         );
     }
@@ -153,13 +153,13 @@ public void setPreviewLayout(PreviewLayout selectedLayout) {
                     Localization.lang("Parsing error") + ": " + Localization.lang("illegal backslash expression"), exception);
         }
 
-        if (selectedLayout instanceof TextBasedPreviewLayout layout) {
-            sourceTextProperty.setValue(layout.getText().replace("__NEWLINE__", "\n"));
-            selectedIsEditableProperty.setValue(true);
-        } else {
-            sourceTextProperty.setValue(((CitationStylePreviewLayout) selectedLayout).getSource());
-            selectedIsEditableProperty.setValue(false);
-        }
+        boolean isEditingAllowed = selectedLayout instanceof TextBasedPreviewLayout;
+        setContentForPreview(selectedLayout.getText(), isEditingAllowed);
+    }
+
+    private void setContentForPreview(String text, boolean editable) {
+        sourceTextProperty.setValue(text);
+        selectedIsEditableProperty.setValue(editable);
     }
 
     public void refreshPreview() {

src/main/java/org/jabref/gui/preview/CopyCitationAction.java

@@ -83,7 +83,7 @@ private List<String> generateCitations() throws IOException {
         PreviewLayout previewLayout = preferencesService.getPreviewPreferences().getSelectedPreviewLayout();
 
         if (previewLayout instanceof CitationStylePreviewLayout citationStyleLayout) {
-            styleSource = citationStyleLayout.getSource();
+            styleSource = citationStyleLayout.getText();
         }
 
         if (styleSource != null) {

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

@@ -1,5 +1,6 @@
 package org.jabref.logic.bst;
 
+import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.List;
@@ -17,16 +18,23 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class BstPreviewLayout implements PreviewLayout {
+public final class BstPreviewLayout implements PreviewLayout {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(BstPreviewLayout.class);
 
     private final String name;
-
+    private String source;
     private BstVM bstVM;
     private String error;
 
     public BstPreviewLayout(Path path) {
+        try {
+            this.source = String.join("\n", Files.readAllLines(path));
+        } catch (IOException e) {
+            LOGGER.error("Error reading file", e);
+            this.source = "";
+        }
+
         name = path.getFileName().toString();
         if (!Files.exists(path)) {
             LOGGER.error("File {} not found", path.toAbsolutePath());
@@ -85,4 +93,9 @@ public String getDisplayName() {
     public String getName() {
         return name;
     }
+
+    @Override
+    public String getText() {
+        return source;
+    }
 }

src/main/java/org/jabref/logic/citationstyle/CitationStylePreviewLayout.java

@@ -5,7 +5,7 @@
 import org.jabref.model.entry.BibEntry;
 import org.jabref.model.entry.BibEntryTypesManager;
 
-public class CitationStylePreviewLayout implements PreviewLayout {
+public final class CitationStylePreviewLayout implements PreviewLayout {
     private final CitationStyle citationStyle;
     private final BibEntryTypesManager bibEntryTypesManager;
 
@@ -24,7 +24,8 @@ public String getDisplayName() {
         return citationStyle.getTitle();
     }
 
-    public String getSource() {
+    @Override
+    public String getText() {
         return citationStyle.getSource();
     }
 

src/main/java/org/jabref/logic/layout/TextBasedPreviewLayout.java

@@ -15,7 +15,7 @@
 /**
  * Implements the preview based JabRef's <a href="https://docs.jabref.org/import-export/export/customexports">Custom export filters</a>.
  */
-public class TextBasedPreviewLayout implements PreviewLayout {
+public final class TextBasedPreviewLayout implements PreviewLayout {
     public static final String NAME = "PREVIEW";
 
     private static final Logger LOGGER = LoggerFactory.getLogger(TextBasedPreviewLayout.class);
@@ -54,8 +54,9 @@ public String generatePreview(BibEntry entry, BibDatabaseContext databaseContext
         }
     }
 
+    @Override
     public String getText() {
-        return text;
+        return text.replace("__NEWLINE__", "\n");
     }
 
     @Override
@@ -67,4 +68,5 @@ public String getName() {
     public String getDisplayName() {
         return Localization.lang("Customized preview style");
     }
+
 }

src/main/java/org/jabref/logic/preview/PreviewLayout.java

@@ -2,18 +2,23 @@
 
 import java.util.Locale;
 
+import org.jabref.logic.bst.BstPreviewLayout;
+import org.jabref.logic.citationstyle.CitationStylePreviewLayout;
+import org.jabref.logic.layout.TextBasedPreviewLayout;
 import org.jabref.model.database.BibDatabaseContext;
 import org.jabref.model.entry.BibEntry;
 
 /**
  * Used for displaying a rendered entry in the UI. Due to historical reasons, "rendering" is called "layout".
  */
-public interface PreviewLayout {
+public sealed interface PreviewLayout permits BstPreviewLayout, CitationStylePreviewLayout, TextBasedPreviewLayout {
 
     String generatePreview(BibEntry entry, BibDatabaseContext databaseContext);
 
     String getDisplayName();
 
+    String getText();
+
     String getName();
 
     default boolean containsCaseIndependent(String searchTerm) {

src/test/java/org/jabref/logic/bst/BstVMTest.java

@@ -5,6 +5,7 @@
 import java.util.Collections;
 import java.util.List;
 
+import org.jabref.logic.util.TestEntry;
 import org.jabref.model.entry.BibEntry;
 import org.jabref.model.entry.field.StandardField;
 import org.jabref.model.entry.types.StandardEntryType;
@@ -42,6 +43,19 @@ public void abbrv() throws RecognitionException, IOException {
                 result.replaceAll("\\s", ""));
     }
 
+    @Test
+    public void ieeetran() throws RecognitionException, IOException {
+        BstVM vm = new BstVM(Path.of("src/test/resources/org/jabref/logic/bst/IEEEtran.bst"));
+        List<BibEntry> testEntries = List.of(TestEntry.getTestEntry());
+
+        String expected = "\\begin{thebibliography}{1}\\bibitem{canh05}K.~Crowston, H.~Annabi, J.~Howison, and C.~Masango.\\newblock Effective work practices for floss development: A model and  propositions.\\newblock In {\\em Hawaii International Conference On System Sciences (HICSS)}, 2005.\\end{thebibliography}";
+        String result = vm.render(testEntries);
+
+        assertEquals(
+                expected.replaceAll("\\s", ""),
+                result.replaceAll("\\s", ""));
+    }
+
     @Test
     public void simple() throws RecognitionException {
         BstVM vm = new BstVM("""