feature/recipe-comments (#448)

* fix favorite color issue

* db and models for comments

* rename files

* initial UI for comments

* fix format

* import / export

* fixes #428

* format

Co-authored-by: hay-kot <hay-kot@pm.me>

mealie/db/database.py

@@ -5,6 +5,7 @@ from mealie.db.db_base import BaseDocument
 from mealie.db.models.event import Event, EventNotification
 from mealie.db.models.group import Group
 from mealie.db.models.mealplan import MealPlan
+from mealie.db.models.recipe.comment import RecipeComment
 from mealie.db.models.recipe.recipe import Category, RecipeModel, Tag
 from mealie.db.models.settings import CustomPage, SiteSettings
 from mealie.db.models.shopping_list import ShoppingList
@@ -12,6 +13,7 @@ from mealie.db.models.sign_up import SignUp
 from mealie.db.models.theme import SiteThemeModel
 from mealie.db.models.users import LongLiveToken, User
 from mealie.schema.category import RecipeCategoryResponse, RecipeTagResponse
+from mealie.schema.comments import CommentOut
 from mealie.schema.event_notifications import EventNotificationIn
 from mealie.schema.events import Event as EventSchema
 from mealie.schema.meal import MealPlanOut
@@ -110,6 +112,13 @@ class _Users(BaseDocument):
         return self.schema.from_orm(entry)
 
 
+class _Comments(BaseDocument):
+    def __init__(self) -> None:
+        self.primary_key = "id"
+        self.sql_model = RecipeComment
+        self.schema = CommentOut
+
+
 class _LongLiveToken(BaseDocument):
     def __init__(self) -> None:
         self.primary_key = "id"
@@ -190,6 +199,7 @@ class Database:
         self.events = _Events()
         self.event_notifications = _EventNotification()
         self.shopping_lists = _ShoppingList()
+        self.comments = _Comments()
 
 
 db = Database()

mealie/db/models/model_base.py

@@ -8,6 +8,7 @@ class BaseMixins:
     def update(self, *args, **kwarg):
         self.__init__(*args, **kwarg)
 
+    @classmethod
     def get_ref(cls_type, session: Session, match_value: str, match_attr: str = "id"):
         eff_ref = getattr(cls_type, match_attr)
         return session.query(cls_type).filter(eff_ref == match_value).one_or_none()

mealie/db/models/recipe/assets.py

@@ -16,7 +16,6 @@ class RecipeAsset(SqlAlchemyBase):
         icon=None,
         file_name=None,
     ) -> None:
-        print("Asset Saved", name)
         self.name = name
         self.file_name = file_name
         self.icon = icon

mealie/db/models/recipe/comment.py

@@ -0,0 +1,36 @@
+from datetime import datetime
+from uuid import uuid4
+
+from mealie.db.models.model_base import BaseMixins, SqlAlchemyBase
+from mealie.db.models.recipe.recipe import RecipeModel
+from mealie.db.models.users import User
+from sqlalchemy import Column, DateTime, ForeignKey, Integer, String, orm
+
+
+def generate_uuid():
+    return str(uuid4())
+
+
+class RecipeComment(SqlAlchemyBase, BaseMixins):
+    __tablename__ = "recipe_comments"
+    id = Column(Integer, primary_key=True)
+    uuid = Column(Integer, unique=True, nullable=False, default=generate_uuid)
+    parent_id = Column(Integer, ForeignKey("recipes.id"), nullable=False)
+    recipe = orm.relationship("RecipeModel", back_populates="comments")
+    user_id = Column(Integer, ForeignKey("users.id"), nullable=False)
+    user = orm.relationship("User", back_populates="comments", single_parent=True, foreign_keys=[user_id])
+    date_added = Column(DateTime, default=datetime.now)
+    text = Column(String)
+
+    def __init__(self, recipe_slug, user, text, session, date_added=None, **_) -> None:
+        self.text = text
+        self.recipe = RecipeModel.get_ref(session, recipe_slug, "slug")
+        self.date_added = date_added or datetime.now()
+
+        if isinstance(user, dict):
+            user = user.get("id")
+
+        self.user = User.get_ref(session, user)
+
+    def update(self, text, **_) -> None:
+        self.text = text

mealie/db/models/recipe/recipe.py

@@ -55,6 +55,8 @@ class RecipeModel(SqlAlchemyBase, BaseMixins):
         collection_class=ordering_list("position"),
     )
 
+    comments: list = orm.relationship("RecipeComment", back_populates="recipe", cascade="all, delete, delete-orphan")
+
     # Mealie Specific
     slug = sa.Column(sa.String, index=True, unique=True)
     settings = orm.relationship("RecipeSettings", uselist=False, cascade="all, delete-orphan")

mealie/db/models/users.py

@@ -33,6 +33,10 @@ class User(SqlAlchemyBase, BaseMixins):
         LongLiveToken, back_populates="user", cascade="all, delete, delete-orphan", single_parent=True
     )
 
+    comments: list = orm.relationship(
+        "RecipeComment", back_populates="user", cascade="all, delete, delete-orphan", single_parent=True
+    )
+
     favorite_recipes: list[RecipeModel] = orm.relationship(RecipeModel, back_populates="favorited_by")
 
     def __init__(
@@ -56,8 +60,7 @@ class User(SqlAlchemyBase, BaseMixins):
         self.password = password
 
         self.favorite_recipes = [
-            RecipeModel.get_ref(RecipeModel, session=session, match_value=x, match_attr="slug")
-            for x in favorite_recipes
+            RecipeModel.get_ref(session=session, match_value=x, match_attr="slug") for x in favorite_recipes
         ]
 
         if self.username is None:
@@ -78,8 +81,7 @@ class User(SqlAlchemyBase, BaseMixins):
             self.password = password
 
         self.favorite_recipes = [
-            RecipeModel.get_ref(RecipeModel, session=session, match_value=x, match_attr="slug")
-            for x in favorite_recipes
+            RecipeModel.get_ref(session=session, match_value=x, match_attr="slug") for x in favorite_recipes
         ]
 
     def update_password(self, password):

mealie/routes/recipe/__init__.py

@@ -1,5 +1,5 @@
 from fastapi import APIRouter
-from mealie.routes.recipe import all_recipe_routes, category_routes, recipe_crud_routes, tag_routes
+from mealie.routes.recipe import all_recipe_routes, category_routes, comments, recipe_crud_routes, tag_routes
 
 recipe_router = APIRouter()
 
@@ -7,3 +7,4 @@ recipe_router.include_router(all_recipe_routes.router)
 recipe_router.include_router(recipe_crud_routes.router)
 recipe_router.include_router(category_routes.router)
 recipe_router.include_router(tag_routes.router)
+recipe_router.include_router(comments.router)

mealie/routes/recipe/comments.py

@@ -0,0 +1,54 @@
+from http.client import HTTPException
+
+from fastapi import APIRouter, Depends, status
+from mealie.db.database import db
+from mealie.db.db_setup import generate_session
+from mealie.routes.deps import get_current_user
+from mealie.schema.comments import CommentIn, CommentOut, CommentSaveToDB
+from mealie.schema.user import UserInDB
+from sqlalchemy.orm.session import Session
+
+router = APIRouter(prefix="/api", tags=["Recipe Comments"])
+
+
+@router.post("/recipes/{slug}/comments")
+async def create_comment(
+    slug: str,
+    new_comment: CommentIn,
+    session: Session = Depends(generate_session),
+    current_user: UserInDB = Depends(get_current_user),
+):
+    """ Create comment in the Database """
+
+    new_comment = CommentSaveToDB(user=current_user.id, text=new_comment.text, recipe_slug=slug)
+    return db.comments.create(session, new_comment)
+
+
+@router.put("/recipes/{slug}/comments/{id}")
+async def update_comment(
+    id: int,
+    new_comment: CommentIn,
+    session: Session = Depends(generate_session),
+    current_user: UserInDB = Depends(get_current_user),
+):
+    """ Update comment in the Database """
+    old_comment: CommentOut = db.comments.get(session, id)
+
+    if current_user.id != old_comment.user.id:
+        raise HTTPException(status.HTTP_401_UNAUTHORIZED)
+
+    return db.comments.update(session, id, new_comment)
+
+
+@router.delete("/recipes/{slug}/comments/{id}")
+async def delete_comment(
+    id: int, session: Session = Depends(generate_session), current_user: UserInDB = Depends(get_current_user)
+):
+    """ Delete comment from the Database """
+    comment: CommentOut = db.comments.get(session, id)
+    print(current_user.id, comment.user.id, current_user.admin)
+    if current_user.id == comment.user.id or current_user.admin:
+        db.comments.delete(session, id)
+        return
+
+    raise HTTPException(status.HTTP_401_UNAUTHORIZED)

mealie/schema/comments.py

@@ -0,0 +1,44 @@
+from datetime import datetime
+from typing import Optional
+
+from fastapi_camelcase import CamelModel
+from pydantic.utils import GetterDict
+
+
+class UserBase(CamelModel):
+    id: int
+    username: Optional[str]
+    admin: bool
+
+    class Config:
+        orm_mode = True
+
+
+class CommentIn(CamelModel):
+    text: str
+
+
+class CommentSaveToDB(CommentIn):
+    recipe_slug: str
+    user: int
+
+    class Config:
+        orm_mode = True
+
+
+class CommentOut(CommentIn):
+    id: int
+    uuid: str
+    recipe_slug: str
+    date_added: datetime
+    user: UserBase
+
+    class Config:
+        orm_mode = True
+
+        @classmethod
+        def getter_dict(_cls, name_orm):
+            return {
+                **GetterDict(name_orm),
+                "recipe_slug": name_orm.recipe.slug,
+            }

mealie/schema/recipe.py

@@ -5,6 +5,7 @@ from typing import Any, Optional
 from fastapi_camelcase import CamelModel
 from mealie.core.config import app_dirs
 from mealie.db.models.recipe.recipe import RecipeModel
+from mealie.schema.comments import CommentOut
 from pydantic import BaseModel, Field, validator
 from pydantic.utils import GetterDict
 from slugify import slugify
@@ -102,6 +103,8 @@ class Recipe(RecipeSummary):
     org_url: Optional[str] = Field(None, alias="orgURL")
     extras: Optional[dict] = {}
 
+    comments: Optional[list[CommentOut]] = []
+
     @staticmethod
     def directory_from_slug(slug) -> Path:
         return app_dirs.RECIPE_DATA_DIR.joinpath(slug)

mealie/services/backups/exports.py

@@ -129,6 +129,9 @@ def backup_all(
         db_export.export_items(all_recipes, "recipes", export_list=False, slug_folder=True)
         db_export.export_templates(all_recipes)
 
+        all_comments = db.comments.get_all(session)
+        db_export.export_items(all_comments, "comments")
+
     if export_settings:
         all_settings = db.settings.get_all(session)
         db_export.export_items(all_settings, "settings")

mealie/services/backups/imports.py

@@ -6,6 +6,7 @@ from typing import Callable
 
 from mealie.core.config import app_dirs
 from mealie.db.database import db
+from mealie.schema.comments import CommentOut
 from mealie.schema.event_notifications import EventNotificationIn
 from mealie.schema.recipe import Recipe
 from mealie.schema.restore import (
@@ -85,6 +86,22 @@ class ImportDatabase:
 
         return imports
 
+    def import_comments(self):
+        comment_dir: Path = self.import_dir.joinpath("comments", "comments.json")
+
+        comments = ImportDatabase.read_models_file(file_path=comment_dir, model=CommentOut)
+
+        for comment in comments:
+            comment: CommentOut
+
+            self.import_model(
+                db_table=db.comments,
+                model=comment,
+                return_model=ThemeImport,
+                name_attr="uuid",
+                search_key="uuid",
+            )
+
     @staticmethod
     def _recipe_migration(recipe_dict: dict) -> dict:
         if recipe_dict.get("categories", False):
@@ -364,6 +381,9 @@ def import_database(
     if import_notifications:
         notification_report = import_session.import_notifications()
 
+    if import_recipes:
+        import_session.import_comments()
+
     import_session.clean_up()
 
     return {