1 // NavDataCache.cxx - defines a unified binary cache for navigation
2 // data, parsed from various text / XML sources.
4 // Written by James Turner, started 2012.
6 // Copyright (C) 2012 James Turner
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.
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.
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.
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
31 #include "NavDataCache.hxx"
36 #include <stdint.h> // for int64_t
38 #include <boost/foreach.hpp>
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>
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>
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>
68 #define SG_NAVCACHE SG_GENERAL
69 //#define LAZY_OCTREE_UPDATES 1
73 const int SCHEMA_VERSION = 5;
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)
81 sqlite3_bind_text(stmt, value, s.c_str(), s.length(), SQLITE_STATIC);
84 // variant of the above, which does not care about the lifetime of the
86 void sqlite_bind_temp_stdstring(sqlite3_stmt* stmt, int value, const std::string& s)
88 sqlite3_bind_text(stmt, value, s.c_str(), s.length(), SQLITE_TRANSIENT);
91 typedef sqlite3_stmt* sqlite3_stmt_ptr;
93 void f_distanceCartSqrFunction(sqlite3_context* ctx, int argc, sqlite3_value* argv[])
99 SGVec3d posA(sqlite3_value_double(argv[0]),
100 sqlite3_value_double(argv[1]),
101 sqlite3_value_double(argv[2]));
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));
110 static string cleanRunwayNo(const string& aRwyNo)
112 if (aRwyNo[0] == 'x') {
113 return string(); // no ident for taxiways
116 string result(aRwyNo);
117 // canonicalise runway ident
118 if ((aRwyNo.size() == 1) || !isdigit(aRwyNo[1])) {
119 result = "0" + aRwyNo;
122 // trim off trailing garbage
123 if (result.size() > 2) {
124 char suffix = toupper(result[2]);
126 result = result.substr(0, 2);
133 } // anonymous namespace
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
145 class RebuildThread : public SGThread
148 RebuildThread(NavDataCache* cache) :
155 bool isFinished() const
157 SGGuard<SGMutex> g(_lock);
166 SG_LOG(SG_GENERAL, SG_INFO, "cache rebuild took:" << st.elapsedMSec() << "msec");
168 SGGuard<SGMutex> g(_lock);
172 NavDataCache* _cache;
173 mutable SGMutex _lock;
177 ////////////////////////////////////////////////////////////////////////////
179 typedef std::map<PositionedID, FGPositionedRef> PositionedCache;
181 class AirportTower : public FGPositioned
184 AirportTower(PositionedID& guid, PositionedID airport,
185 const string& ident, const SGGeod& pos) :
186 FGPositioned(guid, FGPositioned::TOWER, ident, pos)
191 class NavDataCache::NavDataCachePrivate
194 NavDataCachePrivate(const SGPath& p, NavDataCache* o) :
203 ~NavDataCachePrivate()
205 BOOST_FOREACH(sqlite3_stmt_ptr stmt, prepared) {
206 sqlite3_finalize(stmt);
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);
220 sqlite3_stmt_ptr checkTables =
221 prepare("SELECT count(*) FROM sqlite_master WHERE name='properties'");
223 sqlite3_create_function(db, "distanceCartSqr", 6, SQLITE_ANY, NULL,
224 f_distanceCartSqrFunction, NULL, NULL);
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");
234 readPropertyQuery = prepare("SELECT value FROM properties WHERE key=?");
235 writePropertyQuery = prepare("INSERT OR REPLACE INTO properties "
236 "(key, value) VALUES (?,?)");
239 writeIntProperty("schema-version", SCHEMA_VERSION);
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");
251 void checkCacheFile()
253 SG_LOG(SG_NAVCACHE, SG_INFO, "running DB integrity check");
257 sqlite3_stmt_ptr stmt = prepare("PRAGMA integrity_check(1)");
258 if (!execSelect(stmt)) {
259 throw sg_exception("DB integrity check failed to run");
262 string v = (char*) sqlite3_column_text(stmt, 0);
264 throw sg_exception("DB integrity check returned:" + v);
267 SG_LOG(SG_NAVCACHE, SG_INFO, "NavDataCache integrity check took:" << st.elapsedMSec());
271 void callSqlite(int result, const string& sql)
273 if (result == SQLITE_OK)
277 if (result == SQLITE_MISUSE) {
278 errMsg = "Sqlite API abuse";
279 SG_LOG(SG_NAVCACHE, SG_ALERT, "Sqlite API abuse");
281 errMsg = sqlite3_errmsg(db);
282 SG_LOG(SG_NAVCACHE, SG_ALERT, "Sqlite error:" << errMsg << " running:\n\t" << sql);
285 throw sg_exception("Sqlite error:" + errMsg, sql);
288 void runSQL(const string& sql)
290 sqlite3_stmt_ptr stmt;
291 callSqlite(sqlite3_prepare_v2(db, sql.c_str(), sql.length(), &stmt, NULL), sql);
295 } catch (sg_exception&) {
296 sqlite3_finalize(stmt);
300 sqlite3_finalize(stmt);
303 sqlite3_stmt_ptr prepare(const string& sql)
305 sqlite3_stmt_ptr stmt;
306 callSqlite(sqlite3_prepare_v2(db, sql.c_str(), sql.length(), &stmt, NULL), sql);
307 prepared.push_back(stmt);
311 void finalize(sqlite3_stmt_ptr s)
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");
322 void reset(sqlite3_stmt_ptr 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));
332 bool execSelect(sqlite3_stmt_ptr stmt)
334 return stepSelect(stmt);
337 bool stepSelect(sqlite3_stmt_ptr stmt)
339 int result = sqlite3_step(stmt);
340 if (result == SQLITE_ROW) {
341 return true; // at least one result row
344 if (result == SQLITE_DONE) {
345 return false; // no result rows
349 if (result == SQLITE_MISUSE) {
350 errMsg = "Sqlite API abuse";
351 SG_LOG(SG_NAVCACHE, SG_ALERT, "Sqlite API abuse");
353 errMsg = sqlite3_errmsg(db);
354 SG_LOG(SG_NAVCACHE, SG_ALERT, "Sqlite error:" << errMsg
355 << " while running:\n\t" << sqlite3_sql(stmt));
358 throw sg_exception("Sqlite error:" + errMsg, sqlite3_sql(stmt));
361 void execSelect1(sqlite3_stmt_ptr stmt)
363 if (!execSelect(stmt)) {
364 SG_LOG(SG_NAVCACHE, SG_WARN, "empty SELECT running:\n\t" << sqlite3_sql(stmt));
365 throw sg_exception("no results returned for select", sqlite3_sql(stmt));
369 sqlite3_int64 execInsert(sqlite3_stmt_ptr stmt)
372 return sqlite3_last_insert_rowid(db);
375 void execUpdate(sqlite3_stmt_ptr stmt)
382 runSQL("CREATE TABLE properties ("
387 runSQL("CREATE TABLE stat_cache ("
388 "path VARCHAR unique,"
392 runSQL("CREATE TABLE positioned ("
394 "ident VARCHAR collate nocase,"
395 "name VARCHAR collate nocase,"
406 runSQL("CREATE INDEX pos_octree ON positioned(octree_node)");
407 runSQL("CREATE INDEX pos_ident ON positioned(ident collate nocase)");
408 runSQL("CREATE INDEX pos_name ON positioned(name collate nocase)");
409 // allow efficient querying of 'all ATIS at this airport' or
410 // 'all towers at this airport'
411 runSQL("CREATE INDEX pos_apt_type ON positioned(airport, type)");
413 runSQL("CREATE TABLE airport ("
418 runSQL("CREATE TABLE comm ("
424 runSQL("CREATE INDEX comm_freq ON comm(freq_khz)");
426 runSQL("CREATE TABLE runway ("
431 "displaced_threshold FLOAT,"
438 runSQL("CREATE TABLE navaid ("
447 runSQL("CREATE INDEX navaid_freq ON navaid(freq)");
449 runSQL("CREATE TABLE octree (children INT)");
451 runSQL("CREATE TABLE airway ("
452 "ident VARCHAR collate nocase,"
453 "network INT" // high-level or low-level
456 runSQL("CREATE INDEX airway_ident ON airway(ident)");
458 runSQL("CREATE TABLE airway_edge ("
465 runSQL("CREATE INDEX airway_edge_from ON airway_edge(a)");
467 runSQL("CREATE TABLE taxi_node ("
473 runSQL("CREATE TABLE parking ("
481 runSQL("CREATE TABLE groundnet_edge ("
487 runSQL("CREATE INDEX groundnet_edge_airport ON groundnet_edge(airport)");
488 runSQL("CREATE INDEX groundnet_edge_from ON groundnet_edge(a)");
491 void prepareQueries()
493 clearProperty = prepare("DELETE FROM properties WHERE key=?1");
494 writePropertyMulti = prepare("INSERT INTO properties (key, value) VALUES(?1,?2)");
496 #define POSITIONED_COLS "rowid, type, ident, name, airport, lon, lat, elev_m, octree_node"
497 #define AND_TYPED "AND type>=?2 AND type <=?3"
498 statCacheCheck = prepare("SELECT stamp FROM stat_cache WHERE path=?");
499 stampFileCache = prepare("INSERT OR REPLACE INTO stat_cache "
500 "(path, stamp) VALUES (?,?)");
502 loadPositioned = prepare("SELECT " POSITIONED_COLS " FROM positioned WHERE rowid=?");
503 loadAirportStmt = prepare("SELECT has_metar FROM airport WHERE rowid=?");
504 loadNavaid = prepare("SELECT range_nm, freq, multiuse, runway, colocated FROM navaid WHERE rowid=?");
505 loadCommStation = prepare("SELECT freq_khz, range_nm FROM comm WHERE rowid=?");
506 loadRunwayStmt = prepare("SELECT heading, length_ft, width_m, surface, displaced_threshold,"
507 "stopway, reciprocal, ils FROM runway WHERE rowid=?1");
509 getAirportItems = prepare("SELECT rowid FROM positioned WHERE airport=?1 " AND_TYPED);
512 setAirportMetar = prepare("UPDATE airport SET has_metar=?2 WHERE rowid="
513 "(SELECT rowid FROM positioned WHERE ident=?1 AND type>=?3 AND type <=?4)");
514 sqlite3_bind_int(setAirportMetar, 3, FGPositioned::AIRPORT);
515 sqlite3_bind_int(setAirportMetar, 4, FGPositioned::SEAPORT);
517 setRunwayReciprocal = prepare("UPDATE runway SET reciprocal=?2 WHERE rowid=?1");
518 setRunwayILS = prepare("UPDATE runway SET ils=?2 WHERE rowid=?1");
519 updateRunwayThreshold = prepare("UPDATE runway SET heading=?2, displaced_threshold=?3, stopway=?4 WHERE rowid=?1");
521 insertPositionedQuery = prepare("INSERT INTO positioned "
522 "(type, ident, name, airport, lon, lat, elev_m, octree_node, "
523 "cart_x, cart_y, cart_z)"
524 " VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10, ?11)");
526 setAirportPos = prepare("UPDATE positioned SET lon=?2, lat=?3, elev_m=?4, octree_node=?5, "
527 "cart_x=?6, cart_y=?7, cart_z=?8 WHERE rowid=?1");
528 insertAirport = prepare("INSERT INTO airport (rowid, has_metar) VALUES (?, ?)");
529 insertNavaid = prepare("INSERT INTO navaid (rowid, freq, range_nm, multiuse, runway, colocated)"
530 " VALUES (?1, ?2, ?3, ?4, ?5, ?6)");
531 updateILS = prepare("UPDATE navaid SET multiuse=?2 WHERE rowid=?1");
533 insertCommStation = prepare("INSERT INTO comm (rowid, freq_khz, range_nm)"
534 " VALUES (?, ?, ?)");
535 insertRunway = prepare("INSERT INTO runway "
536 "(rowid, heading, length_ft, width_m, surface, displaced_threshold, stopway, reciprocal)"
537 " VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8)");
538 runwayLengthFtQuery = prepare("SELECT length_ft FROM runway WHERE rowid=?1");
541 findClosestWithIdent = prepare("SELECT rowid FROM positioned WHERE ident=?1 "
542 AND_TYPED " ORDER BY distanceCartSqr(cart_x, cart_y, cart_z, ?4, ?5, ?6)");
544 findCommByFreq = prepare("SELECT positioned.rowid FROM positioned, comm WHERE "
545 "positioned.rowid=comm.rowid AND freq_khz=?1 "
546 AND_TYPED " ORDER BY distanceCartSqr(cart_x, cart_y, cart_z, ?4, ?5, ?6)");
548 findNavsByFreq = prepare("SELECT positioned.rowid FROM positioned, navaid WHERE "
549 "positioned.rowid=navaid.rowid "
550 "AND navaid.freq=?1 " AND_TYPED
551 " ORDER BY distanceCartSqr(cart_x, cart_y, cart_z, ?4, ?5, ?6)");
553 findNavsByFreqNoPos = prepare("SELECT positioned.rowid FROM positioned, navaid WHERE "
554 "positioned.rowid=navaid.rowid AND freq=?1 " AND_TYPED);
556 findNavaidForRunway = prepare("SELECT positioned.rowid FROM positioned, navaid WHERE "
557 "positioned.rowid=navaid.rowid AND runway=?1 AND type=?2");
559 // for an octree branch, return the child octree nodes which exist,
560 // described as a bit-mask
561 getOctreeChildren = prepare("SELECT children FROM octree WHERE rowid=?1");
563 #ifdef LAZY_OCTREE_UPDATES
564 updateOctreeChildren = prepare("UPDATE octree SET children=?2 WHERE rowid=?1");
566 // mask the new child value into the existing one
567 updateOctreeChildren = prepare("UPDATE octree SET children=(?2 | children) WHERE rowid=?1");
570 // define a new octree node (with no children)
571 insertOctree = prepare("INSERT INTO octree (rowid, children) VALUES (?1, 0)");
573 getOctreeLeafChildren = prepare("SELECT rowid, type FROM positioned WHERE octree_node=?1");
575 searchAirports = prepare("SELECT ident, name FROM positioned WHERE (name LIKE ?1 OR ident LIKE ?1) " AND_TYPED);
576 sqlite3_bind_int(searchAirports, 2, FGPositioned::AIRPORT);
577 sqlite3_bind_int(searchAirports, 3, FGPositioned::SEAPORT);
579 getAirportItemByIdent = prepare("SELECT rowid FROM positioned WHERE airport=?1 AND ident=?2 AND type=?3");
581 findAirportRunway = prepare("SELECT airport, rowid FROM positioned WHERE ident=?2 AND type=?3 AND airport="
582 "(SELECT rowid FROM positioned WHERE type=?4 AND ident=?1)");
583 sqlite3_bind_int(findAirportRunway, 3, FGPositioned::RUNWAY);
584 sqlite3_bind_int(findAirportRunway, 4, FGPositioned::AIRPORT);
586 // three-way join to get the navaid ident and runway ident in a single select.
587 // we're joining positioned to itself by the navaid runway, with the complication
588 // that we need to join the navaids table to get the runway ID.
589 // we also need to filter by type to excluse glideslope (GS) matches
590 findILS = prepare("SELECT nav.rowid FROM positioned AS nav, positioned AS rwy, navaid WHERE "
591 "nav.ident=?1 AND nav.airport=?2 AND rwy.ident=?3 "
592 "AND rwy.rowid = navaid.runway AND navaid.rowid=nav.rowid "
593 "AND (nav.type=?4 OR nav.type=?5)");
595 sqlite3_bind_int(findILS, 4, FGPositioned::ILS);
596 sqlite3_bind_int(findILS, 5, FGPositioned::LOC);
599 findAirway = prepare("SELECT rowid FROM airway WHERE network=?1 AND ident=?2");
600 insertAirway = prepare("INSERT INTO airway (ident, network) "
603 insertAirwayEdge = prepare("INSERT INTO airway_edge (network, airway, a, b) "
604 "VALUES (?1, ?2, ?3, ?4)");
606 isPosInAirway = prepare("SELECT rowid FROM airway_edge WHERE network=?1 AND a=?2");
608 airwayEdgesFrom = prepare("SELECT airway, b FROM airway_edge WHERE network=?1 AND a=?2");
610 // parking / taxi-node graph
611 insertTaxiNode = prepare("INSERT INTO taxi_node (rowid, hold_type, on_runway, pushback) VALUES(?1, ?2, ?3, 0)");
612 insertParkingPos = prepare("INSERT INTO parking (rowid, heading, radius, gate_type, airlines) "
613 "VALUES (?1, ?2, ?3, ?4, ?5)");
614 setParkingPushBack = prepare("UPDATE parking SET pushback=?2 WHERE rowid=?1");
616 loadTaxiNodeStmt = prepare("SELECT hold_type, on_runway FROM taxi_node WHERE rowid=?1");
617 loadParkingPos = prepare("SELECT heading, radius, gate_type, airlines, pushback FROM parking WHERE rowid=?1");
618 taxiEdgesFrom = prepare("SELECT b FROM groundnet_edge WHERE a=?1");
619 pushbackEdgesFrom = prepare("SELECT b FROM groundnet_edge, taxi_node WHERE "
620 "a=?1 AND groundnet_edge.b = taxi_node.rowid AND pushback=1");
622 insertTaxiEdge = prepare("INSERT INTO groundnet_edge (airport, a,b) VALUES(?1, ?2, ?3)");
624 markTaxiNodeAsPushback = prepare("UPDATE taxi_node SET pushback=1 WHERE rowid=?1");
625 airportTaxiNodes = prepare("SELECT rowid FROM positioned WHERE (type=?2 OR type=?3) AND airport=?1");
626 sqlite3_bind_int(airportTaxiNodes, 2, FGPositioned::PARKING);
627 sqlite3_bind_int(airportTaxiNodes, 3, FGPositioned::TAXI_NODE);
629 airportPushbackNodes = prepare("SELECT positioned.rowid FROM positioned, taxi_node WHERE "\
630 "airport=?1 AND positioned.rowid=taxi_node.rowid AND pushback=1 "
631 "AND (type=?2 OR type=?3)");
632 sqlite3_bind_int(airportPushbackNodes, 2, FGPositioned::PARKING);
633 sqlite3_bind_int(airportPushbackNodes, 3, FGPositioned::TAXI_NODE);
635 findNearestTaxiNode = prepare("SELECT positioned.rowid FROM positioned, taxi_node WHERE "
636 "positioned.rowid = taxi_node.rowid AND airport=?1 "
637 "ORDER BY distanceCartSqr(cart_x, cart_y, cart_z, ?2, ?3, ?4) "
640 findNearestRunwayTaxiNode = prepare("SELECT positioned.rowid FROM positioned, taxi_node WHERE "
641 "positioned.rowid = taxi_node.rowid AND airport=?1 "
643 "ORDER BY distanceCartSqr(cart_x, cart_y, cart_z, ?2, ?3, ?4) ");
645 findAirportParking = prepare("SELECT positioned.rowid FROM positioned, parking WHERE "
646 "airport=?1 AND type=?4 AND "
647 "radius >= ?2 AND gate_type = ?3 AND "
648 "parking.rowid=positioned.rowid");
649 sqlite3_bind_int(findAirportParking, 4, FGPositioned::PARKING);
652 void writeIntProperty(const string& key, int value)
654 sqlite_bind_stdstring(writePropertyQuery, 1, key);
655 sqlite3_bind_int(writePropertyQuery, 2, value);
656 execSelect(writePropertyQuery);
660 FGPositioned* loadFromStmt(sqlite3_stmt_ptr query);
662 FGAirport* loadAirport(sqlite_int64 rowId,
663 FGPositioned::Type ty,
664 const string& id, const string& name, const SGGeod& pos)
666 reset(loadAirportStmt);
667 sqlite3_bind_int64(loadAirportStmt, 1, rowId);
668 execSelect1(loadAirportStmt);
669 bool hasMetar = (sqlite3_column_int(loadAirportStmt, 0) > 0);
670 return new FGAirport(rowId, id, pos, name, hasMetar, ty);
673 FGRunwayBase* loadRunway(sqlite3_int64 rowId, FGPositioned::Type ty,
674 const string& id, const SGGeod& pos, PositionedID apt)
676 reset(loadRunwayStmt);
677 sqlite3_bind_int(loadRunwayStmt, 1, rowId);
678 execSelect1(loadRunwayStmt);
680 double heading = sqlite3_column_double(loadRunwayStmt, 0);
681 double lengthM = sqlite3_column_int(loadRunwayStmt, 1);
682 double widthM = sqlite3_column_double(loadRunwayStmt, 2);
683 int surface = sqlite3_column_int(loadRunwayStmt, 3);
685 if (ty == FGPositioned::TAXIWAY) {
686 return new FGTaxiway(rowId, id, pos, heading, lengthM, widthM, surface);
688 double displacedThreshold = sqlite3_column_double(loadRunwayStmt, 4);
689 double stopway = sqlite3_column_double(loadRunwayStmt, 5);
690 PositionedID reciprocal = sqlite3_column_int64(loadRunwayStmt, 6);
691 PositionedID ils = sqlite3_column_int64(loadRunwayStmt, 7);
692 FGRunway* r = new FGRunway(rowId, apt, id, pos, heading, lengthM, widthM,
693 displacedThreshold, stopway, surface, false);
695 if (reciprocal > 0) {
696 r->setReciprocalRunway(reciprocal);
707 CommStation* loadComm(sqlite3_int64 rowId, FGPositioned::Type ty,
708 const string& id, const string& name,
710 PositionedID airport)
712 reset(loadCommStation);
713 sqlite3_bind_int64(loadCommStation, 1, rowId);
714 execSelect1(loadCommStation);
716 int range = sqlite3_column_int(loadCommStation, 0);
717 int freqKhz = sqlite3_column_int(loadCommStation, 1);
719 CommStation* c = new CommStation(rowId, name, ty, pos, freqKhz, range);
720 c->setAirport(airport);
724 FGPositioned* loadNav(sqlite3_int64 rowId,
725 FGPositioned::Type ty, const string& id,
726 const string& name, const SGGeod& pos)
729 sqlite3_bind_int64(loadNavaid, 1, rowId);
730 execSelect1(loadNavaid);
732 PositionedID runway = sqlite3_column_int64(loadNavaid, 3);
733 // marker beacons are light-weight
734 if ((ty == FGPositioned::OM) || (ty == FGPositioned::IM) ||
735 (ty == FGPositioned::MM))
737 return new FGMarkerBeaconRecord(rowId, ty, runway, pos);
740 int rangeNm = sqlite3_column_int(loadNavaid, 0),
741 freq = sqlite3_column_int(loadNavaid, 1);
742 double mulituse = sqlite3_column_double(loadNavaid, 2);
743 //sqlite3_int64 colocated = sqlite3_column_int64(loadNavaid, 4);
745 return new FGNavRecord(rowId, ty, id, name, pos, freq, rangeNm, mulituse, runway);
748 FGPositioned* loadParking(sqlite3_int64 rowId,
749 const string& name, const SGGeod& pos,
750 PositionedID airport)
752 reset(loadParkingPos);
753 sqlite3_bind_int64(loadParkingPos, 1, rowId);
754 execSelect1(loadParkingPos);
756 double heading = sqlite3_column_double(loadParkingPos, 0);
757 int radius = sqlite3_column_int(loadParkingPos, 1);
758 string aircraftType((char*) sqlite3_column_text(loadParkingPos, 2));
759 string airlines((char*) sqlite3_column_text(loadParkingPos, 3));
760 PositionedID pushBack = sqlite3_column_int64(loadParkingPos, 4);
762 return new FGParking(rowId, pos, heading, radius, name, aircraftType, airlines, pushBack);
765 FGPositioned* loadTaxiNode(sqlite3_int64 rowId, const SGGeod& pos,
766 PositionedID airport)
768 reset(loadTaxiNodeStmt);
769 sqlite3_bind_int64(loadTaxiNodeStmt, 1, rowId);
770 execSelect1(loadTaxiNodeStmt);
772 int hold_type = sqlite3_column_int(loadTaxiNodeStmt, 0);
773 bool onRunway = sqlite3_column_int(loadTaxiNodeStmt, 1);
774 return new FGTaxiNode(rowId, pos, onRunway, hold_type);
777 PositionedID insertPositioned(FGPositioned::Type ty, const string& ident,
778 const string& name, const SGGeod& pos, PositionedID apt,
781 SGVec3d cartPos(SGVec3d::fromGeod(pos));
783 reset(insertPositionedQuery);
784 sqlite3_bind_int(insertPositionedQuery, 1, ty);
785 sqlite_bind_stdstring(insertPositionedQuery, 2, ident);
786 sqlite_bind_stdstring(insertPositionedQuery, 3, name);
787 sqlite3_bind_int64(insertPositionedQuery, 4, apt);
788 sqlite3_bind_double(insertPositionedQuery, 5, pos.getLongitudeDeg());
789 sqlite3_bind_double(insertPositionedQuery, 6, pos.getLatitudeDeg());
790 sqlite3_bind_double(insertPositionedQuery, 7, pos.getElevationM());
793 Octree::Leaf* octreeLeaf = Octree::global_spatialOctree->findLeafForPos(cartPos);
794 assert(intersects(octreeLeaf->bbox(), cartPos));
795 sqlite3_bind_int64(insertPositionedQuery, 8, octreeLeaf->guid());
797 sqlite3_bind_null(insertPositionedQuery, 8);
800 sqlite3_bind_double(insertPositionedQuery, 9, cartPos.x());
801 sqlite3_bind_double(insertPositionedQuery, 10, cartPos.y());
802 sqlite3_bind_double(insertPositionedQuery, 11, cartPos.z());
804 PositionedID r = execInsert(insertPositionedQuery);
808 FGPositioned::List findAllByString(const string& s, const string& column,
809 FGPositioned::Filter* filter, bool exact)
812 if (!exact) query += "%";
814 // build up SQL query text
815 string matchTerm = exact ? "=?1" : " LIKE ?1";
816 string sql = "SELECT rowid FROM positioned WHERE " + column + matchTerm;
818 sql += " " AND_TYPED;
821 // find or prepare a suitable statement frrm the SQL
822 sqlite3_stmt_ptr stmt = findByStringDict[sql];
825 findByStringDict[sql] = stmt;
829 sqlite_bind_stdstring(stmt, 1, query);
831 sqlite3_bind_int(stmt, 2, filter->minType());
832 sqlite3_bind_int(stmt, 3, filter->maxType());
835 FGPositioned::List result;
836 // run the prepared SQL
837 while (stepSelect(stmt))
839 FGPositioned* pos = outer->loadById(sqlite3_column_int64(stmt, 0));
840 if (filter && !filter->pass(pos)) {
844 result.push_back(pos);
850 PositionedIDVec selectIds(sqlite3_stmt_ptr query)
852 PositionedIDVec result;
853 while (stepSelect(query)) {
854 result.push_back(sqlite3_column_int64(query, 0));
859 double runwayLengthFt(PositionedID rwy)
861 reset(runwayLengthFtQuery);
862 sqlite3_bind_int64(runwayLengthFtQuery, 1, rwy);
863 execSelect1(runwayLengthFtQuery);
864 return sqlite3_column_double(runwayLengthFtQuery, 0);
867 void flushDeferredOctreeUpdates()
869 BOOST_FOREACH(Octree::Branch* nd, deferredOctreeUpdates) {
870 reset(updateOctreeChildren);
871 sqlite3_bind_int64(updateOctreeChildren, 1, nd->guid());
872 sqlite3_bind_int(updateOctreeChildren, 2, nd->childMask());
873 execUpdate(updateOctreeChildren);
876 deferredOctreeUpdates.clear();
883 /// the actual cache of ID -> instances. This holds an owning reference,
884 /// so once items are in the cache they will never be deleted until
885 /// the cache drops its reference
886 PositionedCache cache;
887 unsigned int cacheHits, cacheMisses;
889 SGPath aptDatPath, metarDatPath, navDatPath, fixDatPath,
890 carrierDatPath, airwayDatPath;
892 sqlite3_stmt_ptr readPropertyQuery, writePropertyQuery,
893 stampFileCache, statCacheCheck,
894 loadAirportStmt, loadCommStation, loadPositioned, loadNavaid,
896 sqlite3_stmt_ptr writePropertyMulti, clearProperty;
898 sqlite3_stmt_ptr insertPositionedQuery, insertAirport, insertTower, insertRunway,
899 insertCommStation, insertNavaid;
900 sqlite3_stmt_ptr setAirportMetar, setRunwayReciprocal, setRunwayILS,
901 setAirportPos, updateRunwayThreshold, updateILS;
903 sqlite3_stmt_ptr findClosestWithIdent;
904 // octree (spatial index) related queries
905 sqlite3_stmt_ptr getOctreeChildren, insertOctree, updateOctreeChildren,
906 getOctreeLeafChildren;
908 sqlite3_stmt_ptr searchAirports;
909 sqlite3_stmt_ptr findCommByFreq, findNavsByFreq,
910 findNavsByFreqNoPos, findNavaidForRunway;
911 sqlite3_stmt_ptr getAirportItems, getAirportItemByIdent;
912 sqlite3_stmt_ptr findAirportRunway,
915 sqlite3_stmt_ptr runwayLengthFtQuery;
918 sqlite3_stmt_ptr findAirway, insertAirwayEdge, isPosInAirway, airwayEdgesFrom,
921 // groundnet (parking, taxi node graph)
922 sqlite3_stmt_ptr loadTaxiNodeStmt, loadParkingPos, insertTaxiNode, insertParkingPos;
923 sqlite3_stmt_ptr taxiEdgesFrom, pushbackEdgesFrom, insertTaxiEdge, markTaxiNodeAsPushback,
924 airportTaxiNodes, airportPushbackNodes, findNearestTaxiNode, findAirportParking,
925 setParkingPushBack, findNearestRunwayTaxiNode;
927 // since there's many permutations of ident/name queries, we create
928 // them programtically, but cache the exact query by its raw SQL once
930 std::map<string, sqlite3_stmt_ptr> findByStringDict;
932 typedef std::vector<sqlite3_stmt_ptr> StmtVec;
935 std::set<Octree::Branch*> deferredOctreeUpdates;
937 // if we're performing a rebuild, the thread that is doing the work.
939 std::auto_ptr<RebuildThread> rebuilder;
942 //////////////////////////////////////////////////////////////////////
944 FGPositioned* NavDataCache::NavDataCachePrivate::loadFromStmt(sqlite3_stmt_ptr query)
947 sqlite3_int64 rowid = sqlite3_column_int64(query, 0);
948 FGPositioned::Type ty = (FGPositioned::Type) sqlite3_column_int(query, 1);
950 string ident = (char*) sqlite3_column_text(query, 2);
951 string name = (char*) sqlite3_column_text(query, 3);
952 sqlite3_int64 aptId = sqlite3_column_int64(query, 4);
953 double lon = sqlite3_column_double(query, 5);
954 double lat = sqlite3_column_double(query, 6);
955 double elev = sqlite3_column_double(query, 7);
956 SGGeod pos = SGGeod::fromDegM(lon, lat, elev);
959 case FGPositioned::AIRPORT:
960 case FGPositioned::SEAPORT:
961 case FGPositioned::HELIPORT:
962 return loadAirport(rowid, ty, ident, name, pos);
964 case FGPositioned::TOWER:
965 return new AirportTower(rowid, aptId, ident, pos);
967 case FGPositioned::RUNWAY:
968 case FGPositioned::TAXIWAY:
969 return loadRunway(rowid, ty, ident, pos, aptId);
971 case FGPositioned::LOC:
972 case FGPositioned::VOR:
973 case FGPositioned::GS:
974 case FGPositioned::ILS:
975 case FGPositioned::NDB:
976 case FGPositioned::OM:
977 case FGPositioned::MM:
978 case FGPositioned::IM:
979 case FGPositioned::DME:
980 case FGPositioned::TACAN:
981 case FGPositioned::MOBILE_TACAN:
984 FGAirport* apt = (FGAirport*) outer->loadById(aptId);
985 if (apt->validateILSData()) {
986 SG_LOG(SG_NAVCACHE, SG_INFO, "re-loaded ILS data for " << apt->ident());
987 // queried data above is probably invalid, force us to go around again
988 // (the next time through, validateILSData will return false)
989 return outer->loadById(rowid);
993 return loadNav(rowid, ty, ident, name, pos);
996 case FGPositioned::FIX:
997 return new FGFix(rowid, ident, pos);
999 case FGPositioned::WAYPOINT:
1001 FGPositioned* wpt = new FGPositioned(rowid, FGPositioned::WAYPOINT, ident, pos);
1005 case FGPositioned::FREQ_GROUND:
1006 case FGPositioned::FREQ_TOWER:
1007 case FGPositioned::FREQ_ATIS:
1008 case FGPositioned::FREQ_AWOS:
1009 case FGPositioned::FREQ_APP_DEP:
1010 case FGPositioned::FREQ_ENROUTE:
1011 case FGPositioned::FREQ_CLEARANCE:
1012 case FGPositioned::FREQ_UNICOM:
1013 return loadComm(rowid, ty, ident, name, pos, aptId);
1015 case FGPositioned::TAXI_NODE:
1016 return loadTaxiNode(rowid, pos, aptId);
1018 case FGPositioned::PARKING:
1019 return loadParking(rowid, ident, pos, aptId);
1027 static NavDataCache* static_instance = NULL;
1029 NavDataCache::NavDataCache()
1031 const int MAX_TRIES = 3;
1032 SGPath homePath(globals->get_fg_home());
1033 homePath.append("navdata.cache");
1035 for (int t=0; t < MAX_TRIES; ++t) {
1037 d.reset(new NavDataCachePrivate(homePath, this));
1039 //d->checkCacheFile();
1040 // reached this point with no exception, success
1042 } catch (sg_exception& e) {
1043 SG_LOG(SG_NAVCACHE, t == 0 ? SG_WARN : SG_ALERT, "NavCache: init failed:" << e.what()
1044 << " (attempt " << t << ")");
1050 double RADIUS_EARTH_M = 7000 * 1000.0; // 7000km is plenty
1051 SGVec3d earthExtent(RADIUS_EARTH_M, RADIUS_EARTH_M, RADIUS_EARTH_M);
1052 Octree::global_spatialOctree =
1053 new Octree::Branch(SGBox<double>(-earthExtent, earthExtent), 1);
1055 d->aptDatPath = SGPath(globals->get_fg_root());
1056 d->aptDatPath.append("Airports/apt.dat.gz");
1058 d->metarDatPath = SGPath(globals->get_fg_root());
1059 d->metarDatPath.append("Airports/metar.dat.gz");
1061 d->navDatPath = SGPath(globals->get_fg_root());
1062 d->navDatPath.append("Navaids/nav.dat.gz");
1064 d->fixDatPath = SGPath(globals->get_fg_root());
1065 d->fixDatPath.append("Navaids/fix.dat.gz");
1067 d->carrierDatPath = SGPath(globals->get_fg_root());
1068 d->carrierDatPath.append("Navaids/carrier_nav.dat.gz");
1070 d->airwayDatPath = SGPath(globals->get_fg_root());
1071 d->airwayDatPath.append("Navaids/awy.dat.gz");
1074 NavDataCache::~NavDataCache()
1076 assert(static_instance == this);
1077 static_instance = NULL;
1078 SG_LOG(SG_NAVCACHE, SG_INFO, "closing the navcache");
1082 NavDataCache* NavDataCache::instance()
1084 if (!static_instance) {
1085 static_instance = new NavDataCache;
1088 return static_instance;
1091 bool NavDataCache::isRebuildRequired()
1093 if (isCachedFileModified(d->aptDatPath) ||
1094 isCachedFileModified(d->metarDatPath) ||
1095 isCachedFileModified(d->navDatPath) ||
1096 isCachedFileModified(d->fixDatPath) ||
1097 isCachedFileModified(d->airwayDatPath))
1099 SG_LOG(SG_NAVCACHE, SG_INFO, "NavCache: rebuild required");
1103 SG_LOG(SG_NAVCACHE, SG_INFO, "NavCache: no rebuild required");
1107 bool NavDataCache::rebuild()
1109 if (!d->rebuilder.get()) {
1110 d->rebuilder.reset(new RebuildThread(this));
1111 d->rebuilder->start();
1114 // poll the rebuild thread
1115 bool fin = d->rebuilder->isFinished();
1117 d->rebuilder.reset(); // all done!
1122 void NavDataCache::doRebuild()
1126 d->runSQL("DELETE FROM positioned");
1127 d->runSQL("DELETE FROM airport");
1128 d->runSQL("DELETE FROM runway");
1129 d->runSQL("DELETE FROM navaid");
1130 d->runSQL("DELETE FROM comm");
1131 d->runSQL("DELETE FROM octree");
1132 d->runSQL("DELETE FROM airway");
1133 d->runSQL("DELETE FROM airway_edge");
1135 // initialise the root octree node
1136 d->runSQL("INSERT INTO octree (rowid, children) VALUES (1, 0)");
1141 airportDBLoad(d->aptDatPath);
1142 SG_LOG(SG_NAVCACHE, SG_INFO, "apt.dat load took:" << st.elapsedMSec());
1144 metarDataLoad(d->metarDatPath);
1145 stampCacheFile(d->aptDatPath);
1146 stampCacheFile(d->metarDatPath);
1149 loadFixes(d->fixDatPath);
1150 stampCacheFile(d->fixDatPath);
1151 SG_LOG(SG_NAVCACHE, SG_INFO, "fix.dat load took:" << st.elapsedMSec());
1154 navDBInit(d->navDatPath);
1155 stampCacheFile(d->navDatPath);
1156 SG_LOG(SG_NAVCACHE, SG_INFO, "nav.dat load took:" << st.elapsedMSec());
1158 loadCarrierNav(d->carrierDatPath);
1159 stampCacheFile(d->carrierDatPath);
1162 Airway::load(d->airwayDatPath);
1163 stampCacheFile(d->airwayDatPath);
1164 SG_LOG(SG_NAVCACHE, SG_INFO, "awy.dat load took:" << st.elapsedMSec());
1166 d->flushDeferredOctreeUpdates();
1168 d->runSQL("COMMIT");
1169 } catch (sg_exception& e) {
1170 SG_LOG(SG_NAVCACHE, SG_ALERT, "caught exception rebuilding navCache:" << e.what());
1171 // abandon the DB transation completely
1172 d->runSQL("ROLLBACK");
1176 int NavDataCache::readIntProperty(const string& key)
1178 d->reset(d->readPropertyQuery);
1179 sqlite_bind_stdstring(d->readPropertyQuery, 1, key);
1181 if (d->execSelect(d->readPropertyQuery)) {
1182 return sqlite3_column_int(d->readPropertyQuery, 0);
1184 SG_LOG(SG_NAVCACHE, SG_WARN, "readIntProperty: unknown:" << key);
1185 return 0; // no such property
1189 double NavDataCache::readDoubleProperty(const string& key)
1191 d->reset(d->readPropertyQuery);
1192 sqlite_bind_stdstring(d->readPropertyQuery, 1, key);
1193 if (d->execSelect(d->readPropertyQuery)) {
1194 return sqlite3_column_double(d->readPropertyQuery, 0);
1196 SG_LOG(SG_NAVCACHE, SG_WARN, "readDoubleProperty: unknown:" << key);
1197 return 0.0; // no such property
1201 string NavDataCache::readStringProperty(const string& key)
1203 d->reset(d->readPropertyQuery);
1204 sqlite_bind_stdstring(d->readPropertyQuery, 1, key);
1205 if (d->execSelect(d->readPropertyQuery)) {
1206 return (char*) sqlite3_column_text(d->readPropertyQuery, 0);
1208 SG_LOG(SG_NAVCACHE, SG_WARN, "readStringProperty: unknown:" << key);
1209 return string(); // no such property
1213 void NavDataCache::writeIntProperty(const string& key, int value)
1215 d->writeIntProperty(key, value);
1218 void NavDataCache::writeStringProperty(const string& key, const string& value)
1220 d->reset(d->writePropertyQuery);
1221 sqlite_bind_stdstring(d->writePropertyQuery, 1, key);
1222 sqlite_bind_stdstring(d->writePropertyQuery, 2, value);
1223 d->execSelect(d->writePropertyQuery);
1226 void NavDataCache::writeDoubleProperty(const string& key, const double& value)
1228 d->reset(d->writePropertyQuery);
1229 sqlite_bind_stdstring(d->writePropertyQuery, 1, key);
1230 sqlite3_bind_double(d->writePropertyQuery, 2, value);
1231 d->execSelect(d->writePropertyQuery);
1234 string_list NavDataCache::readStringListProperty(const string& key)
1236 d->reset(d->readPropertyQuery);
1237 sqlite_bind_stdstring(d->readPropertyQuery, 1, key);
1239 while (d->stepSelect(d->readPropertyQuery)) {
1240 result.push_back((char*) sqlite3_column_text(d->readPropertyQuery, 0));
1246 void NavDataCache::writeStringListProperty(const string& key, const string_list& values)
1248 d->reset(d->clearProperty);
1249 sqlite_bind_stdstring(d->clearProperty, 1, key);
1250 d->execUpdate(d->clearProperty);
1252 BOOST_FOREACH(string value, values) {
1253 d->reset(d->writePropertyMulti);
1254 sqlite_bind_stdstring(d->writePropertyMulti, 1, key);
1255 sqlite_bind_stdstring(d->writePropertyMulti, 2, value);
1256 d->execInsert(d->writePropertyMulti);
1260 bool NavDataCache::isCachedFileModified(const SGPath& path) const
1262 if (!path.exists()) {
1263 throw sg_io_exception("isCachedFileModified: Missing file:" + path.str());
1266 d->reset(d->statCacheCheck);
1267 sqlite_bind_temp_stdstring(d->statCacheCheck, 1, path.str());
1268 if (d->execSelect(d->statCacheCheck)) {
1269 time_t modtime = sqlite3_column_int64(d->statCacheCheck, 0);
1270 return (modtime != path.modTime());
1276 void NavDataCache::stampCacheFile(const SGPath& path)
1278 d->reset(d->stampFileCache);
1279 sqlite_bind_temp_stdstring(d->stampFileCache, 1, path.str());
1280 sqlite3_bind_int64(d->stampFileCache, 2, path.modTime());
1281 d->execInsert(d->stampFileCache);
1284 void NavDataCache::beginTransaction()
1289 void NavDataCache::commitTransaction()
1291 d->runSQL("COMMIT");
1294 void NavDataCache::abortTransaction()
1296 d->runSQL("ROLLBACK");
1299 FGPositioned* NavDataCache::loadById(PositionedID rowid)
1305 PositionedCache::iterator it = d->cache.find(rowid);
1306 if (it != d->cache.end()) {
1308 return it->second; // cache it
1311 d->reset(d->loadPositioned);
1312 sqlite3_bind_int64(d->loadPositioned, 1, rowid);
1313 FGPositioned* pos = d->loadFromStmt(d->loadPositioned);
1315 d->cache.insert(it, PositionedCache::value_type(rowid, pos));
1321 PositionedID NavDataCache::insertAirport(FGPositioned::Type ty, const string& ident,
1324 // airports have their pos computed based on the avergae runway centres
1325 // so the pos isn't available immediately. Pass a dummy pos and avoid
1326 // doing spatial indexing until later
1327 sqlite3_int64 rowId = d->insertPositioned(ty, ident, name, SGGeod(),
1329 false /* spatial index */);
1331 d->reset(d->insertAirport);
1332 sqlite3_bind_int64(d->insertAirport, 1, rowId);
1333 d->execInsert(d->insertAirport);
1338 void NavDataCache::updatePosition(PositionedID item, const SGGeod &pos)
1340 if (d->cache.find(item) != d->cache.end()) {
1341 SG_LOG(SG_GENERAL, SG_DEBUG, "updating position of an item in the cache");
1342 d->cache[item]->modifyPosition(pos);
1345 SGVec3d cartPos(SGVec3d::fromGeod(pos));
1347 d->reset(d->setAirportPos);
1348 sqlite3_bind_int(d->setAirportPos, 1, item);
1349 sqlite3_bind_double(d->setAirportPos, 2, pos.getLongitudeDeg());
1350 sqlite3_bind_double(d->setAirportPos, 3, pos.getLatitudeDeg());
1351 sqlite3_bind_double(d->setAirportPos, 4, pos.getElevationM());
1353 Octree::Leaf* octreeLeaf = Octree::global_spatialOctree->findLeafForPos(cartPos);
1354 sqlite3_bind_int64(d->setAirportPos, 5, octreeLeaf->guid());
1356 sqlite3_bind_double(d->setAirportPos, 6, cartPos.x());
1357 sqlite3_bind_double(d->setAirportPos, 7, cartPos.y());
1358 sqlite3_bind_double(d->setAirportPos, 8, cartPos.z());
1361 d->execUpdate(d->setAirportPos);
1364 void NavDataCache::insertTower(PositionedID airportId, const SGGeod& pos)
1366 d->insertPositioned(FGPositioned::TOWER, string(), string(),
1367 pos, airportId, true /* spatial index */);
1371 NavDataCache::insertRunway(FGPositioned::Type ty, const string& ident,
1372 const SGGeod& pos, PositionedID apt,
1373 double heading, double length, double width, double displacedThreshold,
1374 double stopway, int surfaceCode)
1376 // only runways are spatially indexed; don't bother indexing taxiways
1378 bool spatialIndex = (ty == FGPositioned::RUNWAY);
1380 sqlite3_int64 rowId = d->insertPositioned(ty, cleanRunwayNo(ident), "", pos, apt,
1382 d->reset(d->insertRunway);
1383 sqlite3_bind_int64(d->insertRunway, 1, rowId);
1384 sqlite3_bind_double(d->insertRunway, 2, heading);
1385 sqlite3_bind_double(d->insertRunway, 3, length);
1386 sqlite3_bind_double(d->insertRunway, 4, width);
1387 sqlite3_bind_int(d->insertRunway, 5, surfaceCode);
1388 sqlite3_bind_double(d->insertRunway, 6, displacedThreshold);
1389 sqlite3_bind_double(d->insertRunway, 7, stopway);
1391 return d->execInsert(d->insertRunway);
1394 void NavDataCache::setRunwayReciprocal(PositionedID runway, PositionedID recip)
1396 d->reset(d->setRunwayReciprocal);
1397 sqlite3_bind_int64(d->setRunwayReciprocal, 1, runway);
1398 sqlite3_bind_int64(d->setRunwayReciprocal, 2, recip);
1399 d->execUpdate(d->setRunwayReciprocal);
1401 // and the opposite direction too!
1402 d->reset(d->setRunwayReciprocal);
1403 sqlite3_bind_int64(d->setRunwayReciprocal, 2, runway);
1404 sqlite3_bind_int64(d->setRunwayReciprocal, 1, recip);
1405 d->execUpdate(d->setRunwayReciprocal);
1408 void NavDataCache::setRunwayILS(PositionedID runway, PositionedID ils)
1410 d->reset(d->setRunwayILS);
1411 sqlite3_bind_int64(d->setRunwayILS, 1, runway);
1412 sqlite3_bind_int64(d->setRunwayILS, 2, ils);
1413 d->execUpdate(d->setRunwayILS);
1416 void NavDataCache::updateRunwayThreshold(PositionedID runwayID, const SGGeod &aThreshold,
1417 double aHeading, double aDisplacedThreshold,
1420 // update the runway information
1421 d->reset(d->updateRunwayThreshold);
1422 sqlite3_bind_int64(d->updateRunwayThreshold, 1, runwayID);
1423 sqlite3_bind_double(d->updateRunwayThreshold, 2, aHeading);
1424 sqlite3_bind_double(d->updateRunwayThreshold, 3, aDisplacedThreshold);
1425 sqlite3_bind_double(d->updateRunwayThreshold, 4, aStopway);
1426 d->execUpdate(d->updateRunwayThreshold);
1428 // compute the new runway center, based on the threshold lat/lon and length,
1429 double offsetFt = (0.5 * d->runwayLengthFt(runwayID));
1432 SGGeodesy::direct(aThreshold, aHeading, offsetFt * SG_FEET_TO_METER, newCenter, dummy);
1434 // now update the positional data
1435 updatePosition(runwayID, newCenter);
1439 NavDataCache::insertNavaid(FGPositioned::Type ty, const string& ident,
1440 const string& name, const SGGeod& pos,
1441 int freq, int range, double multiuse,
1442 PositionedID apt, PositionedID runway)
1444 bool spatialIndex = true;
1445 if (ty == FGPositioned::MOBILE_TACAN) {
1446 spatialIndex = false;
1449 sqlite3_int64 rowId = d->insertPositioned(ty, ident, name, pos, apt,
1451 d->reset(d->insertNavaid);
1452 sqlite3_bind_int64(d->insertNavaid, 1, rowId);
1453 sqlite3_bind_int(d->insertNavaid, 2, freq);
1454 sqlite3_bind_int(d->insertNavaid, 3, range);
1455 sqlite3_bind_double(d->insertNavaid, 4, multiuse);
1456 sqlite3_bind_int64(d->insertNavaid, 5, runway);
1457 return d->execInsert(d->insertNavaid);
1460 void NavDataCache::updateILS(PositionedID ils, const SGGeod& newPos, double aHdg)
1462 d->reset(d->updateILS);
1463 sqlite3_bind_int64(d->updateILS, 1, ils);
1464 sqlite3_bind_double(d->updateILS, 2, aHdg);
1465 d->execUpdate(d->updateILS);
1466 updatePosition(ils, newPos);
1469 PositionedID NavDataCache::insertCommStation(FGPositioned::Type ty,
1470 const string& name, const SGGeod& pos, int freq, int range,
1473 sqlite3_int64 rowId = d->insertPositioned(ty, "", name, pos, apt, true);
1474 d->reset(d->insertCommStation);
1475 sqlite3_bind_int64(d->insertCommStation, 1, rowId);
1476 sqlite3_bind_int(d->insertCommStation, 2, freq);
1477 sqlite3_bind_int(d->insertCommStation, 3, range);
1478 return d->execInsert(d->insertCommStation);
1481 PositionedID NavDataCache::insertFix(const std::string& ident, const SGGeod& aPos)
1483 return d->insertPositioned(FGPositioned::FIX, ident, string(), aPos, 0, true);
1486 PositionedID NavDataCache::createUserWaypoint(const std::string& ident, const SGGeod& aPos)
1488 return d->insertPositioned(FGPositioned::WAYPOINT, ident, string(), aPos, 0,
1489 true /* spatial index */);
1492 void NavDataCache::setAirportMetar(const string& icao, bool hasMetar)
1494 d->reset(d->setAirportMetar);
1495 sqlite_bind_stdstring(d->setAirportMetar, 1, icao);
1496 sqlite3_bind_int(d->setAirportMetar, 2, hasMetar);
1497 d->execUpdate(d->setAirportMetar);
1500 FGPositioned::List NavDataCache::findAllWithIdent(const string& s,
1501 FGPositioned::Filter* filter, bool exact)
1503 return d->findAllByString(s, "ident", filter, exact);
1506 FGPositioned::List NavDataCache::findAllWithName(const string& s,
1507 FGPositioned::Filter* filter, bool exact)
1509 return d->findAllByString(s, "name", filter, exact);
1512 FGPositionedRef NavDataCache::findClosestWithIdent(const string& aIdent,
1513 const SGGeod& aPos, FGPositioned::Filter* aFilter)
1515 d->reset(d->findClosestWithIdent);
1516 sqlite_bind_stdstring(d->findClosestWithIdent, 1, aIdent);
1518 sqlite3_bind_int(d->findClosestWithIdent, 2, aFilter->minType());
1519 sqlite3_bind_int(d->findClosestWithIdent, 3, aFilter->maxType());
1520 } else { // full type range
1521 sqlite3_bind_int(d->findClosestWithIdent, 2, FGPositioned::INVALID);
1522 sqlite3_bind_int(d->findClosestWithIdent, 3, FGPositioned::LAST_TYPE);
1525 SGVec3d cartPos(SGVec3d::fromGeod(aPos));
1526 sqlite3_bind_double(d->findClosestWithIdent, 4, cartPos.x());
1527 sqlite3_bind_double(d->findClosestWithIdent, 5, cartPos.y());
1528 sqlite3_bind_double(d->findClosestWithIdent, 6, cartPos.z());
1530 while (d->stepSelect(d->findClosestWithIdent)) {
1531 FGPositioned* pos = loadById(sqlite3_column_int64(d->findClosestWithIdent, 0));
1532 if (aFilter && !aFilter->pass(pos)) {
1539 return NULL; // no matches at all
1543 int NavDataCache::getOctreeBranchChildren(int64_t octreeNodeId)
1545 d->reset(d->getOctreeChildren);
1546 sqlite3_bind_int64(d->getOctreeChildren, 1, octreeNodeId);
1547 d->execSelect1(d->getOctreeChildren);
1548 return sqlite3_column_int(d->getOctreeChildren, 0);
1551 void NavDataCache::defineOctreeNode(Octree::Branch* pr, Octree::Node* nd)
1553 d->reset(d->insertOctree);
1554 sqlite3_bind_int64(d->insertOctree, 1, nd->guid());
1555 d->execInsert(d->insertOctree);
1557 #ifdef LAZY_OCTREE_UPDATES
1558 d->deferredOctreeUpdates.insert(pr);
1560 // lowest three bits of node ID are 0..7 index of the child in the parent
1561 int childIndex = nd->guid() & 0x07;
1563 d->reset(d->updateOctreeChildren);
1564 sqlite3_bind_int64(d->updateOctreeChildren, 1, pr->guid());
1565 // mask has bit N set where child N exists
1566 int childMask = 1 << childIndex;
1567 sqlite3_bind_int(d->updateOctreeChildren, 2, childMask);
1568 d->execUpdate(d->updateOctreeChildren);
1573 NavDataCache::getOctreeLeafChildren(int64_t octreeNodeId)
1575 d->reset(d->getOctreeLeafChildren);
1576 sqlite3_bind_int64(d->getOctreeLeafChildren, 1, octreeNodeId);
1578 TypedPositionedVec r;
1579 while (d->stepSelect(d->getOctreeLeafChildren)) {
1580 FGPositioned::Type ty = static_cast<FGPositioned::Type>
1581 (sqlite3_column_int(d->getOctreeLeafChildren, 1));
1582 r.push_back(std::make_pair(ty,
1583 sqlite3_column_int64(d->getOctreeLeafChildren, 0)));
1591 * A special purpose helper (used by FGAirport::searchNamesAndIdents) to
1592 * implement the AirportList dialog. It's unfortunate that it needs to reside
1593 * here, but for now it's least ugly solution.
1595 char** NavDataCache::searchAirportNamesAndIdents(const std::string& aFilter)
1597 d->reset(d->searchAirports);
1598 string s = "%" + aFilter + "%";
1599 sqlite_bind_stdstring(d->searchAirports, 1, s);
1601 unsigned int numMatches = 0, numAllocated = 16;
1602 char** result = (char**) malloc(sizeof(char*) * numAllocated);
1604 while (d->stepSelect(d->searchAirports)) {
1605 if ((numMatches + 1) >= numAllocated) {
1606 numAllocated <<= 1; // double in size!
1607 // reallocate results array
1608 char** nresult = (char**) malloc(sizeof(char*) * numAllocated);
1609 memcpy(nresult, result, sizeof(char*) * numMatches);
1614 // nasty code to avoid excessive string copying and allocations.
1615 // We format results as follows (note whitespace!):
1616 // ' name-of-airport-chars (ident)'
1617 // so the total length is:
1618 // 1 + strlen(name) + 4 + strlen(icao) + 1 + 1 (for the null)
1619 // which gives a grand total of 7 + name-length + icao-length.
1620 // note the ident can be three letters (non-ICAO local strip), four
1621 // (default ICAO) or more (extended format ICAO)
1622 int nameLength = sqlite3_column_bytes(d->searchAirports, 1);
1623 int icaoLength = sqlite3_column_bytes(d->searchAirports, 0);
1624 char* entry = (char*) malloc(7 + nameLength + icaoLength);
1627 memcpy(dst, sqlite3_column_text(d->searchAirports, 1), nameLength);
1633 memcpy(dst, sqlite3_column_text(d->searchAirports, 0), icaoLength);
1638 result[numMatches++] = entry;
1641 result[numMatches] = NULL; // end of list marker
1646 NavDataCache::findCommByFreq(int freqKhz, const SGGeod& aPos, FGPositioned::Filter* aFilter)
1648 d->reset(d->findCommByFreq);
1649 sqlite3_bind_int(d->findCommByFreq, 1, freqKhz);
1651 sqlite3_bind_int(d->findCommByFreq, 2, aFilter->minType());
1652 sqlite3_bind_int(d->findCommByFreq, 3, aFilter->maxType());
1653 } else { // full type range
1654 sqlite3_bind_int(d->findCommByFreq, 2, FGPositioned::FREQ_GROUND);
1655 sqlite3_bind_int(d->findCommByFreq, 3, FGPositioned::FREQ_UNICOM);
1658 SGVec3d cartPos(SGVec3d::fromGeod(aPos));
1659 sqlite3_bind_double(d->findCommByFreq, 4, cartPos.x());
1660 sqlite3_bind_double(d->findCommByFreq, 5, cartPos.y());
1661 sqlite3_bind_double(d->findCommByFreq, 6, cartPos.z());
1663 while (d->execSelect(d->findCommByFreq)) {
1664 FGPositioned* p = loadById(sqlite3_column_int64(d->findCommByFreq, 0));
1665 if (aFilter && !aFilter->pass(p)) {
1676 NavDataCache::findNavaidsByFreq(int freqKhz, const SGGeod& aPos, FGPositioned::Filter* aFilter)
1678 d->reset(d->findNavsByFreq);
1679 sqlite3_bind_int(d->findNavsByFreq, 1, freqKhz);
1681 sqlite3_bind_int(d->findNavsByFreq, 2, aFilter->minType());
1682 sqlite3_bind_int(d->findNavsByFreq, 3, aFilter->maxType());
1683 } else { // full type range
1684 sqlite3_bind_int(d->findNavsByFreq, 2, FGPositioned::NDB);
1685 sqlite3_bind_int(d->findNavsByFreq, 3, FGPositioned::GS);
1688 SGVec3d cartPos(SGVec3d::fromGeod(aPos));
1689 sqlite3_bind_double(d->findNavsByFreq, 4, cartPos.x());
1690 sqlite3_bind_double(d->findNavsByFreq, 5, cartPos.y());
1691 sqlite3_bind_double(d->findNavsByFreq, 6, cartPos.z());
1693 return d->selectIds(d->findNavsByFreq);
1697 NavDataCache::findNavaidsByFreq(int freqKhz, FGPositioned::Filter* aFilter)
1699 d->reset(d->findNavsByFreqNoPos);
1700 sqlite3_bind_int(d->findNavsByFreqNoPos, 1, freqKhz);
1702 sqlite3_bind_int(d->findNavsByFreqNoPos, 2, aFilter->minType());
1703 sqlite3_bind_int(d->findNavsByFreqNoPos, 3, aFilter->maxType());
1704 } else { // full type range
1705 sqlite3_bind_int(d->findNavsByFreqNoPos, 2, FGPositioned::NDB);
1706 sqlite3_bind_int(d->findNavsByFreqNoPos, 3, FGPositioned::GS);
1709 return d->selectIds(d->findNavsByFreqNoPos);
1713 NavDataCache::airportItemsOfType(PositionedID apt,FGPositioned::Type ty,
1714 FGPositioned::Type maxTy)
1716 if (maxTy == FGPositioned::INVALID) {
1717 maxTy = ty; // single-type range
1720 d->reset(d->getAirportItems);
1721 sqlite3_bind_int64(d->getAirportItems, 1, apt);
1722 sqlite3_bind_int(d->getAirportItems, 2, ty);
1723 sqlite3_bind_int(d->getAirportItems, 3, maxTy);
1725 return d->selectIds(d->getAirportItems);
1729 NavDataCache::airportItemWithIdent(PositionedID apt, FGPositioned::Type ty,
1730 const std::string& ident)
1732 d->reset(d->getAirportItemByIdent);
1733 sqlite3_bind_int64(d->getAirportItemByIdent, 1, apt);
1734 sqlite_bind_stdstring(d->getAirportItemByIdent, 2, ident);
1735 sqlite3_bind_int(d->getAirportItemByIdent, 3, ty);
1737 if (!d->execSelect(d->getAirportItemByIdent)) {
1741 return sqlite3_column_int64(d->getAirportItemByIdent, 0);
1745 NavDataCache::findAirportRunway(const std::string& aName)
1747 if (aName.empty()) {
1748 return AirportRunwayPair();
1751 string_list parts = simgear::strutils::split(aName);
1752 if (parts.size() < 2) {
1753 SG_LOG(SG_NAVCACHE, SG_WARN, "findAirportRunway: malformed name:" << aName);
1754 return AirportRunwayPair();
1757 d->reset(d->findAirportRunway);
1758 sqlite_bind_stdstring(d->findAirportRunway, 1, parts[0]);
1759 sqlite_bind_stdstring(d->findAirportRunway, 2, parts[1]);
1760 if (!d->execSelect(d->findAirportRunway)) {
1761 SG_LOG(SG_NAVCACHE, SG_WARN, "findAirportRunway: unknown airport/runway:" << aName);
1762 return AirportRunwayPair();
1765 // success, extract the IDs and continue
1766 return AirportRunwayPair(sqlite3_column_int64(d->findAirportRunway, 0),
1767 sqlite3_column_int64(d->findAirportRunway, 1));
1771 NavDataCache::findILS(PositionedID airport, const string& runway, const string& navIdent)
1773 d->reset(d->findILS);
1774 sqlite_bind_stdstring(d->findILS, 1, navIdent);
1775 sqlite3_bind_int64(d->findILS, 2, airport);
1776 sqlite_bind_stdstring(d->findILS, 3, runway);
1778 if (!d->execSelect(d->findILS)) {
1782 return sqlite3_column_int64(d->findILS, 0);
1785 int NavDataCache::findAirway(int network, const string& aName)
1787 d->reset(d->findAirway);
1788 sqlite3_bind_int(d->findAirway, 1, network);
1789 sqlite_bind_stdstring(d->findAirway, 2, aName);
1790 if (d->execSelect(d->findAirway)) {
1792 return sqlite3_column_int(d->findAirway, 0);
1795 d->reset(d->insertAirway);
1796 sqlite_bind_stdstring(d->insertAirway, 1, aName);
1797 sqlite3_bind_int(d->insertAirway, 2, network);
1798 return d->execInsert(d->insertAirway);
1801 void NavDataCache::insertEdge(int network, int airwayID, PositionedID from, PositionedID to)
1803 // assume all edges are bidirectional for the moment
1804 for (int i=0; i<2; ++i) {
1805 d->reset(d->insertAirwayEdge);
1806 sqlite3_bind_int(d->insertAirwayEdge, 1, network);
1807 sqlite3_bind_int(d->insertAirwayEdge, 2, airwayID);
1808 sqlite3_bind_int64(d->insertAirwayEdge, 3, from);
1809 sqlite3_bind_int64(d->insertAirwayEdge, 4, to);
1810 d->execInsert(d->insertAirwayEdge);
1812 std::swap(from, to);
1816 bool NavDataCache::isInAirwayNetwork(int network, PositionedID pos)
1818 d->reset(d->isPosInAirway);
1819 sqlite3_bind_int(d->isPosInAirway, 1, network);
1820 sqlite3_bind_int64(d->isPosInAirway, 2, pos);
1821 bool ok = d->execSelect(d->isPosInAirway);
1825 AirwayEdgeVec NavDataCache::airwayEdgesFrom(int network, PositionedID pos)
1827 d->reset(d->airwayEdgesFrom);
1828 sqlite3_bind_int(d->airwayEdgesFrom, 1, network);
1829 sqlite3_bind_int64(d->airwayEdgesFrom, 2, pos);
1831 AirwayEdgeVec result;
1832 while (d->stepSelect(d->airwayEdgesFrom)) {
1833 result.push_back(AirwayEdge(
1834 sqlite3_column_int(d->airwayEdgesFrom, 0),
1835 sqlite3_column_int64(d->airwayEdgesFrom, 1)
1841 PositionedID NavDataCache::findNavaidForRunway(PositionedID runway, FGPositioned::Type ty)
1843 d->reset(d->findNavaidForRunway);
1844 sqlite3_bind_int64(d->findNavaidForRunway, 1, runway);
1845 sqlite3_bind_int(d->findNavaidForRunway, 2, ty);
1846 if (!d->execSelect(d->findNavaidForRunway)) {
1850 return sqlite3_column_int64(d->findNavaidForRunway, 0);
1854 NavDataCache::insertParking(const std::string& name, const SGGeod& aPos,
1855 PositionedID aAirport,
1856 double aHeading, int aRadius, const std::string& aAircraftType,
1857 const std::string& aAirlines)
1859 sqlite3_int64 rowId = d->insertPositioned(FGPositioned::PARKING, name, "", aPos, aAirport, false);
1861 // we need to insert a row into the taxi_node table, otherwise we can't maintain
1862 // the appropriate pushback flag.
1863 d->reset(d->insertTaxiNode);
1864 sqlite3_bind_int64(d->insertTaxiNode, 1, rowId);
1865 sqlite3_bind_int(d->insertTaxiNode, 2, 0);
1866 sqlite3_bind_int(d->insertTaxiNode, 3, 0);
1867 d->execInsert(d->insertTaxiNode);
1869 d->reset(d->insertParkingPos);
1870 sqlite3_bind_int64(d->insertParkingPos, 1, rowId);
1871 sqlite3_bind_double(d->insertParkingPos, 2, aHeading);
1872 sqlite3_bind_int(d->insertParkingPos, 3, aRadius);
1873 sqlite_bind_stdstring(d->insertParkingPos, 4, aAircraftType);
1874 sqlite_bind_stdstring(d->insertParkingPos, 5, aAirlines);
1875 return d->execInsert(d->insertParkingPos);
1878 void NavDataCache::setParkingPushBackRoute(PositionedID parking, PositionedID pushBackNode)
1880 d->reset(d->setParkingPushBack);
1881 sqlite3_bind_int64(d->setParkingPushBack, 1, parking);
1882 sqlite3_bind_int64(d->setParkingPushBack, 2, pushBackNode);
1883 d->execUpdate(d->setParkingPushBack);
1887 NavDataCache::insertTaxiNode(const SGGeod& aPos, PositionedID aAirport, int aHoldType, bool aOnRunway)
1889 sqlite3_int64 rowId = d->insertPositioned(FGPositioned::TAXI_NODE, string(), string(), aPos, aAirport, false);
1890 d->reset(d->insertTaxiNode);
1891 sqlite3_bind_int64(d->insertTaxiNode, 1, rowId);
1892 sqlite3_bind_int(d->insertTaxiNode, 2, aHoldType);
1893 sqlite3_bind_int(d->insertTaxiNode, 3, aOnRunway);
1894 return d->execInsert(d->insertTaxiNode);
1897 void NavDataCache::insertGroundnetEdge(PositionedID aAirport, PositionedID from, PositionedID to)
1899 d->reset(d->insertTaxiEdge);
1900 sqlite3_bind_int64(d->insertTaxiEdge, 1, aAirport);
1901 sqlite3_bind_int64(d->insertTaxiEdge, 2, from);
1902 sqlite3_bind_int64(d->insertTaxiEdge, 3, to);
1903 d->execInsert(d->insertTaxiEdge);
1906 PositionedIDVec NavDataCache::groundNetNodes(PositionedID aAirport, bool onlyPushback)
1908 sqlite3_stmt_ptr q = onlyPushback ? d->airportPushbackNodes : d->airportTaxiNodes;
1910 sqlite3_bind_int64(q, 1, aAirport);
1911 return d->selectIds(q);
1914 void NavDataCache::markGroundnetAsPushback(PositionedID nodeId)
1916 d->reset(d->markTaxiNodeAsPushback);
1917 sqlite3_bind_int64(d->markTaxiNodeAsPushback, 1, nodeId);
1918 d->execUpdate(d->markTaxiNodeAsPushback);
1921 static double headingDifferenceDeg(double crs1, double crs2)
1923 double diff = crs2 - crs1;
1924 SG_NORMALIZE_RANGE(diff, -180.0, 180.0);
1928 PositionedID NavDataCache::findGroundNetNode(PositionedID airport, const SGGeod& aPos,
1929 bool onRunway, FGRunway* aRunway)
1931 sqlite3_stmt_ptr q = onRunway ? d->findNearestRunwayTaxiNode : d->findNearestTaxiNode;
1933 sqlite3_bind_int64(q, 1, airport);
1935 SGVec3d cartPos(SGVec3d::fromGeod(aPos));
1936 sqlite3_bind_double(q, 2, cartPos.x());
1937 sqlite3_bind_double(q, 3, cartPos.y());
1938 sqlite3_bind_double(q, 4, cartPos.z());
1940 while (d->execSelect(q)) {
1941 PositionedID id = sqlite3_column_int64(q, 0);
1946 // ensure found node lies on the runway
1947 FGPositionedRef node = loadById(id);
1948 double course = SGGeodesy::courseDeg(node->geod(), aRunway->end());
1949 if (fabs(headingDifferenceDeg(course, aRunway->headingDeg())) < 3.0 ) {
1957 PositionedIDVec NavDataCache::groundNetEdgesFrom(PositionedID pos, bool onlyPushback)
1959 sqlite3_stmt_ptr q = onlyPushback ? d->pushbackEdgesFrom : d->taxiEdgesFrom;
1961 sqlite3_bind_int64(q, 1, pos);
1962 return d->selectIds(q);
1965 PositionedIDVec NavDataCache::findAirportParking(PositionedID airport, const std::string& flightType,
1968 d->reset(d->findAirportParking);
1969 sqlite3_bind_int64(d->findAirportParking, 1, airport);
1970 sqlite3_bind_int(d->findAirportParking, 2, radius);
1971 sqlite_bind_stdstring(d->findAirportParking, 3, flightType);
1973 return d->selectIds(d->findAirportParking);
1976 } // of namespace flightgear