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