moviewyrm/bookwyrm/models/tag.py

64 lines
1.9 KiB
Python
Raw Normal View History

2021-03-08 16:49:10 +00:00
""" models for storing different kinds of Activities """
2020-09-17 20:09:11 +00:00
import urllib.parse
2021-02-24 01:18:25 +00:00
from django.apps import apps
2020-09-17 20:09:11 +00:00
from django.db import models
from bookwyrm import activitypub
from bookwyrm.settings import DOMAIN
from .activitypub_mixin import CollectionItemMixin, OrderedCollectionMixin
from .base_model import BookWyrmModel
2020-12-01 03:01:43 +00:00
from . import fields
2020-09-17 20:09:11 +00:00
2020-09-21 15:16:34 +00:00
class Tag(OrderedCollectionMixin, BookWyrmModel):
2021-03-08 16:49:10 +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)
@property
2021-02-24 01:18:25 +00:00
def books(self):
2021-03-08 16:49:10 +00:00
""" count of books associated with this tag """
edition_model = apps.get_model("bookwyrm.Edition", require_ready=True)
return (
edition_model.objects.filter(usertag__tag__identifier=self.identifier)
.order_by("-created_date")
.distinct()
)
2021-02-24 01:18:25 +00:00
collection_queryset = books
2020-09-17 20:09:11 +00:00
def get_remote_id(self):
2021-03-08 16:49:10 +00:00
""" 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):
2021-03-08 16:49:10 +00:00
""" 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(CollectionItemMixin, BookWyrmModel):
2021-03-08 16:49:10 +00:00
""" an instance of a tag on a book by a user """
2020-12-01 03:01:43 +00:00
user = fields.ForeignKey(
2021-03-08 16:49:10 +00:00
"User", on_delete=models.PROTECT, activitypub_field="actor"
)
2020-12-01 03:01:43 +00:00
book = fields.ForeignKey(
2021-03-08 16:49:10 +00:00
"Edition", on_delete=models.PROTECT, activitypub_field="object"
)
tag = fields.ForeignKey("Tag", on_delete=models.PROTECT, activitypub_field="target")
2021-02-19 19:16:01 +00:00
activity_serializer = activitypub.Add
2021-03-08 16:49:10 +00:00
object_field = "book"
collection_field = "tag"
2020-09-17 20:09:11 +00:00
class Meta:
2021-03-08 16:49:10 +00:00
""" unqiueness constraint """
unique_together = ("user", "book", "tag")