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