CustomFolders.java

package fr.tikione.steam.cleaner.util.conf;

import fr.tikione.ini.InfinitiveLoopException;
import fr.tikione.ini.Ini;
import fr.tikione.steam.cleaner.Main;

import java.io.CharConversionException;
import java.io.File;
import java.io.IOException;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.regex.Matcher;

/**
 * List of custom folders for redistributable packages research.
 */
public class CustomFolders {
    
    /** INI configuration file section : custom folders. */
    private static final String CONFIG_CUSTOM_FOLDERS = "CUSTOM_FOLDERS";
    
    /** INI configuration file key : custom folders. */
    private static final String CONFIG_CUSTOM_FOLDERS__ITEM_LIST = "itemList";
    
    /** File to use for configuration loading and saving. */
    private final File configFile;
    
    /** Configuration object. */
    private final Ini ini;
    
    private boolean updated = false;
    
    /**
     * Load application configuration file. A default configuration file is created if necessary.
     *
     * @throws IOException if an I/O error occurs while retrieving the internal default configuration file, or while writing this default
     *         configuration file.
     */
    public CustomFolders()
            throws IOException {
        File backupConfigFile = new File("conf/backup/tikione-steam-cleaner_custom-folders.ini");
        File userprofile = new File(Config.getProfilePath());
        //noinspection ResultOfMethodCallIgnored
        userprofile.mkdirs();
        configFile = new File(userprofile.getAbsolutePath() + "/tikione-steam-cleaner_custom-folders.ini");
        if (!configFile.exists()) {
            org.apache.commons.io.FileUtils.copyFile(backupConfigFile, configFile);
        }
        ini = new Ini();
        ini.getConfig().enableParseLineConcat(false);
        ini.getConfig().enableReadUnicodeEscConv(false);
        ini.load(configFile, Main.CONF_ENCODING);
    }
    
    /**
     * Saves the unchecked items list into a file.
     *
     * @throws IOException if an I/O error occurs while writing the file.
     */
    public void save()
            throws IOException {
        if (updated || !configFile.exists()) {
            ini.store(configFile, Main.CONF_ENCODING, Main.CONF_NEWLINE);
        }
    }
    
    /**
     * Get the list of unchecked items memorized from the file.
     *
     * @return the list of unchecked items.
     * @throws CharConversionException if an error occurs while retrieving the list from the file (invalid characters).
     * @throws InfinitiveLoopException if an error occurs while retrieving the list from the file (file parsing error).
     */
    @SuppressWarnings("unchecked")
    public List<String> getCustomFolders()
            throws CharConversionException,
            InfinitiveLoopException {
        String itemTable = ini.getKeyValue(null, CONFIG_CUSTOM_FOLDERS, CONFIG_CUSTOM_FOLDERS__ITEM_LIST);
        List<String> res;
        if (itemTable == null) {
            res = Collections.EMPTY_LIST;
        } else {
            res = Arrays.asList(itemTable.split(Matcher.quoteReplacement("\""), 0));
        }
        return res;
    }
    
    /**
     * Set the list of unchecked items to memorize.
     *
     * @param items the items to memorize.
     * @throws CharConversionException if an error occurs while setting the list from the file (invalid characters).
     * @throws InfinitiveLoopException if an error occurs while setting the list from the file (file parsing error).
     */
    @SuppressWarnings("Duplicates")
    public void setCustomFolders(List<String> items)
            throws CharConversionException,
            InfinitiveLoopException {
        List<String> prevItems = getCustomFolders();
        if (!prevItems.containsAll(items) || !items.containsAll(prevItems)) {
            updated = true;
            StringBuilder buffer = new StringBuilder(512);
            boolean first = true;
            for (String item : items) {
                if (first) {
                    buffer.append(item);
                } else {
                    buffer.append('\"').append(item);
                }
                first = false;
            }
            ini.setKeyValue(CONFIG_CUSTOM_FOLDERS, CONFIG_CUSTOM_FOLDERS__ITEM_LIST, buffer.toString());
        }
    }
}