launchify 0.3.1

use handlebars::Handlebars;
use regex::Regex;
use serde_json::json;
use std::env;
use std::fmt;
use std::fs;
use std::io;
use std::path::PathBuf;
use std::process::Command;
use std::str::FromStr;
use structopt::StructOpt;
use thiserror::Error;
use which::which;

const PLIST_TEMPLATE: &str = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\"
  \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">
<plist version=\"1.0\">
<dict>
    <key>Label</key>
    <string>{{name}}</string>
    <key>ProgramArguments</key>
    <array>
        <string>{{program_path}}</string>{{#each args}}
        <string>{{this}}</string>{{/each}}
    </array>
    <key>StartInterval</key>
    <integer>{{interval}}</integer>
    <key>StandardOutPath</key>
    <string>{{stdout}}</string>
    <key>StandardErrorPath</key>
    <string>{{stderr}}</string>
    <key>WorkingDirectory</key>
    <string>{{working_dir}}</string>
</dict>
</plist>";

fn main() {
    let args = Cli::from_args();

    if let Err(err) = run(args) {
        println!("Error: {}", err);
        std::process::exit(1);
    }
}

#[derive(Debug, Error)]
enum RunError {
    #[error("invalid filepath")]
    InvalidFilepath,

    #[error("could not find home directory")]
    NoHomeDir,

    #[error("could not find program")]
    InvalidProg,

    #[error("could not get current working dir")]
    CurrentDir,

    #[error("could not render config template: {source}")]
    RenderTemplate {
        #[from]
        source: handlebars::TemplateRenderError,
    },

    #[error("IO error: {source}")]
    Io {
        #[from]
        source: io::Error,
    },

    #[error("could not load config file")]
    Load,
}

fn run(args: Cli) -> Result<(), RunError> {
    let cfg = LaunchConfig::from_cli(&args)?;
    let plist_file = PlistFile::from(&cfg)?;

    if args.dry_run {
        println!("Dry run: would write {}", plist_file);
        return Ok(());
    }

    cfg.dirs.ensure()?;
    plist_file.write()?;
    plist_file.load()?;
    println!("successfuly scheduled {}", cfg.name);

    Ok(())
}

#[derive(Debug, PartialEq)]
enum Period {
    Day(u64),
    Hour(u64),
    Minute(u64),
    Second(u64),
}

impl Period {
    fn to_seconds(&self) -> u64 {
        match self {
            Self::Day(days) => 24 * 60 * 60 * days,
            Self::Hour(hours) => 60 * 60 * hours,
            Self::Minute(mins) => 60 * mins,
            &Self::Second(secs) => secs,
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
struct ParsePeriodError(String);

impl fmt::Display for ParsePeriodError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Error parsing period {}", self.0)
    }
}

impl FromStr for Period {
    type Err = ParsePeriodError;

    fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
        let re = Regex::new(r"^(\d+)(d|h|m|s)$").unwrap();
        let caps = match re.captures(s) {
            Some(caps) => caps,
            None => return Err(ParsePeriodError(s.to_owned())),
        };

        if caps.len() != 3 {
            return Err(ParsePeriodError(s.to_owned()));
        }

        let value: u64 = match caps[1].parse() {
            Ok(val) => val,
            Err(_) => return Err(ParsePeriodError(s.to_owned())),
        };

        let period = match &caps[2] {
            "d" => Period::Day,
            "h" => Period::Hour,
            "m" => Period::Minute,
            "s" => Period::Second,
            _ => return Err(ParsePeriodError(s.to_owned())),
        };

        Ok(period(value))
    }
}

#[derive(StructOpt)]
struct Cli {
    period: Period,
    program: String,

    #[structopt(long)]
    dry_run: bool,

    #[structopt(long)]
    name: Option<String>,

    #[structopt(long)]
    args: Option<String>,

    #[structopt(long)]
    working_dir: Option<String>,
}

struct LaunchConfig {
    name: String,
    program_path: PathBuf,
    start_interval: u64,
    dirs: LaunchDirs,
    args: Vec<String>,
    working_dir: String,
}

impl LaunchConfig {
    fn from_cli(args: &Cli) -> Result<Self, RunError> {
        // First, try and treat the program as a filepath and see if we can
        // get the absolute path. Otherwise, we use the which crate to see
        // if the program matches an executable on the current PATH.
        let path = match fs::canonicalize(&args.program) {
            Ok(path) => path,
            Err(_) => which(&args.program).map_err(|_| RunError::InvalidProg)?,
        };

        let name = match &args.name {
            Some(name) => name.to_owned(),
            None => path
                .file_stem()
                .ok_or(RunError::InvalidFilepath)?
                .to_str()
                .ok_or(RunError::InvalidFilepath)?
                .to_owned(),
        };

        let start_interval = args.period.to_seconds();
        let dirs = LaunchDirs::from(&name)?;

        let program_args = match &args.args {
            Some(a) => a.split_ascii_whitespace().map(|s| s.to_string()).collect(),
            None => Vec::new(),
        };

        let working_dir = match &args.working_dir {
            Some(dir) => dir.to_owned(),
            None => env::current_dir()
                .map_err(|_| RunError::CurrentDir)?
                .to_str()
                .ok_or(RunError::InvalidFilepath)?
                .to_owned(),
        };

        Ok(Self {
            name,
            program_path: path,
            start_interval,
            dirs,
            args: program_args,
            working_dir,
        })
    }

    fn plist_contents(&self) -> Result<String, RunError> {
        let program_path = self
            .program_path
            .to_str()
            .ok_or(RunError::InvalidFilepath)?;
        let stdout_path = self.log_path("stdout")?;
        let stderr_path = self.log_path("stderr")?;

        let reg = Handlebars::new();
        reg.render_template(
            PLIST_TEMPLATE,
            &json!(
                {
                    "name": self.name,
                    "program_path": program_path,
                    "args": self.args,
                    "interval": self.start_interval,
                    "stdout": stdout_path,
                    "stderr": stderr_path,
                    "working_dir": self.working_dir,
                }
            ),
        )
        .map_err(|e| e.into())
    }

    fn log_path(&self, filename: &str) -> Result<String, RunError> {
        let mut path = self.dirs.log_dir.to_owned();
        path.push(filename);
        path.to_str()
            .ok_or(RunError::InvalidFilepath)
            .map(|p| p.to_owned())
    }

    fn plist_filepath(&self) -> Result<PathBuf, RunError> {
        let filename = format!("com.{}.plist", self.name);
        let mut filepath = dirs::home_dir().ok_or(RunError::NoHomeDir)?;

        filepath.push("Library");
        filepath.push("LaunchAgents");
        filepath.push(filename);
        Ok(filepath)
    }
}

struct LaunchDirs {
    log_dir: PathBuf,
    plist_dir: PathBuf,
}

impl LaunchDirs {
    fn from(name: &str) -> Result<Self, RunError> {
        let mut log_dir = dirs::home_dir().ok_or(RunError::NoHomeDir)?;
        let mut plist_dir = log_dir.clone();

        log_dir.push("logs");
        log_dir.push(name);

        plist_dir.push("Library");
        plist_dir.push("LaunchAgents");

        Ok(Self { log_dir, plist_dir })
    }

    fn ensure(&self) -> io::Result<()> {
        fs::create_dir_all(&self.log_dir)?;
        fs::create_dir_all(&self.plist_dir)?;
        Ok(())
    }
}

struct PlistFile {
    filepath: PathBuf,
    contents: String,
}

impl PlistFile {
    fn from(cfg: &LaunchConfig) -> Result<Self, RunError> {
        let filepath = cfg.plist_filepath()?;
        let contents = cfg.plist_contents()?;
        Ok(Self { filepath, contents })
    }

    fn write(&self) -> io::Result<()> {
        fs::write(&self.filepath, &self.contents)
    }

    fn load(&self) -> Result<(), RunError> {
        let filepath = self.filepath.to_str().ok_or(RunError::InvalidFilepath)?;
        let status = Command::new("launchctl")
            .args(&["load", "-w", filepath])
            .status()?;

        if status.success() {
            Ok(())
        } else {
            Err(RunError::Load)
        }
    }
}

impl fmt::Display for PlistFile {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let filepath = match self.filepath.to_str() {
            Some(path) => path,
            None => return Err(fmt::Error),
        };

        write!(f, "{}:\n{}", filepath, self.contents)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_parse_period() -> Result<(), ParsePeriodError> {
        let period = Period::from_str("15s")?;
        assert_eq!(period, Period::Second(15));
        let secs = period.to_seconds();
        assert_eq!(secs, 15);

        let period = Period::from_str("30m")?;
        assert_eq!(period, Period::Minute(30));
        let secs = period.to_seconds();
        assert_eq!(secs, 30 * 60);

        let period = Period::from_str("3h")?;
        assert_eq!(period, Period::Hour(3));
        let secs = period.to_seconds();
        assert_eq!(secs, 3 * 60 * 60);

        let period = Period::from_str("2d")?;
        assert_eq!(period, Period::Day(2));
        let secs = period.to_seconds();
        assert_eq!(secs, 2 * 24 * 60 * 60);

        let period = Period::from_str("123xyz");
        assert_eq!(period, Err(ParsePeriodError(String::from("123xyz"))));

        Ok(())
    }

    const EXPECTED_CONTENTS: &str = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\"
  \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">
<plist version=\"1.0\">
<dict>
    <key>Label</key>
    <string>lister</string>
    <key>ProgramArguments</key>
    <array>
        <string>/bin/ls</string>
        <string>-l</string>
    </array>
    <key>StartInterval</key>
    <integer>1800</integer>
    <key>StandardOutPath</key>
    <string>/Users/ryan/logs/lister/stdout</string>
    <key>StandardErrorPath</key>
    <string>/Users/ryan/logs/lister/stderr</string>
    <key>WorkingDirectory</key>
    <string>/var/tmp</string>
</dict>
</plist>";

    #[test]
    fn test_dry_run() -> Result<(), RunError> {
        let period = Period::Minute(30);

        let args = Cli {
            period,
            program: String::from("ls"),
            dry_run: true,
            name: Some(String::from("lister")),
            args: Some(String::from("-l")),
            working_dir: Some(String::from("/var/tmp")),
        };
        let cfg = LaunchConfig::from_cli(&args)?;
        let plist_file = PlistFile::from(&cfg)?;
        assert_eq!(plist_file.contents, EXPECTED_CONTENTS);

        Ok(())
    }
}