moviewyrm/bookwyrm/views/helpers.py

237 lines
7.6 KiB
Python
Raw Normal View History

2021-03-08 16:49:10 +00:00
""" helper functions used in various views """
2021-01-12 22:43:59 +00:00
import re
from requests import HTTPError
2021-02-24 19:59:21 +00:00
from django.core.exceptions import FieldError
from django.db.models import Count, Max, Q
2021-01-12 22:43:59 +00:00
from bookwyrm import activitypub, models
from bookwyrm.connectors import ConnectorException, get_data
2021-01-13 19:45:08 +00:00
from bookwyrm.status import create_generated_note
2021-01-12 22:43:59 +00:00
from bookwyrm.utils import regex
2021-01-12 18:44:17 +00:00
2021-02-23 20:41:37 +00:00
def get_user_from_username(viewer, username):
2021-03-08 16:49:10 +00:00
""" helper function to resolve a localname or a username to a user """
2021-01-12 20:05:30 +00:00
# raises DoesNotExist if user is now found
try:
2021-02-23 21:05:43 +00:00
return models.User.viewer_aware_objects(viewer).get(localname=username)
2021-01-12 20:05:30 +00:00
except models.User.DoesNotExist:
2021-02-23 20:41:37 +00:00
return models.User.viewer_aware_objects(viewer).get(username=username)
2021-01-12 20:05:30 +00:00
def is_api_request(request):
2021-03-08 16:49:10 +00:00
""" check whether a request is asking for html or data """
return "json" in request.headers.get("Accept", "") or request.path[-5:] == ".json"
2021-01-12 20:05:30 +00:00
2021-02-23 19:34:15 +00:00
def is_bookwyrm_request(request):
2021-03-08 16:49:10 +00:00
""" check if the request is coming from another bookwyrm instance """
user_agent = request.headers.get("User-Agent")
if user_agent is None or re.search(regex.bookwyrm_user_agent, user_agent) is None:
2021-01-12 21:47:00 +00:00
return False
return True
2021-01-16 20:39:51 +00:00
def object_visible_to_user(viewer, obj):
2021-03-08 16:49:10 +00:00
""" is a user authorized to view an object? """
2021-01-18 19:57:20 +00:00
if not obj:
return False
2021-01-23 19:40:41 +00:00
# viewer can't see it if the object's owner blocked them
if viewer in obj.user.blocks.all():
return False
# you can see your own posts and any public or unlisted posts
2021-03-08 16:49:10 +00:00
if viewer == obj.user or obj.privacy in ["public", "unlisted"]:
2021-01-12 21:47:00 +00:00
return True
2021-01-23 19:40:41 +00:00
# you can see the followers only posts of people you follow
2021-03-08 16:49:10 +00:00
if obj.privacy == "followers" and obj.user.followers.filter(id=viewer.id).first():
2021-01-12 21:47:00 +00:00
return True
2021-01-23 19:40:41 +00:00
# you can see dms you are tagged in
2021-01-16 20:39:51 +00:00
if isinstance(obj, models.Status):
2021-03-08 16:49:10 +00:00
if obj.privacy == "direct" and obj.mention_users.filter(id=viewer.id).first():
2021-01-16 20:39:51 +00:00
return True
2021-01-12 21:47:00 +00:00
return False
2021-01-12 18:44:17 +00:00
2021-02-24 19:35:19 +00:00
def privacy_filter(viewer, queryset, privacy_levels=None, following_only=False):
2021-03-08 16:49:10 +00:00
""" filter objects that have "user" and "privacy" fields """
privacy_levels = privacy_levels or ["public", "unlisted", "followers", "direct"]
2021-03-23 02:17:46 +00:00
# if there'd a deleted field, exclude deleted items
try:
queryset = queryset.filter(deleted=False)
except FieldError:
pass
2021-02-24 19:35:19 +00:00
2021-01-25 00:13:26 +00:00
# exclude blocks from both directions
2021-01-31 16:41:11 +00:00
if not viewer.is_anonymous:
blocked = models.User.objects.filter(id__in=viewer.blocks.all()).all()
2021-03-08 16:49:10 +00:00
queryset = queryset.exclude(Q(user__in=blocked) | Q(user__blocks=viewer))
2021-01-25 00:13:26 +00:00
2021-01-12 18:44:17 +00:00
# you can't see followers only or direct messages if you're not logged in
2021-01-31 16:41:11 +00:00
if viewer.is_anonymous:
2021-03-08 16:49:10 +00:00
privacy_levels = [p for p in privacy_levels if not p in ["followers", "direct"]]
2021-01-12 18:44:17 +00:00
# filter to only privided privacy levels
2021-01-31 16:41:11 +00:00
queryset = queryset.filter(privacy__in=privacy_levels)
2021-01-12 18:44:17 +00:00
# only include statuses the user follows
if following_only:
queryset = queryset.exclude(
2021-03-08 16:49:10 +00:00
~Q( # remove everythign except
Q(user__in=viewer.following.all())
| Q(user=viewer) # user following
| Q(mention_users=viewer) # is self # mentions user
2021-01-12 18:44:17 +00:00
),
)
# exclude followers-only statuses the user doesn't follow
2021-03-08 16:49:10 +00:00
elif "followers" in privacy_levels:
2021-01-12 18:44:17 +00:00
queryset = queryset.exclude(
2021-03-08 16:49:10 +00:00
~Q( # user isn't following and it isn't their own status
2021-01-31 16:41:11 +00:00
Q(user__in=viewer.following.all()) | Q(user=viewer)
2021-01-12 18:44:17 +00:00
),
2021-03-08 16:49:10 +00:00
privacy="followers", # and the status is followers only
2021-01-12 18:44:17 +00:00
)
# exclude direct messages not intended for the user
2021-03-08 16:49:10 +00:00
if "direct" in privacy_levels:
2021-02-24 19:59:21 +00:00
try:
queryset = queryset.exclude(
2021-03-08 16:49:10 +00:00
~Q(Q(user=viewer) | Q(mention_users=viewer)), privacy="direct"
2021-02-24 19:59:21 +00:00
)
except FieldError:
2021-03-08 16:49:10 +00:00
queryset = queryset.exclude(~Q(user=viewer), privacy="direct")
2021-02-24 19:59:21 +00:00
2021-01-31 16:41:11 +00:00
return queryset
2021-01-12 21:47:00 +00:00
def handle_remote_webfinger(query):
2021-03-08 16:49:10 +00:00
""" webfingerin' other servers """
2021-01-12 21:47:00 +00:00
user = None
# usernames could be @user@domain or user@domain
if not query:
return None
2021-03-08 16:49:10 +00:00
if query[0] == "@":
2021-01-12 21:47:00 +00:00
query = query[1:]
try:
2021-03-08 16:49:10 +00:00
domain = query.split("@")[1]
2021-01-12 21:47:00 +00:00
except IndexError:
return None
try:
2021-04-08 16:59:21 +00:00
user = models.User.objects.get(username__iexact=query)
2021-01-12 21:47:00 +00:00
except models.User.DoesNotExist:
2021-03-08 16:49:10 +00:00
url = "https://%s/.well-known/webfinger?resource=acct:%s" % (domain, query)
2021-01-12 21:47:00 +00:00
try:
data = get_data(url)
except (ConnectorException, HTTPError):
return None
2021-03-08 16:49:10 +00:00
for link in data.get("links"):
if link.get("rel") == "self":
2021-01-12 21:47:00 +00:00
try:
user = activitypub.resolve_remote_id(
2021-03-08 16:49:10 +00:00
link["href"], model=models.User
2021-01-12 21:47:00 +00:00
)
except (KeyError, activitypub.ActivitySerializerError):
2021-01-12 21:47:00 +00:00
return None
return user
def get_edition(book_id):
2021-03-08 16:49:10 +00:00
""" look up a book in the db and return an edition """
book = models.Book.objects.select_subclasses().get(id=book_id)
if isinstance(book, models.Work):
book = book.get_default_edition()
return book
2021-01-13 19:45:08 +00:00
def handle_reading_status(user, shelf, book, privacy):
2021-03-08 16:49:10 +00:00
""" post about a user reading a book """
2021-01-13 19:45:08 +00:00
# tell the world about this cool thing that happened
try:
message = {
2021-03-08 16:49:10 +00:00
"to-read": "wants to read",
"reading": "started reading",
"read": "finished reading",
2021-01-13 19:45:08 +00:00
}[shelf.identifier]
except KeyError:
# it's a non-standard shelf, don't worry about it
return
2021-03-08 16:49:10 +00:00
status = create_generated_note(user, message, mention_books=[book], privacy=privacy)
2021-01-13 19:45:08 +00:00
status.save()
2021-01-26 16:31:55 +00:00
def is_blocked(viewer, user):
2021-03-08 16:49:10 +00:00
""" is this viewer blocked by the user? """
2021-01-26 16:31:55 +00:00
if viewer.is_authenticated and viewer in user.blocks.all():
return True
return False
2021-03-21 02:14:41 +00:00
def get_discover_books():
""" list of books for the discover page """
return list(
set(
models.Edition.objects.filter(
review__published_date__isnull=False,
review__deleted=False,
review__user__local=True,
review__privacy__in=["public", "unlisted"],
)
.exclude(cover__exact="")
.annotate(Max("review__published_date"))
.order_by("-review__published_date__max")[:6]
)
)
2021-04-02 02:56:53 +00:00
def get_suggested_users(user):
""" bookwyrm users you don't already know """
return (
get_annotated_users(
user,
~Q(id=user.id),
~Q(followers=user),
~Q(follower_requests=user),
bookwyrm_user=True,
)
.order_by("-mutuals", "-last_active_date")
.all()[:5]
)
2021-04-02 03:30:50 +00:00
2021-04-02 02:56:53 +00:00
def get_annotated_users(user, *args, **kwargs):
""" Users, annotated with things they have in common """
return (
models.User.objects.filter(discoverable=True, is_active=True, *args, **kwargs)
.exclude(Q(id__in=user.blocks.all()) | Q(blocks=user))
.annotate(
mutuals=Count(
"following",
filter=Q(
~Q(id=user.id),
~Q(id__in=user.following.all()),
following__in=user.following.all(),
),
2021-03-28 17:45:46 +00:00
distinct=True,
),
shared_books=Count(
"shelfbook",
filter=Q(
~Q(id=user.id),
shelfbook__book__parent_work__in=[
s.book.parent_work for s in user.shelfbook_set.all()
],
),
2021-03-28 17:45:46 +00:00
distinct=True,
),
)
)