Add content folders migrations ans views

Author: Gabatxo1312

src/database/category.rs

@@ -4,6 +4,7 @@ use sea_orm::entity::prelude::*;
 use sea_orm::*;
 use snafu::prelude::*;
 
+use crate::database::content_folder;
 use crate::database::operation::*;
 use crate::extractors::normalized_path::*;
 use crate::extractors::user::User;
@@ -15,6 +16,7 @@ use crate::state::logger::LoggerError;
 ///
 /// Each category has a name and an associated path on disk, where
 /// symlinks to the content will be created.
+#[sea_orm::model]
 #[derive(Clone, Debug, PartialEq, DeriveEntityModel)]
 #[sea_orm(table_name = "category")]
 pub struct Model {
@@ -24,11 +26,10 @@ pub struct Model {
     pub name: NormalizedPathComponent,
     #[sea_orm(unique)]
     pub path: NormalizedPathAbsolute,
+    #[sea_orm(has_many)]
+    pub content_folders: HasMany<super::content_folder::Entity>,
 }
 
-#[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
-pub enum Relation {}
-
 #[async_trait::async_trait]
 impl ActiveModelBehavior for ActiveModel {}
 
@@ -64,6 +65,31 @@ impl CategoryOperator {
         Self { state, user }
     }
 
+    /// List content folders of category    
+    ///
+    /// Should not fail, unless SQLite was corrupted for some reason.
+    pub async fn list_folders_by_category(
+        &self,
+        category_id: i32,
+    ) -> Result<Vec<crate::database::content_folder::Model>, CategoryError> {
+        let category: Option<Model> = Entity::find_by_id(category_id)
+            .one(&self.state.database)
+            .await
+            .context(DBSnafu)?;
+
+        if let Some(category) = category {
+            let folders = category
+                .find_related(content_folder::Entity)
+                .filter(content_folder::Column::ParentId.is_null())
+                .all(&self.state.database)
+                .await
+                .context(DBSnafu)?;
+            Ok(folders)
+        } else {
+            Err(CategoryError::IDNotFound { id: category_id })
+        }
+    }
+
     /// List categories
     ///
     /// Should not fail, unless SQLite was corrupted for some reason.
@@ -74,6 +100,19 @@ impl CategoryOperator {
             .context(DBSnafu)
     }
 
+    /// Find one category by ID
+    pub async fn find_by_id(&self, id: i32) -> Result<Model, CategoryError> {
+        let category = Entity::find_by_id(id)
+            .one(&self.state.database)
+            .await
+            .context(DBSnafu)?;
+
+        match category {
+            Some(category) => Ok(category),
+            None => Err(CategoryError::IDNotFound { id }),
+        }
+    }
+
     /// Find one category by Name
     pub async fn find_by_name(&self, name: String) -> Result<Model, CategoryError> {
         let category = Entity::find()

src/database/content_folder.rs

@@ -0,0 +1,177 @@
+use chrono::Utc;
+use sea_orm::entity::prelude::*;
+use sea_orm::*;
+use snafu::prelude::*;
+
+use crate::database::category;
+use crate::database::operation::{Operation, OperationId, OperationLog, OperationType, Table};
+use crate::extractors::normalized_path::*;
+use crate::extractors::user::User;
+use crate::routes::content_folder::ContentFolderForm;
+use crate::state::AppState;
+use crate::state::logger::LoggerError;
+
+/// A content folder to store associated files.
+///
+/// Each content folder has a name and an associated path on disk, a Category
+/// and it can have an Parent Content Folder (None if it's the first folder
+/// in category)
+#[sea_orm::model]
+#[derive(DeriveEntityModel, Clone, Debug, PartialEq, Eq)]
+#[sea_orm(table_name = "content_folder")]
+pub struct Model {
+    #[sea_orm(primary_key)]
+    pub id: i32,
+    pub name: NormalizedPathComponent,
+    #[sea_orm(unique)]
+    pub path: NormalizedPathAbsolute,
+    pub category_id: i32,
+    #[sea_orm(belongs_to, from = "category_id", to = "id")]
+    pub category: HasOne<category::Entity>,
+    pub parent_id: Option<i32>,
+    #[sea_orm(self_ref, relation_enum = "Parent", from = "parent_id", to = "id")]
+    pub parent: HasOne<Entity>,
+}
+
+#[async_trait::async_trait]
+impl ActiveModelBehavior for ActiveModel {}
+
+#[derive(Debug, Snafu)]
+#[snafu(visibility(pub))]
+pub enum ContentFolderError {
+    #[snafu(display("There is already a content folder called `{name}`"))]
+    NameTaken { name: String },
+    #[snafu(display("There is already a content folder in dir `{path}`"))]
+    PathTaken { path: String },
+    #[snafu(display("The Content Folder (Path: {path}) does not exist"))]
+    NotFound { path: String },
+    #[snafu(display("Database error"))]
+    DB { source: sea_orm::DbErr },
+    #[snafu(display("Failed to save the operation log"))]
+    Logger { source: LoggerError },
+    #[snafu(display("Path is invalid"))]
+    PathInvalid { source: NormalizeError },
+}
+
+#[derive(Clone, Debug)]
+pub struct ContentFolderOperator {
+    pub state: AppState,
+    pub user: Option<User>,
+}
+
+impl ContentFolderOperator {
+    pub fn new(state: AppState, user: Option<User>) -> Self {
+        Self { state, user }
+    }
+
+    /// List childs folder from folder
+    /// Provide a content_folder_id and get all folder with parent_id equal to the
+    /// current_folder_id
+    pub async fn list_child_folders_by_folder(
+        &self,
+        content_folder_id: i32,
+    ) -> Result<Vec<Model>, ContentFolderError> {
+        let query = Entity::find().filter(Column::ParentId.eq(content_folder_id));
+        query.all(&self.state.database).await.context(DBSnafu)
+    }
+
+    /// Find one Content Folder by path
+    ///
+    /// Should not fail, unless SQLite was corrupted for some reason.
+    pub async fn find_by_path(&self, path: String) -> Result<Model, ContentFolderError> {
+        let normalized_path =
+            NormalizedPathAbsolute::try_from(path.clone()).context(PathInvalidSnafu)?;
+
+        let content_folder = Entity::find_by_path(normalized_path)
+            .one(&self.state.database)
+            .await
+            .context(DBSnafu)?;
+
+        match content_folder {
+            Some(category) => Ok(category),
+            None => Err(ContentFolderError::NotFound { path }),
+        }
+    }
+
+    /// Find one Content Folder by ID
+    ///
+    /// Should not fail, unless SQLite was corrupted for some reason.
+    pub async fn find_by_id(&self, id: i32) -> Result<Model, ContentFolderError> {
+        let content_folder = Entity::find_by_id(id)
+            .one(&self.state.database)
+            .await
+            .context(DBSnafu)?;
+
+        match content_folder {
+            Some(category) => Ok(category),
+            None => Err(ContentFolderError::NotFound {
+                path: id.to_string(),
+            }),
+        }
+    }
+
+    /// Create a new content folder
+    ///
+    /// Fails if:
+    ///
+    /// - name or path is already taken (they should be unique in one folder)
+    /// - path parent directory does not exist (to avoid completely wrong paths)
+    pub async fn create(
+        &self,
+        f: &ContentFolderForm,
+        user: Option<User>,
+    ) -> Result<Model, ContentFolderError> {
+        // Check duplicates in same folder
+        let list = if let Some(parent_id) = f.parent_id {
+            self.list_child_folders_by_folder(parent_id).await?
+        } else {
+            vec![]
+        };
+
+        if list.iter().any(|x| x.name == f.name) {
+            return Err(ContentFolderError::NameTaken {
+                name: f.name.to_string(),
+            });
+        }
+
+        if list.iter().any(|x| x.path == f.path) {
+            return Err(ContentFolderError::PathTaken {
+                path: f.path.to_string(),
+            });
+        }
+
+        let model = ActiveModel {
+            name: Set(f.name.clone()),
+            path: Set(f.path.clone()),
+            category_id: Set(f.category_id),
+            parent_id: Set(f.parent_id),
+            ..Default::default()
+        }
+        .save(&self.state.database)
+        .await
+        .context(DBSnafu)?;
+
+        // Should not fail
+        let model = model.try_into_model().unwrap();
+
+        let operation_log = OperationLog {
+            user,
+            date: Utc::now(),
+            table: Table::ContentFolder,
+            operation: OperationType::Create,
+            operation_id: OperationId {
+                object_id: model.id.to_owned(),
+                name: f.name.to_string(),
+            },
+            operation_form: Some(Operation::ContentFolder(f.clone())),
+        };
+
+        self.state
+            .logger
+            .write(operation_log)
+            .await
+            .context(LoggerSnafu)?;
+
+        Ok(model)
+    }
+}

src/database/mod.rs

@@ -1,3 +1,4 @@
 // sea_orm example: https://github.com/SeaQL/sea-orm/blob/master/examples/axum_example/
 pub mod category;
+pub mod content_folder;
 pub mod operation;

src/database/operation.rs

@@ -4,6 +4,7 @@ use serde::{Deserialize, Serialize};
 
 use crate::extractors::user::User;
 use crate::routes::category::CategoryForm;
+use crate::routes::content_folder::ContentFolderForm;
 
 /// Type of operation applied to the database.
 #[derive(Clone, Debug, Display, Serialize, Deserialize)]
@@ -22,6 +23,7 @@ pub struct OperationId {
 #[derive(Clone, Debug, Display, Serialize, Deserialize)]
 pub enum Table {
     Category,
+    ContentFolder,
 }
 
 /// Operation applied to the database.
@@ -31,6 +33,7 @@ pub enum Table {
 #[serde(untagged)]
 pub enum Operation {
     Category(CategoryForm),
+    ContentFolder(ContentFolderForm),
 }
 
 impl std::fmt::Display for Operation {

src/extractors/normalized_path/absolute.rs

@@ -9,7 +9,7 @@ use std::str::FromStr;
 use super::*;
 
 /// [NormalizedPath] with extra constraint that it's absolute.
-#[derive(Clone, Debug, PartialEq, Deserialize, Serialize, Hash, DeriveValueType)]
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize, Hash, DeriveValueType)]
 #[sea_orm(value_type = "String")]
 #[serde(into = "String", try_from = "String")]
 pub struct NormalizedPathAbsolute {

src/extractors/normalized_path/component.rs

@@ -9,7 +9,7 @@ use std::str::FromStr;
 use super::*;
 
 /// [NormalizedPath] with extra constraint that it contains no slashes.
-#[derive(Clone, Debug, PartialEq, Deserialize, Serialize, Hash, DeriveValueType)]
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize, Hash, DeriveValueType)]
 #[sea_orm(value_type = "String")]
 #[serde(into = "String", try_from = "String")]
 pub struct NormalizedPathComponent {

src/extractors/normalized_path/mod.rs

@@ -22,7 +22,7 @@ pub use relative::*;
 /// - disallows parent dir traversal (`..`)
 /// - has no trailing slash
 /// - may contain current dir `./` but these will be discarded
-#[derive(Clone, Debug, PartialEq, Deserialize, Serialize, Hash, DeriveValueType)]
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize, Hash, DeriveValueType)]
 #[sea_orm(value_type = "String")]
 #[serde(into = "String", try_from = "String")]
 pub struct NormalizedPath {

src/lib.rs

@@ -27,6 +27,11 @@ pub fn router(state: state::AppState) -> Router {
         .route("/categories/new", get(routes::category::new))
         .route("/categories/{id}/delete", get(routes::category::delete))
         .route("/folders/{category_id}", get(routes::category::show))
+        .route(
+            "/folders/{category_name}/{*folder_path}",
+            get(routes::content_folder::show),
+        )
+        .route("/folders", post(routes::content_folder::create))
         .route("/logs", get(routes::logs::index))
         // Register static assets routes
         .nest("/assets", static_router())

src/migration/m20251110_01_create_table_category.rs

@@ -27,7 +27,7 @@ impl MigrationTrait for Migration {
 }
 
 #[derive(DeriveIden)]
-enum Category {
+pub enum Category {
     Table,
     Id,
     Name,

src/migration/m20251113_203047_add_content_folder.rs

@@ -0,0 +1,57 @@
+use sea_orm_migration::{prelude::*, schema::*};
+
+use super::m20251110_01_create_table_category::Category;
+
+#[derive(DeriveMigrationName)]
+pub struct Migration;
+
+#[async_trait::async_trait]
+impl MigrationTrait for Migration {
+    async fn up(&self, manager: &SchemaManager) -> Result<(), DbErr> {
+        manager
+            .create_table(
+                Table::create()
+                    .table(ContentFolder::Table)
+                    .if_not_exists()
+                    .col(pk_auto(ContentFolder::Id))
+                    .col(string(ContentFolder::Name))
+                    .col(string(ContentFolder::Path))
+                    .col(
+                        ColumnDef::new(ContentFolder::CategoryId)
+                            .integer()
+                            .not_null(),
+                    )
+                    .foreign_key(
+                        ForeignKey::create()
+                            .name("fk-content-file-category_id")
+                            .from(ContentFolder::Table, ContentFolder::CategoryId)
+                            .to(Category::Table, Category::Id),
+                    )
+                    .col(ColumnDef::new(ContentFolder::ParentId).integer())
+                    .foreign_key(
+                        ForeignKey::create()
+                            .name("fk-content-folder-parent_id")
+                            .from(ContentFolder::ParentId, ContentFolder::ParentId)
+                            .to(ContentFolder::Table, ContentFolder::Id),
+                    )
+                    .to_owned(),
+            )
+            .await
+    }
+
+    async fn down(&self, manager: &SchemaManager) -> Result<(), DbErr> {
+        manager
+            .drop_table(Table::drop().table(ContentFolder::Table).to_owned())
+            .await
+    }
+}
+
+#[derive(DeriveIden)]
+pub enum ContentFolder {
+    Table,
+    Id,
+    Name,
+    Path,
+    CategoryId,
+    ParentId,
+}