Fix: Make FileUtil.relativize symlink-aware #13553
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| package org.jabref.gui.maintable; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| import org.jabref.gui.DialogService; | ||
| import org.jabref.gui.StateManager; | ||
| import org.jabref.gui.actions.ActionHelper; | ||
| import org.jabref.gui.actions.SimpleCommand; | ||
| import org.jabref.gui.fieldeditors.LinkedFileViewModel; | ||
| import org.jabref.gui.preferences.GuiPreferences; | ||
| import org.jabref.logic.l10n.Localization; | ||
| import org.jabref.logic.util.TaskExecutor; | ||
|
|
||
| public class OpenSelectedEntriesFilesAction extends SimpleCommand { | ||
|
|
||
| private static final int FILES_LIMIT = 10; | ||
|
|
||
| private final DialogService dialogService; | ||
| private final StateManager stateManager; | ||
| private final GuiPreferences preferences; | ||
| private final TaskExecutor taskExecutor; | ||
|
|
||
| public OpenSelectedEntriesFilesAction(DialogService dialogService, | ||
| StateManager stateManager, | ||
| GuiPreferences preferences, | ||
| TaskExecutor taskExecutor) { | ||
| this.dialogService = dialogService; | ||
| this.stateManager = stateManager; | ||
| this.preferences = preferences; | ||
| this.taskExecutor = taskExecutor; | ||
|
|
||
| this.executable.bind(ActionHelper.hasLinkedFileForSelectedEntries(stateManager) | ||
| .and(ActionHelper.needsEntriesSelected(stateManager))); | ||
| } | ||
|
|
||
| @Override | ||
| public void execute() { | ||
| stateManager.getActiveDatabase().ifPresent(databaseContext -> { | ||
| List<LinkedFileViewModel> linkedFileViewModelList = stateManager | ||
| .getSelectedEntries().stream() | ||
| .flatMap(entry -> entry.getFiles().stream() | ||
| .map(linkedFile -> new LinkedFileViewModel( | ||
| linkedFile, | ||
| entry, | ||
| databaseContext, | ||
| taskExecutor, | ||
| dialogService, | ||
| preferences))) | ||
| .toList(); | ||
| if (linkedFileViewModelList.size() > FILES_LIMIT) { | ||
| boolean continueOpening = dialogService.showConfirmationDialogAndWait( | ||
| Localization.lang("Opening large number of files"), | ||
| Localization.lang("You are about to open %0 files. Continue?", linkedFileViewModelList.size()), | ||
| Localization.lang("Open all linked files"), | ||
| Localization.lang("Cancel file opening") | ||
| ); | ||
| if (!continueOpening) { | ||
| return; | ||
| } | ||
| } | ||
|
|
||
| linkedFileViewModelList.forEach(LinkedFileViewModel::open); | ||
| }); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| package org.jabref.gui.maintable; | ||
|
|
||
| import java.util.Optional; | ||
|
|
||
| import org.jabref.gui.DialogService; | ||
| import org.jabref.gui.StateManager; | ||
| import org.jabref.gui.actions.SimpleCommand; | ||
| import org.jabref.gui.fieldeditors.LinkedFileViewModel; | ||
| import org.jabref.gui.preferences.GuiPreferences; | ||
| import org.jabref.logic.util.TaskExecutor; | ||
| import org.jabref.model.database.BibDatabaseContext; | ||
| import org.jabref.model.entry.BibEntry; | ||
| import org.jabref.model.entry.LinkedFile; | ||
|
|
||
| import org.jspecify.annotations.NonNull; | ||
|
|
||
| public class OpenSingleExternalFileAction extends SimpleCommand { | ||
|
|
||
| private final DialogService dialogService; | ||
| private final GuiPreferences preferences; | ||
| private final BibEntry entry; | ||
| private final LinkedFile linkedFile; | ||
| private final TaskExecutor taskExecutor; | ||
| private final StateManager stateManager; | ||
|
|
||
| public OpenSingleExternalFileAction(@NonNull DialogService dialogService, | ||
| @NonNull GuiPreferences preferences, | ||
| @NonNull BibEntry entry, | ||
| @NonNull LinkedFile linkedFile, | ||
| @NonNull TaskExecutor taskExecutor, | ||
| @NonNull StateManager stateManager) { | ||
| this.dialogService = dialogService; | ||
| this.preferences = preferences; | ||
| this.entry = entry; | ||
| this.linkedFile = linkedFile; | ||
| this.taskExecutor = taskExecutor; | ||
| this.stateManager = stateManager; | ||
|
|
||
| this.setExecutable(true); | ||
| } | ||
|
|
||
| @Override | ||
| public void execute() { | ||
| Optional<BibDatabaseContext> databaseContextOptional = stateManager.getActiveDatabase(); | ||
| if (databaseContextOptional.isEmpty()) { | ||
| return; | ||
| } | ||
| BibDatabaseContext databaseContext = databaseContextOptional.get(); | ||
| LinkedFileViewModel linkedFileViewModel = new LinkedFileViewModel( | ||
| linkedFile, | ||
| entry, | ||
| databaseContext, | ||
| taskExecutor, | ||
| dialogService, | ||
| preferences); | ||
| linkedFileViewModel.open(); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -256,15 +256,40 @@ public static Path relativize(Path file, List<Path> directories) { | |
| if (!file.isAbsolute()) { | ||
| return file; | ||
| } | ||
| Optional<Path> realFileOpt = tryRealPath(file); | ||
|
|
||
| for (Path directory : directories) { | ||
| Optional<Path> realDirOpt = tryRealPath(directory); | ||
|
|
||
| if (realFileOpt.isPresent() && realDirOpt.isPresent()) { | ||
| Path realFile = realFileOpt.get(); | ||
| Path realDir = realDirOpt.get(); | ||
| if (realFile.startsWith(realDir)) { | ||
| // Figure out offset in original path structure, so the returned path is user-friendly and symlinks are preserved if possible | ||
| // Compute number of elements to drop from file, starting from directory length | ||
Muskan244 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| int nameCountToDrop = realDir.getNameCount(); | ||
| Path relativePart = realFile.subpath(nameCountToDrop, realFile.getNameCount()); | ||
| return relativePart; | ||
|
||
| } | ||
| } | ||
|
|
||
| // Fallback: original logic as before, for non-symlinked directories | ||
Muskan244 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| if (file.startsWith(directory)) { | ||
| return directory.relativize(file); | ||
| } | ||
| } | ||
| return file; | ||
| } | ||
|
|
||
| private static Optional<Path> tryRealPath(Path path) { | ||
| try { | ||
| return Optional.of(path.toRealPath()); | ||
| } catch (IOException e) { | ||
Muskan244 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| // maybe the file does not exist yet? fallback to absolute path. | ||
| return Optional.of(path.toAbsolutePath()); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Converts an absolute file to a relative one, if possible. Returns the parameter file itself if no shortening is | ||
| * possible. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.