Fix for issue 571: File folders: Move between global and user-specific #12059

Officialshubham · 2024-10-22T13:24:59Z

Describe the changes you have made here:
Created a separate class to handle movement of files between directories. The class follows the structure and logic mention in issue #571

Class Location: org.jabref/gui/fieldeditors
Class Name: FileDirectoryHandler
Class Description: Primary objective of this class to give target directory based on the current location/path of the file.

Changes in LinkedFilesEditor.java

Instead of relying upon static text in context menu, based on target path, the text will change.
Dynamic update of text once the file moved to its destination.
Changes to both MOVE_TO_FOLDER and MOVE_TO_FOLDER_AND_RENAME menu item and action.

Changes in LinkedFileViewModel.java

Add moveToDirectory function responsible for actually moving the file based on the return value from file directory handler class.
Add extra helper functions to update text in context menu as well as to determine OS specific directories.
Preserved the sub directory structures.

Add some tests to check the functionality of FileDirectoryHandler

Closes koppor#571

Special Note: Want to confirm whether going in right direction or not. Unit Testing is in process.
Manual testing is performed. Creating a draft PR for review.

Screenshots

Mandatory checks

I own the copyright of the code submitted and I licence it under the MIT license
Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (for UI changes)
Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

…brary-specific

koppor · 2024-10-23T20:42:20Z

@Officialshubham Please revert updates in `csl-styles. See https://devdocs.jabref.org/code-howtos/faq.html#fix. -- I checked the GitHub Diff (tab "Files") and it still shows changes there.

CHANGELOG.md

Co-authored-by: Oliver Kopp <[email protected]>

koppor

Some general remark.

koppor · 2024-10-23T20:54:45Z

GitHub removed my text, here it is:

The class FileDirectoryHandler should go to logic. (Update: Maybe, it should just be included in FileUtil?)

Add another method to BibDatabaseContext similar to org.jabref.model.database.BibDatabaseContext#getFileDirectories

getFileDirectoriesInfo

It returns a record(Path mainFileDirecotry, Optional<Path> librarySpecificDirectory, Optional<Path> userFileDirectory).

(See #12037 for the PR renaming the variables properly)

Then, your method getAvailableDirectories will be obsolete.

The code of the handleXcase will be more readable. Also it will be one method. You can ask userFileDirectory for isEmpty() etc.

Officialshubham · 2024-10-23T21:00:33Z

Thanks @koppor
I will work on your feedback. If I'll encounter any issues, I will let you know.

HoussemNasri · 2024-10-23T21:33:16Z

src/main/java/org/jabref/gui/fieldeditors/LinkedFileViewModel.java

+        String user = preferences.getFilePreferences().getUserAndHost().split("-")[0];
+
+        // Create a set of root-like directories and include the user dynamically
+        Set<String> rootLikeDirs = new HashSet<>(Set.of(


We are recreating the same set each time we check if the directory is root. This doesn't sound efficient.

Yes it is not correct. I am moving it as static and final. It will be loaded once now.

HoussemNasri · 2024-10-23T21:38:16Z

src/main/java/org/jabref/gui/fieldeditors/LinkedFileViewModel.java

+            BooleanProperty isMoveFileDisabled = new SimpleBooleanProperty(true);
+            moveFileItem.disableProperty().bind(isMoveFileDisabled);
+            moveFileItem.setText(Localization.lang("Move file"));


Why are we binding to isMoveFileDisabled here? It is declared locally so its value (true) won't change.

Hi @HoussemNasri
I bind it to follow the consistency in both the classes: LinkedFilesEditor and LinkedFileViewModel
I am aware that we can disable it directly using setDisable().
I will change it. Let me know your views. Thanks

Officialshubham · 2024-10-24T14:03:24Z

@koppor and @HoussemNasri.
I have resolved all the comments mentioned. Have a look at it. Thanks

koppor

an old review comment was not posted - it is still valid.

Pleae also fix buildres/abbrv.jabref.org

koppor · 2024-10-24T13:27:23Z

src/main/java/org/jabref/gui/fieldeditors/LinkedFileViewModel.java

+        }
+    }
+
+    public void moveToDirectory(MenuItem moveFileItem, MenuItem moveAndRenameFileItem, boolean toRename) {


I think, a similar function already exists at org.jabref.logic.externalfiles.LinkedFileHandler#copyOrMoveToDefaultDirectory. One "just" needs to make it more generic to get the target directory (instead of databaseContext.getFirstExistingFileDir(filePreferences);).

With the record I proposed, this should be very easy.

koppor · 2024-10-25T12:55:14Z

src/main/java/org/jabref/gui/fieldeditors/LinkedFilesEditor.java

@@ -325,68 +371,96 @@ private ContextMenu createContextMenuForFile(LinkedFileViewModel linkedFile) {
                factory.createMenuItem(StandardActions.OPEN_FOLDER, new ContextAction(StandardActions.OPEN_FOLDER, linkedFile, preferences)),
                new SeparatorMenuItem(),
                factory.createMenuItem(StandardActions.DOWNLOAD_FILE, new ContextAction(StandardActions.DOWNLOAD_FILE, linkedFile, preferences)),
+                moveFileItems[0],


No - not any arrays in Java.

Officialshubham and others added 30 commits October 8, 2024 01:26

Add a feature for having dynamic move funciton(files): Working for li…

98d19dc

…brary-specific

Change the the retrieval of main file directory

5db6d07

Merge branch 'JabRef:main' into fix-for-issue-571

cc328a6

Merge branch 'JabRef:main' into fix-for-issue-571

f42850d

Merge branch 'JabRef:main' into fix-for-issue-571

2a2a632

Merge branch 'JabRef:main' into fix-for-issue-571

acc484f

Merge branch 'JabRef:main' into fix-for-issue-571

bc9e5e6

Merge branch 'JabRef:main' into fix-for-issue-571

96a7172

Merge branch 'JabRef:main' into fix-for-issue-571

de22fab

Add debugging statements

f62b498

Move files to diff directories

b22c7de

Solve changing the directory after first move

58ca163

Merge branch 'JabRef:main' into fix-for-issue-571

1b497a1

Create the test for FileDirectoryHandlerTest.java

7e74446

Merge branch 'JabRef:main' into fix-for-issue-571

03c185b

Merge branch 'JabRef:main' into fix-for-issue-571

1c3428e

Merge branch 'JabRef:main' into fix-for-issue-571

9c9ecf5

Merge branch 'JabRef:main' into fix-for-issue-571

a50bf02

Add rename logic for move

65b6738

Add logic for concurrent change of label

7df6f97

Working for 2 directory structure now

c2aefe5

Remove junk code: cleanup

61113bf

Add funcitonality when directories are 0

5234308

Change the ordering of menuItem: remove wrong target

8711341

Test for FileDIrectoryHander is working

99b7b90

Remove junk comments: cleanup

0acd0ab

Add more test cases

da29975

Preserve sub dir structure when moving

cc9d491

Add and remove comments

5b1a517

Add changes to CHANGELOG.md: Fixed Section

2c5e559

Officialshubham added 3 commits October 24, 2024 07:33

Change by openrewrite

fa5e0a5

Fix bare URL and trailing spaces error: CHANGELOG.md

126bf41

Add incomplete link in CHANGELOG.md

f08db39

koppor reviewed Oct 23, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Update CHANGELOG.md: fix-for-issue-571

c0ae669

Co-authored-by: Oliver Kopp <[email protected]>

koppor mentioned this pull request Oct 23, 2024

Rename General File Directory to Library-Specific File Directory #12037

Merged

7 tasks

Merge branch 'JabRef:main' into fix-for-issue-571

eb25e9f

koppor requested changes Oct 23, 2024

View reviewed changes

HoussemNasri reviewed Oct 23, 2024

View reviewed changes

Officialshubham and others added 14 commits October 24, 2024 21:14

Merge branch 'JabRef:main' into fix-for-issue-571

38e9a52

Add getDirectoryInfo for dirs and implemet changes from PR

517b393

Change cleanup position after update menu

efe96f3

Remove unnecessary comment

c6f36d9

Change default to library directory name

3ff5918

Rename default to library specific in FileDirectoryHandlerTest

6abe046

Remove cleanup directories stream code: Not required

17ff80e

Improve the logic of getTargetDirectory

b514108

Add language keys

2b8e8c4

Change tests based on directoriesInfo

290968c

Fix language key error

865fcf7

Fix Standard Streams Usage Violation

e911b52

Fix layered architecture violation

b0f519e

Merge branch 'main' into fix-for-issue-571

8089323

koppor requested changes Oct 25, 2024

View reviewed changes

koppor reviewed Oct 25, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix for issue 571: File folders: Move between global and user-specific #12059

Fix for issue 571: File folders: Move between global and user-specific #12059

Officialshubham commented Oct 22, 2024

koppor commented Oct 23, 2024

koppor left a comment

koppor commented Oct 23, 2024 •

edited

Loading

Officialshubham commented Oct 23, 2024

HoussemNasri Oct 23, 2024

Officialshubham Oct 24, 2024

HoussemNasri Oct 23, 2024

Officialshubham Oct 24, 2024 •

edited

Loading

Officialshubham commented Oct 24, 2024

koppor left a comment

koppor Oct 24, 2024

koppor Oct 25, 2024

Fix for issue 571: File folders: Move between global and user-specific #12059

Are you sure you want to change the base?

Fix for issue 571: File folders: Move between global and user-specific #12059

Conversation

Officialshubham commented Oct 22, 2024

Mandatory checks

koppor commented Oct 23, 2024

koppor left a comment

Choose a reason for hiding this comment

koppor commented Oct 23, 2024 • edited Loading

Officialshubham commented Oct 23, 2024

HoussemNasri Oct 23, 2024

Choose a reason for hiding this comment

Officialshubham Oct 24, 2024

Choose a reason for hiding this comment

HoussemNasri Oct 23, 2024

Choose a reason for hiding this comment

Officialshubham Oct 24, 2024 • edited Loading

Choose a reason for hiding this comment

Officialshubham commented Oct 24, 2024

koppor left a comment

Choose a reason for hiding this comment

koppor Oct 24, 2024

Choose a reason for hiding this comment

koppor Oct 25, 2024

Choose a reason for hiding this comment

koppor commented Oct 23, 2024 •

edited

Loading

Officialshubham Oct 24, 2024 •

edited

Loading