Mercurial > public > sg101

annotate gpp/forums/views.py @ 100:eb9f99382476

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Forums: groups support. Some experimentation with select_related() to reduce queries. There are more opportunities for this, see the TODO comments in views.py.
author Brian Neal <bgneal@gmail.com>
date Tue, 15 Sep 2009 03:15:20 +0000
parents 10d6182b9f6e
children 4bbb6a9aa317
rev   line source
bgneal@81 1 """
bgneal@81 2 Views for the forums application.
bgneal@81 3 """
bgneal@83 4 from django.contrib.auth.decorators import login_required
bgneal@82 5 from django.http import Http404
bgneal@98 6 from django.http import HttpResponse
bgneal@89 7 from django.http import HttpResponseBadRequest
bgneal@90 8 from django.http import HttpResponseForbidden
bgneal@83 9 from django.http import HttpResponseRedirect
bgneal@83 10 from django.core.urlresolvers import reverse
bgneal@91 11 from django.core.paginator import InvalidPage
bgneal@82 12 from django.shortcuts import get_object_or_404
bgneal@81 13 from django.shortcuts import render_to_response
bgneal@97 14 from django.template.loader import render_to_string
bgneal@81 15 from django.template import RequestContext
bgneal@89 16 from django.views.decorators.http import require_POST
bgneal@81 17
bgneal@90 18 from core.paginator import DiggPaginator
bgneal@98 19 from core.functions import email_admins
bgneal@81 20 from forums.models import Forum
bgneal@83 21 from forums.models import Topic
bgneal@91 22 from forums.models import Post
bgneal@98 23 from forums.models import FlaggedPost
bgneal@83 24 from forums.forms import NewTopicForm
bgneal@86 25 from forums.forms import PostForm
bgneal@81 26
bgneal@90 27 #######################################################################
bgneal@90 28
bgneal@93 29 TOPICS_PER_PAGE = 50
bgneal@90 30 POSTS_PER_PAGE = 2
bgneal@90 31
bgneal@93 32 def create_topic_paginator(topics):
bgneal@93 33 return DiggPaginator(topics, TOPICS_PER_PAGE, body=5, tail=2, margin=3, padding=2)
bgneal@93 34
bgneal@93 35 def create_post_paginator(posts):
bgneal@93 36 return DiggPaginator(posts, POSTS_PER_PAGE, body=5, tail=2, margin=3, padding=2)
bgneal@90 37
bgneal@90 38 #######################################################################
bgneal@81 39
bgneal@81 40 def index(request):
bgneal@82 41 """
bgneal@82 42 This view displays all the forums available, ordered in each category.
bgneal@82 43 """
bgneal@100 44 forums = Forum.objects.forums_for_user(request.user)
bgneal@81 45 cats = {}
bgneal@81 46 for forum in forums:
bgneal@81 47 cat = cats.setdefault(forum.category.id, {
bgneal@81 48 'cat': forum.category,
bgneal@81 49 'forums': [],
bgneal@81 50 })
bgneal@81 51 cat['forums'].append(forum)
bgneal@81 52
bgneal@81 53 cmpdef = lambda a, b: cmp(a['cat'].position, b['cat'].position)
bgneal@81 54 cats = sorted(cats.values(), cmpdef)
bgneal@81 55
bgneal@81 56 return render_to_response('forums/index.html', {
bgneal@81 57 'cats': cats,
bgneal@81 58 },
bgneal@81 59 context_instance=RequestContext(request))
bgneal@81 60
bgneal@82 61
bgneal@81 62 def forum_index(request, slug):
bgneal@82 63 """
bgneal@82 64 Displays all the topics in a forum.
bgneal@82 65 """
bgneal@100 66 # TODO: use select_related to save queries
bgneal@82 67 forum = get_object_or_404(Forum, slug=slug)
bgneal@100 68
bgneal@100 69 if not forum.category.can_access(request.user):
bgneal@100 70 return HttpResponseForbidden()
bgneal@100 71
bgneal@100 72 topics = forum.topics.select_related('last_post', 'last_post__user')
bgneal@93 73 paginator = create_topic_paginator(topics)
bgneal@93 74 page_num = int(request.GET.get('page', 1))
bgneal@93 75 try:
bgneal@93 76 page = paginator.page(page_num)
bgneal@93 77 except InvalidPage:
bgneal@93 78 raise Http404
bgneal@97 79
bgneal@97 80 # we do this for the template since it is rendered twice
bgneal@97 81 page_nav = render_to_string('forums/pagination.html', {'page': page})
bgneal@82 82
bgneal@82 83 return render_to_response('forums/forum_index.html', {
bgneal@82 84 'forum': forum,
bgneal@93 85 'page': page,
bgneal@97 86 'page_nav': page_nav,
bgneal@82 87 },
bgneal@82 88 context_instance=RequestContext(request))
bgneal@82 89
bgneal@82 90
bgneal@82 91 def topic_index(request, id):
bgneal@82 92 """
bgneal@82 93 Displays all the posts in a topic.
bgneal@82 94 """
bgneal@100 95 #topic = get_object_or_404(Topic, pk=id)
bgneal@100 96 #TODO: optimize this or package it up somehow
bgneal@100 97 # this saves 2 queries vs the get_object_or_404
bgneal@100 98 qs = Topic.objects.filter(pk=id).select_related()
bgneal@100 99 try:
bgneal@100 100 topic = qs[0]
bgneal@100 101 except Topic.DoesNotExist:
bgneal@100 102 raise Http404
bgneal@100 103
bgneal@100 104 if not topic.forum.category.can_access(request.user):
bgneal@100 105 return HttpResponseForbidden()
bgneal@100 106
bgneal@86 107 topic.view_count += 1
bgneal@86 108 topic.save()
bgneal@86 109
bgneal@86 110 posts = topic.posts.select_related()
bgneal@93 111 paginator = create_post_paginator(posts)
bgneal@93 112 page_num = int(request.GET.get('page', 1))
bgneal@90 113 try:
bgneal@90 114 page = paginator.page(page_num)
bgneal@90 115 except InvalidPage:
bgneal@90 116 raise Http404
bgneal@90 117
bgneal@90 118 last_page = page_num == paginator.num_pages
bgneal@86 119
bgneal@97 120 # we do this for the template since it is rendered twice
bgneal@97 121 page_nav = render_to_string('forums/pagination.html', {'page': page})
bgneal@97 122
bgneal@86 123 return render_to_response('forums/topic.html', {
bgneal@86 124 'forum': topic.forum,
bgneal@86 125 'topic': topic,
bgneal@90 126 'page': page,
bgneal@97 127 'page_nav': page_nav,
bgneal@87 128 'last_page': last_page,
bgneal@89 129 'form': PostForm(initial={'topic_id': topic.id}),
bgneal@86 130 },
bgneal@86 131 context_instance=RequestContext(request))
bgneal@83 132
bgneal@83 133
bgneal@83 134 @login_required
bgneal@83 135 def new_topic(request, slug):
bgneal@83 136 """
bgneal@83 137 This view handles the creation of new topics.
bgneal@83 138 """
bgneal@83 139 forum = get_object_or_404(Forum, slug=slug)
bgneal@100 140
bgneal@100 141 if not forum.category.can_access(request.user):
bgneal@100 142 return HttpResponseForbidden()
bgneal@100 143
bgneal@83 144 if request.method == 'POST':
bgneal@83 145 form = NewTopicForm(request.POST)
bgneal@83 146 if form.is_valid():
bgneal@83 147 topic = form.save(forum, request.user, request.META.get("REMOTE_ADDR"))
bgneal@83 148 return HttpResponseRedirect(reverse('forums-new_topic_thanks',
bgneal@83 149 kwargs={'tid': topic.pk}))
bgneal@83 150 else:
bgneal@83 151 form = NewTopicForm()
bgneal@83 152
bgneal@83 153 return render_to_response('forums/new_topic.html', {
bgneal@83 154 'forum': forum,
bgneal@83 155 'form': form,
bgneal@83 156 },
bgneal@83 157 context_instance=RequestContext(request))
bgneal@83 158
bgneal@83 159
bgneal@83 160 @login_required
bgneal@83 161 def new_topic_thanks(request, tid):
bgneal@83 162 """
bgneal@83 163 This view displays the success page for a newly created topic.
bgneal@83 164 """
bgneal@83 165 topic = get_object_or_404(Topic, pk=tid)
bgneal@83 166 return render_to_response('forums/new_topic_thanks.html', {
bgneal@83 167 'forum': topic.forum,
bgneal@83 168 'topic': topic,
bgneal@83 169 },
bgneal@83 170 context_instance=RequestContext(request))
bgneal@89 171
bgneal@89 172
bgneal@89 173 @require_POST
bgneal@89 174 def quick_reply_ajax(request):
bgneal@89 175 """
bgneal@89 176 This function handles the quick reply to a thread function. This
bgneal@89 177 function is meant to be the target of an AJAX post, and returns
bgneal@89 178 the HTML for the new post, which the client-side script appends
bgneal@89 179 to the document.
bgneal@89 180 """
bgneal@90 181 if not request.user.is_authenticated():
bgneal@90 182 return HttpResponseForbidden()
bgneal@90 183
bgneal@89 184 form = PostForm(request.POST)
bgneal@89 185 if form.is_valid():
bgneal@100 186 if not form.topic.forum.category.can_access(request.user):
bgneal@100 187 return HttpResponseForbidden()
bgneal@100 188
bgneal@89 189 post = form.save(request.user, request.META.get("REMOTE_ADDR"))
bgneal@89 190 return render_to_response('forums/display_post.html', {
bgneal@89 191 'post': post,
bgneal@89 192 },
bgneal@89 193 context_instance=RequestContext(request))
bgneal@89 194
bgneal@89 195 return HttpResponseBadRequest();
bgneal@89 196
bgneal@91 197
bgneal@91 198 def goto_post(request, post_id):
bgneal@91 199 """
bgneal@91 200 This function calculates what page a given post is on, then redirects
bgneal@91 201 to that URL. This function is the target of get_absolute_url() for
bgneal@91 202 Post objects.
bgneal@91 203 """
bgneal@91 204 post = get_object_or_404(Post, pk=post_id)
bgneal@91 205 count = post.topic.posts.filter(creation_date__lt=post.creation_date).count()
bgneal@91 206 page = count / POSTS_PER_PAGE + 1
bgneal@91 207 url = reverse('forums-topic_index', kwargs={'id': post.topic.id}) + \
bgneal@91 208 '?page=%s#p%s' % (page, post.id)
bgneal@91 209 return HttpResponseRedirect(url)
bgneal@91 210
bgneal@98 211
bgneal@98 212 @require_POST
bgneal@98 213 def flag_post(request):
bgneal@98 214 """
bgneal@98 215 This function handles the flagging of posts by users. This function should
bgneal@98 216 be the target of an AJAX post.
bgneal@98 217 """
bgneal@98 218 if not request.user.is_authenticated():
bgneal@99 219 return HttpResponseForbidden('Please login or register to flag a post.')
bgneal@98 220
bgneal@98 221 id = request.POST.get('id')
bgneal@98 222 if id is None:
bgneal@98 223 return HttpResponseBadRequest('No post id')
bgneal@98 224
bgneal@98 225 try:
bgneal@98 226 post = Post.objects.get(pk=id)
bgneal@98 227 except Post.DoesNotExist:
bgneal@98 228 return HttpResponseBadRequest('No post with id %s' % id)
bgneal@98 229
bgneal@98 230 flag = FlaggedPost(user=request.user, post=post)
bgneal@98 231 flag.save()
bgneal@98 232 email_admins('A Post Has Been Flagged', """Hello,
bgneal@98 233
bgneal@98 234 A user has flagged a forum post for review.
bgneal@98 235 """)
bgneal@98 236 return HttpResponse('The post was flagged. A moderator will review the post shortly. ' \
bgneal@98 237 'Thanks for helping to improve the discussions on this site.')