]>
Commit | Line | Data |
---|---|---|
d1d74c43 | 1 | //! Datastore Synchronization Job Management |
bf78f708 | 2 | |
59af9ca9 | 3 | use anyhow::{bail, format_err, Error}; |
d43f86f3 | 4 | use serde_json::Value; |
d43f86f3 | 5 | |
59af9ca9 | 6 | use proxmox::api::{api, ApiMethod, Permission, Router, RpcEnvironment}; |
d43f86f3 DC |
7 | use proxmox::api::router::SubdirMap; |
8 | use proxmox::{list_subdirs_api_method, sortable}; | |
9 | ||
e3619d41 DM |
10 | use pbs_api_types::{DATASTORE_SCHEMA, JOB_ID_SCHEMA, Authid, SyncJobConfig, SyncJobStatus}; |
11 | ||
70842b9e DM |
12 | use crate::{ |
13 | api2::{ | |
70842b9e DM |
14 | pull::do_sync_job, |
15 | config::sync::{ | |
16 | check_sync_job_modify_access, | |
17 | check_sync_job_read_access, | |
18 | }, | |
19 | }, | |
20 | config::{ | |
21 | cached_user_info::CachedUserInfo, | |
e3619d41 | 22 | sync, |
70842b9e DM |
23 | }, |
24 | server::{ | |
25 | jobstate::{ | |
26 | Job, | |
27 | JobState, | |
28 | compute_schedule_status, | |
29 | }, | |
30 | }, | |
31 | }; | |
d43f86f3 DC |
32 | |
33 | #[api( | |
34 | input: { | |
d58e6313 DC |
35 | properties: { |
36 | store: { | |
37 | schema: DATASTORE_SCHEMA, | |
38 | optional: true, | |
39 | }, | |
40 | }, | |
d43f86f3 DC |
41 | }, |
42 | returns: { | |
43 | description: "List configured jobs and their status.", | |
44 | type: Array, | |
70842b9e | 45 | items: { type: SyncJobStatus }, |
d43f86f3 | 46 | }, |
59af9ca9 FG |
47 | access: { |
48 | description: "Limited to sync jobs where user has Datastore.Audit on target datastore, and Remote.Audit on source remote.", | |
49 | permission: &Permission::Anybody, | |
50 | }, | |
d43f86f3 DC |
51 | )] |
52 | /// List all sync jobs | |
53 | pub fn list_sync_jobs( | |
d58e6313 | 54 | store: Option<String>, |
d43f86f3 DC |
55 | _param: Value, |
56 | mut rpcenv: &mut dyn RpcEnvironment, | |
57 | ) -> Result<Vec<SyncJobStatus>, Error> { | |
58 | ||
59af9ca9 FG |
59 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
60 | let user_info = CachedUserInfo::new()?; | |
61 | ||
d43f86f3 DC |
62 | let (config, digest) = sync::config()?; |
63 | ||
70842b9e | 64 | let job_config_iter = config |
d58e6313 DC |
65 | .convert_to_typed_array("sync")? |
66 | .into_iter() | |
70842b9e | 67 | .filter(|job: &SyncJobConfig| { |
d58e6313 DC |
68 | if let Some(store) = &store { |
69 | &job.store == store | |
70 | } else { | |
71 | true | |
72 | } | |
59af9ca9 | 73 | }) |
70842b9e DM |
74 | .filter(|job: &SyncJobConfig| { |
75 | check_sync_job_read_access(&user_info, &auth_id, &job) | |
76 | }); | |
77 | ||
78 | let mut list = Vec::new(); | |
d43f86f3 | 79 | |
70842b9e | 80 | for job in job_config_iter { |
664d8a27 DC |
81 | let last_state = JobState::load("syncjob", &job.id) |
82 | .map_err(|err| format_err!("could not open statefile for {}: {}", &job.id, err))?; | |
664d8a27 | 83 | |
70842b9e | 84 | let status = compute_schedule_status(&last_state, job.schedule.as_deref())?; |
8d785899 | 85 | |
70842b9e | 86 | list.push(SyncJobStatus { config: job, status }); |
d43f86f3 DC |
87 | } |
88 | ||
89 | rpcenv["digest"] = proxmox::tools::digest_to_hex(&digest).into(); | |
90 | ||
91 | Ok(list) | |
92 | } | |
93 | ||
94 | #[api( | |
95 | input: { | |
96 | properties: { | |
97 | id: { | |
98 | schema: JOB_ID_SCHEMA, | |
99 | } | |
100 | } | |
59af9ca9 FG |
101 | }, |
102 | access: { | |
103 | description: "User needs Datastore.Backup on target datastore, and Remote.Read on source remote. Additionally, remove_vanished requires Datastore.Prune, and any owner other than the user themselves requires Datastore.Modify", | |
104 | permission: &Permission::Anybody, | |
105 | }, | |
d43f86f3 DC |
106 | )] |
107 | /// Runs the sync jobs manually. | |
bf78f708 | 108 | pub fn run_sync_job( |
d43f86f3 DC |
109 | id: String, |
110 | _info: &ApiMethod, | |
111 | rpcenv: &mut dyn RpcEnvironment, | |
112 | ) -> Result<String, Error> { | |
59af9ca9 FG |
113 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
114 | let user_info = CachedUserInfo::new()?; | |
d43f86f3 DC |
115 | |
116 | let (config, _digest) = sync::config()?; | |
117 | let sync_job: SyncJobConfig = config.lookup("sync", &id)?; | |
118 | ||
59af9ca9 FG |
119 | if !check_sync_job_modify_access(&user_info, &auth_id, &sync_job) { |
120 | bail!("permission check failed"); | |
121 | } | |
d43f86f3 | 122 | |
93bb51fe | 123 | let job = Job::new("syncjob", &id)?; |
02543a5c | 124 | |
e6dc35ac | 125 | let upid_str = do_sync_job(job, sync_job, &auth_id, None)?; |
d43f86f3 DC |
126 | |
127 | Ok(upid_str) | |
128 | } | |
129 | ||
130 | #[sortable] | |
131 | const SYNC_INFO_SUBDIRS: SubdirMap = &[ | |
132 | ( | |
133 | "run", | |
134 | &Router::new() | |
135 | .post(&API_METHOD_RUN_SYNC_JOB) | |
136 | ), | |
137 | ]; | |
138 | ||
139 | const SYNC_INFO_ROUTER: Router = Router::new() | |
140 | .get(&list_subdirs_api_method!(SYNC_INFO_SUBDIRS)) | |
141 | .subdirs(SYNC_INFO_SUBDIRS); | |
142 | ||
143 | ||
144 | pub const ROUTER: Router = Router::new() | |
145 | .get(&API_METHOD_LIST_SYNC_JOBS) | |
146 | .match_all("id", &SYNC_INFO_ROUTER); |