/* * 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 . */ #[macro_use] extern crate lazy_static; use std::thread; use std::fs::{File, OpenOptions}; use std::process::exit; use std::sync::mpsc; use std::sync::mpsc::Receiver; use std::time::Duration; use clap::{App, Arg, SubCommand, ArgMatches}; use fs2::FileExt; use log::{info, warn, LevelFilter}; use simplelog::{CombinedLogger, SharedLogger, TerminalMode, TermLogger, WriteLogger}; use crate::config::ConfigSet; use crate::config::runtime::RuntimeConfigManager; use crate::engine::Engine; use crate::event::*; use crate::event::manager::{DefaultEventManager, EventManager}; use crate::matcher::scrolling::ScrollingMatcher; use crate::system::SystemManager; use crate::ui::UIManager; use crate::protocol::*; use std::io::{BufReader, BufRead}; use crate::package::default::DefaultPackageManager; use crate::package::{PackageManager, InstallResult, UpdateResult, RemoveResult}; mod ui; mod event; mod check; mod utils; mod bridge; mod engine; mod config; mod system; mod context; mod matcher; mod package; mod keyboard; mod protocol; mod clipboard; mod extension; mod sysdaemon; const VERSION: &str = env!("CARGO_PKG_VERSION"); const LOG_FILE: &str = "espanso.log"; fn main() { let install_subcommand = SubCommand::with_name("install") .about("Install a package. Equivalent to 'espanso package install'") .arg(Arg::with_name("package_name") .help("Package name")); let uninstall_subcommand = SubCommand::with_name("uninstall") .about("Remove an installed package. Equivalent to 'espanso package uninstall'") .arg(Arg::with_name("package_name") .help("Package name")); let mut clap_instance = App::new("espanso") .version(VERSION) .author("Federico Terzi") .about("Cross-platform Text Expander written in Rust") .arg(Arg::with_name("v") .short("v") .multiple(true) .help("Sets the level of verbosity")) .subcommand(SubCommand::with_name("cmd") .about("Send a command to the espanso daemon.") .subcommand(SubCommand::with_name("exit") .about("Terminate the daemon.")) .subcommand(SubCommand::with_name("enable") .about("Enable the espanso replacement engine.")) .subcommand(SubCommand::with_name("disable") .about("Disable the espanso replacement engine.")) .subcommand(SubCommand::with_name("toggle") .about("Toggle the status of the espanso replacement engine.")) ) .subcommand(SubCommand::with_name("dump") .about("Prints all current configuration options.")) .subcommand(SubCommand::with_name("detect") .about("Tool to detect current window properties, to simplify filters creation.")) .subcommand(SubCommand::with_name("daemon") .about("Start the daemon without spawning a new process.")) .subcommand(SubCommand::with_name("register") .about("MacOS and Linux only. Register espanso in the system daemon manager.")) .subcommand(SubCommand::with_name("unregister") .about("MacOS and Linux only. Unregister espanso from the system daemon manager.")) .subcommand(SubCommand::with_name("log") .about("Print the latest daemon logs.")) .subcommand(SubCommand::with_name("start") .about("Start the daemon spawning a new process in the background.")) .subcommand(SubCommand::with_name("stop") .about("Stop the espanso daemon.")) .subcommand(SubCommand::with_name("restart") .about("Restart the espanso daemon.")) .subcommand(SubCommand::with_name("status") .about("Check if the espanso daemon is running or not.")) .subcommand(SubCommand::with_name("path") .about("Prints all the current espanso directory paths, to easily locate configuration and data paths.") .subcommand(SubCommand::with_name("config") .about("Print the current config folder path.")) .subcommand(SubCommand::with_name("packages") .about("Print the current packages folder path.")) .subcommand(SubCommand::with_name("data") .about("Print the current data folder path.")) .subcommand(SubCommand::with_name("default") .about("Print the default configuration file path.")) ) // Package manager .subcommand(SubCommand::with_name("package") .about("Espanso package manager commands") .subcommand(install_subcommand.clone()) .subcommand(uninstall_subcommand.clone()) .subcommand(SubCommand::with_name("list") .about("List all installed packages") .arg(Arg::with_name("full") .help("Print all package info") .long("full"))) .subcommand(SubCommand::with_name("refresh") .about("Update espanso package index")) ) .subcommand(install_subcommand) .subcommand(uninstall_subcommand); let matches = clap_instance.clone().get_matches(); let log_level = matches.occurrences_of("v") as i32; // Load the configuration let mut config_set = ConfigSet::load_default().unwrap_or_else(|e| { println!("{}", e); exit(1); }); config_set.default.log_level = log_level; // Match the correct subcommand if let Some(matches) = matches.subcommand_matches("cmd") { cmd_main(config_set, matches); return; } if matches.subcommand_matches("dump").is_some() { println!("{:#?}", config_set); return; } if matches.subcommand_matches("detect").is_some() { detect_main(); return; } if matches.subcommand_matches("daemon").is_some() { daemon_main(config_set); return; } if matches.subcommand_matches("register").is_some() { register_main(config_set); return; } if matches.subcommand_matches("unregister").is_some() { unregister_main(config_set); return; } if matches.subcommand_matches("log").is_some() { log_main(); return; } if matches.subcommand_matches("start").is_some() { start_main(config_set); return; } if matches.subcommand_matches("status").is_some() { status_main(); return; } if matches.subcommand_matches("stop").is_some() { stop_main(config_set); return; } if matches.subcommand_matches("restart").is_some() { restart_main(config_set); return; } if let Some(matches) = matches.subcommand_matches("install") { install_main(config_set, matches); return; } if let Some(matches) = matches.subcommand_matches("uninstall") { remove_package_main(config_set, matches); return; } if let Some(matches) = matches.subcommand_matches("path") { path_main(config_set, matches); return; } if let Some(matches) = matches.subcommand_matches("package") { if let Some(matches) = matches.subcommand_matches("install") { install_main(config_set, matches); return; } if let Some(matches) = matches.subcommand_matches("uninstall") { remove_package_main(config_set, matches); return; } if let Some(matches) = matches.subcommand_matches("list") { list_package_main(config_set, matches); return; } if matches.subcommand_matches("refresh").is_some() { update_index_main(config_set); return; } } // Defaults help print clap_instance.print_long_help().expect("Unable to print help"); println!(); } /// Daemon subcommand, start the event loop and spawn a background thread worker fn daemon_main(config_set: ConfigSet) { // Try to acquire lock file let lock_file = acquire_lock(); if lock_file.is_none() { println!("espanso is already running."); exit(3); } precheck_guard(); // Initialize log let log_level = match config_set.default.log_level { 0 => LevelFilter::Warn, 1 => LevelFilter::Info, 2 | _ => LevelFilter::Debug, }; let mut log_outputs: Vec> = Vec::new(); // Initialize terminal output let terminal_out = TermLogger::new(log_level, simplelog::Config::default(), TerminalMode::Mixed); if let Some(terminal_out) = terminal_out { log_outputs.push(terminal_out); } // Initialize log file output let espanso_dir = context::get_data_dir(); let log_file_path = espanso_dir.join(LOG_FILE); let log_file = OpenOptions::new() .read(true) .write(true) .create(true) .truncate(true) .open(log_file_path) .expect("Cannot create log file."); let file_out = WriteLogger::new(LevelFilter::Info, simplelog::Config::default(), log_file); log_outputs.push(file_out); CombinedLogger::init( log_outputs ).expect("Error opening log destination"); // Activate logging for panics log_panics::init(); info!("espanso version {}", VERSION); info!("using config path: {}", context::get_config_dir().to_string_lossy()); info!("using package path: {}", context::get_package_dir().to_string_lossy()); info!("starting daemon..."); let (send_channel, receive_channel) = mpsc::channel(); let context = context::new(send_channel.clone()); let config_set_copy = config_set.clone(); thread::Builder::new().name("daemon_background".to_string()).spawn(move || { daemon_background(receive_channel, config_set_copy); }).expect("Unable to spawn daemon background thread"); let ipc_server = protocol::get_ipc_server(config_set, send_channel.clone()); ipc_server.start(); context.eventloop(); } /// Background thread worker for the daemon fn daemon_background(receive_channel: Receiver, config_set: ConfigSet) { let system_manager = system::get_manager(); let config_manager = RuntimeConfigManager::new(config_set, system_manager); let ui_manager = ui::get_uimanager(); ui_manager.notify("espanso is running!"); let clipboard_manager = clipboard::get_manager(); let keyboard_manager = keyboard::get_manager(); let extensions = extension::get_extensions(); let engine = Engine::new(&keyboard_manager, &clipboard_manager, &config_manager, &ui_manager, extensions, ); let matcher = ScrollingMatcher::new(&config_manager, &engine); let event_manager = DefaultEventManager::new( receive_channel, vec!(&matcher), vec!(&engine, &matcher), ); info!("espanso is running!"); event_manager.eventloop(); } /// start subcommand, spawn a background espanso process. fn start_main(config_set: ConfigSet) { // Try to acquire lock file let lock_file = acquire_lock(); if lock_file.is_none() { println!("espanso is already running."); exit(3); } release_lock(lock_file.unwrap()); precheck_guard(); start_daemon(config_set); } #[cfg(target_os = "windows")] fn start_daemon(_: ConfigSet) { unsafe { let res = bridge::windows::start_daemon_process(); if res < 0 { println!("Error starting daemon process"); } } } #[cfg(target_os = "macos")] fn start_daemon(config_set: ConfigSet) { if config_set.default.use_system_agent { use std::process::Command; let res = Command::new("launchctl") .args(&["start", "com.federicoterzi.espanso"]) .status(); if let Ok(status) = res { if status.success() { println!("Daemon started correctly!") }else{ eprintln!("Error starting launchd daemon with status: {}", status); } }else{ eprintln!("Error starting launchd daemon: {}", res.unwrap_err()); } }else{ fork_daemon(config_set); } } #[cfg(target_os = "linux")] fn start_daemon(config_set: ConfigSet) { use std::process::{Command, Stdio}; // Check if Systemd is available in the system let status = Command::new("systemctl") .args(&["--version"]) .stdin(Stdio::null()) .stdout(Stdio::null()) .status(); // If Systemd is not available in the system, espanso should default to unmanaged mode // See issue https://github.com/federico-terzi/espanso/issues/139 let force_unmanaged = if let Err(status) = status { true } else { false }; if config_set.default.use_system_agent && !force_unmanaged { // Make sure espanso is currently registered in systemd let res = Command::new("systemctl") .args(&["--user", "is-enabled", "espanso.service"]) .output(); if !res.unwrap().status.success() { use dialoguer::Confirmation; if Confirmation::new() .with_text("espanso must be registered to systemd (user level) first. Do you want to proceed?") .default(true) .show_default(true) .interact().expect("Unable to read user answer") { register_main(config_set); }else{ eprintln!("Please register espanso to systemd with this command:"); eprintln!(" espanso register"); // TODO: enable flag to use non-managed daemon mode std::process::exit(4); } } // Start the espanso service let res = Command::new("systemctl") .args(&["--user", "start", "espanso.service"]) .status(); if let Ok(status) = res { if status.success() { println!("Daemon started correctly!") }else{ eprintln!("Error starting systemd daemon with status: {}", status); } }else{ eprintln!("Error starting systemd daemon: {}", res.unwrap_err()); } }else{ if force_unmanaged { eprintln!("Systemd is not available in this system, switching to unmanaged mode."); } fork_daemon(config_set); } } #[cfg(not(target_os = "windows"))] fn fork_daemon(config_set: ConfigSet) { unsafe { let pid = libc::fork(); if pid < 0 { println!("Unable to fork."); exit(4); } if pid > 0 { // Parent process exit println!("daemon started!"); exit(0); } // Spawned process // Create a new SID for the child process let sid = libc::setsid(); if sid < 0 { exit(5); } // Detach stdout and stderr let null_path = std::ffi::CString::new("/dev/null").expect("CString unwrap failed"); let fd = libc::open(null_path.as_ptr(), libc::O_RDWR, 0); if fd != -1 { libc::dup2(fd, libc::STDIN_FILENO); libc::dup2(fd, libc::STDOUT_FILENO); libc::dup2(fd, libc::STDERR_FILENO); } } daemon_main(config_set); } /// status subcommand, print the current espanso status fn status_main() { let lock_file = acquire_lock(); if let Some(lock_file) = lock_file { println!("espanso is not running"); release_lock(lock_file); }else{ println!("espanso is running"); } } /// Stop subcommand, used to stop the daemon. fn stop_main(config_set: ConfigSet) { // Try to acquire lock file let lock_file = acquire_lock(); if lock_file.is_some() { println!("espanso daemon is not running."); release_lock(lock_file.unwrap()); exit(3); } let res = send_command(config_set, IPCCommand{ id: "exit".to_owned(), payload: "".to_owned(), }); if let Err(e) = res { println!("{}", e); exit(1); }else{ exit(0); } } /// Kill the daemon if running and start it again fn restart_main(config_set: ConfigSet) { // Kill the daemon if running let lock_file = acquire_lock(); if lock_file.is_none() { // Terminate the current espanso daemon send_command(config_set.clone(), IPCCommand{ id: "exit".to_owned(), payload: "".to_owned(), }).unwrap_or_else(|e| warn!("Unable to send IPC command to daemon: {}", e)); }else{ release_lock(lock_file.unwrap()); } std::thread::sleep(Duration::from_millis(300)); // Restart the daemon start_main(config_set); } /// Cli tool used to analyze active windows to extract useful information /// to create configuration filters. #[cfg(not(target_os = "macos"))] fn detect_main() { let system_manager = system::get_manager(); println!("Listening for changes, now focus the window you want to analyze."); println!("You can terminate with CTRL+C\n"); let mut last_title : String = "".to_owned(); let mut last_class : String = "".to_owned(); let mut last_exec : String = "".to_owned(); loop { let curr_title = system_manager.get_current_window_title().unwrap_or_default(); let curr_class = system_manager.get_current_window_class().unwrap_or_default(); let curr_exec = system_manager.get_current_window_executable().unwrap_or_default(); // Check if a change occurred if curr_title != last_title || curr_class != last_class || curr_exec != last_exec { println!("Detected change, current window has properties:"); println!("==> Title: '{}'", curr_title); println!("==> Class: '{}'", curr_class); println!("==> Executable: '{}'", curr_exec); println!(); } last_title = curr_title; last_class = curr_class; last_exec = curr_exec; thread::sleep(Duration::from_millis(500)); } } /// Cli tool used to analyze active windows to extract useful information /// to create configuration filters. /// On macOS version we need to start an event loop for the app to register changes. #[cfg(target_os = "macos")] fn detect_main() { thread::spawn(|| { use std::io::Write; use std::io::stdout; let system_manager = system::get_manager(); println!("Listening for changes, now focus the window you want to analyze."); println!("Warning: stay on the window for a few seconds, as it may take a while to register."); println!("You can terminate with CTRL+C\n"); let mut last_title : String = "".to_owned(); let mut last_class : String = "".to_owned(); let mut last_exec : String = "".to_owned(); loop { let curr_title = system_manager.get_current_window_title().unwrap_or_default(); let curr_class = system_manager.get_current_window_class().unwrap_or_default(); let curr_exec = system_manager.get_current_window_executable().unwrap_or_default(); // Check if a change occurred if curr_title != last_title || curr_class != last_class || curr_exec != last_exec { println!("Detected change, current window has properties:"); println!("==> Title: '{}'", curr_title); println!("==> Class: '{}'", curr_class); println!("==> Executable: '{}'", curr_exec); println!(); } last_title = curr_title; last_class = curr_class; last_exec = curr_exec; thread::sleep(Duration::from_millis(500)); } }); unsafe { crate::bridge::macos::headless_eventloop(); } } /// Send the given command to the espanso daemon fn cmd_main(config_set: ConfigSet, matches: &ArgMatches) { let command = if matches.subcommand_matches("exit").is_some() { Some(IPCCommand { id: String::from("exit"), payload: String::from(""), }) }else if matches.subcommand_matches("toggle").is_some() { Some(IPCCommand { id: String::from("toggle"), payload: String::from(""), }) }else if matches.subcommand_matches("enable").is_some() { Some(IPCCommand { id: String::from("enable"), payload: String::from(""), }) }else if matches.subcommand_matches("disable").is_some() { Some(IPCCommand { id: String::from("disable"), payload: String::from(""), }) }else{ None }; if let Some(command) = command { let res = send_command(config_set, command); if res.is_ok() { exit(0); }else{ println!("{}", res.unwrap_err()); } } exit(1); } fn send_command(config_set: ConfigSet, command: IPCCommand) -> Result<(), String> { let ipc_client = protocol::get_ipc_client(config_set); ipc_client.send_command(command) } fn log_main() { let espanso_dir = context::get_data_dir(); let log_file_path = espanso_dir.join(LOG_FILE); if !log_file_path.exists() { println!("No log file found."); exit(2); } let log_file = File::open(log_file_path); if let Ok(log_file) = log_file { let reader = BufReader::new(log_file); for line in reader.lines() { if let Ok(line) = line { println!("{}", line); } } exit(0); }else{ println!("Error reading log file"); exit(1); } } fn register_main(config_set: ConfigSet) { sysdaemon::register(config_set); } fn unregister_main(config_set: ConfigSet) { sysdaemon::unregister(config_set); } fn install_main(_config_set: ConfigSet, matches: &ArgMatches) { let package_name = matches.value_of("package_name").unwrap_or_else(|| { eprintln!("Missing package name!"); exit(1); }); let mut package_manager = DefaultPackageManager::new_default(); if package_manager.is_index_outdated() { println!("Updating package index..."); let res = package_manager.update_index(false); match res { Ok(update_result) => { match update_result { UpdateResult::NotOutdated => { eprintln!("Index was already up to date"); }, UpdateResult::Updated => { println!("Index updated!"); }, } }, Err(e) => { eprintln!("{}", e); exit(2); }, } }else{ println!("Using cached package index, run 'espanso package refresh' to update it.") } let res = package_manager.install_package(package_name); match res { Ok(install_result) => { match install_result { InstallResult::NotFoundInIndex => { eprintln!("Package not found"); }, InstallResult::NotFoundInRepo => { eprintln!("Package not found in repository, are you sure the folder exist in the repo?"); }, InstallResult::UnableToParsePackageInfo => { eprintln!("Unable to parse Package info from README.md"); }, InstallResult::MissingPackageVersion => { eprintln!("Missing package version"); }, InstallResult::AlreadyInstalled => { eprintln!("{} already installed!", package_name); }, InstallResult::Installed => { println!("{} successfully installed!", package_name); println!(); println!("You need to restart espanso for changes to take effect, using:"); println!(" espanso restart"); }, } }, Err(e) => { eprintln!("{}", e); }, } } fn remove_package_main(_config_set: ConfigSet, matches: &ArgMatches) { let package_name = matches.value_of("package_name").unwrap_or_else(|| { eprintln!("Missing package name!"); exit(1); }); let package_manager = DefaultPackageManager::new_default(); let res = package_manager.remove_package(package_name); match res { Ok(remove_result) => { match remove_result { RemoveResult::NotFound => { eprintln!("{} package was not installed.", package_name); }, RemoveResult::Removed => { println!("{} successfully removed!", package_name); println!(); println!("You need to restart espanso for changes to take effect, using:"); println!(" espanso restart"); }, } }, Err(e) => { eprintln!("{}", e); }, } } fn update_index_main(_config_set: ConfigSet) { let mut package_manager = DefaultPackageManager::new_default(); let res = package_manager.update_index(true); match res { Ok(update_result) => { match update_result { UpdateResult::NotOutdated => { eprintln!("Index was already up to date"); }, UpdateResult::Updated => { println!("Index updated!"); }, } }, Err(e) => { eprintln!("{}", e); exit(2); }, } } fn list_package_main(_config_set: ConfigSet, matches: &ArgMatches) { let package_manager = DefaultPackageManager::new_default(); let list = package_manager.list_local_packages(); if matches.is_present("full") { for package in list.iter() { println!("{:?}", package); } }else{ for package in list.iter() { println!("{} - {}", package.name, package.version); } } } fn path_main(_config_set: ConfigSet, matches: &ArgMatches) { let config = crate::context::get_config_dir(); let packages = crate::context::get_package_dir(); let data = crate::context::get_data_dir(); if matches.subcommand_matches("config").is_some() { println!("{}", config.to_string_lossy()); }else if matches.subcommand_matches("packages").is_some() { println!("{}", packages.to_string_lossy()); }else if matches.subcommand_matches("data").is_some() { println!("{}", data.to_string_lossy()); }else if matches.subcommand_matches("default").is_some() { let default_file = config.join(crate::config::DEFAULT_CONFIG_FILE_NAME); println!("{}", default_file.to_string_lossy()); }else{ println!("Config: {}", config.to_string_lossy()); println!("Packages: {}", packages.to_string_lossy()); println!("Data: {}", data.to_string_lossy()); } } fn acquire_lock() -> Option { let espanso_dir = context::get_data_dir(); let lock_file_path = espanso_dir.join("espanso.lock"); let file = OpenOptions::new() .read(true) .write(true) .create(true) .open(lock_file_path) .expect("Cannot create reference to lock file."); let res = file.try_lock_exclusive(); if res.is_ok() { return Some(file) } None } fn release_lock(lock_file: File) { lock_file.unlock().unwrap() } /// Used to make sure all the required dependencies are present before starting espanso. fn precheck_guard() { let satisfied = check::check_dependencies(); if !satisfied { println!(); println!("Pre-check was not successful, espanso could not be started."); exit(5); } }