/*
 *  RapidMiner
 *
 *  Copyright (C) 2001-2011 by Rapid-I and the contributors
 *
 *  Complete list of developers available at our web site:
 *
 *       http://rapid-i.com
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see http://www.gnu.org/licenses/.
 */
package com.rapidminer.tools;

import static com.rapidminer.tools.ParameterService.PROPERTY_RAPIDMINER_SRC_ROOT;
import static com.rapidminer.tools.ParameterService.RAPIDMINER_CONFIG_FILE_NAME;

import java.io.File;
import java.io.IOException;

import com.rapid_i.Launcher;
import com.rapidminer.RapidMiner;
import com.rapidminer.gui.tools.VersionNumber;

/**
 * This service offers methods for accessing the file system. For example
 * to get the current RapidMiner directory, used home directory and several else.
 * 
 * @author Sebastian Land
 */
public class FileSystemService {

    /** Returns the main user configuration file containing the version number and the OS. */
    public static File getMainUserConfigFile() {
        return FileSystemService.getUserConfigFile(RAPIDMINER_CONFIG_FILE_NAME + "." + System.getProperty("os.name"));
    }

    /**
     * Returns the configuration file in the user dir/.RapidMiner5 and automatically adds
     * the current version number if it is a rc file.
     */
    public static File getUserConfigFile(String name) {
        return getVersionedUserConfigFile(new VersionNumber(RapidMiner.getLongVersion()), name);
    }

    public static File getVersionedUserConfigFile(VersionNumber versionNumber, String name) {
        String configName = name;
        if (configName.startsWith(RAPIDMINER_CONFIG_FILE_NAME)) {
            if (versionNumber != null)
                configName = versionNumber.toString().replaceAll("\\.", "_") + "_" + configName;
        }
        return new File(getUserRapidMinerDir(), configName);
    }

    public static File getUserRapidMinerDir() {
        File homeDir = new File(System.getProperty("user.home"));
        File userHomeDir = new File(homeDir, ".RapidMiner5");
        if (!userHomeDir.exists()) {
            LogService.getRoot().config("Creating directory '" + userHomeDir + "'.");
            boolean result = userHomeDir.mkdir();
            if (!result)
                LogService.getRoot().warning("Unable to create user home rapidminer directory " + userHomeDir);
        }
        return userHomeDir;
    }

    public static File getRapidMinerHome() throws IOException {
        String property = System.getProperty(Launcher.PROPERTY_RAPIDMINER_HOME);
        if (property == null) {
            throw new IOException("Property " + Launcher.PROPERTY_RAPIDMINER_HOME + " is not set");
        }
        return new File(property);
    }

    public static File getLibraryFile(String name) throws IOException {
        File home = getRapidMinerHome();
        return new File(home, "lib" + File.separator + name);
    }

    public static File getSourceRoot() {
        String srcName = System.getProperty(PROPERTY_RAPIDMINER_SRC_ROOT);
        if (srcName == null) {
            LogService.getRoot().warning("Property " + PROPERTY_RAPIDMINER_SRC_ROOT + " not set.");
            return null;
        } else {
            return new File(srcName);
        }
    }

    public static File getSourceFile(String name) {
        File root = getSourceRoot();
        if (root == null) {
            return null;
        } else {
            return new File(new File(root, "src"), name);
        }
    }

    public static File getSourceResourceFile(String name) {
        File root = getSourceRoot();
        if (root == null) {
            return null;
        } else {
            return new File(new File(root, "resources"), name);
        }
    }

}