PluginINI.java

/**
 * Copyright (C) 2009-2014 Cars and Tracks Development Project (CTDP).
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package net.ctdp.rfdynhud.util;

import java.io.File;

import org.jagatoo.util.errorhandling.ParsingException;
import org.jagatoo.util.ini.AbstractIniParser;
import org.jagatoo.util.io.FileUtils;

/**
 * Abstraction of the main ini file for the plugin.
 * 
 * @author Marvin Froehlich (CTDP)
 */
public class PluginINI
{
    private static final File IDE_DATA_FOLDER = ResourceManager.isCompleteIDEMode() ? FileUtils.getCanonicalFile( "yyy_data" ) : null;
    
    public static final String FILENAME = "rfdynhud.ini";
    
    private final File pluginFolder;
    private final File iniFile;
    
    private long lastModified = -1;
    
    private String general_language = null;
    private String general_exeFilename = null;
    private File general_logFolder = null;
    private File general_configFolder = null;
    private File general_cacheFolder = null;
    private String general_threeLetterCodeGenerator = null;
    private String editor_propertyDisplayNameGenerator = null;
    
    private void reset()
    {
        general_language = null;
        general_exeFilename = null;
        general_logFolder = null;
        general_configFolder = null;
        general_cacheFolder = null;
        general_threeLetterCodeGenerator = null;
        editor_propertyDisplayNameGenerator = null;
    }
    
    private static String parsePath( String path )
    {
        int p;
        while ( ( p = path.indexOf( "${" ) ) >= 0 )
        {
            int p2 = path.indexOf( '}', p + 1 );
            if ( p2 < 0 )
                break;
            
            String val = System.getenv( path.substring( p + 2, p2 ) );
            if ( val == null )
                val = "";
            
            if ( p == 0 )
            {
                if ( p2 == path.length() - 1 )
                {
                    path = val;
                }
                else
                {
                    path = val + path.substring( p2 + 1 );
                }
            }
            else if ( p2 == path.length() - 1 )
            {
                path = path.substring( 0, p ) + val;
            }
            else
            {
                path = path.substring( 0, p ) + val + path.substring( p2 + 1 );
            }
        }
        
        return ( path );
    }
    
    /**
     * 
     * @param name
     * @param configPath
     * @param fallback
     * 
     * @return the folder.
     */
    private File getFolder( String name, String configPath, String fallback )
    {
        if ( configPath == null )
            configPath = new File( pluginFolder, fallback ).getAbsolutePath();
        
        configPath = parsePath( configPath );
        File f = new File( configPath );
        if ( !f.isAbsolute() )
        {
            if ( ResourceManager.isCompleteIDEMode() )
                f = new File( IDE_DATA_FOLDER, fallback );
            else
                f = new File( pluginFolder, configPath );
        }
        
        f = FileUtils.getCanonicalFile( f );
        
        //RFDHLog.printlnEx( "Using " + name + " folder \"" + f.getAbsolutePath() + "\"." );
        
        if ( !ResourceManager.isCompleteIDEMode() || !name.equals( "log" ) )
        {
            try
            {
                f.mkdirs();
            }
            catch ( Throwable t )
            {
                t.printStackTrace();
                //RFDHLog.exception( t );
                //RFDHLog.exception( "[ERROR] The " + name + " folder doesn't exist and couldn't be created." );
            }
        }
        
        return ( f );
    }
    
    private void update()
    {
        if ( iniFile.lastModified() <= lastModified )
            return;
        
        reset();
        
        try
        {
            new AbstractIniParser()
            {
                @Override
                protected boolean onSettingParsed( int lineNr, String group, String key, String value, String comment ) throws ParsingException
                {
                    if ( group == null )
                    {
                    }
                    else if ( group.equalsIgnoreCase( "GENERAL" ) )
                    {
                        if ( key.equalsIgnoreCase( "language" ) )
                        {
                            general_language = value;
                        }
                        else if ( key.equalsIgnoreCase( "exeFilename" ) )
                        {
                            general_exeFilename = value;
                        }
                        else if ( key.equalsIgnoreCase( "logFolder" ) )
                        {
                            general_logFolder = getFolder( "log", value, "log" );
                        }
                        else if ( key.equalsIgnoreCase( "configFolder" ) )
                        {
                            general_configFolder = getFolder( "config", value, "config" );
                        }
                        else if ( key.equalsIgnoreCase( "cacheFolder" ) )
                        {
                            if ( ( value == null ) || value.equals( "" ) )
                                general_cacheFolder = null;
                            else
                                general_cacheFolder = getFolder( "cache", value, "cache" );
                        }
                        else if ( key.equalsIgnoreCase( "threeLetterCodeGenerator" ) )
                        {
                            general_threeLetterCodeGenerator = value;
                        }
                    }
                    else if ( group.equalsIgnoreCase( "EDITOR" ) )
                    {
                        if ( key.equalsIgnoreCase( "propertyDisplayNameGenerator" ) )
                        {
                            editor_propertyDisplayNameGenerator = value;
                        }
                    }
                    
                    return ( true );
                }
            }.parse( iniFile );
            
            lastModified = iniFile.lastModified();
        }
        catch ( Throwable t )
        {
            t.printStackTrace();
            //RFDHLog.exception( t );
        }
    }
    
    /**
     * Gets the language setting from GENERAL group.
     * 
     * @return the language setting from GENERAL group.
     */
    public final String getGeneralLanguage()
    {
        update();
        
        return ( general_language );
    }
    
    /**
     * Gets the exe filename from GENERAL group.
     * 
     * @return the exe filename from GENERAL group.
     */
    public final String getGeneralExeFilename()
    {
        update();
        
        return ( general_exeFilename );
    }
    
    /**
     * Gets the configFolder setting from GENERAL group.
     * 
     * @return the configFolder setting from GENERAL group.
     */
    public final File getGeneralLogFolder()
    {
        update();
        
        return ( general_logFolder );
    }
    
    /**
     * Gets the configFolder setting from GENERAL group.
     * 
     * @return the configFolder setting from GENERAL group.
     */
    public final File getGeneralConfigFolder()
    {
        update();
        
        return ( general_configFolder );
    }
    
    /**
     * Gets the cacheFolder setting from GENERAL group.
     * 
     * @return the cacheFolder setting from GENERAL group.
     */
    public final File getGeneralCacheFolder()
    {
        update();
        
        return ( general_cacheFolder );
    }
    
    /**
     * Gets the class name of the threeLetterCodeGenrator setting from GENERAL group.
     * 
     * @return the threeLetterCodeGenrator setting from GENERAL group.
     */
    public final String getGeneralThreeLetterCodeGeneratorClass()
    {
        update();
        
        return ( general_threeLetterCodeGenerator );
    }
    
    /**
     * Gets the class name of the propertyDisplayNameGenerator setting from EDITOR group.
     * 
     * @return the propertyDisplayNameGenerator setting from EDITOR group.
     */
    public final String getEditorPropertyDisplayNameGeneratorClass()
    {
        update();
        
        return ( editor_propertyDisplayNameGenerator );
    }
    
    public PluginINI( File pluginFolder )
    {
        this.pluginFolder = pluginFolder;
        this.iniFile = new File( pluginFolder, FILENAME );
    }
}