Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
320 lines (286 sloc) 21.5 KB
import hashlib
import urllib
import urllib2
from django.conf import settings
from django.db import models
import django.dispatch
from multiselectfield import MultiSelectField
from skrill.settings import *
try:
user_model = settings.AUTH_USER_MODEL
except AttributeError:
from django.contrib.auth.models import User as user_model
class PaymentRequest(models.Model):
# list of custom fields that will be ignored upon submit
SUBMIT_IGNORE_FIELDS = ['user', 'user_id', 'time', 'test', 'submitted', 'statusreport']
# custom stuff
user = models.ForeignKey(user_model, verbose_name="User")
time = models.DateTimeField("Time", auto_now_add=True)
test = models.BooleanField("Is test", default=False)
submitted = models.BooleanField("Is submitted", default=False, editable=False)
# merchant details
transaction_id = models.AutoField("Transaction ID", primary_key=True,
help_text="Reference or identification number provided by the Merchant. MUST be unique for each payment")
pay_to_email = models.EmailField("Merchant Email", max_length=50, default=PAY_TO_EMAIL,
help_text="Email address of the Merchant's moneybookers.com account.")
recipient_description = models.CharField("Merchant description", max_length=30, blank=True, null=True, default=RECIPIENT_DESCRIPTION,
help_text="A description of the Merchant, which will be shown on the gateway. If no value is submitted, the pay_to_email value will be shown as the recipient of the payment.")
return_url = models.URLField("Return URL", max_length=240, blank=True, null=True, default=RETURN_URL,
help_text="URL to which the customer will be returned when the payment is made. If this field is not filled, the gateway window will simply close automatically at the end of the transaction, so that the customer will be returned to the last page on the Merchant's website where he has been before.")
return_url_text = models.CharField("Return URL text", max_length=35, blank=True, null=True, default=RETURN_URL_TEXT,
help_text="The text on the button when the user finishes his payment.")
return_url_target = models.SmallIntegerField("Return URL target", choices=URL_TARGET_CHOICES, default=DEFAULT_URL_TARGET,
help_text="Specifies a target in which the return_url value will be called upon successful payment from customer.")
cancel_url = models.URLField("Cancel URL", max_length=240, blank=True, null=True, default=CANCEL_URL,
help_text="RL to which the customer will be returned if the payment process is cancelled. If this field is not filled, the gateway window will simply close automatically upon clicking the cancellation button, so the customer will be returned to the last page on the Merchant's website where the customer has been before.")
cancel_url_target = models.SmallIntegerField("Cancel URL target", choices=URL_TARGET_CHOICES, default=DEFAULT_URL_TARGET,
help_text="Specifies a target in which the cancel_url value will be called upon cancellation of payment from customer.")
status_url = models.CharField("Status URL", max_length=255, blank=True, null=True, default=STATUS_URL,
help_text="URL to which the transaction details will be posted after the payment process is complete. Alternatively, you may specify an email address to which you would like to receive the results.")
status_url2 = models.CharField("Status URL 2", max_length=255, blank=True, null=True, default=STATUS_URL2,
help_text="Second URL to which the transaction details will be posted after the payment process is complete. Alternatively, you may specify an email address to which you would like to receive the results.")
new_window_redirect = models.BooleanField("New window redirect", default=NEW_WINDOW_REDIRECT,
help_text="Merchants can choose to redirect customers to the Sofortueberweisung payment method in a new window instead of in the same window.")
language = models.CharField("Language", max_length=5, choices=LANGUAGE_CHOICES, default=LANGUAGE,
help_text="2-letter code of the language used for Skrill (Moneybookers)' pages.")
hide_login = models.BooleanField("Hide login", default=False,
help_text="Merchants can show their customers the gateway page without the prominent login section.")
confirmation_note = models.CharField("Confirmation note", max_length=240, blank=True, null=True, default=CONFIRMATION_NOTE,
help_text="Merchant may show to the customer on the confirmation screen - the end step of the process - a note, confirmation number, PIN or any other message. Line breaks <br> may be used for longer messages.")
logo_url = models.URLField("Logo URL", max_length=240, blank=True, null=True, default=LOGO_URL,
help_text="The URL of the logo which you would like to appear at the top of the gateway. The logo must be accessible via HTTPS otherwise it will not be shown. For best integration results we recommend that Merchants use logos with dimensions up to 200px in width and 50px in height.")
prepare_only = models.BooleanField("Prepare only", default=True,
help_text="Forces only SID to be returned without actual page. Useful when using alternative ways to redirect the customer to the gateway.")
rid = models.CharField("Referral ID", max_length=100, blank=True, null=True,
help_text="Merchants can pass the unique referral ID or email of the affiliate from which the customer is referred. The rid value must be included within the actual payment request.")
ext_ref_id = models.CharField("Extra Referral ID", max_length=100, blank=True, null=True,
help_text="Merchants can pass additional identifier in this field in order to track affiliates. You MUST inform your account manager about the exact value that will be submitted so that affiliates can be tracked.")
custom_field_1 = models.CharField("Custom field 1", max_length=240, blank=True, null=True,
help_text="One of 5 custom fields, see \"merchant_fields\" in the Skrill documentation")
custom_field_2 = models.CharField("Custom field 2", max_length=240, blank=True, null=True,
help_text="One of 5 custom fields, see \"merchant_fields\" in the Skrill documentation")
custom_field_3 = models.CharField("Custom field 3", max_length=240, blank=True, null=True,
help_text="One of 5 custom fields, see \"merchant_fields\" in the Skrill documentation")
custom_field_4 = models.CharField("Custom field 4", max_length=240, blank=True, null=True,
help_text="One of 5 custom fields, see \"merchant_fields\" in the Skrill documentation")
custom_field_5 = models.CharField("Custom field 5", max_length=240, blank=True, null=True,
help_text="One of 5 custom fields, see \"merchant_fields\" in the Skrill documentation")
# customer details
pay_from_email = models.EmailField("Pay from Email", max_length=100, blank=True, null=True,
help_text="Email address of the customer who is making the payment. If left empty, the customer has to enter his email address himself.")
title = models.CharField("Title", max_length=3, choices=TITLE_CHOICES, blank=True, null=True,
help_text="Customer's title.")
firstname = models.CharField("First name", max_length=20, blank=True, null=True,
help_text="Customer's first name.")
lastname = models.CharField("Last name", max_length=50, blank=True, null=True,
help_text="Customer's last name.")
date_of_birth = models.DateField("Date of birth", blank=True, null=True,
help_text="Date of birth of the customer.")
address = models.CharField("Address", max_length=100, blank=True, null=True,
help_text="Customer's address.")
address2 = models.CharField("Address2", max_length=100, blank=True, null=True,
help_text="Customer's address.")
phone_number = models.PositiveIntegerField("Phone number", max_length=20, blank=True, null=True,
help_text="Customer's phone number. Only numeric values are accepted.")
postal_code = models.CharField("Postal code", max_length=9, blank=True, null=True,
help_text="Customer's postal code/ZIP Code. Only alphanumeric values are accepted (no punctuation marks etc.)")
city = models.CharField("City", max_length=50, blank=True, null=True,
help_text="Customer's city.")
state = models.CharField("State", max_length=50, blank=True, null=True,
help_text="Customer's state or region.")
country = models.CharField("Country", max_length=3, choices=ISO3166_A3, blank=True, null=True,
help_text="Customer's country in the 3-digit ISO Code.")
# payment details
amount = models.DecimalField("Amount", max_digits=18, decimal_places=2,
help_text="The total amount payable.")
currency = models.CharField("Currency", max_length=3, choices=ISO4217, default=DEFAULT_CURRENCY,
help_text="3-letter code of the currency of the amount according to ISO 4217")
amount2_description = models.CharField("Amount 2 description", max_length=240, blank=True, null=True,
help_text="Merchant may specify a detailed calculation for the total amount payable. Please note that Skrill (Moneybookers) does not check the validity of these data - they are only displayed in the 'More information' section in the header of the gateway.")
amount2 = models.DecimalField("Amount 2", max_digits=18, decimal_places=2, blank=True, null=True,
help_text="This amount in the currency defined in field 'currency' will be shown next to amount2_description.")
amount3_description = models.CharField("Amount 3 description", max_length=240, blank=True, null=True,
help_text="Merchant may specify a detailed calculation for the total amount payable. Please note that Skrill (Moneybookers) does not check the validity of these data - they are only displayed in the 'More information' section in the header of the gateway.")
amount3 = models.DecimalField("Amount 3", max_digits=18, decimal_places=2, blank=True, null=True,
help_text="This amount in the currency defined in field 'currency' will be shown next to amount3_description.")
amount4_description = models.CharField("Amount 4 description", max_length=240, blank=True, null=True,
help_text="Merchant may specify a detailed calculation for the total amount payable. Please note that Skrill (Moneybookers) does not check the validity of these data - they are only displayed in the 'More information' section in the header of the gateway.")
amount4 = models.DecimalField("Amount 4", max_digits=18, decimal_places=2, blank=True, null=True,
help_text="This amount in the currency defined in field 'currency' will be shown next to amount4_description.")
detail1_description = models.CharField("Detail 1 description", max_length=240, blank=True, null=True,
help_text="Merchant may show up to 5 details about the product or transfer in the 'More information' section in the header of the gateway.")
detail1_text = models.CharField("Detail 1 text", max_length=240, blank=True, null=True,
help_text="The detail1_text is shown next to the detail1_description. The detail1_text is also shown to the client in his history at Skrill (Moneybookers)' website.")
detail2_description = models.CharField("Detail 2 description", max_length=240, blank=True, null=True,
help_text="Merchant may show up to 5 details about the product or transfer in the 'More information' section in the header of the gateway.")
detail2_text = models.CharField("Detail 2 text", max_length=240, blank=True, null=True,
help_text="The detail2_text is shown next to the detail2_description. The detail1_text is also shown to the client in his history at Skrill (Moneybookers)' website.")
detail3_description = models.CharField("Detail 3 description", max_length=240, blank=True, null=True,
help_text="Merchant may show up to 5 details about the product or transfer in the 'More information' section in the header of the gateway.")
detail3_text = models.CharField("Detail 3 text", max_length=240, blank=True, null=True,
help_text="The detail3_text is shown next to the detail3_description. The detail3_text is also shown to the client in his history at Skrill (Moneybookers)' website.")
detail4_description = models.CharField("Detail 4 description", max_length=240, blank=True, null=True,
help_text="Merchant may show up to 5 details about the product or transfer in the 'More information' section in the header of the gateway.")
detail4_text = models.CharField("Detail 4 text", max_length=240, blank=True, null=True,
help_text="The detail4_text is shown next to the detail4_description. The detail4_text is also shown to the client in his history at Skrill (Moneybookers)' website.")
detail5_description = models.CharField("Detail 5 description", max_length=240, blank=True, null=True,
help_text="Merchant may show up to 5 details about the product or transfer in the 'More information' section in the header of the gateway.")
detail5_text = models.CharField("Detail 5 text", max_length=240, blank=True, null=True,
help_text="The detail5_text is shown next to the detail5_description. The detail5_text is also shown to the client in his history at Skrill (Moneybookers)' website.")
# other features
payment_methods = MultiSelectField("Payment methods", max_length=100, choices=GATEWAY_PAYMENT_CODES, blank=True, null=True,
help_text="If no payment method is selected all will be available")
class Meta:
verbose_name = "Payment request"
verbose_name_plural = "Payment requests"
ordering = ['time']
def __unicode__(self):
return "#%s %s %s" % (self.transaction_id, self.user, self.time)
def _format_boolean(self, value):
if value:
return 1
else:
return 0
def _get_formatted_field_value(self, field):
field_class = self._meta.get_field(field).__class__
field_value = getattr(self, field)
if field == "payment_methods":
return ",".join(field_value)
elif field_class == models.BooleanField:
return self._format_boolean(field_value)
elif field_class == models.DateField:
return field_value.strftime("%d%m%Y")
elif field_class == models.DecimalField:
return str(field_value)
elif isinstance(field_value, unicode):
return field_value.encode('utf8')
else:
return field_value
def _get_used_custom_fields_as_csv(self):
used_custom_fields = []
for i in range(1, 6):
value = getattr(self, "custom_field_%d" % i)
if value is not None and value != '':
used_custom_fields.append("custom_field_%d" % i)
if len(used_custom_fields) > 0:
return ', '.join(used_custom_fields)
else:
return ''
def submit(self, force_submit=False):
"""Submit model content to skrill and return redirect url with session ID on success."""
assert self.prepare_only is True, "Use this only with prepare_only = True"
assert self.pk is not None, "Save PaymentRequest before submitting!"
if not force_submit:
assert self.submitted is False, "PaymentRequest already submitted!"
self.submitted = True
self.save()
data = {}
for field in self._meta.get_all_field_names():
if field in self.SUBMIT_IGNORE_FIELDS:
continue
field_value = getattr(self, field)
if field_value is not None and field_value != '':
data[field] = self._get_formatted_field_value(field)
used_custom_fields = self._get_used_custom_fields_as_csv()
if used_custom_fields != '':
data['merchant_fields'] = used_custom_fields
req = urllib2.Request(url=API_URL, data=urllib.urlencode(data))
headers = urllib2.urlopen(req).info().headers
for header in headers:
if "Set-Cookie: SESSION_ID=" in header:
return "%s?sid=%s" % (API_URL, header.split(';')[0].replace("Set-Cookie: SESSION_ID=", ""))
class StatusReport(models.Model):
# custom fields
time = models.DateTimeField("Time", auto_now_add=True)
valid = models.BooleanField("Valid", default=False)
signal_sent = models.BooleanField("Signal sent", default=False)
# Skrill fields
pay_to_email = models.EmailField("Merchant Email", max_length=50, default=PAY_TO_EMAIL,
help_text="Email address of the Merchant's moneybookers.com account.")
pay_from_email = models.EmailField("Customer Email", max_length=50,
help_text="Email address of the customer who is making the payment, i.e. sending the money.")
merchant_id = models.PositiveIntegerField("Merchant ID",
help_text="Unique ID for the Merchant's moneybookers.com account.")
customer_id = models.PositiveIntegerField("Customer ID", null=True, blank=True,
help_text="Unique ID for the customer's moneybookers.com account.")
payment_request = models.ForeignKey(PaymentRequest, help_text="PaymentRequest object directly mapped via incoming transaction_id")
mb_transaction_id = models.PositiveIntegerField("Skrill transaction ID",
help_text="Moneybookers' unique transaction ID for the transfer.")
mb_amount = models.DecimalField("MB Amount", max_digits=18, decimal_places=2,
help_text="The total amount of the payment in Merchant's currency.")
mb_currency = models.CharField("MB Currency", max_length=3, choices=ISO4217,
help_text="Currency of mb_amount. Will always be the same as the currency of the beneficiary's account at Skrill (Moneybookers).")
status = models.IntegerField("Status", choices=STATUS_CHOICES,
help_text="Status of the transaction.")
failed_reason_code = models.CharField("Failed reason code", max_length=2, choices=FAILED_REASON_CODES, blank=True, null=True,
help_text="If the transaction is with status -2 (failed), this field will contain a code detailing the reason for the failure.")
md5sig = models.CharField("MD5 signature", max_length=32)
sha2sig = models.CharField("SHA2 signature", max_length=64, null=True, blank=True)
amount = models.DecimalField("Amount", max_digits=18, decimal_places=2,
help_text="Amount of the payment as posted by the Merchant on the entry form.")
currency = models.CharField("Currency", max_length=3, choices=ISO4217,
help_text="Currency of the payment as posted by the Merchant on the entry form")
payment_type = models.CharField("Payment type", max_length=10, blank=True, null=True,
help_text="The payment instrument used by the customer on the Gateway.")
custom_field_1 = models.CharField("Custom field 1", max_length=240, blank=True, null=True,
help_text="One of 5 custom fields, see \"merchant_fields\" in the Skrill documentation")
custom_field_2 = models.CharField("Custom field 2", max_length=240, blank=True, null=True,
help_text="One of 5 custom fields, see \"merchant_fields\" in the Skrill documentation")
custom_field_3 = models.CharField("Custom field 3", max_length=240, blank=True, null=True,
help_text="One of 5 custom fields, see \"merchant_fields\" in the Skrill documentation")
custom_field_4 = models.CharField("Custom field 4", max_length=240, blank=True, null=True,
help_text="One of 5 custom fields, see \"merchant_fields\" in the Skrill documentation")
custom_field_5 = models.CharField("Custom field 5", max_length=240, blank=True, null=True,
help_text="One of 5 custom fields, see \"merchant_fields\" in the Skrill documentation")
class Meta:
verbose_name = "Status report"
verbose_name_plural = "Status reports"
ordering = ['time']
class InvalidMD5Signature(Exception):
def __init__(self, status_report):
self.status_report = status_report
def __str__(self):
return "Invalid MD5 signature in status report #%d" % self.status_report.pk
@property
def transaction_id(self):
return self.payment_request_id
def generate_md5_signature(self):
m = hashlib.md5()
m.update(str(self.merchant_id))
m.update(str(self.transaction_id))
m.update(get_secret_word_as_md5())
m.update(str(self.mb_amount))
m.update(self.mb_currency)
m.update(str(self.status))
return m.hexdigest().upper()
def validate_md5sig(self):
if self.generate_md5_signature() != self.md5sig:
raise StatusReport.InvalidMD5Signature(self)
def send_signal(self, force=False):
if not self.valid:
return
if self.signal_sent and not force:
return
if self.status == -3 or self.status == "-3":
skrill_status_chargeback.send(sender=self)
self.signal_sent = True
elif self.status == -2 or self.status == "-2":
skrill_status_failed.send(sender=self)
self.signal_sent = True
elif self.status == -1 or self.status == "-1":
skrill_status_cancelled.send(sender=self)
self.signal_sent = True
elif self.status == 0 or self.status == "0":
skrill_status_pending.send(sender=self)
self.signal_sent = True
elif self.status == 2 or self.status == "2":
skrill_status_processed.send(sender=self)
self.signal_sent = True
else:
raise Exception("unknown status value %s" % str(self.status))
self.save()
skrill_status_chargeback = django.dispatch.Signal()
skrill_status_failed = django.dispatch.Signal()
skrill_status_cancelled = django.dispatch.Signal()
skrill_status_pending = django.dispatch.Signal()
skrill_status_processed = django.dispatch.Signal()