From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 77D3F9112C; Wed, 7 Sep 2022 10:58:39 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 0EE5B2FA14; Wed, 7 Sep 2022 10:58:38 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS; Wed, 7 Sep 2022 10:58:31 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 3A1DE43F30; Wed, 7 Sep 2022 10:58:31 +0200 (CEST) From: Daniel Tschlatscher To: pve-devel@lists.proxmox.com, pbs-devel@lists.proxmox.com, pmg-devel@lists.proxmox.com Date: Wed, 7 Sep 2022 10:56:27 +0200 Message-Id: <20220907085633.89113-2-d.tschlatscher@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220907085633.89113-1-d.tschlatscher@proxmox.com> References: <20220907085633.89113-1-d.tschlatscher@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.224 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment POISEN_SPAM_PILL 0.1 Meta: its spam POISEN_SPAM_PILL_1 0.1 random spam to be learned in bayes POISEN_SPAM_PILL_3 0.1 random spam to be learned in bayes SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pbs-devel] [PATCH proxmox-backup v2 1/7] make tasklog downloadable in the backup server backend X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 07 Sep 2022 08:58:39 -0000 The API call for getting the tasklog now returns a file stream when the URL parameter 'limit' is set to 0, in accordance with the changes in the PMG and PVE backends. To make this work I had to use one of the lower level apimethod types from the proxmox-router. Therefore I also had to change declarations for the API routing and the corresponding Object Schemas. If the parameter 'limit' is not set to 0 the API should behave the same as before. Signed-off-by: Daniel Tschlatscher --- src/api2/node/tasks.rs | 159 ++++++++++++++++++++++++++--------------- 1 file changed, 101 insertions(+), 58 deletions(-) diff --git a/src/api2/node/tasks.rs b/src/api2/node/tasks.rs index cbd0894e..99600bf4 100644 --- a/src/api2/node/tasks.rs +++ b/src/api2/node/tasks.rs @@ -1,11 +1,17 @@ use std::fs::File; use std::io::{BufRead, BufReader}; +use std::path::PathBuf; use anyhow::{bail, Error}; +use futures::FutureExt; +use http::{Response, StatusCode, header}; +use http::request::Parts; +use hyper::Body; +use proxmox_async::stream::AsyncReaderStream; use serde_json::{json, Value}; -use proxmox_router::{list_subdirs_api_method, Permission, Router, RpcEnvironment, SubdirMap}; -use proxmox_schema::api; +use proxmox_router::{list_subdirs_api_method, Permission, Router, RpcEnvironment, SubdirMap, ApiMethod, ApiHandler, ApiResponseFuture}; +use proxmox_schema::{api, Schema, IntegerSchema, BooleanSchema, ObjectSchema}; use proxmox_sys::sortable; use pbs_api_types::{ @@ -19,6 +25,20 @@ use crate::api2::pull::check_pull_privs; use pbs_config::CachedUserInfo; use proxmox_rest_server::{upid_log_path, upid_read_status, TaskListInfoIterator, TaskState}; +pub const START_PARAM_SCHEMA: Schema = + IntegerSchema::new("Start at this line when reading the tasklog") + .minimum(0) + .schema(); + +pub const LIMIT_PARAM_SCHEMA: Schema = + IntegerSchema::new("The amount of lines to read from the tasklog") + .minimum(0) + .schema(); + +pub const TEST_STATUS_PARAM_SCHEMA: Schema = + BooleanSchema::new("Test task status, and set result attribute \"active\" accordingly.") + .schema(); + // matches respective job execution privileges fn check_job_privs(auth_id: &Authid, user_info: &CachedUserInfo, upid: &UPID) -> Result<(), Error> { match (upid.worker_type.as_str(), &upid.worker_id) { @@ -268,58 +288,88 @@ fn extract_upid(param: &Value) -> Result { upid_str.parse::() } -#[api( - input: { - properties: { - node: { - schema: NODE_SCHEMA, - }, - upid: { - schema: UPID_SCHEMA, - }, - "test-status": { - type: bool, - optional: true, - description: "Test task status, and set result attribute \"active\" accordingly.", - }, - start: { - type: u64, - optional: true, - description: "Start at this line.", - default: 0, - }, - limit: { - type: u64, - optional: true, - description: "Only list this amount of lines.", - default: 50, - }, - }, - }, - access: { - description: "Users can access their own tasks, or need Sys.Audit on /system/tasks.", - permission: &Permission::Anybody, - }, -)] -/// Read task log. -async fn read_task_log(param: Value, rpcenv: &mut dyn RpcEnvironment) -> Result { - let upid = extract_upid(¶m)?; - - let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; - - check_task_access(&auth_id, &upid)?; - - let test_status = param["test-status"].as_bool().unwrap_or(false); - - let start = param["start"].as_u64().unwrap_or(0); - let mut limit = param["limit"].as_u64().unwrap_or(50); - - let mut count: u64 = 0; +#[sortable] +pub const API_METHOD_READ_TASK_LOG: ApiMethod = ApiMethod::new( + &ApiHandler::AsyncHttp(&download_task_log), + &ObjectSchema::new( + "Read the task log", + &sorted!([ + ("node", false, &NODE_SCHEMA), + ("upid", false, &UPID_SCHEMA), + ("start", true, &START_PARAM_SCHEMA), + ("limit", true, &LIMIT_PARAM_SCHEMA), + ("test-status", true, &TEST_STATUS_PARAM_SCHEMA) + ]), + ), +) +.access( + Some("Users can access their own tasks, or need Sys.Audit on /system/tasks."), + &Permission::Anybody, +); +fn download_task_log( + _parts: Parts, + _req_body: Body, + param: Value, + _info: &ApiMethod, + rpcenv: Box, +) -> ApiResponseFuture { + async move { + let upid: UPID = extract_upid(¶m)?; + let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; + check_task_access(&auth_id, &upid)?; + + let test_status = param["test-status"].as_bool().unwrap_or(false); + let start = param["start"].as_u64().unwrap_or(0); + let limit = param["limit"].as_u64().unwrap_or(50); + + let path = upid_log_path(&upid)?; + + if limit == 0 { + let file = tokio::fs::File::open(path).await?; + + let header_disp = format!("attachment; filename={}", &upid.to_string()); + + let stream = AsyncReaderStream::new(file); + + Ok(Response::builder() + .status(StatusCode::OK) + .header(header::CONTENT_TYPE, "text/plain") + .header(header::CONTENT_DISPOSITION, &header_disp) + .body(Body::wrap_stream(stream)) + .unwrap()) + } else { + let (count, lines) = read_tasklog_lines(path, start, limit).unwrap(); + + let mut json = json!({ + "data": lines, + "total": count, + "success": 1, + }); + + if test_status { + let active = proxmox_rest_server::worker_is_active(&upid).await?; + + json["test-status"] = Value::from(active); + } - let path = upid_log_path(&upid)?; + Ok(Response::builder() + .status(StatusCode::OK) + .header(header::CONTENT_TYPE, "application/json") + .body(Body::from(json.to_string())) + .unwrap()) + } + } + .boxed() +} +fn read_tasklog_lines( + path: PathBuf, + start: u64, + mut limit: u64, +) -> Result<(u64, Vec), Error> { let file = File::open(path)?; + let mut count: u64 = 0; let mut lines: Vec = vec![]; for line in BufReader::new(file).lines() { @@ -344,14 +394,7 @@ async fn read_task_log(param: Value, rpcenv: &mut dyn RpcEnvironment) -> Result< } } - rpcenv["total"] = Value::from(count); - - if test_status { - let active = proxmox_rest_server::worker_is_active(&upid).await?; - rpcenv["active"] = Value::from(active); - } - - Ok(json!(lines)) + Ok((count, lines)) } #[api( -- 2.30.2