bookwyrm/fedireads/views.py

481 lines
14 KiB
Python
Raw Normal View History

2020-02-22 22:02:03 +00:00
''' views for pages you can go to in the application '''
2020-01-28 19:45:27 +00:00
from django.contrib.auth.decorators import login_required
2020-02-07 23:29:11 +00:00
from django.db.models import Avg, Q
2020-03-14 00:57:36 +00:00
from django.http import HttpResponseBadRequest, HttpResponseNotFound, \
JsonResponse
2020-01-25 23:25:19 +00:00
from django.template.response import TemplateResponse
2020-03-14 00:57:36 +00:00
from django.views.decorators.csrf import csrf_exempt
2020-01-25 06:32:41 +00:00
2020-03-14 00:57:36 +00:00
from fedireads import activitypub
from fedireads import forms, models, books_manager
2020-01-28 19:45:27 +00:00
2020-02-22 22:02:03 +00:00
def get_user_from_username(username):
''' helper function to resolve a localname or a username to a user '''
try:
user = models.User.objects.get(localname=username)
except models.User.DoesNotExist:
user = models.User.objects.get(username=username)
return user
2020-03-14 00:57:36 +00:00
def is_api_request(request):
''' check whether a request is asking for html or data '''
# TODO: this should probably be the full content type? maybe?
return 'json' in request.headers.get('Accept') or \
request.path[-5:] == '.json'
2020-01-25 06:32:41 +00:00
@login_required
2020-01-25 23:25:19 +00:00
def home(request):
''' this is the same as the feed on the home tab '''
return home_tab(request, 'home')
@login_required
def home_tab(request, tab):
2020-01-28 19:45:27 +00:00
''' user's homepage with activity feed '''
2020-02-21 23:39:25 +00:00
shelves = []
2020-03-16 23:10:59 +00:00
shelves = get_user_shelf_preview(
request.user,
[('reading', 3), ('read', 1), ('to-read', 3)]
)
size = sum(len(s['books']) for s in shelves)
2020-03-15 21:15:36 +00:00
# books new to the instance, for discovery
2020-03-16 23:10:59 +00:00
if size < 6:
2020-03-15 21:15:36 +00:00
shelves.append({
'name': 'Recently added',
'identifier': None,
'books': models.Book.objects.order_by(
'-created_date'
2020-03-16 23:10:59 +00:00
)[:6 - size],
'count': 6 - size,
2020-03-15 21:15:36 +00:00
})
2020-02-07 23:29:11 +00:00
# allows us to check if a user has shelved a book
2020-01-29 01:23:38 +00:00
user_books = models.Book.objects.filter(shelves__user=request.user).all()
2020-02-07 23:29:11 +00:00
# status updates for your follow network
2020-01-28 02:47:54 +00:00
following = models.User.objects.filter(
2020-01-28 19:45:27 +00:00
Q(followers=request.user) | Q(id=request.user.id)
)
activities = models.Status.objects.order_by(
2020-01-28 23:23:49 +00:00
'-created_date'
).select_subclasses()
if tab == 'home':
# people you follow and direct mentions
activities = activities.filter(
Q(user__in=following, privacy='public') | \
Q(mention_users=request.user)
)
elif tab == 'local':
# everyone on this instance
activities = activities.filter(user__local=True, privacy='public')
else:
# all activities from everyone you federate with
activities = activities.filter(privacy='public')
activities = activities[:10]
2020-01-28 02:47:54 +00:00
2020-01-25 23:25:19 +00:00
data = {
'user': request.user,
2020-02-21 23:39:25 +00:00
'shelves': shelves,
2020-01-29 01:23:38 +00:00
'user_books': user_books,
2020-01-28 02:47:54 +00:00
'activities': activities,
2020-03-15 21:15:36 +00:00
'feed_tabs': [
{'id': 'home', 'display': 'Home'},
{'id': 'local', 'display': 'Local'},
{'id': 'federated', 'display': 'Federated'}
],
'active_tab': tab,
2020-03-15 21:15:36 +00:00
'review_form': forms.ReviewForm(),
2020-03-21 23:50:49 +00:00
'comment_form': forms.CommentForm(),
2020-01-25 23:25:19 +00:00
}
return TemplateResponse(request, 'feed.html', data)
2020-01-25 06:32:41 +00:00
2020-01-28 02:47:54 +00:00
2020-03-17 00:45:34 +00:00
def books_page(request):
''' discover books '''
recent_books = models.Book.objects
if request.user.is_authenticated:
recent_books = recent_books.filter(
~Q(shelfbook__shelf__user=request.user)
)
recent_books = recent_books.order_by('-created_date')[:50]
2020-03-17 00:45:34 +00:00
data = {
'books': recent_books,
}
return TemplateResponse(request, 'books.html', data)
2020-03-23 16:40:09 +00:00
@login_required
def import_page(request):
''' import history from goodreads '''
return TemplateResponse(request, 'import.html', {
'import_form': forms.ImportForm(),
})
2020-03-17 00:45:34 +00:00
2020-03-15 21:15:36 +00:00
def login_page(request):
2020-01-25 23:25:19 +00:00
''' authentication '''
# send user to the login page
2020-03-15 21:15:36 +00:00
data = {
'login_form': forms.LoginForm(),
'register_form': forms.RegisterForm(),
}
return TemplateResponse(request, 'login.html', data)
2020-01-29 03:05:59 +00:00
2020-03-10 20:31:57 +00:00
@login_required
2020-03-07 22:50:29 +00:00
def notifications_page(request):
''' list notitications '''
notifications = request.user.notification_set.all() \
.order_by('-created_date')
2020-03-10 20:31:57 +00:00
unread = [n.id for n in notifications.filter(read=False)]
2020-03-07 22:50:29 +00:00
data = {
'notifications': notifications,
2020-03-10 20:31:57 +00:00
'unread': unread,
2020-03-07 22:50:29 +00:00
}
notifications.update(read=True)
2020-03-07 22:50:29 +00:00
return TemplateResponse(request, 'notifications.html', data)
2020-03-14 00:57:36 +00:00
@csrf_exempt
2020-03-17 00:09:45 +00:00
def user_page(request, username, subpage=None):
2020-01-26 20:14:27 +00:00
''' profile page for a user '''
2020-01-28 06:49:56 +00:00
try:
2020-02-22 00:03:05 +00:00
user = get_user_from_username(username)
2020-01-28 06:49:56 +00:00
except models.User.DoesNotExist:
2020-02-22 00:03:05 +00:00
return HttpResponseNotFound()
2020-01-28 06:49:56 +00:00
2020-03-14 00:57:36 +00:00
if is_api_request(request):
# we have a json request
return JsonResponse(activitypub.get_actor(user))
# otherwise we're at a UI view
2020-02-07 23:29:11 +00:00
# TODO: change display with privacy and authentication considerations
2020-03-16 23:10:59 +00:00
2020-01-26 20:14:27 +00:00
data = {
'user': user,
'is_self': request.user.id == user.id,
}
2020-03-17 00:09:45 +00:00
if subpage == 'followers':
data['followers'] = user.followers.all()
return TemplateResponse(request, 'followers.html', data)
elif subpage == 'following':
data['following'] = user.following.all()
return TemplateResponse(request, 'following.html', data)
2020-03-17 00:29:37 +00:00
elif subpage == 'shelves':
data['shelves'] = user.shelf_set.all()
return TemplateResponse(request, 'user_shelves.html', data)
2020-03-17 00:09:45 +00:00
else:
2020-03-17 00:29:37 +00:00
shelves = get_user_shelf_preview(user)
data['shelves'] = shelves
2020-03-17 00:09:45 +00:00
activities = models.Status.objects.filter(
user=user,
).order_by(
'-created_date',
).select_subclasses().all()[:10]
data['activities'] = activities
return TemplateResponse(request, 'user.html', data)
2020-01-26 20:14:27 +00:00
2020-03-14 00:57:36 +00:00
@csrf_exempt
def followers_page(request, username):
''' list of followers '''
if request.method != 'GET':
return HttpResponseBadRequest()
try:
user = get_user_from_username(username)
except models.User.DoesNotExist:
return HttpResponseNotFound()
if is_api_request(request):
user = models.User.objects.get(localname=username)
followers = user.followers
page = request.GET.get('page')
return JsonResponse(activitypub.get_followers(user, page, followers))
2020-03-17 00:09:45 +00:00
return user_page(request, username, subpage='followers')
2020-03-14 00:57:36 +00:00
@csrf_exempt
def following_page(request, username):
''' list of followers '''
if request.method != 'GET':
return HttpResponseBadRequest()
try:
user = get_user_from_username(username)
except models.User.DoesNotExist:
return HttpResponseNotFound()
if is_api_request(request):
user = models.User.objects.get(localname=username)
following = user.following
page = request.GET.get('page')
return JsonResponse(activitypub.get_following(user, page, following))
2020-03-17 00:09:45 +00:00
return user_page(request, username, subpage='following')
2020-03-14 00:57:36 +00:00
2020-03-17 00:29:37 +00:00
@csrf_exempt
def user_shelves_page(request, username):
''' list of followers '''
if request.method != 'GET':
return HttpResponseBadRequest()
return user_page(request, username, subpage='shelves')
2020-03-14 00:57:36 +00:00
@csrf_exempt
2020-03-07 23:28:11 +00:00
def status_page(request, username, status_id):
''' display a particular status (and replies, etc) '''
2020-03-14 00:57:36 +00:00
if request.method != 'GET':
return HttpResponseBadRequest()
2020-03-07 23:28:11 +00:00
try:
user = get_user_from_username(username)
2020-03-07 23:28:11 +00:00
status = models.Status.objects.select_subclasses().get(id=status_id)
except ValueError:
return HttpResponseNotFound()
if user != status.user:
return HttpResponseNotFound()
2020-03-14 00:57:36 +00:00
if is_api_request(request):
return JsonResponse(activitypub.get_status(status))
2020-03-07 23:28:11 +00:00
data = {
'status': status,
}
return TemplateResponse(request, 'status.html', data)
2020-03-14 00:57:36 +00:00
@csrf_exempt
def replies_page(request, username, status_id):
''' ordered collection of replies to a status '''
if request.method != 'GET':
return HttpResponseBadRequest()
if not is_api_request(request):
return status_page(request, username, status_id)
status = models.Status.objects.get(id=status_id)
if status.user.localname != username:
return HttpResponseNotFound()
replies = models.Status.objects.filter(
reply_parent=status,
).select_subclasses()
if request.GET.get('only_other_accounts'):
replies = replies.filter(
~Q(user=status.user)
)
else:
replies = replies.filter(user=status.user)
if request.GET.get('page'):
min_id = request.GET.get('min_id')
if min_id:
replies = replies.filter(id__gt=min_id)
max_id = request.GET.get('max_id')
if max_id:
replies = replies.filter(id__lte=max_id)
activity = activitypub.get_replies_page(status, replies)
return JsonResponse(activity)
return JsonResponse(activitypub.get_replies(status, replies))
2020-01-28 06:49:56 +00:00
@login_required
def edit_profile_page(request):
2020-01-28 06:49:56 +00:00
''' profile page for a user '''
user = request.user
2020-01-28 06:49:56 +00:00
2020-01-29 20:24:50 +00:00
form = forms.EditUserForm(instance=request.user)
2020-01-28 06:49:56 +00:00
data = {
2020-01-29 07:23:05 +00:00
'form': form,
2020-01-28 06:49:56 +00:00
'user': user,
}
return TemplateResponse(request, 'edit_user.html', data)
def book_page(request, book_identifier, tab='friends'):
2020-01-28 02:47:54 +00:00
''' info about a book '''
2020-03-07 20:22:28 +00:00
book = books_manager.get_or_create_book(book_identifier)
2020-03-28 02:52:05 +00:00
if is_api_request(request):
return JsonResponse(activitypub.get_book(book))
2020-03-07 06:56:44 +00:00
if isinstance(book, models.Work):
book_reviews = models.Review.objects.filter(
Q(book=book) | Q(book__parent_work=book),
)
else:
book_reviews = models.Review.objects.filter(book=book)
if request.user.is_authenticated:
user_reviews = book_reviews.filter(
user=request.user,
).all()
if tab == 'friends':
reviews = book_reviews.filter(
Q(user__followers=request.user, privacy='public') | \
Q(user=request.user) | \
Q(mention_users=request.user),
)
elif tab == 'local':
reviews = book_reviews.filter(
Q(privacy='public') | \
Q(mention_users=request.user),
user__local=True,
)
else:
reviews = book_reviews.filter(
Q(privacy='public') | \
Q(mention_users=request.user),
)
try:
shelf = models.Shelf.objects.get(user=request.user, book=book)
except models.Shelf.DoesNotExist:
shelf = None
user_tags = models.Tag.objects.filter(
book=book, user=request.user
).all()
user_tag_names = user_tags.values_list('identifier', flat=True)
user_rating = user_reviews.aggregate(Avg('rating')),
else:
tab = 'public'
reviews = book_reviews.filter(privacy='public')
shelf = None
user_reviews = []
user_rating = None
user_tags = []
user_tag_names = []
2020-01-28 02:47:54 +00:00
rating = reviews.aggregate(Avg('rating'))
2020-02-21 06:19:19 +00:00
tags = models.Tag.objects.filter(
book=book
).values(
2020-02-21 17:10:27 +00:00
'book', 'name', 'identifier'
2020-02-21 06:19:19 +00:00
).distinct().all()
2020-01-29 07:23:05 +00:00
review_form = forms.ReviewForm()
2020-02-21 06:19:19 +00:00
tag_form = forms.TagForm()
2020-01-28 02:47:54 +00:00
data = {
'book': book,
'shelf': shelf,
'user_reviews': user_reviews,
'user_rating': user_rating,
'reviews': reviews.distinct(),
2020-01-28 02:47:54 +00:00
'rating': rating['rating__avg'],
2020-02-21 06:19:19 +00:00
'tags': tags,
'user_tags': user_tags,
'user_tag_names': user_tag_names,
2020-01-29 07:23:05 +00:00
'review_form': review_form,
2020-02-21 06:19:19 +00:00
'tag_form': tag_form,
2020-03-17 00:19:38 +00:00
'feed_tabs': [
{'id': 'friends', 'display': 'Friends'},
{'id': 'local', 'display': 'Local'},
{'id': 'federated', 'display': 'Federated'}
],
'active_tab': tab,
'path': '/book/%s' % book_identifier,
2020-01-28 02:47:54 +00:00
}
return TemplateResponse(request, 'book.html', data)
2020-02-11 06:32:03 +00:00
def author_page(request, author_identifier):
''' landing page for an author '''
try:
2020-03-12 00:44:54 +00:00
author = models.Author.objects.get(openlibrary_key=author_identifier)
2020-02-11 06:32:03 +00:00
except ValueError:
return HttpResponseNotFound()
books = models.Book.objects.filter(authors=author)
data = {
'author': author,
'books': books,
}
return TemplateResponse(request, 'author.html', data)
2020-02-21 17:10:27 +00:00
def tag_page(request, tag_id):
''' books related to a tag '''
2020-02-21 17:15:20 +00:00
tag_obj = models.Tag.objects.filter(identifier=tag_id).first()
2020-02-21 17:32:24 +00:00
books = models.Book.objects.filter(tag__identifier=tag_id).distinct()
2020-02-21 17:10:27 +00:00
data = {
'books': books,
2020-02-21 17:15:20 +00:00
'tag': tag_obj,
2020-02-21 17:10:27 +00:00
}
return TemplateResponse(request, 'tag.html', data)
2020-02-22 00:03:05 +00:00
def shelf_page(request, username, shelf_identifier):
''' display a shelf '''
# TODO: json view
try:
user = get_user_from_username(username)
except models.User.DoesNotExist:
return HttpResponseNotFound()
shelf = models.Shelf.objects.get(user=user, identifier=shelf_identifier)
2020-03-28 02:52:05 +00:00
if is_api_request(request):
return activitypub.get_shelf(shelf)
2020-02-22 00:40:49 +00:00
data = {
'shelf': shelf,
'user': user,
}
return TemplateResponse(request, 'shelf.html', data)
2020-02-22 00:03:05 +00:00
2020-03-16 23:10:59 +00:00
def get_user_shelf_preview(user, shelf_proportions=None):
''' data for the covers shelf (user page and feed page) '''
shelves = []
shelf_max = 6
if not shelf_proportions:
shelf_proportions = [('reading', 3), ('read', 2), ('to-read', -1)]
for (identifier, count) in shelf_proportions:
if shelf_max <= 0:
break
if count > shelf_max or count < 0:
count = shelf_max
2020-03-17 00:09:45 +00:00
try:
shelf = models.Shelf.objects.get(
user=user,
identifier=identifier,
)
except models.Shelf.DoesNotExist:
continue
2020-03-16 23:10:59 +00:00
if not shelf.books.count():
continue
books = models.ShelfBook.objects.filter(
shelf=shelf,
).order_by(
'-updated_date'
)[:count]
shelf_max -= len(books)
shelves.append({
'name': shelf.name,
'identifier': shelf.identifier,
'books': [b.book for b in books],
'size': shelf.books.count(),
})
return shelves