Add the setting changes encoding for CSV file to the preference dialog

(cherry picked from commit 11210b6d8b4584621ef02e7356854ffa9f7f2647)

src/main/java/ninja/javafx/smartcsv/csv/CSVConfigurable.java

@@ -35,6 +35,8 @@ public class CSVConfigurable {
 
     protected CsvPreference csvPreference;
 
+    protected String fileEncoding;
+
     public CSVConfigurable() {
         csvPreference = CsvPreference.EXCEL_NORTH_EUROPE_PREFERENCE;
     }
@@ -42,4 +44,9 @@ public class CSVConfigurable {
     public void setCsvPreference(CsvPreference csvPreference) {
         this.csvPreference = csvPreference;
     }
+
+    public void setFileEncoding(String fileEncoding) {
+        this.fileEncoding = fileEncoding;
+    }
+
 }

src/main/java/ninja/javafx/smartcsv/csv/CSVFileReader.java

@@ -34,6 +34,7 @@ import org.supercsv.io.ICsvMapReader;
 
 import java.io.File;
 import java.io.IOException;
+import java.nio.charset.Charset;
 import java.util.Map;
 
 /**
@@ -48,7 +49,8 @@ public class CSVFileReader extends CSVConfigurable implements FileReader<CSVMode
 
         ICsvMapReader mapReader = null;
         try {
-            mapReader = new CsvMapReader(new java.io.FileReader(file.getAbsoluteFile()), csvPreference);
+            mapReader = new CsvMapReader(new java.io.FileReader(file.getAbsoluteFile(), Charset.forName(fileEncoding)),
+                    csvPreference);
             model = new CSVModel();
 
             // the header columns are used as the keys to the Map

src/main/java/ninja/javafx/smartcsv/csv/CSVFileWriter.java

@@ -34,6 +34,7 @@ import org.supercsv.io.ICsvMapWriter;
 import java.io.File;
 import java.io.FileWriter;
 import java.io.IOException;
+import java.nio.charset.Charset;
 import java.util.Map;
 
 import static java.util.stream.Collectors.toMap;
@@ -53,7 +54,8 @@ public class CSVFileWriter extends CSVConfigurable implements ninja.javafx.smart
     public void write(File filename) throws IOException {
         ICsvMapWriter mapWriter = null;
         try {
-            mapWriter = new CsvMapWriter(new FileWriter(filename.getAbsolutePath()), csvPreference);
+            mapWriter = new CsvMapWriter(new FileWriter(filename.getAbsolutePath(), Charset.forName(fileEncoding)),
+                    csvPreference);
             mapWriter.writeHeader(model.getHeader());
 
             for(CSVRow row: model.getRows()) {

src/main/java/ninja/javafx/smartcsv/fx/SmartCSVController.java

@@ -54,8 +54,7 @@ import ninja.javafx.smartcsv.fx.table.model.CSVValue;
 import ninja.javafx.smartcsv.fx.util.LoadFileService;
 import ninja.javafx.smartcsv.fx.util.SaveFileService;
 import ninja.javafx.smartcsv.fx.validation.ValidationEditorController;
-import ninja.javafx.smartcsv.preferences.PreferencesFileReader;
-import ninja.javafx.smartcsv.preferences.PreferencesFileWriter;
+import ninja.javafx.smartcsv.preferences.*;
 import ninja.javafx.smartcsv.validation.configuration.ValidationConfiguration;
 import ninja.javafx.smartcsv.validation.ValidationError;
 import ninja.javafx.smartcsv.validation.ValidationFileReader;
@@ -68,6 +67,7 @@ import org.supercsv.prefs.CsvPreference;
 import java.io.File;
 import java.io.IOException;
 import java.net.URL;
+import java.nio.charset.Charset;
 import java.util.Optional;
 import java.util.ResourceBundle;
 
@@ -93,6 +93,13 @@ public class SmartCSVController extends FXMLController {
             ".SmartCSV.fx" +
             File.separator + "" +
             "preferences.json");
+
+    private static final File ENCODING_FILE = new File(System.getProperty("user.home") +
+            File.separator +
+            ".SmartCSV.fx" +
+            File.separator +
+            "encoding.json");
+
     public static final String CSV_FILTER_TEXT = "CSV files (*.csv)";
     public static final String CSV_FILTER_EXTENSION = "*.csv";
     public static final String JSON_FILTER_TEXT = "JSON files (*.json)";
@@ -213,6 +220,7 @@ public class SmartCSVController extends FXMLController {
     private FileStorage<CSVModel> currentCsvFile = new FileStorage<>(csvFileReader, csvFileWriter);
     private FileStorage<ValidationConfiguration> currentConfigFile = new FileStorage<>(new ValidationFileReader(), new ValidationFileWriter());
     private FileStorage<CsvPreference> csvPreferenceFile = new FileStorage<>(new PreferencesFileReader(), new PreferencesFileWriter());
+    private FileStorage<String> fileEncodingFile = new FileStorage<>(new EncodingFileReader(), new EncodingFileWriter());
 
     private ListChangeListener<ValidationError> errorListListener = c -> tableView.refresh();
     private WeakListChangeListener<ValidationError> weakErrorListListener = new WeakListChangeListener<>(errorListListener);
@@ -238,10 +246,25 @@ public class SmartCSVController extends FXMLController {
         bindConfigFileName();
 
         csvPreferenceFile.setFile(PREFERENCES_FILE);
+        fileEncodingFile.setFile(ENCODING_FILE);
 
         loadCsvPreferencesFromFile();
     }
 
+    private void loadEncodingFromFile() {
+        if (fileEncodingFile.getFile().exists()) {
+            useLoadFileService(fileEncodingFile, event -> setFileEncoding(fileEncodingFile.getContent()));
+        } else {
+            setFileEncoding(Charset.defaultCharset().name());
+        }
+    }
+
+    private void setFileEncoding(String content) {
+        preferencesController.setFileEncoding(content);
+        csvFileReader.setFileEncoding(content);
+        csvFileWriter.setFileEncoding(content);
+    }
+
     private void setupErrorSideBar(ResourceBundle resourceBundle) {
         errorSideBar = new ErrorSideBar(resourceBundle);
         errorSideBar.selectedValidationErrorProperty().addListener((observable, oldValue, newValue) -> {
@@ -345,8 +368,29 @@ public class SmartCSVController extends FXMLController {
             CsvPreference csvPreference = preferencesController.getCsvPreference();
             setCsvPreference(csvPreference);
             saveCsvPreferences(csvPreference);
+            String fileEncoding = CharsetHelper.getCharsetName(preferencesController.getFileEncoding());
+            setFileEncoding(fileEncoding);
+            saveFileEncoding(fileEncoding);
         } else {
             preferencesController.setCsvPreference(csvPreferenceFile.getContent());
+            preferencesController.setFileEncoding(fileEncodingFile.getContent());
+        }
+    }
+
+    private void saveFileEncoding(String fileEncoding) {
+        try {
+            createFileEncodingFile();
+            fileEncodingFile.setContent(fileEncoding);
+            useSaveFileService(fileEncodingFile);
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+    }
+
+    private void createFileEncodingFile() throws IOException {
+        if (!fileEncodingFile.getFile().exists()) {
+            createPreferencesFileFolder();
+            fileEncodingFile.getFile().createNewFile();
         }
     }
 
@@ -492,9 +536,13 @@ public class SmartCSVController extends FXMLController {
 
     private void loadCsvPreferencesFromFile() {
         if (csvPreferenceFile.getFile().exists()) {
-            useLoadFileService(csvPreferenceFile, event -> setCsvPreference(csvPreferenceFile.getContent()));
+            useLoadFileService(csvPreferenceFile, event -> {
+                setCsvPreference(csvPreferenceFile.getContent());
+                loadEncodingFromFile();
+            });
         } else {
             setCsvPreference(CsvPreference.EXCEL_NORTH_EUROPE_PREFERENCE);
+            loadEncodingFromFile();
         }
     }
 

src/main/java/ninja/javafx/smartcsv/fx/preferences/PreferencesController.java

@@ -39,6 +39,7 @@ import org.springframework.stereotype.Component;
 import org.supercsv.prefs.CsvPreference;
 
 import java.net.URL;
+import java.nio.charset.Charset;
 import java.util.ResourceBundle;
 import java.util.function.UnaryOperator;
 
@@ -66,6 +67,9 @@ public class PreferencesController extends FXMLController {
     @FXML
     private ComboBox<String> quoteMode;
 
+    @FXML
+    private ComboBox<String> fileEncoding;
+
     private String endOfLineSymbols;
 
     private BooleanProperty valid = new SimpleBooleanProperty(true);
@@ -80,6 +84,7 @@ public class PreferencesController extends FXMLController {
     @Override
     public void initialize(URL location, ResourceBundle resources) {
         quoteMode.getItems().addAll("normal", "always", "column");
+        fileEncoding.getItems().addAll(Charset.availableCharsets().keySet());
 
         UnaryOperator<TextFormatter.Change> allowOnlyOneCharacter = change -> {
             if (change.isContentChange()) {
@@ -117,6 +122,14 @@ public class PreferencesController extends FXMLController {
                 .build();
     }
 
+    public void setFileEncoding(String fileEncoding) {
+        this.fileEncoding.setValue(fileEncoding);
+    }
+
+    public String getFileEncoding() {
+        return fileEncoding.getValue();
+    }
+
     public boolean getValid() {
         return valid.get();
     }

src/main/java/ninja/javafx/smartcsv/preferences/CharsetHelper.java

@@ -0,0 +1,44 @@
+/*
+   The MIT License (MIT)
+   -----------------------------------------------------------------------------
+
+   Copyright (c) 2015-2016 javafx.ninja <info@javafx.ninja>
+
+   Permission is hereby granted, free of charge, to any person obtaining a copy
+   of this software and associated documentation files (the "Software"), to deal
+   in the Software without restriction, including without limitation the rights
+   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+   copies of the Software, and to permit persons to whom the Software is
+   furnished to do so, subject to the following conditions:
+
+   The above copyright notice and this permission notice shall be included in
+   all copies or substantial portions of the Software.
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+   THE SOFTWARE.
+
+*/
+
+package ninja.javafx.smartcsv.preferences;
+
+import java.nio.charset.Charset;
+
+/**
+ * Helper class for getting charset's name
+ */
+public class CharsetHelper {
+
+    public static String getCharsetName(String name) {
+        try {
+            return Charset.forName(name).name();
+        } catch (Exception e) {
+            return Charset.defaultCharset().name();
+        }
+    }
+
+}

src/main/java/ninja/javafx/smartcsv/preferences/EncodingFileReader.java

@@ -0,0 +1,62 @@
+/*
+   The MIT License (MIT)
+   -----------------------------------------------------------------------------
+
+   Copyright (c) 2015-2016 javafx.ninja <info@javafx.ninja>
+
+   Permission is hereby granted, free of charge, to any person obtaining a copy
+   of this software and associated documentation files (the "Software"), to deal
+   in the Software without restriction, including without limitation the rights
+   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+   copies of the Software, and to permit persons to whom the Software is
+   furnished to do so, subject to the following conditions:
+
+   The above copyright notice and this permission notice shall be included in
+   all copies or substantial portions of the Software.
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+   THE SOFTWARE.
+
+*/
+
+package ninja.javafx.smartcsv.preferences;
+
+import com.google.gson.GsonBuilder;
+import ninja.javafx.smartcsv.FileReader;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.charset.Charset;
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * file reader for the file encoding
+ */
+public class EncodingFileReader implements FileReader<String> {
+
+    private String fileEncoding;
+
+    public EncodingFileReader() {
+        fileEncoding = Charset.defaultCharset().name();
+    }
+
+    @Override
+    public String getContent() {
+        return fileEncoding;
+    }
+
+    @Override
+    public void read(File filename) throws IOException {
+        Map settings = new GsonBuilder().create().fromJson(new java.io.FileReader(filename), HashMap.class);
+        if (settings != null) {
+            fileEncoding = CharsetHelper.getCharsetName(settings.get("fileEncoding").toString());
+        }
+    }
+
+}

src/main/java/ninja/javafx/smartcsv/preferences/EncodingFileWriter.java

@@ -0,0 +1,59 @@
+/*
+   The MIT License (MIT)
+   -----------------------------------------------------------------------------
+
+   Copyright (c) 2015-2016 javafx.ninja <info@javafx.ninja>
+
+   Permission is hereby granted, free of charge, to any person obtaining a copy
+   of this software and associated documentation files (the "Software"), to deal
+   in the Software without restriction, including without limitation the rights
+   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+   copies of the Software, and to permit persons to whom the Software is
+   furnished to do so, subject to the following conditions:
+
+   The above copyright notice and this permission notice shall be included in
+   all copies or substantial portions of the Software.
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+   THE SOFTWARE.
+
+*/
+
+package ninja.javafx.smartcsv.preferences;
+
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import ninja.javafx.smartcsv.FileWriter;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Save the file encoding to configuration file
+ */
+public class EncodingFileWriter implements FileWriter<String> {
+
+    private String fileEncoding;
+
+    @Override
+    public void setContent(String fileEncoding) {
+        this.fileEncoding = fileEncoding;
+    }
+
+    @Override
+    public void write(File filename) throws IOException {
+        Map<String, String> encodings = new HashMap<>();
+        encodings.put("fileEncoding", CharsetHelper.getCharsetName(fileEncoding));
+        Gson gson = new GsonBuilder().setPrettyPrinting().create();
+        Files.write(filename.toPath(), gson.toJson(encodings).getBytes());
+    }
+
+}

src/main/resources/ninja/javafx/smartcsv/fx/preferences/preferences.fxml

@@ -14,6 +14,7 @@
     <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="NEVER" />
       <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="NEVER" />
       <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="NEVER" />
+      <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="NEVER" />
   </rowConstraints>
    <children>
       <Label text="%preferences.quoteChar" />
@@ -26,6 +27,8 @@
       <CheckBox fx:id="ignoreEmptyLines" mnemonicParsing="false" text="" GridPane.columnIndex="1" GridPane.rowIndex="3" />
       <Label text="%preferences.quoteMode" GridPane.rowIndex="4" />
       <ComboBox fx:id="quoteMode" prefWidth="150.0" GridPane.columnIndex="1" GridPane.rowIndex="4" />
+      <Label text="%preferences.fileEncoding" GridPane.rowIndex="5" />
+      <ComboBox fx:id="fileEncoding" editable="true" prefWidth="150.0" GridPane.columnIndex="1" GridPane.rowIndex="5" />
    </children>
    <padding>
       <Insets bottom="8.0" left="8.0" right="8.0" top="8.0" />

src/main/resources/ninja/javafx/smartcsv/fx/smartcsv.properties

@@ -41,6 +41,7 @@ preferences.delimiterChar = Delimiter character:
 preferences.ignoreEmptyLines = Ignore empty lines:
 preferences.surroundingSpacesNeedQuotes = Surrounding spaces need quotes:
 preferences.quoteMode = Quote mode:
+preferences.fileEncoding = File encoding:
 
 # validaton messages
 validation.message.not.empty = should not be empty

src/main/resources/ninja/javafx/smartcsv/fx/smartcsv_de.properties

@@ -50,6 +50,7 @@ preferences.delimiterChar = Trennzeichen:
 preferences.ignoreEmptyLines = Leere Zeilen ignorieren:
 preferences.surroundingSpacesNeedQuotes = Leerzeichen einfassen:
 preferences.quoteMode = Einfassungsmodus:
+preferences.fileEncoding = Dateicodierung:
 
 # validaton messages
 validation.message.not.empty = Darf nicht leer sein.

src/test/java/ninja/javafx/smartcsv/preferences/CharsetHelperTest.java

@@ -0,0 +1,56 @@
+/*
+   The MIT License (MIT)
+   -----------------------------------------------------------------------------
+
+   Copyright (c) 2015-2016 javafx.ninja <info@javafx.ninja>
+
+   Permission is hereby granted, free of charge, to any person obtaining a copy
+   of this software and associated documentation files (the "Software"), to deal
+   in the Software without restriction, including without limitation the rights
+   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+   copies of the Software, and to permit persons to whom the Software is
+   furnished to do so, subject to the following conditions:
+
+   The above copyright notice and this permission notice shall be included in
+   all copies or substantial portions of the Software.
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+   THE SOFTWARE.
+
+*/
+
+package ninja.javafx.smartcsv.preferences;
+
+import org.junit.jupiter.api.Test;
+
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+public class CharsetHelperTest {
+
+    @Test
+    public void getCharsetName_known_charset() {
+        String result = CharsetHelper.getCharsetName("UTF-16");
+        assertEquals(StandardCharsets.UTF_16.name(), result);
+    }
+
+    @Test
+    public void getCharsetName_unknown_charset() {
+        String result = CharsetHelper.getCharsetName("foobar");
+        assertEquals(StandardCharsets.UTF_8.name(), result);
+    }
+
+    @Test
+    public void getCharsetName_null_charset() {
+        String result = CharsetHelper.getCharsetName(null);
+        assertEquals(StandardCharsets.UTF_8.name(), result);
+    }
+
+}