AI chatting functionality

build.gradle

@@ -321,6 +321,8 @@ dependencies {
     // GemxFX also (transitively) depends on kotlin
     implementation 'org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.9.24'
 
+    implementation "one.jpro.platform:jpro-mdfx:0.3.3-SNAPSHOT"
+
     implementation ('com.squareup.okhttp3:okhttp:4.12.0') {
         exclude group: 'org.jetbrains.kotlin', module: 'kotlin-stdlib-jdk8'
     }

settings.gradle

@@ -1,5 +1,5 @@
 plugins {
-  id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0"
+    id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0"
 }
 
 rootProject.name = "JabRef"

src/main/java/module-info.java

@@ -157,4 +157,5 @@
     requires com.dlsc.unitfx;
     requires org.checkerframework.checker.qual;
     requires jakarta.validation;
+    requires one.jpro.platform.mdfx;
 }

src/main/java/org/jabref/gui/Base.css

@@ -1,4 +1,3 @@
-
 .root {
     -jr-row-odd-background: -fx-control-inner-background-alt;
     -jr-row-even-background: -fx-control-inner-background;
@@ -256,6 +255,34 @@
     /* AI chat style */
     -jr-ai-message-user: #7ee3fb;
     -jr-ai-message-ai: #bac8cb;
+
+    /* MarkdownViewer settings */
+    -mdfx-font-color: black;
+    -mdfx-link-color: blue;
+    -mdfx-border-color-1: #888;
+
+    -mdfx-bg-color-1: #ccc;
+    -mdfx-bg-color-2: #ddd;
+    -mdfx-bg-color-3: #eee;
+
+    -mdfx-bq-color-border: #4488cc; /* the blockquote's border color */
+    -mdfx-bq-color-background: #0000ff0c; /* the blockquote's background color */
+}
+
+.markdown-text {
+    -fx-font-family: sans-serif;
+}
+
+.markdown-italic {
+    -fx-font-style: italic;
+}
+
+.markdown-bold {
+    -fx-font-weight: bold;
+}
+
+.markdown-strikethrough {
+    -fx-strikethrough: true;
 }
 
 .unchanged {

src/main/java/org/jabref/gui/ai/components/JabRefMarkdownView.java

@@ -0,0 +1,12 @@
+package org.jabref.gui.entryeditor.aichattab.components;
+
+import one.jpro.platform.mdfx.MarkdownView;
+
+import java.util.List;
+
+public class JabRefMarkdownView extends MarkdownView {
+    @Override
+    protected List<String> getDefaultStylesheets() {
+        return List.of("Base.css");
+    }
+}

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.fxml

@@ -10,27 +10,36 @@
       <Insets bottom="10.0" left="10.0" right="10.0" top="10.0" />
    </padding>
    <children>
-      <ScrollPane fitToHeight="true" fitToWidth="true" style="-fx-border-color: black;" VBox.vgrow="ALWAYS">
-         <content>
-            <VBox fx:id="chatVBox" spacing="10.0">
-               <padding>
-                  <Insets bottom="10.0" left="10.0" right="10.0" top="10.0" />
-               </padding>
-               <children>
-               </children>
-            </VBox>
-         </content>
-      </ScrollPane>
+      <StackPane fx:id="stackPane" VBox.vgrow="ALWAYS">
+          <children>
+              <ScrollPane fx:id="scrollPane" fitToHeight="true" fitToWidth="true" style="-fx-border-color: black;">
+                  <content>
+                      <VBox fx:id="chatVBox" spacing="10.0">
+                          <padding>
+                              <Insets bottom="10.0" left="10.0" right="10.0" top="10.0" />
+                          </padding>
+                          <children>
+                          </children>
+                      </VBox>
+                  </content>
+              </ScrollPane>
+          </children>
+      </StackPane>
       <HBox alignment="CENTER" spacing="10.0">
          <children>
             <TextField fx:id="userPromptTextField" onAction="#internalSendMessageEvent" HBox.hgrow="ALWAYS" />
             <Button fx:id="submitButton" mnemonicParsing="false" onAction="#internalSendMessageEvent" text="%Submit" />
          </children>
       </HBox>
-      <BorderPane>
-         <center>
-            <Text strokeType="OUTSIDE" strokeWidth="0.0" text="%The AI may generate inaccurate or inappropriate responses. Please verify any information provided." BorderPane.alignment="CENTER" />
-         </center>
-      </BorderPane>
+      <HBox spacing="10.0">
+         <children>
+            <Button mnemonicParsing="false" onAction="#onClearChatHistoryClick" text="%Clear chat history" />
+            <BorderPane HBox.hgrow="ALWAYS">
+               <center>
+                  <Text strokeType="OUTSIDE" strokeWidth="0.0" text="%The AI may generate inaccurate or inappropriate responses. Please verify any information provided." BorderPane.alignment="CENTER" />
+               </center>
+            </BorderPane>
+         </children>
+      </HBox>
    </children>
 </fx:root>

src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.java

@@ -7,24 +7,38 @@
 import javafx.scene.Node;
 import javafx.scene.control.Button;
 import javafx.scene.control.ProgressIndicator;
+import javafx.scene.control.ScrollPane;
 import javafx.scene.control.TextField;
 import javafx.scene.layout.BorderPane;
+import javafx.scene.layout.StackPane;
 import javafx.scene.layout.VBox;
 
 import org.jabref.gui.ai.components.chatmessage.ChatMessageComponent;
 import org.jabref.logic.ai.chathistory.ChatMessage;
+import org.jabref.gui.DialogService;
+import org.jabref.gui.entryeditor.aichattab.components.chatmessage.ChatMessageComponent;
+import org.jabref.logic.ai.ChatMessage;
 
 import com.airhacks.afterburner.views.ViewLoader;
+import org.jabref.logic.l10n.Localization;
 
 public class AiChatComponent extends VBox {
     private final Consumer<String> sendMessageCallback;
+    private final Runnable clearChatHistoryCallback;
 
+    private final DialogService dialogService;
+
+    @FXML private ScrollPane scrollPane;
     @FXML private VBox chatVBox;
     @FXML private TextField userPromptTextField;
     @FXML private Button submitButton;
+    @FXML private StackPane stackPane;
 
-    public AiChatComponent(Consumer<String> sendMessageCallback) {
+    public AiChatComponent(Consumer<String> sendMessageCallback, Runnable clearChatHistoryCallback, DialogService dialogService) {
         this.sendMessageCallback = sendMessageCallback;
+        this.clearChatHistoryCallback = clearChatHistoryCallback;
+
+        this.dialogService = dialogService;
 
         ViewLoader.view(this)
                 .root(this)
@@ -33,37 +47,37 @@ public AiChatComponent(Consumer<String> sendMessageCallback) {
 
     @FXML
     public void initialize() {
+        scrollPane.needsLayoutProperty().addListener((observable, oldValue, newValue) -> {
+            if (!newValue) {
+                scrollPane.setVvalue(1.0);
+            }
+        });
+
         Platform.runLater(() -> userPromptTextField.requestFocus());
     }
 
     @FXML
     private void internalSendMessageEvent() {
         String userPrompt = userPromptTextField.getText();
-        userPromptTextField.clear();
-        sendMessageCallback.accept(userPrompt);
+
+        if (!userPrompt.isEmpty()) {
+            userPromptTextField.clear();
+            sendMessageCallback.accept(userPrompt);
+        }
     }
 
-    /**
-     * This method pushes a progress indicator into the chat box on true, and pops the last element in chat box on false.
-     * Be careful while using this method. If you called setLoading(true), then don't add any chat messages before you call setLoading(false).
-     */
     public void setLoading(boolean loading) {
         userPromptTextField.setDisable(loading);
         submitButton.setDisable(loading);
 
         if (loading) {
-            chatVBox.getChildren().add(makeProgressComponent());
+            stackPane.getChildren().add(new BorderPane(new ProgressIndicator()));
         } else {
-            if (!chatVBox.getChildren().isEmpty() && !(chatVBox.getChildren().getLast() instanceof ChatMessageComponent)) {
-                chatVBox.getChildren().removeLast();
-            }
+            stackPane.getChildren().clear();
+            stackPane.getChildren().add(scrollPane);
         }
     }
 
-    private Node makeProgressComponent() {
-        return new BorderPane(new ProgressIndicator());
-    }
-
     public void addMessage(ChatMessage chatMessage) {
         chatVBox.getChildren().add(new ChatMessageComponent().withChatMessage(chatMessage));
     }
@@ -75,4 +89,14 @@ public void addError(String message) {
     public void requestUserPromptTextFieldFocus() {
         userPromptTextField.requestFocus();
     }
+
+    @FXML
+    private void onClearChatHistoryClick() {
+        boolean result = dialogService.showConfirmationDialogAndWait(Localization.lang("Clear chat history"), Localization.lang("Are you sure you want to clear the chat history with this library entry?"));
+
+        if (result) {
+            chatVBox.getChildren().clear();
+            clearChatHistoryCallback.run();
+        }
+    }
 }

src/main/java/org/jabref/gui/ai/components/chatmessage/ChatMessageComponent.fxml

@@ -5,6 +5,9 @@
 <?import javafx.scene.layout.*?>
 <?import javafx.scene.text.*?>
 
+<?import one.jpro.platform.mdfx.MarkdownView?>
+<?import org.jabref.gui.entryeditor.aichattab.components.JabRefMarkdownView?>
+
 <fx:root nodeOrientation="LEFT_TO_RIGHT" type="javafx.scene.layout.Pane" xmlns="https://javafx.com/javafx/17.0.2-ea" xmlns:fx="https://javafx.com/fxml/1" fx:controller="org.jabref.gui.ai.components.chatmessage.ChatMessageComponent">
     <children>
         <VBox fx:id="vBox" maxWidth="500.0" spacing="10.0">
@@ -17,7 +20,7 @@
                         <Font name="System Bold" size="12.0" />
                     </font>
                 </Label>
-                <TextArea fx:id="contentTextArea" editable="false" text="Content" wrapText="true" />
+                <JabRefMarkdownView fx:id="contentMarkdownView" mdString="Content" />
             </children>
       </VBox>
     </children>

src/main/java/org/jabref/gui/ai/components/chatmessage/ChatMessageComponent.java

@@ -8,14 +8,17 @@
 import javafx.scene.layout.VBox;
 
 import org.jabref.logic.ai.chathistory.ChatMessage;
+import org.jabref.gui.entryeditor.aichattab.components.JabRefMarkdownView;
+import org.jabref.logic.ai.ChatMessage;
 import org.jabref.logic.l10n.Localization;
 
 import com.airhacks.afterburner.views.ViewLoader;
+import one.jpro.platform.mdfx.MarkdownView;
 
 public class ChatMessageComponent extends HBox {
     @FXML private VBox vBox;
     @FXML private Label sourceLabel;
-    @FXML private TextArea contentTextArea;
+    @FXML private JabRefMarkdownView contentMarkdownView;
 
     public ChatMessageComponent() {
         ViewLoader.view(this)
@@ -25,15 +28,15 @@ public ChatMessageComponent() {
 
     public ChatMessageComponent withChatMessage(ChatMessage chatMessage) {
         sourceLabel.setText(chatMessage.getTypeLabel());
-        contentTextArea.setText(chatMessage.getContent());
+        contentMarkdownView.setMdString(chatMessage.getContent());
 
         switch (chatMessage.getType()) {
             case USER:
-                vBox.setStyle("-fx-background-color: -jr-ai-message-user;");
+                setColor("-jr-ai-message-user");
                 setNodeOrientation(NodeOrientation.RIGHT_TO_LEFT);
                 break;
             case ASSISTANT:
-                vBox.setStyle("-fx-background-color: -jr-ai-message-ai;");
+                setColor("-jr-ai-message-ai");
                 setNodeOrientation(NodeOrientation.LEFT_TO_RIGHT);
                 break;
         }
@@ -43,7 +46,7 @@ public ChatMessageComponent withChatMessage(ChatMessage chatMessage) {
 
     public ChatMessageComponent withError(String message) {
         sourceLabel.setText(Localization.lang("Error"));
-        contentTextArea.setText(message);
+        contentMarkdownView.setMdString(message);
         vBox.setStyle("-fx-background-color: -jr-red;");
         return this;
     }
@@ -56,12 +59,12 @@ public void setSourceLabel(String sourceLabel) {
         this.sourceLabel.setText(sourceLabel);
     }
 
-    public String getContentTextArea() {
-        return contentTextArea.getText();
+    public String getContent() {
+        return contentMarkdownView.getMdString();
     }
 
-    public void setContentTextArea(String contentTextArea) {
-        this.contentTextArea.setText(contentTextArea);
+    public void setContent(String contentTextArea) {
+        contentMarkdownView.setMdString(contentTextArea);
     }
 
     public void setColor(String color) {

src/main/java/org/jabref/gui/entryeditor/AiChatTab.java

@@ -211,7 +211,12 @@ private void buildChatUI(BibEntry entry) {
                         aiChatComponent.addError(e.getMessage());
                     })
                     .executeWith(taskExecutor);
-        });
+        }, () -> {
+            if (bibDatabaseChats != null) {
+                assert entry.getCitationKey().isPresent();
+                bibDatabaseChats.clearMessagesForEntry(entry.getCitationKey().get());
+            }
+        }, dialogService);
 
         if (bibDatabaseChatHistory != null) {
             bibDatabaseChatHistory.getAllMessagesForEntry(entry.getCitationKey().get()).forEach(aiChatComponent::addMessage);

src/main/java/org/jabref/logic/ai/chathistory/BibDatabaseChatHistory.java

@@ -45,6 +45,19 @@ public void addMessage(String citationKey, ChatMessage message) {
         this.messageCitationKey.put(id, citationKey);
     }
 
+    public void clearMessagesForEntry(String citationKey) {
+        messageCitationKey
+                .entrySet()
+                .stream()
+                .filter(integerStringEntry -> integerStringEntry.getValue().equals(citationKey))
+                .map(Map.Entry::getKey)
+                .forEach(id -> {
+                    messageType.remove(id);
+                    messageContent.remove(id);
+                    messageCitationKey.remove(id);
+                });
+    }
+
     public void close() {
         this.mvStore.close();
     }