Skip to content

Fix for Issue #4306 - Disable Rename when Filename is the same #4350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 10 commits into from
Closed

Fix for Issue #4306 - Disable Rename when Filename is the same #4350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8df278f
Conditional Added for Rename File
Arbalest007 Sep 13, 2018
c1eb4fd
Implemented Name Conflict Check
Arbalest007 Sep 14, 2018
c9adc47
Changed Variable Names for performNameConflictCheck()
Arbalest007 Sep 14, 2018
181c63b
Added Test Case
Arbalest007 Sep 16, 2018
61c1bcb
Test Case - Mockito Added
Arbalest007 Sep 16, 2018
8c2acdf
Uncommented Test Case
Arbalest007 Sep 17, 2018
aea2360
Final Test Case Code Change
Arbalest007 Sep 18, 2018
27a820e
Removed Test Case and Resolved Codacy Issues
Arbalest007 Sep 19, 2018
59ad414
Resolved Additional Codacy Flags
Arbalest007 Sep 19, 2018
87d07af
Added method performDirectoryConflictCheck to compare filepaths. Re-a…
Arbalest007 Sep 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions src/main/java/org/jabref/gui/fieldeditors/LinkedFileViewModel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,35 @@ public void openFolder() {
}
}

public boolean performNameConflictCheck() {
/*
Get the filepath for current linkedFile and truncate it to only have the filename and
not the filepath. Compare to new suggested filename and return boolean result.
*/
Path file = Paths.get(this.linkedFile.getLink());
String currentFileName = file.getFileName().toString();
String suggestedFileName = this.linkedFileHandler.getSuggestedFileName();

return currentFileName.equals(suggestedFileName);
}

public boolean performDirectoryConflictCheck() {
/*
Get the suggested filepath for current linkedFile and compare it to the existing filepath.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This kind of code documentation is somewhat contrary to the usual style used in the rest of the code. Either move these comments before the method as JavaDoc comments, or use normal inline comments as done below.

Return boolean result.
*/
//Get the new path for the file
Optional<Path> newDir = databaseContext.getFirstExistingFileDir(filePreferences);
Path newDirectory = newDir.get();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The get method throws an exception if the optional is empty. I would propose to rewrite the code as return OptionalUtil.equals(newDir, currentDirectory, Files::isSameFile); and add the following method to OptionalUtil

public <T,U> boolean equals(Optional<T> left, Optional<U> right, BiPredicate<T,U> equality) {
   if(!left.isPresent()) {
       return !right.isPresent();
   } else {
       if (right.isPresent()) {
           return equality.test(left.get(), right.get());
      } else {
           return false;
      }
   }
}

(there might be syntax errors in the above code)


//Get the current path for the file
Optional<Path> currentDir = linkedFile.findIn(databaseContext, filePreferences);
Path currentDirectory = currentDir.get();

//Compare the two paths
return newDirectory.toString().equals(currentDirectory.getParent().toString());
}

public void rename() {
if (linkedFile.isOnlineLink()) {
// Cannot rename remote links
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/org/jabref/gui/fieldeditors/LinkedFilesEditor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,15 +254,15 @@ private ContextMenu createContextMenuForFile(LinkedFileViewModel linkedFile) {

MenuItem renameFile = new MenuItem(Localization.lang("Rename file"));
renameFile.setOnAction(event -> linkedFile.rename());
renameFile.setDisable(linkedFile.getFile().isOnlineLink());
renameFile.setDisable(linkedFile.getFile().isOnlineLink() || linkedFile.performNameConflictCheck());

MenuItem moveFile = new MenuItem(Localization.lang("Move file to file directory"));
moveFile.setOnAction(event -> linkedFile.moveToDefaultDirectory());
moveFile.setDisable(linkedFile.getFile().isOnlineLink());
moveFile.setDisable(linkedFile.getFile().isOnlineLink() || linkedFile.performDirectoryConflictCheck());

MenuItem renameAndMoveFile = new MenuItem(Localization.lang("Move file to file directory and rename file"));
renameAndMoveFile.setOnAction(event -> linkedFile.moveToDefaultDirectoryAndRename());
renameAndMoveFile.setDisable(linkedFile.getFile().isOnlineLink());
renameAndMoveFile.setDisable(linkedFile.getFile().isOnlineLink() || linkedFile.performDirectoryConflictCheck());

MenuItem deleteFile = new MenuItem(Localization.lang("Permanently delete local file"));
deleteFile.setOnAction(event -> viewModel.deleteFile(linkedFile));
Expand Down