From ac7e85c24a7d62445d9dd07064c50599d14141ad Mon Sep 17 00:00:00 2001 From: David Taylor Date: Sat, 8 Oct 2016 17:30:23 +0100 Subject: [PATCH] PEP8 and comments --- PyRIGS/decorators.py | 13 +++++++---- RIGS/urls.py | 23 +++++++++---------- ...edirect_embed.html => login_redirect.html} | 2 +- 3 files changed, 21 insertions(+), 17 deletions(-) rename templates/{login_redirect_embed.html => login_redirect.html} (94%) diff --git a/PyRIGS/decorators.py b/PyRIGS/decorators.py index 4af93097..0b4a72eb 100644 --- a/PyRIGS/decorators.py +++ b/PyRIGS/decorators.py @@ -4,12 +4,17 @@ from django.template import RequestContext from django.http import HttpResponseRedirect from django.core.urlresolvers import reverse +from RIGS import models + + def user_passes_test_with_403(test_func, login_url=None, oembed_view=None): """ Decorator for views that checks that the user passes the given test. - Anonymous users will be redirected to login_url, while users that fail the test will be given a 403 error. + If embed_view is set, then a JS redirect will be used, and a application/json+oembed + meta tag set with the url of oembed_view + (oembed_view will be passed the kwargs from the main function) """ if not login_url: from django.conf import settings @@ -24,7 +29,7 @@ def user_passes_test_with_403(test_func, login_url=None, oembed_view=None): extra_context = {} extra_context['oembed_url'] = request.scheme + '://' + request.META['HTTP_HOST'] + reverse(oembed_view, kwargs=kwargs) extra_context['login_url'] = "{0}?{1}={2}".format(login_url, REDIRECT_FIELD_NAME, request.get_full_path()) - resp = render_to_response('login_redirect_embed.html', extra_context, context_instance=RequestContext(request)) + resp = render_to_response('login_redirect.html', extra_context, context_instance=RequestContext(request)) return resp else: return HttpResponseRedirect('%s?%s=%s' % (login_url, REDIRECT_FIELD_NAME, request.get_full_path())) @@ -37,6 +42,7 @@ def user_passes_test_with_403(test_func, login_url=None, oembed_view=None): return _checklogin return _dec + def permission_required_with_403(perm, login_url=None, oembed_view=None): """ Decorator for views that checks whether a user has a particular permission @@ -44,7 +50,6 @@ def permission_required_with_403(perm, login_url=None, oembed_view=None): """ return user_passes_test_with_403(lambda u: u.has_perm(perm), login_url=login_url, oembed_view=oembed_view) -from RIGS import models def api_key_required(function): """ @@ -73,4 +78,4 @@ def api_key_required(function): if user_object.api_key != key: return error_resp return function(request, *args, **kwargs) - return wrap \ No newline at end of file + return wrap diff --git a/RIGS/urls.py b/RIGS/urls.py index 8767d7b9..cbdef421 100644 --- a/RIGS/urls.py +++ b/RIGS/urls.py @@ -1,4 +1,4 @@ -from django.conf.urls import patterns, include, url +from django.conf.urls import patterns, url from django.contrib.auth.decorators import login_required from RIGS import models, views, rigboard, finance, ical, versioning, forms from django.views.generic import RedirectView @@ -16,7 +16,7 @@ urlpatterns = patterns('', url('^user/login/$', 'RIGS.views.login', name='login'), url('^user/login/embed/$', xframe_options_exempt(views.login_embed), name='login_embed'), - url(r'^user/password_reset/$', 'django.contrib.auth.views.password_reset', {'password_reset_form':forms.PasswordReset}), + url(r'^user/password_reset/$', 'django.contrib.auth.views.password_reset', {'password_reset_form': forms.PasswordReset}), # People url(r'^people/$', permission_required_with_403('RIGS.view_person')(views.PersonList.as_view()), @@ -73,7 +73,7 @@ urlpatterns = patterns('', url(r'^rigboard/calendar/$', login_required()(rigboard.WebCalendar.as_view()), name='web_calendar'), url(r'^rigboard/calendar/(?P(month|week|day))/$', login_required()(rigboard.WebCalendar.as_view()), name='web_calendar'), url(r'^rigboard/calendar/(?P(month|week|day))/(?P(\d{4}-\d{2}-\d{2}))/$', login_required()(rigboard.WebCalendar.as_view()), name='web_calendar'), - url(r'^rigboard/archive/$', RedirectView.as_view(permanent=True,pattern_name='event_archive')), + url(r'^rigboard/archive/$', RedirectView.as_view(permanent=True, pattern_name='event_archive')), url(r'^rigboard/activity/$', permission_required_with_403('RIGS.view_event')(versioning.ActivityTable.as_view()), name='activity_table'), @@ -109,7 +109,7 @@ urlpatterns = patterns('', permission_required_with_403('RIGS.view_event')(versioning.VersionHistory.as_view()), name='event_history', kwargs={'model': models.Event}), - + # Finance url(r'^invoice/$', @@ -148,10 +148,10 @@ urlpatterns = patterns('', # User editing url(r'^user/$', login_required(views.ProfileDetail.as_view()), name='profile_detail'), url(r'^user/(?P\d+)/$', - permission_required_with_403('RIGS.view_profile')(views.ProfileDetail.as_view()), - name='profile_detail'), + permission_required_with_403('RIGS.view_profile')(views.ProfileDetail.as_view()), + name='profile_detail'), url(r'^user/edit/$', login_required(views.ProfileUpdateSelf.as_view()), - name='profile_update_self'), + name='profile_update_self'), url(r'^user/reset_api_key$', login_required(views.ResetApiKey.as_view(permanent=False)), name='reset_api_key'), # ICS Calendar - API key authentication @@ -162,8 +162,7 @@ urlpatterns = patterns('', url(r'^api/(?P\w+)/(?P\d+)/$', login_required(views.SecureAPIRequest.as_view()), name="api_secure"), # Legacy URL's - url(r'^rig/show/(?P\d+)/$', RedirectView.as_view(permanent=True,pattern_name='event_detail')), - url(r'^bookings/$', RedirectView.as_view(permanent=True,pattern_name='rigboard')), - url(r'^bookings/past/$', RedirectView.as_view(permanent=True,pattern_name='event_archive')), -) - + url(r'^rig/show/(?P\d+)/$', RedirectView.as_view(permanent=True, pattern_name='event_detail')), + url(r'^bookings/$', RedirectView.as_view(permanent=True, pattern_name='rigboard')), + url(r'^bookings/past/$', RedirectView.as_view(permanent=True, pattern_name='event_archive')), + ) diff --git a/templates/login_redirect_embed.html b/templates/login_redirect.html similarity index 94% rename from templates/login_redirect_embed.html rename to templates/login_redirect.html index afd3487c..d2dcb0b2 100644 --- a/templates/login_redirect_embed.html +++ b/templates/login_redirect.html @@ -12,7 +12,7 @@ {% if oembed_url %} + title="RIGS Embed" /> {% endif %} {% endblock %}