prizemail.py

import datetime
import itertools

from django.contrib.auth import get_user_model
from django.db.models import Q, F
from django.urls import reverse

AuthUser = get_user_model()

import post_office.mail
import post_office.models

from django.conf import settings

from tracker.models import *
import tracker.viewutil as viewutil

def get_event_default_sender_email(event):
    if event and event.prizecoordinator:
        return event.prizecoordinator.email
    else:
        return viewutil.get_default_email_from_user()

def event_sender_replyto_defaults(event, sender=None, replyTo=None):
    if sender == None:
        sender = get_event_default_sender_email(event)
    if replyTo == None:
        replyTo = sender
    return sender, replyTo

def prize_winners_with_email_pending(event):
    return PrizeWinner.objects.filter(prize__event=event, pendingcount__gt=0, emailsent=False)


def default_prize_winner_template_name():
    return getattr(settings, 'PRIZE_WINNER_EMAIL_TEMPLATE_NAME', 'default_prize_winner_template')


def default_prize_winner_template():
    return post_office.models.EmailTemplate(
        name=default_prize_winner_template_name(),
        subject='{% if multi %}You won some prizes at {{ event.name }}{% else %}You won a prize at {{ event.name }}{% endif %}',
        description="""A basic template for automailing prize winners. DO NOT USE THIS TEMPLATE. Copy the contents and modify it to suit your needs.

The variables that will be defined are:
event -- the event for the set of prizes
winner -- the winner donor object
prizes -- the list of prizes this donor has won
accept_deadline -- the date by which we need a response or we will re-roll
prize_wins -- the list of PrizeWinner objects for this donor (if you need the additional information)
requires_shipping -- true if any of the prizes require shipping information
multi -- true if there are multiple prizes, false if there is only one (used for plurality branches)
prize_count -- the number of prizes won
reply_address -- the reply address specified on the form (will be overridden if the event has a prize coordinator)
""",
        html_content="""Hello {{ winner.contact_name }},

    <p>
    Congratulations, you were selected as the winner of the following prize{% if multi %}s{% endif %} during {{ event.name }}:
    <ul>
{% for prizeWin in prize_wins %}
    <li><a href="{{ prizeWin.make_winner_url }}">{{ prizeWin.prize.name }}</a>
    {% if prizeWin.prize.description %}
        <p>
        Description: {{ prizeWin.prize.description }}
        </p>
    {% endif %} 
    </li>
{% endfor %}
    </ul>
    </p>
    
    <p>
    To claim {% if multi %}any of your prizes{% else %}your prize{% endif %}, click the link on the prize name, and submit the form on the page.
    </p>

    {% if requires_shipping %}
    <p>
    You will also be asked to fill in your mailing address information{% if multi %} on at least one of your prizes{% endif %}. Note that we may already have it on file from PayPal, or from a previous event, in which case we ask you to simply confirm that the information is correct.
    </p>
    {% endif %}

    <p>
    You must accept/deny your prize{{ prize_count|pluralize }} on or before {{ accept_deadline }} (anywhere on earth), after which it will be automatically re-rolled. 
    If you do simply want to decline receiving your prize, we would still ask you do so promptly so we can re-roll to another winner it as quickly as possible.
    </p>
    
    <p> 
    If you have any questions, please contact me at {{ reply_address }}. 
    </p>
    
    <p>
    Once again we would like to thank you for your contribution in helping to make our event a success.
    </p>

Sincerely,
- INSERT CORRESPONDANCE NAME HERE
""")


def automail_prize_winners(event, prizeWinners, mailTemplate, sender=None, replyTo=None, domain=settings.DOMAIN, verbosity=0, dry_run=False):
    sender, replyTo = event_sender_replyto_defaults(event, sender, replyTo)

    winnerDict = {}
    for prizeWinner in prizeWinners:
        if prizeWinner.winner.id in list(winnerDict.keys()):
            winList = winnerDict[prizeWinner.winner.id]
        else:
            winList = []
            winnerDict[prizeWinner.winner.id] = winList
        winList.append(prizeWinner)
    for winnerk, prizesWon in winnerDict.items():
        winner = prizesWon[0].winner
        prizesList = []
        minAcceptDeadline = min(itertools.chain([x for x in [pw.accept_deadline_date() for pw in prizesWon] if x != None], [datetime.date.max]))

        for prizeWon in prizesWon:
            prizesList.append(prizeWon.prize)
        formatContext = {
            'event': event,
            'winner': winner,
            'prize_wins': prizesWon,
            'multi': len(prizesWon) > 1,
            'prize_count': len(prizesWon),
            'reply_address': replyTo,
            'accept_deadline': minAcceptDeadline,
        }

        if not dry_run:
            post_office.mail.send(recipients=[winner.email], sender=sender,
                              template=mailTemplate, context=formatContext, headers={'Reply-to': replyTo})

        message = 'Mailed donor {0} for prize wins {1}'.format(winner.id, list([pw.id for pw in prizesWon]))

        if verbosity > 0:
            print(message)
        if not dry_run:
            viewutil.tracker_log('prize', message, event)
            for prizeWon in prizesWon:
                prizeWon.emailsent = True
                prizeWon.save()


def prizes_with_submission_email_pending(event):
    return Prize.objects.filter(Q(state='ACCEPTED') | Q(state='DENIED'), acceptemailsent=False, event=event)

def default_activate_prize_handlers_template_name():
    return getattr(settings, 'ACTIVATE_PRIZE_HANDLER_EMAIL_TEMPLATE_NAME', 'default_activate_prize_handler_template')

def default_activate_prize_handlers_template():
    return post_office.models.EmailTemplate(
        name=default_activate_prize_handlers_template_name(),
        subject='{{ event.name }} Prize Contributor Account Activation',
        description="""A template to automail prize handlers to activate their account on the site, such that they can deal with prize accept/shipping stuff. Copy the contents and modify it to suit your needs.

The variables that will be defined are:
event -- the event object
handler -- the User objects of the person responsible for shipping
register_url -- the user registration URL (i.e. /user/register)
prize_set -- the set of prizes they are responsible
prize_count -- the number of prizes in the set
reply_address -- the address to reply to
""",
        html_content="""Hello {{ handler.username }}

    <p>
    We have in our records that you are responsible for shipping the following {{ event.name }} prize{{ prize_count|pluralize }}:
    <ul>
    {% for prize in prize_set %}
        <li>{{ prize.name }}</li>
    {% endfor %}
    </ul>
    </p>

    <p>
    In order to manage communication and shipping with potential winners, please activate your account by following this <a href="{{ register_url }}">link</a>, and entering <b>this</b> e-mail address ({{ handler.email }}) into the form. You will be then sent instructions on how to activate your account and set your password.
    </p>

    <p>
    You will receive further instructions once someone has accepted one of your prizes. If you have any questions, please contact me at {{ reply_address }}.
    </p>

    Sincierely,
        - The Staff
""")


def automail_inactive_prize_handlers(event, inactiveUsers, mailTemplate, sender=None, replyTo=None, domain=settings.DOMAIN, verbosity=0, dry_run=False):
    sender, replyTo = event_sender_replyto_defaults(event, sender, replyTo)
    for inactiveUser in inactiveUsers:
        eventPrizes = list(Prize.objects.filter(handler=inactiveUser, event=event, state='ACCEPTED'))
        formatContext = {
            'event': event,
            'handler': inactiveUser,
            'register_url': domain + reverse('tracker:register'),
            'prize_set': eventPrizes,
            'prize_count': len(eventPrizes),
            'reply_address': replyTo,
        }
        if not dry_run:
            post_office.mail.send(recipients=[inactiveUser.email], sender=sender,
                template=mailTemplate, context=formatContext, headers={'Reply-to': replyTo})
        message = 'Mailed prize handler {0} (#{1}) for account activation'.format(inactiveUser, inactiveUser.id)
        if verbosity > 0:
            print(message)
        if not dry_run:
            viewutil.tracker_log('prize', message, event)

def get_event_inactive_prize_handlers(event):
    return AuthUser.objects.filter(is_active=False, prize__event=event, prize__state='ACCEPTED').distinct()

def default_prize_contributor_template_name():
    return getattr(settings, 'PRIZE_CONTRIBUTOR_EMAIL_TEMPLATE_NAME', 'default_prize_contributor_template')


def default_prize_contributor_template():
    return post_office.models.EmailTemplate(
        name=default_prize_contributor_template_name(),
        subject='{{ event.name }} Prize Contributor Notification',
        description="""A basic template for automailing back prize accept/reject notifications. DO NOT USE THIS TEMPLATE. Copy the contents and modify it to suit your needs.

The variables that will be defined are:
event -- the event object.
handler -- the User object of the person responsible for shipping
accepted_prizes -- A list of all accepted prizes.
denied_prizes  -- A list of all denied prizes.
reply_address -- The address to reply to on this e-mail
user_index_url -- the user index url (i.e. /user/index)
""",
        html_content="""Hello {{ handler.username }},

    <p>
    Thank you for your prize submissiom for {{ event.name }}.
    </p>

    {% if accepted_prizes %}
    <p>
    We are pleased to let you know that the following prize(s) have been accepted for the event:
    <ul>
    {% for prize in accepted_prizes %}
        <li>{{ prize.name }}
        {% if prize.reviewnotes %}
        <p>
        {{ prize.reviewnotes }}
        </p>
        {% endif %}
        </li>
    {% endfor %}
    </ul>

    To view the status of these prizes, please follow this link: {{user_index_url}} (note: you may need to log in first).
    </p>
    {% endif %}

    {% if denied_prizes %}
    <p>
        Unfortunately, we were unable to accept the following prize(s):
        <ul>
        {% for prize in denied_prizes %}
            <li>{{ prize.name }}
            {% if prize.reviewnotes %}
            <p>
            {{ prize.reviewnotes }}
            </p>
            {% endif %}
            </li>
        {% endfor %}
        </ul>
    </p>
    {% endif %}

    {% if accepted_prizes %}
    On behalf of the entire GamesDoneQuick staff, thank you for your generosity in support of our event.
    {% endif %}
    
    <p> 
    If you have any questions, please contact me at {{ reply_address }}. 
    </p>

    - The GamesDoneQuick staff
""")


def automail_prize_contributors(event, prizes, mailTemplate, domain=settings.DOMAIN, sender=None, replyTo=None, verbosity=0, dry_run=False):
    sender, replyTo = event_sender_replyto_defaults(event, sender, replyTo)

    handlerDict = {}
    for prize in prizes:
        if prize.handler:
            prizeList = handlerDict.setdefault(prize.handler, [])
            prizeList.append(prize)
    for handler, prizeList in handlerDict.items():
        denied = list([prize for prize in prizeList if prize.state == 'DENIED'])
        formatContext = {
            'user_index_url': domain + reverse('tracker:user_index'),
            'event': event,
            'handler': handler,
            'accepted_prizes': list([prize for prize in prizeList if prize.state == 'ACCEPTED']),
            'denied_prizes': list([prize for prize in prizeList if prize.state == 'DENIED']),
            'reply_address': replyTo,
        }
        if not dry_run:
            post_office.mail.send(recipients=[handler.email], sender=sender,
                template=mailTemplate, context=formatContext, headers={'Reply-to': replyTo})
        message = 'Mailed prize handler {0} for prizes {1}'.format(handler.id, list([p.id for p in prizeList]))
        if verbosity > 0:
            print(message)
        if not dry_run:
            viewutil.tracker_log('prize', message, event)
            for prize in prizeList:
                prize.acceptemailsent = True
                prize.save()


def prizes_with_winner_accept_email_pending(event):
    return PrizeWinner.objects.filter(Q(prize__event=event) & Q(prize__state='ACCEPTED') & Q(acceptcount__gt=F('acceptemailsentcount')))


def default_prize_winner_accept_template_name():
    return getattr(settings, 'WINNER_ACCEPT_EMAIL_TEMPLATE_NAME', 'default_prize_winner_accept_template')


def default_prize_winner_accept_template():
    return post_office.models.EmailTemplate(
        name=default_prize_winner_accept_template_name(),
        description="""A basic template for automailing when prizes are accepted by winners. DO NOT USE THIS TEMPLATE. Copy the contents and modify it to suit your needs.

The variables that will be defined are:
user_index_url -- the user index url (i.e. /user/index)
prize_wins -- the list of PrizeWinner objects that were accepted
prize_count -- the number of prizes in the list
handler -- the user that is handling shipping the prizes
event -- the event for the set of prizes
reply_address -- the address to reply to (will be overridden if the event has a prize coordinator)
""",
        subject='Your Prize{{ prize_count|pluralize }} {{ prize_count|pluralize:"Has:Have" }} Been Accepted',
        html_content="""Hello {{ handler.username }},
            
    <p>
    {% if prize_count > 1 %}Some prize winners have accepted your prizes.{% else %}A prize winner has accepted your prize.{% endif %}

    <ul>
    {% for prizeWin in prize_wins %}
        <li>{{ prizeWin.prize }} for {{ prizeWin.winner.visible_name }}
        {% if prizeWin.winnernotes %}
            <p>
            Winner's Notes: {{ prizeWin.winnernotes }}
            </p>
        {% endif %}
        </li>
    {% endfor %}
    </ul>
    </p>
    
    <p>
    You can view the list of prizes to be shipped, as well as the mailing address details <a href="{{ user_index_url }}">here</a> (requires login). The prizes which are ready to be shipped will be marked "pending shipping".
    </p>
    
    <p>
    Please ship at your earlest convenience, and mark the prizes as 'shipped' on the site when you do.
    </p>
    
    <p> 
    If you have any questions, please contact me at {{ reply_address }}.
    </p>
    
    - The GamesDoneQuick Staff
""")


def automail_winner_accepted_prize(event, prizeWinners, mailTemplate, domain=settings.DOMAIN, sender=None, replyTo=None, verbosity=0, dry_run=False):
    sender, replyTo = event_sender_replyto_defaults(event, sender, replyTo)

    handlerDict = {}
    for prizeWinner in prizeWinners:
        if prizeWinner.prize.handler:
            prizeList = handlerDict.setdefault(prizeWinner.prize.handler, [])
            prizeList.append(prizeWinner)
    for handler, prizeList in handlerDict.items():
        formatContext = {
            'user_index_url': domain + reverse('tracker:user_index'),
            'prize_wins': prizeList,
            'prize_count': len(prizeList),
            'handler': handler,
            'event': event,
            'reply_address': replyTo,
        }
        if not dry_run:
            post_office.mail.send(recipients=[handler.email], sender=sender,
                template=mailTemplate, context=formatContext, headers={'Reply-to': replyTo})
        message = 'Mailed handler {0} for prize accepts {1}'.format(handler.id, list([pw.id for pw in prizeList]))
        if verbosity > 0:
            print(message)
        if not dry_run:
            viewutil.tracker_log('prize', message, event)
            for prizeWinner in prizeList:
                prizeWinner.acceptemailsentcount = prizeWinner.acceptcount
                prizeWinner.save()


def prizes_with_shipping_email_pending(event):
    return PrizeWinner.objects.filter(Q(prize__event=event) & Q(shippingstate='SHIPPED') & Q(shippingemailsent=False))


def default_prize_shipping_template_name():
    return getattr(settings, 'SHIPPING_EMAIL_TEMPLATE_NAME', 'default_prize_shipping_template')


def default_prize_shipping_template():
    return post_office.models.EmailTemplate(
        name=default_prize_shipping_template_name(),
        description="""A basic template for automailing when prizes are shipped. DO NOT USE THIS TEMPLATE. Copy the contents and modify it to suit your needs.

The variables that will be defined are:
prize_wins -- the list PrizeWinner objects
prize_count -- the number of prizes in the list
winner -- the donor that won the prizes
event -- the event for the set of prizes
reply_address -- the address to reply to (will be overridden if the event has a prize coordinator)
""",
        subject='Prize{{ prize_count|pluralize }} Shipped',
        html_content="""Hello {{ winner.contact_name }},
    <p>
    The following prize{{ prize_count|pluralize }} {{ prize_count|pluralize:"has,have" }} been shipped to you:
    </p>
    
    <ul>
    {% for prizeWin in prize_wins %}
        <li><a href="{{ prizeWin.make_winner_url }}">{{ prizeWin.prize.name }}</a>
          {% if prizeWin.couriername %}<p><b>Courier:</b> {{ prizeWin.couriername }}</p>{% if prizeWin.trackingnumber %}<p><b>Tracking#:</b> {{prizeWin.trackingnumber}}</p>{% endif %}{% endif %}
          {% if prizeWin.shippingnotes %}<p><b>Shipping Notes:</b> {{ prizeWin.shippingnotes }}</p>{% endif %}
        </li>
    {% endfor %}
    </ul>

    <p> 
    If you have any questions, please contact me at {{ reply_address }}.
    </p>
    
    - The GamesDoneQuick Staff
""")


def automail_shipping_email_notifications(event, prizeWinners, mailTemplate, domain=settings.DOMAIN, sender=None, replyTo=None, verbosity=0, dry_run=False):
    sender, replyTo = event_sender_replyto_defaults(event, sender, replyTo)

    winnerDict = {}
    for prizeWinner in prizeWinners:
        prizeList = winnerDict.setdefault(prizeWinner.winner, [])
        prizeList.append(prizeWinner)
    for winner, prizeList in winnerDict.items():
        formatContext = {
            'prize_wins': prizeList,
            'prize_count': len(prizeList),
            'winner': winner,
            'event': event,
            'reply_address': replyTo,
        }
        if not dry_run:
            post_office.mail.send(recipients=[winner.email], sender=sender,
                template=mailTemplate, context=formatContext, headers={'Reply-to': replyTo})
        message = 'Mailed donor {0} for prizes shipped {1}'.format(winner.id, list([pw.id for pw in prizeList]))
        if verbosity > 0:
            print(message)
        if not dry_run:
            viewutil.tracker_log('prize', message, event)
            for prizeWinner in prizeList:
                prizeWinner.shippingemailsent = True
                prizeWinner.save()