feat: ✨ add user recipe export functionality (#845)

* feat(frontend): ✨ add user recipe export functionality

* remove depreciated folders

* change/remove depreciated folders

* add testing variable in config

* add GUID support for group_id

* improve testing feedback on 422 errors

* remove/cleanup files/folders

* initial user export support

* delete unused css

* update backup page UI

* remove depreciated settings

* feat: ✨ export download links

* fix #813

* remove top level statements

* show footer

* add export purger to scheduler

* update purge glob

* fix meal-planner lockout

* feat: ✨ add bulk delete/purge exports

* style(frontend): 💄 update UI for site settings

* feat: ✨ add version checker

* update documentation

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

mealie/schema/admin/about.py

@@ -18,6 +18,7 @@ class AppInfo(CamelModel):
 
 
 class AdminAboutInfo(AppInfo):
+    versionLatest: str
     api_port: int
     api_docs: bool
     db_type: str

mealie/schema/cookbook/cookbook.py

@@ -1,3 +1,5 @@
+from uuid import UUID
+
 from fastapi_camelcase import CamelModel
 from pydantic import validator
 from slugify import slugify
@@ -28,11 +30,11 @@ class UpdateCookBook(CreateCookBook):
 
 
 class SaveCookBook(CreateCookBook):
-    group_id: int
+    group_id: UUID
 
 
 class ReadCookBook(UpdateCookBook):
-    group_id: int
+    group_id: UUID
     categories: list[CategoryBase] = []
 
     class Config:
@@ -40,7 +42,7 @@ class ReadCookBook(UpdateCookBook):
 
 
 class RecipeCookBook(ReadCookBook):
-    group_id: int
+    group_id: UUID
     categories: list[RecipeCategoryResponse]
 
     class Config:

mealie/schema/group/group.py

@@ -1,9 +1,10 @@
 from fastapi_camelcase import CamelModel
+from pydantic import UUID4
 
 from .group_preferences import UpdateGroupPreferences
 
 
 class GroupAdminUpdate(CamelModel):
-    id: int
+    id: UUID4
     name: str
     preferences: UpdateGroupPreferences

mealie/schema/group/group_exports.py

@@ -0,0 +1,17 @@
+from datetime import datetime
+
+from fastapi_camelcase import CamelModel
+from pydantic import UUID4
+
+
+class GroupDataExport(CamelModel):
+    id: UUID4
+    group_id: UUID4
+    name: str
+    filename: str
+    path: str
+    size: str
+    expires: datetime
+
+    class Config:
+        orm_mode = True

mealie/schema/group/group_preferences.py

@@ -1,3 +1,5 @@
+from uuid import UUID
+
 from fastapi_camelcase import CamelModel
 
 
@@ -15,7 +17,7 @@ class UpdateGroupPreferences(CamelModel):
 
 
 class CreateGroupPreferences(UpdateGroupPreferences):
-    group_id: int
+    group_id: UUID
 
 
 class ReadGroupPreferences(CreateGroupPreferences):

mealie/schema/group/invite_token.py

@@ -1,3 +1,5 @@
+from uuid import UUID
+
 from fastapi_camelcase import CamelModel
 
 
@@ -7,14 +9,14 @@ class CreateInviteToken(CamelModel):
 
 class SaveInviteToken(CamelModel):
     uses_left: int
-    group_id: int
+    group_id: UUID
     token: str
 
 
 class ReadInviteToken(CamelModel):
     token: str
     uses_left: int
-    group_id: int
+    group_id: UUID
 
     class Config:
         orm_mode = True

mealie/schema/group/webhook.py

@@ -1,3 +1,5 @@
+from uuid import UUID
+
 from fastapi_camelcase import CamelModel
 
 
@@ -9,7 +11,7 @@ class CreateWebhook(CamelModel):
 
 
 class SaveWebhook(CreateWebhook):
-    group_id: int
+    group_id: UUID
 
 
 class ReadWebhook(SaveWebhook):

mealie/schema/meal_plan/new_meal.py

@@ -1,6 +1,7 @@
 from datetime import date
 from enum import Enum
 from typing import Optional
+from uuid import UUID
 
 from fastapi_camelcase import CamelModel
 from pydantic import validator
@@ -33,11 +34,11 @@ class CreatePlanEntry(CamelModel):
 
 class UpdatePlanEntry(CreatePlanEntry):
     id: int
-    group_id: int
+    group_id: UUID
 
 
 class SavePlanEntry(CreatePlanEntry):
-    group_id: int
+    group_id: UUID
 
     class Config:
         orm_mode = True

mealie/schema/recipe/recipe.py

@@ -1,6 +1,7 @@
 import datetime
 from pathlib import Path
 from typing import Any, Optional
+from uuid import UUID, uuid4
 
 from fastapi_camelcase import CamelModel
 from pydantic import BaseModel, Field, validator
@@ -59,7 +60,7 @@ class RecipeSummary(CamelModel):
     id: Optional[int]
 
     user_id: int = 0
-    group_id: int = 0
+    group_id: UUID = Field(default_factory=uuid4)
 
     name: Optional[str]
     slug: str = ""
@@ -74,6 +75,7 @@ class RecipeSummary(CamelModel):
     description: Optional[str] = ""
     recipe_category: Optional[list[RecipeTag]] = []
     tags: Optional[list[RecipeTag]] = []
+    tools: list[RecipeTool] = []
     rating: Optional[int]
     org_url: Optional[str] = Field(None, alias="orgURL")
 
@@ -86,23 +88,28 @@ class RecipeSummary(CamelModel):
         orm_mode = True
 
     @validator("tags", always=True, pre=True)
-    def validate_tags(cats: list[Any], values):
+    def validate_tags(cats: list[Any]):
         if isinstance(cats, list) and cats and isinstance(cats[0], str):
             return [RecipeTag(name=c, slug=slugify(c)) for c in cats]
         return cats
 
     @validator("recipe_category", always=True, pre=True)
-    def validate_categories(cats: list[Any], values):
+    def validate_categories(cats: list[Any]):
         if isinstance(cats, list) and cats and isinstance(cats[0], str):
             return [RecipeCategory(name=c, slug=slugify(c)) for c in cats]
         return cats
 
+    @validator("group_id", always=True, pre=True)
+    def validate_group_id(group_id: list[Any]):
+        if isinstance(group_id, int):
+            return uuid4()
+        return group_id
+
 
 class Recipe(RecipeSummary):
     recipe_ingredient: Optional[list[RecipeIngredient]] = []
     recipe_instructions: Optional[list[RecipeStep]] = []
     nutrition: Optional[Nutrition]
-    tools: list[RecipeTool] = []
 
     # Mealie Specific
     settings: Optional[RecipeSettings] = RecipeSettings()

mealie/schema/reports/reports.py

@@ -37,7 +37,7 @@ class ReportEntryOut(ReportEntryCreate):
 class ReportCreate(CamelModel):
     timestamp: datetime.datetime = Field(default_factory=datetime.datetime.utcnow)
     category: ReportCategory
-    group_id: int
+    group_id: UUID4
     name: str
     status: ReportSummaryStatus = ReportSummaryStatus.in_progress
 

mealie/schema/server/tasks.py

@@ -1,5 +1,6 @@
 import datetime
 import enum
+from uuid import UUID
 
 from fastapi_camelcase import CamelModel
 from pydantic import Field
@@ -18,7 +19,7 @@ class ServerTaskStatus(str, enum.Enum):
 
 
 class ServerTaskCreate(CamelModel):
-    group_id: int
+    group_id: UUID
     name: ServerTaskNames = ServerTaskNames.default
     created_at: datetime.datetime = Field(default_factory=datetime.datetime.now)
     status: ServerTaskStatus = ServerTaskStatus.running

mealie/schema/user/user.py

@@ -1,11 +1,14 @@
 from datetime import datetime
+from pathlib import Path
 from typing import Any, Optional
+from uuid import UUID
 
 from fastapi_camelcase import CamelModel
+from pydantic import UUID4
 from pydantic.types import constr
 from pydantic.utils import GetterDict
 
-from mealie.core.config import get_app_settings
+from mealie.core.config import get_app_dirs, get_app_settings
 from mealie.db.models.users import User
 from mealie.schema.group.group_preferences import ReadGroupPreferences
 from mealie.schema.recipe import RecipeSummary
@@ -87,7 +90,7 @@ class UserIn(UserBase):
 class UserOut(UserBase):
     id: int
     group: str
-    group_id: int
+    group_id: UUID4
     tokens: Optional[list[LongLiveTokenOut]]
     favorite_recipes: Optional[list[str]] = []
 
@@ -119,14 +122,14 @@ class UserFavorites(UserBase):
 
 class PrivateUser(UserOut):
     password: str
-    group_id: int
+    group_id: UUID4
 
     class Config:
         orm_mode = True
 
 
 class UpdateGroup(GroupBase):
-    id: int
+    id: UUID4
     name: str
     categories: Optional[list[CategoryBase]] = []
 
@@ -141,6 +144,26 @@ class GroupInDB(UpdateGroup):
     class Config:
         orm_mode = True
 
+    @staticmethod
+    def get_directory(id: UUID4) -> Path:
+        dir = get_app_dirs().GROUPS_DIR / str(id)
+        dir.mkdir(parents=True, exist_ok=True)
+        return dir
+
+    @staticmethod
+    def get_export_directory(id: UUID) -> Path:
+        dir = GroupInDB.get_directory(id) / "export"
+        dir.mkdir(parents=True, exist_ok=True)
+        return dir
+
+    @property
+    def directory(self) -> Path:
+        return GroupInDB.get_directory(self.id)
+
+    @property
+    def exports(self) -> Path:
+        return GroupInDB.get_export_directory(self.id)
+
 
 class LongLiveTokenInDB(CreateToken):
     id: int