Fix for issue #4652: Add Find Unlinked Files Filter based on Date

CHANGELOG.md

@@ -14,6 +14,9 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
 - We added a progress counter to the title bar in Possible Duplicates dialog window. [#7366](https://github.com/JabRef/jabref/issues/7366)
 - We added new "Customization" tab to the preferences which includes option to choose a custom address for DOI access. [#7337](https://github.com/JabRef/jabref/issues/7337)
 - We added zbmath to the public databases from which the bibliographic information of an existing entry can be updated. [#7437](https://github.com/JabRef/jabref/issues/7437)
+- We showed to the find Unlinked Files Dialog the date of the files' most recent modification. [#4652](https://github.com/JabRef/jabref/issues/4652)
+- We added to the find Unlinked Files function a filter to show only files based on date of last modification (Last Year, Last Month, Last Week, Last Day). [#4652](https://github.com/JabRef/jabref/issues/4652)
+- We added to the find Unlinked Files function a filter that sorts the files based on the date of last modification(Sort by Newest, Sort by Oldest First). [#4652](https://github.com/JabRef/jabref/issues/4652)
 - We added the possibility to add a new entry via its zbMath ID (zbMATH can be chosen as ID type in the "Select entry type" window). [#7202](https://github.com/JabRef/jabref/issues/7202)
 - We added the extension support and the external application support (For Texshow, Texmaker and LyX) to the flatpak [#7248](https://github.com/JabRef/jabref/pull/7248)
 - We added some symbols and keybindings to the context menu in the entry editor. [#7268](https://github.com/JabRef/jabref/pull/7268)

src/main/java/org/jabref/gui/externalfiles/DateRange.java

@@ -0,0 +1,21 @@
+package org.jabref.gui.externalfiles;
+
+import org.jabref.logic.l10n.Localization;
+
+public enum DateRange {
+    DAY(Localization.lang("Last day")),
+    WEEK(Localization.lang("Last week")),
+    MONTH(Localization.lang("Last month")),
+    YEAR(Localization.lang("Last year")),
+    ALL_TIME(Localization.lang("All time"));
+
+    private final String dateRange;
+
+    DateRange(String dateRange) { 
+       this.dateRange = dateRange;
+    }
+
+    public String getDateRange() {
+        return dateRange; 
+    } 
+}

src/main/java/org/jabref/gui/externalfiles/ExternalFileSorter.java

@@ -0,0 +1,19 @@
+package org.jabref.gui.externalfiles;
+
+import org.jabref.logic.l10n.Localization;
+
+public enum ExternalFileSorter {
+    DEFAULT(Localization.lang("Default")),
+    DATE_ASCENDING(Localization.lang("Newest first")),
+    DATE_DESCENDING(Localization.lang("Oldest first"));
+
+    private final String sorter;
+
+    ExternalFileSorter(String sorter) {
+        this.sorter = sorter;
+    }
+
+    public String getSorter() {
+        return sorter;
+    }
+}

src/main/java/org/jabref/gui/externalfiles/ExternalFilesDateViewModel.java

@@ -0,0 +1,20 @@
+package org.jabref.gui.externalfiles;
+
+public class ExternalFilesDateViewModel {
+
+    private final String description;
+    private final DateRange dateRange;
+
+    ExternalFilesDateViewModel(DateRange dateRange) {
+        this.description = dateRange.getDateRange();
+        this.dateRange = dateRange;
+    }
+
+    public String getDescription() {
+        return this.description;
+    }
+
+    public DateRange getDateRanges() {
+        return this.dateRange;
+    }
+}

src/main/java/org/jabref/gui/externalfiles/FileFilterUtils.java

@@ -0,0 +1,113 @@
+package org.jabref.gui.externalfiles;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.attribute.FileTime;
+import java.time.LocalDateTime;
+import java.time.ZoneId;
+import java.util.Comparator;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class FileFilterUtils {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(FileFilterUtils.class);
+
+    /* Returns the last edited time of a file as LocalDateTime. */
+    public static LocalDateTime getFileTime(Path path) {
+        FileTime lastEditedTime = null;
+        try {
+            lastEditedTime = Files.getLastModifiedTime(path);
+        } catch (IOException e) {
+            LOGGER.error("Could not retrieve file time", e);
+        }
+        LocalDateTime localDateTime = lastEditedTime
+                .toInstant()
+                .atZone(ZoneId.systemDefault())
+                .toLocalDateTime();
+        return localDateTime;
+    }
+
+    /* Returns true if a file with a specific path 
+     * was edited during the last 24 hours. */
+    public boolean isDuringLastDay(LocalDateTime fileEditTime) {
+        LocalDateTime NOW = LocalDateTime.now(ZoneId.systemDefault());
+        return fileEditTime.isAfter(NOW.minusHours(24));
+    }
+
+    /* Returns true if a file with a specific path 
+     * was edited during the last 7 days. */
+    public boolean isDuringLastWeek(LocalDateTime fileEditTime) {
+        LocalDateTime NOW = LocalDateTime.now(ZoneId.systemDefault());
+        return fileEditTime.isAfter(NOW.minusDays(7));
+    }
+
+    /* Returns true if a file with a specific path 
+     * was edited during the last 30 days. */
+    public boolean isDuringLastMonth(LocalDateTime fileEditTime) {
+        LocalDateTime NOW = LocalDateTime.now(ZoneId.systemDefault());
+        return fileEditTime.isAfter(NOW.minusDays(30));
+    }
+
+    /* Returns true if a file with a specific path 
+     * was edited during the last 365 days. */
+    public boolean isDuringLastYear(LocalDateTime fileEditTime) {
+        LocalDateTime NOW = LocalDateTime.now(ZoneId.systemDefault());
+        return fileEditTime.isAfter(NOW.minusDays(365));
+    }
+
+    /* Returns true if a file is edited in the time margin specified by the given filter. */
+    public static boolean filterByDate(Path path, ExternalFilesDateViewModel filter) {
+        FileFilterUtils fileFilter = new FileFilterUtils();
+        LocalDateTime fileTime = FileFilterUtils.getFileTime(path);
+        boolean isInDateRange = switch (filter.getDateRanges()) {
+            case DAY -> fileFilter.isDuringLastDay(fileTime);
+            case WEEK -> fileFilter.isDuringLastWeek(fileTime);
+            case MONTH -> fileFilter.isDuringLastMonth(fileTime);
+            case YEAR -> fileFilter.isDuringLastYear(fileTime);
+            case ALL_TIME -> true;
+            default -> true;
+        };
+        return isInDateRange;
+    }
+
+    /* Sorts a list of Path objects according to the last edited date 
+     * of their corresponding files, from newest to oldest. */
+    public List<Path> sortByDateAscending(List<Path> files) {
+        return files.stream()
+                .sorted(Comparator.comparingLong(file -> FileFilterUtils.getFileTime(file)
+                        .atZone(ZoneId.systemDefault())
+                        .toInstant()
+                        .toEpochMilli()))
+                .collect(Collectors.toList());
+    }
+
+    /* Sorts a list of Path objects according to the last edited date 
+     * of their corresponding files, from oldest to newest. */
+    public List<Path> sortByDateDescending(List<Path> files) {
+        return files.stream()
+                .sorted(Comparator.comparingLong(file -> -FileFilterUtils.getFileTime(file)
+                        .atZone(ZoneId.systemDefault())
+                        .toInstant()
+                        .toEpochMilli()))
+                .collect(Collectors.toList());
+    }
+
+    /* Sorts a list of Path objects according to the last edited date
+     * the order depends on the specified sorter type. */
+    public static List<Path> sortByDate(List<Path> files, FileSortViewModel sortType) {
+        FileFilterUtils fileFilter = new FileFilterUtils();
+        List<Path> sortedFiles = switch (sortType.getSorter()) {
+            case DEFAULT -> files;
+            case DATE_ASCENDING -> fileFilter.sortByDateDescending(files);
+            case DATE_DESCENDING -> fileFilter.sortByDateAscending(files);
+            default -> files;
+        };
+        return sortedFiles;
+    }
+}
+

src/main/java/org/jabref/gui/externalfiles/FileSortViewModel.java

@@ -0,0 +1,20 @@
+package org.jabref.gui.externalfiles;
+
+public class FileSortViewModel {
+
+    private final ExternalFileSorter sorter;
+    private final String description;
+
+    public FileSortViewModel(ExternalFileSorter sorter) {
+        this.sorter = sorter;
+        this.description = sorter.getSorter();
+    }
+
+    public String getDescription() {
+        return this.description;
+    }
+
+    public ExternalFileSorter getSorter() {
+        return this.sorter;
+    }
+}

src/main/java/org/jabref/gui/externalfiles/UnlinkedFilesCrawler.java

@@ -32,12 +32,16 @@ public class UnlinkedFilesCrawler extends BackgroundTask<FileNodeViewModel> {
 
     private final Path directory;
     private final Filter<Path> fileFilter;
+    private final ExternalFilesDateViewModel dateFilter;
+    private final FileSortViewModel sorter;
     private final BibDatabaseContext databaseContext;
     private final FilePreferences filePreferences;
 
-    public UnlinkedFilesCrawler(Path directory, Filter<Path> fileFilter, BibDatabaseContext databaseContext, FilePreferences filePreferences) {
+    public UnlinkedFilesCrawler(Path directory, Filter<Path> fileFilter, ExternalFilesDateViewModel dateFilter, FileSortViewModel sorter, BibDatabaseContext databaseContext, FilePreferences filePreferences) {
         this.directory = directory;
         this.fileFilter = fileFilter;
+        this.dateFilter = dateFilter;
+        this.sorter = sorter;
         this.databaseContext = databaseContext;
         this.filePreferences = filePreferences;
     }
@@ -61,6 +65,9 @@ protected FileNodeViewModel call() throws IOException {
      * For ensuring the capability to cancel the work of this recursive method, the first position in the integer array
      * 'state' must be set to 1, to keep the recursion running. When the states value changes, the method will resolve
      * its recursion and return what it has saved so far.
+     * <br>
+     * The files are filtered according to the {@link DateRange} filter value 
+     * and then sorted according to the {@link ExternalFileSorter} value.
      *
      * @throws IOException if directory is not a directory or empty
      */
@@ -92,11 +99,19 @@ private FileNodeViewModel searchDirectory(Path directory, UnlinkedPDFFileFilter
                 parent.getChildren().add(subRoot);
             }
         }
-
-        parent.setFileCount(files.size() + fileCount);
-        parent.getChildren().addAll(files.stream()
-                                         .map(FileNodeViewModel::new)
-                                         .collect(Collectors.toList()));
+        // filter files according to last edited date.
+        List<Path> filteredFiles = new ArrayList<Path>();
+        for (Path path : files) {
+            if (FileFilterUtils.filterByDate(path, dateFilter)) {
+                filteredFiles.add(path);
+            }
+        }
+        // sort files according to last edited date.
+        filteredFiles = FileFilterUtils.sortByDate(filteredFiles, sorter);
+        parent.setFileCount(filteredFiles.size() + fileCount);
+        parent.getChildren().addAll(filteredFiles.stream()
+                .map(FileNodeViewModel::new)
+                .collect(Collectors.toList()));
         return parent;
     }
 }

src/main/java/org/jabref/gui/externalfiles/UnlinkedFilesDialog.fxml

@@ -52,8 +52,12 @@
 
                 <Label text="%File type" GridPane.columnIndex="0" GridPane.rowIndex="1"/>
                 <ComboBox fx:id="fileTypeCombo" maxWidth="Infinity" GridPane.columnIndex="1" GridPane.rowIndex="1"/>
+                <Label text="%Last edited:" GridPane.columnIndex="0" GridPane.rowIndex="2"/>
+                <ComboBox fx:id="fileDateCombo" maxWidth="Infinity" GridPane.columnIndex="1" GridPane.rowIndex="2"/>
+                <Label text="%Sort by:" GridPane.columnIndex="0" GridPane.rowIndex="3"/>
+                <ComboBox fx:id="fileSortCombo" maxWidth="Infinity" GridPane.columnIndex="1" GridPane.rowIndex="3"/>
                 <Button fx:id="scanButton" onAction="#scanFiles" text="%Search"
-                        GridPane.columnIndex="2" GridPane.rowIndex="1">
+                        GridPane.columnIndex="2" GridPane.rowIndex="3">
                     <tooltip>
                         <Tooltip text="%Searches the selected directory for unlinked files."/>
                     </tooltip>

src/main/java/org/jabref/gui/externalfiles/UnlinkedFilesDialogView.java

@@ -54,6 +54,8 @@ public class UnlinkedFilesDialogView extends BaseDialog<Void> {
 
     @FXML private TextField directoryPathField;
     @FXML private ComboBox<FileExtensionViewModel> fileTypeCombo;
+    @FXML private ComboBox<ExternalFilesDateViewModel> fileDateCombo;
+    @FXML private ComboBox<FileSortViewModel> fileSortCombo;
     @FXML private CheckTreeView<FileNodeViewModel> unlinkedFilesList;
     @FXML private Button scanButton;
     @FXML private Button exportButton;
@@ -141,11 +143,23 @@ private void initDirectorySelection() {
         fileTypeCombo.setItems(viewModel.getFileFilters());
         fileTypeCombo.valueProperty().bindBidirectional(viewModel.selectedExtensionProperty());
         fileTypeCombo.getSelectionModel().selectFirst();
+        new ViewModelListCellFactory<ExternalFilesDateViewModel>()
+            .withText(ExternalFilesDateViewModel::getDescription)
+            .install(fileDateCombo);
+        fileDateCombo.setItems(viewModel.getDateFilters());
+        fileDateCombo.valueProperty().bindBidirectional(viewModel.selectedDateProperty());
+        fileDateCombo.getSelectionModel().selectFirst();
+        new ViewModelListCellFactory<FileSortViewModel>()
+                .withText(FileSortViewModel::getDescription)
+                .install(fileSortCombo);
+        fileSortCombo.setItems(viewModel.getSorters());
+        fileSortCombo.valueProperty().bindBidirectional(viewModel.selectedSortProperty());
+        fileSortCombo.getSelectionModel().selectFirst();
     }
 
     private void initUnlinkedFilesList() {
         new ViewModelTreeCellFactory<FileNodeViewModel>()
-                .withText(FileNodeViewModel::getDisplayText)
+                .withText(FileNodeViewModel::getDisplayTextWithEditDate)
                 .install(unlinkedFilesList);
 
         unlinkedFilesList.maxHeightProperty().bind(((Control) filePane.contentProperty().get()).heightProperty());

src/main/java/org/jabref/gui/externalfiles/UnlinkedFilesDialogViewModel.java

@@ -55,6 +55,8 @@ public class UnlinkedFilesDialogViewModel {
     private final ImportHandler importHandler;
     private final StringProperty directoryPath = new SimpleStringProperty("");
     private final ObjectProperty<FileExtensionViewModel> selectedExtension = new SimpleObjectProperty<>();
+    private final ObjectProperty<ExternalFilesDateViewModel> selectedDate = new SimpleObjectProperty<>();
+    private final ObjectProperty<FileSortViewModel> selectedSort = new SimpleObjectProperty<>();
 
     private final ObjectProperty<Optional<FileNodeViewModel>> treeRootProperty = new SimpleObjectProperty<>();
     private final SimpleListProperty<TreeItem<FileNodeViewModel>> checkedFileListProperty = new SimpleListProperty<>(FXCollections.observableArrayList());
@@ -65,6 +67,9 @@ public class UnlinkedFilesDialogViewModel {
 
     private final ObservableList<ImportFilesResultItemViewModel> resultList = FXCollections.observableArrayList();
     private final ObservableList<FileExtensionViewModel> fileFilterList;
+    private final ObservableList<ExternalFilesDateViewModel> dateFilterList;
+    private final ObservableList<FileSortViewModel> fileSortList;
+
     private final DialogService dialogService;
     private final PreferencesService preferences;
     private BackgroundTask<FileNodeViewModel> findUnlinkedFilesTask;
@@ -90,9 +95,21 @@ public UnlinkedFilesDialogViewModel(DialogService dialogService, ExternalFileTyp
                 stateManager);
 
         this.fileFilterList = FXCollections.observableArrayList(
-                new FileExtensionViewModel(StandardFileType.ANY_FILE, externalFileTypes),
-                new FileExtensionViewModel(StandardFileType.BIBTEX_DB, externalFileTypes),
-                new FileExtensionViewModel(StandardFileType.PDF, externalFileTypes));
+            new FileExtensionViewModel(StandardFileType.ANY_FILE, externalFileTypes),
+            new FileExtensionViewModel(StandardFileType.BIBTEX_DB, externalFileTypes),
+            new FileExtensionViewModel(StandardFileType.PDF, externalFileTypes));
+
+        this.dateFilterList = FXCollections.observableArrayList(
+            new ExternalFilesDateViewModel(DateRange.ALL_TIME),
+            new ExternalFilesDateViewModel(DateRange.YEAR),
+            new ExternalFilesDateViewModel(DateRange.MONTH),
+            new ExternalFilesDateViewModel(DateRange.WEEK),
+            new ExternalFilesDateViewModel(DateRange.DAY));
+
+        this.fileSortList = FXCollections.observableArrayList(
+            new FileSortViewModel(ExternalFileSorter.DEFAULT),
+            new FileSortViewModel(ExternalFileSorter.DATE_ASCENDING),
+            new FileSortViewModel(ExternalFileSorter.DATE_DESCENDING));
 
         Predicate<String> isDirectory = path -> Files.isDirectory(Path.of(path));
         scanDirectoryValidator = new FunctionBasedValidator<>(directoryPath, isDirectory,
@@ -104,11 +121,12 @@ public UnlinkedFilesDialogViewModel(DialogService dialogService, ExternalFileTyp
     public void startSearch() {
         Path directory = this.getSearchDirectory();
         Filter<Path> selectedFileFilter = selectedExtension.getValue().dirFilter();
-
+        ExternalFilesDateViewModel selectedDateFilter = selectedDate.getValue();
+        FileSortViewModel selectedSortFilter = selectedSort.getValue();
         progressValueProperty.unbind();
         progressTextProperty.unbind();
 
-        findUnlinkedFilesTask = new UnlinkedFilesCrawler(directory, selectedFileFilter, bibDatabase, preferences.getFilePreferences())
+        findUnlinkedFilesTask = new UnlinkedFilesCrawler(directory, selectedFileFilter, selectedDateFilter, selectedSortFilter, bibDatabase, preferences.getFilePreferences())
                 .onRunning(() -> {
                     progressValueProperty.set(ProgressIndicator.INDETERMINATE_PROGRESS);
                     progressTextProperty.setValue(Localization.lang("Searching file system..."));
@@ -189,6 +207,14 @@ public ObservableList<FileExtensionViewModel> getFileFilters() {
         return this.fileFilterList;
     }
 
+    public ObservableList<ExternalFilesDateViewModel> getDateFilters() {
+        return this.dateFilterList;
+    }
+
+    public ObservableList<FileSortViewModel> getSorters() {
+        return this.fileSortList;
+    }
+
     public void cancelTasks() {
         if (findUnlinkedFilesTask != null) {
             findUnlinkedFilesTask.cancel();
@@ -234,6 +260,14 @@ public ObjectProperty<FileExtensionViewModel> selectedExtensionProperty() {
         return this.selectedExtension;
     }
 
+    public ObjectProperty<ExternalFilesDateViewModel> selectedDateProperty() {
+        return this.selectedDate;
+    }
+
+    public ObjectProperty<FileSortViewModel> selectedSortProperty() {
+        return this.selectedSort;
+    }
+
     public StringProperty directoryPathProperty() {
         return this.directoryPath;
     }