Commit 7bce1dc7 authored by Jean-Paul Smets's avatar Jean-Paul Smets

Moved PeriodicityMixin from Alarm to explicit mixin

git-svn-id: https://svn.erp5.org/repos/public/erp5/sandbox/amount_generator@34957 20353a03-c40f-0410-a6d1-a30d3c3de9de
parent f86357c1
...@@ -28,192 +28,15 @@ ...@@ -28,192 +28,15 @@
############################################################################## ##############################################################################
from compiler.consts import CO_VARKEYWORDS from compiler.consts import CO_VARKEYWORDS
from AccessControl import ClassSecurityInfo from DateTime import DateTime
from AccessControl import Unauthorized from AccessControl import ClassSecurityInfo, Unauthorized
from AccessControl.SecurityManagement import getSecurityManager, \
setSecurityManager, newSecurityManager
from Products.CMFCore.utils import getToolByName from Products.CMFCore.utils import getToolByName
from Products.ERP5Type import Permissions, PropertySheet from Products.ERP5Type import Permissions, PropertySheet
from Products.ERP5Type.XMLObject import XMLObject from Products.ERP5Type.XMLObject import XMLObject
from DateTime import DateTime
from Products.ERP5Type.Message import Message
from Products.ERP5Type.DateUtils import addToDate, atTheEndOfPeriod
from Products.ERP5Security.ERP5UserManager import SUPER_USER from Products.ERP5Security.ERP5UserManager import SUPER_USER
from AccessControl.SecurityManagement import getSecurityManager, \ from Products.ERP5.mixin.periodicity import PeriodicityMixin
setSecurityManager, newSecurityManager
class PeriodicityMixin:
"""
Periodicity is a Mixin Class used to calculate date periodicity.
"""
security = ClassSecurityInfo()
security.declareObjectProtected(Permissions.AccessContentsInformation)
def _validateMinute(self, date, previous_date):
"""
Validate if date's minute matches the periodicity definition
"""
periodicity_minute_frequency = self.getPeriodicityMinuteFrequency()
periodicity_minute_list = self.getPeriodicityMinuteList()
if (periodicity_minute_frequency is None) and \
(periodicity_minute_list in ([], None, ())):
# in this case, we may want to have an periodicity every hour
# based on the start date
# without defining anything about minutes periodicity,
# so we compare with minutes with the one defined
# in the previous alarm date
return (date.minute() == previous_date.minute())
if periodicity_minute_frequency not in ('', None):
return (date.minute() % periodicity_minute_frequency) == 0
elif len(periodicity_minute_list) > 0:
return date.minute() in periodicity_minute_list
def _validateHour(self, date):
"""
Validate if date's hour matches the periodicity definition
"""
periodicity_hour_frequency = self.getPeriodicityHourFrequency()
periodicity_hour_list = self.getPeriodicityHourList()
if (periodicity_hour_frequency is None) and \
(periodicity_hour_list in ([], None, ())):
return 1
if periodicity_hour_frequency not in ('', None):
return (date.hour() % periodicity_hour_frequency) == 0
elif len(periodicity_hour_list) > 0:
return date.hour() in periodicity_hour_list
def _validateDay(self, date):
"""
Validate if date's day matches the periodicity definition
"""
periodicity_day_frequency = self.getPeriodicityDayFrequency()
periodicity_month_day_list = self.getPeriodicityMonthDayList()
if (periodicity_day_frequency is None) and \
(periodicity_month_day_list in ([], None, ())):
return 1
if periodicity_day_frequency not in ('', None):
return (date.day() % periodicity_day_frequency) == 0
elif len(periodicity_month_day_list) > 0:
return date.day() in periodicity_month_day_list
def _validateWeek(self, date):
"""
Validate if date's week matches the periodicity definition
"""
periodicity_week_frequency = self.getPeriodicityWeekFrequency()
periodicity_week_day_list = self.getPeriodicityWeekDayList()
periodicity_week_list = self.getPeriodicityWeekList()
if (periodicity_week_frequency is None) and \
(periodicity_week_day_list in ([], None, ())) and \
(periodicity_week_list is None):
return 1
if periodicity_week_frequency not in ('', None):
if not((date.week() % periodicity_week_frequency) == 0):
return 0
if periodicity_week_day_list not in (None, (), []):
if not (date.Day() in periodicity_week_day_list):
return 0
if periodicity_week_list not in (None, (), []):
if not (date.week() in periodicity_week_list):
return 0
return 1
def _validateMonth(self, date):
"""
Validate if date's month matches the periodicity definition
"""
periodicity_month_frequency = self.getPeriodicityMonthFrequency()
periodicity_month_list = self.getPeriodicityMonthList()
if (periodicity_month_frequency is None) and \
(periodicity_month_list in ([], None, ())):
return 1
if periodicity_month_frequency not in ('', None):
return (date.month() % periodicity_month_frequency) == 0
elif len(periodicity_month_list) > 0:
return date.month() in periodicity_month_list
security.declareProtected(Permissions.AccessContentsInformation, 'getNextPeriodicalDate')
def getNextPeriodicalDate(self, current_date, next_start_date=None):
"""
Get the next date where this periodic event should start.
We have to take into account the start date, because
sometimes an event may be started by hand. We must be
sure to never forget to start an event, even with some
delays.
Here are some rules :
- if the periodicity start date is in the past and we never starts
this periodic event, then return the periodicity start date.
- if the periodicity start date is in the past but we already
have started the periodic event, then see
XXX Better API is needed. It may defined which minimal time duration has to
be added in order to calculate next date.
Ex: here, we use minute as smaller duration.
On CalendarPeriod, day is the smaller duration.
"""
periodicity_stop_date = self.getPeriodicityStopDate()
if next_start_date is None:
next_start_date = current_date
if next_start_date > current_date \
or (periodicity_stop_date is not None \
and next_start_date >= periodicity_stop_date):
return None
previous_date = next_start_date
next_start_date = max(addToDate(next_start_date, minute=1), current_date)
while 1:
if not self._validateMonth(next_start_date):
next_start_date = atTheEndOfPeriod(next_start_date, 'month')
elif not (self._validateDay(next_start_date) and
self._validateWeek(next_start_date)):
next_start_date = atTheEndOfPeriod(next_start_date, 'day')
elif not self._validateMinute(next_start_date, previous_date):
next_start_date = addToDate(next_start_date, minute=1)
elif not self._validateHour(next_start_date):
next_start_date = addToDate(next_start_date, hour=1)
else:
parts = list(next_start_date.parts())
parts[5] = previous_date.second() # XXX keep old behaviour
return DateTime(*parts)
# XXX May be we should create a Date class for following methods ???
security.declareProtected(Permissions.AccessContentsInformation, 'getWeekDayList')
def getWeekDayList(self):
"""
returns something like ['Sunday','Monday',...]
"""
return DateTime._days
security.declareProtected(Permissions.AccessContentsInformation, 'getWeekDayItemList')
def getWeekDayItemList(self):
"""
returns something like [('Sunday', 'Sunday'), ('Monday', 'Monday'),...]
"""
return [(Message(domain='erp5_ui', message=x), x) \
for x in self.getWeekDayList()]
security.declareProtected(Permissions.AccessContentsInformation, 'getWeekDayItemList')
def getMonthItemList(self):
"""
returns something like [('January', 1), ('February', 2),...]
"""
# DateTime._months return '' as first item
return [(Message(domain='erp5_ui', message=DateTime._months[i]), i) \
for i in range(1, len(DateTime._months))]
security.declareProtected(Permissions.AccessContentsInformation,'getPeriodicityWeekDayList')
def getPeriodicityWeekDayList(self):
"""
Make sure that the list of days is ordered
"""
#LOG('getPeriodicityWeekDayList',0,'we should order')
day_list = self._baseGetPeriodicityWeekDayList()
new_list = []
for day in self.getWeekDayList():
if day_list is not None:
if day in day_list:
new_list += [day]
return new_list
class Alarm(XMLObject, PeriodicityMixin): class Alarm(XMLObject, PeriodicityMixin):
""" """
......
...@@ -696,7 +696,7 @@ class Delivery(XMLObject, ImmobilisationDelivery, ...@@ -696,7 +696,7 @@ class Delivery(XMLObject, ImmobilisationDelivery,
########################################################################## ##########################################################################
# Applied Rule stuff # Applied Rule stuff
@UnrestrictedMethod @UnrestrictedMethod # XXX-JPS What is this ?
def updateAppliedRule(self, rule_reference=None, rule_id=None, force=0, def updateAppliedRule(self, rule_reference=None, rule_id=None, force=0,
**kw): **kw):
""" """
...@@ -785,6 +785,8 @@ class Delivery(XMLObject, ImmobilisationDelivery, ...@@ -785,6 +785,8 @@ class Delivery(XMLObject, ImmobilisationDelivery,
Reexpand applied rule Reexpand applied rule
Also reexpand all rules related to movements Also reexpand all rules related to movements
NOTE: seems to be deprecated ?
""" """
excluded_rule_path_list = [] excluded_rule_path_list = []
if applied_rule_id is not None: if applied_rule_id is not None:
......
# -*- coding: utf-8 -*-
############################################################################## ##############################################################################
# #
# Copyright (c) 2009 Nexedi KK, Nexedi SA and Contributors. All Rights Reserved. # Copyright (c) 2009 Nexedi KK, Nexedi SA and Contributors. All Rights Reserved.
...@@ -28,8 +29,7 @@ ...@@ -28,8 +29,7 @@
from AccessControl import ClassSecurityInfo from AccessControl import ClassSecurityInfo
from Products.ERP5Type import Permissions, PropertySheet from Products.ERP5Type import Permissions, PropertySheet
from Products.ERP5.Document.Path import Path from Products.ERP5.Document.Path import Path
from Products.ERP5.Document.Alarm import PeriodicityMixin from Products.ERP5.mixin.periodicity import PeriodicityMixin
class PeriodicityLineMixin(PeriodicityMixin): class PeriodicityLineMixin(PeriodicityMixin):
""" """
......
# -*- coding: utf-8 -*-
############################################################################## ##############################################################################
# #
# Copyright (c) 2006,2007 Nexedi SARL and Contributors. All Rights Reserved. # Copyright (c) 2006,2007 Nexedi SARL and Contributors. All Rights Reserved.
...@@ -31,7 +32,7 @@ ...@@ -31,7 +32,7 @@
from AccessControl import ClassSecurityInfo from AccessControl import ClassSecurityInfo
from Products.ERP5Type import Permissions, PropertySheet from Products.ERP5Type import Permissions, PropertySheet
from Products.ERP5.Document.Alarm import PeriodicityMixin from Products.ERP5.mixin.periodicity import PeriodicityMixin
from Products.ERP5.Document.Movement import Movement from Products.ERP5.Document.Movement import Movement
from Products.ERP5Type.DateUtils import addToDate from Products.ERP5Type.DateUtils import addToDate
......
...@@ -33,8 +33,9 @@ from AccessControl import ClassSecurityInfo ...@@ -33,8 +33,9 @@ from AccessControl import ClassSecurityInfo
from Products.ERP5Type import Permissions, PropertySheet, interfaces from Products.ERP5Type import Permissions, PropertySheet, interfaces
from Products.ERP5.Document.Item import Item from Products.ERP5.Document.Item import Item
from Products.ERP5.mixin.movement_generator import MovementGeneratorMixin from Products.ERP5.mixin.movement_generator import MovementGeneratorMixin
from Products.ERP5.mixin.periodicity import PeriodicityMixin
class SubscriptionItem(Item, MovementGeneratorMixin): class SubscriptionItem(Item, MovementGeneratorMixin, PeriodicityMixin):
""" """
A SubscriptionItem is an Item which expands itself A SubscriptionItem is an Item which expands itself
into simulation movements which represent the item future. into simulation movements which represent the item future.
...@@ -58,6 +59,7 @@ class SubscriptionItem(Item, MovementGeneratorMixin): ...@@ -58,6 +59,7 @@ class SubscriptionItem(Item, MovementGeneratorMixin):
, PropertySheet.Item , PropertySheet.Item
, PropertySheet.Amount , PropertySheet.Amount
, PropertySheet.Reference , PropertySheet.Reference
, PropertySheet.Periodicity
) )
# Declarative interfaces # Declarative interfaces
...@@ -153,13 +155,50 @@ class SubscriptionItem(Item, MovementGeneratorMixin): ...@@ -153,13 +155,50 @@ class SubscriptionItem(Item, MovementGeneratorMixin):
""" """
Input movement list comes from order Input movement list comes from order
""" """
# Here, we just generate movements result = []
# as a time sries catalog_tool = getToolByName(self, 'portal_catalog')
return
order = context.getDefaultCausalityValue() # Try to find the source open order
if order is None: open_order_movement_list = self.getAggregateRelatedValueList(
return [] portal_type="Open Order Line") # XXX-JPS Hard Coded
else: if not open_order_movement_list: return result
return order.getMovementList(
portal_type=order.getPortalOrderMovementTypeList()) # Find out which parent open orders
explanation_uid_list = map(lambda x:x.getParentUid(), open_order_movement_list) # Instead, should call getDeliveryValue or equivalent
open_order_list = catalog_tool.searchResults(uid = explanation_uid_list,
validation_state = 'validated') # XXX-JPS hard coding
# Now generate movements for each valid open order
for movement in open_order_movement_list:
if movement.getParentValue().getValidationState() == 'open': # XXX-JPS hard coding
resource = movement.getResource()
start_date = movement.getStartDate()
stop_date = movement.getStopDate()
source = movement.getSource()
source_section = movement.getSourceSection()
destination = movement.getDestination()
destination_section = movement.getDestinationSection() # XXX More arrows ? use context instead ?
quantity = self.getQuantity() # Is it so ? XXX-JPS
quantity_unit = movement.getQuantityUnit()
price = movement.getPrice()
current_date = start_date
while current_date < stop_date:
next_date = self.getNextPeriodicalDate(current_date)
movement = self.newContent(temp_object=1,
portal_type='Sale Order Line', # XXX-JPS Hard Coded
resource=resource,
quantity=quantity,
quantity_unit=quantity_unit,
price=price,
start_date=current_date,
stop_date=next_date,
source=source,
source_section=source_section,
destination=destination,
destination_section=destination_section,
)
result.append(movement)
current_date = next_date
# And now return result
return result
\ No newline at end of file
...@@ -28,6 +28,8 @@ ...@@ -28,6 +28,8 @@
############################################################################## ##############################################################################
from DateTime import DateTime from DateTime import DateTime
from AccessControl import ClassSecurityInfo
from Products.ERP5Type import Permissions
from Products.ERP5Type.Message import Message from Products.ERP5Type.Message import Message
from Products.ERP5Type.DateUtils import addToDate, atTheEndOfPeriod from Products.ERP5Type.DateUtils import addToDate, atTheEndOfPeriod
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment