/* * Author: Ruben Fiszel * Copyright: Windmill Labs, Inc 2022 * This file and its contents are licensed under the AGPLv3 License. * Please see the included NOTICE for copyright information and * LICENSE-AGPL for a copy of the license. */ use crate::{ db::{UserDB, DB}, users::Authed, webhook_util::{WebhookMessage, WebhookShared}, }; use axum::{ extract::{Extension, Path, Query}, routing::{delete, get, post}, Json, Router, }; use itertools::Itertools; use windmill_audit::{audit_log, ActionKind}; use windmill_common::{ error::{self, Error, JsonResult, Result}, users::username_to_permissioned_as, utils::{not_found_if_none, paginate, Pagination}, }; use serde::{Deserialize, Serialize}; use sqlx::{query_scalar, FromRow, Postgres, Transaction}; pub fn workspaced_service() -> Router { Router::new() .route("/list", get(list_folders)) .route("/listnames", get(list_foldernames)) .route("/create", post(create_folder)) .route("/get/:name", get(get_folder)) .route("/update/:name", post(update_folder)) .route("/getusage/:name", get(get_folder_usage)) .route("/delete/:name", delete(delete_folder)) .route("/addowner/:name", post(add_owner)) .route("/removeowner/:name", post(remove_owner)) .route("/is_owner/*path", get(is_owner)) } #[derive(FromRow, Serialize, Deserialize, Clone)] pub struct Folder { pub workspace_id: String, pub name: String, pub display_name: String, pub owners: Vec, pub extra_perms: serde_json::Value, } #[derive(Deserialize)] pub struct NewFolder { pub name: String, pub display_name: Option, pub owners: Option>, pub extra_perms: Option, } #[derive(Deserialize)] pub struct UpdateFolder { pub display_name: Option, pub owners: Option>, pub extra_perms: Option, } #[derive(Deserialize)] pub struct Owner { pub owner: String, } async fn list_folders( authed: Authed, Extension(user_db): Extension, Path(w_id): Path, Query(pagination): Query, ) -> JsonResult> { let (per_page, offset) = paginate(pagination); let mut tx = user_db.begin(&authed).await?; let rows = sqlx::query_as!( Folder, "SELECT workspace_id, name, display_name, owners, extra_perms FROM folder WHERE workspace_id = $1 ORDER BY name desc LIMIT $2 OFFSET $3", w_id, per_page as i64, offset as i64 ) .fetch_all(&mut tx) .await?; tx.commit().await?; Ok(Json(rows)) } async fn list_foldernames( authed: Authed, Extension(user_db): Extension, Path(w_id): Path, Query(pagination): Query, ) -> JsonResult> { let (per_page, offset) = paginate(pagination); let mut tx = user_db.begin(&authed).await?; let rows = sqlx::query_scalar!( "SELECT name FROM folder WHERE workspace_id = $1 ORDER BY name desc LIMIT $2 OFFSET $3", w_id, per_page as i64, offset as i64 ) .fetch_all(&mut tx) .await?; tx.commit().await?; Ok(Json(rows)) } async fn check_name_conflict<'c>( tx: &mut Transaction<'c, Postgres>, w_id: &str, name: &str, ) -> Result<()> { let exists = sqlx::query_scalar!( "SELECT EXISTS(SELECT 1 FROM folder WHERE name = $1 AND workspace_id = $2)", name, w_id ) .fetch_one(tx) .await? .unwrap_or(false); if exists { return Err(windmill_common::error::Error::BadRequest(format!( "Folder {} already exists", name ))); } return Ok(()); } async fn create_folder( authed: Authed, Extension(user_db): Extension, Extension(webhook): Extension, Path(w_id): Path, Json(ng): Json, ) -> Result { let mut tx = user_db.begin(&authed).await?; check_name_conflict(&mut tx, &w_id, &ng.name).await?; let owner = username_to_permissioned_as(&authed.username); let owners = &ng.owners.unwrap_or(vec![owner.clone()]); if let Some(extra_perms) = ng.extra_perms.clone() { for o in owners { if !extra_perms .get(&o) .and_then(|x| x.as_bool()) .unwrap_or(false) { return Err(windmill_common::error::Error::BadRequest(format!( "Owner {} would not have permission to write to folder and that is an inconsistent state", o ))); } } } let extra_perms = ng.extra_perms.unwrap_or_else(|| { let mut map = serde_json::Map::new(); for o in owners { map.insert(o.clone(), serde_json::json!(true)); } serde_json::Value::Object(map) }); sqlx::query_as!( Folder, "INSERT INTO folder (workspace_id, name, display_name, owners, extra_perms) VALUES ($1, $2, $3, $4, $5)", w_id, ng.name, ng.display_name.unwrap_or(ng.name.clone()), owners, extra_perms, ) .execute(&mut tx) .await?; audit_log( &mut tx, &authed.username, "folder.create", ActionKind::Create, &w_id, Some(&ng.name.to_string()), None, ) .await?; tx.commit().await?; webhook.send_message( w_id.clone(), WebhookMessage::CreateFolder { workspace: w_id, name: ng.name.clone() }, ); Ok(format!("Created folder {}", ng.name)) } pub async fn is_owner( Authed { username, is_admin, groups, .. }: Authed, Extension(db): Extension, Path((w_id, name)): Path<(String, String)>, ) -> JsonResult { if is_admin { Ok(Json(true)) } else { Ok(Json( require_is_owner(&name, &username, &groups, &w_id, &db) .await .is_ok(), )) } } pub async fn require_is_owner( folder_name: &str, username: &str, groups: &Vec, w_id: &str, db: &DB, ) -> Result<()> { let is_owner = query_scalar!( "SELECT EXISTS(SELECT 1 FROM folder WHERE CONCAT('u/', $1::text) = ANY(owners) AND name = $2 AND workspace_id = $4) OR exists( SELECT 1 FROM folder, unnest(folder.owners) as o WHERE o = ANY($3::text[]) AND folder.name = $2 AND folder.workspace_id = $4)", username, folder_name, groups, w_id, ).fetch_one(db) .await? .unwrap_or(false); if !is_owner { Err(Error::BadRequest(format!( "{} is not an owner of {} and hence is not authorized to perform this operation", username, folder_name ))) } else { Ok(()) } } async fn update_folder( authed: Authed, Extension(user_db): Extension, Extension(webhook): Extension, Path((w_id, name)): Path<(String, String)>, Json(ng): Json, ) -> Result { use sql_builder::prelude::*; let mut sqlb = SqlBuilder::update_table("folder"); sqlb.and_where_eq("name", "?".bind(&name)); sqlb.and_where_eq("workspace_id", "?".bind(&w_id)); if let Some(display_name) = ng.display_name { sqlb.set("display_name", display_name); } if let Some(owners) = ng.owners { sqlb.set_str("owners", format!("{{{}}}", owners.into_iter().join(","))); } if let Some(extra_perms) = ng.extra_perms { sqlb.set_str("extra_perms", extra_perms.to_string()); } sqlb.returning("*"); let mut tx = user_db.begin(&authed).await?; let sql = sqlb .sql() .map_err(|e| error::Error::InternalErr(e.to_string()))?; let nfolder = sqlx::query_as::<_, Folder>(&sql).fetch_one(&mut tx).await?; if let Some(extra_perms) = nfolder.extra_perms.as_object() { for o in nfolder.owners { if !extra_perms .get(&o) .and_then(|x| x.as_bool()) .unwrap_or(false) { return Err(windmill_common::error::Error::BadRequest(format!( "Owner {} would not have permission to write to folder and that is an invalid state", o ))); } } } audit_log( &mut tx, &authed.username, "folder.update", ActionKind::Update, &w_id, Some(&name.to_string()), None, ) .await?; tx.commit().await?; webhook.send_message( w_id.clone().clone(), WebhookMessage::UpdateFolder { workspace: w_id, name: name.to_owned() }, ); Ok(format!("Updated folder {}", name)) } pub async fn get_folderopt<'c>( db: &mut Transaction<'c, Postgres>, w_id: &str, name: &str, ) -> Result> { let folderopt = sqlx::query_as!( Folder, "SELECT workspace_id, name, display_name, owners, extra_perms FROM folder WHERE name = $1 AND workspace_id = $2", name, w_id ) .fetch_optional(db) .await?; Ok(folderopt) } async fn get_folder( authed: Authed, Extension(user_db): Extension, Path((w_id, name)): Path<(String, String)>, ) -> JsonResult { let mut tx = user_db.begin(&authed).await?; let folder = not_found_if_none(get_folderopt(&mut tx, &w_id, &name).await?, "Folder", &name)?; tx.commit().await?; Ok(Json(folder)) } #[derive(Serialize)] struct FolderUsage { pub scripts: i64, pub schedules: i64, pub flows: i64, pub apps: i64, pub resources: i64, pub variables: i64, } async fn get_folder_usage( authed: Authed, Extension(user_db): Extension, Path((w_id, name)): Path<(String, String)>, ) -> JsonResult { let mut tx = user_db.begin(&authed).await?; let scripts = sqlx::query_scalar!( "SELECT count(path) FROM script WHERE path LIKE 'f/' || $1 || '%' AND archived IS false AND workspace_id = $2", name, w_id ) .fetch_one(&mut tx) .await? .unwrap_or(0); let schedules = sqlx::query_scalar!( "SELECT count(path) FROM schedule WHERE path LIKE 'f/' || $1 || '%' AND workspace_id = $2", name, w_id ) .fetch_one(&mut tx) .await? .unwrap_or(0); let flows = sqlx::query_scalar!( "SELECT count(path) FROM flow WHERE path LIKE 'f/' || $1 || '%' AND archived IS false AND workspace_id = $2", name, w_id ) .fetch_one(&mut tx) .await? .unwrap_or(0); let apps = sqlx::query_scalar!( "SELECT count(path) FROM app WHERE path LIKE 'f/' || $1 || '%' AND workspace_id = $2", name, w_id ) .fetch_one(&mut tx) .await? .unwrap_or(0); let resources = sqlx::query_scalar!( "SELECT count(path) FROM resource WHERE path LIKE 'f/' || $1 || '%' AND workspace_id = $2", name, w_id ) .fetch_one(&mut tx) .await? .unwrap_or(0); let variables = sqlx::query_scalar!( "SELECT count(path) FROM variable WHERE path LIKE 'f/' || $1 || '%' AND workspace_id = $2", name, w_id ) .fetch_one(&mut tx) .await? .unwrap_or(0); tx.commit().await?; Ok(Json(FolderUsage { scripts, flows, schedules, apps, resources, variables, })) } async fn delete_folder( authed: Authed, Extension(user_db): Extension, Extension(webhook): Extension, Path((w_id, name)): Path<(String, String)>, ) -> Result { let mut tx = user_db.begin(&authed).await?; not_found_if_none(get_folderopt(&mut tx, &w_id, &name).await?, "Folder", &name)?; sqlx::query!( "DELETE FROM folder WHERE name = $1 AND workspace_id = $2", name, w_id ) .execute(&mut tx) .await?; audit_log( &mut tx, &authed.username, "folder.delete", ActionKind::Delete, &w_id, Some(&name.to_string()), None, ) .await?; tx.commit().await?; webhook.send_message( w_id.clone(), WebhookMessage::DeleteFolder { workspace: w_id, name: name.clone() }, ); Ok(format!("delete folder at name {}", name)) } async fn add_owner( authed: Authed, Extension(db): Extension, Extension(user_db): Extension, Extension(webhook): Extension, Path((w_id, name)): Path<(String, String)>, Json(Owner { owner }): Json, ) -> Result { let mut tx = user_db.begin(&authed).await?; not_found_if_none(get_folderopt(&mut tx, &w_id, &name).await?, "Folder", &name)?; if !authed.is_admin { require_is_owner(&name, &authed.username, &authed.groups, &w_id, &db).await?; } sqlx::query!( "UPDATE folder SET owners = array_append(owners, $1) WHERE name = $2 AND workspace_id = $3 AND NOT $1 = ANY(owners) RETURNING name", owner, name, &w_id, ) .fetch_optional(&mut tx) .await?; audit_log( &mut tx, &authed.username, "folder.add_owner", ActionKind::Update, &w_id, Some(&name.to_string()), Some([("owner", owner.as_str())].into()), ) .await?; tx.commit().await?; webhook.send_message( w_id.clone(), WebhookMessage::UpdateFolder { workspace: w_id, name: name.clone() }, ); Ok(format!("Added {} to folder {}", owner, name)) } pub async fn get_folders_for_user( w_id: &str, username: &str, groups: &[String], db: &DB, ) -> Result> { let mut perms = groups .into_iter() .map(|x| format!("g/{}", x)) .collect::>(); perms.insert(0, format!("u/{}", username)); let folders = sqlx::query!( "SELECT name, (EXISTS (SELECT 1 FROM (SELECT key, value FROM jsonb_each_text(extra_perms) WHERE key = ANY($1)) t WHERE value::boolean IS true)) as write FROM folder WHERE extra_perms ?| $1 AND workspace_id = $2", &perms[..], w_id, ) .fetch_all(db) .await? .into_iter() .map(|x| (x.name, x.write.unwrap_or(false))) .collect(); Ok(folders) } async fn remove_owner( authed: Authed, Extension(db): Extension, Extension(user_db): Extension, Extension(webhook): Extension, Path((w_id, name)): Path<(String, String)>, Json(Owner { owner }): Json, ) -> Result { let mut tx = user_db.begin(&authed).await?; not_found_if_none(get_folderopt(&mut tx, &w_id, &name).await?, "Folder", &name)?; if !authed.is_admin { require_is_owner(&name, &authed.username, &authed.groups, &w_id, &db).await?; } sqlx::query!( "UPDATE folder SET owners = array_remove(owners, $1) WHERE name = $2 AND workspace_id = $3 RETURNING name", owner, name, &w_id, ) .fetch_optional(&mut tx) .await?; audit_log( &mut tx, &authed.username, "folder.remove_owner", ActionKind::Update, &w_id, Some(&name.to_string()), Some([("owner", owner.as_str())].into()), ) .await?; tx.commit().await?; webhook.send_message( w_id.clone(), WebhookMessage::UpdateFolder { workspace: w_id, name: name.clone() }, ); Ok(format!("Removed {} to folder {}", owner, name)) }