CSL4LibreOffice - C [GSoC '24]

build.gradle

@@ -179,8 +179,12 @@ dependencies {
 
     implementation 'commons-cli:commons-cli:1.8.0'
 
+    // region: LibreOffice
     implementation 'org.libreoffice:unoloader:24.2.3'
     implementation 'org.libreoffice:libreoffice:24.2.3'
+    // Required for ID generation
+    implementation 'io.github.thibaultmeyer:cuid:2.0.3'
+    // endregion
 
     implementation 'io.github.java-diff-utils:java-diff-utils:4.12'
     implementation 'info.debatty:java-string-similarity:2.0.0'

src/main/java/module-info.java

@@ -161,6 +161,7 @@
     requires transitive org.jspecify;
 
     // region: other libraries (alphabetically)
+    requires cuid;
     requires dd.plist;
     requires mslinks;
     requires org.antlr.antlr4.runtime;

src/main/java/org/jabref/gui/icon/IconTheme.java

@@ -359,7 +359,8 @@ public enum JabRefIcons implements JabRefIcon {
         REMOVE_TAGS(MaterialDesignC.CLOSE),
         ACCEPT_LEFT(MaterialDesignS.SUBDIRECTORY_ARROW_LEFT),
         ACCEPT_RIGHT(MaterialDesignS.SUBDIRECTORY_ARROW_RIGHT),
-        MERGE_GROUPS(MaterialDesignS.SOURCE_MERGE);
+        MERGE_GROUPS(MaterialDesignS.SOURCE_MERGE),
+        ADD_OR_MAKE_BIBLIOGRAPHY(JabRefMaterialDesignIcon.BIBLIOGRAPHY);
         private final JabRefIcon icon;
 
         JabRefIcons(Ikon... icons) {

src/main/java/org/jabref/gui/icon/JabRefMaterialDesignIcon.java

@@ -32,7 +32,8 @@ public enum JabRefMaterialDesignIcon implements Ikon {
     CANCEL("jab-cancel", '\ue90e'),
     SUBLIME_TEXT("jab-sublime-text", '\ue90f'),
     TEXSHOP("jab-texshop", '\ue910'),
-    TEXWORKS("jab-texworks", '\ue911');
+    TEXWORKS("jab-texworks", '\ue911'),
+    BIBLIOGRAPHY("jab-bibliography", '\ue912');
 
     private String description;
     private int code;

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

@@ -24,6 +24,7 @@
 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.CSLUpdateBibliography;
 import org.jabref.logic.openoffice.style.JStyle;
 import org.jabref.logic.openoffice.style.OOStyle;
 import org.jabref.model.database.BibDatabase;
@@ -44,6 +45,7 @@
 import org.jabref.model.openoffice.util.OOResult;
 import org.jabref.model.openoffice.util.OOVoidResult;
 
+import com.airhacks.afterburner.injection.Injector;
 import com.sun.star.beans.IllegalTypeException;
 import com.sun.star.beans.NotRemoveableException;
 import com.sun.star.beans.PropertyVetoException;
@@ -53,13 +55,14 @@
 import com.sun.star.lang.WrappedTargetException;
 import com.sun.star.text.XTextCursor;
 import com.sun.star.text.XTextDocument;
+import com.sun.star.uno.Exception;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
  * Class for manipulating the Bibliography of the currently started document in OpenOffice.
  */
-class OOBibBase {
+public class OOBibBase {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(OOBibBase.class);
 
@@ -73,7 +76,7 @@ class OOBibBase {
 
     private final OOBibBaseConnect connection;
 
-    private final CSLCitationOOAdapter cslCitationOOAdapter;
+    private CSLCitationOOAdapter cslCitationOOAdapter;
 
     public OOBibBase(Path loPath, DialogService dialogService)
             throws
@@ -85,11 +88,14 @@ public OOBibBase(Path loPath, DialogService dialogService)
 
         this.refreshBibliographyDuringSyncWhenCiting = false;
         this.alwaysAddCitedOnPages = false;
+    }
 
-        cslCitationOOAdapter = new CSLCitationOOAdapter();
+    private void initializeCitationAdapter(XTextDocument doc) throws WrappedTargetException, NoSuchElementException {
+            this.cslCitationOOAdapter = new CSLCitationOOAdapter(doc);
+            this.cslCitationOOAdapter.readExistingMarks();
     }
 
-    public void guiActionSelectDocument(boolean autoSelectForSingle) {
+    public void guiActionSelectDocument(boolean autoSelectForSingle) throws WrappedTargetException, NoSuchElementException {
         final String errorTitle = Localization.lang("Problem connecting");
 
         try {
@@ -100,13 +106,14 @@ public void guiActionSelectDocument(boolean autoSelectForSingle) {
         } catch (DisposedException ex) {
             OOError.from(ex).setTitle(errorTitle).showErrorDialog(dialogService);
         } catch (WrappedTargetException
-                | IndexOutOfBoundsException
-                | NoSuchElementException ex) {
+                 | IndexOutOfBoundsException
+                 | NoSuchElementException ex) {
             LOGGER.warn("Problem connecting", ex);
             OOError.fromMisc(ex).setTitle(errorTitle).showErrorDialog(dialogService);
         }
 
         if (this.isConnectedToDocument()) {
+            initializeCitationAdapter(this.getXTextDocument().get());
             dialogService.notify(Localization.lang("Connected to document") + ": "
                     + this.getCurrentDocumentTitle().orElse(""));
         }
@@ -591,16 +598,26 @@ public void guiActionInsertEntry(List<BibEntry> entries,
         }
 
         try {
+
             UnoUndo.enterUndoContext(doc, "Insert citation");
             if (style instanceof CitationStyle citationStyle) {
                 // Handle insertion of CSL Style citations
-                if (citationType == CitationType.AUTHORYEAR_INTEXT) {
-                    cslCitationOOAdapter.insertInText(doc, cursor.get(), citationStyle, entries, bibDatabaseContext, bibEntryTypesManager);
-                } else {
-                    cslCitationOOAdapter.insertBibliography(doc, cursor.get(), citationStyle, entries, bibDatabaseContext, bibEntryTypesManager);
+
+                initializeCitationAdapter(doc);
+
+                if (citationType == CitationType.AUTHORYEAR_PAR) {
+                    // "Cite" button
+                    this.cslCitationOOAdapter.insertCitation(cursor.get(), citationStyle, entries, bibDatabaseContext, bibEntryTypesManager);
+                } else if (citationType == CitationType.AUTHORYEAR_INTEXT) {
+                    // "Cite in-text" button
+                    this.cslCitationOOAdapter.insertInTextCitation(cursor.get(), citationStyle, entries, bibDatabaseContext, bibEntryTypesManager);
+                } else if (citationType == CitationType.INVISIBLE_CIT) {
+                    // "Insert empty citation"
+                    this.cslCitationOOAdapter.insertEmpty(cursor.get(), entries);
                 }
             } else if (style instanceof JStyle jStyle) {
                 // Handle insertion of JStyle citations
+
                 EditInsert.insertCitationGroup(doc,
                         frontend.get(),
                         cursor.get(),
@@ -626,6 +643,8 @@ public void guiActionInsertEntry(List<BibEntry> entries,
                  | NotRemoveableException ex) {
             LOGGER.warn("Could not insert entry", ex);
             OOError.fromMisc(ex).setTitle(errorTitle).showErrorDialog(dialogService);
+        } catch (Exception e) {
+            throw new RuntimeException(e);
         } finally {
             UnoUndo.leaveUndoContext(doc);
         }
@@ -817,9 +836,8 @@ public Optional<BibDatabase> exportCitedHelper(List<BibDatabase> databases, bool
      * @param style     Style.
      */
     public void guiActionUpdateDocument(List<BibDatabase> databases, OOStyle style) {
+        final String errorTitle = Localization.lang("Unable to synchronize bibliography");
         if (style instanceof JStyle jStyle) {
-            final String errorTitle = Localization.lang("Unable to synchronize bibliography");
-
             try {
 
                 OOResult<XTextDocument, OOError> odoc = getXTextDocument();
@@ -871,10 +889,73 @@ public void guiActionUpdateDocument(List<BibDatabase> databases, OOStyle style)
                 OOError.from(ex).setTitle(errorTitle).showErrorDialog(dialogService);
             } catch (DisposedException ex) {
                 OOError.from(ex).setTitle(errorTitle).showErrorDialog(dialogService);
+            } catch (CreationException
+                    | WrappedTargetException
+                    | com.sun.star.lang.IllegalArgumentException ex) {
+                LOGGER.warn("Could not update JStyle bibliography", ex);
+                OOError.fromMisc(ex).setTitle(errorTitle).showErrorDialog(dialogService);
+            }
+        } else if (style instanceof CitationStyle citationStyle) {
+            try {
+
+                CSLUpdateBibliography cslUpdateBibliography = new CSLUpdateBibliography();
+
+                OOResult<XTextDocument, OOError> odoc = getXTextDocument();
+                if (testDialog(errorTitle, odoc.asVoidResult())) {
+                    return;
+                }
+
+                XTextDocument doc = odoc.get();
+
+                OOResult<FunctionalTextViewCursor, OOError> fcursor = getFunctionalTextViewCursor(doc, errorTitle);
+
+                if (testDialog(errorTitle,
+                        fcursor.asVoidResult(),
+                        checkIfOpenOfficeIsRecordingChanges(doc))) {
+                    return;
+                }
+
+                try {
+                    UnoUndo.enterUndoContext(doc, "Create CSL bibliography");
+
+                    initializeCitationAdapter(doc);
+
+                    // Collect only cited entries from all databases
+                    List<BibEntry> citedEntries = new ArrayList<>();
+                    for (BibDatabase database : databases) {
+                        for (BibEntry entry : database.getEntries()) {
+                            if (cslCitationOOAdapter.isCitedEntry(entry)) {
+                                citedEntries.add(entry);
+                            }
+                        }
+                    }
+
+                    // If no entries are cited, show a message and return
+                    if (citedEntries.isEmpty()) {
+                        dialogService.showInformationDialogAndWait(
+                                Localization.lang("Bibliography"),
+                                Localization.lang("No cited entries found in the document.")
+                        );
+                        return;
+                    }
+
+                    // A separate database and database
+                    BibDatabase bibDatabase = new BibDatabase(citedEntries);
+                    BibDatabaseContext bibDatabaseContext = new BibDatabaseContext(bibDatabase);
+
+                    cslUpdateBibliography.rebuildCSLBibliography(doc, cslCitationOOAdapter, citedEntries, citationStyle, bibDatabaseContext, Injector.instantiateModelOrService(BibEntryTypesManager.class));
+
+                } catch (NoDocumentException
+                         | NoSuchElementException e) {
+                    throw new RuntimeException(e);
+                } finally {
+                    UnoUndo.leaveUndoContext(doc);
+                    fcursor.get().restore(doc);
+                }
             } catch (CreationException
                      | WrappedTargetException
                      | com.sun.star.lang.IllegalArgumentException ex) {
-                LOGGER.warn("Could not update bibliography", ex);
+                LOGGER.warn("Could not update CSL bibliography", ex);
                 OOError.fromMisc(ex).setTitle(errorTitle).showErrorDialog(dialogService);
             }
         }

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

@@ -62,6 +62,8 @@
 import org.jabref.preferences.PreferencesService;
 
 import com.sun.star.comp.helper.BootstrapException;
+import com.sun.star.container.NoSuchElementException;
+import com.sun.star.lang.WrappedTargetException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -121,6 +123,7 @@ public OpenOfficePanel(LibraryTabContainer tabContainer,
         this.stateManager = stateManager;
         this.clipBoardManager = clipBoardManager;
         this.undoManager = undoManager;
+        this.currentStyle = preferencesService.getOpenOfficePreferences().getCurrentStyle();
 
         ActionFactory factory = new ActionFactory();
 
@@ -143,7 +146,7 @@ public OpenOfficePanel(LibraryTabContainer tabContainer,
         selectDocument.setMaxWidth(Double.MAX_VALUE);
 
         update = new Button();
-        update.setGraphic(IconTheme.JabRefIcons.REFRESH.getGraphicNode());
+        update.setGraphic(IconTheme.JabRefIcons.ADD_OR_MAKE_BIBLIOGRAPHY.getGraphicNode());
         update.setTooltip(new Tooltip(Localization.lang("Sync OpenOffice/LibreOffice bibliography")));
         update.setMaxWidth(Double.MAX_VALUE);
 
@@ -195,7 +198,14 @@ private void initPanel() {
         manualConnect.setOnAction(e -> connectManually());
 
         selectDocument.setTooltip(new Tooltip(Localization.lang("Select which open Writer document to work on")));
-        selectDocument.setOnAction(e -> ooBase.guiActionSelectDocument(false));
+        selectDocument.setOnAction(e -> {
+            try {
+                ooBase.guiActionSelectDocument(false);
+            } catch (WrappedTargetException
+                     | NoSuchElementException ex) {
+                throw new RuntimeException(ex);
+            }
+        });
 
         setStyleFile.setMaxWidth(Double.MAX_VALUE);
         setStyleFile.setOnAction(event -> {
@@ -213,6 +223,7 @@ private void initPanel() {
                              } else if (currentStyle instanceof CitationStyle cslStyle) {
                                  dialogService.notify(Localization.lang("Currently selected CSL Style: '%0'", cslStyle.getName()));
                              }
+                             updateButtonAvailability();
                          });
         });
 
@@ -229,7 +240,7 @@ private void initPanel() {
         pushEntriesAdvanced.setOnAction(e -> pushEntries(CitationType.AUTHORYEAR_INTEXT, true));
         pushEntriesAdvanced.setMaxWidth(Double.MAX_VALUE);
 
-        update.setTooltip(new Tooltip(Localization.lang("Ensure that the bibliography is up-to-date")));
+        update.setTooltip(new Tooltip(Localization.lang("Make/Sync bibliography")));
 
         update.setOnAction(event -> {
             String title = Localization.lang("Could not update bibliography");
@@ -384,23 +395,25 @@ private void updateButtonAvailability() {
         pushEntries.setDisable(!(isConnectedToDocument && hasStyle && hasDatabase));
 
         boolean canCite = isConnectedToDocument && hasStyle && hasSelectedBibEntry;
+        boolean cslStyleSelected = preferencesService.getOpenOfficePreferences().getCurrentStyle() instanceof CitationStyle;
         pushEntriesInt.setDisable(!canCite);
         pushEntriesEmpty.setDisable(!canCite);
-        pushEntriesAdvanced.setDisable(!canCite);
+        pushEntriesAdvanced.setDisable(!canCite || cslStyleSelected);
 
         boolean canRefreshDocument = isConnectedToDocument && hasStyle;
+
         update.setDisable(!canRefreshDocument);
-        merge.setDisable(!canRefreshDocument);
-        unmerge.setDisable(!canRefreshDocument);
-        manageCitations.setDisable(!canRefreshDocument);
+        merge.setDisable(!canRefreshDocument || cslStyleSelected);
+        unmerge.setDisable(!canRefreshDocument || cslStyleSelected);
+        manageCitations.setDisable(!canRefreshDocument || cslStyleSelected);
 
-        exportCitations.setDisable(!(isConnectedToDocument && hasDatabase));
+        exportCitations.setDisable(!(isConnectedToDocument && hasDatabase) || cslStyleSelected);
     }
 
     private void connect() {
         Task<OOBibBase> connectTask = new Task<>() {
             @Override
-            protected OOBibBase call() throws Exception {
+            protected OOBibBase call() throws BootstrapException, CreationException {
                 updateProgress(ProgressBar.INDETERMINATE_PROGRESS, ProgressBar.INDETERMINATE_PROGRESS);
 
                 Path path = Path.of(preferencesService.getOpenOfficePreferences().getExecutablePath());
@@ -411,7 +424,12 @@ protected OOBibBase call() throws Exception {
         connectTask.setOnSucceeded(value -> {
             ooBase = connectTask.getValue();
 
-            ooBase.guiActionSelectDocument(true);
+            try {
+                ooBase.guiActionSelectDocument(true);
+            } catch (WrappedTargetException
+                     | NoSuchElementException e) {
+                throw new RuntimeException(e);
+            }
 
             // Enable actions that depend on a connection
             updateButtonAvailability();

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

@@ -191,6 +191,18 @@ private void initialize() {
             }
         });
 
+        OOStyle currentStyle = preferencesService.getOpenOfficePreferences().getCurrentStyle();
+        if (currentStyle instanceof JStyle) {
+            tabPane.getSelectionModel().select(1);
+        } else {
+            tabPane.getSelectionModel().select(0);
+        }
+
+        viewModel.setSelectedTab(tabPane.getSelectionModel().getSelectedItem());
+        tabPane.getSelectionModel().selectedItemProperty().addListener((observable, oldValue, newValue) -> {
+            viewModel.setSelectedTab(newValue);
+        });
+
         updateCurrentStyleLabel();
     }
 

src/main/java/org/jabref/logic/citationkeypattern/BracketedPattern.java

@@ -844,7 +844,7 @@ static String allAuthors(AuthorList authorList) {
      * @param authorList an {@link AuthorList}
      * @return the initials of all authors' names
      */
-    static String authorsAlpha(AuthorList authorList) {
+    public static String authorsAlpha(AuthorList authorList) {
         StringBuilder alphaStyle = new StringBuilder();
         int maxAuthors;
         final boolean maxAuthorsExceeded;
@@ -874,7 +874,7 @@ static String authorsAlpha(AuthorList authorList) {
             List<String> vonAndLastNames = authorList.getAuthors().stream()
                                                      .limit(maxAuthors)
                                                      .map(Author::getNamePrefixAndFamilyName)
-                                                     .collect(Collectors.toList());
+                                                     .toList();
             for (String vonAndLast : vonAndLastNames) {
                 // replace all whitespaces by " "
                 // split the lastname at " "
@@ -902,7 +902,7 @@ static String authorsAlpha(AuthorList authorList) {
      * @return a string consisting of authors' last names separated by a `delimiter` and with any authors excess of
      * `maxAuthors` replaced with `suffix`
      */
-    private static String joinAuthorsOnLastName(AuthorList authorList, int maxAuthors, String delimiter, final String suffix) {
+    public static String joinAuthorsOnLastName(AuthorList authorList, int maxAuthors, String delimiter, final String suffix) {
         final String finalSuffix = authorList.getNumberOfAuthors() > maxAuthors ? suffix : "";
         return authorList.getAuthors().stream()
                          .map(author -> {