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