Add basic key verification and change voice in template

This commit is contained in:
Joachim 2021-12-22 15:11:05 +01:00
parent 24b0e086e7
commit 1022e3e165
5 changed files with 131 additions and 91 deletions

View file

@ -10,12 +10,14 @@
{% endblock %} {% endblock %}
{% block content %} {% block content %}
{% with display_name=summary_user.display_name %}
{% if user == summary_user %}
<div class="columns"> <div class="columns">
{% with year=paginated_years|first %} {% with year=paginated_years|first %}
<div class="column"> <div class="column">
<a href="{% url 'annual-summary' year %}"> <a href="{% url 'annual-summary' summary_user.localname year %}">
<span class="icon icon-arrow-left" aria-hidden="true"></span> <span class="icon icon-arrow-left" aria-hidden="true"></span>
{% blocktrans %}{{ year }} in the books{% endblocktrans %} {{ year }}
</a> </a>
</div> </div>
{% endwith %} {% endwith %}
@ -23,20 +25,24 @@
{% with year=paginated_years|last %} {% with year=paginated_years|last %}
{% if year %} {% if year %}
<div class="column has-text-right"> <div class="column has-text-right">
<a href="{% url 'annual-summary' year %}"> <a href="{% url 'annual-summary' summary_user.localname year %}">
{% blocktrans %}{{ year }} in the books{% endblocktrans %} {{ year }}
<span class="icon icon-arrow-right" aria-hidden="true"></span> <span class="icon icon-arrow-right" aria-hidden="true"></span>
</a> </a>
</div> </div>
{% endif %} {% endif %}
{% endwith %} {% endwith %}
</div> </div>
{% endif %}
<h1 class="title is-1 is-serif has-text-centered mb-5"> <h1 class="title is-1 is-serif has-text-centered">
📚✨ 📚✨
{% blocktrans %}{{ year }} <em>in the books</em>{% endblocktrans %} {% blocktrans %}{{ year }} <em>in the books</em>{% endblocktrans %}
✨📚 ✨📚
</h1> </h1>
<p class="subtitle is-3 is-serif has-text-centered mb-5">
{% blocktrans %}<em>{{ display_name }}s</em> year of reading{% endblocktrans %}
</p>
{% if not books %} {% if not books %}
<p class="has-text-centered is-size-5">{% blocktrans %}Sadly you didn't finish any book in {{ year }}{% endblocktrans %}</p> <p class="has-text-centered is-size-5">{% blocktrans %}Sadly you didn't finish any book in {{ year }}{% endblocktrans %}</p>
@ -45,7 +51,7 @@
<div class="columns is-mobile"> <div class="columns is-mobile">
<div class="column is-8 is-offset-2 has-text-centered"> <div class="column is-8 is-offset-2 has-text-centered">
<h2 class="title is-3 is-serif"> <h2 class="title is-3 is-serif">
{% blocktrans %}In {{ year }}, you read {{ books_total }} books<br />for a total of {{ pages_total }} pages!{% endblocktrans %} {% blocktrans %}In {{ year }}, {{ display_name }} read {{ books_total }} books<br />for a total of {{ pages_total }} pages!{% endblocktrans %}
</h2> </h2>
<p class="subtitle is-5">{% trans "Thats great!" %}</p> <p class="subtitle is-5">{% trans "Thats great!" %}</p>
@ -65,7 +71,7 @@
<a href="{{ book_pages_lowest.local_path }}">{% include 'snippets/book_cover.html' with book=book_pages_lowest cover_class='is-w-auto-tablet is-h-l-mobile' %}</a> <a href="{{ book_pages_lowest.local_path }}">{% include 'snippets/book_cover.html' with book=book_pages_lowest cover_class='is-w-auto-tablet is-h-l-mobile' %}</a>
</div> </div>
<div class="column is-3"> <div class="column is-3">
{% trans "Your shortest read this year" %} {% trans "Their shortest read this year…" %}
<p class="title is-4 is-serif is-italic"> <p class="title is-4 is-serif is-italic">
<a href="{{ book_pages_lowest.local_path }}" class="has-text-success-dark"> <a href="{{ book_pages_lowest.local_path }}" class="has-text-success-dark">
{{ book_pages_lowest.title }} {{ book_pages_lowest.title }}
@ -86,7 +92,7 @@
<a href="{{ book_pages_highest.local_path }}">{% include 'snippets/book_cover.html' with book=book_pages_highest cover_class='is-w-auto-tablet is-h-l-mobile' %}</a> <a href="{{ book_pages_highest.local_path }}">{% include 'snippets/book_cover.html' with book=book_pages_highest cover_class='is-w-auto-tablet is-h-l-mobile' %}</a>
</div> </div>
<div class="column is-3"> <div class="column is-3">
{% trans "and the longest read" %} {% trans "and the longest" %}
<p class="title is-4 is-serif is-italic"> <p class="title is-4 is-serif is-italic">
<a href="{{ book_pages_lowest.local_path }}" class="has-text-success-dark"> <a href="{{ book_pages_lowest.local_path }}" class="has-text-success-dark">
{{ book_pages_highest.title }} {{ book_pages_highest.title }}
@ -112,10 +118,11 @@
</div> </div>
</div> </div>
{% if ratings_total > 0 %}
<div class="columns"> <div class="columns">
<div class="column has-text-centered"> <div class="column has-text-centered">
<h2 class="title is-3 is-serif"> <h2 class="title is-3 is-serif">
{% blocktrans %}You left {{ ratings_total }} ratings, <br />your average rating is {{ rating_average }}{% endblocktrans %} {% blocktrans %}{{ display_name }} left {{ ratings_total }} ratings, <br />their average rating is {{ rating_average }}{% endblocktrans %}
</h2> </h2>
</div> </div>
</div> </div>
@ -124,7 +131,7 @@
<a href="{{ book_rating_highest.book.local_path }}">{% include 'snippets/book_cover.html' with book=book_rating_highest.book cover_class='is-w-auto-tablet is-h-l-mobile' %}</a> <a href="{{ book_rating_highest.book.local_path }}">{% include 'snippets/book_cover.html' with book=book_rating_highest.book cover_class='is-w-auto-tablet is-h-l-mobile' %}</a>
</div> </div>
<div class="column is-4"> <div class="column is-4">
{% trans "Your best rated review" %} {% trans "Their best rated review" %}
<p class="title is-4 is-serif is-italic"> <p class="title is-4 is-serif is-italic">
<a href="{{ book_rating_highest.book.local_path }}" class="has-text-success-dark"> <a href="{{ book_rating_highest.book.local_path }}" class="has-text-success-dark">
{{ book_rating_highest.book.title }} {{ book_rating_highest.book.title }}
@ -137,7 +144,7 @@
{% endif %} {% endif %}
<p class="subtitle is-6"> <p class="subtitle is-6">
{% with rating=book_rating_highest.rating|floatformat %} {% with rating=book_rating_highest.rating|floatformat %}
{% blocktrans %}Your rating: <strong>{{ rating }}</strong>{% endblocktrans%} {% blocktrans %}Their rating: <strong>{{ rating }}</strong>{% endblocktrans%}
{% endwith %} {% endwith %}
</p> </p>
</div> </div>
@ -148,11 +155,12 @@
<hr /> <hr />
</div> </div>
</div> </div>
{% endif %}
<div class="columns"> <div class="columns">
<div class="column has-text-centered"> <div class="column has-text-centered">
<h2 class="title is-3 is-serif"> <h2 class="title is-3 is-serif">
{% blocktrans %}All the books you read in 2021{% endblocktrans %} {% blocktrans %}All the books {{ display_name }} read in 2021{% endblocktrans %}
</h2> </h2>
</div> </div>
</div> </div>
@ -180,5 +188,6 @@
</div> </div>
</div> </div>
</div> </div>
{% endif %} {% endif %}
{% endwith %}
{% endblock %} {% endblock %}

View file

@ -15,7 +15,7 @@
</p> </p>
<p> <p>
<a href="{% url 'annual-summary' year %}" class="button is-success has-background-success-dark"> <a href="{% url 'annual-summary' request.user.localname year %}" class="button is-success has-background-success-dark">
{% blocktrans %}Discover your stats for {{ year }}!{% endblocktrans %} {% blocktrans %}Discover your stats for {{ year }}!{% endblocktrans %}
</a> </a>
</p> </p>

View file

@ -479,7 +479,11 @@ urlpatterns = [
), ),
# annual summary # annual summary
re_path( re_path(
r"^my-year-in-the-books/(?P<year>\d{4})/?$", r"^my-year-in-the-books/(?P<year>\d+)/?$",
views.personal_annual_summary,
),
re_path(
rf"{LOCAL_USER_PATH}/(?P<year>\d+)-in-the-books/?$",
views.AnnualSummary.as_view(), views.AnnualSummary.as_view(),
name="annual-summary", name="annual-summary",
), ),

View file

@ -96,4 +96,7 @@ from .status import edit_readthrough
from .updates import get_notification_count, get_unread_status_count from .updates import get_notification_count, get_unread_status_count
from .user import User, Followers, Following, hide_suggestions from .user import User, Followers, Following, hide_suggestions
from .wellknown import * from .wellknown import *
from .annual_summary import AnnualSummary from .annual_summary import (
AnnualSummary,
personal_annual_summary,
)

View file

@ -1,13 +1,17 @@
"""end-of-year read books stats""" """end-of-year read books stats"""
from datetime import date 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.db.models import Case, When, Avg, Sum
from django.http import Http404 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.template.response import TemplateResponse
from django.views import View from django.views import View
from django.views.decorators.http import require_POST
from bookwyrm import models from bookwyrm import models
from .helpers import get_user_from_username
# December day of first availability # December day of first availability
@ -16,6 +20,100 @@ FIRST_DAY = 15
LAST_DAY = 15 LAST_DAY = 15
# pylint: disable= no-self-use
class AnnualSummary(View):
"""display a summary of the year for the current user"""
def get(self, request, username, year):
"""get response"""
if not is_year_available(year):
raise Http404(f"The summary for {year} is unavailable")
paginated_years = (
int(year) - 1,
int(year) + 1 if is_year_available(int(year) + 1) else None,
)
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]
# verify key
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")
# 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,
"book_total": 0,
"books": [],
"paginated_years": paginated_years,
}
return TemplateResponse(request, "annual_summary/layout.html", data)
read_books_in_year = get_books_from_shelfbooks(read_book_ids_in_year)
# pages stats queries
page_stats = read_books_in_year.aggregate(Sum("pages"), Avg("pages"))
book_list_by_pages = read_books_in_year.filter(pages__gte=0).order_by("pages")
# books with no pages
no_page_list = len(read_books_in_year.filter(pages__exact=None))
# rating stats queries
ratings = (
models.Review.objects.filter(user=user)
.exclude(deleted=True)
.exclude(rating=None)
.filter(book_id__in=read_book_ids_in_year)
)
ratings_stats = ratings.aggregate(Avg("rating"))
data = {
"summary_user": user,
"year": year,
"books_total": len(read_books_in_year),
"books": read_books_in_year,
"pages_total": page_stats["pages__sum"],
"pages_average": round(
page_stats["pages__avg"] if page_stats["pages__avg"] else 0
),
"book_pages_lowest": book_list_by_pages.first(),
"book_pages_highest": book_list_by_pages.last(),
"no_page_number": no_page_list,
"ratings_total": len(ratings),
"rating_average": round(
ratings_stats["rating__avg"] if ratings_stats["rating__avg"] else 0, 2
),
"book_rating_highest": ratings.order_by("-rating").first(),
"best_ratings_books_ids": [
review.book.id for review in ratings.filter(rating=5)
],
"paginated_years": paginated_years,
}
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)
def get_annual_summary_year(): def get_annual_summary_year():
"""return the latest available annual summary year or None""" """return the latest available annual summary year or None"""
@ -44,80 +142,6 @@ def is_year_available(year):
return False 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):
"""get response"""
if not is_year_available(year):
raise Http404(f"The summary for {year} is unavailable")
paginated_years = (
int(year) - 1,
int(year) + 1 if is_year_available(int(year) + 1) else None,
)
user = request.user
if not user.is_authenticated:
raise Http404(f"Login or register {year} to access this page")
read_book_ids_in_year = get_read_book_ids_in_year(user, year)
if len(read_book_ids_in_year) == 0:
data = {
"year": year,
"book_total": 0,
"books": [],
"paginated_years": paginated_years,
}
return TemplateResponse(request, "annual_summary/layout.html", data)
read_books_in_year = get_books_from_shelfbooks(read_book_ids_in_year)
# pages stats queries
page_stats = read_books_in_year.aggregate(Sum("pages"), Avg("pages"))
book_list_by_pages = read_books_in_year.filter(pages__gte=0).order_by("pages")
# books with no pages
no_page_list = len(read_books_in_year.filter(pages__exact=None))
# rating stats queries
ratings = (
models.Review.objects.filter(user=user)
.exclude(deleted=True)
.exclude(rating=None)
.filter(book_id__in=read_book_ids_in_year)
)
ratings_stats = ratings.aggregate(Avg("rating"))
data = {
"year": year,
"books_total": len(read_books_in_year),
"books": read_books_in_year,
"pages_total": page_stats["pages__sum"],
"pages_average": round(
page_stats["pages__avg"] if page_stats["pages__avg"] else 0
),
"book_pages_lowest": book_list_by_pages.first(),
"book_pages_highest": book_list_by_pages.last(),
"no_page_number": no_page_list,
"ratings_total": len(ratings),
"rating_average": round(
ratings_stats["rating__avg"] if ratings_stats["rating__avg"] else 0, 2
),
"book_rating_highest": ratings.order_by("-rating").first(),
"best_ratings_books_ids": [
review.book.id for review in ratings.filter(rating=5)
],
"paginated_years": paginated_years,
}
return TemplateResponse(request, "annual_summary/layout.html", data)
def get_read_book_ids_in_year(user, year): def get_read_book_ids_in_year(user, year):
"""return an ordered QuerySet of the read book ids""" """return an ordered QuerySet of the read book ids"""