Merge remote-tracking branch 'upstream/main' into feature/journal-abbreviation-toggle

Author: zikunz

.github/ghprcomment.yml

@@ -88,10 +88,13 @@
 - jobName: no-force-push
   always: true
   message: >
-    Do not force-push!
-    Force pushing is a very bad practice when working together on a project (mainly because it is [not supported well by GitHub itself](https://github.com/orgs/community/discussions/3478)).
+    Hey, we noticed that you **force-pushed** your changes.
+    Force pushing is a bad practice when working together on a project (mainly because it is [not supported well by GitHub itself](https://github.com/orgs/community/discussions/3478)).
     Commits are lost and comments on commits lose their context, thus making it harder to review changes.
     At the end, all commits will be [squashed](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits) anyway before being merged into the `main` branch.
+
+
+    In future, **please avoid that**. For now, you can continue working.
 - jobName: 'Conflicts with target branch'
   message: >
     Your pull request conflicts with the target branch.

CHANGELOG.md

@@ -37,6 +37,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We added path validation to file directories in library properties dialog. [#11840](https://github.com/JabRef/jabref/issues/11840)
 - We now support usage of custom CSL styles in the Open/LibreOffice integration. [#12337](https://github.com/JabRef/jabref/issues/12337)
 - We added ability to toggle journal abbreviation lists (including built-in and external CSV files) on/off in preferences. [#12468](https://github.com/JabRef/jabref/pull/12468)
+- We added support for citation-only CSL styles which don't specify bibliography formatting. [#12996](https://github.com/JabRef/jabref/pull/12996)
 
 ### Changed
 

src/main/java/org/jabref/gui/openoffice/ModifyCSLBibliographyTitleDialogView.java

@@ -33,8 +33,7 @@ public ModifyCSLBibliographyTitleDialogView(OpenOfficePreferences openOfficePref
                   .setAsDialogPane(this);
 
         Button okButton = (Button) getDialogPane().lookupButton(ButtonType.OK);
-        okButton.setOnAction(event -> {
-            viewModel.updateSettings();
+        okButton.setOnAction(_ -> {
             this.close();
         });
     }

src/main/java/org/jabref/gui/openoffice/ModifyCSLBibliographyTitleDialogViewModel.java

@@ -19,10 +19,8 @@ public class ModifyCSLBibliographyTitleDialogViewModel {
              new ReadOnlyListWrapper<>(FXCollections.observableArrayList(
                     Arrays.stream(CSLFormatUtils.Format.values()).map(CSLFormatUtils.Format::getFormat).toList()
             ));
-    private final OpenOfficePreferences openOfficePreferences;
 
     public ModifyCSLBibliographyTitleDialogViewModel(OpenOfficePreferences openOfficePreferences) {
-        this.openOfficePreferences = openOfficePreferences;
         this.cslBibliographyTitle.set(openOfficePreferences.getCslBibliographyTitle());
         this.cslBibliographySelectedHeaderFormat.set(openOfficePreferences.getCslBibliographyHeaderFormat());
 
@@ -41,8 +39,4 @@ public StringProperty cslBibliographySelectedHeaderFormatProperty() {
     public ReadOnlyListProperty<String> formatListProperty() {
         return formatListProperty;
     }
-
-    public void updateSettings() {
-        CSLFormatUtils.setBibliographyProperties(openOfficePreferences);
-    }
 }

src/main/java/org/jabref/gui/openoffice/OOBibBase.java

@@ -1,6 +1,5 @@
 package org.jabref.gui.openoffice;
 
-import java.io.IOException;
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -26,7 +25,6 @@
 import org.jabref.logic.openoffice.frontend.OOFrontend;
 import org.jabref.logic.openoffice.frontend.RangeForOverlapCheck;
 import org.jabref.logic.openoffice.oocsltext.CSLCitationOOAdapter;
-import org.jabref.logic.openoffice.oocsltext.CSLFormatUtils;
 import org.jabref.logic.openoffice.oocsltext.CSLUpdateBibliography;
 import org.jabref.logic.openoffice.style.JStyle;
 import org.jabref.logic.openoffice.style.OOStyle;
@@ -73,11 +71,11 @@ public class OOBibBase {
 
     private final OOBibBaseConnect connection;
 
+    private final OpenOfficePreferences openOfficePreferences;
+
     private CSLCitationOOAdapter cslCitationOOAdapter;
     private CSLUpdateBibliography cslUpdateBibliography;
 
-    private OpenOfficePreferences openOfficePreferences;
-
     public OOBibBase(Path loPath, DialogService dialogService, OpenOfficePreferences openOfficePreferences)
             throws
             BootstrapException,
@@ -92,10 +90,8 @@ private void initializeCitationAdapter(XTextDocument doc) throws WrappedTargetEx
         if (cslCitationOOAdapter == null) {
             StateManager stateManager = Injector.instantiateModelOrService(StateManager.class);
             Supplier<List<BibDatabaseContext>> databasesSupplier = stateManager::getOpenDatabases;
-            OOStyle initialStyle = openOfficePreferences.getCurrentStyle(); // may be a jstyle, can still be used for detecting subsequent style changes in context of CSL
-            cslCitationOOAdapter = new CSLCitationOOAdapter(doc, databasesSupplier, initialStyle);
+            cslCitationOOAdapter = new CSLCitationOOAdapter(doc, databasesSupplier, openOfficePreferences);
             cslUpdateBibliography = new CSLUpdateBibliography();
-            CSLFormatUtils.setBibliographyProperties(openOfficePreferences);
         }
     }
 
@@ -614,7 +610,9 @@ public void guiActionInsertEntry(List<BibEntry> entries,
                     }
 
                     // If "Automatically sync bibliography when inserting citations" is enabled
-                    syncOptions.ifPresent(options -> guiActionUpdateDocument(options.databases, citationStyle));
+                    if (citationStyle.hasBibliography()) {
+                        syncOptions.ifPresent(options -> guiActionUpdateDocument(options.databases, citationStyle));
+                    }
                 } finally {
                     // Release controller lock
                     doc.unlockControllers();
@@ -641,7 +639,6 @@ public void guiActionInsertEntry(List<BibEntry> entries,
             OOError.from(ex).setTitle(errorTitle).showErrorDialog(dialogService);
         } catch (CreationException
                  | WrappedTargetException
-                 | IOException
                  | PropertyVetoException
                  | IllegalTypeException
                  | NotRemoveableException ex) {
@@ -900,8 +897,10 @@ public void guiActionUpdateDocument(List<BibDatabase> databases, OOStyle style)
                 OOError.fromMisc(ex).setTitle(errorTitle).showErrorDialog(dialogService);
             }
         } else if (style instanceof CitationStyle citationStyle) {
+            if (!citationStyle.hasBibliography()) {
+                return;
+            }
             try {
-
                 OOResult<XTextDocument, OOError> odoc = getXTextDocument();
                 if (testDialog(errorTitle, odoc.asVoidResult())) {
                     return;

src/main/java/org/jabref/gui/openoffice/OpenOfficePanel.java

@@ -417,6 +417,7 @@ private void updateButtonAvailability() {
         boolean canCite = isConnectedToDocument && hasStyle && hasDatabase;
         boolean canRefreshDocument = isConnectedToDocument && hasStyle;
         boolean cslStyleSelected = currentStyle instanceof CitationStyle;
+        boolean canGenerateBibliography = currentStyle instanceof CitationStyle citationStyle && citationStyle.hasBibliography();
 
         selectDocument.setDisable(!isConnectedToDocument);
 
@@ -425,7 +426,7 @@ private void updateButtonAvailability() {
         pushEntriesEmpty.setDisable(!canCite);
         pushEntriesAdvanced.setDisable(!canCite || cslStyleSelected);
 
-        update.setDisable(!canRefreshDocument);
+        update.setDisable(!canRefreshDocument || !canGenerateBibliography);
         merge.setDisable(!canRefreshDocument || cslStyleSelected);
         unmerge.setDisable(!canRefreshDocument || cslStyleSelected);
         manageCitations.setDisable(!canRefreshDocument || cslStyleSelected);

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

@@ -66,7 +66,7 @@ private List<String> generateCitations(List<BibEntry> selectedEntries, CitationS
         }
 
         if (styleSource != null) {
-            return CitationStyleGenerator.generateBibliographies(
+            return CitationStyleGenerator.generateBibliography(
                     selectedEntries,
                     styleSource,
                     outputFormat,

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

@@ -52,7 +52,7 @@ public static CitationStyle getDefaultStyle() {
                               .filter(style -> DEFAULT_STYLE.equals(style.getFilePath()))
                               .findFirst()
                               .orElseGet(() -> CSLStyleUtils.createCitationStyleFromFile(DEFAULT_STYLE)
-                                                            .orElse(new CitationStyle("", "Empty", false, "", true)));
+                                                            .orElse(new CitationStyle("", "Empty", false, false, "", true)));
     }
 
     /**
@@ -78,20 +78,21 @@ public static void loadInternalStyles() {
                     String path = (String) info.get("path");
                     String title = (String) info.get("title");
                     boolean isNumeric = (boolean) info.get("isNumeric");
+                    boolean hasBibliography = (boolean) info.get("hasBibliography");
 
                     // We use these metadata and just load the content instead of re-parsing for them
                     try (InputStream styleStream = CSLStyleLoader.class.getResourceAsStream(STYLES_ROOT + "/" + path)) {
                         if (styleStream != null) {
                             String source = new String(styleStream.readAllBytes());
-                            CitationStyle style = new CitationStyle(path, title, isNumeric, source, true);
+                            CitationStyle style = new CitationStyle(path, title, isNumeric, hasBibliography, source, true);
                             INTERNAL_STYLES.add(style);
                         }
                     } catch (IOException e) {
                         LOGGER.error("Error loading style file: {}", path, e);
                         styleCount--;
                     }
                 }
-            LOGGER.info("Loaded {} CSL styles", styleCount);
+                LOGGER.info("Loaded {} CSL styles", styleCount);
             } else {
                 LOGGER.error("Citation style catalog is empty");
             }

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

@@ -21,16 +21,16 @@
  * Utility class for handling Citation Style Language (CSL) files.
  * Contains shared functionality used by both runtime ({@link CSLStyleLoader}) and build-time ({@link CitationStyleCatalogGenerator}) components.
  */
-public class CSLStyleUtils {
+public final class CSLStyleUtils {
     private static final String STYLES_ROOT = "/csl-styles";
     private static final XMLInputFactory XML_INPUT_FACTORY = XMLInputFactory.newInstance();
 
     private static final Logger LOGGER = LoggerFactory.getLogger(CSLStyleUtils.class);
 
     /**
-     * Style information record (title, isNumericStyle) pair for a citation style.
+     * Style information record (title, isNumericStyle, hasBibliography) triad for a citation style.
      */
-    public record StyleInfo(String title, boolean isNumericStyle) {
+    public record StyleInfo(String title, boolean isNumericStyle, boolean hasBibliography) {
     }
 
     static {
@@ -56,7 +56,7 @@ public static boolean isCitationStyleFile(String styleFile) {
      */
     public static Optional<CitationStyle> createCitationStyleFromFile(String styleFile) {
         if (!isCitationStyleFile(styleFile)) {
-            LOGGER.error("Can only load style files: {}", styleFile);
+            LOGGER.error("Not a .csl style file: {}", styleFile);
             return Optional.empty();
         }
 
@@ -95,7 +95,7 @@ private static Optional<CitationStyle> createCitationStyleFromSource(InputStream
             String content = new String(source.readAllBytes());
 
             Optional<StyleInfo> styleInfo = parseStyleInfo(filename, content);
-            return styleInfo.map(info -> new CitationStyle(filename, info.title(), info.isNumericStyle(), content, isInternal));
+            return styleInfo.map(info -> new CitationStyle(filename, info.title(), info.isNumericStyle(), info.hasBibliography(), content, isInternal));
         } catch (IOException e) {
             LOGGER.error("Error while parsing source", e);
             return Optional.empty();
@@ -115,6 +115,7 @@ public static Optional<StyleInfo> parseStyleInfo(String filename, String content
 
             boolean inInfo = false;
             boolean hasBibliography = false;
+            boolean hasCitation = false;
             String title = "";
             boolean isNumericStyle = false;
 
@@ -126,6 +127,7 @@ public static Optional<StyleInfo> parseStyleInfo(String filename, String content
 
                     switch (elementName) {
                         case "bibliography" -> hasBibliography = true;
+                        case "citation" -> hasCitation = true;
                         case "info" -> inInfo = true;
                         case "title" -> {
                             if (inInfo) {
@@ -146,10 +148,10 @@ public static Optional<StyleInfo> parseStyleInfo(String filename, String content
                 }
             }
 
-            if (hasBibliography && title != null) {
-                return Optional.of(new StyleInfo(title, isNumericStyle));
+            if (hasCitation && title != null) {
+                return Optional.of(new StyleInfo(title, isNumericStyle, hasBibliography));
             } else {
-                LOGGER.debug("No valid title or bibliography found for file {}", filename);
+                LOGGER.debug("No valid title or citation found for file {}", filename);
                 return Optional.empty();
             }
         } catch (XMLStreamException e) {

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

@@ -17,22 +17,24 @@ public class CitationStyle implements OOStyle {
     private final String filePath;
     private final String title;
     private final boolean isNumericStyle;
+    private final boolean hasBibliography;
     private final String source;
     private final boolean isInternalStyle;
 
-    public CitationStyle(String filePath, String title, boolean isNumericStyle, String source, boolean isInternalStyle) {
+    public CitationStyle(String filePath, String title, boolean isNumericStyle, boolean hasBibliography, String source, boolean isInternalStyle) {
         this.filePath = Path.of(Objects.requireNonNull(filePath)).toString(); // wrapping with Path.of takes care of extra slashes in path due to subsequent storage and retrieval (observed on Windows)
         this.title = Objects.requireNonNull(title);
         this.isNumericStyle = isNumericStyle;
+        this.hasBibliography = hasBibliography;
         this.source = Objects.requireNonNull(source);
         this.isInternalStyle = isInternalStyle;
     }
 
     /**
      * Creates a new citation style with an auto-determined internal/external state.
      */
-    public CitationStyle(String filePath, String title, boolean isNumericStyle, String source) {
-        this(filePath, title, isNumericStyle, source, !Path.of(filePath).isAbsolute());
+    public CitationStyle(String filePath, String title, boolean isNumericStyle, boolean hasBibliography, String source) {
+        this(filePath, title, isNumericStyle, hasBibliography, source, !Path.of(filePath).isAbsolute());
     }
 
     public String getTitle() {
@@ -43,6 +45,10 @@ public boolean isNumericStyle() {
         return isNumericStyle;
     }
 
+    public boolean hasBibliography() {
+        return hasBibliography;
+    }
+
     /**
      * Currently, we have support for one alphanumeric CSL style.
      * There is no tag or field in .csl style files that can be parsed to determine if it is an alphanumeric style.