django-orchestra/orchestra/apps/services/handlers.py

412 lines
17 KiB
Python
Raw Normal View History

import calendar
2014-09-03 13:56:02 +00:00
import datetime
import decimal
2014-09-03 13:56:02 +00:00
from dateutil import relativedelta
2014-07-21 12:20:04 +00:00
from django.contrib.contenttypes.models import ContentType
from django.db.models import Q
from django.utils import timezone
2014-07-21 12:20:04 +00:00
from django.utils.translation import ugettext_lazy as _
from orchestra.utils import plugins
2014-09-10 16:53:09 +00:00
from orchestra.utils.python import AttributeDict
2014-07-21 12:20:04 +00:00
2014-09-14 09:52:45 +00:00
from . import settings, helpers
2014-07-21 12:20:04 +00:00
class ServiceHandler(plugins.Plugin):
"""
Separates all the logic of billing handling from the model allowing to better
customize its behaviout
"""
2014-07-21 12:20:04 +00:00
model = None
__metaclass__ = plugins.PluginMount
def __init__(self, service):
self.service = service
2014-07-21 15:43:36 +00:00
def __getattr__(self, attr):
return getattr(self.service, attr)
2014-07-21 12:20:04 +00:00
@classmethod
def get_plugin_choices(cls):
choices = super(ServiceHandler, cls).get_plugin_choices()
return [('', _("Default"))] + choices
2014-07-21 15:43:36 +00:00
def get_content_type(self):
if not self.model:
return self.content_type
app_label, model = self.model.split('.')
return ContentType.objects.get_by_natural_key(app_label, model.lower())
2014-07-21 12:20:04 +00:00
def matches(self, instance):
safe_locals = {
instance._meta.model_name: instance
}
return eval(self.match, safe_locals)
def get_metric(self, instance):
2014-07-21 15:43:36 +00:00
if self.metric:
safe_locals = {
instance._meta.model_name: instance
}
return eval(self.metric, safe_locals)
def get_billing_point(self, order, bp=None, **options):
2014-09-03 13:56:02 +00:00
not_cachable = self.billing_point == self.FIXED_DATE and options.get('fixed_point')
if not_cachable or bp is None:
bp = options.get('billing_point', timezone.now().date())
if not options.get('fixed_point'):
2014-09-03 13:56:02 +00:00
msg = ("Support for '%s' period and '%s' point is not implemented"
% (self.get_billing_period_display(), self.get_billing_point_display()))
if self.billing_period == self.MONTHLY:
date = bp
2014-09-03 13:56:02 +00:00
if self.payment_style == self.PREPAY:
date += relativedelta.relativedelta(months=1)
2014-09-22 15:59:53 +00:00
else:
date = timezone.now().date()
2014-09-03 13:56:02 +00:00
if self.billing_point == self.ON_REGISTER:
day = order.registered_on.day
2014-09-03 13:56:02 +00:00
elif self.billing_point == self.FIXED_DATE:
day = 1
2014-09-03 13:56:02 +00:00
else:
raise NotImplementedError(msg)
2014-09-10 16:53:09 +00:00
bp = datetime.datetime(year=date.year, month=date.month, day=day,
tzinfo=timezone.get_current_timezone()).date()
2014-09-03 13:56:02 +00:00
elif self.billing_period == self.ANUAL:
if self.billing_point == self.ON_REGISTER:
month = order.registered_on.month
day = order.registered_on.day
2014-09-03 13:56:02 +00:00
elif self.billing_point == self.FIXED_DATE:
2014-09-17 10:32:29 +00:00
month = settings.SERVICES_SERVICE_ANUAL_BILLING_MONTH
day = 1
2014-09-03 13:56:02 +00:00
else:
raise NotImplementedError(msg)
year = bp.year
2014-09-03 13:56:02 +00:00
if self.payment_style == self.POSTPAY:
2014-09-22 15:59:53 +00:00
year = bp.year - relativedelta.relativedelta(years=1)
if bp.month >= month:
year = bp.year + 1
bp = datetime.datetime(year=year, month=month, day=day,
tzinfo=timezone.get_current_timezone()).date()
2014-09-03 13:56:02 +00:00
elif self.billing_period == self.NEVER:
bp = order.registered_on
else:
2014-09-03 13:56:02 +00:00
raise NotImplementedError(msg)
if self.on_cancel != self.NOTHING and order.cancelled_on and order.cancelled_on < bp:
return order.cancelled_on
return bp
def get_price_size(self, ini, end):
rdelta = relativedelta.relativedelta(end, ini)
if self.billing_period == self.MONTHLY:
size = rdelta.years * 12
size += rdelta.months
2014-09-03 13:56:02 +00:00
days = calendar.monthrange(end.year, end.month)[1]
size += decimal.Decimal(rdelta.days)/days
elif self.billing_period == self.ANUAL:
size = rdelta.years
size += decimal.Decimal(rdelta.months)/12
2014-09-03 13:56:02 +00:00
days = 366 if calendar.isleap(end.year) else 365
size += decimal.Decimal(rdelta.days)/days
elif self.billing_period == self.NEVER:
size = 1
else:
raise NotImplementedError
return decimal.Decimal(size)
def get_pricing_slots(self, ini, end):
2014-09-22 15:59:53 +00:00
day = 1
month = settings.SERVICES_SERVICE_ANUAL_BILLING_MONTH
if self.billing_point == self.ON_REGISTER:
day = ini.day
month = ini.month
period = self.get_pricing_period()
2014-09-03 13:56:02 +00:00
if period == self.MONTHLY:
2014-09-22 15:59:53 +00:00
ini = datetime.datetime(year=ini.year, month=ini.month, day=day,
tzinfo=timezone.get_current_timezone()).date()
2014-09-03 13:56:02 +00:00
rdelta = relativedelta.relativedelta(months=1)
elif period == self.ANUAL:
2014-09-22 15:59:53 +00:00
ini = datetime.datetime(year=ini.year, month=month, day=day,
tzinfo=timezone.get_current_timezone()).date()
2014-09-03 13:56:02 +00:00
rdelta = relativedelta.relativedelta(years=1)
elif period == self.NEVER:
yield ini, end
raise StopIteration
else:
raise NotImplementedError
while True:
next = ini + rdelta
2014-09-22 15:59:53 +00:00
yield ini, next
if next >= end:
break
ini = next
def generate_discount(self, line, dtype, price):
line.discounts.append(AttributeDict(**{
'type': dtype,
'total': price,
}))
2014-09-03 13:56:02 +00:00
def generate_line(self, order, price, size, ini, end, discounts=[]):
subtotal = self.nominal_price * size
line = AttributeDict(**{
2014-09-10 16:53:09 +00:00
'order': order,
'subtotal': subtotal,
'size': size,
'ini': ini,
'end': end,
'discounts': [],
2014-09-10 16:53:09 +00:00
})
discounted = 0
for dtype, dprice in discounts:
self.generate_discount(line, dtype, dprice)
discounted += dprice
2014-09-19 14:47:25 +00:00
subtotal += discounted
if subtotal > price:
self.generate_discount(line, 'volume', price-subtotal)
return line
2014-09-19 14:47:25 +00:00
def assign_compensations(self, givers, receivers, commit=True):
compensations = []
for order in givers:
if order.billed_until and order.cancelled_on and order.cancelled_on < order.billed_until:
interval = helpers.Interval(order.cancelled_on, order.billed_until, order)
2014-09-18 15:07:39 +00:00
compensations.append(interval)
for order in receivers:
if not order.billed_until or order.billed_until < order.new_billed_until:
# receiver
ini = order.billed_until or order.registered_on
end = order.cancelled_on or datetime.date.max
2014-09-19 14:47:25 +00:00
interval = helpers.Interval(ini, end)
compensations, used_compensations = helpers.compensate(interval, compensations)
order._compensations = used_compensations
for comp in used_compensations:
2014-09-19 14:47:25 +00:00
# TODO get min right
comp.order.new_billed_until = min(comp.order.billed_until, comp.ini,
getattr(comp.order, 'new_billed_until', datetime.date.max))
if commit:
for order in givers:
if hasattr(order, 'new_billed_until'):
order.billed_until = order.new_billed_until
order.save()
2014-09-19 14:47:25 +00:00
def apply_compensations(self, order, only_beyond=False):
dsize = 0
discounts = ()
ini = order.billed_until or order.registered_on
end = order.new_billed_until
beyond = end
cend = None
for comp in getattr(order, '_compensations', []):
intersect = comp.intersect(helpers.Interval(ini=ini, end=end))
if intersect:
cini, cend = intersect.ini, intersect.end
if comp.end > beyond:
cend = comp.end
if only_beyond:
cini = beyond
elif not only_beyond:
continue
dsize += self.get_price_size(cini, cend)
# Extend billing point a little bit to benefit from a substantial discount
elif comp.end > beyond and (comp.end-comp.ini).days > 3*(comp.ini-beyond).days:
cend = comp.end
dsize += self.get_price_size(comp.ini, cend)
return dsize, cend
def get_register_or_renew_events(self, porders, ini, end):
# TODO count intermediat billing points too
counter = 0
for order in porders:
bu = getattr(order, 'new_billed_until', order.billed_until)
if bu:
2014-09-22 15:59:53 +00:00
if order.registered_on > ini and order.registered_on <= end:
counter += 1
2014-09-22 15:59:53 +00:00
if order.registered_on != bu and bu > ini and bu <= end:
counter += 1
if order.billed_until and order.billed_until != bu:
2014-09-22 15:59:53 +00:00
if order.registered_on != order.billed_until and order.billed_until > ini and order.billed_until <= end:
counter += 1
return counter
def bill_concurrent_orders(self, account, porders, rates, ini, end, commit=True):
# Concurrent
# Get pricing orders
priced = {}
for ini, end, orders in helpers.get_chunks(porders, ini, end):
size = self.get_price_size(ini, end)
metric = len(orders)
interval = helpers.Interval(ini=ini, end=end)
2014-09-22 15:59:53 +00:00
for position, order in enumerate(orders, start=1):
csize = 0
compensations = getattr(order, '_compensations', [])
2014-09-19 14:47:25 +00:00
# Compensations < new_billed_until
for comp in compensations:
intersect = comp.intersect(interval)
if intersect:
csize += self.get_price_size(intersect.ini, intersect.end)
price = self.get_price(account, metric, position=position, rates=rates)
price = price * size
cprice = price * (size-csize)
if order in prices:
priced[order][0] += price
priced[order][1] += cprice
else:
priced[order] = (price, cprice)
lines = []
for order, prices in priced.iteritems():
# Generate lines and discounts from order.nominal_price
price, cprice = prices
2014-09-19 14:47:25 +00:00
# Compensations > new_billed_until
dsize, new_end = self.apply_compensations(order, only_beyond=True)
cprice += dsize*price
if cprice:
2014-09-19 14:47:25 +00:00
discounts = (('compensation', -cprice),)
if new_end:
size = self.get_price_size(order.new_billed_until, new_end)
price += price*size
order.new_billed_until = new_end
line = self.generate_line(order, price, size, ini, end, discounts=discounts)
lines.append(line)
if commit:
order.billed_until = order.new_billed_until
order.save()
return lines
2014-09-19 14:47:25 +00:00
def bill_registered_or_renew_events(self, account, porders, rates, commit=True):
# Before registration
lines = []
2014-09-22 15:59:53 +00:00
period = self.get_pricing_period()
if period == self.MONTHLY:
rdelta = relativedelta.relativedelta(months=1)
elif period == self.ANUAL:
rdelta = relativedelta.relativedelta(years=1)
elif period == self.NEVER:
raise NotImplementedError("Rates with no pricing period?")
2014-09-22 15:59:53 +00:00
for position, order in enumerate(porders, start=1):
if hasattr(order, 'new_billed_until'):
2014-09-19 14:47:25 +00:00
pend = order.billed_until or order.registered_on
pini = pend - rdelta
metric = self.get_register_or_renew_events(porders, pini, pend)
price = self.get_price(account, metric, position=position, rates=rates)
2014-09-19 14:47:25 +00:00
ini = order.billed_until or order.registered_on
end = order.new_billed_until
discounts = ()
dsize, new_end = self.apply_compensations(order)
if dsize:
discounts=(('compensation', -dsize*price),)
if new_end:
order.new_billed_until = new_end
end = new_end
size = self.get_price_size(ini, end)
price = price * size
2014-09-19 14:47:25 +00:00
line = self.generate_line(order, price, size, ini, end, discounts=discounts)
lines.append(line)
if commit:
order.billed_until = order.new_billed_until
order.save()
2014-09-22 15:59:53 +00:00
return lines
2014-09-10 16:53:09 +00:00
def bill_with_orders(self, orders, account, **options):
2014-09-14 09:52:45 +00:00
# For the "boundary conditions" just think that:
# date(2011, 1, 1) is equivalent to datetime(2011, 1, 1, 0, 0, 0)
# In most cases:
# ini >= registered_date, end < registered_date
commit = options.get('commit', True)
2014-09-19 14:47:25 +00:00
# boundary lookup and exclude cancelled and billed
orders_ = []
bp = None
2014-09-14 09:52:45 +00:00
ini = datetime.date.max
end = datetime.date.min
2014-09-14 09:52:45 +00:00
for order in orders:
cini = order.registered_on
if order.billed_until:
2014-09-19 14:47:25 +00:00
# exclude cancelled and billed
if self.on_cancel != self.REFOUND:
if order.cancelled_on and order.billed_until > order.cancelled_on:
continue
2014-09-14 09:52:45 +00:00
cini = order.billed_until
bp = self.get_billing_point(order, bp=bp, **options)
order.new_billed_until = bp
ini = min(ini, cini)
end = max(end, bp)
2014-09-19 14:47:25 +00:00
orders_.append(order)
orders = orders_
# Compensation
2014-09-17 10:32:29 +00:00
related_orders = account.orders.filter(service=self.service)
2014-09-18 15:07:39 +00:00
if self.on_cancel == self.DISCOUNT:
2014-09-14 19:36:27 +00:00
# Get orders pending for compensation
2014-09-19 14:47:25 +00:00
givers = list(related_orders.givers(ini, end))
2014-09-14 19:36:27 +00:00
givers.sort(cmp=helpers.cmp_billed_until_or_registered_on)
orders.sort(cmp=helpers.cmp_billed_until_or_registered_on)
2014-09-19 14:47:25 +00:00
self.assign_compensations(givers, orders, commit=commit)
2014-09-14 19:36:27 +00:00
rates = self.get_rates(account)
2014-09-14 22:00:00 +00:00
if rates:
2014-09-19 14:47:25 +00:00
porders = related_orders.pricing_orders(ini, end)
porders = list(set(orders).union(set(porders)))
porders.sort(cmp=helpers.cmp_billed_until_or_registered_on)
2014-09-22 15:59:53 +00:00
if self.billing_period != self.NEVER and self.get_pricing_period == self.NEVER:
liens = self.bill_concurrent_orders(account, porders, rates, ini, end, commit=commit)
else:
2014-09-19 14:47:25 +00:00
# TODO compensation in this case?
lines = self.bill_registered_or_renew_events(account, porders, rates, commit=commit)
2014-09-14 22:00:00 +00:00
else:
lines = []
price = self.nominal_price
# Calculate nominal price
for order in orders:
2014-09-14 19:36:27 +00:00
ini = order.billed_until or order.registered_on
end = order.new_billed_until
2014-09-19 14:47:25 +00:00
discounts = ()
dsize, new_end = self.apply_compensations(order)
if dsize:
discounts=(('compensation', -dsize*price),)
if new_end:
order.new_billed_until = new_end
end = new_end
size = self.get_price_size(ini, end)
2014-09-19 14:47:25 +00:00
line = self.generate_line(order, price*size, size, ini, end, discounts=discounts)
lines.append(line)
if commit:
order.billed_until = order.new_billed_until
order.save()
return lines
2014-09-14 09:52:45 +00:00
def bill_with_metric(self, orders, account, **options):
2014-09-19 14:47:25 +00:00
# TODO filter out orders with cancelled_on < billed_until ?
lines = []
2014-09-10 16:53:09 +00:00
commit = options.get('commit', True)
2014-09-22 15:59:53 +00:00
bp = None
for order in orders:
bp = self.get_billing_point(order, bp=bp, **options)
ini = order.billed_until or order.registered_on
2014-09-03 13:56:02 +00:00
if bp <= ini:
continue
order.new_billed_until = bp
# weighted metric; bill line per pricing period
prev = None
lines_info = []
for ini, end in self.get_pricing_slots(ini, bp):
metric = order.get_metric(ini, end)
price = self.get_price(order, metric)
2014-09-22 15:59:53 +00:00
lines.append(self.generate_line(order, price, metric, ini, end))
2014-09-10 16:53:09 +00:00
if commit:
order.billed_until = order.new_billed_until
2014-09-10 16:53:09 +00:00
order.save()
return lines
def generate_bill_lines(self, orders, account, **options):
2014-09-22 15:59:53 +00:00
if options.get('proforma', False):
options['commit'] = False
if not self.metric:
lines = self.bill_with_orders(orders, account, **options)
else:
lines = self.bill_with_metric(orders, account, **options)
return lines