tim/prune/config/Config.java

   1 package tim.prune.config;
   2
   3 import java.io.File;
   4 import java.io.FileInputStream;
   5 import java.util.Properties;
   6
   7 import tim.prune.data.RecentFileList;
   8 import tim.prune.data.UnitSet;
   9 import tim.prune.data.UnitSetLibrary;
  10 import tim.prune.gui.colour.ColourerFactory;
  11 import tim.prune.gui.colour.PointColourer;
  12 import tim.prune.gui.map.MapSourceLibrary;
  13
  14
  15 /**
  16  * Abstract class to hold application-wide configuration
  17  */
  18 public abstract class Config
  19 {
  20         /** File from which Config was loaded */
  21         private static File _configFile = null;
  22
  23         /** Hashtable containing all config values */
  24         private static Properties _configValues = null;
  25         /** Colour scheme object is also part of config */
  26         private static ColourScheme _colourScheme = new ColourScheme();
  27         /** Point colourer object, if any */
  28         private static PointColourer _pointColourer = null;
  29         /** Recently-used file list */
  30         private static RecentFileList _recentFiles = new RecentFileList();
  31         /** Current unit set */
  32         private static UnitSet _unitSet = UnitSetLibrary.getUnitSet(null);
  33
  34         /** Default config file */
  35         public static final File DEFAULT_CONFIG_FILE = new File(".pruneconfig");
  36         public static final File HOME_CONFIG_FILE = new File(System.getProperty("user.home"), ".pruneconfig");
  37
  38         /** Key for track directory */
  39         public static final String KEY_TRACK_DIR = "prune.trackdirectory";
  40         /** Key for photo directory */
  41         public static final String KEY_PHOTO_DIR = "prune.photodirectory";
  42         /** Key for language code */
  43         public static final String KEY_LANGUAGE_CODE = "prune.languagecode";
  44         /** Key for language file */
  45         public static final String KEY_LANGUAGE_FILE = "prune.languagefile";
  46         /** Key for GPS device */
  47         public static final String KEY_GPS_DEVICE = "prune.gpsdevice";
  48         /** Key for GPS format */
  49         public static final String KEY_GPS_FORMAT = "prune.gpsformat";
  50         /** Key for GPSBabel filter string */
  51         public static final String KEY_GPSBABEL_FILTER = "prune.gpsbabelfilter";
  52         /** Key for GPSBabel import file format */
  53         public static final String KEY_IMPORT_FILE_FORMAT = "prune.lastimportfileformat";
  54         /** Key for Povray font */
  55         public static final String KEY_POVRAY_FONT = "prune.povrayfont";
  56         /** Key for the selected unit set */
  57         public static final String KEY_UNITSET_KEY  = "prune.unitsetkey";
  58         /** Key for index of map source */
  59         public static final String KEY_MAPSOURCE_INDEX = "prune.mapsource";
  60         /** Key for number of fixed map sources */
  61         public static final String KEY_NUM_FIXED_MAPS = "prune.numfixedmapsources";
  62         /** Key for String containing custom map sources */
  63         public static final String KEY_MAPSOURCE_LIST = "prune.mapsourcelist";
  64         /** Key for show map flag */
  65         public static final String KEY_SHOW_MAP = "prune.showmap";
  66         /** Key for path to disk cache */
  67         public static final String KEY_DISK_CACHE = "prune.diskcache";
  68         /** Key for working online flag */
  69         public static final String KEY_ONLINE_MODE = "prune.onlinemode";
  70         /** Key for width of thumbnails in kmz */
  71         public static final String KEY_KMZ_IMAGE_SIZE = "prune.kmzimagewidth";
  72         /** Key for gpsbabel path */
  73         public static final String KEY_GPSBABEL_PATH = "prune.gpsbabelpath";
  74         /** Key for gnuplot path */
  75         public static final String KEY_GNUPLOT_PATH = "prune.gnuplotpath";
  76         /** Key for exiftool path */
  77         public static final String KEY_EXIFTOOL_PATH = "prune.exiftoolpath";
  78         /** Key for colour scheme */
  79         public static final String KEY_COLOUR_SCHEME = "prune.colourscheme";
  80         /** Key for point colourer */
  81         public static final String KEY_POINT_COLOURER = "prune.pointcolourer";
  82         /** Key for line width used for drawing */
  83         public static final String KEY_LINE_WIDTH = "prune.linewidth";
  84         /** Key for whether to use antialiasing or not */
  85         public static final String KEY_ANTIALIAS = "prune.antialias";
  86         /** Key for kml track colour */
  87         public static final String KEY_KML_TRACK_COLOUR = "prune.kmltrackcolour";
  88         /** Key for autosaving settings */
  89         public static final String KEY_AUTOSAVE_SETTINGS = "prune.autosavesettings";
  90         /** Key for recently used files */
  91         public static final String KEY_RECENT_FILES = "prune.recentfiles";
  92         /** Key for estimation parameters */
  93         public static final String KEY_ESTIMATION_PARAMS = "prune.estimationparams";
  94         /** Key for 3D exaggeration factor */
  95         public static final String KEY_HEIGHT_EXAGGERATION = "prune.heightexaggeration";
  96         /** Key for terrain grid size */
  97         public static final String KEY_TERRAIN_GRID_SIZE = "prune.terraingridsize";
  98         /** Key for altitude tolerance */
  99         public static final String KEY_ALTITUDE_TOLERANCE = "prune.altitudetolerance";
 100
 101
 102         /** Initialise the default properties */
 103         static
 104         {
 105                 _configValues = getDefaultProperties();
 106         }
 107
 108         /**
 109          * Load the default configuration file
 110          */
 111         public static void loadDefaultFile()
 112         {
 113                 if (DEFAULT_CONFIG_FILE.exists())
 114                 {
 115                         try {
 116                                 loadFile(DEFAULT_CONFIG_FILE);
 117                                 return;
 118                         }
 119                         catch (ConfigException ce) {} // ignore
 120                 }
 121                 if (HOME_CONFIG_FILE.exists())
 122                 {
 123                         try {
 124                                 loadFile(HOME_CONFIG_FILE);
 125                         }
 126                         catch (ConfigException ce) {} // ignore
 127                 }
 128         }
 129
 130
 131         /**
 132          * Load configuration from file
 133          * @param inFile file to load
 134          * @throws ConfigException if specified file couldn't be read
 135          */
 136         public static void loadFile(File inFile) throws ConfigException
 137         {
 138                 // Start with default properties
 139                 Properties props = getDefaultProperties();
 140                 // Try to load the file into a properties object
 141                 boolean loadFailed = false;
 142                 FileInputStream fis = null;
 143                 try
 144                 {
 145                         fis = new FileInputStream(inFile);
 146                         props.load(fis);
 147                 }
 148                 catch (Exception e) {
 149                         loadFailed = true;
 150                 }
 151                 finally {
 152                         if (fis != null) try {
 153                                 fis.close();
 154                         }
 155                         catch (Exception e) {}
 156                 }
 157                 // Save all properties from file
 158                 _configValues.putAll(props);
 159                 _colourScheme.loadFromHex(_configValues.getProperty(KEY_COLOUR_SCHEME));
 160                 _pointColourer = ColourerFactory.createColourer(_configValues.getProperty(KEY_POINT_COLOURER));
 161                 _recentFiles = new RecentFileList(_configValues.getProperty(KEY_RECENT_FILES));
 162                 _unitSet = UnitSetLibrary.getUnitSet(_configValues.getProperty(KEY_UNITSET_KEY));
 163                 // Adjust map source index if necessary
 164                 adjustSelectedMap();
 165
 166                 if (loadFailed) {
 167                         throw new ConfigException();
 168                 }
 169                 // Store location of successfully loaded config file
 170                 _configFile = inFile;
 171         }
 172
 173         /**
 174          * @return Properties object containing default values
 175          */
 176         private static Properties getDefaultProperties()
 177         {
 178                 Properties props = new Properties();
 179                 // Fill in defaults
 180                 props.put(KEY_GPS_DEVICE, "usb:");
 181                 props.put(KEY_GPS_FORMAT, "garmin");
 182                 props.put(KEY_POVRAY_FONT, "crystal.ttf"); // alternative: DejaVuSans-Bold.ttf
 183                 props.put(KEY_SHOW_MAP, "0"); // hide by default
 184                 props.put(KEY_EXIFTOOL_PATH, "exiftool");
 185                 props.put(KEY_GNUPLOT_PATH, "gnuplot");
 186                 props.put(KEY_GPSBABEL_PATH, "gpsbabel");
 187                 props.put(KEY_IMPORT_FILE_FORMAT, "-1"); // no file format selected
 188                 props.put(KEY_KMZ_IMAGE_SIZE, "240");
 189                 props.put(KEY_ANTIALIAS, "1"); // antialias on by default
 190                 props.put(KEY_AUTOSAVE_SETTINGS, "0"); // autosave false by default
 191                 props.put(KEY_UNITSET_KEY, "unitset.kilometres"); // metric by default
 192                 props.put(KEY_HEIGHT_EXAGGERATION, "100"); // 100%, no exaggeration
 193                 props.put(KEY_TERRAIN_GRID_SIZE, "50");
 194                 props.put(KEY_ALTITUDE_TOLERANCE, "0"); // 0, all exact as before
 195                 return props;
 196         }
 197
 198         /**
 199          * Adjust the index of the selected map
 200          * (only required if config was loaded from a previous version of GpsPrune)
 201          */
 202         private static void adjustSelectedMap()
 203         {
 204                 int sourceNum = getConfigInt(Config.KEY_MAPSOURCE_INDEX);
 205                 int prevNumFixed = getConfigInt(Config.KEY_NUM_FIXED_MAPS);
 206                 // Number of fixed maps not specified in version <=13, default to 6
 207                 if (prevNumFixed == 0) prevNumFixed = 6;
 208                 int currNumFixed = MapSourceLibrary.getNumFixedSources();
 209                 // Only need to do something if the number has changed
 210                 if (currNumFixed != prevNumFixed && (sourceNum >= prevNumFixed || sourceNum >= currNumFixed))
 211                 {
 212                         sourceNum += (currNumFixed - prevNumFixed);
 213                         setConfigInt(Config.KEY_MAPSOURCE_INDEX, sourceNum);
 214                 }
 215                 setConfigInt(Config.KEY_NUM_FIXED_MAPS, currNumFixed);
 216         }
 217
 218         /**
 219          * @param inString String to parse
 220          * @return int value of String, or 0 if unparseable
 221          */
 222         private static int parseInt(String inString)
 223         {
 224                 int val = 0;
 225                 try {
 226                         val = Integer.parseInt(inString);
 227                 }
 228                 catch (Exception e) {} // ignore, value stays zero
 229                 return val;
 230         }
 231
 232         /** @return File from which config was loaded (or null) */
 233         public static File getConfigFile()
 234         {
 235                 return _configFile;
 236         }
 237
 238         /**
 239          * @return config Properties object to allow all config values to be saved
 240          */
 241         public static Properties getAllConfig()
 242         {
 243                 // Update recently-used files
 244                 _configValues.setProperty(KEY_RECENT_FILES, _recentFiles.getConfigString());
 245                 return _configValues;
 246         }
 247
 248         /**
 249          * @return the current colour scheme
 250          */
 251         public static ColourScheme getColourScheme()
 252         {
 253                 return _colourScheme;
 254         }
 255
 256         /**
 257          * @return the current point colourer, if any
 258          */
 259         public static PointColourer getPointColourer()
 260         {
 261                 return _pointColourer;
 262         }
 263
 264         /**
 265          * @return list of recently used files
 266          */
 267         public static RecentFileList getRecentFileList()
 268         {
 269                 return _recentFiles;
 270         }
 271
 272         /**
 273          * Store the given configuration setting
 274          * @param inKey key (from constants)
 275          * @param inValue value as string
 276          */
 277         public static void setConfigString(String inKey, String inValue)
 278         {
 279                 if (inValue == null || inValue.equals("")) {
 280                         _configValues.remove(inKey);
 281                 }
 282                 else {
 283                         _configValues.put(inKey, inValue);
 284                 }
 285         }
 286
 287         /**
 288          * Store the given configuration setting
 289          * @param inKey key (from constants)
 290          * @param inValue value as boolean
 291          */
 292         public static void setConfigBoolean(String inKey, boolean inValue)
 293         {
 294                 if (inKey != null && !inKey.equals(""))
 295                 {
 296                         _configValues.put(inKey, (inValue?"1":"0"));
 297                 }
 298         }
 299
 300         /**
 301          * Store the given configuration setting
 302          * @param inKey key (from constants)
 303          * @param inValue value as int
 304          */
 305         public static void setConfigInt(String inKey, int inValue)
 306         {
 307                 if (inKey != null && !inKey.equals(""))
 308                 {
 309                         _configValues.put(inKey, "" + inValue);
 310                 }
 311         }
 312
 313         /**
 314          * Get the given configuration setting as a String
 315          * @param inKey key
 316          * @return configuration setting as a String
 317          */
 318         public static String getConfigString(String inKey)
 319         {
 320                 return _configValues.getProperty(inKey);
 321         }
 322
 323         /**
 324          * Get the given configuration setting as a boolean
 325          * @param inKey key
 326          * @return configuration setting as a boolean (default to true)
 327          */
 328         public static boolean getConfigBoolean(String inKey)
 329         {
 330                 String val = _configValues.getProperty(inKey);
 331                 return (val == null || val.equals("1"));
 332         }
 333
 334         /**
 335          * Get the given configuration setting as an int
 336          * @param inKey key
 337          * @return configuration setting as an int
 338          */
 339         public static int getConfigInt(String inKey)
 340         {
 341                 return parseInt(_configValues.getProperty(inKey));
 342         }
 343
 344         /**
 345          * Check whether the given key corresponds to a boolean property
 346          * @param inKey key to check
 347          * @return true if corresponding property is boolean
 348          */
 349         public static boolean isKeyBoolean(String inKey)
 350         {
 351                 return inKey != null && (
 352                         inKey.equals(KEY_SHOW_MAP) || inKey.equals(KEY_AUTOSAVE_SETTINGS) || inKey.equals(KEY_ONLINE_MODE)
 353                         || inKey.equals(KEY_ANTIALIAS));
 354         }
 355
 356         /**
 357          * Update the colour scheme property from the current settings
 358          */
 359         public static void updateColourScheme()
 360         {
 361                 setConfigString(KEY_COLOUR_SCHEME, _colourScheme.toString());
 362         }
 363
 364         /**
 365          * Update the point colourer from the given colourer
 366          * @param inColourer point colourer object, or null
 367          */
 368         public static void updatePointColourer(PointColourer inColourer)
 369         {
 370                 _pointColourer = inColourer;
 371                 setConfigString(KEY_POINT_COLOURER, ColourerFactory.PointColourerToString(_pointColourer));
 372         }
 373
 374         /**
 375          * @return the current unit set
 376          */
 377         public static UnitSet getUnitSet() {
 378                 return _unitSet;
 379         }
 380
 381         /**
 382          * @param inIndex index of unit set to select
 383          */
 384         public static void selectUnitSet(int inIndex)
 385         {
 386                 _unitSet = UnitSetLibrary.getUnitSet(inIndex);
 387                 // Set name of set in config
 388                 setConfigString(KEY_UNITSET_KEY, _unitSet.getNameKey());
 389         }
 390 }