Mercurial > public > sg101

annotate donations/views.py @ 1054:5b8062cce722

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Top-bar search is working. A few small visual tweaks.
author Brian Neal <bgneal@gmail.com>
date Mon, 07 Mar 2016 19:55:26 -0600
parents e1c03da72818
children 75189bd9c4ba
rev   line source
bgneal@35 1 """
bgneal@35 2 Views for the donations application.
bgneal@35 3 """
bgneal@36 4 import urllib2
bgneal@36 5 import decimal
bgneal@36 6 import datetime
bgneal@316 7 import logging
bgneal@36 8
bgneal@1031 9 from django.shortcuts import render
bgneal@35 10 from django.conf import settings
bgneal@35 11 from django.contrib.sites.models import Site
bgneal@36 12 from django.http import HttpResponse
bgneal@36 13 from django.contrib.auth.models import User
bgneal@238 14 from django.views.decorators.csrf import csrf_exempt
bgneal@238 15
bgneal@35 16
bgneal@35 17 from donations.models import Donation
bgneal@35 18
bgneal@63 19 PP_DATE_FMT = '%H:%M:%S %b %d, %Y'
bgneal@35 20
bgneal@36 21 def paypal_params():
bgneal@36 22 """
bgneal@36 23 This function returns a tuple where the 1st element is the Paypal
bgneal@36 24 URL and the 2nd element is the Paypal business email. This information
bgneal@36 25 depends on the setting DONATIONS_DEBUG.
bgneal@36 26 """
bgneal@36 27 if settings.DONATIONS_DEBUG:
bgneal@35 28 form_action = 'https://www.sandbox.paypal.com/cgi-bin/webscr'
bgneal@35 29 business = settings.DONATIONS_BUSINESS_DEBUG
bgneal@35 30 else:
bgneal@35 31 form_action = 'https://www.paypal.com/cgi-bin/webscr'
bgneal@35 32 business = settings.DONATIONS_BUSINESS
bgneal@35 33
bgneal@36 34 return form_action, business
bgneal@36 35
bgneal@36 36
bgneal@316 37 def verify_request(params):
bgneal@316 38 """
bgneal@316 39 Send the parameters back to Paypal and return the response string.
bgneal@316 40 """
bgneal@316 41 # If we are doing localhost-type unit tests, just return whatever
bgneal@316 42 # the test wants us to...
bgneal@316 43 if hasattr(settings, 'DONATIONS_DEBUG_VERIFY_RESPONSE'):
bgneal@316 44 return settings.DONATIONS_DEBUG_VERIFY_RESPONSE
bgneal@316 45
bgneal@316 46 req = urllib2.Request(paypal_params()[0], params)
bgneal@316 47 req.add_header("Content-type", "application/x-www-form-urlencoded")
bgneal@316 48 try:
bgneal@316 49 response = urllib2.urlopen(req)
bgneal@1031 50 except urllib2.URLError as ex:
bgneal@1031 51 logging.exception('IPN: exception verifying IPN: %s', ex)
bgneal@316 52 return None
bgneal@316 53
bgneal@316 54 return response.read()
bgneal@316 55
bgneal@316 56
bgneal@36 57 def index(request):
bgneal@36 58 gross, net, donations = Donation.objects.monthly_stats()
bgneal@36 59 current_site = Site.objects.get_current()
bgneal@36 60 form_action, business = paypal_params()
bgneal@36 61
bgneal@1031 62 return render(request, 'donations/index.html', {
bgneal@35 63 'goal': settings.DONATIONS_GOAL,
bgneal@35 64 'gross': gross,
bgneal@35 65 'net': net,
bgneal@35 66 'left': settings.DONATIONS_GOAL - net,
bgneal@35 67 'donations': donations,
bgneal@35 68 'form_action': form_action,
bgneal@35 69 'business': business,
bgneal@35 70 'anonymous': settings.DONATIONS_ANON_NAME,
bgneal@35 71 'item_name': settings.DONATIONS_ITEM_NAME,
bgneal@35 72 'item_number': settings.DONATIONS_ITEM_NUM,
bgneal@35 73 'item_anon_number': settings.DONATIONS_ITEM_ANON_NUM,
bgneal@35 74 'domain': current_site.domain,
bgneal@1031 75 })
bgneal@35 76
bgneal@35 77
bgneal@238 78 @csrf_exempt
bgneal@35 79 def ipn(request):
bgneal@36 80 """
bgneal@36 81 This function is the IPN listener and handles the IPN POST from Paypal.
bgneal@39 82 The algorithm here roughly follows the outline described in chapter 2
bgneal@39 83 of Paypal's IPNGuide.pdf "Implementing an IPN Listener".
bgneal@316 84
bgneal@39 85 """
bgneal@39 86 # Log some info about this IPN event
bgneal@39 87 ip = request.META.get('REMOTE_ADDR', '?')
bgneal@39 88 parameters = request.POST.copy()
bgneal@316 89 logging.info('IPN from %s; post data: %s', ip, parameters.urlencode())
bgneal@35 90
bgneal@39 91 # Now we follow the instructions in chapter 2 of the Paypal IPNGuide.pdf.
bgneal@39 92 # Create a request that contains exactly the same IPN variables and values in
bgneal@39 93 # the same order, preceded with cmd=_notify-validate
bgneal@39 94 parameters['cmd']='_notify-validate'
bgneal@36 95
bgneal@316 96 # Post the request back to Paypal (either to the sandbox or the real deal),
bgneal@316 97 # and read the response:
bgneal@316 98 status = verify_request(parameters.urlencode())
bgneal@39 99 if status != 'VERIFIED':
bgneal@316 100 logging.warning('IPN: Payapl did not verify; status was %s', status)
bgneal@39 101 return HttpResponse()
bgneal@36 102
bgneal@39 103 # Response was VERIFIED; act on this if it is a Completed donation,
bgneal@39 104 # otherwise don't handle it (we are just a donations application. Here
bgneal@39 105 # is where we could be expanded to be a more general payment processor).
bgneal@36 106
bgneal@39 107 payment_status = parameters.get('payment_status')
bgneal@39 108 if payment_status != 'Completed':
bgneal@316 109 logging.info('IPN: payment_status is %s; we are done.', payment_status)
bgneal@39 110 return HttpResponse()
bgneal@39 111
bgneal@39 112 # Is this a donation to the site?
bgneal@39 113 item_number = parameters.get('item_number')
bgneal@316 114 if (item_number == settings.DONATIONS_ITEM_NUM or
bgneal@316 115 item_number == settings.DONATIONS_ITEM_ANON_NUM):
bgneal@39 116 process_donation(item_number, parameters)
bgneal@39 117 else:
bgneal@39 118 logging.info('IPN: not a donation; done.')
bgneal@39 119
bgneal@39 120 return HttpResponse()
bgneal@36 121
bgneal@36 122
bgneal@36 123 def process_donation(item_number, params):
bgneal@36 124 """
bgneal@39 125 A few validity and duplicate checks are made on the donation params.
bgneal@316 126 If everything is ok, construct a donation object from the parameters and
bgneal@39 127 store it in the database.
bgneal@316 128
bgneal@36 129 """
bgneal@36 130 # Has this transaction been processed before?
bgneal@39 131 txn_id = params.get('txn_id')
bgneal@39 132 if txn_id is None:
bgneal@39 133 logging.error('IPN: missing txn_id')
bgneal@36 134 return
bgneal@39 135
bgneal@36 136 try:
bgneal@36 137 donation = Donation.objects.get(txn_id__exact=txn_id)
bgneal@36 138 except Donation.DoesNotExist:
bgneal@36 139 pass
bgneal@36 140 else:
bgneal@39 141 logging.warning('IPN: duplicate txn_id')
bgneal@36 142 return # no exception, this is a duplicate
bgneal@36 143
bgneal@36 144 # Is the email address ours?
bgneal@36 145 business = params.get('business')
bgneal@36 146 if business != paypal_params()[1]:
bgneal@316 147 logging.warning('IPN: invalid business: %s', business)
bgneal@36 148 return
bgneal@36 149
bgneal@36 150 # is this a payment received?
bgneal@36 151 txn_type = params.get('txn_type')
bgneal@36 152 if txn_type != 'web_accept':
bgneal@316 153 logging.warning('IPN: invalid txn_type: %s', txn_type)
bgneal@36 154 return
bgneal@316 155
bgneal@36 156 # Looks like a donation, save it to the database.
bgneal@36 157 # Determine which user this came from, if any.
bgneal@36 158 # The username is stored in the custom field if the user was logged in when
bgneal@36 159 # the donation was made.
bgneal@36 160 user = None
bgneal@65 161 if 'custom' in params and params['custom']:
bgneal@36 162 try:
bgneal@36 163 user = User.objects.get(username__exact=params['custom'])
bgneal@36 164 except User.DoesNotExist:
bgneal@36 165 pass
bgneal@36 166
bgneal@36 167 is_anonymous = item_number == settings.DONATIONS_ITEM_ANON_NUM
bgneal@36 168 test_ipn = params.get('test_ipn') == '1'
bgneal@36 169
bgneal@36 170 first_name = params.get('first_name', '')
bgneal@36 171 last_name = params.get('last_name', '')
bgneal@36 172 payer_email = params.get('payer_email', '')
bgneal@36 173 payer_id = params.get('payer_id', '')
bgneal@36 174 memo = params.get('memo', '')
bgneal@36 175 payer_status = params.get('payer_status', '')
bgneal@36 176
bgneal@36 177 try:
bgneal@36 178 mc_gross = decimal.Decimal(params['mc_gross'])
bgneal@36 179 mc_fee = decimal.Decimal(params['mc_fee'])
bgneal@36 180 except KeyError, decimal.InvalidOperation:
bgneal@39 181 logging.error('IPN: invalid/missing mc_gross or mc_fee')
bgneal@36 182 return
bgneal@36 183
bgneal@61 184 payment_date = params.get('payment_date')
bgneal@61 185 if payment_date is None:
bgneal@61 186 logging.error('IPN: missing payment_date')
bgneal@36 187 return
bgneal@36 188
bgneal@61 189 # strip off the timezone
bgneal@61 190 payment_date = payment_date[:-4]
bgneal@61 191 try:
bgneal@61 192 payment_date = datetime.datetime.strptime(payment_date, PP_DATE_FMT)
bgneal@61 193 except ValueError:
bgneal@316 194 logging.error('IPN: invalid payment_date "%s"', params['payment_date'])
bgneal@61 195 return
bgneal@36 196
bgneal@61 197 try:
bgneal@61 198 donation = Donation(
bgneal@61 199 user=user,
bgneal@61 200 is_anonymous=is_anonymous,
bgneal@61 201 test_ipn=test_ipn,
bgneal@61 202 txn_id=txn_id,
bgneal@61 203 txn_type=txn_type,
bgneal@61 204 first_name=first_name,
bgneal@61 205 last_name=last_name,
bgneal@61 206 payer_email=payer_email,
bgneal@61 207 payer_id=payer_id,
bgneal@61 208 memo=memo,
bgneal@61 209 payer_status=payer_status,
bgneal@61 210 mc_gross=mc_gross,
bgneal@61 211 mc_fee=mc_fee,
bgneal@61 212 payment_date=payment_date)
bgneal@61 213 except:
bgneal@61 214 logging.exception('IPN: exception during donation creation')
bgneal@61 215 else:
bgneal@61 216 donation.save()
bgneal@61 217 logging.info('IPN: donation saved')