Version bump to v0.2.2

.woodpecker.yml

@@ -2,6 +2,8 @@ pipeline:
   tests:
     image: rust:1.63
     commands:
+      - "apt update"
+      - "apt install -y lsof"
       - "cargo test"
 
   build_release:

Cargo.toml

@@ -1,13 +1,15 @@
 [package]
 name = "zealot"
 description = "Bit Goblin automated video transcoding service."
-version = "0.1.3"
+version = "0.2.2"
 edition = "2021"
 readme = "README.md"
 license = "BSD 2-Clause"
 authors = ["Gregory Ballantine <gballantine@bitgoblin.tech>"]
 
 [dependencies]
+clap = { version = "3.2", features = ['derive'] }
+config = { version = "0.13", features = ['toml'] }
 log = "0.4"
 log4rs = "1.1"
 toml = "0.5"
@@ -23,6 +25,7 @@ section = "video"
 assets = [
 	["target/release/zealot", "usr/bin/zealot", "755"],
 	["build/etc/example.toml", "etc/zealot/example.toml", "644"],
+	["build/etc/log4rs.yaml", "etc/zealot/log4rs.yaml", "755"],
 	["README.md", "usr/share/doc/zealot/README", "644"]
 ]
 [package.metadata.deb.systemd-units]

build/debian/service/zealot.service

@@ -4,7 +4,7 @@ Description=Zealot video transcoder service
 [Service]
 User=zealot
 Group=zealot
-ExecStart=/usr/bin/zealot
+ExecStart=/usr/bin/zealot -l /etc/zealot/log4rs.yaml
 SuccessExitStatus=143
 
 [Install]

build/etc/log4rs.yaml

@@ -0,0 +1,12 @@
+appenders:
+  stdout:
+    kind: console
+    encoder:
+      pattern: "{d(%+)(utc)} {h({l})}: {m}{n}"
+    filters:
+      - kind: threshold
+        level: info
+root:
+  level: info
+  appenders:
+    - stdout

build/scripts/postinst

@@ -5,6 +5,7 @@ GETENT_GROUP=$(getent group zealot)
 
 # Create the zealot user if it doesn't already exist
 if [ "$GETENT_USER" = "" ]; then
+	echo "Creating the 'zealot' user."
 	useradd -r zealot
 else
 	echo "The 'zealot' user already exists, skipping creation."
@@ -12,6 +13,7 @@ fi
 
 # Create the zealot group if it doesn't already exist
 if [ "$GETENT_GROUP" = "" ]; then
+	echo "Creating the 'zealot' group."
 	groupadd zealot
 	usermod -aG zealot zealot
 else
@@ -21,6 +23,15 @@ fi
 # Change the directory ownership of /etc
 chown -R zealot:zealot /etc/zealot
 
+# Create the log directory under /var/log
+if [ ! -d /var/log/zealot ]; then
+	echo "Creating /var/log/zealot to store log files."
+	mkdir /var/log/zealot
+	chown zealot:zealot /var/log/zealot
+else
+	echo "/var/log/zealot already exists, skipping creation."
+fi
+
 #DEBHELPER#
 
 exit 0

example.config

@@ -0,0 +1,10 @@
+[transcoder]
+repo_path = '~/zealot'
+interval = 15
+video_format = 'mov'
+video_codec = 'dnxhd'
+video_profile = 'dnxhr_hq'
+video_resolution = '1920x1080'
+video_framerate = '60'
+video_color = 'yuv422p'
+audio_codec = 'pcm_s16le'

src/cmd/core.rs

@@ -0,0 +1,20 @@
+use config::Config;
+use crate::settings;
+use crate::transcoder::repository::Repository;
+
+pub fn setup_command() {
+  // load configuration
+  let c: Config = settings::load_config();
+
+  // resolve repository path
+  let repository_dir_raw: &str = &c.get_string("transcoder.repository").unwrap();
+  let repository_dir: &str = &shellexpand::tilde(repository_dir_raw);
+
+  // alert the user to what's happening
+  println!("Initializing video repository at {}...", repository_dir);
+
+  // create and initialize our repository object
+  let r: Repository = Repository::new(repository_dir);
+  // initialize the video repository
+  r.initialize();
+}

src/cmd/mod.rs

@@ -0,0 +1 @@
+pub mod core;

src/config.rs

@@ -1,34 +0,0 @@
-use serde_derive::Deserialize;
-use std::fs;
-
-#[derive(Deserialize)]
-pub struct Config {
-  pub transcoder: Transcoder,
-}
-
-impl Config {
-  pub fn new(config_path: &str) -> Config {
-    let resolved_path = shellexpand::tilde(config_path);
-    let config_text = fs::read_to_string(&*resolved_path).unwrap();
-    let c: Config = toml::from_str(&config_text).unwrap();
-    return c;
-  }
-
-  pub fn get_repository(&self) -> String {
-    let resolved_path = shellexpand::tilde(&self.transcoder.repository);
-    return String::from(&*resolved_path);
-  }
-}
-
-#[derive(Deserialize)]
-pub struct Transcoder {
-  pub repository:       String,
-  pub interval:         u16,
-  pub video_format:     String,
-  pub video_codec:      String,
-  pub video_profile:    String,
-  pub video_resolution: String,
-  pub video_framerate:  u8,
-  pub video_color:      String,
-  pub audio_codec:      String,
-}

src/main.rs

@@ -1,21 +1,52 @@
+use clap::{Parser, Subcommand};
 use log4rs;
 use config::Config;
 use transcoder::repository::Repository;
 use transcoder::transcoder::Transcoder;
 
-mod config;
+mod cmd;
+mod settings;
 mod transcoder;
 mod util;
 
-fn main() {
+#[derive(Parser)]
-  // initialize the log4rs logger
+#[clap(author, version, about, long_about = None)]
-  log4rs::init_file("./log4rs.yaml", Default::default()).unwrap();
+struct Cli {
+  /// Number of times to greet
+  #[clap(short = 'l', long, default_value_t = String::from("./log4rs.yaml"))]
+  log_config: String,
 
-  // create and initialize our config and repository objects
+  #[clap(subcommand)]
-  let c: Config = Config::new("~/.config/zealot.toml");
+  command: Option<Commands>,
-  let r: Repository = Repository::new(&c.get_repository());
+}
-
+
-  // create and start the video transcoder object
+#[derive(Subcommand)]
-  let t: Transcoder = Transcoder::new(c, r);
+enum Commands {
-  t.start();
+  /// displays version info about this program
+  Setup {},
+}
+
+fn main() {
+  // initialize the clap CLI
+  let cli = Cli::parse();
+
+  // grab the log4rs config file path, then initialize log4rs
+  let log4rs_config: String = cli.log_config;
+  log4rs::init_file(&log4rs_config, Default::default()).unwrap();
+
+  match &cli.command {
+    // sub-commands will be handled here
+    Some(Commands::Setup {}) => cmd::core::setup_command(),
+
+    // run the main program without any commands
+    None => {
+      // create and initialize our config and repository objects
+      let c: Config = settings::load_config();
+      let r: Repository = Repository::new(&shellexpand::tilde(&c.get_string("transcoder.repository").unwrap()));
+
+      // create and start the video transcoder object
+      let t: Transcoder = Transcoder::new(c, r);
+      t.start();
+    },
+  }
 }

src/settings.rs

@@ -0,0 +1,33 @@
+use config::Config;
+
+pub fn load_config() -> Config {
+  let global_config_path: String = find_global_config_path();
+  let home_config_path: String = find_home_config_path();
+
+  let settings = Config::builder()
+    // Add in `./Settings.toml`
+    .add_source(config::File::with_name(&global_config_path).required(false))
+    .add_source(config::File::with_name(&home_config_path).required(false))
+    .build()
+    .unwrap();
+
+  return settings;
+}
+
+fn find_global_config_path() -> String {
+  if cfg!(windows) {
+    return String::from("C:\\Program Files\\Zealot\\config.toml");
+  }
+
+  return String::from("/etc/zealot/config.toml");
+}
+
+fn find_home_config_path() -> String {
+  let home_path: &str = &shellexpand::tilde("~/.config/zealot.toml");
+
+  if cfg!(windows) {
+    return String::from(home_path.replace("/", "\\"));
+  }
+
+  return String::from(home_path);
+}

src/transcoder/repository.rs

@@ -11,16 +11,9 @@ pub struct Repository {
 
 impl Repository {
   pub fn new(base_path: &str) -> Repository {
-    // create the base directory path
-    create_directory(base_path);
-
-    // create the needed sub-directories
     let ingest_path = Path::new(base_path).join("ingest");
-    create_directory(ingest_path.to_str().unwrap());
     let archive_path = Path::new(base_path).join("archive");
-    create_directory(archive_path.to_str().unwrap());
     let output_path = Path::new(base_path).join("output");
-    create_directory(output_path.to_str().unwrap());
 
     return Repository {
       base_dir: String::from(base_path),
@@ -30,6 +23,16 @@ impl Repository {
     };
   }
 
+  pub fn initialize(&self) {
+    // create the base directory path
+    create_directory(&self.base_dir);
+
+    // create the needed sub-directories
+    create_directory(&self.ingest_dir.as_str());
+    create_directory(&self.archive_dir.as_str());
+    create_directory(&self.output_dir.as_str());
+  }
+
   pub fn search_ingest(&self) -> Vec<String> {
     // read file entries from ingest
     let files = fs::read_dir(&self.ingest_dir).unwrap();

src/transcoder/transcoder.rs

@@ -1,9 +1,9 @@
+use config::Config;
 use std::path::Path;
 use std::process;
 use std::{thread, time};
-use log::{info};
+use log::{debug, info};
 
-use crate::config::Config;
 use crate::util::io;
 use super::repository::Repository;
 
@@ -50,25 +50,32 @@ impl Transcoder {
       }
 
       // put the loop to sleep for X minutes
-      let sleep_minutes = time::Duration::from_secs((self.config.transcoder.interval * 60).into());
+      let sleep_minutes = time::Duration::from_secs((self.config.get_int("transcoder.interval").unwrap() as u64 * 60).into());
       thread::sleep(sleep_minutes);
     }
   }
 
   fn transcode(&self, file: &str) {
     let ingest_file = Path::new(&self.repository.ingest_dir).join(file);
-    let output_file = Path::new(&self.repository.output_dir).join(file);
+    let video_format = &self.config.get_string("transcoder.video_format").unwrap();
+    let output_stem = Path::new(file).file_stem().unwrap();
+    let output_bits = vec![output_stem.to_str().unwrap(), &video_format];
+    let output_name = output_bits.join(".");
+    let output_file = Path::new(&self.repository.output_dir).join(output_name);
+
+    let video_codec = &self.config.get_string("transcoder.video_codec").unwrap();
+    info!("Transcoding {} to {} with the {} encoder.", ingest_file.display(), output_file.display(), video_codec);
 
     let cmd_output = process::Command::new("/usr/bin/ffmpeg")
       .arg("-i")        .arg(&*ingest_file.to_string_lossy())
       .arg("-y")
-      .arg("-f")        .arg(&self.config.transcoder.video_format)
+      .arg("-f")        .arg(&video_format)
-      .arg("-c:v")      .arg(&self.config.transcoder.video_codec)
+      .arg("-c:v")      .arg(&video_codec)
-      .arg("-s")        .arg(&self.config.transcoder.video_resolution)
+      .arg("-s")        .arg(&self.config.get_string("transcoder.video_resolution").unwrap())
-      .arg("-r")        .arg(format!("{}", self.config.transcoder.video_framerate))
+      .arg("-r")        .arg(format!("{}", self.config.get_string("transcoder.video_framerate").unwrap()))
-      .arg("-vf")       .arg(format!("format={}", &self.config.transcoder.video_color))
+      .arg("-vf")       .arg(format!("format={}", &self.config.get_string("transcoder.video_color").unwrap()))
-      .arg("-profile:v").arg(&self.config.transcoder.video_profile)
+      .arg("-profile:v").arg(&self.config.get_string("transcoder.video_profile").unwrap())
-      .arg("-c:a")      .arg(&self.config.transcoder.audio_codec)
+      .arg("-c:a")      .arg(&self.config.get_string("transcoder.audio_codec").unwrap())
       .arg(&*output_file.to_string_lossy())
       .output()
       .expect("Failed to execute command");
@@ -76,6 +83,6 @@ impl Transcoder {
     assert!(cmd_output.status.success());
 
     let results_raw = &String::from_utf8_lossy(&cmd_output.stderr);
-    info!("{}", results_raw);
+    debug!("{}", results_raw);
   }
 }