1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
pub mod errors;
mod config;
mod files;
mod git;
mod test_util;
mod tests;
use config::Config;
use errors::{config::ConfigError, DotbakError, Result};
use files::Files;
use git::Repository;
use itertools::Itertools;
use std::{
path::{Path, PathBuf},
process::Output,
};
/// The path to the configuration file, relative to `XDG_CONFIG_HOME`.
pub(crate) const CONFIG_FILE_NAME: &str = "config.toml";
/// The path to the git repository folder, relative to `XDG_DATA_HOME`.
pub(crate) const REPO_FOLDER_NAME: &str = "dotfiles";
/// The main structure to manage `dotbak`'s actions and such.
pub struct Dotbak {
/// The configuration for `dotbak`.
config: Config,
/// The repository for `dotbak`.
repo: Repository,
/// The dotfiles that are being managed by `dotbak`.
dotfiles: Files,
}
/// Public API for `Dotbak`.
impl Dotbak {
/// Create a new instance of `dotbak`. If the configuration file does not exist, it will be created.
/// If it does exist, it will be loaded.
pub fn init() -> Result<Self> {
let (home, config, repo) = get_dotbak_dirs();
let mut dotbak = Self::init_into_dirs(home, config, repo)?;
dotbak.sync_all_files()?;
Ok(dotbak)
}
/// Clone a remote repository to the local repository. If the local repository already exists, it will be
/// deleted and re-cloned.
pub fn clone(url: &str) -> Result<Self> {
let (home, config, repo) = get_dotbak_dirs();
let mut dotbak = Self::clone_into_dirs(home, config, repo, url)?;
dotbak.sync_all_files()?;
Ok(dotbak)
}
/// Creates a new instance of `dotbak` from pre-defined configuration. If the configuration file does not exist,
/// an error will be returned. If it does exist, it will be loaded.
pub fn load() -> Result<Self> {
let (home, config, repo) = get_dotbak_dirs();
let mut dotbak = Self::load_into_dirs(home, config, repo)?;
dotbak.sync_all_files()?;
Ok(dotbak)
}
/// Sync the state. I.e., load all the files that are supposed to be loaded through `files.include`.
pub fn sync(&mut self) -> Result<()> {
self.sync_all_files()?;
// Commit to the repository.
self.repo.commit("Sync files")?;
// Pull from the repository.
self.repo.pull()?;
// Push to the repository.
self.repo.push()?;
Ok(())
}
/// Add a set of files/folders to the repository. This will move the files/folders to the repository and
/// symlink them to their original location. It also writes their paths to the configuration file in the `include`
/// list.
pub fn add<P>(&mut self, files: &[P]) -> Result<()>
where
P: AsRef<Path>,
{
// Add the paths to the `include` list.
self.config
.files
.include
.extend(files.iter().map(|p| p.as_ref().to_path_buf()));
self.config.save_config()?;
// Move the files/folders to the repository and symlink them to their original location.
self.sync_files(files)?;
// Commit to the repository.
// TODO: Make this message configurable.
self.repo.commit(&format!(
"Add files: {}",
files.iter().map(|p| p.as_ref().display()).join(", ")
))?;
Ok(())
}
/// Remove a set of files/folders from the repository. This will remove the files/folders from the repository
/// and restore them to their original location. It also removes their paths from the configuration file in the
/// `include` list.
pub fn remove<P>(&mut self, files: &[P]) -> Result<()>
where
P: AsRef<Path>,
{
// Remove the paths from the `include` list.
self.config
.files
.include
.retain(|p| !files.iter().any(|p2| p == p2.as_ref()));
// Save the configuration file.
self.config.save_config()?;
// Remove the files/folders from the repository and restore them to their original location.
self.dotfiles.remove_and_restore(files)?;
// Commit to the repository.
// TODO: Make this message configurable.
self.repo.commit(&format!(
"Remove files: {}",
files.iter().map(|p| p.as_ref().display()).join(", ")
))?;
Ok(())
}
/// Push the repository to the remote.
/// TODO: Logging/tracing and such.
pub fn push(&mut self) -> Result<Output> {
self.sync_all_files()?;
self.repo.push()
}
/// Pull changes from the remote.
/// TODO: Logging/tracing and such.
pub fn pull(&mut self) -> Result<Output> {
let output = self.repo.pull()?;
self.sync_all_files()?;
Ok(output)
}
/// Run an arbitrary git command on the repository.
pub fn arbitrary_git_command(&mut self, args: &[&str]) -> Result<Output> {
let output = self.repo.arbitrary_command(args)?;
self.sync_all_files()?;
Ok(output)
}
// Deinitializes `dotbak`, removing the configuration file and the repository. This also restores all files
// that were managed by `dotbak` to their original location.
pub fn deinit(self) -> Result<()> {
// Restore all files that were managed by `dotbak` to their original location.
self.dotfiles
.remove_and_restore(&self.config.files.include)?;
// Remove the configuration file.
self.config.delete_config()?;
// Remove the repository.
self.repo.delete()?;
Ok(())
}
}
/// Private API for `Dotbak`. These are mainly used for testing.
impl Dotbak {
/// Initialize a new instance of `dotbak`, loading the configuration file from `<dotbak>/config.toml` and the
/// repository from `<dotbak>/dotfiles`. The user's home directory is assumed to be `<home>`.
fn init_into_dirs<P1, P2, P3>(home: P1, config: P2, repo: P3) -> Result<Self>
where
P1: AsRef<Path>,
P2: AsRef<Path>,
P3: AsRef<Path>,
{
let config_path = config.as_ref().to_path_buf();
let repo_path = repo.as_ref().to_path_buf();
let home_path = home.as_ref().to_path_buf();
// Try to load the configuration file.
let config = match Config::load_config(&config_path) {
// If the configuration file exists, load it.
// TODO: log that the configuration file was loaded, not created.
Ok(config) => config,
// If the configuration file does not exist, create it.
// TODO: log that the configuration file was created, not loaded.
Err(DotbakError::Config {
source: ConfigError::ConfigNotFound { .. },
}) => Config::create_config(config_path)?,
// If the error is not a `ConfigNotFound` error, return it.
Err(err) => return Err(err),
};
// Try to load the repository.
let repo = Repository::init(&repo_path, None)?;
Ok(Dotbak {
dotfiles: Files::init(home_path, repo_path),
config,
repo,
})
}
/// Load an instance of `dotbak`, loading the configuration file from `<dotbak>/config.toml` and the
/// repository from `<dotbak>/dotfiles`.
fn load_into_dirs<P1, P2, P3>(home: P1, config: P2, repo: P3) -> Result<Self>
where
P1: AsRef<Path>,
P2: AsRef<Path>,
P3: AsRef<Path>,
{
let config_path = config.as_ref().to_path_buf();
let repo_path = repo.as_ref().to_path_buf();
let home_path = home.as_ref().to_path_buf();
// Load the configuration file and the repository.
let config = Config::load_config(config_path)?;
let repo = Repository::load(&repo_path)?;
Ok(Dotbak {
dotfiles: Files::init(home_path, repo_path),
config,
repo,
})
}
/// Clone an instance of `dotbak`, cloning the repository from the given URL to `<dotbak>/dotfiles`.
/// The user's home directory is assumed to be `<home>`.
fn clone_into_dirs<P1, P2, P3>(home: P1, config: P2, repo: P3, url: &str) -> Result<Self>
where
P1: AsRef<Path>,
P2: AsRef<Path>,
P3: AsRef<Path>,
{
let config_path = config.as_ref().to_path_buf();
let repo_path = repo.as_ref().to_path_buf();
let home_path = home.as_ref().to_path_buf();
// Try to load the configuration file.
let config = match Config::load_config(&config_path) {
// If the configuration file exists, load it.
// TODO: log that the configuration file was loaded, not created.
Ok(config) => config,
// If the configuration file does not exist, create it.
// TODO: log that the configuration file was created, not loaded.
Err(DotbakError::Config {
source: ConfigError::ConfigNotFound { .. },
}) => Config::create_config(config_path)?,
// If the error is not a `ConfigNotFound` error, return it.
Err(err) => return Err(err),
};
// Try to load the repository.
let repo = Repository::clone(&repo_path, url)?;
Ok(Dotbak {
dotfiles: Files::init(home_path, repo_path),
config,
repo,
})
}
/// Synchronize all files that are supposed to be synchronized.
fn sync_all_files(&mut self) -> Result<()> {
let files = self.config.files.include.clone(); // TODO: Get rid of this clone!
self.sync_files(&files)
}
/// Synchronize a select set of files.
fn sync_files<P>(&mut self, files: &[P]) -> Result<()>
where
P: AsRef<Path>,
{
// Move the files/folders to the repository and symlink them to their original location.
self.dotfiles.move_and_symlink(files)?;
// Synchronize the files/folders.
self.dotfiles.symlink_back_home(files)?;
Ok(())
}
}
/// Get the directories that `dotbak` uses. In order, it returns the `<home>`, `<config>`, and `<repo>` dirs.
fn get_dotbak_dirs() -> (PathBuf, PathBuf, PathBuf) {
let home_dir = dirs::home_dir().expect("You should have a home directory!");
let dotbak_dir = home_dir.join(".dotbak");
(
home_dir,
dotbak_dir.join(CONFIG_FILE_NAME),
dotbak_dir.join(REPO_FOLDER_NAME),
)
}