]>
Commit | Line | Data |
---|---|---|
bf78f708 DM |
1 | //! Datastore Verify Job Management |
2 | ||
8d1beca7 | 3 | use anyhow::{format_err, Error}; |
1917ea3c | 4 | use serde_json::Value; |
8d1beca7 | 5 | |
6ef1b649 WB |
6 | use proxmox::sortable; |
7 | use proxmox_router::{ | |
8 | list_subdirs_api_method, ApiMethod, Router, RpcEnvironment, RpcEnvironmentType, SubdirMap, | |
9 | Permission, | |
10 | }; | |
11 | use proxmox_schema::api; | |
8d1beca7 | 12 | |
8cc3760e DM |
13 | use pbs_api_types::{ |
14 | VerificationJobConfig, VerificationJobStatus, JOB_ID_SCHEMA, Authid, | |
6227654a | 15 | PRIV_DATASTORE_AUDIT, PRIV_DATASTORE_VERIFY, DATASTORE_SCHEMA, |
8cc3760e | 16 | }; |
802189f7 | 17 | use pbs_config::verify; |
ba3d7e19 | 18 | use pbs_config::CachedUserInfo; |
e3619d41 | 19 | |
1917ea3c | 20 | use crate::{ |
1917ea3c DM |
21 | server::{ |
22 | do_verification_job, | |
23 | jobstate::{ | |
24 | Job, | |
25 | JobState, | |
26 | compute_schedule_status, | |
27 | }, | |
28 | }, | |
4c979d54 | 29 | }; |
1917ea3c | 30 | |
8d1beca7 HL |
31 | #[api( |
32 | input: { | |
d58e6313 DC |
33 | properties: { |
34 | store: { | |
35 | schema: DATASTORE_SCHEMA, | |
36 | optional: true, | |
37 | }, | |
38 | }, | |
8d1beca7 HL |
39 | }, |
40 | returns: { | |
4c979d54 | 41 | description: "List configured jobs and their status (filtered by access)", |
8d1beca7 | 42 | type: Array, |
e3619d41 | 43 | items: { type: VerificationJobStatus }, |
8d1beca7 | 44 | }, |
4c979d54 FG |
45 | access: { |
46 | permission: &Permission::Anybody, | |
47 | description: "Requires Datastore.Audit or Datastore.Verify on datastore.", | |
48 | }, | |
8d1beca7 HL |
49 | )] |
50 | /// List all verification jobs | |
51 | pub fn list_verification_jobs( | |
d58e6313 | 52 | store: Option<String>, |
8d1beca7 HL |
53 | _param: Value, |
54 | mut rpcenv: &mut dyn RpcEnvironment, | |
55 | ) -> Result<Vec<VerificationJobStatus>, Error> { | |
4c979d54 FG |
56 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
57 | let user_info = CachedUserInfo::new()?; | |
58 | ||
59 | let required_privs = PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_VERIFY; | |
8d1beca7 HL |
60 | |
61 | let (config, digest) = verify::config()?; | |
62 | ||
1917ea3c | 63 | let job_config_iter = config |
d58e6313 DC |
64 | .convert_to_typed_array("verification")? |
65 | .into_iter() | |
1917ea3c | 66 | .filter(|job: &VerificationJobConfig| { |
4c979d54 FG |
67 | let privs = user_info.lookup_privs(&auth_id, &["datastore", &job.store]); |
68 | if privs & required_privs == 0 { | |
69 | return false; | |
70 | } | |
71 | ||
d58e6313 DC |
72 | if let Some(store) = &store { |
73 | &job.store == store | |
74 | } else { | |
75 | true | |
76 | } | |
1917ea3c | 77 | }); |
8d1beca7 | 78 | |
1917ea3c DM |
79 | let mut list = Vec::new(); |
80 | ||
81 | for job in job_config_iter { | |
8d1beca7 HL |
82 | let last_state = JobState::load("verificationjob", &job.id) |
83 | .map_err(|err| format_err!("could not open statefile for {}: {}", &job.id, err))?; | |
84 | ||
1917ea3c | 85 | let status = compute_schedule_status(&last_state, job.schedule.as_deref())?; |
8d1beca7 | 86 | |
1917ea3c | 87 | list.push(VerificationJobStatus { config: job, status }); |
8d1beca7 HL |
88 | } |
89 | ||
90 | rpcenv["digest"] = proxmox::tools::digest_to_hex(&digest).into(); | |
91 | ||
92 | Ok(list) | |
93 | } | |
94 | ||
95 | #[api( | |
96 | input: { | |
97 | properties: { | |
98 | id: { | |
99 | schema: JOB_ID_SCHEMA, | |
100 | } | |
101 | } | |
4c979d54 FG |
102 | }, |
103 | access: { | |
104 | permission: &Permission::Anybody, | |
105 | description: "Requires Datastore.Verify on job's datastore.", | |
106 | }, | |
8d1beca7 HL |
107 | )] |
108 | /// Runs a verification job manually. | |
bf78f708 | 109 | pub fn run_verification_job( |
8d1beca7 HL |
110 | id: String, |
111 | _info: &ApiMethod, | |
112 | rpcenv: &mut dyn RpcEnvironment, | |
113 | ) -> Result<String, Error> { | |
4c979d54 FG |
114 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
115 | let user_info = CachedUserInfo::new()?; | |
116 | ||
8d1beca7 HL |
117 | let (config, _digest) = verify::config()?; |
118 | let verification_job: VerificationJobConfig = config.lookup("verification", &id)?; | |
119 | ||
4c979d54 | 120 | user_info.check_privs(&auth_id, &["datastore", &verification_job.store], PRIV_DATASTORE_VERIFY, true)?; |
8d1beca7 HL |
121 | |
122 | let job = Job::new("verificationjob", &id)?; | |
bfa942c0 | 123 | let to_stdout = rpcenv.env_type() == RpcEnvironmentType::CLI; |
8d1beca7 | 124 | |
bfa942c0 | 125 | let upid_str = do_verification_job(job, verification_job, &auth_id, None, to_stdout)?; |
8d1beca7 HL |
126 | |
127 | Ok(upid_str) | |
128 | } | |
129 | ||
130 | #[sortable] | |
131 | const VERIFICATION_INFO_SUBDIRS: SubdirMap = &[("run", &Router::new().post(&API_METHOD_RUN_VERIFICATION_JOB))]; | |
132 | ||
133 | const VERIFICATION_INFO_ROUTER: Router = Router::new() | |
134 | .get(&list_subdirs_api_method!(VERIFICATION_INFO_SUBDIRS)) | |
135 | .subdirs(VERIFICATION_INFO_SUBDIRS); | |
136 | ||
137 | pub const ROUTER: Router = Router::new() | |
138 | .get(&API_METHOD_LIST_VERIFICATION_JOBS) | |
139 | .match_all("id", &VERIFICATION_INFO_ROUTER); |