]> git.proxmox.com Git - proxmox-backup.git/blob - src/bin/proxmox-backup-client.rs
docs: add epilog.rst to define common things.
[proxmox-backup.git] / src / bin / proxmox-backup-client.rs
1 extern crate proxmox_backup;
2
3 use failure::*;
4 //use std::os::unix::io::AsRawFd;
5 use chrono::{DateTime, Local, Utc, TimeZone};
6 use std::path::Path;
7
8 use proxmox_backup::tools;
9 use proxmox_backup::flog;
10 use proxmox_backup::cli::*;
11 use proxmox_backup::api_schema::*;
12 use proxmox_backup::api_schema::router::*;
13 use proxmox_backup::client::*;
14 use proxmox_backup::backup::*;
15 //use proxmox_backup::backup::image_index::*;
16 //use proxmox_backup::config::datastore;
17 //use proxmox_backup::catar::encoder::*;
18 //use proxmox_backup::backup::datastore::*;
19
20 use serde_json::{Value};
21 use hyper::Body;
22 use std::sync::Arc;
23 use regex::Regex;
24
25 use lazy_static::lazy_static;
26
27 lazy_static! {
28 static ref BACKUPSPEC_REGEX: Regex = Regex::new(r"^([a-zA-Z0-9_-]+):(.+)$").unwrap();
29 }
30
31 fn backup_directory<P: AsRef<Path>>(
32 client: &mut HttpClient,
33 repo: &BackupRepository,
34 dir_path: P,
35 archive_name: &str,
36 backup_time: DateTime<Utc>,
37 chunk_size: Option<u64>,
38 ) -> Result<(), Error> {
39
40 let mut query = url::form_urlencoded::Serializer::new(String::new());
41
42 query
43 .append_pair("archive_name", archive_name)
44 .append_pair("type", "host")
45 .append_pair("id", &tools::nodename())
46 .append_pair("time", &backup_time.timestamp().to_string());
47
48 if let Some(size) = chunk_size {
49 query.append_pair("chunk-size", &size.to_string());
50 }
51
52 let query = query.finish();
53
54 let path = format!("api2/json/admin/datastore/{}/catar?{}", repo.store, query);
55
56 let stream = CaTarBackupStream::open(dir_path.as_ref())?;
57
58 let body = Body::wrap_stream(stream);
59
60 client.upload("application/x-proxmox-backup-catar", body, &path)?;
61
62 Ok(())
63 }
64
65 /****
66 fn backup_image(datastore: &DataStore, file: &std::fs::File, size: usize, target: &str, chunk_size: usize) -> Result<(), Error> {
67
68 let mut target = PathBuf::from(target);
69
70 if let Some(ext) = target.extension() {
71 if ext != "fidx" {
72 bail!("got wrong file extension - expected '.fidx'");
73 }
74 } else {
75 target.set_extension("fidx");
76 }
77
78 let mut index = datastore.create_image_writer(&target, size, chunk_size)?;
79
80 tools::file_chunker(file, chunk_size, |pos, chunk| {
81 index.add_chunk(pos, chunk)?;
82 Ok(true)
83 })?;
84
85 index.close()?; // commit changes
86
87 Ok(())
88 }
89 */
90
91 fn list_backups(
92 param: Value,
93 _info: &ApiMethod,
94 _rpcenv: &mut RpcEnvironment,
95 ) -> Result<Value, Error> {
96
97 let repo_url = tools::required_string_param(&param, "repository")?;
98 let repo = BackupRepository::parse(repo_url)?;
99
100 let mut client = HttpClient::new(&repo.host, &repo.user);
101
102 let path = format!("api2/json/admin/datastore/{}/backups", repo.store);
103
104 let result = client.get(&path)?;
105
106 // fixme: implement and use output formatter instead ..
107 let list = result["data"].as_array().unwrap();
108
109 for item in list {
110
111 let id = item["backup_id"].as_str().unwrap();
112 let btype = item["backup_type"].as_str().unwrap();
113 let epoch = item["backup_time"].as_i64().unwrap();
114 let backup_time = Local.timestamp(epoch, 0);
115
116 let backup_dir = BackupDir {
117 group: BackupGroup {
118 backup_type: btype.to_string(),
119 backup_id: id.to_string(),
120 },
121 backup_time
122 };
123
124 let files = item["files"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_owned()).collect();
125
126 let info = BackupInfo { backup_dir, files };
127
128 for filename in info.files {
129 let path = info.backup_dir.relative_path().to_str().unwrap().to_owned();
130 println!("{} | {}/{}", backup_time.format("%c"), path, filename);
131 }
132 }
133
134 //Ok(result)
135 Ok(Value::Null)
136 }
137
138 fn start_garbage_collection(
139 param: Value,
140 _info: &ApiMethod,
141 _rpcenv: &mut RpcEnvironment,
142 ) -> Result<Value, Error> {
143
144 let repo_url = tools::required_string_param(&param, "repository")?;
145 let repo = BackupRepository::parse(repo_url)?;
146
147 let mut client = HttpClient::new(&repo.host, &repo.user);
148
149 let path = format!("api2/json/admin/datastore/{}/gc", repo.store);
150
151 let result = client.post(&path)?;
152
153 Ok(result)
154 }
155
156 fn parse_backupspec(value: &str) -> Result<(&str, &str), Error> {
157
158 if let Some(caps) = BACKUPSPEC_REGEX.captures(value) {
159 return Ok((caps.get(1).unwrap().as_str(), caps.get(2).unwrap().as_str()));
160 }
161 bail!("unable to parse directory specification '{}'", value);
162 }
163
164 fn create_backup(
165 param: Value,
166 _info: &ApiMethod,
167 _rpcenv: &mut RpcEnvironment,
168 ) -> Result<Value, Error> {
169
170 let repo_url = tools::required_string_param(&param, "repository")?;
171
172 let backupspec_list = tools::required_array_param(&param, "backupspec")?;
173
174 let repo = BackupRepository::parse(repo_url)?;
175
176 let chunk_size_opt = param["chunk-size"].as_u64().map(|v| v*1024);
177
178 if let Some(size) = chunk_size_opt {
179 verify_chunk_size(size)?;
180 }
181
182 let mut upload_list = vec![];
183
184 for backupspec in backupspec_list {
185 let (target, filename) = parse_backupspec(backupspec.as_str().unwrap())?;
186
187 let stat = match nix::sys::stat::stat(filename) {
188 Ok(s) => s,
189 Err(err) => bail!("unable to access '{}' - {}", filename, err),
190 };
191
192 if (stat.st_mode & libc::S_IFDIR) != 0 {
193
194 let target = format!("{}.catar", target);
195
196 upload_list.push((filename.to_owned(), target));
197
198 } else if (stat.st_mode & (libc::S_IFREG|libc::S_IFBLK)) != 0 {
199 if stat.st_size <= 0 { bail!("got strange file size '{}'", stat.st_size); }
200 let _size = stat.st_size as usize;
201
202 panic!("implement me");
203
204 //backup_image(&datastore, &file, size, &target, chunk_size)?;
205
206 // let idx = datastore.open_image_reader(target)?;
207 // idx.print_info();
208
209 } else {
210 bail!("unsupported file type (expected a directory, file or block device)");
211 }
212 }
213
214 let backup_time = Utc::now();
215
216 let mut client = HttpClient::new(&repo.host, &repo.user);
217
218 client.login()?; // login before starting backup
219
220 let log_file_name = format!("backup-log-{}.log", backup_time.format("%Y-%m-%dT%H:%M:%S"));
221
222 let mut log = tools::FileLogger::new(&log_file_name, true)?;
223
224 flog!(log, "Starting backup");
225 flog!(log, "Client name: {}", tools::nodename());
226 flog!(log, "UTC Start Time: {}", Utc::now().format("%c"));
227
228 for (filename, target) in upload_list {
229 flog!(log, "Upload '{}' to '{:?}' as {}", filename, repo, target);
230 backup_directory(&mut client, &repo, &filename, &target, backup_time, chunk_size_opt)?;
231 }
232
233 flog!(log, "Upload backup log");
234 // fixme: impl upload log
235
236 flog!(log, "UTC End Time: {}", Utc::now().format("%c"));
237
238 //datastore.garbage_collection()?;
239
240 Ok(Value::Null)
241
242 }
243
244 pub fn complete_backup_source(arg: &str) -> Vec<String> {
245
246 let mut result = vec![];
247
248 let data: Vec<&str> = arg.splitn(2, ':').collect();
249
250 if data.len() != 2 { return result; }
251
252 let files = tools::complete_file_name(data[1]);
253
254 for file in files {
255 result.push(format!("{}:{}", data[0], file));
256 }
257
258 result
259 }
260
261 fn prune(
262 mut param: Value,
263 _info: &ApiMethod,
264 _rpcenv: &mut RpcEnvironment,
265 ) -> Result<Value, Error> {
266
267 let repo_url = tools::required_string_param(&param, "repository")?;
268 let repo = BackupRepository::parse(repo_url)?;
269
270 let mut client = HttpClient::new(&repo.host, &repo.user);
271
272 let path = format!("api2/json/admin/datastore/{}/prune", repo.store);
273
274 param.as_object_mut().unwrap().remove("repository");
275
276 let result = client.post_json(&path, param)?;
277
278 Ok(result)
279 }
280
281 fn main() {
282
283 let repo_url_schema: Arc<Schema> = Arc::new(
284 StringSchema::new("Repository URL.")
285 .format(BACKUP_REPO_URL.clone())
286 .max_length(256)
287 .into()
288 );
289
290 let backup_source_schema: Arc<Schema> = Arc::new(
291 StringSchema::new("Backup source specification ([<label>:<path>]).")
292 .format(Arc::new(ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)))
293 .into()
294 );
295
296 let create_cmd_def = CliCommand::new(
297 ApiMethod::new(
298 create_backup,
299 ObjectSchema::new("Create backup.")
300 .required("repository", repo_url_schema.clone())
301 .required(
302 "backupspec",
303 ArraySchema::new(
304 "List of backup source specifications ([<label>:<path>] ...)",
305 backup_source_schema,
306 ).min_length(1)
307 )
308 .optional(
309 "chunk-size",
310 IntegerSchema::new("Chunk size in KB. Must be a power of 2.")
311 .minimum(64)
312 .maximum(4096)
313 .default(4096)
314 )
315 ))
316 .arg_param(vec!["repository", "backupspec"])
317 .completion_cb("backupspec", complete_backup_source);
318
319 let list_cmd_def = CliCommand::new(
320 ApiMethod::new(
321 list_backups,
322 ObjectSchema::new("List backups.")
323 .required("repository", repo_url_schema.clone())
324 ))
325 .arg_param(vec!["repository"]);
326
327 let garbage_collect_cmd_def = CliCommand::new(
328 ApiMethod::new(
329 start_garbage_collection,
330 ObjectSchema::new("Start garbage collection for a specific repository.")
331 .required("repository", repo_url_schema.clone())
332 ))
333 .arg_param(vec!["repository"]);
334
335 let prune_cmd_def = CliCommand::new(
336 ApiMethod::new(
337 prune,
338 proxmox_backup::api2::admin::datastore::add_common_prune_prameters(
339 ObjectSchema::new("Prune backup repository.")
340 .required("repository", repo_url_schema.clone())
341 )
342 ))
343 .arg_param(vec!["repository"]);
344 let cmd_def = CliCommandMap::new()
345 .insert("create".to_owned(), create_cmd_def.into())
346 .insert("garbage-collect".to_owned(), garbage_collect_cmd_def.into())
347 .insert("list".to_owned(), list_cmd_def.into())
348 .insert("prune".to_owned(), prune_cmd_def.into());
349
350 run_cli_command(cmd_def.into());
351 }