From 6e71ff2aa1f94bda74def7d6e64ea2c1a8507d48 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Tue, 12 Jan 2021 08:08:43 -0800 Subject: [PATCH 01/34] Adds login class view --- bookwyrm/templates/login.html | 2 +- bookwyrm/urls.py | 75 ++++++++++++++++---------------- bookwyrm/view_actions.py | 26 +---------- bookwyrm/views/__init__.py | 2 + bookwyrm/views/authentication.py | 45 +++++++++++++++++++ bookwyrm/{views.py => vviews.py} | 14 ------ 6 files changed, 86 insertions(+), 78 deletions(-) create mode 100644 bookwyrm/views/__init__.py create mode 100644 bookwyrm/views/authentication.py rename bookwyrm/{views.py => vviews.py} (98%) diff --git a/bookwyrm/templates/login.html b/bookwyrm/templates/login.html index 40d57fa4..87a97f3b 100644 --- a/bookwyrm/templates/login.html +++ b/bookwyrm/templates/login.html @@ -8,7 +8,7 @@ {% if login_form.non_field_errors %}

{{ login_form.non_field_errors }}

{% endif %} -
+ {% csrf_token %}
diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index 3abcac11..ce0e26b7 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -3,7 +3,7 @@ from django.conf.urls.static import static from django.contrib import admin from django.urls import path, re_path -from bookwyrm import incoming, outgoing, views, settings, wellknown +from bookwyrm import incoming, outgoing, settings, vviews, views, wellknown from bookwyrm import view_actions as actions from bookwyrm.utils import regex @@ -23,8 +23,8 @@ status_path = r'%s/(%s)/(?P\d+)' % \ book_path = r'^book/(?P\d+)' -handler404 = 'bookwyrm.views.not_found_page' -handler500 = 'bookwyrm.views.server_error_page' +handler404 = 'bookwyrm.vviews.not_found_page' +handler500 = 'bookwyrm.vviews.server_error_page' urlpatterns = [ path('admin/', admin.site.urls), @@ -42,56 +42,55 @@ urlpatterns = [ # TODO: re_path(r'^.well-known/host-meta/?$', incoming.host_meta), # TODO: robots.txt - # ui views - re_path(r'^login/?$', views.login_page), - re_path(r'^about/?$', views.about_page), - re_path(r'^password-reset/?$', views.password_reset_request), - re_path(r'^password-reset/(?P[A-Za-z0-9]+)/?$', views.password_reset), - re_path(r'^invite/?$', views.manage_invites), - re_path(r'^invite/(?P[A-Za-z0-9]+)/?$', views.invite_page), + # ui vviews + re_path(r'^login/?$', views.LoginView.as_view()), + re_path(r'^about/?$', vviews.about_page), + re_path(r'^password-reset/?$', vviews.password_reset_request), + re_path(r'^password-reset/(?P[A-Za-z0-9]+)/?$', vviews.password_reset), + re_path(r'^invite/?$', vviews.manage_invites), + re_path(r'^invite/(?P[A-Za-z0-9]+)/?$', vviews.invite_page), - path('', views.home), - re_path(r'^(?Phome|local|federated)/?$', views.home_tab), - re_path(r'^discover/?$', views.discover_page), - re_path(r'^notifications/?$', views.notifications_page), - re_path(r'^direct-messages/?$', views.direct_messages_page), - re_path(r'^import/?$', views.import_page), - re_path(r'^import-status/(\d+)/?$', views.import_status), - re_path(r'^user-edit/?$', views.edit_profile_page), + path('', vviews.home), + re_path(r'^(?Phome|local|federated)/?$', vviews.home_tab), + re_path(r'^discover/?$', vviews.discover_page), + re_path(r'^notifications/?$', vviews.notifications_page), + re_path(r'^direct-messages/?$', vviews.direct_messages_page), + re_path(r'^import/?$', vviews.import_page), + re_path(r'^import-status/(\d+)/?$', vviews.import_status), + re_path(r'^user-edit/?$', vviews.edit_profile_page), # should return a ui view or activitypub json blob as requested # users - re_path(r'%s/?$' % user_path, views.user_page), - re_path(r'%s\.json$' % local_user_path, views.user_page), - re_path(r'%s/?$' % local_user_path, views.user_page), - re_path(r'%s/shelves/?$' % local_user_path, views.user_shelves_page), - re_path(r'%s/followers(.json)?/?$' % local_user_path, views.followers_page), - re_path(r'%s/following(.json)?/?$' % local_user_path, views.following_page), + re_path(r'%s/?$' % user_path, vviews.user_page), + re_path(r'%s\.json$' % local_user_path, vviews.user_page), + re_path(r'%s/?$' % local_user_path, vviews.user_page), + re_path(r'%s/shelves/?$' % local_user_path, vviews.user_shelves_page), + re_path(r'%s/followers(.json)?/?$' % local_user_path, vviews.followers_page), + re_path(r'%s/following(.json)?/?$' % local_user_path, vviews.following_page), # statuses - re_path(r'%s(.json)?/?$' % status_path, views.status_page), - re_path(r'%s/activity/?$' % status_path, views.status_page), - re_path(r'%s/replies(.json)?/?$' % status_path, views.replies_page), + re_path(r'%s(.json)?/?$' % status_path, vviews.status_page), + re_path(r'%s/activity/?$' % status_path, vviews.status_page), + re_path(r'%s/replies(.json)?/?$' % status_path, vviews.replies_page), # books - re_path(r'%s(.json)?/?$' % book_path, views.book_page), - re_path(r'%s/edit/?$' % book_path, views.edit_book_page), - re_path(r'^author/(?P[\w\-]+)/edit/?$', views.edit_author_page), - re_path(r'%s/editions(.json)?/?$' % book_path, views.editions_page), + re_path(r'%s(.json)?/?$' % book_path, vviews.book_page), + re_path(r'%s/edit/?$' % book_path, vviews.edit_book_page), + re_path(r'^author/(?P[\w\-]+)/edit/?$', vviews.edit_author_page), + re_path(r'%s/editions(.json)?/?$' % book_path, vviews.editions_page), - re_path(r'^author/(?P[\w\-]+)(.json)?/?$', views.author_page), - re_path(r'^tag/(?P.+)\.json/?$', views.tag_page), - re_path(r'^tag/(?P.+)/?$', views.tag_page), + re_path(r'^author/(?P[\w\-]+)(.json)?/?$', vviews.author_page), + re_path(r'^tag/(?P.+)\.json/?$', vviews.tag_page), + re_path(r'^tag/(?P.+)/?$', vviews.tag_page), re_path(r'^%s/shelf/(?P[\w-]+)(.json)?/?$' % \ - user_path, views.shelf_page), + user_path, vviews.shelf_page), re_path(r'^%s/shelf/(?P[\w-]+)(.json)?/?$' % \ - local_user_path, views.shelf_page), + local_user_path, vviews.shelf_page), - re_path(r'^search/?$', views.search), + re_path(r'^search/?$', vviews.search), # internal action endpoints re_path(r'^logout/?$', actions.user_logout), - re_path(r'^user-login/?$', actions.user_login), re_path(r'^user-register/?$', actions.register), re_path(r'^reset-password-request/?$', actions.password_reset_request), re_path(r'^reset-password/?$', actions.password_reset), diff --git a/bookwyrm/view_actions.py b/bookwyrm/view_actions.py index eff70ff6..249e6270 100644 --- a/bookwyrm/view_actions.py +++ b/bookwyrm/view_actions.py @@ -22,31 +22,7 @@ from bookwyrm.connectors import connector_manager from bookwyrm.broadcast import broadcast from bookwyrm.emailing import password_reset_email from bookwyrm.settings import DOMAIN -from bookwyrm.views import get_user_from_username, get_edition - - -@require_POST -def user_login(request): - ''' authenticate user login ''' - login_form = forms.LoginForm(request.POST) - - localname = login_form.data['localname'] - username = '%s@%s' % (localname, DOMAIN) - password = login_form.data['password'] - user = authenticate(request, username=username, password=password) - if user is not None: - # successful login - login(request, user) - user.last_active_date = timezone.now() - return redirect(request.GET.get('next', '/')) - - login_form.non_field_errors = 'Username or password are incorrect' - register_form = forms.RegisterForm() - data = { - 'login_form': login_form, - 'register_form': register_form - } - return TemplateResponse(request, 'login.html', data) +from bookwyrm.vviews import get_user_from_username, get_edition @require_POST diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py new file mode 100644 index 00000000..0a5d9900 --- /dev/null +++ b/bookwyrm/views/__init__.py @@ -0,0 +1,2 @@ +''' make sure all our nice views are available ''' +from .authentication import LoginView diff --git a/bookwyrm/views/authentication.py b/bookwyrm/views/authentication.py new file mode 100644 index 00000000..b789e9cf --- /dev/null +++ b/bookwyrm/views/authentication.py @@ -0,0 +1,45 @@ +''' class views for login/register/password management views ''' +from django.contrib.auth import authenticate, login +from django.shortcuts import redirect +from django.template.response import TemplateResponse +from django.utils import timezone +from django.views import View + +from bookwyrm import forms +from bookwyrm.settings import DOMAIN + + +class LoginView(View): + ''' authenticate an existing user ''' + def get(self, request): + if request.user.is_authenticated: + return redirect('/') + # send user to the login page + data = { + 'title': 'Login', + 'login_form': forms.LoginForm(), + 'register_form': forms.RegisterForm(), + } + return TemplateResponse(request, 'login.html', data) + + def post(self, request): + login_form = forms.LoginForm(request.POST) + + localname = login_form.data['localname'] + username = '%s@%s' % (localname, DOMAIN) + password = login_form.data['password'] + user = authenticate(request, username=username, password=password) + if user is not None: + # successful login + login(request, user) + user.last_active_date = timezone.now() + return redirect(request.GET.get('next', '/')) + + # login errors + login_form.non_field_errors = 'Username or password are incorrect' + register_form = forms.RegisterForm() + data = { + 'login_form': login_form, + 'register_form': register_form + } + return TemplateResponse(request, 'login.html', data) diff --git a/bookwyrm/views.py b/bookwyrm/vviews.py similarity index 98% rename from bookwyrm/views.py rename to bookwyrm/vviews.py index faacd2ff..ebae3696 100644 --- a/bookwyrm/views.py +++ b/bookwyrm/vviews.py @@ -323,20 +323,6 @@ def import_status(request, job_id): }) -@require_GET -def login_page(request): - ''' authentication ''' - if request.user.is_authenticated: - return redirect('/') - # send user to the login page - data = { - 'title': 'Login', - 'login_form': forms.LoginForm(), - 'register_form': forms.RegisterForm(), - } - return TemplateResponse(request, 'login.html', data) - - @require_GET def about_page(request): ''' more information about the instance ''' From 05b4cb59b0b28d92ded07e6d34a62abc2fd35131 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Tue, 12 Jan 2021 08:19:08 -0800 Subject: [PATCH 02/34] Adds registration view --- bookwyrm/templates/discover.html | 2 +- bookwyrm/templates/invite.html | 2 +- bookwyrm/templates/layout.html | 4 +-- bookwyrm/templates/login.html | 2 +- bookwyrm/urls.py | 5 +-- bookwyrm/view_actions.py | 51 -------------------------- bookwyrm/views/__init__.py | 2 +- bookwyrm/views/authentication.py | 61 ++++++++++++++++++++++++++++++-- 8 files changed, 68 insertions(+), 61 deletions(-) diff --git a/bookwyrm/templates/discover.html b/bookwyrm/templates/discover.html index 79e31f56..2ff091f0 100644 --- a/bookwyrm/templates/discover.html +++ b/bookwyrm/templates/discover.html @@ -16,7 +16,7 @@
{% if site.allow_registration %}

Join {{ site.name }}

- + {% include 'snippets/register_form.html' %} {% else %} diff --git a/bookwyrm/templates/invite.html b/bookwyrm/templates/invite.html index 458ce3df..3345424c 100644 --- a/bookwyrm/templates/invite.html +++ b/bookwyrm/templates/invite.html @@ -7,7 +7,7 @@ {% if valid %}

Create an Account

-
+ {% include 'snippets/register_form.html' %}
diff --git a/bookwyrm/templates/layout.html b/bookwyrm/templates/layout.html index fe448585..edd43f97 100644 --- a/bookwyrm/templates/layout.html +++ b/bookwyrm/templates/layout.html @@ -122,10 +122,10 @@
{% else %}
- {% if request.path != '/login' and request.path != '/login/' and request.path != '/user-login' %} + {% if request.path != '/login' and request.path != '/login/' %}
-
+ {% csrf_token %}
diff --git a/bookwyrm/templates/login.html b/bookwyrm/templates/login.html index 87a97f3b..68342210 100644 --- a/bookwyrm/templates/login.html +++ b/bookwyrm/templates/login.html @@ -38,7 +38,7 @@
{% if site.allow_registration %}

Create an Account

- + {% include 'snippets/register_form.html' %} {% else %} diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index ce0e26b7..209dac01 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -42,8 +42,10 @@ urlpatterns = [ # TODO: re_path(r'^.well-known/host-meta/?$', incoming.host_meta), # TODO: robots.txt - # ui vviews + # authentication re_path(r'^login/?$', views.LoginView.as_view()), + re_path(r'^register/?$', views.RegisterView.as_view()), + re_path(r'^about/?$', vviews.about_page), re_path(r'^password-reset/?$', vviews.password_reset_request), re_path(r'^password-reset/(?P[A-Za-z0-9]+)/?$', vviews.password_reset), @@ -91,7 +93,6 @@ urlpatterns = [ # internal action endpoints re_path(r'^logout/?$', actions.user_logout), - re_path(r'^user-register/?$', actions.register), re_path(r'^reset-password-request/?$', actions.password_reset_request), re_path(r'^reset-password/?$', actions.password_reset), re_path(r'^change-password/?$', actions.password_change), diff --git a/bookwyrm/view_actions.py b/bookwyrm/view_actions.py index 249e6270..d87798f0 100644 --- a/bookwyrm/view_actions.py +++ b/bookwyrm/view_actions.py @@ -25,57 +25,6 @@ from bookwyrm.settings import DOMAIN from bookwyrm.vviews import get_user_from_username, get_edition -@require_POST -def register(request): - ''' join the server ''' - if not models.SiteSettings.get().allow_registration: - invite_code = request.POST.get('invite_code') - - if not invite_code: - raise PermissionDenied - - invite = get_object_or_404(models.SiteInvite, code=invite_code) - if not invite.valid(): - raise PermissionDenied - else: - invite = None - - form = forms.RegisterForm(request.POST) - errors = False - if not form.is_valid(): - errors = True - - localname = form.data['localname'].strip() - email = form.data['email'] - password = form.data['password'] - - # check localname and email uniqueness - if models.User.objects.filter(localname=localname).first(): - form.errors['localname'] = ['User with this username already exists'] - errors = True - - if errors: - data = { - 'login_form': forms.LoginForm(), - 'register_form': form, - 'invite': invite, - 'valid': invite.valid() if invite else True, - } - if invite: - return TemplateResponse(request, 'invite.html', data) - return TemplateResponse(request, 'login.html', data) - - username = '%s@%s' % (localname, DOMAIN) - user = models.User.objects.create_user( - username, email, password, localname=localname, local=True) - if invite: - invite.times_used += 1 - invite.save() - - login(request, user) - return redirect('/') - - @login_required @require_GET def user_logout(request): diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 0a5d9900..7a92fa4c 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -1,2 +1,2 @@ ''' make sure all our nice views are available ''' -from .authentication import LoginView +from .authentication import LoginView, RegisterView diff --git a/bookwyrm/views/authentication.py b/bookwyrm/views/authentication.py index b789e9cf..8c7d21d1 100644 --- a/bookwyrm/views/authentication.py +++ b/bookwyrm/views/authentication.py @@ -1,17 +1,20 @@ ''' class views for login/register/password management views ''' from django.contrib.auth import authenticate, login -from django.shortcuts import redirect +from django.core.exceptions import PermissionDenied +from django.shortcuts import get_object_or_404, redirect from django.template.response import TemplateResponse from django.utils import timezone from django.views import View -from bookwyrm import forms +from bookwyrm import forms, models from bookwyrm.settings import DOMAIN +# pylint: disable= no-self-use class LoginView(View): ''' authenticate an existing user ''' def get(self, request): + ''' login page ''' if request.user.is_authenticated: return redirect('/') # send user to the login page @@ -23,6 +26,7 @@ class LoginView(View): return TemplateResponse(request, 'login.html', data) def post(self, request): + ''' authentication action ''' login_form = forms.LoginForm(request.POST) localname = login_form.data['localname'] @@ -43,3 +47,56 @@ class LoginView(View): 'register_form': register_form } return TemplateResponse(request, 'login.html', data) + + +class RegisterView(View): + ''' register a user ''' + def post(self, request): + ''' join the server ''' + if not models.SiteSettings.get().allow_registration: + invite_code = request.POST.get('invite_code') + + if not invite_code: + raise PermissionDenied + + invite = get_object_or_404(models.SiteInvite, code=invite_code) + if not invite.valid(): + raise PermissionDenied + else: + invite = None + + form = forms.RegisterForm(request.POST) + errors = False + if not form.is_valid(): + errors = True + + localname = form.data['localname'].strip() + email = form.data['email'] + password = form.data['password'] + + # check localname and email uniqueness + if models.User.objects.filter(localname=localname).first(): + form.errors['localname'] = [ + 'User with this username already exists'] + errors = True + + if errors: + data = { + 'login_form': forms.LoginForm(), + 'register_form': form, + 'invite': invite, + 'valid': invite.valid() if invite else True, + } + if invite: + return TemplateResponse(request, 'invite.html', data) + return TemplateResponse(request, 'login.html', data) + + username = '%s@%s' % (localname, DOMAIN) + user = models.User.objects.create_user( + username, email, password, localname=localname, local=True) + if invite: + invite.times_used += 1 + invite.save() + + login(request, user) + return redirect('/') From 00a67f1b99fda1ab4e603b174d3a1b21275f90e7 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Tue, 12 Jan 2021 08:48:31 -0800 Subject: [PATCH 03/34] Password reset and change password flows --- bookwyrm/templates/password_reset.html | 3 +- .../templates/password_reset_request.html | 2 +- bookwyrm/urls.py | 17 ++- bookwyrm/view_actions.py | 76 +------------ bookwyrm/views/__init__.py | 3 +- bookwyrm/views/authentication.py | 19 +++- bookwyrm/views/password.py | 102 ++++++++++++++++++ bookwyrm/vviews.py | 8 -- 8 files changed, 130 insertions(+), 100 deletions(-) create mode 100644 bookwyrm/views/password.py diff --git a/bookwyrm/templates/password_reset.html b/bookwyrm/templates/password_reset.html index 99d114e4..e8da6562 100644 --- a/bookwyrm/templates/password_reset.html +++ b/bookwyrm/templates/password_reset.html @@ -8,9 +8,8 @@ {% for error in errors %}

{{ error }}

{% endfor %} -
+ {% csrf_token %} -
diff --git a/bookwyrm/templates/password_reset_request.html b/bookwyrm/templates/password_reset_request.html index 2c15b189..b491a6ac 100644 --- a/bookwyrm/templates/password_reset_request.html +++ b/bookwyrm/templates/password_reset_request.html @@ -7,7 +7,7 @@

Reset Password

{% if message %}

{{ message }}

{% endif %}

A link to reset your password will be sent to your email address

- + {% csrf_token %}
diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index 209dac01..d93570f6 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -43,12 +43,16 @@ urlpatterns = [ # TODO: robots.txt # authentication - re_path(r'^login/?$', views.LoginView.as_view()), - re_path(r'^register/?$', views.RegisterView.as_view()), + re_path(r'^login/?$', views.Login.as_view()), + re_path(r'^register/?$', views.Register.as_view()), + re_path(r'^logout/?$', views.Logout.as_view()), + re_path(r'^password-reset/?$', views.PasswordResetRequest.as_view()), + re_path(r'^password-reset/(?P[A-Za-z0-9]+)/?$', + views.PasswordReset.as_view()), + re_path(r'^change-password/?$', views.ChangePassword), + re_path(r'^about/?$', vviews.about_page), - re_path(r'^password-reset/?$', vviews.password_reset_request), - re_path(r'^password-reset/(?P[A-Za-z0-9]+)/?$', vviews.password_reset), re_path(r'^invite/?$', vviews.manage_invites), re_path(r'^invite/(?P[A-Za-z0-9]+)/?$', vviews.invite_page), @@ -92,11 +96,6 @@ urlpatterns = [ re_path(r'^search/?$', vviews.search), # internal action endpoints - re_path(r'^logout/?$', actions.user_logout), - re_path(r'^reset-password-request/?$', actions.password_reset_request), - re_path(r'^reset-password/?$', actions.password_reset), - re_path(r'^change-password/?$', actions.password_change), - re_path(r'^edit-profile/?$', actions.edit_profile), re_path(r'^import-data/?$', actions.import_data), diff --git a/bookwyrm/view_actions.py b/bookwyrm/view_actions.py index d87798f0..7977498b 100644 --- a/bookwyrm/view_actions.py +++ b/bookwyrm/view_actions.py @@ -6,95 +6,21 @@ from PIL import Image import dateutil.parser from dateutil.parser import ParserError -from django.contrib.auth import authenticate, login, logout from django.contrib.auth.decorators import login_required, permission_required -from django.core.exceptions import PermissionDenied from django.core.files.base import ContentFile from django.db import transaction from django.http import HttpResponseBadRequest, HttpResponseNotFound from django.shortcuts import get_object_or_404, redirect from django.template.response import TemplateResponse from django.utils import timezone -from django.views.decorators.http import require_GET, require_POST +from django.views.decorators.http import require_POST from bookwyrm import forms, models, outgoing, goodreads_import from bookwyrm.connectors import connector_manager from bookwyrm.broadcast import broadcast -from bookwyrm.emailing import password_reset_email -from bookwyrm.settings import DOMAIN from bookwyrm.vviews import get_user_from_username, get_edition -@login_required -@require_GET -def user_logout(request): - ''' done with this place! outa here! ''' - logout(request) - return redirect('/') - - -@require_POST -def password_reset_request(request): - ''' create a password reset token ''' - email = request.POST.get('email') - try: - user = models.User.objects.get(email=email) - except models.User.DoesNotExist: - return redirect('/password-reset') - - # remove any existing password reset cods for this user - models.PasswordReset.objects.filter(user=user).all().delete() - - # create a new reset code - code = models.PasswordReset.objects.create(user=user) - password_reset_email(code) - data = {'message': 'Password reset link sent to %s' % email} - return TemplateResponse(request, 'password_reset_request.html', data) - - -@require_POST -def password_reset(request): - ''' allow a user to change their password through an emailed token ''' - try: - reset_code = models.PasswordReset.objects.get( - code=request.POST.get('reset-code') - ) - except models.PasswordReset.DoesNotExist: - data = {'errors': ['Invalid password reset link']} - return TemplateResponse(request, 'password_reset.html', data) - - user = reset_code.user - - new_password = request.POST.get('password') - confirm_password = request.POST.get('confirm-password') - - if new_password != confirm_password: - data = {'errors': ['Passwords do not match']} - return TemplateResponse(request, 'password_reset.html', data) - - user.set_password(new_password) - user.save() - login(request, user) - reset_code.delete() - return redirect('/') - - -@login_required -@require_POST -def password_change(request): - ''' allow a user to change their password ''' - new_password = request.POST.get('password') - confirm_password = request.POST.get('confirm-password') - - if new_password != confirm_password: - return redirect('/user-edit') - - request.user.set_password(new_password) - request.user.save() - login(request, request.user) - return redirect('/user/%s' % request.user.localname) - - @login_required @require_POST def edit_profile(request): diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 7a92fa4c..0adf771f 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -1,2 +1,3 @@ ''' make sure all our nice views are available ''' -from .authentication import LoginView, RegisterView +from .authentication import Login, Register, Logout +from .password import PasswordResetRequest, PasswordReset, ChangePassword diff --git a/bookwyrm/views/authentication.py b/bookwyrm/views/authentication.py index 8c7d21d1..cc5ce625 100644 --- a/bookwyrm/views/authentication.py +++ b/bookwyrm/views/authentication.py @@ -1,9 +1,11 @@ -''' class views for login/register/password management views ''' -from django.contrib.auth import authenticate, login +''' class views for login/register views ''' +from django.contrib.auth import authenticate, login, logout +from django.contrib.auth.decorators import login_required from django.core.exceptions import PermissionDenied from django.shortcuts import get_object_or_404, redirect from django.template.response import TemplateResponse from django.utils import timezone +from django.utils.decorators import method_decorator from django.views import View from bookwyrm import forms, models @@ -11,7 +13,7 @@ from bookwyrm.settings import DOMAIN # pylint: disable= no-self-use -class LoginView(View): +class Login(View): ''' authenticate an existing user ''' def get(self, request): ''' login page ''' @@ -49,7 +51,7 @@ class LoginView(View): return TemplateResponse(request, 'login.html', data) -class RegisterView(View): +class Register(View): ''' register a user ''' def post(self, request): ''' join the server ''' @@ -100,3 +102,12 @@ class RegisterView(View): login(request, user) return redirect('/') + + +@method_decorator(login_required, name='dispatch') +class Logout(View): + ''' log out ''' + def get(self, request): + ''' done with this place! outa here! ''' + logout(request) + return redirect('/') diff --git a/bookwyrm/views/password.py b/bookwyrm/views/password.py new file mode 100644 index 00000000..85c44d11 --- /dev/null +++ b/bookwyrm/views/password.py @@ -0,0 +1,102 @@ +''' class views for password management ''' +from django.contrib.auth import login +from django.contrib.auth.decorators import login_required +from django.core.exceptions import PermissionDenied +from django.shortcuts import redirect +from django.template.response import TemplateResponse +from django.utils.decorators import method_decorator +from django.views import View + +from bookwyrm import models +from bookwyrm.emailing import password_reset_email + + +# pylint: disable= no-self-use +class PasswordResetRequest(View): + ''' forgot password flow ''' + def get(self, request): + ''' password reset page ''' + return TemplateResponse( + request, + 'password_reset_request.html', + {'title': 'Reset Password'} + ) + + def post(self, request): + ''' create a password reset token ''' + email = request.POST.get('email') + try: + user = models.User.objects.get(email=email) + except models.User.DoesNotExist: + return redirect('/password-reset') + + # remove any existing password reset cods for this user + models.PasswordReset.objects.filter(user=user).all().delete() + + # create a new reset code + code = models.PasswordReset.objects.create(user=user) + password_reset_email(code) + data = {'message': 'Password reset link sent to %s' % email} + return TemplateResponse(request, 'password_reset_request.html', data) + + +class PasswordReset(View): + ''' set new password ''' + def get(self, request, code): + ''' endpoint for sending invites ''' + if request.user.is_authenticated: + return redirect('/') + try: + reset_code = models.PasswordReset.objects.get(code=code) + if not reset_code.valid(): + raise PermissionDenied + except models.PasswordReset.DoesNotExist: + raise PermissionDenied + + return TemplateResponse( + request, + 'password_reset.html', + {'title': 'Reset Password', 'code': reset_code.code} + ) + + def post(self, request, code): + ''' allow a user to change their password through an emailed token ''' + try: + reset_code = models.PasswordReset.objects.get( + code=code + ) + except models.PasswordReset.DoesNotExist: + data = {'errors': ['Invalid password reset link']} + return TemplateResponse(request, 'password_reset.html', data) + + user = reset_code.user + + new_password = request.POST.get('password') + confirm_password = request.POST.get('confirm-password') + + if new_password != confirm_password: + data = {'errors': ['Passwords do not match']} + return TemplateResponse(request, 'password_reset.html', data) + + user.set_password(new_password) + user.save() + login(request, user) + reset_code.delete() + return redirect('/') + + +@method_decorator(login_required, name='dispatch') +class ChangePassword(View): + ''' change password as logged in user ''' + def post(self, request): + ''' allow a user to change their password ''' + new_password = request.POST.get('password') + confirm_password = request.POST.get('confirm-password') + + if new_password != confirm_password: + return redirect('/user-edit') + + request.user.set_password(new_password) + request.user.save() + login(request, request.user) + return redirect('/user/%s' % request.user.localname) diff --git a/bookwyrm/vviews.py b/bookwyrm/vviews.py index ebae3696..66b26615 100644 --- a/bookwyrm/vviews.py +++ b/bookwyrm/vviews.py @@ -332,14 +332,6 @@ def about_page(request): return TemplateResponse(request, 'about.html', data) -@require_GET -def password_reset_request(request): - ''' invite management page ''' - return TemplateResponse( - request, - 'password_reset_request.html', - {'title': 'Reset Password'} - ) @require_GET From a2d7a97dc34c1c56308a64e5c4cac077a929a6ca Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Tue, 12 Jan 2021 09:09:05 -0800 Subject: [PATCH 04/34] Updates tests --- bookwyrm/tests/test_view_actions.py | 230 ---------------- bookwyrm/tests/test_views.py | 39 +-- bookwyrm/tests/views/test_authentication.py | 278 ++++++++++++++++++++ 3 files changed, 280 insertions(+), 267 deletions(-) create mode 100644 bookwyrm/tests/views/test_authentication.py diff --git a/bookwyrm/tests/test_view_actions.py b/bookwyrm/tests/test_view_actions.py index 30549bf2..bf7d37bd 100644 --- a/bookwyrm/tests/test_view_actions.py +++ b/bookwyrm/tests/test_view_actions.py @@ -5,13 +5,11 @@ import dateutil from django.core.exceptions import PermissionDenied from django.contrib.auth.models import Group, Permission from django.contrib.contenttypes.models import ContentType -from django.http.response import Http404 from django.test import TestCase from django.test.client import RequestFactory from django.utils import timezone from bookwyrm import forms, models, view_actions as actions -from bookwyrm.settings import DOMAIN #pylint: disable=too-many-public-methods @@ -51,234 +49,6 @@ class ViewActions(TestCase): self.factory = RequestFactory() - def test_register(self): - ''' create a user ''' - self.assertEqual(models.User.objects.count(), 2) - request = self.factory.post( - 'register/', - { - 'localname': 'nutria-user.user_nutria', - 'password': 'mouseword', - 'email': 'aa@bb.cccc' - }) - with patch('bookwyrm.view_actions.login'): - response = actions.register(request) - self.assertEqual(models.User.objects.count(), 3) - self.assertEqual(response.status_code, 302) - nutria = models.User.objects.last() - self.assertEqual(nutria.username, 'nutria-user.user_nutria@%s' % DOMAIN) - self.assertEqual(nutria.localname, 'nutria-user.user_nutria') - self.assertEqual(nutria.local, True) - - def test_register_trailing_space(self): - ''' django handles this so weirdly ''' - request = self.factory.post( - 'register/', - { - 'localname': 'nutria ', - 'password': 'mouseword', - 'email': 'aa@bb.ccc' - }) - with patch('bookwyrm.view_actions.login'): - response = actions.register(request) - self.assertEqual(models.User.objects.count(), 3) - self.assertEqual(response.status_code, 302) - nutria = models.User.objects.last() - self.assertEqual(nutria.username, 'nutria@%s' % DOMAIN) - self.assertEqual(nutria.localname, 'nutria') - self.assertEqual(nutria.local, True) - - def test_register_invalid_email(self): - ''' gotta have an email ''' - self.assertEqual(models.User.objects.count(), 2) - request = self.factory.post( - 'register/', - { - 'localname': 'nutria', - 'password': 'mouseword', - 'email': 'aa' - }) - response = actions.register(request) - self.assertEqual(models.User.objects.count(), 2) - self.assertEqual(response.template_name, 'login.html') - - def test_register_invalid_username(self): - ''' gotta have an email ''' - self.assertEqual(models.User.objects.count(), 2) - request = self.factory.post( - 'register/', - { - 'localname': 'nut@ria', - 'password': 'mouseword', - 'email': 'aa@bb.ccc' - }) - response = actions.register(request) - self.assertEqual(models.User.objects.count(), 2) - self.assertEqual(response.template_name, 'login.html') - - request = self.factory.post( - 'register/', - { - 'localname': 'nutr ia', - 'password': 'mouseword', - 'email': 'aa@bb.ccc' - }) - response = actions.register(request) - self.assertEqual(models.User.objects.count(), 2) - self.assertEqual(response.template_name, 'login.html') - - request = self.factory.post( - 'register/', - { - 'localname': 'nut@ria', - 'password': 'mouseword', - 'email': 'aa@bb.ccc' - }) - response = actions.register(request) - self.assertEqual(models.User.objects.count(), 2) - self.assertEqual(response.template_name, 'login.html') - - - def test_register_closed_instance(self): - ''' you can't just register ''' - self.settings.allow_registration = False - self.settings.save() - request = self.factory.post( - 'register/', - { - 'localname': 'nutria ', - 'password': 'mouseword', - 'email': 'aa@bb.ccc' - }) - with self.assertRaises(PermissionDenied): - actions.register(request) - - def test_register_invite(self): - ''' you can't just register ''' - self.settings.allow_registration = False - self.settings.save() - models.SiteInvite.objects.create( - code='testcode', user=self.local_user, use_limit=1) - self.assertEqual(models.SiteInvite.objects.get().times_used, 0) - - request = self.factory.post( - 'register/', - { - 'localname': 'nutria', - 'password': 'mouseword', - 'email': 'aa@bb.ccc', - 'invite_code': 'testcode' - }) - with patch('bookwyrm.view_actions.login'): - response = actions.register(request) - self.assertEqual(models.User.objects.count(), 3) - self.assertEqual(response.status_code, 302) - self.assertEqual(models.SiteInvite.objects.get().times_used, 1) - - # invite already used to max capacity - request = self.factory.post( - 'register/', - { - 'localname': 'nutria2', - 'password': 'mouseword', - 'email': 'aa@bb.ccc', - 'invite_code': 'testcode' - }) - with self.assertRaises(PermissionDenied): - response = actions.register(request) - self.assertEqual(models.User.objects.count(), 3) - - # bad invite code - request = self.factory.post( - 'register/', - { - 'localname': 'nutria3', - 'password': 'mouseword', - 'email': 'aa@bb.ccc', - 'invite_code': 'dkfkdjgdfkjgkdfj' - }) - with self.assertRaises(Http404): - response = actions.register(request) - self.assertEqual(models.User.objects.count(), 3) - - - def test_password_reset_request(self): - ''' send 'em an email ''' - request = self.factory.post('', {'email': 'aa@bb.ccc'}) - resp = actions.password_reset_request(request) - self.assertEqual(resp.status_code, 302) - - request = self.factory.post( - '', {'email': 'mouse@mouse.com'}) - with patch('bookwyrm.emailing.send_email.delay'): - resp = actions.password_reset_request(request) - self.assertEqual(resp.template_name, 'password_reset_request.html') - - self.assertEqual( - models.PasswordReset.objects.get().user, self.local_user) - - def test_password_reset(self): - ''' reset from code ''' - code = models.PasswordReset.objects.create(user=self.local_user) - request = self.factory.post('', { - 'reset-code': code.code, - 'password': 'hi', - 'confirm-password': 'hi' - }) - with patch('bookwyrm.view_actions.login'): - resp = actions.password_reset(request) - self.assertEqual(resp.status_code, 302) - self.assertFalse(models.PasswordReset.objects.exists()) - - def test_password_reset_wrong_code(self): - ''' reset from code ''' - models.PasswordReset.objects.create(user=self.local_user) - request = self.factory.post('', { - 'reset-code': 'jhgdkfjgdf', - 'password': 'hi', - 'confirm-password': 'hi' - }) - resp = actions.password_reset(request) - self.assertEqual(resp.template_name, 'password_reset.html') - self.assertTrue(models.PasswordReset.objects.exists()) - - def test_password_reset_mismatch(self): - ''' reset from code ''' - code = models.PasswordReset.objects.create(user=self.local_user) - request = self.factory.post('', { - 'reset-code': code.code, - 'password': 'hi', - 'confirm-password': 'hihi' - }) - resp = actions.password_reset(request) - self.assertEqual(resp.template_name, 'password_reset.html') - self.assertTrue(models.PasswordReset.objects.exists()) - - - def test_password_change(self): - ''' change password ''' - password_hash = self.local_user.password - request = self.factory.post('', { - 'password': 'hi', - 'confirm-password': 'hi' - }) - request.user = self.local_user - with patch('bookwyrm.view_actions.login'): - actions.password_change(request) - self.assertNotEqual(self.local_user.password, password_hash) - - def test_password_change_mismatch(self): - ''' change password ''' - password_hash = self.local_user.password - request = self.factory.post('', { - 'password': 'hi', - 'confirm-password': 'hihi' - }) - request.user = self.local_user - actions.password_change(request) - self.assertEqual(self.local_user.password, password_hash) - - def test_edit_user(self): ''' use a form to update a user ''' form = forms.EditUserForm(instance=self.local_user) diff --git a/bookwyrm/tests/test_views.py b/bookwyrm/tests/test_views.py index eee69d06..6cbd67d8 100644 --- a/bookwyrm/tests/test_views.py +++ b/bookwyrm/tests/test_views.py @@ -8,7 +8,8 @@ from django.template.response import TemplateResponse from django.test import TestCase from django.test.client import RequestFactory -from bookwyrm import models, views +from bookwyrm import models +from bookwyrm import vviews as views from bookwyrm.activitypub import ActivitypubResponse from bookwyrm.connectors import abstract_connector from bookwyrm.settings import DOMAIN, USER_AGENT @@ -263,21 +264,6 @@ class Views(TestCase): self.assertEqual(result.status_code, 200) - def test_login_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - request = self.factory.get('') - request.user = AnonymousUser - result = views.login_page(request) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'login.html') - self.assertEqual(result.status_code, 200) - - request.user = self.local_user - result = views.login_page(request) - self.assertEqual(result.url, '/') - self.assertEqual(result.status_code, 302) - - def test_about_page(self): ''' there are so many views, this just makes sure it LOADS ''' request = self.factory.get('') @@ -288,27 +274,6 @@ class Views(TestCase): self.assertEqual(result.status_code, 200) - def test_password_reset_request(self): - ''' there are so many views, this just makes sure it LOADS ''' - request = self.factory.get('') - request.user = self.local_user - result = views.password_reset_request(request) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'password_reset_request.html') - self.assertEqual(result.status_code, 200) - - - def test_password_reset(self): - ''' there are so many views, this just makes sure it LOADS ''' - code = models.PasswordReset.objects.create(user=self.local_user) - request = self.factory.get('') - request.user = AnonymousUser - result = views.password_reset(request, code.code) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'password_reset.html') - self.assertEqual(result.status_code, 200) - - def test_invite_page(self): ''' there are so many views, this just makes sure it LOADS ''' models.SiteInvite.objects.create(code='hi', user=self.local_user) diff --git a/bookwyrm/tests/views/test_authentication.py b/bookwyrm/tests/views/test_authentication.py new file mode 100644 index 00000000..88a4f6b7 --- /dev/null +++ b/bookwyrm/tests/views/test_authentication.py @@ -0,0 +1,278 @@ +''' test for app action functionality ''' +from unittest.mock import patch + +from django.contrib.auth.models import AnonymousUser +from django.core.exceptions import PermissionDenied +from django.http.response import Http404 +from django.template.response import TemplateResponse +from django.test import TestCase + +from bookwyrm import models, views +from bookwyrm.settings import DOMAIN + + +# pylint: disable=too-many-public-methods +class AuthenticationViews(TestCase): + ''' login and password management ''' + def test_login_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + request = self.factory.get('') + request.user = AnonymousUser + result = views.Login.get(request) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'login.html') + self.assertEqual(result.status_code, 200) + + request.user = self.local_user + result = views.Login.get(request) + self.assertEqual(result.url, '/') + self.assertEqual(result.status_code, 302) + + + def test_password_reset_request(self): + ''' there are so many views, this just makes sure it LOADS ''' + request = self.factory.get('') + request.user = self.local_user + result = views.PasswordResetRequest.get(request) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'password_reset_request.html') + self.assertEqual(result.status_code, 200) + + + def test_password_reset_request_post(self): + ''' send 'em an email ''' + request = self.factory.post('', {'email': 'aa@bb.ccc'}) + resp = views.PasswordReset.post_request(request) + self.assertEqual(resp.status_code, 302) + + request = self.factory.post( + '', {'email': 'mouse@mouse.com'}) + with patch('bookwyrm.emailing.send_email.delay'): + resp = views.PasswordReset.post_request(request) + self.assertEqual(resp.template_name, 'password_reset_request.html') + + self.assertEqual( + models.PasswordReset.objects.get().user, self.local_user) + + def test_password_reset(self): + ''' there are so many views, this just makes sure it LOADS ''' + code = models.PasswordReset.objects.create(user=self.local_user) + request = self.factory.get('') + request.user = AnonymousUser + result = views.PasswordReset.get(request, code.code) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'password_reset.html') + self.assertEqual(result.status_code, 200) + + + def test_password_reset_post(self): + ''' reset from code ''' + code = models.PasswordReset.objects.create(user=self.local_user) + request = self.factory.post('', { + 'reset-code': code.code, + 'password': 'hi', + 'confirm-password': 'hi' + }) + with patch('bookwyrm.views.Login.get'): + resp = views.PasswordReset.post(request) + self.assertEqual(resp.status_code, 302) + self.assertFalse(models.PasswordReset.objects.exists()) + + def test_password_reset_wrong_code(self): + ''' reset from code ''' + models.PasswordReset.objects.create(user=self.local_user) + request = self.factory.post('', { + 'reset-code': 'jhgdkfjgdf', + 'password': 'hi', + 'confirm-password': 'hi' + }) + resp = views.PasswordReset.post(request) + self.assertEqual(resp.template_name, 'password_reset.html') + self.assertTrue(models.PasswordReset.objects.exists()) + + def test_password_reset_mismatch(self): + ''' reset from code ''' + code = models.PasswordReset.objects.create(user=self.local_user) + request = self.factory.post('', { + 'reset-code': code.code, + 'password': 'hi', + 'confirm-password': 'hihi' + }) + resp = views.PasswordReset.post(request) + self.assertEqual(resp.template_name, 'password_reset.html') + self.assertTrue(models.PasswordReset.objects.exists()) + + + def test_register(self): + ''' create a user ''' + self.assertEqual(models.User.objects.count(), 2) + request = self.factory.post( + 'register/', + { + 'localname': 'nutria-user.user_nutria', + 'password': 'mouseword', + 'email': 'aa@bb.cccc' + }) + with patch('bookwyrm.views.Login.get'): + response = views.Register.post(request) + self.assertEqual(models.User.objects.count(), 3) + self.assertEqual(response.status_code, 302) + nutria = models.User.objects.last() + self.assertEqual(nutria.username, 'nutria-user.user_nutria@%s' % DOMAIN) + self.assertEqual(nutria.localname, 'nutria-user.user_nutria') + self.assertEqual(nutria.local, True) + + def test_register_trailing_space(self): + ''' django handles this so weirdly ''' + request = self.factory.post( + 'register/', + { + 'localname': 'nutria ', + 'password': 'mouseword', + 'email': 'aa@bb.ccc' + }) + with patch('bookwyrm.views.Login.get'): + response = views.Register.post(request) + self.assertEqual(models.User.objects.count(), 3) + self.assertEqual(response.status_code, 302) + nutria = models.User.objects.last() + self.assertEqual(nutria.username, 'nutria@%s' % DOMAIN) + self.assertEqual(nutria.localname, 'nutria') + self.assertEqual(nutria.local, True) + + def test_register_invalid_email(self): + ''' gotta have an email ''' + self.assertEqual(models.User.objects.count(), 2) + request = self.factory.post( + 'register/', + { + 'localname': 'nutria', + 'password': 'mouseword', + 'email': 'aa' + }) + response = views.Register.post(request) + self.assertEqual(models.User.objects.count(), 2) + self.assertEqual(response.template_name, 'login.html') + + def test_register_invalid_username(self): + ''' gotta have an email ''' + self.assertEqual(models.User.objects.count(), 2) + request = self.factory.post( + 'register/', + { + 'localname': 'nut@ria', + 'password': 'mouseword', + 'email': 'aa@bb.ccc' + }) + response = views.Register.post(request) + self.assertEqual(models.User.objects.count(), 2) + self.assertEqual(response.template_name, 'login.html') + + request = self.factory.post( + 'register/', + { + 'localname': 'nutr ia', + 'password': 'mouseword', + 'email': 'aa@bb.ccc' + }) + response = views.Register.post(request) + self.assertEqual(models.User.objects.count(), 2) + self.assertEqual(response.template_name, 'login.html') + + request = self.factory.post( + 'register/', + { + 'localname': 'nut@ria', + 'password': 'mouseword', + 'email': 'aa@bb.ccc' + }) + response = views.Register.post(request) + self.assertEqual(models.User.objects.count(), 2) + self.assertEqual(response.template_name, 'login.html') + + + def test_register_closed_instance(self): + ''' you can't just register ''' + self.settings.allow_registration = False + self.settings.save() + request = self.factory.post( + 'register/', + { + 'localname': 'nutria ', + 'password': 'mouseword', + 'email': 'aa@bb.ccc' + }) + with self.assertRaises(PermissionDenied): + views.Register.post(request) + + def test_register_invite(self): + ''' you can't just register ''' + self.settings.allow_registration = False + self.settings.save() + models.SiteInvite.objects.create( + code='testcode', user=self.local_user, use_limit=1) + self.assertEqual(models.SiteInvite.objects.get().times_used, 0) + + request = self.factory.post( + 'register/', + { + 'localname': 'nutria', + 'password': 'mouseword', + 'email': 'aa@bb.ccc', + 'invite_code': 'testcode' + }) + with patch('bookwyrm.views.Login.get'): + response = views.Register.post(request) + self.assertEqual(models.User.objects.count(), 3) + self.assertEqual(response.status_code, 302) + self.assertEqual(models.SiteInvite.objects.get().times_used, 1) + + # invite already used to max capacity + request = self.factory.post( + 'register/', + { + 'localname': 'nutria2', + 'password': 'mouseword', + 'email': 'aa@bb.ccc', + 'invite_code': 'testcode' + }) + with self.assertRaises(PermissionDenied): + response = views.Register.post(request) + self.assertEqual(models.User.objects.count(), 3) + + # bad invite code + request = self.factory.post( + 'register/', + { + 'localname': 'nutria3', + 'password': 'mouseword', + 'email': 'aa@bb.ccc', + 'invite_code': 'dkfkdjgdfkjgkdfj' + }) + with self.assertRaises(Http404): + response = views.Register.post(request) + self.assertEqual(models.User.objects.count(), 3) + + + def test_password_change(self): + ''' change password ''' + password_hash = self.local_user.password + request = self.factory.post('', { + 'password': 'hi', + 'confirm-password': 'hi' + }) + request.user = self.local_user + with patch('bookwyrm.views.Login.get'): + views.ChangePassword.post(request) + self.assertNotEqual(self.local_user.password, password_hash) + + def test_password_change_mismatch(self): + ''' change password ''' + password_hash = self.local_user.password + request = self.factory.post('', { + 'password': 'hi', + 'confirm-password': 'hihi' + }) + request.user = self.local_user + views.ChangePassword.post(request) + self.assertEqual(self.local_user.password, password_hash) From 65fa08633f30d3712666234a4994a1380fdaf484 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Tue, 12 Jan 2021 09:53:04 -0800 Subject: [PATCH 05/34] Fixes authentication tests --- bookwyrm/tests/views/test_authentication.py | 116 ++++++++++++-------- bookwyrm/views/authentication.py | 2 +- 2 files changed, 71 insertions(+), 47 deletions(-) diff --git a/bookwyrm/tests/views/test_authentication.py b/bookwyrm/tests/views/test_authentication.py index 88a4f6b7..b0d09983 100644 --- a/bookwyrm/tests/views/test_authentication.py +++ b/bookwyrm/tests/views/test_authentication.py @@ -6,6 +6,7 @@ from django.core.exceptions import PermissionDenied from django.http.response import Http404 from django.template.response import TemplateResponse from django.test import TestCase +from django.test.client import RequestFactory from bookwyrm import models, views from bookwyrm.settings import DOMAIN @@ -14,26 +15,40 @@ from bookwyrm.settings import DOMAIN # pylint: disable=too-many-public-methods class AuthenticationViews(TestCase): ''' login and password management ''' - def test_login_page(self): + def setUp(self): + ''' we need basic test data and mocks ''' + self.factory = RequestFactory() + self.local_user = models.User.objects.create_user( + 'mouse@local.com', 'mouse@mouse.com', 'password', + local=True, localname='mouse') + self.anonymous_user = AnonymousUser + self.anonymous_user.is_authenticated = False + self.settings = models.SiteSettings.objects.create(id=1) + + def test_login_get(self): ''' there are so many views, this just makes sure it LOADS ''' + login = views.Login.as_view() request = self.factory.get('') - request.user = AnonymousUser - result = views.Login.get(request) + request.user = self.anonymous_user + + result = login(request) self.assertIsInstance(result, TemplateResponse) self.assertEqual(result.template_name, 'login.html') self.assertEqual(result.status_code, 200) request.user = self.local_user - result = views.Login.get(request) + result = login(request) self.assertEqual(result.url, '/') self.assertEqual(result.status_code, 302) def test_password_reset_request(self): ''' there are so many views, this just makes sure it LOADS ''' + view = views.PasswordResetRequest.as_view() request = self.factory.get('') request.user = self.local_user - result = views.PasswordResetRequest.get(request) + + result = view(request) self.assertIsInstance(result, TemplateResponse) self.assertEqual(result.template_name, 'password_reset_request.html') self.assertEqual(result.status_code, 200) @@ -42,13 +57,13 @@ class AuthenticationViews(TestCase): def test_password_reset_request_post(self): ''' send 'em an email ''' request = self.factory.post('', {'email': 'aa@bb.ccc'}) - resp = views.PasswordReset.post_request(request) + view = views.PasswordResetRequest.as_view() + resp = view(request) self.assertEqual(resp.status_code, 302) - request = self.factory.post( - '', {'email': 'mouse@mouse.com'}) + request = self.factory.post('', {'email': 'mouse@mouse.com'}) with patch('bookwyrm.emailing.send_email.delay'): - resp = views.PasswordReset.post_request(request) + resp = view(request) self.assertEqual(resp.template_name, 'password_reset_request.html') self.assertEqual( @@ -56,10 +71,11 @@ class AuthenticationViews(TestCase): def test_password_reset(self): ''' there are so many views, this just makes sure it LOADS ''' + view = views.PasswordReset.as_view() code = models.PasswordReset.objects.create(user=self.local_user) request = self.factory.get('') - request.user = AnonymousUser - result = views.PasswordReset.get(request, code.code) + request.user = self.anonymous_user + result = view(request, code.code) self.assertIsInstance(result, TemplateResponse) self.assertEqual(result.template_name, 'password_reset.html') self.assertEqual(result.status_code, 200) @@ -67,45 +83,46 @@ class AuthenticationViews(TestCase): def test_password_reset_post(self): ''' reset from code ''' + view = views.PasswordReset.as_view() code = models.PasswordReset.objects.create(user=self.local_user) request = self.factory.post('', { - 'reset-code': code.code, 'password': 'hi', 'confirm-password': 'hi' }) - with patch('bookwyrm.views.Login.get'): - resp = views.PasswordReset.post(request) + with patch('bookwyrm.views.password.login'): + resp = view(request, code.code) self.assertEqual(resp.status_code, 302) self.assertFalse(models.PasswordReset.objects.exists()) def test_password_reset_wrong_code(self): ''' reset from code ''' + view = views.PasswordReset.as_view() models.PasswordReset.objects.create(user=self.local_user) request = self.factory.post('', { - 'reset-code': 'jhgdkfjgdf', 'password': 'hi', 'confirm-password': 'hi' }) - resp = views.PasswordReset.post(request) + resp = view(request, 'jhgdkfjgdf') self.assertEqual(resp.template_name, 'password_reset.html') self.assertTrue(models.PasswordReset.objects.exists()) def test_password_reset_mismatch(self): ''' reset from code ''' + view = views.PasswordReset.as_view() code = models.PasswordReset.objects.create(user=self.local_user) request = self.factory.post('', { - 'reset-code': code.code, 'password': 'hi', 'confirm-password': 'hihi' }) - resp = views.PasswordReset.post(request) + resp = view(request, code.code) self.assertEqual(resp.template_name, 'password_reset.html') self.assertTrue(models.PasswordReset.objects.exists()) def test_register(self): ''' create a user ''' - self.assertEqual(models.User.objects.count(), 2) + view = views.Register.as_view() + self.assertEqual(models.User.objects.count(), 1) request = self.factory.post( 'register/', { @@ -113,9 +130,9 @@ class AuthenticationViews(TestCase): 'password': 'mouseword', 'email': 'aa@bb.cccc' }) - with patch('bookwyrm.views.Login.get'): - response = views.Register.post(request) - self.assertEqual(models.User.objects.count(), 3) + with patch('bookwyrm.views.authentication.login'): + response = view(request) + self.assertEqual(models.User.objects.count(), 2) self.assertEqual(response.status_code, 302) nutria = models.User.objects.last() self.assertEqual(nutria.username, 'nutria-user.user_nutria@%s' % DOMAIN) @@ -124,6 +141,7 @@ class AuthenticationViews(TestCase): def test_register_trailing_space(self): ''' django handles this so weirdly ''' + view = views.Register.as_view() request = self.factory.post( 'register/', { @@ -131,9 +149,9 @@ class AuthenticationViews(TestCase): 'password': 'mouseword', 'email': 'aa@bb.ccc' }) - with patch('bookwyrm.views.Login.get'): - response = views.Register.post(request) - self.assertEqual(models.User.objects.count(), 3) + with patch('bookwyrm.views.authentication.login'): + response = view(request) + self.assertEqual(models.User.objects.count(), 2) self.assertEqual(response.status_code, 302) nutria = models.User.objects.last() self.assertEqual(nutria.username, 'nutria@%s' % DOMAIN) @@ -142,7 +160,8 @@ class AuthenticationViews(TestCase): def test_register_invalid_email(self): ''' gotta have an email ''' - self.assertEqual(models.User.objects.count(), 2) + view = views.Register.as_view() + self.assertEqual(models.User.objects.count(), 1) request = self.factory.post( 'register/', { @@ -150,13 +169,14 @@ class AuthenticationViews(TestCase): 'password': 'mouseword', 'email': 'aa' }) - response = views.Register.post(request) - self.assertEqual(models.User.objects.count(), 2) + response = view(request) + self.assertEqual(models.User.objects.count(), 1) self.assertEqual(response.template_name, 'login.html') def test_register_invalid_username(self): ''' gotta have an email ''' - self.assertEqual(models.User.objects.count(), 2) + view = views.Register.as_view() + self.assertEqual(models.User.objects.count(), 1) request = self.factory.post( 'register/', { @@ -164,8 +184,8 @@ class AuthenticationViews(TestCase): 'password': 'mouseword', 'email': 'aa@bb.ccc' }) - response = views.Register.post(request) - self.assertEqual(models.User.objects.count(), 2) + response = view(request) + self.assertEqual(models.User.objects.count(), 1) self.assertEqual(response.template_name, 'login.html') request = self.factory.post( @@ -175,8 +195,8 @@ class AuthenticationViews(TestCase): 'password': 'mouseword', 'email': 'aa@bb.ccc' }) - response = views.Register.post(request) - self.assertEqual(models.User.objects.count(), 2) + response = view(request) + self.assertEqual(models.User.objects.count(), 1) self.assertEqual(response.template_name, 'login.html') request = self.factory.post( @@ -186,13 +206,14 @@ class AuthenticationViews(TestCase): 'password': 'mouseword', 'email': 'aa@bb.ccc' }) - response = views.Register.post(request) - self.assertEqual(models.User.objects.count(), 2) + response = view(request) + self.assertEqual(models.User.objects.count(), 1) self.assertEqual(response.template_name, 'login.html') def test_register_closed_instance(self): ''' you can't just register ''' + view = views.Register.as_view() self.settings.allow_registration = False self.settings.save() request = self.factory.post( @@ -203,10 +224,11 @@ class AuthenticationViews(TestCase): 'email': 'aa@bb.ccc' }) with self.assertRaises(PermissionDenied): - views.Register.post(request) + view(request) def test_register_invite(self): ''' you can't just register ''' + view = views.Register.as_view() self.settings.allow_registration = False self.settings.save() models.SiteInvite.objects.create( @@ -221,9 +243,9 @@ class AuthenticationViews(TestCase): 'email': 'aa@bb.ccc', 'invite_code': 'testcode' }) - with patch('bookwyrm.views.Login.get'): - response = views.Register.post(request) - self.assertEqual(models.User.objects.count(), 3) + with patch('bookwyrm.views.authentication.login'): + response = view(request) + self.assertEqual(models.User.objects.count(), 2) self.assertEqual(response.status_code, 302) self.assertEqual(models.SiteInvite.objects.get().times_used, 1) @@ -237,8 +259,8 @@ class AuthenticationViews(TestCase): 'invite_code': 'testcode' }) with self.assertRaises(PermissionDenied): - response = views.Register.post(request) - self.assertEqual(models.User.objects.count(), 3) + response = view(request) + self.assertEqual(models.User.objects.count(), 2) # bad invite code request = self.factory.post( @@ -250,29 +272,31 @@ class AuthenticationViews(TestCase): 'invite_code': 'dkfkdjgdfkjgkdfj' }) with self.assertRaises(Http404): - response = views.Register.post(request) - self.assertEqual(models.User.objects.count(), 3) + response = view(request) + self.assertEqual(models.User.objects.count(), 2) def test_password_change(self): ''' change password ''' + view = views.ChangePassword.as_view() password_hash = self.local_user.password request = self.factory.post('', { 'password': 'hi', 'confirm-password': 'hi' }) request.user = self.local_user - with patch('bookwyrm.views.Login.get'): - views.ChangePassword.post(request) + with patch('bookwyrm.views.password.login'): + view(request) self.assertNotEqual(self.local_user.password, password_hash) def test_password_change_mismatch(self): ''' change password ''' + view = views.ChangePassword.as_view() password_hash = self.local_user.password request = self.factory.post('', { 'password': 'hi', 'confirm-password': 'hihi' }) request.user = self.local_user - views.ChangePassword.post(request) + view(request) self.assertEqual(self.local_user.password, password_hash) diff --git a/bookwyrm/views/authentication.py b/bookwyrm/views/authentication.py index cc5ce625..30632bf8 100644 --- a/bookwyrm/views/authentication.py +++ b/bookwyrm/views/authentication.py @@ -19,7 +19,7 @@ class Login(View): ''' login page ''' if request.user.is_authenticated: return redirect('/') - # send user to the login page + # sene user to the login page data = { 'title': 'Login', 'login_form': forms.LoginForm(), From fd6603ee070225caf9318fd716c00ce26d312642 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Tue, 12 Jan 2021 10:19:58 -0800 Subject: [PATCH 06/34] Invite views --- bookwyrm/templates/manage_invites.html | 2 +- bookwyrm/tests/test_views.py | 26 ------------ bookwyrm/tests/views/test_invite.py | 48 +++++++++++++++++++++ bookwyrm/urls.py | 7 ++-- bookwyrm/view_actions.py | 17 -------- bookwyrm/views/__init__.py | 1 + bookwyrm/views/invite.py | 58 ++++++++++++++++++++++++++ bookwyrm/vviews.py | 53 +---------------------- 8 files changed, 112 insertions(+), 100 deletions(-) create mode 100644 bookwyrm/tests/views/test_invite.py create mode 100644 bookwyrm/views/invite.py diff --git a/bookwyrm/templates/manage_invites.html b/bookwyrm/templates/manage_invites.html index 14808490..a29ee5e4 100644 --- a/bookwyrm/templates/manage_invites.html +++ b/bookwyrm/templates/manage_invites.html @@ -27,7 +27,7 @@

Generate New Invite

- + {% csrf_token %}
diff --git a/bookwyrm/tests/test_views.py b/bookwyrm/tests/test_views.py index 6cbd67d8..9729b0f1 100644 --- a/bookwyrm/tests/test_views.py +++ b/bookwyrm/tests/test_views.py @@ -274,32 +274,6 @@ class Views(TestCase): self.assertEqual(result.status_code, 200) - def test_invite_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - models.SiteInvite.objects.create(code='hi', user=self.local_user) - request = self.factory.get('') - request.user = AnonymousUser - # why?? this is annoying. - request.user.is_authenticated = False - with patch('bookwyrm.models.site.SiteInvite.valid') as invite: - invite.return_value = True - result = views.invite_page(request, 'hi') - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'invite.html') - self.assertEqual(result.status_code, 200) - - - def test_manage_invites(self): - ''' there are so many views, this just makes sure it LOADS ''' - request = self.factory.get('') - request.user = self.local_user - request.user.is_superuser = True - result = views.manage_invites(request) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'manage_invites.html') - self.assertEqual(result.status_code, 200) - - def test_notifications_page(self): ''' there are so many views, this just makes sure it LOADS ''' request = self.factory.get('') diff --git a/bookwyrm/tests/views/test_invite.py b/bookwyrm/tests/views/test_invite.py new file mode 100644 index 00000000..57b7a34a --- /dev/null +++ b/bookwyrm/tests/views/test_invite.py @@ -0,0 +1,48 @@ +''' test for app action functionality ''' +from unittest.mock import patch + +from django.contrib.auth.models import AnonymousUser +from django.template.response import TemplateResponse +from django.test import TestCase +from django.test.client import RequestFactory + +from bookwyrm import models +from bookwyrm import views + + +class InviteViews(TestCase): + ''' every response to a get request, html or json ''' + def setUp(self): + ''' we need basic test data and mocks ''' + self.factory = RequestFactory() + self.local_user = models.User.objects.create_user( + 'mouse@local.com', 'mouse@mouse.mouse', 'password', + local=True, localname='mouse') + + + def test_invite_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.Invite.as_view() + models.SiteInvite.objects.create(code='hi', user=self.local_user) + request = self.factory.get('') + request.user = AnonymousUser + # why?? this is annoying. + request.user.is_authenticated = False + with patch('bookwyrm.models.site.SiteInvite.valid') as invite: + invite.return_value = True + result = view(request, 'hi') + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'invite.html') + self.assertEqual(result.status_code, 200) + + + def test_manage_invites(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.ManageInvites.as_view() + request = self.factory.get('') + request.user = self.local_user + request.user.is_superuser = True + result = view(request) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'manage_invites.html') + self.assertEqual(result.status_code, 200) diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index d93570f6..c2e3ef36 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -51,11 +51,11 @@ urlpatterns = [ views.PasswordReset.as_view()), re_path(r'^change-password/?$', views.ChangePassword), + #invites + re_path(r'^invite/?$', views.ManageInvites.as_view()), + re_path(r'^invite/(?P[A-Za-z0-9]+)/?$', views.Invite.as_view()), re_path(r'^about/?$', vviews.about_page), - re_path(r'^invite/?$', vviews.manage_invites), - re_path(r'^invite/(?P[A-Za-z0-9]+)/?$', vviews.invite_page), - path('', vviews.home), re_path(r'^(?Phome|local|federated)/?$', vviews.home_tab), re_path(r'^discover/?$', vviews.discover_page), @@ -141,6 +141,5 @@ urlpatterns = [ re_path(r'^clear-notifications/?$', actions.clear_notifications), - re_path(r'^create-invite/?$', actions.create_invite), ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT) diff --git a/bookwyrm/view_actions.py b/bookwyrm/view_actions.py index 7977498b..8af68e06 100644 --- a/bookwyrm/view_actions.py +++ b/bookwyrm/view_actions.py @@ -653,23 +653,6 @@ def retry_import(request): goodreads_import.start_import(job) return redirect('/import-status/%d' % job.id) - -@login_required -@require_POST -@permission_required('bookwyrm.create_invites', raise_exception=True) -def create_invite(request): - ''' creates a user invite database entry ''' - form = forms.CreateInviteForm(request.POST) - if not form.is_valid(): - return HttpResponseBadRequest("ERRORS : %s" % (form.errors,)) - - invite = form.save(commit=False) - invite.user = request.user - invite.save() - - return redirect('/invite') - - def update_readthrough(request, book=None, create=True): ''' updates but does not save dates on a readthrough ''' try: diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 0adf771f..5d2fda52 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -1,3 +1,4 @@ ''' make sure all our nice views are available ''' from .authentication import Login, Register, Logout from .password import PasswordResetRequest, PasswordReset, ChangePassword +from .invite import ManageInvites, Invite diff --git a/bookwyrm/views/invite.py b/bookwyrm/views/invite.py new file mode 100644 index 00000000..56485861 --- /dev/null +++ b/bookwyrm/views/invite.py @@ -0,0 +1,58 @@ +''' invites when registration is closed ''' +from django.contrib.auth.decorators import login_required, permission_required +from django.http import HttpResponseBadRequest +from django.shortcuts import get_object_or_404, redirect +from django.template.response import TemplateResponse +from django.utils.decorators import method_decorator +from django.views import View + +from bookwyrm import forms, models + + +# pylint: disable= no-self-use +@method_decorator(login_required, name='dispatch') +@method_decorator( + permission_required('bookwyrm.create_invites', raise_exception=True), + name='dispatch') +class ManageInvites(View): + ''' create invites ''' + def get(self, request): + ''' invite management page ''' + data = { + 'title': 'Invitations', + 'invites': models.SiteInvite.objects.filter( + user=request.user).order_by('-created_date'), + 'form': forms.CreateInviteForm(), + } + return TemplateResponse(request, 'manage_invites.html', data) + + def post(self, request): + ''' creates an invite database entry ''' + form = forms.CreateInviteForm(request.POST) + if not form.is_valid(): + return HttpResponseBadRequest("ERRORS : %s" % (form.errors,)) + + invite = form.save(commit=False) + invite.user = request.user + invite.save() + + return redirect('/invite') + + +class Invite(View): + ''' use an invite to register ''' + def get(self, request, code): + ''' endpoint for using an invites ''' + if request.user.is_authenticated: + return redirect('/') + invite = get_object_or_404(models.SiteInvite, code=code) + + data = { + 'title': 'Join', + 'register_form': forms.RegisterForm(), + 'invite': invite, + 'valid': invite.valid() if invite else True, + } + return TemplateResponse(request, 'invite.html', data) + + # post handling is in views.authentication.Register diff --git a/bookwyrm/vviews.py b/bookwyrm/vviews.py index 66b26615..17ff8806 100644 --- a/bookwyrm/vviews.py +++ b/bookwyrm/vviews.py @@ -8,7 +8,7 @@ from django.db.models import Avg, Q, Max from django.db.models.functions import Greatest from django.http import HttpResponseNotFound, JsonResponse from django.core.exceptions import PermissionDenied -from django.shortcuts import get_object_or_404, redirect +from django.shortcuts import get_object_or_404 from django.template.response import TemplateResponse from django.views.decorators.csrf import csrf_exempt from django.views.decorators.http import require_GET @@ -332,57 +332,6 @@ def about_page(request): return TemplateResponse(request, 'about.html', data) - - -@require_GET -def password_reset(request, code): - ''' endpoint for sending invites ''' - if request.user.is_authenticated: - return redirect('/') - try: - reset_code = models.PasswordReset.objects.get(code=code) - if not reset_code.valid(): - raise PermissionDenied - except models.PasswordReset.DoesNotExist: - raise PermissionDenied - - return TemplateResponse( - request, - 'password_reset.html', - {'title': 'Reset Password', 'code': reset_code.code} - ) - - -@require_GET -def invite_page(request, code): - ''' endpoint for sending invites ''' - if request.user.is_authenticated: - return redirect('/') - invite = get_object_or_404(models.SiteInvite, code=code) - - data = { - 'title': 'Join', - 'register_form': forms.RegisterForm(), - 'invite': invite, - 'valid': invite.valid() if invite else True, - } - return TemplateResponse(request, 'invite.html', data) - - -@login_required -@permission_required('bookwyrm.create_invites', raise_exception=True) -@require_GET -def manage_invites(request): - ''' invite management page ''' - data = { - 'title': 'Invitations', - 'invites': models.SiteInvite.objects.filter( - user=request.user).order_by('-created_date'), - 'form': forms.CreateInviteForm(), - } - return TemplateResponse(request, 'manage_invites.html', data) - - @login_required @require_GET def notifications_page(request): From aa8b2c2f2b7ad928e272812749d8f5cd0d3907f1 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Tue, 12 Jan 2021 10:44:17 -0800 Subject: [PATCH 07/34] Creates landing page views --- bookwyrm/tests/views/test_landing.py | 49 ++++++++++ bookwyrm/urls.py | 11 ++- bookwyrm/views/__init__.py | 1 + bookwyrm/views/helpers.py | 60 ++++++++++++ bookwyrm/views/landing.py | 133 +++++++++++++++++++++++++++ bookwyrm/vviews.py | 118 +----------------------- 6 files changed, 251 insertions(+), 121 deletions(-) create mode 100644 bookwyrm/tests/views/test_landing.py create mode 100644 bookwyrm/views/helpers.py create mode 100644 bookwyrm/views/landing.py diff --git a/bookwyrm/tests/views/test_landing.py b/bookwyrm/tests/views/test_landing.py new file mode 100644 index 00000000..d57f0347 --- /dev/null +++ b/bookwyrm/tests/views/test_landing.py @@ -0,0 +1,49 @@ +''' test for app action functionality ''' +from django.template.response import TemplateResponse +from django.test import TestCase +from django.test.client import RequestFactory + +from bookwyrm import models +from bookwyrm import views + + +class LandingViews(TestCase): + ''' pages you land on without really trying ''' + def setUp(self): + ''' we need basic test data and mocks ''' + self.factory = RequestFactory() + self.local_user = models.User.objects.create_user( + 'mouse@local.com', 'mouse@mouse.mouse', 'password', + local=True, localname='mouse') + + + def test_about_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.About.as_view() + request = self.factory.get('') + request.user = self.local_user + result = view(request) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'about.html') + self.assertEqual(result.status_code, 200) + + + def test_feed(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.Feed.as_view() + request = self.factory.get('') + request.user = self.local_user + result = view(request, 'local') + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'feed.html') + self.assertEqual(result.status_code, 200) + + + def test_discover(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.Discover.as_view() + request = self.factory.get('') + result = view(request) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'discover.html') + self.assertEqual(result.status_code, 200) diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index c2e3ef36..c1741397 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -55,12 +55,15 @@ urlpatterns = [ re_path(r'^invite/?$', views.ManageInvites.as_view()), re_path(r'^invite/(?P[A-Za-z0-9]+)/?$', views.Invite.as_view()), - re_path(r'^about/?$', vviews.about_page), - path('', vviews.home), - re_path(r'^(?Phome|local|federated)/?$', vviews.home_tab), - re_path(r'^discover/?$', vviews.discover_page), + #landing pages + re_path(r'^about/?$', views.About.as_view()), + path('', views.Home.as_view()), + re_path(r'^(?Phome|local|federated)/?$', views.Feed.as_view()), + re_path(r'^discover/?$', views.Discover.as_view()), + re_path(r'^notifications/?$', vviews.notifications_page), re_path(r'^direct-messages/?$', vviews.direct_messages_page), + re_path(r'^import/?$', vviews.import_page), re_path(r'^import-status/(\d+)/?$', vviews.import_status), re_path(r'^user-edit/?$', vviews.edit_profile_page), diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 5d2fda52..03a589dc 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -2,3 +2,4 @@ from .authentication import Login, Register, Logout from .password import PasswordResetRequest, PasswordReset, ChangePassword from .invite import ManageInvites, Invite +from .landing import About, Home, Feed, Discover diff --git a/bookwyrm/views/helpers.py b/bookwyrm/views/helpers.py new file mode 100644 index 00000000..d702f580 --- /dev/null +++ b/bookwyrm/views/helpers.py @@ -0,0 +1,60 @@ +''' helper functions used in various views ''' +from django.db.models import Q +from bookwyrm import models + +def get_activity_feed( + user, privacy, local_only=False, following_only=False, + queryset=models.Status.objects): + ''' get a filtered queryset of statuses ''' + privacy = privacy if isinstance(privacy, list) else [privacy] + # if we're looking at Status, we need this. We don't if it's Comment + if hasattr(queryset, 'select_subclasses'): + queryset = queryset.select_subclasses() + + # exclude deleted + queryset = queryset.exclude(deleted=True).order_by('-published_date') + + # you can't see followers only or direct messages if you're not logged in + if user.is_anonymous: + privacy = [p for p in privacy if not p in ['followers', 'direct']] + + # filter to only privided privacy levels + queryset = queryset.filter(privacy__in=privacy) + + # only include statuses the user follows + if following_only: + queryset = queryset.exclude( + ~Q(# remove everythign except + Q(user__in=user.following.all()) | # user follwoing + Q(user=user) |# is self + Q(mention_users=user)# mentions user + ), + ) + # exclude followers-only statuses the user doesn't follow + elif 'followers' in privacy: + queryset = queryset.exclude( + ~Q(# user isn't following and it isn't their own status + Q(user__in=user.following.all()) | Q(user=user) + ), + privacy='followers' # and the status is followers only + ) + + # exclude direct messages not intended for the user + if 'direct' in privacy: + queryset = queryset.exclude( + ~Q( + Q(user=user) | Q(mention_users=user) + ), privacy='direct' + ) + + # filter for only local status + if local_only: + queryset = queryset.filter(user__local=True) + + # remove statuses that have boosts in the same queryset + try: + queryset = queryset.filter(~Q(boosters__in=queryset)) + except ValueError: + pass + + return queryset diff --git a/bookwyrm/views/landing.py b/bookwyrm/views/landing.py new file mode 100644 index 00000000..389ab2ec --- /dev/null +++ b/bookwyrm/views/landing.py @@ -0,0 +1,133 @@ +''' non-interactive pages ''' +from django.contrib.auth.decorators import login_required +from django.core.paginator import Paginator +from django.db.models import Avg, Max +from django.template.response import TemplateResponse +from django.utils.decorators import method_decorator +from django.views import View + +from bookwyrm import forms, models +from bookwyrm.settings import PAGE_LENGTH +from .helpers import get_activity_feed + + +# pylint: disable= no-self-use +@method_decorator(login_required, name='dispatch') +class About(View): + ''' create invites ''' + def get(self, request): + ''' more information about the instance ''' + data = { + 'title': 'About', + } + return TemplateResponse(request, 'about.html', data) + +class Home(View): + ''' discover page or home feed depending on auth ''' + def get(self, request): + ''' this is the same as the feed on the home tab ''' + if request.user.is_authenticated: + feed_view = Feed.as_view() + return feed_view(request, 'home') + discover_view = Discover.as_view() + return discover_view(request) + +class Discover(View): + ''' preview of recently reviewed books ''' + def get(self, request): + ''' tiled book activity page ''' + books = models.Edition.objects.filter( + review__published_date__isnull=False, + review__user__local=True, + review__privacy__in=['public', 'unlisted'], + ).exclude( + cover__exact='' + ).annotate( + Max('review__published_date') + ).order_by('-review__published_date__max')[:6] + + ratings = {} + for book in books: + reviews = models.Review.objects.filter( + book__in=book.parent_work.editions.all() + ) + reviews = get_activity_feed( + request.user, ['public', 'unlisted'], queryset=reviews) + ratings[book.id] = reviews.aggregate(Avg('rating'))['rating__avg'] + data = { + 'title': 'Discover', + 'register_form': forms.RegisterForm(), + 'books': list(set(books)), + 'ratings': ratings + } + return TemplateResponse(request, 'discover.html', data) + + +@method_decorator(login_required, name='dispatch') +class Feed(View): + ''' activity stream ''' + def get(self, request, tab): + ''' user's homepage with activity feed ''' + try: + page = int(request.GET.get('page', 1)) + except ValueError: + page = 1 + + suggested_books = get_suggested_books(request.user) + + if tab == 'home': + activities = get_activity_feed( + request.user, ['public', 'unlisted', 'followers'], + following_only=True) + elif tab == 'local': + activities = get_activity_feed( + request.user, ['public', 'followers'], local_only=True) + else: + activities = get_activity_feed( + request.user, ['public', 'followers']) + paginated = Paginator(activities, PAGE_LENGTH) + activity_page = paginated.page(page) + + prev_page = next_page = None + if activity_page.has_next(): + next_page = '/%s/?page=%d#feed' % \ + (tab, activity_page.next_page_number()) + if activity_page.has_previous(): + prev_page = '/%s/?page=%d#feed' % \ + (tab, activity_page.previous_page_number()) + data = { + 'title': 'Updates Feed', + 'user': request.user, + 'suggested_books': suggested_books, + 'activities': activity_page.object_list, + 'tab': tab, + 'next': next_page, + 'prev': prev_page, + } + return TemplateResponse(request, 'feed.html', data) + + +def get_suggested_books(user, max_books=5): + ''' helper to get a user's recent books ''' + book_count = 0 + preset_shelves = [ + ('reading', max_books), ('read', 2), ('to-read', max_books) + ] + suggested_books = [] + for (preset, shelf_max) in preset_shelves: + limit = shelf_max if shelf_max < (max_books - book_count) \ + else max_books - book_count + shelf = user.shelf_set.get(identifier=preset) + + shelf_books = shelf.shelfbook_set.order_by( + '-updated_date' + ).all()[:limit] + if not shelf_books: + continue + shelf_preview = { + 'name': shelf.name, + 'books': [s.book for s in shelf_books] + } + suggested_books.append(shelf_preview) + book_count += len(shelf_preview['books']) + return suggested_books diff --git a/bookwyrm/vviews.py b/bookwyrm/vviews.py index 17ff8806..0b839561 100644 --- a/bookwyrm/vviews.py +++ b/bookwyrm/vviews.py @@ -4,7 +4,7 @@ import re from django.contrib.auth.decorators import login_required, permission_required from django.contrib.postgres.search import TrigramSimilarity from django.core.paginator import Paginator -from django.db.models import Avg, Q, Max +from django.db.models import Avg, Q from django.db.models.functions import Greatest from django.http import HttpResponseNotFound, JsonResponse from django.core.exceptions import PermissionDenied @@ -64,113 +64,6 @@ def not_found_page(request, _): request, 'notfound.html', {'title': 'Not found'}, status=404) -@require_GET -def home(request): - ''' this is the same as the feed on the home tab ''' - if request.user.is_authenticated: - return home_tab(request, 'home') - return discover_page(request) - - -@login_required -@require_GET -def home_tab(request, tab): - ''' user's homepage with activity feed ''' - try: - page = int(request.GET.get('page', 1)) - except ValueError: - page = 1 - - suggested_books = get_suggested_books(request.user) - - if tab == 'home': - activities = get_activity_feed( - request.user, ['public', 'unlisted', 'followers'], - following_only=True) - elif tab == 'local': - activities = get_activity_feed( - request.user, ['public', 'followers'], local_only=True) - else: - activities = get_activity_feed( - request.user, ['public', 'followers']) - paginated = Paginator(activities, PAGE_LENGTH) - activity_page = paginated.page(page) - - prev_page = next_page = None - if activity_page.has_next(): - next_page = '/%s/?page=%d#feed' % \ - (tab, activity_page.next_page_number()) - if activity_page.has_previous(): - prev_page = '/%s/?page=%d#feed' % \ - (tab, activity_page.previous_page_number()) - data = { - 'title': 'Updates Feed', - 'user': request.user, - 'suggested_books': suggested_books, - 'activities': activity_page.object_list, - 'tab': tab, - 'next': next_page, - 'prev': prev_page, - } - return TemplateResponse(request, 'feed.html', data) - - -def get_suggested_books(user, max_books=5): - ''' helper to get a user's recent books ''' - book_count = 0 - preset_shelves = [ - ('reading', max_books), ('read', 2), ('to-read', max_books) - ] - suggested_books = [] - for (preset, shelf_max) in preset_shelves: - limit = shelf_max if shelf_max < (max_books - book_count) \ - else max_books - book_count - shelf = user.shelf_set.get(identifier=preset) - - shelf_books = shelf.shelfbook_set.order_by( - '-updated_date' - ).all()[:limit] - if not shelf_books: - continue - shelf_preview = { - 'name': shelf.name, - 'books': [s.book for s in shelf_books] - } - suggested_books.append(shelf_preview) - book_count += len(shelf_preview['books']) - return suggested_books - - -@require_GET -def discover_page(request): - ''' tiled book activity page ''' - books = models.Edition.objects.filter( - review__published_date__isnull=False, - review__user__local=True, - review__privacy__in=['public', 'unlisted'], - ).exclude( - cover__exact='' - ).annotate( - Max('review__published_date') - ).order_by('-review__published_date__max')[:6] - - ratings = {} - for book in books: - reviews = models.Review.objects.filter( - book__in=book.parent_work.editions.all() - ) - reviews = get_activity_feed( - request.user, ['public', 'unlisted'], queryset=reviews) - ratings[book.id] = reviews.aggregate(Avg('rating'))['rating__avg'] - data = { - 'title': 'Discover', - 'register_form': forms.RegisterForm(), - 'books': list(set(books)), - 'ratings': ratings - } - return TemplateResponse(request, 'discover.html', data) - - @login_required @require_GET def direct_messages_page(request, page=1): @@ -323,15 +216,6 @@ def import_status(request, job_id): }) -@require_GET -def about_page(request): - ''' more information about the instance ''' - data = { - 'title': 'About', - } - return TemplateResponse(request, 'about.html', data) - - @login_required @require_GET def notifications_page(request): From b61544b5f58602bae004611e5d9fdbd23640b6ce Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Tue, 12 Jan 2021 11:07:29 -0800 Subject: [PATCH 08/34] DM and notification views --- bookwyrm/templates/notifications.html | 2 +- bookwyrm/tests/test_views.py | 40 -------------------- bookwyrm/tests/views/test_direct_message.py | 28 ++++++++++++++ bookwyrm/tests/views/test_notifications.py | 41 +++++++++++++++++++++ bookwyrm/urls.py | 14 ++++--- bookwyrm/view_actions.py | 7 ---- bookwyrm/views/__init__.py | 3 ++ bookwyrm/views/direct_message.py | 36 ++++++++++++++++++ bookwyrm/views/notifications.py | 29 +++++++++++++++ bookwyrm/vviews.py | 41 --------------------- 10 files changed, 146 insertions(+), 95 deletions(-) create mode 100644 bookwyrm/tests/views/test_direct_message.py create mode 100644 bookwyrm/tests/views/test_notifications.py create mode 100644 bookwyrm/views/direct_message.py create mode 100644 bookwyrm/views/notifications.py diff --git a/bookwyrm/templates/notifications.html b/bookwyrm/templates/notifications.html index ae026a9f..faa91cc5 100644 --- a/bookwyrm/templates/notifications.html +++ b/bookwyrm/templates/notifications.html @@ -5,7 +5,7 @@

Notifications

- + {% csrf_token %} diff --git a/bookwyrm/tests/test_views.py b/bookwyrm/tests/test_views.py index 9729b0f1..49429c3d 100644 --- a/bookwyrm/tests/test_views.py +++ b/bookwyrm/tests/test_views.py @@ -75,26 +75,6 @@ class Views(TestCase): self.assertFalse(views.is_api_request(request)) - def test_home_tab(self): - ''' there are so many views, this just makes sure it LOADS ''' - request = self.factory.get('') - request.user = self.local_user - result = views.home_tab(request, 'local') - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'feed.html') - self.assertEqual(result.status_code, 200) - - - def test_direct_messages_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - request = self.factory.get('') - request.user = self.local_user - result = views.direct_messages_page(request) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'direct_messages.html') - self.assertEqual(result.status_code, 200) - - def test_get_activity_feed(self): ''' loads statuses ''' rat = models.User.objects.create_user( @@ -264,26 +244,6 @@ class Views(TestCase): self.assertEqual(result.status_code, 200) - def test_about_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - request = self.factory.get('') - request.user = self.local_user - result = views.about_page(request) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'about.html') - self.assertEqual(result.status_code, 200) - - - def test_notifications_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - request = self.factory.get('') - request.user = self.local_user - result = views.notifications_page(request) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'notifications.html') - self.assertEqual(result.status_code, 200) - - def test_user_page(self): ''' there are so many views, this just makes sure it LOADS ''' request = self.factory.get('') diff --git a/bookwyrm/tests/views/test_direct_message.py b/bookwyrm/tests/views/test_direct_message.py new file mode 100644 index 00000000..5c0bdcbf --- /dev/null +++ b/bookwyrm/tests/views/test_direct_message.py @@ -0,0 +1,28 @@ +''' test for app action functionality ''' +from django.template.response import TemplateResponse +from django.test import TestCase +from django.test.client import RequestFactory + +from bookwyrm import models +from bookwyrm import views + + +class DirectMessageViews(TestCase): + ''' dms ''' + def setUp(self): + ''' we need basic test data and mocks ''' + self.factory = RequestFactory() + self.local_user = models.User.objects.create_user( + 'mouse@local.com', 'mouse@mouse.mouse', 'password', + local=True, localname='mouse') + + + def test_direct_messages_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.DirectMessages.as_view() + request = self.factory.get('') + request.user = self.local_user + result = view(request) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'direct_messages.html') + self.assertEqual(result.status_code, 200) diff --git a/bookwyrm/tests/views/test_notifications.py b/bookwyrm/tests/views/test_notifications.py new file mode 100644 index 00000000..683424d5 --- /dev/null +++ b/bookwyrm/tests/views/test_notifications.py @@ -0,0 +1,41 @@ +''' test for app action functionality ''' +from django.template.response import TemplateResponse +from django.test import TestCase +from django.test.client import RequestFactory + +from bookwyrm import models +from bookwyrm import views + + +class NotificationViews(TestCase): + ''' notifications ''' + def setUp(self): + ''' we need basic test data and mocks ''' + self.factory = RequestFactory() + self.local_user = models.User.objects.create_user( + 'mouse@local.com', 'mouse@mouse.mouse', 'password', + local=True, localname='mouse') + + def test_notifications_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.Notifications.as_view() + request = self.factory.get('') + request.user = self.local_user + result = view(request) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'notifications.html') + self.assertEqual(result.status_code, 200) + + def test_clear_notifications(self): + ''' erase notifications ''' + models.Notification.objects.create( + user=self.local_user, notification_type='MENTION') + models.Notification.objects.create( + user=self.local_user, notification_type='MENTION', read=True) + self.assertEqual(models.Notification.objects.count(), 2) + view = views.Notifications.as_view() + request = self.factory.post('') + request.user = self.local_user + result = view(request) + self.assertEqual(result.status_code, 302) + self.assertEqual(models.Notification.objects.count(), 1) diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index c1741397..46dd3f0f 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -61,11 +61,16 @@ urlpatterns = [ re_path(r'^(?Phome|local|federated)/?$', views.Feed.as_view()), re_path(r'^discover/?$', views.Discover.as_view()), - re_path(r'^notifications/?$', vviews.notifications_page), - re_path(r'^direct-messages/?$', vviews.direct_messages_page), + re_path(r'^notifications/?$', views.Notifications.as_view()), - re_path(r'^import/?$', vviews.import_page), + re_path(r'^direct-messages/?$', views.DirectMessage.as_view()), + + re_path(r'^import/?$', views.Import.as_view()), + re_path(r'^import/?$', actions.import_data), + re_path(r'^retry-import/?$', actions.retry_import), re_path(r'^import-status/(\d+)/?$', vviews.import_status), + + re_path(r'^user-edit/?$', vviews.edit_profile_page), # should return a ui view or activitypub json blob as requested @@ -101,8 +106,6 @@ urlpatterns = [ # internal action endpoints re_path(r'^edit-profile/?$', actions.edit_profile), - re_path(r'^import-data/?$', actions.import_data), - re_path(r'^retry-import/?$', actions.retry_import), re_path(r'^resolve-book/?$', actions.resolve_book), re_path(r'^edit-book/(?P\d+)/?$', actions.edit_book), re_path(r'^upload-cover/(?P\d+)/?$', actions.upload_cover), @@ -142,7 +145,6 @@ urlpatterns = [ re_path(r'^accept-follow-request/?$', actions.accept_follow_request), re_path(r'^delete-follow-request/?$', actions.delete_follow_request), - re_path(r'^clear-notifications/?$', actions.clear_notifications), ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT) diff --git a/bookwyrm/view_actions.py b/bookwyrm/view_actions.py index 8af68e06..0db08ab7 100644 --- a/bookwyrm/view_actions.py +++ b/bookwyrm/view_actions.py @@ -559,13 +559,6 @@ def unfollow(request): return redirect('/user/%s' % user_slug) -@login_required -def clear_notifications(request): - ''' permanently delete notification for user ''' - request.user.notification_set.filter(read=True).delete() - return redirect('/notifications') - - @login_required @require_POST def accept_follow_request(request): diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 03a589dc..0173f565 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -3,3 +3,6 @@ from .authentication import Login, Register, Logout from .password import PasswordResetRequest, PasswordReset, ChangePassword from .invite import ManageInvites, Invite from .landing import About, Home, Feed, Discover +from .notifications import Notifications +from .direct_message import DirectMessage +from .import_datra import Import diff --git a/bookwyrm/views/direct_message.py b/bookwyrm/views/direct_message.py new file mode 100644 index 00000000..feb0c19a --- /dev/null +++ b/bookwyrm/views/direct_message.py @@ -0,0 +1,36 @@ +''' non-interactive pages ''' +from django.contrib.auth.decorators import login_required +from django.core.paginator import Paginator +from django.template.response import TemplateResponse +from django.utils.decorators import method_decorator +from django.views import View + +from bookwyrm.settings import PAGE_LENGTH +from .helpers import get_activity_feed + + +# pylint: disable= no-self-use +@method_decorator(login_required, name='dispatch') +class DirectMessage(View): + ''' dm view ''' + def get(self, request, page=1): + ''' like a feed but for dms only ''' + activities = get_activity_feed(request.user, 'direct') + paginated = Paginator(activities, PAGE_LENGTH) + activity_page = paginated.page(page) + + prev_page = next_page = None + if activity_page.has_next(): + next_page = '/direct-message/?page=%d#feed' % \ + activity_page.next_page_number() + if activity_page.has_previous(): + prev_page = '/direct-messages/?page=%d#feed' % \ + activity_page.previous_page_number() + data = { + 'title': 'Direct Messages', + 'user': request.user, + 'activities': activity_page.object_list, + 'next': next_page, + 'prev': prev_page, + } + return TemplateResponse(request, 'direct_messages.html', data) diff --git a/bookwyrm/views/notifications.py b/bookwyrm/views/notifications.py new file mode 100644 index 00000000..7d6a3149 --- /dev/null +++ b/bookwyrm/views/notifications.py @@ -0,0 +1,29 @@ +''' non-interactive pages ''' +from django.contrib.auth.decorators import login_required +from django.template.response import TemplateResponse +from django.utils.decorators import method_decorator +from django.shortcuts import redirect +from django.views import View + + +# pylint: disable= no-self-use +@method_decorator(login_required, name='dispatch') +class Notifications(View): + ''' notifications view ''' + def get(self, request): + ''' people are interacting with you, get hyped ''' + notifications = request.user.notification_set.all() \ + .order_by('-created_date') + unread = [n.id for n in notifications.filter(read=False)] + data = { + 'title': 'Notifications', + 'notifications': notifications, + 'unread': unread, + } + notifications.update(read=True) + return TemplateResponse(request, 'notifications.html', data) + + def post(self, request): + ''' permanently delete notification for user ''' + request.user.notification_set.filter(read=True).delete() + return redirect('/notifications') diff --git a/bookwyrm/vviews.py b/bookwyrm/vviews.py index 0b839561..d7e8c913 100644 --- a/bookwyrm/vviews.py +++ b/bookwyrm/vviews.py @@ -64,31 +64,6 @@ def not_found_page(request, _): request, 'notfound.html', {'title': 'Not found'}, status=404) -@login_required -@require_GET -def direct_messages_page(request, page=1): - ''' like a feed but for dms only ''' - activities = get_activity_feed(request.user, 'direct') - paginated = Paginator(activities, PAGE_LENGTH) - activity_page = paginated.page(page) - - prev_page = next_page = None - if activity_page.has_next(): - next_page = '/direct-message/?page=%d#feed' % \ - activity_page.next_page_number() - if activity_page.has_previous(): - prev_page = '/direct-messages/?page=%d#feed' % \ - activity_page.previous_page_number() - data = { - 'title': 'Direct Messages', - 'user': request.user, - 'activities': activity_page.object_list, - 'next': next_page, - 'prev': prev_page, - } - return TemplateResponse(request, 'direct_messages.html', data) - - def get_activity_feed( user, privacy, local_only=False, following_only=False, queryset=models.Status.objects): @@ -216,22 +191,6 @@ def import_status(request, job_id): }) -@login_required -@require_GET -def notifications_page(request): - ''' list notitications ''' - notifications = request.user.notification_set.all() \ - .order_by('-created_date') - unread = [n.id for n in notifications.filter(read=False)] - data = { - 'title': 'Notifications', - 'notifications': notifications, - 'unread': unread, - } - notifications.update(read=True) - return TemplateResponse(request, 'notifications.html', data) - - @csrf_exempt @require_GET def user_page(request, username): From 8693895bc65266a7094ae4ca97573729fe88b4d0 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Tue, 12 Jan 2021 11:28:03 -0800 Subject: [PATCH 09/34] Adds import view --- bookwyrm/templates/import.html | 4 +- bookwyrm/templates/import_status.html | 3 +- bookwyrm/templates/notifications.html | 2 +- bookwyrm/tests/views/test_direct_message.py | 2 +- bookwyrm/tests/views/test_import.py | 43 +++++++++++ bookwyrm/urls.py | 6 +- bookwyrm/view_actions.py | 45 +---------- bookwyrm/views/__init__.py | 2 +- bookwyrm/views/import_data.py | 83 +++++++++++++++++++++ bookwyrm/vviews.py | 34 --------- 10 files changed, 136 insertions(+), 88 deletions(-) create mode 100644 bookwyrm/tests/views/test_import.py create mode 100644 bookwyrm/views/import_data.py diff --git a/bookwyrm/templates/import.html b/bookwyrm/templates/import.html index bfa8d3ec..23cd3445 100644 --- a/bookwyrm/templates/import.html +++ b/bookwyrm/templates/import.html @@ -3,7 +3,7 @@ {% block content %}

Import Books from GoodReads

-
+ {% csrf_token %}
{{ import_form.as_p }} @@ -30,7 +30,7 @@ {% endif %}
diff --git a/bookwyrm/templates/import_status.html b/bookwyrm/templates/import_status.html index c58635d1..8b8f3f30 100644 --- a/bookwyrm/templates/import_status.html +++ b/bookwyrm/templates/import_status.html @@ -30,9 +30,8 @@

Failed to load

{% if not job.retry %} - + {% csrf_token %} -
    {% for item in failed_items %} diff --git a/bookwyrm/templates/notifications.html b/bookwyrm/templates/notifications.html index faa91cc5..b594251f 100644 --- a/bookwyrm/templates/notifications.html +++ b/bookwyrm/templates/notifications.html @@ -63,7 +63,7 @@ boosted your {{ related_status | status_preview_name|safe }} {% endif %} {% else %} - your import completed. + your import completed. {% endif %}

diff --git a/bookwyrm/tests/views/test_direct_message.py b/bookwyrm/tests/views/test_direct_message.py index 5c0bdcbf..48820c75 100644 --- a/bookwyrm/tests/views/test_direct_message.py +++ b/bookwyrm/tests/views/test_direct_message.py @@ -19,7 +19,7 @@ class DirectMessageViews(TestCase): def test_direct_messages_page(self): ''' there are so many views, this just makes sure it LOADS ''' - view = views.DirectMessages.as_view() + view = views.DirectMessage.as_view() request = self.factory.get('') request.user = self.local_user result = view(request) diff --git a/bookwyrm/tests/views/test_import.py b/bookwyrm/tests/views/test_import.py new file mode 100644 index 00000000..14209f24 --- /dev/null +++ b/bookwyrm/tests/views/test_import.py @@ -0,0 +1,43 @@ +''' test for app action functionality ''' +from unittest.mock import patch +from django.template.response import TemplateResponse +from django.test import TestCase +from django.test.client import RequestFactory + +from bookwyrm import models +from bookwyrm import views + + +class ImportViews(TestCase): + ''' goodreads import views ''' + def setUp(self): + ''' we need basic test data and mocks ''' + self.factory = RequestFactory() + self.local_user = models.User.objects.create_user( + 'mouse@local.com', 'mouse@mouse.mouse', 'password', + local=True, localname='mouse') + + + def test_import_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.Import.as_view() + request = self.factory.get('') + request.user = self.local_user + result = view(request) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'import.html') + self.assertEqual(result.status_code, 200) + + + def test_import_status(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.ImportStatus.as_view() + import_job = models.ImportJob.objects.create(user=self.local_user) + request = self.factory.get('') + request.user = self.local_user + with patch('bookwyrm.tasks.app.AsyncResult') as async_result: + async_result.return_value = [] + result = view(request, import_job.id) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'import_status.html') + self.assertEqual(result.status_code, 200) diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index 46dd3f0f..b7f21f3e 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -65,11 +65,9 @@ urlpatterns = [ re_path(r'^direct-messages/?$', views.DirectMessage.as_view()), + # imports re_path(r'^import/?$', views.Import.as_view()), - re_path(r'^import/?$', actions.import_data), - re_path(r'^retry-import/?$', actions.retry_import), - re_path(r'^import-status/(\d+)/?$', vviews.import_status), - + re_path(r'^import/(\d+)/?$', views.ImportStatus.as_view()), re_path(r'^user-edit/?$', vviews.edit_profile_page), diff --git a/bookwyrm/view_actions.py b/bookwyrm/view_actions.py index 0db08ab7..a6cfb794 100644 --- a/bookwyrm/view_actions.py +++ b/bookwyrm/view_actions.py @@ -1,5 +1,5 @@ ''' views for actions you can take in the application ''' -from io import BytesIO, TextIOWrapper +from io import BytesIO from uuid import uuid4 from PIL import Image @@ -15,7 +15,7 @@ from django.template.response import TemplateResponse from django.utils import timezone from django.views.decorators.http import require_POST -from bookwyrm import forms, models, outgoing, goodreads_import +from bookwyrm import forms, models, outgoing from bookwyrm.connectors import connector_manager from bookwyrm.broadcast import broadcast from bookwyrm.vviews import get_user_from_username, get_edition @@ -605,47 +605,6 @@ def delete_follow_request(request): return redirect('/user/%s' % request.user.localname) -@login_required -@require_POST -def import_data(request): - ''' ingest a goodreads csv ''' - form = forms.ImportForm(request.POST, request.FILES) - if form.is_valid(): - include_reviews = request.POST.get('include_reviews') == 'on' - privacy = request.POST.get('privacy') - try: - job = goodreads_import.create_job( - request.user, - TextIOWrapper( - request.FILES['csv_file'], - encoding=request.encoding), - include_reviews, - privacy, - ) - except (UnicodeDecodeError, ValueError): - return HttpResponseBadRequest('Not a valid csv file') - goodreads_import.start_import(job) - return redirect('/import-status/%d' % job.id) - return HttpResponseBadRequest() - - -@login_required -@require_POST -def retry_import(request): - ''' ingest a goodreads csv ''' - job = get_object_or_404(models.ImportJob, id=request.POST.get('import_job')) - items = [] - for item in request.POST.getlist('import_item'): - items.append(get_object_or_404(models.ImportItem, id=item)) - - job = goodreads_import.create_retry_job( - request.user, - job, - items, - ) - goodreads_import.start_import(job) - return redirect('/import-status/%d' % job.id) - def update_readthrough(request, book=None, create=True): ''' updates but does not save dates on a readthrough ''' try: diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 0173f565..048bc80d 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -5,4 +5,4 @@ from .invite import ManageInvites, Invite from .landing import About, Home, Feed, Discover from .notifications import Notifications from .direct_message import DirectMessage -from .import_datra import Import +from .import_data import Import, ImportStatus diff --git a/bookwyrm/views/import_data.py b/bookwyrm/views/import_data.py new file mode 100644 index 00000000..a8bfc865 --- /dev/null +++ b/bookwyrm/views/import_data.py @@ -0,0 +1,83 @@ +''' import books from another app ''' +from io import TextIOWrapper + +from django.contrib.auth.decorators import login_required +from django.core.exceptions import PermissionDenied +from django.http import HttpResponseBadRequest +from django.shortcuts import get_object_or_404, redirect +from django.template.response import TemplateResponse +from django.utils.decorators import method_decorator +from django.views import View + +from bookwyrm import forms, goodreads_import, models +from bookwyrm.tasks import app + +# pylint: disable= no-self-use +@method_decorator(login_required, name='dispatch') +class Import(View): + ''' import view ''' + def get(self, request): + ''' load import page ''' + return TemplateResponse(request, 'import.html', { + 'title': 'Import Books', + 'import_form': forms.ImportForm(), + 'jobs': models.ImportJob. + objects.filter(user=request.user).order_by('-created_date'), + }) + + def post(self, request): + ''' ingest a goodreads csv ''' + form = forms.ImportForm(request.POST, request.FILES) + if form.is_valid(): + include_reviews = request.POST.get('include_reviews') == 'on' + privacy = request.POST.get('privacy') + try: + job = goodreads_import.create_job( + request.user, + TextIOWrapper( + request.FILES['csv_file'], + encoding=request.encoding), + include_reviews, + privacy, + ) + except (UnicodeDecodeError, ValueError): + return HttpResponseBadRequest('Not a valid csv file') + goodreads_import.start_import(job) + return redirect('/import-status/%d' % job.id) + return HttpResponseBadRequest() + + +@method_decorator(login_required, name='dispatch') +class ImportStatus(View): + ''' status of an existing import ''' + def get(self, request, job_id): + ''' status of an import job ''' + job = models.ImportJob.objects.get(id=job_id) + if job.user != request.user: + raise PermissionDenied + task = app.AsyncResult(job.task_id) + items = job.items.order_by('index').all() + failed_items = [i for i in items if i.fail_reason] + items = [i for i in items if not i.fail_reason] + return TemplateResponse(request, 'import_status.html', { + 'title': 'Import Status', + 'job': job, + 'items': items, + 'failed_items': failed_items, + 'task': task + }) + + def post(self, request, job_id): + ''' retry lines from an import ''' + job = get_object_or_404(models.ImportJob, id=job_id) + items = [] + for item in request.POST.getlist('import_item'): + items.append(get_object_or_404(models.ImportItem, id=item)) + + job = goodreads_import.create_retry_job( + request.user, + job, + items, + ) + goodreads_import.start_import(job) + return redirect('/import-status/%d' % job.id) diff --git a/bookwyrm/vviews.py b/bookwyrm/vviews.py index d7e8c913..26b0e5f9 100644 --- a/bookwyrm/vviews.py +++ b/bookwyrm/vviews.py @@ -7,7 +7,6 @@ from django.core.paginator import Paginator from django.db.models import Avg, Q from django.db.models.functions import Greatest from django.http import HttpResponseNotFound, JsonResponse -from django.core.exceptions import PermissionDenied from django.shortcuts import get_object_or_404 from django.template.response import TemplateResponse from django.views.decorators.csrf import csrf_exempt @@ -18,7 +17,6 @@ from bookwyrm import forms, models from bookwyrm.activitypub import ActivitypubResponse from bookwyrm.connectors import connector_manager from bookwyrm.settings import PAGE_LENGTH -from bookwyrm.tasks import app from bookwyrm.utils import regex @@ -159,38 +157,6 @@ def search(request): return TemplateResponse(request, 'search_results.html', data) -@login_required -@require_GET -def import_page(request): - ''' import history from goodreads ''' - return TemplateResponse(request, 'import.html', { - 'title': 'Import Books', - 'import_form': forms.ImportForm(), - 'jobs': models.ImportJob. - objects.filter(user=request.user).order_by('-created_date'), - }) - - -@login_required -@require_GET -def import_status(request, job_id): - ''' status of an import job ''' - job = models.ImportJob.objects.get(id=job_id) - if job.user != request.user: - raise PermissionDenied - task = app.AsyncResult(job.task_id) - items = job.items.order_by('index').all() - failed_items = [i for i in items if i.fail_reason] - items = [i for i in items if not i.fail_reason] - return TemplateResponse(request, 'import_status.html', { - 'title': 'Import Status', - 'job': job, - 'items': items, - 'failed_items': failed_items, - 'task': task - }) - - @csrf_exempt @require_GET def user_page(request, username): From 85d01d5df0871a1580e67d1b642571fc690aa031 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Tue, 12 Jan 2021 12:05:30 -0800 Subject: [PATCH 10/34] Moves user views to class view --- bookwyrm/templates/layout.html | 2 +- bookwyrm/templates/user.html | 2 +- bookwyrm/tests/test_views.py | 77 ------------ bookwyrm/tests/views/test_user.py | 99 +++++++++++++++ bookwyrm/urls.py | 15 +-- bookwyrm/view_actions.py | 49 -------- bookwyrm/views/__init__.py | 1 + bookwyrm/views/helpers.py | 15 +++ bookwyrm/views/password.py | 2 +- bookwyrm/views/user.py | 192 ++++++++++++++++++++++++++++++ bookwyrm/vviews.py | 131 -------------------- 11 files changed, 316 insertions(+), 269 deletions(-) create mode 100644 bookwyrm/tests/views/test_user.py create mode 100644 bookwyrm/views/user.py diff --git a/bookwyrm/templates/layout.html b/bookwyrm/templates/layout.html index edd43f97..ec575b38 100644 --- a/bookwyrm/templates/layout.html +++ b/bookwyrm/templates/layout.html @@ -82,7 +82,7 @@
  • - + Settings
    • diff --git a/bookwyrm/templates/user.html b/bookwyrm/templates/user.html index 8ad5ee08..2d3fac1e 100644 --- a/bookwyrm/templates/user.html +++ b/bookwyrm/templates/user.html @@ -7,7 +7,7 @@
    {% if is_self %}
    - + Edit profile diff --git a/bookwyrm/tests/test_views.py b/bookwyrm/tests/test_views.py index 49429c3d..8229edf0 100644 --- a/bookwyrm/tests/test_views.py +++ b/bookwyrm/tests/test_views.py @@ -221,83 +221,6 @@ class Views(TestCase): response.context_data['user_results'][0], self.local_user) - def test_import_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - request = self.factory.get('') - request.user = self.local_user - result = views.import_page(request) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'import.html') - self.assertEqual(result.status_code, 200) - - - def test_import_status(self): - ''' there are so many views, this just makes sure it LOADS ''' - import_job = models.ImportJob.objects.create(user=self.local_user) - request = self.factory.get('') - request.user = self.local_user - with patch('bookwyrm.tasks.app.AsyncResult') as async_result: - async_result.return_value = [] - result = views.import_status(request, import_job.id) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'import_status.html') - self.assertEqual(result.status_code, 200) - - - def test_user_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - request = self.factory.get('') - request.user = self.local_user - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = False - result = views.user_page(request, 'mouse') - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'user.html') - self.assertEqual(result.status_code, 200) - - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = True - result = views.user_page(request, 'mouse') - self.assertIsInstance(result, ActivitypubResponse) - self.assertEqual(result.status_code, 200) - - - def test_followers_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - request = self.factory.get('') - request.user = self.local_user - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = False - result = views.followers_page(request, 'mouse') - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'followers.html') - self.assertEqual(result.status_code, 200) - - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = True - result = views.followers_page(request, 'mouse') - self.assertIsInstance(result, ActivitypubResponse) - self.assertEqual(result.status_code, 200) - - - def test_following_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - request = self.factory.get('') - request.user = self.local_user - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = False - result = views.following_page(request, 'mouse') - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'following.html') - self.assertEqual(result.status_code, 200) - - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = True - result = views.following_page(request, 'mouse') - self.assertIsInstance(result, ActivitypubResponse) - self.assertEqual(result.status_code, 200) - - def test_status_page(self): ''' there are so many views, this just makes sure it LOADS ''' status = models.Status.objects.create( diff --git a/bookwyrm/tests/views/test_user.py b/bookwyrm/tests/views/test_user.py new file mode 100644 index 00000000..0e2ad904 --- /dev/null +++ b/bookwyrm/tests/views/test_user.py @@ -0,0 +1,99 @@ +''' test for app action functionality ''' +from unittest.mock import patch +from django.template.response import TemplateResponse +from django.test import TestCase +from django.test.client import RequestFactory + +from bookwyrm import forms, models, views +from bookwyrm.activitypub import ActivitypubResponse + + +class UserViews(TestCase): + ''' view user and edit profile ''' + def setUp(self): + ''' we need basic test data and mocks ''' + self.factory = RequestFactory() + self.local_user = models.User.objects.create_user( + 'mouse@local.com', 'mouse@mouse.mouse', 'password', + local=True, localname='mouse') + + + def test_user_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.User.as_view() + request = self.factory.get('') + request.user = self.local_user + with patch('bookwyrm.views.user.is_api_request') as is_api: + is_api.return_value = False + result = view(request, 'mouse') + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'user.html') + self.assertEqual(result.status_code, 200) + + with patch('bookwyrm.views.user.is_api_request') as is_api: + is_api.return_value = True + result = view(request, 'mouse') + self.assertIsInstance(result, ActivitypubResponse) + self.assertEqual(result.status_code, 200) + + + def test_followers_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.Followers.as_view() + request = self.factory.get('') + request.user = self.local_user + with patch('bookwyrm.views.user.is_api_request') as is_api: + is_api.return_value = False + result = view(request, 'mouse') + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'followers.html') + self.assertEqual(result.status_code, 200) + + with patch('bookwyrm.views.user.is_api_request') as is_api: + is_api.return_value = True + result = view(request, 'mouse') + self.assertIsInstance(result, ActivitypubResponse) + self.assertEqual(result.status_code, 200) + + + def test_following_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.Following.as_view() + request = self.factory.get('') + request.user = self.local_user + with patch('bookwyrm.views.user.is_api_request') as is_api: + is_api.return_value = False + result = view(request, 'mouse') + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'following.html') + self.assertEqual(result.status_code, 200) + + with patch('bookwyrm.views.user.is_api_request') as is_api: + is_api.return_value = True + result = view(request, 'mouse') + self.assertIsInstance(result, ActivitypubResponse) + self.assertEqual(result.status_code, 200) + + + def test_edit_profile_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.EditUser.as_view() + request = self.factory.get('') + request.user = self.local_user + result = view(request) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'edit_user.html') + self.assertEqual(result.status_code, 200) + + + def test_edit_user(self): + ''' use a form to update a user ''' + view = views.EditUser.as_view() + form = forms.EditUserForm(instance=self.local_user) + form.data['name'] = 'New Name' + request = self.factory.post('', form.data) + request.user = self.local_user + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request) + self.assertEqual(self.local_user.name, 'New Name') diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index b7f21f3e..a82e6509 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -69,16 +69,14 @@ urlpatterns = [ re_path(r'^import/?$', views.Import.as_view()), re_path(r'^import/(\d+)/?$', views.ImportStatus.as_view()), - re_path(r'^user-edit/?$', vviews.edit_profile_page), - # should return a ui view or activitypub json blob as requested # users - re_path(r'%s/?$' % user_path, vviews.user_page), - re_path(r'%s\.json$' % local_user_path, vviews.user_page), - re_path(r'%s/?$' % local_user_path, vviews.user_page), - re_path(r'%s/shelves/?$' % local_user_path, vviews.user_shelves_page), - re_path(r'%s/followers(.json)?/?$' % local_user_path, vviews.followers_page), - re_path(r'%s/following(.json)?/?$' % local_user_path, vviews.following_page), + re_path(r'%s/?$' % user_path, views.User.as_view()), + re_path(r'%s\.json$' % user_path, views.User.as_view()), + re_path(r'%s/shelves/?$' % user_path, vviews.user_shelves_page), + re_path(r'%s/followers(.json)?/?$' % user_path, views.Followers.as_view()), + re_path(r'%s/following(.json)?/?$' % user_path, views.Following.as_view()), + re_path(r'^edit-profile/?$', views.EditUser.as_view()), # statuses re_path(r'%s(.json)?/?$' % status_path, vviews.status_page), @@ -102,7 +100,6 @@ urlpatterns = [ re_path(r'^search/?$', vviews.search), # internal action endpoints - re_path(r'^edit-profile/?$', actions.edit_profile), re_path(r'^resolve-book/?$', actions.resolve_book), re_path(r'^edit-book/(?P\d+)/?$', actions.edit_book), diff --git a/bookwyrm/view_actions.py b/bookwyrm/view_actions.py index a6cfb794..5c14a54a 100644 --- a/bookwyrm/view_actions.py +++ b/bookwyrm/view_actions.py @@ -1,13 +1,8 @@ ''' views for actions you can take in the application ''' -from io import BytesIO -from uuid import uuid4 -from PIL import Image - import dateutil.parser from dateutil.parser import ParserError from django.contrib.auth.decorators import login_required, permission_required -from django.core.files.base import ContentFile from django.db import transaction from django.http import HttpResponseBadRequest, HttpResponseNotFound from django.shortcuts import get_object_or_404, redirect @@ -21,50 +16,6 @@ from bookwyrm.broadcast import broadcast from bookwyrm.vviews import get_user_from_username, get_edition -@login_required -@require_POST -def edit_profile(request): - ''' les get fancy with images ''' - form = forms.EditUserForm( - request.POST, request.FILES, instance=request.user) - if not form.is_valid(): - data = {'form': form, 'user': request.user} - return TemplateResponse(request, 'edit_user.html', data) - - user = form.save(commit=False) - - if 'avatar' in form.files: - # crop and resize avatar upload - image = Image.open(form.files['avatar']) - target_size = 120 - width, height = image.size - thumbnail_scale = height / (width / target_size) if height > width \ - else width / (height / target_size) - image.thumbnail([thumbnail_scale, thumbnail_scale]) - width, height = image.size - - width_diff = width - target_size - height_diff = height - target_size - cropped = image.crop(( - int(width_diff / 2), - int(height_diff / 2), - int(width - (width_diff / 2)), - int(height - (height_diff / 2)) - )) - output = BytesIO() - cropped.save(output, format=image.format) - ContentFile(output.getvalue()) - - # set the name to a hash - extension = form.files['avatar'].name.split('.')[-1] - filename = '%s.%s' % (uuid4(), extension) - user.avatar.save(filename, ContentFile(output.getvalue())) - user.save() - - broadcast(user, user.to_update_activity(user)) - return redirect('/user/%s' % request.user.localname) - - @require_POST def resolve_book(request): ''' figure out the local path to a book from a remote_id ''' diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 048bc80d..30cc6ea4 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -6,3 +6,4 @@ from .landing import About, Home, Feed, Discover from .notifications import Notifications from .direct_message import DirectMessage from .import_data import Import, ImportStatus +from .user import User, EditUser, Followers, Following diff --git a/bookwyrm/views/helpers.py b/bookwyrm/views/helpers.py index d702f580..e20a923f 100644 --- a/bookwyrm/views/helpers.py +++ b/bookwyrm/views/helpers.py @@ -2,6 +2,21 @@ from django.db.models import Q from bookwyrm import models +def get_user_from_username(username): + ''' helper function to resolve a localname or a username to a user ''' + # raises DoesNotExist if user is now found + try: + return models.User.objects.get(localname=username) + except models.User.DoesNotExist: + return models.User.objects.get(username=username) + + +def is_api_request(request): + ''' check whether a request is asking for html or data ''' + return 'json' in request.headers.get('Accept') or \ + request.path[-5:] == '.json' + + def get_activity_feed( user, privacy, local_only=False, following_only=False, queryset=models.Status.objects): diff --git a/bookwyrm/views/password.py b/bookwyrm/views/password.py index 85c44d11..915659e3 100644 --- a/bookwyrm/views/password.py +++ b/bookwyrm/views/password.py @@ -94,7 +94,7 @@ class ChangePassword(View): confirm_password = request.POST.get('confirm-password') if new_password != confirm_password: - return redirect('/user-edit') + return redirect('/edit-profile') request.user.set_password(new_password) request.user.save() diff --git a/bookwyrm/views/user.py b/bookwyrm/views/user.py new file mode 100644 index 00000000..35d06fd0 --- /dev/null +++ b/bookwyrm/views/user.py @@ -0,0 +1,192 @@ +''' non-interactive pages ''' +from io import BytesIO +from uuid import uuid4 +from PIL import Image + +from django.contrib.auth.decorators import login_required +from django.core.files.base import ContentFile +from django.core.paginator import Paginator +from django.http import HttpResponseNotFound +from django.shortcuts import redirect +from django.template.response import TemplateResponse +from django.utils.decorators import method_decorator +from django.views import View + +from bookwyrm import forms, models +from bookwyrm.activitypub import ActivitypubResponse +from bookwyrm.broadcast import broadcast +from bookwyrm.settings import PAGE_LENGTH +from .helpers import get_activity_feed, get_user_from_username, is_api_request + + +# pylint: disable= no-self-use +class User(View): + ''' user profile page ''' + def get(self, request, username): + ''' profile page for a user ''' + try: + user = get_user_from_username(username) + except models.User.DoesNotExist: + return HttpResponseNotFound() + + if is_api_request(request): + # we have a json request + return ActivitypubResponse(user.to_activity()) + # otherwise we're at a UI view + + try: + page = int(request.GET.get('page', 1)) + except ValueError: + page = 1 + + shelf_preview = [] + + # only show other shelves that should be visible + shelves = user.shelf_set + is_self = request.user.id == user.id + if not is_self: + follower = user.followers.filter(id=request.user.id).exists() + if follower: + shelves = shelves.filter(privacy__in=['public', 'followers']) + else: + shelves = shelves.filter(privacy='public') + + for user_shelf in shelves.all(): + if not user_shelf.books.count(): + continue + shelf_preview.append({ + 'name': user_shelf.name, + 'local_path': user_shelf.local_path, + 'books': user_shelf.books.all()[:3], + 'size': user_shelf.books.count(), + }) + if len(shelf_preview) > 2: + break + + # user's posts + activities = get_activity_feed( + request.user, + ['public', 'unlisted', 'followers'], + queryset=models.Status.objects.filter(user=user) + ) + paginated = Paginator(activities, PAGE_LENGTH) + activity_page = paginated.page(page) + + prev_page = next_page = None + if activity_page.has_next(): + next_page = '/user/%s/?page=%d' % \ + (username, activity_page.next_page_number()) + if activity_page.has_previous(): + prev_page = '/user/%s/?page=%d' % \ + (username, activity_page.previous_page_number()) + data = { + 'title': user.name, + 'user': user, + 'is_self': is_self, + 'shelves': shelf_preview, + 'shelf_count': shelves.count(), + 'activities': activity_page.object_list, + 'next': next_page, + 'prev': prev_page, + } + + return TemplateResponse(request, 'user.html', data) + +class Followers(View): + ''' list of followers view ''' + def get(self, request, username): + ''' list of followers ''' + try: + user = get_user_from_username(username) + except models.User.DoesNotExist: + return HttpResponseNotFound() + + if is_api_request(request): + return ActivitypubResponse( + user.to_followers_activity(**request.GET)) + + data = { + 'title': '%s: followers' % user.name, + 'user': user, + 'is_self': request.user.id == user.id, + 'followers': user.followers.all(), + } + return TemplateResponse(request, 'followers.html', data) + +class Following(View): + ''' list of following view ''' + def get(self, request, username): + ''' list of followers ''' + try: + user = get_user_from_username(username) + except models.User.DoesNotExist: + return HttpResponseNotFound() + + if is_api_request(request): + return ActivitypubResponse( + user.to_following_activity(**request.GET)) + + data = { + 'title': '%s: following' % user.name, + 'user': user, + 'is_self': request.user.id == user.id, + 'following': user.following.all(), + } + return TemplateResponse(request, 'following.html', data) + + +@method_decorator(login_required, name='dispatch') +class EditUser(View): + ''' edit user view ''' + def get(self, request): + ''' profile page for a user ''' + user = request.user + + form = forms.EditUserForm(instance=request.user) + data = { + 'title': 'Edit profile', + 'form': form, + 'user': user, + } + return TemplateResponse(request, 'edit_user.html', data) + + def post(self, request): + ''' les get fancy with images ''' + form = forms.EditUserForm( + request.POST, request.FILES, instance=request.user) + if not form.is_valid(): + data = {'form': form, 'user': request.user} + return TemplateResponse(request, 'edit_user.html', data) + + user = form.save(commit=False) + + if 'avatar' in form.files: + # crop and resize avatar upload + image = Image.open(form.files['avatar']) + target_size = 120 + width, height = image.size + thumbnail_scale = height / (width / target_size) if height > width \ + else width / (height / target_size) + image.thumbnail([thumbnail_scale, thumbnail_scale]) + width, height = image.size + + width_diff = width - target_size + height_diff = height - target_size + cropped = image.crop(( + int(width_diff / 2), + int(height_diff / 2), + int(width - (width_diff / 2)), + int(height - (height_diff / 2)) + )) + output = BytesIO() + cropped.save(output, format=image.format) + ContentFile(output.getvalue()) + + # set the name to a hash + extension = form.files['avatar'].name.split('.')[-1] + filename = '%s.%s' % (uuid4(), extension) + user.avatar.save(filename, ContentFile(output.getvalue())) + user.save() + + broadcast(user, user.to_update_activity(user)) + return redirect('/user/%s' % request.user.localname) diff --git a/bookwyrm/vviews.py b/bookwyrm/vviews.py index 26b0e5f9..ceda2c23 100644 --- a/bookwyrm/vviews.py +++ b/bookwyrm/vviews.py @@ -157,121 +157,6 @@ def search(request): return TemplateResponse(request, 'search_results.html', data) -@csrf_exempt -@require_GET -def user_page(request, username): - ''' profile page for a user ''' - try: - user = get_user_from_username(username) - except models.User.DoesNotExist: - return HttpResponseNotFound() - - if is_api_request(request): - # we have a json request - return ActivitypubResponse(user.to_activity()) - # otherwise we're at a UI view - - try: - page = int(request.GET.get('page', 1)) - except ValueError: - page = 1 - - shelf_preview = [] - - # only show other shelves that should be visible - shelves = user.shelf_set - is_self = request.user.id == user.id - if not is_self: - follower = user.followers.filter(id=request.user.id).exists() - if follower: - shelves = shelves.filter(privacy__in=['public', 'followers']) - else: - shelves = shelves.filter(privacy='public') - - for user_shelf in shelves.all(): - if not user_shelf.books.count(): - continue - shelf_preview.append({ - 'name': user_shelf.name, - 'local_path': user_shelf.local_path, - 'books': user_shelf.books.all()[:3], - 'size': user_shelf.books.count(), - }) - if len(shelf_preview) > 2: - break - - # user's posts - activities = get_activity_feed( - request.user, - ['public', 'unlisted', 'followers'], - queryset=models.Status.objects.filter(user=user) - ) - paginated = Paginator(activities, PAGE_LENGTH) - activity_page = paginated.page(page) - - prev_page = next_page = None - if activity_page.has_next(): - next_page = '/user/%s/?page=%d' % \ - (username, activity_page.next_page_number()) - if activity_page.has_previous(): - prev_page = '/user/%s/?page=%d' % \ - (username, activity_page.previous_page_number()) - data = { - 'title': user.name, - 'user': user, - 'is_self': is_self, - 'shelves': shelf_preview, - 'shelf_count': shelves.count(), - 'activities': activity_page.object_list, - 'next': next_page, - 'prev': prev_page, - } - - return TemplateResponse(request, 'user.html', data) - - -@csrf_exempt -@require_GET -def followers_page(request, username): - ''' list of followers ''' - try: - user = get_user_from_username(username) - except models.User.DoesNotExist: - return HttpResponseNotFound() - - if is_api_request(request): - return ActivitypubResponse(user.to_followers_activity(**request.GET)) - - data = { - 'title': '%s: followers' % user.name, - 'user': user, - 'is_self': request.user.id == user.id, - 'followers': user.followers.all(), - } - return TemplateResponse(request, 'followers.html', data) - - -@csrf_exempt -@require_GET -def following_page(request, username): - ''' list of followers ''' - try: - user = get_user_from_username(username) - except models.User.DoesNotExist: - return HttpResponseNotFound() - - if is_api_request(request): - return ActivitypubResponse(user.to_following_activity(**request.GET)) - - data = { - 'title': '%s: following' % user.name, - 'user': user, - 'is_self': request.user.id == user.id, - 'following': user.following.all(), - } - return TemplateResponse(request, 'following.html', data) - - @csrf_exempt @require_GET def status_page(request, username, status_id): @@ -327,22 +212,6 @@ def replies_page(request, username, status_id): return ActivitypubResponse(status.to_replies(**request.GET)) - -@login_required -@require_GET -def edit_profile_page(request): - ''' profile page for a user ''' - user = request.user - - form = forms.EditUserForm(instance=request.user) - data = { - 'title': 'Edit profile', - 'form': form, - 'user': user, - } - return TemplateResponse(request, 'edit_user.html', data) - - @require_GET def book_page(request, book_id): ''' info about a book ''' From 4ec64c02f442d8836a798e05af98b0eb966d9289 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Tue, 12 Jan 2021 13:47:00 -0800 Subject: [PATCH 11/34] Adds status views --- bookwyrm/outgoing.py | 105 ---------- .../snippets/create_status_form.html | 2 +- bookwyrm/tests/test_view_actions.py | 12 -- bookwyrm/tests/test_views.py | 51 ----- bookwyrm/urls.py | 42 ++-- bookwyrm/view_actions.py | 64 ------ bookwyrm/views/__init__.py | 1 + bookwyrm/views/helpers.py | 58 ++++++ bookwyrm/views/status.py | 193 ++++++++++++++++++ bookwyrm/vviews.py | 55 ----- 10 files changed, 269 insertions(+), 314 deletions(-) create mode 100644 bookwyrm/views/status.py diff --git a/bookwyrm/outgoing.py b/bookwyrm/outgoing.py index 2a62fd04..1e80852b 100644 --- a/bookwyrm/outgoing.py +++ b/bookwyrm/outgoing.py @@ -213,111 +213,6 @@ def handle_imported_book(user, item, include_reviews, privacy): broadcast(user, review.to_create_activity(user), privacy=privacy) -def handle_delete_status(user, status): - ''' delete a status and broadcast deletion to other servers ''' - delete_status(status) - broadcast(user, status.to_delete_activity(user)) - - -def handle_status(user, form): - ''' generic handler for statuses ''' - status = form.save(commit=False) - if not status.sensitive and status.content_warning: - # the cw text field remains populated when you click "remove" - status.content_warning = None - status.save() - - # inspect the text for user tags - content = status.content - for (mention_text, mention_user) in find_mentions(content): - # add them to status mentions fk - status.mention_users.add(mention_user) - - # turn the mention into a link - content = re.sub( - r'%s([^@]|$)' % mention_text, - r'%s\g<1>' % \ - (mention_user.remote_id, mention_text), - content) - - # add reply parent to mentions and notify - if status.reply_parent: - status.mention_users.add(status.reply_parent.user) - for mention_user in status.reply_parent.mention_users.all(): - status.mention_users.add(mention_user) - - if status.reply_parent.user.local: - create_notification( - status.reply_parent.user, - 'REPLY', - related_user=user, - related_status=status - ) - - # deduplicate mentions - status.mention_users.set(set(status.mention_users.all())) - # create mention notifications - for mention_user in status.mention_users.all(): - if status.reply_parent and mention_user == status.reply_parent.user: - continue - if mention_user.local: - create_notification( - mention_user, - 'MENTION', - related_user=user, - related_status=status - ) - - # don't apply formatting to generated notes - if not isinstance(status, models.GeneratedNote): - status.content = to_markdown(content) - # do apply formatting to quotes - if hasattr(status, 'quote'): - status.quote = to_markdown(status.quote) - - status.save() - - broadcast(user, status.to_create_activity(user), software='bookwyrm') - - # re-format the activity for non-bookwyrm servers - remote_activity = status.to_create_activity(user, pure=True) - broadcast(user, remote_activity, software='other') - - -def find_mentions(content): - ''' detect @mentions in raw status content ''' - for match in re.finditer(regex.strict_username, content): - username = match.group().strip().split('@')[1:] - if len(username) == 1: - # this looks like a local user (@user), fill in the domain - username.append(DOMAIN) - username = '@'.join(username) - - mention_user = handle_remote_webfinger(username) - if not mention_user: - # we can ignore users we don't know about - continue - yield (match.group(), mention_user) - - -def format_links(content): - ''' detect and format links ''' - return re.sub( - r'([^(href=")]|^|\()(https?:\/\/(%s([\w\.\-_\/+&\?=:;,])*))' % \ - regex.domain, - r'\g<1>\g<3>', - content) - -def to_markdown(content): - ''' catch links and convert to markdown ''' - content = format_links(content) - content = markdown(content) - # sanitize resulting html - sanitizer = InputHtmlParser() - sanitizer.feed(content) - return sanitizer.get_output() - - def handle_favorite(user, status): ''' a user likes a status ''' try: diff --git a/bookwyrm/templates/snippets/create_status_form.html b/bookwyrm/templates/snippets/create_status_form.html index a0c6b817..c34aa348 100644 --- a/bookwyrm/templates/snippets/create_status_form.html +++ b/bookwyrm/templates/snippets/create_status_form.html @@ -1,4 +1,4 @@ - + {% csrf_token %} diff --git a/bookwyrm/tests/test_view_actions.py b/bookwyrm/tests/test_view_actions.py index bf7d37bd..c0c613ac 100644 --- a/bookwyrm/tests/test_view_actions.py +++ b/bookwyrm/tests/test_view_actions.py @@ -49,18 +49,6 @@ class ViewActions(TestCase): self.factory = RequestFactory() - def test_edit_user(self): - ''' use a form to update a user ''' - form = forms.EditUserForm(instance=self.local_user) - form.data['name'] = 'New Name' - request = self.factory.post('', form.data) - request.user = self.local_user - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - actions.edit_profile(request) - self.assertEqual(self.local_user.name, 'New Name') - - def test_edit_book(self): ''' lets a user edit a book ''' self.local_user.groups.add(self.group) diff --git a/bookwyrm/tests/test_views.py b/bookwyrm/tests/test_views.py index 8229edf0..c3cce675 100644 --- a/bookwyrm/tests/test_views.py +++ b/bookwyrm/tests/test_views.py @@ -220,57 +220,6 @@ class Views(TestCase): self.assertEqual( response.context_data['user_results'][0], self.local_user) - - def test_status_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - status = models.Status.objects.create( - content='hi', user=self.local_user) - request = self.factory.get('') - request.user = self.local_user - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = False - result = views.status_page(request, 'mouse', status.id) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'status.html') - self.assertEqual(result.status_code, 200) - - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = True - result = views.status_page(request, 'mouse', status.id) - self.assertIsInstance(result, ActivitypubResponse) - self.assertEqual(result.status_code, 200) - - - def test_replies_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - status = models.Status.objects.create( - content='hi', user=self.local_user) - request = self.factory.get('') - request.user = self.local_user - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = False - result = views.replies_page(request, 'mouse', status.id) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'status.html') - self.assertEqual(result.status_code, 200) - - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = True - result = views.replies_page(request, 'mouse', status.id) - self.assertIsInstance(result, ActivitypubResponse) - self.assertEqual(result.status_code, 200) - - - def test_edit_profile_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - request = self.factory.get('') - request.user = self.local_user - result = views.edit_profile_page(request) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'edit_user.html') - self.assertEqual(result.status_code, 200) - - def test_book_page(self): ''' there are so many views, this just makes sure it LOADS ''' request = self.factory.get('') diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index a82e6509..3054260e 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -39,8 +39,6 @@ urlpatterns = [ re_path(r'^nodeinfo/2\.0/?$', wellknown.nodeinfo), re_path(r'^api/v1/instance/?$', wellknown.instance_info), re_path(r'^api/v1/instance/peers/?$', wellknown.peers), - # TODO: re_path(r'^.well-known/host-meta/?$', incoming.host_meta), - # TODO: robots.txt # authentication re_path(r'^login/?$', views.Login.as_view()), @@ -60,16 +58,13 @@ urlpatterns = [ path('', views.Home.as_view()), re_path(r'^(?Phome|local|federated)/?$', views.Feed.as_view()), re_path(r'^discover/?$', views.Discover.as_view()), - re_path(r'^notifications/?$', views.Notifications.as_view()), - re_path(r'^direct-messages/?$', views.DirectMessage.as_view()), # imports re_path(r'^import/?$', views.Import.as_view()), re_path(r'^import/(\d+)/?$', views.ImportStatus.as_view()), - # users re_path(r'%s/?$' % user_path, views.User.as_view()), re_path(r'%s\.json$' % user_path, views.User.as_view()), @@ -79,16 +74,29 @@ urlpatterns = [ re_path(r'^edit-profile/?$', views.EditUser.as_view()), # statuses - re_path(r'%s(.json)?/?$' % status_path, vviews.status_page), - re_path(r'%s/activity/?$' % status_path, vviews.status_page), - re_path(r'%s/replies(.json)?/?$' % status_path, vviews.replies_page), + re_path(r'%s(.json)?/?$' % status_path, views.Status.as_view()), + re_path(r'%s/activity/?$' % status_path, views.Status.as_view()), + re_path(r'%s/replies(.json)?/?$' % status_path, views.Replies.as_view()), + re_path(r'^post/(?P\w+)/?$', views.CreateStatus.as_view()), + re_path(r'^delete-status/(?P\d+)/?$', + views.DeleteStatus.as_view()), + + re_path(r'^tag/?$', actions.tag), + re_path(r'^untag/?$', actions.untag), # books re_path(r'%s(.json)?/?$' % book_path, vviews.book_page), re_path(r'%s/edit/?$' % book_path, vviews.edit_book_page), re_path(r'^author/(?P[\w\-]+)/edit/?$', vviews.edit_author_page), re_path(r'%s/editions(.json)?/?$' % book_path, vviews.editions_page), + # interact + re_path(r'^favorite/(?P\d+)/?$', actions.favorite), + re_path(r'^unfavorite/(?P\d+)/?$', actions.unfavorite), + re_path(r'^boost/(?P\d+)/?$', actions.boost), + re_path(r'^unboost/(?P\d+)/?$', actions.unboost), + + re_path(r'^author/(?P[\w\-]+)(.json)?/?$', vviews.author_page), re_path(r'^tag/(?P.+)\.json/?$', vviews.tag_page), re_path(r'^tag/(?P.+)/?$', vviews.tag_page), @@ -112,21 +120,6 @@ urlpatterns = [ re_path(r'^delete-readthrough/?$', actions.delete_readthrough), re_path(r'^create-readthrough/?$', actions.create_readthrough), - re_path(r'^rate/?$', actions.rate), - re_path(r'^review/?$', actions.review), - re_path(r'^quote/?$', actions.quotate), - re_path(r'^comment/?$', actions.comment), - re_path(r'^tag/?$', actions.tag), - re_path(r'^untag/?$', actions.untag), - re_path(r'^reply/?$', actions.reply), - - re_path(r'^favorite/(?P\d+)/?$', actions.favorite), - re_path(r'^unfavorite/(?P\d+)/?$', actions.unfavorite), - re_path(r'^boost/(?P\d+)/?$', actions.boost), - re_path(r'^unboost/(?P\d+)/?$', actions.unboost), - - re_path(r'^delete-status/(?P\d+)/?$', actions.delete_status), - re_path(r'^create-shelf/?$', actions.create_shelf), re_path(r'^edit-shelf/(?P\d+)?$', actions.edit_shelf), re_path(r'^delete-shelf/(?P\d+)?$', actions.delete_shelf), @@ -139,7 +132,4 @@ urlpatterns = [ re_path(r'^unfollow/?$', actions.unfollow), re_path(r'^accept-follow-request/?$', actions.accept_follow_request), re_path(r'^delete-follow-request/?$', actions.delete_follow_request), - - - ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT) diff --git a/bookwyrm/view_actions.py b/bookwyrm/view_actions.py index 5c14a54a..6b818350 100644 --- a/bookwyrm/view_actions.py +++ b/bookwyrm/view_actions.py @@ -337,55 +337,6 @@ def create_readthrough(request): return redirect(request.headers.get('Referer', '/')) -@login_required -@require_POST -def rate(request): - ''' just a star rating for a book ''' - form = forms.RatingForm(request.POST) - return handle_status(request, form) - - -@login_required -@require_POST -def review(request): - ''' create a book review ''' - form = forms.ReviewForm(request.POST) - return handle_status(request, form) - - -@login_required -@require_POST -def quotate(request): - ''' create a book quotation ''' - form = forms.QuotationForm(request.POST) - return handle_status(request, form) - - -@login_required -@require_POST -def comment(request): - ''' create a book comment ''' - form = forms.CommentForm(request.POST) - return handle_status(request, form) - - -@login_required -@require_POST -def reply(request): - ''' respond to a book review ''' - form = forms.ReplyForm(request.POST) - return handle_status(request, form) - - -def handle_status(request, form): - ''' all the "create a status" functions are the same ''' - if not form.is_valid(): - return redirect(request.headers.get('Referer', '/')) - - outgoing.handle_status(request.user, form) - return redirect(request.headers.get('Referer', '/')) - - @login_required @require_POST def tag(request): @@ -463,21 +414,6 @@ def unboost(request, status_id): return redirect(request.headers.get('Referer', '/')) -@login_required -@require_POST -def delete_status(request, status_id): - ''' delete and tombstone a status ''' - status = get_object_or_404(models.Status, id=status_id) - - # don't let people delete other people's statuses - if status.user != request.user: - return HttpResponseBadRequest() - - # perform deletion - outgoing.handle_delete_status(request.user, status) - return redirect(request.headers.get('Referer', '/')) - - @login_required @require_POST def follow(request): diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 30cc6ea4..1714c59e 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -7,3 +7,4 @@ from .notifications import Notifications from .direct_message import DirectMessage from .import_data import Import, ImportStatus from .user import User, EditUser, Followers, Following +from .status import Status, Replies, CreateStatus, DeleteStatus diff --git a/bookwyrm/views/helpers.py b/bookwyrm/views/helpers.py index e20a923f..effc2463 100644 --- a/bookwyrm/views/helpers.py +++ b/bookwyrm/views/helpers.py @@ -17,6 +17,27 @@ def is_api_request(request): request.path[-5:] == '.json' +def is_bookworm_request(request): + ''' check if the request is coming from another bookworm instance ''' + user_agent = request.headers.get('User-Agent') + if user_agent is None or \ + re.search(regex.bookwyrm_user_agent, user_agent) is None: + return False + return True + + +def status_visible_to_user(viewer, status): + ''' is a user authorized to view a status? ''' + if viewer == status.user or status.privacy in ['public', 'unlisted']: + return True + if status.privacy == 'followers' and \ + status.user.followers.filter(id=viewer.id).first(): + return True + if status.privacy == 'direct' and \ + status.mention_users.filter(id=viewer.id).first(): + return True + return False + def get_activity_feed( user, privacy, local_only=False, following_only=False, queryset=models.Status.objects): @@ -73,3 +94,40 @@ def get_activity_feed( pass return queryset + + +def handle_remote_webfinger(query): + ''' webfingerin' other servers ''' + user = None + + # usernames could be @user@domain or user@domain + if not query: + return None + + if query[0] == '@': + query = query[1:] + + try: + domain = query.split('@')[1] + except IndexError: + return None + + try: + user = models.User.objects.get(username=query) + except models.User.DoesNotExist: + url = 'https://%s/.well-known/webfinger?resource=acct:%s' % \ + (domain, query) + try: + data = get_data(url) + except (ConnectorException, HTTPError): + return None + + for link in data.get('links'): + if link.get('rel') == 'self': + try: + user = activitypub.resolve_remote_id( + models.User, link['href'] + ) + except KeyError: + return None + return user diff --git a/bookwyrm/views/status.py b/bookwyrm/views/status.py new file mode 100644 index 00000000..98b082fd --- /dev/null +++ b/bookwyrm/views/status.py @@ -0,0 +1,193 @@ +''' non-interactive pages ''' +import re +from django.contrib.auth.decorators import login_required +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 +from django.views import View +from markdown import markdown + +from bookwyrm import forms, models +from bookwyrm.activitypub import ActivitypubResponse +from bookwyrm.broadcast import broadcast +from bookwyrm.sanitize_html import InputHtmlParser +from bookwyrm.settings import DOMAIN +from bookwyrm.status import create_notification, delete_status +from bookwyrm.utils import regex +from .helpers import get_user_from_username, handle_remote_webfinger +from .helpers import is_api_request, is_bookworm_request, status_visible_to_user + + +# pylint: disable= no-self-use +class Status(View): + ''' the view for *posting* ''' + def get(self, request, username, status_id): + ''' display a particular status (and replies, etc) ''' + try: + user = get_user_from_username(username) + status = models.Status.objects.select_subclasses().get(id=status_id) + except ValueError: + return HttpResponseNotFound() + + # the url should have the poster's username in it + if user != status.user: + return HttpResponseNotFound() + + # make sure the user is authorized to see the status + if not status_visible_to_user(request.user, status): + return HttpResponseNotFound() + + if is_api_request(request): + return ActivitypubResponse( + status.to_activity(pure=not is_bookworm_request(request))) + + data = { + 'title': 'Status by %s' % user.username, + 'status': status, + } + return TemplateResponse(request, 'status.html', data) + + +@method_decorator(login_required, name='dispatch') +class CreateStatus(View): + ''' get posting ''' + def post(self, request, status_type): + ''' create status of whatever type ''' + if status_type not in models.status_models: + return HttpResponseBadRequest() + form = forms.get_attr(status_type)(request.POST) + if not form.is_valid(): + return redirect(request.headers.get('Referer', '/')) + + status = form.save(commit=False) + if not status.sensitive and status.content_warning: + # the cw text field remains populated when you click "remove" + status.content_warning = None + status.save() + + # inspect the text for user tags + content = status.content + for (mention_text, mention_user) in find_mentions(content): + # add them to status mentions fk + status.mention_users.add(mention_user) + + # turn the mention into a link + content = re.sub( + r'%s([^@]|$)' % mention_text, + r'%s\g<1>' % \ + (mention_user.remote_id, mention_text), + content) + + # add reply parent to mentions and notify + if status.reply_parent: + status.mention_users.add(status.reply_parent.user) + for mention_user in status.reply_parent.mention_users.all(): + status.mention_users.add(mention_user) + + if status.reply_parent.user.local: + create_notification( + status.reply_parent.user, + 'REPLY', + related_user=request.user, + related_status=status + ) + + # deduplicate mentions + status.mention_users.set(set(status.mention_users.all())) + # create mention notifications + for mention_user in status.mention_users.all(): + if status.reply_parent and mention_user == status.reply_parent.user: + continue + if mention_user.local: + create_notification( + mention_user, + 'MENTION', + related_user=request.user, + related_status=status + ) + + # don't apply formatting to generated notes + if not isinstance(status, models.GeneratedNote): + status.content = to_markdown(content) + # do apply formatting to quotes + if hasattr(status, 'quote'): + status.quote = to_markdown(status.quote) + + status.save() + + broadcast( + request.user, + status.to_create_activity(request.user), + software='bookwyrm') + + # re-format the activity for non-bookwyrm servers + remote_activity = status.to_create_activity(request.user, pure=True) + broadcast(request.user, remote_activity, software='other') + return redirect(request.headers.get('Referer', '/')) + + +class DeleteStatus(View): + ''' tombstone that bad boy ''' + def post(self, request, status_id): + ''' delete and tombstone a status ''' + status = get_object_or_404(models.Status, id=status_id) + + # don't let people delete other people's statuses + if status.user != request.user: + return HttpResponseBadRequest() + + # perform deletion + delete_status(status) + broadcast(request.user, status.to_delete_activity(request.user)) + return redirect(request.headers.get('Referer', '/')) + + +class Replies(View): + ''' replies page (a json view of status) ''' + def get(self, request, username, status_id): + ''' ordered collection of replies to a status ''' + # the html view is the same as Status + if not is_api_request(request): + status_view = Status.as_view() + return status_view(request, username, status_id) + + # the json view is different than Status + status = models.Status.objects.get(id=status_id) + if status.user.localname != username: + return HttpResponseNotFound() + + return ActivitypubResponse(status.to_replies(**request.GET)) + +def find_mentions(content): + ''' detect @mentions in raw status content ''' + for match in re.finditer(regex.strict_username, content): + username = match.group().strip().split('@')[1:] + if len(username) == 1: + # this looks like a local user (@user), fill in the domain + username.append(DOMAIN) + username = '@'.join(username) + + mention_user = handle_remote_webfinger(username) + if not mention_user: + # we can ignore users we don't know about + continue + yield (match.group(), mention_user) + + +def format_links(content): + ''' detect and format links ''' + return re.sub( + r'([^(href=")]|^|\()(https?:\/\/(%s([\w\.\-_\/+&\?=:;,])*))' % \ + regex.domain, + r'\g<1>\g<3>', + content) + +def to_markdown(content): + ''' catch links and convert to markdown ''' + content = format_links(content) + content = markdown(content) + # sanitize resulting html + sanitizer = InputHtmlParser() + sanitizer.feed(content) + return sanitizer.get_output() diff --git a/bookwyrm/vviews.py b/bookwyrm/vviews.py index ceda2c23..2c7137e6 100644 --- a/bookwyrm/vviews.py +++ b/bookwyrm/vviews.py @@ -157,61 +157,6 @@ def search(request): return TemplateResponse(request, 'search_results.html', data) -@csrf_exempt -@require_GET -def status_page(request, username, status_id): - ''' display a particular status (and replies, etc) ''' - try: - user = get_user_from_username(username) - status = models.Status.objects.select_subclasses().get(id=status_id) - except ValueError: - return HttpResponseNotFound() - - # the url should have the poster's username in it - if user != status.user: - return HttpResponseNotFound() - - # make sure the user is authorized to see the status - if not status_visible_to_user(request.user, status): - return HttpResponseNotFound() - - if is_api_request(request): - return ActivitypubResponse( - status.to_activity(pure=not is_bookworm_request(request))) - - data = { - 'title': 'Status by %s' % user.username, - 'status': status, - } - return TemplateResponse(request, 'status.html', data) - - -def status_visible_to_user(viewer, status): - ''' is a user authorized to view a status? ''' - if viewer == status.user or status.privacy in ['public', 'unlisted']: - return True - if status.privacy == 'followers' and \ - status.user.followers.filter(id=viewer.id).first(): - return True - if status.privacy == 'direct' and \ - status.mention_users.filter(id=viewer.id).first(): - return True - return False - - -@csrf_exempt -@require_GET -def replies_page(request, username, status_id): - ''' ordered collection of replies to a status ''' - 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() - - return ActivitypubResponse(status.to_replies(**request.GET)) - @require_GET def book_page(request, book_id): ''' info about a book ''' From 6c80b128a40dcf0df47714dad49c59a70b3b2e43 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Tue, 12 Jan 2021 14:02:38 -0800 Subject: [PATCH 12/34] Adds status tests --- .../templates/snippets/create_status.html | 2 +- .../snippets/create_status_form.html | 6 +- bookwyrm/templates/snippets/reply_form.html | 2 +- bookwyrm/templatetags/bookwyrm_tags.py | 2 +- bookwyrm/tests/test_outgoing.py | 163 ------------ bookwyrm/tests/views/test_status.py | 242 ++++++++++++++++++ bookwyrm/views/status.py | 6 +- 7 files changed, 252 insertions(+), 171 deletions(-) create mode 100644 bookwyrm/tests/views/test_status.py diff --git a/bookwyrm/templates/snippets/create_status.html b/bookwyrm/templates/snippets/create_status.html index ac8c0b75..02239e2f 100644 --- a/bookwyrm/templates/snippets/create_status.html +++ b/bookwyrm/templates/snippets/create_status.html @@ -39,5 +39,5 @@
    - {% include 'snippets/create_status_form.html' with type="quote" placeholder="An excerpt from '"|add:book.title|add:"'" %} + {% include 'snippets/create_status_form.html' with type="quotation" placeholder="An excerpt from '"|add:book.title|add:"'" %}
    diff --git a/bookwyrm/templates/snippets/create_status_form.html b/bookwyrm/templates/snippets/create_status_form.html index c34aa348..e8540721 100644 --- a/bookwyrm/templates/snippets/create_status_form.html +++ b/bookwyrm/templates/snippets/create_status_form.html @@ -9,7 +9,7 @@
    {% endif %}
    - + {% if type == 'review' %}
    @@ -29,14 +29,14 @@ {% include 'snippets/content_warning_field.html' %} - {% if type == 'quote' %} + {% if type == 'quotation' %} {% else %} {% endif %}
    - {% if type == 'quote' %} + {% if type == 'quotation' %}
    diff --git a/bookwyrm/templates/snippets/reply_form.html b/bookwyrm/templates/snippets/reply_form.html index bf1f0259..de938bcc 100644 --- a/bookwyrm/templates/snippets/reply_form.html +++ b/bookwyrm/templates/snippets/reply_form.html @@ -1,6 +1,6 @@ {% load bookwyrm_tags %} {% with status.id|uuid as uuid %} - +
    {% csrf_token %} diff --git a/bookwyrm/templatetags/bookwyrm_tags.py b/bookwyrm/templatetags/bookwyrm_tags.py index d774a079..c58f5c47 100644 --- a/bookwyrm/templatetags/bookwyrm_tags.py +++ b/bookwyrm/templatetags/bookwyrm_tags.py @@ -7,7 +7,7 @@ from django import template from django.utils import timezone from bookwyrm import models -from bookwyrm.outgoing import to_markdown +from bookwyrm.views.status import to_markdown register = template.Library() diff --git a/bookwyrm/tests/test_outgoing.py b/bookwyrm/tests/test_outgoing.py index 67599673..192db0dd 100644 --- a/bookwyrm/tests/test_outgoing.py +++ b/bookwyrm/tests/test_outgoing.py @@ -444,169 +444,6 @@ class Outgoing(TestCase): self.assertTrue(status.deleted) - def test_handle_status(self): - ''' create a status ''' - form = forms.CommentForm({ - 'content': 'hi', - 'user': self.local_user.id, - 'book': self.book.id, - 'privacy': 'public', - }) - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_status(self.local_user, form) - status = models.Comment.objects.get() - self.assertEqual(status.content, '

    hi

    ') - self.assertEqual(status.user, self.local_user) - self.assertEqual(status.book, self.book) - - def test_handle_status_reply(self): - ''' create a status in reply to an existing status ''' - user = models.User.objects.create_user( - 'rat', 'rat@rat.com', 'password', local=True) - parent = models.Status.objects.create( - content='parent status', user=self.local_user) - form = forms.ReplyForm({ - 'content': 'hi', - 'user': user.id, - 'reply_parent': parent.id, - 'privacy': 'public', - }) - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_status(user, form) - status = models.Status.objects.get(user=user) - self.assertEqual(status.content, '

    hi

    ') - self.assertEqual(status.user, user) - self.assertEqual( - models.Notification.objects.get().user, self.local_user) - - def test_handle_status_mentions(self): - ''' @mention a user in a post ''' - user = models.User.objects.create_user( - 'rat@%s' % DOMAIN, 'rat@rat.com', 'password', - local=True, localname='rat') - form = forms.CommentForm({ - 'content': 'hi @rat', - 'user': self.local_user.id, - 'book': self.book.id, - 'privacy': 'public', - }) - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_status(self.local_user, form) - status = models.Status.objects.get() - self.assertEqual(list(status.mention_users.all()), [user]) - self.assertEqual(models.Notification.objects.get().user, user) - self.assertEqual( - status.content, - '

    hi @rat

    ' % user.remote_id) - - def test_handle_status_reply_with_mentions(self): - ''' reply to a post with an @mention'ed user ''' - user = models.User.objects.create_user( - 'rat', 'rat@rat.com', 'password', - local=True, localname='rat') - form = forms.CommentForm({ - 'content': 'hi @rat@example.com', - 'user': self.local_user.id, - 'book': self.book.id, - 'privacy': 'public', - }) - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_status(self.local_user, form) - status = models.Status.objects.get() - - form = forms.ReplyForm({ - 'content': 'right', - 'user': user, - 'privacy': 'public', - 'reply_parent': status.id - }) - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_status(user, form) - - reply = models.Status.replies(status).first() - self.assertEqual(reply.content, '

    right

    ') - self.assertEqual(reply.user, user) - self.assertTrue(self.remote_user in reply.mention_users.all()) - self.assertTrue(self.local_user in reply.mention_users.all()) - - def test_find_mentions(self): - ''' detect and look up @ mentions of users ''' - user = models.User.objects.create_user( - 'nutria@%s' % DOMAIN, 'nutria@nutria.com', 'password', - local=True, localname='nutria') - self.assertEqual(user.username, 'nutria@%s' % DOMAIN) - - self.assertEqual( - list(outgoing.find_mentions('@nutria'))[0], - ('@nutria', user) - ) - self.assertEqual( - list(outgoing.find_mentions('leading text @nutria'))[0], - ('@nutria', user) - ) - self.assertEqual( - list(outgoing.find_mentions('leading @nutria trailing text'))[0], - ('@nutria', user) - ) - self.assertEqual( - list(outgoing.find_mentions('@rat@example.com'))[0], - ('@rat@example.com', self.remote_user) - ) - - multiple = list(outgoing.find_mentions('@nutria and @rat@example.com')) - self.assertEqual(multiple[0], ('@nutria', user)) - self.assertEqual(multiple[1], ('@rat@example.com', self.remote_user)) - - with patch('bookwyrm.outgoing.handle_remote_webfinger') as rw: - rw.return_value = self.local_user - self.assertEqual( - list(outgoing.find_mentions('@beep@beep.com'))[0], - ('@beep@beep.com', self.local_user) - ) - with patch('bookwyrm.outgoing.handle_remote_webfinger') as rw: - rw.return_value = None - self.assertEqual(list(outgoing.find_mentions('@beep@beep.com')), []) - - self.assertEqual( - list(outgoing.find_mentions('@nutria@%s' % DOMAIN))[0], - ('@nutria@%s' % DOMAIN, user) - ) - - def test_format_links(self): - ''' find and format urls into a tags ''' - url = 'http://www.fish.com/' - self.assertEqual( - outgoing.format_links(url), - 'www.fish.com/' % url) - self.assertEqual( - outgoing.format_links('(%s)' % url), - '(www.fish.com/)' % url) - url = 'https://archive.org/details/dli.granth.72113/page/n25/mode/2up' - self.assertEqual( - outgoing.format_links(url), - '' \ - 'archive.org/details/dli.granth.72113/page/n25/mode/2up' \ - % url) - url = 'https://openlibrary.org/search' \ - '?q=arkady+strugatsky&mode=everything' - self.assertEqual( - outgoing.format_links(url), - 'openlibrary.org/search' \ - '?q=arkady+strugatsky&mode=everything' % url) - - - def test_to_markdown(self): - ''' this is mostly handled in other places, but nonetheless ''' - text = '_hi_ and http://fish.com is rad' - result = outgoing.to_markdown(text) - self.assertEqual( - result, - '

    hi and fish.com ' \ - 'is rad

    ') - - def test_handle_favorite(self): ''' create and broadcast faving a status ''' status = models.Status.objects.create( diff --git a/bookwyrm/tests/views/test_status.py b/bookwyrm/tests/views/test_status.py new file mode 100644 index 00000000..e3d46178 --- /dev/null +++ b/bookwyrm/tests/views/test_status.py @@ -0,0 +1,242 @@ +''' test for app action functionality ''' +from unittest.mock import patch +from django.template.response import TemplateResponse +from django.test import TestCase +from django.test.client import RequestFactory + +from bookwyrm import forms, models, views +from bookwyrm.activitypub import ActivitypubResponse +from bookwyrm.settings import DOMAIN + + +class StatusViews(TestCase): + ''' viewing and creating statuses ''' + def setUp(self): + ''' we need basic test data and mocks ''' + self.factory = RequestFactory() + self.local_user = models.User.objects.create_user( + 'mouse@local.com', 'mouse@mouse.mouse', 'password', + local=True, localname='mouse') + + + def test_status_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.Status.as_view() + status = models.Status.objects.create( + content='hi', user=self.local_user) + request = self.factory.get('') + request.user = self.local_user + with patch('bookwyrm.views.is_api_request') as is_api: + is_api.return_value = False + result = view(request, 'mouse', status.id) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'status.html') + self.assertEqual(result.status_code, 200) + + with patch('bookwyrm.views.is_api_request') as is_api: + is_api.return_value = True + result = view(request, 'mouse', status.id) + self.assertIsInstance(result, ActivitypubResponse) + self.assertEqual(result.status_code, 200) + + + def test_replies_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.Replies.as_view() + status = models.Status.objects.create( + content='hi', user=self.local_user) + request = self.factory.get('') + request.user = self.local_user + with patch('bookwyrm.views.status.is_api_request') as is_api: + is_api.return_value = False + result = view(request, 'mouse', status.id) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'status.html') + self.assertEqual(result.status_code, 200) + + with patch('bookwyrm.views.is_api_request') as is_api: + is_api.return_value = True + result = view(request, 'mouse', status.id) + self.assertIsInstance(result, ActivitypubResponse) + self.assertEqual(result.status_code, 200) + + + def test_handle_status(self): + ''' create a status ''' + view = views.CreateStatus.as_view() + form = forms.CommentForm({ + 'content': 'hi', + 'user': self.local_user.id, + 'book': self.book.id, + 'privacy': 'public', + }) + request = self.factory.get('', form.data) + request.user = self.local_user + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request, 'comment') + status = models.Comment.objects.get() + self.assertEqual(status.content, '

    hi

    ') + self.assertEqual(status.user, self.local_user) + self.assertEqual(status.book, self.book) + + def test_handle_status_reply(self): + ''' create a status in reply to an existing status ''' + view = views.CreateStatus.as_view() + user = models.User.objects.create_user( + 'rat', 'rat@rat.com', 'password', local=True) + parent = models.Status.objects.create( + content='parent status', user=self.local_user) + form = forms.ReplyForm({ + 'content': 'hi', + 'user': user.id, + 'reply_parent': parent.id, + 'privacy': 'public', + }) + request = self.factory.get('', form.data) + request.user = self.local_user + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request, 'reply') + status = models.Status.objects.get(user=user) + self.assertEqual(status.content, '

    hi

    ') + self.assertEqual(status.user, user) + self.assertEqual( + models.Notification.objects.get().user, self.local_user) + + def test_handle_status_mentions(self): + ''' @mention a user in a post ''' + view = views.CreateStatus.as_view() + user = models.User.objects.create_user( + 'rat@%s' % DOMAIN, 'rat@rat.com', 'password', + local=True, localname='rat') + form = forms.CommentForm({ + 'content': 'hi @rat', + 'user': self.local_user.id, + 'book': self.book.id, + 'privacy': 'public', + }) + request = self.factory.get('', form.data) + request.user = self.local_user + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request, 'comment') + status = models.Status.objects.get() + self.assertEqual(list(status.mention_users.all()), [user]) + self.assertEqual(models.Notification.objects.get().user, user) + self.assertEqual( + status.content, + '

    hi @rat

    ' % user.remote_id) + + def test_handle_status_reply_with_mentions(self): + ''' reply to a post with an @mention'ed user ''' + view = views.CreateStatus.as_view() + user = models.User.objects.create_user( + 'rat', 'rat@rat.com', 'password', + local=True, localname='rat') + form = forms.CommentForm({ + 'content': 'hi @rat@example.com', + 'user': self.local_user.id, + 'book': self.book.id, + 'privacy': 'public', + }) + request = self.factory.get('', form.data) + request.user = self.local_user + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request, 'comment') + status = models.Status.objects.get() + + form = forms.ReplyForm({ + 'content': 'right', + 'user': user, + 'privacy': 'public', + 'reply_parent': status.id + }) + request = self.factory.get('', form.data) + request.user = self.local_user + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request, 'comment') + + reply = models.Status.replies(status).first() + self.assertEqual(reply.content, '

    right

    ') + self.assertEqual(reply.user, user) + self.assertTrue(self.remote_user in reply.mention_users.all()) + self.assertTrue(self.local_user in reply.mention_users.all()) + + def test_find_mentions(self): + ''' detect and look up @ mentions of users ''' + user = models.User.objects.create_user( + 'nutria@%s' % DOMAIN, 'nutria@nutria.com', 'password', + local=True, localname='nutria') + self.assertEqual(user.username, 'nutria@%s' % DOMAIN) + + self.assertEqual( + list(views.status.find_mentions('@nutria'))[0], + ('@nutria', user) + ) + self.assertEqual( + list(views.status.find_mentions('leading text @nutria'))[0], + ('@nutria', user) + ) + self.assertEqual( + list(views.status.find_mentions( + 'leading @nutria trailing text'))[0], + ('@nutria', user) + ) + self.assertEqual( + list(views.status.find_mentions( + '@rat@example.com'))[0], + ('@rat@example.com', self.remote_user) + ) + + multiple = list(views.status.find_mentions( + '@nutria and @rat@example.com')) + self.assertEqual(multiple[0], ('@nutria', user)) + self.assertEqual(multiple[1], ('@rat@example.com', self.remote_user)) + + with patch('bookwyrm.views.status.handle_remote_webfinger') as rw: + rw.return_value = self.local_user + self.assertEqual( + list(views.status.find_mentions('@beep@beep.com'))[0], + ('@beep@beep.com', self.local_user) + ) + with patch('bookwyrm.views.status.handle_remote_webfinger') as rw: + rw.return_value = None + self.assertEqual(list(views.status.find_mentions( + '@beep@beep.com')), []) + + self.assertEqual( + list(views.status.find_mentions('@nutria@%s' % DOMAIN))[0], + ('@nutria@%s' % DOMAIN, user) + ) + + def test_format_links(self): + ''' find and format urls into a tags ''' + url = 'http://www.fish.com/' + self.assertEqual( + views.status.format_links(url), + 'www.fish.com/' % url) + self.assertEqual( + views.status.format_links('(%s)' % url), + '(www.fish.com/)' % url) + url = 'https://archive.org/details/dli.granth.72113/page/n25/mode/2up' + self.assertEqual( + views.status.format_links(url), + '' \ + 'archive.org/details/dli.granth.72113/page/n25/mode/2up' \ + % url) + url = 'https://openlibrary.org/search' \ + '?q=arkady+strugatsky&mode=everything' + self.assertEqual( + views.status.format_links(url), + 'openlibrary.org/search' \ + '?q=arkady+strugatsky&mode=everything' % url) + + + def test_to_markdown(self): + ''' this is mostly handled in other places, but nonetheless ''' + text = '_hi_ and http://fish.com is rad' + result = views.status.to_markdown(text) + self.assertEqual( + result, + '

    hi and fish.com ' \ + 'is rad

    ') diff --git a/bookwyrm/views/status.py b/bookwyrm/views/status.py index 98b082fd..60a1f814 100644 --- a/bookwyrm/views/status.py +++ b/bookwyrm/views/status.py @@ -54,9 +54,11 @@ class CreateStatus(View): ''' get posting ''' def post(self, request, status_type): ''' create status of whatever type ''' - if status_type not in models.status_models: + status_type = status_type[0].upper() + status_type[1:] + try: + form = getattr(forms, '%sForm' % status_type)(request.POST) + except AttributeError: return HttpResponseBadRequest() - form = forms.get_attr(status_type)(request.POST) if not form.is_valid(): return redirect(request.headers.get('Referer', '/')) From 5596277d29937afba81913e3b6d85cf0d596297d Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Tue, 12 Jan 2021 14:43:59 -0800 Subject: [PATCH 13/34] tests status class view --- bookwyrm/tests/test_outgoing.py | 3 +-- bookwyrm/tests/test_views.py | 1 - bookwyrm/tests/views/test_status.py | 39 +++++++++++++++++++++-------- bookwyrm/urls.py | 16 ++++++------ bookwyrm/views/helpers.py | 8 +++++- 5 files changed, 43 insertions(+), 24 deletions(-) diff --git a/bookwyrm/tests/test_outgoing.py b/bookwyrm/tests/test_outgoing.py index 192db0dd..956862e0 100644 --- a/bookwyrm/tests/test_outgoing.py +++ b/bookwyrm/tests/test_outgoing.py @@ -9,8 +9,7 @@ from django.test import TestCase from django.test.client import RequestFactory import responses -from bookwyrm import forms, models, outgoing -from bookwyrm.settings import DOMAIN +from bookwyrm import models, outgoing # pylint: disable=too-many-public-methods diff --git a/bookwyrm/tests/test_views.py b/bookwyrm/tests/test_views.py index c3cce675..fcf88610 100644 --- a/bookwyrm/tests/test_views.py +++ b/bookwyrm/tests/test_views.py @@ -2,7 +2,6 @@ import json from unittest.mock import patch -from django.contrib.auth.models import AnonymousUser from django.http import JsonResponse from django.template.response import TemplateResponse from django.test import TestCase diff --git a/bookwyrm/tests/views/test_status.py b/bookwyrm/tests/views/test_status.py index e3d46178..3d81b46f 100644 --- a/bookwyrm/tests/views/test_status.py +++ b/bookwyrm/tests/views/test_status.py @@ -15,8 +15,25 @@ class StatusViews(TestCase): ''' we need basic test data and mocks ''' self.factory = RequestFactory() self.local_user = models.User.objects.create_user( - 'mouse@local.com', 'mouse@mouse.mouse', 'password', - local=True, localname='mouse') + 'mouse@local.com', 'mouse@mouse.com', 'mouseword', + local=True, localname='mouse', + remote_id='https://example.com/users/mouse', + ) + with patch('bookwyrm.models.user.set_remote_server'): + self.remote_user = models.User.objects.create_user( + 'rat', 'rat@email.com', 'ratword', + local=False, + remote_id='https://example.com/users/rat', + inbox='https://example.com/users/rat/inbox', + outbox='https://example.com/users/rat/outbox', + ) + + work = models.Work.objects.create(title='Test Work') + self.book = models.Edition.objects.create( + title='Example Edition', + remote_id='https://example.com/book/1', + parent_work=work + ) def test_status_page(self): @@ -70,7 +87,7 @@ class StatusViews(TestCase): 'book': self.book.id, 'privacy': 'public', }) - request = self.factory.get('', form.data) + request = self.factory.post('', form.data) request.user = self.local_user with patch('bookwyrm.broadcast.broadcast_task.delay'): view(request, 'comment') @@ -92,8 +109,8 @@ class StatusViews(TestCase): 'reply_parent': parent.id, 'privacy': 'public', }) - request = self.factory.get('', form.data) - request.user = self.local_user + request = self.factory.post('', form.data) + request.user = user with patch('bookwyrm.broadcast.broadcast_task.delay'): view(request, 'reply') status = models.Status.objects.get(user=user) @@ -114,7 +131,7 @@ class StatusViews(TestCase): 'book': self.book.id, 'privacy': 'public', }) - request = self.factory.get('', form.data) + request = self.factory.post('', form.data) request.user = self.local_user with patch('bookwyrm.broadcast.broadcast_task.delay'): @@ -138,7 +155,7 @@ class StatusViews(TestCase): 'book': self.book.id, 'privacy': 'public', }) - request = self.factory.get('', form.data) + request = self.factory.post('', form.data) request.user = self.local_user with patch('bookwyrm.broadcast.broadcast_task.delay'): @@ -147,14 +164,14 @@ class StatusViews(TestCase): form = forms.ReplyForm({ 'content': 'right', - 'user': user, + 'user': user.id, 'privacy': 'public', 'reply_parent': status.id }) - request = self.factory.get('', form.data) - request.user = self.local_user + request = self.factory.post('', form.data) + request.user = user with patch('bookwyrm.broadcast.broadcast_task.delay'): - view(request, 'comment') + view(request, 'reply') reply = models.Status.replies(status).first() self.assertEqual(reply.content, '

    right

    ') diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index 3054260e..a6e0cd30 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -81,21 +81,19 @@ urlpatterns = [ re_path(r'^delete-status/(?P\d+)/?$', views.DeleteStatus.as_view()), - - re_path(r'^tag/?$', actions.tag), - re_path(r'^untag/?$', actions.untag), - # books - re_path(r'%s(.json)?/?$' % book_path, vviews.book_page), - re_path(r'%s/edit/?$' % book_path, vviews.edit_book_page), - re_path(r'^author/(?P[\w\-]+)/edit/?$', vviews.edit_author_page), - re_path(r'%s/editions(.json)?/?$' % book_path, vviews.editions_page), - # interact re_path(r'^favorite/(?P\d+)/?$', actions.favorite), re_path(r'^unfavorite/(?P\d+)/?$', actions.unfavorite), re_path(r'^boost/(?P\d+)/?$', actions.boost), re_path(r'^unboost/(?P\d+)/?$', actions.unboost), + # books + re_path(r'%s(.json)?/?$' % book_path, vviews.book_page), + re_path(r'%s/edit/?$' % book_path, vviews.edit_book_page), + re_path(r'^author/(?P[\w\-]+)/edit/?$', vviews.edit_author_page), + re_path(r'%s/editions(.json)?/?$' % book_path, vviews.editions_page), + re_path(r'^tag/?$', actions.tag), + re_path(r'^untag/?$', actions.untag), re_path(r'^author/(?P[\w\-]+)(.json)?/?$', vviews.author_page), re_path(r'^tag/(?P.+)\.json/?$', vviews.tag_page), diff --git a/bookwyrm/views/helpers.py b/bookwyrm/views/helpers.py index effc2463..3c3afcce 100644 --- a/bookwyrm/views/helpers.py +++ b/bookwyrm/views/helpers.py @@ -1,6 +1,12 @@ ''' helper functions used in various views ''' +import re +from requests import HTTPError from django.db.models import Q -from bookwyrm import models + +from bookwyrm import activitypub, models +from bookwyrm.connectors import ConnectorException, get_data +from bookwyrm.utils import regex + def get_user_from_username(username): ''' helper function to resolve a localname or a username to a user ''' From c8efa1ffc8bbe68380da54cd4f2b12385fe0bb5e Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 08:04:43 -0800 Subject: [PATCH 14/34] Fixes status tests and adds delete test --- bookwyrm/tests/views/test_status.py | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/bookwyrm/tests/views/test_status.py b/bookwyrm/tests/views/test_status.py index 3d81b46f..6e0c73df 100644 --- a/bookwyrm/tests/views/test_status.py +++ b/bookwyrm/tests/views/test_status.py @@ -43,14 +43,14 @@ class StatusViews(TestCase): content='hi', user=self.local_user) request = self.factory.get('') request.user = self.local_user - with patch('bookwyrm.views.is_api_request') as is_api: + with patch('bookwyrm.views.status.is_api_request') as is_api: is_api.return_value = False result = view(request, 'mouse', status.id) self.assertIsInstance(result, TemplateResponse) self.assertEqual(result.template_name, 'status.html') self.assertEqual(result.status_code, 200) - with patch('bookwyrm.views.is_api_request') as is_api: + with patch('bookwyrm.views.status.is_api_request') as is_api: is_api.return_value = True result = view(request, 'mouse', status.id) self.assertIsInstance(result, ActivitypubResponse) @@ -71,7 +71,7 @@ class StatusViews(TestCase): self.assertEqual(result.template_name, 'status.html') self.assertEqual(result.status_code, 200) - with patch('bookwyrm.views.is_api_request') as is_api: + with patch('bookwyrm.views.status.is_api_request') as is_api: is_api.return_value = True result = view(request, 'mouse', status.id) self.assertIsInstance(result, ActivitypubResponse) @@ -257,3 +257,17 @@ class StatusViews(TestCase): result, '

    hi and fish.com ' \ 'is rad

    ') + + + def test_handle_delete_status(self): + ''' marks a status as deleted ''' + view = views.DeleteStatus.as_view() + status = models.Status.objects.create( + user=self.local_user, content='hi') + self.assertFalse(status.deleted) + request = self.factory.post('') + request.user = self.local_user + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request, status.id) + status.refresh_from_db() + self.assertTrue(status.deleted) From cf2b9937c6a0dd58141e1c808351a97f11397036 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 08:10:50 -0800 Subject: [PATCH 15/34] Adds fav/boost class view --- bookwyrm/outgoing.py | 97 --------------- bookwyrm/tests/test_outgoing.py | 109 ---------------- bookwyrm/tests/views/test_interaction.py | 152 +++++++++++++++++++++++ bookwyrm/urls.py | 8 +- bookwyrm/view_actions.py | 9 -- bookwyrm/views/__init__.py | 1 + bookwyrm/views/interaction.py | 131 +++++++++++++++++++ bookwyrm/views/status.py | 2 +- 8 files changed, 289 insertions(+), 220 deletions(-) create mode 100644 bookwyrm/tests/views/test_interaction.py create mode 100644 bookwyrm/views/interaction.py diff --git a/bookwyrm/outgoing.py b/bookwyrm/outgoing.py index 1e80852b..546d1201 100644 --- a/bookwyrm/outgoing.py +++ b/bookwyrm/outgoing.py @@ -16,7 +16,6 @@ from bookwyrm.broadcast import broadcast from bookwyrm.sanitize_html import InputHtmlParser from bookwyrm.status import create_notification from bookwyrm.status import create_generated_note -from bookwyrm.status import delete_status from bookwyrm.settings import DOMAIN from bookwyrm.utils import regex @@ -211,99 +210,3 @@ def handle_imported_book(user, item, include_reviews, privacy): # we don't need to send out pure activities because non-bookwyrm # instances don't need this data broadcast(user, review.to_create_activity(user), privacy=privacy) - - -def handle_favorite(user, status): - ''' a user likes a status ''' - try: - favorite = models.Favorite.objects.create( - status=status, - user=user - ) - except IntegrityError: - # you already fav'ed that - return - - fav_activity = favorite.to_activity() - broadcast( - user, fav_activity, privacy='direct', direct_recipients=[status.user]) - if status.user.local: - create_notification( - status.user, - 'FAVORITE', - related_user=user, - related_status=status - ) - - -def handle_unfavorite(user, status): - ''' a user likes a status ''' - try: - favorite = models.Favorite.objects.get( - status=status, - user=user - ) - except models.Favorite.DoesNotExist: - # can't find that status, idk - return - - fav_activity = favorite.to_undo_activity(user) - favorite.delete() - broadcast(user, fav_activity, direct_recipients=[status.user]) - - # check for notification - if status.user.local: - notification = models.Notification.objects.filter( - user=status.user, related_user=user, - related_status=status, notification_type='FAVORITE' - ).first() - if notification: - notification.delete() - - -def handle_boost(user, status): - ''' a user wishes to boost a status ''' - # is it boostable? - if not status.boostable: - return - - if models.Boost.objects.filter( - boosted_status=status, user=user).exists(): - # you already boosted that. - return - boost = models.Boost.objects.create( - boosted_status=status, - privacy=status.privacy, - user=user, - ) - - boost_activity = boost.to_activity() - broadcast(user, boost_activity) - - if status.user.local: - create_notification( - status.user, - 'BOOST', - related_user=user, - related_status=status - ) - - -def handle_unboost(user, status): - ''' a user regrets boosting a status ''' - boost = models.Boost.objects.filter( - boosted_status=status, user=user - ).first() - activity = boost.to_undo_activity(user) - - boost.delete() - broadcast(user, activity) - - # delete related notification - if status.user.local: - notification = models.Notification.objects.filter( - user=status.user, related_user=user, - related_status=status, notification_type='BOOST' - ).first() - if notification: - notification.delete() diff --git a/bookwyrm/tests/test_outgoing.py b/bookwyrm/tests/test_outgoing.py index 956862e0..ec29b48d 100644 --- a/bookwyrm/tests/test_outgoing.py +++ b/bookwyrm/tests/test_outgoing.py @@ -430,112 +430,3 @@ class Outgoing(TestCase): self.assertFalse(models.Review.objects.filter( book=self.book, user=self.local_user ).exists()) - - - def test_handle_delete_status(self): - ''' marks a status as deleted ''' - status = models.Status.objects.create( - user=self.local_user, content='hi') - self.assertFalse(status.deleted) - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_delete_status(self.local_user, status) - status.refresh_from_db() - self.assertTrue(status.deleted) - - - def test_handle_favorite(self): - ''' create and broadcast faving a status ''' - status = models.Status.objects.create( - user=self.local_user, content='hi') - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_favorite(self.remote_user, status) - fav = models.Favorite.objects.get() - self.assertEqual(fav.status, status) - self.assertEqual(fav.user, self.remote_user) - - notification = models.Notification.objects.get() - self.assertEqual(notification.notification_type, 'FAVORITE') - self.assertEqual(notification.user, self.local_user) - self.assertEqual(notification.related_user, self.remote_user) - - - def test_handle_unfavorite(self): - ''' unfav a status ''' - status = models.Status.objects.create( - user=self.local_user, content='hi') - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_favorite(self.remote_user, status) - - self.assertEqual(models.Favorite.objects.count(), 1) - self.assertEqual(models.Notification.objects.count(), 1) - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_unfavorite(self.remote_user, status) - self.assertEqual(models.Favorite.objects.count(), 0) - self.assertEqual(models.Notification.objects.count(), 0) - - - def test_handle_boost(self): - ''' boost a status ''' - status = models.Status.objects.create( - user=self.local_user, content='hi') - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_boost(self.remote_user, status) - - boost = models.Boost.objects.get() - self.assertEqual(boost.boosted_status, status) - self.assertEqual(boost.user, self.remote_user) - self.assertEqual(boost.privacy, 'public') - - notification = models.Notification.objects.get() - self.assertEqual(notification.notification_type, 'BOOST') - self.assertEqual(notification.user, self.local_user) - self.assertEqual(notification.related_user, self.remote_user) - self.assertEqual(notification.related_status, status) - - def test_handle_boost_unlisted(self): - ''' boost a status ''' - status = models.Status.objects.create( - user=self.local_user, content='hi', privacy='unlisted') - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_boost(self.remote_user, status) - - boost = models.Boost.objects.get() - self.assertEqual(boost.privacy, 'unlisted') - - def test_handle_boost_private(self): - ''' boost a status ''' - status = models.Status.objects.create( - user=self.local_user, content='hi', privacy='followers') - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_boost(self.remote_user, status) - self.assertFalse(models.Boost.objects.exists()) - - def test_handle_boost_twice(self): - ''' boost a status ''' - status = models.Status.objects.create( - user=self.local_user, content='hi') - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_boost(self.remote_user, status) - outgoing.handle_boost(self.remote_user, status) - self.assertEqual(models.Boost.objects.count(), 1) - - - def test_handle_unboost(self): - ''' undo a boost ''' - status = models.Status.objects.create( - user=self.local_user, content='hi') - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_boost(self.remote_user, status) - - self.assertEqual(models.Boost.objects.count(), 1) - self.assertEqual(models.Notification.objects.count(), 1) - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_unboost(self.remote_user, status) - self.assertEqual(models.Boost.objects.count(), 0) - self.assertEqual(models.Notification.objects.count(), 0) diff --git a/bookwyrm/tests/views/test_interaction.py b/bookwyrm/tests/views/test_interaction.py new file mode 100644 index 00000000..c77d6f28 --- /dev/null +++ b/bookwyrm/tests/views/test_interaction.py @@ -0,0 +1,152 @@ +''' test for app action functionality ''' +from unittest.mock import patch +from django.test import TestCase +from django.test.client import RequestFactory + +from bookwyrm import models, views + + +class InteractionViews(TestCase): + ''' viewing and creating statuses ''' + def setUp(self): + ''' we need basic test data and mocks ''' + self.factory = RequestFactory() + self.local_user = models.User.objects.create_user( + 'mouse@local.com', 'mouse@mouse.com', 'mouseword', + local=True, localname='mouse', + remote_id='https://example.com/users/mouse', + ) + with patch('bookwyrm.models.user.set_remote_server'): + self.remote_user = models.User.objects.create_user( + 'rat', 'rat@email.com', 'ratword', + local=False, + remote_id='https://example.com/users/rat', + inbox='https://example.com/users/rat/inbox', + outbox='https://example.com/users/rat/outbox', + ) + + work = models.Work.objects.create(title='Test Work') + self.book = models.Edition.objects.create( + title='Example Edition', + remote_id='https://example.com/book/1', + parent_work=work + ) + + + def test_handle_favorite(self): + ''' create and broadcast faving a status ''' + view = views.Favorite.as_view() + request = self.factory.post('') + request.user = self.local_user + status = models.Status.objects.create( + user=self.local_user, content='hi') + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request, status) + fav = models.Favorite.objects.get() + self.assertEqual(fav.status, status) + self.assertEqual(fav.user, self.remote_user) + + notification = models.Notification.objects.get() + self.assertEqual(notification.notification_type, 'FAVORITE') + self.assertEqual(notification.user, self.local_user) + self.assertEqual(notification.related_user, self.remote_user) + + + def test_handle_unfavorite(self): + ''' unfav a status ''' + view = views.Unfavorite.as_view() + request = self.factory.post('') + request.user = self.local_user + status = models.Status.objects.create( + user=self.local_user, content='hi') + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request, status) + + self.assertEqual(models.Favorite.objects.count(), 1) + self.assertEqual(models.Notification.objects.count(), 1) + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request, status) + self.assertEqual(models.Favorite.objects.count(), 0) + self.assertEqual(models.Notification.objects.count(), 0) + + + def test_handle_boost(self): + ''' boost a status ''' + view = views.Boost.as_view() + request = self.factory.post('') + request.user = self.local_user + status = models.Status.objects.create( + user=self.local_user, content='hi') + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request, status) + + boost = models.Boost.objects.get() + self.assertEqual(boost.boosted_status, status) + self.assertEqual(boost.user, self.remote_user) + self.assertEqual(boost.privacy, 'public') + + notification = models.Notification.objects.get() + self.assertEqual(notification.notification_type, 'BOOST') + self.assertEqual(notification.user, self.local_user) + self.assertEqual(notification.related_user, self.remote_user) + self.assertEqual(notification.related_status, status) + + def test_handle_boost_unlisted(self): + ''' boost a status ''' + view = views.Boost.as_view() + request = self.factory.post('') + request.user = self.local_user + status = models.Status.objects.create( + user=self.local_user, content='hi', privacy='unlisted') + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request, status) + + boost = models.Boost.objects.get() + self.assertEqual(boost.privacy, 'unlisted') + + def test_handle_boost_private(self): + ''' boost a status ''' + view = views.Boost.as_view() + request = self.factory.post('') + request.user = self.local_user + status = models.Status.objects.create( + user=self.local_user, content='hi', privacy='followers') + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request, status) + self.assertFalse(models.Boost.objects.exists()) + + def test_handle_boost_twice(self): + ''' boost a status ''' + view = views.Boost.as_view() + request = self.factory.post('') + request.user = self.local_user + status = models.Status.objects.create( + user=self.local_user, content='hi') + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request, status) + view(request, status) + self.assertEqual(models.Boost.objects.count(), 1) + + + def test_handle_unboost(self): + ''' undo a boost ''' + view = views.Unboost.as_view() + request = self.factory.post('') + request.user = self.local_user + status = models.Status.objects.create( + user=self.local_user, content='hi') + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request, status) + + self.assertEqual(models.Boost.objects.count(), 1) + self.assertEqual(models.Notification.objects.count(), 1) + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request, status) + self.assertEqual(models.Boost.objects.count(), 0) + self.assertEqual(models.Notification.objects.count(), 0) diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index a6e0cd30..dfd2ff81 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -82,10 +82,10 @@ urlpatterns = [ views.DeleteStatus.as_view()), # interact - re_path(r'^favorite/(?P\d+)/?$', actions.favorite), - re_path(r'^unfavorite/(?P\d+)/?$', actions.unfavorite), - re_path(r'^boost/(?P\d+)/?$', actions.boost), - re_path(r'^unboost/(?P\d+)/?$', actions.unboost), + re_path(r'^favorite/(?P\d+)/?$', views.Favorite.as_view()), + re_path(r'^unfavorite/(?P\d+)/?$', views.Unfavorite.as_view()), + re_path(r'^boost/(?P\d+)/?$', views.Boost.as_view()), + re_path(r'^unboost/(?P\d+)/?$', views.Unboost.as_view()), # books re_path(r'%s(.json)?/?$' % book_path, vviews.book_page), diff --git a/bookwyrm/view_actions.py b/bookwyrm/view_actions.py index 6b818350..1a6edd7f 100644 --- a/bookwyrm/view_actions.py +++ b/bookwyrm/view_actions.py @@ -378,15 +378,6 @@ def untag(request): return redirect('/book/%s' % book_id) -@login_required -@require_POST -def favorite(request, status_id): - ''' like a status ''' - status = models.Status.objects.get(id=status_id) - outgoing.handle_favorite(request.user, status) - return redirect(request.headers.get('Referer', '/')) - - @login_required @require_POST def unfavorite(request, status_id): diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 1714c59e..2611184b 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -8,3 +8,4 @@ from .direct_message import DirectMessage from .import_data import Import, ImportStatus from .user import User, EditUser, Followers, Following from .status import Status, Replies, CreateStatus, DeleteStatus +from .interaction import Favorite, Unfavorite, Boost, Unboost diff --git a/bookwyrm/views/interaction.py b/bookwyrm/views/interaction.py new file mode 100644 index 00000000..2c5de375 --- /dev/null +++ b/bookwyrm/views/interaction.py @@ -0,0 +1,131 @@ +''' boosts and favs ''' +from django.db import IntegrityError +from django.contrib.auth.decorators import login_required +from django.http import HttpResponseBadRequest, HttpResponseNotFound +from django.shortcuts import redirect +from django.utils.decorators import method_decorator +from django.views import View + +from bookwyrm import models +from bookwyrm.broadcast import broadcast +from bookwyrm.status import create_notification + + +# pylint: disable= no-self-use +@method_decorator(login_required, name='dispatch') +class Favorite(View): + ''' like a status ''' + def post(self, request, status_id): + ''' create a like ''' + status = models.Status.objects.get(id=status_id) + try: + favorite = models.Favorite.objects.create( + status=status, + user=request.user + ) + except IntegrityError: + # you already fav'ed that + return HttpResponseBadRequest() + + fav_activity = favorite.to_activity() + broadcast( + request.user, fav_activity, privacy='direct', + direct_recipients=[status.user]) + if status.user.local: + create_notification( + status.user, + 'FAVORITE', + related_user=request.user, + related_status=status + ) + return redirect(request.headers.get('Referer', '/')) + + +@method_decorator(login_required, name='dispatch') +class Unfavorite(View): + ''' take back a fav ''' + def post(self, request, status_id): + ''' unlike a status ''' + status = models.Status.objects.get(id=status_id) + try: + favorite = models.Favorite.objects.get( + status=status, + user=request.user + ) + except models.Favorite.DoesNotExist: + # can't find that status, idk + return HttpResponseNotFound() + + fav_activity = favorite.to_undo_activity(request.user) + favorite.delete() + broadcast(request.user, fav_activity, direct_recipients=[status.user]) + + # check for notification + if status.user.local: + notification = models.Notification.objects.filter( + user=status.user, related_user=request.user, + related_status=status, notification_type='FAVORITE' + ).first() + if notification: + notification.delete() + return redirect(request.headers.get('Referer', '/')) + + +@method_decorator(login_required, name='dispatch') +class Boost(View): + ''' boost a status ''' + def post(self, request, status_id): + ''' boost a status ''' + status = models.Status.objects.get(id=status_id) + # is it boostable? + if not status.boostable: + return HttpResponseBadRequest() + + if models.Boost.objects.filter( + boosted_status=status, user=request.user).exists(): + # you already boosted that. + return redirect(request.headers.get('Referer', '/')) + + boost = models.Boost.objects.create( + boosted_status=status, + privacy=status.privacy, + user=request.user, + ) + + boost_activity = boost.to_activity() + broadcast(request.user, boost_activity) + + if status.user.local: + create_notification( + status.user, + 'BOOST', + related_user=request.user, + related_status=status + ) + return redirect(request.headers.get('Referer', '/')) + + + +@method_decorator(login_required, name='dispatch') +class Unboost(View): + ''' boost a status ''' + def post(self, request, status_id): + ''' boost a status ''' + status = models.Status.objects.get(id=status_id) + boost = models.Boost.objects.filter( + boosted_status=status, user=request.user + ).first() + activity = boost.to_undo_activity(request.user) + + boost.delete() + broadcast(request.user, activity) + + # delete related notification + if status.user.local: + notification = models.Notification.objects.filter( + user=status.user, related_user=request.user, + related_status=status, notification_type='BOOST' + ).first() + if notification: + notification.delete() + return redirect(request.headers.get('Referer', '/')) diff --git a/bookwyrm/views/status.py b/bookwyrm/views/status.py index 60a1f814..39cd6077 100644 --- a/bookwyrm/views/status.py +++ b/bookwyrm/views/status.py @@ -1,4 +1,4 @@ -''' non-interactive pages ''' +''' what are we here for if not for posting ''' import re from django.contrib.auth.decorators import login_required from django.http import HttpResponseBadRequest, HttpResponseNotFound From 56e3e98bc12a3c27a3e70c6b59bfea4a03ded497 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 09:42:54 -0800 Subject: [PATCH 16/34] Adds book class view and re-works pagination --- bookwyrm/templates/book.html | 35 ++-- bookwyrm/templates/direct_messages.html | 20 +- bookwyrm/templates/edit_book.html | 2 +- bookwyrm/templates/feed.html | 20 +- bookwyrm/templates/snippets/pagination.html | 19 ++ bookwyrm/templates/user.html | 22 +-- bookwyrm/tests/views/test_book.py | 127 +++++++++++++ bookwyrm/urls.py | 19 +- bookwyrm/view_actions.py | 127 ------------- bookwyrm/views/__init__.py | 2 + bookwyrm/views/direct_message.py | 12 +- bookwyrm/views/helpers.py | 10 + bookwyrm/views/interaction.py | 1 - bookwyrm/views/landing.py | 13 +- bookwyrm/views/user.py | 13 +- bookwyrm/vviews.py | 194 +------------------- 16 files changed, 197 insertions(+), 439 deletions(-) create mode 100644 bookwyrm/templates/snippets/pagination.html create mode 100644 bookwyrm/tests/views/test_book.py diff --git a/bookwyrm/templates/book.html b/bookwyrm/templates/book.html index 35c8dd5f..f792408c 100644 --- a/bookwyrm/templates/book.html +++ b/bookwyrm/templates/book.html @@ -223,7 +223,7 @@
    -
    +
    {% for review in reviews %}
    {% include 'snippets/status.html' with status=review hide_book=True depth=1 %} @@ -231,25 +231,28 @@ {% endfor %}
    - {% for rating in ratings %} -
    -
    -
    {% include 'snippets/avatar.html' with user=rating.user %}
    -
    -
    - {% include 'snippets/username.html' with user=rating.user %} -
    -
    -
    rated it
    - {% include 'snippets/stars.html' with rating=rating.rating %} -
    -
    - {{ rating.published_date | naturaltime }} + {% for rating in ratings %} +
    +
    +
    {% include 'snippets/avatar.html' with user=rating.user %}
    +
    +
    + {% include 'snippets/username.html' with user=rating.user %} +
    +
    +
    rated it
    + {% include 'snippets/stars.html' with rating=rating.rating %} +
    +
    + {% endfor %}
    - {% endfor %} +
    + {% include 'snippets/pagination.html' with page=reviews path=book.local_path anchor="#reviews" %}
    diff --git a/bookwyrm/templates/direct_messages.html b/bookwyrm/templates/direct_messages.html index 6a20b111..666f5290 100644 --- a/bookwyrm/templates/direct_messages.html +++ b/bookwyrm/templates/direct_messages.html @@ -13,25 +13,7 @@
    {% endfor %} - + {% include 'snippets/pagination.html' with page=activities path="direct-messages" %}
    {% endblock %} diff --git a/bookwyrm/templates/edit_book.html b/bookwyrm/templates/edit_book.html index b0e262dd..27d1d5be 100644 --- a/bookwyrm/templates/edit_book.html +++ b/bookwyrm/templates/edit_book.html @@ -27,7 +27,7 @@
    {% endif %} - + {% csrf_token %}
    diff --git a/bookwyrm/templates/feed.html b/bookwyrm/templates/feed.html index f02219bc..db66a72d 100644 --- a/bookwyrm/templates/feed.html +++ b/bookwyrm/templates/feed.html @@ -94,25 +94,7 @@
    {% endfor %} - + {% include 'snippets/pagination.html' with page=activities path='/'|add:tab anchor="#feed" %}
    {% endblock %} diff --git a/bookwyrm/templates/snippets/pagination.html b/bookwyrm/templates/snippets/pagination.html new file mode 100644 index 00000000..1855dfed --- /dev/null +++ b/bookwyrm/templates/snippets/pagination.html @@ -0,0 +1,19 @@ + diff --git a/bookwyrm/templates/user.html b/bookwyrm/templates/user.html index 2d3fac1e..dd5ca94c 100644 --- a/bookwyrm/templates/user.html +++ b/bookwyrm/templates/user.html @@ -45,7 +45,7 @@

    User Activity

    {% for activity in activities %} -
    +
    {% include 'snippets/status.html' with status=activity %}
    {% endfor %} @@ -55,25 +55,7 @@
    {% endif %} - + {% include 'snippets/pagination.html' with page=activities path=user.local_path anchor="#feed" %}
    {% endblock %} diff --git a/bookwyrm/tests/views/test_book.py b/bookwyrm/tests/views/test_book.py new file mode 100644 index 00000000..a9475772 --- /dev/null +++ b/bookwyrm/tests/views/test_book.py @@ -0,0 +1,127 @@ +''' test for app action functionality ''' +from unittest.mock import patch +from django.contrib.auth.models import Group, Permission +from django.contrib.contenttypes.models import ContentType +from django.template.response import TemplateResponse +from django.test import TestCase +from django.test.client import RequestFactory + +from bookwyrm import forms, models, views +from bookwyrm.activitypub import ActivitypubResponse + + +class InteractionViews(TestCase): + ''' viewing and creating statuses ''' + def setUp(self): + ''' we need basic test data and mocks ''' + self.factory = RequestFactory() + self.local_user = models.User.objects.create_user( + 'mouse@local.com', 'mouse@mouse.com', 'mouseword', + local=True, localname='mouse', + remote_id='https://example.com/users/mouse', + ) + self.group = Group.objects.create(name='editor') + self.group.permissions.add( + Permission.objects.create( + name='edit_book', + codename='edit_book', + content_type=ContentType.objects.get_for_model(models.User)).id + ) + self.work = models.Work.objects.create(title='Test Work') + self.book = models.Edition.objects.create( + title='Example Edition', + remote_id='https://example.com/book/1', + parent_work=self.work + ) + + + def test_book_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.Book.as_view() + request = self.factory.get('') + request.user = self.local_user + with patch('bookwyrm.views.books.is_api_request') as is_api: + is_api.return_value = False + result = view(request, self.book.id) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'book.html') + self.assertEqual(result.status_code, 200) + + request = self.factory.get('') + with patch('bookwyrm.views.books.is_api_request') as is_api: + is_api.return_value = True + result = view(request, self.book.id) + self.assertIsInstance(result, ActivitypubResponse) + self.assertEqual(result.status_code, 200) + + + def test_edit_book_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.EditBook.as_view() + request = self.factory.get('') + request.user = self.local_user + request.user.is_superuser = True + result = view(request, self.book.id) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'edit_book.html') + self.assertEqual(result.status_code, 200) + + + def test_edit_book(self): + ''' lets a user edit a book ''' + view = views.EditBook.as_view() + self.local_user.groups.add(self.group) + form = forms.EditionForm(instance=self.book) + form.data['title'] = 'New Title' + form.data['last_edited_by'] = self.local_user.id + request = self.factory.post('', form.data) + request.user = self.local_user + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request, self.book.id) + self.book.refresh_from_db() + self.assertEqual(self.book.title, 'New Title') + + + def test_switch_edition(self): + ''' updates user's relationships to a book ''' + work = models.Work.objects.create(title='test work') + edition1 = models.Edition.objects.create( + title='first ed', parent_work=work) + edition2 = models.Edition.objects.create( + title='second ed', parent_work=work) + shelf = models.Shelf.objects.create( + name='Test Shelf', user=self.local_user) + shelf.books.add(edition1) + models.ReadThrough.objects.create( + user=self.local_user, book=edition1) + + self.assertEqual(models.ShelfBook.objects.get().book, edition1) + self.assertEqual(models.ReadThrough.objects.get().book, edition1) + request = self.factory.post('', { + 'edition': edition2.id + }) + request.user = self.local_user + with patch('bookwyrm.broadcast.broadcast_task.delay'): + views.switch_edition(request) + + self.assertEqual(models.ShelfBook.objects.get().book, edition2) + self.assertEqual(models.ReadThrough.objects.get().book, edition2) + + + def test_editions_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.Editions.as_view() + request = self.factory.get('') + with patch('bookwyrm.views.books.is_api_request') as is_api: + is_api.return_value = False + result = view(request, self.work.id) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'editions.html') + self.assertEqual(result.status_code, 200) + + request = self.factory.get('') + with patch('bookwyrm.views.books.is_api_request') as is_api: + is_api.return_value = True + result = view(request, self.work.id) + self.assertIsInstance(result, ActivitypubResponse) + self.assertEqual(result.status_code, 200) diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index dfd2ff81..186a0d94 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -88,10 +88,16 @@ urlpatterns = [ re_path(r'^unboost/(?P\d+)/?$', views.Unboost.as_view()), # books - re_path(r'%s(.json)?/?$' % book_path, vviews.book_page), - re_path(r'%s/edit/?$' % book_path, vviews.edit_book_page), + re_path(r'%s(.json)?/?$' % book_path, views.Book.as_view()), + re_path(r'%s/edit/?$' % book_path, views.EditBook.as_view()), + re_path(r'%s/editions(.json)?/?$' % book_path, views.Editions.as_view()), + re_path(r'^upload-cover/(?P\d+)/?$', views.upload_cover), + re_path(r'^add-description/(?P\d+)/?$', views.add_description), + re_path(r'^resolve-book/?$', views.resolve_book), + re_path(r'^switch-edition/?$', views.switch_edition), + re_path(r'^author/(?P[\w\-]+)/edit/?$', vviews.edit_author_page), - re_path(r'%s/editions(.json)?/?$' % book_path, vviews.editions_page), + re_path(r'^tag/?$', actions.tag), re_path(r'^untag/?$', actions.untag), @@ -105,15 +111,8 @@ urlpatterns = [ re_path(r'^search/?$', vviews.search), - # internal action endpoints - - re_path(r'^resolve-book/?$', actions.resolve_book), - re_path(r'^edit-book/(?P\d+)/?$', actions.edit_book), - re_path(r'^upload-cover/(?P\d+)/?$', actions.upload_cover), - re_path(r'^add-description/(?P\d+)/?$', actions.add_description), re_path(r'^edit-author/(?P\d+)/?$', actions.edit_author), - re_path(r'^switch-edition/?$', actions.switch_edition), re_path(r'^edit-readthrough/?$', actions.edit_readthrough), re_path(r'^delete-readthrough/?$', actions.delete_readthrough), re_path(r'^create-readthrough/?$', actions.create_readthrough), diff --git a/bookwyrm/view_actions.py b/bookwyrm/view_actions.py index 1a6edd7f..f2456491 100644 --- a/bookwyrm/view_actions.py +++ b/bookwyrm/view_actions.py @@ -3,7 +3,6 @@ import dateutil.parser from dateutil.parser import ParserError from django.contrib.auth.decorators import login_required, permission_required -from django.db import transaction from django.http import HttpResponseBadRequest, HttpResponseNotFound from django.shortcuts import get_object_or_404, redirect from django.template.response import TemplateResponse @@ -11,108 +10,9 @@ from django.utils import timezone from django.views.decorators.http import require_POST from bookwyrm import forms, models, outgoing -from bookwyrm.connectors import connector_manager from bookwyrm.broadcast import broadcast from bookwyrm.vviews import get_user_from_username, get_edition - -@require_POST -def resolve_book(request): - ''' figure out the local path to a book from a remote_id ''' - remote_id = request.POST.get('remote_id') - connector = connector_manager.get_or_create_connector(remote_id) - book = connector.get_or_create_book(remote_id) - - return redirect('/book/%d' % book.id) - - -@login_required -@permission_required('bookwyrm.edit_book', raise_exception=True) -@require_POST -def edit_book(request, book_id): - ''' edit a book cool ''' - book = get_object_or_404(models.Edition, id=book_id) - - form = forms.EditionForm(request.POST, request.FILES, instance=book) - if not form.is_valid(): - data = { - 'title': 'Edit Book', - 'book': book, - 'form': form - } - return TemplateResponse(request, 'edit_book.html', data) - book = form.save() - - broadcast(request.user, book.to_update_activity(request.user)) - return redirect('/book/%s' % book.id) - - -@login_required -@require_POST -@transaction.atomic -def switch_edition(request): - ''' switch your copy of a book to a different edition ''' - edition_id = request.POST.get('edition') - new_edition = get_object_or_404(models.Edition, id=edition_id) - shelfbooks = models.ShelfBook.objects.filter( - book__parent_work=new_edition.parent_work, - shelf__user=request.user - ) - for shelfbook in shelfbooks.all(): - broadcast(request.user, shelfbook.to_remove_activity(request.user)) - - shelfbook.book = new_edition - shelfbook.save() - - broadcast(request.user, shelfbook.to_add_activity(request.user)) - - readthroughs = models.ReadThrough.objects.filter( - book__parent_work=new_edition.parent_work, - user=request.user - ) - for readthrough in readthroughs.all(): - readthrough.book = new_edition - readthrough.save() - - return redirect('/book/%d' % new_edition.id) - - -@login_required -@require_POST -def upload_cover(request, book_id): - ''' upload a new cover ''' - book = get_object_or_404(models.Edition, id=book_id) - - form = forms.CoverForm(request.POST, request.FILES, instance=book) - if not form.is_valid(): - return redirect('/book/%d' % book.id) - - book.cover = form.files['cover'] - book.save() - - broadcast(request.user, book.to_update_activity(request.user)) - return redirect('/book/%s' % book.id) - - -@login_required -@require_POST -@permission_required('bookwyrm.edit_book', raise_exception=True) -def add_description(request, book_id): - ''' upload a new cover ''' - if not request.method == 'POST': - return redirect('/') - - book = get_object_or_404(models.Edition, id=book_id) - - description = request.POST.get('description') - - book.description = description - book.save() - - broadcast(request.user, book.to_update_activity(request.user)) - return redirect('/book/%s' % book.id) - - @login_required @permission_required('bookwyrm.edit_book', raise_exception=True) @require_POST @@ -378,33 +278,6 @@ def untag(request): return redirect('/book/%s' % book_id) -@login_required -@require_POST -def unfavorite(request, status_id): - ''' like a status ''' - status = models.Status.objects.get(id=status_id) - outgoing.handle_unfavorite(request.user, status) - return redirect(request.headers.get('Referer', '/')) - - -@login_required -@require_POST -def boost(request, status_id): - ''' boost a status ''' - status = models.Status.objects.get(id=status_id) - outgoing.handle_boost(request.user, status) - return redirect(request.headers.get('Referer', '/')) - - -@login_required -@require_POST -def unboost(request, status_id): - ''' boost a status ''' - status = models.Status.objects.get(id=status_id) - outgoing.handle_unboost(request.user, status) - return redirect(request.headers.get('Referer', '/')) - - @login_required @require_POST def follow(request): diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 2611184b..52f4f36f 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -9,3 +9,5 @@ from .import_data import Import, ImportStatus from .user import User, EditUser, Followers, Following from .status import Status, Replies, CreateStatus, DeleteStatus from .interaction import Favorite, Unfavorite, Boost, Unboost +from .books import Book, EditBook, Editions +from .books import upload_cover, add_description, switch_edition, resolve_book diff --git a/bookwyrm/views/direct_message.py b/bookwyrm/views/direct_message.py index feb0c19a..1f6c4f19 100644 --- a/bookwyrm/views/direct_message.py +++ b/bookwyrm/views/direct_message.py @@ -18,19 +18,9 @@ class DirectMessage(View): activities = get_activity_feed(request.user, 'direct') paginated = Paginator(activities, PAGE_LENGTH) activity_page = paginated.page(page) - - prev_page = next_page = None - if activity_page.has_next(): - next_page = '/direct-message/?page=%d#feed' % \ - activity_page.next_page_number() - if activity_page.has_previous(): - prev_page = '/direct-messages/?page=%d#feed' % \ - activity_page.previous_page_number() data = { 'title': 'Direct Messages', 'user': request.user, - 'activities': activity_page.object_list, - 'next': next_page, - 'prev': prev_page, + 'activities': activity_page, } return TemplateResponse(request, 'direct_messages.html', data) diff --git a/bookwyrm/views/helpers.py b/bookwyrm/views/helpers.py index 3c3afcce..13f990fb 100644 --- a/bookwyrm/views/helpers.py +++ b/bookwyrm/views/helpers.py @@ -137,3 +137,13 @@ def handle_remote_webfinger(query): except KeyError: return None return user + + +def get_edition(book_id): + ''' look up a book in the db and return an edition ''' + book = models.Book.objects.select_subclasses().get(id=book_id) + if isinstance(book, models.Work): + book = book.get_default_edition() + return book + + diff --git a/bookwyrm/views/interaction.py b/bookwyrm/views/interaction.py index 2c5de375..a6732c52 100644 --- a/bookwyrm/views/interaction.py +++ b/bookwyrm/views/interaction.py @@ -105,7 +105,6 @@ class Boost(View): return redirect(request.headers.get('Referer', '/')) - @method_decorator(login_required, name='dispatch') class Unboost(View): ''' boost a status ''' diff --git a/bookwyrm/views/landing.py b/bookwyrm/views/landing.py index 389ab2ec..7917c5b4 100644 --- a/bookwyrm/views/landing.py +++ b/bookwyrm/views/landing.py @@ -86,23 +86,12 @@ class Feed(View): activities = get_activity_feed( request.user, ['public', 'followers']) paginated = Paginator(activities, PAGE_LENGTH) - activity_page = paginated.page(page) - - prev_page = next_page = None - if activity_page.has_next(): - next_page = '/%s/?page=%d#feed' % \ - (tab, activity_page.next_page_number()) - if activity_page.has_previous(): - prev_page = '/%s/?page=%d#feed' % \ - (tab, activity_page.previous_page_number()) data = { 'title': 'Updates Feed', 'user': request.user, 'suggested_books': suggested_books, - 'activities': activity_page.object_list, + 'activities': paginated.page(page), 'tab': tab, - 'next': next_page, - 'prev': prev_page, } return TemplateResponse(request, 'feed.html', data) diff --git a/bookwyrm/views/user.py b/bookwyrm/views/user.py index 35d06fd0..9a22c47c 100644 --- a/bookwyrm/views/user.py +++ b/bookwyrm/views/user.py @@ -70,24 +70,13 @@ class User(View): queryset=models.Status.objects.filter(user=user) ) paginated = Paginator(activities, PAGE_LENGTH) - activity_page = paginated.page(page) - - prev_page = next_page = None - if activity_page.has_next(): - next_page = '/user/%s/?page=%d' % \ - (username, activity_page.next_page_number()) - if activity_page.has_previous(): - prev_page = '/user/%s/?page=%d' % \ - (username, activity_page.previous_page_number()) data = { 'title': user.name, 'user': user, 'is_self': is_self, 'shelves': shelf_preview, 'shelf_count': shelves.count(), - 'activities': activity_page.object_list, - 'next': next_page, - 'prev': prev_page, + 'activities': paginated.page(page), } return TemplateResponse(request, 'user.html', data) diff --git a/bookwyrm/vviews.py b/bookwyrm/vviews.py index 2c7137e6..befdca2d 100644 --- a/bookwyrm/vviews.py +++ b/bookwyrm/vviews.py @@ -3,8 +3,7 @@ import re from django.contrib.auth.decorators import login_required, permission_required from django.contrib.postgres.search import TrigramSimilarity -from django.core.paginator import Paginator -from django.db.models import Avg, Q +from django.db.models import Q from django.db.models.functions import Greatest from django.http import HttpResponseNotFound, JsonResponse from django.shortcuts import get_object_or_404 @@ -16,10 +15,8 @@ from bookwyrm import outgoing from bookwyrm import forms, models from bookwyrm.activitypub import ActivitypubResponse from bookwyrm.connectors import connector_manager -from bookwyrm.settings import PAGE_LENGTH from bookwyrm.utils import regex - def get_edition(book_id): ''' look up a book in the db and return an edition ''' book = models.Book.objects.select_subclasses().get(id=book_id) @@ -27,6 +24,8 @@ def get_edition(book_id): book = book.get_default_edition() return book + + def get_user_from_username(username): ''' helper function to resolve a localname or a username to a user ''' # raises DoesNotExist if user is now found @@ -41,14 +40,6 @@ def is_api_request(request): return 'json' in request.headers.get('Accept') or \ request.path[-5:] == '.json' -def is_bookworm_request(request): - ''' check if the request is coming from another bookworm instance ''' - user_agent = request.headers.get('User-Agent') - if user_agent is None or \ - re.search(regex.bookwyrm_user_agent, user_agent) is None: - return False - - return True def server_error_page(request): ''' 500 errors ''' @@ -62,64 +53,6 @@ def not_found_page(request, _): request, 'notfound.html', {'title': 'Not found'}, status=404) -def get_activity_feed( - user, privacy, local_only=False, following_only=False, - queryset=models.Status.objects): - ''' get a filtered queryset of statuses ''' - privacy = privacy if isinstance(privacy, list) else [privacy] - # if we're looking at Status, we need this. We don't if it's Comment - if hasattr(queryset, 'select_subclasses'): - queryset = queryset.select_subclasses() - - # exclude deleted - queryset = queryset.exclude(deleted=True).order_by('-published_date') - - # you can't see followers only or direct messages if you're not logged in - if user.is_anonymous: - privacy = [p for p in privacy if not p in ['followers', 'direct']] - - # filter to only privided privacy levels - queryset = queryset.filter(privacy__in=privacy) - - # only include statuses the user follows - if following_only: - queryset = queryset.exclude( - ~Q(# remove everythign except - Q(user__in=user.following.all()) | # user follwoing - Q(user=user) |# is self - Q(mention_users=user)# mentions user - ), - ) - # exclude followers-only statuses the user doesn't follow - elif 'followers' in privacy: - queryset = queryset.exclude( - ~Q(# user isn't following and it isn't their own status - Q(user__in=user.following.all()) | Q(user=user) - ), - privacy='followers' # and the status is followers only - ) - - # exclude direct messages not intended for the user - if 'direct' in privacy: - queryset = queryset.exclude( - ~Q( - Q(user=user) | Q(mention_users=user) - ), privacy='direct' - ) - - # filter for only local status - if local_only: - queryset = queryset.filter(user__local=True) - - # remove statuses that have boosts in the same queryset - try: - queryset = queryset.filter(~Q(boosters__in=queryset)) - except ValueError: - pass - - return queryset - - @require_GET def search(request): ''' that search bar up top ''' @@ -157,111 +90,6 @@ def search(request): return TemplateResponse(request, 'search_results.html', data) -@require_GET -def book_page(request, book_id): - ''' info about a book ''' - try: - page = int(request.GET.get('page', 1)) - except ValueError: - page = 1 - - try: - book = models.Book.objects.select_subclasses().get(id=book_id) - except models.Book.DoesNotExist: - return HttpResponseNotFound() - - if is_api_request(request): - return ActivitypubResponse(book.to_activity()) - - if isinstance(book, models.Work): - book = book.get_default_edition() - if not book: - return HttpResponseNotFound() - - work = book.parent_work - if not work: - return HttpResponseNotFound() - - reviews = models.Review.objects.filter( - book__in=work.editions.all(), - ) - # all reviews for the book - reviews = get_activity_feed( - request.user, - ['public', 'unlisted', 'followers', 'direct'], - queryset=reviews - ) - - # the reviews to show - paginated = Paginator(reviews.exclude( - Q(content__isnull=True) | Q(content='') - ), PAGE_LENGTH) - reviews_page = paginated.page(page) - - prev_page = next_page = None - if reviews_page.has_next(): - next_page = '/book/%d/?page=%d' % \ - (book_id, reviews_page.next_page_number()) - if reviews_page.has_previous(): - prev_page = '/book/%s/?page=%d' % \ - (book_id, reviews_page.previous_page_number()) - - user_tags = readthroughs = user_shelves = other_edition_shelves = [] - if request.user.is_authenticated: - user_tags = models.UserTag.objects.filter( - book=book, user=request.user - ).values_list('tag__identifier', flat=True) - - readthroughs = models.ReadThrough.objects.filter( - user=request.user, - book=book, - ).order_by('start_date') - - user_shelves = models.ShelfBook.objects.filter( - added_by=request.user, book=book - ) - - other_edition_shelves = models.ShelfBook.objects.filter( - ~Q(book=book), - added_by=request.user, - book__parent_work=book.parent_work, - ) - - data = { - 'title': book.title, - 'book': book, - 'reviews': reviews_page, - 'review_count': reviews.count(), - 'ratings': reviews.filter(Q(content__isnull=True) | Q(content='')), - 'rating': reviews.aggregate(Avg('rating'))['rating__avg'], - 'tags': models.UserTag.objects.filter(book=book), - 'user_tags': user_tags, - 'user_shelves': user_shelves, - 'other_edition_shelves': other_edition_shelves, - 'readthroughs': readthroughs, - 'path': '/book/%s' % book_id, - 'next': next_page, - 'prev': prev_page, - } - return TemplateResponse(request, 'book.html', data) - - -@login_required -@permission_required('bookwyrm.edit_book', raise_exception=True) -@require_GET -def edit_book_page(request, book_id): - ''' info about a book ''' - book = get_edition(book_id) - if not book.description: - book.description = book.parent_work.description - data = { - 'title': 'Edit Book', - 'book': book, - 'form': forms.EditionForm(instance=book) - } - return TemplateResponse(request, 'edit_book.html', data) - - @login_required @permission_required('bookwyrm.edit_book', raise_exception=True) @require_GET @@ -276,22 +104,6 @@ def edit_author_page(request, author_id): return TemplateResponse(request, 'edit_author.html', data) -@require_GET -def editions_page(request, book_id): - ''' list of editions of a book ''' - work = get_object_or_404(models.Work, id=book_id) - - if is_api_request(request): - return ActivitypubResponse(work.to_edition_list(**request.GET)) - - data = { - 'title': 'Editions of %s' % work.title, - 'editions': work.editions.order_by('-edition_rank').all(), - 'work': work, - } - return TemplateResponse(request, 'editions.html', data) - - @require_GET def author_page(request, author_id): ''' landing page for an author ''' From 4dea22bef658d222e5ebd3bb6cfa45a298f8a47a Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 09:54:35 -0800 Subject: [PATCH 17/34] Author class view --- bookwyrm/templates/edit_author.html | 2 +- bookwyrm/urls.py | 7 +- bookwyrm/view_actions.py | 24 +-- bookwyrm/views/__init__.py | 1 + bookwyrm/views/author.py | 66 ++++++++ bookwyrm/views/books.py | 228 ++++++++++++++++++++++++++++ bookwyrm/vviews.py | 37 +---- 7 files changed, 301 insertions(+), 64 deletions(-) create mode 100644 bookwyrm/views/author.py create mode 100644 bookwyrm/views/books.py diff --git a/bookwyrm/templates/edit_author.html b/bookwyrm/templates/edit_author.html index b08aa983..de028d85 100644 --- a/bookwyrm/templates/edit_author.html +++ b/bookwyrm/templates/edit_author.html @@ -27,7 +27,7 @@
    {% endif %} - + {% csrf_token %} diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index 186a0d94..260164b7 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -96,12 +96,13 @@ urlpatterns = [ re_path(r'^resolve-book/?$', views.resolve_book), re_path(r'^switch-edition/?$', views.switch_edition), - re_path(r'^author/(?P[\w\-]+)/edit/?$', vviews.edit_author_page), + # author + re_path(r'^author/(?P\d+)(.json)?/?$', views.Author.as_view()), + re_path(r'^author/(?P\d+)/edit/?$', views.EditAuthor.as_view()), re_path(r'^tag/?$', actions.tag), re_path(r'^untag/?$', actions.untag), - re_path(r'^author/(?P[\w\-]+)(.json)?/?$', vviews.author_page), re_path(r'^tag/(?P.+)\.json/?$', vviews.tag_page), re_path(r'^tag/(?P.+)/?$', vviews.tag_page), re_path(r'^%s/shelf/(?P[\w-]+)(.json)?/?$' % \ @@ -111,8 +112,6 @@ urlpatterns = [ re_path(r'^search/?$', vviews.search), - re_path(r'^edit-author/(?P\d+)/?$', actions.edit_author), - re_path(r'^edit-readthrough/?$', actions.edit_readthrough), re_path(r'^delete-readthrough/?$', actions.delete_readthrough), re_path(r'^create-readthrough/?$', actions.create_readthrough), diff --git a/bookwyrm/view_actions.py b/bookwyrm/view_actions.py index f2456491..c349f3f9 100644 --- a/bookwyrm/view_actions.py +++ b/bookwyrm/view_actions.py @@ -2,10 +2,9 @@ import dateutil.parser from dateutil.parser import ParserError -from django.contrib.auth.decorators import login_required, permission_required +from django.contrib.auth.decorators import login_required from django.http import HttpResponseBadRequest, HttpResponseNotFound from django.shortcuts import get_object_or_404, redirect -from django.template.response import TemplateResponse from django.utils import timezone from django.views.decorators.http import require_POST @@ -13,27 +12,6 @@ from bookwyrm import forms, models, outgoing from bookwyrm.broadcast import broadcast from bookwyrm.vviews import get_user_from_username, get_edition -@login_required -@permission_required('bookwyrm.edit_book', raise_exception=True) -@require_POST -def edit_author(request, author_id): - ''' edit a author cool ''' - author = get_object_or_404(models.Author, id=author_id) - - form = forms.AuthorForm(request.POST, request.FILES, instance=author) - if not form.is_valid(): - data = { - 'title': 'Edit Author', - 'author': author, - 'form': form - } - return TemplateResponse(request, 'edit_author.html', data) - author = form.save() - - broadcast(request.user, author.to_update_activity(request.user)) - return redirect('/author/%s' % author.id) - - @login_required @require_POST def create_shelf(request): diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 52f4f36f..0d01fb56 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -11,3 +11,4 @@ from .status import Status, Replies, CreateStatus, DeleteStatus from .interaction import Favorite, Unfavorite, Boost, Unboost from .books import Book, EditBook, Editions from .books import upload_cover, add_description, switch_edition, resolve_book +from .author import Author, EditAuthor diff --git a/bookwyrm/views/author.py b/bookwyrm/views/author.py new file mode 100644 index 00000000..ad9d1873 --- /dev/null +++ b/bookwyrm/views/author.py @@ -0,0 +1,66 @@ +''' the good people stuff! the authors! ''' +from django.contrib.auth.decorators import login_required, permission_required +from django.db.models import Q +from django.shortcuts import get_object_or_404, redirect +from django.template.response import TemplateResponse +from django.utils.decorators import method_decorator +from django.views import View + +from bookwyrm import forms, models +from bookwyrm.activitypub import ActivitypubResponse +from bookwyrm.broadcast import broadcast +from .helpers import is_api_request + + +# pylint: disable= no-self-use +class Author(View): + ''' this person wrote a book ''' + def get(self, request, author_id): + ''' landing page for an author ''' + author = get_object_or_404(models.Author, id=author_id) + + if is_api_request(request): + return ActivitypubResponse(author.to_activity()) + + books = models.Work.objects.filter( + Q(authors=author) | Q(editions__authors=author)).distinct() + data = { + 'title': author.name, + 'author': author, + 'books': [b.get_default_edition() for b in books], + } + return TemplateResponse(request, 'author.html', data) + + +@method_decorator(login_required, name='dispatch') +@method_decorator( + permission_required('bookwyrm.edit_book', raise_exception=True), + name='dispatch') +class EditAuthor(View): + ''' edit author info ''' + def get(self, request, author_id): + ''' info about a book ''' + author = get_object_or_404(models.Author, id=author_id) + data = { + 'title': 'Edit Author', + 'author': author, + 'form': forms.AuthorForm(instance=author) + } + return TemplateResponse(request, 'edit_author.html', data) + + def post(self, request, author_id): + ''' edit a author cool ''' + author = get_object_or_404(models.Author, id=author_id) + + form = forms.AuthorForm(request.POST, request.FILES, instance=author) + if not form.is_valid(): + data = { + 'title': 'Edit Author', + 'author': author, + 'form': form + } + return TemplateResponse(request, 'edit_author.html', data) + author = form.save() + + broadcast(request.user, author.to_update_activity(request.user)) + return redirect('/author/%s' % author.id) diff --git a/bookwyrm/views/books.py b/bookwyrm/views/books.py new file mode 100644 index 00000000..553c7478 --- /dev/null +++ b/bookwyrm/views/books.py @@ -0,0 +1,228 @@ +''' the good stuff! the books! ''' +from django.core.paginator import Paginator +from django.contrib.auth.decorators import login_required, permission_required +from django.db import transaction +from django.db.models import Avg, Q +from django.http import HttpResponseNotFound +from django.shortcuts import get_object_or_404, redirect +from django.template.response import TemplateResponse +from django.utils.decorators import method_decorator +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.broadcast import broadcast +from bookwyrm.connectors import connector_manager +from bookwyrm.settings import PAGE_LENGTH +from .helpers import is_api_request, get_activity_feed, get_edition + + +# pylint: disable= no-self-use +class Book(View): + ''' a book! this is the stuff ''' + def get(self, request, book_id): + ''' info about a book ''' + try: + page = int(request.GET.get('page', 1)) + except ValueError: + page = 1 + + try: + book = models.Book.objects.select_subclasses().get(id=book_id) + except models.Book.DoesNotExist: + return HttpResponseNotFound() + + if is_api_request(request): + return ActivitypubResponse(book.to_activity()) + + if isinstance(book, models.Work): + book = book.get_default_edition() + if not book: + return HttpResponseNotFound() + + work = book.parent_work + if not work: + return HttpResponseNotFound() + + reviews = models.Review.objects.filter( + book__in=work.editions.all(), + ) + # all reviews for the book + reviews = get_activity_feed( + request.user, + ['public', 'unlisted', 'followers', 'direct'], + queryset=reviews + ) + + # the reviews to show + paginated = Paginator(reviews.exclude( + Q(content__isnull=True) | Q(content='') + ), PAGE_LENGTH) + reviews_page = paginated.page(page) + + user_tags = readthroughs = user_shelves = other_edition_shelves = [] + if request.user.is_authenticated: + user_tags = models.UserTag.objects.filter( + book=book, user=request.user + ).values_list('tag__identifier', flat=True) + + readthroughs = models.ReadThrough.objects.filter( + user=request.user, + book=book, + ).order_by('start_date') + + user_shelves = models.ShelfBook.objects.filter( + added_by=request.user, book=book + ) + + other_edition_shelves = models.ShelfBook.objects.filter( + ~Q(book=book), + added_by=request.user, + book__parent_work=book.parent_work, + ) + + data = { + 'title': book.title, + 'book': book, + 'reviews': reviews_page, + 'review_count': reviews.count(), + 'ratings': reviews.filter(Q(content__isnull=True) | Q(content='')), + 'rating': reviews.aggregate(Avg('rating'))['rating__avg'], + 'tags': models.UserTag.objects.filter(book=book), + 'user_tags': user_tags, + 'user_shelves': user_shelves, + 'other_edition_shelves': other_edition_shelves, + 'readthroughs': readthroughs, + 'path': '/book/%s' % book_id, + } + return TemplateResponse(request, 'book.html', data) + + +@method_decorator(login_required, name='dispatch') +@method_decorator( + permission_required('bookwyrm.edit_book', raise_exception=True), + name='dispatch') +class EditBook(View): + ''' edit a book ''' + def get(self, request, book_id): + ''' info about a book ''' + book = get_edition(book_id) + if not book.description: + book.description = book.parent_work.description + data = { + 'title': 'Edit Book', + 'book': book, + 'form': forms.EditionForm(instance=book) + } + return TemplateResponse(request, 'edit_book.html', data) + + def post(self, request, book_id): + ''' edit a book cool ''' + book = get_object_or_404(models.Edition, id=book_id) + + form = forms.EditionForm(request.POST, request.FILES, instance=book) + if not form.is_valid(): + data = { + 'title': 'Edit Book', + 'book': book, + 'form': form + } + return TemplateResponse(request, 'edit_book.html', data) + book = form.save() + + broadcast(request.user, book.to_update_activity(request.user)) + return redirect('/book/%s' % book.id) + + +class Editions(View): + ''' list of editions ''' + def get(self, request, book_id): + ''' list of editions of a book ''' + work = get_object_or_404(models.Work, id=book_id) + + if is_api_request(request): + return ActivitypubResponse(work.to_edition_list(**request.GET)) + + data = { + 'title': 'Editions of %s' % work.title, + 'editions': work.editions.order_by('-edition_rank').all(), + 'work': work, + } + return TemplateResponse(request, 'editions.html', data) + + +@login_required +@require_POST +def upload_cover(request, book_id): + ''' upload a new cover ''' + book = get_object_or_404(models.Edition, id=book_id) + + form = forms.CoverForm(request.POST, request.FILES, instance=book) + if not form.is_valid(): + return redirect('/book/%d' % book.id) + + book.cover = form.files['cover'] + book.save() + + broadcast(request.user, book.to_update_activity(request.user)) + return redirect('/book/%s' % book.id) + + +@login_required +@require_POST +@permission_required('bookwyrm.edit_book', raise_exception=True) +def add_description(request, book_id): + ''' upload a new cover ''' + if not request.method == 'POST': + return redirect('/') + + book = get_object_or_404(models.Edition, id=book_id) + + description = request.POST.get('description') + + book.description = description + book.save() + + broadcast(request.user, book.to_update_activity(request.user)) + return redirect('/book/%s' % book.id) + + +@require_POST +def resolve_book(request): + ''' figure out the local path to a book from a remote_id ''' + remote_id = request.POST.get('remote_id') + connector = connector_manager.get_or_create_connector(remote_id) + book = connector.get_or_create_book(remote_id) + + return redirect('/book/%d' % book.id) + + +@login_required +@require_POST +@transaction.atomic +def switch_edition(request): + ''' switch your copy of a book to a different edition ''' + edition_id = request.POST.get('edition') + new_edition = get_object_or_404(models.Edition, id=edition_id) + shelfbooks = models.ShelfBook.objects.filter( + book__parent_work=new_edition.parent_work, + shelf__user=request.user + ) + for shelfbook in shelfbooks.all(): + broadcast(request.user, shelfbook.to_remove_activity(request.user)) + + shelfbook.book = new_edition + shelfbook.save() + + broadcast(request.user, shelfbook.to_add_activity(request.user)) + + readthroughs = models.ReadThrough.objects.filter( + book__parent_work=new_edition.parent_work, + user=request.user + ) + for readthrough in readthroughs.all(): + readthrough.book = new_edition + readthrough.save() + + return redirect('/book/%d' % new_edition.id) diff --git a/bookwyrm/vviews.py b/bookwyrm/vviews.py index befdca2d..3d78a277 100644 --- a/bookwyrm/vviews.py +++ b/bookwyrm/vviews.py @@ -1,18 +1,15 @@ ''' views for pages you can go to in the application ''' import re -from django.contrib.auth.decorators import login_required, permission_required from django.contrib.postgres.search import TrigramSimilarity -from django.db.models import Q from django.db.models.functions import Greatest from django.http import HttpResponseNotFound, JsonResponse -from django.shortcuts import get_object_or_404 from django.template.response import TemplateResponse from django.views.decorators.csrf import csrf_exempt from django.views.decorators.http import require_GET from bookwyrm import outgoing -from bookwyrm import forms, models +from bookwyrm import models from bookwyrm.activitypub import ActivitypubResponse from bookwyrm.connectors import connector_manager from bookwyrm.utils import regex @@ -90,38 +87,6 @@ def search(request): return TemplateResponse(request, 'search_results.html', data) -@login_required -@permission_required('bookwyrm.edit_book', raise_exception=True) -@require_GET -def edit_author_page(request, author_id): - ''' info about a book ''' - author = get_object_or_404(models.Author, id=author_id) - data = { - 'title': 'Edit Author', - 'author': author, - 'form': forms.AuthorForm(instance=author) - } - return TemplateResponse(request, 'edit_author.html', data) - - -@require_GET -def author_page(request, author_id): - ''' landing page for an author ''' - author = get_object_or_404(models.Author, id=author_id) - - if is_api_request(request): - return ActivitypubResponse(author.to_activity()) - - books = models.Work.objects.filter( - Q(authors=author) | Q(editions__authors=author)).distinct() - data = { - 'title': author.name, - 'author': author, - 'books': [b.get_default_edition() for b in books], - } - return TemplateResponse(request, 'author.html', data) - - @require_GET def tag_page(request, tag_id): ''' books related to a tag ''' From 99abb2631e7a5ea88dd4928c56bbd1a97126e4a6 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 10:04:44 -0800 Subject: [PATCH 18/34] Adds author view --- bookwyrm/tests/test_view_actions.py | 84 +------------------- bookwyrm/tests/test_views.py | 86 -------------------- bookwyrm/tests/views/test_author.py | 119 ++++++++++++++++++++++++++++ bookwyrm/tests/views/test_book.py | 4 +- 4 files changed, 122 insertions(+), 171 deletions(-) create mode 100644 bookwyrm/tests/views/test_author.py diff --git a/bookwyrm/tests/test_view_actions.py b/bookwyrm/tests/test_view_actions.py index c0c613ac..e7c5e0cb 100644 --- a/bookwyrm/tests/test_view_actions.py +++ b/bookwyrm/tests/test_view_actions.py @@ -2,14 +2,13 @@ from unittest.mock import patch import dateutil -from django.core.exceptions import PermissionDenied from django.contrib.auth.models import Group, Permission from django.contrib.contenttypes.models import ContentType from django.test import TestCase from django.test.client import RequestFactory from django.utils import timezone -from bookwyrm import forms, models, view_actions as actions +from bookwyrm import models, view_actions as actions #pylint: disable=too-many-public-methods @@ -49,87 +48,6 @@ class ViewActions(TestCase): self.factory = RequestFactory() - def test_edit_book(self): - ''' lets a user edit a book ''' - self.local_user.groups.add(self.group) - form = forms.EditionForm(instance=self.book) - form.data['title'] = 'New Title' - form.data['last_edited_by'] = self.local_user.id - request = self.factory.post('', form.data) - request.user = self.local_user - with patch('bookwyrm.broadcast.broadcast_task.delay'): - actions.edit_book(request, self.book.id) - self.book.refresh_from_db() - self.assertEqual(self.book.title, 'New Title') - - - def test_switch_edition(self): - ''' updates user's relationships to a book ''' - work = models.Work.objects.create(title='test work') - edition1 = models.Edition.objects.create( - title='first ed', parent_work=work) - edition2 = models.Edition.objects.create( - title='second ed', parent_work=work) - shelf = models.Shelf.objects.create( - name='Test Shelf', user=self.local_user) - shelf.books.add(edition1) - models.ReadThrough.objects.create( - user=self.local_user, book=edition1) - - self.assertEqual(models.ShelfBook.objects.get().book, edition1) - self.assertEqual(models.ReadThrough.objects.get().book, edition1) - request = self.factory.post('', { - 'edition': edition2.id - }) - request.user = self.local_user - with patch('bookwyrm.broadcast.broadcast_task.delay'): - actions.switch_edition(request) - - self.assertEqual(models.ShelfBook.objects.get().book, edition2) - self.assertEqual(models.ReadThrough.objects.get().book, edition2) - - - def test_edit_author(self): - ''' edit an author ''' - author = models.Author.objects.create(name='Test Author') - self.local_user.groups.add(self.group) - form = forms.AuthorForm(instance=author) - form.data['name'] = 'New Name' - form.data['last_edited_by'] = self.local_user.id - request = self.factory.post('', form.data) - request.user = self.local_user - with patch('bookwyrm.broadcast.broadcast_task.delay'): - actions.edit_author(request, author.id) - author.refresh_from_db() - self.assertEqual(author.name, 'New Name') - self.assertEqual(author.last_edited_by, self.local_user) - - def test_edit_author_non_editor(self): - ''' edit an author with invalid post data''' - author = models.Author.objects.create(name='Test Author') - form = forms.AuthorForm(instance=author) - form.data['name'] = 'New Name' - form.data['last_edited_by'] = self.local_user.id - request = self.factory.post('', form.data) - request.user = self.local_user - with self.assertRaises(PermissionDenied): - actions.edit_author(request, author.id) - author.refresh_from_db() - self.assertEqual(author.name, 'Test Author') - - def test_edit_author_invalid_form(self): - ''' edit an author with invalid post data''' - author = models.Author.objects.create(name='Test Author') - self.local_user.groups.add(self.group) - form = forms.AuthorForm(instance=author) - form.data['name'] = '' - form.data['last_edited_by'] = self.local_user.id - request = self.factory.post('', form.data) - request.user = self.local_user - resp = actions.edit_author(request, author.id) - author.refresh_from_db() - self.assertEqual(author.name, 'Test Author') - self.assertEqual(resp.template_name, 'edit_author.html') def test_edit_shelf_privacy(self): diff --git a/bookwyrm/tests/test_views.py b/bookwyrm/tests/test_views.py index fcf88610..b060de9f 100644 --- a/bookwyrm/tests/test_views.py +++ b/bookwyrm/tests/test_views.py @@ -41,14 +41,6 @@ class Views(TestCase): ) - def test_get_edition(self): - ''' given an edition or a work, returns an edition ''' - self.assertEqual( - views.get_edition(self.book.id), self.book) - self.assertEqual( - views.get_edition(self.work.id), self.book) - - def test_get_user_from_username(self): ''' works for either localname or username ''' self.assertEqual( @@ -219,84 +211,6 @@ class Views(TestCase): self.assertEqual( response.context_data['user_results'][0], self.local_user) - def test_book_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - request = self.factory.get('') - request.user = self.local_user - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = False - result = views.book_page(request, self.book.id) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'book.html') - self.assertEqual(result.status_code, 200) - - request = self.factory.get('') - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = True - result = views.book_page(request, self.book.id) - self.assertIsInstance(result, ActivitypubResponse) - self.assertEqual(result.status_code, 200) - - - def test_edit_book_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - request = self.factory.get('') - request.user = self.local_user - request.user.is_superuser = True - result = views.edit_book_page(request, self.book.id) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'edit_book.html') - self.assertEqual(result.status_code, 200) - - - def test_edit_author_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - author = models.Author.objects.create(name='Test Author') - request = self.factory.get('') - request.user = self.local_user - request.user.is_superuser = True - result = views.edit_author_page(request, author.id) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'edit_author.html') - self.assertEqual(result.status_code, 200) - - - def test_editions_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - request = self.factory.get('') - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = False - result = views.editions_page(request, self.work.id) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'editions.html') - self.assertEqual(result.status_code, 200) - - request = self.factory.get('') - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = True - result = views.editions_page(request, self.work.id) - self.assertIsInstance(result, ActivitypubResponse) - self.assertEqual(result.status_code, 200) - - - def test_author_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - author = models.Author.objects.create(name='Jessica') - request = self.factory.get('') - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = False - result = views.author_page(request, author.id) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'author.html') - self.assertEqual(result.status_code, 200) - - request = self.factory.get('') - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = True - result = views.author_page(request, author.id) - self.assertIsInstance(result, ActivitypubResponse) - self.assertEqual(result.status_code, 200) - def test_tag_page(self): ''' there are so many views, this just makes sure it LOADS ''' diff --git a/bookwyrm/tests/views/test_author.py b/bookwyrm/tests/views/test_author.py new file mode 100644 index 00000000..c00972f3 --- /dev/null +++ b/bookwyrm/tests/views/test_author.py @@ -0,0 +1,119 @@ +''' test for app action functionality ''' +from unittest.mock import patch +from django.contrib.auth.models import Group, Permission +from django.contrib.contenttypes.models import ContentType +from django.core.exceptions import PermissionDenied +from django.template.response import TemplateResponse +from django.test import TestCase +from django.test.client import RequestFactory + +from bookwyrm import forms, models, views +from bookwyrm.activitypub import ActivitypubResponse + + +class AuthorViews(TestCase): + ''' author views''' + def setUp(self): + ''' we need basic test data and mocks ''' + self.factory = RequestFactory() + self.local_user = models.User.objects.create_user( + 'mouse@local.com', 'mouse@mouse.com', 'mouseword', + local=True, localname='mouse', + remote_id='https://example.com/users/mouse', + ) + self.group = Group.objects.create(name='editor') + self.group.permissions.add( + Permission.objects.create( + name='edit_book', + codename='edit_book', + content_type=ContentType.objects.get_for_model(models.User)).id + ) + self.work = models.Work.objects.create(title='Test Work') + self.book = models.Edition.objects.create( + title='Example Edition', + remote_id='https://example.com/book/1', + parent_work=self.work + ) + + + def test_author_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.Author.as_view() + author = models.Author.objects.create(name='Jessica') + request = self.factory.get('') + with patch('bookwyrm.views.author.is_api_request') as is_api: + is_api.return_value = False + result = view(request, author.id) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'author.html') + self.assertEqual(result.status_code, 200) + + request = self.factory.get('') + with patch('bookwyrm.views.author.is_api_request') as is_api: + is_api.return_value = True + result = view(request, author.id) + self.assertIsInstance(result, ActivitypubResponse) + self.assertEqual(result.status_code, 200) + + + def test_edit_author_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.EditAuthor.as_view() + author = models.Author.objects.create(name='Test Author') + request = self.factory.get('') + request.user = self.local_user + request.user.is_superuser = True + + result = view(request, author.id) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'edit_author.html') + self.assertEqual(result.status_code, 200) + + + def test_edit_author(self): + ''' edit an author ''' + view = views.EditAuthor.as_view() + author = models.Author.objects.create(name='Test Author') + self.local_user.groups.add(self.group) + form = forms.AuthorForm(instance=author) + form.data['name'] = 'New Name' + form.data['last_edited_by'] = self.local_user.id + request = self.factory.post('', form.data) + request.user = self.local_user + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request, author.id) + author.refresh_from_db() + self.assertEqual(author.name, 'New Name') + self.assertEqual(author.last_edited_by, self.local_user) + + def test_edit_author_non_editor(self): + ''' edit an author with invalid post data''' + view = views.EditAuthor.as_view() + author = models.Author.objects.create(name='Test Author') + form = forms.AuthorForm(instance=author) + form.data['name'] = 'New Name' + form.data['last_edited_by'] = self.local_user.id + request = self.factory.post('', form.data) + request.user = self.local_user + + with self.assertRaises(PermissionDenied): + view(request, author.id) + author.refresh_from_db() + self.assertEqual(author.name, 'Test Author') + + def test_edit_author_invalid_form(self): + ''' edit an author with invalid post data''' + view = views.EditAuthor.as_view() + author = models.Author.objects.create(name='Test Author') + self.local_user.groups.add(self.group) + form = forms.AuthorForm(instance=author) + form.data['name'] = '' + form.data['last_edited_by'] = self.local_user.id + request = self.factory.post('', form.data) + request.user = self.local_user + + resp = view(request, author.id) + author.refresh_from_db() + self.assertEqual(author.name, 'Test Author') + self.assertEqual(resp.template_name, 'edit_author.html') diff --git a/bookwyrm/tests/views/test_book.py b/bookwyrm/tests/views/test_book.py index a9475772..8306b803 100644 --- a/bookwyrm/tests/views/test_book.py +++ b/bookwyrm/tests/views/test_book.py @@ -10,8 +10,8 @@ from bookwyrm import forms, models, views from bookwyrm.activitypub import ActivitypubResponse -class InteractionViews(TestCase): - ''' viewing and creating statuses ''' +class BookViews(TestCase): + ''' books books books ''' def setUp(self): ''' we need basic test data and mocks ''' self.factory = RequestFactory() From 20e280e67666052131a4d19bf89c9b246c74a574 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 10:24:24 -0800 Subject: [PATCH 19/34] Adds tag class views --- bookwyrm/tests/test_view_actions.py | 42 ------------ bookwyrm/tests/views/test_tag.py | 99 +++++++++++++++++++++++++++++ bookwyrm/urls.py | 9 +-- bookwyrm/view_actions.py | 42 ------------ bookwyrm/views/__init__.py | 1 + bookwyrm/views/tag.py | 78 +++++++++++++++++++++++ bookwyrm/vviews.py | 22 ------- 7 files changed, 183 insertions(+), 110 deletions(-) create mode 100644 bookwyrm/tests/views/test_tag.py create mode 100644 bookwyrm/views/tag.py diff --git a/bookwyrm/tests/test_view_actions.py b/bookwyrm/tests/test_view_actions.py index e7c5e0cb..a554c645 100644 --- a/bookwyrm/tests/test_view_actions.py +++ b/bookwyrm/tests/test_view_actions.py @@ -48,8 +48,6 @@ class ViewActions(TestCase): self.factory = RequestFactory() - - def test_edit_shelf_privacy(self): ''' set name or privacy on shelf ''' shelf = self.local_user.shelf_set.get(identifier='to-read') @@ -168,43 +166,3 @@ class ViewActions(TestCase): self.assertEqual(readthrough.finish_date.day, 7) self.assertEqual(readthrough.book, self.book) self.assertEqual(readthrough.user, self.local_user) - - - def test_tag(self): - ''' add a tag to a book ''' - request = self.factory.post( - '', { - 'name': 'A Tag!?', - 'book': self.book.id, - }) - request.user = self.local_user - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - actions.tag(request) - - tag = models.Tag.objects.get() - user_tag = models.UserTag.objects.get() - self.assertEqual(tag.name, 'A Tag!?') - self.assertEqual(tag.identifier, 'A+Tag%21%3F') - self.assertEqual(user_tag.user, self.local_user) - self.assertEqual(user_tag.book, self.book) - - - def test_untag(self): - ''' remove a tag from a book ''' - tag = models.Tag.objects.create(name='A Tag!?') - models.UserTag.objects.create( - user=self.local_user, book=self.book, tag=tag) - request = self.factory.post( - '', { - 'user': self.local_user.id, - 'book': self.book.id, - 'name': tag.name, - }) - request.user = self.local_user - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - actions.untag(request) - - self.assertTrue(models.Tag.objects.filter(name='A Tag!?').exists()) - self.assertFalse(models.UserTag.objects.exists()) diff --git a/bookwyrm/tests/views/test_tag.py b/bookwyrm/tests/views/test_tag.py new file mode 100644 index 00000000..1556139c --- /dev/null +++ b/bookwyrm/tests/views/test_tag.py @@ -0,0 +1,99 @@ +''' test for app action functionality ''' +from unittest.mock import patch +from django.contrib.auth.models import Group, Permission +from django.contrib.contenttypes.models import ContentType +from django.template.response import TemplateResponse +from django.test import TestCase +from django.test.client import RequestFactory + +from bookwyrm import models, views +from bookwyrm.activitypub import ActivitypubResponse + + +class TagViews(TestCase): + ''' tag views''' + def setUp(self): + ''' we need basic test data and mocks ''' + self.factory = RequestFactory() + self.local_user = models.User.objects.create_user( + 'mouse@local.com', 'mouse@mouse.com', 'mouseword', + local=True, localname='mouse', + remote_id='https://example.com/users/mouse', + ) + self.group = Group.objects.create(name='editor') + self.group.permissions.add( + Permission.objects.create( + name='edit_book', + codename='edit_book', + content_type=ContentType.objects.get_for_model(models.User)).id + ) + self.work = models.Work.objects.create(title='Test Work') + self.book = models.Edition.objects.create( + title='Example Edition', + remote_id='https://example.com/book/1', + parent_work=self.work + ) + + + def test_tag_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.Tag.as_view() + tag = models.Tag.objects.create(name='hi there') + models.UserTag.objects.create( + tag=tag, user=self.local_user, book=self.book) + request = self.factory.get('') + with patch('bookwyrm.views.tag.is_api_request') as is_api: + is_api.return_value = False + result = view(request, tag.identifier) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'tag.html') + self.assertEqual(result.status_code, 200) + + request = self.factory.get('') + with patch('bookwyrm.views.tag.is_api_request') as is_api: + is_api.return_value = True + result = view(request, tag.identifier) + self.assertIsInstance(result, ActivitypubResponse) + self.assertEqual(result.status_code, 200) + + + def test_tag(self): + ''' add a tag to a book ''' + view = views.AddTag.as_view() + request = self.factory.post( + '', { + 'name': 'A Tag!?', + 'book': self.book.id, + }) + request.user = self.local_user + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request) + + tag = models.Tag.objects.get() + user_tag = models.UserTag.objects.get() + self.assertEqual(tag.name, 'A Tag!?') + self.assertEqual(tag.identifier, 'A+Tag%21%3F') + self.assertEqual(user_tag.user, self.local_user) + self.assertEqual(user_tag.book, self.book) + + + def test_untag(self): + ''' remove a tag from a book ''' + view = views.RemoveTag.as_view() + tag = models.Tag.objects.create(name='A Tag!?') + models.UserTag.objects.create( + user=self.local_user, book=self.book, tag=tag) + request = self.factory.post( + '', { + 'user': self.local_user.id, + 'book': self.book.id, + 'name': tag.name, + }) + request.user = self.local_user + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + view(request) + + self.assertTrue(models.Tag.objects.filter(name='A Tag!?').exists()) + self.assertFalse(models.UserTag.objects.exists()) diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index 260164b7..02b3f6e9 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -100,11 +100,12 @@ urlpatterns = [ re_path(r'^author/(?P\d+)(.json)?/?$', views.Author.as_view()), re_path(r'^author/(?P\d+)/edit/?$', views.EditAuthor.as_view()), - re_path(r'^tag/?$', actions.tag), - re_path(r'^untag/?$', actions.untag), + # tags + re_path(r'^tag/(?P.+)\.json/?$', views.Tag.as_view()), + re_path(r'^tag/(?P.+)/?$', views.Tag.as_view()), + re_path(r'^tag/?$', views.AddTag.as_view()), + re_path(r'^untag/?$', views.RemoveTag.as_view()), - re_path(r'^tag/(?P.+)\.json/?$', vviews.tag_page), - re_path(r'^tag/(?P.+)/?$', vviews.tag_page), re_path(r'^%s/shelf/(?P[\w-]+)(.json)?/?$' % \ user_path, vviews.shelf_page), re_path(r'^%s/shelf/(?P[\w-]+)(.json)?/?$' % \ diff --git a/bookwyrm/view_actions.py b/bookwyrm/view_actions.py index c349f3f9..4279b281 100644 --- a/bookwyrm/view_actions.py +++ b/bookwyrm/view_actions.py @@ -9,7 +9,6 @@ from django.utils import timezone from django.views.decorators.http import require_POST from bookwyrm import forms, models, outgoing -from bookwyrm.broadcast import broadcast from bookwyrm.vviews import get_user_from_username, get_edition @login_required @@ -215,47 +214,6 @@ def create_readthrough(request): return redirect(request.headers.get('Referer', '/')) -@login_required -@require_POST -def tag(request): - ''' tag a book ''' - # I'm not using a form here because sometimes "name" is sent as a hidden - # field which doesn't validate - name = request.POST.get('name') - book_id = request.POST.get('book') - book = get_object_or_404(models.Edition, id=book_id) - tag_obj, created = models.Tag.objects.get_or_create( - name=name, - ) - user_tag, _ = models.UserTag.objects.get_or_create( - user=request.user, - book=book, - tag=tag_obj, - ) - - if created: - broadcast(request.user, user_tag.to_add_activity(request.user)) - return redirect('/book/%s' % book_id) - - -@login_required -@require_POST -def untag(request): - ''' untag a book ''' - name = request.POST.get('name') - tag_obj = get_object_or_404(models.Tag, name=name) - book_id = request.POST.get('book') - book = get_object_or_404(models.Edition, id=book_id) - - user_tag = get_object_or_404( - models.UserTag, tag=tag_obj, book=book, user=request.user) - tag_activity = user_tag.to_remove_activity(request.user) - user_tag.delete() - - broadcast(request.user, tag_activity) - return redirect('/book/%s' % book_id) - - @login_required @require_POST def follow(request): diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 0d01fb56..5eed7f17 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -12,3 +12,4 @@ from .interaction import Favorite, Unfavorite, Boost, Unboost from .books import Book, EditBook, Editions from .books import upload_cover, add_description, switch_edition, resolve_book from .author import Author, EditAuthor +from .tag import Tag, AddTag, RemoveTag diff --git a/bookwyrm/views/tag.py b/bookwyrm/views/tag.py new file mode 100644 index 00000000..e95ffe81 --- /dev/null +++ b/bookwyrm/views/tag.py @@ -0,0 +1,78 @@ +''' tagging views''' +from django.contrib.auth.decorators import login_required +from django.http import HttpResponseNotFound +from django.shortcuts import get_object_or_404, redirect +from django.template.response import TemplateResponse +from django.utils.decorators import method_decorator +from django.views import View + +from bookwyrm import models +from bookwyrm.activitypub import ActivitypubResponse +from bookwyrm.broadcast import broadcast +from .helpers import is_api_request + + +# pylint: disable= no-self-use +class Tag(View): + ''' tag page ''' + def get(self, request, tag_id): + ''' see books related to a tag ''' + tag_obj = models.Tag.objects.filter(identifier=tag_id).first() + if not tag_obj: + return HttpResponseNotFound() + + if is_api_request(request): + return ActivitypubResponse(tag_obj.to_activity(**request.GET)) + + books = models.Edition.objects.filter( + usertag__tag__identifier=tag_id + ).distinct() + data = { + 'title': tag_obj.name, + 'books': books, + 'tag': tag_obj, + } + return TemplateResponse(request, 'tag.html', data) + + +@method_decorator(login_required, name='dispatch') +class AddTag(View): + ''' add a tag to a book ''' + def post(self, request): + ''' tag a book ''' + # I'm not using a form here because sometimes "name" is sent as a hidden + # field which doesn't validate + name = request.POST.get('name') + book_id = request.POST.get('book') + book = get_object_or_404(models.Edition, id=book_id) + tag_obj, created = models.Tag.objects.get_or_create( + name=name, + ) + user_tag, _ = models.UserTag.objects.get_or_create( + user=request.user, + book=book, + tag=tag_obj, + ) + + if created: + broadcast(request.user, user_tag.to_add_activity(request.user)) + return redirect('/book/%s' % book_id) + + +@method_decorator(login_required, name='dispatch') +class RemoveTag(View): + ''' remove a user's tag from a book ''' + def post(self, request): + ''' untag a book ''' + name = request.POST.get('name') + tag_obj = get_object_or_404(models.Tag, name=name) + book_id = request.POST.get('book') + book = get_object_or_404(models.Edition, id=book_id) + + user_tag = get_object_or_404( + models.UserTag, tag=tag_obj, book=book, user=request.user) + tag_activity = user_tag.to_remove_activity(request.user) + user_tag.delete() + + broadcast(request.user, tag_activity) + return redirect('/book/%s' % book_id) diff --git a/bookwyrm/vviews.py b/bookwyrm/vviews.py index 3d78a277..4110ebbb 100644 --- a/bookwyrm/vviews.py +++ b/bookwyrm/vviews.py @@ -22,7 +22,6 @@ def get_edition(book_id): return book - def get_user_from_username(username): ''' helper function to resolve a localname or a username to a user ''' # raises DoesNotExist if user is now found @@ -87,27 +86,6 @@ def search(request): return TemplateResponse(request, 'search_results.html', data) -@require_GET -def tag_page(request, tag_id): - ''' books related to a tag ''' - tag_obj = models.Tag.objects.filter(identifier=tag_id).first() - if not tag_obj: - return HttpResponseNotFound() - - if is_api_request(request): - return ActivitypubResponse(tag_obj.to_activity(**request.GET)) - - books = models.Edition.objects.filter( - usertag__tag__identifier=tag_id - ).distinct() - data = { - 'title': tag_obj.name, - 'books': books, - 'tag': tag_obj, - } - return TemplateResponse(request, 'tag.html', data) - - @csrf_exempt @require_GET def user_shelves_page(request, username): From beeeaaaf39040a23bba3828d7ccb3a8d9690ca29 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 11:45:08 -0800 Subject: [PATCH 20/34] Adds shelf views --- bookwyrm/outgoing.py | 43 ------- bookwyrm/tests/views/test_shelf.py | 192 +++++++++++++++++++++++++++++ bookwyrm/urls.py | 16 +-- bookwyrm/view_actions.py | 101 +++------------ bookwyrm/views/__init__.py | 3 + bookwyrm/views/helpers.py | 24 ++++ bookwyrm/views/shelf.py | 172 ++++++++++++++++++++++++++ bookwyrm/vviews.py | 77 +----------- 8 files changed, 414 insertions(+), 214 deletions(-) create mode 100644 bookwyrm/tests/views/test_shelf.py create mode 100644 bookwyrm/views/shelf.py diff --git a/bookwyrm/outgoing.py b/bookwyrm/outgoing.py index 546d1201..18c1eaea 100644 --- a/bookwyrm/outgoing.py +++ b/bookwyrm/outgoing.py @@ -115,49 +115,6 @@ def handle_reject(follow_request): broadcast(to_follow, activity, privacy='direct', direct_recipients=[user]) -def handle_shelve(user, book, shelf): - ''' a local user is getting a book put on their shelf ''' - # update the database - shelve = models.ShelfBook(book=book, shelf=shelf, added_by=user) - shelve.save() - - broadcast(user, shelve.to_add_activity(user)) - - -def handle_unshelve(user, book, shelf): - ''' a local user is getting a book put on their shelf ''' - # update the database - row = models.ShelfBook.objects.get(book=book, shelf=shelf) - activity = row.to_remove_activity(user) - row.delete() - - broadcast(user, activity) - - -def handle_reading_status(user, shelf, book, privacy): - ''' post about a user reading a book ''' - # tell the world about this cool thing that happened - try: - message = { - 'to-read': 'wants to read', - 'reading': 'started reading', - 'read': 'finished reading' - }[shelf.identifier] - except KeyError: - # it's a non-standard shelf, don't worry about it - return - - status = create_generated_note( - user, - message, - mention_books=[book], - privacy=privacy - ) - status.save() - - broadcast(user, status.to_create_activity(user)) - - def handle_imported_book(user, item, include_reviews, privacy): ''' process a goodreads csv and then post about it ''' if isinstance(item.book, models.Work): diff --git a/bookwyrm/tests/views/test_shelf.py b/bookwyrm/tests/views/test_shelf.py new file mode 100644 index 00000000..64966a77 --- /dev/null +++ b/bookwyrm/tests/views/test_shelf.py @@ -0,0 +1,192 @@ +''' test for app action functionality ''' +from unittest.mock import patch +from django.template.response import TemplateResponse +from django.test import TestCase +from django.test.client import RequestFactory + +from bookwyrm import models, views +from bookwyrm.activitypub import ActivitypubResponse + + +class ShelfViews(TestCase): + ''' tag views''' + def setUp(self): + ''' we need basic test data and mocks ''' + self.factory = RequestFactory() + self.local_user = models.User.objects.create_user( + 'mouse@local.com', 'mouse@mouse.com', 'mouseword', + local=True, localname='mouse', + remote_id='https://example.com/users/mouse', + ) + self.work = models.Work.objects.create(title='Test Work') + self.book = models.Edition.objects.create( + title='Example Edition', + remote_id='https://example.com/book/1', + parent_work=self.work + ) + self.shelf = models.Shelf.objects.create( + name='Test Shelf', + identifier='test-shelf', + user=self.local_user + ) + + + def test_shelf_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.Shelf.as_view() + shelf = self.local_user.shelf_set.first() + request = self.factory.get('') + request.user = self.local_user + with patch('bookwyrm.views.shelf.is_api_request') as is_api: + is_api.return_value = False + result = view(request, self.local_user.username, shelf.identifier) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.template_name, 'shelf.html') + self.assertEqual(result.status_code, 200) + + with patch('bookwyrm.views.shelf.is_api_request') as is_api: + is_api.return_value = True + result = view( + request, self.local_user.username, shelf.identifier) + self.assertIsInstance(result, ActivitypubResponse) + self.assertEqual(result.status_code, 200) + + request = self.factory.get('/?page=1') + request.user = self.local_user + with patch('bookwyrm.views.shelf.is_api_request') as is_api: + is_api.return_value = True + result = view( + request, self.local_user.username, shelf.identifier) + self.assertIsInstance(result, ActivitypubResponse) + self.assertEqual(result.status_code, 200) + + + def test_edit_shelf_privacy(self): + ''' set name or privacy on shelf ''' + view = views.Shelf.as_view() + shelf = self.local_user.shelf_set.get(identifier='to-read') + self.assertEqual(shelf.privacy, 'public') + + request = self.factory.post( + '', { + 'privacy': 'unlisted', + 'user': self.local_user.id, + 'name': 'To Read', + }) + request.user = self.local_user + view(request, self.local_user.username, shelf.id) + shelf.refresh_from_db() + + self.assertEqual(shelf.privacy, 'unlisted') + + + def test_edit_shelf_name(self): + ''' change the name of an editable shelf ''' + view = views.Shelf.as_view() + shelf = models.Shelf.objects.create( + name='Test Shelf', user=self.local_user) + self.assertEqual(shelf.privacy, 'public') + + request = self.factory.post( + '', { + 'privacy': 'public', + 'user': self.local_user.id, + 'name': 'cool name' + }) + request.user = self.local_user + view(request, request.user.username, shelf.id) + shelf.refresh_from_db() + + self.assertEqual(shelf.name, 'cool name') + self.assertEqual(shelf.identifier, 'testshelf-%d' % shelf.id) + + + def test_edit_shelf_name_not_editable(self): + ''' can't change the name of an non-editable shelf ''' + view = views.Shelf.as_view() + shelf = self.local_user.shelf_set.get(identifier='to-read') + self.assertEqual(shelf.privacy, 'public') + + request = self.factory.post( + '', { + 'privacy': 'public', + 'user': self.local_user.id, + 'name': 'cool name' + }) + request.user = self.local_user + view(request, request.user.username, shelf.id) + + self.assertEqual(shelf.name, 'To Read') + + + def test_handle_shelve(self): + ''' shelve a book ''' + request = self.factory.post('', { + 'book': self.book.id, + 'shelf': self.shelf.identifier + }) + request.user = self.local_user + with patch('bookwyrm.broadcast.broadcast_task.delay'): + views.shelve(request) + # make sure the book is on the shelf + self.assertEqual(self.shelf.books.get(), self.book) + + + def test_handle_shelve_to_read(self): + ''' special behavior for the to-read shelf ''' + shelf = models.Shelf.objects.get(identifier='to-read') + request = self.factory.post('', { + 'book': self.book.id, + 'shelf': shelf.identifier + }) + request.user = self.local_user + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + views.shelve(request) + # make sure the book is on the shelf + self.assertEqual(shelf.books.get(), self.book) + + + def test_handle_shelve_reading(self): + ''' special behavior for the reading shelf ''' + shelf = models.Shelf.objects.get(identifier='reading') + request = self.factory.post('', { + 'book': self.book.id, + 'shelf': shelf.identifier + }) + request.user = self.local_user + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + views.shelve(request) + # make sure the book is on the shelf + self.assertEqual(shelf.books.get(), self.book) + + + def test_handle_shelve_read(self): + ''' special behavior for the read shelf ''' + shelf = models.Shelf.objects.get(identifier='read') + request = self.factory.post('', { + 'book': self.book.id, + 'shelf': shelf.identifier + }) + request.user = self.local_user + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + views.shelve(request) + # make sure the book is on the shelf + self.assertEqual(shelf.books.get(), self.book) + + + def test_handle_unshelve(self): + ''' remove a book from a shelf ''' + self.shelf.books.add(self.book) + self.shelf.save() + self.assertEqual(self.shelf.books.count(), 1) + request = self.factory.post('', { + 'book': self.book.id, + 'shelf': self.shelf.id + }) + request.user = self.local_user + with patch('bookwyrm.broadcast.broadcast_task.delay'): + views.unshelve(request) + self.assertEqual(self.shelf.books.count(), 0) diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index 02b3f6e9..d7efa0fb 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -68,7 +68,7 @@ urlpatterns = [ # users re_path(r'%s/?$' % user_path, views.User.as_view()), re_path(r'%s\.json$' % user_path, views.User.as_view()), - re_path(r'%s/shelves/?$' % user_path, vviews.user_shelves_page), + re_path(r'%s/shelves/?$' % user_path, views.user_shelves_page), re_path(r'%s/followers(.json)?/?$' % user_path, views.Followers.as_view()), re_path(r'%s/following(.json)?/?$' % user_path, views.Following.as_view()), re_path(r'^edit-profile/?$', views.EditUser.as_view()), @@ -106,10 +106,15 @@ urlpatterns = [ re_path(r'^tag/?$', views.AddTag.as_view()), re_path(r'^untag/?$', views.RemoveTag.as_view()), + # shelf re_path(r'^%s/shelf/(?P[\w-]+)(.json)?/?$' % \ - user_path, vviews.shelf_page), + user_path, views.Shelf.as_view()), re_path(r'^%s/shelf/(?P[\w-]+)(.json)?/?$' % \ - local_user_path, vviews.shelf_page), + local_user_path, views.Shelf.as_view()), + re_path(r'^create-shelf/?$', views.create_shelf), + re_path(r'^delete-shelf/(?P\d+)?$', views.delete_shelf), + re_path(r'^shelve/?$', views.shelve), + re_path(r'^unshelve/?$', views.unshelve), re_path(r'^search/?$', vviews.search), @@ -117,11 +122,6 @@ urlpatterns = [ re_path(r'^delete-readthrough/?$', actions.delete_readthrough), re_path(r'^create-readthrough/?$', actions.create_readthrough), - re_path(r'^create-shelf/?$', actions.create_shelf), - re_path(r'^edit-shelf/(?P\d+)?$', actions.edit_shelf), - re_path(r'^delete-shelf/(?P\d+)?$', actions.delete_shelf), - re_path(r'^shelve/?$', actions.shelve), - re_path(r'^unshelve/?$', actions.unshelve), re_path(r'^start-reading/(?P\d+)/?$', actions.start_reading), re_path(r'^finish-reading/(?P\d+)/?$', actions.finish_reading), diff --git a/bookwyrm/view_actions.py b/bookwyrm/view_actions.py index 4279b281..20e4f300 100644 --- a/bookwyrm/view_actions.py +++ b/bookwyrm/view_actions.py @@ -8,95 +8,22 @@ from django.shortcuts import get_object_or_404, redirect from django.utils import timezone from django.views.decorators.http import require_POST -from bookwyrm import forms, models, outgoing -from bookwyrm.vviews import get_user_from_username, get_edition +from bookwyrm import models, outgoing -@login_required -@require_POST -def create_shelf(request): - ''' user generated shelves ''' - form = forms.ShelfForm(request.POST) - if not form.is_valid(): - return redirect(request.headers.get('Referer', '/')) +def get_edition(book_id): + ''' look up a book in the db and return an edition ''' + book = models.Book.objects.select_subclasses().get(id=book_id) + if isinstance(book, models.Work): + book = book.get_default_edition() + return book - shelf = form.save() - return redirect('/user/%s/shelf/%s' % \ - (request.user.localname, shelf.identifier)) - - -@login_required -@require_POST -def edit_shelf(request, shelf_id): - ''' user generated shelves ''' - shelf = get_object_or_404(models.Shelf, id=shelf_id) - if request.user != shelf.user: - return HttpResponseBadRequest() - if not shelf.editable and request.POST.get('name') != shelf.name: - 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 delete_shelf(request, shelf_id): - ''' user generated shelves ''' - shelf = get_object_or_404(models.Shelf, id=shelf_id) - if request.user != shelf.user or not shelf.editable: - return HttpResponseBadRequest() - - shelf.delete() - return redirect('/user/%s/shelves' % request.user.localname) - - -@login_required -@require_POST -def shelve(request): - ''' put a on a user's shelf ''' - book = get_edition(request.POST['book']) - - desired_shelf = models.Shelf.objects.filter( - identifier=request.POST['shelf'], - user=request.user - ).first() - - if request.POST.get('reshelve', True): - try: - current_shelf = models.Shelf.objects.get( - user=request.user, - edition=book - ) - outgoing.handle_unshelve(request.user, book, current_shelf) - except models.Shelf.DoesNotExist: - # this just means it isn't currently on the user's shelves - pass - outgoing.handle_shelve(request.user, book, desired_shelf) - - # post about "want to read" shelves - if desired_shelf.identifier == 'to-read': - outgoing.handle_reading_status( - request.user, - desired_shelf, - book, - privacy=desired_shelf.privacy - ) - - return redirect('/') - - -@login_required -@require_POST -def unshelve(request): - ''' put a on a user's shelf ''' - book = models.Edition.objects.get(id=request.POST['book']) - current_shelf = models.Shelf.objects.get(id=request.POST['shelf']) - - outgoing.handle_unshelve(request.user, book, current_shelf) - return redirect(request.headers.get('Referer', '/')) +def get_user_from_username(username): + ''' helper function to resolve a localname or a username to a user ''' + # raises DoesNotExist if user is now found + try: + return models.User.objects.get(localname=username) + except models.User.DoesNotExist: + return models.User.objects.get(username=username) @login_required diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 5eed7f17..609fbfa0 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -13,3 +13,6 @@ from .books import Book, EditBook, Editions from .books import upload_cover, add_description, switch_edition, resolve_book from .author import Author, EditAuthor from .tag import Tag, AddTag, RemoveTag +from .shelf import Shelf +from .shelf import user_shelves_page, create_shelf, delete_shelf +from .shelf import shelve, unshelve diff --git a/bookwyrm/views/helpers.py b/bookwyrm/views/helpers.py index 13f990fb..3036e568 100644 --- a/bookwyrm/views/helpers.py +++ b/bookwyrm/views/helpers.py @@ -4,7 +4,9 @@ from requests import HTTPError from django.db.models import Q from bookwyrm import activitypub, models +from bookwyrm.broadcast import broadcast from bookwyrm.connectors import ConnectorException, get_data +from bookwyrm.status import create_generated_note from bookwyrm.utils import regex @@ -147,3 +149,25 @@ def get_edition(book_id): return book +def handle_reading_status(user, shelf, book, privacy): + ''' post about a user reading a book ''' + # tell the world about this cool thing that happened + try: + message = { + 'to-read': 'wants to read', + 'reading': 'started reading', + 'read': 'finished reading' + }[shelf.identifier] + except KeyError: + # it's a non-standard shelf, don't worry about it + return + + status = create_generated_note( + user, + message, + mention_books=[book], + privacy=privacy + ) + status.save() + + broadcast(user, status.to_create_activity(user)) diff --git a/bookwyrm/views/shelf.py b/bookwyrm/views/shelf.py new file mode 100644 index 00000000..968f0cbe --- /dev/null +++ b/bookwyrm/views/shelf.py @@ -0,0 +1,172 @@ +''' shelf views''' +from django.contrib.auth.decorators import login_required +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 +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.broadcast import broadcast +from .helpers import is_api_request, get_edition, get_user_from_username +from .helpers import handle_reading_status + + +# pylint: disable= no-self-use +class Shelf(View): + ''' shelf page ''' + def get(self, request, username, shelf_identifier): + ''' display a shelf ''' + try: + user = get_user_from_username(username) + except models.User.DoesNotExist: + return HttpResponseNotFound() + + if shelf_identifier: + shelf = user.shelf_set.get(identifier=shelf_identifier) + else: + shelf = user.shelf_set.first() + + is_self = request.user == user + + shelves = user.shelf_set + if not is_self: + follower = user.followers.filter(id=request.user.id).exists() + # make sure the user has permission to view the shelf + if shelf.privacy == 'direct' or \ + (shelf.privacy == 'followers' and not follower): + return HttpResponseNotFound() + + # only show other shelves that should be visible + if follower: + shelves = shelves.filter(privacy__in=['public', 'followers']) + else: + shelves = shelves.filter(privacy='public') + + + if is_api_request(request): + return ActivitypubResponse(shelf.to_activity(**request.GET)) + + books = models.ShelfBook.objects.filter( + added_by=user, shelf=shelf + ).order_by('-updated_date').all() + + data = { + 'title': '%s\'s %s shelf' % (user.display_name, shelf.name), + 'user': user, + 'is_self': is_self, + 'shelves': shelves.all(), + 'shelf': shelf, + 'books': [b.book for b in books], + } + + return TemplateResponse(request, 'shelf.html', data) + + @method_decorator(login_required, name='dispatch') + def post(self, request, username, shelf_id): + ''' user generated shelves ''' + if not request.user.username == username: + return HttpResponseBadRequest() + + shelf = get_object_or_404(models.Shelf, id=shelf_id) + if request.user != shelf.user: + return HttpResponseBadRequest() + if not shelf.editable and request.POST.get('name') != shelf.name: + 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) + + +def user_shelves_page(request, username): + ''' default shelf ''' + return Shelf.as_view()(request, username, None) + + +@login_required +@require_POST +def create_shelf(request): + ''' user generated shelves ''' + form = forms.ShelfForm(request.POST) + if not form.is_valid(): + return redirect(request.headers.get('Referer', '/')) + + shelf = form.save() + return redirect('/user/%s/shelf/%s' % \ + (request.user.localname, shelf.identifier)) + + +@login_required +@require_POST +def delete_shelf(request, shelf_id): + ''' user generated shelves ''' + shelf = get_object_or_404(models.Shelf, id=shelf_id) + if request.user != shelf.user or not shelf.editable: + return HttpResponseBadRequest() + + shelf.delete() + return redirect('/user/%s/shelves' % request.user.localname) + + +@login_required +@require_POST +def shelve(request): + ''' put a on a user's shelf ''' + book = get_edition(request.POST.get('book')) + + desired_shelf = models.Shelf.objects.filter( + identifier=request.POST.get('shelf'), + user=request.user + ).first() + + if request.POST.get('reshelve', True): + try: + current_shelf = models.Shelf.objects.get( + user=request.user, + edition=book + ) + handle_unshelve(request.user, book, current_shelf) + except models.Shelf.DoesNotExist: + # this just means it isn't currently on the user's shelves + pass + shelfbook = models.ShelfBook( + book=book, shelf=desired_shelf, added_by=request.user) + shelfbook.save() + + broadcast(request.user, shelfbook.to_add_activity(request.user)) + + # post about "want to read" shelves + if desired_shelf.identifier == 'to-read': + handle_reading_status( + request.user, + desired_shelf, + book, + privacy=desired_shelf.privacy + ) + + return redirect('/') + + +@login_required +@require_POST +def unshelve(request): + ''' put a on a user's shelf ''' + book = models.Edition.objects.get(id=request.POST['book']) + current_shelf = models.Shelf.objects.get(id=request.POST['shelf']) + + handle_unshelve(request.user, book, current_shelf) + return redirect(request.headers.get('Referer', '/')) + + +def handle_unshelve(user, book, shelf): + ''' unshelve a book ''' + row = models.ShelfBook.objects.get(book=book, shelf=shelf) + activity = row.to_remove_activity(user) + row.delete() + + broadcast(user, activity) diff --git a/bookwyrm/vviews.py b/bookwyrm/vviews.py index 4110ebbb..a9d75879 100644 --- a/bookwyrm/vviews.py +++ b/bookwyrm/vviews.py @@ -3,40 +3,21 @@ import re from django.contrib.postgres.search import TrigramSimilarity from django.db.models.functions import Greatest -from django.http import HttpResponseNotFound, JsonResponse +from django.http import JsonResponse from django.template.response import TemplateResponse -from django.views.decorators.csrf import csrf_exempt from django.views.decorators.http import require_GET from bookwyrm import outgoing from bookwyrm import models -from bookwyrm.activitypub import ActivitypubResponse from bookwyrm.connectors import connector_manager from bookwyrm.utils import regex -def get_edition(book_id): - ''' look up a book in the db and return an edition ''' - book = models.Book.objects.select_subclasses().get(id=book_id) - if isinstance(book, models.Work): - book = book.get_default_edition() - return book - - -def get_user_from_username(username): - ''' helper function to resolve a localname or a username to a user ''' - # raises DoesNotExist if user is now found - try: - return models.User.objects.get(localname=username) - except models.User.DoesNotExist: - return models.User.objects.get(username=username) - def is_api_request(request): ''' check whether a request is asking for html or data ''' return 'json' in request.headers.get('Accept') or \ request.path[-5:] == '.json' - def server_error_page(request): ''' 500 errors ''' return TemplateResponse( @@ -84,59 +65,3 @@ def search(request): 'query': query, } return TemplateResponse(request, 'search_results.html', data) - - -@csrf_exempt -@require_GET -def user_shelves_page(request, username): - ''' list of followers ''' - return shelf_page(request, username, None) - - -@require_GET -def shelf_page(request, username, shelf_identifier): - ''' display a shelf ''' - try: - user = get_user_from_username(username) - except models.User.DoesNotExist: - return HttpResponseNotFound() - - if shelf_identifier: - shelf = user.shelf_set.get(identifier=shelf_identifier) - else: - shelf = user.shelf_set.first() - - is_self = request.user == user - - shelves = user.shelf_set - if not is_self: - follower = user.followers.filter(id=request.user.id).exists() - # make sure the user has permission to view the shelf - if shelf.privacy == 'direct' or \ - (shelf.privacy == 'followers' and not follower): - return HttpResponseNotFound() - - # only show other shelves that should be visible - if follower: - shelves = shelves.filter(privacy__in=['public', 'followers']) - else: - shelves = shelves.filter(privacy='public') - - - if is_api_request(request): - return ActivitypubResponse(shelf.to_activity(**request.GET)) - - books = models.ShelfBook.objects.filter( - added_by=user, shelf=shelf - ).order_by('-updated_date').all() - - data = { - 'title': '%s\'s %s shelf' % (user.display_name, shelf.name), - 'user': user, - 'is_self': is_self, - 'shelves': shelves.all(), - 'shelf': shelf, - 'books': [b.book for b in books], - } - - return TemplateResponse(request, 'shelf.html', data) From b6bdfab943667205b61b0999318df94911821740 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 12:03:27 -0800 Subject: [PATCH 21/34] Search class views --- bookwyrm/tests/test_views.py | 129 +--------------------------- bookwyrm/tests/views/test_search.py | 108 +++++++++++++++++++++++ bookwyrm/urls.py | 11 +-- bookwyrm/views/__init__.py | 1 + bookwyrm/views/search.py | 53 ++++++++++++ bookwyrm/vviews.py | 48 ----------- 6 files changed, 169 insertions(+), 181 deletions(-) create mode 100644 bookwyrm/tests/views/test_search.py create mode 100644 bookwyrm/views/search.py diff --git a/bookwyrm/tests/test_views.py b/bookwyrm/tests/test_views.py index b060de9f..66721fd4 100644 --- a/bookwyrm/tests/test_views.py +++ b/bookwyrm/tests/test_views.py @@ -1,17 +1,12 @@ ''' test for app action functionality ''' -import json from unittest.mock import patch -from django.http import JsonResponse -from django.template.response import TemplateResponse from django.test import TestCase from django.test.client import RequestFactory from bookwyrm import models from bookwyrm import vviews as views -from bookwyrm.activitypub import ActivitypubResponse -from bookwyrm.connectors import abstract_connector -from bookwyrm.settings import DOMAIN, USER_AGENT +from bookwyrm.settings import USER_AGENT # pylint: disable=too-many-public-methods @@ -142,128 +137,6 @@ class Views(TestCase): self.assertEqual(statuses[0], rat_mention) - def test_search_json_response(self): - ''' searches local data only and returns book data in json format ''' - # we need a connector for this, sorry - request = self.factory.get('', {'q': 'Test Book'}) - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = True - response = views.search(request) - self.assertIsInstance(response, JsonResponse) - - data = json.loads(response.content) - self.assertEqual(len(data), 1) - self.assertEqual(data[0]['title'], 'Test Book') - self.assertEqual( - data[0]['key'], 'https://%s/book/%d' % (DOMAIN, self.book.id)) - - - def test_search_html_response(self): - ''' searches remote connectors ''' - class TestConnector(abstract_connector.AbstractMinimalConnector): - ''' nothing added here ''' - def format_search_result(self, search_result): - pass - def get_or_create_book(self, remote_id): - pass - def parse_search_data(self, data): - pass - models.Connector.objects.create( - identifier='example.com', - connector_file='openlibrary', - base_url='https://example.com', - books_url='https://example.com/books', - covers_url='https://example.com/covers', - search_url='https://example.com/search?q=', - ) - connector = TestConnector('example.com') - - search_result = abstract_connector.SearchResult( - key='http://www.example.com/book/1', - title='Gideon the Ninth', - author='Tamsyn Muir', - year='2019', - connector=connector - ) - - request = self.factory.get('', {'q': 'Test Book'}) - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = False - with patch( - 'bookwyrm.connectors.connector_manager.search') as manager: - manager.return_value = [search_result] - response = views.search(request) - self.assertIsInstance(response, TemplateResponse) - self.assertEqual(response.template_name, 'search_results.html') - self.assertEqual( - response.context_data['book_results'][0].title, 'Gideon the Ninth') - - - def test_search_html_response_users(self): - ''' searches remote connectors ''' - request = self.factory.get('', {'q': 'mouse'}) - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = False - with patch('bookwyrm.connectors.connector_manager.search'): - response = views.search(request) - self.assertIsInstance(response, TemplateResponse) - self.assertEqual(response.template_name, 'search_results.html') - self.assertEqual( - response.context_data['user_results'][0], self.local_user) - - - def test_tag_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - tag = models.Tag.objects.create(name='hi there') - models.UserTag.objects.create( - tag=tag, user=self.local_user, book=self.book) - request = self.factory.get('') - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = False - result = views.tag_page(request, tag.identifier) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'tag.html') - self.assertEqual(result.status_code, 200) - - request = self.factory.get('') - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = True - result = views.tag_page(request, tag.identifier) - self.assertIsInstance(result, ActivitypubResponse) - self.assertEqual(result.status_code, 200) - - - def test_shelf_page(self): - ''' there are so many views, this just makes sure it LOADS ''' - shelf = self.local_user.shelf_set.first() - request = self.factory.get('') - request.user = self.local_user - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = False - result = views.shelf_page( - request, self.local_user.username, shelf.identifier) - self.assertIsInstance(result, TemplateResponse) - self.assertEqual(result.template_name, 'shelf.html') - self.assertEqual(result.status_code, 200) - - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = True - result = views.shelf_page( - request, self.local_user.username, shelf.identifier) - self.assertIsInstance(result, ActivitypubResponse) - self.assertEqual(result.status_code, 200) - - - request = self.factory.get('/?page=1') - request.user = self.local_user - with patch('bookwyrm.views.is_api_request') as is_api: - is_api.return_value = True - result = views.shelf_page( - request, self.local_user.username, shelf.identifier) - self.assertIsInstance(result, ActivitypubResponse) - self.assertEqual(result.status_code, 200) - - def test_is_bookwyrm_request(self): ''' checks if a request came from a bookwyrm instance ''' request = self.factory.get('', {'q': 'Test Book'}) diff --git a/bookwyrm/tests/views/test_search.py b/bookwyrm/tests/views/test_search.py new file mode 100644 index 00000000..3f1d7850 --- /dev/null +++ b/bookwyrm/tests/views/test_search.py @@ -0,0 +1,108 @@ +''' test for app action functionality ''' +import json +from unittest.mock import patch + +from django.http import JsonResponse +from django.template.response import TemplateResponse +from django.test import TestCase +from django.test.client import RequestFactory + +from bookwyrm import models, views +from bookwyrm.connectors import abstract_connector +from bookwyrm.settings import DOMAIN + + +class ShelfViews(TestCase): + ''' tag views''' + def setUp(self): + ''' we need basic test data and mocks ''' + self.factory = RequestFactory() + self.local_user = models.User.objects.create_user( + 'mouse@local.com', 'mouse@mouse.com', 'mouseword', + local=True, localname='mouse', + remote_id='https://example.com/users/mouse', + ) + self.work = models.Work.objects.create(title='Test Work') + self.book = models.Edition.objects.create( + title='Test Book', + remote_id='https://example.com/book/1', + parent_work=self.work + ) + models.Connector.objects.create( + identifier='self', + connector_file='self_connector', + local=True + ) + + + def test_search_json_response(self): + ''' searches local data only and returns book data in json format ''' + view = views.Search.as_view() + # we need a connector for this, sorry + request = self.factory.get('', {'q': 'Test Book'}) + with patch('bookwyrm.views.search.is_api_request') as is_api: + is_api.return_value = True + response = view(request) + self.assertIsInstance(response, JsonResponse) + + data = json.loads(response.content) + self.assertEqual(len(data), 1) + self.assertEqual(data[0]['title'], 'Test Book') + self.assertEqual( + data[0]['key'], 'https://%s/book/%d' % (DOMAIN, self.book.id)) + + + def test_search_html_response(self): + ''' searches remote connectors ''' + view = views.Search.as_view() + class TestConnector(abstract_connector.AbstractMinimalConnector): + ''' nothing added here ''' + def format_search_result(self, search_result): + pass + def get_or_create_book(self, remote_id): + pass + def parse_search_data(self, data): + pass + models.Connector.objects.create( + identifier='example.com', + connector_file='openlibrary', + base_url='https://example.com', + books_url='https://example.com/books', + covers_url='https://example.com/covers', + search_url='https://example.com/search?q=', + ) + connector = TestConnector('example.com') + + search_result = abstract_connector.SearchResult( + key='http://www.example.com/book/1', + title='Gideon the Ninth', + author='Tamsyn Muir', + year='2019', + connector=connector + ) + + request = self.factory.get('', {'q': 'Test Book'}) + with patch('bookwyrm.views.search.is_api_request') as is_api: + is_api.return_value = False + with patch( + 'bookwyrm.connectors.connector_manager.search') as manager: + manager.return_value = [search_result] + response = view(request) + self.assertIsInstance(response, TemplateResponse) + self.assertEqual(response.template_name, 'search_results.html') + self.assertEqual( + response.context_data['book_results'][0].title, 'Gideon the Ninth') + + + def test_search_html_response_users(self): + ''' searches remote connectors ''' + view = views.Search.as_view() + request = self.factory.get('', {'q': 'mouse'}) + with patch('bookwyrm.views.search.is_api_request') as is_api: + is_api.return_value = False + with patch('bookwyrm.connectors.connector_manager.search'): + response = view(request) + self.assertIsInstance(response, TemplateResponse) + self.assertEqual(response.template_name, 'search_results.html') + self.assertEqual( + response.context_data['user_results'][0], self.local_user) diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index d7efa0fb..56dac60a 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -3,7 +3,7 @@ from django.conf.urls.static import static from django.contrib import admin from django.urls import path, re_path -from bookwyrm import incoming, outgoing, settings, vviews, views, wellknown +from bookwyrm import incoming, outgoing, settings, views, wellknown from bookwyrm import view_actions as actions from bookwyrm.utils import regex @@ -49,11 +49,11 @@ urlpatterns = [ views.PasswordReset.as_view()), re_path(r'^change-password/?$', views.ChangePassword), - #invites + # invites re_path(r'^invite/?$', views.ManageInvites.as_view()), re_path(r'^invite/(?P[A-Za-z0-9]+)/?$', views.Invite.as_view()), - #landing pages + # landing pages re_path(r'^about/?$', views.About.as_view()), path('', views.Home.as_view()), re_path(r'^(?Phome|local|federated)/?$', views.Feed.as_view()), @@ -61,6 +61,9 @@ urlpatterns = [ re_path(r'^notifications/?$', views.Notifications.as_view()), re_path(r'^direct-messages/?$', views.DirectMessage.as_view()), + # search + re_path(r'^search/?$', views.Search.as_view()), + # imports re_path(r'^import/?$', views.Import.as_view()), re_path(r'^import/(\d+)/?$', views.ImportStatus.as_view()), @@ -116,8 +119,6 @@ urlpatterns = [ re_path(r'^shelve/?$', views.shelve), re_path(r'^unshelve/?$', views.unshelve), - re_path(r'^search/?$', vviews.search), - re_path(r'^edit-readthrough/?$', actions.edit_readthrough), re_path(r'^delete-readthrough/?$', actions.delete_readthrough), re_path(r'^create-readthrough/?$', actions.create_readthrough), diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 609fbfa0..778badeb 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -16,3 +16,4 @@ from .tag import Tag, AddTag, RemoveTag from .shelf import Shelf from .shelf import user_shelves_page, create_shelf, delete_shelf from .shelf import shelve, unshelve +from .search import Search diff --git a/bookwyrm/views/search.py b/bookwyrm/views/search.py new file mode 100644 index 00000000..8066777a --- /dev/null +++ b/bookwyrm/views/search.py @@ -0,0 +1,53 @@ +''' search views''' +import re + +from django.contrib.postgres.search import TrigramSimilarity +from django.db.models.functions import Greatest +from django.http import JsonResponse +from django.template.response import TemplateResponse +from django.views import View + +from bookwyrm import models +from bookwyrm.connectors import connector_manager +from bookwyrm.utils import regex +from .helpers import is_api_request +from .helpers import handle_remote_webfinger + + +# pylint: disable= no-self-use +class Search(View): + ''' search users or books ''' + def get(self, request): + ''' that search bar up top ''' + query = request.GET.get('q') + min_confidence = request.GET.get('min_confidence', 0.1) + + if is_api_request(request): + # only return local book results via json so we don't cascade + book_results = connector_manager.local_search( + query, min_confidence=min_confidence) + return JsonResponse([r.json() for r in book_results], safe=False) + + # use webfinger for mastodon style account@domain.com username + if re.match(r'\B%s' % regex.full_username, query): + handle_remote_webfinger(query) + + # do a local user search + user_results = models.User.objects.annotate( + similarity=Greatest( + TrigramSimilarity('username', query), + TrigramSimilarity('localname', query), + ) + ).filter( + similarity__gt=0.5, + ).order_by('-similarity')[:10] + + book_results = connector_manager.search( + query, min_confidence=min_confidence) + data = { + 'title': 'Search Results', + 'book_results': book_results, + 'user_results': user_results, + 'query': query, + } + return TemplateResponse(request, 'search_results.html', data) diff --git a/bookwyrm/vviews.py b/bookwyrm/vviews.py index a9d75879..d849970a 100644 --- a/bookwyrm/vviews.py +++ b/bookwyrm/vviews.py @@ -1,16 +1,5 @@ ''' views for pages you can go to in the application ''' -import re - -from django.contrib.postgres.search import TrigramSimilarity -from django.db.models.functions import Greatest -from django.http import JsonResponse from django.template.response import TemplateResponse -from django.views.decorators.http import require_GET - -from bookwyrm import outgoing -from bookwyrm import models -from bookwyrm.connectors import connector_manager -from bookwyrm.utils import regex def is_api_request(request): @@ -28,40 +17,3 @@ def not_found_page(request, _): ''' 404s ''' return TemplateResponse( request, 'notfound.html', {'title': 'Not found'}, status=404) - - -@require_GET -def search(request): - ''' that search bar up top ''' - query = request.GET.get('q') - min_confidence = request.GET.get('min_confidence', 0.1) - - if is_api_request(request): - # only return local book results via json so we don't cause a cascade - book_results = connector_manager.local_search( - query, min_confidence=min_confidence) - return JsonResponse([r.json() for r in book_results], safe=False) - - # use webfinger for mastodon style account@domain.com username - if re.match(r'\B%s' % regex.full_username, query): - outgoing.handle_remote_webfinger(query) - - # do a local user search - user_results = models.User.objects.annotate( - similarity=Greatest( - TrigramSimilarity('username', query), - TrigramSimilarity('localname', query), - ) - ).filter( - similarity__gt=0.5, - ).order_by('-similarity')[:10] - - book_results = connector_manager.search( - query, min_confidence=min_confidence) - data = { - 'title': 'Search Results', - 'book_results': book_results, - 'user_results': user_results, - 'query': query, - } - return TemplateResponse(request, 'search_results.html', data) From ffd403dd47cfc323b98f054facd15e8625120aec Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 12:08:35 -0800 Subject: [PATCH 22/34] sorts imports for views --- bookwyrm/views/__init__.py | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 778badeb..62b046a3 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -1,19 +1,20 @@ ''' make sure all our nice views are available ''' from .authentication import Login, Register, Logout -from .password import PasswordResetRequest, PasswordReset, ChangePassword +from .author import Author, EditAuthor +from .books import Book, EditBook, Editions +from .books import upload_cover, add_description, switch_edition, resolve_book +from .direct_message import DirectMessage +from .error import not_found_page, server_error_page +from .import_data import Import, ImportStatus +from .interaction import Favorite, Unfavorite, Boost, Unboost from .invite import ManageInvites, Invite from .landing import About, Home, Feed, Discover from .notifications import Notifications -from .direct_message import DirectMessage -from .import_data import Import, ImportStatus -from .user import User, EditUser, Followers, Following -from .status import Status, Replies, CreateStatus, DeleteStatus -from .interaction import Favorite, Unfavorite, Boost, Unboost -from .books import Book, EditBook, Editions -from .books import upload_cover, add_description, switch_edition, resolve_book -from .author import Author, EditAuthor +from .password import PasswordResetRequest, PasswordReset, ChangePassword from .tag import Tag, AddTag, RemoveTag +from .search import Search from .shelf import Shelf from .shelf import user_shelves_page, create_shelf, delete_shelf from .shelf import shelve, unshelve -from .search import Search +from .status import Status, Replies, CreateStatus, DeleteStatus +from .user import User, EditUser, Followers, Following From 12bf34e2424e753a5aeab198aa9fffca19bf4248 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 12:08:51 -0800 Subject: [PATCH 23/34] Adds error page views --- bookwyrm/urls.py | 4 ++-- bookwyrm/views/error.py | 13 +++++++++++++ 2 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 bookwyrm/views/error.py diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index 56dac60a..ee70ae2a 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -23,8 +23,8 @@ status_path = r'%s/(%s)/(?P\d+)' % \ book_path = r'^book/(?P\d+)' -handler404 = 'bookwyrm.vviews.not_found_page' -handler500 = 'bookwyrm.vviews.server_error_page' +handler404 = 'bookwyrm.views.not_found_page' +handler500 = 'bookwyrm.views.server_error_page' urlpatterns = [ path('admin/', admin.site.urls), diff --git a/bookwyrm/views/error.py b/bookwyrm/views/error.py new file mode 100644 index 00000000..9eabe29f --- /dev/null +++ b/bookwyrm/views/error.py @@ -0,0 +1,13 @@ +''' something has gone amiss ''' +from django.template.response import TemplateResponse + +def server_error_page(request): + ''' 500 errors ''' + return TemplateResponse( + request, 'error.html', {'title': 'Oops!'}, status=500) + + +def not_found_page(request, _): + ''' 404s ''' + return TemplateResponse( + request, 'notfound.html', {'title': 'Not found'}, status=404) From 2e61bd0e7a4ae4d278633ee376fa7b74963938a5 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 12:18:19 -0800 Subject: [PATCH 24/34] Removes old views file --- bookwyrm/tests/test_outgoing.py | 48 -------------- bookwyrm/tests/test_view_actions.py | 55 ---------------- .../{test_views.py => views/test_helpers.py} | 63 ++++++++++--------- bookwyrm/vviews.py | 19 ------ 4 files changed, 33 insertions(+), 152 deletions(-) rename bookwyrm/tests/{test_views.py => views/test_helpers.py} (73%) delete mode 100644 bookwyrm/vviews.py diff --git a/bookwyrm/tests/test_outgoing.py b/bookwyrm/tests/test_outgoing.py index ec29b48d..78caa93a 100644 --- a/bookwyrm/tests/test_outgoing.py +++ b/bookwyrm/tests/test_outgoing.py @@ -211,54 +211,6 @@ class Outgoing(TestCase): self.assertEqual(result.username, 'mouse@example.com') - def test_handle_shelve(self): - ''' shelve a book ''' - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_shelve(self.local_user, self.book, self.shelf) - # make sure the book is on the shelf - self.assertEqual(self.shelf.books.get(), self.book) - - - def test_handle_shelve_to_read(self): - ''' special behavior for the to-read shelf ''' - shelf = models.Shelf.objects.get(identifier='to-read') - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_shelve(self.local_user, self.book, shelf) - # make sure the book is on the shelf - self.assertEqual(shelf.books.get(), self.book) - - - def test_handle_shelve_reading(self): - ''' special behavior for the reading shelf ''' - shelf = models.Shelf.objects.get(identifier='reading') - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_shelve(self.local_user, self.book, shelf) - # make sure the book is on the shelf - self.assertEqual(shelf.books.get(), self.book) - - - def test_handle_shelve_read(self): - ''' special behavior for the read shelf ''' - shelf = models.Shelf.objects.get(identifier='read') - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_shelve(self.local_user, self.book, shelf) - # make sure the book is on the shelf - self.assertEqual(shelf.books.get(), self.book) - - - def test_handle_unshelve(self): - ''' remove a book from a shelf ''' - self.shelf.books.add(self.book) - self.shelf.save() - self.assertEqual(self.shelf.books.count(), 1) - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_unshelve(self.local_user, self.book, self.shelf) - self.assertEqual(self.shelf.books.count(), 0) - - def test_handle_reading_status_to_read(self): ''' posts shelve activities ''' shelf = self.local_user.shelf_set.get(identifier='to-read') diff --git a/bookwyrm/tests/test_view_actions.py b/bookwyrm/tests/test_view_actions.py index a554c645..11fefae4 100644 --- a/bookwyrm/tests/test_view_actions.py +++ b/bookwyrm/tests/test_view_actions.py @@ -48,61 +48,6 @@ class ViewActions(TestCase): self.factory = RequestFactory() - def test_edit_shelf_privacy(self): - ''' set name or privacy on shelf ''' - shelf = self.local_user.shelf_set.get(identifier='to-read') - self.assertEqual(shelf.privacy, 'public') - - request = self.factory.post( - '', { - 'privacy': 'unlisted', - 'user': self.local_user.id, - 'name': 'To Read', - }) - request.user = self.local_user - actions.edit_shelf(request, shelf.id) - shelf.refresh_from_db() - - self.assertEqual(shelf.privacy, 'unlisted') - - - def test_edit_shelf_name(self): - ''' change the name of an editable shelf ''' - shelf = models.Shelf.objects.create( - name='Test Shelf', user=self.local_user) - self.assertEqual(shelf.privacy, 'public') - - request = self.factory.post( - '', { - 'privacy': 'public', - 'user': self.local_user.id, - 'name': 'cool name' - }) - request.user = self.local_user - actions.edit_shelf(request, shelf.id) - shelf.refresh_from_db() - - self.assertEqual(shelf.name, 'cool name') - self.assertEqual(shelf.identifier, 'testshelf-%d' % shelf.id) - - - def test_edit_shelf_name_not_editable(self): - ''' can't change the name of an non-editable shelf ''' - shelf = self.local_user.shelf_set.get(identifier='to-read') - self.assertEqual(shelf.privacy, 'public') - - request = self.factory.post( - '', { - 'privacy': 'public', - 'user': self.local_user.id, - 'name': 'cool name' - }) - request.user = self.local_user - actions.edit_shelf(request, shelf.id) - - self.assertEqual(shelf.name, 'To Read') - - def test_edit_readthrough(self): ''' adding dates to an ongoing readthrough ''' start = timezone.make_aware(dateutil.parser.parse('2021-01-03')) diff --git a/bookwyrm/tests/test_views.py b/bookwyrm/tests/views/test_helpers.py similarity index 73% rename from bookwyrm/tests/test_views.py rename to bookwyrm/tests/views/test_helpers.py index 66721fd4..66973a31 100644 --- a/bookwyrm/tests/test_views.py +++ b/bookwyrm/tests/views/test_helpers.py @@ -1,31 +1,27 @@ ''' test for app action functionality ''' from unittest.mock import patch - from django.test import TestCase from django.test.client import RequestFactory -from bookwyrm import models -from bookwyrm import vviews as views +from bookwyrm import models, views from bookwyrm.settings import USER_AGENT - -# pylint: disable=too-many-public-methods -class Views(TestCase): - ''' every response to a get request, html or json ''' +class ViewsHelpers(TestCase): + ''' viewing and creating statuses ''' def setUp(self): ''' we need basic test data and mocks ''' self.factory = RequestFactory() + self.local_user = models.User.objects.create_user( + 'mouse@local.com', 'mouse@mouse.com', 'mouseword', + local=True, localname='mouse', + remote_id='https://example.com/users/mouse', + ) self.work = models.Work.objects.create(title='Test Work') self.book = models.Edition.objects.create( - title='Test Book', parent_work=self.work) - models.Connector.objects.create( - identifier='self', - connector_file='self_connector', - local=True + title='Test Book', + remote_id='https://example.com/book/1', + parent_work=self.work ) - self.local_user = models.User.objects.create_user( - 'mouse@local.com', 'mouse@mouse.mouse', 'password', - local=True, localname='mouse') with patch('bookwyrm.models.user.set_remote_server.delay'): self.remote_user = models.User.objects.create_user( 'rat', 'rat@rat.com', 'ratword', @@ -35,30 +31,37 @@ class Views(TestCase): outbox='https://example.com/users/rat/outbox', ) + def test_get_edition(self): + ''' given an edition or a work, returns an edition ''' + self.assertEqual( + views.helpers.get_edition(self.book.id), self.book) + self.assertEqual( + views.helpers.get_edition(self.work.id), self.book) def test_get_user_from_username(self): ''' works for either localname or username ''' self.assertEqual( - views.get_user_from_username('mouse'), self.local_user) + views.helpers.get_user_from_username('mouse'), self.local_user) self.assertEqual( - views.get_user_from_username('mouse@local.com'), self.local_user) + views.helpers.get_user_from_username( + 'mouse@local.com'), self.local_user) with self.assertRaises(models.User.DoesNotExist): - views.get_user_from_username('mojfse@example.com') + views.helpers.get_user_from_username('mojfse@example.com') def test_is_api_request(self): ''' should it return html or json ''' request = self.factory.get('/path') request.headers = {'Accept': 'application/json'} - self.assertTrue(views.is_api_request(request)) + self.assertTrue(views.helpers.is_api_request(request)) request = self.factory.get('/path.json') request.headers = {'Accept': 'Praise'} - self.assertTrue(views.is_api_request(request)) + self.assertTrue(views.helpers.is_api_request(request)) request = self.factory.get('/path') request.headers = {'Accept': 'Praise'} - self.assertFalse(views.is_api_request(request)) + self.assertFalse(views.helpers.is_api_request(request)) def test_get_activity_feed(self): @@ -83,7 +86,7 @@ class Views(TestCase): content='blah blah blah', user=rat, privacy='followers') rat_mention.mention_users.set([self.local_user]) - statuses = views.get_activity_feed( + statuses = views.helpers.get_activity_feed( self.local_user, ['public', 'unlisted', 'followers'], following_only=True, @@ -92,7 +95,7 @@ class Views(TestCase): self.assertEqual(len(statuses), 1) self.assertEqual(statuses[0], public_status) - statuses = views.get_activity_feed( + statuses = views.helpers.get_activity_feed( self.local_user, ['public', 'followers'], local_only=True @@ -101,11 +104,11 @@ class Views(TestCase): self.assertEqual(statuses[1], public_status) self.assertEqual(statuses[0], rat_public) - statuses = views.get_activity_feed(self.local_user, 'direct') + statuses = views.helpers.get_activity_feed(self.local_user, 'direct') self.assertEqual(len(statuses), 1) self.assertEqual(statuses[0], direct_status) - statuses = views.get_activity_feed( + statuses = views.helpers.get_activity_feed( self.local_user, ['public', 'followers'], ) @@ -114,7 +117,7 @@ class Views(TestCase): self.assertEqual(statuses[1], rat_public) self.assertEqual(statuses[0], remote_status) - statuses = views.get_activity_feed( + statuses = views.helpers.get_activity_feed( self.local_user, ['public', 'unlisted', 'followers'], following_only=True @@ -124,7 +127,7 @@ class Views(TestCase): self.assertEqual(statuses[0], rat_mention) rat.followers.add(self.local_user) - statuses = views.get_activity_feed( + statuses = views.helpers.get_activity_feed( self.local_user, ['public', 'unlisted', 'followers'], following_only=True @@ -140,15 +143,15 @@ class Views(TestCase): def test_is_bookwyrm_request(self): ''' checks if a request came from a bookwyrm instance ''' request = self.factory.get('', {'q': 'Test Book'}) - self.assertFalse(views.is_bookworm_request(request)) + self.assertFalse(views.helpers.is_bookworm_request(request)) request = self.factory.get( '', {'q': 'Test Book'}, HTTP_USER_AGENT=\ "http.rb/4.4.1 (Mastodon/3.3.0; +https://mastodon.social/)" ) - self.assertFalse(views.is_bookworm_request(request)) + self.assertFalse(views.helpers.is_bookworm_request(request)) request = self.factory.get( '', {'q': 'Test Book'}, HTTP_USER_AGENT=USER_AGENT) - self.assertTrue(views.is_bookworm_request(request)) + self.assertTrue(views.helpers.is_bookworm_request(request)) diff --git a/bookwyrm/vviews.py b/bookwyrm/vviews.py deleted file mode 100644 index d849970a..00000000 --- a/bookwyrm/vviews.py +++ /dev/null @@ -1,19 +0,0 @@ -''' views for pages you can go to in the application ''' -from django.template.response import TemplateResponse - - -def is_api_request(request): - ''' check whether a request is asking for html or data ''' - return 'json' in request.headers.get('Accept') or \ - request.path[-5:] == '.json' - -def server_error_page(request): - ''' 500 errors ''' - return TemplateResponse( - request, 'error.html', {'title': 'Oops!'}, status=500) - - -def not_found_page(request, _): - ''' 404s ''' - return TemplateResponse( - request, 'notfound.html', {'title': 'Not found'}, status=404) From 7555d76c3ffd7674bcfecbbaf2624cabd3f78870 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 12:33:48 -0800 Subject: [PATCH 25/34] Adds reading acitivity views --- bookwyrm/outgoing.py | 10 +-- bookwyrm/urls.py | 12 +-- bookwyrm/view_actions.py | 158 ---------------------------------- bookwyrm/views/__init__.py | 2 + bookwyrm/views/reading.py | 171 +++++++++++++++++++++++++++++++++++++ bookwyrm/views/shelf.py | 4 +- 6 files changed, 182 insertions(+), 175 deletions(-) create mode 100644 bookwyrm/views/reading.py diff --git a/bookwyrm/outgoing.py b/bookwyrm/outgoing.py index 18c1eaea..9b259012 100644 --- a/bookwyrm/outgoing.py +++ b/bookwyrm/outgoing.py @@ -1,23 +1,15 @@ ''' handles all the activity coming out of the server ''' -import re - -from django.db import IntegrityError, transaction +from django.db import transaction from django.http import JsonResponse from django.shortcuts import get_object_or_404 from django.views.decorators.csrf import csrf_exempt from django.views.decorators.http import require_GET -from markdown import markdown from requests import HTTPError from bookwyrm import activitypub from bookwyrm import models from bookwyrm.connectors import get_data, ConnectorException from bookwyrm.broadcast import broadcast -from bookwyrm.sanitize_html import InputHtmlParser -from bookwyrm.status import create_notification -from bookwyrm.status import create_generated_note -from bookwyrm.settings import DOMAIN -from bookwyrm.utils import regex @csrf_exempt diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index ee70ae2a..96fcd2c5 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -119,13 +119,15 @@ urlpatterns = [ re_path(r'^shelve/?$', views.shelve), re_path(r'^unshelve/?$', views.unshelve), - re_path(r'^edit-readthrough/?$', actions.edit_readthrough), - re_path(r'^delete-readthrough/?$', actions.delete_readthrough), - re_path(r'^create-readthrough/?$', actions.create_readthrough), + # reading progress + re_path(r'^edit-readthrough/?$', views.edit_readthrough), + re_path(r'^delete-readthrough/?$', views.delete_readthrough), + re_path(r'^create-readthrough/?$', views.create_readthrough), - re_path(r'^start-reading/(?P\d+)/?$', actions.start_reading), - re_path(r'^finish-reading/(?P\d+)/?$', actions.finish_reading), + re_path(r'^start-reading/(?P\d+)/?$', views.start_reading), + re_path(r'^finish-reading/(?P\d+)/?$', views.finish_reading), + # following re_path(r'^follow/?$', actions.follow), re_path(r'^unfollow/?$', actions.unfollow), re_path(r'^accept-follow-request/?$', actions.accept_follow_request), diff --git a/bookwyrm/view_actions.py b/bookwyrm/view_actions.py index 20e4f300..50506203 100644 --- a/bookwyrm/view_actions.py +++ b/bookwyrm/view_actions.py @@ -1,11 +1,7 @@ ''' views for actions you can take in the application ''' -import dateutil.parser -from dateutil.parser import ParserError - from django.contrib.auth.decorators import login_required from django.http import HttpResponseBadRequest, HttpResponseNotFound from django.shortcuts import get_object_or_404, redirect -from django.utils import timezone from django.views.decorators.http import require_POST from bookwyrm import models, outgoing @@ -25,122 +21,6 @@ def get_user_from_username(username): except models.User.DoesNotExist: return models.User.objects.get(username=username) - -@login_required -@require_POST -def start_reading(request, book_id): - ''' begin reading a book ''' - book = get_edition(book_id) - shelf = models.Shelf.objects.filter( - identifier='reading', - user=request.user - ).first() - - # create a readthrough - readthrough = update_readthrough(request, book=book) - if readthrough.start_date: - readthrough.save() - - # shelve the book - if request.POST.get('reshelve', True): - try: - current_shelf = models.Shelf.objects.get( - user=request.user, - edition=book - ) - outgoing.handle_unshelve(request.user, book, current_shelf) - except models.Shelf.DoesNotExist: - # this just means it isn't currently on the user's shelves - pass - outgoing.handle_shelve(request.user, book, shelf) - - # post about it (if you want) - if request.POST.get('post-status'): - privacy = request.POST.get('privacy') - outgoing.handle_reading_status(request.user, shelf, book, privacy) - - return redirect(request.headers.get('Referer', '/')) - - -@login_required -@require_POST -def finish_reading(request, book_id): - ''' a user completed a book, yay ''' - book = get_edition(book_id) - shelf = models.Shelf.objects.filter( - identifier='read', - user=request.user - ).first() - - # update or create a readthrough - readthrough = update_readthrough(request, book=book) - if readthrough.start_date or readthrough.finish_date: - readthrough.save() - - # shelve the book - if request.POST.get('reshelve', True): - try: - current_shelf = models.Shelf.objects.get( - user=request.user, - edition=book - ) - outgoing.handle_unshelve(request.user, book, current_shelf) - except models.Shelf.DoesNotExist: - # this just means it isn't currently on the user's shelves - pass - outgoing.handle_shelve(request.user, book, shelf) - - # post about it (if you want) - if request.POST.get('post-status'): - privacy = request.POST.get('privacy') - outgoing.handle_reading_status(request.user, shelf, book, privacy) - - return redirect(request.headers.get('Referer', '/')) - - -@login_required -@require_POST -def edit_readthrough(request): - ''' can't use the form because the dates are too finnicky ''' - readthrough = update_readthrough(request, create=False) - if not readthrough: - return HttpResponseNotFound() - - # don't let people edit other people's data - if request.user != readthrough.user: - return HttpResponseBadRequest() - readthrough.save() - - return redirect(request.headers.get('Referer', '/')) - - -@login_required -@require_POST -def delete_readthrough(request): - ''' remove a readthrough ''' - readthrough = get_object_or_404( - models.ReadThrough, id=request.POST.get('id')) - - # don't let people edit other people's data - if request.user != readthrough.user: - return HttpResponseBadRequest() - - readthrough.delete() - return redirect(request.headers.get('Referer', '/')) - - -@login_required -@require_POST -def create_readthrough(request): - ''' can't use the form because the dates are too finnicky ''' - book = get_object_or_404(models.Edition, id=request.POST.get('book')) - readthrough = update_readthrough(request, create=True, book=book) - if not readthrough: - return redirect(book.local_path) - readthrough.save() - return redirect(request.headers.get('Referer', '/')) - - @login_required @require_POST def follow(request): @@ -217,41 +97,3 @@ def delete_follow_request(request): outgoing.handle_reject(follow_request) return redirect('/user/%s' % request.user.localname) - - -def update_readthrough(request, book=None, create=True): - ''' updates but does not save dates on a readthrough ''' - try: - read_id = request.POST.get('id') - if not read_id: - raise models.ReadThrough.DoesNotExist - readthrough = models.ReadThrough.objects.get(id=read_id) - except models.ReadThrough.DoesNotExist: - if not create or not book: - return None - readthrough = models.ReadThrough( - user=request.user, - book=book, - ) - - start_date = request.POST.get('start_date') - if start_date: - try: - start_date = timezone.make_aware(dateutil.parser.parse(start_date)) - readthrough.start_date = start_date - except ParserError: - pass - - finish_date = request.POST.get('finish_date') - if finish_date: - try: - finish_date = timezone.make_aware( - dateutil.parser.parse(finish_date)) - readthrough.finish_date = finish_date - except ParserError: - pass - - if not readthrough.start_date and not readthrough.finish_date: - return None - - return readthrough diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 62b046a3..38b03f48 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -10,6 +10,8 @@ from .interaction import Favorite, Unfavorite, Boost, Unboost from .invite import ManageInvites, Invite from .landing import About, Home, Feed, Discover from .notifications import Notifications +from .reading import edit_readthrough, create_readthrough, delete_readthrough +from .reading import start_reading, finish_reading from .password import PasswordResetRequest, PasswordReset, ChangePassword from .tag import Tag, AddTag, RemoveTag from .search import Search diff --git a/bookwyrm/views/reading.py b/bookwyrm/views/reading.py new file mode 100644 index 00000000..51fb2419 --- /dev/null +++ b/bookwyrm/views/reading.py @@ -0,0 +1,171 @@ +''' the good stuff! the books! ''' +import dateutil.parser +from dateutil.parser import ParserError + +from django.contrib.auth.decorators import login_required +from django.http import HttpResponseBadRequest, HttpResponseNotFound +from django.shortcuts import get_object_or_404, redirect +from django.utils import timezone +from django.views.decorators.http import require_POST + +from bookwyrm import models +from bookwyrm.broadcast import broadcast +from .helpers import get_edition, handle_reading_status, handle_unshelve + + +# pylint: disable= no-self-use +@login_required +@require_POST +def start_reading(request, book_id): + ''' begin reading a book ''' + book = get_edition(book_id) + shelf = models.Shelf.objects.filter( + identifier='reading', + user=request.user + ).first() + + # create a readthrough + readthrough = update_readthrough(request, book=book) + if readthrough.start_date: + readthrough.save() + + # shelve the book + if request.POST.get('reshelve', True): + try: + current_shelf = models.Shelf.objects.get( + user=request.user, + edition=book + ) + handle_unshelve(request.user, book, current_shelf) + except models.Shelf.DoesNotExist: + # this just means it isn't currently on the user's shelves + pass + shelfbook = models.ShelfBook.objects.create( + book=book, shelf=shelf, added_by=request.user) + broadcast(request.user, shelfbook.to_add_activity(request.user)) + + # post about it (if you want) + if request.POST.get('post-status'): + privacy = request.POST.get('privacy') + handle_reading_status(request.user, shelf, book, privacy) + + return redirect(request.headers.get('Referer', '/')) + + +@login_required +@require_POST +def finish_reading(request, book_id): + ''' a user completed a book, yay ''' + book = get_edition(book_id) + shelf = models.Shelf.objects.filter( + identifier='read', + user=request.user + ).first() + + # update or create a readthrough + readthrough = update_readthrough(request, book=book) + if readthrough.start_date or readthrough.finish_date: + readthrough.save() + + # shelve the book + if request.POST.get('reshelve', True): + try: + current_shelf = models.Shelf.objects.get( + user=request.user, + edition=book + ) + handle_unshelve(request.user, book, current_shelf) + except models.Shelf.DoesNotExist: + # this just means it isn't currently on the user's shelves + pass + shelfbook = models.ShelfBook.objects.create( + book=book, shelf=shelf, added_by=request.user) + broadcast(request.user, shelfbook.to_add_activity(request.user)) + + # post about it (if you want) + if request.POST.get('post-status'): + privacy = request.POST.get('privacy') + handle_reading_status(request.user, shelf, book, privacy) + + return redirect(request.headers.get('Referer', '/')) + + +@login_required +@require_POST +def edit_readthrough(request): + ''' can't use the form because the dates are too finnicky ''' + readthrough = update_readthrough(request, create=False) + if not readthrough: + return HttpResponseNotFound() + + # don't let people edit other people's data + if request.user != readthrough.user: + return HttpResponseBadRequest() + readthrough.save() + + return redirect(request.headers.get('Referer', '/')) + + +@login_required +@require_POST +def delete_readthrough(request): + ''' remove a readthrough ''' + readthrough = get_object_or_404( + models.ReadThrough, id=request.POST.get('id')) + + # don't let people edit other people's data + if request.user != readthrough.user: + return HttpResponseBadRequest() + + readthrough.delete() + return redirect(request.headers.get('Referer', '/')) + + +@login_required +@require_POST +def create_readthrough(request): + ''' can't use the form because the dates are too finnicky ''' + book = get_object_or_404(models.Edition, id=request.POST.get('book')) + readthrough = update_readthrough(request, create=True, book=book) + if not readthrough: + return redirect(book.local_path) + readthrough.save() + return redirect(request.headers.get('Referer', '/')) + + +def update_readthrough(request, book=None, create=True): + ''' updates but does not save dates on a readthrough ''' + try: + read_id = request.POST.get('id') + if not read_id: + raise models.ReadThrough.DoesNotExist + readthrough = models.ReadThrough.objects.get(id=read_id) + except models.ReadThrough.DoesNotExist: + if not create or not book: + return None + readthrough = models.ReadThrough( + user=request.user, + book=book, + ) + + start_date = request.POST.get('start_date') + if start_date: + try: + start_date = timezone.make_aware(dateutil.parser.parse(start_date)) + readthrough.start_date = start_date + except ParserError: + pass + + finish_date = request.POST.get('finish_date') + if finish_date: + try: + finish_date = timezone.make_aware( + dateutil.parser.parse(finish_date)) + readthrough.finish_date = finish_date + except ParserError: + pass + + if not readthrough.start_date and not readthrough.finish_date: + return None + + return readthrough diff --git a/bookwyrm/views/shelf.py b/bookwyrm/views/shelf.py index 968f0cbe..ce836955 100644 --- a/bookwyrm/views/shelf.py +++ b/bookwyrm/views/shelf.py @@ -134,10 +134,8 @@ def shelve(request): except models.Shelf.DoesNotExist: # this just means it isn't currently on the user's shelves pass - shelfbook = models.ShelfBook( + shelfbook = models.ShelfBook.objects.create( book=book, shelf=desired_shelf, added_by=request.user) - shelfbook.save() - broadcast(request.user, shelfbook.to_add_activity(request.user)) # post about "want to read" shelves From a385aa4cb54ad801ed39132e0f69434de73afc1b Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 13:05:16 -0800 Subject: [PATCH 26/34] Following views --- bookwyrm/tests/test_outgoing.py | 60 ---------- bookwyrm/tests/views/test_follow.py | 108 ++++++++++++++++++ .../test_reading.py} | 50 +++----- bookwyrm/urls.py | 9 +- bookwyrm/view_actions.py | 99 ---------------- bookwyrm/views/__init__.py | 2 + bookwyrm/views/reading.py | 3 +- 7 files changed, 133 insertions(+), 198 deletions(-) create mode 100644 bookwyrm/tests/views/test_follow.py rename bookwyrm/tests/{test_view_actions.py => views/test_reading.py} (71%) diff --git a/bookwyrm/tests/test_outgoing.py b/bookwyrm/tests/test_outgoing.py index 78caa93a..6cd84070 100644 --- a/bookwyrm/tests/test_outgoing.py +++ b/bookwyrm/tests/test_outgoing.py @@ -112,66 +112,6 @@ class Outgoing(TestCase): self.assertEqual(data['totalItems'], 1) - def test_handle_follow(self): - ''' send a follow request ''' - self.assertEqual(models.UserFollowRequest.objects.count(), 0) - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_follow(self.local_user, self.remote_user) - - rel = models.UserFollowRequest.objects.get() - - self.assertEqual(rel.user_subject, self.local_user) - self.assertEqual(rel.user_object, self.remote_user) - self.assertEqual(rel.status, 'follow_request') - - - def test_handle_unfollow(self): - ''' send an unfollow ''' - self.remote_user.followers.add(self.local_user) - self.assertEqual(self.remote_user.followers.count(), 1) - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_unfollow(self.local_user, self.remote_user) - - self.assertEqual(self.remote_user.followers.count(), 0) - - - def test_handle_accept(self): - ''' accept a follow request ''' - rel = models.UserFollowRequest.objects.create( - user_subject=self.local_user, - user_object=self.remote_user - ) - rel_id = rel.id - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_accept(rel) - # request should be deleted - self.assertEqual( - models.UserFollowRequest.objects.filter(id=rel_id).count(), 0 - ) - # follow relationship should exist - self.assertEqual(self.remote_user.followers.first(), self.local_user) - - - def test_handle_reject(self): - ''' reject a follow request ''' - rel = models.UserFollowRequest.objects.create( - user_subject=self.local_user, - user_object=self.remote_user - ) - rel_id = rel.id - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_reject(rel) - # request should be deleted - self.assertEqual( - models.UserFollowRequest.objects.filter(id=rel_id).count(), 0 - ) - # follow relationship should not exist - self.assertEqual( - models.UserFollows.objects.filter(id=rel_id).count(), 0 - ) def test_existing_user(self): ''' simple database lookup by username ''' diff --git a/bookwyrm/tests/views/test_follow.py b/bookwyrm/tests/views/test_follow.py new file mode 100644 index 00000000..9bbf67fb --- /dev/null +++ b/bookwyrm/tests/views/test_follow.py @@ -0,0 +1,108 @@ +''' test for app action functionality ''' +from unittest.mock import patch +from django.contrib.auth.models import Group, Permission +from django.contrib.contenttypes.models import ContentType +from django.test import TestCase +from django.test.client import RequestFactory + +from bookwyrm import models, views + + +class BookViews(TestCase): + ''' books books books ''' + def setUp(self): + ''' we need basic test data and mocks ''' + self.factory = RequestFactory() + self.local_user = models.User.objects.create_user( + 'mouse@local.com', 'mouse@mouse.com', 'mouseword', + local=True, localname='mouse', + remote_id='https://example.com/users/mouse', + ) + with patch('bookwyrm.models.user.set_remote_server'): + self.remote_user = models.User.objects.create_user( + 'rat', 'rat@email.com', 'ratword', + local=False, + remote_id='https://example.com/users/rat', + inbox='https://example.com/users/rat/inbox', + outbox='https://example.com/users/rat/outbox', + ) + self.group = Group.objects.create(name='editor') + self.group.permissions.add( + Permission.objects.create( + name='edit_book', + codename='edit_book', + content_type=ContentType.objects.get_for_model(models.User)).id + ) + self.work = models.Work.objects.create(title='Test Work') + self.book = models.Edition.objects.create( + title='Example Edition', + remote_id='https://example.com/book/1', + parent_work=self.work + ) + + def test_handle_follow(self): + ''' send a follow request ''' + request = self.factory.post('', {'user': self.remote_user.username}) + request.user = self.local_user + self.assertEqual(models.UserFollowRequest.objects.count(), 0) + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + views.follow(request) + + rel = models.UserFollowRequest.objects.get() + + self.assertEqual(rel.user_subject, self.local_user) + self.assertEqual(rel.user_object, self.remote_user) + self.assertEqual(rel.status, 'follow_request') + + + def test_handle_unfollow(self): + ''' send an unfollow ''' + request = self.factory.post('', {'user': self.remote_user.username}) + request.user = self.local_user + self.remote_user.followers.add(self.local_user) + self.assertEqual(self.remote_user.followers.count(), 1) + with patch('bookwyrm.broadcast.broadcast_task.delay'): + views.unfollow(request) + + self.assertEqual(self.remote_user.followers.count(), 0) + + + def test_handle_accept(self): + ''' accept a follow request ''' + request = self.factory.post('', {'user': self.remote_user.username}) + request.user = self.local_user + rel = models.UserFollowRequest.objects.create( + user_subject=self.remote_user, + user_object=self.local_user + ) + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + views.accept_follow_request(request) + # request should be deleted + self.assertEqual( + models.UserFollowRequest.objects.filter(id=rel.id).count(), 0 + ) + # follow relationship should exist + self.assertEqual(self.local_user.followers.first(), self.remote_user) + + + def test_handle_reject(self): + ''' reject a follow request ''' + request = self.factory.post('', {'user': self.remote_user.username}) + request.user = self.local_user + rel = models.UserFollowRequest.objects.create( + user_subject=self.remote_user, + user_object=self.local_user + ) + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + views.delete_follow_request(request) + # request should be deleted + self.assertEqual( + models.UserFollowRequest.objects.filter(id=rel.id).count(), 0 + ) + # follow relationship should not exist + self.assertEqual( + models.UserFollows.objects.filter(id=rel.id).count(), 0 + ) diff --git a/bookwyrm/tests/test_view_actions.py b/bookwyrm/tests/views/test_reading.py similarity index 71% rename from bookwyrm/tests/test_view_actions.py rename to bookwyrm/tests/views/test_reading.py index 11fefae4..f5e4cd52 100644 --- a/bookwyrm/tests/test_view_actions.py +++ b/bookwyrm/tests/views/test_reading.py @@ -1,32 +1,27 @@ ''' test for app action functionality ''' from unittest.mock import patch - import dateutil -from django.contrib.auth.models import Group, Permission -from django.contrib.contenttypes.models import ContentType from django.test import TestCase from django.test.client import RequestFactory from django.utils import timezone -from bookwyrm import models, view_actions as actions +from bookwyrm import models, views - -#pylint: disable=too-many-public-methods -class ViewActions(TestCase): - ''' a lot here: all handlers for receiving activitypub requests ''' +class ReadingViews(TestCase): + ''' viewing and creating statuses ''' def setUp(self): - ''' we need basic things, like users ''' + ''' we need basic test data and mocks ''' + self.factory = RequestFactory() self.local_user = models.User.objects.create_user( - 'mouse', 'mouse@mouse.com', 'mouseword', - local=True, localname='mouse') - self.local_user.remote_id = 'https://example.com/user/mouse' - self.local_user.save() - self.group = Group.objects.create(name='editor') - self.group.permissions.add( - Permission.objects.create( - name='edit_book', - codename='edit_book', - content_type=ContentType.objects.get_for_model(models.User)).id + 'mouse@local.com', 'mouse@mouse.com', 'mouseword', + local=True, localname='mouse', + remote_id='https://example.com/users/mouse', + ) + self.work = models.Work.objects.create(title='Test Work') + self.book = models.Edition.objects.create( + title='Test Book', + remote_id='https://example.com/book/1', + parent_work=self.work ) with patch('bookwyrm.models.user.set_remote_server.delay'): self.remote_user = models.User.objects.create_user( @@ -36,17 +31,6 @@ class ViewActions(TestCase): inbox='https://example.com/users/rat/inbox', outbox='https://example.com/users/rat/outbox', ) - self.status = models.Status.objects.create( - user=self.local_user, - content='Test status', - remote_id='https://example.com/status/1', - ) - self.work = models.Work.objects.create(title='Test Work') - self.book = models.Edition.objects.create( - title='Test Book', parent_work=self.work) - self.settings = models.SiteSettings.objects.create(id=1) - self.factory = RequestFactory() - def test_edit_readthrough(self): ''' adding dates to an ongoing readthrough ''' @@ -62,7 +46,7 @@ class ViewActions(TestCase): }) request.user = self.local_user - actions.edit_readthrough(request) + views.edit_readthrough(request) readthrough.refresh_from_db() self.assertEqual(readthrough.start_date.year, 2017) self.assertEqual(readthrough.start_date.month, 1) @@ -85,7 +69,7 @@ class ViewActions(TestCase): }) request.user = self.local_user - actions.delete_readthrough(request) + views.delete_readthrough(request) self.assertFalse( models.ReadThrough.objects.filter(id=readthrough.id).exists()) @@ -101,7 +85,7 @@ class ViewActions(TestCase): }) request.user = self.local_user - actions.create_readthrough(request) + views.create_readthrough(request) readthrough = models.ReadThrough.objects.get() self.assertEqual(readthrough.start_date.year, 2017) self.assertEqual(readthrough.start_date.month, 1) diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index 96fcd2c5..c6ada37f 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -4,7 +4,6 @@ from django.contrib import admin from django.urls import path, re_path from bookwyrm import incoming, outgoing, settings, views, wellknown -from bookwyrm import view_actions as actions from bookwyrm.utils import regex user_path = r'^user/(?P%s)' % regex.username @@ -128,8 +127,8 @@ urlpatterns = [ re_path(r'^finish-reading/(?P\d+)/?$', views.finish_reading), # following - re_path(r'^follow/?$', actions.follow), - re_path(r'^unfollow/?$', actions.unfollow), - re_path(r'^accept-follow-request/?$', actions.accept_follow_request), - re_path(r'^delete-follow-request/?$', actions.delete_follow_request), + re_path(r'^follow/?$', views.follow), + re_path(r'^unfollow/?$', views.unfollow), + re_path(r'^accept-follow-request/?$', views.accept_follow_request), + re_path(r'^delete-follow-request/?$', views.delete_follow_request), ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT) diff --git a/bookwyrm/view_actions.py b/bookwyrm/view_actions.py index 50506203..e69de29b 100644 --- a/bookwyrm/view_actions.py +++ b/bookwyrm/view_actions.py @@ -1,99 +0,0 @@ -''' views for actions you can take in the application ''' -from django.contrib.auth.decorators import login_required -from django.http import HttpResponseBadRequest, HttpResponseNotFound -from django.shortcuts import get_object_or_404, redirect -from django.views.decorators.http import require_POST - -from bookwyrm import models, outgoing - -def get_edition(book_id): - ''' look up a book in the db and return an edition ''' - book = models.Book.objects.select_subclasses().get(id=book_id) - if isinstance(book, models.Work): - book = book.get_default_edition() - return book - -def get_user_from_username(username): - ''' helper function to resolve a localname or a username to a user ''' - # raises DoesNotExist if user is now found - try: - return models.User.objects.get(localname=username) - except models.User.DoesNotExist: - return models.User.objects.get(username=username) - -@login_required -@require_POST -def follow(request): - ''' follow another user, here or abroad ''' - username = request.POST['user'] - try: - to_follow = get_user_from_username(username) - except models.User.DoesNotExist: - return HttpResponseBadRequest() - - outgoing.handle_follow(request.user, to_follow) - user_slug = to_follow.localname if to_follow.localname \ - else to_follow.username - return redirect('/user/%s' % user_slug) - - -@login_required -@require_POST -def unfollow(request): - ''' unfollow a user ''' - username = request.POST['user'] - try: - to_unfollow = get_user_from_username(username) - except models.User.DoesNotExist: - return HttpResponseBadRequest() - - outgoing.handle_unfollow(request.user, to_unfollow) - user_slug = to_unfollow.localname if to_unfollow.localname \ - else to_unfollow.username - return redirect('/user/%s' % user_slug) - - -@login_required -@require_POST -def accept_follow_request(request): - ''' a user accepts a follow request ''' - username = request.POST['user'] - try: - requester = get_user_from_username(username) - except models.User.DoesNotExist: - return HttpResponseBadRequest() - - try: - follow_request = models.UserFollowRequest.objects.get( - user_subject=requester, - user_object=request.user - ) - except models.UserFollowRequest.DoesNotExist: - # Request already dealt with. - pass - else: - outgoing.handle_accept(follow_request) - - return redirect('/user/%s' % request.user.localname) - - -@login_required -@require_POST -def delete_follow_request(request): - ''' a user rejects a follow request ''' - username = request.POST['user'] - try: - requester = get_user_from_username(username) - except models.User.DoesNotExist: - return HttpResponseBadRequest() - - try: - follow_request = models.UserFollowRequest.objects.get( - user_subject=requester, - user_object=request.user - ) - except models.UserFollowRequest.DoesNotExist: - return HttpResponseBadRequest() - - outgoing.handle_reject(follow_request) - return redirect('/user/%s' % request.user.localname) diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 38b03f48..7c050339 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -5,6 +5,8 @@ from .books import Book, EditBook, Editions from .books import upload_cover, add_description, switch_edition, resolve_book from .direct_message import DirectMessage from .error import not_found_page, server_error_page +from .follow import follow, unfollow +from .follow import accept_follow_request, delete_follow_request from .import_data import Import, ImportStatus from .interaction import Favorite, Unfavorite, Boost, Unboost from .invite import ManageInvites, Invite diff --git a/bookwyrm/views/reading.py b/bookwyrm/views/reading.py index 51fb2419..51c3217e 100644 --- a/bookwyrm/views/reading.py +++ b/bookwyrm/views/reading.py @@ -10,7 +10,8 @@ from django.views.decorators.http import require_POST from bookwyrm import models from bookwyrm.broadcast import broadcast -from .helpers import get_edition, handle_reading_status, handle_unshelve +from .helpers import get_edition, handle_reading_status +from .shelf import handle_unshelve # pylint: disable= no-self-use From 3e5ed19643cfcee7a3675f06ae9e75c7f3526efe Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 13:36:01 -0800 Subject: [PATCH 27/34] Removes outgoing and view_actions --- bookwyrm/goodreads_import.py | 61 ++++++++++++- bookwyrm/incoming.py | 4 +- bookwyrm/outgoing.py | 161 ----------------------------------- bookwyrm/urls.py | 4 +- bookwyrm/view_actions.py | 0 bookwyrm/views/__init__.py | 3 +- bookwyrm/views/follow.py | 113 ++++++++++++++++++++++++ bookwyrm/views/outbox.py | 22 +++++ 8 files changed, 199 insertions(+), 169 deletions(-) delete mode 100644 bookwyrm/outgoing.py delete mode 100644 bookwyrm/view_actions.py create mode 100644 bookwyrm/views/follow.py create mode 100644 bookwyrm/views/outbox.py diff --git a/bookwyrm/goodreads_import.py b/bookwyrm/goodreads_import.py index 5c982764..b19994ed 100644 --- a/bookwyrm/goodreads_import.py +++ b/bookwyrm/goodreads_import.py @@ -2,10 +2,11 @@ import csv import logging -from bookwyrm import outgoing -from bookwyrm.tasks import app +from bookwyrm import models +from bookwyrm.broadcast import broadcast from bookwyrm.models import ImportJob, ImportItem from bookwyrm.status import create_notification +from bookwyrm.tasks import app logger = logging.getLogger(__name__) @@ -62,7 +63,7 @@ def import_data(job_id): item.save() # shelves book and handles reviews - outgoing.handle_imported_book( + handle_imported_book( job.user, item, job.include_reviews, job.privacy) else: item.fail_reason = 'Could not find a match for book' @@ -71,3 +72,57 @@ def import_data(job_id): create_notification(job.user, 'IMPORT', related_import=job) job.complete = True job.save() + + +def handle_imported_book(user, item, include_reviews, privacy): + ''' process a goodreads csv and then post about it ''' + if isinstance(item.book, models.Work): + item.book = item.book.default_edition + if not item.book: + return + + existing_shelf = models.ShelfBook.objects.filter( + book=item.book, added_by=user).exists() + + # shelve the book if it hasn't been shelved already + if item.shelf and not existing_shelf: + desired_shelf = models.Shelf.objects.get( + identifier=item.shelf, + user=user + ) + shelf_book = models.ShelfBook.objects.create( + book=item.book, shelf=desired_shelf, added_by=user) + broadcast(user, shelf_book.to_add_activity(user), privacy=privacy) + + for read in item.reads: + # check for an existing readthrough with the same dates + if models.ReadThrough.objects.filter( + user=user, book=item.book, + start_date=read.start_date, + finish_date=read.finish_date + ).exists(): + continue + read.book = item.book + read.user = user + read.save() + + if include_reviews and (item.rating or item.review): + review_title = 'Review of {!r} on Goodreads'.format( + item.book.title, + ) if item.review else '' + + # we don't know the publication date of the review, + # but "now" is a bad guess + published_date_guess = item.date_read or item.date_added + review = models.Review.objects.create( + user=user, + book=item.book, + name=review_title, + content=item.review, + rating=item.rating, + published_date=published_date_guess, + privacy=privacy, + ) + # we don't need to send out pure activities because non-bookwyrm + # instances don't need this data + broadcast(user, review.to_create_activity(user), privacy=privacy) diff --git a/bookwyrm/incoming.py b/bookwyrm/incoming.py index 920e99c5..9653c5d2 100644 --- a/bookwyrm/incoming.py +++ b/bookwyrm/incoming.py @@ -9,7 +9,7 @@ from django.views.decorators.csrf import csrf_exempt from django.views.decorators.http import require_POST import requests -from bookwyrm import activitypub, models, outgoing +from bookwyrm import activitypub, models, views from bookwyrm import status as status_builder from bookwyrm.tasks import app from bookwyrm.signatures import Signature @@ -133,7 +133,7 @@ def handle_follow(activity): related_user=relationship.user_subject ) if not manually_approves: - outgoing.handle_accept(relationship) + views.handle_accept(relationship) @app.task diff --git a/bookwyrm/outgoing.py b/bookwyrm/outgoing.py deleted file mode 100644 index 9b259012..00000000 --- a/bookwyrm/outgoing.py +++ /dev/null @@ -1,161 +0,0 @@ -''' handles all the activity coming out of the server ''' -from django.db import transaction -from django.http import JsonResponse -from django.shortcuts import get_object_or_404 -from django.views.decorators.csrf import csrf_exempt -from django.views.decorators.http import require_GET -from requests import HTTPError - -from bookwyrm import activitypub -from bookwyrm import models -from bookwyrm.connectors import get_data, ConnectorException -from bookwyrm.broadcast import broadcast - - -@csrf_exempt -@require_GET -def outbox(request, username): - ''' outbox for the requested user ''' - user = get_object_or_404(models.User, localname=username) - filter_type = request.GET.get('type') - if filter_type not in models.status_models: - filter_type = None - - return JsonResponse( - user.to_outbox(**request.GET, filter_type=filter_type), - encoder=activitypub.ActivityEncoder - ) - - -def handle_remote_webfinger(query): - ''' webfingerin' other servers ''' - user = None - - # usernames could be @user@domain or user@domain - if not query: - return None - - if query[0] == '@': - query = query[1:] - - try: - domain = query.split('@')[1] - except IndexError: - return None - - try: - user = models.User.objects.get(username=query) - except models.User.DoesNotExist: - url = 'https://%s/.well-known/webfinger?resource=acct:%s' % \ - (domain, query) - try: - data = get_data(url) - except (ConnectorException, HTTPError): - return None - - for link in data.get('links'): - if link.get('rel') == 'self': - try: - user = activitypub.resolve_remote_id( - models.User, link['href'] - ) - except KeyError: - return None - return user - - -def handle_follow(user, to_follow): - ''' someone local wants to follow someone ''' - relationship, _ = models.UserFollowRequest.objects.get_or_create( - user_subject=user, - user_object=to_follow, - ) - activity = relationship.to_activity() - broadcast(user, activity, privacy='direct', direct_recipients=[to_follow]) - - -def handle_unfollow(user, to_unfollow): - ''' someone local wants to follow someone ''' - relationship = models.UserFollows.objects.get( - user_subject=user, - user_object=to_unfollow - ) - activity = relationship.to_undo_activity(user) - broadcast(user, activity, privacy='direct', direct_recipients=[to_unfollow]) - to_unfollow.followers.remove(user) - - -def handle_accept(follow_request): - ''' send an acceptance message to a follow request ''' - user = follow_request.user_subject - to_follow = follow_request.user_object - with transaction.atomic(): - relationship = models.UserFollows.from_request(follow_request) - follow_request.delete() - relationship.save() - - activity = relationship.to_accept_activity() - broadcast(to_follow, activity, privacy='direct', direct_recipients=[user]) - - -def handle_reject(follow_request): - ''' a local user who managed follows rejects a follow request ''' - user = follow_request.user_subject - to_follow = follow_request.user_object - activity = follow_request.to_reject_activity() - follow_request.delete() - broadcast(to_follow, activity, privacy='direct', direct_recipients=[user]) - - -def handle_imported_book(user, item, include_reviews, privacy): - ''' process a goodreads csv and then post about it ''' - if isinstance(item.book, models.Work): - item.book = item.book.default_edition - if not item.book: - return - - existing_shelf = models.ShelfBook.objects.filter( - book=item.book, added_by=user).exists() - - # shelve the book if it hasn't been shelved already - if item.shelf and not existing_shelf: - desired_shelf = models.Shelf.objects.get( - identifier=item.shelf, - user=user - ) - shelf_book = models.ShelfBook.objects.create( - book=item.book, shelf=desired_shelf, added_by=user) - broadcast(user, shelf_book.to_add_activity(user), privacy=privacy) - - for read in item.reads: - # check for an existing readthrough with the same dates - if models.ReadThrough.objects.filter( - user=user, book=item.book, - start_date=read.start_date, - finish_date=read.finish_date - ).exists(): - continue - read.book = item.book - read.user = user - read.save() - - if include_reviews and (item.rating or item.review): - review_title = 'Review of {!r} on Goodreads'.format( - item.book.title, - ) if item.review else '' - - # we don't know the publication date of the review, - # but "now" is a bad guess - published_date_guess = item.date_read or item.date_added - review = models.Review.objects.create( - user=user, - book=item.book, - name=review_title, - content=item.review, - rating=item.rating, - published_date=published_date_guess, - privacy=privacy, - ) - # we don't need to send out pure activities because non-bookwyrm - # instances don't need this data - broadcast(user, review.to_create_activity(user), privacy=privacy) diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index c6ada37f..4ed16288 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -3,7 +3,7 @@ from django.conf.urls.static import static from django.contrib import admin from django.urls import path, re_path -from bookwyrm import incoming, outgoing, settings, views, wellknown +from bookwyrm import incoming, settings, views, wellknown from bookwyrm.utils import regex user_path = r'^user/(?P%s)' % regex.username @@ -30,7 +30,7 @@ urlpatterns = [ # federation endpoints re_path(r'^inbox/?$', incoming.shared_inbox), re_path(r'%s/inbox/?$' % local_user_path, incoming.inbox), - re_path(r'%s/outbox/?$' % local_user_path, outgoing.outbox), + re_path(r'%s/outbox/?$' % local_user_path, views.Outbox.as_view()), # .well-known endpoints re_path(r'^.well-known/webfinger/?$', wellknown.webfinger), diff --git a/bookwyrm/view_actions.py b/bookwyrm/view_actions.py deleted file mode 100644 index e69de29b..00000000 diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 7c050339..6351a87a 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -6,12 +6,13 @@ from .books import upload_cover, add_description, switch_edition, resolve_book from .direct_message import DirectMessage from .error import not_found_page, server_error_page from .follow import follow, unfollow -from .follow import accept_follow_request, delete_follow_request +from .follow import accept_follow_request, delete_follow_request, handle_accept from .import_data import Import, ImportStatus from .interaction import Favorite, Unfavorite, Boost, Unboost from .invite import ManageInvites, Invite from .landing import About, Home, Feed, Discover from .notifications import Notifications +from .outbox import Outbox from .reading import edit_readthrough, create_readthrough, delete_readthrough from .reading import start_reading, finish_reading from .password import PasswordResetRequest, PasswordReset, ChangePassword diff --git a/bookwyrm/views/follow.py b/bookwyrm/views/follow.py new file mode 100644 index 00000000..08b6cca3 --- /dev/null +++ b/bookwyrm/views/follow.py @@ -0,0 +1,113 @@ +''' views for actions you can take in the application ''' +from django.db import transaction +from django.contrib.auth.decorators import login_required +from django.http import HttpResponseBadRequest +from django.shortcuts import redirect +from django.views.decorators.http import require_POST + +from bookwyrm import models +from bookwyrm.broadcast import broadcast +from .helpers import get_user_from_username + +@login_required +@require_POST +def follow(request): + ''' follow another user, here or abroad ''' + username = request.POST['user'] + try: + to_follow = get_user_from_username(username) + except models.User.DoesNotExist: + return HttpResponseBadRequest() + + relationship, _ = models.UserFollowRequest.objects.get_or_create( + user_subject=request.user, + user_object=to_follow, + ) + activity = relationship.to_activity() + broadcast( + request.user, activity, privacy='direct', direct_recipients=[to_follow]) + return redirect(to_follow.local_path) + + +@login_required +@require_POST +def unfollow(request): + ''' unfollow a user ''' + username = request.POST['user'] + try: + to_unfollow = get_user_from_username(username) + except models.User.DoesNotExist: + return HttpResponseBadRequest() + + relationship = models.UserFollows.objects.get( + user_subject=request.user, + user_object=to_unfollow + ) + activity = relationship.to_undo_activity(request.user) + broadcast( + request.user, activity, + privacy='direct', direct_recipients=[to_unfollow]) + + to_unfollow.followers.remove(request.user) + return redirect(to_unfollow.local_path) + + +@login_required +@require_POST +def accept_follow_request(request): + ''' a user accepts a follow request ''' + username = request.POST['user'] + try: + requester = get_user_from_username(username) + except models.User.DoesNotExist: + return HttpResponseBadRequest() + + try: + follow_request = models.UserFollowRequest.objects.get( + user_subject=requester, + user_object=request.user + ) + except models.UserFollowRequest.DoesNotExist: + # Request already dealt with. + return redirect(request.user.local_path) + handle_accept(follow_request) + + return redirect(request.user.local_path) + + +def handle_accept(follow_request): + ''' send an acceptance message to a follow request ''' + user = follow_request.user_subject + to_follow = follow_request.user_object + with transaction.atomic(): + relationship = models.UserFollows.from_request(follow_request) + follow_request.delete() + relationship.save() + + activity = relationship.to_accept_activity() + broadcast(to_follow, activity, privacy='direct', direct_recipients=[user]) + + +@login_required +@require_POST +def delete_follow_request(request): + ''' a user rejects a follow request ''' + username = request.POST['user'] + try: + requester = get_user_from_username(username) + except models.User.DoesNotExist: + return HttpResponseBadRequest() + + try: + follow_request = models.UserFollowRequest.objects.get( + user_subject=requester, + user_object=request.user + ) + except models.UserFollowRequest.DoesNotExist: + return HttpResponseBadRequest() + + activity = follow_request.to_reject_activity() + follow_request.delete() + broadcast( + request.user, activity, privacy='direct', direct_recipients=[requester]) + return redirect('/user/%s' % request.user.localname) diff --git a/bookwyrm/views/outbox.py b/bookwyrm/views/outbox.py new file mode 100644 index 00000000..8bfc3b3d --- /dev/null +++ b/bookwyrm/views/outbox.py @@ -0,0 +1,22 @@ +''' the good stuff! the books! ''' +from django.http import JsonResponse +from django.shortcuts import get_object_or_404 +from django.views import View + +from bookwyrm import activitypub, models + + +# pylint: disable= no-self-use +class Outbox(View): + ''' outbox ''' + def get(self, request, username): + ''' outbox for the requested user ''' + user = get_object_or_404(models.User, localname=username) + filter_type = request.GET.get('type') + if filter_type not in models.status_models: + filter_type = None + + return JsonResponse( + user.to_outbox(**request.GET, filter_type=filter_type), + encoder=activitypub.ActivityEncoder + ) From e32a31e0208406d306efbe802c9a82c3fa7e2d01 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 13:54:01 -0800 Subject: [PATCH 28/34] Fixes tests --- bookwyrm/tests/test_goodreads_import.py | 135 +++++++++- bookwyrm/tests/test_outgoing.py | 324 ------------------------ bookwyrm/tests/views/test_helpers.py | 93 +++++++ bookwyrm/tests/views/test_outbox.py | 88 +++++++ 4 files changed, 315 insertions(+), 325 deletions(-) delete mode 100644 bookwyrm/tests/test_outgoing.py create mode 100644 bookwyrm/tests/views/test_outbox.py diff --git a/bookwyrm/tests/test_goodreads_import.py b/bookwyrm/tests/test_goodreads_import.py index 2518ab7b..2405a790 100644 --- a/bookwyrm/tests/test_goodreads_import.py +++ b/bookwyrm/tests/test_goodreads_import.py @@ -1,5 +1,6 @@ ''' testing import ''' from collections import namedtuple +import csv import pathlib from unittest.mock import patch @@ -97,8 +98,140 @@ class GoodreadsImport(TestCase): 'bookwyrm.models.import_job.ImportItem.get_book_from_isbn' ) as resolve: resolve.return_value = book - with patch('bookwyrm.outgoing.handle_imported_book'): + with patch('bookwyrm.goodreads_import.handle_imported_book'): goodreads_import.import_data(import_job.id) import_item = models.ImportItem.objects.get(job=import_job, index=0) self.assertEqual(import_item.book.id, book.id) + + + def test_handle_imported_book(self): + ''' goodreads import added a book, this adds related connections ''' + shelf = self.local_user.shelf_set.filter(identifier='read').first() + self.assertIsNone(shelf.books.first()) + + import_job = models.ImportJob.objects.create(user=self.local_user) + datafile = pathlib.Path(__file__).parent.joinpath('data/goodreads.csv') + csv_file = open(datafile, 'r') + for index, entry in enumerate(list(csv.DictReader(csv_file))): + import_item = models.ImportItem.objects.create( + job_id=import_job.id, index=index, data=entry, book=self.book) + break + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + goodreads_import.handle_imported_book( + self.local_user, import_item, False, 'public') + + shelf.refresh_from_db() + self.assertEqual(shelf.books.first(), self.book) + + readthrough = models.ReadThrough.objects.get(user=self.local_user) + self.assertEqual(readthrough.book, self.book) + # I can't remember how to create dates and I don't want to look it up. + self.assertEqual(readthrough.start_date.year, 2020) + self.assertEqual(readthrough.start_date.month, 10) + self.assertEqual(readthrough.start_date.day, 21) + self.assertEqual(readthrough.finish_date.year, 2020) + self.assertEqual(readthrough.finish_date.month, 10) + self.assertEqual(readthrough.finish_date.day, 25) + + + def test_handle_imported_book_already_shelved(self): + ''' goodreads import added a book, this adds related connections ''' + shelf = self.local_user.shelf_set.filter(identifier='to-read').first() + models.ShelfBook.objects.create( + shelf=shelf, added_by=self.local_user, book=self.book) + + import_job = models.ImportJob.objects.create(user=self.local_user) + datafile = pathlib.Path(__file__).parent.joinpath('data/goodreads.csv') + csv_file = open(datafile, 'r') + for index, entry in enumerate(list(csv.DictReader(csv_file))): + import_item = models.ImportItem.objects.create( + job_id=import_job.id, index=index, data=entry, book=self.book) + break + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + goodreads_import.handle_imported_book( + self.local_user, import_item, False, 'public') + + shelf.refresh_from_db() + self.assertEqual(shelf.books.first(), self.book) + self.assertIsNone( + self.local_user.shelf_set.get(identifier='read').books.first()) + readthrough = models.ReadThrough.objects.get(user=self.local_user) + self.assertEqual(readthrough.book, self.book) + self.assertEqual(readthrough.start_date.year, 2020) + self.assertEqual(readthrough.start_date.month, 10) + self.assertEqual(readthrough.start_date.day, 21) + self.assertEqual(readthrough.finish_date.year, 2020) + self.assertEqual(readthrough.finish_date.month, 10) + self.assertEqual(readthrough.finish_date.day, 25) + + + def test_handle_import_twice(self): + ''' re-importing books ''' + shelf = self.local_user.shelf_set.filter(identifier='read').first() + import_job = models.ImportJob.objects.create(user=self.local_user) + datafile = pathlib.Path(__file__).parent.joinpath('data/goodreads.csv') + csv_file = open(datafile, 'r') + for index, entry in enumerate(list(csv.DictReader(csv_file))): + import_item = models.ImportItem.objects.create( + job_id=import_job.id, index=index, data=entry, book=self.book) + break + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + goodreads_import.handle_imported_book( + self.local_user, import_item, False, 'public') + goodreads_import.handle_imported_book( + self.local_user, import_item, False, 'public') + + shelf.refresh_from_db() + self.assertEqual(shelf.books.first(), self.book) + + readthrough = models.ReadThrough.objects.get(user=self.local_user) + self.assertEqual(readthrough.book, self.book) + # I can't remember how to create dates and I don't want to look it up. + self.assertEqual(readthrough.start_date.year, 2020) + self.assertEqual(readthrough.start_date.month, 10) + self.assertEqual(readthrough.start_date.day, 21) + self.assertEqual(readthrough.finish_date.year, 2020) + self.assertEqual(readthrough.finish_date.month, 10) + self.assertEqual(readthrough.finish_date.day, 25) + + + def test_handle_imported_book_review(self): + ''' goodreads review import ''' + import_job = models.ImportJob.objects.create(user=self.local_user) + datafile = pathlib.Path(__file__).parent.joinpath('data/goodreads.csv') + csv_file = open(datafile, 'r') + entry = list(csv.DictReader(csv_file))[2] + import_item = models.ImportItem.objects.create( + job_id=import_job.id, index=0, data=entry, book=self.book) + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + goodreads_import.handle_imported_book( + self.local_user, import_item, True, 'unlisted') + review = models.Review.objects.get(book=self.book, user=self.local_user) + self.assertEqual(review.content, 'mixed feelings') + self.assertEqual(review.rating, 2) + self.assertEqual(review.published_date.year, 2019) + self.assertEqual(review.published_date.month, 7) + self.assertEqual(review.published_date.day, 8) + self.assertEqual(review.privacy, 'unlisted') + + + def test_handle_imported_book_reviews_disabled(self): + ''' goodreads review import ''' + import_job = models.ImportJob.objects.create(user=self.local_user) + datafile = pathlib.Path(__file__).parent.joinpath('data/goodreads.csv') + csv_file = open(datafile, 'r') + entry = list(csv.DictReader(csv_file))[2] + import_item = models.ImportItem.objects.create( + job_id=import_job.id, index=0, data=entry, book=self.book) + + with patch('bookwyrm.broadcast.broadcast_task.delay'): + goodreads_import.handle_imported_book( + self.local_user, import_item, False, 'unlisted') + self.assertFalse(models.Review.objects.filter( + book=self.book, user=self.local_user + ).exists()) diff --git a/bookwyrm/tests/test_outgoing.py b/bookwyrm/tests/test_outgoing.py deleted file mode 100644 index 6cd84070..00000000 --- a/bookwyrm/tests/test_outgoing.py +++ /dev/null @@ -1,324 +0,0 @@ -''' sending out activities ''' -import csv -import json -import pathlib -from unittest.mock import patch - -from django.http import JsonResponse -from django.test import TestCase -from django.test.client import RequestFactory -import responses - -from bookwyrm import models, outgoing - - -# pylint: disable=too-many-public-methods -class Outgoing(TestCase): - ''' sends out activities ''' - def setUp(self): - ''' we'll need some data ''' - self.factory = RequestFactory() - with patch('bookwyrm.models.user.set_remote_server'): - self.remote_user = models.User.objects.create_user( - 'rat', 'rat@email.com', 'ratword', - local=False, - remote_id='https://example.com/users/rat', - inbox='https://example.com/users/rat/inbox', - outbox='https://example.com/users/rat/outbox', - ) - self.local_user = models.User.objects.create_user( - 'mouse@local.com', 'mouse@mouse.com', 'mouseword', - local=True, localname='mouse', - remote_id='https://example.com/users/mouse', - ) - - datafile = pathlib.Path(__file__).parent.joinpath( - 'data/ap_user.json' - ) - self.userdata = json.loads(datafile.read_bytes()) - del self.userdata['icon'] - - work = models.Work.objects.create(title='Test Work') - self.book = models.Edition.objects.create( - title='Example Edition', - remote_id='https://example.com/book/1', - parent_work=work - ) - self.shelf = models.Shelf.objects.create( - name='Test Shelf', - identifier='test-shelf', - user=self.local_user - ) - - - def test_outbox(self): - ''' returns user's statuses ''' - request = self.factory.get('') - result = outgoing.outbox(request, 'mouse') - self.assertIsInstance(result, JsonResponse) - - def test_outbox_bad_method(self): - ''' can't POST to outbox ''' - request = self.factory.post('') - result = outgoing.outbox(request, 'mouse') - self.assertEqual(result.status_code, 405) - - def test_outbox_unknown_user(self): - ''' should 404 for unknown and remote users ''' - request = self.factory.post('') - result = outgoing.outbox(request, 'beepboop') - self.assertEqual(result.status_code, 405) - result = outgoing.outbox(request, 'rat') - self.assertEqual(result.status_code, 405) - - def test_outbox_privacy(self): - ''' don't show dms et cetera in outbox ''' - models.Status.objects.create( - content='PRIVATE!!', user=self.local_user, privacy='direct') - models.Status.objects.create( - content='bffs ONLY', user=self.local_user, privacy='followers') - models.Status.objects.create( - content='unlisted status', user=self.local_user, privacy='unlisted') - models.Status.objects.create( - content='look at this', user=self.local_user, privacy='public') - - request = self.factory.get('') - result = outgoing.outbox(request, 'mouse') - self.assertIsInstance(result, JsonResponse) - data = json.loads(result.content) - self.assertEqual(data['type'], 'OrderedCollection') - self.assertEqual(data['totalItems'], 2) - - def test_outbox_filter(self): - ''' if we only care about reviews, only get reviews ''' - models.Review.objects.create( - content='look at this', name='hi', rating=1, - book=self.book, user=self.local_user) - models.Status.objects.create( - content='look at this', user=self.local_user) - - request = self.factory.get('', {'type': 'bleh'}) - result = outgoing.outbox(request, 'mouse') - self.assertIsInstance(result, JsonResponse) - data = json.loads(result.content) - self.assertEqual(data['type'], 'OrderedCollection') - self.assertEqual(data['totalItems'], 2) - - request = self.factory.get('', {'type': 'Review'}) - result = outgoing.outbox(request, 'mouse') - self.assertIsInstance(result, JsonResponse) - data = json.loads(result.content) - self.assertEqual(data['type'], 'OrderedCollection') - self.assertEqual(data['totalItems'], 1) - - - - def test_existing_user(self): - ''' simple database lookup by username ''' - result = outgoing.handle_remote_webfinger('@mouse@local.com') - self.assertEqual(result, self.local_user) - - result = outgoing.handle_remote_webfinger('mouse@local.com') - self.assertEqual(result, self.local_user) - - - @responses.activate - def test_load_user(self): - ''' find a remote user using webfinger ''' - username = 'mouse@example.com' - wellknown = { - "subject": "acct:mouse@example.com", - "links": [{ - "rel": "self", - "type": "application/activity+json", - "href": "https://example.com/user/mouse" - }] - } - responses.add( - responses.GET, - 'https://example.com/.well-known/webfinger?resource=acct:%s' \ - % username, - json=wellknown, - status=200) - responses.add( - responses.GET, - 'https://example.com/user/mouse', - json=self.userdata, - status=200) - with patch('bookwyrm.models.user.set_remote_server.delay'): - result = outgoing.handle_remote_webfinger('@mouse@example.com') - self.assertIsInstance(result, models.User) - self.assertEqual(result.username, 'mouse@example.com') - - - def test_handle_reading_status_to_read(self): - ''' posts shelve activities ''' - shelf = self.local_user.shelf_set.get(identifier='to-read') - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_reading_status( - self.local_user, shelf, self.book, 'public') - status = models.GeneratedNote.objects.get() - self.assertEqual(status.user, self.local_user) - self.assertEqual(status.mention_books.first(), self.book) - self.assertEqual(status.content, 'wants to read') - - def test_handle_reading_status_reading(self): - ''' posts shelve activities ''' - shelf = self.local_user.shelf_set.get(identifier='reading') - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_reading_status( - self.local_user, shelf, self.book, 'public') - status = models.GeneratedNote.objects.get() - self.assertEqual(status.user, self.local_user) - self.assertEqual(status.mention_books.first(), self.book) - self.assertEqual(status.content, 'started reading') - - def test_handle_reading_status_read(self): - ''' posts shelve activities ''' - shelf = self.local_user.shelf_set.get(identifier='read') - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_reading_status( - self.local_user, shelf, self.book, 'public') - status = models.GeneratedNote.objects.get() - self.assertEqual(status.user, self.local_user) - self.assertEqual(status.mention_books.first(), self.book) - self.assertEqual(status.content, 'finished reading') - - def test_handle_reading_status_other(self): - ''' posts shelve activities ''' - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_reading_status( - self.local_user, self.shelf, self.book, 'public') - self.assertFalse(models.GeneratedNote.objects.exists()) - - - def test_handle_imported_book(self): - ''' goodreads import added a book, this adds related connections ''' - shelf = self.local_user.shelf_set.filter(identifier='read').first() - self.assertIsNone(shelf.books.first()) - - import_job = models.ImportJob.objects.create(user=self.local_user) - datafile = pathlib.Path(__file__).parent.joinpath('data/goodreads.csv') - csv_file = open(datafile, 'r') - for index, entry in enumerate(list(csv.DictReader(csv_file))): - import_item = models.ImportItem.objects.create( - job_id=import_job.id, index=index, data=entry, book=self.book) - break - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_imported_book( - self.local_user, import_item, False, 'public') - - shelf.refresh_from_db() - self.assertEqual(shelf.books.first(), self.book) - - readthrough = models.ReadThrough.objects.get(user=self.local_user) - self.assertEqual(readthrough.book, self.book) - # I can't remember how to create dates and I don't want to look it up. - self.assertEqual(readthrough.start_date.year, 2020) - self.assertEqual(readthrough.start_date.month, 10) - self.assertEqual(readthrough.start_date.day, 21) - self.assertEqual(readthrough.finish_date.year, 2020) - self.assertEqual(readthrough.finish_date.month, 10) - self.assertEqual(readthrough.finish_date.day, 25) - - - def test_handle_imported_book_already_shelved(self): - ''' goodreads import added a book, this adds related connections ''' - shelf = self.local_user.shelf_set.filter(identifier='to-read').first() - models.ShelfBook.objects.create( - shelf=shelf, added_by=self.local_user, book=self.book) - - import_job = models.ImportJob.objects.create(user=self.local_user) - datafile = pathlib.Path(__file__).parent.joinpath('data/goodreads.csv') - csv_file = open(datafile, 'r') - for index, entry in enumerate(list(csv.DictReader(csv_file))): - import_item = models.ImportItem.objects.create( - job_id=import_job.id, index=index, data=entry, book=self.book) - break - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_imported_book( - self.local_user, import_item, False, 'public') - - shelf.refresh_from_db() - self.assertEqual(shelf.books.first(), self.book) - self.assertIsNone( - self.local_user.shelf_set.get(identifier='read').books.first()) - readthrough = models.ReadThrough.objects.get(user=self.local_user) - self.assertEqual(readthrough.book, self.book) - self.assertEqual(readthrough.start_date.year, 2020) - self.assertEqual(readthrough.start_date.month, 10) - self.assertEqual(readthrough.start_date.day, 21) - self.assertEqual(readthrough.finish_date.year, 2020) - self.assertEqual(readthrough.finish_date.month, 10) - self.assertEqual(readthrough.finish_date.day, 25) - - - def test_handle_import_twice(self): - ''' re-importing books ''' - shelf = self.local_user.shelf_set.filter(identifier='read').first() - import_job = models.ImportJob.objects.create(user=self.local_user) - datafile = pathlib.Path(__file__).parent.joinpath('data/goodreads.csv') - csv_file = open(datafile, 'r') - for index, entry in enumerate(list(csv.DictReader(csv_file))): - import_item = models.ImportItem.objects.create( - job_id=import_job.id, index=index, data=entry, book=self.book) - break - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_imported_book( - self.local_user, import_item, False, 'public') - outgoing.handle_imported_book( - self.local_user, import_item, False, 'public') - - shelf.refresh_from_db() - self.assertEqual(shelf.books.first(), self.book) - - readthrough = models.ReadThrough.objects.get(user=self.local_user) - self.assertEqual(readthrough.book, self.book) - # I can't remember how to create dates and I don't want to look it up. - self.assertEqual(readthrough.start_date.year, 2020) - self.assertEqual(readthrough.start_date.month, 10) - self.assertEqual(readthrough.start_date.day, 21) - self.assertEqual(readthrough.finish_date.year, 2020) - self.assertEqual(readthrough.finish_date.month, 10) - self.assertEqual(readthrough.finish_date.day, 25) - - - def test_handle_imported_book_review(self): - ''' goodreads review import ''' - import_job = models.ImportJob.objects.create(user=self.local_user) - datafile = pathlib.Path(__file__).parent.joinpath('data/goodreads.csv') - csv_file = open(datafile, 'r') - entry = list(csv.DictReader(csv_file))[2] - import_item = models.ImportItem.objects.create( - job_id=import_job.id, index=0, data=entry, book=self.book) - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_imported_book( - self.local_user, import_item, True, 'unlisted') - review = models.Review.objects.get(book=self.book, user=self.local_user) - self.assertEqual(review.content, 'mixed feelings') - self.assertEqual(review.rating, 2) - self.assertEqual(review.published_date.year, 2019) - self.assertEqual(review.published_date.month, 7) - self.assertEqual(review.published_date.day, 8) - self.assertEqual(review.privacy, 'unlisted') - - - def test_handle_imported_book_reviews_disabled(self): - ''' goodreads review import ''' - import_job = models.ImportJob.objects.create(user=self.local_user) - datafile = pathlib.Path(__file__).parent.joinpath('data/goodreads.csv') - csv_file = open(datafile, 'r') - entry = list(csv.DictReader(csv_file))[2] - import_item = models.ImportItem.objects.create( - job_id=import_job.id, index=0, data=entry, book=self.book) - - with patch('bookwyrm.broadcast.broadcast_task.delay'): - outgoing.handle_imported_book( - self.local_user, import_item, False, 'unlisted') - self.assertFalse(models.Review.objects.filter( - book=self.book, user=self.local_user - ).exists()) diff --git a/bookwyrm/tests/views/test_helpers.py b/bookwyrm/tests/views/test_helpers.py index 66973a31..bd892896 100644 --- a/bookwyrm/tests/views/test_helpers.py +++ b/bookwyrm/tests/views/test_helpers.py @@ -1,7 +1,10 @@ ''' test for app action functionality ''' +import json from unittest.mock import patch +import pathlib from django.test import TestCase from django.test.client import RequestFactory +import responses from bookwyrm import models, views from bookwyrm.settings import USER_AGENT @@ -30,6 +33,17 @@ class ViewsHelpers(TestCase): inbox='https://example.com/users/rat/inbox', outbox='https://example.com/users/rat/outbox', ) + datafile = pathlib.Path(__file__).parent.joinpath( + '../data/ap_user.json' + ) + self.userdata = json.loads(datafile.read_bytes()) + del self.userdata['icon'] + self.shelf = models.Shelf.objects.create( + name='Test Shelf', + identifier='test-shelf', + user=self.local_user + ) + def test_get_edition(self): ''' given an edition or a work, returns an edition ''' @@ -155,3 +169,82 @@ class ViewsHelpers(TestCase): request = self.factory.get( '', {'q': 'Test Book'}, HTTP_USER_AGENT=USER_AGENT) self.assertTrue(views.helpers.is_bookworm_request(request)) + + + def test_existing_user(self): + ''' simple database lookup by username ''' + result = views.helpers.handle_remote_webfinger('@mouse@local.com') + self.assertEqual(result, self.local_user) + + result = views.helpers.handle_remote_webfinger('mouse@local.com') + self.assertEqual(result, self.local_user) + + + @responses.activate + def test_load_user(self): + ''' find a remote user using webfinger ''' + username = 'mouse@example.com' + wellknown = { + "subject": "acct:mouse@example.com", + "links": [{ + "rel": "self", + "type": "application/activity+json", + "href": "https://example.com/user/mouse" + }] + } + responses.add( + responses.GET, + 'https://example.com/.well-known/webfinger?resource=acct:%s' \ + % username, + json=wellknown, + status=200) + responses.add( + responses.GET, + 'https://example.com/user/mouse', + json=self.userdata, + status=200) + with patch('bookwyrm.models.user.set_remote_server.delay'): + result = views.helpers.handle_remote_webfinger('@mouse@example.com') + self.assertIsInstance(result, models.User) + self.assertEqual(result.username, 'mouse@example.com') + + + def test_handle_reading_status_to_read(self): + ''' posts shelve activities ''' + shelf = self.local_user.shelf_set.get(identifier='to-read') + with patch('bookwyrm.broadcast.broadcast_task.delay'): + views.helpers.handle_reading_status( + self.local_user, shelf, self.book, 'public') + status = models.GeneratedNote.objects.get() + self.assertEqual(status.user, self.local_user) + self.assertEqual(status.mention_books.first(), self.book) + self.assertEqual(status.content, 'wants to read') + + def test_handle_reading_status_reading(self): + ''' posts shelve activities ''' + shelf = self.local_user.shelf_set.get(identifier='reading') + with patch('bookwyrm.broadcast.broadcast_task.delay'): + views.helpers.handle_reading_status( + self.local_user, shelf, self.book, 'public') + status = models.GeneratedNote.objects.get() + self.assertEqual(status.user, self.local_user) + self.assertEqual(status.mention_books.first(), self.book) + self.assertEqual(status.content, 'started reading') + + def test_handle_reading_status_read(self): + ''' posts shelve activities ''' + shelf = self.local_user.shelf_set.get(identifier='read') + with patch('bookwyrm.broadcast.broadcast_task.delay'): + views.helpers.handle_reading_status( + self.local_user, shelf, self.book, 'public') + status = models.GeneratedNote.objects.get() + self.assertEqual(status.user, self.local_user) + self.assertEqual(status.mention_books.first(), self.book) + self.assertEqual(status.content, 'finished reading') + + def test_handle_reading_status_other(self): + ''' posts shelve activities ''' + with patch('bookwyrm.broadcast.broadcast_task.delay'): + views.helpers.handle_reading_status( + self.local_user, self.shelf, self.book, 'public') + self.assertFalse(models.GeneratedNote.objects.exists()) diff --git a/bookwyrm/tests/views/test_outbox.py b/bookwyrm/tests/views/test_outbox.py new file mode 100644 index 00000000..4b47d7ac --- /dev/null +++ b/bookwyrm/tests/views/test_outbox.py @@ -0,0 +1,88 @@ +''' sending out activities ''' +import json + +from django.http import JsonResponse +from django.test import TestCase +from django.test.client import RequestFactory + +from bookwyrm import models, views + + +# pylint: disable=too-many-public-methods +class OutboxView(TestCase): + ''' sends out activities ''' + def setUp(self): + ''' we'll need some data ''' + self.factory = RequestFactory() + self.local_user = models.User.objects.create_user( + 'mouse@local.com', 'mouse@mouse.com', 'mouseword', + local=True, localname='mouse', + remote_id='https://example.com/users/mouse', + ) + work = models.Work.objects.create(title='Test Work') + self.book = models.Edition.objects.create( + title='Example Edition', + remote_id='https://example.com/book/1', + parent_work=work + ) + + + def test_outbox(self): + ''' returns user's statuses ''' + request = self.factory.get('') + result = views.Outbox.as_view()(request, 'mouse') + self.assertIsInstance(result, JsonResponse) + + def test_outbox_bad_method(self): + ''' can't POST to outbox ''' + request = self.factory.post('') + result = views.Outbox.as_view()(request, 'mouse') + self.assertEqual(result.status_code, 405) + + def test_outbox_unknown_user(self): + ''' should 404 for unknown and remote users ''' + request = self.factory.post('') + result = views.Outbox.as_view()(request, 'beepboop') + self.assertEqual(result.status_code, 405) + result = views.Outbox.as_view()(request, 'rat') + self.assertEqual(result.status_code, 405) + + def test_outbox_privacy(self): + ''' don't show dms et cetera in outbox ''' + models.Status.objects.create( + content='PRIVATE!!', user=self.local_user, privacy='direct') + models.Status.objects.create( + content='bffs ONLY', user=self.local_user, privacy='followers') + models.Status.objects.create( + content='unlisted status', user=self.local_user, privacy='unlisted') + models.Status.objects.create( + content='look at this', user=self.local_user, privacy='public') + + request = self.factory.get('') + result = views.Outbox.as_view()(request, 'mouse') + self.assertIsInstance(result, JsonResponse) + data = json.loads(result.content) + self.assertEqual(data['type'], 'OrderedCollection') + self.assertEqual(data['totalItems'], 2) + + def test_outbox_filter(self): + ''' if we only care about reviews, only get reviews ''' + models.Review.objects.create( + content='look at this', name='hi', rating=1, + book=self.book, user=self.local_user) + models.Status.objects.create( + content='look at this', user=self.local_user) + + request = self.factory.get('', {'type': 'bleh'}) + result = views.Outbox.as_view()(request, 'mouse') + self.assertIsInstance(result, JsonResponse) + data = json.loads(result.content) + self.assertEqual(data['type'], 'OrderedCollection') + self.assertEqual(data['totalItems'], 2) + + request = self.factory.get('', {'type': 'Review'}) + result = views.Outbox.as_view()(request, 'mouse') + self.assertIsInstance(result, JsonResponse) + data = json.loads(result.content) + self.assertEqual(data['type'], 'OrderedCollection') + self.assertEqual(data['totalItems'], 1) From 90933fa81de391dde7b8e201edc554cff26375a2 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 14:02:01 -0800 Subject: [PATCH 29/34] Fixes goodreads import tests --- bookwyrm/tests/test_goodreads_import.py | 48 ++++++++++++++----------- 1 file changed, 27 insertions(+), 21 deletions(-) diff --git a/bookwyrm/tests/test_goodreads_import.py b/bookwyrm/tests/test_goodreads_import.py index 2405a790..9519aab1 100644 --- a/bookwyrm/tests/test_goodreads_import.py +++ b/bookwyrm/tests/test_goodreads_import.py @@ -31,6 +31,12 @@ class GoodreadsImport(TestCase): search_url='https://%s/search?q=' % DOMAIN, priority=1, ) + work = models.Work.objects.create(title='Test Work') + self.book = models.Edition.objects.create( + title='Example Edition', + remote_id='https://example.com/book/1', + parent_work=work + ) def test_create_job(self): @@ -107,10 +113,10 @@ class GoodreadsImport(TestCase): def test_handle_imported_book(self): ''' goodreads import added a book, this adds related connections ''' - shelf = self.local_user.shelf_set.filter(identifier='read').first() + shelf = self.user.shelf_set.filter(identifier='read').first() self.assertIsNone(shelf.books.first()) - import_job = models.ImportJob.objects.create(user=self.local_user) + import_job = models.ImportJob.objects.create(user=self.user) datafile = pathlib.Path(__file__).parent.joinpath('data/goodreads.csv') csv_file = open(datafile, 'r') for index, entry in enumerate(list(csv.DictReader(csv_file))): @@ -120,12 +126,12 @@ class GoodreadsImport(TestCase): with patch('bookwyrm.broadcast.broadcast_task.delay'): goodreads_import.handle_imported_book( - self.local_user, import_item, False, 'public') + self.user, import_item, False, 'public') shelf.refresh_from_db() self.assertEqual(shelf.books.first(), self.book) - readthrough = models.ReadThrough.objects.get(user=self.local_user) + readthrough = models.ReadThrough.objects.get(user=self.user) self.assertEqual(readthrough.book, self.book) # I can't remember how to create dates and I don't want to look it up. self.assertEqual(readthrough.start_date.year, 2020) @@ -138,11 +144,11 @@ class GoodreadsImport(TestCase): def test_handle_imported_book_already_shelved(self): ''' goodreads import added a book, this adds related connections ''' - shelf = self.local_user.shelf_set.filter(identifier='to-read').first() + shelf = self.user.shelf_set.filter(identifier='to-read').first() models.ShelfBook.objects.create( - shelf=shelf, added_by=self.local_user, book=self.book) + shelf=shelf, added_by=self.user, book=self.book) - import_job = models.ImportJob.objects.create(user=self.local_user) + import_job = models.ImportJob.objects.create(user=self.user) datafile = pathlib.Path(__file__).parent.joinpath('data/goodreads.csv') csv_file = open(datafile, 'r') for index, entry in enumerate(list(csv.DictReader(csv_file))): @@ -152,13 +158,13 @@ class GoodreadsImport(TestCase): with patch('bookwyrm.broadcast.broadcast_task.delay'): goodreads_import.handle_imported_book( - self.local_user, import_item, False, 'public') + self.user, import_item, False, 'public') shelf.refresh_from_db() self.assertEqual(shelf.books.first(), self.book) self.assertIsNone( - self.local_user.shelf_set.get(identifier='read').books.first()) - readthrough = models.ReadThrough.objects.get(user=self.local_user) + self.user.shelf_set.get(identifier='read').books.first()) + readthrough = models.ReadThrough.objects.get(user=self.user) self.assertEqual(readthrough.book, self.book) self.assertEqual(readthrough.start_date.year, 2020) self.assertEqual(readthrough.start_date.month, 10) @@ -170,8 +176,8 @@ class GoodreadsImport(TestCase): def test_handle_import_twice(self): ''' re-importing books ''' - shelf = self.local_user.shelf_set.filter(identifier='read').first() - import_job = models.ImportJob.objects.create(user=self.local_user) + shelf = self.user.shelf_set.filter(identifier='read').first() + import_job = models.ImportJob.objects.create(user=self.user) datafile = pathlib.Path(__file__).parent.joinpath('data/goodreads.csv') csv_file = open(datafile, 'r') for index, entry in enumerate(list(csv.DictReader(csv_file))): @@ -181,14 +187,14 @@ class GoodreadsImport(TestCase): with patch('bookwyrm.broadcast.broadcast_task.delay'): goodreads_import.handle_imported_book( - self.local_user, import_item, False, 'public') + self.user, import_item, False, 'public') goodreads_import.handle_imported_book( - self.local_user, import_item, False, 'public') + self.user, import_item, False, 'public') shelf.refresh_from_db() self.assertEqual(shelf.books.first(), self.book) - readthrough = models.ReadThrough.objects.get(user=self.local_user) + readthrough = models.ReadThrough.objects.get(user=self.user) self.assertEqual(readthrough.book, self.book) # I can't remember how to create dates and I don't want to look it up. self.assertEqual(readthrough.start_date.year, 2020) @@ -201,7 +207,7 @@ class GoodreadsImport(TestCase): def test_handle_imported_book_review(self): ''' goodreads review import ''' - import_job = models.ImportJob.objects.create(user=self.local_user) + import_job = models.ImportJob.objects.create(user=self.user) datafile = pathlib.Path(__file__).parent.joinpath('data/goodreads.csv') csv_file = open(datafile, 'r') entry = list(csv.DictReader(csv_file))[2] @@ -210,8 +216,8 @@ class GoodreadsImport(TestCase): with patch('bookwyrm.broadcast.broadcast_task.delay'): goodreads_import.handle_imported_book( - self.local_user, import_item, True, 'unlisted') - review = models.Review.objects.get(book=self.book, user=self.local_user) + self.user, import_item, True, 'unlisted') + review = models.Review.objects.get(book=self.book, user=self.user) self.assertEqual(review.content, 'mixed feelings') self.assertEqual(review.rating, 2) self.assertEqual(review.published_date.year, 2019) @@ -222,7 +228,7 @@ class GoodreadsImport(TestCase): def test_handle_imported_book_reviews_disabled(self): ''' goodreads review import ''' - import_job = models.ImportJob.objects.create(user=self.local_user) + import_job = models.ImportJob.objects.create(user=self.user) datafile = pathlib.Path(__file__).parent.joinpath('data/goodreads.csv') csv_file = open(datafile, 'r') entry = list(csv.DictReader(csv_file))[2] @@ -231,7 +237,7 @@ class GoodreadsImport(TestCase): with patch('bookwyrm.broadcast.broadcast_task.delay'): goodreads_import.handle_imported_book( - self.local_user, import_item, False, 'unlisted') + self.user, import_item, False, 'unlisted') self.assertFalse(models.Review.objects.filter( - book=self.book, user=self.local_user + book=self.book, user=self.user ).exists()) From 3eceb1e2b8122152501ae770df71e486f5170434 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 14:31:52 -0800 Subject: [PATCH 30/34] Fixes interaction tests --- bookwyrm/tests/views/test_interaction.py | 28 ++++++++++++------------ 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/bookwyrm/tests/views/test_interaction.py b/bookwyrm/tests/views/test_interaction.py index c77d6f28..da1fa90d 100644 --- a/bookwyrm/tests/views/test_interaction.py +++ b/bookwyrm/tests/views/test_interaction.py @@ -37,12 +37,12 @@ class InteractionViews(TestCase): ''' create and broadcast faving a status ''' view = views.Favorite.as_view() request = self.factory.post('') - request.user = self.local_user + request.user = self.remote_user status = models.Status.objects.create( user=self.local_user, content='hi') with patch('bookwyrm.broadcast.broadcast_task.delay'): - view(request, status) + view(request, status.id) fav = models.Favorite.objects.get() self.assertEqual(fav.status, status) self.assertEqual(fav.user, self.remote_user) @@ -57,17 +57,17 @@ class InteractionViews(TestCase): ''' unfav a status ''' view = views.Unfavorite.as_view() request = self.factory.post('') - request.user = self.local_user + request.user = self.remote_user status = models.Status.objects.create( user=self.local_user, content='hi') with patch('bookwyrm.broadcast.broadcast_task.delay'): - view(request, status) + views.Favorite.as_view()(request, status.id) self.assertEqual(models.Favorite.objects.count(), 1) self.assertEqual(models.Notification.objects.count(), 1) with patch('bookwyrm.broadcast.broadcast_task.delay'): - view(request, status) + view(request, status.id) self.assertEqual(models.Favorite.objects.count(), 0) self.assertEqual(models.Notification.objects.count(), 0) @@ -76,12 +76,12 @@ class InteractionViews(TestCase): ''' boost a status ''' view = views.Boost.as_view() request = self.factory.post('') - request.user = self.local_user + request.user = self.remote_user status = models.Status.objects.create( user=self.local_user, content='hi') with patch('bookwyrm.broadcast.broadcast_task.delay'): - view(request, status) + view(request, status.id) boost = models.Boost.objects.get() self.assertEqual(boost.boosted_status, status) @@ -103,7 +103,7 @@ class InteractionViews(TestCase): user=self.local_user, content='hi', privacy='unlisted') with patch('bookwyrm.broadcast.broadcast_task.delay'): - view(request, status) + view(request, status.id) boost = models.Boost.objects.get() self.assertEqual(boost.privacy, 'unlisted') @@ -117,7 +117,7 @@ class InteractionViews(TestCase): user=self.local_user, content='hi', privacy='followers') with patch('bookwyrm.broadcast.broadcast_task.delay'): - view(request, status) + view(request, status.id) self.assertFalse(models.Boost.objects.exists()) def test_handle_boost_twice(self): @@ -129,8 +129,8 @@ class InteractionViews(TestCase): user=self.local_user, content='hi') with patch('bookwyrm.broadcast.broadcast_task.delay'): - view(request, status) - view(request, status) + view(request, status.id) + view(request, status.id) self.assertEqual(models.Boost.objects.count(), 1) @@ -138,15 +138,15 @@ class InteractionViews(TestCase): ''' undo a boost ''' view = views.Unboost.as_view() request = self.factory.post('') - request.user = self.local_user + request.user = self.remote_user status = models.Status.objects.create( user=self.local_user, content='hi') with patch('bookwyrm.broadcast.broadcast_task.delay'): - view(request, status) + views.Boost.as_view()(request, status.id) self.assertEqual(models.Boost.objects.count(), 1) self.assertEqual(models.Notification.objects.count(), 1) with patch('bookwyrm.broadcast.broadcast_task.delay'): - view(request, status) + view(request, status.id) self.assertEqual(models.Boost.objects.count(), 0) self.assertEqual(models.Notification.objects.count(), 0) From 7d6a06025e09ef58b365c0b980055c82c7a2984e Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 18:02:01 -0800 Subject: [PATCH 31/34] Adds more reading tests --- bookwyrm/tests/views/test_reading.py | 79 ++++++++++++++++++++++++++++ bookwyrm/views/reading.py | 4 +- 2 files changed, 81 insertions(+), 2 deletions(-) diff --git a/bookwyrm/tests/views/test_reading.py b/bookwyrm/tests/views/test_reading.py index f5e4cd52..436dbf68 100644 --- a/bookwyrm/tests/views/test_reading.py +++ b/bookwyrm/tests/views/test_reading.py @@ -32,6 +32,85 @@ class ReadingViews(TestCase): outbox='https://example.com/users/rat/outbox', ) + + def test_start_reading(self): + ''' begin a book ''' + shelf = self.local_user.shelf_set.get(identifier='reading') + self.assertFalse(shelf.books.exists()) + self.assertFalse(models.Status.objects.exists()) + + request = self.factory.post('', { + 'post-status': True, + 'privacy': 'followers', + 'start_date': '2020-01-05', + }) + request.user = self.local_user + views.start_reading(request, self.book.id) + + self.assertEqual(shelf.books.get(), self.book) + + status = models.GeneratedNote.objects.get() + self.assertEqual(status.user, self.local_user) + self.assertEqual(status.mention_books.get(), self.book) + self.assertEqual(status.privacy, 'followers') + + readthrough = models.ReadThrough.objects.get() + self.assertIsNotNone(readthrough.start_date) + self.assertIsNone(readthrough.finish_date) + self.assertEqual(readthrough.user, self.local_user) + self.assertEqual(readthrough.book, self.book) + + + def test_start_reading_reshelf(self): + ''' begin a book ''' + to_read_shelf = self.local_user.shelf_set.get(identifier='to-read') + models.ShelfBook.objects.create( + shelf=to_read_shelf, book=self.book, added_by=self.local_user) + shelf = self.local_user.shelf_set.get(identifier='reading') + self.assertEqual(to_read_shelf.books.get(), self.book) + self.assertFalse(shelf.books.exists()) + self.assertFalse(models.Status.objects.exists()) + + request = self.factory.post('') + request.user = self.local_user + views.start_reading(request, self.book.id) + + self.assertFalse(to_read_shelf.books.exists()) + self.assertEqual(shelf.books.get(), self.book) + + def test_finish_reading(self): + ''' begin a book ''' + shelf = self.local_user.shelf_set.get(identifier='read') + self.assertFalse(shelf.books.exists()) + self.assertFalse(models.Status.objects.exists()) + readthrough = models.ReadThrough.objects.create( + user=self.local_user, + start_date=timezone.now(), + book=self.book) + + request = self.factory.post('', { + 'post-status': True, + 'privacy': 'followers', + 'finish_date': '2020-01-07', + 'id': readthrough.id, + }) + request.user = self.local_user + views.finish_reading(request, self.book.id) + + self.assertEqual(shelf.books.get(), self.book) + + status = models.GeneratedNote.objects.get() + self.assertEqual(status.user, self.local_user) + self.assertEqual(status.mention_books.get(), self.book) + self.assertEqual(status.privacy, 'followers') + + readthrough = models.ReadThrough.objects.get() + self.assertIsNotNone(readthrough.start_date) + self.assertIsNotNone(readthrough.finish_date) + self.assertEqual(readthrough.user, self.local_user) + self.assertEqual(readthrough.book, self.book) + + def test_edit_readthrough(self): ''' adding dates to an ongoing readthrough ''' start = timezone.make_aware(dateutil.parser.parse('2021-01-03')) diff --git a/bookwyrm/views/reading.py b/bookwyrm/views/reading.py index 51c3217e..11b6e335 100644 --- a/bookwyrm/views/reading.py +++ b/bookwyrm/views/reading.py @@ -27,7 +27,7 @@ def start_reading(request, book_id): # create a readthrough readthrough = update_readthrough(request, book=book) - if readthrough.start_date: + if readthrough: readthrough.save() # shelve the book @@ -65,7 +65,7 @@ def finish_reading(request, book_id): # update or create a readthrough readthrough = update_readthrough(request, book=book) - if readthrough.start_date or readthrough.finish_date: + if readthrough: readthrough.save() # shelve the book From c0ce38a9d3f2eebb7809a5f84296380468fb336a Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 18:48:50 -0800 Subject: [PATCH 32/34] landing page tests --- bookwyrm/tests/views/test_landing.py | 35 ++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/bookwyrm/tests/views/test_landing.py b/bookwyrm/tests/views/test_landing.py index d57f0347..5596b4f3 100644 --- a/bookwyrm/tests/views/test_landing.py +++ b/bookwyrm/tests/views/test_landing.py @@ -1,4 +1,5 @@ ''' test for app action functionality ''' +from django.contrib.auth.models import AnonymousUser from django.template.response import TemplateResponse from django.test import TestCase from django.test.client import RequestFactory @@ -15,6 +16,28 @@ class LandingViews(TestCase): self.local_user = models.User.objects.create_user( 'mouse@local.com', 'mouse@mouse.mouse', 'password', local=True, localname='mouse') + self.anonymous_user = AnonymousUser + self.anonymous_user.is_authenticated = False + self.book = models.Edition.objects.create( + title='Example Edition', + remote_id='https://example.com/book/1', + ) + + + def test_home_page(self): + ''' there are so many views, this just makes sure it LOADS ''' + view = views.Home.as_view() + request = self.factory.get('') + request.user = self.local_user + result = view(request) + self.assertEqual(result.status_code, 200) + self.assertEqual(result.template_name, 'feed.html') + + request.user = self.anonymous_user + result = view(request) + self.assertIsInstance(result, TemplateResponse) + self.assertEqual(result.status_code, 200) + self.assertEqual(result.template_name, 'discover.html') def test_about_page(self): @@ -47,3 +70,15 @@ class LandingViews(TestCase): self.assertIsInstance(result, TemplateResponse) self.assertEqual(result.template_name, 'discover.html') self.assertEqual(result.status_code, 200) + + + def test_get_suggested_book(self): + ''' gets books the ~*~ algorithm ~*~ thinks you want to post about ''' + models.ShelfBook.objects.create( + book=self.book, + added_by=self.local_user, + shelf=self.local_user.shelf_set.get(identifier='reading') + ) + suggestions = views.landing.get_suggested_books(self.local_user) + self.assertEqual(suggestions[0]['name'], 'Currently Reading') + self.assertEqual(suggestions[0]['books'][0], self.book) From 0a9757bf016b7e6554c335f0dce37dcf41c247c3 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 19:28:44 -0800 Subject: [PATCH 33/34] A few more templatetag tests --- bookwyrm/tests/test_templatetags.py | 51 ++++++++++++++++++++++++++++- 1 file changed, 50 insertions(+), 1 deletion(-) diff --git a/bookwyrm/tests/test_templatetags.py b/bookwyrm/tests/test_templatetags.py index 004dd893..2cc61eab 100644 --- a/bookwyrm/tests/test_templatetags.py +++ b/bookwyrm/tests/test_templatetags.py @@ -2,7 +2,6 @@ import re from unittest.mock import patch -from dateutil.parser import parse from dateutil.relativedelta import relativedelta from django.test import TestCase from django.utils import timezone @@ -213,3 +212,53 @@ class TemplateTags(TestCase): r'[A-Z][a-z]{2} \d?\d \d{4}', bookwyrm_tags.time_since(years_ago) )) + + + def test_get_markdown(self): + ''' mardown format data ''' + result = bookwyrm_tags.get_markdown('_hi_') + self.assertEqual(result, '

    hi

    ') + + result = bookwyrm_tags.get_markdown('_hi_') + self.assertEqual(result, '

    hi

    ') + + + def test_get_mentions(self): + ''' list of people mentioned ''' + status = models.Status.objects.create( + content='hi', user=self.remote_user) + result = bookwyrm_tags.get_mentions(status, self.user) + self.assertEqual(result, '@rat@example.com') + + + def test_get_status_preview_name(self): + ''' status context string ''' + status = models.Status.objects.create(content='hi', user=self.user) + result = bookwyrm_tags.get_status_preview_name(status) + self.assertEqual(result, 'status') + + status = models.Review.objects.create( + content='hi', user=self.user, book=self.book) + result = bookwyrm_tags.get_status_preview_name(status) + self.assertEqual(result, 'review of Test Book') + + status = models.Comment.objects.create( + content='hi', user=self.user, book=self.book) + result = bookwyrm_tags.get_status_preview_name(status) + self.assertEqual(result, 'comment on Test Book') + + status = models.Quotation.objects.create( + content='hi', user=self.user, book=self.book) + result = bookwyrm_tags.get_status_preview_name(status) + self.assertEqual(result, 'quotation from Test Book') + + + def test_related_status(self): + ''' gets the subclass model for a notification status ''' + status = models.Status.objects.create(content='hi', user=self.user) + notification = models.Notification.objects.create( + user=self.user, notification_type='MENTION', + related_status=status) + + result = bookwyrm_tags.related_status(notification) + self.assertIsInstance(result, models.Status) From 766c7afdb90f1aeae15f9bc79ba79216240b0723 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Wed, 13 Jan 2021 19:38:26 -0800 Subject: [PATCH 34/34] Don't let long titles display past card title box --- bookwyrm/static/css/format.css | 3 +++ 1 file changed, 3 insertions(+) diff --git a/bookwyrm/static/css/format.css b/bookwyrm/static/css/format.css index fab335b1..cec44f4a 100644 --- a/bookwyrm/static/css/format.css +++ b/bookwyrm/static/css/format.css @@ -9,6 +9,9 @@ .card { overflow: visible; } +.card-header-title { + overflow: hidden; +} /* --- TOGGLES --- */ input.toggle-control {