]> git.openstreetmap.org Git - osqa.git/blobdiff - forum/views/readers.py
adding support for focusing answers when linking to them
[osqa.git] / forum / views / readers.py
index 860f54c51f25d3a5efdb02df1ed4ab1f4514a1ee..3de8c4148c4f4ebaf3fc2e9e509d8ccd3da839dd 100644 (file)
 import datetime
 import logging
 from urllib import unquote
-from forum import settings as django_settings
 from django.shortcuts import render_to_response, get_object_or_404
-from django.http import HttpResponseRedirect, HttpResponse, Http404, HttpResponsePermanentRedirect
+from django.http import HttpResponseRedirect, Http404, HttpResponsePermanentRedirect
 from django.core.paginator import Paginator, EmptyPage, InvalidPage
 from django.template import RequestContext
 from django import template
 from django.utils.html import *
-from django.utils import simplejson
-from django.db.models import Q
+from django.db.models import Q, Count
 from django.utils.translation import ugettext as _
-from django.template.defaultfilters import slugify
 from django.core.urlresolvers import reverse
-from django.utils.datastructures import SortedDict
-from django.views.decorators.cache import cache_page
-from django.utils.http import urlquote  as django_urlquote
 from django.template.defaultfilters import slugify
 from django.utils.safestring import mark_safe
 
-from forum.utils.html import sanitize_html
+from forum import settings as django_settings
+from forum.utils.html import hyperlink
 from forum.utils.diff import textDiff as htmldiff
+from forum.utils import pagination
 from forum.forms import *
 from forum.models import *
-from forum.forms import get_next_url
 from forum.actions import QuestionViewAction
+from forum.http_responses import HttpResponseUnauthorized
+from forum.feed import RssQuestionFeed, RssAnswerFeed
+from forum.utils.pagination import generate_uri
+
 import decorators
 
-# used in index page
-#refactor - move these numbers somewhere?
-INDEX_PAGE_SIZE = 30
-INDEX_AWARD_SIZE = 15
-INDEX_TAGS_SIZE = 25
-# used in tags list
-DEFAULT_PAGE_SIZE = 60
-# used in questions
-QUESTIONS_PAGE_SIZE = 30
-# used in answers
-ANSWERS_PAGE_SIZE = 10
+class HottestQuestionsSort(pagination.SortBase):
+    def apply(self, questions):
+        return questions.annotate(new_child_count=Count('all_children')).filter(
+                all_children__added_at__gt=datetime.datetime.now() - datetime.timedelta(days=1)).order_by('-new_child_count')
+
+
+class QuestionListPaginatorContext(pagination.PaginatorContext):
+    def __init__(self, id='QUESTIONS_LIST', prefix='', pagesizes=(15, 30, 50), default_pagesize=30):
+        super (QuestionListPaginatorContext, self).__init__(id, sort_methods=(
+            (_('active'), pagination.SimpleSort(_('active'), '-last_activity_at', _("Most <strong>recently updated</strong> questions"))),
+            (_('newest'), pagination.SimpleSort(_('newest'), '-added_at', _("most <strong>recently asked</strong> questions"))),
+            (_('hottest'), HottestQuestionsSort(_('hottest'), _("most <strong>active</strong> questions in the last 24 hours</strong>"))),
+            (_('mostvoted'), pagination.SimpleSort(_('most voted'), '-score', _("most <strong>voted</strong> questions"))),
+        ), pagesizes=pagesizes, default_pagesize=default_pagesize, prefix=prefix)
+
+class AnswerSort(pagination.SimpleSort):
+    def apply(self, answers):
+        if not settings.DISABLE_ACCEPTING_FEATURE:
+            return answers.order_by(*(['-marked'] + list(self._get_order_by())))
+        else:
+            return super(AnswerSort, self).apply(answers)
+
+class AnswerPaginatorContext(pagination.PaginatorContext):
+    def __init__(self, id='ANSWER_LIST', prefix='', default_pagesize=10):
+        super (AnswerPaginatorContext, self).__init__(id, sort_methods=(
+            (_('oldest'), AnswerSort(_('oldest answers'), 'added_at', _("oldest answers will be shown first"))),
+            (_('newest'), AnswerSort(_('newest answers'), '-added_at', _("newest answers will be shown first"))),
+            (_('votes'), AnswerSort(_('popular answers'), ('-score', 'added_at'), _("most voted answers will be shown first"))),
+        ), default_sort=_('votes'), pagesizes=(5, 10, 20), default_pagesize=default_pagesize, prefix=prefix)
+
+class TagPaginatorContext(pagination.PaginatorContext):
+    def __init__(self):
+        super (TagPaginatorContext, self).__init__('TAG_LIST', sort_methods=(
+            (_('name'), pagination.SimpleSort(_('by name'), 'name', _("sorted alphabetically"))),
+            (_('used'), pagination.SimpleSort(_('by popularity'), '-used_count', _("sorted by frequency of tag use"))),
+        ), default_sort=_('used'), pagesizes=(30, 60, 120))
+    
+
+def feed(request):
+    return RssQuestionFeed(
+                request,
+                Question.objects.filter_state(deleted=False).order_by('-last_activity_at'),
+                settings.APP_TITLE + _(' - ')+ _('latest questions'),
+                settings.APP_DESCRIPTION)(request)
 
 @decorators.render('index.html')
 def index(request):
+    paginator_context = QuestionListPaginatorContext()
+    paginator_context.base_path = reverse('questions')
     return question_list(request,
                          Question.objects.all(),
-                         sort=request.utils.set_sort_method('active'),
-                         base_path=reverse('questions'))
+                         base_path=reverse('questions'),
+                         feed_url=reverse('latest_questions_feed'),
+                         paginator_context=paginator_context)
 
-@decorators.render('questions.html', 'unanswered')
+@decorators.render('questions.html', 'unanswered', _('unanswered'), weight=400)
 def unanswered(request):
     return question_list(request,
-                         Question.objects.filter(extra_ref=None),
+                         Question.objects.exclude(id__in=Question.objects.filter(children__marked=True).distinct()).exclude(marked=True),
                          _('open questions without an accepted answer'),
-                         request.utils.set_sort_method('active'),
                          None,
                          _("Unanswered Questions"))
 
-@decorators.render('questions.html', 'questions')
+@decorators.render('questions.html', 'questions', _('questions'), weight=0)
 def questions(request):
-    return question_list(request, Question.objects.all(), _('questions'), request.utils.set_sort_method('active'))
+    return question_list(request, Question.objects.all(), _('questions'))
 
 @decorators.render('questions.html')
 def tag(request, tag):
-    return question_list(request,
-                         Question.objects.filter(tags__name=unquote(tag)),
-                         mark_safe(_('questions tagged <span class="tag">%(tag)s</span>') % {'tag': tag}),
-                         request.utils.set_sort_method('active'),
+    try:
+        tag = Tag.active.get(name=unquote(tag))
+    except Tag.DoesNotExist:
+        raise Http404
+
+    # Getting the questions QuerySet
+    questions = Question.objects.filter(tags__id=tag.id)
+
+    if request.method == "GET":
+        user = request.GET.get('user', None)
+
+        if user is not None:
+            try:
+                questions = questions.filter(author=User.objects.get(username=user))
+            except User.DoesNotExist:
+                raise Http404
+
+    # The extra tag context we need to pass
+    tag_context = {
+        'tag' : tag,
+    }
+
+    # The context returned by the question_list function, contains info about the questions
+    question_context = question_list(request,
+                         questions,
+                         mark_safe(_(u'questions tagged <span class="tag">%(tag)s</span>') % {'tag': tag}),
                          None,
-                         mark_safe(_('Questions Tagged With <span class="tag">%(tag)s</span>') % {'tag': tag}),
+                         mark_safe(_(u'Questions Tagged With %(tag)s') % {'tag': tag}),
                          False)
 
-@decorators.list('questions', QUESTIONS_PAGE_SIZE)
+    # If the return data type is not a dict just return it
+    if not isinstance(question_context, dict):
+        return question_context
+
+    question_context = dict(question_context)
+
+    # Create the combined context
+    context = dict(question_context.items() + tag_context.items())
+
+    return context
+
+@decorators.render('questions.html', 'questions', tabbed=False)
+def user_questions(request, mode, user, slug):
+    user = get_object_or_404(User, id=user)
+
+    if mode == _('asked-by'):
+        questions = Question.objects.filter(author=user)
+        description = _("Questions asked by %s")
+    elif mode == _('answered-by'):
+        questions = Question.objects.filter(children__author=user, children__node_type='answer').distinct()
+        description = _("Questions answered by %s")
+    elif mode == _('subscribed-by'):
+        if not (request.user.is_superuser or request.user == user):
+            return HttpResponseUnauthorized(request)
+        questions = user.subscriptions
+
+        if request.user == user:
+            description = _("Questions you subscribed %s")
+        else:
+            description = _("Questions subscribed by %s")
+    else:
+        raise Http404
+
+
+    return question_list(request, questions,
+                         mark_safe(description % hyperlink(user.get_profile_url(), user.username)),
+                         page_title=description % user.username)
+
 def question_list(request, initial,
                   list_description=_('questions'),
-                  sort=None,
                   base_path=None,
                   page_title=_("All Questions"),
-                  allowIgnoreTags=True):
+                  allowIgnoreTags=True,
+                  feed_url=None,
+                  paginator_context=None,
+                  feed_sort=('-added_at',),
+                  feed_req_params_exclude=(_('page'), _('pagesize'), _('sort')),
+                  extra_context={}):
 
     questions = initial.filter_state(deleted=False)
 
     if request.user.is_authenticated() and allowIgnoreTags:
-        questions = questions.filter(~Q(tags__id__in = request.user.marked_tags.filter(user_selections__reason = 'bad'))
-                                     )
-
-    if sort is not False:
-        if sort is None:
-            sort = request.utils.sort_method('latest')
-        else:
-            request.utils.set_sort_method(sort)
-
-        view_dic = {"latest":"-added_at", "active":"-last_activity_at", "hottest":"-extra_count", "mostvoted":"-score" }
-
-        questions=questions.order_by(view_dic.get(sort, '-added_at'))
+        questions = questions.filter(~Q(tags__id__in = request.user.marked_tags.filter(user_selections__reason = 'bad')))
 
     if page_title is None:
         page_title = _("Questions")
 
+    if request.GET.get('type', None) == 'rss':
+        if feed_sort:
+            questions = questions.order_by(*feed_sort)
+        return RssQuestionFeed(request, questions, page_title, list_description)(request)
+
     keywords =  ""
     if request.GET.get("q"):
         keywords = request.GET.get("q").strip()
 
-    answer_count = Answer.objects.filter_state(deleted=False).filter(parent__in=questions).count()
-    answer_description = _("answers")
-
-    return {
-    "questions" : questions,
-    "questions_count" : questions.count(),
-    "answer_count" : answer_count,
-    "keywords" : keywords,
-    #"tags_autocomplete" : _get_tags_cache_json(),
-    "list_description": list_description,
-    "answer_description": answer_description,
-    "base_path" : base_path,
-    "page_title" : page_title,
-    "tab" : "questions",
+    #answer_count = Answer.objects.filter_state(deleted=False).filter(parent__in=questions).count()
+    #answer_description = _("answers")
+
+    if not feed_url:
+        req_params = generate_uri(request.GET, feed_req_params_exclude)
+
+        if req_params:
+            req_params = '&' + req_params
+
+        feed_url = request.path + "?type=rss" + req_params
+
+    context = {
+        'questions' : questions.distinct(),
+        'questions_count' : questions.count(),
+        'keywords' : keywords,
+        'list_description': list_description,
+        'base_path' : base_path,
+        'page_title' : page_title,
+        'tab' : 'questions',
+        'feed_url': feed_url,
     }
+    context.update(extra_context)
+
+    return pagination.paginated(request,
+                               ('questions', paginator_context or QuestionListPaginatorContext()), context)
 
 
 def search(request):
@@ -129,89 +230,66 @@ def search(request):
             return HttpResponseRedirect(reverse('tags') + '?q=%s' % urlquote(keywords.strip()))
         elif search_type == "user":
             return HttpResponseRedirect(reverse('users') + '?q=%s' % urlquote(keywords.strip()))
-        elif search_type == "question":
+        else:
             return question_search(request, keywords)
     else:
         return render_to_response("search.html", context_instance=RequestContext(request))
 
 @decorators.render('questions.html')
 def question_search(request, keywords):
-    initial = Question.objects.search(keywords)
+    rank_feed = False
+    can_rank, initial = Question.objects.search(keywords)
+
+    if can_rank:
+        sort_order = None
+
+        if isinstance(can_rank, basestring):
+            sort_order = can_rank
+            rank_feed = True
+
+        paginator_context = QuestionListPaginatorContext()
+        paginator_context.sort_methods[_('ranking')] = pagination.SimpleSort(_('relevance'), sort_order, _("most relevant questions"))
+        paginator_context.force_sort = _('ranking')
+    else:
+        paginator_context = None
+
+    feed_url = mark_safe(escape(request.path + "?type=rss&q=" + keywords))
 
     return question_list(request, initial,
                          _("questions matching '%(keywords)s'") % {'keywords': keywords},
-                         False,
-                         "%s?t=question&q=%s" % (reverse('search'),django_urlquote(keywords)),
-                         _("questions matching '%(keywords)s'") % {'keywords': keywords})
+                         None,
+                         _("questions matching '%(keywords)s'") % {'keywords': keywords},
+                         paginator_context=paginator_context,
+                         feed_url=feed_url, feed_sort=rank_feed and (can_rank,) or '-added_at')
 
 
-def tags(request):#view showing a listing of available tags - plain list
+@decorators.render('tags.html', 'tags', _('tags'), weight=100)
+def tags(request):
     stag = ""
-    is_paginated = True
-    sortby = request.GET.get('sort', 'used')
-    try:
-        page = int(request.GET.get('page', '1'))
-    except ValueError:
-        page = 1
+    tags = Tag.active.all()
 
     if request.method == "GET":
         stag = request.GET.get("q", "").strip()
-        if stag != '':
-            objects_list = Paginator(Tag.active.filter(name__contains=stag), DEFAULT_PAGE_SIZE)
-        else:
-            if sortby == "name":
-                objects_list = Paginator(Tag.active.order_by("name"), DEFAULT_PAGE_SIZE)
-            else:
-                objects_list = Paginator(Tag.active.order_by("-used_count"), DEFAULT_PAGE_SIZE)
-
-    try:
-        tags = objects_list.page(page)
-    except (EmptyPage, InvalidPage):
-        tags = objects_list.page(objects_list.num_pages)
-
-    return render_to_response('tags.html', {
-    "tags" : tags,
-    "stag" : stag,
-    "tab_id" : sortby,
-    "keywords" : stag,
-    "context" : {
-    'is_paginated' : is_paginated,
-    'pages': objects_list.num_pages,
-    'page': page,
-    'has_previous': tags.has_previous(),
-    'has_next': tags.has_next(),
-    'previous': tags.previous_page_number(),
-    'next': tags.next_page_number(),
-    'base_url' : reverse('tags') + '?sort=%s&' % sortby
-    }
-    }, context_instance=RequestContext(request))
-
-def get_answer_sort_order(request):
-    view_dic = {"latest":"-added_at", "oldest":"added_at", "votes":"-score" }
-
-    view_id = request.GET.get('sort', request.session.get('answer_sort_order', None))
-
-    if view_id is None or not view_id in view_dic:
-        view_id = "votes"
+        if stag:
+            tags = tags.filter(name__icontains=stag)
 
-    if view_id != request.session.get('answer_sort_order', None):
-        request.session['answer_sort_order'] = view_id
-
-    return (view_id, view_dic[view_id])
+    return pagination.paginated(request, ('tags', TagPaginatorContext()), {
+        "tags" : tags,
+        "stag" : stag,
+        "keywords" : stag
+    })
 
 def update_question_view_times(request, question):
-    if not 'last_seen_in_question' in request.session:
-        request.session['last_seen_in_question'] = {}
+    last_seen_in_question = request.session.get('last_seen_in_question', {})
 
-    last_seen = request.session['last_seen_in_question'].get(question.id, None)
+    last_seen = last_seen_in_question.get(question.id, None)
 
-    if (not last_seen) or last_seen < question.last_activity_at:
+    if (not last_seen) or (last_seen < question.last_activity_at):
         QuestionViewAction(question, request.user, ip=request.META['REMOTE_ADDR']).save()
-        request.session['last_seen_in_question'][question.id] = datetime.datetime.now()
-
-    request.session['last_seen_in_question'][question.id] = datetime.datetime.now()
+        last_seen_in_question[question.id] = datetime.datetime.now()
+        request.session['last_seen_in_question'] = last_seen_in_question
 
-def match_question_slug(slug):
+def match_question_slug(id, slug):
     slug_words = slug.split('-')
     qs = Question.objects.filter(title__istartswith=slug_words[0])
 
@@ -221,37 +299,73 @@ def match_question_slug(slug):
 
     return None
 
-def question(request, id, slug):
+def answer_redirect(request, answer):
+    pc = AnswerPaginatorContext()
+
+    sort = pc.sort(request)
+
+    if sort == _('oldest'):
+        filter = Q(added_at__lt=answer.added_at)
+    elif sort == _('newest'):
+        filter = Q(added_at__gt=answer.added_at)
+    elif sort == _('votes'):
+        filter = Q(score__gt=answer.score) | Q(score=answer.score, added_at__lt=answer.added_at)
+    else:
+        raise Http404()
+
+    count = answer.question.answers.filter(Q(marked=True) | filter).exclude(state_string="(deleted)").count()
+    pagesize = pc.pagesize(request)
+
+    page = count / pagesize
+    
+    if count % pagesize:
+        page += 1
+        
+    if page == 0:
+        page = 1
+
+    return HttpResponseRedirect("%s?%s=%s&focusedAnswerId=%s#%s" % (
+        answer.question.get_absolute_url(), _('page'), page, answer.id, answer.id))
+
+@decorators.render("question.html", 'questions')
+def question(request, id, slug='', answer=None):
     try:
         question = Question.objects.get(id=id)
     except:
         if slug:
-            question = match_question_slug(slug)
+            question = match_question_slug(id, slug)
             if question is not None:
-                return HttpResponsePermanentRedirect(question.get_absolute_url())
+                return HttpResponseRedirect(question.get_absolute_url())
 
         raise Http404()
 
-    page = int(request.GET.get('page', 1))
-    view_id, order_by = get_answer_sort_order(request)
-
     if question.nis.deleted and not request.user.can_view_deleted_post(question):
         raise Http404
 
+    if request.GET.get('type', None) == 'rss':
+        return RssAnswerFeed(request, question, include_comments=request.GET.get('comments', None) == 'yes')(request)
+
+    if answer:
+        answer = get_object_or_404(Answer, id=answer)
+
+        if (question.nis.deleted and not request.user.can_view_deleted_post(question)) or answer.question != question:
+            raise Http404
+
+        if answer.marked:
+            return HttpResponsePermanentRedirect(question.get_absolute_url())
+
+        return answer_redirect(request, answer)
+
+    if settings.FORCE_SINGLE_URL and (slug != slugify(question.title)):
+        return HttpResponsePermanentRedirect(question.get_absolute_url())
+
     if request.POST:
-        answer_form = AnswerForm(question, request.POST)
+        answer_form = AnswerForm(request.POST, user=request.user)
     else:
-        answer_form = AnswerForm(question)
+        answer_form = AnswerForm(user=request.user)
 
     answers = request.user.get_visible_answers(question)
 
-    if answers is not None:
-        answers = [a for a in answers.order_by("-marked", order_by)
-                   if not a.nis.deleted or a.author == request.user]
-
-    objects_list = Paginator(answers, ANSWERS_PAGE_SIZE)
-    page_objects = objects_list.page(page)
-
     update_question_view_times(request, question)
 
     if request.user.is_authenticated():
@@ -261,26 +375,20 @@ def question(request, id, slug):
             subscription = False
     else:
         subscription = False
+    try:
+        focused_answer_id = int(request.GET.get("focusedAnswerId", None))
+    except TypeError, ValueError:
+        focused_answer_id = None
 
-    return render_to_response('question.html', {
+    return pagination.paginated(request, ('answers', AnswerPaginatorContext()), {
     "question" : question,
     "answer" : answer_form,
-    "answers" : page_objects.object_list,
-    "tab_id" : view_id,
+    "answers" : answers,
     "similar_questions" : question.get_related_questions(),
     "subscription": subscription,
-    "context" : {
-    'is_paginated' : True,
-    'pages': objects_list.num_pages,
-    'page': page,
-    'has_previous': page_objects.has_previous(),
-    'has_next': page_objects.has_next(),
-    'previous': page_objects.previous_page_number(),
-    'next': page_objects.next_page_number(),
-    'base_url' : request.path + '?sort=%s&' % view_id,
-    'extend_url' : "#sort-top"
-    }
-    }, context_instance=RequestContext(request))
+    "embed_youtube_videos" : settings.EMBED_YOUTUBE_VIDEOS,
+    "focused_answer_id" : focused_answer_id
+    })
 
 
 REVISION_TEMPLATE = template.loader.get_template('node/revision.html')
@@ -288,11 +396,10 @@ REVISION_TEMPLATE = template.loader.get_template('node/revision.html')
 def revisions(request, id):
     post = get_object_or_404(Node, id=id).leaf
     revisions = list(post.revisions.order_by('revised_at'))
-
     rev_ctx = []
 
     for i, revision in enumerate(revisions):
-        rev_ctx.append(dict(inst=revision, html=REVISION_TEMPLATE.render(template.Context({
+        rev_ctx.append(dict(inst=revision, html=template.loader.get_template('node/revision.html').render(template.Context({
         'title': revision.title,
         'html': revision.html,
         'tags': revision.tagname_list(),
@@ -308,6 +415,8 @@ def revisions(request, id):
         else:
             rev_ctx[i]['summary'] = revision.summary
 
+    rev_ctx.reverse()
+
     return render_to_response('revisions.html', {
     'post': post,
     'revisions': rev_ctx,