paypalutil.py

from paypal.standard.ipn.forms import PayPalIPNForm
from paypal.standard.ipn.models import PayPalIPN
from tracker.models import *
from datetime import *
import tracker.viewutil as viewutil
import random

from decimal import *
import pytz

def create_ipn(request):
  flag = None
  ipnObj = None
  form = PayPalIPNForm(request.POST)
  if form.is_valid():
    try:
      ipnObj = form.save(commit=False)
    except Exception as e:
      flag = "Exception while processing. (%s)" % e
  else:
    flag = "Invalid form. (%s)" % form.errors
  if ipnObj is None:
    ipnObj = PayPalIPN()
  ipnObj.initialize(request)
  if flag is not None:
    ipnObj.set_flag(flag)
  else:
    # Secrets should only be used over SSL.
    if request.is_secure() and 'secret' in request.GET:
      ipnObj.verify_secret(form, request.GET['secret'])
    else:
      donation = get_ipn_donation(ipnObj)
      if not donation:
        raise Exception('No donation associated with this IPN: Custom field value {!r}'.format(ipnObj.custom))
      ipnObj.verify()

      # Check if receiver email matches event here.  This removes the need for a custom fork of django-paypal.
      business = donation.event.paypalemail
      if (ipnObj.business and ipnObj.business.lower() != business.lower()) or (
              not ipnObj.business and ipnObj.receiver_email.lower() != business.lower()):
        ipnObj.set_flag("Business email mismatch. (%s)" % ipnObj.business)

  ipnObj.save()
  return ipnObj

def get_ipn(request):
  ipnObj = PayPalIPN()
  ipnObj.initialize(request)
  return ipnObj

def get_ipn_donation(ipnObj):
  if ipnObj.custom:
    toks = ipnObj.custom.split(':')
    pk = int(toks[0])
    return Donation.objects.filter(pk=pk).first()
  else:
    return None

def fill_donor_address(donor, ipnObj):
  if not donor.addressstreet:
    donor.addressstreet = ipnObj.address_street
  if not donor.addresscity:
    donor.addresscity = ipnObj.address_city
  if not donor.addresscountry:
    countrycode = ipnObj.residence_country if not ipnObj.address_country_code else ipnObj.address_country_code
    donor.addresscountry = Country.objects.get(alpha2=countrycode)
  if not donor.addressstate:
    donor.addressstate = ipnObj.address_state
  if not donor.addresszip:
    donor.addresszip = ipnObj.address_zip
  donor.save()

def initialize_paypal_donation(ipnObj):
  countrycode = ipnObj.residence_country if not ipnObj.address_country_code else ipnObj.address_country_code
  defaults = {
    'email'           : ipnObj.payer_email.lower(),
    'firstname'       : ipnObj.first_name,
    'lastname'        : ipnObj.last_name,
    'addressstreet'  : ipnObj.address_street,
    'addresscity'    : ipnObj.address_city,
    'addresscountry' : Country.objects.get(alpha2=countrycode),
    'addressstate'   : ipnObj.address_state,
    'addresszip'     : ipnObj.address_zip,
    'visibility'      : 'ANON',
  }
  donor,created = Donor.objects.get_or_create(paypalemail=ipnObj.payer_email.lower(),defaults=defaults)

  fill_donor_address(donor, ipnObj)

  donation = get_ipn_donation(ipnObj)

  if donation:
    if donation.requestedvisibility != 'CURR':
      donor.visibility = donation.requestedvisibility
    if donation.requestedalias and (not donor.alias or donation.requestedalias.lower() != donor.alias.lower()):
      foundAResult = False
      currentAlias = donation.requestedalias
      while not foundAResult:
        results = Donor.objects.filter(alias__iexact=currentAlias)
        if results.exists():
          currentAlias = donation.requestedalias + str(random.getrandbits(8))
        else:
          foundAResult = True
      donor.alias = currentAlias
    if donation.requestedemail and donation.requestedemail != donor.email and not Donor.objects.filter(email=donation.requestedemail).exists():
      donor.email = donation.requestedemail
    if donation.requestedsolicitemail != 'CURR':
      donor.solicitemail = donation.requestedsolicitemail
    donor.save()
  else:
    donation = Donation()
    donation.modcomment = '*Donation for ipn was not found, creating new*'
    donation.event = Event.objects.latest()

  donation.domain='PAYPAL'
  donation.domainId=ipnObj.txn_id
  donation.donor=donor
  donation.amount=Decimal(ipnObj.mc_gross)
  donation.currency=ipnObj.mc_currency
  if not donation.timereceived:
    donation.timereceived = datetime.utcnow()
  donation.testdonation=ipnObj.test_ipn
  donation.fee=Decimal(ipnObj.mc_fee or 0)

  # if the user attempted to tamper with the donation amount, remove all bids
  if donation.amount != ipnObj.mc_gross:
    donation.modcomment += "\n*Tampered donation amount from " + str(donation.amount) + " to " + str(ipnObj.mc_gross) + ", removed all bids*"
    donation.amount = ipnObj.mc_gross
    donation.bids.clear()
    viewutil.tracker_log('paypal', 'Tampered amount detected in donation {0} (${1} -> ${2})'.format(donation.id, donation.amount, ipnObj.mc_gross), event=donation.event)

  paymentStatus = ipnObj.payment_status.lower()

  if not ipnObj.flag:
    if paymentStatus == 'pending':
      donation.transactionstate = 'PENDING'
    elif paymentStatus == 'completed' or paymentStatus == 'canceled_reversal' or paymentStatus == 'processed':
      donation.transactionstate = 'COMPLETED'
    elif paymentStatus == 'refunded' or paymentStatus == 'reversed' or paymentStatus == 'failed' or paymentStatus == 'voided' or paymentStatus == 'denied':
      donation.transactionstate = 'CANCELLED'
    else:
      donation.transactionstate = 'FLAGGED'
      viewutil.tracker_log('paypal', 'Unknown payment status in donation {0} ({1})'.format(donation.id, paymentStatus), event=donation.event)
  else:
    donation.transactionstate = 'FLAGGED'
    viewutil.tracker_log('paypal', 'IPN object flagged for donation {0} ({1})'.format(donation.id, ipnObj.txn_id), event=donation.event)

  donation.save()
  # I think we only care if the _donation_ was freshly created
  return donation

def get_paypal_donation(paypalemail, amount, transactionid):
  donations = Donation.objects.filter(amount=amount, domain='PAYPAL', domainId=transactionid)
  if donations.exists():
    donation = donations[0]
    donors = Donor.objects.filter(paypalemail=paypalemail)
    if donors.exists() and donation.donor.id == donors[0].id:
      return donation
  return None

_reasonCodeDetails = {
'echeck': ("Payments sent as eCheck tend to take several days to a week to clear. Unfortuantely, there is nothing we can do to expidite this process. In the future, please consider using instant-payment type payments.", False),
'paymentreview': ("The payment is being reviewed by PayPal. Typically, this will occur with large transaction amounts and/or from accounts with low overall activity.", False),
'regulatory_review': ("This payment is being reviewed for compliance with government regulations.", False),
'intl': ("The payment was sent via a currency the target account is not set up to receive, and must be confirmed manually by the account holder.", True),
'multi-currency': ("The payment was sent in a currency the target account cannot convert from, and must be manually converted by the account holder.", True),
'unilateral': ("The receiver account e-mail has not yet been confirmed", True),
'upgrade': ("The receiver account is unable to process the payment, due to its account status", True),
}


def get_pending_reason_details(pending_reason):
  return _reasonCodeDetails.get(pending_reason, ('', True))

def log_ipn(ipnObj, message=''):
  donation = get_ipn_donation(ipnObj)
  message = "{message}\ntxn_id : {txn_id}\nstatus : {status}\nemail : {email}\namount : {amount}\ndate : {date}\ncustom : {custom}\ndonation : {donation}".format(
  **{ "message"  : message,
      "txn_id"   : ipnObj.txn_id,
      "status"   : ipnObj.payment_status,
      "email"    : ipnObj.payer_email,
      "amount"   : ipnObj.mc_gross,
      "date"     : ipnObj.payment_date,
      "custom"   : ipnObj.custom,
      "donation" : donation, })
  status = ipnObj.payment_status.lower()
  if status == 'pending':
    message += 'pending : ' + ipnObj.pending_reason
  elif status in ['reversed', 'refunded', 'canceled_reversal', 'denied']:
    message += 'reason  : ' + ipnObj.reason_code
  viewutil.tracker_log('paypal', message, event=donation.event if donation else None)