gremmie@1: """This file houses various core utility functions for GPP"""
bgneal@176: import datetime
bgneal@227: import re
gremmie@1: 
gremmie@1: import django.core.mail
gremmie@1: from django.contrib.sites.models import Site
gremmie@1: from django.conf import settings
gremmie@1: 
bgneal@181: import mailer
bgneal@181: 
gremmie@1: 
bgneal@252: def send_mail(subject, message, from_email, recipient_list,
bgneal@252:         fail_silently=False, auth_user=None, auth_password=None,
bgneal@252:         expedite=False):
gremmie@1:     """The main gpp send email function.
gremmie@1:     Use this function to send email from the site. It will obey debug settings and
bgneal@252:     log all emails. The expedite flag, when True, will bypass the mail queue.
gremmie@1:     """
gremmie@1: 
bgneal@252:     if settings.MAILER_ENQUEUE_MAIL and not expedite:
bgneal@180:         mailer.enqueue_mail(subject, message, from_email, recipient_list)
bgneal@180:     elif settings.GPP_SEND_EMAIL:
gremmie@1:         django.core.mail.send_mail(subject, message, from_email, recipient_list,
gremmie@1:                 fail_silently, auth_user, auth_password)
gremmie@1: 
bgneal@38:     import logging
bgneal@38:     logging.debug('EMAIL:\nFrom: %s\nTo: %s\nSubject: %s\nMessage:\n%s' %
bgneal@38:             (from_email, str(recipient_list), subject, message))
gremmie@1: 
gremmie@1: 
gremmie@1: def email_admins(subject, message):
gremmie@1:     """Emails the site admins. Goes through the site send_mail function."""
gremmie@1:     site = Site.objects.get_current()
gremmie@1:     subject = '[%s] %s' % (site.name, subject)
gremmie@1:     send_mail(subject, 
gremmie@1:             message, 
gremmie@1:             '%s@%s' % (settings.GPP_NO_REPLY_EMAIL, site.domain),
gremmie@1:             [mail_tuple[1] for mail_tuple in settings.ADMINS])
gremmie@1: 
gremmie@1: 
gremmie@1: def email_managers(subject, message):
gremmie@1:     """Emails the site managers. Goes through the site send_mail function."""
gremmie@1:     site = Site.objects.get_current()
gremmie@1:     subject = '[%s] %s' % (site.name, subject)
gremmie@1:     send_mail(subject, 
gremmie@1:             msg, 
gremmie@1:             '%s@%s' % (settings.GPP_NO_REPLY_EMAIL, site.domain),
gremmie@1:             [mail_tuple[1] for mail_tuple in settings.MANAGERS])
gremmie@1: 
gremmie@1: 
gremmie@1: def get_full_name(user):
gremmie@1:     """Returns the user's full name if available, otherwise falls back
gremmie@1:     to the username."""
gremmie@1:     full_name = user.get_full_name()
gremmie@1:     if full_name:
gremmie@1:         return full_name
gremmie@1:     return user.username
bgneal@9: 
bgneal@176: 
bgneal@176: BASE_YEAR = 2010
bgneal@176: 
bgneal@176: def copyright_str():
bgneal@176:     curr_year = datetime.datetime.now().year
bgneal@176:     if curr_year == BASE_YEAR:
bgneal@176:         year_range = str(BASE_YEAR)
bgneal@176:     else:
bgneal@176:         year_range = "%d - %d" % (BASE_YEAR, curr_year)
bgneal@176: 
bgneal@176:     return 'Copyright (C) %s, SurfGuitar101.com' % year_range
bgneal@227: 
bgneal@227: 
bgneal@227: IP_PAT = re.compile('(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})')
bgneal@227: 
bgneal@227: def get_ip(request):
bgneal@227:     """Returns the IP from the request or None if it cannot be retrieved."""
bgneal@227:     ip = request.META.get('HTTP_X_FORWARDED_FOR',
bgneal@227:             request.META.get('REMOTE_ADDR'))
bgneal@227: 
bgneal@227:     if ip:
bgneal@227:         match = IP_PAT.match(ip)
bgneal@227:         ip = match.group(1) if match else None
bgneal@227: 
bgneal@227:     return ip
bgneal@241: 
bgneal@241: 
bgneal@241: def get_page(qdict):
bgneal@241:     """Attempts to retrieve the value for "page" from the given query dict and
bgneal@241:     return it as an integer. If the key cannot be found or converted to an
bgneal@241:     integer, 1 is returned.
bgneal@241:     """
bgneal@241:     n = qdict.get('page', 1)
bgneal@241:     try:
bgneal@241:         n = int(n)
bgneal@241:     except ValueError:
bgneal@241:         n = 1
bgneal@241:     return n