Configure backup path in prefs #9809

Siedlerchr · 2023-04-27T17:56:35Z

Adds a new option in the preferences to enable/disable backups and to choose the backup directory
Fallback/Default dir is always app dir as usual

Enable/disable backup
Fill the textfield in the prefs

Compulsory checks

Give feedback

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.
Options

TODO: Enable/disable backup

src/main/java/org/jabref/logic/autosaveandbackup/BackupManager.java

src/main/java/org/jabref/gui/preferences/file/FileTabViewModel.java

TODO: test flag if createBackup

src/main/java/org/jabref/logic/autosaveandbackup/BackupManager.java

src/main/java/org/jabref/gui/dialogs/BackupUIManager.java

* upstream/main: (31 commits) Fixes #9372 Change default File Chooser to show supported files extensions Fix path in devs documentation (#9810) New translations JabRef_en.properties (Tagalog) New translations JabRef_en.properties (Persian) New translations JabRef_en.properties (Indonesian) New translations JabRef_en.properties (Portuguese, Brazilian) New translations JabRef_en.properties (Vietnamese) New translations JabRef_en.properties (Chinese Traditional) New translations JabRef_en.properties (Chinese Simplified) New translations JabRef_en.properties (Ukrainian) New translations JabRef_en.properties (Turkish) New translations JabRef_en.properties (Swedish) New translations JabRef_en.properties (Russian) New translations JabRef_en.properties (Portuguese) New translations JabRef_en.properties (Polish) New translations JabRef_en.properties (Norwegian) New translations JabRef_en.properties (Dutch) New translations JabRef_en.properties (Korean) New translations JabRef_en.properties (Japanese) New translations JabRef_en.properties (Italian) ...

koppor

Some minor comments.

Yeah, the enable and disable of the backup (start/stop of BackupManager with other configuraiton) really needs to be done.

src/main/java/org/jabref/logic/autosaveandbackup/BackupManager.java

src/main/java/org/jabref/logic/util/io/BackupFileUtil.java

src/main/java/org/jabref/preferences/JabRefPreferences.java

* upstream/main: (68 commits) Bump org.junit.platform:junit-platform-launcher from 1.9.2 to 1.9.3 Bump org.jsoup:jsoup from 1.15.4 to 1.16.1 Bump org.junit.jupiter:junit-jupiter from 5.9.2 to 5.9.3 Bump com.puppycrawl.tools:checkstyle from 10.9.3 to 10.10.0 Bump com.vladsch.flexmark:flexmark from 0.64.0 to 0.64.2 Refresh example styles Squashed 'buildres/csl/csl-styles/' changes from 4728902faa..a985762505 New translations JabRef_en.properties (Tagalog) New translations JabRef_en.properties (Persian) New translations JabRef_en.properties (Indonesian) New translations JabRef_en.properties (Portuguese, Brazilian) New translations JabRef_en.properties (Vietnamese) New translations JabRef_en.properties (Chinese Traditional) New translations JabRef_en.properties (Chinese Simplified) New translations JabRef_en.properties (Ukrainian) New translations JabRef_en.properties (Turkish) New translations JabRef_en.properties (Swedish) New translations JabRef_en.properties (Russian) New translations JabRef_en.properties (Portuguese) New translations JabRef_en.properties (Polish) ... # Conflicts: # src/main/java/org/jabref/gui/preferences/file/FileTab.java # src/main/java/org/jabref/gui/preferences/file/FileTabViewModel.java # src/main/java/org/jabref/logic/autosaveandbackup/BackupManager.java

src/main/java/org/jabref/logic/autosaveandbackup/BackupManager.java

* upstream/main: Fix modernizer (#9824) Improve search history by attaching change listener (#9794) Fix split multiline localization (#9814) New Crowdin updates (#9834) change versin to 0.8.10 remove jacoco version config

…orBak

HoussemNasri · 2023-05-04T22:29:42Z

I checkout the PR, but then I can't seem to trigger the backup manager dialog. I have tried closing JabRef from IntelliJ and from the Taskmanager by ending the process but neither has worked; when I start JabRef again, the backup dialog doesn't show. Keep in mind that the "Create backup" is enabled.

polish: besides that problem, I think the backup path text field should be disabled when the "Create backup" checkbox is unchecked.

koppor · 2023-05-04T23:41:10Z

I checkout the PR, but then I can't seem to trigger the backup manager dialog. I have tried closing JabRef from IntelliJ and from the Taskmanager by ending the process but neither has worked;

Did you also modify the library without saving?

I did and I got the dialog:

polish: besides that problem, I think the backup path text field should be disabled when the "Create backup" checkbox is unchecked.

Current state:

We should also have a button "reset to default" (same icon as in "Reset preferences")

HoussemNasri · 2023-05-04T23:51:24Z

Yes, I modified the library before closing it. I also changed the backup path.

Siedlerchr · 2023-05-05T04:39:15Z

A restart might be necessary after changing the prefs, the back up manager is started very early Houssem Nasri ***@***.***> schrieb am Fr., 5. Mai 2023, 01:51:

…

Yes, I modified the library before closing it. I also changed the backup path. — Reply to this email directly, view it on GitHub <#9809 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACOFZEE6UOQD53GWPFAJTTXEQ6IRANCNFSM6AAAAAAXOGJY5M> . You are receiving this because you authored the thread.Message ID: ***@***.***>

* upstream/main: Minimal config for openRewrite Fix missing # CHANGELOG.md Removed unused code Refined ui Dissolved FileTab and moved contents to EntryTab Renamed CustomEditorFieldsTab to EntryEditorTabsTab Fixed antipattern, fixed radiobutton with checkbox Renamed ImportExportPreferences to ExportPreferences Separated WebSearchPrefs and ExportPrefs Separated WebSearchTab and ExportTab Renamed ImportExportTab to WebSearchTab # Conflicts: # src/main/java/org/jabref/gui/preferences/export/ExportTab.java # src/main/java/org/jabref/gui/preferences/file/FileTab.fxml # src/main/java/org/jabref/gui/preferences/file/FileTabViewModel.java

HoussemNasri · 2023-05-05T18:06:14Z

@Siedlerchr It is working now! A restart was needed as you said. Also, I noticed that if I open JabRef, make a change, and then close it (kill the process) very fast, the backup dialog doesn't show the next time.

Siedlerchr · 2023-05-05T18:09:13Z

Yep, you have to wait a few seconds because the backup path is using seconds in the filename only as minimum String timeSuffix = ZonedDateTime.now().format(DateTimeFormatter.ofPattern("yyyy-MM-dd--HH.mm.ss"));

That's why I added a sleep in the test as well

HoussemNasri · 2023-05-05T18:27:27Z

issue: Crossref field changes aren't recorded; It is probably not caused by this pr but I'm documenting it here to not forget it.

HoussemNasri

LGTM codewise, I didn't look too much into the tests but they look good overall. It would be great if you can get the backup directory to be updated without restarting, otherwise, a "you need to restart" message is fine.

src/main/java/org/jabref/gui/JabRefFrame.java

src/main/java/org/jabref/logic/util/io/BackupFileUtil.java

Configure backup path in prefs

2ff3e9b

TODO: Enable/disable backup

github-actions bot reviewed Apr 27, 2023

View reviewed changes

bind ui to prefs, fix making of backups in correct dir

ddca12a

TODO: test flag if createBackup

github-actions bot reviewed Apr 28, 2023

View reviewed changes

Siedlerchr added 4 commits April 28, 2023 22:24

fix l1ßn

7c534b2

checkstyle and l10n

473a5e0

checkstyle

0bb9321

koppor requested changes Apr 28, 2023

View reviewed changes

ThiloteE added preferences backup labels May 1, 2023

Siedlerchr added 3 commits May 1, 2023 20:24

fix merge conflicts

b935fde

add comment

5dae372

github-actions bot reviewed May 1, 2023

View reviewed changes

src/main/java/org/jabref/logic/autosaveandbackup/BackupManager.java Outdated Show resolved Hide resolved

Siedlerchr and others added 7 commits May 4, 2023 20:54

Merge remote-tracking branch 'upstream/main' into addPrefsForBak

f6688b8

* upstream/main: Fix modernizer (#9824) Improve search history by attaching change listener (#9794) Fix split multiline localization (#9814) New Crowdin updates (#9834) change versin to 0.8.10 remove jacoco version config

fix checkstyle

2f447d9

Moved backup settings to GeneralTab

bf4c43d

Merge remote-tracking branch 'upstream/addPrefsForBak' into addPrefsF…

749fb42

…orBak

Refine ui

9a270dc

fix unit tests

de97779

add tests

cfebdbe

Siedlerchr changed the title ~~WIP: Configure backup path in prefs~~ Configure backup path in prefs May 4, 2023

Siedlerchr added 2 commits May 4, 2023 22:17

fix indentation

243f73a

remove useless var

ad52f32

Siedlerchr added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label May 4, 2023

Siedlerchr added 2 commits May 5, 2023 19:40

disable backup dir when unchecked

b9c1af2

remove test for second file

2df54e8

HoussemNasri requested changes May 5, 2023

View reviewed changes

src/main/java/org/jabref/gui/JabRefFrame.java Show resolved Hide resolved

src/main/java/org/jabref/logic/util/io/BackupFileUtil.java Show resolved Hide resolved

fix missing path parameter

5547e35

calixtus merged commit 3de6c7b into main May 8, 2023

calixtus deleted the addPrefsForBak branch May 8, 2023 18:57

koppor mentioned this pull request May 8, 2023

Disable creation of .bak files at all #9741

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Configure backup path in prefs #9809

Configure backup path in prefs #9809

Siedlerchr commented Apr 27, 2023 •

edited

Loading

Compulsory checks

koppor left a comment

HoussemNasri commented May 4, 2023

koppor commented May 4, 2023

HoussemNasri commented May 4, 2023

Siedlerchr commented May 5, 2023 via email

HoussemNasri commented May 5, 2023

Siedlerchr commented May 5, 2023

HoussemNasri commented May 5, 2023

HoussemNasri left a comment

Configure backup path in prefs #9809

Configure backup path in prefs #9809

Conversation

Siedlerchr commented Apr 27, 2023 • edited Loading

Compulsory checks

koppor left a comment

Choose a reason for hiding this comment

HoussemNasri commented May 4, 2023

koppor commented May 4, 2023

HoussemNasri commented May 4, 2023

Siedlerchr commented May 5, 2023 via email

HoussemNasri commented May 5, 2023

Siedlerchr commented May 5, 2023

HoussemNasri commented May 5, 2023

HoussemNasri left a comment

Choose a reason for hiding this comment

Siedlerchr commented Apr 27, 2023 •

edited

Loading