Files
Oxicloud/src/application/dtos/file_dto.rs
T

149 lines
4.4 KiB
Rust
Raw Normal View History

use std::sync::Arc;
2025-03-17 21:28:08 +01:00
use crate::domain::entities::file::File;
2026-02-14 01:29:34 +01:00
use serde::{Deserialize, Serialize};
use utoipa::ToSchema;
2025-03-17 21:28:08 +01:00
use super::display_helpers::{
category_for, format_file_size, icon_class_for, icon_special_class_for,
};
2025-03-17 21:28:08 +01:00
/// DTO for file responses
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
2025-03-17 21:28:08 +01:00
pub struct FileDto {
/// File ID
pub id: String,
2026-02-14 01:29:34 +01:00
2025-03-17 21:28:08 +01:00
/// File name
pub name: String,
2026-02-14 01:29:34 +01:00
2025-03-17 21:28:08 +01:00
/// Path to the file (relative)
pub path: String,
2026-02-14 01:29:34 +01:00
2025-03-17 21:28:08 +01:00
/// Size in bytes
pub size: u64,
2026-02-14 01:29:34 +01:00
/// MIME type — `Arc<str>` because MIME values repeat across files
/// and DTOs are cloned on every request (clone is O(1) atomic increment).
#[schema(value_type = String)]
pub mime_type: Arc<str>,
2026-02-14 01:29:34 +01:00
2025-03-17 21:28:08 +01:00
/// Parent folder ID
pub folder_id: Option<String>,
2026-02-14 01:29:34 +01:00
2025-03-17 21:28:08 +01:00
/// Creation timestamp
pub created_at: u64,
2026-02-14 01:29:34 +01:00
2025-03-17 21:28:08 +01:00
/// Last modification timestamp
pub modified_at: u64,
// ── Pre-computed display fields (Arc<str>: values come from static tables) ──
/// FontAwesome icon CSS class (e.g. "fas fa-file-image")
#[schema(value_type = String)]
pub icon_class: Arc<str>,
/// Extra CSS class for icon styling (e.g. "image-icon", "" when default)
#[schema(value_type = String)]
pub icon_special_class: Arc<str>,
/// Human-readable file category (e.g. "Image", "Document")
#[schema(value_type = String)]
pub category: Arc<str>,
/// Human-readable formatted size (e.g. "3.27 MB")
pub size_formatted: String,
/// Owner user ID (omitted from JSON when None)
#[serde(skip_serializing_if = "Option::is_none")]
pub owner_id: Option<String>,
/// Sort date for Photos timeline — COALESCE(EXIF captured_at, created_at).
/// Only populated by the /api/photos endpoint.
#[serde(skip_serializing_if = "Option::is_none")]
pub sort_date: Option<u64>,
/// Content-addressable ETag (= blob_hash). Changes on every content write.
/// Used for WebDAV/Nextcloud ETag headers. Omitted from REST API JSON.
#[serde(skip)]
pub etag: String,
2025-03-17 21:28:08 +01:00
}
impl From<File> for FileDto {
fn from(file: File) -> Self {
// Consume the entity by moving all fields — zero heap allocations
// for id, name, path, folder_id, owner_id (previously 5× .to_string()).
let parts = file.into_parts();
let icon_class = Arc::from(icon_class_for(&parts.name, &parts.mime_type));
let icon_special_class = Arc::from(icon_special_class_for(&parts.name, &parts.mime_type));
let category = Arc::from(category_for(&parts.name, &parts.mime_type));
let size_formatted = format_file_size(parts.size);
let mime_type = Arc::from(parts.mime_type.as_str());
2025-03-17 21:28:08 +01:00
Self {
id: parts.id,
name: parts.name,
path: parts.path_string,
size: parts.size,
mime_type,
folder_id: parts.folder_id,
created_at: parts.created_at,
modified_at: parts.modified_at,
icon_class,
icon_special_class,
category,
size_formatted,
owner_id: parts.owner_id.map(|u| u.to_string()),
sort_date: None,
etag: parts.etag,
2025-03-17 21:28:08 +01:00
}
}
2025-03-19 00:44:27 +01:00
}
// To convert from FileDto to File for batch handlers
2025-03-19 00:44:27 +01:00
impl From<FileDto> for File {
fn from(dto: FileDto) -> Self {
// Display fields (icon_class, icon_special_class, category, size_formatted)
// are not part of the domain entity and are ignored.
2025-03-19 00:44:27 +01:00
File::from_dto(
2026-02-14 01:29:34 +01:00
dto.id,
dto.name,
2025-03-19 00:44:27 +01:00
dto.path,
dto.size,
dto.mime_type.to_string(),
2025-03-19 00:44:27 +01:00
dto.folder_id,
dto.created_at,
2026-02-14 01:29:34 +01:00
dto.modified_at,
2025-03-19 00:44:27 +01:00
)
}
2025-03-20 09:22:31 +01:00
}
impl FileDto {
/// Creates an empty file DTO for stub implementations
pub fn empty() -> Self {
Self {
id: "stub-id".to_string(),
name: "stub-file".to_string(),
path: "/stub/path".to_string(),
size: 0,
mime_type: Arc::from("application/octet-stream"),
2025-03-20 09:22:31 +01:00
folder_id: None,
created_at: 0,
modified_at: 0,
icon_class: Arc::from("fas fa-file"),
icon_special_class: Arc::from(""),
category: Arc::from("Document"),
size_formatted: "0 Bytes".to_string(),
owner_id: None,
etag: String::new(),
sort_date: None,
2025-03-20 09:22:31 +01:00
}
}
}
impl Default for FileDto {
fn default() -> Self {
Self::empty()
}
2026-02-14 01:29:34 +01:00
}