"""
Configuration items for the shop.
Also contains shopping cart and related classes.
"""
from decimal import Decimal, ROUND_CEILING
from django.contrib.sites.models import Site
from django.conf import settings
from django.core import urlresolvers
from django.db import models
from django.utils.encoding import force_unicode
from django.utils.safestring import mark_safe
from django.utils.translation import ugettext, ugettext_lazy as _
from l10n.models import Country
from l10n.utils import moneyfmt
from livesettings import ConfigurationSettings, config_value
from product.models import Discount, Product, Price, get_product_quantity_adjustments
from product.prices import PriceAdjustmentCalc, PriceAdjustment
from satchmo_store.contact.models import Contact
from satchmo_utils.fields import CurrencyField
from satchmo_utils.numbers import trunc_decimal
import shipping.fields
import payment.config
from satchmo_utils.iterchoices import iterchoices_db
from tax.utils import get_tax_processor
import datetime
import keyedcache
import logging
import operator
import signals
log = logging.getLogger('satchmo_store.shop.models')
class NullConfig(object):
"""Standin for a real config when we don't have one yet."""
def __init__(self):
self.store_name = self.store_description = _("Test Store")
self.store_email = self.street1 = self.street2 = self.city = self.state = self.postal_code = self.phone = ""
self.site = self.country = None
self.in_country_only = True
self.sales_country = None
def _options(self):
return ConfigurationSettings()
options = property(fget=_options)
def __str__(self):
return "Test Store - no configured store exists!"
class ConfigManager(models.Manager):
def get_current(self, site=None):
"""Convenience method to get the current shop config"""
if not site:
site = Site.objects.get_current()
site = site.id
try:
shop_config = keyedcache.cache_get("Config", site)
except keyedcache.NotCachedError, nce:
try:
shop_config = self.get(site__id__exact=site)
keyedcache.cache_set(nce.key, value=shop_config)
except Config.DoesNotExist:
log.warning("No Shop Config found, using test shop config for site=%s.", site)
shop_config = NullConfig()
return shop_config
class Config(models.Model):
"""
Used to store specific information about a store. Also used to
configure various store behaviors
"""
site = models.OneToOneField(Site, verbose_name=_("Site"), primary_key=True)
store_name = models.CharField(_("Store Name"),max_length=100, unique=True)
store_description = models.TextField(_("Description"), blank=True, null=True)
store_email = models.EmailField(_("Email"), blank=True, null=True, max_length=75)
street1=models.CharField(_("Street"),max_length=50, blank=True, null=True)
street2=models.CharField(_("Street"), max_length=50, blank=True, null=True)
city=models.CharField(_("City"), max_length=50, blank=True, null=True)
state=models.CharField(_("State"), max_length=30, blank=True, null=True)
postal_code=models.CharField(_("Zip Code"), blank=True, null=True, max_length=9)
country=models.ForeignKey(Country, blank=False, null=False, verbose_name=_('Country'))
phone = models.CharField(_("Phone Number"), blank=True, null=True, max_length=30)
in_country_only = models.BooleanField(
_("Only sell to in-country customers?"),
default=True)
sales_country = models.ForeignKey(
Country, blank=True, null=True,
related_name='sales_country',
verbose_name=_("Default country for customers"))
shipping_countries = models.ManyToManyField(
Country,
blank=True,
verbose_name=_("Shipping Countries"),
related_name="shop_configs")
objects = ConfigManager()
def _options(self):
return ConfigurationSettings()
options = property(fget=_options)
def areas(self):
"""Get country areas (states/counties). Used in forms."""
if self.in_country_only:
return self.sales_country.adminarea_set.filter(active=True)
else:
return None
def countries(self):
"""Get country selections. Used in forms."""
if self.in_country_only:
return Country.objects.filter(pk=self.sales_country.pk)
else:
return self.shipping_countries.filter(active=True)
def _base_url(self, secure=False):
prefix = "http"
if secure:
prefix += "s"
return prefix + "://" + self.site.domain
base_url = property(fget=_base_url)
def save(self, **kwargs):
keyedcache.cache_delete("Config", self.site.id)
# ensure the default country is in shipping countries
mycountry = self.country
if mycountry:
if not self.sales_country:
log.debug("%s: No sales_country set, adding country of store, '%s'", self, mycountry)
self.sales_country = mycountry
# This code doesn't work when creating a new site. At the time of creation, all of the necessary relationships
# aren't setup. I modified the load_store code so that it would create this relationship manually when running
# with sample data. This is a bit of a django limitation so I'm leaving this in here for now. - CBM
# salescountry = self.sales_country
# try:
# need = self.shipping_countries.get(pk=salescountry.pk)
# except Country.DoesNotExist:
# log.debug("%s: Adding default country '%s' to shipping countries", self, salescountry.iso2_code)
# self.shipping_countries.add(salescountry)
else:
log.warn("%s: has no country set", self)
super(Config, self).save(**kwargs)
keyedcache.cache_set("Config", self.site.id, value=self)
def __unicode__(self):
return self.store_name
class Meta:
verbose_name = _("Store Configuration")
verbose_name_plural = _("Store Configurations")
class NullCart(object):
"""Standin for a real cart when we don't have one yet. More convenient than testing for null all the time."""
desc = None
date_time_created = None
customer = None
total = Decimal("0")
numItems = 0
def add_item(self, *args, **kwargs):
pass
def remove_item(self, *args, **kwargs):
pass
def empty(self):
pass
def __str__(self):
return "NullCart (empty)"
def __iter__(self):
return iter([])
def __len__(self):
return 0
def save(self):
pass
class OrderCart(NullCart):
"""Allows us to fake a cart if we are reloading an order."""
def __init__(self, order):
self._order = order
def _numItems(self):
return self._order.orderitem_set.count()
numItems = property(_numItems)
def _cartitem_set(self):
return self._order.orderitem_set
cartitem_set = property(_cartitem_set)
def _total(self):
return self._order.balance
total = property(_total)
is_shippable = False
def __str__(self):
return "OrderCart (%i) = %i" % (self._order.id, len(self))
def __len__(self):
return self.numItems
def __iter__(self):
return iter(self.cartitem_set.all())
class CartManager(models.Manager):
def from_request(self, request, create=False, return_nullcart=True):
"""Get the current cart from the request"""
cart = None
try:
contact = Contact.objects.from_request(request, create=False)
except Contact.DoesNotExist:
contact = None
if 'cart' in request.session:
cartid = request.session['cart']
if cartid == "order":
log.debug("Getting Order Cart from request")
try:
order = Order.objects.from_request(request)
cart = OrderCart(order)
except Order.DoesNotExist:
pass
else:
try:
cart = Cart.objects.get(id=cartid)
except Cart.DoesNotExist:
log.debug('Removing invalid cart from session')
del request.session['cart']
if isinstance(cart, NullCart) and not isinstance(cart, OrderCart) and contact is not None:
carts = Cart.objects.filter(customer=contact)
if carts.count() > 0:
cart = carts[0]
request.session['cart'] = cart.id
if not cart:
if create:
site = Site.objects.get_current()
if contact is None:
cart = Cart(site=site)
else:
cart = Cart(site=site, customer=contact)
cart.save()
request.session['cart'] = cart.id
elif return_nullcart:
cart = NullCart()
else:
raise Cart.DoesNotExist()
#log.debug("Cart: %s", cart)
return cart
class Cart(models.Model):
"""
Store items currently in a cart
The desc isn't used but it is needed to make the admin interface work appropriately
Could be used for debugging
"""
site = models.ForeignKey(Site, verbose_name=_('Site'))
desc = models.CharField(_("Description"), blank=True, null=True, max_length=10)
date_time_created = models.DateTimeField(_("Creation Date"))
customer = models.ForeignKey(Contact, blank=True, null=True, verbose_name=_('Customer'))
objects = CartManager()
def _get_count(self):
itemCount = 0
for item in self.cartitem_set.all():
itemCount += item.quantity
return (itemCount)
numItems = property(_get_count)
def _get_discount(self):
return self.undiscounted_total - self.total
discount = property(_get_discount)
def _get_total(self, include_discount=True):
total = Decimal("0")
for item in self.cartitem_set.all():
if include_discount:
total += item.line_total
else:
total += item.undiscounted_line_total
return(total)
total = property(_get_total)
def _get_undiscounted_total(self):
return self._get_total(False)
undiscounted_total = property(_get_undiscounted_total)
def __iter__(self):
return iter(self.cartitem_set.all())
def __len__(self):
return self.cartitem_set.count()
def __nonzero__(self):
"""
This is used by django to evaluate whether or not to
include an object when dumping data. Therefore, we will dump
carts even if they have no items. This is ok because the most likely
scenario is moving data from one db to the next. See ticket #1015 for
discussion.
Use len(cart) if you want to know if there are items in the cart.
"""
return True
def _is_empty(self):
return self.cartitem_set.count() == 0
is_empty = property(_is_empty)
def __unicode__(self):
return u"Shopping Cart (%s)" % self.date_time_created
def add_item(self, chosen_item, number_added, details=[]):
alreadyInCart = False
# Custom Products will not be added, they will each get their own line item
if 'CustomProduct' in chosen_item.get_subtypes():
item_to_modify = CartItem(cart=self, product=chosen_item, quantity=Decimal('0'))
else:
item_to_modify = CartItem(cart=self, product=chosen_item, quantity=Decimal('0'))
for similarItem in self.cartitem_set.filter(product__id = chosen_item.id):
looksTheSame = len(details) == similarItem.details.count()
if looksTheSame:
for detail in details:
try:
similarItem.details.get(
name=detail['name'],
value=str(detail['value']), # typecasting for Postgresql
price_change=detail['price_change']
)
except CartItemDetails.DoesNotExist:
looksTheSame = False
if looksTheSame:
item_to_modify = similarItem
alreadyInCart = True
break
# Verify that the 'item_to_modify' can be added to the cart regardless
# of whether or not it is already in the cart
signals.satchmo_cart_add_verify.send(
self,
cart=self,
cartitem=item_to_modify,
added_quantity=number_added,
details=details)
if not alreadyInCart:
self.cartitem_set.add(item_to_modify)
item_to_modify.quantity += number_added
item_to_modify.save()
if not alreadyInCart:
for data in details:
item_to_modify.add_detail(data)
return item_to_modify
def remove_item(self, chosen_item_id, number_removed):
item_to_modify = self.cartitem_set.get(id = chosen_item_id)
item_to_modify.quantity -= number_removed
if item_to_modify.quantity <= 0:
item_to_modify.delete()
else:
item_to_modify.save()
def merge_carts(self, src_cart):
"""
Merge the items from the src_cart into
the destination. Source cart will be emptied
"""
for item in src_cart.cartitem_set.all():
self.add_item(item.product, item.quantity, item.details.all())
item.delete()
self.save()
def empty(self):
for item in self.cartitem_set.all():
item.delete()
self.save()
def save(self, **kwargs):
"""Ensure we have a date_time_created before saving the first time."""
if not self.pk:
self.date_time_created = datetime.datetime.now()
try:
site = self.site
except Site.DoesNotExist:
self.site = Site.objects.get_current()
super(Cart, self).save(**kwargs)
def _get_shippable(self):
"""Return whether the cart contains shippable items."""
for cartitem in self.cartitem_set.all():
if cartitem.is_shippable:
return True
return False
is_shippable = property(_get_shippable)
def get_shipment_list(self):
"""Return a list of shippable products, where each item is split into
multiple elements, one for each quantity."""
items = []
for cartitem in self.cartitem_set.all():
if cartitem.is_shippable:
p = cartitem.product
q = int(cartitem.quantity.quantize(Decimal('0'), ROUND_CEILING))
for single in range(0, q):
items.append(p)
return items
def get_shipment_by_amount(self):
"""
Returna list of shippable products, with it's quantity
"""
items = []
for cartitem in self.cartitem_set.all():
if cartitem.is_shippable:
p = cartitem.product
q = int(cartitem.quantity.quantize(Decimal('0'), ROUND_CEILING))
items.append((q,p))
return items
class Meta:
verbose_name = _("Shopping Cart")
verbose_name_plural = _("Shopping Carts")
class NullCartItem(object):
def __init__(self, itemid):
self.id = itemid
self.quantity = Decimal('0')
self.line_total = 0
class CartItem(models.Model):
"""
An individual item in the cart
"""
cart = models.ForeignKey(Cart, verbose_name=_('Cart'))
product = models.ForeignKey(Product, verbose_name=_('Product'))
quantity = models.DecimalField(_("Quantity"), max_digits=18, decimal_places=6)
def _get_line_unitprice(self, include_discount=True):
# Get the qty discount price as the unit price for the line.
if config_value('SHOP','CART_QTY'):
qty = self.cart.numItems
else:
qty = self.quantity
self.qty_price = self.get_qty_price(qty, include_discount=include_discount)
self.detail_price = self.get_detail_price()
#send signal to possibly adjust the unitprice
if include_discount:
signals.satchmo_cartitem_price_query.send(self, cartitem=self)
price = self.qty_price + self.detail_price
#clean up temp vars
del self.qty_price
del self.detail_price
return price
unit_price = property(_get_line_unitprice)
def _get_undiscounted_unitprice(self):
return self._get_line_unitprice(include_discount=False)
undiscounted_unit_price = property(_get_undiscounted_unitprice)
def get_detail_price(self):
"""Get the delta price based on detail modifications"""
delta = Decimal("0")
if self.has_details:
for detail in self.details.all():
if detail.price_change and detail.value:
delta += detail.price_change
return delta
def get_qty_price(self, qty, include_discount=True):
"""Get the price for for each unit before any detail modifications"""
return self.product.get_qty_price(qty, include_discount=include_discount)
def _get_line_total(self):
return self.unit_price * self.quantity
line_total = property(_get_line_total)
def _get_undiscounted_line_total(self):
return self.undiscounted_unit_price * self.quantity
undiscounted_line_total = property(_get_undiscounted_line_total)
def _get_description(self):
return self.product.translated_name()
description = property(_get_description)
def _is_shippable(self):
return self.product.is_shippable
is_shippable = property(fget=_is_shippable)
def add_detail(self, data):
detl = CartItemDetails(
cartitem=self,
name=data['name'],
value=data['value'],
sort_order=data['sort_order'],
price_change=data['price_change'])
detl.save()
#self.details.add(detl)
def _has_details(self):
"""
Determine if this specific item has more detail
"""
return (self.details.count() > 0)
has_details = property(_has_details)
def __unicode__(self):
money_format = force_unicode(moneyfmt(self.line_total))
return u'%s - %s %s' % (self.quantity, self.product.name,
money_format)
class Meta:
verbose_name = _("Cart Item")
verbose_name_plural = _("Cart Items")
ordering = ('id',)
class CartItemDetails(models.Model):
"""
An arbitrary detail about a cart item.
"""
cartitem = models.ForeignKey(CartItem, related_name='details', )
value = models.TextField(_('detail'))
name = models.CharField(_('name'), max_length=100)
price_change = CurrencyField(_("Item Detail Price Change"), max_digits=6,
decimal_places=2, blank=True, null=True)
sort_order = models.IntegerField(_("Sort Order"),
help_text=_("The display order for this group."))
class Meta:
ordering = ('sort_order',)
verbose_name = _("Cart Item Detail")
verbose_name_plural = _("Cart Item Details")
ORDER_CHOICES = (
('Online', _('Online')),
('In Person', _('In Person')),
('Show', _('Show')),
)
ORDER_STATUS = (
('Temp', _('Temp')),
('New', _('New')),
('Blocked', _('Blocked')),
('In Process', _('In Process')),
('Billed', _('Billed')),
('Shipped', _('Shipped')),
('Complete', _('Complete')),
('Cancelled', _('Cancelled')),
)
class OrderManager(models.Manager):
def from_request(self, request):
"""Get the order from the session
Returns:
- Order object
"""
order = None
if 'orderID' in request.session:
try:
order = Order.objects.get(id=request.session['orderID'])
# TODO: Validate against logged-in user.
except Order.DoesNotExist:
pass
if not order:
del request.session['orderID']
if not order:
raise Order.DoesNotExist()
return order
def remove_partial_order(self, request):
"""Delete cart from request if it exists and is incomplete (has no status)"""
try:
order = Order.objects.from_request(request)
if not order.status:
del request.session['orderID']
log.info("Deleting incomplete order #%i from database", order.id)
order.delete()
return True
except Order.DoesNotExist:
pass
return False
class OrderVariable(models.Model):
order = models.ForeignKey("Order", related_name="variables")
key = models.SlugField(_('key'), )
value = models.CharField(_('value'), max_length=100)
class Meta:
ordering=('key',)
verbose_name = _("Order variable")
verbose_name_plural = _("Order variables")
def __unicode__(self):
if len(self.value)>10:
v = self.value[:10] + '...'
else:
v = self.value
return u"OrderVariable: %s=%s" % (self.key, v)
class Order(models.Model):
"""
Orders contain a copy of all the information at the time the order was
placed.
"""
site = models.ForeignKey(Site, verbose_name=_('Site'))
contact = models.ForeignKey(Contact, verbose_name=_('Contact'))
ship_addressee = models.CharField(_("Addressee"), max_length=61, blank=True)
ship_street1 = models.CharField(_("Street"), max_length=80, blank=True)
ship_street2 = models.CharField(_("Street"), max_length=80, blank=True)
ship_city = models.CharField(_("City"), max_length=50, blank=True)
ship_state = models.CharField(_("State"), max_length=50, blank=True)
ship_postal_code = models.CharField(_("Zip Code"), max_length=30, blank=True)
ship_country = models.CharField(_("Country"), max_length=2, blank=True)
bill_addressee = models.CharField(_("Addressee"), max_length=61, blank=True)
bill_street1 = models.CharField(_("Street"), max_length=80, blank=True)
bill_street2 = models.CharField(_("Street"), max_length=80, blank=True)
bill_city = models.CharField(_("City"), max_length=50, blank=True)
bill_state = models.CharField(_("State"), max_length=50, blank=True)
bill_postal_code = models.CharField(_("Zip Code"), max_length=30, blank=True)
bill_country = models.CharField(_("Country"), max_length=2, blank=True)
notes = models.TextField(_("Notes"), blank=True, null=True)
sub_total = CurrencyField(_("Subtotal"),
max_digits=18, decimal_places=10, blank=True, null=True, display_decimal=4)
total = CurrencyField(_("Total"),
max_digits=18, decimal_places=10, blank=True, null=True, display_decimal=4)
discount_code = models.CharField(
_("Discount Code"), max_length=20, blank=True, null=True,
help_text=_("Coupon Code"))
discount = CurrencyField(_("Discount amount"),
max_digits=18, decimal_places=10, blank=True, null=True)
method = models.CharField(_("Order method"),
choices=ORDER_CHOICES, max_length=50, blank=True)
shipping_description = models.CharField(_("Shipping Description"),
max_length=200, blank=True, null=True)
shipping_method = models.CharField(_("Shipping Method"),
max_length=200, blank=True, null=True)
shipping_model = models.CharField(_("Shipping Models"), choices=iterchoices_db(shipping.fields.shipping_choices),
max_length=30, blank=True, null=True)
shipping_cost = CurrencyField(_("Shipping Cost"),
max_digits=18, decimal_places=10, blank=True, null=True)
shipping_discount = CurrencyField(_("Shipping Discount"),
max_digits=18, decimal_places=10, blank=True, null=True)
tax = CurrencyField(_("Tax"),
max_digits=18, decimal_places=10, blank=True, null=True)
time_stamp = models.DateTimeField(_("Timestamp"), blank=True, null=True)
status = models.CharField(_("Status"), max_length=20, choices=ORDER_STATUS,
blank=True, help_text=_("This is set automatically."))
objects = OrderManager()
def __unicode__(self):
return "Order #%s: %s" % (self.id, self.contact.full_name)
def add_status(self, status=None, notes=""):
orderstatus = OrderStatus()
if not status:
try:
curr_status = self.orderstatus_set.latest()
status = curr_status.status
except OrderStatus.DoesNotExist:
status = 'New'
orderstatus.status = status
orderstatus.notes = notes
orderstatus.order = self
orderstatus.save()
def add_variable(self, key, value):
"""Add an OrderVariable, used for misc stuff that is just too small to get its own field"""
try:
v = self.variables.get(key__exact=key)
v.value = value
except OrderVariable.DoesNotExist:
v = OrderVariable(order=self, key=key, value=value)
v.save()
def _authorized_remaining(self):
auths = [p.amount for p in self.authorizations.filter(complete=False)]
if auths:
amount = reduce(operator.add, auths)
else:
amount = Decimal('0.00')
return amount
authorized_remaining = property(fget=_authorized_remaining)
def _get_count(self):
itemCount = 0
for item in self.orderitem_set.all():
itemCount += item.quantity
return (itemCount)
numItems = property(_get_count)
def get_variable(self, key, default=None):
qry = self.variables.filter(key__exact=key)
ct = qry.count()
if ct == 0:
return default
else:
return qry[0]
def copy_addresses(self):
"""
Copy the addresses so we know what the information was at time of order.
"""
shipaddress = self.contact.shipping_address
billaddress = self.contact.billing_address
self.ship_addressee = shipaddress.addressee
self.ship_street1 = shipaddress.street1
self.ship_street2 = shipaddress.street2
self.ship_city = shipaddress.city
self.ship_state = shipaddress.state
self.ship_postal_code = shipaddress.postal_code
self.ship_country = shipaddress.country.iso2_code
self.bill_addressee = billaddress.addressee
self.bill_street1 = billaddress.street1
self.bill_street2 = billaddress.street2
self.bill_city = billaddress.city
self.bill_state = billaddress.state
self.bill_postal_code = billaddress.postal_code
self.bill_country = billaddress.country.iso2_code
def remove_all_items(self):
"""Delete all items belonging to this order."""
for item in self.orderitem_set.all():
item.delete()
self.save()
def _balance(self):
if self.total is None:
self.force_recalculate_total(save=True)
return trunc_decimal(self.total-self.balance_paid, 2)
balance = property(fget=_balance)
def balance_forward(self):
return moneyfmt(self.balance)
balance_forward = property(fget=balance_forward)
def _balance_paid(self):
payments = [p.amount for p in self.payments.all()]
if payments:
paid = reduce(operator.add, payments)
else:
paid = Decimal("0.0000000000")
return paid + self.authorized_remaining
balance_paid = property(_balance_paid)
def _credit_card(self):
"""Return the credit card associated with this payment."""
from payment.models import CreditCardDetail
for payment in self.payments.order_by('-time_stamp'):
try:
if payment.creditcards.count() > 0:
return payment.creditcards.get()
except CreditCardDetail.DoesNotExist:
pass
return None
credit_card = property(_credit_card)
def _full_bill_street(self, delim="\n"):
"""
Return both billing street entries separated by delim.
Note - Use linebreaksbr filter to convert to html in templates.
"""
if self.bill_street2:
address = self.bill_street1 + delim + self.bill_street2
else:
address = self.bill_street1
return mark_safe(address)
full_bill_street = property(_full_bill_street)
def _full_ship_street(self, delim="\n"):
"""
Return both shipping street entries separated by delim.
Note - Use linebreaksbr filterto convert to html in templates.
"""
if self.ship_street2:
address = self.ship_street1 + delim + self.ship_street2
else:
address = self.ship_street1
return mark_safe(address)
full_ship_street = property(_full_ship_street)
def _ship_country_name(self):
return Country.objects.get(iso2_code=self.ship_country).name
ship_country_name = property(_ship_country_name)
def _bill_country_name(self):
return Country.objects.get(iso2_code=self.bill_country).name
bill_country_name = property(_bill_country_name)
def _ship_first_name(self):
"""Given the addressee name, try to return a first name"""
return ' '.join(self.ship_addressee.split()[0:-1]) or ''
ship_first_name = property(_ship_first_name)
def _ship_last_name(self):
"""Given the addressee name, try to return a last name"""
return ' '.join(self.ship_addressee.split()[-1:]) or ''
ship_last_name = property(_ship_last_name)
def _discounted_sub_total(self):
return self.sub_total - self.item_discount
discounted_sub_total = property(_discounted_sub_total)
def _get_balance_remaining_url(self):
return ('satchmo_balance_remaining_order', None, {'order_id' : self.id})
get_balance_remaining_url = models.permalink(_get_balance_remaining_url)
def _partially_paid(self):
return self.balance_paid > Decimal("0.0000000000")
partially_paid = property(_partially_paid)
def _is_partially_paid(self):
if self.total:
return (
float(self.balance) > 0.0
and float(self.balance_paid) > 0.0
and self.balance != self.balance_paid
)
else:
return False
is_partially_paid = property(fget=_is_partially_paid)
def payments_completed(self):
q = self.payments.exclude(transaction_id__isnull = False, transaction_id = "PENDING")
result = [p for p in q if p.amount]
return result
def save(self, **kwargs):
"""
Copy addresses from contact. If the order has just been created, set
the create_date.
"""
if not self.pk:
self.time_stamp = datetime.datetime.now()
self.copy_addresses()
super(Order, self).save(**kwargs) # Call the "real" save() method.
def invoice(self):
url = urlresolvers.reverse('satchmo_print_shipping', None, None, {'doc' : 'invoice', 'id' : self.id})
return mark_safe(u'<a href="%s">%s</a>' % (url, ugettext('View')))
invoice.allow_tags = True
def _item_discount(self):
"""Get the discount of just the items, less the shipping discount."""
return self.discount-self.shipping_discount
item_discount = property(_item_discount)
def packingslip(self):
url = urlresolvers.reverse('satchmo_print_shipping', None, None, {'doc' : 'packingslip', 'id' : self.id})
return mark_safe(u'<a href="%s">%s</a>' % (url, ugettext('View')))
packingslip.allow_tags = True
def recalculate_total(self, save=True):
"""Calculates sub_total, taxes and total if the order is not already partially paid."""
if self.is_partially_paid:
log.debug("Order %i - skipping recalculate_total since product is partially paid.", self.id)
else:
self.force_recalculate_total(save=save)
def force_recalculate_total(self, save=True):
"""Calculates sub_total, taxes and total."""
zero = Decimal("0.0000000000")
total_discount = Decimal("0.0000000000")
discount = Discount.objects.by_code(self.discount_code)
discount.calc(self)
discounts = discount.item_discounts
itemprices = []
fullprices = []
qty_override = config_value('SHOP','CART_QTY')
if qty_override:
itemct = self.numItems
for lineitem in self.orderitem_set.all():
lid = lineitem.id
if lid in discounts:
lineitem.discount = discounts[lid]
total_discount += lineitem.discount
#log.debug('total_discount (calc): %s', total_discount)
else:
lineitem.discount = zero
# now double check against other discounts, such as tiered discounts
if qty_override:
qty = itemct
else:
qty = lineitem.quantity
adjustment = get_product_quantity_adjustments(lineitem.product, qty=qty)
if adjustment and adjustment.price:
baseprice = adjustment.price.price
finalprice = adjustment.final_price()
#We need to add in any OrderItemDetail price adjustments before we do anything else
baseprice += lineitem.get_detail_price()
finalprice += lineitem.get_detail_price()
if baseprice > finalprice or baseprice != lineitem.unit_price:
unitdiscount = (lineitem.discount/lineitem.quantity) + baseprice-finalprice
unitdiscount = trunc_decimal(unitdiscount, 2)
linediscount = unitdiscount * lineitem.quantity
total_discount += linediscount
#log.debug('total_discount (line): %s', total_discount)
fullydiscounted = (baseprice - unitdiscount) * lineitem.quantity
lineitem.unit_price = baseprice
lineitem.discount = linediscount
lineitem.line_item_price = baseprice * lineitem.quantity
log.debug('Adjusting lineitem unit price for %s. Full price=%s, discount=%s. Final price for qty %d is %s',
lineitem.product.slug, baseprice, unitdiscount, lineitem.quantity, fullydiscounted)
if save:
lineitem.save()
itemprices.append(lineitem.sub_total)
fullprices.append(lineitem.line_item_price)
shipprice = Price()
shipprice.price = self.shipping_cost
shipadjust = PriceAdjustmentCalc(shipprice)
if 'Shipping' in discounts:
shipadjust += PriceAdjustment('discount', _('Discount'), discounts['Shipping'])
signals.satchmo_shipping_price_query.send(self, adjustment=shipadjust)
shipdiscount = shipadjust.total_adjustment()
self.shipping_discount = shipdiscount
total_discount += shipdiscount
#log.debug('total_discount (+ship): %s', total_discount)
self.discount = total_discount
if itemprices:
item_sub_total = reduce(operator.add, itemprices)
else:
item_sub_total = zero
if fullprices:
full_sub_total = reduce(operator.add, fullprices)
else:
full_sub_total = zero
self.sub_total = full_sub_total
taxProcessor = get_tax_processor(self)
totaltax, taxrates = taxProcessor.process()
self.tax = totaltax
# clear old taxes
for taxdetl in self.taxes.all():
taxdetl.delete()
for taxdesc, taxamt in taxrates.items():
taxdetl = OrderTaxDetail(order=self, tax=taxamt, description=taxdesc, method=taxProcessor.method)
taxdetl.save()
log.debug("Order #%i, recalc: sub_total=%s, shipping=%s, discount=%s, tax=%s",
self.id,
moneyfmt(item_sub_total),
moneyfmt(self.shipping_sub_total),
moneyfmt(self.discount),
moneyfmt(self.tax))
self.total = Decimal(item_sub_total + self.shipping_sub_total + self.tax)
if save:
self.save()
def shippinglabel(self):
url = urlresolvers.reverse('satchmo_print_shipping', None, None, {'doc' : 'shippinglabel', 'id' : self.id})
return mark_safe(u'<a href="%s">%s</a>' % (url, ugettext('View')))
shippinglabel.allow_tags = True
def _order_total(self):
#Needed for the admin list display
return moneyfmt(self.total)
order_total = property(_order_total)
def order_success(self):
"""Run each item's order_success method."""
log.info("Order success: %s", self)
for orderitem in self.orderitem_set.all():
subtype = orderitem.product.get_subtype_with_attr('order_success')
if subtype:
subtype.order_success(self, orderitem)
signals.order_success.send(self, order=self)
def order_cancel(self):
"""Ask if the order can be cancelled. By default, do not cancel shipped, completed and
already cancelled orders."""
self.is_cancellable = self.status not in ('Shipped', 'Completed', 'Cancelled')
# listeners can override default flag setting and (dis)allow cancellation
signals.order_cancel_query.send(self, order=self)
if self.is_cancellable:
self.add_status('Cancelled')
signals.order_cancelled.send(self, order=self)
return self.is_cancellable
def _paid_in_full(self):
"""True if total has been paid"""
return self.balance == Decimal('0.00')
paid_in_full = property(fget=_paid_in_full)
def _has_downloads(self):
"""Determine if there are any downloadable products on this order"""
if 'product.modules.downloadable' in settings.INSTALLED_APPS \
and self.downloadlink_set.count() > 0:
return True
return False
has_downloads = property(_has_downloads)
def _is_downloadable(self):
"""Determine if all products on this order are downloadable"""
for orderitem in self.orderitem_set.all():
if not orderitem.product.is_downloadable:
return False
return True
is_downloadable = property(_is_downloadable)
def _is_shippable(self):
"""Determine if we will be shipping any items on this order """
for orderitem in self.orderitem_set.all():
if orderitem.is_shippable:
return True
return False
is_shippable = property(_is_shippable)
def _shipping_sub_total(self):
if self.shipping_cost is None:
self.shipping_cost = Decimal('0.00')
if self.shipping_discount is None:
self.shipping_discount = Decimal('0.00')
return self.shipping_cost-self.shipping_discount
shipping_sub_total = property(_shipping_sub_total)
def _shipping_tax(self):
rates = self.taxes.filter(description__iexact = 'shipping')
if rates.count()>0:
tax = reduce(operator.add, [t.tax for t in rates])
else:
tax = Decimal("0.0000000000")
return tax
shipping_tax = property(_shipping_tax)
def _shipping_with_tax(self):
return self.shipping_sub_total + self.shipping_tax
shipping_with_tax = property(_shipping_with_tax)
def sub_total_with_tax(self):
return reduce(operator.add, [o.total_with_tax for o in self.orderitem_set.all()])
def update_status(self, status):
"""WARNING: To just change order status, use Order.add_status().
This method is called back when OrderStatus is saved and does not create required object."""
oldstatus = self.status
self.status = status
self.save()
if (oldstatus != self.status):
signals.satchmo_order_status_changed.send(self, oldstatus=oldstatus, newstatus=status, order=self)
def validate(self, request):
"""
Return whether the order is valid.
Not guaranteed to be side-effect free.
"""
valid = True
for orderitem in self.orderitem_set.all():
for subtype_name in orderitem.product.get_subtypes():
subtype = getattr(orderitem.product, subtype_name.lower())
validate_method = getattr(subtype, 'validate_order', None)
if validate_method:
valid = valid and validate_method(request, self, orderitem)
return valid
class Meta:
verbose_name = _("Product Order")
verbose_name_plural = _("Product Orders")
class OrderItem(models.Model):
"""
A line item on an order.
"""
order = models.ForeignKey(Order, verbose_name=_("Order"))
product = models.ForeignKey(Product, verbose_name=_("Product"))
quantity = models.DecimalField(_("Quantity"), max_digits=18, decimal_places=6)
unit_price = CurrencyField(_("Unit price"),
max_digits=18, decimal_places=10)
unit_tax = CurrencyField(_("Unit tax"), default=Decimal('0.00'),
max_digits=18, decimal_places=10)
line_item_price = CurrencyField(_("Line item price"),
max_digits=18, decimal_places=10)
tax = CurrencyField(_("Line item tax"), default=Decimal('0.00'),
max_digits=18, decimal_places=10)
expire_date = models.DateField(_("Subscription End"), help_text=_("Subscription expiration date."), blank=True, null=True)
completed = models.BooleanField(_("Completed"), default=False)
discount = CurrencyField(_("Line item discount"),
max_digits=18, decimal_places=10, blank=True, null=True)
def __unicode__(self):
return self.product.translated_name()
def _get_category(self):
return(self.product.get_category.translated_name())
category = property(_get_category)
def _is_shippable(self):
return self.product.is_shippable
is_shippable = property(fget=_is_shippable)
def _has_details(self):
"""Determine if this specific item has more detail"""
return (self.orderitemdetail_set.count() > 0)
has_details = property(_has_details)
def get_detail_price(self):
"""Get the delta price based on detail modifications"""
delta = Decimal("0.000000")
if self.has_details:
for detail in self.orderitemdetail_set.all():
if detail.price_change and detail.value:
delta += detail.price_change
return delta
def _sub_total(self):
if self.discount:
return self.line_item_price-self.discount
else:
return self.line_item_price
sub_total = property(_sub_total)
def _total_with_tax(self):
return self.sub_total + self.tax
total_with_tax = property(_total_with_tax)
def _unit_price_with_tax(self):
return self.unit_price + self.unit_tax
unit_price_with_tax = property(_unit_price_with_tax)
def _get_description(self):
return self.product.translated_name()
description = property(_get_description)
def _get_line_total(self):
return self.unit_price * self.quantity
line_total = property(_get_line_total)
def save(self, **kwargs):
self.update_tax()
super(OrderItem, self).save(**kwargs)
def update_tax(self):
taxclass = self.product.taxClass
processor = get_tax_processor(order=self.order)
if self.product.taxable:
self.unit_tax = processor.by_price(taxclass, self.unit_price)
self.tax = processor.by_orderitem(self)
class Meta:
verbose_name = _("Order Line Item")
verbose_name_plural = _("Order Line Items")
ordering = ('id',)
class OrderItemDetail(models.Model):
"""
Name, value pair and price delta associated with a specific item in an order
"""
item = models.ForeignKey(OrderItem, verbose_name=_("Order Item"), )
name = models.CharField(_('Name'), max_length=100)
value = models.CharField(_('Value'), max_length=255)
price_change = CurrencyField(_("Price Change"), max_digits=18, decimal_places=10, blank=True, null=True)
sort_order = models.IntegerField(_("Sort Order"),
help_text=_("The display order for this group."))
def __unicode__(self):
return u"%s - %s,%s" % (self.item, self.name, self.value)
class Meta:
verbose_name = _("Order Item Detail")
verbose_name_plural = _("Order Item Details")
ordering = ('sort_order',)
class OrderStatus(models.Model):
"""
An order will have multiple statuses as it moves its way through processing.
"""
order = models.ForeignKey(Order, verbose_name=_("Order"))
status = models.CharField(_("Status"),
max_length=20, choices=ORDER_STATUS, blank=True)
notes = models.CharField(_("Notes"), max_length=100, blank=True)
time_stamp = models.DateTimeField(_("Timestamp"))
def __unicode__(self):
return self.status
def save(self, **kwargs):
if not self.pk and not self.time_stamp:
self.time_stamp = datetime.datetime.now()
super(OrderStatus, self).save(**kwargs)
self.order.update_status(self.status)
class Meta:
verbose_name = _("Order Status")
verbose_name_plural = _("Order Statuses")
ordering = ('time_stamp',)
get_latest_by = 'time_stamp'
class OrderPaymentBase(models.Model):
payment = models.CharField(_("Payment Method"), choices=iterchoices_db(payment.config.labelled_gateway_choices),
max_length=25, blank=True)
amount = CurrencyField(_("amount"),
max_digits=18, decimal_places=10, blank=True, null=True)
time_stamp = models.DateTimeField(_("timestamp"), blank=True, null=True)
transaction_id = models.CharField(_("Transaction ID"), max_length=45, blank=True, null=True)
details = models.CharField(_("Details"), max_length=255, blank=True, null=True)
reason_code = models.CharField(_('Reason Code'), max_length=255, blank=True, null=True)
def _credit_card(self):
"""Return the credit card associated with this payment."""
try:
return self.creditcards.get()
except self.creditcards.model.DoesNotExist:
return None
credit_card = property(_credit_card)
def _amount_total(self):
return moneyfmt(self.amount)
amount_total = property(fget=_amount_total)
def save(self, **kwargs):
if not self.pk:
self.time_stamp = datetime.datetime.now()
super(OrderPaymentBase, self).save(**kwargs)
class Meta:
abstract = True
class OrderAuthorization(OrderPaymentBase):
order = models.ForeignKey(Order, related_name="authorizations")
capture = models.ForeignKey('OrderPayment', related_name="authorizations")
complete = models.BooleanField(_('Complete'), default=False)
def __unicode__(self):
if self.id is not None:
return u"Order Authorization #%i" % self.id
else:
return u"Order Authorization (unsaved)"
def remaining(self):
payments = [p.amount for p in self.order.payments.all()]
if payments:
amount = reduce(operator.add, payments)
else:
amount = Decimal('0.00')
remaining = self.order.total - amount
if remaining > self.amount:
remaining = self.amount
return trunc_decimal(remaining, 2)
def save(self, **kwargs):
# create linked payment
try:
capture = self.capture
except OrderPayment.DoesNotExist:
log.debug('Payment Authorization - creating linked payment')
log.debug('order is: %s', self.order)
self.capture = OrderPayment.objects.create_linked(self)
super(OrderPaymentBase, self).save(**kwargs)
class Meta:
verbose_name = _("Order Payment Authorization")
verbose_name_plural = _("Order Payment Authorizations")
class OrderPaymentManager(models.Manager):
def create_linked(self, other, **kwargs):
linked = OrderPayment(
order = other.order,
payment = other.payment,
amount=Decimal('0.00'),
transaction_id="LINKED",
details=other.details,
reason_code="")
linked.save(**kwargs)
return linked
class OrderPayment(OrderPaymentBase):
order = models.ForeignKey(Order, related_name="payments")
objects = OrderPaymentManager()
def __unicode__(self):
if self.id is not None:
return u"Order Payment #%i" % self.id
else:
return u"Order Payment (unsaved)"
class Meta:
verbose_name = _("Order Payment")
verbose_name_plural = _("Order Payments")
class OrderPendingPayment(OrderPaymentBase):
order = models.ForeignKey(Order, related_name="pendingpayments")
capture = models.ForeignKey('OrderPayment', related_name="pendingpayments")
def __unicode__(self):
if self.id is not None:
return u"Order Pending Payment #%i" % self.id
else:
return u"Order Pending Payment (unsaved)"
def save(self, **kwargs):
# create linked payment
try:
capture = self.capture
except OrderPayment.DoesNotExist:
log.debug('Pending Payment - creating linked payment')
self.capture = OrderPayment.objects.create_linked(self, **kwargs)
super(OrderPaymentBase, self).save(**kwargs)
class Meta:
verbose_name = _("Order Pending Payment")
verbose_name_plural = _("Order Pending Payments")
class OrderPaymentFailure(OrderPaymentBase):
order = models.ForeignKey(Order, null=True, blank=True, related_name='paymentfailures')
class OrderTaxDetail(models.Model):
"""A tax line item"""
order = models.ForeignKey(Order, related_name="taxes")
method = models.CharField(_("Model"), max_length=50, )
description = models.CharField(_("Description"), max_length=50, blank=True)
tax = CurrencyField(_("Tax"),
max_digits=18, decimal_places=10, blank=True, null=True)
def __unicode__(self):
if self.description:
return u"Tax: %s %s" % (self.description, self.tax)
else:
return u"Tax: %s" % self.tax
class Meta:
verbose_name = _('Order tax detail')
verbose_name_plural = _('Order tax details')
ordering = ('id',)
import config
import listeners
listeners.start_default_listening()
