moviewyrm/bookwyrm/models/user.py

368 lines
12 KiB
Python
Raw Normal View History

2020-02-11 23:17:21 +00:00
''' database schema for user data '''
import re
from urllib.parse import urlparse
2020-12-30 21:14:16 +00:00
from django.apps import apps
2020-02-11 23:17:21 +00:00
from django.contrib.auth.models import AbstractUser
2021-01-19 15:30:35 +00:00
from django.core.validators import MinValueValidator
2020-02-11 23:17:21 +00:00
from django.db import models
from django.dispatch import receiver
2021-01-16 16:18:54 +00:00
from django.utils import timezone
2020-02-11 23:17:21 +00:00
from bookwyrm import activitypub
from bookwyrm.connectors import get_data
from bookwyrm.models.shelf import Shelf
from bookwyrm.models.status import Status, Review
from bookwyrm.settings import DOMAIN
from bookwyrm.signatures import create_key_pair
from bookwyrm.tasks import app
from bookwyrm.utils import regex
from .activitypub_mixin import OrderedCollectionPageMixin, ActivitypubMixin
from .base_model import BookWyrmModel
from .federated_server import FederatedServer
2021-01-16 19:34:19 +00:00
from . import fields, Review
2020-02-11 23:17:21 +00:00
class User(OrderedCollectionPageMixin, AbstractUser):
2020-02-11 23:17:21 +00:00
''' a user who wants to read books '''
2020-11-30 18:32:13 +00:00
username = fields.UsernameField()
2021-01-18 19:51:38 +00:00
email = models.EmailField(unique=True, null=True)
2020-11-30 18:32:13 +00:00
key_pair = fields.OneToOneField(
'KeyPair',
on_delete=models.CASCADE,
blank=True, null=True,
2020-11-30 18:32:54 +00:00
activitypub_field='publicKey',
2020-11-30 18:32:13 +00:00
related_name='owner'
)
inbox = fields.RemoteIdField(unique=True)
shared_inbox = fields.RemoteIdField(
2020-11-30 18:32:54 +00:00
activitypub_field='sharedInbox',
2020-12-12 21:39:55 +00:00
activitypub_wrapper='endpoints',
deduplication_field=False,
null=True)
2020-02-11 23:17:21 +00:00
federated_server = models.ForeignKey(
'FederatedServer',
on_delete=models.PROTECT,
null=True,
2020-10-30 20:11:13 +00:00
blank=True,
2020-02-11 23:17:21 +00:00
)
2020-11-30 18:32:13 +00:00
outbox = fields.RemoteIdField(unique=True)
summary = fields.HtmlField(null=True, blank=True)
2020-11-30 18:32:13 +00:00
local = models.BooleanField(default=False)
bookwyrm_user = fields.BooleanField(default=True)
2020-02-11 23:17:21 +00:00
localname = models.CharField(
max_length=255,
null=True,
unique=True,
validators=[fields.validate_localname],
2020-02-11 23:17:21 +00:00
)
# name is your display name, which you can change at will
name = fields.CharField(max_length=100, null=True, blank=True)
2020-11-30 18:32:13 +00:00
avatar = fields.ImageField(
2020-12-17 20:46:05 +00:00
upload_to='avatars/', blank=True, null=True,
activitypub_field='icon', alt_field='alt_text')
2020-11-30 18:32:13 +00:00
followers = fields.ManyToManyField(
2020-02-19 06:44:13 +00:00
'self',
2020-11-30 18:32:13 +00:00
link_only=True,
2020-02-19 06:44:13 +00:00
symmetrical=False,
through='UserFollows',
2020-11-30 18:32:13 +00:00
through_fields=('user_object', 'user_subject'),
related_name='following'
)
follow_requests = models.ManyToManyField(
'self',
symmetrical=False,
through='UserFollowRequest',
through_fields=('user_subject', 'user_object'),
related_name='follower_requests'
)
blocks = models.ManyToManyField(
'self',
symmetrical=False,
through='UserBlocks',
through_fields=('user_subject', 'user_object'),
related_name='blocked_by'
2020-02-19 06:44:13 +00:00
)
2020-02-19 07:26:42 +00:00
favorites = models.ManyToManyField(
'Status',
symmetrical=False,
through='Favorite',
through_fields=('user', 'status'),
related_name='favorite_statuses'
)
2020-11-30 18:32:13 +00:00
remote_id = fields.RemoteIdField(
null=True, unique=True, activitypub_field='id')
created_date = models.DateTimeField(auto_now_add=True)
updated_date = models.DateTimeField(auto_now=True)
last_active_date = models.DateTimeField(auto_now=True)
2020-11-30 18:32:13 +00:00
manually_approves_followers = fields.BooleanField(default=False)
2020-12-18 19:00:30 +00:00
name_field = 'username'
2020-12-17 20:46:05 +00:00
@property
def alt_text(self):
''' alt text with username '''
return 'avatar for %s' % (self.localname or self.username)
2020-11-30 22:24:31 +00:00
@property
def display_name(self):
''' show the cleanest version of the user's name possible '''
2020-12-20 20:50:35 +00:00
if self.name and self.name != '':
2020-11-30 22:24:31 +00:00
return self.name
return self.localname or self.username
activity_serializer = activitypub.Person
2020-12-30 21:14:16 +00:00
def to_outbox(self, filter_type=None, **kwargs):
''' an ordered collection of statuses '''
2020-12-30 21:14:16 +00:00
if filter_type:
filter_class = apps.get_model(
'bookwyrm.%s' % filter_type, require_ready=True)
if not issubclass(filter_class, Status):
raise TypeError(
'filter_status_class must be a subclass of models.Status')
queryset = filter_class.objects
else:
queryset = Status.objects
queryset = queryset.filter(
user=self,
2020-11-06 22:53:27 +00:00
deleted=False,
2020-12-30 20:41:19 +00:00
privacy__in=['public', 'unlisted'],
2020-12-04 16:07:47 +00:00
).select_subclasses().order_by('-published_date')
return self.to_ordered_collection(queryset, \
2021-02-02 22:59:40 +00:00
collection_only=True, remote_id=self.outbox, **kwargs)
def to_following_activity(self, **kwargs):
''' activitypub following list '''
remote_id = '%s/following' % self.remote_id
return self.to_ordered_collection(
self.following.order_by('-updated_date').all(),
remote_id=remote_id,
id_only=True,
**kwargs
)
def to_followers_activity(self, **kwargs):
''' activitypub followers list '''
remote_id = '%s/followers' % self.remote_id
return self.to_ordered_collection(
self.followers.order_by('-updated_date').all(),
remote_id=remote_id,
id_only=True,
**kwargs
)
2020-11-30 22:24:31 +00:00
def to_activity(self):
''' override default AP serializer to add context object
idk if this is the best way to go about this '''
activity_object = super().to_activity()
activity_object['@context'] = [
'https://www.w3.org/ns/activitystreams',
'https://w3id.org/security/v1',
{
'manuallyApprovesFollowers': 'as:manuallyApprovesFollowers',
'schema': 'http://schema.org#',
'PropertyValue': 'schema:PropertyValue',
'value': 'schema:value',
}
]
return activity_object
2020-05-10 04:55:00 +00:00
2020-02-17 03:17:11 +00:00
2020-11-01 16:54:10 +00:00
def save(self, *args, **kwargs):
''' populate fields for new local users '''
# this user already exists, no need to populate fields
if not self.local and not re.match(regex.full_username, self.username):
2020-11-01 16:54:10 +00:00
# generate a username that uses the domain (webfinger format)
actor_parts = urlparse(self.remote_id)
self.username = '%s@%s' % (self.username, actor_parts.netloc)
return super().save(*args, **kwargs)
2020-11-01 16:54:10 +00:00
if self.id or not self.local:
return super().save(*args, **kwargs)
2020-11-01 16:54:10 +00:00
# populate fields for local users
self.remote_id = 'https://%s/user/%s' % (DOMAIN, self.localname)
2020-11-01 16:54:10 +00:00
self.inbox = '%s/inbox' % self.remote_id
self.shared_inbox = 'https://%s/inbox' % DOMAIN
self.outbox = '%s/outbox' % self.remote_id
2020-11-30 18:32:13 +00:00
return super().save(*args, **kwargs)
2020-11-01 16:54:10 +00:00
2020-12-31 01:36:35 +00:00
@property
def local_path(self):
''' this model doesn't inherit bookwyrm model, so here we are '''
return '/user/%s' % (self.localname or self.username)
2020-11-30 18:32:13 +00:00
class KeyPair(ActivitypubMixin, BookWyrmModel):
''' public and private keys for a user '''
private_key = models.TextField(blank=True, null=True)
public_key = fields.TextField(
blank=True, null=True, activitypub_field='publicKeyPem')
activity_serializer = activitypub.PublicKey
2021-01-11 19:16:10 +00:00
serialize_reverse_fields = [('owner', 'owner', 'id')]
2020-11-30 18:32:13 +00:00
def get_remote_id(self):
# self.owner is set by the OneToOneField on User
return '%s/#main-key' % self.owner.remote_id
def save(self, *args, **kwargs):
''' create a key pair '''
# no broadcasting happening here
if 'broadcast' in kwargs:
del kwargs['broadcast']
2020-12-03 20:35:57 +00:00
if not self.public_key:
self.private_key, self.public_key = create_key_pair()
return super().save(*args, **kwargs)
2020-02-11 23:17:21 +00:00
2020-11-30 18:32:54 +00:00
def to_activity(self):
''' override default AP serializer to add context object
idk if this is the best way to go about this '''
activity_object = super().to_activity()
del activity_object['@context']
del activity_object['type']
return activity_object
2020-02-11 23:17:21 +00:00
2021-01-16 16:18:54 +00:00
class AnnualGoal(BookWyrmModel):
''' set a goal for how many books you read in a year '''
2021-01-16 19:34:19 +00:00
user = models.ForeignKey('User', on_delete=models.PROTECT)
2021-01-19 15:30:35 +00:00
goal = models.IntegerField(
validators=[MinValueValidator(1)]
)
2021-01-16 16:18:54 +00:00
year = models.IntegerField(default=timezone.now().year)
2021-01-16 19:34:19 +00:00
privacy = models.CharField(
max_length=255,
default='public',
choices=fields.PrivacyLevels.choices
)
2021-01-16 16:18:54 +00:00
class Meta:
''' unqiueness constraint '''
unique_together = ('user', 'year')
def get_remote_id(self):
''' put the year in the path '''
return '%s/goal/%d' % (self.user.remote_id, self.year)
@property
def books(self):
''' the books you've read this year '''
return self.user.readthrough_set.filter(
finish_date__year__gte=self.year
).order_by('-finish_date').all()
2021-01-16 16:18:54 +00:00
2021-01-16 19:34:19 +00:00
@property
def ratings(self):
''' ratings for books read this year '''
book_ids = [r.book.id for r in self.books]
reviews = Review.objects.filter(
user=self.user,
book__in=book_ids,
)
return {r.book.id: r.rating for r in reviews}
@property
def progress_percent(self):
2021-02-02 22:59:40 +00:00
''' how close to your goal, in percent form '''
2021-01-16 19:34:19 +00:00
return int(float(self.book_count / self.goal) * 100)
2021-01-16 16:18:54 +00:00
@property
def book_count(self):
''' how many books you've read this year '''
return self.user.readthrough_set.filter(
finish_date__year__gte=self.year).count()
2020-02-11 23:17:21 +00:00
@receiver(models.signals.post_save, sender=User)
2020-12-12 23:00:20 +00:00
#pylint: disable=unused-argument
2020-02-11 23:17:21 +00:00
def execute_after_save(sender, instance, created, *args, **kwargs):
''' create shelves for new users '''
if not created:
return
if not instance.local:
set_remote_server.delay(instance.id)
2020-12-03 20:35:57 +00:00
return
2020-02-11 23:17:21 +00:00
instance.key_pair = KeyPair.objects.create(
remote_id='%s/#main-key' % instance.remote_id)
instance.save(broadcast=False)
2020-02-11 23:17:21 +00:00
shelves = [{
'name': 'To Read',
2020-02-15 22:38:46 +00:00
'identifier': 'to-read',
2020-02-11 23:17:21 +00:00
}, {
'name': 'Currently Reading',
2020-02-15 22:38:46 +00:00
'identifier': 'reading',
2020-02-11 23:17:21 +00:00
}, {
'name': 'Read',
2020-02-15 22:38:46 +00:00
'identifier': 'read',
2020-02-11 23:17:21 +00:00
}]
for shelf in shelves:
Shelf(
name=shelf['name'],
2020-02-15 22:38:46 +00:00
identifier=shelf['identifier'],
2020-02-11 23:17:21 +00:00
user=instance,
editable=False
).save(broadcast=False)
2020-11-30 18:32:13 +00:00
@app.task
def set_remote_server(user_id):
''' figure out the user's remote server in the background '''
user = User.objects.get(id=user_id)
actor_parts = urlparse(user.remote_id)
user.federated_server = \
get_or_create_remote_server(actor_parts.netloc)
user.save()
if user.bookwyrm_user:
get_remote_reviews.delay(user.outbox)
def get_or_create_remote_server(domain):
''' get info on a remote server '''
try:
return FederatedServer.objects.get(
server_name=domain
)
except FederatedServer.DoesNotExist:
pass
data = get_data('https://%s/.well-known/nodeinfo' % domain)
try:
nodeinfo_url = data.get('links')[0].get('href')
except (TypeError, KeyError):
return None
data = get_data(nodeinfo_url)
server = FederatedServer.objects.create(
server_name=domain,
application_type=data['software']['name'],
application_version=data['software']['version'],
)
return server
@app.task
def get_remote_reviews(outbox):
''' ingest reviews by a new remote bookwyrm user '''
outbox_page = outbox + '?page=true&type=Review'
data = get_data(outbox_page)
# TODO: pagination?
for activity in data['orderedItems']:
if not activity['type'] == 'Review':
continue
2021-02-16 05:41:08 +00:00
activitypub.Review(**activity).to_model()