rzbackup 3.3.0

RZBackup
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

use std::path::Path;
use std::path::PathBuf;

use output::Output;

use rustc_serialize::hex::ToHex;

use zbackup::crypto::*;
use zbackup::data::*;
use zbackup::disk_format::*;

#[ derive (Clone, Debug) ]
pub struct RepositoryCore {
	storage_info: DiskStorageInfo,
	path: PathBuf,
	encryption_key: Option <EncryptionKey>,
}

impl RepositoryCore {

	#[ inline ]
	pub fn open <
		RepositoryPath: AsRef <Path>,
		PasswordFilePath: AsRef <Path>,
	> (
		output: & Output,
		repository_path: RepositoryPath,
		password_file_path: Option <PasswordFilePath>,
	) -> Result <RepositoryCore, String> {

		Self::open_impl (
			output,
			repository_path.as_ref (),
			password_file_path.as_ref ().map (|value| value.as_ref ()),
		)

	}

	fn open_impl (
		output: & Output,
		repository_path: & Path,
		password_file_path: Option <& Path>,
	) -> Result <RepositoryCore, String> {

		let output_job =
			output_job_start! (
				output,
				"Opening repository {}",
				repository_path.to_string_lossy ());

		let storage_info =
			storage_info_read (
				repository_path.join (
					"info"),
			) ?;

		// decrypt encryption key with password

		let encryption_key =
			if storage_info.has_encryption_key () {

			if password_file_path.is_none () {

				output_job.remove ();

				return Err (
					"Required password file not provided".to_string ());

			}

			match (
				decrypt_key (
					password_file_path.unwrap (),
					storage_info.encryption_key (),
				) ?
			) {

				Some (key) =>
					Some (key),

				None => {

					output_job.remove ();

					return Err (
						"Incorrect password".to_string ());

				},

			}

		} else {

			if password_file_path.is_some () {

				output_job.remove ();

				return Err (
					"Unnecessary password file provided".to_string ());

			}

			None

		};

		output_job.complete ();

		Ok (RepositoryCore {
			storage_info: storage_info,
			path: repository_path.to_owned (),
			encryption_key: encryption_key,
		})

	}

	/// Accessor method for the storage info

	#[ inline ]
	pub fn storage_info (& self) -> & DiskStorageInfo {
		& self.storage_info
	}

	/// Accessor method for the path

	#[ inline ]
	pub fn path (& self) -> & Path {
		& self.path
	}

	/// Accessor method for the encryption key

	#[ inline ]
	pub fn encryption_key (& self) -> Option <EncryptionKey> {
		self.encryption_key
	}

	/// Convenience function to return the filesystem path for a backup.

	#[ inline ]
	pub fn backup_path (
		& self,
		backup_name: & str,
	) -> PathBuf {

		if backup_name.chars ().next ().unwrap () == '/' {

			self.backup_path (
				& backup_name [1 .. ])

		} else {

			self.path
				.join ("backups")
				.join (backup_name)

		}

	}

	/// Convenience function to return the filesystem path for a bundle id.

	#[ inline ]
	pub fn bundle_path (
		& self,
		bundle_id: BundleId,
	) -> PathBuf {

		self.path
			.join ("bundles")
			.join (bundle_id.bytes () [0 .. 1].to_hex ())
			.join (bundle_id.to_string ())

	}

	/// Convenience function to return the filesystem path for an index id.

	#[ inline ]
	pub fn index_path (
		& self,
		index_id: IndexId,
	) -> PathBuf {

		self.path
			.join ("index")
			.join (index_id.to_string ())

	}

}

// ex: noet ts=4 filetype=rust