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 @register.simple_tag
 174 def get_tag_font_size(tag):
 175     occurrences_of_current_tag = tag.used_count
 176
 177     # Occurrences count settings
 178     min_occurs = int(settings.TAGS_CLOUD_MIN_OCCURS)
 179     max_occurs = int(settings.TAGS_CLOUD_MAX_OCCURS)
 180
 181     # Font size settings
 182     min_font_size = int(settings.TAGS_CLOUD_MIN_FONT_SIZE)
 183     max_font_size = int(settings.TAGS_CLOUD_MAX_FONT_SIZE)
 184
 185     # Calculate the font size of the tag according to the occurrences count
 186     weight = (math.log(occurrences_of_current_tag)-math.log(min_occurs))/(math.log(max_occurs)-math.log(min_occurs))
 187     font_size_of_current_tag = min_font_size + int(math.floor((max_font_size-min_font_size)*weight))
 188
 189     return font_size_of_current_tag
 190
 191 class ItemSeparatorNode(template.Node):
 192     def __init__(self, separator):
 193         sep = separator.strip()
 194         if sep[0] == sep[-1] and sep[0] in ('\'', '"'):
 195             sep = sep[1:-1]
 196         else:
 197             raise template.TemplateSyntaxError('separator in joinitems tag must be quoted')
 198         self.content = sep
 199
 200     def render(self, context):
 201         return self.content
 202
 203 class BlockMediaUrlNode(template.Node):
 204     def __init__(self, nodelist):
 205         self.items = nodelist
 206
 207     def render(self, context):
 208         prefix = settings.APP_URL + 'm/'
 209         url = ''
 210         if self.items:
 211             url += '/'
 212         for item in self.items:
 213             url += item.render(context)
 214
 215         url = skins.find_media_source(url)
 216         url = prefix + url
 217         out = url
 218         return out.replace(' ', '')
 219
 220 @register.tag(name='blockmedia')
 221 def blockmedia(parser, token):
 222     try:
 223         tagname = token.split_contents()
 224     except ValueError:
 225         raise template.TemplateSyntaxError("blockmedia tag does not use arguments")
 226     nodelist = []
 227     while True:
 228         nodelist.append(parser.parse(('endblockmedia')))
 229         next = parser.next_token()
 230         if next.contents == 'endblockmedia':
 231             break
 232     return BlockMediaUrlNode(nodelist)
 233
 234
 235 @register.simple_tag
 236 def fullmedia(url):
 237     domain = settings.APP_BASE_URL
 238     #protocol = getattr(settings, "PROTOCOL", "http")
 239     path = media(url)
 240     return "%s%s" % (domain, path)
 241
 242
 243 class SimpleVarNode(template.Node):
 244     def __init__(self, name, value):
 245         self.name = name
 246         self.value = template.Variable(value)
 247
 248     def render(self, context):
 249         context[self.name] = self.value.resolve(context)
 250         return ''
 251
 252 class BlockVarNode(template.Node):
 253     def __init__(self, name, block):
 254         self.name = name
 255         self.block = block
 256
 257     def render(self, context):
 258         source = self.block.render(context)
 259         context[self.name] = source.strip()
 260         return ''
 261
 262
 263 @register.tag(name='var')
 264 def do_var(parser, token):
 265     tokens = token.split_contents()[1:]
 266
 267     if not len(tokens) or not re.match('^\w+$', tokens[0]):
 268         raise template.TemplateSyntaxError("Expected variable name")
 269
 270     if len(tokens) == 1:
 271         nodelist = parser.parse(('endvar',))
 272         parser.delete_first_token()
 273         return BlockVarNode(tokens[0], nodelist)
 274     elif len(tokens) == 3:
 275         return SimpleVarNode(tokens[0], tokens[2])
 276
 277     raise template.TemplateSyntaxError("Invalid number of arguments")
 278
 279 class DeclareNode(template.Node):
 280     dec_re = re.compile('^\s*(\w+)\s*(:?=)\s*(.*)$')
 281
 282     def __init__(self, block):
 283         self.block = block
 284
 285     def render(self, context):
 286         source = self.block.render(context)
 287
 288         for line in source.splitlines():
 289             m = self.dec_re.search(line)
 290             if m:
 291                 clist = list(context)
 292                 clist.reverse()
 293                 d = {}
 294                 d['_'] = _
 295                 d['os'] = os
 296                 d['html'] = html
 297                 d['reverse'] = reverse
 298                 d['settings'] = settings
 299                 d['smart_str'] = smart_str
 300                 d['smart_unicode'] = smart_unicode
 301                 d['force_unicode'] = force_unicode
 302                 for c in clist:
 303                     d.update(c)
 304                 try:
 305                     command = m.group(3).strip()
 306                     context[m.group(1).strip()] = eval(command, d)
 307                 except Exception, e:
 308                     logging.error("Error in declare tag, when evaluating: %s" % m.group(3).strip())
 309                     raise
 310         return ''
 311
 312 @register.tag(name='declare')
 313 def do_declare(parser, token):
 314     nodelist = parser.parse(('enddeclare',))
 315     parser.delete_first_token()
 316     return DeclareNode(nodelist)
 317
 318 # Usage: {% random 1 999 %}
 319 # Generates random number in the template
 320 class RandomNumberNode(template.Node):
 321     # We get the limiting numbers
 322     def __init__(self, int_from, int_to):
 323         self.int_from = int(int_from)
 324         self.int_to = int(int_to)
 325
 326     # We generate the random number using the standard python interface
 327     def render(self, context):
 328         return str(random.randint(self.int_from, self.int_to))
 329
 330 @register.tag(name="random")
 331 def random_number(parser, token):
 332     # Try to get the limiting numbers from the token
 333     try:
 334         tag_name, int_from, int_to = token.split_contents()
 335     except ValueError:
 336         # If we had no success -- raise an exception
 337         raise template.TemplateSyntaxError, "%r tag requires exactly two arguments" % token.contents.split()[0]
 338
 339     # Call the random Node
 340     return RandomNumberNode(int_from, int_to)