forum/templatetags/extra_tags.py

   1 import time
   2 import os
   3 import posixpath
   4 import datetime
   5 import math
   6 import re
   7 import logging
   8 import random
   9 from django import template
  10 from django.utils.encoding import smart_unicode, force_unicode, smart_str
  11 from django.utils.safestring import mark_safe
  12 from django.utils import dateformat
  13 from forum.models import Question, Answer, QuestionRevision, AnswerRevision, NodeRevision
  14 from django.utils.translation import ugettext as _
  15 from django.utils.translation import ungettext
  16 from django.utils import simplejson
  17 from forum import settings
  18 from django.template.defaulttags import url as default_url
  19 from forum import skins
  20 from forum.utils import html
  21 from extra_filters import decorated_int
  22 from django.core.urlresolvers import reverse
  23
  24 register = template.Library()
  25
  26 GRAVATAR_TEMPLATE = ('<img class="gravatar" width="%(size)s" height="%(size)s" '
  27 'src="https://secure.gravatar.com/avatar/%(gravatar_hash)s'
  28 '?s=%(size)s&amp;d=%(default)s&amp;r=%(rating)s" '
  29 'alt="%(username)s\'s gravatar image" />')
  30
  31 @register.simple_tag
  32 def gravatar(user, size):
  33     try:
  34         gravatar = user['gravatar']
  35         username = user['username']
  36     except (TypeError, AttributeError, KeyError):
  37         gravatar = user.gravatar
  38         username = user.username
  39     return mark_safe(GRAVATAR_TEMPLATE % {
  40     'size': size,
  41     'gravatar_hash': gravatar,
  42     'default': settings.GRAVATAR_DEFAULT_IMAGE,
  43     'rating': settings.GRAVATAR_ALLOWED_RATING,
  44     'username': template.defaultfilters.urlencode(username),
  45     })
  46
  47
  48 @register.simple_tag
  49 def get_score_badge(user):
  50     if user.is_suspended():
  51         return _("(suspended)")
  52
  53     repstr = decorated_int(user.reputation, "")
  54
  55     BADGE_TEMPLATE = '<span class="score" title="%(reputation)s %(reputationword)s">%(repstr)s</span>'
  56     if user.gold > 0 :
  57         BADGE_TEMPLATE = '%s%s' % (BADGE_TEMPLATE, '<span title="%(gold)s %(badgesword)s">'
  58         '<span class="badge1">&#9679;</span>'
  59         '<span class="badgecount">%(gold)s</span>'
  60         '</span>')
  61     if user.silver > 0:
  62         BADGE_TEMPLATE = '%s%s' % (BADGE_TEMPLATE, '<span title="%(silver)s %(badgesword)s">'
  63         '<span class="silver">&#9679;</span>'
  64         '<span class="badgecount">%(silver)s</span>'
  65         '</span>')
  66     if user.bronze > 0:
  67         BADGE_TEMPLATE = '%s%s' % (BADGE_TEMPLATE, '<span title="%(bronze)s %(badgesword)s">'
  68         '<span class="bronze">&#9679;</span>'
  69         '<span class="badgecount">%(bronze)s</span>'
  70         '</span>')
  71     BADGE_TEMPLATE = smart_unicode(BADGE_TEMPLATE, encoding='utf-8', strings_only=False, errors='strict')
  72     return mark_safe(BADGE_TEMPLATE % {
  73     'reputation' : user.reputation,
  74     'repstr': repstr,
  75     'gold' : user.gold,
  76     'silver' : user.silver,
  77     'bronze' : user.bronze,
  78     'badgesword' : _('badges'),
  79     'reputationword' : _('reputation points'),
  80     })
  81
  82 # Usage: {% get_accept_rate node.author %}
  83 @register.simple_tag
  84 def get_accept_rate(user):
  85     # We get the number of all user's answers.
  86     total_answers_count = Answer.objects.filter(author=user).count()
  87
  88     # We get the number of the user's accepted answers.
  89     accepted_answers_count = Answer.objects.filter(author=user, state_string__contains="(accepted)").count()
  90
  91     # In order to represent the accept rate in percentages we divide the number of the accepted answers to the
  92     # total answers count and make a hundred multiplication.
  93     try:
  94         accept_rate = (float(accepted_answers_count) / float(total_answers_count) * 100)
  95     except ZeroDivisionError:
  96         accept_rate = 0
  97
  98     # If the user has more than one accepted answers the rate title will be in plural.
  99     if accepted_answers_count > 1:
 100         accept_rate_number_title = _('%(user)s has %(count)d accepted answers') % {
 101             'user' :  smart_unicode(user.username),
 102             'count' : int(accepted_answers_count)
 103         }
 104     # If the user has one accepted answer we'll be using singular.
 105     elif accepted_answers_count == 1:
 106         accept_rate_number_title = _('%s has one accepted answer') % user.username
 107     # This are the only options. Otherwise there are no accepted answers at all.
 108     else:
 109         accept_rate_number_title = _('%s has no accepted answers') % smart_unicode(user.username)
 110
 111     html_output = """
 112     <span title="%(accept_rate_title)s" class="accept_rate">%(accept_rate_label)s:</span>
 113     <span title="%(accept_rate_number_title)s">%(accept_rate)d&#37;</span>
 114     """ % {
 115         'accept_rate_label' : _('accept rate'),
 116         'accept_rate_title' : _('Rate of the user\'s accepted answers'),
 117         'accept_rate' : int(accept_rate),
 118         'accept_rate_number_title' : u'%s' % accept_rate_number_title,
 119     }
 120
 121     return mark_safe(html_output)
 122
 123 @register.simple_tag
 124 def get_age(birthday):
 125     current_time = datetime.datetime(*time.localtime()[0:6])
 126     year = birthday.year
 127     month = birthday.month
 128     day = birthday.day
 129     diff = current_time - datetime.datetime(year, month, day, 0, 0, 0)
 130     return diff.days / 365
 131
 132 @register.simple_tag
 133 def diff_date(date, limen=2):
 134     if not date:
 135         return _('unknown')
 136
 137     now = datetime.datetime.now()
 138     diff = now - date
 139     days = diff.days
 140     hours = int(diff.seconds/3600)
 141     minutes = int(diff.seconds/60)
 142
 143     if date.year != now.year:
 144         return dateformat.format(date, 'd M \'y, H:i')
 145     elif days > 2:
 146         return dateformat.format(date, 'd M, H:i')
 147
 148     elif days == 2:
 149         return _('2 days ago')
 150     elif days == 1:
 151         return _('yesterday')
 152     elif minutes >= 60:
 153         return ungettext('%(hr)d ' + _("hour ago"), '%(hr)d ' + _("hours ago"), hours) % {'hr':hours}
 154     elif diff.seconds >= 60:
 155         return ungettext('%(min)d ' + _("min ago"), '%(min)d ' + _("mins ago"), minutes) % {'min':minutes}
 156     else:
 157         return ungettext('%(sec)d ' + _("sec ago"), '%(sec)d ' + _("secs ago"), diff.seconds) % {'sec':diff.seconds}
 158
 159 @register.simple_tag
 160 def media(url):
 161     url = skins.find_media_source(url)
 162     if url:
 163         # Create the URL prefix.
 164         url_prefix = settings.FORCE_SCRIPT_NAME + '/m/'
 165
 166         # Make sure any duplicate forward slashes are replaced with a single
 167         # forward slash.
 168         url_prefix = re.sub("/+", "/", url_prefix)
 169
 170         url = url_prefix + url
 171         return url
 172
 173 class ItemSeparatorNode(template.Node):
 174     def __init__(self, separator):
 175         sep = separator.strip()
 176         if sep[0] == sep[-1] and sep[0] in ('\'', '"'):
 177             sep = sep[1:-1]
 178         else:
 179             raise template.TemplateSyntaxError('separator in joinitems tag must be quoted')
 180         self.content = sep
 181
 182     def render(self, context):
 183         return self.content
 184
 185 class BlockMediaUrlNode(template.Node):
 186     def __init__(self, nodelist):
 187         self.items = nodelist
 188
 189     def render(self, context):
 190         prefix = settings.APP_URL + 'm/'
 191         url = ''
 192         if self.items:
 193             url += '/'
 194         for item in self.items:
 195             url += item.render(context)
 196
 197         url = skins.find_media_source(url)
 198         url = prefix + url
 199         out = url
 200         return out.replace(' ', '')
 201
 202 @register.tag(name='blockmedia')
 203 def blockmedia(parser, token):
 204     try:
 205         tagname = token.split_contents()
 206     except ValueError:
 207         raise template.TemplateSyntaxError("blockmedia tag does not use arguments")
 208     nodelist = []
 209     while True:
 210         nodelist.append(parser.parse(('endblockmedia')))
 211         next = parser.next_token()
 212         if next.contents == 'endblockmedia':
 213             break
 214     return BlockMediaUrlNode(nodelist)
 215
 216
 217 @register.simple_tag
 218 def fullmedia(url):
 219     domain = settings.APP_BASE_URL
 220     #protocol = getattr(settings, "PROTOCOL", "http")
 221     path = media(url)
 222     return "%s%s" % (domain, path)
 223
 224
 225 class SimpleVarNode(template.Node):
 226     def __init__(self, name, value):
 227         self.name = name
 228         self.value = template.Variable(value)
 229
 230     def render(self, context):
 231         context[self.name] = self.value.resolve(context)
 232         return ''
 233
 234 class BlockVarNode(template.Node):
 235     def __init__(self, name, block):
 236         self.name = name
 237         self.block = block
 238
 239     def render(self, context):
 240         source = self.block.render(context)
 241         context[self.name] = source.strip()
 242         return ''
 243
 244
 245 @register.tag(name='var')
 246 def do_var(parser, token):
 247     tokens = token.split_contents()[1:]
 248
 249     if not len(tokens) or not re.match('^\w+$', tokens[0]):
 250         raise template.TemplateSyntaxError("Expected variable name")
 251
 252     if len(tokens) == 1:
 253         nodelist = parser.parse(('endvar',))
 254         parser.delete_first_token()
 255         return BlockVarNode(tokens[0], nodelist)
 256     elif len(tokens) == 3:
 257         return SimpleVarNode(tokens[0], tokens[2])
 258
 259     raise template.TemplateSyntaxError("Invalid number of arguments")
 260
 261 class DeclareNode(template.Node):
 262     dec_re = re.compile('^\s*(\w+)\s*(:?=)\s*(.*)$')
 263
 264     def __init__(self, block):
 265         self.block = block
 266
 267     def render(self, context):
 268         source = self.block.render(context)
 269
 270         for line in source.splitlines():
 271             m = self.dec_re.search(line)
 272             if m:
 273                 clist = list(context)
 274                 clist.reverse()
 275                 d = {}
 276                 d['_'] = _
 277                 d['os'] = os
 278                 d['html'] = html
 279                 d['reverse'] = reverse
 280                 d['smart_str'] = smart_str
 281                 d['smart_unicode'] = smart_unicode
 282                 d['force_unicode'] = force_unicode
 283                 for c in clist:
 284                     d.update(c)
 285                 try:
 286                     command = m.group(3).strip()
 287                     context[m.group(1).strip()] = eval(command, d)
 288                 except Exception, e:
 289                     logging.error("Error in declare tag, when evaluating: %s" % m.group(3).strip())
 290                     raise
 291         return ''
 292
 293 @register.tag(name='declare')
 294 def do_declare(parser, token):
 295     nodelist = parser.parse(('enddeclare',))
 296     parser.delete_first_token()
 297     return DeclareNode(nodelist)
 298
 299 # Usage: {% random 1 999 %}
 300 # Generates random number in the template
 301 class RandomNumberNode(template.Node):
 302     # We get the limiting numbers
 303     def __init__(self, int_from, int_to):
 304         self.int_from = int(int_from)
 305         self.int_to = int(int_to)
 306
 307     # We generate the random number using the standard python interface
 308     def render(self, context):
 309         return str(random.randint(self.int_from, self.int_to))
 310
 311 @register.tag(name="random")
 312 def random_number(parser, token):
 313     # Try to get the limiting numbers from the token
 314     try:
 315         tag_name, int_from, int_to = token.split_contents()
 316     except ValueError:
 317         # If we had no success -- raise an exception
 318         raise template.TemplateSyntaxError, "%r tag requires exactly two arguments" % token.contents.split()[0]
 319
 320     # Call the random Node
 321     return RandomNumberNode(int_from, int_to)