1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
|
import codecs
from django.contrib.auth.models import User
from django.http import HttpResponse
from django.utils.translation import gettext_lazy as _
from django.views.generic import (
View,
UpdateView,
FormView,
TemplateView,
ListView,
DetailView,
CreateView,
)
from braces import views
from .models import Article, CanonicalArticle
from .forms import ArticleForm, FormWithUserKwarg
from .helpers import SetJSONEncoder
class OkView(View):
"""
A view which simply returns "OK" for every request.
"""
def get(self, request):
"""Everything is going to be OK"""
return HttpResponse("OK")
def post(self, request):
"""Get it?"""
return self.get(request)
def put(self, request):
"""Get it?"""
return self.get(request)
def delete(self, request):
"""Get it?"""
return self.get(request)
class LoginRequiredView(views.LoginRequiredMixin, OkView):
"""
A view for testing LoginRequiredMixin.
"""
class AnonymousRequiredView(views.AnonymousRequiredMixin, OkView):
"""
A view for testing AnonymousRequiredMixin. Should accept
unauthenticated users and redirect authenticated users to the
authenticated_redirect_url set on the view.
"""
authenticated_redirect_url = "/authenticated_view/"
class AuthenticatedView(views.LoginRequiredMixin, OkView):
"""
A view for testing AnonymousRequiredMixin. Should accept
authenticated users.
"""
class AjaxResponseView(views.AjaxResponseMixin, OkView):
"""
A view for testing AjaxResponseMixin.
"""
def get_ajax(self, request):
"""Everything will eventually be OK"""
return HttpResponse("AJAX_OK")
def post_ajax(self, request):
"""Get it?"""
return self.get_ajax(request)
def put_ajax(self, request):
"""Get it?"""
return self.get_ajax(request)
def delete_ajax(self, request):
"""Get it?"""
return self.get_ajax(request)
class SimpleJsonView(views.JSONResponseMixin, View):
"""
A view for testing JSONResponseMixin's render_json_response() method.
"""
def get(self, request):
"""Send back some JSON"""
object = {"username": request.user.username}
return self.render_json_response(object)
class CustomJsonEncoderView(views.JSONResponseMixin, View):
"""
A view for testing JSONResponseMixin's `json_encoder_class` attribute
with custom JSONEncoder class.
"""
json_encoder_class = SetJSONEncoder
def get(self, request):
"""Send back some JSON"""
object = {"numbers": set([1, 2, 3])}
return self.render_json_response(object)
class SimpleJsonBadRequestView(views.JSONResponseMixin, View):
"""
A view for testing JSONResponseMixin's render_json_response() method with
400 HTTP status code.
"""
def get(self, request):
"""Send back some JSON"""
object = {"username": request.user.username}
return self.render_json_response(object, status=400)
class ArticleListJsonView(views.JSONResponseMixin, View):
"""
A view for testing JSONResponseMixin's render_json_object_response()
method.
"""
def get(self, request):
"""Send back some JSON"""
queryset = Article.objects.all()
return self.render_json_object_response(queryset, fields=("title",))
class JsonRequestResponseView(views.JsonRequestResponseMixin, View):
"""
A view for testing JsonRequestResponseMixin's json conversion
"""
def post(self, request):
"""Send back some JSON"""
return self.render_json_response(self.request_json)
class JsonBadRequestView(views.JsonRequestResponseMixin, View):
"""
A view for testing JsonRequestResponseMixin's require_json
and render_bad_request_response methods
"""
require_json = True
def post(self, request, *args, **kwargs):
"""Send back some JSON"""
return self.render_json_response(self.request_json)
class JsonCustomBadRequestView(views.JsonRequestResponseMixin, View):
"""
A view for testing JsonRequestResponseMixin's
render_bad_request_response method with a custom error message
"""
def post(self, request, *args, **kwargs):
"""Handle the POST request"""
if not self.request_json:
return self.render_bad_request_response({"error": "you messed up"})
return self.render_json_response(self.request_json)
class CreateArticleView(CreateView):
"""
View for testing CreateAndRedirectEditToView.
"""
fields = ["author", "title", "body", "slug"]
model = Article
template_name = "form.html"
class EditArticleView(UpdateView):
"""
View for testing CreateAndRedirectEditToView.
"""
model = Article
template_name = "form.html"
class CreateArticleAndRedirectToListView(
views.SuccessURLRedirectListMixin, CreateArticleView
):
"""
View for testing SuccessURLRedirectListMixin
"""
success_list_url = "article_list"
class CreateArticleAndRedirectToListViewBad(
views.SuccessURLRedirectListMixin, CreateArticleView
):
"""
View for testing SuccessURLRedirectListMixin
"""
success_list_url = None
class ArticleListView(views.SelectRelatedMixin, ListView):
"""
A list view for articles, required for testing SuccessURLRedirectListMixin.
Also used to test SelectRelatedMixin.
"""
model = Article
template_name = "blank.html"
select_related = ("author",)
class ArticleListViewWithCustomQueryset(views.SelectRelatedMixin, ListView):
"""
Another list view for articles, required to test SelectRelatedMixin.
"""
queryset = Article.objects.select_related("author").prefetch_related(
"article_set"
)
template_name = "blank.html"
select_related = ()
class FormWithUserKwargView(views.UserFormKwargsMixin, FormView):
"""
View for testing UserFormKwargsMixin.
"""
form_class = FormWithUserKwarg
template_name = "form.html"
def form_valid(self, form):
"""A simple response to watch for"""
return HttpResponse(f"username: {form.user.username}")
class HeadlineView(views.SetHeadlineMixin, TemplateView):
"""
View for testing SetHeadlineMixin.
"""
template_name = "blank.html"
headline = "Test headline"
class LazyHeadlineView(views.SetHeadlineMixin, TemplateView):
"""
View for testing SetHeadlineMixin.
"""
template_name = "blank.html"
headline = _("Test Headline")
class ContextView(views.StaticContextMixin, TemplateView):
"""View for testing StaticContextMixin."""
template_name = "blank.html"
static_context = {"test": True}
class DynamicHeadlineView(views.SetHeadlineMixin, TemplateView):
"""
View for testing SetHeadlineMixin's get_headline() method.
"""
template_name = "blank.html"
def get_headline(self):
"""Return the headline passed in via kwargs"""
return self.kwargs["s"]
class PermissionRequiredView(views.PermissionRequiredMixin, OkView):
"""
View for testing PermissionRequiredMixin.
"""
permission_required = "auth.add_user"
def get_object(self):
"""
Get the article object for the query parameter's primary key
"""
article_obj = None
object_pk = self.request.GET.get("pk")
if object_pk:
article_obj = Article.objects.get(pk=object_pk)
return article_obj
class MultiplePermissionsRequiredView(
views.MultiplePermissionsRequiredMixin, OkView
):
permissions = {
"all": ["tests.add_article", "tests.change_article"],
"any": ["auth.add_user", "auth.change_user"],
}
def get_object(self):
"""
Get the article object for the query parameter's primary key
"""
article_obj = None
object_pk = self.request.GET.get("pk")
if object_pk:
article_obj = Article.objects.get(pk=object_pk)
return article_obj
class SuperuserRequiredView(views.SuperuserRequiredMixin, OkView):
"""Require a superuser"""
class StaffuserRequiredView(views.StaffuserRequiredMixin, OkView):
"""Require a user marked as `is_staff`"""
class CsrfExemptView(views.CsrfExemptMixin, OkView):
"""Ignore CSRF"""
class AuthorDetailView(views.PrefetchRelatedMixin, ListView):
"""A basic detail view to test prefetching"""
model = User
prefetch_related = ["article_set"]
template_name = "blank.html"
class OrderableListView(views.OrderableListMixin, ListView):
"""A basic list view to test ordering the output"""
model = Article
orderable_columns = (
"id",
"title",
)
orderable_columns_default = "id"
class CanonicalSlugDetailView(views.CanonicalSlugDetailMixin, DetailView):
"""A basic detail view to test a canonical slug"""
model = Article
template_name = "blank.html"
class OverriddenCanonicalSlugDetailView(views.CanonicalSlugDetailMixin, DetailView):
"""A basic detail view to test an overridden slug"""
model = Article
template_name = "blank.html"
def get_canonical_slug(self):
"""Give back a different, encoded slug. My slug secrets are safe"""
return codecs.encode(self.get_object().slug, "rot_13")
class CanonicalSlugDetailCustomUrlKwargsView(views.CanonicalSlugDetailMixin, DetailView):
"""A basic detail view to test a slug with custom URL stuff"""
model = Article
template_name = "blank.html"
pk_url_kwarg = "my_pk"
slug_url_kwarg = "my_slug"
class ModelCanonicalSlugDetailView(views.CanonicalSlugDetailMixin, DetailView):
"""A basic detail view to test a model with a canonical slug"""
model = CanonicalArticle
template_name = "blank.html"
class FormMessagesView(views.FormMessagesMixin, CreateView):
"""A basic form view to test valid/invalid messages"""
form_class = ArticleForm
form_invalid_message = _("Invalid")
form_valid_message = _("Valid")
model = Article
success_url = "/form_messages/"
template_name = "form.html"
class GroupRequiredView(views.GroupRequiredMixin, OkView):
"""Is everything OK in this group?"""
group_required = "test_group"
class UserPassesTestView(views.UserPassesTestMixin, OkView):
"""Did I pass a test?"""
def test_func(self, user):
return (
user.is_staff
and not user.is_superuser
and user.email.endswith("@mydomain.com")
)
class UserPassesTestLoginRequiredView(
views.LoginRequiredMixin, views.UserPassesTestMixin, OkView
):
"""Am I logged in _and_ passing a test?"""
def test_func(self, user):
return (
user.is_staff
and not user.is_superuser
and user.email.endswith("@mydomain.com")
)
class UserPassesTestNotImplementedView(views.UserPassesTestMixin, OkView):
"""The test went missing?"""
pass
class AllVerbsView(views.AllVerbsMixin, View):
"""I know, like, all the verbs"""
def all(self, request, *args, **kwargs):
return HttpResponse("All verbs return this!")
class SSLRequiredView(views.SSLRequiredMixin, OkView):
"""Speak friend and enter"""
pass
class RecentLoginRequiredView(views.RecentLoginRequiredMixin, OkView):
"""
A view for testing RecentLoginRequiredMixin.
"""
class AttributeHeaderView(views.HeaderMixin, OkView):
"""Set headers in an attribute w/o a template render class"""
headers = {
"X-DJANGO-BRACES-1": 1,
"X-DJANGO-BRACES-2": 2,
}
class MethodHeaderView(views.HeaderMixin, OkView):
"""Set headers in a method w/o a template render class"""
def get_headers(self, request):
return {
"X-DJANGO-BRACES-1": 1,
"X-DJANGO-BRACES-2": 2,
}
class AuxiliaryHeaderView(View):
"""A view with a header already set"""
def dispatch(self, request, *args, **kwargs):
response = HttpResponse("OK with headers")
response["X-DJANGO-BRACES-EXISTING"] = "value"
return response
class ExistingHeaderView(views.HeaderMixin, AuxiliaryHeaderView):
"""A view trying to override a parent's header"""
headers = {
'X-DJANGO-BRACES-EXISTING': 'other value'
}
class CacheControlPublicView(views.CacheControlMixin, OkView):
"""A public-cached page with a 60 second timeout"""
cachecontrol_public = True
cachecontrol_max_age = 60
class NeverCacheView(views.NeverCacheMixin, OkView):
"""
View that will never be cached upstream.
"""
|