com.willwinder.universalgcodesender.firmware.FirmwareSettingUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ugs-core Show documentation
Universal Gcode Sender Library
The newest version!
package com.willwinder.universalgcodesender.firmware;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.willwinder.universalgcodesender.IController;
import com.willwinder.universalgcodesender.i18n.Localization;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.StringUtils;

import javax.swing.JOptionPane;
import java.awt.Frame;
import java.io.File;
import java.io.IOException;
import java.time.LocalDate;
import java.time.format.DateTimeFormatter;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Static utils for handling firmware settings
 *
 * @author Joacim Breiler
 */
public class FirmwareSettingUtils {
    private static final Logger LOGGER = Logger.getLogger(FirmwareSettingUtils.class.getName());

    /**
     * Imports firmware settings from a settings file. Displays a popup with a question if the file should be imported.
     *
     * @param settingsFile     the file containing a JSON with {@link FirmwareSettingsFile}
     * @param firmwareSettings the firmware settings to update
     */
    public static void importSettings(File settingsFile, IFirmwareSettings firmwareSettings) {
        try {
            FirmwareSettingsFile firmwareSettingsFile = readSettings(settingsFile);
            String message = Localization.getString("firmware.settings.importSettings") + "\n\n  " +
                    Localization.getString("firmware.settings.importSettingsName") + ": " + firmwareSettingsFile.getName() + "\n  " +
                    Localization.getString("firmware.settings.importSettingsDate") + ": " + firmwareSettingsFile.getDate() + "\n  " +
                    Localization.getString("firmware.settings.importSettingsCreatedBy") + ": " + firmwareSettingsFile.getCreatedBy() + "\n  " +
                    Localization.getString("firmware.settings.importSettingsFirmware") + ": " + firmwareSettingsFile.getFirmwareName();

            int result = JOptionPane.showConfirmDialog(new Frame(), message, Localization.getString("firmware.settings.importSettingsTitle"), JOptionPane.OK_CANCEL_OPTION);
            if (result == JOptionPane.OK_OPTION) {
                firmwareSettings.setSettings(firmwareSettingsFile.getSettings());
            }
        } catch (IOException e) {
            LOGGER.log(Level.SEVERE, "Couldn't open the settings file " + settingsFile.getAbsolutePath(), e);
        } catch (FirmwareSettingsException e) {
            LOGGER.log(Level.SEVERE, "Couldn't update all settings", e);
        }
    }

    /**
     * Exports the current firmware settings to a file. The file will be in JSON format with
     * {@link FirmwareSettingsFile}
     *
     * @param settingsFile the file to write the settings to.
     * @param controller   the controller to get the firmware settings from
     */
    public static void exportSettings(final File settingsFile, IController controller) {
        File file = settingsFile;
        if (!StringUtils.endsWith(settingsFile.getName(), ".settings")) {
            file = new File(settingsFile.getAbsolutePath() + ".settings");
        }

        FirmwareSettingsFile firmwareSettingsFile = new FirmwareSettingsFileBuilder()
                .setCreatedBy(System.getProperty("user.name"))
                .setDate(LocalDate.now().format(DateTimeFormatter.ISO_DATE))
                .setFirmwareName(controller.getFirmwareVersion())
                .setName(Localization.getString("firmware.settings.exportSettingsDefaultName"))
                .setSettings(controller.getFirmwareSettings().getAllSettings())
                .build();

        Gson gson = new GsonBuilder()
                .setPrettyPrinting()
                .create();

        try {
            String json = gson.toJson(firmwareSettingsFile);
            FileUtils.writeStringToFile(file, json);
        } catch (IOException e) {
            LOGGER.log(Level.SEVERE, "Couldn't write the settings file " + settingsFile.getAbsolutePath(), e);
        }
    }

    /**
     * Reads a file and parses it to a firmware settings file
     *
     * @param settingsFile the file containing a JSON with {@link FirmwareSettingsFile}
     * @return the firmware settings together with its meta data
     * @throws IOException if the settings file couldn't be read or parsed
     */
    public static FirmwareSettingsFile readSettings(File settingsFile) throws IOException {
        String json = FileUtils.readFileToString(settingsFile);
        Gson gson = new Gson();
        return gson.fromJson(json, FirmwareSettingsFile.class);
    }
}