Periodicity.py 8.8 KB
Newer Older
Sebastien Robin's avatar
Sebastien Robin committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
##############################################################################
#
# Copyright (c) 2004 Nexedi SARL and Contributors. All Rights Reserved.
#                    Sebastien Robin <seb@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

from AccessControl import ClassSecurityInfo
from Products.CMFCore.utils import getToolByName
from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
from Products.ERP5Type.Base import Base
from Acquisition import aq_base, aq_parent, aq_inner, aq_acquire
from Products.CMFCore.utils import getToolByName
from DateTime import DateTime
36
from Products.ERP5Type.DateUtils import addToDate
Sebastien Robin's avatar
Sebastien Robin committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

from zLOG import LOG



class Periodicity(Base):
    """
    An Alarm is in charge of checking anything (quantity of a certain
    resource on the stock, consistency of some order,....) periodically.

    It should also provide a solution if something wrong happens.

    Some information should be displayed to the user, and also notifications.
    """

    # CMF Type Definition
    meta_type = 'ERP5 Periodicity'
    portal_type = 'Periodicity'
    add_permission = Permissions.AddPortalContent
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
61
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Sebastien Robin's avatar
Sebastien Robin committed
62 63 64 65 66 67 68

    # Default Properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.DublinCore
                      , PropertySheet.Periodicity
                      )

69 70
    security.declareProtected(Permissions.View, 'setNextAlarmDate')
    def setNextAlarmDate(self,current_date=None):
Sebastien Robin's avatar
Sebastien Robin committed
71 72 73 74 75 76 77 78 79 80 81 82
      """
      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, event 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
Aurel's avatar
Aurel committed
83
        have started the periodic event, then see
Sebastien Robin's avatar
Sebastien Robin committed
84
      """
85 86

      if self.getPeriodicityStartDate() is None:
87
        return
88
      next_start_date = self.getAlarmDate()
Aurel's avatar
Aurel committed
89
      if current_date is None:
90 91 92
        # This is usefull to set the current date as parameter for
        # unit testing, by default it should be now
        current_date = DateTime()
93
      if next_start_date > current_date:
94 95
        return

Aurel's avatar
Aurel committed
96 97 98 99 100 101 102 103 104 105 106 107 108
      def validateMinute(self,date, previous_date):
        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

109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
      def validateHour(self,date):
        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):
        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):
        periodicity_week_frequency = self.getPeriodicityWeekFrequency()
        periodicity_week_day_list = self.getPeriodicityWeekDayList()
Sebastien Robin's avatar
Sebastien Robin committed
132 133 134
        periodicity_week_list = self.getPeriodicityWeekList()
        if periodicity_week_frequency is None and periodicity_week_day_list in ([],None,()) \
            and periodicity_week_list is None:
135 136
          return 1
        if periodicity_week_frequency not in ('',None):
Sebastien Robin's avatar
Sebastien Robin committed
137 138 139 140 141 142 143 144 145
          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
146 147 148 149 150 151 152 153 154 155 156

      def validateMonth(self,date):
        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

Aurel's avatar
Aurel committed
157 158 159 160 161 162 163 164 165
      previous_date = next_start_date
      next_start_date = addToDate(next_start_date,minute=1)
      while not(next_start_date >= current_date \
                and validateMinute(self,next_start_date, previous_date) \
                and validateHour(self,next_start_date) \
                and validateDay(self,next_start_date) \
                and validateWeek(self,next_start_date) \
                and validateMonth(self,next_start_date)):
        next_start_date = addToDate(next_start_date,minute=1)
166
      self.setAlarmDate(next_start_date)
167

168

169
    security.declareProtected(Permissions.View, 'getAlarmDate')
170 171 172 173 174 175 176 177
    def getAlarmDate(self):
      """
      returns something like ['Sunday','Monday',...]
      """
      alarm_date = self._baseGetAlarmDate()
      if alarm_date is None:
        alarm_date = self.getPeriodicityStartDate()
      return alarm_date
Sebastien Robin's avatar
Sebastien Robin committed
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207


    # XXX May be we should create a Date class for following methods ???

    security.declareProtected(Permissions.View, 'getWeekDayList')
    def getWeekDayList(self):
      """
      returns something like ['Sunday','Monday',...]
      """
      return DateTime._days

    # XXX This look like to not works, so override the getter
#    security.declarePrivate('_setPeriodicityWeekDayList')
#    def _setPeriodicityWeekDayList(self,value):
#      """
#      Make sure that the list of days is ordered
#      """
#      LOG('_setPeriodicityWeekDayList',0,'we should order')
#      day_list = self._baseGetPeriodicityWeekDayList()
#      new_list = []
#      for day in self.getWeekDayList():
#        if day in value:
#          new_list += [day]
#      self._baseSetPeriodicityWeekDayList(new_list)

    security.declareProtected(Permissions.View,'getPeriodicityWeekDayList')
    def getPeriodicityWeekDayList(self):
      """
      Make sure that the list of days is ordered
      """
Aurel's avatar
Aurel committed
208
      #LOG('getPeriodicityWeekDayList',0,'we should order')
Sebastien Robin's avatar
Sebastien Robin committed
209 210 211
      day_list = self._baseGetPeriodicityWeekDayList()
      new_list = []
      for day in self.getWeekDayList():
212 213 214
        if day_list is not None:
          if day in day_list:
            new_list += [day]
Sebastien Robin's avatar
Sebastien Robin committed
215 216 217 218
      return new_list