moviewyrm/bookwyrm/models/tag.py

76 lines
2.3 KiB
Python
Raw Normal View History

2020-09-17 20:09:11 +00:00
''' models for storing different kinds of Activities '''
import urllib.parse
from django.db import models
from bookwyrm import activitypub
from bookwyrm.settings import DOMAIN
2020-12-01 03:01:43 +00:00
from .base_model import OrderedCollectionMixin, BookWyrmModel
from . import fields
2020-09-17 20:09:11 +00:00
2020-09-21 15:16:34 +00:00
class Tag(OrderedCollectionMixin, BookWyrmModel):
2020-09-17 20:09:11 +00:00
''' freeform tags for books '''
2020-12-01 03:01:43 +00:00
name = fields.CharField(max_length=100, unique=True)
2020-09-17 20:09:11 +00:00
identifier = models.CharField(max_length=100)
@classmethod
def book_queryset(cls, identifier):
''' county of books associated with this tag '''
return cls.objects.filter(
identifier=identifier
).order_by('-updated_date')
2020-09-17 20:09:11 +00:00
@property
def collection_queryset(self):
''' books associated with this tag '''
return self.book_queryset(self.identifier)
def get_remote_id(self):
''' tag should use identifier not id in remote_id '''
base_path = 'https://%s' % DOMAIN
return '%s/tag/%s' % (base_path, self.identifier)
def save(self, *args, **kwargs):
''' create a url-safe lookup key for the tag '''
if not self.id:
# add identifiers to new tags
self.identifier = urllib.parse.quote_plus(self.name)
super().save(*args, **kwargs)
class UserTag(BookWyrmModel):
''' an instance of a tag on a book by a user '''
2020-12-01 03:01:43 +00:00
user = fields.ForeignKey(
'User', on_delete=models.PROTECT, activitypub_field='actor')
book = fields.ForeignKey(
'Edition', on_delete=models.PROTECT, activitypub_field='object')
tag = fields.ForeignKey(
'Tag', on_delete=models.PROTECT, activitypub_field='target')
activity_serializer = activitypub.AddBook
2020-09-17 20:09:11 +00:00
def to_add_activity(self, user):
''' AP for shelving a book'''
return activitypub.Add(
id='%s#add' % self.remote_id,
actor=user.remote_id,
2020-11-08 00:11:12 +00:00
object=self.book.to_activity(),
2020-11-06 22:25:48 +00:00
target=self.remote_id,
2020-09-17 20:09:11 +00:00
).serialize()
def to_remove_activity(self, user):
''' AP for un-shelving a book'''
return activitypub.Remove(
id='%s#remove' % self.remote_id,
actor=user.remote_id,
object=self.book.to_activity(),
2020-12-31 16:42:09 +00:00
target=self.remote_id,
2020-09-17 20:09:11 +00:00
).serialize()
class Meta:
''' unqiueness constraint '''
unique_together = ('user', 'book', 'tag')