feat: support use of bundled navigation data

Author: pepperoni505

README.md

@@ -30,6 +30,14 @@ Here's an overview on the structure of this repository, which is designed to be
    ```
    - Note that if you already have a `VCockpit` with `NO_TEXTURE` you can just add another `htmlgauge` to it, while making sure to increase the index
 
+## Dealing with Bundled Navigation Data
+
+If you bundle outdated navigation data in your aircraft and you want this module to handle updating it for users with subscriptions, place the navigation data into the `NavigationData` directory in `PackageSources`. You can see an example [here](examples/aircraft/PackageSources/NavigationData/)
+
+## Where is the Navigation Data Stored?
+
+The default location for navigation data is `work/NavigationData`. If you have bundled navigation data, its located in the `NavigationData` folder in the root of your project. You can use the `GetActiveDatabasePath` function from the interface to find the most up to date version installed.
+
 ## Building the Sample Aircraft
 
 Before building, make sure you have properly created and set an `.env` file in `src/gauge`! An example can be found in the `.env.example` file in that directory. Replace with your credentials

examples/aircraft/PackageDefinitions/navigraph-aircraft-navigation-data-interface-sample.xml

@@ -43,6 +43,14 @@
 			<AssetDir>PackageSources\html_ui\</AssetDir>
 			<OutputDir>html_ui\</OutputDir>
 		</AssetGroup>
+		<AssetGroup Name="NavigationData">
+			<Type>Copy</Type>
+			<Flags>
+				<FSXCompatibility>false</FSXCompatibility>
+			</Flags>
+			<AssetDir>PackageSources\NavigationData\</AssetDir>
+			<OutputDir>NavigationData\</OutputDir>
+		</AssetGroup>
 	</AssetGroups>
 </AssetPackage>
 

examples/aircraft/PackageSources/NavigationData/outdated-cycle/coolfolder/anotherfile.txt

@@ -0,0 +1 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

examples/aircraft/PackageSources/NavigationData/outdated-cycle/coolfolder/coolfolder2/finalfile.txt

@@ -0,0 +1 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

examples/aircraft/PackageSources/NavigationData/outdated-cycle/myawesomefile.txt

@@ -0,0 +1 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

examples/gauge/Components/InterfaceSample.tsx

@@ -22,7 +22,6 @@ export class InterfaceSample extends DisplayComponent<InterfaceSampleProps> {
   private readonly dropdownRef = FSComponent.createRef<Dropdown>()
   private readonly downloadButtonRef = FSComponent.createRef<HTMLButtonElement>()
   private readonly executeButtonRef = FSComponent.createRef<HTMLButtonElement>()
-  private readonly setActiveButtonRef = FSComponent.createRef<HTMLButtonElement>()
   private readonly inputRef = FSComponent.createRef<HTMLInputElement>()
 
   private cancelSource = CancelToken.source()
@@ -69,9 +68,6 @@ export class InterfaceSample extends DisplayComponent<InterfaceSampleProps> {
             <div ref={this.downloadButtonRef} class="button">
               Download
             </div>
-            <div ref={this.setActiveButtonRef} class="button">
-              Set as Active
-            </div>
             <input ref={this.inputRef} type="text" id="sql" name="sql" value="ESSA" class="text-field" />
             <div ref={this.executeButtonRef} class="button">
               Execute SQL
@@ -103,16 +99,6 @@ export class InterfaceSample extends DisplayComponent<InterfaceSampleProps> {
         .catch(e => console.error(e))
     })
 
-    this.setActiveButtonRef.instance.addEventListener("click", () => {
-      const format = this.dropdownRef.instance.getNavigationDataFormat()
-      if (!format) return
-      // This will only work if the database specified is a SQLite database
-      this.navigationDataInterface
-        .set_active_database(format)
-        .then(() => console.info("WASM set active database"))
-        .catch(err => this.displayError(String(err)))
-    })
-
     AuthService.user.sub(user => {
       if (user) {
         this.qrCodeRef.instance.src = ""
@@ -173,7 +159,7 @@ export class InterfaceSample extends DisplayComponent<InterfaceSampleProps> {
       const pkg = await packages.getPackage(format)
 
       // Download navigation data to work dir
-      await this.navigationDataInterface.download_navigation_data(pkg.file.url, pkg.format)
+      await this.navigationDataInterface.download_navigation_data(pkg.file.url)
       this.displayMessage("Navigation data downloaded")
     } catch (err) {
       if (err instanceof Error) this.displayError(err.message)

src/database/src/database.rs

@@ -27,35 +27,49 @@ use crate::{
         vhf_navaid::VhfNavaid,
         waypoint::Waypoint,
     },
-    sql_structs::{self},
-    util,
+    sql_structs, util,
 };
 
 pub struct Database {
     database: Option<Connection>,
+    pub path: Option<String>,
 }
 
 #[derive(Debug)]
 struct NoDatabaseOpen;
 
 impl Display for NoDatabaseOpen {
-    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { write!(f, "No database open") }
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        write!(f, "No database open")
+    }
 }
 
 impl Error for NoDatabaseOpen {}
 
 impl Database {
-    pub fn new() -> Self { Database { database: None } }
+    pub fn new() -> Self {
+        Database {
+            database: None,
+            path: None,
+        }
+    }
 
-    fn get_database(&self) -> Result<&Connection, NoDatabaseOpen> { self.database.as_ref().ok_or(NoDatabaseOpen) }
+    fn get_database(&self) -> Result<&Connection, NoDatabaseOpen> {
+        self.database.as_ref().ok_or(NoDatabaseOpen)
+    }
 
-    pub fn set_active_database(&mut self, mut path: String) -> Result<(), Box<dyn Error>> {
-        // Check if the path is a directory and if it is, search for a sqlite file
-        let formatted_path = format!("\\work/{}", path);
-        if util::get_path_type(std::path::Path::new(&formatted_path)) == util::PathType::Directory {
-            path = util::find_sqlite_file(&formatted_path)?;
+    pub fn set_active_database(&mut self, path: String) -> Result<(), Box<dyn Error>> {
+        println!("[NAVIGRAPH] Setting active database to {}", path);
+        self.close_connection();
+        if util::is_sqlite_file(&path)? {
+            self.open_connection(path.clone())?;
         }
+        self.path = Some(path);
 
+        Ok(())
+    }
+
+    pub fn open_connection(&mut self, path: String) -> Result<(), Box<dyn Error>> {
         // We have to open with flags because the SQLITE_OPEN_CREATE flag with the default open causes the file to
         // be overwritten
         let flags = OpenFlags::SQLITE_OPEN_READ_WRITE | OpenFlags::SQLITE_OPEN_URI | OpenFlags::SQLITE_OPEN_NO_MUTEX;
@@ -541,5 +555,7 @@ impl Database {
         Ok(data)
     }
 
-    pub fn close_connection(&mut self) { self.database = None; }
+    pub fn close_connection(&mut self) {
+        self.database = None;
+    }
 }

src/database/src/util.rs

@@ -1,4 +1,9 @@
-use std::{fs, io::Read, path::Path};
+use std::{error::Error, fs, io::Read, path::Path};
+
+// From 1.3.1 of https://www.sqlite.org/fileformat.html
+const SQLITE_HEADER: [u8; 16] = [
+    0x53, 0x51, 0x4c, 0x69, 0x74, 0x65, 0x20, 0x66, 0x6f, 0x72, 0x6d, 0x61, 0x74, 0x20, 0x33, 0x00,
+];
 
 #[derive(PartialEq, Eq)]
 pub enum PathType {
@@ -31,27 +36,33 @@ pub fn get_path_type(path: &Path) -> PathType {
     PathType::DoesNotExist
 }
 
-pub fn find_sqlite_file(path: &str) -> Result<String, Box<dyn std::error::Error>> {
-    // From 1.3.1 of https://www.sqlite.org/fileformat.html
-    let sqlite_header = [
-        0x53, 0x51, 0x4c, 0x69, 0x74, 0x65, 0x20, 0x66, 0x6f, 0x72, 0x6d, 0x61, 0x74, 0x20, 0x33, 0x00,
-    ];
+pub fn find_sqlite_file(path: &str) -> Result<String, Box<dyn Error>> {
+    if get_path_type(&Path::new(path)) != PathType::Directory {
+        return Err("Path is not a directory".into());
+    }
+
     // We are going to search this directory for a database
     for entry in std::fs::read_dir(path)? {
         let entry = entry?;
         let path = entry.path();
         if get_path_type(&path) == PathType::File {
             let path = path.to_str().ok_or("Invalid path")?;
-            // Get first 16 bytes of file
-            let mut file = std::fs::File::open(path)?;
-            let mut buf = [0; 16];
-            file.read_exact(buf.as_mut())?;
-            // Compare bytes to sqlite header
-            if buf == sqlite_header {
-                // We found a database
+
+            if is_sqlite_file(path)? {
                 return Ok(path.to_string());
             }
         }
     }
     Err("No SQL database found. Make sure the database specified is a SQL database".into())
 }
+
+pub fn is_sqlite_file(path: &str) -> Result<bool, Box<dyn Error>> {
+    if get_path_type(&Path::new(path)) != PathType::File {
+        return Ok(false);
+    }
+
+    let mut file = fs::File::open(path)?;
+    let mut buf = [0; 16];
+    file.read_exact(&mut buf)?;
+    Ok(buf == SQLITE_HEADER)
+}

src/js/interface/NavigationDataInterfaceTypes.ts

@@ -24,8 +24,8 @@ export interface DownloadProgressData {
 
 export enum NavigraphFunction {
   DownloadNavigationData = "DownloadNavigationData",
+  GetActiveDatabasePath = "GetActiveDatabasePath",
   SetDownloadOptions = "SetDownloadOptions",
-  SetActiveDatabase = "SetActiveDatabase",
   ExecuteSQLQuery = "ExecuteSQLQuery",
   GetDatabaseInfo = "GetDatabaseInfo",
   GetAirport = "GetAirport",

src/js/interface/NavigraphNavigationDataInterface.ts

@@ -69,34 +69,30 @@ export class NavigraphNavigationDataInterface {
    * Downloads the navigation data from the given URL to the given path
    *
    * @param url - A valid signed URL to download the navigation data from
-   * @param path - The path to download the navigation data to
    * @returns A promise that resolves when the download is complete
    */
-  public async download_navigation_data(url: string, path: string): Promise<void> {
-    return await this.callWasmFunction("DownloadNavigationData", { url, path })
+  public async download_navigation_data(url: string): Promise<void> {
+    return await this.callWasmFunction("DownloadNavigationData", { url })
   }
 
   /**
-   * Sets the download options for all future downloads
+   * Gets the currently active database path
    *
-   * @param batchSize - The number of files to delete or unzip each update (default: 10). This is a performance optimization to avoid blocking the main thread for too long.
-   * @returns A promise that resolves when the function is complete
+   * @returns A promise that resolves with the path of the currently active database
    */
-  public async set_download_options(batch_size: number): Promise<void> {
-    return await this.callWasmFunction("SetDownloadOptions", batch_size)
+
+  public async get_active_database_path(): Promise<string> {
+    return await this.callWasmFunction("GetActiveDatabasePath", {})
   }
 
   /**
-   * Sets the active DFD database to the one at the given path
-   *
-   * @remarks
-   * The path must be a valid path to a folder that contains a DFD file.
+   * Sets the download options for all future downloads
    *
-   * @param path - The path to the folder that contains the DFD file
+   * @param batchSize - The number of files to delete or unzip each update (default: 10). This is a performance optimization to avoid blocking the main thread for too long.
    * @returns A promise that resolves when the function is complete
    */
-  public async set_active_database(path: string): Promise<void> {
-    return await this.callWasmFunction("SetActiveDatabase", { path })
+  public async set_download_options(batch_size: number): Promise<void> {
+    return await this.callWasmFunction("SetDownloadOptions", batch_size)
   }
 
   /**