liboxen 0.9.9-alpha

Oxen is a fast, unstructured data version control, to help version datasets, written in Rust.
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

use filetime::FileTime;
use std::path::Path;

use crate::api::local::resource;
use crate::core::index::Stager;
use crate::core::index::{CommitDirEntryWriter, CommitEntryReader};
use crate::error::OxenError;
use crate::model::{Commit, CommitEntry, LocalRepository};
use crate::opts::RestoreOpts;
use crate::util;

use super::CommitDirEntryReader;

pub fn restore(repo: &LocalRepository, opts: RestoreOpts) -> Result<(), OxenError> {
    if opts.staged {
        return restore_staged(repo, opts);
    }

    let path = opts.path;
    let commit = resource::get_commit_or_head(repo, opts.source_ref)?;
    let reader = CommitEntryReader::new(repo, &commit)?;

    // Check if is directory, need to recursively restore
    if reader.has_dir(&path) {
        log::debug!("Restoring directory: {:?}", path);
        restore_dir(repo, &path, &commit, &reader)
    } else {
        // is file
        if let Some(entry) = reader.get_entry(&path)? {
            restore_file(repo, &path, &commit.id, &entry)
        } else {
            let error = format!("Could not restore file: {path:?} does not exist");
            Err(OxenError::basic_str(error))
        }
    }
}

fn restore_staged(repo: &LocalRepository, opts: RestoreOpts) -> Result<(), OxenError> {
    let path = opts.path;
    log::debug!("restore_staged {:?}", path);

    let stager = Stager::new(repo)?;
    if stager.has_entry(&path) {
        stager.remove_staged_file(&path)
    } else if stager.has_staged_dir(&path) {
        stager.remove_staged_dir(&path)
    } else {
        let error = format!("Could not restore staged file: {path:?} does not exist");
        Err(OxenError::basic_str(error))
    }
}

fn restore_dir(
    repo: &LocalRepository,
    path: &Path,
    commit: &Commit,
    dir_reader: &CommitEntryReader,
) -> Result<(), OxenError> {
    let dirs = dir_reader.list_dirs()?;
    for dir in dirs {
        if dir.starts_with(path) {
            let reader = CommitDirEntryReader::new(repo, &commit.id, &dir)?;
            let entries = reader.list_entries()?;
            let msg = format!("Restoring Directory: {:?}", dir);
            let bar = util::progress_bar::oxen_progress_bar_with_msg(entries.len() as u64, &msg);
            // iterate over entries in parallel
            entries.iter().for_each(|entry| {
                match restore_file(repo, &entry.path, &commit.id, entry) {
                    Ok(_) => {}
                    Err(e) => {
                        log::error!("Error restoring file {:?}: {:?}", entry.path, e);
                    }
                }
                bar.inc(1);
            });
            bar.finish_and_clear();
        }
    }

    Ok(())
}

pub fn restore_file(
    repo: &LocalRepository,
    path: &Path,
    commit_id: &str,
    entry: &CommitEntry,
) -> Result<(), OxenError> {
    // Update the local modified timestamps
    let dir = path.parent().unwrap();
    let committer = CommitDirEntryWriter::new(repo, commit_id, dir)?;
    restore_file_with_commit_writer(repo, path, entry, &committer)?;

    Ok(())
}

pub fn restore_file_with_commit_writer(
    repo: &LocalRepository,
    path: &Path,
    entry: &CommitEntry,
    committer: &CommitDirEntryWriter,
) -> Result<(), OxenError> {
    // copy data back over
    restore_regular(repo, path, entry)?;

    // Update the local modified timestamps
    let working_path = repo.path.join(path);
    let metadata = util::fs::metadata(working_path).unwrap();
    let mtime = FileTime::from_last_modification_time(&metadata);
    committer.set_file_timestamps(entry, &mtime).unwrap();

    Ok(())
}

fn restore_regular(
    repo: &LocalRepository,
    path: &Path,
    entry: &CommitEntry,
) -> Result<(), OxenError> {
    let version_path = util::fs::version_path(repo, entry);
    let working_path = repo.path.join(path);
    let parent = working_path.parent().unwrap();
    if !parent.exists() {
        util::fs::create_dir_all(parent)?;
    }

    log::debug!("Restore file: {:?} from {:?}", entry.path, version_path);
    util::fs::copy(version_path, working_path)?;
    Ok(())
}