docs.views: 49 total statements, 73.0% covered

Generated: Mon 2013-04-29 21:17 CST

Source file: /home/slam/workspace/django-docs/docs/views.py

Stats: 27 executed, 10 missed, 12 excluded, 43 ignored

1. from django.views.generic import RedirectView
2. from django.core.urlresolvers import reverse
3. from django.views.static import serve
4. from django.conf import settings
5. from django.contrib.auth.decorators import login_required
6. from functools import wraps
7. from django.contrib.admin.forms import AdminAuthenticationForm
8. from django.contrib.auth.views import login
9. from django.contrib.admin.views.decorators import staff_member_required
10. from django.contrib.auth import REDIRECT_FIELD_NAME
11. from django.utils.translation import ugettext as _
12. from exceptions import ValueError
15. def superuser_required(view_func):
16. """
17. Decorator for views that checks that the user is logged in and is a staff
18. member, displaying the login page if necessary.
19. """
20. @wraps(view_func)
21. def _checklogin(request, *args, **kwargs):
22. if request.user.is_active and request.user.is_superuser:
23. # The user is valid. Continue to the admin page.
24. return view_func(request, *args, **kwargs)
26. assert hasattr(request, 'session'), "The Django admin requires session middleware to be installed. Edit your MIDDLEWARE_CLASSES setting to insert 'django.contrib.sessions.middleware.SessionMiddleware'."
27. defaults = {
28. 'template_name': 'admin/login.html',
29. 'authentication_form': AdminAuthenticationForm,
30. 'extra_context': {
31. 'title': _('Log in'),
32. 'app_path': request.get_full_path(),
33. REDIRECT_FIELD_NAME: request.get_full_path(),
34. },
35. }
36. return login(request, **defaults)
37. return _checklogin
39. def public(function=None):
40. """
41. Dummy decorator that doesn't check anything.
42. """
43. return function
46. class DocsAccessSettingError(ValueError):
47. pass
50. class DocsRootSettingError(ValueError):
51. pass
54. DOCS_ACCESS_CHOICES = (
55. 'public',
56. 'login_required',
57. 'staff',
58. 'superuser',
59. )
60. DOCS_ROOT = getattr(settings, 'DOCS_ROOT', None)
61. DOCS_ACCESS = getattr(settings, 'DOCS_ACCESS', DOCS_ACCESS_CHOICES[0])
63. if DOCS_ACCESS == 'public':
64. decorator = public
65. elif DOCS_ACCESS == 'login_required':
66. decorator = login_required
67. elif DOCS_ACCESS == 'staff':
68. decorator = staff_member_required
69. elif DOCS_ACCESS == 'superuser':
70. decorator = superuser_required
71. else:
72. decorator = public
75. @decorator
76. def serve_docs(request, path, **kwargs):
77. if DOCS_ACCESS not in DOCS_ACCESS_CHOICES:
78. raise DocsAccessSettingError('DOCS_ACCESS setting value is incorrect: %s (choises are: %s)' % (
79. DOCS_ACCESS,
80. DOCS_ACCESS_CHOICES
81. ))
82. if 'document_root' not in kwargs and not DOCS_ROOT:
83. raise DocsRootSettingError('DOCS_ROOT setting value is incorrect: %s (must be a valid path)' % DOCS_ROOT)
84. if 'document_root' not in kwargs and DOCS_ROOT:
85. kwargs['document_root'] = DOCS_ROOT
86. return serve(request, path, **kwargs)
89. class DocsRootView(RedirectView):
90. def get_redirect_url(self, **kwargs):
91. return reverse('docs_files', kwargs={'path': 'index.html'})