-
Notifications
You must be signed in to change notification settings - Fork 0
/
views.py
177 lines (160 loc) · 7.38 KB
/
views.py
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
from django.contrib.contenttypes.models import ContentType
from django.core.exceptions import ObjectDoesNotExist
from django.http import Http404, HttpResponse, HttpResponseRedirect
from django.contrib.auth.views import redirect_to_login
from django.template import loader, RequestContext
from django.utils import simplejson
from voting.models import Vote
VOTE_DIRECTIONS = (('up', 1), ('down', -1), ('clear', 0))
def vote_on_object(request, direction=None, model=None, content_type_id=None,
post_vote_redirect=None, object_id=None, slug=None,
slug_field=None, template_name=None, template_loader=loader,
extra_context=None, context_processors=None,
template_object_name='object', allow_xmlhttprequest=True):
"""
A wrapper around the original vote_on_object to allow fetching model
from content_type_id if model is not given
Also allows POSTing direction, content_type_id and object_id parameters
instead of supplying from within the request URL.
"""
if not direction:
direction = request.POST.get('direction')
if not object_id:
object_id = request.POST.get('object_id')
if not model:
if not content_type_id:
content_type_id = request.POST.get('content_type_id')
model = ContentType.objects.get_for_id(content_type_id).model_class()
return _vote_on_object(request, model, direction, post_vote_redirect=post_vote_redirect,
object_id=object_id, slug=slug, slug_field=slug_field, template_name=template_name,
template_loader=loader, extra_context=extra_context, context_processors=context_processors,
template_object_name='object', allow_xmlhttprequest=allow_xmlhttprequest)
def _vote_on_object(request, model, direction, post_vote_redirect=None,
object_id=None, slug=None, slug_field=None, template_name=None,
template_loader=loader, extra_context=None, context_processors=None,
template_object_name='object', allow_xmlhttprequest=False):
"""
Generic object vote function.
The given template will be used to confirm the vote if this view is
fetched using GET; vote registration will only be performed if this
view is POSTed.
If ``allow_xmlhttprequest`` is ``True`` and an XMLHttpRequest is
detected by examining the ``HTTP_X_REQUESTED_WITH`` header, the
``xmlhttp_vote_on_object`` view will be used to process the
request - this makes it trivial to implement voting via
XMLHttpRequest with a fallback for users who don't have JavaScript
enabled.
Templates:``<app_label>/<model_name>_confirm_vote.html``
Context:
object
The object being voted on.
direction
The type of vote which will be registered for the object.
"""
if allow_xmlhttprequest and request.is_ajax():
return xmlhttprequest_vote_on_object(request, model, direction,
object_id=object_id, slug=slug,
slug_field=slug_field)
if extra_context is None: extra_context = {}
if not request.user.is_authenticated():
return redirect_to_login(request.path)
try:
vote = dict(VOTE_DIRECTIONS)[direction]
except KeyError:
raise AttributeError("'%s' is not a valid vote type." % vote_type)
# Look up the object to be voted on
lookup_kwargs = {}
if object_id:
lookup_kwargs['%s__exact' % model._meta.pk.name] = object_id
elif slug and slug_field:
lookup_kwargs['%s__exact' % slug_field] = slug
else:
raise AttributeError('Generic vote view must be called with either '
'object_id or slug and slug_field.')
try:
obj = model._default_manager.get(**lookup_kwargs)
except ObjectDoesNotExist:
raise Http404, 'No %s found for %s.' % (model._meta.app_label, lookup_kwargs)
if request.method == 'POST':
if post_vote_redirect is not None:
next = post_vote_redirect
elif request.REQUEST.has_key('next'):
next = request.REQUEST['next']
elif hasattr(obj, 'get_absolute_url'):
if callable(getattr(obj, 'get_absolute_url')):
next = obj.get_absolute_url()
else:
next = obj.get_absolute_url
else:
raise AttributeError('Generic vote view must be called with either '
'post_vote_redirect, a "next" parameter in '
'the request, or the object being voted on '
'must define a get_absolute_url method or '
'property.')
Vote.objects.record_vote(obj, request.user, vote)
return HttpResponseRedirect(next)
else:
if not template_name:
template_name = '%s/%s_confirm_vote.html' % (
model._meta.app_label, model._meta.object_name.lower())
t = template_loader.get_template(template_name)
c = RequestContext(request, {
template_object_name: obj,
'direction': direction,
}, context_processors)
for key, value in extra_context.items():
if callable(value):
c[key] = value()
else:
c[key] = value
response = HttpResponse(t.render(c))
return response
def json_error_response(error_message):
return HttpResponse(simplejson.dumps(dict(success=False,
error_message=error_message)))
def xmlhttprequest_vote_on_object(request, model, direction,
object_id=None, slug=None, slug_field=None):
"""
Generic object vote function for use via XMLHttpRequest.
Properties of the resulting JSON object:
success
``true`` if the vote was successfully processed, ``false``
otherwise.
score
The object's updated score and number of votes if the vote
was successfully processed.
error_message
Contains an error message if the vote was not successfully
processed.
"""
if request.method == 'GET':
return json_error_response(
'XMLHttpRequest votes can only be made using POST.')
if not request.user.is_authenticated():
return json_error_response('Not authenticated.')
try:
vote = dict(VOTE_DIRECTIONS)[direction]
except KeyError:
return json_error_response(
'\'%s\' is not a valid vote type.' % direction)
# Look up the object to be voted on
lookup_kwargs = {}
if object_id:
lookup_kwargs['%s__exact' % model._meta.pk.name] = object_id
elif slug and slug_field:
lookup_kwargs['%s__exact' % slug_field] = slug
else:
return json_error_response('Generic XMLHttpRequest vote view must be '
'called with either object_id or slug and '
'slug_field.')
try:
obj = model._default_manager.get(**lookup_kwargs)
except ObjectDoesNotExist:
return json_error_response(
'No %s found for %s.' % (model._meta.verbose_name, lookup_kwargs))
# Vote and respond
Vote.objects.record_vote(obj, request.user, vote)
return HttpResponse(simplejson.dumps({
'success': True,
'score': Vote.objects.get_score(obj),
}))