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
 478     insertPositionedQuery = prepare("INSERT INTO positioned "
 479                                     "(type, ident, name, airport, lon, lat, elev_m, octree_node, "
 480                                     "cart_x, cart_y, cart_z)"
 481                                     " VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10, ?11)");
 482
 483     setAirportPos = prepare("UPDATE positioned SET lon=?2, lat=?3, elev_m=?4, octree_node=?5, "
 484                             "cart_x=?6, cart_y=?7, cart_z=?8 WHERE rowid=?1");
 485     insertAirport = prepare("INSERT INTO airport (rowid, has_metar) VALUES (?, ?)");
 486     insertNavaid = prepare("INSERT INTO navaid (rowid, freq, range_nm, multiuse, runway, colocated)"
 487                            " VALUES (?1, ?2, ?3, ?4, ?5, ?6)");
 488
 489     insertCommStation = prepare("INSERT INTO comm (rowid, freq_khz, range_nm)"
 490                                 " VALUES (?, ?, ?)");
 491     insertRunway = prepare("INSERT INTO runway "
 492                            "(rowid, heading, length_ft, width_m, surface, displaced_threshold, stopway, reciprocal)"
 493                            " VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8)");
 494     runwayLengthFtQuery = prepare("SELECT length_ft FROM runway WHERE rowid=?1");
 495
 496     removePOIQuery = prepare("DELETE FROM positioned WHERE type=?1 AND ident=?2");
 497
 498   // query statement
 499     findClosestWithIdent = prepare("SELECT rowid FROM positioned WHERE ident=?1 "
 500                                    AND_TYPED " ORDER BY distanceCartSqr(cart_x, cart_y, cart_z, ?4, ?5, ?6)");
 501
 502     findCommByFreq = prepare("SELECT positioned.rowid FROM positioned, comm WHERE "
 503                              "positioned.rowid=comm.rowid AND freq_khz=?1 "
 504                              AND_TYPED " ORDER BY distanceCartSqr(cart_x, cart_y, cart_z, ?4, ?5, ?6)");
 505
 506     findNavsByFreq = prepare("SELECT positioned.rowid FROM positioned, navaid WHERE "
 507                              "positioned.rowid=navaid.rowid "
 508                              "AND navaid.freq=?1 " AND_TYPED
 509                              " ORDER BY distanceCartSqr(cart_x, cart_y, cart_z, ?4, ?5, ?6)");
 510
 511     findNavsByFreqNoPos = prepare("SELECT positioned.rowid FROM positioned, navaid WHERE "
 512                                   "positioned.rowid=navaid.rowid AND freq=?1 " AND_TYPED);
 513
 514     findNavaidForRunway = prepare("SELECT positioned.rowid FROM positioned, navaid WHERE "
 515                                   "positioned.rowid=navaid.rowid AND runway=?1 AND type=?2");
 516
 517   // for an octree branch, return the child octree nodes which exist,
 518   // described as a bit-mask
 519     getOctreeChildren = prepare("SELECT children FROM octree WHERE rowid=?1");
 520
 521 #ifdef LAZY_OCTREE_UPDATES
 522     updateOctreeChildren = prepare("UPDATE octree SET children=?2 WHERE rowid=?1");
 523 #else
 524   // mask the new child value into the existing one
 525     updateOctreeChildren = prepare("UPDATE octree SET children=(?2 | children) WHERE rowid=?1");
 526 #endif
 527
 528   // define a new octree node (with no children)
 529     insertOctree = prepare("INSERT INTO octree (rowid, children) VALUES (?1, 0)");
 530
 531     getOctreeLeafChildren = prepare("SELECT rowid, type FROM positioned WHERE octree_node=?1");
 532
 533     searchAirports = prepare("SELECT ident, name FROM positioned WHERE (name LIKE ?1 OR ident LIKE ?1) " AND_TYPED);
 534     sqlite3_bind_int(searchAirports, 2, FGPositioned::AIRPORT);
 535     sqlite3_bind_int(searchAirports, 3, FGPositioned::SEAPORT);
 536
 537     getAllAirports = prepare("SELECT ident, name FROM positioned WHERE type>=?1 AND type <=?2");
 538     sqlite3_bind_int(getAllAirports, 1, FGPositioned::AIRPORT);
 539     sqlite3_bind_int(getAllAirports, 2, FGPositioned::SEAPORT);
 540
 541
 542     getAirportItemByIdent = prepare("SELECT rowid FROM positioned WHERE airport=?1 AND ident=?2 AND type=?3");
 543
 544     findAirportRunway = prepare("SELECT airport, rowid FROM positioned WHERE ident=?2 AND type=?3 AND airport="
 545                                 "(SELECT rowid FROM positioned WHERE type=?4 AND ident=?1)");
 546     sqlite3_bind_int(findAirportRunway, 3, FGPositioned::RUNWAY);
 547     sqlite3_bind_int(findAirportRunway, 4, FGPositioned::AIRPORT);
 548
 549     // three-way join to get the navaid ident and runway ident in a single select.
 550     // we're joining positioned to itself by the navaid runway, with the complication
 551     // that we need to join the navaids table to get the runway ID.
 552     // we also need to filter by type to excluse glideslope (GS) matches
 553     findILS = prepare("SELECT nav.rowid FROM positioned AS nav, positioned AS rwy, navaid WHERE "
 554                       "nav.ident=?1 AND nav.airport=?2 AND rwy.ident=?3 "
 555                       "AND rwy.rowid = navaid.runway AND navaid.rowid=nav.rowid "
 556                       "AND (nav.type=?4 OR nav.type=?5)");
 557
 558     sqlite3_bind_int(findILS, 4, FGPositioned::ILS);
 559     sqlite3_bind_int(findILS, 5, FGPositioned::LOC);
 560
 561   // airways
 562     findAirway = prepare("SELECT rowid FROM airway WHERE network=?1 AND ident=?2");
 563     insertAirway = prepare("INSERT INTO airway (ident, network) "
 564                            "VALUES (?1, ?2)");
 565
 566     insertAirwayEdge = prepare("INSERT INTO airway_edge (network, airway, a, b) "
 567                                "VALUES (?1, ?2, ?3, ?4)");
 568
 569     isPosInAirway = prepare("SELECT rowid FROM airway_edge WHERE network=?1 AND a=?2");
 570
 571     airwayEdgesFrom = prepare("SELECT airway, b FROM airway_edge WHERE network=?1 AND a=?2");
 572
 573   // parking / taxi-node graph
 574     insertTaxiNode = prepare("INSERT INTO taxi_node (rowid, hold_type, on_runway, pushback) VALUES(?1, ?2, ?3, 0)");
 575     insertParkingPos = prepare("INSERT INTO parking (rowid, heading, radius, gate_type, airlines) "
 576                                "VALUES (?1, ?2, ?3, ?4, ?5)");
 577     setParkingPushBack = prepare("UPDATE parking SET pushback=?2 WHERE rowid=?1");
 578
 579     loadTaxiNodeStmt = prepare("SELECT hold_type, on_runway FROM taxi_node WHERE rowid=?1");
 580     loadParkingPos = prepare("SELECT heading, radius, gate_type, airlines, pushback FROM parking WHERE rowid=?1");
 581     taxiEdgesFrom = prepare("SELECT b FROM groundnet_edge WHERE a=?1");
 582     pushbackEdgesFrom = prepare("SELECT b FROM groundnet_edge, taxi_node WHERE "
 583                                 "a=?1 AND groundnet_edge.b = taxi_node.rowid AND pushback=1");
 584
 585     insertTaxiEdge = prepare("INSERT INTO groundnet_edge (airport, a,b) VALUES(?1, ?2, ?3)");
 586
 587     markTaxiNodeAsPushback = prepare("UPDATE taxi_node SET pushback=1 WHERE rowid=?1");
 588     airportTaxiNodes = prepare("SELECT rowid FROM positioned WHERE (type=?2 OR type=?3) AND airport=?1");
 589     sqlite3_bind_int(airportTaxiNodes, 2, FGPositioned::PARKING);
 590     sqlite3_bind_int(airportTaxiNodes, 3, FGPositioned::TAXI_NODE);
 591
 592     airportPushbackNodes = prepare("SELECT positioned.rowid FROM positioned, taxi_node WHERE "\
 593                                    "airport=?1 AND positioned.rowid=taxi_node.rowid AND pushback=1 "
 594                                    "AND (type=?2 OR type=?3)");
 595     sqlite3_bind_int(airportPushbackNodes, 2, FGPositioned::PARKING);
 596     sqlite3_bind_int(airportPushbackNodes, 3, FGPositioned::TAXI_NODE);
 597
 598     findNearestTaxiNode = prepare("SELECT positioned.rowid FROM positioned, taxi_node WHERE "
 599                                   "positioned.rowid = taxi_node.rowid AND airport=?1 "
 600                                   "ORDER BY distanceCartSqr(cart_x, cart_y, cart_z, ?2, ?3, ?4) "
 601                                   "LIMIT 1");
 602
 603     findNearestRunwayTaxiNode = prepare("SELECT positioned.rowid FROM positioned, taxi_node WHERE "
 604                                         "positioned.rowid = taxi_node.rowid AND airport=?1 "
 605                                         "AND on_runway=1 "
 606                                         "ORDER BY distanceCartSqr(cart_x, cart_y, cart_z, ?2, ?3, ?4) ");
 607
 608     findAirportParking = prepare("SELECT positioned.rowid FROM positioned, parking WHERE "
 609                                  "airport=?1 AND type=?4 AND "
 610                                  "radius >= ?2 AND gate_type = ?3 AND "
 611                                  "parking.rowid=positioned.rowid");
 612     sqlite3_bind_int(findAirportParking, 4, FGPositioned::PARKING);
 613   }
 614
 615   void writeIntProperty(const string& key, int value)
 616   {
 617     sqlite_bind_stdstring(clearProperty, 1, key);
 618     execUpdate(clearProperty);
 619
 620     sqlite_bind_stdstring(writePropertyQuery, 1, key);
 621     sqlite3_bind_int(writePropertyQuery, 2, value);
 622     execUpdate(writePropertyQuery);
 623   }
 624
 625
 626   FGPositioned* loadById(sqlite_int64 rowId, sqlite3_int64& aptId);
 627
 628   FGAirport* loadAirport(sqlite_int64 rowId,
 629                          FGPositioned::Type ty,
 630                          const string& id, const string& name, const SGGeod& pos)
 631   {
 632     sqlite3_bind_int64(loadAirportStmt, 1, rowId);
 633     execSelect1(loadAirportStmt);
 634     bool hasMetar = (sqlite3_column_int(loadAirportStmt, 0) > 0);
 635     reset(loadAirportStmt);
 636
 637     return new FGAirport(rowId, id, pos, name, hasMetar, ty);
 638   }
 639
 640   FGRunwayBase* loadRunway(sqlite3_int64 rowId, FGPositioned::Type ty,
 641                            const string& id, const SGGeod& pos, PositionedID apt)
 642   {
 643     sqlite3_bind_int(loadRunwayStmt, 1, rowId);
 644     execSelect1(loadRunwayStmt);
 645
 646     double heading = sqlite3_column_double(loadRunwayStmt, 0);
 647     double lengthM = sqlite3_column_int(loadRunwayStmt, 1);
 648     double widthM = sqlite3_column_double(loadRunwayStmt, 2);
 649     int surface = sqlite3_column_int(loadRunwayStmt, 3);
 650
 651     if (ty == FGPositioned::TAXIWAY) {
 652       reset(loadRunwayStmt);
 653       return new FGTaxiway(rowId, id, pos, heading, lengthM, widthM, surface);
 654     } else if (ty == FGPositioned::HELIPAD) {
 655         reset(loadRunwayStmt);
 656         return new FGHelipad(rowId, apt, id, pos, heading, lengthM, widthM, surface);
 657     } else {
 658       double displacedThreshold = sqlite3_column_double(loadRunwayStmt, 4);
 659       double stopway = sqlite3_column_double(loadRunwayStmt, 5);
 660       PositionedID reciprocal = sqlite3_column_int64(loadRunwayStmt, 6);
 661       PositionedID ils = sqlite3_column_int64(loadRunwayStmt, 7);
 662       FGRunway* r = new FGRunway(rowId, apt, id, pos, heading, lengthM, widthM,
 663                           displacedThreshold, stopway, surface);
 664
 665       if (reciprocal > 0) {
 666         r->setReciprocalRunway(reciprocal);
 667       }
 668
 669       if (ils > 0) {
 670         r->setILS(ils);
 671       }
 672
 673       reset(loadRunwayStmt);
 674       return r;
 675     }
 676   }
 677
 678   CommStation* loadComm(sqlite3_int64 rowId, FGPositioned::Type ty,
 679                         const string& id, const string& name,
 680                         const SGGeod& pos,
 681                         PositionedID airport)
 682   {
 683     sqlite3_bind_int64(loadCommStation, 1, rowId);
 684     execSelect1(loadCommStation);
 685
 686     int range = sqlite3_column_int(loadCommStation, 0);
 687     int freqKhz = sqlite3_column_int(loadCommStation, 1);
 688     reset(loadCommStation);
 689
 690     CommStation* c = new CommStation(rowId, name, ty, pos, freqKhz, range);
 691     c->setAirport(airport);
 692     return c;
 693   }
 694
 695   FGPositioned* loadNav(sqlite3_int64 rowId,
 696                        FGPositioned::Type ty, const string& id,
 697                        const string& name, const SGGeod& pos)
 698   {
 699     sqlite3_bind_int64(loadNavaid, 1, rowId);
 700     execSelect1(loadNavaid);
 701
 702     PositionedID runway = sqlite3_column_int64(loadNavaid, 3);
 703     // marker beacons are light-weight
 704     if ((ty == FGPositioned::OM) || (ty == FGPositioned::IM) ||
 705         (ty == FGPositioned::MM))
 706     {
 707       reset(loadNavaid);
 708       return new FGMarkerBeaconRecord(rowId, ty, runway, pos);
 709     }
 710
 711     int rangeNm = sqlite3_column_int(loadNavaid, 0),
 712     freq = sqlite3_column_int(loadNavaid, 1);
 713     double mulituse = sqlite3_column_double(loadNavaid, 2);
 714     PositionedID colocated = sqlite3_column_int64(loadNavaid, 4);
 715     reset(loadNavaid);
 716
 717     FGNavRecord* n =
 718       (ty == FGPositioned::MOBILE_TACAN)
 719       ? new FGMobileNavRecord
 720             (rowId, ty, id, name, pos, freq, rangeNm, mulituse, runway)
 721       : new FGNavRecord
 722             (rowId, ty, id, name, pos, freq, rangeNm, mulituse, runway);
 723
 724     if (colocated)
 725       n->setColocatedDME(colocated);
 726
 727     return n;
 728   }
 729
 730   FGPositioned* loadParking(sqlite3_int64 rowId,
 731                             const string& name, const SGGeod& pos,
 732                             PositionedID airport)
 733   {
 734     sqlite3_bind_int64(loadParkingPos, 1, rowId);
 735     execSelect1(loadParkingPos);
 736
 737     double heading = sqlite3_column_double(loadParkingPos, 0);
 738     int radius = sqlite3_column_int(loadParkingPos, 1);
 739     string aircraftType((char*) sqlite3_column_text(loadParkingPos, 2));
 740     string airlines((char*) sqlite3_column_text(loadParkingPos, 3));
 741     PositionedID pushBack = sqlite3_column_int64(loadParkingPos, 4);
 742     reset(loadParkingPos);
 743
 744     return new FGParking(rowId, pos, heading, radius, name, aircraftType, airlines, pushBack);
 745   }
 746
 747   FGPositioned* loadTaxiNode(sqlite3_int64 rowId, const SGGeod& pos,
 748                              PositionedID airport)
 749   {
 750     sqlite3_bind_int64(loadTaxiNodeStmt, 1, rowId);
 751     execSelect1(loadTaxiNodeStmt);
 752
 753     int hold_type = sqlite3_column_int(loadTaxiNodeStmt, 0);
 754     bool onRunway = sqlite3_column_int(loadTaxiNodeStmt, 1);
 755     reset(loadTaxiNodeStmt);
 756
 757     return new FGTaxiNode(rowId, pos, onRunway, hold_type);
 758   }
 759
 760   PositionedID insertPositioned(FGPositioned::Type ty, const string& ident,
 761                                 const string& name, const SGGeod& pos, PositionedID apt,
 762                                 bool spatialIndex)
 763   {
 764     SGVec3d cartPos(SGVec3d::fromGeod(pos));
 765
 766     sqlite3_bind_int(insertPositionedQuery, 1, ty);
 767     sqlite_bind_stdstring(insertPositionedQuery, 2, ident);
 768     sqlite_bind_stdstring(insertPositionedQuery, 3, name);
 769     sqlite3_bind_int64(insertPositionedQuery, 4, apt);
 770     sqlite3_bind_double(insertPositionedQuery, 5, pos.getLongitudeDeg());
 771     sqlite3_bind_double(insertPositionedQuery, 6, pos.getLatitudeDeg());
 772     sqlite3_bind_double(insertPositionedQuery, 7, pos.getElevationM());
 773
 774     if (spatialIndex) {
 775       Octree::Leaf* octreeLeaf = Octree::global_spatialOctree->findLeafForPos(cartPos);
 776       assert(intersects(octreeLeaf->bbox(), cartPos));
 777       sqlite3_bind_int64(insertPositionedQuery, 8, octreeLeaf->guid());
 778     } else {
 779       sqlite3_bind_null(insertPositionedQuery, 8);
 780     }
 781
 782     sqlite3_bind_double(insertPositionedQuery, 9, cartPos.x());
 783     sqlite3_bind_double(insertPositionedQuery, 10, cartPos.y());
 784     sqlite3_bind_double(insertPositionedQuery, 11, cartPos.z());
 785
 786     PositionedID r = execInsert(insertPositionedQuery);
 787     return r;
 788   }
 789
 790   FGPositionedList findAllByString(const string& s, const string& column,
 791                                      FGPositioned::Filter* filter, bool exact)
 792   {
 793     string query = s;
 794     if (!exact) query += "%";
 795
 796   // build up SQL query text
 797     string matchTerm = exact ? "=?1" : " LIKE ?1";
 798     string sql = "SELECT rowid FROM positioned WHERE " + column + matchTerm;
 799     if (filter) {
 800       sql += " " AND_TYPED;
 801     }
 802
 803   // find or prepare a suitable statement frrm the SQL
 804     sqlite3_stmt_ptr stmt = findByStringDict[sql];
 805     if (!stmt) {
 806       stmt = prepare(sql);
 807       findByStringDict[sql] = stmt;
 808     }
 809
 810     sqlite_bind_stdstring(stmt, 1, query);
 811     if (filter) {
 812       sqlite3_bind_int(stmt, 2, filter->minType());
 813       sqlite3_bind_int(stmt, 3, filter->maxType());
 814     }
 815
 816     FGPositionedList result;
 817   // run the prepared SQL
 818     while (stepSelect(stmt))
 819     {
 820       FGPositioned* pos = outer->loadById(sqlite3_column_int64(stmt, 0));
 821       if (filter && !filter->pass(pos)) {
 822         continue;
 823       }
 824
 825       result.push_back(pos);
 826     }
 827
 828     reset(stmt);
 829     return result;
 830   }
 831
 832   PositionedIDVec selectIds(sqlite3_stmt_ptr query)
 833   {
 834     PositionedIDVec result;
 835     while (stepSelect(query)) {
 836       result.push_back(sqlite3_column_int64(query, 0));
 837     }
 838     reset(query);
 839     return result;
 840   }
 841
 842   double runwayLengthFt(PositionedID rwy)
 843   {
 844     sqlite3_bind_int64(runwayLengthFtQuery, 1, rwy);
 845     execSelect1(runwayLengthFtQuery);
 846     double length = sqlite3_column_double(runwayLengthFtQuery, 0);
 847     reset(runwayLengthFtQuery);
 848     return length;
 849   }
 850
 851   void flushDeferredOctreeUpdates()
 852   {
 853     BOOST_FOREACH(Octree::Branch* nd, deferredOctreeUpdates) {
 854       sqlite3_bind_int64(updateOctreeChildren, 1, nd->guid());
 855       sqlite3_bind_int(updateOctreeChildren, 2, nd->childMask());
 856       execUpdate(updateOctreeChildren);
 857     }
 858
 859     deferredOctreeUpdates.clear();
 860   }
 861
 862   void removePositionedWithIdent(FGPositioned::Type ty, const std::string& aIdent)
 863   {
 864     sqlite3_bind_int(removePOIQuery, 1, ty);
 865     sqlite_bind_stdstring(removePOIQuery, 2, aIdent);
 866     execUpdate(removePOIQuery);
 867     reset(removePOIQuery);
 868   }
 869
 870   NavDataCache* outer;
 871   sqlite3* db;
 872   SGPath path;
 873     bool readOnly;
 874
 875   /// the actual cache of ID -> instances. This holds an owning reference,
 876   /// so once items are in the cache they will never be deleted until
 877   /// the cache drops its reference
 878   PositionedCache cache;
 879   unsigned int cacheHits, cacheMisses;
 880
 881   /**
 882    * record the levels of open transaction objects we have
 883    */
 884   unsigned int transactionLevel;
 885   bool transactionAborted;
 886   sqlite3_stmt_ptr beginTransactionStmt, commitTransactionStmt, rollbackTransactionStmt;
 887
 888   SGPath aptDatPath, metarDatPath, navDatPath, fixDatPath, poiDatPath,
 889   carrierDatPath, airwayDatPath;
 890
 891   sqlite3_stmt_ptr readPropertyQuery, writePropertyQuery,
 892     stampFileCache, statCacheCheck,
 893     loadAirportStmt, loadCommStation, loadPositioned, loadNavaid,
 894     loadRunwayStmt;
 895   sqlite3_stmt_ptr writePropertyMulti, clearProperty;
 896
 897   sqlite3_stmt_ptr insertPositionedQuery, insertAirport, insertTower, insertRunway,
 898   insertCommStation, insertNavaid;
 899   sqlite3_stmt_ptr setAirportMetar, setRunwayReciprocal, setRunwayILS, setNavaidColocated,
 900     setAirportPos;
 901   sqlite3_stmt_ptr removePOIQuery;
 902
 903   sqlite3_stmt_ptr findClosestWithIdent;
 904 // octree (spatial index) related queries
 905   sqlite3_stmt_ptr getOctreeChildren, insertOctree, updateOctreeChildren,
 906     getOctreeLeafChildren;
 907
 908   sqlite3_stmt_ptr searchAirports, getAllAirports;
 909   sqlite3_stmt_ptr findCommByFreq, findNavsByFreq,
 910   findNavsByFreqNoPos, findNavaidForRunway;
 911   sqlite3_stmt_ptr getAirportItems, getAirportItemByIdent;
 912   sqlite3_stmt_ptr findAirportRunway,
 913     findILS;
 914
 915   sqlite3_stmt_ptr runwayLengthFtQuery;
 916
 917 // airways
 918   sqlite3_stmt_ptr findAirway, insertAirwayEdge, isPosInAirway, airwayEdgesFrom,
 919   insertAirway;
 920
 921 // groundnet (parking, taxi node graph)
 922   sqlite3_stmt_ptr loadTaxiNodeStmt, loadParkingPos, insertTaxiNode, insertParkingPos;
 923   sqlite3_stmt_ptr taxiEdgesFrom, pushbackEdgesFrom, insertTaxiEdge, markTaxiNodeAsPushback,
 924     airportTaxiNodes, airportPushbackNodes, findNearestTaxiNode, findAirportParking,
 925     setParkingPushBack, findNearestRunwayTaxiNode;
 926
 927 // since there's many permutations of ident/name queries, we create
 928 // them programtically, but cache the exact query by its raw SQL once
 929 // used.
 930   std::map<string, sqlite3_stmt_ptr> findByStringDict;
 931
 932   typedef std::vector<sqlite3_stmt_ptr> StmtVec;
 933   StmtVec prepared;
 934
 935   std::set<Octree::Branch*> deferredOctreeUpdates;
 936
 937   // if we're performing a rebuild, the thread that is doing the work.
 938   // otherwise, NULL
 939   std::auto_ptr<RebuildThread> rebuilder;
 940 };
 941
 942   //////////////////////////////////////////////////////////////////////
 943
 944 FGPositioned* NavDataCache::NavDataCachePrivate::loadById(sqlite3_int64 rowid,
 945                                                           sqlite3_int64& aptId)
 946 {
 947
 948   sqlite3_bind_int64(loadPositioned, 1, rowid);
 949   execSelect1(loadPositioned);
 950
 951   assert(rowid == sqlite3_column_int64(loadPositioned, 0));
 952   FGPositioned::Type ty = (FGPositioned::Type) sqlite3_column_int(loadPositioned, 1);
 953
 954   PositionedID prowid = static_cast<PositionedID>(rowid);
 955   string ident = (char*) sqlite3_column_text(loadPositioned, 2);
 956   string name = (char*) sqlite3_column_text(loadPositioned, 3);
 957   aptId = sqlite3_column_int64(loadPositioned, 4);
 958   double lon = sqlite3_column_double(loadPositioned, 5);
 959   double lat = sqlite3_column_double(loadPositioned, 6);
 960   double elev = sqlite3_column_double(loadPositioned, 7);
 961   SGGeod pos = SGGeod::fromDegM(lon, lat, elev);
 962
 963   reset(loadPositioned);
 964
 965   switch (ty) {
 966     case FGPositioned::AIRPORT:
 967     case FGPositioned::SEAPORT:
 968     case FGPositioned::HELIPORT:
 969       return loadAirport(rowid, ty, ident, name, pos);
 970
 971     case FGPositioned::TOWER:
 972       return new AirportTower(prowid, aptId, ident, pos);
 973
 974     case FGPositioned::RUNWAY:
 975     case FGPositioned::HELIPAD:
 976     case FGPositioned::TAXIWAY:
 977       return loadRunway(rowid, ty, ident, pos, aptId);
 978
 979     case FGPositioned::LOC:
 980     case FGPositioned::VOR:
 981     case FGPositioned::GS:
 982     case FGPositioned::ILS:
 983     case FGPositioned::NDB:
 984     case FGPositioned::OM:
 985     case FGPositioned::MM:
 986     case FGPositioned::IM:
 987     case FGPositioned::DME:
 988     case FGPositioned::TACAN:
 989     case FGPositioned::MOBILE_TACAN:
 990       return loadNav(rowid, ty, ident, name, pos);
 991
 992     case FGPositioned::FIX:
 993       return new FGFix(rowid, ident, pos);
 994
 995     case FGPositioned::WAYPOINT:
 996     case FGPositioned::COUNTRY:
 997     case FGPositioned::CITY:
 998     case FGPositioned::TOWN:
 999     case FGPositioned::VILLAGE:
1000     {
1001         FGPositioned* wpt = new FGPositioned(rowid, ty, ident, pos);
1002       return wpt;
1003     }
1004
1005     case FGPositioned::FREQ_GROUND:
1006     case FGPositioned::FREQ_TOWER:
1007     case FGPositioned::FREQ_ATIS:
1008     case FGPositioned::FREQ_AWOS:
1009     case FGPositioned::FREQ_APP_DEP:
1010     case FGPositioned::FREQ_ENROUTE:
1011     case FGPositioned::FREQ_CLEARANCE:
1012     case FGPositioned::FREQ_UNICOM:
1013       return loadComm(rowid, ty, ident, name, pos, aptId);
1014
1015     case FGPositioned::TAXI_NODE:
1016       return loadTaxiNode(rowid, pos, aptId);
1017
1018     case FGPositioned::PARKING:
1019       return loadParking(rowid, ident, pos, aptId);
1020
1021     default:
1022       return NULL;
1023   }
1024 }
1025
1026
1027 static NavDataCache* static_instance = NULL;
1028
1029 NavDataCache::NavDataCache()
1030 {
1031   const int MAX_TRIES = 3;
1032   SGPath homePath(globals->get_fg_home());
1033
1034   std::ostringstream os;
1035   string_list versionParts = simgear::strutils::split(VERSION, ".");
1036   if (versionParts.size() < 2) {
1037     os << "navdata.cache";
1038   } else {
1039     os << "navdata_" << versionParts[0] << "_" << versionParts[1] << ".cache";
1040   }
1041
1042   homePath.append(os.str());
1043
1044   for (int t=0; t < MAX_TRIES; ++t) {
1045     try {
1046       d.reset(new NavDataCachePrivate(homePath, this));
1047       d->init();
1048       //d->checkCacheFile();
1049     // reached this point with no exception, success
1050       break;
1051     } catch (sg_exception& e) {
1052       SG_LOG(SG_NAVCACHE, t == 0 ? SG_WARN : SG_ALERT, "NavCache: init failed:" << e.what()
1053              << " (attempt " << t << ")");
1054       d.reset();
1055
1056         // only wipe the existing if not readonly
1057         if (!fgGetBool("/sim/fghome-readonly", false)) {
1058             homePath.remove();
1059         }
1060     }
1061   } // of retry loop
1062
1063   double RADIUS_EARTH_M = 7000 * 1000.0; // 7000km is plenty
1064   SGVec3d earthExtent(RADIUS_EARTH_M, RADIUS_EARTH_M, RADIUS_EARTH_M);
1065   Octree::global_spatialOctree =
1066     new Octree::Branch(SGBox<double>(-earthExtent, earthExtent), 1);
1067
1068   d->aptDatPath = SGPath(globals->get_fg_root());
1069   d->aptDatPath.append("Airports/apt.dat.gz");
1070
1071   d->metarDatPath = SGPath(globals->get_fg_root());
1072   d->metarDatPath.append("Airports/metar.dat.gz");
1073
1074   d->navDatPath = SGPath(globals->get_fg_root());
1075   d->navDatPath.append("Navaids/nav.dat.gz");
1076
1077   d->fixDatPath = SGPath(globals->get_fg_root());
1078   d->fixDatPath.append("Navaids/fix.dat.gz");
1079
1080   d->poiDatPath = SGPath(globals->get_fg_root());
1081   d->poiDatPath.append("Navaids/poi.dat.gz");
1082
1083   d->carrierDatPath = SGPath(globals->get_fg_root());
1084   d->carrierDatPath.append("Navaids/carrier_nav.dat.gz");
1085
1086   d->airwayDatPath = SGPath(globals->get_fg_root());
1087   d->airwayDatPath.append("Navaids/awy.dat.gz");
1088 }
1089
1090 NavDataCache::~NavDataCache()
1091 {
1092   assert(static_instance == this);
1093   static_instance = NULL;
1094   d.reset();
1095 }
1096
1097 NavDataCache* NavDataCache::instance()
1098 {
1099   if (!static_instance) {
1100     static_instance = new NavDataCache;
1101   }
1102
1103   return static_instance;
1104 }
1105
1106 bool NavDataCache::isRebuildRequired()
1107 {
1108     if (d->readOnly) {
1109         return false;
1110     }
1111
1112     if (flightgear::Options::sharedInstance()->isOptionSet("restore-defaults")) {
1113         SG_LOG(SG_NAVCACHE, SG_INFO, "NavCache: restore-defaults requested, will rebuild cache");
1114         return true;
1115     }
1116
1117   if (isCachedFileModified(d->aptDatPath) ||
1118       isCachedFileModified(d->metarDatPath) ||
1119       isCachedFileModified(d->navDatPath) ||
1120       isCachedFileModified(d->carrierDatPath) ||
1121       isCachedFileModified(d->fixDatPath) ||
1122 // since POI loading is disabled on Windows, don't check for it
1123 // this caused: https://code.google.com/p/flightgear-bugs/issues/detail?id=1227
1124 #ifndef SG_WINDOWS
1125       isCachedFileModified(d->poiDatPath) ||
1126 #endif
1127       isCachedFileModified(d->airwayDatPath))
1128   {
1129     SG_LOG(SG_NAVCACHE, SG_INFO, "NavCache: main cache rebuild required");
1130     return true;
1131   }
1132
1133   string sceneryPaths = simgear::strutils::join(globals->get_fg_scenery(), ";");
1134   if (readStringProperty("scenery_paths") != sceneryPaths) {
1135     SG_LOG(SG_NAVCACHE, SG_INFO, "NavCache: scenery paths changed, main cache rebuild required");
1136     return true;
1137   }
1138
1139   SG_LOG(SG_NAVCACHE, SG_INFO, "NavCache: no main cache rebuild required");
1140   return false;
1141 }
1142
1143 bool NavDataCache::rebuild()
1144 {
1145   if (!d->rebuilder.get()) {
1146     d->rebuilder.reset(new RebuildThread(this));
1147     d->rebuilder->start();
1148   }
1149
1150 // poll the rebuild thread
1151   bool fin = d->rebuilder->isFinished();
1152   if (fin) {
1153     d->rebuilder.reset(); // all done!
1154   }
1155   return fin;
1156 }
1157
1158 void NavDataCache::doRebuild()
1159 {
1160   try {
1161     d->close(); // completely close the sqlite object
1162     d->path.remove(); // remove the file on disk
1163     d->init(); // start again from scratch
1164
1165     // initialise the root octree node
1166     d->runSQL("INSERT INTO octree (rowid, children) VALUES (1, 0)");
1167
1168     SGTimeStamp st;
1169     {
1170         Transaction txn(this);
1171
1172         st.stamp();
1173         airportDBLoad(d->aptDatPath);
1174         SG_LOG(SG_NAVCACHE, SG_INFO, "apt.dat load took:" << st.elapsedMSec());
1175
1176         metarDataLoad(d->metarDatPath);
1177         stampCacheFile(d->aptDatPath);
1178         stampCacheFile(d->metarDatPath);
1179
1180         st.stamp();
1181         loadFixes(d->fixDatPath);
1182         stampCacheFile(d->fixDatPath);
1183         SG_LOG(SG_NAVCACHE, SG_INFO, "fix.dat load took:" << st.elapsedMSec());
1184
1185         st.stamp();
1186         navDBInit(d->navDatPath);
1187         stampCacheFile(d->navDatPath);
1188         SG_LOG(SG_NAVCACHE, SG_INFO, "nav.dat load took:" << st.elapsedMSec());
1189
1190         st.stamp();
1191         txn.commit();
1192         SG_LOG(SG_NAVCACHE, SG_INFO, "stage 1 commit took:" << st.elapsedMSec());
1193     }
1194
1195 #ifdef SG_WINDOWS
1196       SG_LOG(SG_NAVCACHE, SG_ALERT, "SKIPPING POI load on Windows");
1197 #else
1198       {
1199           Transaction txn(this);
1200
1201           st.stamp();
1202           poiDBInit(d->poiDatPath);
1203           stampCacheFile(d->poiDatPath);
1204           SG_LOG(SG_NAVCACHE, SG_INFO, "poi.dat load took:" << st.elapsedMSec());
1205
1206           st.stamp();
1207           txn.commit();
1208           SG_LOG(SG_NAVCACHE, SG_INFO, "POI commit took:" << st.elapsedMSec());
1209       }
1210 #endif
1211
1212       {
1213           Transaction txn(this);
1214           loadCarrierNav(d->carrierDatPath);
1215           stampCacheFile(d->carrierDatPath);
1216
1217           st.stamp();
1218           Airway::load(d->airwayDatPath);
1219           stampCacheFile(d->airwayDatPath);
1220           SG_LOG(SG_NAVCACHE, SG_INFO, "awy.dat load took:" << st.elapsedMSec());
1221
1222           d->flushDeferredOctreeUpdates();
1223
1224           string sceneryPaths = simgear::strutils::join(globals->get_fg_scenery(), ";");
1225           writeStringProperty("scenery_paths", sceneryPaths);
1226
1227           st.stamp();
1228           txn.commit();
1229           SG_LOG(SG_NAVCACHE, SG_INFO, "final commit took:" << st.elapsedMSec());
1230
1231       }
1232
1233   } catch (sg_exception& e) {
1234     SG_LOG(SG_NAVCACHE, SG_ALERT, "caught exception rebuilding navCache:" << e.what());
1235   }
1236 }
1237
1238 int NavDataCache::readIntProperty(const string& key)
1239 {
1240   sqlite_bind_stdstring(d->readPropertyQuery, 1, key);
1241   int result = 0;
1242
1243   if (d->execSelect(d->readPropertyQuery)) {
1244     result = sqlite3_column_int(d->readPropertyQuery, 0);
1245   } else {
1246     SG_LOG(SG_NAVCACHE, SG_WARN, "readIntProperty: unknown:" << key);
1247   }
1248
1249   d->reset(d->readPropertyQuery);
1250   return result;
1251 }
1252
1253 double NavDataCache::readDoubleProperty(const string& key)
1254 {
1255   sqlite_bind_stdstring(d->readPropertyQuery, 1, key);
1256   double result = 0.0;
1257   if (d->execSelect(d->readPropertyQuery)) {
1258     result = sqlite3_column_double(d->readPropertyQuery, 0);
1259   } else {
1260     SG_LOG(SG_NAVCACHE, SG_WARN, "readDoubleProperty: unknown:" << key);
1261   }
1262
1263   d->reset(d->readPropertyQuery);
1264   return result;
1265 }
1266
1267 string NavDataCache::readStringProperty(const string& key)
1268 {
1269   sqlite_bind_stdstring(d->readPropertyQuery, 1, key);
1270   string result;
1271   if (d->execSelect(d->readPropertyQuery)) {
1272     result = (char*) sqlite3_column_text(d->readPropertyQuery, 0);
1273   } else {
1274     SG_LOG(SG_NAVCACHE, SG_WARN, "readStringProperty: unknown:" << key);
1275   }
1276
1277   d->reset(d->readPropertyQuery);
1278   return result;
1279 }
1280
1281 void NavDataCache::writeIntProperty(const string& key, int value)
1282 {
1283   d->writeIntProperty(key, value);
1284 }
1285
1286 void NavDataCache::writeStringProperty(const string& key, const string& value)
1287 {
1288   sqlite_bind_stdstring(d->clearProperty, 1, key);
1289   d->execUpdate(d->clearProperty);
1290
1291   sqlite_bind_stdstring(d->writePropertyQuery, 1, key);
1292   sqlite_bind_stdstring(d->writePropertyQuery, 2, value);
1293   d->execUpdate(d->writePropertyQuery);
1294 }
1295
1296 void NavDataCache::writeDoubleProperty(const string& key, const double& value)
1297 {
1298   sqlite_bind_stdstring(d->clearProperty, 1, key);
1299   d->execUpdate(d->clearProperty);
1300
1301   sqlite_bind_stdstring(d->writePropertyQuery, 1, key);
1302   sqlite3_bind_double(d->writePropertyQuery, 2, value);
1303   d->execUpdate(d->writePropertyQuery);
1304 }
1305
1306 string_list NavDataCache::readStringListProperty(const string& key)
1307 {
1308   sqlite_bind_stdstring(d->readPropertyQuery, 1, key);
1309   string_list result;
1310   while (d->stepSelect(d->readPropertyQuery)) {
1311     result.push_back((char*) sqlite3_column_text(d->readPropertyQuery, 0));
1312   }
1313   d->reset(d->readPropertyQuery);
1314
1315   return result;
1316 }
1317
1318 void NavDataCache::writeStringListProperty(const string& key, const string_list& values)
1319 {
1320   sqlite_bind_stdstring(d->clearProperty, 1, key);
1321   d->execUpdate(d->clearProperty);
1322
1323   BOOST_FOREACH(string value, values) {
1324     sqlite_bind_stdstring(d->writePropertyMulti, 1, key);
1325     sqlite_bind_stdstring(d->writePropertyMulti, 2, value);
1326     d->execInsert(d->writePropertyMulti);
1327   }
1328 }
1329
1330 bool NavDataCache::isCachedFileModified(const SGPath& path) const
1331 {
1332   if (!path.exists()) {
1333     throw sg_io_exception("isCachedFileModified: Missing file:" + path.str());
1334   }
1335
1336   sqlite_bind_temp_stdstring(d->statCacheCheck, 1, path.str());
1337   bool isModified = true;
1338
1339   if (d->execSelect(d->statCacheCheck)) {
1340     time_t modtime = sqlite3_column_int64(d->statCacheCheck, 0);
1341     time_t delta = std::labs(modtime - path.modTime());
1342     if (delta != 0)
1343     {
1344       SG_LOG(SG_NAVCACHE, SG_DEBUG, "NavCache: rebuild required for " << path << ". Timestamps: " << modtime << " != " << path.modTime());
1345     }
1346     else
1347     {
1348       SG_LOG(SG_NAVCACHE, SG_DEBUG, "NavCache: no rebuild required for " << path);
1349     }
1350
1351     isModified = (delta != 0);
1352   } else {
1353     SG_LOG(SG_NAVCACHE, SG_DEBUG, "NavCache: initial build required for " << path);
1354   }
1355
1356   d->reset(d->statCacheCheck);
1357   return isModified;
1358 }
1359
1360 void NavDataCache::stampCacheFile(const SGPath& path)
1361 {
1362   sqlite_bind_temp_stdstring(d->stampFileCache, 1, path.str());
1363   sqlite3_bind_int64(d->stampFileCache, 2, path.modTime());
1364   d->execInsert(d->stampFileCache);
1365 }
1366
1367 void NavDataCache::beginTransaction()
1368 {
1369   if (d->transactionLevel == 0) {
1370     d->transactionAborted = false;
1371     d->stepSelect(d->beginTransactionStmt);
1372     sqlite3_reset(d->beginTransactionStmt);
1373   }
1374
1375   ++d->transactionLevel;
1376 }
1377
1378 void NavDataCache::commitTransaction()
1379 {
1380   assert(d->transactionLevel > 0);
1381   if (--d->transactionLevel == 0) {
1382     // if a nested transaction aborted, we might end up here, but must
1383     // still abort the entire transaction. That's bad, but safer than
1384     // committing.
1385     sqlite3_stmt_ptr q = d->transactionAborted ? d->rollbackTransactionStmt : d->commitTransactionStmt;
1386
1387     int retries = 0;
1388     int result;
1389     while (retries < MAX_RETRIES) {
1390       result = sqlite3_step(q);
1391       if (result == SQLITE_DONE) {
1392         break;
1393       }
1394
1395       // see http://www.sqlite.org/c3ref/get_autocommit.html for a hint
1396       // what's going on here: autocommit in inactive inside BEGIN, so if
1397       // it's active, the DB was rolled-back
1398       if (sqlite3_get_autocommit(d->db)) {
1399         SG_LOG(SG_NAVCACHE, SG_ALERT, "commit: was rolled back!" << retries);
1400         d->transactionAborted = true;
1401         break;
1402       }
1403
1404       if (result != SQLITE_BUSY) {
1405         break;
1406       }
1407
1408       SGTimeStamp::sleepForMSec(++retries * 10);
1409       SG_LOG(SG_NAVCACHE, SG_ALERT, "NavCache contention on commit, will retry:" << retries);
1410     } // of retry loop for DB busy
1411
1412     string errMsg;
1413     if (result != SQLITE_DONE) {
1414       errMsg = sqlite3_errmsg(d->db);
1415       SG_LOG(SG_NAVCACHE, SG_ALERT, "Sqlite error:" << errMsg << " for  " << result
1416              << " while running:\n\t" << sqlite3_sql(q));
1417     }
1418
1419     sqlite3_reset(q);
1420   }
1421 }
1422
1423 void NavDataCache::abortTransaction()
1424 {
1425   SG_LOG(SG_NAVCACHE, SG_WARN, "NavCache: aborting transaction");
1426
1427   assert(d->transactionLevel > 0);
1428   if (--d->transactionLevel == 0) {
1429     d->stepSelect(d->rollbackTransactionStmt);
1430     sqlite3_reset(d->rollbackTransactionStmt);
1431   }
1432
1433   d->transactionAborted = true;
1434 }
1435
1436 FGPositionedRef NavDataCache::loadById(PositionedID rowid)
1437 {
1438   if (rowid == 0) {
1439     return NULL;
1440   }
1441
1442   PositionedCache::iterator it = d->cache.find(rowid);
1443   if (it != d->cache.end()) {
1444     d->cacheHits++;
1445     return it->second; // cache it
1446   }
1447
1448   PositionedID aptId;
1449   FGPositioned* pos = d->loadById(rowid, aptId);
1450   d->cache.insert(it, PositionedCache::value_type(rowid, pos));
1451   d->cacheMisses++;
1452
1453   // when we loaded an ILS, we must apply per-airport changes
1454   if ((pos->type() == FGPositioned::ILS) && (aptId > 0)) {
1455     FGAirport* apt = FGPositioned::loadById<FGAirport>(aptId);
1456     apt->validateILSData();
1457   }
1458
1459   return pos;
1460 }
1461
1462 PositionedID NavDataCache::insertAirport(FGPositioned::Type ty, const string& ident,
1463                                          const string& name)
1464 {
1465   // airports have their pos computed based on the avergae runway centres
1466   // so the pos isn't available immediately. Pass a dummy pos and avoid
1467   // doing spatial indexing until later
1468   sqlite3_int64 rowId = d->insertPositioned(ty, ident, name, SGGeod(),
1469                                             0 /* airport */,
1470                                             false /* spatial index */);
1471
1472   sqlite3_bind_int64(d->insertAirport, 1, rowId);
1473   d->execInsert(d->insertAirport);
1474
1475   return rowId;
1476 }
1477
1478 void NavDataCache::updatePosition(PositionedID item, const SGGeod &pos)
1479 {
1480   if (d->cache.find(item) != d->cache.end()) {
1481     SG_LOG(SG_NAVCACHE, SG_DEBUG, "updating position of an item in the cache");
1482     d->cache[item]->modifyPosition(pos);
1483   }
1484
1485   SGVec3d cartPos(SGVec3d::fromGeod(pos));
1486
1487   sqlite3_bind_int(d->setAirportPos, 1, item);
1488   sqlite3_bind_double(d->setAirportPos, 2, pos.getLongitudeDeg());
1489   sqlite3_bind_double(d->setAirportPos, 3, pos.getLatitudeDeg());
1490   sqlite3_bind_double(d->setAirportPos, 4, pos.getElevationM());
1491
1492 // bug 905; the octree leaf may change here, but the leaf may already be
1493 // loaded, and caching its children. (Either the old or new leaf!). Worse,
1494 // we may be called here as a result of loading one of those leaf's children.
1495 // instead of dealing with all those possibilites, such as modifying
1496 // the in-memory leaf's STL child container, we simply leave the runtime
1497 // structures alone. This is fine providing items do no move very far, since
1498 // all the spatial searches ultimately use the items' real cartesian position,
1499 // which was updated above.
1500   Octree::Leaf* octreeLeaf = Octree::global_spatialOctree->findLeafForPos(cartPos);
1501   sqlite3_bind_int64(d->setAirportPos, 5, octreeLeaf->guid());
1502
1503   sqlite3_bind_double(d->setAirportPos, 6, cartPos.x());
1504   sqlite3_bind_double(d->setAirportPos, 7, cartPos.y());
1505   sqlite3_bind_double(d->setAirportPos, 8, cartPos.z());
1506
1507
1508   d->execUpdate(d->setAirportPos);
1509 }
1510
1511 void NavDataCache::insertTower(PositionedID airportId, const SGGeod& pos)
1512 {
1513   d->insertPositioned(FGPositioned::TOWER, string(), string(),
1514                       pos, airportId, true /* spatial index */);
1515 }
1516
1517 PositionedID
1518 NavDataCache::insertRunway(FGPositioned::Type ty, const string& ident,
1519                            const SGGeod& pos, PositionedID apt,
1520                            double heading, double length, double width, double displacedThreshold,
1521                            double stopway, int surfaceCode)
1522 {
1523   // only runways are spatially indexed; don't bother indexing taxiways
1524   // or pavements
1525   bool spatialIndex = ( ty == FGPositioned::RUNWAY || ty == FGPositioned::HELIPAD);
1526
1527   sqlite3_int64 rowId = d->insertPositioned(ty, cleanRunwayNo(ident), "", pos, apt,
1528                                             spatialIndex);
1529   sqlite3_bind_int64(d->insertRunway, 1, rowId);
1530   sqlite3_bind_double(d->insertRunway, 2, heading);
1531   sqlite3_bind_double(d->insertRunway, 3, length);
1532   sqlite3_bind_double(d->insertRunway, 4, width);
1533   sqlite3_bind_int(d->insertRunway, 5, surfaceCode);
1534   sqlite3_bind_double(d->insertRunway, 6, displacedThreshold);
1535   sqlite3_bind_double(d->insertRunway, 7, stopway);
1536
1537   return d->execInsert(d->insertRunway);
1538 }
1539
1540 void NavDataCache::setRunwayReciprocal(PositionedID runway, PositionedID recip)
1541 {
1542   sqlite3_bind_int64(d->setRunwayReciprocal, 1, runway);
1543   sqlite3_bind_int64(d->setRunwayReciprocal, 2, recip);
1544   d->execUpdate(d->setRunwayReciprocal);
1545
1546 // and the opposite direction too!
1547   sqlite3_bind_int64(d->setRunwayReciprocal, 2, runway);
1548   sqlite3_bind_int64(d->setRunwayReciprocal, 1, recip);
1549   d->execUpdate(d->setRunwayReciprocal);
1550 }
1551
1552 void NavDataCache::setRunwayILS(PositionedID runway, PositionedID ils)
1553 {
1554   sqlite3_bind_int64(d->setRunwayILS, 1, runway);
1555   sqlite3_bind_int64(d->setRunwayILS, 2, ils);
1556   d->execUpdate(d->setRunwayILS);
1557
1558   // and the in-memory one
1559   if (d->cache.find(runway) != d->cache.end()) {
1560     FGRunway* instance = (FGRunway*) d->cache[runway].ptr();
1561     instance->setILS(ils);
1562   }
1563 }
1564
1565 PositionedID
1566 NavDataCache::insertNavaid(FGPositioned::Type ty, const string& ident,
1567                           const string& name, const SGGeod& pos,
1568                            int freq, int range, double multiuse,
1569                            PositionedID apt, PositionedID runway)
1570 {
1571   bool spatialIndex = true;
1572   if (ty == FGPositioned::MOBILE_TACAN) {
1573     spatialIndex = false;
1574   }
1575
1576   sqlite3_int64 rowId = d->insertPositioned(ty, ident, name, pos, apt,
1577                                             spatialIndex);
1578   sqlite3_bind_int64(d->insertNavaid, 1, rowId);
1579   sqlite3_bind_int(d->insertNavaid, 2, freq);
1580   sqlite3_bind_int(d->insertNavaid, 3, range);
1581   sqlite3_bind_double(d->insertNavaid, 4, multiuse);
1582   sqlite3_bind_int64(d->insertNavaid, 5, runway);
1583   sqlite3_bind_int64(d->insertNavaid, 6, 0);
1584   return d->execInsert(d->insertNavaid);
1585 }
1586
1587 void NavDataCache::setNavaidColocated(PositionedID navaid, PositionedID colocatedDME)
1588 {
1589   // Update DB entries...
1590   sqlite3_bind_int64(d->setNavaidColocated, 1, navaid);
1591   sqlite3_bind_int64(d->setNavaidColocated, 2, colocatedDME);
1592   d->execUpdate(d->setNavaidColocated);
1593
1594   // ...and the in-memory copy of the navrecord
1595   if (d->cache.find(navaid) != d->cache.end()) {
1596     FGNavRecord* rec = (FGNavRecord*) d->cache[navaid].get();
1597     rec->setColocatedDME(colocatedDME);
1598   }
1599 }
1600
1601 PositionedID NavDataCache::insertCommStation(FGPositioned::Type ty,
1602                                              const string& name, const SGGeod& pos, int freq, int range,
1603                                              PositionedID apt)
1604 {
1605   sqlite3_int64 rowId = d->insertPositioned(ty, "", name, pos, apt, true);
1606   sqlite3_bind_int64(d->insertCommStation, 1, rowId);
1607   sqlite3_bind_int(d->insertCommStation, 2, freq);
1608   sqlite3_bind_int(d->insertCommStation, 3, range);
1609   return d->execInsert(d->insertCommStation);
1610 }
1611
1612 PositionedID NavDataCache::insertFix(const std::string& ident, const SGGeod& aPos)
1613 {
1614   return d->insertPositioned(FGPositioned::FIX, ident, string(), aPos, 0, true);
1615 }
1616
1617 PositionedID NavDataCache::createPOI(FGPositioned::Type ty, const std::string& ident, const SGGeod& aPos)
1618 {
1619   return d->insertPositioned(ty, ident, string(), aPos, 0,
1620                              true /* spatial index */);
1621 }
1622
1623 bool NavDataCache::removePOI(FGPositioned::Type ty, const std::string& aIdent)
1624 {
1625   d->removePositionedWithIdent(ty, aIdent);
1626   // should remove from the live cache too?
1627
1628     return true;
1629 }
1630
1631 void NavDataCache::setAirportMetar(const string& icao, bool hasMetar)
1632 {
1633   sqlite_bind_stdstring(d->setAirportMetar, 1, icao);
1634   sqlite3_bind_int(d->setAirportMetar, 2, hasMetar);
1635   d->execUpdate(d->setAirportMetar);
1636 }
1637
1638 //------------------------------------------------------------------------------
1639 FGPositionedList NavDataCache::findAllWithIdent( const string& s,
1640                                                  FGPositioned::Filter* filter,
1641                                                  bool exact )
1642 {
1643   return d->findAllByString(s, "ident", filter, exact);
1644 }
1645
1646 //------------------------------------------------------------------------------
1647 FGPositionedList NavDataCache::findAllWithName( const string& s,
1648                                                 FGPositioned::Filter* filter,
1649                                                 bool exact )
1650 {
1651   return d->findAllByString(s, "name", filter, exact);
1652 }
1653
1654 //------------------------------------------------------------------------------
1655 FGPositionedRef NavDataCache::findClosestWithIdent( const string& aIdent,
1656                                                     const SGGeod& aPos,
1657                                                     FGPositioned::Filter* aFilter )
1658 {
1659   sqlite_bind_stdstring(d->findClosestWithIdent, 1, aIdent);
1660   if (aFilter) {
1661     sqlite3_bind_int(d->findClosestWithIdent, 2, aFilter->minType());
1662     sqlite3_bind_int(d->findClosestWithIdent, 3, aFilter->maxType());
1663   } else { // full type range
1664     sqlite3_bind_int(d->findClosestWithIdent, 2, FGPositioned::INVALID);
1665     sqlite3_bind_int(d->findClosestWithIdent, 3, FGPositioned::LAST_TYPE);
1666   }
1667
1668   SGVec3d cartPos(SGVec3d::fromGeod(aPos));
1669   sqlite3_bind_double(d->findClosestWithIdent, 4, cartPos.x());
1670   sqlite3_bind_double(d->findClosestWithIdent, 5, cartPos.y());
1671   sqlite3_bind_double(d->findClosestWithIdent, 6, cartPos.z());
1672
1673   FGPositionedRef result;
1674
1675   while (d->stepSelect(d->findClosestWithIdent)) {
1676     FGPositioned* pos = loadById(sqlite3_column_int64(d->findClosestWithIdent, 0));
1677     if (aFilter && !aFilter->pass(pos)) {
1678       continue;
1679     }
1680
1681     result = pos;
1682     break;
1683   }
1684
1685   d->reset(d->findClosestWithIdent);
1686   return result;
1687 }
1688
1689
1690 int NavDataCache::getOctreeBranchChildren(int64_t octreeNodeId)
1691 {
1692   sqlite3_bind_int64(d->getOctreeChildren, 1, octreeNodeId);
1693   d->execSelect1(d->getOctreeChildren);
1694   int children = sqlite3_column_int(d->getOctreeChildren, 0);
1695   d->reset(d->getOctreeChildren);
1696   return children;
1697 }
1698
1699 void NavDataCache::defineOctreeNode(Octree::Branch* pr, Octree::Node* nd)
1700 {
1701   sqlite3_bind_int64(d->insertOctree, 1, nd->guid());
1702   d->execInsert(d->insertOctree);
1703
1704 #ifdef LAZY_OCTREE_UPDATES
1705   d->deferredOctreeUpdates.insert(pr);
1706 #else
1707   // lowest three bits of node ID are 0..7 index of the child in the parent
1708   int childIndex = nd->guid() & 0x07;
1709
1710   sqlite3_bind_int64(d->updateOctreeChildren, 1, pr->guid());
1711 // mask has bit N set where child N exists
1712   int childMask = 1 << childIndex;
1713   sqlite3_bind_int(d->updateOctreeChildren, 2, childMask);
1714   d->execUpdate(d->updateOctreeChildren);
1715 #endif
1716 }
1717
1718 TypedPositionedVec
1719 NavDataCache::getOctreeLeafChildren(int64_t octreeNodeId)
1720 {
1721   sqlite3_bind_int64(d->getOctreeLeafChildren, 1, octreeNodeId);
1722
1723   TypedPositionedVec r;
1724   while (d->stepSelect(d->getOctreeLeafChildren)) {
1725     FGPositioned::Type ty = static_cast<FGPositioned::Type>
1726       (sqlite3_column_int(d->getOctreeLeafChildren, 1));
1727     r.push_back(std::make_pair(ty,
1728                 sqlite3_column_int64(d->getOctreeLeafChildren, 0)));
1729   }
1730
1731   d->reset(d->getOctreeLeafChildren);
1732   return r;
1733 }
1734
1735
1736 /**
1737  * A special purpose helper (used by FGAirport::searchNamesAndIdents) to
1738  * implement the AirportList dialog. It's unfortunate that it needs to reside
1739  * here, but for now it's least ugly solution.
1740  */
1741 char** NavDataCache::searchAirportNamesAndIdents(const std::string& aFilter)
1742 {
1743   sqlite3_stmt_ptr stmt;
1744   unsigned int numMatches = 0, numAllocated = 16;
1745   if (aFilter.empty()) {
1746     stmt = d->getAllAirports;
1747     numAllocated = 4096; // start much larger for all airports
1748   } else {
1749     stmt = d->searchAirports;
1750     string s = "%" + aFilter + "%";
1751     sqlite_bind_stdstring(stmt, 1, s);
1752   }
1753
1754   char** result = (char**) malloc(sizeof(char*) * numAllocated);
1755   while (d->stepSelect(stmt)) {
1756     if ((numMatches + 1) >= numAllocated) {
1757       numAllocated <<= 1; // double in size!
1758     // reallocate results array
1759       char** nresult = (char**) malloc(sizeof(char*) * numAllocated);
1760       memcpy(nresult, result, sizeof(char*) * numMatches);
1761       free(result);
1762       result = nresult;
1763     }
1764
1765     // nasty code to avoid excessive string copying and allocations.
1766     // We format results as follows (note whitespace!):
1767     //   ' name-of-airport-chars   (ident)'
1768     // so the total length is:
1769     //    1 + strlen(name) + 4 + strlen(icao) + 1 + 1 (for the null)
1770     // which gives a grand total of 7 + name-length + icao-length.
1771     // note the ident can be three letters (non-ICAO local strip), four
1772     // (default ICAO) or more (extended format ICAO)
1773     int nameLength = sqlite3_column_bytes(stmt, 1);
1774     int icaoLength = sqlite3_column_bytes(stmt, 0);
1775     char* entry = (char*) malloc(7 + nameLength + icaoLength);
1776     char* dst = entry;
1777     *dst++ = ' ';
1778     memcpy(dst, sqlite3_column_text(stmt, 1), nameLength);
1779     dst += nameLength;
1780     *dst++ = ' ';
1781     *dst++ = ' ';
1782     *dst++ = ' ';
1783     *dst++ = '(';
1784     memcpy(dst, sqlite3_column_text(stmt, 0), icaoLength);
1785     dst += icaoLength;
1786     *dst++ = ')';
1787     *dst++ = 0;
1788
1789     result[numMatches++] = entry;
1790   }
1791
1792   result[numMatches] = NULL; // end of list marker
1793   d->reset(stmt);
1794   return result;
1795 }
1796
1797 FGPositionedRef
1798 NavDataCache::findCommByFreq(int freqKhz, const SGGeod& aPos, FGPositioned::Filter* aFilter)
1799 {
1800   sqlite3_bind_int(d->findCommByFreq, 1, freqKhz);
1801   if (aFilter) {
1802     sqlite3_bind_int(d->findCommByFreq, 2, aFilter->minType());
1803     sqlite3_bind_int(d->findCommByFreq, 3, aFilter->maxType());
1804   } else { // full type range
1805     sqlite3_bind_int(d->findCommByFreq, 2, FGPositioned::FREQ_GROUND);
1806     sqlite3_bind_int(d->findCommByFreq, 3, FGPositioned::FREQ_UNICOM);
1807   }
1808
1809   SGVec3d cartPos(SGVec3d::fromGeod(aPos));
1810   sqlite3_bind_double(d->findCommByFreq, 4, cartPos.x());
1811   sqlite3_bind_double(d->findCommByFreq, 5, cartPos.y());
1812   sqlite3_bind_double(d->findCommByFreq, 6, cartPos.z());
1813   FGPositionedRef result;
1814
1815   while (d->execSelect(d->findCommByFreq)) {
1816     FGPositioned* p = loadById(sqlite3_column_int64(d->findCommByFreq, 0));
1817     if (aFilter && !aFilter->pass(p)) {
1818       continue;
1819     }
1820
1821     result = p;
1822     break;
1823   }
1824
1825   d->reset(d->findCommByFreq);
1826   return result;
1827 }
1828
1829 PositionedIDVec
1830 NavDataCache::findNavaidsByFreq(int freqKhz, const SGGeod& aPos, FGPositioned::Filter* aFilter)
1831 {
1832   sqlite3_bind_int(d->findNavsByFreq, 1, freqKhz);
1833   if (aFilter) {
1834     sqlite3_bind_int(d->findNavsByFreq, 2, aFilter->minType());
1835     sqlite3_bind_int(d->findNavsByFreq, 3, aFilter->maxType());
1836   } else { // full type range
1837     sqlite3_bind_int(d->findNavsByFreq, 2, FGPositioned::NDB);
1838     sqlite3_bind_int(d->findNavsByFreq, 3, FGPositioned::GS);
1839   }
1840
1841   SGVec3d cartPos(SGVec3d::fromGeod(aPos));
1842   sqlite3_bind_double(d->findNavsByFreq, 4, cartPos.x());
1843   sqlite3_bind_double(d->findNavsByFreq, 5, cartPos.y());
1844   sqlite3_bind_double(d->findNavsByFreq, 6, cartPos.z());
1845
1846   return d->selectIds(d->findNavsByFreq);
1847 }
1848
1849 PositionedIDVec
1850 NavDataCache::findNavaidsByFreq(int freqKhz, FGPositioned::Filter* aFilter)
1851 {
1852   sqlite3_bind_int(d->findNavsByFreqNoPos, 1, freqKhz);
1853   if (aFilter) {
1854     sqlite3_bind_int(d->findNavsByFreqNoPos, 2, aFilter->minType());
1855     sqlite3_bind_int(d->findNavsByFreqNoPos, 3, aFilter->maxType());
1856   } else { // full type range
1857     sqlite3_bind_int(d->findNavsByFreqNoPos, 2, FGPositioned::NDB);
1858     sqlite3_bind_int(d->findNavsByFreqNoPos, 3, FGPositioned::GS);
1859   }
1860
1861   return d->selectIds(d->findNavsByFreqNoPos);
1862 }
1863
1864 PositionedIDVec
1865 NavDataCache::airportItemsOfType(PositionedID apt,FGPositioned::Type ty,
1866                                  FGPositioned::Type maxTy)
1867 {
1868   if (maxTy == FGPositioned::INVALID) {
1869     maxTy = ty; // single-type range
1870   }
1871
1872   sqlite3_bind_int64(d->getAirportItems, 1, apt);
1873   sqlite3_bind_int(d->getAirportItems, 2, ty);
1874   sqlite3_bind_int(d->getAirportItems, 3, maxTy);
1875
1876   return d->selectIds(d->getAirportItems);
1877 }
1878
1879 PositionedID
1880 NavDataCache::airportItemWithIdent(PositionedID apt, FGPositioned::Type ty,
1881                                    const std::string& ident)
1882 {
1883   sqlite3_bind_int64(d->getAirportItemByIdent, 1, apt);
1884   sqlite_bind_stdstring(d->getAirportItemByIdent, 2, ident);
1885   sqlite3_bind_int(d->getAirportItemByIdent, 3, ty);
1886   PositionedID result = 0;
1887
1888   if (d->execSelect(d->getAirportItemByIdent)) {
1889     result = sqlite3_column_int64(d->getAirportItemByIdent, 0);
1890   }
1891
1892   d->reset(d->getAirportItemByIdent);
1893   return result;
1894 }
1895
1896 AirportRunwayPair
1897 NavDataCache::findAirportRunway(const std::string& aName)
1898 {
1899   if (aName.empty()) {
1900     return AirportRunwayPair();
1901   }
1902
1903   string_list parts = simgear::strutils::split(aName);
1904   if (parts.size() < 2) {
1905     SG_LOG(SG_NAVCACHE, SG_WARN, "findAirportRunway: malformed name:" << aName);
1906     return AirportRunwayPair();
1907   }
1908
1909   AirportRunwayPair result;
1910   sqlite_bind_stdstring(d->findAirportRunway, 1, parts[0]);
1911   sqlite_bind_stdstring(d->findAirportRunway, 2, parts[1]);
1912
1913   if (d->execSelect(d->findAirportRunway)) {
1914     result = AirportRunwayPair(sqlite3_column_int64(d->findAirportRunway, 0),
1915                       sqlite3_column_int64(d->findAirportRunway, 1));
1916
1917   } else {
1918     SG_LOG(SG_NAVCACHE, SG_WARN, "findAirportRunway: unknown airport/runway:" << aName);
1919   }
1920
1921   d->reset(d->findAirportRunway);
1922   return result;
1923 }
1924
1925 PositionedID
1926 NavDataCache::findILS(PositionedID airport, const string& runway, const string& navIdent)
1927 {
1928   sqlite_bind_stdstring(d->findILS, 1, navIdent);
1929   sqlite3_bind_int64(d->findILS, 2, airport);
1930   sqlite_bind_stdstring(d->findILS, 3, runway);
1931   PositionedID result = 0;
1932   if (d->execSelect(d->findILS)) {
1933     result = sqlite3_column_int64(d->findILS, 0);
1934   }
1935
1936   d->reset(d->findILS);
1937   return result;
1938 }
1939
1940 int NavDataCache::findAirway(int network, const string& aName)
1941 {
1942   sqlite3_bind_int(d->findAirway, 1, network);
1943   sqlite_bind_stdstring(d->findAirway, 2, aName);
1944
1945   int airway = 0;
1946   if (d->execSelect(d->findAirway)) {
1947     // already exists
1948     airway = sqlite3_column_int(d->findAirway, 0);
1949   } else {
1950     sqlite_bind_stdstring(d->insertAirway, 1, aName);
1951     sqlite3_bind_int(d->insertAirway, 2, network);
1952     airway = d->execInsert(d->insertAirway);
1953   }
1954
1955   d->reset(d->findAirway);
1956   return airway;
1957 }
1958
1959 void NavDataCache::insertEdge(int network, int airwayID, PositionedID from, PositionedID to)
1960 {
1961   // assume all edges are bidirectional for the moment
1962   for (int i=0; i<2; ++i) {
1963     sqlite3_bind_int(d->insertAirwayEdge, 1, network);
1964     sqlite3_bind_int(d->insertAirwayEdge, 2, airwayID);
1965     sqlite3_bind_int64(d->insertAirwayEdge, 3, from);
1966     sqlite3_bind_int64(d->insertAirwayEdge, 4, to);
1967     d->execInsert(d->insertAirwayEdge);
1968
1969     std::swap(from, to);
1970   }
1971 }
1972
1973 bool NavDataCache::isInAirwayNetwork(int network, PositionedID pos)
1974 {
1975   sqlite3_bind_int(d->isPosInAirway, 1, network);
1976   sqlite3_bind_int64(d->isPosInAirway, 2, pos);
1977   bool ok = d->execSelect(d->isPosInAirway);
1978   d->reset(d->isPosInAirway);
1979
1980   return ok;
1981 }
1982
1983 AirwayEdgeVec NavDataCache::airwayEdgesFrom(int network, PositionedID pos)
1984 {
1985   sqlite3_bind_int(d->airwayEdgesFrom, 1, network);
1986   sqlite3_bind_int64(d->airwayEdgesFrom, 2, pos);
1987
1988   AirwayEdgeVec result;
1989   while (d->stepSelect(d->airwayEdgesFrom)) {
1990     result.push_back(AirwayEdge(
1991                      sqlite3_column_int(d->airwayEdgesFrom, 0),
1992                      sqlite3_column_int64(d->airwayEdgesFrom, 1)
1993                      ));
1994   }
1995
1996   d->reset(d->airwayEdgesFrom);
1997   return result;
1998 }
1999
2000 PositionedID NavDataCache::findNavaidForRunway(PositionedID runway, FGPositioned::Type ty)
2001 {
2002   sqlite3_bind_int64(d->findNavaidForRunway, 1, runway);
2003   sqlite3_bind_int(d->findNavaidForRunway, 2, ty);
2004
2005   PositionedID result = 0;
2006   if (d->execSelect(d->findNavaidForRunway)) {
2007     result = sqlite3_column_int64(d->findNavaidForRunway, 0);
2008   }
2009
2010   d->reset(d->findNavaidForRunway);
2011   return result;
2012 }
2013
2014 PositionedID
2015 NavDataCache::insertParking(const std::string& name, const SGGeod& aPos,
2016                             PositionedID aAirport,
2017                            double aHeading, int aRadius, const std::string& aAircraftType,
2018                            const std::string& aAirlines)
2019 {
2020   sqlite3_int64 rowId = d->insertPositioned(FGPositioned::PARKING, name, "", aPos, aAirport, false);
2021
2022 // we need to insert a row into the taxi_node table, otherwise we can't maintain
2023 // the appropriate pushback flag.
2024   sqlite3_bind_int64(d->insertTaxiNode, 1, rowId);
2025   sqlite3_bind_int(d->insertTaxiNode, 2, 0);
2026   sqlite3_bind_int(d->insertTaxiNode, 3, 0);
2027   d->execInsert(d->insertTaxiNode);
2028
2029   sqlite3_bind_int64(d->insertParkingPos, 1, rowId);
2030   sqlite3_bind_double(d->insertParkingPos, 2, aHeading);
2031   sqlite3_bind_int(d->insertParkingPos, 3, aRadius);
2032   sqlite_bind_stdstring(d->insertParkingPos, 4, aAircraftType);
2033   sqlite_bind_stdstring(d->insertParkingPos, 5, aAirlines);
2034   return d->execInsert(d->insertParkingPos);
2035 }
2036
2037 void NavDataCache::setParkingPushBackRoute(PositionedID parking, PositionedID pushBackNode)
2038 {
2039   sqlite3_bind_int64(d->setParkingPushBack, 1, parking);
2040   sqlite3_bind_int64(d->setParkingPushBack, 2, pushBackNode);
2041   d->execUpdate(d->setParkingPushBack);
2042 }
2043
2044 PositionedID
2045 NavDataCache::insertTaxiNode(const SGGeod& aPos, PositionedID aAirport, int aHoldType, bool aOnRunway)
2046 {
2047   sqlite3_int64 rowId = d->insertPositioned(FGPositioned::TAXI_NODE, string(), string(), aPos, aAirport, false);
2048   sqlite3_bind_int64(d->insertTaxiNode, 1, rowId);
2049   sqlite3_bind_int(d->insertTaxiNode, 2, aHoldType);
2050   sqlite3_bind_int(d->insertTaxiNode, 3, aOnRunway);
2051   return d->execInsert(d->insertTaxiNode);
2052 }
2053
2054 void NavDataCache::insertGroundnetEdge(PositionedID aAirport, PositionedID from, PositionedID to)
2055 {
2056   sqlite3_bind_int64(d->insertTaxiEdge, 1, aAirport);
2057   sqlite3_bind_int64(d->insertTaxiEdge, 2, from);
2058   sqlite3_bind_int64(d->insertTaxiEdge, 3, to);
2059   d->execInsert(d->insertTaxiEdge);
2060 }
2061
2062 PositionedIDVec NavDataCache::groundNetNodes(PositionedID aAirport, bool onlyPushback)
2063 {
2064   sqlite3_stmt_ptr q = onlyPushback ? d->airportPushbackNodes : d->airportTaxiNodes;
2065   sqlite3_bind_int64(q, 1, aAirport);
2066   return d->selectIds(q);
2067 }
2068
2069 void NavDataCache::markGroundnetAsPushback(PositionedID nodeId)
2070 {
2071   sqlite3_bind_int64(d->markTaxiNodeAsPushback, 1, nodeId);
2072   d->execUpdate(d->markTaxiNodeAsPushback);
2073 }
2074
2075 static double headingDifferenceDeg(double crs1, double crs2)
2076 {
2077   double diff =  crs2 - crs1;
2078   SG_NORMALIZE_RANGE(diff, -180.0, 180.0);
2079   return diff;
2080 }
2081
2082 PositionedID NavDataCache::findGroundNetNode(PositionedID airport, const SGGeod& aPos,
2083                                              bool onRunway, FGRunway* aRunway)
2084 {
2085   sqlite3_stmt_ptr q = onRunway ? d->findNearestRunwayTaxiNode : d->findNearestTaxiNode;
2086   sqlite3_bind_int64(q, 1, airport);
2087
2088   SGVec3d cartPos(SGVec3d::fromGeod(aPos));
2089   sqlite3_bind_double(q, 2, cartPos.x());
2090   sqlite3_bind_double(q, 3, cartPos.y());
2091   sqlite3_bind_double(q, 4, cartPos.z());
2092
2093   PositionedID result = 0;
2094   while (d->execSelect(q)) {
2095     PositionedID id = sqlite3_column_int64(q, 0);
2096     if (!aRunway) {
2097       result = id;
2098       break;
2099     }
2100
2101   // ensure found node lies on the runway
2102     FGPositionedRef node = loadById(id);
2103     double course = SGGeodesy::courseDeg(node->geod(), aRunway->end());
2104     if (fabs(headingDifferenceDeg(course, aRunway->headingDeg())) < 3.0 ) {
2105       result = id;
2106       break;
2107     }
2108   }
2109
2110   d->reset(q);
2111   return result;
2112 }
2113
2114 PositionedIDVec NavDataCache::groundNetEdgesFrom(PositionedID pos, bool onlyPushback)
2115 {
2116   sqlite3_stmt_ptr q = onlyPushback ? d->pushbackEdgesFrom : d->taxiEdgesFrom;
2117   sqlite3_bind_int64(q, 1, pos);
2118   return d->selectIds(q);
2119 }
2120
2121 PositionedIDVec NavDataCache::findAirportParking(PositionedID airport, const std::string& flightType,
2122                                    int radius)
2123 {
2124   sqlite3_bind_int64(d->findAirportParking, 1, airport);
2125   sqlite3_bind_int(d->findAirportParking, 2, radius);
2126   sqlite_bind_stdstring(d->findAirportParking, 3, flightType);
2127
2128   return d->selectIds(d->findAirportParking);
2129 }
2130
2131 void NavDataCache::dropGroundnetFor(PositionedID aAirport)
2132 {
2133   sqlite3_stmt_ptr q = d->prepare("DELETE FROM parking WHERE rowid IN (SELECT rowid FROM positioned WHERE type=?1 AND airport=?2)");
2134   sqlite3_bind_int(q, 1, FGPositioned::PARKING);
2135   sqlite3_bind_int64(q, 2, aAirport);
2136   d->execUpdate(q);
2137
2138   q = d->prepare("DELETE FROM taxi_node WHERE rowid IN (SELECT rowid FROM positioned WHERE (type=?1 OR type=?2) AND airport=?3)");
2139   sqlite3_bind_int(q, 1, FGPositioned::TAXI_NODE);
2140   sqlite3_bind_int(q, 2, FGPositioned::PARKING);
2141   sqlite3_bind_int64(q, 3, aAirport);
2142   d->execUpdate(q);
2143
2144   q = d->prepare("DELETE FROM positioned WHERE (type=?1 OR type=?2) AND airport=?3");
2145   sqlite3_bind_int(q, 1, FGPositioned::TAXI_NODE);
2146   sqlite3_bind_int(q, 2, FGPositioned::PARKING);
2147   sqlite3_bind_int64(q, 3, aAirport);
2148   d->execUpdate(q);
2149
2150   q = d->prepare("DELETE FROM groundnet_edge WHERE airport=?1");
2151   sqlite3_bind_int64(q, 1, aAirport);
2152   d->execUpdate(q);
2153 }
2154
2155 bool NavDataCache::isReadOnly() const
2156 {
2157     return d->readOnly;
2158 }
2159
2160 /////////////////////////////////////////////////////////////////////////////////////////
2161 // Transaction RAII object
2162
2163 NavDataCache::Transaction::Transaction(NavDataCache* cache) :
2164     _instance(cache),
2165     _committed(false)
2166 {
2167     assert(cache);
2168     _instance->beginTransaction();
2169 }
2170
2171 NavDataCache::Transaction::~Transaction()
2172 {
2173     if (!_committed) {
2174         SG_LOG(SG_NAVCACHE, SG_INFO, "aborting cache transaction!");
2175         _instance->abortTransaction();
2176     }
2177 }
2178
2179 void NavDataCache::Transaction::commit()
2180 {
2181     assert(!_committed);
2182     _committed = true;
2183     _instance->commitTransaction();
2184 }
2185
2186 } // of namespace flightgear
2187