src/Navaids/NavDataCache.cxx

   1 // NavDataCache.cxx - defines a unified binary cache for navigation
   2 // data, parsed from various text / XML sources.
   3
   4 // Written by James Turner, started 2012.
   5 //
   6 // Copyright (C) 2012  James Turner
   7 //
   8 // This program is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU General Public License as
  10 // published by the Free Software Foundation; either version 2 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful, but
  14 // WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  21
  22 #ifdef HAVE_CONFIG_H
  23 # include "config.h"
  24 #endif
  25
  26 #include "NavDataCache.hxx"
  27
  28 // std
  29 #include <map>
  30 #include <cassert>
  31 #include <stdint.h> // for int64_t
  32 // boost
  33 #include <boost/foreach.hpp>
  34
  35
  36 #ifdef SYSTEM_SQLITE
  37 // the standard sqlite3.h doesn't give a way to set SQLITE_UINT64_TYPE,
  38 // so we have to hope sizeof(int64_t) matches sizeof(sqlite3_int64).
  39 // otherwise things will go bad quickly.
  40   #include "sqlite3.h"
  41 #else
  42 // to ensure compatability between sqlite3_int64 and PositionedID,
  43 // force the type used by sqlite to match PositionedID explicitly
  44 #define SQLITE_INT64_TYPE int64_t
  45 #define SQLITE_UINT64_TYPE uint64_t
  46
  47   #include "fg_sqlite3.h"
  48 #endif
  49
  50 // SimGear
  51 #include <simgear/sg_inlines.h>
  52 #include <simgear/structure/exception.hxx>
  53 #include <simgear/debug/logstream.hxx>
  54 #include <simgear/bucket/newbucket.hxx>
  55 #include <simgear/misc/sg_path.hxx>
  56 #include <simgear/misc/strutils.hxx>
  57 #include <simgear/threads/SGThread.hxx>
  58 #include <simgear/threads/SGGuard.hxx>
  59
  60 #include <Main/globals.hxx>
  61 #include <Main/fg_props.hxx>
  62 #include <Main/options.hxx>
  63 #include "markerbeacon.hxx"
  64 #include "navrecord.hxx"
  65 #include <Airports/airport.hxx>
  66 #include <Airports/runways.hxx>
  67 #include <ATC/CommStation.hxx>
  68 #include "fix.hxx"
  69 #include <Navaids/fixlist.hxx>
  70 #include <Navaids/navdb.hxx>
  71 #include "PositionedOctree.hxx"
  72 #include <Airports/apt_loader.hxx>
  73 #include <Navaids/airways.hxx>
  74 #include "poidb.hxx"
  75 #include <Airports/parking.hxx>
  76 #include <Airports/gnnode.hxx>
  77 #include "CacheSchema.h"
  78
  79 using std::string;
  80
  81 #define SG_NAVCACHE SG_NAVAID
  82 //#define LAZY_OCTREE_UPDATES 1
  83
  84 namespace {
  85
  86 const int MAX_RETRIES = 10;
  87
  88 const int CACHE_SIZE_KBYTES= 32 * 1024;
  89
  90 // bind a std::string to a sqlite statement. The std::string must live the
  91 // entire duration of the statement execution - do not pass a temporary
  92 // std::string, or the compiler may delete it, freeing the C-string storage,
  93 // and causing subtle memory corruption bugs!
  94 void sqlite_bind_stdstring(sqlite3_stmt* stmt, int value, const std::string& s)
  95 {
  96   sqlite3_bind_text(stmt, value, s.c_str(), s.length(), SQLITE_STATIC);
  97 }
  98
  99 // variant of the above, which does not care about the lifetime of the
 100 // passed std::string
 101 void sqlite_bind_temp_stdstring(sqlite3_stmt* stmt, int value, const std::string& s)
 102 {
 103   sqlite3_bind_text(stmt, value, s.c_str(), s.length(), SQLITE_TRANSIENT);
 104 }
 105
 106 typedef sqlite3_stmt* sqlite3_stmt_ptr;
 107
 108 void f_distanceCartSqrFunction(sqlite3_context* ctx, int argc, sqlite3_value* argv[])
 109 {
 110   if (argc != 6) {
 111     return;
 112   }
 113
 114   SGVec3d posA(sqlite3_value_double(argv[0]),
 115                sqlite3_value_double(argv[1]),
 116                sqlite3_value_double(argv[2]));
 117
 118   SGVec3d posB(sqlite3_value_double(argv[3]),
 119                sqlite3_value_double(argv[4]),
 120                sqlite3_value_double(argv[5]));
 121   sqlite3_result_double(ctx, distSqr(posA, posB));
 122 }
 123
 124
 125 static string cleanRunwayNo(const string& aRwyNo)
 126 {
 127   if (aRwyNo[0] == 'x') {
 128     return string(); // no ident for taxiways
 129   }
 130
 131   string result(aRwyNo);
 132   // canonicalise runway ident
 133   if ((aRwyNo.size() == 1) || !isdigit(aRwyNo[1])) {
 134     result = "0" + aRwyNo;
 135   }
 136
 137   // trim off trailing garbage
 138   if (result.size() > 2) {
 139     char suffix = toupper(result[2]);
 140     if (suffix == 'X') {
 141       result = result.substr(0, 2);
 142     }
 143   }
 144
 145   return result;
 146 }
 147
 148 } // anonymous namespace
 149
 150 namespace flightgear
 151 {
 152
 153 /**
 154  * Thread encapsulating a cache rebuild. This is not used to parallelise
 155  * the rebuild - we must still wait until completion before doing other
 156  * startup, since many things rely on a complete cache. The thread is used
 157  * so we don't block the main event loop for an unacceptable duration,
 158  * which causes 'not responding' / spinning beachballs on Windows & Mac
 159  */
 160 class RebuildThread : public SGThread
 161 {
 162 public:
 163   RebuildThread(NavDataCache* cache) :
 164   _cache(cache),
 165   _isFinished(false)
 166   {
 167
 168   }
 169
 170   bool isFinished() const
 171   {
 172     SGGuard<SGMutex> g(_lock);
 173     return _isFinished;
 174   }
 175
 176   virtual void run()
 177   {
 178     SGTimeStamp st;
 179     st.stamp();
 180     _cache->doRebuild();
 181     SG_LOG(SG_NAVCACHE, SG_INFO, "cache rebuild took:" << st.elapsedMSec() << "msec");
 182
 183     SGGuard<SGMutex> g(_lock);
 184     _isFinished = true;
 185   }
 186 private:
 187   NavDataCache* _cache;
 188   mutable SGMutex _lock;
 189   bool _isFinished;
 190 };
 191
 192 ////////////////////////////////////////////////////////////////////////////
 193
 194 typedef std::map<PositionedID, FGPositionedRef> PositionedCache;
 195
 196 class AirportTower : public FGPositioned
 197 {
 198 public:
 199   AirportTower(PositionedID& guid, PositionedID airport,
 200                const string& ident, const SGGeod& pos) :
 201     FGPositioned(guid, FGPositioned::TOWER, ident, pos)
 202   {
 203   }
 204 };
 205
 206 class NavDataCache::NavDataCachePrivate
 207 {
 208 public:
 209   NavDataCachePrivate(const SGPath& p, NavDataCache* o) :
 210     outer(o),
 211     db(NULL),
 212     path(p),
 213     readOnly(false),
 214     cacheHits(0),
 215     cacheMisses(0),
 216     transactionLevel(0),
 217     transactionAborted(false)
 218   {
 219   }
 220
 221   ~NavDataCachePrivate()
 222   {
 223     close();
 224   }
 225
 226   void init()
 227   {
 228     SG_LOG(SG_NAVCACHE, SG_INFO, "NavCache at:" << path);
 229
 230       readOnly = fgGetBool("/sim/fghome-readonly", false);
 231
 232       int openFlags = readOnly ? SQLITE_OPEN_READONLY :
 233         SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE;
 234       // see http://code.google.com/p/flightgear-bugs/issues/detail?id=1055
 235       // for the UTF8 / path logic here
 236         std::string pathUtf8 = simgear::strutils::convertWindowsLocal8BitToUtf8(path.str());
 237     sqlite3_open_v2(pathUtf8.c_str(), &db, openFlags, NULL);
 238
 239     sqlite3_stmt_ptr checkTables =
 240       prepare("SELECT count(*) FROM sqlite_master WHERE name='properties'");
 241
 242     sqlite3_create_function(db, "distanceCartSqr", 6, SQLITE_ANY, NULL,
 243                             f_distanceCartSqrFunction, NULL, NULL);
 244
 245     execSelect(checkTables);
 246     bool didCreate = false;
 247     if (!readOnly && (sqlite3_column_int(checkTables, 0) == 0)) {
 248       SG_LOG(SG_NAVCACHE, SG_INFO, "will create tables");
 249       initTables();
 250       didCreate = true;
 251     }
 252
 253     readPropertyQuery = prepare("SELECT value FROM properties WHERE key=?");
 254     writePropertyQuery = prepare("INSERT INTO properties (key, value) VALUES (?,?)");
 255     clearProperty = prepare("DELETE FROM properties WHERE key=?1");
 256
 257     if (didCreate) {
 258       writeIntProperty("schema-version", SCHEMA_VERSION);
 259     } else {
 260       int schemaVersion = outer->readIntProperty("schema-version");
 261       if (schemaVersion != SCHEMA_VERSION) {
 262         SG_LOG(SG_NAVCACHE, SG_INFO, "Navcache schema mismatch, will rebuild");
 263         throw sg_exception("Navcache schema has changed");
 264       }
 265     }
 266
 267     // see http://www.sqlite.org/pragma.html#pragma_cache_size
 268     // for the details, small cache would cause thrashing.
 269     std::ostringstream q;
 270     q << "PRAGMA cache_size=-" << CACHE_SIZE_KBYTES << ";";
 271     runSQL(q.str());
 272     prepareQueries();
 273   }
 274
 275   void close()
 276   {
 277     BOOST_FOREACH(sqlite3_stmt_ptr stmt, prepared) {
 278       sqlite3_finalize(stmt);
 279     }
 280     prepared.clear();
 281     sqlite3_close(db);
 282   }
 283
 284   void checkCacheFile()
 285   {
 286     SG_LOG(SG_NAVCACHE, SG_INFO, "running DB integrity check");
 287     SGTimeStamp st;
 288     st.stamp();
 289
 290     sqlite3_stmt_ptr stmt = prepare("PRAGMA quick_check(1)");
 291     if (!execSelect(stmt)) {
 292       throw sg_exception("DB integrity check failed to run");
 293     }
 294
 295     string v = (char*) sqlite3_column_text(stmt, 0);
 296     if (v != "ok") {
 297       throw sg_exception("DB integrity check returned:" + v);
 298     }
 299
 300     SG_LOG(SG_NAVCACHE, SG_INFO, "NavDataCache integrity check took:" << st.elapsedMSec());
 301     finalize(stmt);
 302   }
 303
 304   void callSqlite(int result, const string& sql)
 305   {
 306     if (result == SQLITE_OK)
 307       return; // all good
 308
 309     string errMsg;
 310     if (result == SQLITE_MISUSE) {
 311       errMsg = "Sqlite API abuse";
 312       SG_LOG(SG_NAVCACHE, SG_ALERT, "Sqlite API abuse");
 313     } else {
 314       errMsg = sqlite3_errmsg(db);
 315       SG_LOG(SG_NAVCACHE, SG_ALERT, "Sqlite error:" << errMsg << " running:\n\t" << sql);
 316     }
 317
 318     throw sg_exception("Sqlite error:" + errMsg, sql);
 319   }
 320
 321   void runSQL(const string& sql)
 322   {
 323     sqlite3_stmt_ptr stmt;
 324     callSqlite(sqlite3_prepare_v2(db, sql.c_str(), sql.length(), &stmt, NULL), sql);
 325
 326     try {
 327       execSelect(stmt);
 328     } catch (sg_exception&) {
 329       sqlite3_finalize(stmt);
 330       throw; // re-throw
 331     }
 332
 333     sqlite3_finalize(stmt);
 334   }
 335
 336   sqlite3_stmt_ptr prepare(const string& sql)
 337   {
 338     sqlite3_stmt_ptr stmt;
 339     callSqlite(sqlite3_prepare_v2(db, sql.c_str(), sql.length(), &stmt, NULL), sql);
 340     prepared.push_back(stmt);
 341     return stmt;
 342   }
 343
 344   void finalize(sqlite3_stmt_ptr s)
 345   {
 346     StmtVec::iterator it = std::find(prepared.begin(), prepared.end(), s);
 347     if (it == prepared.end()) {
 348       throw sg_exception("Finalising statement that was not prepared");
 349     }
 350
 351     prepared.erase(it);
 352     sqlite3_finalize(s);
 353   }
 354
 355   void reset(sqlite3_stmt_ptr stmt)
 356   {
 357     assert(stmt);
 358     if (sqlite3_reset(stmt) != SQLITE_OK) {
 359       string errMsg = sqlite3_errmsg(db);
 360       SG_LOG(SG_NAVCACHE, SG_ALERT, "Sqlite error resetting:" << errMsg);
 361       throw sg_exception("Sqlite error resetting:" + errMsg, sqlite3_sql(stmt));
 362     }
 363   }
 364
 365   bool execSelect(sqlite3_stmt_ptr stmt)
 366   {
 367     return stepSelect(stmt);
 368   }
 369
 370   bool stepSelect(sqlite3_stmt_ptr stmt)
 371   {
 372     int retries = 0;
 373     int result;
 374     while (retries < MAX_RETRIES) {
 375       result = sqlite3_step(stmt);
 376       if (result == SQLITE_ROW) {
 377         return true; // at least one result row
 378       }
 379
 380       if (result == SQLITE_DONE) {
 381         return false; // no result rows
 382       }
 383
 384       if (result != SQLITE_BUSY) {
 385         break;
 386       }
 387
 388       SG_LOG(SG_NAVCACHE, SG_ALERT, "NavCache contention on select, will retry:" << retries);
 389       SGTimeStamp::sleepForMSec(++retries * 10);
 390     } // of retry loop for DB locked
 391
 392     if (retries >= MAX_RETRIES) {
 393       SG_LOG(SG_NAVCACHE, SG_ALERT, "exceeded maximum number of SQLITE_BUSY retries");
 394       return false;
 395     }
 396
 397     string errMsg;
 398     if (result == SQLITE_MISUSE) {
 399       errMsg = "Sqlite API abuse";
 400       SG_LOG(SG_NAVCACHE, SG_ALERT, "Sqlite API abuse");
 401     } else {
 402       errMsg = sqlite3_errmsg(db);
 403       SG_LOG(SG_NAVCACHE, SG_ALERT, "Sqlite error:" << errMsg << " (" << result
 404              << ") while running:\n\t" << sqlite3_sql(stmt));
 405     }
 406
 407     throw sg_exception("Sqlite error:" + errMsg, sqlite3_sql(stmt));
 408   }
 409
 410   void execSelect1(sqlite3_stmt_ptr stmt)
 411   {
 412     if (!execSelect(stmt)) {
 413       SG_LOG(SG_NAVCACHE, SG_WARN, "empty SELECT running:\n\t" << sqlite3_sql(stmt));
 414       throw sg_exception("no results returned for select", sqlite3_sql(stmt));
 415     }
 416   }
 417
 418   sqlite3_int64 execInsert(sqlite3_stmt_ptr stmt)
 419   {
 420     execSelect(stmt);
 421     sqlite3_int64 rowid = sqlite3_last_insert_rowid(db);
 422     reset(stmt);
 423     return rowid;
 424   }
 425
 426   void execUpdate(sqlite3_stmt_ptr stmt)
 427   {
 428     execSelect(stmt);
 429     reset(stmt);
 430   }
 431
 432   void initTables()
 433   {
 434       string_list commands = simgear::strutils::split(SCHEMA_SQL, ";");
 435       BOOST_FOREACH(std::string sql, commands) {
 436           if (sql.empty()) {
 437               continue;
 438           }
 439
 440           runSQL(sql);
 441       } // of commands in scheme loop
 442   }
 443
 444   void prepareQueries()
 445   {
 446     writePropertyMulti = prepare("INSERT INTO properties (key, value) VALUES(?1,?2)");
 447
 448     beginTransactionStmt = prepare("BEGIN");
 449     commitTransactionStmt = prepare("COMMIT");
 450     rollbackTransactionStmt = prepare("ROLLBACK");
 451
 452
 453 #define POSITIONED_COLS "rowid, type, ident, name, airport, lon, lat, elev_m, octree_node"
 454 #define AND_TYPED "AND type>=?2 AND type <=?3"
 455     statCacheCheck = prepare("SELECT stamp FROM stat_cache WHERE path=?");
 456     stampFileCache = prepare("INSERT OR REPLACE INTO stat_cache "
 457                              "(path, stamp) VALUES (?,?)");
 458
 459     loadPositioned = prepare("SELECT " POSITIONED_COLS " FROM positioned WHERE rowid=?");
 460     loadAirportStmt = prepare("SELECT has_metar FROM airport WHERE rowid=?");
 461     loadNavaid = prepare("SELECT range_nm, freq, multiuse, runway, colocated FROM navaid WHERE rowid=?");
 462     loadCommStation = prepare("SELECT freq_khz, range_nm FROM comm WHERE rowid=?");
 463     loadRunwayStmt = prepare("SELECT heading, length_ft, width_m, surface, displaced_threshold,"
 464                              "stopway, reciprocal, ils FROM runway WHERE rowid=?1");
 465
 466     getAirportItems = prepare("SELECT rowid FROM positioned WHERE airport=?1 " AND_TYPED);
 467
 468
 469     setAirportMetar = prepare("UPDATE airport SET has_metar=?2 WHERE rowid="
 470                               "(SELECT rowid FROM positioned WHERE ident=?1 AND type>=?3 AND type <=?4)");
 471     sqlite3_bind_int(setAirportMetar, 3, FGPositioned::AIRPORT);
 472     sqlite3_bind_int(setAirportMetar, 4, FGPositioned::SEAPORT);
 473
 474     setRunwayReciprocal = prepare("UPDATE runway SET reciprocal=?2 WHERE rowid=?1");
 475     setRunwayILS = prepare("UPDATE runway SET ils=?2 WHERE rowid=?1");
 476     setNavaidColocated = prepare("UPDATE navaid SET colocated=?2 WHERE rowid=?1");
 477     updateRunwayThreshold = prepare("UPDATE runway SET heading=?2, displaced_threshold=?3, stopway=?4 WHERE rowid=?1");
 478
 479     insertPositionedQuery = prepare("INSERT INTO positioned "
 480                                     "(type, ident, name, airport, lon, lat, elev_m, octree_node, "
 481                                     "cart_x, cart_y, cart_z)"
 482                                     " VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10, ?11)");
 483
 484     setAirportPos = prepare("UPDATE positioned SET lon=?2, lat=?3, elev_m=?4, octree_node=?5, "
 485                             "cart_x=?6, cart_y=?7, cart_z=?8 WHERE rowid=?1");
 486     insertAirport = prepare("INSERT INTO airport (rowid, has_metar) VALUES (?, ?)");
 487     insertNavaid = prepare("INSERT INTO navaid (rowid, freq, range_nm, multiuse, runway, colocated)"
 488                            " VALUES (?1, ?2, ?3, ?4, ?5, ?6)");
 489     updateILS = prepare("UPDATE navaid SET multiuse=?2 WHERE rowid=?1");
 490
 491     insertCommStation = prepare("INSERT INTO comm (rowid, freq_khz, range_nm)"
 492                                 " VALUES (?, ?, ?)");
 493     insertRunway = prepare("INSERT INTO runway "
 494                            "(rowid, heading, length_ft, width_m, surface, displaced_threshold, stopway, reciprocal)"
 495                            " VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8)");
 496     runwayLengthFtQuery = prepare("SELECT length_ft FROM runway WHERE rowid=?1");
 497
 498     removePOIQuery = prepare("DELETE FROM positioned WHERE type=?1 AND ident=?2");
 499
 500   // query statement
 501     findClosestWithIdent = prepare("SELECT rowid FROM positioned WHERE ident=?1 "
 502                                    AND_TYPED " ORDER BY distanceCartSqr(cart_x, cart_y, cart_z, ?4, ?5, ?6)");
 503
 504     findCommByFreq = prepare("SELECT positioned.rowid FROM positioned, comm WHERE "
 505                              "positioned.rowid=comm.rowid AND freq_khz=?1 "
 506                              AND_TYPED " ORDER BY distanceCartSqr(cart_x, cart_y, cart_z, ?4, ?5, ?6)");
 507
 508     findNavsByFreq = prepare("SELECT positioned.rowid FROM positioned, navaid WHERE "
 509                              "positioned.rowid=navaid.rowid "
 510                              "AND navaid.freq=?1 " AND_TYPED
 511                              " ORDER BY distanceCartSqr(cart_x, cart_y, cart_z, ?4, ?5, ?6)");
 512
 513     findNavsByFreqNoPos = prepare("SELECT positioned.rowid FROM positioned, navaid WHERE "
 514                                   "positioned.rowid=navaid.rowid AND freq=?1 " AND_TYPED);
 515
 516     findNavaidForRunway = prepare("SELECT positioned.rowid FROM positioned, navaid WHERE "
 517                                   "positioned.rowid=navaid.rowid AND runway=?1 AND type=?2");
 518
 519   // for an octree branch, return the child octree nodes which exist,
 520   // described as a bit-mask
 521     getOctreeChildren = prepare("SELECT children FROM octree WHERE rowid=?1");
 522
 523 #ifdef LAZY_OCTREE_UPDATES
 524     updateOctreeChildren = prepare("UPDATE octree SET children=?2 WHERE rowid=?1");
 525 #else
 526   // mask the new child value into the existing one
 527     updateOctreeChildren = prepare("UPDATE octree SET children=(?2 | children) WHERE rowid=?1");
 528 #endif
 529
 530   // define a new octree node (with no children)
 531     insertOctree = prepare("INSERT INTO octree (rowid, children) VALUES (?1, 0)");
 532
 533     getOctreeLeafChildren = prepare("SELECT rowid, type FROM positioned WHERE octree_node=?1");
 534
 535     searchAirports = prepare("SELECT ident, name FROM positioned WHERE (name LIKE ?1 OR ident LIKE ?1) " AND_TYPED);
 536     sqlite3_bind_int(searchAirports, 2, FGPositioned::AIRPORT);
 537     sqlite3_bind_int(searchAirports, 3, FGPositioned::SEAPORT);
 538
 539     getAllAirports = prepare("SELECT ident, name FROM positioned WHERE type>=?1 AND type <=?2");
 540     sqlite3_bind_int(getAllAirports, 1, FGPositioned::AIRPORT);
 541     sqlite3_bind_int(getAllAirports, 2, FGPositioned::SEAPORT);
 542
 543
 544     getAirportItemByIdent = prepare("SELECT rowid FROM positioned WHERE airport=?1 AND ident=?2 AND type=?3");
 545
 546     findAirportRunway = prepare("SELECT airport, rowid FROM positioned WHERE ident=?2 AND type=?3 AND airport="
 547                                 "(SELECT rowid FROM positioned WHERE type=?4 AND ident=?1)");
 548     sqlite3_bind_int(findAirportRunway, 3, FGPositioned::RUNWAY);
 549     sqlite3_bind_int(findAirportRunway, 4, FGPositioned::AIRPORT);
 550
 551     // three-way join to get the navaid ident and runway ident in a single select.
 552     // we're joining positioned to itself by the navaid runway, with the complication
 553     // that we need to join the navaids table to get the runway ID.
 554     // we also need to filter by type to excluse glideslope (GS) matches
 555     findILS = prepare("SELECT nav.rowid FROM positioned AS nav, positioned AS rwy, navaid WHERE "
 556                       "nav.ident=?1 AND nav.airport=?2 AND rwy.ident=?3 "
 557                       "AND rwy.rowid = navaid.runway AND navaid.rowid=nav.rowid "
 558                       "AND (nav.type=?4 OR nav.type=?5)");
 559
 560     sqlite3_bind_int(findILS, 4, FGPositioned::ILS);
 561     sqlite3_bind_int(findILS, 5, FGPositioned::LOC);
 562
 563   // airways
 564     findAirway = prepare("SELECT rowid FROM airway WHERE network=?1 AND ident=?2");
 565     insertAirway = prepare("INSERT INTO airway (ident, network) "
 566                            "VALUES (?1, ?2)");
 567
 568     insertAirwayEdge = prepare("INSERT INTO airway_edge (network, airway, a, b) "
 569                                "VALUES (?1, ?2, ?3, ?4)");
 570
 571     isPosInAirway = prepare("SELECT rowid FROM airway_edge WHERE network=?1 AND a=?2");
 572
 573     airwayEdgesFrom = prepare("SELECT airway, b FROM airway_edge WHERE network=?1 AND a=?2");
 574
 575   // parking / taxi-node graph
 576     insertTaxiNode = prepare("INSERT INTO taxi_node (rowid, hold_type, on_runway, pushback) VALUES(?1, ?2, ?3, 0)");
 577     insertParkingPos = prepare("INSERT INTO parking (rowid, heading, radius, gate_type, airlines) "
 578                                "VALUES (?1, ?2, ?3, ?4, ?5)");
 579     setParkingPushBack = prepare("UPDATE parking SET pushback=?2 WHERE rowid=?1");
 580
 581     loadTaxiNodeStmt = prepare("SELECT hold_type, on_runway FROM taxi_node WHERE rowid=?1");
 582     loadParkingPos = prepare("SELECT heading, radius, gate_type, airlines, pushback FROM parking WHERE rowid=?1");
 583     taxiEdgesFrom = prepare("SELECT b FROM groundnet_edge WHERE a=?1");
 584     pushbackEdgesFrom = prepare("SELECT b FROM groundnet_edge, taxi_node WHERE "
 585                                 "a=?1 AND groundnet_edge.b = taxi_node.rowid AND pushback=1");
 586
 587     insertTaxiEdge = prepare("INSERT INTO groundnet_edge (airport, a,b) VALUES(?1, ?2, ?3)");
 588
 589     markTaxiNodeAsPushback = prepare("UPDATE taxi_node SET pushback=1 WHERE rowid=?1");
 590     airportTaxiNodes = prepare("SELECT rowid FROM positioned WHERE (type=?2 OR type=?3) AND airport=?1");
 591     sqlite3_bind_int(airportTaxiNodes, 2, FGPositioned::PARKING);
 592     sqlite3_bind_int(airportTaxiNodes, 3, FGPositioned::TAXI_NODE);
 593
 594     airportPushbackNodes = prepare("SELECT positioned.rowid FROM positioned, taxi_node WHERE "\
 595                                    "airport=?1 AND positioned.rowid=taxi_node.rowid AND pushback=1 "
 596                                    "AND (type=?2 OR type=?3)");
 597     sqlite3_bind_int(airportPushbackNodes, 2, FGPositioned::PARKING);
 598     sqlite3_bind_int(airportPushbackNodes, 3, FGPositioned::TAXI_NODE);
 599
 600     findNearestTaxiNode = prepare("SELECT positioned.rowid FROM positioned, taxi_node WHERE "
 601                                   "positioned.rowid = taxi_node.rowid AND airport=?1 "
 602                                   "ORDER BY distanceCartSqr(cart_x, cart_y, cart_z, ?2, ?3, ?4) "
 603                                   "LIMIT 1");
 604
 605     findNearestRunwayTaxiNode = prepare("SELECT positioned.rowid FROM positioned, taxi_node WHERE "
 606                                         "positioned.rowid = taxi_node.rowid AND airport=?1 "
 607                                         "AND on_runway=1 "
 608                                         "ORDER BY distanceCartSqr(cart_x, cart_y, cart_z, ?2, ?3, ?4) ");
 609
 610     findAirportParking = prepare("SELECT positioned.rowid FROM positioned, parking WHERE "
 611                                  "airport=?1 AND type=?4 AND "
 612                                  "radius >= ?2 AND gate_type = ?3 AND "
 613                                  "parking.rowid=positioned.rowid");
 614     sqlite3_bind_int(findAirportParking, 4, FGPositioned::PARKING);
 615   }
 616
 617   void writeIntProperty(const string& key, int value)
 618   {
 619     sqlite_bind_stdstring(clearProperty, 1, key);
 620     execUpdate(clearProperty);
 621
 622     sqlite_bind_stdstring(writePropertyQuery, 1, key);
 623     sqlite3_bind_int(writePropertyQuery, 2, value);
 624     execUpdate(writePropertyQuery);
 625   }
 626
 627
 628   FGPositioned* loadById(sqlite_int64 rowId);
 629
 630   FGAirport* loadAirport(sqlite_int64 rowId,
 631                          FGPositioned::Type ty,
 632                          const string& id, const string& name, const SGGeod& pos)
 633   {
 634     sqlite3_bind_int64(loadAirportStmt, 1, rowId);
 635     execSelect1(loadAirportStmt);
 636     bool hasMetar = (sqlite3_column_int(loadAirportStmt, 0) > 0);
 637     reset(loadAirportStmt);
 638
 639     return new FGAirport(rowId, id, pos, name, hasMetar, ty);
 640   }
 641
 642   FGRunwayBase* loadRunway(sqlite3_int64 rowId, FGPositioned::Type ty,
 643                            const string& id, const SGGeod& pos, PositionedID apt)
 644   {
 645     sqlite3_bind_int(loadRunwayStmt, 1, rowId);
 646     execSelect1(loadRunwayStmt);
 647
 648     double heading = sqlite3_column_double(loadRunwayStmt, 0);
 649     double lengthM = sqlite3_column_int(loadRunwayStmt, 1);
 650     double widthM = sqlite3_column_double(loadRunwayStmt, 2);
 651     int surface = sqlite3_column_int(loadRunwayStmt, 3);
 652
 653     if (ty == FGPositioned::TAXIWAY) {
 654       reset(loadRunwayStmt);
 655       return new FGTaxiway(rowId, id, pos, heading, lengthM, widthM, surface);
 656     } else if (ty == FGPositioned::HELIPAD) {
 657         reset(loadRunwayStmt);
 658         return new FGHelipad(rowId, apt, id, pos, heading, lengthM, widthM, surface);
 659     } else {
 660       double displacedThreshold = sqlite3_column_double(loadRunwayStmt, 4);
 661       double stopway = sqlite3_column_double(loadRunwayStmt, 5);
 662       PositionedID reciprocal = sqlite3_column_int64(loadRunwayStmt, 6);
 663       PositionedID ils = sqlite3_column_int64(loadRunwayStmt, 7);
 664       FGRunway* r = new FGRunway(rowId, apt, id, pos, heading, lengthM, widthM,
 665                           displacedThreshold, stopway, surface);
 666
 667       if (reciprocal > 0) {
 668         r->setReciprocalRunway(reciprocal);
 669       }
 670
 671       if (ils > 0) {
 672         r->setILS(ils);
 673       }
 674
 675       reset(loadRunwayStmt);
 676       return r;
 677     }
 678   }
 679
 680   CommStation* loadComm(sqlite3_int64 rowId, FGPositioned::Type ty,
 681                         const string& id, const string& name,
 682                         const SGGeod& pos,
 683                         PositionedID airport)
 684   {
 685     sqlite3_bind_int64(loadCommStation, 1, rowId);
 686     execSelect1(loadCommStation);
 687
 688     int range = sqlite3_column_int(loadCommStation, 0);
 689     int freqKhz = sqlite3_column_int(loadCommStation, 1);
 690     reset(loadCommStation);
 691
 692     CommStation* c = new CommStation(rowId, name, ty, pos, freqKhz, range);
 693     c->setAirport(airport);
 694     return c;
 695   }
 696
 697   FGPositioned* loadNav(sqlite3_int64 rowId,
 698                        FGPositioned::Type ty, const string& id,
 699                        const string& name, const SGGeod& pos)
 700   {
 701     sqlite3_bind_int64(loadNavaid, 1, rowId);
 702     execSelect1(loadNavaid);
 703
 704     PositionedID runway = sqlite3_column_int64(loadNavaid, 3);
 705     // marker beacons are light-weight
 706     if ((ty == FGPositioned::OM) || (ty == FGPositioned::IM) ||
 707         (ty == FGPositioned::MM))
 708     {
 709       reset(loadNavaid);
 710       return new FGMarkerBeaconRecord(rowId, ty, runway, pos);
 711     }
 712
 713     int rangeNm = sqlite3_column_int(loadNavaid, 0),
 714     freq = sqlite3_column_int(loadNavaid, 1);
 715     double mulituse = sqlite3_column_double(loadNavaid, 2);
 716     PositionedID colocated = sqlite3_column_int64(loadNavaid, 4);
 717     reset(loadNavaid);
 718
 719     FGNavRecord* n =
 720       (ty == FGPositioned::MOBILE_TACAN)
 721       ? new FGMobileNavRecord
 722             (rowId, ty, id, name, pos, freq, rangeNm, mulituse, runway)
 723       : new FGNavRecord
 724             (rowId, ty, id, name, pos, freq, rangeNm, mulituse, runway);
 725
 726     if (colocated)
 727       n->setColocatedDME(colocated);
 728
 729     return n;
 730   }
 731
 732   FGPositioned* loadParking(sqlite3_int64 rowId,
 733                             const string& name, const SGGeod& pos,
 734                             PositionedID airport)
 735   {
 736     sqlite3_bind_int64(loadParkingPos, 1, rowId);
 737     execSelect1(loadParkingPos);
 738
 739     double heading = sqlite3_column_double(loadParkingPos, 0);
 740     int radius = sqlite3_column_int(loadParkingPos, 1);
 741     string aircraftType((char*) sqlite3_column_text(loadParkingPos, 2));
 742     string airlines((char*) sqlite3_column_text(loadParkingPos, 3));
 743     PositionedID pushBack = sqlite3_column_int64(loadParkingPos, 4);
 744     reset(loadParkingPos);
 745
 746     return new FGParking(rowId, pos, heading, radius, name, aircraftType, airlines, pushBack);
 747   }
 748
 749   FGPositioned* loadTaxiNode(sqlite3_int64 rowId, const SGGeod& pos,
 750                              PositionedID airport)
 751   {
 752     sqlite3_bind_int64(loadTaxiNodeStmt, 1, rowId);
 753     execSelect1(loadTaxiNodeStmt);
 754
 755     int hold_type = sqlite3_column_int(loadTaxiNodeStmt, 0);
 756     bool onRunway = sqlite3_column_int(loadTaxiNodeStmt, 1);
 757     reset(loadTaxiNodeStmt);
 758
 759     return new FGTaxiNode(rowId, pos, onRunway, hold_type);
 760   }
 761
 762   PositionedID insertPositioned(FGPositioned::Type ty, const string& ident,
 763                                 const string& name, const SGGeod& pos, PositionedID apt,
 764                                 bool spatialIndex)
 765   {
 766     SGVec3d cartPos(SGVec3d::fromGeod(pos));
 767
 768     sqlite3_bind_int(insertPositionedQuery, 1, ty);
 769     sqlite_bind_stdstring(insertPositionedQuery, 2, ident);
 770     sqlite_bind_stdstring(insertPositionedQuery, 3, name);
 771     sqlite3_bind_int64(insertPositionedQuery, 4, apt);
 772     sqlite3_bind_double(insertPositionedQuery, 5, pos.getLongitudeDeg());
 773     sqlite3_bind_double(insertPositionedQuery, 6, pos.getLatitudeDeg());
 774     sqlite3_bind_double(insertPositionedQuery, 7, pos.getElevationM());
 775
 776     if (spatialIndex) {
 777       Octree::Leaf* octreeLeaf = Octree::global_spatialOctree->findLeafForPos(cartPos);
 778       assert(intersects(octreeLeaf->bbox(), cartPos));
 779       sqlite3_bind_int64(insertPositionedQuery, 8, octreeLeaf->guid());
 780     } else {
 781       sqlite3_bind_null(insertPositionedQuery, 8);
 782     }
 783
 784     sqlite3_bind_double(insertPositionedQuery, 9, cartPos.x());
 785     sqlite3_bind_double(insertPositionedQuery, 10, cartPos.y());
 786     sqlite3_bind_double(insertPositionedQuery, 11, cartPos.z());
 787
 788     PositionedID r = execInsert(insertPositionedQuery);
 789     return r;
 790   }
 791
 792   FGPositionedList findAllByString(const string& s, const string& column,
 793                                      FGPositioned::Filter* filter, bool exact)
 794   {
 795     string query = s;
 796     if (!exact) query += "%";
 797
 798   // build up SQL query text
 799     string matchTerm = exact ? "=?1" : " LIKE ?1";
 800     string sql = "SELECT rowid FROM positioned WHERE " + column + matchTerm;
 801     if (filter) {
 802       sql += " " AND_TYPED;
 803     }
 804
 805   // find or prepare a suitable statement frrm the SQL
 806     sqlite3_stmt_ptr stmt = findByStringDict[sql];
 807     if (!stmt) {
 808       stmt = prepare(sql);
 809       findByStringDict[sql] = stmt;
 810     }
 811
 812     sqlite_bind_stdstring(stmt, 1, query);
 813     if (filter) {
 814       sqlite3_bind_int(stmt, 2, filter->minType());
 815       sqlite3_bind_int(stmt, 3, filter->maxType());
 816     }
 817
 818     FGPositionedList result;
 819   // run the prepared SQL
 820     while (stepSelect(stmt))
 821     {
 822       FGPositioned* pos = outer->loadById(sqlite3_column_int64(stmt, 0));
 823       if (filter && !filter->pass(pos)) {
 824         continue;
 825       }
 826
 827       result.push_back(pos);
 828     }
 829
 830     reset(stmt);
 831     return result;
 832   }
 833
 834   PositionedIDVec selectIds(sqlite3_stmt_ptr query)
 835   {
 836     PositionedIDVec result;
 837     while (stepSelect(query)) {
 838       result.push_back(sqlite3_column_int64(query, 0));
 839     }
 840     reset(query);
 841     return result;
 842   }
 843
 844   double runwayLengthFt(PositionedID rwy)
 845   {
 846     sqlite3_bind_int64(runwayLengthFtQuery, 1, rwy);
 847     execSelect1(runwayLengthFtQuery);
 848     double length = sqlite3_column_double(runwayLengthFtQuery, 0);
 849     reset(runwayLengthFtQuery);
 850     return length;
 851   }
 852
 853   void flushDeferredOctreeUpdates()
 854   {
 855     BOOST_FOREACH(Octree::Branch* nd, deferredOctreeUpdates) {
 856       sqlite3_bind_int64(updateOctreeChildren, 1, nd->guid());
 857       sqlite3_bind_int(updateOctreeChildren, 2, nd->childMask());
 858       execUpdate(updateOctreeChildren);
 859     }
 860
 861     deferredOctreeUpdates.clear();
 862   }
 863
 864   void removePositionedWithIdent(FGPositioned::Type ty, const std::string& aIdent)
 865   {
 866     sqlite3_bind_int(removePOIQuery, 1, ty);
 867     sqlite_bind_stdstring(removePOIQuery, 2, aIdent);
 868     execUpdate(removePOIQuery);
 869     reset(removePOIQuery);
 870   }
 871
 872   NavDataCache* outer;
 873   sqlite3* db;
 874   SGPath path;
 875     bool readOnly;
 876
 877   /// the actual cache of ID -> instances. This holds an owning reference,
 878   /// so once items are in the cache they will never be deleted until
 879   /// the cache drops its reference
 880   PositionedCache cache;
 881   unsigned int cacheHits, cacheMisses;
 882
 883   /**
 884    * record the levels of open transaction objects we have
 885    */
 886   unsigned int transactionLevel;
 887   bool transactionAborted;
 888   sqlite3_stmt_ptr beginTransactionStmt, commitTransactionStmt, rollbackTransactionStmt;
 889
 890   SGPath aptDatPath, metarDatPath, navDatPath, fixDatPath, poiDatPath,
 891   carrierDatPath, airwayDatPath;
 892
 893   sqlite3_stmt_ptr readPropertyQuery, writePropertyQuery,
 894     stampFileCache, statCacheCheck,
 895     loadAirportStmt, loadCommStation, loadPositioned, loadNavaid,
 896     loadRunwayStmt;
 897   sqlite3_stmt_ptr writePropertyMulti, clearProperty;
 898
 899   sqlite3_stmt_ptr insertPositionedQuery, insertAirport, insertTower, insertRunway,
 900   insertCommStation, insertNavaid;
 901   sqlite3_stmt_ptr setAirportMetar, setRunwayReciprocal, setRunwayILS, setNavaidColocated,
 902     setAirportPos, updateRunwayThreshold, updateILS;
 903   sqlite3_stmt_ptr removePOIQuery;
 904
 905   sqlite3_stmt_ptr findClosestWithIdent;
 906 // octree (spatial index) related queries
 907   sqlite3_stmt_ptr getOctreeChildren, insertOctree, updateOctreeChildren,
 908     getOctreeLeafChildren;
 909
 910   sqlite3_stmt_ptr searchAirports, getAllAirports;
 911   sqlite3_stmt_ptr findCommByFreq, findNavsByFreq,
 912   findNavsByFreqNoPos, findNavaidForRunway;
 913   sqlite3_stmt_ptr getAirportItems, getAirportItemByIdent;
 914   sqlite3_stmt_ptr findAirportRunway,
 915     findILS;
 916
 917   sqlite3_stmt_ptr runwayLengthFtQuery;
 918
 919 // airways
 920   sqlite3_stmt_ptr findAirway, insertAirwayEdge, isPosInAirway, airwayEdgesFrom,
 921   insertAirway;
 922
 923 // groundnet (parking, taxi node graph)
 924   sqlite3_stmt_ptr loadTaxiNodeStmt, loadParkingPos, insertTaxiNode, insertParkingPos;
 925   sqlite3_stmt_ptr taxiEdgesFrom, pushbackEdgesFrom, insertTaxiEdge, markTaxiNodeAsPushback,
 926     airportTaxiNodes, airportPushbackNodes, findNearestTaxiNode, findAirportParking,
 927     setParkingPushBack, findNearestRunwayTaxiNode;
 928
 929 // since there's many permutations of ident/name queries, we create
 930 // them programtically, but cache the exact query by its raw SQL once
 931 // used.
 932   std::map<string, sqlite3_stmt_ptr> findByStringDict;
 933
 934   typedef std::vector<sqlite3_stmt_ptr> StmtVec;
 935   StmtVec prepared;
 936
 937   std::set<Octree::Branch*> deferredOctreeUpdates;
 938
 939   // if we're performing a rebuild, the thread that is doing the work.
 940   // otherwise, NULL
 941   std::auto_ptr<RebuildThread> rebuilder;
 942 };
 943
 944   //////////////////////////////////////////////////////////////////////
 945
 946 FGPositioned* NavDataCache::NavDataCachePrivate::loadById(sqlite3_int64 rowid)
 947 {
 948
 949   sqlite3_bind_int64(loadPositioned, 1, rowid);
 950   execSelect1(loadPositioned);
 951
 952   assert(rowid == sqlite3_column_int64(loadPositioned, 0));
 953   FGPositioned::Type ty = (FGPositioned::Type) sqlite3_column_int(loadPositioned, 1);
 954
 955   PositionedID prowid = static_cast<PositionedID>(rowid);
 956   string ident = (char*) sqlite3_column_text(loadPositioned, 2);
 957   string name = (char*) sqlite3_column_text(loadPositioned, 3);
 958   sqlite3_int64 aptId = sqlite3_column_int64(loadPositioned, 4);
 959   double lon = sqlite3_column_double(loadPositioned, 5);
 960   double lat = sqlite3_column_double(loadPositioned, 6);
 961   double elev = sqlite3_column_double(loadPositioned, 7);
 962   SGGeod pos = SGGeod::fromDegM(lon, lat, elev);
 963
 964   reset(loadPositioned);
 965
 966   switch (ty) {
 967     case FGPositioned::AIRPORT:
 968     case FGPositioned::SEAPORT:
 969     case FGPositioned::HELIPORT:
 970       return loadAirport(rowid, ty, ident, name, pos);
 971
 972     case FGPositioned::TOWER:
 973       return new AirportTower(prowid, aptId, ident, pos);
 974
 975     case FGPositioned::RUNWAY:
 976     case FGPositioned::HELIPAD:
 977     case FGPositioned::TAXIWAY:
 978       return loadRunway(rowid, ty, ident, pos, aptId);
 979
 980     case FGPositioned::LOC:
 981     case FGPositioned::VOR:
 982     case FGPositioned::GS:
 983     case FGPositioned::ILS:
 984     case FGPositioned::NDB:
 985     case FGPositioned::OM:
 986     case FGPositioned::MM:
 987     case FGPositioned::IM:
 988     case FGPositioned::DME:
 989     case FGPositioned::TACAN:
 990     case FGPositioned::MOBILE_TACAN:
 991     {
 992       if (aptId > 0) {
 993         FGAirport* apt = FGPositioned::loadById<FGAirport>(aptId);
 994         if (apt->validateILSData()) {
 995           // queried data above is probably invalid, force us to go around again
 996           // (the next time through, validateILSData will return false)
 997           return outer->loadById(rowid);
 998         }
 999       }
1000
1001       return loadNav(rowid, ty, ident, name, pos);
1002     }
1003
1004     case FGPositioned::FIX:
1005       return new FGFix(rowid, ident, pos);
1006
1007     case FGPositioned::WAYPOINT:
1008     case FGPositioned::COUNTRY:
1009     case FGPositioned::CITY:
1010     case FGPositioned::TOWN:
1011     case FGPositioned::VILLAGE:
1012     {
1013         FGPositioned* wpt = new FGPositioned(rowid, ty, ident, pos);
1014       return wpt;
1015     }
1016
1017     case FGPositioned::FREQ_GROUND:
1018     case FGPositioned::FREQ_TOWER:
1019     case FGPositioned::FREQ_ATIS:
1020     case FGPositioned::FREQ_AWOS:
1021     case FGPositioned::FREQ_APP_DEP:
1022     case FGPositioned::FREQ_ENROUTE:
1023     case FGPositioned::FREQ_CLEARANCE:
1024     case FGPositioned::FREQ_UNICOM:
1025       return loadComm(rowid, ty, ident, name, pos, aptId);
1026
1027     case FGPositioned::TAXI_NODE:
1028       return loadTaxiNode(rowid, pos, aptId);
1029
1030     case FGPositioned::PARKING:
1031       return loadParking(rowid, ident, pos, aptId);
1032
1033     default:
1034       return NULL;
1035   }
1036 }
1037
1038
1039 static NavDataCache* static_instance = NULL;
1040
1041 NavDataCache::NavDataCache()
1042 {
1043   const int MAX_TRIES = 3;
1044   SGPath homePath(globals->get_fg_home());
1045
1046   std::ostringstream os;
1047   string_list versionParts = simgear::strutils::split(VERSION, ".");
1048   if (versionParts.size() < 2) {
1049     os << "navdata.cache";
1050   } else {
1051     os << "navdata_" << versionParts[0] << "_" << versionParts[1] << ".cache";
1052   }
1053
1054   homePath.append(os.str());
1055
1056   for (int t=0; t < MAX_TRIES; ++t) {
1057     try {
1058       d.reset(new NavDataCachePrivate(homePath, this));
1059       d->init();
1060       //d->checkCacheFile();
1061     // reached this point with no exception, success
1062       break;
1063     } catch (sg_exception& e) {
1064       SG_LOG(SG_NAVCACHE, t == 0 ? SG_WARN : SG_ALERT, "NavCache: init failed:" << e.what()
1065              << " (attempt " << t << ")");
1066       d.reset();
1067
1068         // only wipe the existing if not readonly
1069         if (!fgGetBool("/sim/fghome-readonly", false)) {
1070             homePath.remove();
1071         }
1072     }
1073   } // of retry loop
1074
1075   double RADIUS_EARTH_M = 7000 * 1000.0; // 7000km is plenty
1076   SGVec3d earthExtent(RADIUS_EARTH_M, RADIUS_EARTH_M, RADIUS_EARTH_M);
1077   Octree::global_spatialOctree =
1078     new Octree::Branch(SGBox<double>(-earthExtent, earthExtent), 1);
1079
1080   d->aptDatPath = SGPath(globals->get_fg_root());
1081   d->aptDatPath.append("Airports/apt.dat.gz");
1082
1083   d->metarDatPath = SGPath(globals->get_fg_root());
1084   d->metarDatPath.append("Airports/metar.dat.gz");
1085
1086   d->navDatPath = SGPath(globals->get_fg_root());
1087   d->navDatPath.append("Navaids/nav.dat.gz");
1088
1089   d->fixDatPath = SGPath(globals->get_fg_root());
1090   d->fixDatPath.append("Navaids/fix.dat.gz");
1091
1092   d->poiDatPath = SGPath(globals->get_fg_root());
1093   d->poiDatPath.append("Navaids/poi.dat.gz");
1094
1095   d->carrierDatPath = SGPath(globals->get_fg_root());
1096   d->carrierDatPath.append("Navaids/carrier_nav.dat.gz");
1097
1098   d->airwayDatPath = SGPath(globals->get_fg_root());
1099   d->airwayDatPath.append("Navaids/awy.dat.gz");
1100 }
1101
1102 NavDataCache::~NavDataCache()
1103 {
1104   assert(static_instance == this);
1105   static_instance = NULL;
1106   d.reset();
1107 }
1108
1109 NavDataCache* NavDataCache::instance()
1110 {
1111   if (!static_instance) {
1112     static_instance = new NavDataCache;
1113   }
1114
1115   return static_instance;
1116 }
1117
1118 bool NavDataCache::isRebuildRequired()
1119 {
1120     if (d->readOnly) {
1121         return false;
1122     }
1123
1124     if (flightgear::Options::sharedInstance()->isOptionSet("restore-defaults")) {
1125         SG_LOG(SG_NAVCACHE, SG_INFO, "NavCache: restore-defaults requested, will rebuild cache");
1126         return true;
1127     }
1128
1129   if (isCachedFileModified(d->aptDatPath) ||
1130       isCachedFileModified(d->metarDatPath) ||
1131       isCachedFileModified(d->navDatPath) ||
1132       isCachedFileModified(d->carrierDatPath) ||
1133       isCachedFileModified(d->fixDatPath) ||
1134 // since POI loading is disabled on Windows, don't check for it
1135 // this caused: https://code.google.com/p/flightgear-bugs/issues/detail?id=1227
1136 #ifndef SG_WINDOWS
1137       isCachedFileModified(d->poiDatPath) ||
1138 #endif
1139       isCachedFileModified(d->airwayDatPath))
1140   {
1141     SG_LOG(SG_NAVCACHE, SG_INFO, "NavCache: main cache rebuild required");
1142     return true;
1143   }
1144
1145   string sceneryPaths = simgear::strutils::join(globals->get_fg_scenery(), ";");
1146   if (readStringProperty("scenery_paths") != sceneryPaths) {
1147     SG_LOG(SG_NAVCACHE, SG_INFO, "NavCache: scenery paths changed, main cache rebuild required");
1148     return true;
1149   }
1150
1151   SG_LOG(SG_NAVCACHE, SG_INFO, "NavCache: no main cache rebuild required");
1152   return false;
1153 }
1154
1155 bool NavDataCache::rebuild()
1156 {
1157   if (!d->rebuilder.get()) {
1158     d->rebuilder.reset(new RebuildThread(this));
1159     d->rebuilder->start();
1160   }
1161
1162 // poll the rebuild thread
1163   bool fin = d->rebuilder->isFinished();
1164   if (fin) {
1165     d->rebuilder.reset(); // all done!
1166   }
1167   return fin;
1168 }
1169
1170 void NavDataCache::doRebuild()
1171 {
1172   try {
1173     d->close(); // completely close the sqlite object
1174     d->path.remove(); // remove the file on disk
1175     d->init(); // start again from scratch
1176
1177     // initialise the root octree node
1178     d->runSQL("INSERT INTO octree (rowid, children) VALUES (1, 0)");
1179
1180     SGTimeStamp st;
1181     {
1182         Transaction txn(this);
1183
1184         st.stamp();
1185         airportDBLoad(d->aptDatPath);
1186         SG_LOG(SG_NAVCACHE, SG_INFO, "apt.dat load took:" << st.elapsedMSec());
1187
1188         metarDataLoad(d->metarDatPath);
1189         stampCacheFile(d->aptDatPath);
1190         stampCacheFile(d->metarDatPath);
1191
1192         st.stamp();
1193         loadFixes(d->fixDatPath);
1194         stampCacheFile(d->fixDatPath);
1195         SG_LOG(SG_NAVCACHE, SG_INFO, "fix.dat load took:" << st.elapsedMSec());
1196
1197         st.stamp();
1198         navDBInit(d->navDatPath);
1199         stampCacheFile(d->navDatPath);
1200         SG_LOG(SG_NAVCACHE, SG_INFO, "nav.dat load took:" << st.elapsedMSec());
1201
1202         st.stamp();
1203         txn.commit();
1204         SG_LOG(SG_NAVCACHE, SG_INFO, "stage 1 commit took:" << st.elapsedMSec());
1205     }
1206
1207 #ifdef SG_WINDOWS
1208       SG_LOG(SG_NAVCACHE, SG_ALERT, "SKIPPING POI load on Windows");
1209 #else
1210       {
1211           Transaction txn(this);
1212
1213           st.stamp();
1214           poiDBInit(d->poiDatPath);
1215           stampCacheFile(d->poiDatPath);
1216           SG_LOG(SG_NAVCACHE, SG_INFO, "poi.dat load took:" << st.elapsedMSec());
1217
1218           st.stamp();
1219           txn.commit();
1220           SG_LOG(SG_NAVCACHE, SG_INFO, "POI commit took:" << st.elapsedMSec());
1221       }
1222 #endif
1223
1224       {
1225           Transaction txn(this);
1226           loadCarrierNav(d->carrierDatPath);
1227           stampCacheFile(d->carrierDatPath);
1228
1229           st.stamp();
1230           Airway::load(d->airwayDatPath);
1231           stampCacheFile(d->airwayDatPath);
1232           SG_LOG(SG_NAVCACHE, SG_INFO, "awy.dat load took:" << st.elapsedMSec());
1233
1234           d->flushDeferredOctreeUpdates();
1235
1236           string sceneryPaths = simgear::strutils::join(globals->get_fg_scenery(), ";");
1237           writeStringProperty("scenery_paths", sceneryPaths);
1238
1239           st.stamp();
1240           txn.commit();
1241           SG_LOG(SG_NAVCACHE, SG_INFO, "final commit took:" << st.elapsedMSec());
1242
1243       }
1244
1245   } catch (sg_exception& e) {
1246     SG_LOG(SG_NAVCACHE, SG_ALERT, "caught exception rebuilding navCache:" << e.what());
1247   }
1248 }
1249
1250 int NavDataCache::readIntProperty(const string& key)
1251 {
1252   sqlite_bind_stdstring(d->readPropertyQuery, 1, key);
1253   int result = 0;
1254
1255   if (d->execSelect(d->readPropertyQuery)) {
1256     result = sqlite3_column_int(d->readPropertyQuery, 0);
1257   } else {
1258     SG_LOG(SG_NAVCACHE, SG_WARN, "readIntProperty: unknown:" << key);
1259   }
1260
1261   d->reset(d->readPropertyQuery);
1262   return result;
1263 }
1264
1265 double NavDataCache::readDoubleProperty(const string& key)
1266 {
1267   sqlite_bind_stdstring(d->readPropertyQuery, 1, key);
1268   double result = 0.0;
1269   if (d->execSelect(d->readPropertyQuery)) {
1270     result = sqlite3_column_double(d->readPropertyQuery, 0);
1271   } else {
1272     SG_LOG(SG_NAVCACHE, SG_WARN, "readDoubleProperty: unknown:" << key);
1273   }
1274
1275   d->reset(d->readPropertyQuery);
1276   return result;
1277 }
1278
1279 string NavDataCache::readStringProperty(const string& key)
1280 {
1281   sqlite_bind_stdstring(d->readPropertyQuery, 1, key);
1282   string result;
1283   if (d->execSelect(d->readPropertyQuery)) {
1284     result = (char*) sqlite3_column_text(d->readPropertyQuery, 0);
1285   } else {
1286     SG_LOG(SG_NAVCACHE, SG_WARN, "readStringProperty: unknown:" << key);
1287   }
1288
1289   d->reset(d->readPropertyQuery);
1290   return result;
1291 }
1292
1293 void NavDataCache::writeIntProperty(const string& key, int value)
1294 {
1295   d->writeIntProperty(key, value);
1296 }
1297
1298 void NavDataCache::writeStringProperty(const string& key, const string& value)
1299 {
1300   sqlite_bind_stdstring(d->clearProperty, 1, key);
1301   d->execUpdate(d->clearProperty);
1302
1303   sqlite_bind_stdstring(d->writePropertyQuery, 1, key);
1304   sqlite_bind_stdstring(d->writePropertyQuery, 2, value);
1305   d->execUpdate(d->writePropertyQuery);
1306 }
1307
1308 void NavDataCache::writeDoubleProperty(const string& key, const double& value)
1309 {
1310   sqlite_bind_stdstring(d->clearProperty, 1, key);
1311   d->execUpdate(d->clearProperty);
1312
1313   sqlite_bind_stdstring(d->writePropertyQuery, 1, key);
1314   sqlite3_bind_double(d->writePropertyQuery, 2, value);
1315   d->execUpdate(d->writePropertyQuery);
1316 }
1317
1318 string_list NavDataCache::readStringListProperty(const string& key)
1319 {
1320   sqlite_bind_stdstring(d->readPropertyQuery, 1, key);
1321   string_list result;
1322   while (d->stepSelect(d->readPropertyQuery)) {
1323     result.push_back((char*) sqlite3_column_text(d->readPropertyQuery, 0));
1324   }
1325   d->reset(d->readPropertyQuery);
1326
1327   return result;
1328 }
1329
1330 void NavDataCache::writeStringListProperty(const string& key, const string_list& values)
1331 {
1332   sqlite_bind_stdstring(d->clearProperty, 1, key);
1333   d->execUpdate(d->clearProperty);
1334
1335   BOOST_FOREACH(string value, values) {
1336     sqlite_bind_stdstring(d->writePropertyMulti, 1, key);
1337     sqlite_bind_stdstring(d->writePropertyMulti, 2, value);
1338     d->execInsert(d->writePropertyMulti);
1339   }
1340 }
1341
1342 bool NavDataCache::isCachedFileModified(const SGPath& path) const
1343 {
1344   if (!path.exists()) {
1345     throw sg_io_exception("isCachedFileModified: Missing file:" + path.str());
1346   }
1347
1348   sqlite_bind_temp_stdstring(d->statCacheCheck, 1, path.str());
1349   bool isModified = true;
1350
1351   if (d->execSelect(d->statCacheCheck)) {
1352     time_t modtime = sqlite3_column_int64(d->statCacheCheck, 0);
1353     time_t delta = std::labs(modtime - path.modTime());
1354     if (delta != 0)
1355     {
1356       SG_LOG(SG_NAVCACHE, SG_DEBUG, "NavCache: rebuild required for " << path << ". Timestamps: " << modtime << " != " << path.modTime());
1357     }
1358     else
1359     {
1360       SG_LOG(SG_NAVCACHE, SG_DEBUG, "NavCache: no rebuild required for " << path);
1361     }
1362
1363     isModified = (delta != 0);
1364   } else {
1365     SG_LOG(SG_NAVCACHE, SG_DEBUG, "NavCache: initial build required for " << path);
1366   }
1367
1368   d->reset(d->statCacheCheck);
1369   return isModified;
1370 }
1371
1372 void NavDataCache::stampCacheFile(const SGPath& path)
1373 {
1374   sqlite_bind_temp_stdstring(d->stampFileCache, 1, path.str());
1375   sqlite3_bind_int64(d->stampFileCache, 2, path.modTime());
1376   d->execInsert(d->stampFileCache);
1377 }
1378
1379 void NavDataCache::beginTransaction()
1380 {
1381   if (d->transactionLevel == 0) {
1382     d->transactionAborted = false;
1383     d->stepSelect(d->beginTransactionStmt);
1384     sqlite3_reset(d->beginTransactionStmt);
1385   }
1386
1387   ++d->transactionLevel;
1388 }
1389
1390 void NavDataCache::commitTransaction()
1391 {
1392   assert(d->transactionLevel > 0);
1393   if (--d->transactionLevel == 0) {
1394     // if a nested transaction aborted, we might end up here, but must
1395     // still abort the entire transaction. That's bad, but safer than
1396     // committing.
1397     sqlite3_stmt_ptr q = d->transactionAborted ? d->rollbackTransactionStmt : d->commitTransactionStmt;
1398
1399     int retries = 0;
1400     int result;
1401     while (retries < MAX_RETRIES) {
1402       result = sqlite3_step(q);
1403       if (result == SQLITE_DONE) {
1404         break;
1405       }
1406
1407       // see http://www.sqlite.org/c3ref/get_autocommit.html for a hint
1408       // what's going on here: autocommit in inactive inside BEGIN, so if
1409       // it's active, the DB was rolled-back
1410       if (sqlite3_get_autocommit(d->db)) {
1411         SG_LOG(SG_NAVCACHE, SG_ALERT, "commit: was rolled back!" << retries);
1412         d->transactionAborted = true;
1413         break;
1414       }
1415
1416       if (result != SQLITE_BUSY) {
1417         break;
1418       }
1419
1420       SGTimeStamp::sleepForMSec(++retries * 10);
1421       SG_LOG(SG_NAVCACHE, SG_ALERT, "NavCache contention on commit, will retry:" << retries);
1422     } // of retry loop for DB busy
1423
1424     string errMsg;
1425     if (result != SQLITE_DONE) {
1426       errMsg = sqlite3_errmsg(d->db);
1427       SG_LOG(SG_NAVCACHE, SG_ALERT, "Sqlite error:" << errMsg << " for  " << result
1428              << " while running:\n\t" << sqlite3_sql(q));
1429     }
1430
1431     sqlite3_reset(q);
1432   }
1433 }
1434
1435 void NavDataCache::abortTransaction()
1436 {
1437   SG_LOG(SG_NAVCACHE, SG_WARN, "NavCache: aborting transaction");
1438
1439   assert(d->transactionLevel > 0);
1440   if (--d->transactionLevel == 0) {
1441     d->stepSelect(d->rollbackTransactionStmt);
1442     sqlite3_reset(d->rollbackTransactionStmt);
1443   }
1444
1445   d->transactionAborted = true;
1446 }
1447
1448 FGPositionedRef NavDataCache::loadById(PositionedID rowid)
1449 {
1450   if (rowid == 0) {
1451     return NULL;
1452   }
1453
1454   PositionedCache::iterator it = d->cache.find(rowid);
1455   if (it != d->cache.end()) {
1456     d->cacheHits++;
1457     return it->second; // cache it
1458   }
1459
1460   FGPositioned* pos = d->loadById(rowid);
1461   d->cache.insert(it, PositionedCache::value_type(rowid, pos));
1462   d->cacheMisses++;
1463   return pos;
1464 }
1465
1466 PositionedID NavDataCache::insertAirport(FGPositioned::Type ty, const string& ident,
1467                                          const string& name)
1468 {
1469   // airports have their pos computed based on the avergae runway centres
1470   // so the pos isn't available immediately. Pass a dummy pos and avoid
1471   // doing spatial indexing until later
1472   sqlite3_int64 rowId = d->insertPositioned(ty, ident, name, SGGeod(),
1473                                             0 /* airport */,
1474                                             false /* spatial index */);
1475
1476   sqlite3_bind_int64(d->insertAirport, 1, rowId);
1477   d->execInsert(d->insertAirport);
1478
1479   return rowId;
1480 }
1481
1482 void NavDataCache::updatePosition(PositionedID item, const SGGeod &pos)
1483 {
1484   if (d->cache.find(item) != d->cache.end()) {
1485     SG_LOG(SG_NAVCACHE, SG_DEBUG, "updating position of an item in the cache");
1486     d->cache[item]->modifyPosition(pos);
1487   }
1488
1489   SGVec3d cartPos(SGVec3d::fromGeod(pos));
1490
1491   sqlite3_bind_int(d->setAirportPos, 1, item);
1492   sqlite3_bind_double(d->setAirportPos, 2, pos.getLongitudeDeg());
1493   sqlite3_bind_double(d->setAirportPos, 3, pos.getLatitudeDeg());
1494   sqlite3_bind_double(d->setAirportPos, 4, pos.getElevationM());
1495
1496 // bug 905; the octree leaf may change here, but the leaf may already be
1497 // loaded, and caching its children. (Either the old or new leaf!). Worse,
1498 // we may be called here as a result of loading one of those leaf's children.
1499 // instead of dealing with all those possibilites, such as modifying
1500 // the in-memory leaf's STL child container, we simply leave the runtime
1501 // structures alone. This is fine providing items do no move very far, since
1502 // all the spatial searches ultimately use the items' real cartesian position,
1503 // which was updated above.
1504   Octree::Leaf* octreeLeaf = Octree::global_spatialOctree->findLeafForPos(cartPos);
1505   sqlite3_bind_int64(d->setAirportPos, 5, octreeLeaf->guid());
1506
1507   sqlite3_bind_double(d->setAirportPos, 6, cartPos.x());
1508   sqlite3_bind_double(d->setAirportPos, 7, cartPos.y());
1509   sqlite3_bind_double(d->setAirportPos, 8, cartPos.z());
1510
1511
1512   d->execUpdate(d->setAirportPos);
1513 }
1514
1515 void NavDataCache::insertTower(PositionedID airportId, const SGGeod& pos)
1516 {
1517   d->insertPositioned(FGPositioned::TOWER, string(), string(),
1518                       pos, airportId, true /* spatial index */);
1519 }
1520
1521 PositionedID
1522 NavDataCache::insertRunway(FGPositioned::Type ty, const string& ident,
1523                            const SGGeod& pos, PositionedID apt,
1524                            double heading, double length, double width, double displacedThreshold,
1525                            double stopway, int surfaceCode)
1526 {
1527   // only runways are spatially indexed; don't bother indexing taxiways
1528   // or pavements
1529   bool spatialIndex = ( ty == FGPositioned::RUNWAY || ty == FGPositioned::HELIPAD);
1530
1531   sqlite3_int64 rowId = d->insertPositioned(ty, cleanRunwayNo(ident), "", pos, apt,
1532                                             spatialIndex);
1533   sqlite3_bind_int64(d->insertRunway, 1, rowId);
1534   sqlite3_bind_double(d->insertRunway, 2, heading);
1535   sqlite3_bind_double(d->insertRunway, 3, length);
1536   sqlite3_bind_double(d->insertRunway, 4, width);
1537   sqlite3_bind_int(d->insertRunway, 5, surfaceCode);
1538   sqlite3_bind_double(d->insertRunway, 6, displacedThreshold);
1539   sqlite3_bind_double(d->insertRunway, 7, stopway);
1540
1541   return d->execInsert(d->insertRunway);
1542 }
1543
1544 void NavDataCache::setRunwayReciprocal(PositionedID runway, PositionedID recip)
1545 {
1546   sqlite3_bind_int64(d->setRunwayReciprocal, 1, runway);
1547   sqlite3_bind_int64(d->setRunwayReciprocal, 2, recip);
1548   d->execUpdate(d->setRunwayReciprocal);
1549
1550 // and the opposite direction too!
1551   sqlite3_bind_int64(d->setRunwayReciprocal, 2, runway);
1552   sqlite3_bind_int64(d->setRunwayReciprocal, 1, recip);
1553   d->execUpdate(d->setRunwayReciprocal);
1554 }
1555
1556 void NavDataCache::setRunwayILS(PositionedID runway, PositionedID ils)
1557 {
1558   sqlite3_bind_int64(d->setRunwayILS, 1, runway);
1559   sqlite3_bind_int64(d->setRunwayILS, 2, ils);
1560   d->execUpdate(d->setRunwayILS);
1561
1562   // and the in-memory one
1563   if (d->cache.find(runway) != d->cache.end()) {
1564     FGRunway* instance = (FGRunway*) d->cache[runway].ptr();
1565     instance->setILS(ils);
1566   }
1567 }
1568
1569 void NavDataCache::updateRunwayThreshold(PositionedID runwayID, const SGGeod &aThreshold,
1570                                   double aHeading, double aDisplacedThreshold,
1571                                   double aStopway)
1572 {
1573 // update the runway information
1574   sqlite3_bind_int64(d->updateRunwayThreshold, 1, runwayID);
1575   sqlite3_bind_double(d->updateRunwayThreshold, 2, aHeading);
1576   sqlite3_bind_double(d->updateRunwayThreshold, 3, aDisplacedThreshold);
1577   sqlite3_bind_double(d->updateRunwayThreshold, 4, aStopway);
1578   d->execUpdate(d->updateRunwayThreshold);
1579
1580   // now update the positional data
1581   updatePosition(runwayID, aThreshold);
1582 }
1583
1584 PositionedID
1585 NavDataCache::insertNavaid(FGPositioned::Type ty, const string& ident,
1586                           const string& name, const SGGeod& pos,
1587                            int freq, int range, double multiuse,
1588                            PositionedID apt, PositionedID runway)
1589 {
1590   bool spatialIndex = true;
1591   if (ty == FGPositioned::MOBILE_TACAN) {
1592     spatialIndex = false;
1593   }
1594
1595   sqlite3_int64 rowId = d->insertPositioned(ty, ident, name, pos, apt,
1596                                             spatialIndex);
1597   sqlite3_bind_int64(d->insertNavaid, 1, rowId);
1598   sqlite3_bind_int(d->insertNavaid, 2, freq);
1599   sqlite3_bind_int(d->insertNavaid, 3, range);
1600   sqlite3_bind_double(d->insertNavaid, 4, multiuse);
1601   sqlite3_bind_int64(d->insertNavaid, 5, runway);
1602   sqlite3_bind_int64(d->insertNavaid, 6, 0);
1603   return d->execInsert(d->insertNavaid);
1604 }
1605
1606 void NavDataCache::setNavaidColocated(PositionedID navaid, PositionedID colocatedDME)
1607 {
1608   // Update DB entries...
1609   sqlite3_bind_int64(d->setNavaidColocated, 1, navaid);
1610   sqlite3_bind_int64(d->setNavaidColocated, 2, colocatedDME);
1611   d->execUpdate(d->setNavaidColocated);
1612
1613   // ...and the in-memory copy of the navrecord
1614   if (d->cache.find(navaid) != d->cache.end()) {
1615     FGNavRecord* rec = (FGNavRecord*) d->cache[navaid].get();
1616     rec->setColocatedDME(colocatedDME);
1617   }
1618 }
1619
1620 void NavDataCache::updateILS(PositionedID ils, const SGGeod& newPos, double aHdg)
1621 {
1622   sqlite3_bind_int64(d->updateILS, 1, ils);
1623   sqlite3_bind_double(d->updateILS, 2, aHdg);
1624   d->execUpdate(d->updateILS);
1625   updatePosition(ils, newPos);
1626 }
1627
1628 PositionedID NavDataCache::insertCommStation(FGPositioned::Type ty,
1629                                              const string& name, const SGGeod& pos, int freq, int range,
1630                                              PositionedID apt)
1631 {
1632   sqlite3_int64 rowId = d->insertPositioned(ty, "", name, pos, apt, true);
1633   sqlite3_bind_int64(d->insertCommStation, 1, rowId);
1634   sqlite3_bind_int(d->insertCommStation, 2, freq);
1635   sqlite3_bind_int(d->insertCommStation, 3, range);
1636   return d->execInsert(d->insertCommStation);
1637 }
1638
1639 PositionedID NavDataCache::insertFix(const std::string& ident, const SGGeod& aPos)
1640 {
1641   return d->insertPositioned(FGPositioned::FIX, ident, string(), aPos, 0, true);
1642 }
1643
1644 PositionedID NavDataCache::createPOI(FGPositioned::Type ty, const std::string& ident, const SGGeod& aPos)
1645 {
1646   return d->insertPositioned(ty, ident, string(), aPos, 0,
1647                              true /* spatial index */);
1648 }
1649
1650 bool NavDataCache::removePOI(FGPositioned::Type ty, const std::string& aIdent)
1651 {
1652   d->removePositionedWithIdent(ty, aIdent);
1653   // should remove from the live cache too?
1654
1655     return true;
1656 }
1657
1658 void NavDataCache::setAirportMetar(const string& icao, bool hasMetar)
1659 {
1660   sqlite_bind_stdstring(d->setAirportMetar, 1, icao);
1661   sqlite3_bind_int(d->setAirportMetar, 2, hasMetar);
1662   d->execUpdate(d->setAirportMetar);
1663 }
1664
1665 //------------------------------------------------------------------------------
1666 FGPositionedList NavDataCache::findAllWithIdent( const string& s,
1667                                                  FGPositioned::Filter* filter,
1668                                                  bool exact )
1669 {
1670   return d->findAllByString(s, "ident", filter, exact);
1671 }
1672
1673 //------------------------------------------------------------------------------
1674 FGPositionedList NavDataCache::findAllWithName( const string& s,
1675                                                 FGPositioned::Filter* filter,
1676                                                 bool exact )
1677 {
1678   return d->findAllByString(s, "name", filter, exact);
1679 }
1680
1681 //------------------------------------------------------------------------------
1682 FGPositionedRef NavDataCache::findClosestWithIdent( const string& aIdent,
1683                                                     const SGGeod& aPos,
1684                                                     FGPositioned::Filter* aFilter )
1685 {
1686   sqlite_bind_stdstring(d->findClosestWithIdent, 1, aIdent);
1687   if (aFilter) {
1688     sqlite3_bind_int(d->findClosestWithIdent, 2, aFilter->minType());
1689     sqlite3_bind_int(d->findClosestWithIdent, 3, aFilter->maxType());
1690   } else { // full type range
1691     sqlite3_bind_int(d->findClosestWithIdent, 2, FGPositioned::INVALID);
1692     sqlite3_bind_int(d->findClosestWithIdent, 3, FGPositioned::LAST_TYPE);
1693   }
1694
1695   SGVec3d cartPos(SGVec3d::fromGeod(aPos));
1696   sqlite3_bind_double(d->findClosestWithIdent, 4, cartPos.x());
1697   sqlite3_bind_double(d->findClosestWithIdent, 5, cartPos.y());
1698   sqlite3_bind_double(d->findClosestWithIdent, 6, cartPos.z());
1699
1700   FGPositionedRef result;
1701
1702   while (d->stepSelect(d->findClosestWithIdent)) {
1703     FGPositioned* pos = loadById(sqlite3_column_int64(d->findClosestWithIdent, 0));
1704     if (aFilter && !aFilter->pass(pos)) {
1705       continue;
1706     }
1707
1708     result = pos;
1709     break;
1710   }
1711
1712   d->reset(d->findClosestWithIdent);
1713   return result;
1714 }
1715
1716
1717 int NavDataCache::getOctreeBranchChildren(int64_t octreeNodeId)
1718 {
1719   sqlite3_bind_int64(d->getOctreeChildren, 1, octreeNodeId);
1720   d->execSelect1(d->getOctreeChildren);
1721   int children = sqlite3_column_int(d->getOctreeChildren, 0);
1722   d->reset(d->getOctreeChildren);
1723   return children;
1724 }
1725
1726 void NavDataCache::defineOctreeNode(Octree::Branch* pr, Octree::Node* nd)
1727 {
1728   sqlite3_bind_int64(d->insertOctree, 1, nd->guid());
1729   d->execInsert(d->insertOctree);
1730
1731 #ifdef LAZY_OCTREE_UPDATES
1732   d->deferredOctreeUpdates.insert(pr);
1733 #else
1734   // lowest three bits of node ID are 0..7 index of the child in the parent
1735   int childIndex = nd->guid() & 0x07;
1736
1737   sqlite3_bind_int64(d->updateOctreeChildren, 1, pr->guid());
1738 // mask has bit N set where child N exists
1739   int childMask = 1 << childIndex;
1740   sqlite3_bind_int(d->updateOctreeChildren, 2, childMask);
1741   d->execUpdate(d->updateOctreeChildren);
1742 #endif
1743 }
1744
1745 TypedPositionedVec
1746 NavDataCache::getOctreeLeafChildren(int64_t octreeNodeId)
1747 {
1748   sqlite3_bind_int64(d->getOctreeLeafChildren, 1, octreeNodeId);
1749
1750   TypedPositionedVec r;
1751   while (d->stepSelect(d->getOctreeLeafChildren)) {
1752     FGPositioned::Type ty = static_cast<FGPositioned::Type>
1753       (sqlite3_column_int(d->getOctreeLeafChildren, 1));
1754     r.push_back(std::make_pair(ty,
1755                 sqlite3_column_int64(d->getOctreeLeafChildren, 0)));
1756   }
1757
1758   d->reset(d->getOctreeLeafChildren);
1759   return r;
1760 }
1761
1762
1763 /**
1764  * A special purpose helper (used by FGAirport::searchNamesAndIdents) to
1765  * implement the AirportList dialog. It's unfortunate that it needs to reside
1766  * here, but for now it's least ugly solution.
1767  */
1768 char** NavDataCache::searchAirportNamesAndIdents(const std::string& aFilter)
1769 {
1770   sqlite3_stmt_ptr stmt;
1771   unsigned int numMatches = 0, numAllocated = 16;
1772   if (aFilter.empty()) {
1773     stmt = d->getAllAirports;
1774     numAllocated = 4096; // start much larger for all airports
1775   } else {
1776     stmt = d->searchAirports;
1777     string s = "%" + aFilter + "%";
1778     sqlite_bind_stdstring(stmt, 1, s);
1779   }
1780
1781   char** result = (char**) malloc(sizeof(char*) * numAllocated);
1782   while (d->stepSelect(stmt)) {
1783     if ((numMatches + 1) >= numAllocated) {
1784       numAllocated <<= 1; // double in size!
1785     // reallocate results array
1786       char** nresult = (char**) malloc(sizeof(char*) * numAllocated);
1787       memcpy(nresult, result, sizeof(char*) * numMatches);
1788       free(result);
1789       result = nresult;
1790     }
1791
1792     // nasty code to avoid excessive string copying and allocations.
1793     // We format results as follows (note whitespace!):
1794     //   ' name-of-airport-chars   (ident)'
1795     // so the total length is:
1796     //    1 + strlen(name) + 4 + strlen(icao) + 1 + 1 (for the null)
1797     // which gives a grand total of 7 + name-length + icao-length.
1798     // note the ident can be three letters (non-ICAO local strip), four
1799     // (default ICAO) or more (extended format ICAO)
1800     int nameLength = sqlite3_column_bytes(stmt, 1);
1801     int icaoLength = sqlite3_column_bytes(stmt, 0);
1802     char* entry = (char*) malloc(7 + nameLength + icaoLength);
1803     char* dst = entry;
1804     *dst++ = ' ';
1805     memcpy(dst, sqlite3_column_text(stmt, 1), nameLength);
1806     dst += nameLength;
1807     *dst++ = ' ';
1808     *dst++ = ' ';
1809     *dst++ = ' ';
1810     *dst++ = '(';
1811     memcpy(dst, sqlite3_column_text(stmt, 0), icaoLength);
1812     dst += icaoLength;
1813     *dst++ = ')';
1814     *dst++ = 0;
1815
1816     result[numMatches++] = entry;
1817   }
1818
1819   result[numMatches] = NULL; // end of list marker
1820   d->reset(stmt);
1821   return result;
1822 }
1823
1824 FGPositionedRef
1825 NavDataCache::findCommByFreq(int freqKhz, const SGGeod& aPos, FGPositioned::Filter* aFilter)
1826 {
1827   sqlite3_bind_int(d->findCommByFreq, 1, freqKhz);
1828   if (aFilter) {
1829     sqlite3_bind_int(d->findCommByFreq, 2, aFilter->minType());
1830     sqlite3_bind_int(d->findCommByFreq, 3, aFilter->maxType());
1831   } else { // full type range
1832     sqlite3_bind_int(d->findCommByFreq, 2, FGPositioned::FREQ_GROUND);
1833     sqlite3_bind_int(d->findCommByFreq, 3, FGPositioned::FREQ_UNICOM);
1834   }
1835
1836   SGVec3d cartPos(SGVec3d::fromGeod(aPos));
1837   sqlite3_bind_double(d->findCommByFreq, 4, cartPos.x());
1838   sqlite3_bind_double(d->findCommByFreq, 5, cartPos.y());
1839   sqlite3_bind_double(d->findCommByFreq, 6, cartPos.z());
1840   FGPositionedRef result;
1841
1842   while (d->execSelect(d->findCommByFreq)) {
1843     FGPositioned* p = loadById(sqlite3_column_int64(d->findCommByFreq, 0));
1844     if (aFilter && !aFilter->pass(p)) {
1845       continue;
1846     }
1847
1848     result = p;
1849     break;
1850   }
1851
1852   d->reset(d->findCommByFreq);
1853   return result;
1854 }
1855
1856 PositionedIDVec
1857 NavDataCache::findNavaidsByFreq(int freqKhz, const SGGeod& aPos, FGPositioned::Filter* aFilter)
1858 {
1859   sqlite3_bind_int(d->findNavsByFreq, 1, freqKhz);
1860   if (aFilter) {
1861     sqlite3_bind_int(d->findNavsByFreq, 2, aFilter->minType());
1862     sqlite3_bind_int(d->findNavsByFreq, 3, aFilter->maxType());
1863   } else { // full type range
1864     sqlite3_bind_int(d->findNavsByFreq, 2, FGPositioned::NDB);
1865     sqlite3_bind_int(d->findNavsByFreq, 3, FGPositioned::GS);
1866   }
1867
1868   SGVec3d cartPos(SGVec3d::fromGeod(aPos));
1869   sqlite3_bind_double(d->findNavsByFreq, 4, cartPos.x());
1870   sqlite3_bind_double(d->findNavsByFreq, 5, cartPos.y());
1871   sqlite3_bind_double(d->findNavsByFreq, 6, cartPos.z());
1872
1873   return d->selectIds(d->findNavsByFreq);
1874 }
1875
1876 PositionedIDVec
1877 NavDataCache::findNavaidsByFreq(int freqKhz, FGPositioned::Filter* aFilter)
1878 {
1879   sqlite3_bind_int(d->findNavsByFreqNoPos, 1, freqKhz);
1880   if (aFilter) {
1881     sqlite3_bind_int(d->findNavsByFreqNoPos, 2, aFilter->minType());
1882     sqlite3_bind_int(d->findNavsByFreqNoPos, 3, aFilter->maxType());
1883   } else { // full type range
1884     sqlite3_bind_int(d->findNavsByFreqNoPos, 2, FGPositioned::NDB);
1885     sqlite3_bind_int(d->findNavsByFreqNoPos, 3, FGPositioned::GS);
1886   }
1887
1888   return d->selectIds(d->findNavsByFreqNoPos);
1889 }
1890
1891 PositionedIDVec
1892 NavDataCache::airportItemsOfType(PositionedID apt,FGPositioned::Type ty,
1893                                  FGPositioned::Type maxTy)
1894 {
1895   if (maxTy == FGPositioned::INVALID) {
1896     maxTy = ty; // single-type range
1897   }
1898
1899   sqlite3_bind_int64(d->getAirportItems, 1, apt);
1900   sqlite3_bind_int(d->getAirportItems, 2, ty);
1901   sqlite3_bind_int(d->getAirportItems, 3, maxTy);
1902
1903   return d->selectIds(d->getAirportItems);
1904 }
1905
1906 PositionedID
1907 NavDataCache::airportItemWithIdent(PositionedID apt, FGPositioned::Type ty,
1908                                    const std::string& ident)
1909 {
1910   sqlite3_bind_int64(d->getAirportItemByIdent, 1, apt);
1911   sqlite_bind_stdstring(d->getAirportItemByIdent, 2, ident);
1912   sqlite3_bind_int(d->getAirportItemByIdent, 3, ty);
1913   PositionedID result = 0;
1914
1915   if (d->execSelect(d->getAirportItemByIdent)) {
1916     result = sqlite3_column_int64(d->getAirportItemByIdent, 0);
1917   }
1918
1919   d->reset(d->getAirportItemByIdent);
1920   return result;
1921 }
1922
1923 AirportRunwayPair
1924 NavDataCache::findAirportRunway(const std::string& aName)
1925 {
1926   if (aName.empty()) {
1927     return AirportRunwayPair();
1928   }
1929
1930   string_list parts = simgear::strutils::split(aName);
1931   if (parts.size() < 2) {
1932     SG_LOG(SG_NAVCACHE, SG_WARN, "findAirportRunway: malformed name:" << aName);
1933     return AirportRunwayPair();
1934   }
1935
1936   AirportRunwayPair result;
1937   sqlite_bind_stdstring(d->findAirportRunway, 1, parts[0]);
1938   sqlite_bind_stdstring(d->findAirportRunway, 2, parts[1]);
1939
1940   if (d->execSelect(d->findAirportRunway)) {
1941     result = AirportRunwayPair(sqlite3_column_int64(d->findAirportRunway, 0),
1942                       sqlite3_column_int64(d->findAirportRunway, 1));
1943
1944   } else {
1945     SG_LOG(SG_NAVCACHE, SG_WARN, "findAirportRunway: unknown airport/runway:" << aName);
1946   }
1947
1948   d->reset(d->findAirportRunway);
1949   return result;
1950 }
1951
1952 PositionedID
1953 NavDataCache::findILS(PositionedID airport, const string& runway, const string& navIdent)
1954 {
1955   sqlite_bind_stdstring(d->findILS, 1, navIdent);
1956   sqlite3_bind_int64(d->findILS, 2, airport);
1957   sqlite_bind_stdstring(d->findILS, 3, runway);
1958   PositionedID result = 0;
1959   if (d->execSelect(d->findILS)) {
1960     result = sqlite3_column_int64(d->findILS, 0);
1961   }
1962
1963   d->reset(d->findILS);
1964   return result;
1965 }
1966
1967 int NavDataCache::findAirway(int network, const string& aName)
1968 {
1969   sqlite3_bind_int(d->findAirway, 1, network);
1970   sqlite_bind_stdstring(d->findAirway, 2, aName);
1971
1972   int airway = 0;
1973   if (d->execSelect(d->findAirway)) {
1974     // already exists
1975     airway = sqlite3_column_int(d->findAirway, 0);
1976   } else {
1977     sqlite_bind_stdstring(d->insertAirway, 1, aName);
1978     sqlite3_bind_int(d->insertAirway, 2, network);
1979     airway = d->execInsert(d->insertAirway);
1980   }
1981
1982   d->reset(d->findAirway);
1983   return airway;
1984 }
1985
1986 void NavDataCache::insertEdge(int network, int airwayID, PositionedID from, PositionedID to)
1987 {
1988   // assume all edges are bidirectional for the moment
1989   for (int i=0; i<2; ++i) {
1990     sqlite3_bind_int(d->insertAirwayEdge, 1, network);
1991     sqlite3_bind_int(d->insertAirwayEdge, 2, airwayID);
1992     sqlite3_bind_int64(d->insertAirwayEdge, 3, from);
1993     sqlite3_bind_int64(d->insertAirwayEdge, 4, to);
1994     d->execInsert(d->insertAirwayEdge);
1995
1996     std::swap(from, to);
1997   }
1998 }
1999
2000 bool NavDataCache::isInAirwayNetwork(int network, PositionedID pos)
2001 {
2002   sqlite3_bind_int(d->isPosInAirway, 1, network);
2003   sqlite3_bind_int64(d->isPosInAirway, 2, pos);
2004   bool ok = d->execSelect(d->isPosInAirway);
2005   d->reset(d->isPosInAirway);
2006
2007   return ok;
2008 }
2009
2010 AirwayEdgeVec NavDataCache::airwayEdgesFrom(int network, PositionedID pos)
2011 {
2012   sqlite3_bind_int(d->airwayEdgesFrom, 1, network);
2013   sqlite3_bind_int64(d->airwayEdgesFrom, 2, pos);
2014
2015   AirwayEdgeVec result;
2016   while (d->stepSelect(d->airwayEdgesFrom)) {
2017     result.push_back(AirwayEdge(
2018                      sqlite3_column_int(d->airwayEdgesFrom, 0),
2019                      sqlite3_column_int64(d->airwayEdgesFrom, 1)
2020                      ));
2021   }
2022
2023   d->reset(d->airwayEdgesFrom);
2024   return result;
2025 }
2026
2027 PositionedID NavDataCache::findNavaidForRunway(PositionedID runway, FGPositioned::Type ty)
2028 {
2029   sqlite3_bind_int64(d->findNavaidForRunway, 1, runway);
2030   sqlite3_bind_int(d->findNavaidForRunway, 2, ty);
2031
2032   PositionedID result = 0;
2033   if (d->execSelect(d->findNavaidForRunway)) {
2034     result = sqlite3_column_int64(d->findNavaidForRunway, 0);
2035   }
2036
2037   d->reset(d->findNavaidForRunway);
2038   return result;
2039 }
2040
2041 PositionedID
2042 NavDataCache::insertParking(const std::string& name, const SGGeod& aPos,
2043                             PositionedID aAirport,
2044                            double aHeading, int aRadius, const std::string& aAircraftType,
2045                            const std::string& aAirlines)
2046 {
2047   sqlite3_int64 rowId = d->insertPositioned(FGPositioned::PARKING, name, "", aPos, aAirport, false);
2048
2049 // we need to insert a row into the taxi_node table, otherwise we can't maintain
2050 // the appropriate pushback flag.
2051   sqlite3_bind_int64(d->insertTaxiNode, 1, rowId);
2052   sqlite3_bind_int(d->insertTaxiNode, 2, 0);
2053   sqlite3_bind_int(d->insertTaxiNode, 3, 0);
2054   d->execInsert(d->insertTaxiNode);
2055
2056   sqlite3_bind_int64(d->insertParkingPos, 1, rowId);
2057   sqlite3_bind_double(d->insertParkingPos, 2, aHeading);
2058   sqlite3_bind_int(d->insertParkingPos, 3, aRadius);
2059   sqlite_bind_stdstring(d->insertParkingPos, 4, aAircraftType);
2060   sqlite_bind_stdstring(d->insertParkingPos, 5, aAirlines);
2061   return d->execInsert(d->insertParkingPos);
2062 }
2063
2064 void NavDataCache::setParkingPushBackRoute(PositionedID parking, PositionedID pushBackNode)
2065 {
2066   sqlite3_bind_int64(d->setParkingPushBack, 1, parking);
2067   sqlite3_bind_int64(d->setParkingPushBack, 2, pushBackNode);
2068   d->execUpdate(d->setParkingPushBack);
2069 }
2070
2071 PositionedID
2072 NavDataCache::insertTaxiNode(const SGGeod& aPos, PositionedID aAirport, int aHoldType, bool aOnRunway)
2073 {
2074   sqlite3_int64 rowId = d->insertPositioned(FGPositioned::TAXI_NODE, string(), string(), aPos, aAirport, false);
2075   sqlite3_bind_int64(d->insertTaxiNode, 1, rowId);
2076   sqlite3_bind_int(d->insertTaxiNode, 2, aHoldType);
2077   sqlite3_bind_int(d->insertTaxiNode, 3, aOnRunway);
2078   return d->execInsert(d->insertTaxiNode);
2079 }
2080
2081 void NavDataCache::insertGroundnetEdge(PositionedID aAirport, PositionedID from, PositionedID to)
2082 {
2083   sqlite3_bind_int64(d->insertTaxiEdge, 1, aAirport);
2084   sqlite3_bind_int64(d->insertTaxiEdge, 2, from);
2085   sqlite3_bind_int64(d->insertTaxiEdge, 3, to);
2086   d->execInsert(d->insertTaxiEdge);
2087 }
2088
2089 PositionedIDVec NavDataCache::groundNetNodes(PositionedID aAirport, bool onlyPushback)
2090 {
2091   sqlite3_stmt_ptr q = onlyPushback ? d->airportPushbackNodes : d->airportTaxiNodes;
2092   sqlite3_bind_int64(q, 1, aAirport);
2093   return d->selectIds(q);
2094 }
2095
2096 void NavDataCache::markGroundnetAsPushback(PositionedID nodeId)
2097 {
2098   sqlite3_bind_int64(d->markTaxiNodeAsPushback, 1, nodeId);
2099   d->execUpdate(d->markTaxiNodeAsPushback);
2100 }
2101
2102 static double headingDifferenceDeg(double crs1, double crs2)
2103 {
2104   double diff =  crs2 - crs1;
2105   SG_NORMALIZE_RANGE(diff, -180.0, 180.0);
2106   return diff;
2107 }
2108
2109 PositionedID NavDataCache::findGroundNetNode(PositionedID airport, const SGGeod& aPos,
2110                                              bool onRunway, FGRunway* aRunway)
2111 {
2112   sqlite3_stmt_ptr q = onRunway ? d->findNearestRunwayTaxiNode : d->findNearestTaxiNode;
2113   sqlite3_bind_int64(q, 1, airport);
2114
2115   SGVec3d cartPos(SGVec3d::fromGeod(aPos));
2116   sqlite3_bind_double(q, 2, cartPos.x());
2117   sqlite3_bind_double(q, 3, cartPos.y());
2118   sqlite3_bind_double(q, 4, cartPos.z());
2119
2120   PositionedID result = 0;
2121   while (d->execSelect(q)) {
2122     PositionedID id = sqlite3_column_int64(q, 0);
2123     if (!aRunway) {
2124       result = id;
2125       break;
2126     }
2127
2128   // ensure found node lies on the runway
2129     FGPositionedRef node = loadById(id);
2130     double course = SGGeodesy::courseDeg(node->geod(), aRunway->end());
2131     if (fabs(headingDifferenceDeg(course, aRunway->headingDeg())) < 3.0 ) {
2132       result = id;
2133       break;
2134     }
2135   }
2136
2137   d->reset(q);
2138   return result;
2139 }
2140
2141 PositionedIDVec NavDataCache::groundNetEdgesFrom(PositionedID pos, bool onlyPushback)
2142 {
2143   sqlite3_stmt_ptr q = onlyPushback ? d->pushbackEdgesFrom : d->taxiEdgesFrom;
2144   sqlite3_bind_int64(q, 1, pos);
2145   return d->selectIds(q);
2146 }
2147
2148 PositionedIDVec NavDataCache::findAirportParking(PositionedID airport, const std::string& flightType,
2149                                    int radius)
2150 {
2151   sqlite3_bind_int64(d->findAirportParking, 1, airport);
2152   sqlite3_bind_int(d->findAirportParking, 2, radius);
2153   sqlite_bind_stdstring(d->findAirportParking, 3, flightType);
2154
2155   return d->selectIds(d->findAirportParking);
2156 }
2157
2158 void NavDataCache::dropGroundnetFor(PositionedID aAirport)
2159 {
2160   sqlite3_stmt_ptr q = d->prepare("DELETE FROM parking WHERE rowid IN (SELECT rowid FROM positioned WHERE type=?1 AND airport=?2)");
2161   sqlite3_bind_int(q, 1, FGPositioned::PARKING);
2162   sqlite3_bind_int64(q, 2, aAirport);
2163   d->execUpdate(q);
2164
2165   q = d->prepare("DELETE FROM taxi_node WHERE rowid IN (SELECT rowid FROM positioned WHERE (type=?1 OR type=?2) AND airport=?3)");
2166   sqlite3_bind_int(q, 1, FGPositioned::TAXI_NODE);
2167   sqlite3_bind_int(q, 2, FGPositioned::PARKING);
2168   sqlite3_bind_int64(q, 3, aAirport);
2169   d->execUpdate(q);
2170
2171   q = d->prepare("DELETE FROM positioned WHERE (type=?1 OR type=?2) AND airport=?3");
2172   sqlite3_bind_int(q, 1, FGPositioned::TAXI_NODE);
2173   sqlite3_bind_int(q, 2, FGPositioned::PARKING);
2174   sqlite3_bind_int64(q, 3, aAirport);
2175   d->execUpdate(q);
2176
2177   q = d->prepare("DELETE FROM groundnet_edge WHERE airport=?1");
2178   sqlite3_bind_int64(q, 1, aAirport);
2179   d->execUpdate(q);
2180 }
2181
2182 bool NavDataCache::isReadOnly() const
2183 {
2184     return d->readOnly;
2185 }
2186
2187 /////////////////////////////////////////////////////////////////////////////////////////
2188 // Transaction RAII object
2189
2190 NavDataCache::Transaction::Transaction(NavDataCache* cache) :
2191     _instance(cache),
2192     _committed(false)
2193 {
2194     assert(cache);
2195     _instance->beginTransaction();
2196 }
2197
2198 NavDataCache::Transaction::~Transaction()
2199 {
2200     if (!_committed) {
2201         SG_LOG(SG_NAVCACHE, SG_INFO, "aborting cache transaction!");
2202         _instance->abortTransaction();
2203     }
2204 }
2205
2206 void NavDataCache::Transaction::commit()
2207 {
2208     assert(!_committed);
2209     _committed = true;
2210     _instance->commitTransaction();
2211 }
2212
2213 } // of namespace flightgear
2214