Documentation
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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
use std::collections::HashSet;
use std::fs;
use std::io::Cursor;
use std::path::Path;
use std::path::PathBuf;

use rust_crypto::sha1::Sha1;

use output::Output;

use protobuf::stream::CodedInputStream;

use rustc_serialize::hex::ToHex;

use ::misc::*;
use ::zbackup::data::*;
use ::zbackup::disk_format::*;
use ::zbackup::repository::*;
use ::zbackup::repository_core::*;

pub fn scan_index_files <
	RepositoryPath: AsRef <Path>,
> (
	repository_path: RepositoryPath,
) -> Result <Vec <IndexId>, String> {

	let repository_path =
		repository_path.as_ref ();

	let mut index_ids: Vec <IndexId> =
		Vec::new ();

	// read directory

	for dir_entry_result in (

		io_result (
			fs::read_dir (
				repository_path.join (
					"index")))

	) ? {

		let dir_entry = (

			io_result (
				dir_entry_result)

		) ?;

		let index_id =
			IndexId::parse (
				dir_entry.file_name ().to_string_lossy (),
			) ?;

		index_ids.push (
			index_id);

	}

	// return

	Ok (index_ids)

}

pub fn scan_index_files_with_sizes <
	RepositoryPath: AsRef <Path>,
> (
	repository_path: RepositoryPath,
) -> Result <Vec <(IndexId, u64)>, String> {

	let repository_path =
		repository_path.as_ref ();

	let mut index_ids_and_sizes: Vec <(IndexId, u64)> =
		Vec::new ();

	// read directory

	let indexes_path =
		repository_path.join (
			"index");

	for dir_entry_result in
		io_result_with_prefix (
			|| format! (
				"Error opening directory {}: ",
				indexes_path.to_string_lossy ()),
			fs::read_dir (
				& indexes_path),
		) ? {

		let dir_entry =
			io_result_with_prefix (
				|| format! (
					"Error reading directory {}: ",
					indexes_path.to_string_lossy ()),
				dir_entry_result,
			) ?;

		let index_id =
			IndexId::parse (
				dir_entry.file_name ().to_string_lossy (),
			) ?;

		let index_metadata =
			io_result_with_prefix (
				|| format! (
					"Error getting metadata for {}",
					dir_entry.path ().to_string_lossy ()),
				fs::metadata (
					dir_entry.path ()),
			) ?;

		index_ids_and_sizes.push (
			(
				index_id,
				index_metadata.len (),
			)
		);

	}

	// return

	Ok (index_ids_and_sizes)

}

pub fn scan_backup_files <
	RepositoryPath: AsRef <Path>,
> (
	repository_path: RepositoryPath,
) -> Result <Vec <PathBuf>, String> {

	let repository_path =
		repository_path.as_ref ();

	let mut backup_files: Vec <PathBuf> =
		Vec::new ();

	let backups_root =
		repository_path.join (
			"backups");

	scan_backup_files_real (
		& mut backup_files,
		& backups_root,
		& PathBuf::new (),
	) ?;

	Ok (backup_files)

}

fn scan_backup_files_real (
	backup_files: & mut Vec <PathBuf>,
	backups_root: & Path,
	directory: & Path,
) -> Result <(), String> {

	for dir_entry_result in (
		io_result (
			fs::read_dir (
				backups_root.join (
					directory)))
	) ? {

		let dir_entry = (
			io_result (
				dir_entry_result)
		) ?;

		let entry_metadata = (
			io_result (
				fs::metadata (
					dir_entry.path ()))
		) ?;

		if entry_metadata.is_dir () {

			scan_backup_files_real (
				backup_files,
				backups_root,
				& directory.join (
					dir_entry.file_name ()),
			) ?;

		} else if entry_metadata.is_file () {

			backup_files.push (
				directory.join (
					dir_entry.file_name ()));

		} else {

			panic! (
				"Don't know how to handle {:?}: {}",
				entry_metadata.file_type (),
				dir_entry.path ().to_string_lossy ());

		}

	}

	// return

	Ok (())

}

pub fn scan_bundle_files <
	RepositoryPath: AsRef <Path>,
> (
	output: & Output,
	repository_path: RepositoryPath,
) -> Result <Vec <BundleId>, String> {

	let repository_path =
		repository_path.as_ref ();

	let mut bundle_ids: Vec <BundleId> =
		Vec::new ();

	for prefix in (0 .. 256).map (
		|byte| [ byte as u8 ].to_hex ()
	) {

		let bundles_directory =
			repository_path
				.join ("bundles")
				.join (prefix);

		if ! bundles_directory.exists () {
			continue;
		}

		for dir_entry_result in (
			io_result (
				fs::read_dir (
					bundles_directory))
		) ? {

			let dir_entry =
				io_result (
					dir_entry_result,
				) ?;

			let file_name =
				dir_entry.file_name ();

			let bundle_name =
				file_name.to_string_lossy ();

			match BundleId::parse (
				& bundle_name,
			) {

				Ok (bundle_id) =>
					bundle_ids.push (
						bundle_id),

				Err (_) =>
					output.message_format (
						format_args! (
							"Ignoring invalid bundle name: {}",
							bundle_name)),

			}

		}

	}

	Ok (bundle_ids)

}

pub fn scan_bundle_files_with_sizes <
	RepositoryPath: AsRef <Path>,
> (
	repository_path: RepositoryPath,
) -> Result <Vec <(BundleId, u64)>, String> {

	let repository_path =
		repository_path.as_ref ();

	let mut bundle_ids_and_sizes: Vec <(BundleId, u64)> =
		Vec::new ();

	for prefix in (0 .. 256).map (
		|byte| [ byte as u8 ].to_hex ()
	) {

		let bundles_directory =
			repository_path
				.join ("bundles")
				.join (prefix);

		if ! bundles_directory.exists () {
			continue;
		}

		for dir_entry_result in (
			io_result (
				fs::read_dir (
					bundles_directory))
		) ? {

			let dir_entry =
				io_result (
					dir_entry_result,
				) ?;

			let file_name =
				dir_entry.file_name ();

			let bundle_name =
				file_name.to_string_lossy ();

			let bundle_id =
				BundleId::parse (
					bundle_name,
				) ?;

			let bundle_metadata =
				io_result_with_prefix (
					|| format! (
						"Error getting metadata for {}",
						dir_entry.path ().to_string_lossy ()),
					fs::metadata (
						dir_entry.path ()),
				) ?;

			bundle_ids_and_sizes.push (
				(
					bundle_id,
					bundle_metadata.len (),
				)
			);

		}

	}

	Ok (bundle_ids_and_sizes)

}

pub fn flush_index_entries (
	output: & Output,
	repository_core: & RepositoryCore,
	atomic_file_writer: & AtomicFileWriter,
	index_entries_buffer: & Vec <RawIndexEntry>,
) -> Result <IndexId, String> {

	let index_id =
		IndexId::random ();

	let output_job =
		output_job_start! (
			output,
			"Writing index {}",
			index_id);

	index_write_auto (
		repository_core,
		atomic_file_writer,
		& index_entries_buffer,
	) ?;

	output_job.remove ();

	Ok (index_id)

}

pub fn collect_chunks_from_backup (
	repository: & Repository,
	chunk_ids: & mut HashSet <ChunkId>,
	backup_name: & Path,
) -> Result <(), String> {

	// load backup

	let backup_info =
		backup_read_path (
			repository.path ()
				.join ("backups")
				.join (backup_name),
			repository.encryption_key (),
		) ?;

	// collect chunk ids

	collect_chunks_from_instructions (
		chunk_ids,
		& backup_info.backup_data (),
	) ?;

	// expand backup data

	let mut input =
		Cursor::new (
			backup_info.backup_data ().to_owned ());

	for _iteration in 0 .. backup_info.iterations () {

		let mut temp_output: Cursor <Vec <u8>> =
			Cursor::new (
				Vec::new ());

		let mut sha1_digest =
			Sha1::new ();

		repository.follow_instructions (
			& mut input,
			& mut temp_output,
			& mut sha1_digest,
			& |_count| (),
		) ?;

		let result =
			temp_output.into_inner ();

		// collect chunk ids

		collect_chunks_from_instructions (
			chunk_ids,
			& result,
		) ?;

		// prepare for next iteration

		input =
			Cursor::new (
				result);

	}

	Ok (())

}

pub fn collect_chunks_from_instructions (
	chunk_ids: & mut HashSet <ChunkId>,
	instructions: & [u8],
) -> Result <(), String> {

	let mut instructions_cursor =
		Cursor::new (
			& instructions);

	let mut coded_input_stream =
		CodedInputStream::new (
			& mut instructions_cursor);

	while ! protobuf_result (
		coded_input_stream.eof (),
	) ? {

		let backup_instruction =
			DiskBackupInstruction::read (
				& mut coded_input_stream,
			) ?;

		if backup_instruction.has_chunk_to_emit () {

			chunk_ids.insert (
				backup_instruction.chunk_to_emit ());

		}

	}

	Ok (())

}

// ex: noet ts=4 filetype=rust