src/Input/FGDeviceConfigurationMap.cxx

   1 // FGDeviceConfigurationMap.cxx -- a map to access xml device configuration
   2 //
   3 // Written by Torsten Dreyer, started August 2009
   4 // Based on work from David Megginson, started May 2001.
   5 //
   6 // Copyright (C) 2009 Torsten Dreyer, Torsten (at) t3r _dot_ de
   7 // Copyright (C) 2001 David Megginson, david@megginson.com
   8 //
   9 // This program is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU General Public License as
  11 // published by the Free Software Foundation; either version 2 of the
  12 // License, or (at your option) any later version.
  13 //
  14 // This program is distributed in the hope that it will be useful, but
  15 // WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 // General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU General Public License
  20 // along with this program; if not, write to the Free Software
  21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  22 //
  23 // $Id$
  24
  25 #ifdef HAVE_CONFIG_H
  26 #  include <config.h>
  27 #endif
  28
  29 #include "FGDeviceConfigurationMap.hxx"
  30
  31 #include <boost/foreach.hpp>
  32
  33 #include <simgear/misc/sg_dir.hxx>
  34 #include <simgear/props/props_io.hxx>
  35 #include <simgear/structure/exception.hxx>
  36
  37 #include <Main/globals.hxx>
  38 #include <Navaids/NavDataCache.hxx>
  39
  40 using simgear::PropertyList;
  41 using std::string;
  42
  43 FGDeviceConfigurationMap::FGDeviceConfigurationMap( const string& relative_path,
  44                                                    SGPropertyNode* nodePath,
  45                                                    const std::string& nodeName)
  46 {
  47   // scan for over-ride configurations, loaded via joysticks.xml, etc
  48   BOOST_FOREACH(SGPropertyNode_ptr preloaded, nodePath->getChildren(nodeName)) {
  49     BOOST_FOREACH(SGPropertyNode* nameProp, preloaded->getChildren("name")) {
  50       overrideDict[nameProp->getStringValue()] = preloaded;
  51     } // of names iteration
  52   } // of defined overrides iteration
  53
  54   scan_dir( SGPath(globals->get_fg_home(), relative_path));
  55   scan_dir( SGPath(globals->get_fg_root(), relative_path));
  56 }
  57
  58 FGDeviceConfigurationMap::~FGDeviceConfigurationMap()
  59 {
  60 }
  61
  62 SGPropertyNode_ptr
  63 FGDeviceConfigurationMap::configurationForDeviceName(const std::string& name)
  64 {
  65   NameNodeMap::iterator j = overrideDict.find(name);
  66   if (j != overrideDict.end()) {
  67     return j->second;
  68   }
  69
  70 // no override, check out list of config files
  71   NamePathMap::iterator it = namePathMap.find(name);
  72   if (it == namePathMap.end()) {
  73     return SGPropertyNode_ptr();
  74   }
  75
  76   SGPropertyNode_ptr result(new SGPropertyNode);
  77   try {
  78     readProperties(it->second.str(), result);
  79     result->setStringValue("source", it->second.c_str());
  80   } catch (sg_exception&) {
  81     SG_LOG(SG_INPUT, SG_WARN, "parse failure reading:" << it->second);
  82     return NULL;
  83   }
  84   return result;
  85 }
  86
  87 bool FGDeviceConfigurationMap::hasConfiguration(const std::string& name) const
  88 {
  89   NameNodeMap::const_iterator j = overrideDict.find(name);
  90   if (j != overrideDict.end()) {
  91     return true;
  92   }
  93
  94   return namePathMap.find(name) != namePathMap.end();
  95 }
  96
  97 void FGDeviceConfigurationMap::scan_dir(const SGPath & path)
  98 {
  99   if (!path.exists())
 100     return;
 101
 102   flightgear::NavDataCache* cache = flightgear::NavDataCache::instance();
 103   flightgear::NavDataCache::Transaction txn(cache);
 104
 105   simgear::Dir dir(path);
 106   simgear::PathList children = dir.children(simgear::Dir::TYPE_FILE |
 107     simgear::Dir::TYPE_DIR | simgear::Dir::NO_DOT_OR_DOTDOT);
 108
 109   BOOST_FOREACH(SGPath path, children) {
 110     if (path.isDir()) {
 111       scan_dir(path);
 112     } else if (path.extension() == "xml") {
 113       if (cache->isCachedFileModified(path)) {
 114         refreshCacheForFile(path);
 115       } else {
 116         readCachedData(path);
 117       } // of cached file stamp is valid
 118     } // of child is a file with '.xml' extension
 119   } // of directory children iteration
 120
 121   txn.commit();
 122 }
 123
 124 void FGDeviceConfigurationMap::readCachedData(const SGPath& path)
 125 {
 126   flightgear::NavDataCache* cache = flightgear::NavDataCache::instance();
 127   NamePathMap::iterator it;
 128   BOOST_FOREACH(string s, cache->readStringListProperty(path.str())) {
 129     // important - only insert if not already present. This ensures
 130     // user configs can override those in the base package, since they are
 131     // searched first.
 132     it = namePathMap.find(s);
 133     if (it == namePathMap.end()) {
 134       namePathMap.insert(std::make_pair(s, path));
 135     }
 136   } // of cached names iteration
 137 }
 138
 139 void FGDeviceConfigurationMap::refreshCacheForFile(const SGPath& path)
 140 {
 141   SG_LOG(SG_INPUT, SG_DEBUG, "Reading joystick file " << path.str());
 142   SGPropertyNode_ptr n(new SGPropertyNode);
 143   try {
 144     readProperties(path.str(), n);
 145   } catch (sg_exception&) {
 146     SG_LOG(SG_INPUT, SG_WARN, "parse failure reading:" << path);
 147     return;
 148   }
 149
 150   NamePathMap::iterator it;
 151   string_list names;
 152   BOOST_FOREACH(SGPropertyNode* nameProp, n->getChildren("name")) {
 153     names.push_back(nameProp->getStringValue());
 154     // same comment as readCachedData: only insert if not already present
 155     it = namePathMap.find(names.back());
 156     if (it == namePathMap.end()) {
 157       namePathMap.insert(std::make_pair(names.back(), path));
 158     }
 159   }
 160
 161   flightgear::NavDataCache* cache = flightgear::NavDataCache::instance();
 162   cache->stampCacheFile(path);
 163   cache->writeStringListProperty(path.str(), names);
 164 }