Files
Oxicloud/src/interfaces/api/handlers/folder_handler.rs
T

556 lines
22 KiB
Rust
Raw Normal View History

2025-03-17 21:28:08 +01:00
use axum::{
Json,
2026-02-14 20:22:19 +01:00
extract::{Path, Query, State},
http::{Response, StatusCode, header},
2026-02-14 20:22:19 +01:00
response::IntoResponse,
2025-03-17 21:28:08 +01:00
};
2026-02-14 20:22:19 +01:00
use std::collections::HashMap;
use std::sync::Arc;
2025-03-17 21:28:08 +01:00
use crate::application::dtos::display_helpers::{
category_for, format_file_size, icon_class_for, icon_special_class_for, intern_display,
intern_mime,
};
use crate::application::dtos::file_dto::FileDto;
use crate::application::dtos::folder_dto::{
CreateFolderDto, FolderDto, FolderResourceItemDto, FolderResourcesDto, FolderResourcesQuery,
ListResourcesOptions, MoveFolderDto, RenameFolderDto,
};
use crate::application::dtos::grant_dto::{ResourceContentDto, ResourceTypeDto};
use crate::application::ports::folder_ports::FolderUseCase;
use crate::application::ports::trash_ports::TrashUseCase;
2026-02-14 20:22:19 +01:00
use crate::application::services::folder_service::FolderService;
2025-03-26 18:33:22 +01:00
use crate::common::di::AppState as GlobalAppState;
use crate::domain::entities::file::File;
use crate::interfaces::errors::AppError;
use crate::interfaces::middleware::auth::AuthUser;
2025-03-17 21:28:08 +01:00
type AppState = Arc<FolderService>;
/// Handler for folder-related API endpoints
pub struct FolderHandler;
impl FolderHandler {
// ── Why no #[utoipa::path] here? ─────────────────────────────────────────────
// utoipa 5.4.0's proc macro generates helper structs / impls inside its expansion.
// Rust allows struct definitions at module scope but forbids them inside impl blocks,
// so `#[utoipa::path]` fails on every method in this impl block regardless of HTTP
// verb or annotation content. All route handlers are free functions below.
// TODO: collapse after utoipa upgrade.
/// Creates a new folder.
/// When parent_id is not provided, the folder is created inside the
/// authenticated user's home folder rather than at the storage root.
pub(super) async fn create_folder_impl(
2025-03-17 21:28:08 +01:00
State(service): State<AppState>,
auth_user: AuthUser,
Json(mut dto): Json<CreateFolderDto>,
2025-03-17 21:28:08 +01:00
) -> impl IntoResponse {
// If no parent_id was supplied, resolve the user's home folder as
// the default parent so the new folder is nested correctly.
if dto.parent_id.is_none() {
tracing::info!(
"create_folder: parent_id is None for user '{}', resolving home folder",
auth_user.username
);
match service.list_folders_with_perms(None, auth_user.id).await {
Ok(folders) => {
if let Some(home) = folders.first() {
tracing::info!(
"create_folder: resolved home folder ID '{}' for user '{}'",
2026-02-14 20:22:19 +01:00
home.id,
auth_user.username
);
dto.parent_id = Some(home.id.clone());
} else {
tracing::warn!(
"create_folder: home folder not found for user '{}', folder will be created at root",
auth_user.username
);
}
}
Err(e) => {
2026-02-14 20:22:19 +01:00
tracing::error!(
"create_folder: failed to list folders for home resolution: {}",
e
);
}
}
}
match service.create_folder_with_perms(dto, auth_user.id).await {
2025-03-17 21:28:08 +01:00
Ok(folder) => (StatusCode::CREATED, Json(folder)).into_response(),
2026-03-05 21:28:51 +01:00
Err(err) => AppError::from(err).into_response(),
2025-03-17 21:28:08 +01:00
}
}
2026-02-14 20:22:19 +01:00
/// Gets a folder by ID.
/// Validates that the authenticated user owns the folder.
pub(super) async fn get_folder_impl(
2025-03-17 21:28:08 +01:00
State(service): State<AppState>,
auth_user: AuthUser,
2025-03-17 21:28:08 +01:00
Path(id): Path<String>,
) -> impl IntoResponse {
match service.get_folder_with_perms(&id, auth_user.id).await {
Ok(folder) => (StatusCode::OK, Json(folder)).into_response(),
2026-03-05 21:28:51 +01:00
Err(err) => AppError::from(err).into_response(),
2025-03-17 21:28:08 +01:00
}
}
2026-02-14 20:22:19 +01:00
/// Lists root folders for the authenticated user.
/// Only returns folders owned by this user — no information disclosure.
pub(super) async fn list_root_folders_impl(
State(service): State<AppState>,
auth_user: AuthUser,
2026-02-13 23:00:16 +01:00
) -> axum::response::Response {
Self::list_folders_scoped(service, None, &auth_user).await
}
/// Internal helper: lists folders the authenticated caller can Read.
/// Post-PR-B, `list_root_folders_for_caller` scopes via
/// drive-membership grants (`role_grants` + group cascade via
/// `storage.caller_group_ids`) instead of the legacy `folders.user_id`
/// filter, so folders in shared drives the caller belongs to
/// surface here too.
async fn list_folders_scoped(
2026-02-13 23:00:16 +01:00
service: AppState,
parent_id: Option<&str>,
auth_user: &AuthUser,
2026-02-13 23:00:16 +01:00
) -> axum::response::Response {
match service
.list_folders_with_perms(parent_id, auth_user.id)
.await
{
Ok(folders) => (StatusCode::OK, Json(folders)).into_response(),
2026-03-05 21:28:51 +01:00
Err(err) => AppError::from(err).into_response(),
}
}
/// Renames a folder (ownership enforced).
pub(super) async fn rename_folder_impl(
2025-03-17 21:28:08 +01:00
State(service): State<AppState>,
auth_user: AuthUser,
2025-03-17 21:28:08 +01:00
Path(id): Path<String>,
Json(dto): Json<RenameFolderDto>,
) -> impl IntoResponse {
match service
.rename_folder_with_perms(&id, dto, auth_user.id)
.await
{
2025-03-17 21:28:08 +01:00
Ok(folder) => (StatusCode::OK, Json(folder)).into_response(),
2026-03-05 21:28:51 +01:00
Err(err) => AppError::from(err).into_response(),
2025-03-17 21:28:08 +01:00
}
}
2026-02-14 20:22:19 +01:00
/// Moves a folder to a new parent (ownership enforced).
pub(super) async fn move_folder_impl(
2025-03-17 21:28:08 +01:00
State(service): State<AppState>,
auth_user: AuthUser,
2025-03-17 21:28:08 +01:00
Path(id): Path<String>,
Json(dto): Json<MoveFolderDto>,
) -> impl IntoResponse {
match service.move_folder_with_perms(&id, dto, auth_user.id).await {
2025-03-17 21:28:08 +01:00
Ok(folder) => (StatusCode::OK, Json(folder)).into_response(),
2026-03-05 21:28:51 +01:00
Err(err) => AppError::from(err).into_response(),
2025-03-17 21:28:08 +01:00
}
}
2026-02-14 20:22:19 +01:00
/// Deletes a folder (ownership enforced by service layer)
2025-03-17 21:28:08 +01:00
pub async fn delete_folder(
State(service): State<AppState>,
auth_user: AuthUser,
2025-03-17 21:28:08 +01:00
Path(id): Path<String>,
) -> impl IntoResponse {
match service.delete_folder_with_perms(&id, auth_user.id).await {
2025-03-17 21:28:08 +01:00
Ok(_) => StatusCode::NO_CONTENT.into_response(),
2026-03-05 21:28:51 +01:00
Err(err) => AppError::from(err).into_response(),
2025-03-17 21:28:08 +01:00
}
}
2026-02-14 20:22:19 +01:00
/// Deletes a folder (moves to trash if enabled, otherwise permanent).
pub(super) async fn delete_folder_with_trash_impl(
State(state): State<Arc<GlobalAppState>>,
auth_user: AuthUser,
2025-03-26 18:33:22 +01:00
Path(id): Path<String>,
) -> impl IntoResponse {
let user_id = auth_user.id;
2025-03-26 18:33:22 +01:00
// Check if trash service is available
// FIXME: permissions !!
2025-03-26 18:33:22 +01:00
if let Some(trash_service) = &state.trash_service {
tracing::info!("Moving folder to trash: {}", id);
2026-02-14 20:22:19 +01:00
2025-03-26 18:33:22 +01:00
// Try to move to trash first
match trash_service.move_to_trash(&id, "folder", user_id).await {
2025-03-26 18:33:22 +01:00
Ok(_) => {
tracing::info!("Folder successfully moved to trash: {}", id);
return StatusCode::NO_CONTENT.into_response();
2026-02-14 20:22:19 +01:00
}
2025-03-26 18:33:22 +01:00
Err(err) => {
2026-02-14 20:22:19 +01:00
tracing::warn!(
"Could not move folder to trash, falling back to permanent delete: {}",
err
);
2025-03-26 18:33:22 +01:00
// Fall through to regular delete if trash fails
}
}
}
2026-02-14 20:22:19 +01:00
2025-03-26 18:33:22 +01:00
// Fallback to permanent delete if trash is unavailable or failed
let folder_service = &state.applications.folder_service;
match folder_service.delete_folder_with_perms(&id, user_id).await {
2025-03-26 18:33:22 +01:00
Ok(_) => {
tracing::info!("Folder permanently deleted: {}", id);
StatusCode::NO_CONTENT.into_response()
2026-02-14 20:22:19 +01:00
}
2026-03-05 21:28:51 +01:00
Err(err) => AppError::from(err).into_response(),
2025-03-26 18:33:22 +01:00
}
}
2026-02-14 20:22:19 +01:00
/// Downloads a folder and all its contents as a ZIP archive.
pub(super) async fn download_folder_zip_impl(
State(state): State<Arc<GlobalAppState>>,
auth_user: AuthUser,
2025-04-02 01:22:05 +02:00
Path(id): Path<String>,
Query(_params): Query<HashMap<String, String>>,
) -> impl IntoResponse {
tracing::info!("Downloading folder as ZIP: {}", id);
2026-02-14 20:22:19 +01:00
// Get folder information and verify ownership
2025-04-02 01:22:05 +02:00
let folder_service = &state.applications.folder_service;
2026-02-14 20:22:19 +01:00
match folder_service
.get_folder_with_perms(&id, auth_user.id)
.await
{
2025-04-02 01:22:05 +02:00
Ok(folder) => {
tracing::info!("Preparing ZIP for folder: {} ({})", folder.name, id);
2026-02-14 20:22:19 +01:00
// Use ZIP service from DI container
let zip_service = match &state.core.zip_service {
Some(svc) => svc,
None => {
tracing::error!("ZipService not initialized");
return (
StatusCode::INTERNAL_SERVER_ERROR,
Json(serde_json::json!({ "error": "ZipService not initialized" })),
)
.into_response();
}
};
2026-02-14 20:22:19 +01:00
// Stream the archive as it is built — the first byte reaches
// the client after the first entry, not after the whole ZIP
// exists on disk (benches/ZIP-STREAM.md). No Content-Length:
// the final size isn't known up front (chunked encoding).
match zip_service
.create_folder_zip_stream(&id, &folder.name)
.await
{
Ok(stream) => {
let body = axum::body::Body::from_stream(stream);
2025-04-02 01:22:05 +02:00
// Setup headers for download
let filename = format!("{}.zip", folder.name);
let content_disposition = format!("attachment; filename=\"{}\"", filename);
2026-02-14 20:22:19 +01:00
Response::builder()
2025-04-02 01:22:05 +02:00
.status(StatusCode::OK)
.header(header::CONTENT_TYPE, "application/zip")
.header(header::CONTENT_DISPOSITION, content_disposition)
.body(body)
.unwrap()
.into_response()
2026-02-14 20:22:19 +01:00
}
2025-04-02 01:22:05 +02:00
Err(err) => {
tracing::error!("Error creating ZIP file: {}", err);
AppError::internal_error(format!("Error creating ZIP file: {}", err))
2026-02-14 20:22:19 +01:00
.into_response()
2025-04-02 01:22:05 +02:00
}
}
2026-02-14 20:22:19 +01:00
}
2025-04-02 01:22:05 +02:00
Err(err) => {
tracing::error!("Folder not found: {}", err);
AppError::from(err).into_response()
2025-04-02 01:22:05 +02:00
}
}
}
2026-02-14 20:22:19 +01:00
}
// ── Route handlers (free functions) ──────────────────────────────────────────
//
// All annotated route functions live here rather than as methods on FolderHandler
// because utoipa 5.4.0's #[utoipa::path] macro generates helper structs inside
// its expansion. Rust allows struct definitions at module scope but forbids them
// inside impl blocks — so every #[utoipa::path] annotation on a FolderHandler
// method fails to compile regardless of HTTP verb or annotation content.
//
// All logic lives in the FolderHandler::*_impl methods above; these thin wrappers
// exist solely to carry the OpenAPI annotation at a scope where utoipa can
// generate its helper types.
//
// routes.rs calls these free functions directly.
// TODO: collapse back into the impl block after a utoipa upgrade resolves the issue.
#[utoipa::path(
post,
path = "/api/folders",
request_body(content = CreateFolderDto, content_type = "application/json", description = "Folder creation payload"),
responses(
(status = 201, description = "Folder created", body = FolderDto),
(status = 400, description = "Invalid request"),
),
security(("bearerAuth" = [])),
tag = "folders"
)]
pub async fn create_folder(
state: State<AppState>,
auth_user: AuthUser,
json: Json<CreateFolderDto>,
) -> impl IntoResponse {
FolderHandler::create_folder_impl(state, auth_user, json).await
}
#[utoipa::path(
get,
path = "/api/folders/{id}",
params(("id" = String, Path, description = "Folder ID")),
responses(
(status = 200, description = "Folder", body = FolderDto),
(status = 404, description = "Folder not found"),
),
security(("bearerAuth" = [])),
tag = "folders"
)]
pub async fn get_folder(
state: State<AppState>,
auth_user: AuthUser,
path: Path<String>,
) -> impl IntoResponse {
FolderHandler::get_folder_impl(state, auth_user, path).await
}
#[utoipa::path(
get,
path = "/api/folders",
responses(
(status = 200, description = "List of root folders", body = Vec<FolderDto>),
),
security(("bearerAuth" = [])),
tag = "folders"
)]
pub async fn list_root_folders(
state: State<AppState>,
auth_user: AuthUser,
) -> axum::response::Response {
FolderHandler::list_root_folders_impl(state, auth_user).await
}
#[utoipa::path(
put,
path = "/api/folders/{id}/rename",
params(("id" = String, Path, description = "Folder ID")),
request_body(content = RenameFolderDto, content_type = "application/json", description = "Rename payload"),
responses(
(status = 200, description = "Renamed folder", body = FolderDto),
(status = 404, description = "Folder not found"),
),
security(("bearerAuth" = [])),
tag = "folders"
)]
pub async fn rename_folder(
state: State<AppState>,
auth_user: AuthUser,
path: Path<String>,
json: Json<RenameFolderDto>,
) -> impl IntoResponse {
FolderHandler::rename_folder_impl(state, auth_user, path, json).await
}
#[utoipa::path(
put,
path = "/api/folders/{id}/move",
params(("id" = String, Path, description = "Folder ID")),
request_body(content = MoveFolderDto, content_type = "application/json", description = "Move payload"),
responses(
(status = 200, description = "Moved folder", body = FolderDto),
(status = 404, description = "Folder or destination not found"),
),
security(("bearerAuth" = [])),
tag = "folders"
)]
pub async fn move_folder(
state: State<AppState>,
auth_user: AuthUser,
path: Path<String>,
json: Json<MoveFolderDto>,
) -> impl IntoResponse {
FolderHandler::move_folder_impl(state, auth_user, path, json).await
}
#[utoipa::path(
delete,
path = "/api/folders/{id}",
params(("id" = String, Path, description = "Folder ID")),
responses(
(status = 204, description = "Folder deleted"),
(status = 404, description = "Folder not found"),
),
security(("bearerAuth" = [])),
tag = "folders"
)]
pub async fn delete_folder_with_trash(
state: State<Arc<GlobalAppState>>,
auth_user: AuthUser,
path: Path<String>,
) -> impl IntoResponse {
FolderHandler::delete_folder_with_trash_impl(state, auth_user, path).await
}
#[utoipa::path(
get,
path = "/api/folders/{id}/download",
params(("id" = String, Path, description = "Folder ID")),
responses(
(status = 200, description = "ZIP archive stream (application/zip)"),
(status = 404, description = "Folder not found"),
(status = 501, description = "ZIP service not available"),
),
security(("bearerAuth" = [])),
tag = "folders"
)]
pub async fn download_folder_zip(
state: State<Arc<GlobalAppState>>,
auth_user: AuthUser,
path: Path<String>,
query: Query<HashMap<String, String>>,
) -> impl IntoResponse {
FolderHandler::download_folder_zip_impl(state, auth_user, path, query).await
}
// ── GET /api/folders/{id}/resources ─────────────────────────────────────────
#[utoipa::path(
get,
path = "/api/folders/{id}/resources",
params(
("id" = String, Path, description = "Folder ID"),
FolderResourcesQuery,
),
responses(
(status = 200,
description = "Cursor-paginated files and folders inside the requested folder. \
Items arrive in `order_by` order (folders first when order_by=name). \
`next_cursor` is absent on the last page.",
body = FolderResourcesDto),
(status = 404, description = "Folder not found or access denied"),
),
security(("bearerAuth" = [])),
tag = "folders"
)]
pub async fn list_folder_resources(
State(service): State<AppState>,
auth_user: AuthUser,
Path(id): Path<String>,
Query(q): Query<FolderResourcesQuery>,
) -> impl IntoResponse {
let order_by = q.order_by.clone().unwrap_or_else(|| "name".to_owned());
let kinds = q.resource_kinds();
let opts = ListResourcesOptions {
limit: q.limit_clamped(),
cursor: q.decode_cursor(),
order_by: &order_by,
kinds: kinds.as_deref(),
reverse: q.reverse,
};
match service
.list_resources_paged_with_perms(&id, auth_user.id, opts)
.await
{
Ok((rows, next_cursor)) => {
let items: Vec<FolderResourceItemDto> = rows
.into_iter()
.map(|row| {
if row.resource_type == "folder" {
let resource_id = row.id.to_string();
let dto = FolderDto {
etag: resource_id.clone(),
id: resource_id,
name: row.name.clone(),
path: String::new(), // cleared — share recipients must not see hierarchy
parent_id: row.parent_id.map(|u| u.to_string()),
drive_id: row.drive_id,
created_at: row.created_at.timestamp() as u64,
modified_at: row.modified_at.timestamp() as u64,
is_root: false,
icon_class: intern_display("fas fa-folder"),
icon_special_class: intern_display("folder-icon"),
category: intern_display("Folder"),
2026-06-19 10:51:13 +02:00
// §14 provenance not selected by the resources query.
created_by: None,
updated_by: None,
};
FolderResourceItemDto {
resource_type: ResourceTypeDto::Folder,
resource: ResourceContentDto::Folder(dto),
}
} else {
let mime = row
.mime_type
.as_deref()
.unwrap_or("application/octet-stream");
let size_bytes = row.size.max(0) as u64;
// `blob_hash` is `Some(_)` for file rows in the
// UNION ALL (`NULL` for folders). Route the
// ETag formula through `File::compute_etag` —
// the single source of truth shared with
// GET/HEAD/PROPFIND/PUT response — so this
// listing's `etag` byte-equals what a
// conditional request would compare against.
let modified_at_u = row.modified_at.timestamp() as u64;
let content_hash = row.blob_hash.clone().unwrap_or_default();
let etag = if content_hash.is_empty() {
String::new()
} else {
File::compute_etag(&content_hash, modified_at_u)
};
let dto = FileDto {
id: row.id.to_string(),
name: row.name.clone(),
path: String::new(),
size: size_bytes,
mime_type: intern_mime(mime),
folder_id: row.parent_id.map(|u| u.to_string()),
created_at: row.created_at.timestamp() as u64,
modified_at: row.modified_at.timestamp() as u64,
icon_class: intern_display(icon_class_for(&row.name, mime)),
icon_special_class: intern_display(icon_special_class_for(
&row.name, mime,
)),
category: intern_display(category_for(&row.name, mime)),
size_formatted: format_file_size(size_bytes),
sort_date: None,
content_hash,
etag,
2026-06-19 10:51:13 +02:00
// §14 provenance not selected by the resources query.
created_by: None,
updated_by: None,
};
FolderResourceItemDto {
resource_type: ResourceTypeDto::File,
resource: ResourceContentDto::File(dto),
}
}
})
.collect();
(
StatusCode::OK,
Json(FolderResourcesDto::with_cursor(items, next_cursor)),
)
.into_response()
}
Err(e) => AppError::from(e).into_response(),
}
}