anise 0.9.6

/*
 * ANISE Toolkit
 * Copyright (C) 2021-onward Christopher Rabotin <christopher.rabotin@gmail.com> et al. (cf. AUTHORS.md)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 *
 * Documentation: https://nyxspace.com/
 */

mod metaalmanac;
mod metafile;

pub use metaalmanac::MetaAlmanac;
pub use metafile::MetaFile;

use super::Almanac;

use crate::{
    errors::{AlmanacResult, MetaSnafu},
    prelude::InputOutputError,
};
use snafu::prelude::*;

#[cfg(feature = "python")]
use pyo3::prelude::*;

#[cfg(feature = "python")]
mod python;

#[derive(Debug, PartialEq, Snafu)]
#[snafu(visibility(pub(crate)))]
#[non_exhaustive]
pub enum MetaAlmanacError {
    #[snafu(display("could not create the cache folder for ANISE, please use a relative path"))]
    AppDirError,
    #[snafu(display("could not find a file path in {path}"))]
    MissingFilePath { path: String },
    #[snafu(display("IO error {source} when {what} with {path}"))]
    MetaIO {
        path: String,
        what: &'static str,
        source: InputOutputError,
    },
    #[snafu(display("fetching {uri} returned {error}"))]
    FetchError { error: String, uri: String },
    #[snafu(display("connection {uri} returned {error}"))]
    CnxError { uri: String, error: String },
    #[snafu(display("error parsing `{path}` as Dhall config: {err}"))]
    ParseDhall { path: String, err: String },
    #[snafu(display("error exporting as Dhall config (please file a bug): {err}"))]
    ExportDhall { err: String },
    #[snafu(display(
        "download to {desired} blocked while lock file `{desired}.lock` exists, please delete lock file"
    ))]
    PersistentLock { desired: String },
}

impl Almanac {
    /// Load from the provided MetaFile, downloading it if necessary.
    /// Set autodelete to true to automatically delete lock files. Lock files are important in multi-threaded loads.
    pub fn load_from_metafile(
        self,
        mut metafile: MetaFile,
        autodelete: bool,
    ) -> AlmanacResult<Self> {
        metafile.process(autodelete).context(MetaSnafu {
            fno: 0_usize,
            file: metafile.clone(),
        })?;
        self.load(&metafile.uri)
    }

    /// Saves the current configuration to a MetaAlmanac for future reloading from the local file system.
    ///
    /// WARNING: If data was loaded from its raw bytes, or if a custom alias was used, then the MetaFile produced will not be usable.
    /// The alias used for each data type is expected to be a path. Further, all paths are ASSUMED to be loaded from the same directory.
    /// The Almanac does not resolve directories for you.
    pub fn to_metaalmanac(&self) -> MetaAlmanac {
        MetaAlmanac {
            files: self
                .list_kernels(None, None, None, None, None, None)
                .iter()
                .cloned()
                .map(|path| MetaFile {
                    uri: path,
                    crc32: None,
                })
                .collect::<Vec<MetaFile>>(),
        }
    }
}

#[cfg(feature = "python")]
#[pymethods]
impl Almanac {
    /// Load from the provided MetaFile, downloading it if necessary.
    /// Set autodelete to true to automatically delete lock files. Lock files are important in multi-threaded loads.
    ///
    ///
    /// :type metafile: MetaFile
    /// :type autodelete: bool
    /// :rtype: Almanac
    #[pyo3(name = "load_from_metafile")]
    fn py_load_from_metafile(
        &mut self,
        py: Python,
        metafile: MetaFile,
        autodelete: bool,
    ) -> AlmanacResult<Self> {
        py.detach(|| self.clone().load_from_metafile(metafile, autodelete))
    }

    /// Saves the current configuration to a MetaAlmanac for future reloading from the local file system.
    ///
    /// WARNING: If data was loaded from its raw bytes, or if a custom alias was used, then the MetaFile produced will not be usable.
    /// The alias used for each data type is expected to be a path. Further, all paths are ASSUMED to be loaded from the same directory.
    /// The Almanac does not resolve directories for you.
    /// :rtype: MetaAlmanac
    #[pyo3(name = "to_metaalmanac")]
    fn py_to_metaalmanac(&self) -> MetaAlmanac {
        self.to_metaalmanac()
    }
}

#[cfg(test)]
mod meta_test {
    use super::MetaAlmanac;
    use crate::almanac::metaload::MetaFile;
    use hifitime::Epoch;
    use std::path::Path;
    use std::{env, str::FromStr};

    #[test]
    fn test_meta_almanac() {
        let _ = pretty_env_logger::try_init();
        let mut meta = MetaAlmanac::default();
        println!("{meta:?}");

        let almanac = meta.process(true).unwrap();
        // Shows everything in this Almanac
        almanac.describe(None, None, None, None, None, None, None, None);
        let rtn_meta = almanac.to_metaalmanac();
        println!("{}", rtn_meta.to_dhall().unwrap());
        // Check that none of the URIs are epochs
        for file in rtn_meta.files {
            assert!(Epoch::from_str(&file.uri).is_err());
        }

        // Process again to confirm that the CRC check works
        assert!(meta.process(true).is_ok());
        // Test that loading from an invalid URI reports an error
        assert!(almanac
            .load_from_metafile(
                MetaFile {
                    uri: "http://example.com/non/existing.pca".to_string(),
                    crc32: None
                },
                true
            )
            .is_err());
    }

    #[test]
    fn test_from_dhall() {
        let default = MetaAlmanac::default();

        println!("{}", default.dumps().unwrap());

        let path = Path::new(env!("CARGO_MANIFEST_DIR")).join("../data/latest.dhall");
        let dhall = MetaAlmanac::new(path.to_str().unwrap()).unwrap();

        assert_eq!(dhall, default);

        // Try FromStr

        let from_str = MetaAlmanac::from_str(
            r#"
{ files =
  [ { crc32 = Some 0x7286750a
    , uri = "http://public-data.nyxspace.com/anise/de440s.bsp"
    }
  , { crc32 = Some 0x51f69e46
    , uri = "http://public-data.nyxspace.com/anise/v0.7/pck11.pca"
    }
  , { crc32 = Some 0x32c8f9d7
    , uri = "http://public-data.nyxspace.com/anise/v0.7/moon_fk_de440.epa"
    }
  , { crc32 = Some 0xcde5ca7d
    , uri = "http://public-data.nyxspace.com/anise/moon_pa_de440_200625.bpc"
    }
  , { crc32 = None Natural
    , uri =
        "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/pck/earth_latest_high_prec.bpc"
    }
  ]
}
             "#,
        )
        .unwrap();

        assert_eq!(from_str, default);
    }
}