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