annotate gpp/core/functions.py @ 227:423c39ee44e0

Rework the who's online middleware and template tag for #87.
author Brian Neal <bgneal@gmail.com>
date Tue, 06 Jul 2010 03:02:20 +0000
parents 500e5875a306
children 27bee3ac85e6
rev   line source
gremmie@1 1 """This file houses various core utility functions for GPP"""
bgneal@176 2 import datetime
bgneal@227 3 import re
gremmie@1 4
gremmie@1 5 import django.core.mail
gremmie@1 6 from django.contrib.sites.models import Site
gremmie@1 7 from django.conf import settings
gremmie@1 8
bgneal@181 9 import mailer
bgneal@181 10
gremmie@1 11
gremmie@1 12 def send_mail(subject, message, from_email, recipient_list,
gremmie@1 13 fail_silently = False, auth_user = None, auth_password = None):
gremmie@1 14 """The main gpp send email function.
gremmie@1 15 Use this function to send email from the site. It will obey debug settings and
gremmie@1 16 log all emails.
gremmie@1 17 """
gremmie@1 18
bgneal@180 19 if settings.MAILER_ENQUEUE_MAIL:
bgneal@180 20 mailer.enqueue_mail(subject, message, from_email, recipient_list)
bgneal@180 21 elif settings.GPP_SEND_EMAIL:
gremmie@1 22 django.core.mail.send_mail(subject, message, from_email, recipient_list,
gremmie@1 23 fail_silently, auth_user, auth_password)
gremmie@1 24
bgneal@38 25 import logging
bgneal@38 26 logging.debug('EMAIL:\nFrom: %s\nTo: %s\nSubject: %s\nMessage:\n%s' %
bgneal@38 27 (from_email, str(recipient_list), subject, message))
gremmie@1 28
gremmie@1 29
gremmie@1 30 def email_admins(subject, message):
gremmie@1 31 """Emails the site admins. Goes through the site send_mail function."""
gremmie@1 32 site = Site.objects.get_current()
gremmie@1 33 subject = '[%s] %s' % (site.name, subject)
gremmie@1 34 send_mail(subject,
gremmie@1 35 message,
gremmie@1 36 '%s@%s' % (settings.GPP_NO_REPLY_EMAIL, site.domain),
gremmie@1 37 [mail_tuple[1] for mail_tuple in settings.ADMINS])
gremmie@1 38
gremmie@1 39
gremmie@1 40 def email_managers(subject, message):
gremmie@1 41 """Emails the site managers. Goes through the site send_mail function."""
gremmie@1 42 site = Site.objects.get_current()
gremmie@1 43 subject = '[%s] %s' % (site.name, subject)
gremmie@1 44 send_mail(subject,
gremmie@1 45 msg,
gremmie@1 46 '%s@%s' % (settings.GPP_NO_REPLY_EMAIL, site.domain),
gremmie@1 47 [mail_tuple[1] for mail_tuple in settings.MANAGERS])
gremmie@1 48
gremmie@1 49
gremmie@1 50 def get_full_name(user):
gremmie@1 51 """Returns the user's full name if available, otherwise falls back
gremmie@1 52 to the username."""
gremmie@1 53 full_name = user.get_full_name()
gremmie@1 54 if full_name:
gremmie@1 55 return full_name
gremmie@1 56 return user.username
bgneal@9 57
bgneal@176 58
bgneal@176 59 BASE_YEAR = 2010
bgneal@176 60
bgneal@176 61 def copyright_str():
bgneal@176 62 curr_year = datetime.datetime.now().year
bgneal@176 63 if curr_year == BASE_YEAR:
bgneal@176 64 year_range = str(BASE_YEAR)
bgneal@176 65 else:
bgneal@176 66 year_range = "%d - %d" % (BASE_YEAR, curr_year)
bgneal@176 67
bgneal@176 68 return 'Copyright (C) %s, SurfGuitar101.com' % year_range
bgneal@227 69
bgneal@227 70
bgneal@227 71 IP_PAT = re.compile('(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})')
bgneal@227 72
bgneal@227 73 def get_ip(request):
bgneal@227 74 """Returns the IP from the request or None if it cannot be retrieved."""
bgneal@227 75 ip = request.META.get('HTTP_X_FORWARDED_FOR',
bgneal@227 76 request.META.get('REMOTE_ADDR'))
bgneal@227 77
bgneal@227 78 if ip:
bgneal@227 79 match = IP_PAT.match(ip)
bgneal@227 80 ip = match.group(1) if match else None
bgneal@227 81
bgneal@227 82 return ip