byceps/services/user/dbmodels/avatar.py
"""
byceps.services.user.dbmodels.avatar
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:Copyright: 2014-2024 Jochen Kupperschmidt
:License: Revised BSD (see `LICENSE` file for details)
"""
from datetime import datetime
from pathlib import Path
from typing import TYPE_CHECKING
from flask import current_app
from sqlalchemy.orm import Mapped, mapped_column
if TYPE_CHECKING:
hybrid_property = property
else:
from sqlalchemy.ext.hybrid import hybrid_property
from byceps.database import db
from byceps.services.user.models.user import UserAvatarID
from byceps.util.image.models import ImageType
from byceps.util.instances import ReprBuilder
from byceps.util.uuid import generate_uuid7
_ABSOLUTE_URL_PATH_PREFIX = '/data/global/users/avatars/'
FALLBACK_AVATAR_URL_PATH = '/static/avatar_fallback.svg'
class DbUserAvatar(db.Model):
"""An avatar image uploaded by a user."""
__tablename__ = 'user_avatars'
id: Mapped[UserAvatarID] = mapped_column(
db.Uuid, default=generate_uuid7, primary_key=True
)
created_at: Mapped[datetime] = mapped_column(default=datetime.utcnow)
_image_type: Mapped[str] = mapped_column('image_type', db.UnicodeText)
def __init__(self, image_type: ImageType) -> None:
self.image_type = image_type
@hybrid_property
def image_type(self) -> ImageType:
return ImageType[self._image_type]
@image_type.setter
def image_type(self, image_type: ImageType) -> None:
self._image_type = image_type.name
@property
def filename(self) -> Path:
name_without_suffix = str(self.id)
suffix = '.' + self.image_type.name
return Path(name_without_suffix).with_suffix(suffix)
@property
def path(self) -> Path:
path = current_app.config['PATH_DATA'] / 'global' / 'users' / 'avatars'
return path / self.filename
@property
def url(self) -> str:
return get_absolute_url_path(str(self.filename))
def __repr__(self) -> str:
return (
ReprBuilder(self)
.add_with_lookup('id')
.add('image_type', self.image_type.name)
.build()
)
def get_absolute_url_path(filename: str) -> str:
return _ABSOLUTE_URL_PATH_PREFIX + str(filename)