Merge branch 'main' into group-list-button

bookwyrm/views/__init__.py

@@ -94,5 +94,11 @@ from .search import Search
 from .status import CreateStatus, EditStatus, DeleteStatus, update_progress
 from .status import edit_readthrough
 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, user_redirect
 from .wellknown import *
+from .annual_summary import (
+    AnnualSummary,
+    personal_annual_summary,
+    summary_add_key,
+    summary_revoke_key,
+)

bookwyrm/views/annual_summary.py

@@ -0,0 +1,210 @@
+"""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 Avg, Sum, Min, Case, When
+from django.http import Http404
+from django.shortcuts import 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
+FIRST_DAY = 15
+# January day of last availability, 0 for no availability in Jan.
+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"""
+
+        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 if is_year_available(user, int(year) - 1) else None,
+            int(year) + 1 if is_year_available(user, int(year) + 1) else None,
+        )
+
+        # get data
+        read_book_ids_in_year = (
+            user.readthrough_set.filter(
+                finish_date__year__gte=year,
+                finish_date__year__lt=int(year) + 1,
+            )
+            .order_by("finish_date")
+            .values_list("book__id", flat=True)
+        )
+
+        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,
+            }
+            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,
+            "year_key": year_key,
+            "books_total": len(read_books_in_year),
+            "books": read_books_in_year,
+            "pages_total": page_stats["pages__sum"] or 0,
+            "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)
+
+
+@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 = user.readthrough_set.filter(finish_date__isnull=False).aggregate(
+        Min("finish_date")
+    )["finish_date__min"]
+    if not earliest_year:
+        return True
+    earliest_year = earliest_year.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_books_from_shelfbooks(books_ids):
+    """return an ordered QuerySet of books from a list"""
+
+    ordered = Case(*[When(pk=pk, then=pos) for pos, pk in enumerate(books_ids)])
+    books = models.Edition.objects.filter(id__in=books_ids).order_by(ordered)
+
+    return books

bookwyrm/views/feed.py

@@ -16,6 +16,7 @@ from bookwyrm.settings import PAGE_LENGTH, STREAMS
 from bookwyrm.suggested_users import suggested_users
 from .helpers import filter_stream_by_status_type, get_user_from_username
 from .helpers import is_api_request, is_bookwyrm_request
+from .annual_summary import get_annual_summary_year
 
 
 # pylint: disable= no-self-use
@@ -62,6 +63,7 @@ class Feed(View):
                 "allowed_status_types": request.user.feed_status_types,
                 "settings_saved": settings_saved,
                 "path": f"/{tab['key']}",
+                "annual_summary_year": get_annual_summary_year(),
             },
         }
         return TemplateResponse(request, "feed/feed.html", data)

bookwyrm/views/landing/login.py

@@ -39,7 +39,8 @@ class Login(View):
             return redirect("/")
         login_form = forms.LoginForm(request.POST)
 
-        localname = login_form.data["localname"]
+        localname = login_form.data.get("localname")
+
         if "@" in localname:  # looks like an email address to me
             try:
                 username = models.User.objects.get(email=localname).username
@@ -47,7 +48,7 @@ class Login(View):
                 username = localname
         else:
             username = f"{localname}@{DOMAIN}"
-        password = login_form.data["password"]
+        password = login_form.data.get("password")
 
         # perform authentication
         user = authenticate(request, username=username, password=password)

bookwyrm/views/shelf/shelf.py

@@ -52,7 +52,7 @@ class Shelf(View):
             )
             shelf = FakeShelf("all", _("All books"), user, books, "public")
 
-        if is_api_request(request):
+        if is_api_request(request) and shelf_identifier:
             return ActivitypubResponse(shelf.to_activity(**request.GET))
 
         reviews = models.Review.objects

bookwyrm/views/user.py

@@ -151,3 +151,9 @@ def hide_suggestions(request):
     request.user.show_suggested_users = False
     request.user.save(broadcast=False, update_fields=["show_suggested_users"])
     return redirect(request.headers.get("Referer", "/"))
+
+
+# pylint: disable=unused-argument
+def user_redirect(request, username):
+    """redirect to a user's feed"""
+    return redirect("user-feed", username=username)