mirror of
https://github.com/mealie-recipes/mealie.git
synced 2025-10-28 00:34:47 -04:00
* adds authentication method for users * fix db migration with postgres * tests for auth method * update migration ids * hide auth method on user creation form * (docs): Added documentation for the new authentication method * update migration * add to auto-form instead of having hidden fields
220 lines
5.1 KiB
Python
220 lines
5.1 KiB
Python
from datetime import datetime, timedelta
|
|
from pathlib import Path
|
|
from typing import Any
|
|
from uuid import UUID
|
|
|
|
from pydantic import UUID4, Field, validator
|
|
from pydantic.types import constr
|
|
from pydantic.utils import GetterDict
|
|
|
|
from mealie.core.config import get_app_dirs, get_app_settings
|
|
from mealie.db.models.users import User
|
|
from mealie.db.models.users.users import AuthMethod
|
|
from mealie.schema._mealie import MealieModel
|
|
from mealie.schema.group.group_preferences import ReadGroupPreferences
|
|
from mealie.schema.recipe import RecipeSummary
|
|
from mealie.schema.response.pagination import PaginationBase
|
|
|
|
from ..recipe import CategoryBase
|
|
|
|
DEFAULT_INTEGRATION_ID = "generic"
|
|
settings = get_app_settings()
|
|
|
|
|
|
class LongLiveTokenIn(MealieModel):
|
|
name: str
|
|
integration_id: str = DEFAULT_INTEGRATION_ID
|
|
|
|
|
|
class LongLiveTokenOut(MealieModel):
|
|
token: str
|
|
name: str
|
|
id: int
|
|
created_at: datetime | None
|
|
|
|
class Config:
|
|
orm_mode = True
|
|
|
|
|
|
class CreateToken(LongLiveTokenIn):
|
|
user_id: UUID4
|
|
token: str
|
|
|
|
class Config:
|
|
orm_mode = True
|
|
|
|
|
|
class DeleteTokenResponse(MealieModel):
|
|
token_delete: str
|
|
|
|
class Config:
|
|
orm_mode = True
|
|
|
|
|
|
class ChangePassword(MealieModel):
|
|
current_password: str
|
|
new_password: str = Field(..., min_length=8)
|
|
|
|
|
|
class GroupBase(MealieModel):
|
|
name: str
|
|
|
|
class Config:
|
|
orm_mode = True
|
|
|
|
|
|
class UserBase(MealieModel):
|
|
username: str | None
|
|
full_name: str | None = None
|
|
email: constr(to_lower=True, strip_whitespace=True) # type: ignore
|
|
auth_method: AuthMethod = AuthMethod.MEALIE
|
|
admin: bool = False
|
|
group: str | None
|
|
advanced: bool = False
|
|
favorite_recipes: list[str] | None = []
|
|
|
|
can_invite: bool = False
|
|
can_manage: bool = False
|
|
can_organize: bool = False
|
|
|
|
class Config:
|
|
orm_mode = True
|
|
|
|
@classmethod
|
|
def getter_dict(cls, name_orm: User):
|
|
return {
|
|
**GetterDict(name_orm),
|
|
"group": name_orm.group.name,
|
|
}
|
|
|
|
schema_extra = {
|
|
"example": {
|
|
"username": "ChangeMe",
|
|
"fullName": "Change Me",
|
|
"email": "changeme@email.com",
|
|
"group": settings.DEFAULT_GROUP,
|
|
"admin": "false",
|
|
}
|
|
}
|
|
|
|
|
|
class UserIn(UserBase):
|
|
password: str
|
|
|
|
|
|
class UserOut(UserBase):
|
|
id: UUID4
|
|
group: str
|
|
group_id: UUID4
|
|
tokens: list[LongLiveTokenOut] | None
|
|
cache_key: str
|
|
favorite_recipes: list[str] | None = []
|
|
|
|
class Config:
|
|
orm_mode = True
|
|
|
|
@classmethod
|
|
def getter_dict(cls, ormModel: User):
|
|
return {
|
|
**GetterDict(ormModel),
|
|
"group": ormModel.group.name,
|
|
"favorite_recipes": [x.slug for x in ormModel.favorite_recipes],
|
|
}
|
|
|
|
|
|
class UserPagination(PaginationBase):
|
|
items: list[UserOut]
|
|
|
|
|
|
class UserFavorites(UserBase):
|
|
favorite_recipes: list[RecipeSummary] = [] # type: ignore
|
|
|
|
class Config:
|
|
orm_mode = True
|
|
|
|
@classmethod
|
|
def getter_dict(cls, ormModel: User):
|
|
return {
|
|
**GetterDict(ormModel),
|
|
"group": ormModel.group.name,
|
|
}
|
|
|
|
|
|
class PrivateUser(UserOut):
|
|
password: str
|
|
group_id: UUID4
|
|
login_attemps: int = 0
|
|
locked_at: datetime | None = None
|
|
|
|
class Config:
|
|
orm_mode = True
|
|
|
|
@validator("login_attemps", pre=True)
|
|
def none_to_zero(cls, v):
|
|
return 0 if v is None else v
|
|
|
|
@staticmethod
|
|
def get_directory(user_id: UUID4 | str) -> Path:
|
|
user_dir = get_app_dirs().USER_DIR / str(user_id)
|
|
user_dir.mkdir(parents=True, exist_ok=True)
|
|
return user_dir
|
|
|
|
@property
|
|
def is_locked(self) -> bool:
|
|
if self.locked_at is None:
|
|
return False
|
|
|
|
lockout_expires_at = self.locked_at + timedelta(hours=get_app_settings().SECURITY_USER_LOCKOUT_TIME)
|
|
return lockout_expires_at > datetime.now()
|
|
|
|
def directory(self) -> Path:
|
|
return PrivateUser.get_directory(self.id)
|
|
|
|
|
|
class UpdateGroup(GroupBase):
|
|
id: UUID4
|
|
name: str
|
|
categories: list[CategoryBase] | None = []
|
|
|
|
webhooks: list[Any] = []
|
|
|
|
|
|
class GroupInDB(UpdateGroup):
|
|
users: list[UserOut] | None
|
|
preferences: ReadGroupPreferences | None = None
|
|
|
|
class Config:
|
|
orm_mode = True
|
|
|
|
@staticmethod
|
|
def get_directory(id: UUID4) -> Path:
|
|
group_dir = get_app_dirs().GROUPS_DIR / str(id)
|
|
group_dir.mkdir(parents=True, exist_ok=True)
|
|
return group_dir
|
|
|
|
@staticmethod
|
|
def get_export_directory(id: UUID) -> Path:
|
|
export_dir = GroupInDB.get_directory(id) / "export"
|
|
export_dir.mkdir(parents=True, exist_ok=True)
|
|
return export_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 GroupPagination(PaginationBase):
|
|
items: list[GroupInDB]
|
|
|
|
|
|
class LongLiveTokenInDB(CreateToken):
|
|
id: int
|
|
user: PrivateUser
|
|
|
|
class Config:
|
|
orm_mode = True
|