From 34ef64ef62d0ca49e0a0b4b3156b2c18c12b7666 Mon Sep 17 00:00:00 2001
From: Oliver Kopp <kopp.dev@gmail.com>
Date: Tue, 9 Jan 2024 15:10:51 +0100
Subject: [PATCH] Add property for recheck of attached files

---
 CHANGELOG.md                                      |  1 +
 .../preferences/linkedfiles/LinkedFilesTab.fxml   |  1 +
 .../preferences/linkedfiles/LinkedFilesTab.java   |  3 +++
 .../linkedfiles/LinkedFilesTabViewModel.java      |  7 +++++++
 .../org/jabref/preferences/FilePreferences.java   | 15 +++++++++++++++
 .../org/jabref/preferences/JabRefPreferences.java |  6 ++++++
 src/main/resources/l10n/JabRef_en.properties      |  1 +
 7 files changed, 34 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 744c6d801b0..ca551a0beb2 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -12,6 +12,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 ### Added
 
 - When importing entries form the "Citation relations" tab, the field [cites](https://docs.jabref.org/advanced/entryeditor/entrylinks) is now filled according to the relationship between the entries. [#10572](https://github.com/JabRef/jabref/pull/10752)
+- Added a configuration option to enable fulltext search not checking all attached files upon start for modifications (disabled as default).
 
 ### Changed
 
diff --git a/src/main/java/org/jabref/gui/preferences/linkedfiles/LinkedFilesTab.fxml b/src/main/java/org/jabref/gui/preferences/linkedfiles/LinkedFilesTab.fxml
index 0f26e9890e7..d644f571fab 100644
--- a/src/main/java/org/jabref/gui/preferences/linkedfiles/LinkedFilesTab.fxml
+++ b/src/main/java/org/jabref/gui/preferences/linkedfiles/LinkedFilesTab.fxml
@@ -57,6 +57,7 @@
 
     <Label styleClass="sectionHeader" text="%Fulltext Index"/>
     <CheckBox fx:id="fulltextIndex" text="%Automatically index all linked files for fulltext search"/>
+    <CheckBox fx:id="fulltextIndexLinkedFilesShouldCheckForModifications" text="%Indexed files should be checked for modifications on startup"/>
 
     <Label styleClass="sectionHeader" text="%Linked file name conventions"/>
     <GridPane hgap="4.0" vgap="4.0">
diff --git a/src/main/java/org/jabref/gui/preferences/linkedfiles/LinkedFilesTab.java b/src/main/java/org/jabref/gui/preferences/linkedfiles/LinkedFilesTab.java
index 83325c8e3f2..f484744d20f 100644
--- a/src/main/java/org/jabref/gui/preferences/linkedfiles/LinkedFilesTab.java
+++ b/src/main/java/org/jabref/gui/preferences/linkedfiles/LinkedFilesTab.java
@@ -34,6 +34,7 @@ public class LinkedFilesTab extends AbstractPreferenceTabView<LinkedFilesTabView
     @FXML private TextField autolinkRegexKey;
 
     @FXML private CheckBox fulltextIndex;
+    @FXML private CheckBox fulltextIndexLinkedFilesShouldCheckForModifications;
 
     @FXML private ComboBox<String> fileNamePattern;
     @FXML private TextField fileDirectoryPattern;
@@ -66,6 +67,8 @@ public void initialize() {
         autolinkRegexKey.textProperty().bindBidirectional(viewModel.autolinkRegexKeyProperty());
         autolinkRegexKey.disableProperty().bind(autolinkUseRegex.selectedProperty().not());
         fulltextIndex.selectedProperty().bindBidirectional(viewModel.fulltextIndexProperty());
+        fulltextIndexLinkedFilesShouldCheckForModifications.selectedProperty().bindBidirectional(viewModel.fulltextIndexLinkedFilesShouldCheckForModificationsProperty());
+        fulltextIndexLinkedFilesShouldCheckForModifications.disableProperty().bind(fulltextIndex.selectedProperty().not());
         fileNamePattern.valueProperty().bindBidirectional(viewModel.fileNamePatternProperty());
         fileNamePattern.itemsProperty().bind(viewModel.defaultFileNamePatternsProperty());
         fileDirectoryPattern.textProperty().bindBidirectional(viewModel.fileDirectoryPatternProperty());
diff --git a/src/main/java/org/jabref/gui/preferences/linkedfiles/LinkedFilesTabViewModel.java b/src/main/java/org/jabref/gui/preferences/linkedfiles/LinkedFilesTabViewModel.java
index d020b267179..f052b68d762 100644
--- a/src/main/java/org/jabref/gui/preferences/linkedfiles/LinkedFilesTabViewModel.java
+++ b/src/main/java/org/jabref/gui/preferences/linkedfiles/LinkedFilesTabViewModel.java
@@ -37,6 +37,7 @@ public class LinkedFilesTabViewModel implements PreferenceTabViewModel {
     private final ListProperty<String> defaultFileNamePatternsProperty =
             new SimpleListProperty<>(FXCollections.observableArrayList(FilePreferences.DEFAULT_FILENAME_PATTERNS));
     private final BooleanProperty fulltextIndex = new SimpleBooleanProperty();
+    private final BooleanProperty fulltextIndexLinkedFilesShouldCheckForModifications = new SimpleBooleanProperty();
     private final StringProperty fileNamePatternProperty = new SimpleStringProperty();
     private final StringProperty fileDirectoryPatternProperty = new SimpleStringProperty();
 
@@ -78,6 +79,7 @@ public void setValues() {
         useMainFileDirectoryProperty.setValue(!filePreferences.shouldStoreFilesRelativeToBibFile());
         useBibLocationAsPrimaryProperty.setValue(filePreferences.shouldStoreFilesRelativeToBibFile());
         fulltextIndex.setValue(filePreferences.shouldFulltextIndexLinkedFiles());
+        fulltextIndexLinkedFilesShouldCheckForModifications.setValue(filePreferences.shouldFulltextIndexLinkedFilesShouldCheckForModifications());
         fileNamePatternProperty.setValue(filePreferences.getFileNamePattern());
         fileDirectoryPatternProperty.setValue(filePreferences.getFileDirectoryPattern());
 
@@ -99,6 +101,7 @@ public void storeSettings() {
         filePreferences.setFileNamePattern(fileNamePatternProperty.getValue());
         filePreferences.setFileDirectoryPattern(fileDirectoryPatternProperty.getValue());
         filePreferences.setFulltextIndexLinkedFiles(fulltextIndex.getValue());
+        filePreferences.setFulltextIndexLinkedFilesShouldCheckForModifications(fulltextIndexLinkedFilesShouldCheckForModifications.getValue());
 
         // Autolink preferences
         if (autolinkFileStartsBibtexProperty.getValue()) {
@@ -163,6 +166,10 @@ public BooleanProperty fulltextIndexProperty() {
         return fulltextIndex;
     }
 
+    public BooleanProperty fulltextIndexLinkedFilesShouldCheckForModificationsProperty() {
+        return fulltextIndexLinkedFilesShouldCheckForModifications;
+    }
+
     public ListProperty<String> defaultFileNamePatternsProperty() {
         return defaultFileNamePatternsProperty;
     }
diff --git a/src/main/java/org/jabref/preferences/FilePreferences.java b/src/main/java/org/jabref/preferences/FilePreferences.java
index e937943fcca..f82869ca6a0 100644
--- a/src/main/java/org/jabref/preferences/FilePreferences.java
+++ b/src/main/java/org/jabref/preferences/FilePreferences.java
@@ -32,6 +32,7 @@ public class FilePreferences {
     private final StringProperty fileDirectoryPattern = new SimpleStringProperty();
     private final BooleanProperty downloadLinkedFiles = new SimpleBooleanProperty();
     private final BooleanProperty fulltextIndexLinkedFiles = new SimpleBooleanProperty();
+    private final BooleanProperty fulltextIndexLinkedFilesShouldCheckForModifications = new SimpleBooleanProperty();
     private final ObjectProperty<Path> workingDirectory = new SimpleObjectProperty<>();
     private final ObservableSet<ExternalFileType> externalFileTypes = FXCollections.observableSet(new TreeSet<>(Comparator.comparing(ExternalFileType::getName)));
     private final BooleanProperty createBackup = new SimpleBooleanProperty();
@@ -44,6 +45,7 @@ public FilePreferences(String userAndHost,
                            String fileDirectoryPattern,
                            boolean downloadLinkedFiles,
                            boolean fulltextIndexLinkedFiles,
+                           boolean fulltextIndexLinkedFilesShouldCheckForModifications,
                            Path workingDirectory,
                            Set<ExternalFileType> externalFileTypes,
                            boolean createBackup,
@@ -55,6 +57,7 @@ public FilePreferences(String userAndHost,
         this.fileDirectoryPattern.setValue(fileDirectoryPattern);
         this.downloadLinkedFiles.setValue(downloadLinkedFiles);
         this.fulltextIndexLinkedFiles.setValue(fulltextIndexLinkedFiles);
+        this.fulltextIndexLinkedFilesShouldCheckForModifications.setValue(fulltextIndexLinkedFilesShouldCheckForModifications);
         this.workingDirectory.setValue(workingDirectory);
         this.externalFileTypes.addAll(externalFileTypes);
         this.createBackup.setValue(createBackup);
@@ -141,6 +144,18 @@ public void setFulltextIndexLinkedFiles(boolean shouldFulltextIndexLinkedFiles)
         this.fulltextIndexLinkedFiles.set(shouldFulltextIndexLinkedFiles);
     }
 
+    public boolean shouldFulltextIndexLinkedFilesShouldCheckForModifications() {
+        return fulltextIndexLinkedFilesShouldCheckForModifications.get();
+    }
+
+    public BooleanProperty fulltextIndexLinkedFilesShouldCheckForModifications() {
+        return fulltextIndexLinkedFilesShouldCheckForModifications;
+    }
+
+    public void setFulltextIndexLinkedFilesShouldCheckForModifications(boolean shouldFulltextIndexLinkedFilesShouldCheckForModifications) {
+        this.fulltextIndexLinkedFilesShouldCheckForModifications.set(shouldFulltextIndexLinkedFilesShouldCheckForModifications);
+    }
+
     public Path getWorkingDirectory() {
         return workingDirectory.get();
     }
diff --git a/src/main/java/org/jabref/preferences/JabRefPreferences.java b/src/main/java/org/jabref/preferences/JabRefPreferences.java
index 30670250f62..01d74a4971b 100644
--- a/src/main/java/org/jabref/preferences/JabRefPreferences.java
+++ b/src/main/java/org/jabref/preferences/JabRefPreferences.java
@@ -421,7 +421,9 @@ public class JabRefPreferences implements PreferencesService {
     // Dialog states
     private static final String PREFS_EXPORT_PATH = "prefsExportPath";
     private static final String DOWNLOAD_LINKED_FILES = "downloadLinkedFiles";
+
     private static final String FULLTEXT_INDEX_LINKED_FILES = "fulltextIndexLinkedFiles";
+    private static final String FULLTEXT_INDEX_LINKED_FILES_SHOULD_CHECK_FOR_MODIFICATIONS = "fulltextIndexLinkedFilesShouldCheckForModifications";
 
     // Helper string
     private static final String USER_HOME = System.getProperty("user.home");
@@ -764,6 +766,8 @@ private JabRefPreferences() {
         defaults.put(DOWNLOAD_LINKED_FILES, true);
         // Create Fulltext-Index by default
         defaults.put(FULLTEXT_INDEX_LINKED_FILES, true);
+        // On JabRef startup, do not check for modifications by default
+        defaults.put(FULLTEXT_INDEX_LINKED_FILES_SHOULD_CHECK_FOR_MODIFICATIONS, false);
 
         String defaultExpression = "**/.*[citationkey].*\\\\.[extension]";
         defaults.put(AUTOLINK_REG_EXP_SEARCH_EXPRESSION_KEY, defaultExpression);
@@ -2186,6 +2190,7 @@ public FilePreferences getFilePreferences() {
                 get(IMPORT_FILEDIRPATTERN),
                 getBoolean(DOWNLOAD_LINKED_FILES),
                 getBoolean(FULLTEXT_INDEX_LINKED_FILES),
+                getBoolean(FULLTEXT_INDEX_LINKED_FILES_SHOULD_CHECK_FOR_MODIFICATIONS),
                 Path.of(get(WORKING_DIRECTORY)),
                 ExternalFileTypes.fromString(get(EXTERNAL_FILE_TYPES)),
                 getBoolean(CREATE_BACKUP),
@@ -2198,6 +2203,7 @@ public FilePreferences getFilePreferences() {
         EasyBind.listen(filePreferences.fileDirectoryPatternProperty(), (obs, oldValue, newValue) -> put(IMPORT_FILEDIRPATTERN, newValue));
         EasyBind.listen(filePreferences.downloadLinkedFilesProperty(), (obs, oldValue, newValue) -> putBoolean(DOWNLOAD_LINKED_FILES, newValue));
         EasyBind.listen(filePreferences.fulltextIndexLinkedFilesProperty(), (obs, oldValue, newValue) -> putBoolean(FULLTEXT_INDEX_LINKED_FILES, newValue));
+        EasyBind.listen(filePreferences.fulltextIndexLinkedFilesShouldCheckForModifications(), (obs, oldValue, newValue) -> putBoolean(FULLTEXT_INDEX_LINKED_FILES_SHOULD_CHECK_FOR_MODIFICATIONS, newValue));
         EasyBind.listen(filePreferences.workingDirectoryProperty(), (obs, oldValue, newValue) -> put(WORKING_DIRECTORY, newValue.toString()));
         filePreferences.getExternalFileTypes().addListener((SetChangeListener<ExternalFileType>) c ->
                 put(EXTERNAL_FILE_TYPES, ExternalFileTypes.toStringList(filePreferences.getExternalFileTypes())));
diff --git a/src/main/resources/l10n/JabRef_en.properties b/src/main/resources/l10n/JabRef_en.properties
index 3e766da2048..9b1145d78f2 100644
--- a/src/main/resources/l10n/JabRef_en.properties
+++ b/src/main/resources/l10n/JabRef_en.properties
@@ -2459,6 +2459,7 @@ Select\ directory=Select directory
 
 Fulltext\ Index=Fulltext Index
 Automatically\ index\ all\ linked\ files\ for\ fulltext\ search=Automatically index all linked files for fulltext search
+Indexed\ files\ should\ be\ checked\ for\ modifications\ on\ startup=Indexed files should be checked for modifications on startup
 Rebuild\ fulltext\ search\ index=Rebuild fulltext search index
 Rebuild\ fulltext\ search\ index\ for\ current\ library?=Rebuild fulltext search index for current library?
 Rebuilding\ fulltext\ search\ index...=Rebuilding fulltext search index...