forked from mirrors/bookwyrm
148 lines
5 KiB
Python
148 lines
5 KiB
Python
''' models for storing different kinds of Activities '''
|
|
from django.utils import timezone
|
|
from django.core.validators import MaxValueValidator, MinValueValidator
|
|
from django.db import models
|
|
from model_utils.managers import InheritanceManager
|
|
import urllib.parse
|
|
|
|
from fedireads.utils.models import FedireadsModel
|
|
|
|
|
|
class Status(FedireadsModel):
|
|
''' any post, like a reply to a review, etc '''
|
|
remote_id = models.CharField(max_length=255, unique=True, null=True)
|
|
user = models.ForeignKey('User', on_delete=models.PROTECT)
|
|
status_type = models.CharField(max_length=255, default='Note')
|
|
content = models.TextField(blank=True, null=True)
|
|
mention_users = models.ManyToManyField('User', related_name='mention_user')
|
|
mention_books = models.ManyToManyField('Edition', related_name='mention_book')
|
|
activity_type = models.CharField(max_length=255, default='Note')
|
|
local = models.BooleanField(default=True)
|
|
privacy = models.CharField(max_length=255, default='public')
|
|
sensitive = models.BooleanField(default=False)
|
|
# the created date can't be this, because of receiving federated posts
|
|
published_date = models.DateTimeField(default=timezone.now)
|
|
favorites = models.ManyToManyField(
|
|
'User',
|
|
symmetrical=False,
|
|
through='Favorite',
|
|
through_fields=('status', 'user'),
|
|
related_name='user_favorites'
|
|
)
|
|
reply_parent = models.ForeignKey(
|
|
'self',
|
|
null=True,
|
|
on_delete=models.PROTECT
|
|
)
|
|
objects = InheritanceManager()
|
|
|
|
@property
|
|
def absolute_id(self):
|
|
''' constructs the absolute reference to any db object '''
|
|
if self.remote_id:
|
|
return self.remote_id
|
|
base_path = self.user.absolute_id
|
|
model_name = type(self).__name__.lower()
|
|
return '%s/%s/%d' % (base_path, model_name, self.id)
|
|
|
|
|
|
class Comment(Status):
|
|
''' like a review but without a rating and transient '''
|
|
book = models.ForeignKey('Edition', on_delete=models.PROTECT)
|
|
|
|
def save(self, *args, **kwargs):
|
|
self.status_type = 'Comment'
|
|
self.activity_type = 'Note'
|
|
super().save(*args, **kwargs)
|
|
|
|
|
|
class Review(Status):
|
|
''' a book review '''
|
|
name = models.CharField(max_length=255, null=True)
|
|
book = models.ForeignKey('Edition', on_delete=models.PROTECT)
|
|
rating = models.IntegerField(
|
|
default=None,
|
|
null=True,
|
|
blank=True,
|
|
validators=[MinValueValidator(1), MaxValueValidator(5)]
|
|
)
|
|
|
|
def save(self, *args, **kwargs):
|
|
self.status_type = 'Review'
|
|
self.activity_type = 'Article'
|
|
super().save(*args, **kwargs)
|
|
|
|
|
|
class Favorite(FedireadsModel):
|
|
''' fav'ing a post '''
|
|
user = models.ForeignKey('User', on_delete=models.PROTECT)
|
|
status = models.ForeignKey('Status', on_delete=models.PROTECT)
|
|
remote_id = models.CharField(max_length=255, unique=True, null=True)
|
|
|
|
@property
|
|
def absolute_id(self):
|
|
''' constructs the absolute reference to any db object '''
|
|
if self.remote_id:
|
|
return self.remote_id
|
|
return super().absolute_id
|
|
|
|
class Meta:
|
|
unique_together = ('user', 'status')
|
|
|
|
|
|
class Boost(Status):
|
|
''' boost'ing a post '''
|
|
boosted_status = models.ForeignKey(
|
|
'Status',
|
|
on_delete=models.PROTECT,
|
|
related_name="boosters")
|
|
|
|
def save(self, *args, **kwargs):
|
|
self.status_type = 'Boost'
|
|
self.activity_type = 'Announce'
|
|
super().save(*args, **kwargs)
|
|
|
|
# This constraint can't work as it would cross tables.
|
|
# class Meta:
|
|
# unique_together = ('user', 'boosted_status')
|
|
|
|
class Tag(FedireadsModel):
|
|
''' freeform tags for books '''
|
|
user = models.ForeignKey('User', on_delete=models.PROTECT)
|
|
book = models.ForeignKey('Edition', on_delete=models.PROTECT)
|
|
name = models.CharField(max_length=100)
|
|
identifier = models.CharField(max_length=100)
|
|
|
|
def save(self, *args, **kwargs):
|
|
if not self.id:
|
|
# add identifiers to new tags
|
|
self.identifier = urllib.parse.quote_plus(self.name)
|
|
super().save(*args, **kwargs)
|
|
|
|
class Meta:
|
|
unique_together = ('user', 'book', 'name')
|
|
|
|
|
|
NotificationType = models.TextChoices(
|
|
'NotificationType', 'FAVORITE REPLY TAG FOLLOW FOLLOW_REQUEST BOOST')
|
|
|
|
class Notification(FedireadsModel):
|
|
''' you've been tagged, liked, followed, etc '''
|
|
user = models.ForeignKey('User', on_delete=models.PROTECT)
|
|
related_book = models.ForeignKey(
|
|
'Edition', on_delete=models.PROTECT, null=True)
|
|
related_user = models.ForeignKey(
|
|
'User',
|
|
on_delete=models.PROTECT, null=True, related_name='related_user')
|
|
related_status = models.ForeignKey(
|
|
'Status', on_delete=models.PROTECT, null=True)
|
|
read = models.BooleanField(default=False)
|
|
notification_type = models.CharField(
|
|
max_length=255, choices=NotificationType.choices)
|
|
class Meta:
|
|
constraints = [
|
|
models.CheckConstraint(
|
|
check=models.Q(notification_type__in=NotificationType.values),
|
|
name="notification_type_valid",
|
|
)
|
|
]
|