Add local index in package manager

Cargo.toml

@@ -26,6 +26,7 @@ backtrace = "0.3.37"
 chrono = "0.4.9"
 lazy_static = "1.4.0"
 walkdir = "2.2.9"
+reqwest = "0.9.20"
 
 [target.'cfg(unix)'.dependencies]
 libc = "0.2.62"

src/config/mod.rs

@@ -321,48 +321,56 @@ impl ConfigSet {
     }
 
     pub fn load_default() -> Result<ConfigSet, ConfigLoadError> {
-        let res = dirs::home_dir();
+        let espanso_dir = ConfigSet::get_default_config_dir();
-        if let Some(home_dir) = res {
-            let espanso_dir = home_dir.join(".espanso");
 
-            // Create the espanso dir if id doesn't exist
+        // Create the espanso dir if id doesn't exist
-            let res = create_dir_all(espanso_dir.as_path());
+        let res = create_dir_all(espanso_dir.as_path());
 
-            if let Ok(_) = res {
+        if let Ok(_) = res {
-                let default_file = espanso_dir.join(DEFAULT_CONFIG_FILE_NAME);
+            let default_file = espanso_dir.join(DEFAULT_CONFIG_FILE_NAME);
 
-                // If config file does not exist, create one from template
+            // If config file does not exist, create one from template
-                if !default_file.exists() {
+            if !default_file.exists() {
-                    let result = fs::write(&default_file, DEFAULT_CONFIG_FILE_CONTENT);
+                let result = fs::write(&default_file, DEFAULT_CONFIG_FILE_CONTENT);
-                    if result.is_err() {
+                if result.is_err() {
-                        return Err(ConfigLoadError::UnableToCreateDefaultConfig)
+                    return Err(ConfigLoadError::UnableToCreateDefaultConfig)
-                    }
                 }
-
-                // Create auxiliary directories
-
-                let user_config_dir = espanso_dir.join(USER_CONFIGS_FOLDER_NAME);
-                if !user_config_dir.exists() {
-                    let res = create_dir_all(user_config_dir.as_path());
-                    if res.is_err() {
-                        return Err(ConfigLoadError::UnableToCreateDefaultConfig)
-                    }
-                }
-
-                let packages_dir = espanso_dir.join(PACKAGES_FOLDER_NAME);
-                if !packages_dir.exists() {
-                    let res = create_dir_all(packages_dir.as_path());
-                    if res.is_err() {
-                        return Err(ConfigLoadError::UnableToCreateDefaultConfig)
-                    }
-                }
-
-                return ConfigSet::load(espanso_dir.as_path())
             }
+
+            // Create auxiliary directories
+
+            let user_config_dir = espanso_dir.join(USER_CONFIGS_FOLDER_NAME);
+            if !user_config_dir.exists() {
+                let res = create_dir_all(user_config_dir.as_path());
+                if res.is_err() {
+                    return Err(ConfigLoadError::UnableToCreateDefaultConfig)
+                }
+            }
+
+            let packages_dir = espanso_dir.join(PACKAGES_FOLDER_NAME);
+            if !packages_dir.exists() {
+                let res = create_dir_all(packages_dir.as_path());
+                if res.is_err() {
+                    return Err(ConfigLoadError::UnableToCreateDefaultConfig)
+                }
+            }
+
+            return ConfigSet::load(espanso_dir.as_path())
         }
 
         return Err(ConfigLoadError::UnableToCreateDefaultConfig)
     }
+
+    pub fn get_default_config_dir() -> PathBuf {
+        let home_dir = dirs::home_dir().expect("Unable to get home directory");
+        let espanso_dir = home_dir.join(".espanso");
+        espanso_dir
+    }
+
+    pub fn get_default_packages_dir() -> PathBuf {
+        let espanso_dir = ConfigSet::get_default_config_dir();
+        espanso_dir.join(PACKAGES_FOLDER_NAME)
+    }
 }
 
 pub trait ConfigManager<'a> {

src/package/default.rs

@@ -0,0 +1,162 @@
+/*
+ * This file is part of espanso.
+ *
+ * Copyright (C) 2019 Federico Terzi
+ *
+ * espanso is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * espanso is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with espanso.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+use std::path::{PathBuf, Path};
+use crate::package::PackageIndex;
+use std::error::Error;
+use std::fs::File;
+use std::io::BufReader;
+use chrono::{NaiveDateTime, Timelike};
+use std::time::{SystemTime, UNIX_EPOCH};
+
+const DEFAULT_PACKAGE_INDEX_FILE : &str = "package_index.json";
+
+pub struct DefaultPackageManager {
+    package_dir: PathBuf,
+    data_dir: PathBuf,
+
+    local_index: Option<PackageIndex>,
+}
+
+impl DefaultPackageManager {
+    pub fn new(package_dir: PathBuf, data_dir: PathBuf) -> DefaultPackageManager {
+        let local_index = Self::load_local_index(&data_dir);
+
+        DefaultPackageManager{
+            package_dir,
+            data_dir,
+            local_index
+        }
+    }
+
+    pub fn new_default() -> DefaultPackageManager {
+        DefaultPackageManager::new(
+            crate::config::ConfigSet::get_default_packages_dir(),
+            crate::context::get_data_dir()
+        )
+    }
+
+    fn get_package_index_path(data_dir: &Path) -> PathBuf {
+        data_dir.join(DEFAULT_PACKAGE_INDEX_FILE)
+    }
+
+    fn load_local_index(data_dir: &Path) -> Option<super::PackageIndex> {
+        let local_index_file = File::open(Self::get_package_index_path(data_dir));
+        if let Ok(local_index_file) = local_index_file {
+            let reader = BufReader::new(local_index_file);
+            let local_index = serde_json::from_reader(reader);
+
+            if let Ok(local_index) = local_index {
+                return local_index
+            }
+        }
+
+        None
+    }
+
+    fn request_index() -> Result<super::PackageIndex, Box<dyn Error>> {
+        let mut client = reqwest::Client::new();
+        let request = client.get("https://hub.espanso.org/json/")
+            .header("User-Agent", format!("espanso/{}", crate::VERSION));
+
+        let mut res = request.send()?;
+        let body = res.text()?;
+        let index : PackageIndex = serde_json::from_str(&body)?;
+
+        Ok(index)
+    }
+
+
+    fn local_index_timestamp(&self) -> u64 {
+        if let Some(local_index) = &self.local_index {
+            return local_index.last_update
+        }
+
+        return 0;
+    }
+}
+
+impl super::PackageManager for DefaultPackageManager {
+    fn update_index(&self) {
+        unimplemented!()
+    }
+
+    fn is_index_outdated(&self) -> bool {
+        let current_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time went backwards");
+        let current_timestamp = current_time.as_secs();
+
+        let local_index_timestamp = self.local_index_timestamp();
+
+        // Local index is outdated if older than a day
+        local_index_timestamp < current_timestamp + 60*60*24
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use tempfile::TempDir;
+    use std::path::Path;
+    use crate::package::PackageManager;
+
+    const OUTDATED_INDEX_CONTENT : &str = include_str!("../res/test/outdated_index.json");
+
+    struct TempPackageManager {
+        package_dir: TempDir,
+        data_dir: TempDir,
+        package_manager: DefaultPackageManager,
+    }
+
+    fn create_temp_package_manager<F>(setup: F) -> TempPackageManager where F: Fn(&Path, &Path) -> (){
+        let package_dir = TempDir::new().expect("unable to create temp directory");
+        let data_dir = TempDir::new().expect("unable to create temp directory");
+
+        setup(package_dir.path(), data_dir.path());
+
+        let package_manager = DefaultPackageManager::new(
+            package_dir.path().clone().to_path_buf(),
+            data_dir.path().clone().to_path_buf()
+        );
+
+        TempPackageManager {
+            package_dir,
+            data_dir,
+            package_manager
+        }
+    }
+
+    #[test]
+    fn test_download_index() {
+        let temp = create_temp_package_manager(|_, _| {});
+        let index = DefaultPackageManager::request_index();
+
+        assert!(index.is_ok());
+        assert!(index.unwrap().packages.len() > 0);
+    }
+
+    #[test]
+    fn test_outdated_index() {
+        let temp = create_temp_package_manager(|_, data_dir| {
+            let index_file = data_dir.join(DEFAULT_PACKAGE_INDEX_FILE);
+            std::fs::write(index_file, OUTDATED_INDEX_CONTENT);
+        });
+
+        assert!(temp.package_manager.is_index_outdated());
+    }
+}

src/package/mod.rs

@@ -0,0 +1,44 @@
+/*
+ * This file is part of espanso.
+ *
+ * Copyright (C) 2019 Federico Terzi
+ *
+ * espanso is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * espanso is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with espanso.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+pub(crate) mod default;
+use serde::{Serialize, Deserialize};
+
+pub trait PackageManager {
+    fn update_index(&self);
+    fn is_index_outdated(&self) -> bool;
+}
+
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub struct Package {
+    name: String,
+    title: String,
+    version: String,
+    repo: String,
+    desc: String,
+    author: String
+}
+
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub struct PackageIndex {
+    #[serde(rename = "lastUpdate")]
+    last_update: u64,
+
+    packages: Vec<Package>
+}

src/res/test/outdated_index.json

@@ -0,0 +1,27 @@
+{
+    "lastUpdate": 1565437389,
+    "packages": [
+
+        {
+            "name": "basic-emojis",
+            "title": "Basic Emojis",
+            "version": "0.1.0",
+            "repo": "https://github.com/federico-terzi/espanso-hub-core",
+            "desc": "A package to include some basic emojis in espanso.",
+            "author": "Federico Terzi"
+
+        },
+
+
+        {
+            "name": "italian-accents",
+            "title": "Italian Accents",
+            "version": "0.1.0",
+            "repo": "https://github.com/federico-terzi/espanso-hub-core",
+            "desc": "Include Italian accents substitutions to espanso.",
+            "author": "Federico Terzi"
+
+        }
+
+
+]}