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
use std;
use std::fs;
use std::fs::read_dir;
use std::path::{Path, PathBuf};
use super::*;
use super::io::{file_exists, require_empty_directory};
use super::jsonio;
const HEADER_FILENAME: &'static str = "CONSERVE";
#[derive(Clone, Debug)]
pub struct Archive {
path: PathBuf,
report: Report,
}
#[derive(Debug, RustcDecodable, RustcEncodable)]
struct ArchiveHeader {
conserve_archive_version: String,
}
impl Archive {
pub fn create<P: AsRef<Path>>(path: P) -> Result<Archive> {
let path = path.as_ref();
let archive = Archive {
path: path.to_path_buf(),
report: Report::new(),
};
require_empty_directory(&archive.path)?;
let header = ArchiveHeader { conserve_archive_version: String::from(ARCHIVE_VERSION) };
let header_filename = path.join(HEADER_FILENAME);
jsonio::write(&header_filename, &header, &archive.report)
.chain_err(|| {
format!("Failed to write archive header: {:?}", header_filename)
})?;
info!("Created new archive in {:?}", path.display());
Ok(archive)
}
pub fn open<P: AsRef<Path>>(path: P, report: &Report) -> Result<Archive> {
let path = path.as_ref();
let header_path = path.join(HEADER_FILENAME);
if !file_exists(&header_path)? {
return Err(ErrorKind::NotAnArchive(path.into()).into());
}
let header: ArchiveHeader = jsonio::read(&header_path, &report).chain_err(|| {
format!("Failed to read archive header")
})?;
if header.conserve_archive_version != ARCHIVE_VERSION {
return Err(
ErrorKind::UnsupportedArchiveVersion(header.conserve_archive_version).into(),
);
}
Ok(Archive {
path: path.to_path_buf(),
report: report.clone(),
})
}
pub fn iter_bands_unsorted(self: &Archive) -> Result<IterBands> {
let read_dir = read_dir(&self.path).chain_err(|| {
format!("failed reading directory {:?}", &self.path)
})?;
Ok(IterBands { dir_iter: read_dir })
}
pub fn list_bands(self: &Archive) -> Result<Vec<BandId>> {
let mut band_ids: Vec<BandId> = try!(self.iter_bands_unsorted()?.collect());
band_ids.sort();
Ok(band_ids)
}
pub fn path(self: &Archive) -> &Path {
self.path.as_path()
}
pub fn last_band_id(self: &Archive) -> Result<BandId> {
let mut accum: Option<BandId> = None;
for next in self.iter_bands_unsorted()? {
accum = Some(match (next, accum) {
(Err(e), _) => return Err(e),
(Ok(b), None) => b,
(Ok(b), Some(a)) => std::cmp::max(b, a),
})
}
accum.ok_or(ErrorKind::ArchiveEmpty.into())
}
pub fn last_complete_band(self: &Archive) -> Result<Band> {
for id in self.list_bands()?.iter().rev() {
let b = Band::open(self, &id)?;
if b.is_closed()? {
return Ok(b);
}
}
Err(ErrorKind::NoCompleteBands.into())
}
pub fn report(&self) -> &Report {
&self.report
}
}
pub struct IterBands {
dir_iter: fs::ReadDir,
}
impl Iterator for IterBands {
type Item = Result<BandId>;
fn next(&mut self) -> Option<Result<BandId>> {
loop {
let entry = match self.dir_iter.next() {
None => return None,
Some(Ok(entry)) => entry,
Some(Err(e)) => {
return Some(Err(e.into()));
}
};
let ft = match entry.file_type() {
Ok(ft) => ft,
Err(e) => {
return Some(Err(e.into()));
}
};
if !ft.is_dir() {
continue;
}
if let Ok(name_string) = entry.file_name().into_string() {
if let Ok(band_id) = BandId::from_string(&name_string) {
return Some(Ok(band_id));
} else {
warn!("unexpected archive subdirectory {:?}", &name_string);
}
} else {
warn!(
"unexpected archive subdirectory with un-decodable name {:?}",
entry.file_name()
)
}
}
}
}
#[cfg(test)]
mod tests {
extern crate tempdir;
use std::fs;
use std::io::Read;
use super::*;
use errors::ErrorKind;
use {BandId, Report};
use io::list_dir;
use test_fixtures::ScratchArchive;
#[test]
fn create_then_open_archive() {
let testdir = tempdir::TempDir::new("conserve-tests").unwrap();
let arch_path = &testdir.path().join("arch");
let arch = Archive::create(arch_path).unwrap();
assert_eq!(arch.path(), arch_path.as_path());
assert!(arch.list_bands().unwrap().is_empty());
Archive::open(arch_path, &Report::new()).unwrap();
assert!(arch.list_bands().unwrap().is_empty());
assert!(arch.last_complete_band().is_err());
}
#[test]
fn init_empty_dir() {
let testdir = tempdir::TempDir::new("conserve-tests").unwrap();
let arch_path = testdir.path();
let arch = Archive::create(arch_path).unwrap();
assert_eq!(arch.path(), arch_path);
assert!(arch.list_bands().unwrap().is_empty());
Archive::open(arch_path, &Report::new()).unwrap();
assert!(arch.list_bands().unwrap().is_empty());
}
#[test]
fn empty_archive() {
let af = ScratchArchive::new();
let (file_names, dir_names) = list_dir(af.path()).unwrap();
assert_eq!(file_names.len(), 1);
assert!(file_names.contains("CONSERVE"));
assert_eq!(dir_names.len(), 0);
let header_path = af.path().join("CONSERVE");
let mut header_file = fs::File::open(&header_path).unwrap();
let mut contents = String::new();
header_file.read_to_string(&mut contents).unwrap();
assert_eq!(contents, "{\"conserve_archive_version\":\"0.4\"}\n");
match *af.last_band_id().unwrap_err().kind() {
ErrorKind::ArchiveEmpty => (),
ref x => panic!("Unexpected error {:?}", x),
}
match *af.last_complete_band().unwrap_err().kind() {
ErrorKind::NoCompleteBands => (),
ref x => panic!("Unexpected error {:?}", x),
}
}
#[test]
fn create_bands() {
use super::super::io::directory_exists;
let af = ScratchArchive::new();
let _band1 = Band::create(&af).unwrap();
assert!(directory_exists(af.path()).unwrap());
let (_file_names, dir_names) = list_dir(af.path()).unwrap();
println!("dirs: {:?}", dir_names);
assert!(dir_names.contains("b0000"));
assert_eq!(af.list_bands().unwrap(), vec![BandId::new(&[0])]);
assert_eq!(af.last_band_id().unwrap(), BandId::new(&[0]));
let _band2 = Band::create(&af).unwrap();
assert_eq!(
af.list_bands().unwrap(),
vec![BandId::new(&[0]), BandId::new(&[1])]
);
assert_eq!(af.last_band_id().unwrap(), BandId::new(&[1]));
}
}