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
use log::{debug, warn};
use serde::{Deserialize, Serialize};
use shellexpand::LookupError;
use std::env::VarError;
use std::{fs, io, os::unix, path::Path};

#[derive(Debug)]
pub enum Error {
    /// Could not expand path
    ShellExpand(LookupError<VarError>),

    /// io error creating symlink.
    Io(io::Error),
}

impl std::fmt::Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Error::ShellExpand(e) => write!(f, "Unable to expand path: {}", e),
            Error::Io(e) => write!(f, "{}", e),
        }
    }
}

impl From<LookupError<VarError>> for Error {
    fn from(val: LookupError<VarError>) -> Self {
        Error::ShellExpand(val)
    }
}

impl From<io::Error> for Error {
    fn from(val: io::Error) -> Self {
        Error::Io(val)
    }
}

#[derive(Debug, Serialize, Deserialize, PartialEq)]
pub struct SymLink {
    pub dst: String,

    pub src: String,

    #[serde(default)]
    pub relink: bool,

    #[serde(default = "default_create")]
    pub create: bool,
}

impl SymLink {
    pub fn new(dst: &str, src: &str, relink: bool, create: bool) -> Self {
        SymLink {
            dst: dst.to_string(),
            src: src.to_string(),
            relink,
            create,
        }
    }
}

pub fn symlink(link: &SymLink) -> Result<(), Error> {
    let mut src = String::new();
    let mut dst = String::new();
    symlink_path(
        expand_path(&link.src, &mut src)?,
        expand_path(&link.dst, &mut dst)?,
        link.relink,
        link.create,
    )
}

fn symlink_path(src: &Path, dst: &Path, relink: bool, create: bool) -> Result<(), Error> {
    if !src.exists() {
        return Err(Error::Io(io::Error::new(
            io::ErrorKind::NotFound,
            format!("source file of link does not exists: {:?}", src),
        )));
    }

    if src.is_dir() && dst.is_dir() {
        return symlink_dir(src, dst, relink, create);
    }

    if dst.exists() {
        if !relink {
            warn!("Symbolic link {:?} already exists", dst);
            return Ok(());
        }
        warn!("Relinking {:?}", dst);
        fs::remove_file(dst)?;
    }

    if create {
        if let Some(parent) = dst.parent() {
            if !parent.exists() {
                debug!("Create destination sub directory {:?}", parent);
                fs::create_dir_all(parent)?;
            }
        }
    }

    debug!("Linking {:?} in {:?}", src, dst);
    unix::fs::symlink(src, dst)?;
    Ok(())
}

fn symlink_dir(src: &Path, dst: &Path, relink: bool, create: bool) -> Result<(), Error> {
    debug!("Create symbolic link to all files into {:?}", src);
    for entry in fs::read_dir(src)? {
        let entry = entry?;

        // The first entry of iterator is src path
        if entry.path() == src {
            continue;
        }

        if entry.path().is_dir() {
            if let Some(name) = entry.path().file_name() {
                let dst_dir = dst.join(name);
                if !dst_dir.exists() {
                    fs::create_dir(&dst_dir)?;
                }
                symlink_dir(entry.path().as_path(), dst_dir.as_path(), relink, create)?;
            }
        } else if let Some(name) = entry.path().file_name() {
            symlink_path(
                entry.path().as_path(),
                dst.join(name).as_path(),
                relink,
                create,
            )?;
        }
    }
    Ok(())
}

// Convert a path like `~/some/path/in/home` to `/home/user/some/path/in/home`
fn expand_path<'a>(s: &str, out: &'a mut String) -> Result<&'a Path, Error> {
    let path = shellexpand::full(s)?;
    out.push_str(path.as_ref());
    Ok(Path::new(out))
}

fn default_create() -> bool {
    true
}

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

    #[test]
    fn test_create_dst_subdirectory() {
        let src_dir = tempdir().unwrap();
        let dst_dir = tempdir().unwrap();

        let src_path_config = src_dir.path().join("src");
        std::fs::File::create(&src_path_config).unwrap();

        let dst_path_config = dst_dir.path().join("dst/").join("file");

        let link = SymLink::new(
            &dst_path_config.to_str().unwrap(),
            &src_path_config.to_str().unwrap(),
            true,
            true,
        );

        assert!(symlink(&link).is_ok());
    }

    #[test]
    fn test_src_file_not_exist() {
        let link = SymLink::new("/tmp/src-invalid", "/tmp/dst-invalid", false, false);
        assert!(symlink(&link).is_err());
    }

    #[test]
    fn test_link_dir() {
        let src_dir = tempdir().unwrap();
        let dst_dir = tempdir().unwrap();

        let src_path_config = src_dir.path().join("src");
        std::fs::File::create(&src_path_config).unwrap();

        let link = SymLink::new(
            &dst_dir.path().to_str().unwrap(),
            &src_dir.path().to_str().unwrap(),
            true,
            false,
        );

        symlink(&link).unwrap();

        let dst_config = dst_dir.path().join(src_path_config.file_name().unwrap());

        assert!(
            dst_config.as_path().exists(),
            "Assert that {:?} is created",
            dst_config.as_path()
        );
    }

    #[test]
    fn test_relink_links() {
        let src_dir = tempdir().unwrap();
        let dst_dir = tempdir().unwrap();

        let src_path_config = src_dir.path().join("src");
        std::fs::File::create(&src_path_config).unwrap();

        let dst_path_config = dst_dir.path().join("dst");
        std::fs::File::create(&dst_path_config).unwrap();

        let link = SymLink::new(
            &dst_path_config.to_str().unwrap(),
            &src_path_config.to_str().unwrap(),
            true,
            false,
        );

        symlink(&link).unwrap();

        let is_symlink = std::fs::symlink_metadata(dst_path_config.as_path())
            .unwrap()
            .file_type()
            .is_symlink();

        assert_eq!(true, is_symlink);
    }

    #[test]
    fn test_not_relink_links() {
        let src_dir = tempdir().unwrap();
        let dst_dir = tempdir().unwrap();

        let src_path_config = src_dir.path().join("src");
        std::fs::File::create(&src_path_config).unwrap();

        let dst_path_config = dst_dir.path().join("dst");
        std::fs::File::create(&dst_path_config).unwrap();

        let link = SymLink::new(
            &dst_path_config.to_str().unwrap(),
            &src_path_config.to_str().unwrap(),
            false,
            false,
        );

        symlink(&link).unwrap();

        let is_symlink = std::fs::symlink_metadata(dst_path_config.as_path())
            .unwrap()
            .file_type()
            .is_symlink();

        assert_eq!(false, is_symlink);
    }
}