Merge pull request #1692 from joachimesque/summary-review-sharing
Feature: Annual summary sharing
This commit is contained in:
Mouse Reeve
GitHub
@ -1,13 +1,17 @@
|
||||
"""end-of-year read books stats"""
|
||||
from datetime import date
|
||||
from uuid import uuid4
|
||||
|
||||
from django.contrib.auth.decorators import login_required
|
||||
from django.db.models import Case, When, Avg, Sum
|
||||
from django.http import Http404
|
||||
from django.shortcuts import get_object_or_404
|
||||
from django.shortcuts import get_object_or_404, redirect
|
||||
from django.template.response import TemplateResponse
|
||||
from django.views import View
|
||||
from django.views.decorators.http import require_POST
|
||||
|
||||
from bookwyrm import models
|
||||
from .helpers import get_user_from_username
|
||||
|
||||
|
||||
# December day of first availability
|
||||
@ -16,59 +20,34 @@ FIRST_DAY = 15
|
||||
LAST_DAY = 15
|
||||
|
||||
|
||||
def get_annual_summary_year():
|
||||
"""return the latest available annual summary year or None"""
|
||||
|
||||
today = date.today()
|
||||
if date(today.year, 12, FIRST_DAY) <= today <= date(today.year, 12, 31):
|
||||
return today.year
|
||||
|
||||
if LAST_DAY > 0 and date(today.year, 1, 1) <= today <= date(
|
||||
today.year, 1, LAST_DAY
|
||||
):
|
||||
return today.year - 1
|
||||
|
||||
return None
|
||||
|
||||
|
||||
def is_year_available(year):
|
||||
"""return boolean"""
|
||||
|
||||
today = date.today()
|
||||
year = int(year)
|
||||
if year < today.year:
|
||||
return True
|
||||
if year == today.year and today >= date(today.year, 12, FIRST_DAY):
|
||||
return True
|
||||
|
||||
return False
|
||||
|
||||
|
||||
# pylint: disable= no-self-use
|
||||
class AnnualSummary(View):
|
||||
"""display a summary of the year for the current user"""
|
||||
|
||||
def get(self, request, year):
|
||||
def get(self, request, username, year):
|
||||
"""get response"""
|
||||
|
||||
if not is_year_available(year):
|
||||
raise Http404(f"The summary for {year} is unavailable")
|
||||
user = get_user_from_username(request.user, username)
|
||||
|
||||
year_key = None
|
||||
if user.summary_keys and year in user.summary_keys:
|
||||
year_key = user.summary_keys[year]
|
||||
|
||||
privacy_verification(request, user, year, year_key)
|
||||
|
||||
paginated_years = (
|
||||
int(year) - 1,
|
||||
int(year) + 1 if is_year_available(int(year) + 1) else None,
|
||||
int(year) - 1 if is_year_available(user, int(year) - 1) else None,
|
||||
int(year) + 1 if is_year_available(user, int(year) + 1) else None,
|
||||
)
|
||||
|
||||
user = request.user
|
||||
|
||||
if not user.is_authenticated:
|
||||
raise Http404(f"Login or register {year} to access this page")
|
||||
|
||||
# get data
|
||||
read_book_ids_in_year = get_read_book_ids_in_year(user, year)
|
||||
|
||||
if len(read_book_ids_in_year) == 0:
|
||||
data = {
|
||||
"summary_user": user,
|
||||
"year": year,
|
||||
"year_key": year_key,
|
||||
"book_total": 0,
|
||||
"books": [],
|
||||
"paginated_years": paginated_years,
|
||||
@ -94,7 +73,9 @@ class AnnualSummary(View):
|
||||
ratings_stats = ratings.aggregate(Avg("rating"))
|
||||
|
||||
data = {
|
||||
"summary_user": user,
|
||||
"year": year,
|
||||
"year_key": year_key,
|
||||
"books_total": len(read_books_in_year),
|
||||
"books": read_books_in_year,
|
||||
"pages_total": page_stats["pages__sum"] or 0,
|
||||
@ -118,18 +99,166 @@ class AnnualSummary(View):
|
||||
return TemplateResponse(request, "annual_summary/layout.html", data)
|
||||
|
||||
|
||||
@login_required
|
||||
def personal_annual_summary(request, year):
|
||||
"""redirect simple URL to URL with username"""
|
||||
|
||||
return redirect("annual-summary", request.user.localname, year)
|
||||
|
||||
|
||||
@login_required
|
||||
@require_POST
|
||||
def summary_add_key(request):
|
||||
"""add summary key"""
|
||||
|
||||
year = request.POST["year"]
|
||||
user = request.user
|
||||
|
||||
new_key = uuid4().hex
|
||||
|
||||
if not user.summary_keys:
|
||||
user.summary_keys = {
|
||||
year: new_key,
|
||||
}
|
||||
else:
|
||||
user.summary_keys[year] = new_key
|
||||
|
||||
user.save()
|
||||
|
||||
response = redirect("annual-summary", user.localname, year)
|
||||
response["Location"] += f"?key={str(new_key)}"
|
||||
return response
|
||||
|
||||
|
||||
@login_required
|
||||
@require_POST
|
||||
def summary_revoke_key(request):
|
||||
"""revoke summary key"""
|
||||
|
||||
year = request.POST["year"]
|
||||
user = request.user
|
||||
|
||||
if user.summary_keys and year in user.summary_keys:
|
||||
user.summary_keys.pop(year)
|
||||
|
||||
user.save()
|
||||
|
||||
return redirect("annual-summary", user.localname, year)
|
||||
|
||||
|
||||
def get_annual_summary_year():
|
||||
"""return the latest available annual summary year or None"""
|
||||
|
||||
today = date.today()
|
||||
if date(today.year, 12, FIRST_DAY) <= today <= date(today.year, 12, 31):
|
||||
return today.year
|
||||
|
||||
if LAST_DAY > 0 and date(today.year, 1, 1) <= today <= date(
|
||||
today.year, 1, LAST_DAY
|
||||
):
|
||||
return today.year - 1
|
||||
|
||||
return None
|
||||
|
||||
|
||||
def privacy_verification(request, user, year, year_key):
|
||||
"""raises a 404 error if the user should not access the page"""
|
||||
if user != request.user:
|
||||
request_key = None
|
||||
if "key" in request.GET:
|
||||
request_key = request.GET["key"]
|
||||
|
||||
if not request_key or request_key != year_key:
|
||||
raise Http404(f"The summary for {year} is unavailable")
|
||||
|
||||
if not is_year_available(user, year):
|
||||
raise Http404(f"The summary for {year} is unavailable")
|
||||
|
||||
|
||||
def is_year_available(user, year):
|
||||
"""return boolean"""
|
||||
|
||||
earliest_year = int(get_earliest_year(user, year))
|
||||
today = date.today()
|
||||
year = int(year)
|
||||
if earliest_year <= year < today.year:
|
||||
return True
|
||||
if year == today.year and today >= date(today.year, 12, FIRST_DAY):
|
||||
return True
|
||||
|
||||
return False
|
||||
|
||||
|
||||
def get_earliest_year(user, year):
|
||||
"""return the earliest finish_date or shelved_date year for user books in read shelf"""
|
||||
|
||||
read_shelfbooks = models.ShelfBook.objects.filter(user__id=user.id).filter(
|
||||
shelf__identifier__exact="read"
|
||||
)
|
||||
read_shelfbooks_list = list(read_shelfbooks.values("book", "shelved_date"))
|
||||
|
||||
book_dates = []
|
||||
|
||||
for book in read_shelfbooks_list:
|
||||
earliest_finished = (
|
||||
models.ReadThrough.objects.filter(user__id=user.id)
|
||||
.filter(book_id=book["book"])
|
||||
.exclude(finish_date__exact=None)
|
||||
.order_by("finish_date")
|
||||
.values("finish_date")
|
||||
.first()
|
||||
)
|
||||
|
||||
if earliest_finished:
|
||||
book_dates.append(
|
||||
min(earliest_finished["finish_date"], book["shelved_date"])
|
||||
)
|
||||
else:
|
||||
book_dates.append(book["shelved_date"])
|
||||
|
||||
if book_dates:
|
||||
return min(book_dates).year
|
||||
|
||||
return year
|
||||
|
||||
|
||||
def get_read_book_ids_in_year(user, year):
|
||||
"""return an ordered QuerySet of the read book ids"""
|
||||
|
||||
read_shelf = get_object_or_404(user.shelf_set, identifier="read")
|
||||
read_book_ids_in_year = (
|
||||
shelved_book_ids = (
|
||||
models.ShelfBook.objects.filter(shelf=read_shelf)
|
||||
.filter(user=user)
|
||||
.filter(shelved_date__year=year)
|
||||
.order_by("shelved_date", "created_date", "updated_date")
|
||||
.values_list("book", flat=True)
|
||||
.values_list("book", "shelved_date")
|
||||
)
|
||||
return read_book_ids_in_year
|
||||
|
||||
book_dates = []
|
||||
|
||||
for book in shelved_book_ids:
|
||||
finished_in_year = (
|
||||
models.ReadThrough.objects.filter(user__id=user.id)
|
||||
.filter(book_id=book[0])
|
||||
.filter(finish_date__year=year)
|
||||
.values("finish_date")
|
||||
.first()
|
||||
)
|
||||
|
||||
if finished_in_year:
|
||||
# Finished a readthrough in the year
|
||||
book_dates.append((book[0], finished_in_year["finish_date"]))
|
||||
else:
|
||||
has_other_year_readthrough = (
|
||||
models.ReadThrough.objects.filter(user__id=user.id)
|
||||
.filter(book_id=book[0])
|
||||
.exists()
|
||||
)
|
||||
if not has_other_year_readthrough and book[1].year == int(year):
|
||||
# No readthrough but shelved this year
|
||||
book_dates.append(book)
|
||||
|
||||
book_dates = sorted(book_dates, key=lambda tup: tup[1])
|
||||
|
||||
return [book[0] for book in book_dates]
|
||||
|
||||
|
||||
def get_books_from_shelfbooks(books_ids):
|
||||
|
||||
Reference in New Issue
Block a user