Add interactive commands and config setup (#8)

Author: Trojan295

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "eso-addons"
-version = "0.2.0"
-authors = ["Damian Czaja <trojan295@gmail.com>"]
+version = "0.3.0"
+authors = ["Damian Czaja <trojan295@protonmail.com>"]
 edition = "2018"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
@@ -16,7 +16,7 @@ path = "src/main.rs"
 toml = "0.4"
 serde = "1.0"
 serde_derive = "1.0"
-clap = "3.0.0-beta.2"
+clap = "3.0.0-beta.4"
 dirs = "3.0"
 simple-error = "0.2"
 regex = "1"
@@ -25,4 +25,7 @@ openssl = { version = "0.10", features = ["vendored"] }
 html5ever = "0.25"
 markup5ever_rcdom = "0.1"
 zip = "0.5"
-tempfile = "3.1"
+tempfile = "3.1"
+requestty = "0.1"
+colored = "2"
+prettytable-rs = "^0.8"

Cargo.toml

@@ -4,7 +4,7 @@
 
 This repository holds a simple command line ESO Addon Manager written in Rust. With it you can manage addons from [esoui.com](https://www.esoui.com/).
 
-The list of addons you want to install, is put in a single configuration file. This means you can save and share your addon configuration with a single file!
+The list of addons you want to install is put in a single configuration file. This means you can save and share your addon configuration with a single file!
 
 - [ESO Addon Manager](#eso-addon-manager)
   - [Usage](#usage)
@@ -16,48 +16,79 @@ The list of addons you want to install, is put in a single configuration file. T
 
 ## Usage
 
-<a href="https://asciinema.org/a/381564" target="_blank"><img height="500px" src="https://asciinema.org/a/381564.svg" /></a>
-
+<a href="https://asciinema.org/a/431685" target="_blank"><img src="https://asciinema.org/a/431685.svg" /></a>
 
 ### Configuration
 
-Create a config file in your user directory:
-- Linux - `$HOME/.eso-addons.toml`
+Run:
 
-For an example config see [eso-addons.toml](./eso-addons.toml).
+```bash
+eso-addons list
+```
 
-### Install and update addon
+to generate the config file. The config file is in your user directory:
+- Linux - `/home/<username>/.eso-addons.toml`
+- Windows - `C:/Users/<username>/.eso-addons.toml`
 
-To install or update addons, execute:
-```
-eso-addons update
+If necessary, edit the `addonDir` parameter in the config file to the directory, where your ESO addons should be placed:
+```toml
+addonDir = "/home/damian/drive_c/users/user/My Documents/Elder Scrolls Online/live/AddOns" # edit this, if needed
 ```
 
-### List addons, show missing or unused dependencies
+### Install new addon
 
-To list the installation status of addons and show missing or unused dependencies, execute:
-```
-eso-addons list
+To install a new addon use the `eso-addons add` command:
+```bash
+❯ eso-addons add
+✔ URL of the addon on esoui.com · https://www.esoui.com/downloads/info1536-ActionDurationReminder.html
+✔ Is addon only a dependency? · No
+🎊 Installed ActionDurationReminder!
 ```
 
-### Remove addons
+### Update installed addons
 
-The Addon Manager can remove addons, which are present in the ESO addon dir, but not listed in the configuration file.
+In case you want to update the addons to the newest version execute `eso-addons update`:
+```bash
+❯ eso-addons update
+✔ Updated ActionDurationReminder!
+✔ Updated LibAddonMenu-2.0!
+```
 
-It can also detect addons, which are an unused dependency, i.e. you installed addon A, because it was a dependency of B. When you remove B, then `eso-addons` will detect that A is not required anymore and can be removed.
+### List addons, show missing or unused addon dependencies
 
-To get the list of addons to be removed, execute:
+To list the status of all installed addons, show missing or unused dependencies use `eso-addons list`
 ```
-eso-addons clean
+❯ eso-addons list
++------------------------+-----------+
+| Name                   | Status    |
++------------------------+-----------+
+| ActionDurationReminder | INSTALLED |
+| LibAddonMenu-2.0       | MISSING   |
++------------------------+-----------+
 ```
 
-To remove the addons, execute:
+### Remove addons
+
+To remove an addon use `eso-addons remove`:
+```bash
+❯ eso-addons remove
+✔ Select addon to remove · ActionDurationReminder
+✔ Uninstalled ActionDurationReminder!
 ```
-eso-addons clean --remove
+
+There is also the `eso-addons clean` command, which can be used to remove addons, which are not managed by `eso-addons` (i.e. you installed them manually):
+```bash
+❯ eso-addons clean
+🗑 Addons to remove:
+- LibAddonMenu-2.0
+
+✔ Do you want to remove these addons? · Yes
+
+✓ LibAddonMenu-2.0 removed!
 ```
 
 ### Backup and share your addon configuration
 
-Just backup the `eso-addons.toml` file and that's it! In case you have to restore the addons (e.g. after a OS reinstall), just use the backup `eso-addons.toml` and install the addons again.
+Just backup the `eso-addons.toml` file and that's it! In case you have to restore the addons (e.g. after an OS reinstall), just put the backuped `eso-addons.toml` in [user directory](#configuration) and run `eso-addons update` to install all addons.
 
-You can also share your addon configuration with friends using the same way, by sending them your `eso-addons.toml` file.
+You can also share your addon configuration with other people by sending them your `eso-addons.toml` file.

README.md

@@ -3,12 +3,14 @@
 # "C:\Users\[account]\Documents\Elder Scrolls Online\live\AddOns" becomes "/Users/[account]/Documents/Elder Scrolls Online/live/AddOns"
 #
 addonDir = "/home/damian/Games/the-elder-scrolls-online-tamriel-unlimited/drive_c/users/damian/My Documents/Elder Scrolls Online/live/AddOns"
-
-# addons - list of addons to be installed
-#   name - name of the addon
-#   url - download URL of the addon, it is the link under the Download button on ESOUI
-#   dependency - (default: false) determines, if the addon is a dependency.
-#                Set this to true, if you don't use the addon standalone, but only as a dependency for another addon
+# example for Windows:
+#addonDir = "C:/Users/Administrator/My Documents/Elder Scrolls Online/live/AddOns"
+
+# addons - List of addons to be installed
+#   name - Name of the addon
+#   url - Download URL of the addon, it is the link under the Download button on ESOUI.
+#   dependency - (default: false) Determines, if the addon is a dependency.
+#                Set this to true, if you don't use the addon standalone, but only as a dependency for another addon.
 [[addons]]
 name = "SkyShards"
 url = "https://www.esoui.com/downloads/download128-SkyShards.html"

eso-addons.toml

@@ -1,3 +1,5 @@
+use crate::htmlparser;
+
 use super::errors::ErrorChain;
 use html5ever::tendril::TendrilSink;
 use html5ever::{self, tree_builder::TreeBuilderOpts, ParseOpts};
@@ -188,7 +190,7 @@ impl Manager {
 }
 
 fn get_cdn_download_link(dom: &RcDom) -> Option<String> {
-    let node = find_first_in_node(&dom.document, &|node: &Rc<Node>| match &node.data {
+    let node = htmlparser::find_first_in_node(&dom.document, &|node: &Rc<Node>| match &node.data {
         NodeData::Element {
             name,
             attrs,
@@ -215,28 +217,12 @@ fn get_cdn_download_link(dom: &RcDom) -> Option<String> {
     }
 }
 
-fn find_first_in_node<T>(node: &Rc<Node>, f: &dyn Fn(&Rc<Node>) -> Option<T>) -> Option<T> {
-    match f(node) {
-        Some(x) => Some(x),
-        None => {
-            for child in node.children.borrow().iter() {
-                match find_first_in_node(child, f) {
-                    Some(x) => return Some(x),
-                    None => {}
-                }
-            }
-
-            None
-        }
-    }
-}
-
 fn get_root_dir(path: &Path) -> PathBuf {
     match path.parent() {
         None => path.to_owned(),
         Some(parent) => match parent.to_str().unwrap() {
             "" => path.to_owned(),
-            &_ => get_root_dir(parent)
-        }
+            &_ => get_root_dir(parent),
+        },
     }
 }

src/addons.rs

@@ -0,0 +1,151 @@
+use eso_addons::{
+    addons::Manager,
+    config::{self, AddonEntry, Config},
+    errors::ErrorChain,
+    htmlparser,
+};
+use html5ever::{tendril::TendrilSink, tree_builder::TreeBuilderOpts, ParseOpts};
+use markup5ever_rcdom::{Node, NodeData, RcDom};
+use regex::Regex;
+use std::{error::Error, path::Path, rc::Rc};
+
+#[derive(Clap)]
+pub struct AddCommand {
+    addon_url: Option<String>,
+    #[clap(
+        short,
+        long,
+        about = "Indicate, if the addon is only a dependency for another addon"
+    )]
+    dependency: Option<bool>,
+}
+
+impl AddCommand {
+    pub fn run(
+        &mut self,
+        cfg: &mut Config,
+        config_filepath: &Path,
+        addon_manager: &Manager,
+    ) -> Result<(), Box<dyn std::error::Error>> {
+        let mut entry = self.get_entry()?;
+
+        if cfg.addons.iter().find(|el| el.url == entry.url).is_some() {
+            println!("Addon {} is already installed", &entry.name);
+            return Ok(());
+        }
+
+        let installed = addon_manager
+            .download_addon(&entry.url.clone().unwrap())
+            .chain_err(&format!("while downloading {}", &entry.name))?;
+
+        if entry.name != installed.name {
+            entry.name = installed.name;
+        }
+
+        cfg.addons.push(entry.clone());
+
+        config::save_config(config_filepath, &cfg)?;
+
+        println!("🎊 Installed {}!", &entry.name);
+
+        Ok(())
+    }
+
+    pub fn get_entry(&mut self) -> Result<AddonEntry, Box<dyn Error>> {
+        if self.addon_url.is_none() {
+            self.ask_for_fields()
+                .chain_err(&format!("failed to get parameters"))?;
+        }
+
+        let addon_url = self.addon_url.clone().ok_or("missing addon URL")?;
+        let dependency = self.dependency.unwrap_or(false);
+
+        let mut response = reqwest::blocking::get(&addon_url)?;
+
+        let opts = ParseOpts {
+            tree_builder: TreeBuilderOpts {
+                drop_doctype: true,
+                ..Default::default()
+            },
+            ..Default::default()
+        };
+
+        let dom = html5ever::parse_document(RcDom::default(), opts)
+            .from_utf8()
+            .read_from(&mut response)?;
+
+        let addon_name = get_addon_name(&dom).ok_or(simple_error!("failed to get addon name"))?;
+        let download_url = get_download_url(&addon_url);
+
+        Ok(AddonEntry {
+            name: addon_name,
+            url: download_url,
+            dependency: dependency,
+        })
+    }
+
+    fn ask_for_fields(&mut self) -> Result<(), Box<dyn std::error::Error>> {
+        let mut questions = vec![requestty::Question::input("addon_url")
+            .message("URL of the addon on esoui.com")
+            .build()];
+
+        if self.dependency.is_none() {
+            questions.push(
+                requestty::Question::confirm("dependency")
+                    .message("Is addon only a dependency?")
+                    .default(false)
+                    .build(),
+            );
+        }
+
+        let answers = requestty::prompt(questions)?;
+
+        if let Some(addon_url) = answers.get("addon_url") {
+            self.addon_url = addon_url.as_string().map(|x| x.to_owned());
+        };
+
+        if let Some(dependency) = answers.get("dependency") {
+            self.dependency = dependency.as_bool();
+        };
+
+        Ok(())
+    }
+}
+
+fn get_addon_name(dom: &RcDom) -> Option<String> {
+    htmlparser::find_first_in_node(&dom.document, &|node: &Rc<Node>| match &node.data {
+        NodeData::Element {
+            name,
+            attrs,
+            template_contents: _,
+            mathml_annotation_xml_integration_point: _,
+        } => {
+            if &name.local == "meta" {
+                for attr in attrs.borrow().iter() {
+                    if &attr.name.local == "property" {
+                        if attr.value.to_string().eq("og:title") {
+                            return attrs
+                                .borrow()
+                                .iter()
+                                .find(|x| &x.name.local == "content")
+                                .map(|x| x.value.to_string());
+                        }
+                    }
+                }
+            }
+            None
+        }
+        _ => None,
+    })
+}
+
+fn get_download_url(addon_url: &str) -> Option<String> {
+    let re = Regex::new(r"^https://.*esoui.com/downloads/info(\d+)-(.+)\.html$").unwrap();
+    re.captures(addon_url).map(|captures| {
+        format!(
+            "https://www.esoui.com/downloads/download{}-{}.html",
+            captures[1].to_owned(),
+            captures[2].to_owned()
+        )
+    })
+}