Add possibility to reformat all entries on save (under Preferences, File)

Implements [#756](#756)

Author: tobiasdiez

CHANGELOG.md

@@ -13,6 +13,7 @@ to [sourceforge feature requests](https://sourceforge.net/p/jabref/features/) by
 ## [Unreleased]
 
 ### Changed
+- Implemented [#756](https://github.com/JabRef/jabref/issues/756): Add possibility to reformat all entries on save (under Preferences, File)
 - Comments and preamble are serialized with capitalized first letter, i.e. `@Comment` instead of `@comment` and `@Preamble` instead of `@PREAMBLE`.
 - Global sorting options and preferences are removed. Databases can still be sorted on save, but this is configured locally and stored in the file
 - OvidImporter now also imports fields: doi, issn, language and keywords

src/main/java/net/sf/jabref/JabRefPreferences.java

@@ -60,7 +60,6 @@
 public class JabRefPreferences {
     private static final Log LOGGER = LogFactory.getLog(JabRefPreferences.class);
     public static final String EXTERNAL_FILE_TYPES = "externalFileTypes";
-
     /**
      * HashMap that contains all preferences which are set by default
      */
@@ -110,6 +109,7 @@ public class JabRefPreferences {
     public static final String TABLE_SECONDARY_SORT_DESCENDING = "secDescending";
     public static final String TABLE_TERTIARY_SORT_FIELD = "terSort";
     public static final String TABLE_TERTIARY_SORT_DESCENDING = "terDescending";
+    public static final String REFORMAT_FILE_ON_SAVE_AND_EXPORT = "reformatFileOnSaveAndExport";
     public static final String EXPORT_IN_ORIGINAL_ORDER = "exportInOriginalOrder";
     public static final String EXPORT_IN_SPECIFIED_ORDER = "exportInSpecifiedOrder";
     public static final String EXPORT_PRIMARY_SORT_FIELD = "exportPriSort";
@@ -505,6 +505,8 @@ private JabRefPreferences() {
         defaults.put(TABLE_TERTIARY_SORT_FIELD, "title");
         defaults.put(TABLE_TERTIARY_SORT_DESCENDING, Boolean.FALSE);
 
+        defaults.put(REFORMAT_FILE_ON_SAVE_AND_EXPORT, Boolean.FALSE);
+
         // export order
         defaults.put(EXPORT_IN_ORIGINAL_ORDER, Boolean.FALSE);
         defaults.put(EXPORT_IN_SPECIFIED_ORDER, Boolean.FALSE);

src/main/java/net/sf/jabref/bibtex/BibEntryWriter.java

@@ -27,8 +27,11 @@ public BibEntryWriter(LatexFieldFormatter fieldFormatter, boolean write) {
     }
 
     public void write(BibEntry entry, Writer out, BibDatabaseMode bibDatabaseMode) throws IOException {
+        write(entry, out, bibDatabaseMode, false);
+    }
+    public void write(BibEntry entry, Writer out, BibDatabaseMode bibDatabaseMode, Boolean reformat) throws IOException {
         // if the entry has not been modified, write it as it was
-        if (!entry.hasChanged()) {
+        if (!reformat && !entry.hasChanged()) {
             out.write(entry.getParsedSerialization());
             return;
         }

src/main/java/net/sf/jabref/exporter/BibDatabaseWriter.java

@@ -178,7 +178,7 @@ public void writePartOfDatabase(Writer writer, BibDatabaseContext bibDatabaseCon
         writePreamble(writer, bibDatabaseContext.getDatabase().getPreamble());
 
         // Write strings if there are any.
-        writeStrings(writer, bibDatabaseContext.getDatabase());
+        writeStrings(writer, bibDatabaseContext.getDatabase(), preferences.isReformatFile());
 
         // Write database entries.
         List<BibEntry> sortedEntries = BibDatabaseWriter.getSortedEntries(bibDatabaseContext,
@@ -198,7 +198,7 @@ public void writePartOfDatabase(Writer writer, BibDatabaseContext bibDatabaseCon
                         entryType -> typesToWrite.put(entryType.getName(), entryType));
             }
 
-            bibtexEntryWriter.write(entry, writer, bibDatabaseContext.getMode());
+            bibtexEntryWriter.write(entry, writer, bibDatabaseContext.getMode(), preferences.isReformatFile());
 
         }
 
@@ -324,13 +324,14 @@ private void writePreamble(Writer fw, String preamble) throws IOException {
         }
     }
 
-    private void writeString(Writer fw, BibtexString bs, Map<String, BibtexString> remaining, int maxKeyLength)
+    private void writeString(Writer fw, BibtexString bs, Map<String, BibtexString> remaining, int maxKeyLength,
+            Boolean reformatFile)
             throws IOException {
         // First remove this from the "remaining" list so it can't cause problem with circular refs:
         remaining.remove(bs.getName());
 
         //if the string has not been modified, write it back as it was
-        if (!bs.hasChanged()) {
+        if (!reformatFile && !bs.hasChanged()) {
             fw.write(bs.getParsedSerialization());
             return;
         }
@@ -351,7 +352,7 @@ private void writeString(Writer fw, BibtexString bs, Map<String, BibtexString> r
             Object referred = remaining.get(foundLabel.substring(1, foundLabel.length() - 1));
             // If the label we found exists as a key in the "remaining" Map, we go on and write it now:
             if (referred != null) {
-                writeString(fw, (BibtexString) referred, remaining, maxKeyLength);
+                writeString(fw, (BibtexString) referred, remaining, maxKeyLength, reformatFile);
             }
         }
 
@@ -384,9 +385,10 @@ private void writeString(Writer fw, BibtexString bs, Map<String, BibtexString> r
      *
      * @param fw       The Writer to send the output to.
      * @param database The database whose strings we should write.
+     * @param reformatFile
      * @throws IOException If anything goes wrong in writing.
      */
-    private void writeStrings(Writer fw, BibDatabase database) throws IOException {
+    private void writeStrings(Writer fw, BibDatabase database, Boolean reformatFile) throws IOException {
         List<BibtexString> strings = database.getStringKeySet().stream().map(database::getString).collect(
                 Collectors.toList());
         strings.sort(new BibtexStringComparator(true));
@@ -402,7 +404,7 @@ private void writeStrings(Writer fw, BibDatabase database) throws IOException {
             isFirstStringInType = true;
             for (BibtexString bs : strings) {
                 if (remaining.containsKey(bs.getName()) && (bs.getType() == t)) {
-                    writeString(fw, bs, remaining, maxKeyLength);
+                    writeString(fw, bs, remaining, maxKeyLength, reformatFile);
                     isFirstStringInType = false;
                 }
             }

src/main/java/net/sf/jabref/exporter/SavePreferences.java

@@ -8,6 +8,7 @@
 
 public class SavePreferences {
 
+    private boolean reformatFile;
     private boolean saveInOriginalOrder;
     private SaveOrderConfig saveOrder;
     private Charset encoding;
@@ -20,13 +21,14 @@ public SavePreferences() {
     }
 
     public SavePreferences(Boolean saveInOriginalOrder, SaveOrderConfig saveOrder, Charset encoding, Boolean makeBackup,
-            DatabaseSaveType saveType, Boolean takeMetadataSaveOrderInAccount) {
+            DatabaseSaveType saveType, Boolean takeMetadataSaveOrderInAccount, Boolean reformatFile) {
         this.saveInOriginalOrder = saveInOriginalOrder;
         this.saveOrder = saveOrder;
         this.encoding = encoding;
         this.makeBackup = makeBackup;
         this.saveType = saveType;
         this.takeMetadataSaveOrderInAccount = takeMetadataSaveOrderInAccount;
+        this.reformatFile = reformatFile;
     }
 
     public static SavePreferences loadForExportFromPreferences(JabRefPreferences preferences) {
@@ -43,8 +45,9 @@ public static SavePreferences loadForExportFromPreferences(JabRefPreferences pre
         Boolean makeBackup = preferences.getBoolean(JabRefPreferences.BACKUP);
         DatabaseSaveType saveType = DatabaseSaveType.ALL;
         Boolean takeMetadataSaveOrderInAccount = false;
+        Boolean reformatFile = preferences.getBoolean(JabRefPreferences.REFORMAT_FILE_ON_SAVE_AND_EXPORT);
         return new SavePreferences(saveInOriginalOrder, saveOrder, encoding, makeBackup, saveType,
-                takeMetadataSaveOrderInAccount);
+                takeMetadataSaveOrderInAccount, reformatFile);
     }
 
     public static SavePreferences loadForSaveFromPreferences(JabRefPreferences preferences) {
@@ -54,8 +57,9 @@ public static SavePreferences loadForSaveFromPreferences(JabRefPreferences prefe
         Boolean makeBackup = preferences.getBoolean(JabRefPreferences.BACKUP);
         DatabaseSaveType saveType = DatabaseSaveType.ALL;
         Boolean takeMetadataSaveOrderInAccount = true;
+        Boolean reformatFile = preferences.getBoolean(JabRefPreferences.REFORMAT_FILE_ON_SAVE_AND_EXPORT);
         return new SavePreferences(saveInOriginalOrder, saveOrder, encoding, makeBackup, saveType,
-                takeMetadataSaveOrderInAccount);
+                takeMetadataSaveOrderInAccount, reformatFile);
     }
 
     public Boolean getTakeMetadataSaveOrderInAccount() {
@@ -98,6 +102,14 @@ public void setSaveType(DatabaseSaveType saveType) {
         this.saveType = saveType;
     }
 
+    public Boolean isReformatFile() {
+        return reformatFile;
+    }
+
+    public void setReformatFile(boolean reformatFile) {
+        this.reformatFile = reformatFile;
+    }
+
     public enum DatabaseSaveType {
         ALL,
         PLAIN_BIBTEX

src/main/java/net/sf/jabref/gui/preftabs/FileTab.java

@@ -32,6 +32,7 @@
 import javax.swing.event.ChangeListener;
 
 import net.sf.jabref.Globals;
+import net.sf.jabref.JabRef;
 import net.sf.jabref.gui.JabRefFrame;
 import net.sf.jabref.JabRefPreferences;
 
@@ -56,6 +57,7 @@ class FileTab extends JPanel implements PrefsTab {
     private final JCheckBox promptBeforeUsingAutoSave;
     private final JComboBox<String> valueDelimiter;
     private final JComboBox<String> newlineSeparator;
+    private final JCheckBox reformatFileOnSaveAndExport;
     private final JRadioButton resolveStringsStandard;
     private final JRadioButton resolveStringsAll;
     private final JTextField bracesAroundCapitalsFields;
@@ -86,6 +88,8 @@ public FileTab(JabRefFrame frame, JabRefPreferences prefs) {
         // This is sort of a quick hack
         newlineSeparator = new JComboBox<>(new String[] {"CR", "CR/LF", "LF"});
 
+        reformatFileOnSaveAndExport = new JCheckBox(Localization.lang("Always reformat .bib file on save and export"));
+
         bracesAroundCapitalsFields = new JTextField(25);
         nonWrappableFields = new JTextField(25);
         doNotResolveStringsFor = new JTextField(30);
@@ -128,6 +132,9 @@ public void stateChanged(ChangeEvent changeEvent) {
         builder.append(newlineSeparator);
         builder.nextLine();
 
+        builder.append(reformatFileOnSaveAndExport, 3);
+        builder.nextLine();
+
         builder.appendSeparator(Localization.lang("Autosave"));
         builder.append(autoSave, 1);
         JButton help = new HelpAction(HelpFiles.autosaveHelp).getHelpButton();
@@ -164,6 +171,7 @@ public void setValues() {
             // fallback: windows standard
             newlineSeparator.setSelectedIndex(1);
         }
+        reformatFileOnSaveAndExport.setSelected(prefs.getBoolean(JabRefPreferences.REFORMAT_FILE_ON_SAVE_AND_EXPORT));
 
         resolveStringsAll.setSelected(prefs.getBoolean(JabRefPreferences.RESOLVE_STRINGS_ALL_FIELDS));
         resolveStringsStandard.setSelected(!resolveStringsAll.isSelected());
@@ -195,6 +203,7 @@ public void storeSettings() {
         // we also have to change Globals variable as globals is not a getter, but a constant
         Globals.NEWLINE = newline;
 
+        prefs.putBoolean(JabRefPreferences.REFORMAT_FILE_ON_SAVE_AND_EXPORT, reformatFileOnSaveAndExport.isSelected());
         prefs.putBoolean(JabRefPreferences.BACKUP, backup.isSelected());
         prefs.putBoolean(JabRefPreferences.OPEN_LAST_EDITED, openLast.isSelected());
         prefs.putBoolean(JabRefPreferences.RESOLVE_STRINGS_ALL_FIELDS, resolveStringsAll.isSelected());

src/main/resources/l10n/JabRef_da.properties

@@ -1748,3 +1748,5 @@ New_%0_database=
 New_%0_database_created.=
 
 No_entry_found_for_IBSN_%0_at_www.ebook.de=
+
+Always_reformat_.bib_file_on_save_and_export=

src/main/resources/l10n/JabRef_de.properties

@@ -2457,3 +2457,5 @@ New_%0_database=
 New_%0_database_created.=
 
 No_entry_found_for_IBSN_%0_at_www.ebook.de=
+
+Always_reformat_.bib_file_on_save_and_export=

src/main/resources/l10n/JabRef_en.properties

@@ -91,6 +91,9 @@ All_fields=All_fields
 All_subgroups_(recursively)=All_subgroups_(recursively)
 
 Allow_editing_in_table_cells=Allow_editing_in_table_cells
+
+Always_reformat_.bib_file_on_save_and_export=Always_reformat_.bib_file_on_save_and_export
+
 An_Error_occurred_while_fetching_from_OAI2_source_(%0)\:=An_Error_occurred_while_fetching_from_OAI2_source_(%0):
 An_Exception_occurred_while_accessing_'%0'=An_Exception_occurred_while_accessing_'%0'
 An_SAXException_occurred_while_parsing_'%0'\:=An_SAXException_occurred_while_parsing_'%0':

src/main/resources/l10n/JabRef_es.properties

@@ -1646,3 +1646,5 @@ New_%0_database=
 New_%0_database_created.=
 
 No_entry_found_for_IBSN_%0_at_www.ebook.de=
+
+Always_reformat_.bib_file_on_save_and_export=