moviewyrm/bookwyrm/views/shelf.py

209 lines
7 KiB
Python
Raw Normal View History

2021-03-08 16:49:10 +00:00
""" shelf views"""
2021-03-31 17:23:20 +00:00
from collections import namedtuple
from django.db import IntegrityError
from django.db.models import OuterRef, Subquery, F
2021-01-13 19:45:08 +00:00
from django.contrib.auth.decorators import login_required
from django.core.paginator import Paginator
2021-01-13 19:45:08 +00:00
from django.http import HttpResponseBadRequest, HttpResponseNotFound
from django.shortcuts import get_object_or_404, redirect
from django.template.response import TemplateResponse
from django.utils.decorators import method_decorator
2021-08-17 21:35:28 +00:00
from django.utils.translation import gettext_lazy as _
2021-01-13 19:45:08 +00:00
from django.views import View
from django.views.decorators.http import require_POST
from bookwyrm import forms, models
from bookwyrm.activitypub import ActivitypubResponse
from bookwyrm.settings import PAGE_LENGTH
2021-01-13 19:45:08 +00:00
from .helpers import is_api_request, get_edition, get_user_from_username
2021-06-18 21:12:56 +00:00
from .helpers import privacy_filter
2021-01-13 19:45:08 +00:00
# pylint: disable=no-self-use
2021-01-13 19:45:08 +00:00
class Shelf(View):
2021-04-26 16:15:42 +00:00
"""shelf page"""
2021-03-08 16:49:10 +00:00
2021-03-31 17:23:20 +00:00
def get(self, request, username, shelf_identifier=None):
2021-04-26 16:15:42 +00:00
"""display a shelf"""
user = get_user_from_username(request.user, username)
2021-01-13 19:45:08 +00:00
is_self = user == request.user
if is_self:
shelves = user.shelf_set
else:
shelves = privacy_filter(request.user, user.shelf_set)
2021-03-31 17:23:20 +00:00
# get the shelf and make sure the logged in user should be able to see it
2021-01-13 19:45:08 +00:00
if shelf_identifier:
2021-04-01 14:24:56 +00:00
try:
shelf = user.shelf_set.get(identifier=shelf_identifier)
except models.Shelf.DoesNotExist:
return HttpResponseNotFound()
if not shelf.visible_to_user(request.user):
2021-03-31 17:23:20 +00:00
return HttpResponseNotFound()
2021-05-11 20:54:38 +00:00
books = shelf.books
2021-03-31 17:23:20 +00:00
# this is a constructed "all books" view, with a fake "shelf" obj
2021-01-13 19:45:08 +00:00
else:
2021-03-31 17:32:50 +00:00
FakeShelf = namedtuple(
"Shelf", ("identifier", "name", "user", "books", "privacy")
)
2021-03-31 17:23:20 +00:00
books = models.Edition.objects.filter(
2021-05-11 20:54:38 +00:00
# privacy is ensured because the shelves are already filtered above
2021-03-31 17:23:20 +00:00
shelfbook__shelf__in=shelves.all()
).distinct()
2021-03-31 17:32:50 +00:00
shelf = FakeShelf("all", _("All books"), user, books, "public")
2021-01-13 19:45:08 +00:00
if is_api_request(request):
return ActivitypubResponse(shelf.to_activity(**request.GET))
reviews = models.Review.objects.filter(
user=user,
rating__isnull=False,
book__id=OuterRef("id"),
2021-05-23 15:48:00 +00:00
deleted=False,
2021-05-11 20:54:38 +00:00
).order_by("-published_date")
if not is_self:
reviews = privacy_filter(request.user, reviews)
books = books.annotate(
rating=Subquery(reviews.values("rating")[:1]),
shelved_date=F("shelfbook__shelved_date"),
).prefetch_related("authors")
2021-05-11 20:54:38 +00:00
paginated = Paginator(
books.order_by("-shelfbook__updated_date"),
PAGE_LENGTH,
2021-03-08 16:49:10 +00:00
)
2021-01-13 19:45:08 +00:00
page = paginated.get_page(request.GET.get("page"))
2021-01-13 19:45:08 +00:00
data = {
2021-03-08 16:49:10 +00:00
"user": user,
"is_self": is_self,
2021-03-08 16:49:10 +00:00
"shelves": shelves.all(),
"shelf": shelf,
"books": page,
"page_range": paginated.get_elided_page_range(
page.number, on_each_side=2, on_ends=1
2021-05-03 21:52:24 +00:00
),
2021-01-13 19:45:08 +00:00
}
return TemplateResponse(request, "user/shelf/shelf.html", data)
2021-01-13 19:45:08 +00:00
2021-03-08 16:49:10 +00:00
@method_decorator(login_required, name="dispatch")
2021-01-27 17:31:01 +00:00
# pylint: disable=unused-argument
2021-01-19 00:38:04 +00:00
def post(self, request, username, shelf_identifier):
2021-04-26 16:15:42 +00:00
"""edit a shelf"""
2021-01-19 00:38:04 +00:00
try:
shelf = request.user.shelf_set.get(identifier=shelf_identifier)
except models.Shelf.DoesNotExist:
return HttpResponseNotFound()
2021-01-13 19:45:08 +00:00
if request.user != shelf.user:
return HttpResponseBadRequest()
2021-03-08 16:49:10 +00:00
if not shelf.editable and request.POST.get("name") != shelf.name:
2021-01-13 19:45:08 +00:00
return HttpResponseBadRequest()
form = forms.ShelfForm(request.POST, instance=shelf)
if not form.is_valid():
return redirect(shelf.local_path)
shelf = form.save()
return redirect(shelf.local_path)
@login_required
@require_POST
def create_shelf(request):
2021-04-26 16:15:42 +00:00
"""user generated shelves"""
2021-01-13 19:45:08 +00:00
form = forms.ShelfForm(request.POST)
if not form.is_valid():
2021-03-08 16:49:10 +00:00
return redirect(request.headers.get("Referer", "/"))
2021-01-13 19:45:08 +00:00
shelf = form.save()
2021-03-31 22:03:07 +00:00
return redirect(shelf.local_path)
2021-01-13 19:45:08 +00:00
@login_required
@require_POST
def delete_shelf(request, shelf_id):
2021-04-26 16:15:42 +00:00
"""user generated shelves"""
2021-01-13 19:45:08 +00:00
shelf = get_object_or_404(models.Shelf, id=shelf_id)
if request.user != shelf.user or not shelf.editable:
return HttpResponseBadRequest()
shelf.delete()
2021-03-31 22:03:07 +00:00
return redirect("user-shelves", request.user.localname)
2021-01-13 19:45:08 +00:00
@login_required
@require_POST
def shelve(request):
2021-04-26 16:15:42 +00:00
"""put a book on a user's shelf"""
2021-03-08 16:49:10 +00:00
book = get_edition(request.POST.get("book"))
2021-01-13 19:45:08 +00:00
desired_shelf = models.Shelf.objects.filter(
2021-03-08 16:49:10 +00:00
identifier=request.POST.get("shelf"), user=request.user
2021-01-13 19:45:08 +00:00
).first()
if not desired_shelf:
return HttpResponseNotFound()
2021-01-13 19:45:08 +00:00
change_from_current_identifier = request.POST.get("change-shelf-from")
if change_from_current_identifier is not None:
current_shelf = models.Shelf.objects.get(
user=request.user, identifier=change_from_current_identifier
)
handle_unshelve(book, current_shelf)
# A book can be on multiple shelves, but only on one read status shelf at a time
if desired_shelf.identifier in models.Shelf.READ_STATUS_IDENTIFIERS:
current_read_status_shelfbook = (
models.ShelfBook.objects.select_related("shelf")
.filter(
shelf__identifier__in=models.Shelf.READ_STATUS_IDENTIFIERS,
user=request.user,
book=book,
)
.first()
)
if current_read_status_shelfbook is not None:
if (
current_read_status_shelfbook.shelf.identifier
!= desired_shelf.identifier
):
handle_unshelve(book, current_read_status_shelfbook.shelf)
else: # It is already on the shelf
return redirect(request.headers.get("Referer", "/"))
models.ShelfBook.objects.create(
book=book, shelf=desired_shelf, user=request.user
)
else:
2021-01-13 19:45:08 +00:00
try:
models.ShelfBook.objects.create(
book=book, shelf=desired_shelf, user=request.user
)
2021-03-31 17:23:20 +00:00
# The book is already on this shelf.
# Might be good to alert, or reject the action?
except IntegrityError:
2021-01-13 19:45:08 +00:00
pass
return redirect(request.headers.get("Referer", "/"))
2021-01-13 19:45:08 +00:00
@login_required
@require_POST
def unshelve(request):
2021-04-26 16:15:42 +00:00
"""put a on a user's shelf"""
2021-03-08 16:49:10 +00:00
book = models.Edition.objects.get(id=request.POST["book"])
current_shelf = models.Shelf.objects.get(id=request.POST["shelf"])
2021-01-13 19:45:08 +00:00
handle_unshelve(book, current_shelf)
2021-03-08 16:49:10 +00:00
return redirect(request.headers.get("Referer", "/"))
2021-01-13 19:45:08 +00:00
def handle_unshelve(book, shelf):
2021-04-26 16:15:42 +00:00
"""unshelve a book"""
2021-01-13 19:45:08 +00:00
row = models.ShelfBook.objects.get(book=book, shelf=shelf)
row.delete()