osdpctl: WIP: Add CP and PD support for running as a service

Signed-off-by: Siddharth Chandrasekaran <[email protected]>

osdpctl/Cargo.toml

@@ -12,3 +12,6 @@ configparser = "3.0.2"
 daemonize = "0.5.0"
 dirs = "5.0.1"
 libosdp = { version = "0.1.2", path = "../rust" }
+log = "0.4.20"
+log4rs = "1.2.0"
+toml = "0.8.8"

osdpctl/config/devices/cp-multiple-pd.cfg

@@ -3,7 +3,7 @@ NumPd = 2
 
 [Service]
 LogLevel = INFO
-LogFile = /tmp/single-cp.log
+LogDir = /tmp/osdpctl
 PidFile = /tmp/cp-002.pid
 
 [PD-0]

osdpctl/config/devices/cp-single-pd.cfg

@@ -3,7 +3,7 @@ NumPd = 1
 
 [Service]
 LogLevel = INFO
-LogFile = /tmp/single-cp.log
+LogDir = /tmp/osdpctl
 PidFile = /tmp/cp-002.pid
 
 [PD-0]

osdpctl/config/devices/pd-0.cfg

@@ -5,7 +5,7 @@ KeyStore = /tmp/pd-0.key
 
 [Service]
 LogLevel = INFO
-LogFile = /tmp/pd-0.log
+LogDir = /tmp/osdpctl
 PidFile = /tmp/pd-0.pid
 
 [PdCapability]

osdpctl/config/devices/pd-1.cfg

@@ -6,7 +6,7 @@ Flags = EnforceSecure
 
 [Service]
 LogLevel = INFO
-LogFile = /tmp/pd-0.log
+LogDir = /tmp/osdpctl
 PidFile = /tmp/pd-1.pid
 
 [PdCapability]

osdpctl/config/osdpctl.cfg

@@ -1 +1,2 @@
-device_config_dir = ./devices
+DeviceDir = ./devices
+LogDir = /tmp/osdpctls

osdpctl/src/config.rs

@@ -1,22 +1,18 @@
+use configparser::ini::Ini;
+use libosdp::{
+    channel::{unix_channel::UnixChannel, OsdpChannel},
+    common::{OsdpFlag, PdCapability, PdId, PdInfo},
+};
 use std::{
+    fmt::Write,
     path::{Path, PathBuf},
     str::FromStr,
-    fmt::Write
-};
-use configparser::ini::Ini;
-use libosdp::{
-    common::{
-        OsdpFlag, PdId, PdCapability, PdInfo
-    },
-    channel::{
-        unix_channel::UnixChannel, OsdpChannel
-    }
 };
 
 type Result<T> = anyhow::Result<T, anyhow::Error>;
 
 pub struct AppConfig {
-    pub device_config_dir: PathBuf
+    pub device_config_dir: PathBuf,
 }
 
 impl AppConfig {
@@ -29,8 +25,8 @@ impl AppConfig {
             });
         }
         let mut config = Ini::new();
-        let _ = config.load(cfg).unwrap();
-        let s = config.get("default", "device_config_dir").unwrap();
+        config.load(cfg).map_err(|e| anyhow::anyhow!(e))?;
+        let s = config.get("default", "DeviceDir").unwrap();
         let device_config_dir = if s.starts_with("./") {
             let mut path = PathBuf::from(cfg);
             path.pop();
@@ -51,15 +47,13 @@ fn vec_to_array<T, const N: usize>(v: Vec<T>) -> [T; N] {
 }
 
 pub struct KeyStore {
-    store: PathBuf
+    store: PathBuf,
 }
 
 impl KeyStore {
     pub fn from_path(path: &str) -> Self {
         let store = PathBuf::from_str(path).unwrap();
-        Self {
-            store,
-        }
+        Self { store }
     }
 
     pub fn decode_hex(&self, s: &str) -> anyhow::Result<Vec<u8>, std::num::ParseIntError> {
@@ -102,14 +96,14 @@ pub struct PdData {
     channel: String,
     address: i32,
     pub key_store: KeyStore,
-    flags: OsdpFlag
+    flags: OsdpFlag,
 }
 
 pub struct CpConfig {
     pub name: String,
     pd_data: Vec<PdData>,
     pub pid_file: PathBuf,
-    pub log_file: PathBuf,
+    pub log_dir: PathBuf,
     pub log_level: String,
 }
 
@@ -129,9 +123,15 @@ impl CpConfig {
             });
         }
         let pid_file = PathBuf::from_str(&config.get("Service", "PidFile").unwrap())?;
-        let log_file = PathBuf::from_str(&config.get("Service", "LogFile").unwrap())?;
+        let log_dir = PathBuf::from_str(&config.get("Service", "LogDir").unwrap())?;
         let log_level = config.get("Service", "LogLevel").unwrap();
-        Ok(Self { name, pd_data, pid_file, log_level, log_file })
+        Ok(Self {
+            name,
+            pd_data,
+            pid_file,
+            log_level,
+            log_dir,
+        })
     }
 
     pub fn pd_info(&self) -> Result<Vec<PdInfo>> {
@@ -155,7 +155,7 @@ impl CpConfig {
 }
 
 pub struct PdConfig {
-    name: String,
+    pub name: String,
     channel: String,
     address: i32,
     pub key_store: KeyStore,
@@ -164,7 +164,7 @@ pub struct PdConfig {
     flags: OsdpFlag,
     pub pid_file: PathBuf,
     pub log_level: String,
-    pub log_file: PathBuf,
+    pub log_dir: PathBuf,
 }
 
 impl PdConfig {
@@ -174,7 +174,7 @@ impl PdConfig {
             model: config.getuint("PdId", "Model").unwrap().unwrap() as i32,
             vendor_code: config.getuint("PdId", "VendorCode").unwrap().unwrap() as u32,
             serial_number: config.getuint("PdId", "SerialNumber").unwrap().unwrap() as u32,
-            firmware_version: config.getuint("PdId", "FirmwareVersion").unwrap().unwrap() as u32
+            firmware_version: config.getuint("PdId", "FirmwareVersion").unwrap().unwrap() as u32,
         };
         let mut flags = OsdpFlag::empty();
         if let Some(val) = config.get("default", "Flags") {
@@ -191,12 +191,25 @@ impl PdConfig {
         let cap_map = map.get("PdCapability").unwrap();
         let mut pd_cap = Vec::new();
         for (key, val) in cap_map {
-            pd_cap.push(PdCapability::from_str(format!("{}:{}", key, val.as_deref().unwrap()).as_str())?);
+            pd_cap.push(PdCapability::from_str(
+                format!("{}:{}", key, val.as_deref().unwrap()).as_str(),
+            )?);
         }
         let pid_file = PathBuf::from_str(&config.get("Service", "PidFile").unwrap())?;
-        let log_file = PathBuf::from_str(&config.get("Service", "LogFile").unwrap())?;
+        let log_dir = PathBuf::from_str(&config.get("Service", "LogDir").unwrap())?;
         let log_level = config.get("Service", "LogLevel").unwrap();
-        Ok(Self { name, channel, address, key_store, pd_id, pd_cap, flags, pid_file, log_level, log_file })
+        Ok(Self {
+            name,
+            channel,
+            address,
+            key_store,
+            pd_id,
+            pd_cap,
+            flags,
+            pid_file,
+            log_level,
+            log_dir,
+        })
     }
 
     pub fn pd_info(&self) -> Result<PdInfo> {

osdpctl/src/cp.rs

@@ -1,9 +1,7 @@
-use std::{fs::File, thread, time::Duration};
-use daemonize::Daemonize;
-use libosdp::{
-    cp::ControlPanel, events::OsdpEvent
-};
 use crate::config::CpConfig;
+use daemonize::Daemonize;
+use libosdp::{cp::ControlPanel, events::OsdpEvent};
+use std::{fs::File, thread, time::Duration};
 
 type Result<T> = anyhow::Result<T, anyhow::Error>;
 
@@ -18,25 +16,33 @@ impl CpDaemon {
         cp.set_event_callback(|pd, event| {
             match event {
                 OsdpEvent::CardRead(e) => {
-                    println!("Event: PD-{pd} {:?}", e);
-                },
+                    log::info!("Event: PD-{pd} {:?}", e);
+                }
                 OsdpEvent::KeyPress(e) => {
-                    println!("Event: PD-{pd} {:?}", e);
-                },
+                    log::info!("Event: PD-{pd} {:?}", e);
+                }
                 OsdpEvent::MfgReply(e) => {
-                    println!("Event: PD-{pd} {:?}", e);
-                },
+                    log::info!("Event: PD-{pd} {:?}", e);
+                }
                 OsdpEvent::IO(e) => {
-                    println!("Event: PD-{pd} {:?}", e);
-                },
+                    log::info!("Event: PD-{pd} {:?}", e);
+                }
                 OsdpEvent::Status(e) => {
-                    println!("Event: PD-{pd} {:?}", e);
-                },
+                    log::info!("Event: PD-{pd} {:?}", e);
+                }
             }
             0
         });
-        let stdout = File::create("/tmp/daemon.out").unwrap();
-        let stderr = File::create("/tmp/daemon.err").unwrap();
+        let stdout = File::create(
+            dev.log_dir
+                .as_path()
+                .join(format!("pd-{}.out.log", &dev.name).as_str()),
+        )?;
+        let stderr = File::create(
+            dev.log_dir
+                .as_path()
+                .join(format!("pd-{}.err.log", &dev.name).as_str()),
+        )?;
         let daemon = Daemonize::new()
             .pid_file(&dev.pid_file)
             .chown_pid_file(true)
@@ -56,4 +62,4 @@ impl CpDaemon {
             thread::sleep(Duration::from_millis(50));
         }
     }
-}
+}

osdpctl/src/main.rs

@@ -2,14 +2,16 @@ mod config;
 mod cp;
 mod pd;
 
-use std::{
-    path::PathBuf,
-    collections::HashMap,
-};
+use std::{collections::HashMap, path::PathBuf};
 
 use clap::{arg, Command};
 use config::{AppConfig, DeviceConfig};
 use cp::CpDaemon;
+use log4rs::{
+    append::console::ConsoleAppender,
+    config::{Appender, Root},
+    Config,
+};
 use pd::PdDaemon;
 
 type Result<T> = anyhow::Result<T, anyhow::Error>;
@@ -20,10 +22,7 @@ fn cli() -> Command {
         .subcommand_required(true)
         .arg_required_else_help(true)
         .allow_external_subcommands(true)
-        .subcommand(
-            Command::new("list")
-                .about("List configured OSDP devices")
-        )
+        .subcommand(Command::new("list").about("List configured OSDP devices"))
         .subcommand(
             Command::new("start")
                 .about("Start a OSDP device")
@@ -50,7 +49,8 @@ fn osdpctl_config_dir() -> Result<PathBuf> {
         cfg_dir = std::fs::canonicalize(&dir)?;
     } else {
         cfg_dir = dirs::config_dir()
-            .or_else(|| Some(PathBuf::from("/tmp/.config/"))).unwrap();
+            .or_else(|| Some(PathBuf::from("/tmp/.config/")))
+            .unwrap();
         cfg_dir.push("osdp");
         if !cfg_dir.is_dir() {
             std::fs::create_dir_all(&cfg_dir)?;
@@ -60,6 +60,13 @@ fn osdpctl_config_dir() -> Result<PathBuf> {
 }
 
 fn main() -> Result<()> {
+    let stdout = ConsoleAppender::builder().build();
+    let log_level = log::LevelFilter::Info;
+    let config = Config::builder()
+        .appender(Appender::builder().build("stdout", Box::new(stdout)))
+        .build(Root::builder().appender("stdout").build(log_level))?;
+    let _ = log4rs::init_config(config).unwrap();
+
     let cfg_dir = osdpctl_config_dir()?;
     let config = AppConfig::from(&cfg_dir.join("osdpctl.cfg"))?;
 
@@ -82,30 +89,33 @@ fn main() -> Result<()> {
             }
         }
         Some(("start", sub_matches)) => {
-            let name = sub_matches.get_one::<String>("DEV")
+            let name = sub_matches
+                .get_one::<String>("DEV")
                 .expect("device name is required");
             if let Some(dev) = device_map.get(name) {
                 match dev {
                     DeviceConfig::CpConfig(c) => {
                         let mut daemon = CpDaemon::new(c)?;
                         daemon.run();
-                    },
+                    }
                     DeviceConfig::PdConfig(c) => {
                         let mut daemon = PdDaemon::new(c)?;
                         daemon.run();
-                    },
+                    }
                 };
             }
         }
         Some(("stop", sub_matches)) => {
-            let name = sub_matches.get_one::<String>("DEV")
+            let name = sub_matches
+                .get_one::<String>("DEV")
                 .expect("device name is required");
             if let Some(dev) = device_map.get(name) {
                 println!("stop: {}", dev.name());
             }
         }
         Some(("attach", sub_matches)) => {
-            let name = sub_matches.get_one::<String>("DEV")
+            let name = sub_matches
+                .get_one::<String>("DEV")
                 .expect("device name is required");
             if let Some(dev) = device_map.get(name) {
                 println!("attach: {}", dev.name());
@@ -114,4 +124,4 @@ fn main() -> Result<()> {
         _ => unreachable!(),
     }
     Ok(())
-}
+}